Validating an orchestration

An orchestration must be valid (complete and correct) before you can publish it to the Integration Appliance. Use the validation feature in Studio to validate your orchestration.

Before you begin

To be valid an orchestration must met the following requirements:
  • Have a starter activity or a Pick activity as the first activity. Starter activities are denoted in the Activities tab with the blue orchestration icon and a downward arrow Inbound. The first activity in each branch of the Pick activity must be a starter activity.
    Note: All starter activities are represented in Studio by the inbound icon Inbound, except for the Schedule Job activity.
  • Variables must be initialized before they are used. This includes variables that are initialized in the branches of an If.. Then activity. The variable must be initialized in all branches.

Procedure

  1. Select the Project tab, and expand the Orchestration folder.
  2. Select and open an orchestration from the Orchestration folder. A graphical representation of the orchestration is displayed in the Orchestration tab.  
  3. Validate your orchestration using one of the following options:
    • Select Orchestration > Validate from the menu toolbar. The Validation Results dialog box is displayed.
    • Press ALT-F8. The Validation Results dialog box is displayed.
    • Click an orchestration in the Project tab. If the orchestration is invalid, the Validation Results popup is displayed next to the Project tab and the invalid orchestration icon Invalid orchestration icon is displayed next to the orchestration in the Project tab
    The Validation Results dialog box lists the problem areas in the orchestration. Problems prefaced by a blue icon are informational; you will have to navigate to that area to fix the problem. Problems prefaced by a red icon are errors. Click the error message in the dialog box to open the appropriate panel to fix the error.

    Validation ensures that all the basic requirements for an orchestration have been met. You must resolve all validation issues before publishing the orchestration to the Integration Appliance.

Example

To validate all the orchestrations in the project complete the following steps:
  1. In the Project tab, click Revalidate Project Revalidate Project. All the orchestrations in the project are validated. If an orchestration is invalid the invalid orchestration icon Invalid orchestration icon is displayed next to the orchestration in the Project tab. If the orchestration is invalid, click on the orchestration to view the errors in the Validation Results list.
  2. Select the Validate Project Validate Project toolbar button. All the orchestrations in the project are validated. If an orchestration is invalid the invalid orchestration icon Invalid orchestration icon is displayed next to the orchestration in the Project tab. If the orchestration is invalid, click on the orchestration to view the errors in the Validation Results list.

What to do next

Validation icons are displayed throughout the orchestration providing visual clues to potential problem areas or to provide further information.

In Studio, the following validation icons are displayed:
Warning icon Warning icon
Click warning icons to learn what information is required to complete the configuration of the entity in the pane. For example, in an activity's checklist, the warning icon appears next the endpoint if an endpoint has not yet been specified.
Information icon Information icon
Click information icons to learn details about a entity in the pane, for example why a button has been disabled.
Checkmark icon Checkmark icon
Checkmark icon is displayed when all the information for a entity in the pane has been specified.  For example, in an activity's checklist, the checkmark icon appears next to the endpoint if a valid endpoint has been specified.

A warning icon Warning icon displays in the upper-right corner of many panes (for example, the Endpoint configuration pane). You can click this icon to toggle the warning icons ON or OFF displayed in the pane. If turned OFF, the warning icons are not displayed in the pane.