Managing Contracts

Let’s now see in detail the Contracts main page displayed going to Design β†’ Contracts.

The Contracts main page is made up of different sections.

In the Filters panel on the right, you can filter Contracts by:

  • Name (note: the search is not case sensitive, wildcard characters and boolean operators
    are not supported),
  • Status (Enabled or Disabled),
  • Type (Input, Mediation or Output),
  • Actor to which the Contract is assigned,
  • Workflow action associated with the Contract,
  • Trigger (On demand, Time, New file, Incoming transfer, Incoming update metadata, Outgoing transfer, VirtualBox Bind, VirtualBox Unbind),
  • Date of creation, modification, or both, of the Contract.

An Advanced filter section is also available in the Filters panel. The Advanced filters allow you to filter Contracts by:

  • VFS,
  • VFS path,
  • queue,
  • cluster
  • Virtual Box

Note that, when filtering with advanced filters, the VFS and VFS path options will appear only if an Actor has already been selected in the Actor filter.

Existing contracts will appear in the Results list according to the criteria selected and can be sorted by:

  • Last updated
  • Name A-Z - alphabetical order
  • Name Z-A - reverse alphabetical order
  • Actor A-Z - alphabetical order
  • Actor Z-A - reverse alphabetical order

To sort contracts, click the icon next to the Modified, Contract or Actor wording at the top of the result list.

A Contract status can be set to ENABLED or to DISABLED. To quickly change the status of a Contract, click the 3-dot button and select the Enable Contract or Disable Contract menu according to your needs. To enable or disable multiple Contracts in one go, select the Contracts by checking the box on the left of the row and click the Change Status option at the top of the list. If you select a Contract that is already in the destination status, a warning message will appear. To change the status, you can also edit the contract and use the toggle button in the panel on the right of the Edit Contract page.
Note that ENABLED Contracts cannot be set to DISABLED if they are associated to an active FEL.

Learn how to use the toolbar at the top of the page here.

Contracts can be searched in the search bar in the toolbar at the top of the page. Note that the search is case sensitive.

Select the 3-dot icon at the end of each result to:

  • Duplicate a Contract.
  • Duplicate an Action.
  • Enable or Disable a Contract
  • Edit a Contract.
  • Delete a Contract.

Click any of the entries in the result list to open the Contract detail page shown below.

The Contract detail page provides additional information about a Contract. It is composed of three different sections.

At the top of the page, a toolbar displays the Name, Type and Actor associated with the Contract you have selected.

Click on the icon to Edit the Contract or on the icon to Delete it.

Note that the Filters panel is disabled in this section.

Once you have selected the filters you want to apply click on the APPLY button, the result will appear in the Actions section. If you want to clear all the filters click on the Clear All wording at the top of the Filters panel.
Additional details about the Contract and information about the Actions associated with it can be found in the main section of this page.

The Additional details section features a set of information about the Contract such as:

  • The Description of the Contract
  • The date it was created
  • The date of when it was last modified

In the Actions section you can find a list of the actions associated with the Contract.

1249

Actions can be searched in the search bar in the toolbar at the top of the section. Note that the search is case insensitive.

Click on the 3-dot icon at the end of each result to either Edit or Duplicate the action selected.

Click on any of the action workflows in this section to open the Action Workflow page.

1940

The Action Workflow page shows all the variables associated with the action workflows associated to a Contract. Variables can be sorted by Action by clicking on the action name on the left side of the page.
The search bar at the top of the page can be used to search through variables. Note that the search is case sensitive.

Warning!

The buttons to Create, Edit and Delete a Contract described in these sections are not visible to Users with READ ONLY permission on the Contracts section of Data One.