Create a Mediation Contract

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:

1. Define the contract info. This step defines the details of the contract, its name, type, and how it must be processed.

2. Define the contract actions. This step defines the trigger that will start the contract and the workflow associated with the contract.

3. 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.

Define the contract info

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.

• 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 Job Queues section of this documentation.

Once you have filled in all the fields, click on the CONTINUE button.

Define the contract actions

This step defines the trigger that will start the contract and the workflow associated with the contract.

Enter the Action Name. If you are satisfied with the system-generated name, you can leave it as it is. If you are not, enter a different name.

Select the Trigger type that will execute the contract. Possible options are listed on the Trigger types page and subpages.

Select the Workflow from the drop-down menu. A brief description of the template and a visual representation of the workflow will appear in the lower section of the window. For more information about workflows to be used in mediation contracts, refer to the Custom workflow templates page.

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.

Set the contract variables

The New Contract page is made of different sections, shown 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.

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. The action variables depend on the selected workflow. The action variables for system workflow templates released by Primeur are described on the Mediation Templates page. The action variables for custom workflow templates depend on the service tasks. Service task variables are described on the Service tasks 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.