Configurations
In TIF Cloud you can setup different "Configurations". A configuration consists of a name, a type, some content and with some optional key/values (properties) attached.
The configuration itself is used in different integration use cases. Either the configuration will contain some execution logic declared in Script format, such as JavaScript, or it will contain input parameters to some pre-defined integration-type (a parameterized type).
The type property on the configuration defines what kind of content you can have in the configuration itself.
Some type’s might also provide an additional UI in order to simplify editing the content of the configuration.
Referencing a Configuration
A configuration is referenced from an event-mapping or a REST-mapping.
Within the Event/REST-mapping, you will point out a configuration that will perform the job. The type on the configuration defines how the configuration will be executed. Each type has its own executor capable of interpreting the content of the configuration.
If the configuration is of type "JavaScript", then the content of the configuration will be executed as a javascript within the TIF Cloud backend.
There might be other kind of configuration types available, which instead just will contain some "input parameters" to a pre-defined executor. In such case, the configuration that you point out will only carry a reference to the pre-defined executor via its "type", and the configuration content will be used as input for this pre-defined executor.
Once a job is started, the application will automatically track what version of a specific configuration that was used to perform the job. So two jobs executed at different time using the same event mapping may use two different versions of the same configuration IF changes have been made to the configuration between the execution of the two jobs.
Configuration Properties
These are the properties that is available on a configuration
-
name
-
Logical name of the configuration.
-
Use forward slash (/) to build up hierarchical names logically grouped together. Similar to package names in Java.
-
-
type
-
Defines the configuration type. This value is used to resolve what "Executor" to be used.
-
You can for example point out built-in executors like "sap:sendEBOM" or similar. NOTE: The available built-in executors available to chose among depends on licenses and what features that have been granted to an environment.
-
Or you can specify "JavaScript" and by so allowing scripting to take place.
-
-
content
-
Depending on the configuration type chosen, the content of the configuration follows different format.
-
In case type is set to "JavaScript" then the content is java-script code.
-
-
properties
-
Key/value pairs providing additional input for the executor.
-
Certain executors are parameterized and allows to be configured via these properties.
-
-
version
-
Over time when the configuration is developed, the application may create snapshot versions of the configuration in order to be able to track exactly how a configuration was defined when a job was executed.
-
Creating a Configuration
| Only users having the role 'Configuration Editor' can create and edit configurations. |
Within the Administration UI, creating a configuration is done from the Actions menu.
When creating the configuration, you need to give it a name and a type. Names can contain forward slashes in order to build tree-like structures of configurations.
When editing the configuration, a suitable editor depending on the type will be opened.
In the UI you save the changes made to the configuration via the save icon. Moreover, there is a "play" button available, which allows you to test the configuration.
| Configurations that belongs to extensions installed from the Marketplace will generally appear as read-only in the editor. |