Tririga Configuration for Envizi Integration
Table of Contents
Overview
This solution adds four fields that hold the group name values and the path for the integration. It also makes sure that the payload is sent when there is an update.
Security Role Configuration
In order to properly configure Tririga, a user needs to be configured with the proper security access for Object Migration and Tririga APIs
Object Migration Access
Object Migration is a task managed by administrators. If a Tririga User needs to have full access to Object Migration in Tririga, access is granted at the group level. Follow the steps given in Chapter 1 to create a new security group.
- Select the newly created group or desired existing group and switch to the Access tab and add the appropriate access for importation of Object Migration Packages. There are 2 panes in Access: Object and Permissions.
- Scroll and find the Object Migration Object on the left pane and click Full Access on the right pane. The users in this group, granted through the Members tab, will be able to import the Tririga API Object Migration package.
Access Permissions
Additional information on Tririga Security groups
Import OM Package
Import the most recent OM Package into the Tririga instance. Go to Tools -> Administration -> Object Migration and select New Import Package to begin the import process.
Please refer to official IBM® Tririga documentation for more information on Object Migration
Tririga API User Access
In order for AppConnect to be able to use Tririga APIs, it will need a user with certain permissions. These user's credentials will be configured in App Connect.
-
Create a new user by following the steps given in Chapter 2.
-
Choose a security group or create a new group (refer to the above OM Migration steps if a new security group needs to be created) and add the newly created user to it.
-
Add the permissions below for the new user's group:
| Module | Business Object | Permissions |
|---|---|---|
| Location | triBuilding | Read |
| triAPIConnect | triAPICTimestamp | Read and Update |
- Follow the steps given in Chapter 1 and add any one of the licenses below for the new user's group:
a. IBM TRIRIGA Portfolio Data Manager
b. IBM Facilities and Real Estate Management on Cloud Self Service
c. Any other license that grants access to the modules
Please refer to the TRIRIGA Documentation on Security and Licenses for additional information.
The user will now be able to interact with the proper Tririga Modules.
Outbound Traffic from Tririga
For outbound traffic from Tririga, grant at least READ access on the Business Objects that will be used. The table below shows the various supported business Objects the API can pull from:
| Module | Business Object Label |
|---|---|
| Asset | Building Equipment |
| Classification | Request Class |
| Classification | Space Class Current |
| Classification | Asset Spec Class |
| People | People |
| Location | Property |
| Location | Building |
| Location | Floor |
| Location | Space |
| Organization | Organization |
| Request | Service Request |
| Task | Work Task |
In the example below, the API user is able to pull data from the Building Business Object:
Inbound traffic to Tririga
For inbound traffic, Data Access needs to be enabled as well as Application Access permissions to the triAPIConnect Module or the individual Objects. To enable an API user to create a building, grant access to the triAPICBuilding Business object as shown below:
Minimum requirements
For users to pull from these URLs, the minimum requirements are:
| URL | Requirement |
|---|---|
| GET /oslc/spq/triAPICOutboundBuildingQC | READ access to triBuilding Business object |
| GET /oslc/spq/triAPICTimeStampQC | READ access to triAPICTimestamp Business Object |
| POST /oslc/so/triAPICTimeStampRS/ |
Write access to triAPICTimestamp Business Object |
Group Name Configuration
Data Modeler
Go to Tools -> Builder Tools -> Data Modeler and using the Object Browser navigate to Location->triBuilding.
Revise the BO and add four fields: cstEnviziParentOneTX, cstEnviziParentTwoTX, cstEnviziParentThreeTX and cstEnviziGroupNamePathTX
Name and Label should be the following:
| Name | Label |
|---|---|
| cstEnviziParentOneTX | Envizi Group 1 |
| cstEnviziParentTwoTX | Envizi Group 2 |
| cstEnviziParentThreeTX | Envizi Group 3 |
| cstEnviziGroupNamePathTX | Envizi Path |
After entering these values, click 'Publish' to publish the BO
Form Builder
Under Tools -> Builder Tools -> Form Builder, click on the Location module on the left side of the screen and then click on triBuilding.
Revise the triBuilding form by clicking 'Revise' in the top right corner of the pop-up
In the Navigation pane on the left side of the screen, click on triBuilding and then 'Add Tab'. Enter "cstEnvizi" as the 'Name' and 'Envizi' as the Label. Click Apply
Select this new tab and click on 'Add Section'
Enter "cstEnviziDetails" as the 'Name' and "Envizi Details" as the 'Label'. Click 'Apply'.
Now click on the newly created Section and select 'Add Field'. Select each of the four created business objects from the previous step as fields under "Envizi Details".
Select 'cstEnviziGroupNamePathTX' and modify 'Start Row' to 3 and 'Col Span' to 2 on the properties window. Mark this field as "ReadOnly" and click 'Apply'.
The form should look like this:
Click on triBuilding on the left panel and then click on 'Sort Tab'. Move the 'cstEnvizi' tab to the second position and click 'Apply'
Publish the form
Object Migration
Go to Import Migration and import package EnviziConfig.zip
To do that, click on New Import Package, and select the zip file and click Ok.
A new window will be displayed. If it is not displayed, just select the package from the list.
On this package, click on Validate and wait for the validation to complete. If no errors are displayed, import the package.
Security Manager
Go to Tools -> Administration -> Security Manager
This application sets who can and cannot access this newly created tab. Click on the desired group, and navigate to the 'Access' tab
On this tab select Location -> triBuilding -> cstEnvizi
Choose the access level for the group and 'Save'
Workflow Builder
Go to Tools -> Builder Tools -> Workflow Builder. Select Location -> triBuilding.
Within the Location object, search for the existing Workflow "triBuilding - Synchronous - Permanent Save Validation".
Revise this workflow and after Call Module Level Validation add a new WF call to "triBuilding - Update Envizi fields with defined options" like displayed below:
It will be defined as the image below:
Click on the 'Start' task at the top and publish the workflow
My Reports and OSLC
Go to My Reports and navigate to 'System Reports'. Add those four new fields to the existing query "triAPICBuilding - OSLC -- Outbound" by clicking the 'Columns' tab and adding the four fields like below:
Save the report.
Open Tools -> System Setup -> Integration -> OSLC Resource manager and search for "triAPICOutboundBuildingRS". On this resource, add the four new fields either individually or using 'Import all Fields'
Navigation Builder
Go to Tools->Builder Tools-> Navigation Builder and find TRIRIGA Global Menu(or the menu associated to the user that will need access to the app). Select and click Edit
On navigation Items section, expand Landing Page –Tools -> Menu Group –System Setup. Select Menu group –Integration and expand Navigations Item Library
Search for Envizi, select the item and click on Add to Collection
Click Save. Logout and Login again to the system
How to use
Time Stamp Pre-requisite
The triAPICTimestamp is a tririga record needed to set the baseline for when API connect runs for the first time.
To enable this functionality go to My Reports -> System Reports and search for Timestamp in the 'Name' section. Run the system report "triAPICTimestamp – Display – Manager Query" as shown below:
Click Add, and create a new record without details, as shown below, and close it
The default date and time the record gets automatically applied to the record, and consequent opening of the record shows the default date and time as shown below:
Using the Integration
This tool will allow user to make changes on this new Envizi group name fields. But we must consider the existing records too. If you want those records to be populated, there is a patch helper workflow that can handle that.
The first this that must be defined is which fields will be used to populate groups 1, 2 and 3 to be used on envizi. To access the envizi tool, go to Tools -> System Setup -> Integration -> Envizi Integation.
When you open the page, the fieldswill be displayed as group1/group2/group3. By default the values are World Region/Country/City. The field Envizi Hierarchy Path shows how the envizi groupnames will be configured according to the selected option.
Enable Envizi checkbox is available too. The envizi tab will be displayed only when this checkbox is marked
One more item that must be configured is the Number of levels to be used on the envizi configuration. Envizihierarchy path will match this selection.
Also, notice that there is a section named “Active/Retire with missing data”and “Draft/Revision with Missing Data”. This section will list the buildings that don’t have data defined for envizi group 3, so it means that no envizi group will be populated on those buildings.
You can filter to change only the desired records by changing query “cst -triBuilding -Query -Get All Buildings for envizi”. The list of buildings displayed on this query will be the listof buildings that the patch helper will modify.
To use the tool, just select the desired envizi group names and click Save. On the moment Save is triggered, all buildings will be populated with the desired options. This process may take a few minutes depending on how many buildings you have on your system. After that envizi groups and path will be updated according to the selections made on Envizi Integration page.
Also, every time a building is saved and there are changes on the defined fields, or a new building is created, the envizi groups and path will be modifiedaccording to the selected options. You can find the groups on tab Envizi on the building record