Add or manage Integration
This guide teaches how to add or manage an Integration.
Tutorial overview
Use the following table as your to-do list managing the Integration:
| # | Topic |
|---|---|
| 1. | Add or Manage Integration |
| 2. | Name the Integration |
| 3. | Manage Custom Fields |
| 4. | Manage Services |
| 5. | Monitor View relations |
Step 1: Add or Manage Integration
Click the Add/New button to create a new Integration or the Duplicate button to clone the current.
Click the 'Add/New' button to add a new Integration.
Step 2: Name the Integration
Now give your Integration a unique name. You can change this name at will:
Here's an example of editing an Integration.
Mandatory fields
- Name: An Integration must have a unique user-friendly name assigned. You can safely change this name at any point later.
Optional fields
- Description - You can and should give your Integration a user-friendly description of its intended purpose
- Web Site - You can provide a quick link for users when working with and viewing the Integration. The link usually points to a WIKI/Sharepoint site with additional reading.
Almost all further operations regarding the Integration should hereafter be performed using the Integration Landscape feature.
Step 3: Manage Custom Fields
As part of the Repository Model model, You can also manage Custom Fields to provide additional unstructured documentation about your Integration.
Here's an example of a Custom Field.
You can manage the Custom Fields for the Integration. Click the Edit button to enter the modal from where to manage Custom Fields. You can Add, Remove, and change values for the list of available Custom Fields.
Example modal with how to manage Custom Fields for Integration.
We recommend that you use Custom Metadata instead of Custom Fields.
Step 4: Manage Services
You can connect one or more Services to an Integration. We recommend using the graphical Integration Landscape feature instead of working on the Manage page.
Click the Edit button to manage Services.
You can Add, Remove, and Filter the list of available Services.
Examples of Services to add for current Integration.
Step 5: Monitor View relations
You can also see which Monitor Views the Integration is bound to as part of the Monitoring feature. This information is available within the Relations tab.
Here's an example of the Relations tab.
Here the list and state of currently associated Monitor Views are presented. You can filter the list of available Monitor Views. If you click on any of the listed Monitor Views, you will navigate further to the Add or manage Monitor View.
Example list of currently associated Monitor Views for Integration.
Next Step
Add or manage Custom Field
Add or manage Service