Personal tools
  •   Log in  

Integration Configuration

From OpsHub Integration Manager

Jump to: navigation, search

This section includes steps for basic integration and advance settings during an integration.

However, before you start these steps, ensure that you are in the right folder. To learn more about folders, click Organize Integrations.

Basic Integration

  • The dashboard, by default, shows all integrations created so far on the selected instance.
Integration Configuration Image 20F.png
  • If the integration you want to use is not present in the list, follow the steps here:
    • Click the Integrate button on the screen.
Integration Configuration Image 21C.png
  • Click the plus icon [+] on the top right corner of the screen. You will be prompted to enter the  Integration Name and name of systems you want to integrate.
Integration Configuration Image 21C1.png

Note.jpg You are free to choose any name for the integration; however, we advise you to choose a name that helps identify the systems involved in the integration.

Integration Configuration Image 1a.png
  • Click the plus sign [+] adjacent to the System 1 and System 2 fields. You will be navigated to the System Configuration screen. Check the System Configuration steps here.
  • In the Select Project to Sync section, select the projects you want to synchronize between the systems by clicking them. For example, in this case, we select Demo Project from TFS and OpsHub project from JIRA.
  • Click the forward arrow (>), bi-directional arrow (<-->), or backward arrow (<) depending upon whether you want to integrate projects from System 1 and System 2, or do a bi-directional synchronization.
  • In the Select Entities to Sync section, select the entities (issue types) you want to synchronize between the systems. A list of entities that are common for both projects would appear for both systems. Click the ones you want to synchronize. You can synchronize multiple entities in one integration. To add more entities, click the plus sign [+] adjacent to Select Entities to Sync.

Note.jpg Some systems will have entities that require special settings. These entities would appear on the right side of the screen.

  • If the required mapping doesn't exist, click the the plus button [+] adjacent to Select fields to be synced (In one of the screenshots above, select fields to be synced section is populated with TFS-JIRA map). You will be navigated to Mapping Configuration screen.

Click Mapping Configuration to learn the steps to create a new mapping.

Integration Configuration Image 23a.png
  • Set the time to start sychronizing data in both the systems in the Start Polling Time fields. The time could be past, present, or future.
  • To save the integration in active mode, slide the Activate Integration  button to the right. Select Yes in the Are you sure? pop-up.

Integration Configuration Image 3a.png


  • Click Save to save the integration.

Criteria Configuration

Criteria Configuration helps in integration of subset of entities based on some conditions. For example, you can specify that only bugs with high priority are to be synchronized or tickets that are closed should be synchronized. Even after the entities are integrated, this synchronization based on defined criteria is retained.

  • Click the icon shown in the image below for enabling Criteria Configuration .


Integration Configuration Image 5a.png


2. A pop-up window - Criteria Configuration appears on the right. In this window, for a bidirectional mapping, sections specific to both systems involved in the integration will appear in backward and forward criteria configuration tabs. Fill the requisite details.


Integration Configuration Image 6a.png


3. First, select Yes in the Configure Criteria drop-down list. Once you select Yes in the Configure Criteria drop-down list, two more fields, Query and Select criteria storage type field, appear. Note that it is mandatory to select values for these three fields.

  • In the Query field, enter the condition that you want OpsHub Integration Manager to consider when it synchronizes the selected entity between the source system and the destination system. For example, if you enter PRIORITY= 'High' in the Query field for this integration, it means you are instructing to synchronize only those entities that are high priority.

Note.jpg The format in which you enter condition in the Query field will vary from one system to another. Refer the Connectors section to learn more.

  • From the Select criteria storage type drop-down list, select whether you want to store the entities from the source system in the database or directly in the end system. The default behavior is to store the data in the database.
    • When you select In Database,the selected entities synchronize between both systems even when the conditions defined in the Query field has been updated.
    • When you select In End System,the selected entities synchronize between both systems only when the current conditions in the Query field are met. When you select this option, you also need to specify the field of the source system where the criteria need to be stored in the Select where criteria info is to be stored field.

