Working with integration points

Create a new integration point

To create a new integration point, follow these steps:

1. In CMS UI, click the Menu icon () to expand the CMS Modules pane, and then click Integration Studio.
2. Click the New integration point icon () to display the New Integration Point pane.

3. Enter a name and description for the integration point.

4. Select the appropriate integration adapter. The Adapter Properties section is populated with the relevant adapter properties.

5. Enter the adapter properties.

6. If the adapter protocol requires credentials, click the Credentials text box to open the Choose Credentials pane, select a credential from the list, and then click OK.

   If the required credential is not displayed, click the Add icon () in the Choose Credentials pane, enter the credential information, click Save, and then click OK.

7. Click OK to create the new integration point.
8. Add integration jobs to the integration point. For more information about how to do this, see Working with integration jobs.

Import or export an integration point

To import or export an integration point, follow these steps:

1. In CMS UI, click the Menu icon () to expand the CMS Modules pane, and then click Integration Studio.
2. Click the Import/Export icon (), and then select Import or Export to open the Import & Export pane.

3. To import an integration point, click the Add icon (), select the desired integration point .xml file, and then click IMPORT.

   To export an integration point, select the desired integration point from the drop-down list, and then click EXPORT.

Search for an integration point

To search for an integration point, follow these steps:

1. In CMS UI, click the Menu icon () to expand the CMS Modules pane, and then click Integration Studio.

2. Click the Search icon (), enter your search terms in the Search box, and then press Enter.

   Note To display all available integration points again once that you have performed a search, click the Search icon, clear the Search box, and then press Enter.

Activate or deactivate integration points

To activate or deactivate an integration point, follow these steps:

1. In CMS UI, click the Menu icon () to expand the CMS Modules pane, and then click Integration Studio.

2. Locate the integration point that you want to activate or deactivate, and then switch the toggle button () next to the adapter name to the desired position.

   Note When an integration point is deactivated, the toggle button appears dimmed, and the status is displayed as a question mark icon. When you activate an integration point, the connection is tested, and the status is displayed as a tick icon if the test is successful.

   To deactivate all integration points, click the Deactivate All icon (), and then click Deactivate to confirm the action. A pop-up progress bar displays the number of integration points that have been disabled.

Change the grouping of the displayed integration points

When you view integration points in Integration Studio, the displayed integration points are grouped by adapter or by status. To change which type of grouping is used, follow these steps:

1. In CMS UI, click the Menu icon () to expand the CMS Modules pane, and then click Integration Studio.
2. Click the Filter icon (), and then select the desired grouping.

View the details and overview of an integration point

To view the details and overview of an integration point, follow these steps:

1. In CMS UI, click the Menu icon () to expand the CMS Modules pane, and then click Integration Studio.
2. Click the name of the desired integration point to display details of the associated integration jobs.
3. Click the Overview icon () to display an overview of the integration point, including the associated integration jobs and a graphical representation of the job status.

Edit or delete an integration point

To edit or delete an integration point, follow these steps:

1. In CMS UI, click the Menu icon () to expand the CMS Modules pane, and then click Integration Studio.
2. Point the mouse to the integration point that you want to edit or delete. The Edit (), Delete (), and Pin () icons are displayed.

3. To edit an integration point, click the Edit icon to display the Edit Integration Point pane, make the required changes, and then click OK.

   To delete an integration point, click the Delete icon, and then click Yes to confirm the deletion.

Refresh the integration points

To refresh an integration point so that current status information is displayed, follow these steps:

1. In CMS UI, click the Menu icon () to expand the CMS Modules pane, and then click Integration Studio.
2. Click the Refresh icon () to refresh the integration points.

Pin an integration point to the Home Page

To pin an integration point to the Home Page, follow these steps:

1. In CMS UI, click the Menu icon () to expand the CMS Modules pane, and then click Integration Studio.
2. Point the mouse to the integration point that you want to edit or delete. The Edit (), Delete (), and Pin () icons are displayed.

3. Click the Pin icon to display the integration point widget on the CMS UI Landing Page.

   To unpin the widget from the Home page, click the Unpin from Dashboard icon () or remove it directly from the Home page.

   Note From the integration point widget on the Home Page, you can activate or deactivate the integration point by using the toggle button, and you can click the integration point name to view the list of integration jobs for the integration point. You cannot edit or delete an integration point from its widget on the Home Page.