Create a Mediation Contract
Last updated
Last updated
Mediation contracts manage changes to files that must be applied before delivering them. For example, mediation contracts can rename or zip files before sending them to the final consumer.
The creation of the Mediation Contract consists of these main steps:
Define the Contract InfoThis step defines the details of the contract, its name, type, and how it must be processed.
Define the Contract Actions. This step defines the trigger that will start the contract and the workflow associated with the contract.
Set the Contract Variables. This step defines the interaction between the contract and the workflow, setting the variables that will be initialized.
To create a new mediation contract, go to Design → Contracts and click the New button to open the New Contract window.
To create a Mediation Contract, complete the fields in the INFO section as follows:
Name: assign an identification name to the Contract. It is suggested to assign a name that can be easily identified at any time.
Description: enter a description for the Contract you are creating.
Contract Type: in the drop-down list, select Mediation.
Once you have filled in all the fields, click on the CONTINUE button.
This step defines the trigger that will start the contract and the workflow associated with the contract.
You will access the ACTIONS section of the wizard where you must insert the Action Name and select the Action Workflow you want to associate with your contract. If you are satisfied with the system-generated Action Name, leave it as it is. Otherwise, enter a different name.
When you select an Action Workflow from the drop-down menu, a brief description of the template and a visual representation of the workflow will appear.
Once all the fields have been selected, click on the SAVE button. The wizard will be closed, and you will be directed to the New Contract page to configure Action variables.
The New Contract page is made of different sections, in this figure:
In the panel at the top of the page, you can edit the Name, Description and Execution Queue of the contract.
The Name, Status, Contract type and Actor associated with your contract are displayed in the panel on the right of the page. The status of the contract will appear as ENABLED. The toggle button cannot be set to DISABLED if the Contract is associated with an active FEL. The status of the contract is also shown in the Contracts column of the Contracts page. You can change the actor associated with the contract by selecting one of the entries in the Actor drop-down menu.
Execution Queue: by default a Contract is associated with the Default Queue. Queues order the tasks designed in the Contract and define how they must be processed. To assign a Contract to a different queue, open the drop-down menu and select another queue among those available. Details about queues can be found in the section of this documentation.
The action selected in the wizard will appear in the Actions section of this page. The icon next to the Action Name signals that the action variables have not been configured yet. To configure the action variables, click on the icon to expand the action row.
All mandatory action variables must be set to proceed. You can find the description of all action variables on the page.
Once all the variables are set, this icon will appear next to the Action Name and the Status of the Contract will change to READY. You can add a new action by clicking the button below the action variables row.
