This document explains the Environments View in ONEiO covering these three main topics:
- Overview - Environments view page breakdown: An overview of the objects in the QA and PROD environments. Objects is a collective term for Endpoints, Entity Types, Message Types, and Routing Rules
- Sync Status: The sync status of the environments to highlight if there are differences between the QA and PROD environments in relation to Endpoints and Routing rules.
- Difference View - Endpoint JSON Structure / Routing Rule JSON Structure : A view to quickly assess the differences of changes of these objects in order to determine changes that need to be synced from the QA to PROD and vice-versa if needed.
In case you have questions related to setting up the integration, send a mail to firstname.lastname@example.org.
Overview - Environments view page breakdown
The Environments View is designed to present an overview of the differences in the environments regarding the various objects of the Environment components:
- Entity Types
- Message Types
- Routing Rules.
image (1) - An Overview of the Environments view
- Environments icon: Access the Environments View by clicking on this icon ().
- An endpoint object displaying collapsible rows of Entity types, Message types, and Routing Rules. It also shows their sync statuses in QA and their equivalents in PROD.
- Entity type Incident in the QA endpoint.
- The Message type object shows all the message types belonging to a specific Entity type. In this example, the Entity type Task in QA has three message types: AddAttachment, AddLink, and SetTransition.
- The Routings rules object contains all Routing Rules related to the patent Entity type. This example shows all rules related to the Entity type Task in QA and PROD environments.
A Closer look at Routing rules
Just as we have actions that define what happens when a rule is matched, there are visual indicators for these types of rules by the actions that they are defined:
- Route to the target: Two arrows, one pointing to the left and another pointing to the right, followed by the rule's name and the endpoint icon. Hovering over the endpoint icon shows the endpoint name and related entity.
- Process-only / Drop message rules: These kinds of rules do not have an outbound endpoint, so, no outbound endpoint icon is shown.
- Response rule: The icon iO containing a curve arrow pointing to the left() indicates a response rule.
There are three columns in the Environments view: The left column shows the QA Environment, the middle column shows the Sync Status and the right column shows the PROD Environment.
image (2) - Environment states
The sync column can show three main states:
1. Synced state () icon is shown when a specific endpoint, entity type, message type, and/or a routing rule in QA has an equivalent pair in the PROD environment and the configurations are the same.
2. Out of Sync () icon is shown when a specific endpoint, entity type, message type and/or a routing rule in QA has an equivalent pair in the PROD environment but the two objects have differences in the configurations making them out of sync.
Clicking on the icon out of sync and on See differences will open the Endpoint structure or the Routing rule structure where you can see the difference between both environments.
- You can find details about this view in the topic: Difference View - Endpoint JSON Structure and Routing Rule JSON Structure.
3. No paired object () is shown when there are no paired Endpoints / Entity Type / Routing Rule / and/or Message Types. It means that the object containing this icon only exists in one environment: QA or PROD.
The labels in the image (2) - Environment states means:
- Label 3 - The Routing rule Jira demo - Zendesk demo - Attachments exists in QA environment but does not exist in PROD environment.
- Label 4 - The MS Teams - Incident endpoint object, containing the Entity types Message and ResponseAdded, and one routing rule related to the ResponseAdded Entity.
- The icon Out of Sync () is shown in the Endpoint object, Message object, and ResponseAdded object, meaning these objects have differences in QA and PROD environment.
- Label 5 shows an example of the icon No paired object (), in this case, meaning that the Routing rule Teams Form - ServiceNow -initialize queue exists in PROD but does not exists in QA.
Difference View - Endpoint JSON Structure / Routing Rule JSON Structure
When objects are out of sync, clicking in the out of sync icon () and on See differences will show the Endpoint structure or the Routing rule structure in QA and PROD environments, side by side, where you can pinpoint the differences between the two environments.
Here is an example of the difference View, showing a JIRA endpoint JSON structure in the QA and PROD environments:
image (3) - Difference View - Endpoint
- This is a read-only editor on both the QA and PROD sides.
- Within the editor, you can scroll to the particular location where the differences are.
- You can also directly click on the blue indicator(s) in the scroll navigation section to directly view the differences.
An example of a Routing Rule structure in the QA and PROD environments:
image (4) - Difference View - Routing Rule
Note that the compared routing rules are the current version in use, not necessarily the latest version.
- For example, if the rule in QA environment has 10 versions (version 10 being the newest) and you have set the current version to be version 8, the rule version in the environments view will be version 8.