Open topic with navigation

Integrations Page

 

Required Edition

Automation, Enterprise Automation

The Integrations page of Administration Console allows you to view and manage your deployed integrations. From this page you can stop and start integrations, add a new deployment for an integration file, or delete the deployed integration file from the Integration Service. You can also open a detailed view of each integration, where you can start and stop the integration, and view the logged messages related to the integration and its actions.

To open the Integrations page, click Integrations in the left Navigation Pane of Administration Console.

The page has two views, the first for viewing and managing all deployed integrations and the second for viewing detailed information for a selected integration.

ClosedDeployed Integrations View

To access the Deployed Integration View of the Integration page, simply click Integrations in the left Navigation Pane of Administration Console.

There are three buttons at the top-right of this view:

Integration Tables

Each deployed integration file appears in an individual table identified by the deployment name that was specified on the New Deployment dialog at the time that the file was deployed. Each integration file table lists the integrations contained in the integration file, with information about each integration described in the following columns:

You can also start or stop an individual integration. Simply locate the desired integration within the deployed integration file's table and click the appropriate button.

Each integration table also provides a button that allows you to remove an integration file from the Integration Service,

You can customize an integration table view to change column widths, sort ascending or descending, or filter the rows to show only the desired integration(s) contained in the integration file.

ClosedTo change column width

Use one of the following methods to change the width of columns in the integration table:

  • Place your cursor over a column divider between two column headers. When the cursor pointer turns into horizontal arrows, click and drag the divider until the desired column widths are achieved.

  • Right-click a column header and select Best Fit to automatically fit the column from which the context menu was opened.

  • Right-click a column header and select Best Fit (all columns) to automatically fit all the columns to their best width.

ClosedTo sort the rows ascending or descending

Use one of the following methods to sort the rows in the table ascending or descending:

  • Click on the desired column header to toggle sorting of the table rows ascending or descending based on the contents of the selected row.

  • Right-click on the desired column header to open the context menu, and select Sort Ascending or Sort Descending to sort the table rows ascending or descending based on the contents of the selected row.

You can clear sorting at any time by right-clicking a column previously used for sorting and selecting Clear Sorting from the context menu.

ClosedTo filter the integrations displayed in the integration table

If you have a number of integrations contained in an integration file, you may need to filter the list of integrations to quickly display a single integration, or perhaps to display only those integrations that have 1 "Event Occurrence" or those that are "Waiting For Events".

Filter the integrations in the table based on specific column's value using the following method:

  • Click the Filter Editor icon in the desired column header and select the filter criteria from the dropdown list of valid values.

To clear a filter, click the Filter Editor icon in the column header that was previously filtered and select All from the dropdown list. Alternatively, right-click anywhere in the column header that was previously filtered and select Clear Filter from the context menu.

ClosedDetailed Integration View

To access the Detailed Integration View of the Integration page, locate the desired integration file table on the Deployed Integration View and click on the name of the integration that you want to display in the Detailed Integration View.

To return to the Deployed Integration View, click at the top left of the page.

The following information and options are available on this view: 

ClosedGeneral Statistics

The General Statistics area of the page is located directly under the integration name. It shows the following information for the integration:

ClosedActions

The Actions area of the page shows the action(s) that the integration will perform when the integration event is detected.

Action statistics include the action name, status, and last error message. If failures have occurred with execution of the action, you can hover the cursor over the icon to view the last error message. Alternatively, click to open the Last Error Message dialog, where you can copy the error message to the clipboard.

ClosedOutput

The Output area of the page shows the messages associated with the integration, including messages for the integration starting or stopping, detection of the integration method, and running of the integration's actions.

The Output area includes the following options and controls:

You can customize the output table to change column widths, sort ascending or descending, or filter the rows to show only the desired messages.

ClosedTo change column width

Use one of the following methods to change the width of columns in the output table:

  • Place your cursor over a column divider between two column headers. When the cursor pointer turns into horizontal arrows, click and drag the divider until the desired column widths are achieved.

  • Right-click a column header and select Best Fit to automatically fit the column from which the context menu was opened.

  • Right-click a column header and select Best Fit (all columns) to automatically fit all the columns to their best width.

ClosedTo sort the rows ascending or descending

Use one of the following methods to sort the rows in the table ascending or descending:

  • Click on the desired column header to toggle sorting of the table rows ascending or descending based on the contents of the selected row.

  • Right-click on the desired column header to open the context menu, and select Sort Ascending or Sort Descending to sort the table rows ascending or descending based on the contents of the selected row.

You can clear sorting at any time by right-clicking a column previously used for sorting and selecting Clear Sorting from the context menu.

ClosedTo filter the messages displayed in the output table

If there are a number of messages contained in the output table, you may need to filter the list of messages to display only the messages you are interested in viewing.

You can filter the messages in the output table based on specific column's value using the following method:

  • Click the Filter Editor icon in the desired column header and select the filter criteria from the dropdown list of valid values.

To clear a filter, click the Filter Editor icon in the column header that was previously filtered and select All from the dropdown list. Alternatively, right-click anywhere in the column header that was previously filtered and select Clear Filter from the context menu.

Related Topics