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 for managing Integrations. Stay organized and ensure every integration is fully documented and connected for maximum business value.
| # | 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 one.
Click the 'Add/New' button to add a new Integration.
Step 2: Name the Integration
Give your Integration a unique, descriptive name. You can update this name at any time to reflect changes in your business or technical landscape.
Here's an example of editing an Integration.
Mandatory fields
- Name: Every Integration must have a unique, user-friendly name. You can safely change this name at any time.
Optional fields
- Description – Provide a clear, user-friendly description of the integration's purpose.
- Web Site – Add a quick link for users, such as a WIKI or SharePoint page, for additional documentation.
For ongoing management, use the Integration Landscape feature for a visual, intuitive experience.
Step 3: Manage Custom Fields
As part of the Repository Model, you can manage Custom Fields to add flexible, unstructured documentation to your Integration.
Here's an example of a Custom Field.
Click the Edit button to manage Custom Fields. You can Add, Remove, and update values for the available Custom Fields.
Example modal showing how to manage Custom Fields for an Integration.
We recommend using Custom Metadata for even greater flexibility and structure.
Step 4: Manage Services
Connect one or more Services to an Integration. For a graphical approach, use the Integration Landscape feature.
Click the Edit button to manage Services.
You can Add, Remove, and Filter the list of available Services.
Examples of Services to add for the current Integration.
Step 5: Monitor View relations
See which Monitor Views are linked to your Integration as part of the monitoring feature. This information is available in the Relations tab.
Here's an example of the Relations tab.
The list and state of associated Monitor Views are presented here. You can filter the list, and clicking any Monitor View takes you to the Add or manage Monitor View.
Example list of currently associated Monitor Views for an Integration.
Next Step
Add or manage Custom Field
Add or manage Service