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 on the Add/New button to create a new Integration or click on the Duplicate button to clone current.
Click on the 'Add/New' button to add a new Integration
Step 2: Name the Integration
Now give your Integration a unique name, the name can be changed at any time later:
Edit 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. This quick link is usually a WIKI/Sharepoint site with additional documentation
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.
Example of a Custom Field
You can manage Custom Fields for an Integration. Click on the Edit button to enter the modal from where to manage Custom Fields. You have the option to 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. The recommended and preferred way to do this is using the graphical Integration Landscape feature instead.
You have the options to Add, Remove, and Filter the list of available Services.
Example of Services to add for current Integration
Step 5: Monitor View relations
As part of the Monitoring feature, You can also see which Monitor Views the Integration is bound to. This information is available within the Relations tab.
Example of the Relations tab
Here the list and state of currently associated Monitor Views are presented. You have the option to 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