WebhookDefinitionOverload_xxx

// WebhookDefinitionOverload_xxx
// @Description             =>  Overload webhook definition

languageCode     = VARGET_SHELL( "languageCode", "WebhookDefinition" )

specificOverload = TRANSLATE( "
  {
    'extendedFieldsListToExclude': '',
    'simpleFieldsList': '',
    'relatedTablesCount': '',
    'relatedTables': [],
    'authorizedTables': [],
    'cascadeDeleteTables': [],
    'fieldsList': {
    
    },
    strictFilters: [
      
    ],
    'strictOrderBy': [
      
    ],
    'outOfMainTableFields': [
      
    ]
  }
" )
RETURN( "<varscript>specificOverload</varscript>" )

'extendedFieldsListToExclude': 'field1,field2,field3,...'

'extendedFieldsListToExclude': 'serialnumber,location'

'simpleFieldsList': 'field1,field2,field3,...'

'simpleFieldsList': 'codecustomer,name,city,final_pricecategory_ID_tarCod'

'relatedTablesCount': xx,
'relatedTables': ['fieldFK1', 'fieldFK2', '...']

'relatedTablesCount': 2,
'relatedTables': ['generictype_ID_customerFamily', 'final_pricecategory_ID_tarCod']

'authorizedTables': [{'tableName':'mainTableName'}, {'tableName':'additionalTableName1'}, {'tableName':'additionalTableName2'}, {'tableName':'....'}]

'authorizedTables': [{'tableName':'intervention'}, {'tableName':'interventionequipment'}, {'tableName':'interventionpart'}, {'tableName':'interventionoperationrange'}]

Attention, on ne permet qu’un seul niveau de suppression en cascade.

La suppression d’un enregistrement d’une table principale permet de supprimer en cascade un enregistrement d’une sous-table. Mais si l’enregistrement de cette sous-table est utiilisé dans une autre table, la suppression sera interdite.

'cascadeDeleteTables': [{'tableName':'tableName1'}, {'tableName':'tableName2'}, {'tableName':'...'}]

'cascadeDeleteTables': [{'tableName':'interventionequipment'}, {'tableName':'interventionpart'}, {'tableName':'interventionoperationrange'}],

'fieldsList': {
      'field1': {
          'type': '…',
          'length': '…',
          'label': '…',
          'targetTableName': '…',
          'targetFieldName': '…',
          'fieldNameToShow': '…',
          'alias': '…',
          'mandatory': 0 or 1,
          'cannotBeNull': 0 or 1,
          'canGet': 0 or 1,
          'canInsert': 0 or 1,
          'canUpdate': 0 or 1,
          'deprecated': 0 or 1,
          'foreignParent': '…'		
      },
      'field2': {
          'type': '…',
          'length': '…',
          'label': '…',
          'targetTableName': '…',
      	  'targetFieldName': '…',
	  	  'fieldNameToShow': '…',
	      'alias': '…',
          'mandatory': 0 or 1,
          'cannotBeNull': 0 or 1,
          'canGet': 0 or 1,
          'canInsert': 0 or 1,
          'canUpdate': 0 or 1,
          'deprecated': 0 or 1,
	      'foreignParent': '…'
      },
      'field3': {
          'type': '…',
          'length': '…',
          'label': '…',
          'targetTableName': '…',
      	  'targetFieldName': '…',
	      'fieldNameToShow': '…',
	      'alias': '…',
          'mandatory': 0 or 1,
          'cannotBeNull': 0 or 1,
          'canGet': 0 or 1,
          'canInsert': 0 or 1,
          'canUpdate': 0 or 1,
          'deprecated': 0 or 1,
	      'foreignParent': '…'
      }
      … 
},
'outOfMainTableFields': [
{
    'fieldName': '…',
    'tableName': '…'
}
],

"response":
  {
    "data":
      [{ depends of the webhook}],

    "fieldList": 
    [{
      "entityName": "value", // name of the table (ie intervention)
      "fields":
      [{
        "fieldName": "value", // name of the field (ie codeintervention, customer_ID, …)
        "fieldType": "value", // type of the field : varchar, text, int, double, bool, datetime, timestamp, foreignkey
        "fieldLength": "value", // length of the field : informed for varchar, text
        "fieldLabel": "value" // label of the field : depends on the value of the languageCode from the header (default : FR)
      },
      {
        "fieldName": "value",
        "fieldType": "value",
        "fieldLength": "value",
        "fieldLabel": "value"
      },
      {
        ...
      }],
      "related":
      [{
        "entityName": "value",
        "fields":
        [{
          ...
        }]
      },
      {
        "entityName": "value",
        "fields":
        [{
          ...
        }]
      },
      {
        ...  
      }]
    }]

"result": {
  "common" : {
    "resultCode": "1",
    "errorMessage": "Data Error: Value of final_pricecategory_ID_tarCod cannot be null" 
  }
}

"N° Siret du client principal" : "1234567899988",

"fields": [
  {
    "fieldName" : "generictype_ID_country",
    "fieldType": "foreignkey-varchar" 
    "fieldLength" : "255",
    "fieldLabel" : "Pays",
  }
]

'fieldsList': {
    'final_test_ID': {
        'deprecated': 1
    }
}

'fieldsList': {
    'final_pricecategory_ID_tarCodInternal': {
        'canGetDefinitionList': 1,
        'definitionFilter': 'tarifPart = 0'
    }
}

'strictFilters': [
{
    'fieldName': '…',
    'operator': '…',
    'targetField': '…',
    'query': '…'    	
},
{
    'fieldName': '…',
    'operator': '…'
    'targetField': '…',
    'query': '…'
},
{
    ...
}
]

"filters": 
{
  "v_A101": "1000"
}

'strictOrderBy': [
{
    'name': '...',
    'fields': [
    {
        'table': '...'
        'field': '...',
        'order': '...'
    },
    {
        'table': '...'
        'field': '...',
        'order': '...'
    },
    {
        ...
    }]
},
{
    'name': '...',
    'fields': [
    {
        'table': '...'
        'field': '...',
        'order': '...'
    },
    {
        ...
    }]        
}]

"orderBy": "codeCountryAscNameAsc"

// WebhookRulesOverload_xxxx
// @description     => Overload rules with yours. Return a response and a errorMessage if needed.
//
// @code            => Row code. Not exploited at the moment.
// @verb            => Method used. Can be PUT | GET | LIST | DELETE
// @dataInput       => Depending of the method. Contains json for the PUT method. Only PUT contain data.
// @ruleFields      => Empty Object
//                     Can be filled like this : DOCUMENT_ADD_PROPERTY_TO_OBJECT( ruleFields, "nameOfDataInput", yourNewValue )
//
// @returns         => Response JSON document with two properties :
//                     response [ required ] => 1 if all rules are valid or 0 IF at least one rule is not valid
//                     errorMessage [ optional ] => if response equal to 0, THEN we display your errorMessage

code       = TRANSLATE( "<varscript>arg1</varscript>" )
verb       = TRANSLATE( "<varscript>arg2</varscript>" )
dataInput  = TRANSLATE( "<varscript>arg3</varscript>" )
ruleFields = TRANSLATE( "<varscript>arg4</varscript>" )

jsonResponse = DOCUMENT_CREATE_DOCUMENT()

// To complete
…

response = DOCUMENT_SERIALIZE( jsonResponse, "json" )
RETURN( response )

DOCUMENT_ADD_PROPERTY_TO_OBJECT( jsonResponse, "response", "0" )
DOCUMENT_ADD_PROPERTY_TO_OBJECT( jsonResponse, "errorMessage", "Specific rule error: …" )
      
response = DOCUMENT_SERIALIZE( jsonResponse, "json" )
RETURN( response )

"result": {
  "common": {
    "resultCode": "1",
    "errorMessage": "Specific rule error: La note administrative du cl, valeur envoyée 6)""
  },

Pour initialiser un champ de type foreignKey, il est impératif de passer le code de l’enregistrement et pas son ID.

// WebhookOverload_Before
// @Description             => A script to use before webhook execution
//
// @tableName               => Name on wich table webhook will proceed
// @code                    => Row code. Can be empty depending of the method. It is empty for LIST || PUT.
//                             GET: contains code link to the row to be returned
//                             DELETE: contains code link to the row to be deleted
// @method                  => Method used. Can be GET || LIST || PUT || DELETE
// @headerInput             => Header input
// @dataInput               => Data input. Can be empty depending of the method. It is empty for GET || LIST || DELETE.
//                             PUT: contains data to be inserted
// @resultCode              => If webhook execution will fail, resultCode is equal to 0. Otherwise, 1.
// @errorMessage            => Error message associated to the code
// @verifiedData            => An object that contains all data. IF others arguments are not enough
// @entity                  => To be used to differenciate between webhooks using the same table
//
// @Returns                 => Void
 
tableName     = TRANSLATE( "<varscript>arg1</varscript>" )
code          = TRANSLATE( "<varscript>arg2</varscript>" )
method        = TRANSLATE( "<varscript>arg3</varscript>" )
headerInput   = TRANSLATE( "<varscript>arg4</varscript>" )
dataInput     = TRANSLATE( "<varscript>arg5</varscript>" )
resultCode    = TRANSLATE( "<varscript>arg6</varscript>" )
errorMessage  = TRANSLATE( "<varscript>arg7</varscript>" )
verifiedData  = TRANSLATE( "<varscript>arg8</varscript>" )
entity        = TRANSLATE( "<varscript>arg9</varscript>" )

// For specific case, markForExport property can be changed here.
// To do it, a variable is available
// VARSET_SHELL( "markForExport", "Can be 0, 1, 2", "WebhookHeader" )

// IF resultCode = 0, THEN all data are empty, except errorMessage.
IF( EQUALS( resultCode, "1" ) )THEN
  
ENDIF

dataInput = REPLACE("<varscript>dataInput</varscript>",";",",")

msg = "message="
msg = CONCAT( msg, "tableName = <varscript>tableName</varscript>-" )
msg = CONCAT( msg, "code = <varscript>code</varscript>-" )
msg = CONCAT( msg, "method = <varscript>method</varscript>-" )
msg = CONCAT( msg, "headerinput = <varscript>headerinput</varscript>-" )
msg = CONCAT( msg, "datainput = <varscript>datainput</varscript>-" )
msg = CONCAT( msg, "resultcode = <varscript>resultcode</varscript>-" )
msg = CONCAT( msg, "errormessage = <varscript>errormessage</varscript>" )
msg = CONCAT( msg, "entity= <varscript>entity</varscript>" )

VARADD_DB( "sw_data_final_log", msg )

// WebhookOverload_After
// @Description             => A script to use after webhook execution
//
// @tableName               => Name on wich table webhook proceeded
// @code                    => Row code. Can be empty depending of the method. It is empty for LIST || PUT.
//                             GET: contains code link to the returned row
//                             DELETE: contains code link to the deleted row
// @method                  => Method used. Can be GET || LIST || PUT || DELETE
// @dataInput               => Data input. Can be empty depending of the method. It is empty for GET || LIST || DELETE.
//                             PUT: contains data inserted
// @dataOuput               => Data ouput. Can be empty depending of the method. It is empty for PUT || DELETE.
//                             GET || LIST: contains data returned
// @resultCode              => IF webhook execution failed, resultCode is equal to 1. Otherwise, 0.
// @errorMessage            => Error message associated to the code
// @action                  => insert / update / select / delete. Useful to differantiate insert and update
// @verifiedData            => An object that contains all data. If others arguments are not enough
// @entity                  => To be used to differenciate between webhooks using the same table
//
// @Returns                 => Void

tableName     = TRANSLATE( "<varscript>arg1</varscript>" )
code          = TRANSLATE( "<varscript>arg2</varscript>" )
method        = TRANSLATE( "<varscript>arg3</varscript>" )
dataInput     = TRANSLATE( "<varscript>arg4</varscript>" )
dataOutput    = TRANSLATE( "<varscript>arg5</varscript>" )
resultCode    = TRANSLATE( "<varscript>arg6</varscript>" )
errorMessage  = TRANSLATE( "<varscript>arg7</varscript>" )
action        = TRANSLATE( "<varscript>arg8</varscript>" )
verifiedData  = TRANSLATE( "<varscript>arg9</varscript>" )
entity        = TRANSLATE( "<varscript>arg10</varscript>" )