Behaviour JSON - Behaviour JSON - Alfresco - Alfresco Content Connector for SAP Cloud - Alfresco/Alfresco-Content-Connector-for-SAP-Cloud/2.0/Alfresco-Content-Connector-for-SAP-Cloud/Configure/Configure-GenericXchange/Configuration/Behaviour-JSON - 2.0 - 2.0

Alfresco Content Connector for SAP Cloud

Platform
Alfresco
Product
Alfresco Content Connector for SAP Cloud
Release
2.0
License
ft:lastPublication
2025-02-25T09:47:46.920000
ft:locale
en-US
Note:
  • Make sure you have all the required RFC related settings present in alfresco-global.properties. See Settings for RFC/SNC
  • Make sure you always use a separate paid SAP (system) user for the connection.
Note: Each change in the JSON configuration file for a Behaviour requires a reload of the script on all Content Services nodes (or by restarting each Content Services node). To reload the Behaviour JSON file, a Webscript with name genericXchange Reload is provided. This Webscript is part of the Content Connector for SAP - genericXchange Webscript family which is accessible in the Alfresco WebScripts Home.

The following table lists all available settings for the rfcBehaviour.1.json, as it’s not possible to use OData calls along with an Alfresco Behaviour. All the settings below must be present in the JSON configuration file.

Property Type Description
enabled Boolean Sets if the Behaviour is enabled or not. Example value: true or false.
sapName String Defines the mapping to the related SAP system configuration in the alfresco-global.properties. This must match the value of key genericXchange.rfc.sap.system. 1 .name.

Example value: GX_Behaviour_S4H.

mode String Sets how the module handles the specified function modules.
  • standard: Invokes one function module for the current document.
  • chain: Invokes multiple function modules in the given order for the current document.
behaviour String Any behaviour from the NodeServicePolicies interface of the Alfresco Public API.

Example value: onUpdateProperties, onAddAspect, or see the NodePolicy list.

notificationFrequency String Defines where in the transaction event the handler is invoked.

Example value: TRANSACTION_COMMIT, EVERY_EVENT, or FIRST_EVENT.

listeningOn String The aspect which must be available on the document to invoke the behaviour. Must be entered with a namespace prefix.

Example value: cm:summarizable.

mandatoryProperties Array List of all mandatory properties on the document which must be set to invoke the behavior. This can’t be empty or null.
Note: The behaviour is invoked only if all specified properties have changed their values. It is not enough just to have the property available and filled, it also must be changed.

Example value: cm:summary.

aspects Array List of all aspects which must be available on the document to invoke the behaviour.

Example value: cm:titled.

noAspects Array List of all aspects which should not be present on the document to invoke the behaviour. If at least one aspect in this list is available, the behaviour does not fire.

Example value: cm:taggable.

values Object A list of objects with property names and defined values which must be available to invoke the behaviour. Here it’s possible to trigger the behaviour only for specified values of a property. For a list of defined property/value pairs all must match to invoke the behaviour.

The value must exactly match the defined value (i.e. case sensitive, and no wildcards). A list of possible values can also be defined (see example for noValues).

Based on the following example, the behaviour would only be invoked if cm:title exactly matches the word Alfresco.

Example value: [“cm:title”: “Alfresco”].

noValues Object A list of objects with property names having defined values which are not allowed to invoke the behaviour. Here it’s possible to prevent the execution of the behaviour for properties with specified values.
Note: The value must exactly match the defined value (i.e. case sensitive, and no wildcards).
Looking at the example, the behaviour would only be invoked if cm:summary exactly matches either the word Happy OR the word Day AND cm:title matches the word Alfresco.

Example value: [“cm:title”: “Alfresco”,“cm:summary”: [“Happy” , “Day”]].

detachBehaviour Boolean If true the RFC call (see parameter functionModule/functionModules below) is fired after the behaviour has been finished.

Example value: true or false.

asyncRfc Boolean Sets whether to invoke the behaviour asynchronously or synchronously.

Example value: true (asynchronous) or false (synchronous).

createALFolder Boolean If true, the parent folder for the current document is created and the required SAP ArchiveLink related aspects are applied to it. This is to match the SAP ArchiveLink protocol specification.

Example value: true or false.

functionModule or functionModules Object Specify SAP function module(s) including all required parameters. See Property functionModule/functionModules.
error Object Optional. Handles the errors which might be returned by the request or functionModule. See Property error.
success Object Optional. Handles the success messages which might be returned by the request or functionModule. See Property success.