To read in detail about Criteria information storage in end system, click here.

Advance Settings

These features help the user specify custom conditions during integration configuration.

1. Click the Configure Advance icon to define custom configuration settings. A pop-up windows appears on the right.

2. Within the pop-up window, there are two tabs: Forward Advance Settings and Backward Advance Settings. When you select the Forward Advance Settings tab, you specify configuration settings for System 1. When you select the Backward Advance Settings tab, you specify configuration settings for System 2. Here you can define following key parameters.

Integration Configuration Image 19a.png
Integration Configuration Image 24a.png

Global Settings

The Global level settings allows customizing default behaviour of integration for all mapped entity types. When The Global level setting button is clicked, the Global level advance configurations pop-up opens on the right. In the given pop-up, the Entity Id Field Name, the Link Field Name, and the Sync Field Name for the integrated systems can be selected and common parameters such as Max Retry Count and Associate Schedule can be set at once.

  • Entity ID Field Name: Set this to a custom text property available in the end system. Ensure the field is available in all entity types in a given integration. If set, this will sync Entity id of other system in the system for which it is set. For example, if Entity id field name is set for Jira then once entity is created in VSTS or in Jira, integration will be set for VSTS Entity id (bug id, requirement id, etc.) in this field.
  • Link Field Name: Set this to a custom text property available in the end system. Make sure that the field is available in all entity types in a given integration. If set, this will sync Entity web URL of other system entity in the system for which it is set. User can click on the link and access the entity of other system directly, instead of going to end system and searching for it. For example, if Link field name is set for Jira then once entity is created in VSTS or in Jira, integration will set VSTS entity URL (https://<companyname>.visualstudio.com/project/_workitems/edit/84701) in this field.
  • Sync Field Name: Set this to a custom text property in the end system. Make sure that the field is available in all entity types in a given integration. If set, integration will maintain time of last successful sync for every entity in the selected text field. The time here will represent the audit time till when the changes are successfully synced to target. Any change done after that time is not synced.

Common sections

  • Max Retry Count: Set the maximum number of times the failed events should be retried. The default value is 3.
  • Associate Schedule: Set an interval at which the data between the source and the target systems should be synchronized. The default schedule is 1 Minute Schedule.
Global Level Confg.png

Once the Global level settings are configured, continue with other configurations.

Maximum Retry Count

Click the Configure Advance icon > Go to Advance Configuration pop-up> Select Override parameters for read operations > Go to Maximum Retry Count.

Sync Only Current State

Click the Configure Advance icon > Go to Advance Configuration pop-up> Select Override parameters for read operations > Sync Only Current State.

From the Sync only current state drop-down list, select No if you want to synchronize the selected entity along with its history. Select Yes if you only want to synchronize the current state.

Note.jpg This feature is available only for selected connectors. If you want to request for this feature, please contact your sales/support point of contact.

These fields are shown in the image below.

Integration Configuration Image 7a.png

Skip Absent Field

Click the Configure Advance icon > Go to Advance Configuration pop-up> Select Other configurations > Go to Skip Absent Field.

The Skip absent field allows OpsHub Integration Manager to skip the fields for the selected entity from source system which are not present in target system. Select Yes or No from the Skip Absent drop-down list accordingly.

Action on Entity Deleted in Target

Click the Configure Advance icon > Go to Advance Configuration pop-up> Select Other configurations > Go to Action on Entity Deleted in Target.

From the Action on entity deleted in target drop-down list, select Create Failure, Recreate or Skip Update depending on the action you want to take when the synchronized entity is deleted from the target system.

  • When you select Create Failure, failure is created when the selected entity has been deleted from the target system.
  • When you select Recreate, entity is recreated in the target system when the selected entity has been deleted from the target system.
  • When you select Skip Update, no action is taken when the selected entity has been deleted from the target system.

Associate Schedule

Click the Configure Advance icon > Go to Advance Configuration pop-up> Select Other configurations > Go to Associate Schedule.

From the Associate Schedule drop-down list, select an interval at which you want to synchronize the data between the source and the target systems. The default schedule is 1 Minute Schedule.

Sync New, Failed, or Both Events

Click the Configure Advance icon > Go to Advance Configuration pop-up> Select Other configurations > Go to Sync.

  • Select 'New Event' when you only want to synchronize events that are new.
  • Select 'Failed Event' when you only want to synchronize events that are failed.
  • Select 'Both (Failed and New Events)' when you only want to synchronize failed as well as new events.

These fields are shown in the image below.

Integration Configuration Image 8a.png

Tracking ID and Link

Click the Configure Advance icon > Go to Advance Configuration pop-up> Select Override parameters for write operations > Go to Remote Entity Id Field Name and Remote Entity Link Field Name.

  • Remote Entity ID Field Name: The Remote Entity ID field keeps a track of the relationship between the unique id of the selected entity in the source system and the target system. For example, Bug No. 123 from the source system was synchronized in the target system as Bug No. 1245, the Remote Entity ID field will save this information. From the Remote Entity ID Field Name drop-down list, select the field in which you will like to save this information.
  • Remote Entity Link Field Name: The Remote Entity Link field keeps a track of the navigation path to the selected entity in the source system. From the Remote Entity Link Field Name, select the field in which you will like to save this information.

Integration Configuration Image 9a.png


Search in Target Before Sync

Click the Configure Advance icon > Go to Advance Configuration pop-up> Select Override parameters for write operations (Destination) > Go to Search in Target Before Sync.

Integration Configuration Image 10a.png


The Search In Target Before Sync feature allows OpsHub Integration Manager to search whether the selected entities from the source system already exist in the target system, and if yes, the what is the course of action that should be followed.

If you select No from the Search In Target Before Sync drop-down field, then OpsHub Integration Manager will rewrite over the already existing entities. If you select Yes, you will have to define the course of action that OpsHub Integration Manager should take when matching entities are found in the source and the target systems.

Once you select Yes, three drop-down options appear: What if multiple entities found in Target System matching above Query?, Continue sync to the entity matching above query, and If no entity found matching above query.

  • In the What if multiple entities found in Target System matching above Query? drop-down list, select Continue with the first entity found if you want to update the existing entity in the target system or Fail the sync so that OpsHub Integration Manager can notify that a matching field exists in the target system.
  • In the Continue sync to the entity matching above query drop-down list, select Yes if you want OpsHub Integration Manager to update the existing entity in the target system. Select No if you want to OpsHub Integration Manager to skip the existing entity in the target system.
  • In the If no entity found matching above query drop-down list, select Create new entity in the target if you want to create a new entity in the target field if the search query doesn't yield any matching results. Select Skip the event if you want OpsHub Integration Manager to ignore this search information and not take any action.

Workflow Association

Click the Configure Advance icon > Go to Advance Configuration pop-up> Select Workflow Association.

Integration Configuration Image 11a.png


OpsHub Integration Manager provides default workflow, which comes with default installation. If you want a customized workflow, please contact your sales/support point of contact.

  • Select Create option if you don't want to synchronize new entities created in the source system.
  • Select Update option if you don't want to synchronize those entities that are updated in the source system.

Click the Integrate button to complete the integration process.

Managing Integrations

  • Click the exclamation mark icon against an integration name to perform multiple actions on the integration.


Integration Configuration Image With Export.png


  • Delete Integration: Delete the selected integration
  • Configure Reconciliation: Set reconciliation rules
  • Clone Integration: Create a copy of the selected integration
  • Execute Integration: Execute all the settings defined in the selected integration
  • Failure Notification: Allow OpsHub Integration Manager to send failure notifications after the integration is active
  • Activate/Inactivate Integration: Activate or Inactivate the selected integration
  • Edit Integration: Open the integration in a view mode and get an option to edit it

Note.jpg Always inactivate an integration to be able to edit it.

Integration Configuration Image 27a.png

Some of these actions: Activate/Inactivate, Execute, Failure Notification can be performed as a bulk operation for multiple integrations. You can also select multiple integrations and move them to another folder.