Integration between two systems (i.e. BSS platform and a third-party system) is a very common practice in the industry. However, since integrations may malfunction at times for various reasons, we have launched a reporting tool that helps the BSS user to check the integration framework between the two systems, and more specifically, to check the synchronization of entities.

The main features that the Integration Framework Report offers are:

1. Depicting which entity failed and why.
2. Depicting the relation of two entities between the two different systems.
3. Allowing to apply corrective actions such re-syncing or breaking the relationship between our platform record and the third party system.

Locating the Integration Framework Report

The report page can be found under: BSS Setup > System Options > Integrations Systems.

For each available integrated system that is activated and is therefore displayed under the "Enable Connectors", a Report button will be displayed, as per the following screenshot, and no other action is required of you.

Interacting with the Integration Framework Report

After the first synchronization, once the Report button is clicked, you are transferred to the report page. All the relevant information, concerning the integration framework which contains the entities, are being displayed on the following list.

• Instance: Is the name of the instance of the Integration Provider.

• Module: The data that can be sent during an integration belong to specific Modules. This column contains all the available modules (as a predefined list). A specific Integration Provider cannot send/receive data for Accounts for example. However, in this list, the "Accounts" module will be displayed. If selected via the filter, empty results will be displayed.
  

• Internal ID: Is the ID of each entity that is displayed on our platform. This field is linked to the details of the related BSS record (e.g invoice or account).
  • Internal ID for invoice or order items: For invoice or order items, this field has as value the ID of the related invoice or order. This facilitates the search for the records of a specific invoice or order since the result set will include its items too.
• Integration ID: Is the ID of the entity on the third-party system.
  • Integration ID for invoice or order items: For invoice or order items, this field has as value the ID of the related record of the external system. This facilitates the search for the records of a specific invoice or order since the result set will include its items too.
    
• Status: The synchronization status for the specific record.
  • success: This means that a link has been created between the two entities in the two systems.
  • failed: This means that a connection between the two entities was either not created or not updated during the sync of the two systems.
• Comment: This column has values for the invoice and order items:

  • For Invoice Items. It displayed invoice items' product Name, quantity and billing cycle.

  • For Order Items. It displayed order items' product Name and quantity.

• Exception: The fields of this column are populated only if the status is failed. If so, they contain the reason for failure. It could be an error from the third-party system or an error on our side.The exception message is clickable and a pop-up window is displayed with the full message

• Sync date: Is the date that the connection was established or got updated. It is displayed on the timezone of the BSS User that views the report.

Searching and Filtering Options

You can use the following options for narrow your results set:

1. Date Selection Fields. They are placed at the beginning of the page and you can use them for searching for a specific period.
2. Columns Filtering. Filtering is available for the columns Instance, Module, Internal ID, Integration ID and Status. 

3. Multi-Sorting Capabilities. All columns have sorting capabilities and you can sort the results using multiple columns

Export to Excel

The results of the reporting tool can be exported to an excel file. The option is located in the top left corner. 

Available Actions

The actions that are available for the records the connector synced with the third party system are the following:

• Break Link (available for both success and failed records). This action removes the connection between the BSS record and the third party system. After executing this action, the BSS record will be considered unsynchronized and the connector will try to push it to the third party system the next time it runs the PUSH Create action.  
• Synchronize (available only for failed records). This action will retry the connection between the two entities.