Creating a Contract

To create a new Contract, go to Design β†’ Contracts and click the New button to open the New Contract window.

As you can see on the left of the window, the wizard guides you through 3 subsequent steps:

  • INFO
  • ACTOR
  • ACTIONS

Note that when you select a Mediation contract only the INFO and ACTIONS steps will appear.

Let's now create an Input Contract.

These are the fields that you must fill in in the INFO section:

  • 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 Input.
  • 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.

After you have filled in all the fields click the CONTINUE button.

You will access the ACTORS section of the wizard where you must select the actor your contract will be associated to. Choose a Partner or Application from the drop-down list, if needed, a Search field is available to look for specific names. The list will be filtered as soon as you start typing an alpha-numeric character and all Actors containing that character will be listed.

Now that an Actor is selected, click the CONTINUE button.

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 to your contract. The Action Name field is editable. Note that the Action Name field will appear with a system generated name based on the information already given. 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 as shown in the figure below:

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 to 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.
A list of Action variables will appear, set all the mandatory parameters to proceed.

For a detailed list of all the Action variables associated with SYSTEM and ERROR Workflow templates please refer to the System Workflow section of this guide.

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.

Want to know how to create a Mediation and an Output Contract? Head over to ...create a Mediation Contract and ...create an Output Contract.