IBM 10.3.1 TRIRIGA Connector User Guide
விளம்பரம்
விளம்பரம்
IBM TRIRIGA
Version 10.3.1
© Copyright IBM Corp. 2011
Connector
User Guide
i
Note
This edition applies to version 10, release 3, modification 1 of IBM® TRIRIGA® and to all subsequent releases and modifications until otherwise indicated in new editions.
© Copyright International Business Machines Corporation 2011, 2013. All rights reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with
IBM Corp.
Contents
CONNECTOR FOR ESRI GEOGRAPHIC INFORMATION SYSTEM ...................... 23
About This Guide
This user guide describes the procedures for implementing IBM TRIRIGA connector products.
Conventions
This document uses the following conventions to ensure that it is as easy to read and understand as possible:
Note
– A Note provides important information that you should know in addition to the standard details. Often, notes are used to make you aware of the results of actions.
Tip
– A Tip adds insightful information that may help you use the system better.
Attention –
An attention notice indicates the possibility of damage to a program, device, system, or data.
Intended Audience
This document is intended for people who are implementing one of the IBM TRIRIGA connector products.
Prerequisites
This guide assumes that the reader has a basic understanding of the IBM TRIRIGA Application Platform and the fundamental concepts required to operate the web-based IBM TRIRIGA system.
Support
IBM Software Support provides assistance with product defects, answering FAQs, and performing rediscovery. View the IBM Software Support site at www.ibm.com/support .
© Copyright IBM Corporation 2011, 2013. 1
1. ENERGY STAR Connector
Executives require a mechanism to evaluate the energy performance of their building portfolio. They require the ability to compare the energy performance rating of buildings to other buildings within their portfolio as well as to the average of similar buildings. From these ratings, executives set targets for improving the ratings of their buildings and evaluate the potential savings if they meet their targets. By comparing the current ratings to the targets, managers prioritize buildings that maximize return on investment by comparing potential savings to costs of efficiency opportunities.
The EPA ENERGY STAR rating provides the de facto industry standard for energy performance ratings in the United States. The 1 - 100 scale makes it easy for executives and managers to understand the performance of their buildings. The rating system considers attributes of each building by space type, as well as the energy usage and monthly weather data for each building region.
Implementing the IBM TRIRIGA Connector for Energy Star Benchmarking involves the following steps:
1.
2.
3.
4.
Setup
A few activities must be undertaken as the first steps of implementing the IBM TRIRIGA Connector for
Energy Star Benchmarking. These activities focus on tailoring classifications; updating building, structure, and retail location records; and establishing system-wide defaults.
Setup activities should be performed in the following areas before starting to use the IBM TRIRIGA
Connector for Energy Star Benchmarking. There is no recommended sequence of activities. All activities listed are important.
Energy Rating Type Classification
Energy Space Type Classification
Location (Building, Retail Location, Structure)
Location Primary Use Classification
© Copyright IBM Corporation 2011, 2013. 2
Energy Rating Settings
Set the default Energy Rating Settings for the system in the Integration Settings tab of Application
Settings, which is located in
Tools > System Setup > General > Application Settings. See the IBM
TRIRIGA 10 Application Administration User Guide for details.
Note
– These are global settings. The Energy Rating Settings on the Integration Settings tab apply to the entire IBM TRIRIGA system.
The system attempts to integrate with the EPA ENERGY STAR Automated Benchmarking System on the periodic schedule set in Retry Every (hours). If the system does not receive an actual rating from the
EPA ENERGY STAR Automated Benchmarking System, the system tries again until it reaches the number specified in the # of Retries field or the EPA ENERGY STAR Automated Benchmarking System returns an error.
Energy Rating Type Classification
Classifications are records presented in a hierarchical fashion. If the type of field is classification, a record in the Classifications hierarchy can be chosen as the value of the field. For an in-depth discussion of Classifications and the Classifications hierarchy, see the IBM TRIRIGA 10 Application
Administration User Guide.
The Energy Rating Type identifies the rating system used. For the IBM TRIRIGA Connector for Energy
Star Benchmarking, use the Energy Star Energy Rating Type. Energy Space Types are associated to an Energy Rating Type.
In the Integration Credentials section, Test URL, Test Username, and Test Password display the connection to the EPA ENERGY STAR Automated Benchmarking System test environment. Live URL, Live
Username, and Live Password display the connection to the EPA ENERGY STAR Automated
Benchmarking System live environment.
ENERGY STAR Processing Log
The ENERGY STAR processing log stores failure point information related to the ENERGY STAR rating process. An ENERGY STAR processing log record is created for each error returned by the ABS system in response to a request for an ENERGY STAR rating. The records are associated to the building, structure and retail location for which the ENERGY STAR rating is being processed.
IBM TRIRIGA processes all errors received from ABS ENERGY STAR, creating a record in the ENERGY
STAR processing log object for the error being processed. The record created contains information such as Transaction Date, Transaction ID, Transaction Status, Energy Star Error ID, Energy Star Error Type, and Energy Star Error Description.
On the Environmental tab of building, structure and retail location forms, you can see the fields from the ENERGY STAR processing log in the Energy Ratings section. To open the full ENERGY STAR processing log record, click an entry in the query.
The following section lists and describes each error message and/or alert that ABS returns.
3 © Copyright IBM Corporation 2011, 2013.
18
30
31
101
102
103
12
13
14
15
9
10
11
16
17
7
8
4
5
6
Error Code
1
2
3
Type
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Alert
Error
Error
Description
Defaults were used in calculation of metrics
Less than a full year of energy data
Values exceeded the upper/lower bounds for this attribute
Meter has gaps of more than 1 day of data
Meter has overlaps of more than 1 day of data
Meter has at least one electrical entry period that is greater than 65 days
Less than 50% of floor space is can be benchmarked
The floor area for computer data center is greater than 10% of the total floor space
The floor area for garage is greater than 100% of the total floor space
Space types within the same facility are incompatible
There is no electricity use for the time period specified
There is no energy use for the time period specified
Energy use is greater than the maximum allowable for a rating
Cannot set default attribute value after actual value is provided
Meter data is greater than 120 days old
No metric information available to provide a period ending date
Floor Area for "Other" Space Type Is Greater than 10% of the Gross
Floor Area.
Less than One Full Year of Space Attribute Data
Energy rate for electricity varies by more than 20% from the average rate for this ZIP code
Energy rate for non-electrical fuel varies by more than 20% from the average rate for this ZIP code
No Pending Authorizations for this ESP
Bad Ref_abs_transaction_type.abs_transaction_code
No Customer Objects sent by WebService
© Copyright IBM Corporation 2011, 2013. 4
Error Code
104
105
Type
Error
Error
200 Alert
300
400
8810
8820
8830
8840
8850
11000
11010
11020
11030
11040
11050
11060
8860
8870
8880
8890
8900
9010
Alert
Alert
Error
Error
Error
Error
Error
Error
Error
Error
Error
Error
Error
Error
Error
Error
Error
Error
Error
Error
Description
EspCustID not in PM
An authorization request must have a value for either espCustID or pmCustId.
General building level alert code used for each specific building level alert message.
General meter level alert code used for each specific meter level alert message
General space level alert code used for each specific space level alert message espCustID / pmUserID does not match an authorized User ID espBldgID / pmBldgID does not match an authorized Building ID espMeterID / pmMeterID combination does not match an authorized set of Meter IDs pmSpaceID provided does not match an authorized Space ID pmRECid provided does not match an authorized Renewable Energy
Certificate identifier espBldgID already exists espMeterID already exists espSpaceID already exists
Invalid espSpaceID espCustID already exists
Customer Org Name was not provided for new customer
Building ID cannot be found in system
The unit of measure is incompatible with the fuel type specified
The Space ID does not exist for the facility being updated
The Meter ID does not exist for the facility being updated
The first 3 digits of the zip code are not valid
Cannot respond with metrics for meters set as inactive
Space attribute effective date cannot be later than the current date
© Copyright IBM Corporation 2011, 2013. 5
Error Code
11090
11100
11110
Type
Error
Error
Error
11120
11130
11140
12000
12010
12020
12030
12040
12060
13020
13030
Error
Error
Error
Error
Error
Error
Error
Error
Error
Error
Error
Description
Must specify Warehouse type (Refrigerated or Unrefrigerated)
Future dates not allowed for meter entries
The temporary meter end date cannot be the same as or earlier than the temporary meter start date
The fuel generation method is required for the fuel type specified
The fuel generation method is incompatible with the fuel type specified
A description of the Other fuel type is required
A general error occurred while processing request
The submitted transaction ID is invalid
Transaction currently being processed, please try retrieving results at a later time.
Transaction results already retrieved or expired
XML document is invalid or does not comply with schema
This account is not registered
Internal error occurred. Please resubmit your request or contact technical support
IO error occurred. Please resubmit your request or contact technical support
Energy Space Type Classification
Classifications are records presented in a hierarchical fashion. If the type of field is classification, a record in the Classifications hierarchy can be chosen as the value of the field. For an in-depth discussion of Classifications and the Classifications hierarchy, see the IBM TRIRIGA 10 Application
Administration User Guide.
An Energy Rating Type has attributes for specific use of spaces. Each Energy Space Type contains the energy rating data attributes for that type of space and default values as appropriate. For the IBM
TRIRIGA Connector for Energy Star Benchmarking, the data attributes must correspond to ones used in the EPA ENERGY STAR system. Energy Space Types are associated to an Energy Rating Type.
To see the Energy Space Type records, go to
Tools > Administration > Classifications. Scroll down the
Hierarchy left-side bar and expand the Energy Rating Type section. Expand the Energy Star section, select the Energy Space Type record you want, and click
Open.
© Copyright IBM Corporation 2011, 2013. 6
Once the Energy Space Type record is opened, you can add data attributes by clicking Add or Find
Using Template on the Data Attributes section.
Attention
– If you change a data attribute name or add a data attribute, you must make a corresponding change to the interface configuration that defines the mapping between the IBM TRIRIGA Connector for Energy Star Benchmarking and the EPA ENERGY STAR
Automated Benchmarking System. The file is named energyStarAttrMapping.xml and
is in the Energy Star ClassLoader. For more information, see Energy Star ClassLoader .
To Add Data Attributes to an Energy Space Type
Step 1
Click
Add on the Data Attributes section bar.
The system opens the Data Attribute Item for Energy Star form.
Step 2
In the General section:
The system generates the ID and Status when the record is created.
Specify a value for the Name and the Description fields.
If this data attribute is required in order to receive a rating, select the Required check box.
Select the Field Type from the drop-down box.
Specify a default value in the Data Value filed.
Other fields may be present depending on the Field Type selected.
Step 3
Click Create.
The system adds the new data attribute to the Energy Space Type Data Attributes section.
Location
ENERGY STAR ratings can be done for buildings, structures, and retail locations. The Locations hierarchy is located in the Locations portal section on the Portfolio page. For information about the
Locations hierarchy, go to the IBM TRIRIGA 10 Information Center and select Managing portfolio data.
Several fields in a building/structure/retail location are used by the IBM TRIRIGA Connector for Energy
Star Benchmarking.
In a Location record, in the Details section on the General tab, the Primary Use field contains a value
from the Location Primary Use classification, as described in Location Primary Use Classification .
The fields in the Energy Rating Setup and Energy Rating Result sections specifically relate to the IBM
TRIRIGA Connector for Energy Star Benchmarking.
The Geography for the address of the location must include a State Geography record that contains a valid two-letter abbreviation for the state as the ID field of that record. The two letter state is required by ABS so that it can correctly categorize the location in its ranking algorithms and is
7 © Copyright IBM Corporation 2011, 2013.
submitted to them from this field in the associated record. Without this correct linkage, any new buildings submitted to ABS will be rejected.
In the Environmental tab, data from most sections are used for ENERGY STAR ratings. Previous ENERGY
STAR ratings for a Building, Structure, or Retail Location are displayed in the Energy Ratings tab.
Location Primary Use Classification
Classifications are records presented in a hierarchical fashion. If the type of field is classification, a record in the Classifications hierarchy can be chosen as the value of the field. For an in-depth discussion of Classifications and the Classifications hierarchy, see the IBM TRIRIGA 10 Application
Administration User Guide.
To view the records available in as Location Primary Use, go to Tools > Administration > Classification.
Scroll down the Hierarchy section until you find the Location Primary Use section, and expand it. Select the record you want and click Open.
The Location Primary Use includes one or more Energy Rating Type and Energy Space Type values. For each energy rating record created, the system captures the associated energy space types using the
Location Primary Use of the Building, Structure, or Retail Location.
In the Energy Space section, Subtype further defines the Energy Space within the Energy Rating Type.
For the IBM TRIRIGA Connector for Energy Star Benchmarking, the Energy Rating Type must be Energy
Star
.
Meter
Define the meters used to record energy rating data in the Building Equipment business object.
To find the Building Equipment page navigate to Portfolio > Assets > Building Equipment. For information about the Assets page, go to the IBM TRIRIGA 10 Information Center and select Managing
portfolio data.
See Appendix B for allowed values in ENERGY STAR attributes and meters.
The Spec Class is Utility Meter, which is in the Operations Specification Class, under
Instrumentation and Controls.
ENERGY STAR ClassLoader
Set the ClassLoader Type field in your ClassLoader instance to Parent First.
To Access the ENERGY STAR ClassLoader
Step 1
Select Tools > System Setup > System > Class Loader.
Step 2
Open the ENERGY STAR record. The system opens the ENERGY STAR ClassLoader form.
Make sure that the Resource Files section contains only the following libraries and dependencies:
© Copyright IBM Corporation 2011, 2013. 8
energyStar.properties
This file is used to define several runtime parameters used for the ENERGY STAR integration.
Inside this file you will find parameters for which URL to use, where to find the XSD schemas to validate against, what resource file is used to define the translation and ordering of the
DataAttributes for SpaceTypes, as well as the UOM translation between IBM TRIRIGA and ABS.
This file is heavily commented with what each parameter is used for and what options you have for modifications. This file cannot be renamed. It is referenced in the code to find all other runtime attributes for this integration.
energyStarClient.keystore
This file was provided by ENERGY STAR and is required in order to make an SSL connection to
ABS.
energyStarAttrMapping.xml
This file defines the DataAttribute mapping between IBM TRIRIGA objects and the ABS XML schema elements used to be sent to ABS. The name of this file can change but must be reflected in the energyStar.properties file. The ordering of the attributes define the order that the SpaceTypes are created in the XML sent to ABS. The XSD from ABS requires that these elements be in a precisely defined order otherwise the submission will fail.
energyStar.jar
This is the JAR file where the classes for the ENERGY STAR connector reside. The Java stubs for connecting to the ABS website, defined by the WSDL provided by ENERGY STAR, also are included in this package and were created by using JDK 1.5 with the Java2WSDL class from
Apache Axis 1.3. The axis.jar file is not included in this package because it exists in the server library classpath.
You must include the dependent libraries as resource files to this ClassLoader object. The libraries required can be retrieved from the ABS Client_tool package at http://estar8.energystar.gov/ESES/ABS20/ClientTools/ClientTool_Test.zip
. You may need a valid ABS account to log in.
Note
– If you modify the name of the ENERGY STAR ClassLoader file, or use a different
ClassLoader file for your ENERGY STAR processing, you must change the following workflows:
• triEnergyRating - Synchronous - Submit Transaction Process
• triRatingTransactionStatus - SCHEVENTSTART
• triRatingSchedule - SubmitHidden - Submit Transaction Process
Notifications
The IBM TRIRIGA Connector for Energy Star Benchmarking can send out notifications internally and to external email accounts with the use of an Integration Notification object. You can use this object to set up templates for notification types that can contain groups, persons, or both, that should be notified if an error, alert, or warning of the specified type occurs.
To Set Up Templates for Notification Types
Step 1
Navigate to Sustainability > Set Up > Templates > Integration.
9 © Copyright IBM Corporation 2011, 2013.
To Set Up Templates for Notification Types
You should see three Integration Types.
Energy Rating: This is for general messages and system failures.
Energy Rating Alert: This is for any alert responses that come back from ABS for buildings, meters, or space types.
Energy Rating Error: This is for any error responses that come back from ABS for buildings, meters, or space types.
Note
– If you do not see these three, you must add them for the notifications to work.
Step 3
Depending on the message type, the ENERGY STAR integration will create an instance of an Integration Notification using one of these types. Most occasions will use
Energy Rating
.
IBM TRIRIGA contains workflows that fire when an Integration Notification is created.
These workflows dynamically attach an Integration Notification to the IBM TRIRIGA notification engine, which sends out emails and internal notifications.
Debugging
The energyStar.log helps diagnose problems while testing or even if in a production environment.
The energyStar.log is located in the <IBM TRIRIGA_INSTALL_DIR>\log folder. You can enable debugging for Energy Star in the Administrator Console under Platform Logging > Energy Star. The error messages can be verbose as they will print out the request and responses to and from ABS.
Baseline Locations
Baseline data provides a set of initial energy rating values for a building/structure/retail location. You can tell the system to baseline an individual building/structure/retail location from the Energy Rating
Setup section or to baseline a collection of buildings/structures/retail locations from Sustainability >
Set Up > General > Baseline and Target Setup.
Baseline a Building/Structure/Retail Location
Follow the steps below to establish baseline energy rating values for a single building/structure/retail location.
To Establish Baseline Energy Rating Values for a Single Building
Step 1
Navigate to the form for the building/structure/retail location.
Step 2
Scroll to the Energy Rating Setup section.
Step 3
Make sure that Energy Rating Type is set to Energy Star.
© Copyright IBM Corporation 2011, 2013. 10
To Establish Baseline Energy Rating Values for a Single Building
Step 4
Set Baseline Date to the date the baseline data represents.
Step 5
Set Baseline Rating to the ENERGY STAR rating on the Baseline Date.
Step 6
Click Set Baseline on the Energy Rating Setup section bar.
The system sets the baseline value from the most recent Energy Rating from the
Baseline Date given. If the baseline date is not provided, the system sets the baseline date and value from earliest Energy Rating record.
Baseline Buildings/Structures/Retail Locations
Follow the steps below to establish baseline energy rating values for several buildings/structures/retail locations.
To Establish Baseline Energy Rating Values for Several Buildings/Structures/Retail Locations
Step 1
Navigate to Sustainability > Set Up > General > Baseline and Target Setup.
Step 2
Click
Add.
Step 3
In the General section of the Baseline and Target Setup form:
The system supplies an ID and Status when the record is created.
The Date Created is the current date.
Enter a unique Name for the Baseline or Target.
Select the Process Type (Baseline or Target) from the drop-down list.
Step 4
If Process Type is Baseline, enter the Baseline Date.
The system sets the baseline value from the most recent Energy Rating from the
Baseline Date given. If the Baseline Date is not provided, the system sets the baseline date and value from earliest Energy Rating record.
Step 5
If Process Type is Target, enter the Target Date and Target Rating.
Step 6
In the Locations section, click Find and select the buildings, structures, and retail locations to which the Baseline or Target applies.
Step 7
Click
Create Draft and click Apply.
Request Ratings
You can schedule or manually request ratings from EPA ENERGY STAR.
© Copyright IBM Corporation 2011, 2013. 11
Schedule Ratings
A rating schedule creates an Energy Rating record automatically for each Building/Structure/Retail
Location listed in the rating schedule.
To Establish a Rating Schedule
Step 1
Navigate to Sustainability > Set Up > General > Energy Rating Schedule.
Step 2
Click
Add.
Step 3
In the General section of the Rating Schedule form:
The system supplies an ID and Status when the record is created.
The Recorded Date is the current date.
Enter a unique Name.
Energy Rating Type must be Energy Star.
Select the Frequency (Monthly, Quarterly, Semi-Annual, or Annual) from the drop-down list.
Enter the appropriate value in Number of months of energy logs to use. The default value is 12, which is the minimum value.
Tip
– The data sent to EPA ENERGY STAR must include consecutive data for each day this time period with no gaps or overlaps in time.
Step 4
The other fields in the General section depend on the value for Frequency. In this example, Frequency is Annual.
Month is the month the record becomes active.
Day of Month is the day the record is processed.
Set Submit After to be the number of days after the record becomes active that the system is to submit the record to EPA ENERGY STAR. Click the Calendar icon
to set the value.
Tip
– While Submit After can be 0, set it to a value that allows time to adjust any data attributes that have changed.
The system sends a notification when the record for a building/structure/retail location is ready. This gives you time to adjust the data attributes on the building/ structure/retail location if any changes occurred.
Start Date is the first date in the frequency range. The value must be greater than or equal to the current date. Click the Calendar icon to set the value.
End Date is the last date in the frequency range. The value must be greater than
12 © Copyright IBM Corporation 2011, 2013.
To Establish a Rating Schedule
or equal to Start Date. Click the Calendar icon to set the value.
Initially the system sets Next Scheduled Date to be the same as Start Date. After a rating event completes, the system updates the date to the next date appropriate for the value of Frequency.
Step 5
In the Locations section:
Click
Find. The system displays Buildings, Structures, Retail Locations, or all options with Energy Rating Type equal to the Energy Rating Type in the Rating
Schedule General section (Energy Star).
Select the Buildings, Structures, Retail Locations, or all options to be submitted to
EPA ENERGY STAR.
Step 6
Click Create Draft.
Step 7
Click
Issue.
The Rating Transaction Status section shows each status step as the rating schedule is submitted to and processed by EPA ENERGY STAR. The Rating Transaction Status section displays Rating Schedule, Transaction ID, Retry Count, Polling Date Time, and
Status.
The system sends notifications when it submits a rating schedule to EPA ENERGY STAR and when it receives success or failed results.
Before submitting any requests to ABS, you must Add or Update the Attributes in the Energy Rating with a valid Meter. This is true for both Automatic and Manual submissions and is a one-time setup step. Once the Meter has been associated to the Attributes for the Space Type used for the Building, each subsequent request to ABS will pull the Meters used on the previous submission. If a Meter is not associated, the space type will not be sent to ABS and the submission will result in error.
Manual Rating
Follow the steps below to manually request an Energy Rating record for a building, structure, or retail location.
To Manually Request an Energy Rating Record
Step 1
Navigate to the General tab of the building, structure, or retail location record.
Step 2
Scroll to the Energy Rating Result section. Click Update on the Energy Rating Result section bar.
The system opens an Energy Rating form.
Step 3
Enter the number of months and the End Date.
© Copyright IBM Corporation 2011, 2013. 13
To Manually Request an Energy Rating Record
Step 4
Click
Create. The system associates all energy meters associated with the location.
If you have created Energy Spaces the location, the system copies them to the new request.
If you created a previous request, the Attribute records from this last rating request are located, and the attribute values are pulled into the current record.
Step 5
You can change the Attributes, Find or Remove associations to energy meters, and
Finds or Remove associations to Energy Spaces if needed
Step 6
Click Submit.
Step 7
The system calculates the start date for records, then associates energy logs within the start and end date range to the request for the meters that are associated.
Step 8
The ABS Integration process runs.
Step 9
The result from the integration is used to update the rating record.
Before submitting any requests to ABS, you must Add or Update the Attributes in the Energy Rating with a valid Meter. This is true for both Automatic and Manual submissions and is a one-time setup step. Once the Meter has been associated to the Attributes for the Space Type used for the Building, each subsequent request to ABS will pull the Meters used on the previous submission. If a Meter is not associated, the space type will not be sent to ABS and the submission will result in error.
Review Results
The IBM TRIRIGA Connector for Energy Star Benchmarking offers several ways to check the results from an EPA ENERGY STAR rating and to evaluate the rating for your portfolio.
Environmental Manager
The Energy Rating business object in the Environmental Manager displays Energy Rating records. For those that have been rated, the system shows a color coded status in the Location Status column.
The Location Status color coding is based on the following criteria:
Green
: If the rating is greater than or equal to the Target * (1 – (Days until Target Date) /
(Days between Target Date and Baseline Date))
Yellow : If the rating is less than the Target * (1 – (Days until Target Date) / (Days between
Target Date and Baseline Date)) and greater than or equal to the Baseline
Red
: If the rating is less than the Baseline
© Copyright IBM Corporation 2011, 2013. 14
Building/Structure/Retail Location Form
The Energy Rating Result section on the General tab of a building/structure/retail location form shows the result of the most current rating by EPA ENERGY STAR.
The Projected Yearly Savings uses current annual energy costs as follows:
If the Target is greater than the Rating, the Projected Yearly Savings = ((Target – Rating) / Max
Rating * Effect Factor * Annual Energy Costs)
If the Target is less than or equal to the Rating, the Projected Yearly Savings = $0
Environmental Manager Portal Metrics
The Home - Environmental Manager Portal includes IBM TRIRIGA ENERGY STAR metrics in the
Performance Metrics portal section.
Metric Categories
The IBM TRIRIGA Connector for Energy Star Benchmarking metrics are in the following metric categories:
Environmental: Measures cost, intensity, and recovery for Energy, Emissions, Water, and
Waste.
Financial: Measures the cost of operations, total occupancy costs, revenue weeks, and profitability of workplace operations and resources.
Note
– The external corporate financial system used is hierarchical and aggregates costs at the building/structure level, and the cost code structure and roll-up align with common industry definitions of: Capital, Cost of Operations (IFMA definition),
Operating Costs (IFMA definition), Capital or Expense.
Portfolio: Measures the utilization, condition, and return on workplace assets.
The following section provides a detailed explanation of each metric delivered with the IBM TRIRIGA
Connector for Energy Star Benchmarking. For a discussion of other performance metrics, see the IBM
TRIRIGA 10 Workplace Performance Management User Guide.
IBM TRIRIGA Connector for Energy Star Benchmarking Metric ID
The following chart provides a Metric ID to identify each IBM TRIRIGA Connector for Energy Star
Benchmarking metric.
IBM TRIRIGA ENERGY STAR Metric ID Metric Category IBM TRIRIGA ENERGY STAR Metric
Environmental
Financial
Portfolio
Portfolio
Portfolio
Ranking by Quartile
Projected Yearly Savings
Energy Rating Certification
Energy Rating Comparison to Average
Energy Rating Improvement
15 © Copyright IBM Corporation 2011, 2013.
IBM TRIRIGA Connector for Energy Star Benchmarking Metric Details
This section describes each IBM TRIRIGA Connector for Energy Star Benchmarking metric. See Appendix
B for allowed values in ENERGY STAR attributes and meters.
Energy Rating Certification
Item
Name
Description
Energy Rating Certification
Metric ID
1203-01-PO
Metric Category
Portfolio
Metric Objective
Determine which buildings/structures/retail locations are eligible for
ENERGY STAR recognition
Analysis Objective for
Exception Conditions
Identify buildings/structures/retail locations with ENERGY STAR rating equal to or greater than 50
Description
ENERGY STAR ratings
Source (of metric recommendation or industry benchmark reference)
Measurement
Customer Focus Group, EPA
ENERGY STAR rating
Dependent Data that is calculated
Roles
Display/Graph Types
Thresholds (default)
ES Manager/Planner
Value-based: Horizontal Stacked Bar Chart (default view)
None
Fact Details
Module: triMetricFact
Business object: triLocationFact
Metric Query: triLocationFact – Metric – Energy Rating Certification
Value-based: Geography, Capture Period, Certification
Drill Paths (graph or table axis)
Filters (Interactive)
Filters (Static)
Value-based: Geography, Location, Building Class
Active Buildings, Active Structures, Active Retail Locations, Active
Energy Rating records
© Copyright IBM Corporation 2011, 2013. 16
Item
Sub-tabs
Description
Related Reports – triLocationFact – Related Report – Building
Summary – Energy Rating Certification
Data – standard for all metrics
Time
Data Point Refresh Rate
License Dependency
Functional Dependency
IBM TRIRIGA Connector for Energy Star Benchmarking
Energy Rating
Energy Rating Comparison to Average
Item
Name
Description
Energy Rating Comparison to Average
Metric ID
1204-01-PO
Metric Category
Portfolio
Metric Objective
Determine energy efficiency of the portfolio compared with EPA averages
Analysis Objective for
Exception Conditions
Determine what buildings/structures/retail locations have good or poor energy used compared with EPA ENERGY STAR average (always
50)
Description
Energy Rating Comparison to Average
Source (of metric recommendation or industry benchmark reference)
Measurement
Customer Focus Group, EPA
(Rating – Average/Max Rating)
Dependent Data that is calculated
Roles
Display/Graph Types
Thresholds (default)
ES Manager/Planner
Value-based: Horizontal Stacked Bar Chart (default view)
None
© Copyright IBM Corporation 2011, 2013. 17
Item
Fact Details
Drill Paths (graph or table axis)
Filters (Interactive)
Filters (Static)
Sub-tabs
Time
Data Point Refresh Rate
License Dependency
Functional Dependency
Description
Module: triMetricFact
Business object: triLocationFact
Metric Query: triLocationFact – Metric – Energy Rating Comparison to
Average
Value-based: Geography, Location, Capture Period
Value-based: Geography, Location, Building Class
Active Buildings, Active Structures, Active Retail Locations, Active
Energy Rating records
Data – standard for all metrics
IBM TRIRIGA Connector for Energy Star Benchmarking
Energy Rating
Energy Rating Improvement
Item
Name
Description
Energy Rating Improvement
Metric ID
1205-01-PO
Metric Category
Portfolio
Metric Objective
Determine energy rating improvement of the portfolio
Analysis Objective for
Exception Conditions
Description
Determine what buildings/structures/retail locations have improved
EPA ENERGY STAR ratings
Energy Rating Improvement over time
Source (of metric recommendation or industry benchmark reference)
Customer Focus Group, EPA
© Copyright IBM Corporation 2011, 2013. 18
Item
Measurement
Dependent Data that is calculated
Roles
Display/Graph Types
Thresholds (default)
Fact Details
Drill Paths (graph or table axis)
Filters (Interactive)
Filters (Static)
Sub-tabs
Time
Data Point Refresh Rate
License Dependency
Functional Dependency
Projected Yearly Savings
Item
Name
Metric ID
Description
Compare the current rating to the baseline and derive the improvement percentage from baseline:
If Baseline greater than zero, ((Rating – Baseline)/Max Rating)
If Baseline zero, N/A
ES Manager/Planner
Value-based: Horizontal Stacked Bar Chart (default view)
None
Module: triMetricFact
Business object: triLocationFact
Metric Query: triLocationFact – Metric – Energy Rating Improvement
Value-based: Geography, Location, Capture Period
Value-based: Geography, Location, Building Class
Active Buildings, Active Structures, Active Retail Locations, Active
Energy Rating records
Data – standard for all metrics
IBM TRIRIGA Connector for Energy Star Benchmarking
Energy Rating
Description
Projected Yearly Savings
1202-01-FI
© Copyright IBM Corporation 2011, 2013. 19
Item
Metric Category
Description
Metric Objective
Financial
Determine energy cost efficiency based on comparing projected yearly savings from Energy Rating records
Analysis Objective for
Exception Conditions
Description
Display/Graph Types
Thresholds (default)
Summarize potential savings by geography, location, building type
Source (of metric recommendation or industry benchmark reference)
Measurement
Dependent Data that is calculated
Roles
Projected yearly savings
Customer Focus Group
Evaluate the current rating to the Target.
If Target > Rating: ((Target – Rating) / Max Rating * Effect
Factor * Annual Energy Costs)
If Target less than or equal to Rating: 0
ES Manager/Planner
Value-based: Horizontal Stacked Bar Chart (default view)
None
Fact Details
Module: triMetricFact
Business object: triLocationFact
Metric Query: triLocationFact – Metric – Projected Yearly Savings
(USD)
Value-based: Geography, Location, Capture Period
Drill Paths (graph or table axis)
Filters (Interactive)
Filters (Static)
Sub-tabs
Time
Value-based: Geography, Location, Building Class
Active Buildings, Active Structures, Active Retail Locations, Active
Energy Rating records
Data – standard for all metrics
Years
© Copyright IBM Corporation 2011, 2013. 20
Item
Data Point Refresh Rate
License Dependency
Functional Dependency
Description
Yearly
IBM TRIRIGA Connector for Energy Star Benchmarking
Energy Rating
Ranking by Quartile
Item
Name
Description
Ranking by Quartile
Metric ID
1201-01-EN
Metric Category
Environmental
Metric Objective
Determine energy efficiency based on comparing ENERGY STAR ratings
Analysis Objective for
Exception Conditions
Description
Determine what facilities have good or poor ENERGY STAR ratings
ENERGY STAR ratings per quartile
Source (of metric recommendation or industry benchmark reference)
Measurement
Customer Focus Group, EPA
Rank each Building/Structure/Retail Location rating per quartile (0 -
<25, 25 - <50, 50 - <75, 75 – 100)
Dependent Data that is calculated
Roles
Display/Graph Types
Thresholds (default)
ES Manager/Planner
Value-based: Horizontal Stacked Bar Chart (default view)
Fact Details
None
Module: triMetricFact
Business object: triLocationFact
Metric Query: triLocationFact – Metric – Ranking by Quartile
© Copyright IBM Corporation 2011, 2013. 21
Item
Drill Paths (graph or table axis)
Filters (Interactive)
Filters (Static)
Sub-tabs
Time
Data Point Refresh Rate
License Dependency
Functional Dependency
Description
Value-based: Geography, Capture Period, Quartile, Location
Value-based: Geography, Location, Building Class
Active Buildings, Active Structures, Active Retail Locations, Active
Energy Rating records
Related Reports – triLocationFact – Related Report – Building
Summary – Energy Rating Quartile
Data – standard for all metrics
IBM TRIRIGA Connector for Energy Star Benchmarking
Energy Rating
ENERGY STAR Tips
ENERGY STAR Tips
In order to get an Energy Star rating, you must submit a minimum of 12 months of energy use information to the EPA. It is also necessary to submit 12 months of attribute data or set the Effective
Date of the attributes back 12 months.
Energy logs cannot have a zero Rate. While it would not be normal for someone to enter a zero Rate, if you wanted to document usage you might enter records with a quantity but a zero Rate. Doing so causes the Energy Star Connector to not submit the records. Consider changing the validation rule on the quantity to not equal to zero.
You should become familiar with the requirements and documentation set forth from the EPA’s
ENERGY STAR ABS provided online at: https://www.energystar.gov/istar/has/
The ID field on a State Geography record must be the two character state abbreviation. The ENERGY
STAR Connector uses this ID field and if it is not valid the EPA’s ABS system rejects the building.
© Copyright IBM Corporation 2011, 2013. 22
2. Connector for Esri Geographic
Information System
A geographic information system (GIS) is a system for capturing, storing, analyzing, and managing data and associated attributes that are spatially referenced to Earth. In the strictest sense, it is an information system capable of integrating, storing, editing, analyzing, sharing, and displaying geographically referenced information. In a more general sense, GIS is a tool that makes it possible for users to create interactive queries, analyze spatial information, edit data, integrate maps, and present the results of these tasks.
Geographic information system technology is used for resource management, asset management, environmental impact assessment, urban planning, sales, marketing, logistics, and many other activities. For example, GIS makes it possible for facility managers to easily assess impacts on facility assets in the event of a natural disaster, or GIS can be used to find a site for a new business to take advantage of a previously underserved market.
Tools and data that enable the GIS feature come from both IBM TRIRIGA and Esri. The breakdown is as follows:
Source
IBM TRIRIGA
Esri
What is provided
An initial set of building data used to query the Esri ArcGIS server.
A ClassLoader object that contains the logic to render the Esri
JavaScript Viewer. For more information about ClassLoaders, see
Custom ClassLoader in Appendix A.
Tools to configure the basemaps, layers, spatial references, widgets, and queries used in the rendered GIS Map areas within IBM TRIRIGA.
The geographical and geospatial data (Data Services). The IBM TRIRIGA system obtains this data through REST API services on Esri servers.
The actual map view. The ArcGIS Server, whether the services offered online or the services hosted on a proprietary ArcGIS Server, renders the maps and handles your geoprocessing.
Geoprocessing for drive time or distance radii. This is provided by the
ArcGIS Server.
Geocoding for gathering the latitude and longitude coordinates of addressable objects or identifiers that represent the features. This is provided by the ArcGIS Server.
The Esri JavaScript API is used to render the viewer to provide data from the server and to provide basic interaction with the map data. The standard configuration is defined in the IBM TRIRIGA GIS Map object.
Esri offers a number of data services, in particular the Spatial Query data service. These services are used by GIS to determine the geographies the user sees within the current map view.
The ArcGIS connector can be displayed in two functional areas in IBM TRIRIGA applications: as a portal section or within a custom tab in a business object record. The same full-featured functionality is available each time a map is displayed.
© Copyright IBM Corporation 2011, 2013. 23
The versions of the IBM TRIRIGA Application Platform and the IBM TRIRIGA applications that support the
GIS features described in this chapter are defined in the IBM TRIRIGA Support and Compatibility
Matrix, which can be found at the following link: https://www.ibm.com/developerworks/mydeveloperworks/wikis/home?lang=en#/wiki/IBM+TRIRIGA1/ page/Support+Matrix .
GIS Portal Section
A GIS portal section points to an internal web page that contains a GIS map. The map has a default GIS
Map record associated to it that defines what to render.
The URL section names of the internal web pages are as follows:
triURL - GIS - Environmental Manager/Planner (US Govt)
triURL - GIS - Environmental Manager/Planner
When a user signs in to the application, the URL is called to load the web page containing the map.
Based on the map defined in the URL parameter, a list of executable reports is returned, the first report in that list is executed, and the results are returned to the map.
The map determines and runs the appropriate report. Reports can be metric queries or standard queries. The reports define what a user sees in the bubble markers for the locations or features. These queries also populate the data grid in the viewer. There is a one-to-one correlation between the bubble markers on the map and the grid data. The grid data contains the same fields that the bubble marker contains, because the source data for both is the same report.
The map has widgets available so that the user can pan or zoom, find locations, or create and edit features on the map and assign those features to an IBM TRIRIGA object.
The view shows the locations returned from the query pinpointed on the map. Each location has a bubble marker (hover text) that displays information related to the location. If the query is a metric query, the bubble markers display the metric results and the colors of the location pinpoint icons match the thresholds represented by the metric results. If the query is a standard query, the location pinpoint icons are colored blue. The default colors are blue, red, green, and yellow. You have the option to supply your own icons on the map to represent the location pinpoints on the screen.
The query that is associated to the map in a portal section does not have a direct impact on and does not react to any other metric on the portal. GIS is a stand-alone application inside of a portal section.
A GIS section includes a Save Preferences button. This feature saves the current map extent and the view. The next time the user signs in, the saved settings override the default in the URL parameter of the portal section URL. If the user did not save preferences, the section shows the default view as defined in the URL parameter string. The user preferences are stored per user, per map. When the user changes to a different map, the preferences for the original map are not applied to the second map.
Instead the second map is displayed with the default settings for that map, unless the user previously saved preferences for the second map.
© Copyright IBM Corporation 2011, 2013. 24
Creating a Custom GIS Portal Section
The following steps describe how to create a custom GIS portal section. For an example, you can use one of the as-delivered portal sections for reference: triURL – GIS Environmental
Manager/Planner
or triURL – GIS Environmental Manager/Planner (US Govt).
To Create a Custom GIS Portal Section
Step 1
Create a new GIS Map object. Define the initial extents, basemaps, layers, and queries to be applied to the map when it renders in the portal section. In this example, the map is named My First Map.
Step 2
Create a new portal section of type External. Enter a URL as shown in the following example: /html/en/default/rest/EsriJS?map=My First Map. The map parameter value of My First Map tells the viewer to render that record.
GIS Tab
When a user has appropriate licenses, as-delivered Location, Geography, and RE Transaction Plan records include a GIS tab. This tab contains a map that pinpoints the location of the record, and the map extent is the localized area. A default query renders the map. The query is specified in the URL as a parameter string that determines which queries to execute. The URL of the GIS tab is defined in the
Form Builder.
GIS/Esri Integration Points
For GIS functionality, IBM TRIRIGA uses a mapping service provided by Esri ArcGIS Server. IBM TRIRIGA communicates to the server using Java, JavaScript, and HTML. Use the Esri JavaScript API to make the service calls to ArcGIS Server and to IBM TRIRIGA using its native HTTP Service protocol. Actions provided on IBM TRIRIGA records (for example, the Geocode Address action) use a Custom task that makes calls to the services. The following fields on each of the as-delivered Location forms and business objects support this Custom task:
Field Description
triGisLatitudeNU triGisLongitudeNU
Holds the latitude of the geocode point.
Holds the longitude of the geocode point.
Configuring the IBM TRIRIGA ArcGIS mapping tool
Use the IBM TRIRIGA ArcGIS mapping tool to configure your connection from IBM TRIRIGA to ArcGIS. The
IBM TRIRIGA ArcGIS mapping tool is located in
Tools > System Setup > GIS Map. Each record in the GIS
Map object contains the metadata that defines how the map is used, including basemaps, layers, queries, and widgets.
© Copyright IBM Corporation 2011, 2013. 25
Creating a GIS Map Record
To create a GIS Map record
Step 1
Click Tools > System Setup > GIS Map > Add.
The name you enter for the map must be different from the name of any other GIS
Map record in the system.
Step 2
Complete the Initial Extents section.
The Initial Extents section defines the initial extents and the default value for the spatial reference, the well-known ID (WKID). These values establish the boundaries of the map when it first opens in a portal section or tab. You must validate that the
WKID is appropriate for the basemaps and layers that you specify. If the WKID is not correct, your map section is blank and does not contain a map.
Step 3
Complete the Query List section.
Any query that is supported by the IBM TRIRIGA Report Manager can be included in the
Query List section. The query with the lowest value in the Display Order field is displayed by default. A user can select another query by clicking the Show Details tab above the map, selecting the query from a drop-down list, and running that query.
Metric queries behave differently in GIS than they do in other areas of IBM TRIRIGA because the map is the main driver. Metric queries for other areas of IBM TRIRIGA have a Show By/Group By drop-down box and filter drop-down menus. In GIS, metric query data is filtered and grouped by the geographical data that is displayed in the current map view. For the results of a metric query to display correctly, the structure of the metric query must be tabular and the query must include the following display columns: Longitude, Latitude.
If the results of the query are in different map systems, the GIS software does the conversion and displays the results in the basemap.
When a query is executed, if the query filter includes the triGisLatitudeNU and triGisLongitudeNU
fields to represent the Latitude and Longitude fields used to pinpoint the item on the map, the esriJS viewer automatically adds filters to the query to only return results within the given extents of the map. The map can return a maximum of 1000 records. Note that the actual field names are the only way that filters can be added. If you use fields other than triGisLatitudeNU and triGisLongitudeNU
, there is no way to add the filter.
Step 4
Complete the Basemaps section.
The Basemaps section identifies the maps that are available for display. The basemap with the lowest value in the Display Order field is displayed by default. The user can select another basemap by clicking the Show Details tab above the map and selecting from the Switch Basemap drop-down list. Additionally, information about the map provided by the map vendor displays when the user selects the Show Details tab.
© Copyright IBM Corporation 2011, 2013. 26
To create a GIS Map record
Step 5
Complete the Layers section.
The Layers section identifies the layers that are available for display on top of the basemap. When the Default check box is selected, the layer displays when the map renders. A user adds or removes a layer by clicking the Show Details tab above the map and selecting or clearing the check box next to the name of the layer.
When the user selects a layer with associated legend information, a column on the right of the map lists the legend that corresponds to the layer. When multiple layers are displayed, the legends are listed in order. As the user modifies the extents on the map by zooming, the data in the legends updates to reflect the correct level of detail. If the map has a layer that is set as a default, the legend does not display until the user clicks either the Show Details tab or the Show Table tab. This conserves space on the map when it is viewed in smaller spaces, such as a portal. The column that displays the legends is removed after the last layer is removed.
Step 6
Click the Options tab.
The color of a pin on the map can represent the data value. When the query used to determine the points to display on the map is a metric query, the colors of the pins represent where the value of each result falls within the thresholds defined in the metric query. For example, assume the threshold defined in the metric query is that a value of 1 through 3 is low and should have the color red representing a negative result. If the result is 2, the pin is displayed with the icon file contained in the Red
Icon field. The Blue Icon field is used for a value that is returned by a standard query.
You can change the icons that are displayed by uploading your files into the Icons section. An icon file can be in any format used to render on the web, for example, a
JPG file or a PNG file. If you do not change the icon files, the as-delivered icons are used.
You use the Widgets section to add a geoprocessor, to provide an overview map, or to add custom widgets. To define a widget, upload the JavaScript for the widget in the
Code field.
The as-delivered Widgets section contains example widgets from Esri. These widgets are not tied to the base application and are only included for purposes of illustration.
Most widgets become available to the user by clicking the Show Details tab above the map.
With the as-delivered geocoding widget, the user can direct the map to latitude/longitude coordinates or to an address.
The as-delivered drive time widget displays radii for 1, 2, and 3 minute drive times from the point selected.
A user opens the as-delivered overview map by clicking the arrow that is in the upper right corner of the map display. The sample overview map shows a condensed version of the map and contains a pane that can be moved. The user drags that pane to navigate much larger regions of the map without having to zoom out.
With the as-delivered editor widget, a user can draw a line, polygon, or point on
© Copyright IBM Corporation 2011, 2013. 27
To create a GIS Map record
an Esri map. The entity is saved on the Esri map if the user associated the feature to one of the records in the query or selected the Show All Features check box. The as-delivered editor widget is named sampleEditor.js. You can use that file as an example of how to create custom editor widgets.
In the as-delivered sample editor widget, a feature can be associated with a
TRIRIGA ID by entering a value in one of the number fields or text fields in the information panel. In the sample, the Issue Id field is used. You can use this same method in another editor widget to associate a feature to a value.
A user can draw a feature and associate it to a TRIRIGA record by clicking the
Show Table tab and selecting the Associate to selected feature icon for TRIRIGA record in the table. The next time that the record is queried, the feature displays on the map. This method uses the TRIRIGA ID as the common ID between
TRIRIGA and Esri.
When enabled, the as-delivered editor widget interferes with the bubble marker information provided by the pins. At the time of this release, there is no known workaround.
With the as-delivered proximity widget, when a user clicks a point on the map, the server processes a distance radius from that map. The data displayed on the map changes to only show buildings that fall within that proximity boundary. The proximity boundary is determined by the server.
Custom widgets are made up of compartmentalized JavaScript code specific to Esri widget functionality. This is a low-level feature that makes it possible for you to apply a custom Esri widget based on the Esri JavaScript API version 3.3. A custom widget might be something as simple as a map overlay or as complex as polygon editing.
When you add your code to the binary field in the widget, if it is part of the GIS Map object, it appends that code to the rendered map at runtime.
Identify the security groups that are authorized to access widgets in addition to members of the Admin Group. Users in one of the listed security groups or in the
Admin Group can see a widget when the Add Security check box in the Widgets section is selected.
Step 7
Click the Preview tab to see the map that is configured.
A user can save the basemap and extents of their current view by clicking the Show
Details tab and then the Save Preferences button. Clicking the Clear Preferences button returns the basemap and extents to the default values in the GIS Map record.
This information is saved by an association from the GIS Map record to the GIS User
Preferences object. The user can store preferences for each map.
A user can see the data that is represented on the map in a table by clicking the Show
Table tab. When the user selects a row in the table, the map zooms to the point on the map corresponding to that record and centers there.
When viewing the table results, you can click the
Export link in the upper-right corner of the table to download the results as a tab delimited text file.
The value in the Constructed URL field on the Preview tab and the System tab is the
© Copyright IBM Corporation 2011, 2013. 28
To create a GIS Map record
URL for the map that is displayed in the Preview tab. You can copy this value to paste into a Location record to tie it to the map.
GIS Tips
GIS Tips
Performance of the map when the user zooms in and out is at Internet speed. Each time a user moves the map, a call is made to respond and redraw the map. The JavaScript Viewer handles these actions. The time it takes to redraw the map depends on the speed of the network being used. If you use an online service such as Esri, the commands are communicating over HTTP. If you use an inhouse Esri server, your intranet determines the latency.
GIS may show different locations than when the same metric query is used in other areas of IBM
TRIRIGA. Although GIS uses the same metric calculation on the same Fact Table record, GIS does not support filtering of metric results.
Metric queries in other areas of IBM TRIRIGA have a Group By drop-down box to define dimension and a set of filter drop-down boxes to filter the results based on other criteria. GIS considers only the
Group By drop-down (the dimension). In order to compare the results, the IBM TRIRIGA metric needs to have its Group By set to either Locations or Geographies and all filters cleared out.
The labels within the bubble markers and the grid are defined by the IBM TRIRIGA queries used for the display. There are three fields that can be added to your query results. The three field labels are
“Latitude” and “Longitude”, which are used to paint the marker on the map, and “Image”, which is used to display the image graphic of your location in the bubble marker.
If locations do not show on the GIS map, the cause might be one of the following:
The locations are not geocoded. In order for GIS to display a location on the map, the record must be geocoded so that GIS knows where to put it on the map.
There are no results returned from your query.
The ArcGIS server is down or not responding.
Use these standards for IBM TRIRIGA data to work properly with Esri:
All queries must resolve to a list of locations or entities.
The system is designed to have an initial query and a basemap.
A standard query can bypass these requirements and display any geocoded results returned on the map. The caveat is that the query must return two columns with the Latitude and
Longitude in the results.
Duplicate records in the grid are caused by a data issue with your hierarchy structures. GIS uses a flattened hierarchy table. If there is an issue with that table, you can rebuild the flattened hierarchy structure.
To rebuild the flattened hierarchy structure:
© Copyright IBM Corporation 2011, 2013. 29
GIS Tips
1. Select
Tools > Builder Tools > Data Modeler.
2. Select
Utilities > Hierarchy Structures. The Hierarchy Structure Manager displays all hierarchies that are defined in the flattened hierarchy table.
3. For each of the following hierarchies, click the hyperlinked name, then click the
Generate
Data link:
• All Geographies
• Building Spaces
• Buildings and Land
If you see a blank white screen instead of a map, check the following conditions:
The GIS configuration pages are set up properly.
The ArcGIS server is up.
The ArcGIS ClassLoader is not set to debug mode.
You have the proper licenses to use the GIS map.
If you see a “No GIS License” message, make sure your IBM TRIRIGA license file or files are up to date.
© Copyright IBM Corporation 2011, 2013. 30
3. TRIRIGA Integration Object
The TRIRIGA Integration Object is a utility business object that contains the metadata that controls integration between IBM TRIRIGA and external systems. With the TRIRIGA Integration Object, an application builder uses standard IBM TRIRIGA tools, such as workflow and queries, to create integration touch points. The TRIRIGA Integration Object has a point-and-click interface and includes options for different types of integrations. You access the TRIRIGA Integration Object from
Tools >
System Setup > Integration > Integration Object.
The fields, sections, and tabs in the Integration Object form hide and show dynamically as you enter data into the form. You are presented with only the fields, sections, and tabs that are pertinent to the integration you are defining. The general process flow is to create the Integration Object record and then run that record. After the integration process completes, the record includes a section that contains the history of what happened when you ran the integration. Also, the record includes a tab that contains the records that were affected by the response. If there are any failures, you can find a detailed description of the failure and a method you can use to manually edit the failed step and resubmit it.
Creating Integration Objects
To Create an Integration Object Record
Step 1
Navigate to
Tools > System Setup > Integration > Integration Object. Click the Add action.
Step 2
Specify the details to define the integration.
Step 3
Click the
Create action.
An initial Integration Object form has two sections in the General tab, the General section and the
Execute History section. The fields in the General section identify how the integration you are creating functions. The following table describes these fields.
Field Name
Name
Description
Scheme
Direction
The published name. The value of this field must be unique.
Tip
– Use the object – scheme - direction format for the name. For example, an inbound integration for People from a database would be named People – database – inbound.
The payload, protocol, and transport for the data. The four scheme types are: Database, File, File to DC, and Http Post.
The direction the integration travels from the view point of IBM
TRIRIGA. The two options are Inbound and Outbound. Each option dictates the elements that are displayed in the form and that can be
© Copyright IBM Corporation 2011, 2013. 31
Field Name
Debug
Description
configured for the integration.
If you select the Debug check box, debugging is enabled for the integration. Using the Debug check box avoids having to bounce the server or to enable debugging with the Administrator Console. When active, debugging logs verbose data to the server.log file.
If you are in a production environment or a performance testing environment, do not select the Debug check box.
After you create the record, use the
Execute action to start the integration. This action runs the triIntegration - Execute
workflow, which is described in more detail here . The Integration
Object record becomes read only and the status changes to Processing. When the integration processing is complete, if there were no errors, the Integration Object record transitions back to the
Ready state. If an error occurred during processing, the status displays as Failed, and the object is not transitioned. You must then manually inspect the errors that occurred.
You can override the inspection and transition the record back to the Ready state by clicking the
Complete action. The Delete action is available, but hidden.
The following lifecycle diagram shows the state transitions for an Integration Object record.
State Transitions for an Integration Object Record
The records in the Execute History section contain the details about each integration. Each detail record contains the status, processing counts, and duration of the run. When an integration has errors, it also includes a log of the errors and a query section that lists the individual records that failed.
When the Integration Object is triggered from a workflow, the Integration Object record that contains the full overview of errors also contains a truncated message in a hidden text field that can be used to display to the user, for example in an Attention message.
Note
– The Integration Object for outbound objects can process a maximum of 1000 records at one time. If there are more than 1000 records to be exported, create your workflow logic to run the Integration Object until all records have been processed.
32 © Copyright IBM Corporation 2011, 2013.
Data Map Tab
The Data Map tab is present in the Integration Object form when you select the inbound direction for the integration. You use the Map section on the Data Map tab to map the data from the external source to fields within the IBM TRIRIGA business object.
The Map section can have two native IBM TRIRIGA fields: Integration Map and Last Updated. The rest of the page uses the ServletProxy technology to display data during communication with the data source through the IBM TRIRIGA Connector for Business Applications.
The Integration Map field is a binary field that stores the mapping that you define for how data is to be imported. The file is stored and parsed as a JavaScript Object Notation (JSON) object that contains the information that is collected from the Data Map tab. This data is stored as application instance data.
Selecting a Form
To map data to the correct objects within IBM TRIRIGA, you must select a form in the Map section.
To Select a Form in the Map Section
Step 1
Select a module.
Step 2
Select a business object.
Step 3
Select the form.
When you select the form, a tree representation of the form is displayed.
The Default Action field is used if the record to be imported cannot be found and must be created. If the record exists, the default action is ignored and the record is updated. The actions that are in the Default Action list are the transitions from the null state that are available for the record.
The form is displayed in a tree format with icons representing the type of object of the section or field in the tree. The hierarchy of the form tree is Form -> Tab -> Section -> Field.
Icon Representation
Form
Comment
Tab
Smart Section Triggers a popup to define how to identify the data element. There
is more information about using smart sections here .
Graphics Section
Query Section
Multi-tab Section
Cannot be mapped
Cannot be mapped
Cannot be mapped
© Copyright IBM Corporation 2011, 2013. 33
Icon
Strike
Red
Representation
Locator Field
Regular Field
Date Field
Read Only field
Required field
Comment
Acts as a standard field, but the integration fails if the data cannot be located or is not unique
Text fields treated as strings
Not displayed in the tree. You use the table to the right of the form tree to define the date format for the incoming data, so that it can convert to IBM TRIRIGA date format correctly.
A field with a strikethrough cannot be mapped, but it can be used as a key field to help identify the record.
It is required to create the record. This integration record fails if it is not mapped.
In the form tree, the labels display with names in parentheses. When you click a form name, tab, or section, the element is expanded. If it is a field, it is added to the table of columns on the right of the page. If it is a field from a smart section, you use the popup window to further identify the element.
Defining the Fields
You define the fields in the Integration Object on the right side of the form.
Field
Base Parent
Description
The Base Parent field is used for hierarchy objects, such as Location,
Organization, and Geography, to identify the root of the hierarchy.
To ensure that the record is created under the correct root of the hierarchy, you must specify the path in the Base Parent field. If you do not specify the path in the Base Parent field, the record is created at the same level as the root and you cannot see or get to the record from the form.
Type
External
Example: \Location
The metadata definition of the system field type. All fields are treated as strings.
Example: List
The name of the external field that you want to map to IBM TRIRIGA.
Since these values can be used for database columns or for formatted files, do not use spaces, special characters, or numbers.
Example: User_Language
© Copyright IBM Corporation 2011, 2013. 34
Field
isKey
Description
Note
– When this column is used in the Response Map tab ,
the External field represents either nothing, or an xpath string, or a jsonPath string.
To update records in IBM TRIRIGA, you need the record ID to identify the record. If you select isKey, the value for that row of data is used as a filter for the queried object so that exactly one record ID is returned. If no record IDs or multiple record IDs are returned, the row creates a record with all values for the row. isParent Select isParent to identify this record as being a parent of another object so that the hierarchy can be created. When you select isParent, you use the popup window to select the business object, form, and field.
When the record is sent to IBM TRIRIGA, if the Integration Object finds that this incoming record has a field that is defined as a parent, the value for the incoming record is used as a filter in the query that is used to capture the record ID for the parent.
For the record to be placed as a child of another record, you must submit the update or create with the record ID of the parent in the request. If you define this value in the map, this is handled automatically.
If the parent is not found or multiple parents are returned based on the value submitted, then a warning is logged and the record is created at the same level as the root.
Default You can use the Default field to specify constant values to be applied for all instances of the record. If the Default field is populated, the
External value is ignored and the integration assumes that the column exists only in this mapping.
Example: US English
Note
– After your mappings are complete, you must click the
Save Map action. If you click either the Save form action or the Save & Close form action, your mappings are lost; they are not saved.
When you save the map, the data you specified is collected and stored in the Integration
Map field in the Map section. The format of the field is a JSON object in a text file.
Using Smart Section Fields
A smart section is a section that is used to link to another business object. The data that is displayed on the primary record reflects data in a different object. A smart section field is a field that is linked
© Copyright IBM Corporation 2011, 2013. 35
to a smart section. For more information about smart sections, see the Application Building for the IBM
TRIRIGA Application Platform 3 book.
The IBM TRIRIGA Connector for Business Applications must have the record ID of the linked smart section. To get this value, the Integration Object takes the data value submitted for the field you identify, uses the value as a filter to query for the object, and returns a single record. This value is then passed to the IBM TRIRIGA Connector for Business Applications.
Each smart section field represents a link to another business object. When you select a field, you use the popup window to select the form to use as a filter. Next choose the field to be used as a filter to retrieve the record ID.
In the smart section popup window, if you select the Should this record fail if the association cannot
be made check box and the lookup for the record ID cannot find exactly one record, the submission of the record fails. If this check box is not selected and the record ID cannot be found, a warning is written to the log, but the record is created or updated.
Query For Outbound Section
The Query For Outbound section is present in the General tab when you select the outbound direction for the integration. The fields to be exported are copied from the IBM TRIRIGA database with the query identified in this section.
Selecting a Query
Outbound integrations can be defined using either a query from the IBM TRIRIGA Report Manager or a dynamic query.
Report Manager Query
If you use a query from the Report Manager,
To select a query in the Query For Outbound section
Step 1
Select a module.
Step 2
Either select a business object and a query name, or select Module Query and enter the query name.
Step 3
Select the action name for the action to be performed on the record after it has been exported. For example, you might call a workflow to flag the record to not be exported again. If you leave this field blank, no action is triggered.
Step 4
Optional: Select to include the record ID. You can use the query label as an element.
For XML-defined exports, there is a binary field for use with an XSLT to do
transformations. The record ID adds the field TRIRIGA_RECORD_ID for file outputs
© Copyright IBM Corporation 2011, 2013. 36
You use the Report Manager to define the query. For more information about creating queries with the
Report Manager, see the IBM TRIRIGA Application Platform 3 Reporting User Guide book. The mapping of data is done in the query definition. The report labels you specify for each field must represent the external table name, XML node name, label value, or the text field header column name.
Dynamic Query
If you use a dynamic query, the Integration Object form changes. The query name elements in the
Query For Outbound section disappear and the Data Map tab is added to the form. You use the Data
Map tab to create a map to dynamically call your query. In this use of the Data Map tab, instead of
defining how inbound data is to be mapped, you are selecting the fields to be exported and the labels represent the external data source to which the fields are mapped.
You use a dynamic query to specify default data for fields. For example, if you use the Http Post scheme and need to pass a static parameter or value. For default data to work correctly with a dynamic query, you first define your data map with the default data set and then you use the
You must use a dynamic query if you are using the Database scheme and need to export blobs. You can select binary, note, or Document Manager content fields for export.
Schemes
A scheme defines the payload, protocol, and transport for the data. The following table summarizes each scheme and includes a hyperlink to more information.
Scheme
Description
Uses a database table for importing or exporting data
Imports or exports using standard files
Loads files into DataConnect staging tables
Exports data via HTTP protocol
Inbound
Yes
Yes
Yes
No
Outbound
Yes
Yes
No
Yes
Database Scheme
The Database scheme uses a database table to import or export data. When you select the Database scheme, the Integration Object form expands to open the Database section, in which you add or find data sources that can connect to your database.
When you select the Database scheme to import data, you use the Database section to define the
database tables from which to import data and you use the Data Map tab to map the external database
tables to IBM TRIRIGA fields.
When you select the Database scheme to export data, you use the Query for Outbound section to
define the data to be exported.
The fields in the Database section identify the data source.
© Copyright IBM Corporation 2011, 2013. 37
Field
Datasource Name
Table Name
Description
The Datasource Name is a locator field that represents connections to various databases. You use this field to predefine data source access with a username, password, and connection string that can be reused for multiple Integration Objects. You can connect to as many databases as needed.
Click the search icon to see the list of existing data sources. From this list, you can add new data sources as needed. The name of the data source is used as a filter to find the correct data source when the Integration Object runs.
The name of the table from which the integration pulls data
(inbound direction) or to which the integration exports data
(outbound direction).
The Database section bar actions provide useful tools.
Action
Test DB Connection
Generate SQL for Table
Description
You select the
Test DB Connection action to verify that the server can communicate with the database. The table name is used to run a select 1+1 from [table name]
query to the database. The color of the Database section header changes to red if an error occurred. To view the errors, review the server logs in the IBM
TRIRIGA administrator console. For information about the administrator console, see the IBM TRIRIGA Application Platform 3
Administrator Console User Guide book.
You select the Generate SQL for Table action to create generic SQL to define your database table. Enter the name of the new database
table and complete the mapping on the Data Map tab before clicking
this action.
Each table used for inbound transactions must have the following columns:
IMD_ID
The transaction id. Unique to each entry in the table.
IMD_STATUS
The default status of Ready is used to identify records to be processed. The other states used are
Processing, Completed, and Failed.
IMD_MESSAGE
Used if there are any errors importing the row to contain the errors. The same errors are also displayed in the Integration Object form.
TRIRIGA
_RECORD_ID
The internal record ID that IBM TRIRIGA uses to identify the record being updated or created.
© Copyright IBM Corporation 2011, 2013. 38
Action
Generate Test Data
Description
This sample code was generated for a People inbound integration using the fields defined above:
-- Auto generated script for MSSQL.
CREATE TABLE example_people_in (
IMD_ID NUMERIC (18, 0) IDENTITY(1,1) NOT NULL,
IMD_STATUS VARCHAR(1000) COLLATE SQL_Latin1_General_CP1_CS_AS null DEFAULT 'Ready',
IMD_MESSAGE VARCHAR(1000) COLLATE
SQL_Latin1_General_CP1_CS_AS null,
TRIRIGA_RECORD_ID VARCHAR(1000) COLLATE
SQL_Latin1_General_CP1_CS_AS null,
TRI_ID VARCHAR(1000) COLLATE SQL_Latin1_General_CP1_CS_AS null,
FIRST_NAME VARCHAR(1000) COLLATE SQL_Latin1_General_CP1_CS_AS null,
LAST_NAME VARCHAR(1000) COLLATE SQL_Latin1_General_CP1_CS_AS null,
LANGUAGE VARCHAR(1000) COLLATE SQL_Latin1_General_CP1_CS_AS null
)
This action is only available in the inbound direction. You select the
Generate Test Data action to load your database with test data.
After you create the database table and can connect to it, you can load your database with test data. You use the test data to run simple functional testing to verify that the mappings are correct and that the integration process works correctly. Enter the number of rows to be inserted into the database table in the Test Rows field.
The data generated is created as alphanumeric values. If you specify a default value on the Data Map tab, that value is inserted for all rows. This is useful when the field might be a locator field, a number field, a date field, or a list that requires a specific value.
If an external system is populating the staging database, the external system only needs to populate the non-metadata fields. The IMD_* columns are auto-populated. After the record is updated or created, the TRIRIGA_RECORD_ID contains the record ID that identifies this record in IBM TRIRIGA internally.
Blobs are supported for both inbound and outbound transactions in the Database scheme. The types of blobs supported are binary fields, note fields, and Document Manager content. Image fields are not
binary content of the document on the object. Instead, you select any base object column (for example, a text field in the General section) to use as a place holder for your content. The external name can be whatever you want, but the Default Value column must be CONTENT. This is the trigger that connects the Document Manager object to the content.
File Scheme
The File scheme imports from standardized delimited flat files or exports to formats that include standardized delimited flat files and JSON, XML, or XSLT files. You can read from or write to anywhere on the network that the server can access.
© Copyright IBM Corporation 2011, 2013. 39
When you select the File scheme, you use the File section to define the file. This section has different elements depending on whether the direction is inbound or outbound. This table describes the elements used for both.
Element
File Name
File Path
Delimiter
Description
The name of the file to be imported or exported.
The network folder containing the file.
The delimiter used for the file. The three options are Tab \t, Pipe
|
, and Double Colon ::.
Test File Access
You select the
Test File Access action to determine if the integration object can connect to the file. After the connection is established, a workflow runs that attempts to read the file. The workflow also attempts to create a file in the directory specified, write to it, and then delete it. If everything is successful, then the color of the section bar changes to green and the text on the section bar changes to File Access Successful.
File Scheme Inbound
When you select the File scheme to import data, you can manually provide a binary field that is a copy of the integration field to be imported. You can use a manual field to assist in testing, so that localized processing can be repeated without overwriting the import file.
After a file has been imported, it is renamed with the processing date and moved to a folder named processed
.
If there are multiple workflow agents running in your IBM TRIRIGA environment, you must verify that either all servers have access to the file location or be sure that there is a copy of the file on all servers. This is because the workflow that runs during the Execute process for the integration needs to have access to the file regardless of which workflow agent starts the workflow.
File Scheme Outbound
When you select the File scheme to export data, additional fields in the File section provide information to the integration.
Field
Overwrite
Description
If you select the Overwrite check box, the file to be exported is named the File Name and overwrites any existing file with the same name. If this check box is cleared, the current timestamp is appended to the name of the file.
Export Type
You choose the format of the outbound file. You can select the Flat option for standard delimited files, JSON, or XML. JSON and XML
adhere to the guidelines in the Outbound Formats section of this document .
© Copyright IBM Corporation 2011, 2013. 40
Field
File Header
Description
This field is only available when the value of Export Type is Flat. If you enter a value in the File Header field, the text entered into this field is written to the export file before any other data is written to the file. For example, if you need to add copyright or processing instructions, you could place it here and the data in this field will be printed before the header columns are printed.
File to DC Scheme
The File to DC scheme imports delimited files into IBM TRIRIGA DataConnect staging tables. Use the
File to DC scheme if you do not have access to or the training required to use an ETL tool. With this scheme you can use workflows to process and validate data, giving you additional control over error handling.
For information about DataConnect, see the DataConnect chapter in the Application Building for the
IBM TRIRIGA Application Platform: Data Management book.
When you select the File to DC scheme, the Integration Object form expands to open a Database section, a File section, and a DataConnect section, as well as adding a Data Map tab.
After you define your mapping, save the map, and run the integration object, the entries are inserted into the DataConnect staging tables with an upsert action. You must select one or more fields in the
Data Modeler as a key. DataConnect uses the keys to determine if it needs to do an insert or an update to the row.
Database Section
The fields in the Database section identify the data source.
Field
Datasource Name
Table Name
Description
The Datasource Name is a locator field that represents connections to various databases. You use this field to predefine data source access with a username, password, and connection string. You can connect to as many databases as needed.
Click the search icon to see the list of existing data sources. From this list, you can add new data sources as needed. The name of the data source is used as a filter to find the correct data source when the Integration Object runs.
You must select a data source object that gives you access to the IBM
TRIRIGA S_ staging tables.
The name of the table from which the integration pulls data. For testing, you must use the value DC_JOB.
The Database section action tests the database connection .
© Copyright IBM Corporation 2011, 2013. 41
The File to DC scheme is completely separate from the TRIRIGA internal APIs and uses the Connector for Business Applications to communicate with TRIRIGA. However, the API does not allow for inspection or manipulation of the DataConnect-related information. The File to DC scheme has code that goes directly against the database to inspect, read, and write to.
The following summarizes the access that is required to the tables needed for the File to DC scheme.
The tables other than DC_JOB and the S_ tables are used to determine the columns available for the
DataConnect objects and must have Read capabilities for the user selected in the data source.
Table
IBS_SPEC_TYPE_STAGE
Read
X
Write
IBS_SPEC_TYPE
X
SYS.COLUMNS (MSSQL)
SYS.TABLES(MSSQL)
IBS_MODULE
ALL_TAB_COLUMNS (ORACLE)
DC_JOB
S_ tables
X
X
X
X
X
X
X
X
File Section
You use the File section to define the path on the computer or network to the file you want to import.
Element
File Name
File Path
Delimiter
Test File Access
Description
The name of the file to be imported.
The network folder containing the file.
The delimiter used for the file. The three options are Tab \t, Pipe
|
, and Double Colon ::.
You select the
Test File Access action to determine if the integration object can connect to the file. After the connection is established, a workflow runs that attempts to read the file. The workflow also attempts to create a file in the directory specified, write to it, and then delete it. If everything is successful, then the color of the section bar changes to green and the text on the section bar changes to File Access Successful.
You can manually provide a binary field that is a copy of the integration field to be imported. You can use a manual field to assist in testing, so that localized processing can be repeated without overwriting the import file.
© Copyright IBM Corporation 2011, 2013. 42
After a file has been imported, it is renamed with the processing date and moved to a folder named processed
.
If there are multiple workflow agents running, you must verify that either all servers have access to the file location or be sure that the file is on all servers. This is because the workflow that runs during the
Execute process for the integration needs to have access to the file and path specified.
DataConnect Section
The DataConnect section defines elements required for DataConnect functionality.
Field
Business Object
Concurrency
DataConnect Type
Description
The business object that this integration uses to trigger the workflow that is tied to DataConnect. The business objects are in the triDataConnectJob
module.
Select whether the DataConnect job runs as a single thread transaction or as a multi-tread transaction.
1 –
Standard
Creates one job for the one business object selected.
When this integration object runs, the process flow is
2 -
Multi a. New job number created from max DC_JOB number. b. New entry inserted into DC_JOB table with new job number, business object, and a status of 1 (New). c. Staging Table is loaded with job number, form name, state of 2 (Ready) and action of 4 (Upsert). d. DC_JOB table is updated to status of 2 (Ready).
The integration loads multiple staging tables and runs them as one job. You must select a value for
IntegrationObject Dependent. The objects do not need to be correlated, but they are all available in the workflow.
When this integration object runs, the process flow is, a. New job number created from max DC_JOB number. b. New entry inserted into DC_JOB table with new job number, business object, and a status of 1 (New). c. Staging Table is loaded with job number, form name, state of 2 (Ready) and action of 4 (Upsert). d. Query for the IntegrationObject Dependent and
© Copyright IBM Corporation 2011, 2013. 43
Field Description
repeat steps a through c until an object reached no longer has an IntegrationObject Dependent defined. e. DC_JOB table is updated to status of 2 (Ready).
IntegrationObject Dependent This field is used only when the value of DataConnect Type is 2 –
Multi
. It identifies the locator field to the other Integration
Objects.
Data Map Tab
In the File to DC scheme, you use the Data Map tab to define the mappings between the delimited file uploaded and the columns in the staging table defined for the object you select.
The Integration Map field is a binary field that stores the mapping that you define for how data is to be imported. The file is stored and parsed as a JavaScript Object Notation (JSON) object that contains the information that is collected from the Data Map tab. This data is stored as application instance data.
The list of modules is limited to the modules that have business objects that have been identified as
Has Staging Table in the Data Modeler. The list of business objects is specific to those that are marked for Has Staging Table.
When a business object is selected, a query runs and displays the database columns available in the staging table associated with the business object. The name of the staging table is populated in the
Staging Table field and is read only. You must specify a value in the Form field for the process to work correctly.
The list on the left side shows the fields defined in the Data Modeler as staging table fields. The elements that are grayed out with a strikethrough are used by the automatic process and cannot be mapped. The other fields are available and when clicked add another row to the table on the right.
The External column defaults to the column name, but you can change it to match your file header.
The isKey, isParent, and Default columns are read only and are not used.
Because you are mapping your file to the staging database columns, the first row of the file must have columns that match the External column. The sequence of the columns does not matter, but the column names are case sensitive. For example, if the External columns in the map are listed as Field1,
Field2, Field3, then the actual external columns can be Field2, Field1, Field3. As long as the names are identical, the fields are applied correctly.
After your map is complete, you must click the
Save Map action. If you click either the Save form action or the Save & Close form action, your mappings are lost. When you save the map, the data you specified is collected and stored in the Integration Map binary field in the Map section.
Http Post Scheme
The Http Post scheme exports data to a server using HTTP protocol. When you select the Http Post scheme, the Integration Object form expands to open an Http Post section and a Query for Outbound section, as well as adding a Response Map tab.
© Copyright IBM Corporation 2011, 2013. 44
Http Post Section
You use the Http Post section to define the server to which the data is sent.
Tokens can be added to the values of the Http URL, Http URI, and Headers fields. A token is a value that is sourced from the query results for this post. The token name must exactly match the column label in your query. For example, to add the value from the column labeled accountId in your query results to the Http URI field, enter /ws/account/{accountId}/property in the Http URI field. At runtime, it renders the value returned in the query result. If the value of accountId is 123, then the
URI sent is /ws/account/123/property. The values in the last result row provide the tokens when a batch request is made using tokens.
Field
Post Type
Description
The format of the post. If you select XML format, the Query for
Outbound adds an XSLT for further transformation.
JSON Runs the query specified in the Query for
Outbound section, converts the results to JSON format , and applies that as the entity of the
request made to the specified HTTP URL.
To batch all records as one submission, do not specify a response type.
To make a separate request for each record returned by the query, specify a response type.
This matches up the request/response to the correct records.
PARAMETER Runs the query specified in the Query for
Outbound section, converts each row into Post parameter name and value pairs, and submits each record separately. No batch submission.
QUERY_STRING Runs the query specified in the Query for
Outbound section, converts each row in URLappended, query string parameter name and value pairs, and submits.
XML
Although there is no data in the body of the
HTTP request and the URL has values appended to it, the request type is Post, not Get.
Runs the query specified in the Query For
Outbound section, converts the results to XML format , and applies that as the entity of the
request made to the specified HTTP URL.
To batch all records as one submission, do not specify a response type.
© Copyright IBM Corporation 2011, 2013. 45
Field
Response Type
Description
To make a separate request for each record returned by the query, specify a response type.
This matches up the request and response to the correct records.
The format for the response sent for each request. When selected, the integration expects the response to match up to fields defined in the Response Map tab.
Flat The response expects a simple response string to be mapped to a field in IBM TRIRIGA. For example, if the response prints “Success” or “Failure”, you can map that string as-is to a field that can be used as a decision point in a post-processing workflow.
JSON
The response expects a response in the form of a JSON object. You define the JSONPath as the external field in the Response Map tab. JSONPath is a standardized, dot notation syntax to traverse a JSON object to a specific value.
The Response Map used to map a field to an IBM TRIRIGA value expects only simple definitions. If the element you want to map is in an array, you must specify the index of the array you want to continue down.
For example, candidates[0].location.x returns -
12819744.7565
in the following JSON object:
{
"spatialReference" : {
"wkid" : 102100
},
"candidates" : [
{
"address" : "6720 Via Austi Pky, Las Vegas, NV,
89119",
"location" : {
"x" : -12819744.7565,
"y" : 4309920.3012000024
},
"score" : 100,
"attributes" : {
}
},
{
"address" : "6721 Via Austi Pky, Las Vegas, NV,
89119",
"location" : {
"x" : -12819812.309700001,
"y" : 4309994.186999999
},
"score" : 79,
"attributes" : {
}
}
© Copyright IBM Corporation 2011, 2013. 46
Field
Http URL
Http URI
Request Method
Description
]
}
XML The response expects the response to be in the form of an
XML object. You define the XPath as the external field in the Response Map tab. XPath is a standard, slash notation syntax to traverse a XML object to a specific node or value.
For more information on XPath, see http://www.w3.org/TR/xpath/ or http://www.zvon.org/xxl/XPathTutorial/General/example s.html
Although XPath provides a way to do complex definitions, the Response Map used to map a field to an IBM TRIRIGA value expects only simple definitions. If the element you want to map is in an array, you must specify the index of the array you want to continue down.
For example, //root/candidate/location[2]/x returns 5 in the following XML object:
<root>
<candidate>
<location>
<x>1</x>
<y>2</y>
</location>
<location>
<x>5</x>
<y>6</y>
</location>
</root>
</candidate>
After the integration process completes, the records that were affected by the response are listed in the Associations tab of the integration instance record with an association string of Sourced.
The dynamic portion of the location of the server receiving the data.
For example, when there is a production server and a test server, the value of the Http URL field changes to identify the server to be used and the value of the Http URI field does not change.
The static portion of the location of the server receiving the data.
For example, when there is a production server and a test server, the value of the Http URI field does not change; however, the value of the Http URL field changes to identify which server is to be used.
The HTTP request method.
DELETE
GET
The origin server is to delete the resource identified by the value of the value of the Http
URI field.
The origin server is to return a copy of the data
© Copyright IBM Corporation 2011, 2013. 47
Field
Content-Type
Omit Request Entity
Send As Batch
Headers
Description
for the resource identified by the value of the
Http URI field.
POST The origin server is to add the resource enclosed in the request as a new subordinate of the resource identified by the value of the Http URI field.
PUT The origin server is to update the entity identified by the value of the Http URI field.
The format of the request header used to specify data in the body of an entity.
If selected, the body of the request is excluded from the request.
If selected, the records identified in the query are sent in a group instead of one at a time.
You can add custom headers to be sent with the request in the format {name}:{value}. For example, to send userID with the value 12345 in the header, set the value of this field to userID:12345
.
You use the other fields in the Http Post section to define the security.
Field
UserName Parameter
UserName
Add To Header
Description
This option only affects the Http Post scheme when the UserName field has a value.
If your post does not require user name and password parameters, the UserName Parameter field must be blank.
If your post does not require a user name and password, the
UserName field must be blank.
This option only affects the Http Post scheme when the UserName field has a value.
If selected, the values in the UserName Parameter field and the
Password Parameter field are added to the header of the request going out. The values of each are the corresponding UserName and
Password fields.
Use Auth Basic
No encoding is provided. However, this option can be used as SSO where the token must be applied to the header.
This option only affects the Http Post scheme when the UserName field has a value.
© Copyright IBM Corporation 2011, 2013. 48
Field Description
If selected, the UserName field and the Password field must have values. When selected, an Authorization Basic encoding entry is added into the header of the request going out.
The user name and password are concatenated with a colon : and then Base64 encoded. This is a standard security protocol.
If the UserName field has a value and both the Use Auth Basic check box and the Add To Header check box are selected, the scheme uses Use Auth Basic.
If the UserName field has a value and neither the Use Auth Basic check box nor the Add To Header check box is selected, the values in the UserName Parameter field and the Password Parameter field are added as post variables of the request going out. The values of each are the corresponding
UserName and Password fields. No encoding is provided.
Response Map Tab
The Response Map tab maps the response parameters from the request to an existing IBM TRIRIGA
the Data Map tab, and response mapping is only allowed for simple field values.
Outbound Formats
Element
JSON
Description
You can select JSON as the Post Type for the Http Post scheme or as the Export Type for the File scheme. When you select JSON, the
Query for Outbound section displays the Include Record ID check box.
The format of the JSON object has two objects: data and header.
The data object contains an array of objects containing the label name and value for the columns from the outbound query and also includes the boId and recId if specified.
The following example shows a typical default JSON structure:
{
"data": [
{
“[column_label]”:”[column_value]”,
"boId": 10002100,
"recId": 2999294
},
…
],
"header": [
"[column_label]",
…
]
}
© Copyright IBM Corporation 2011, 2013. 49
Element
XML
Description
You can select XML as the Post Type for the Http Post scheme or as the Export Type for the File scheme. When you select XML, the
Query for Outbound section contains the Include Record ID check box, the XSLT binary field to contain the XSLT for any customized export formats, and the Use Query Label As Element check box, which determines whether the export uses the label from the query as the XML node.
The default XML structure includes three nodes for each column: field, label, and value. The following example shows this default XML structure:
<query>
<continueToken/>
<results total="13">
<result recordId="11430080" associatedRecordId="null" boId="106402">
<columns>
<column>
<field>triIdTX</field>
<label>HR_ID</label>
<value>1000000</value>
</column>
...
</columns>
</result>
...
</results>
</query>
If the Use Query Label As Element check box is selected, the default
XML structure changes. The label and value nodes are merged by using the label as a node. The following example shows the default
XML structure when the Use Query Label As Element check box is selected:
<query>
<continueToken/>
<results total="13">
<result recordId="11430080" associatedRecordId="null" boId="106402">
<columns>
<column>
<field>triIdTX</field>
<HR_ID>1000000</HR_ID>
</column>
...
</columns>
</result>
...
</results>
</query>
XML query results for dates include the raw values (the value stored in database) and the display value(the formatted value displayed to the user) and function as follows:
The following example shows the XML structure when the Use Query
Label As Element check box is not selected. displayValue is added to the XML results.
© Copyright IBM Corporation 2011, 2013. 50
Element Description
<column>
<field>Date</field>
<label><![CDATA[Date]]></label>
<value><![CDATA[1359964800000]]></value>
<displayValue><![CDATA[02/04/2013]]></displayValue>
</column>
<column>
<field>DateTime</field>
<label><![CDATA[Date_Time]]></label>
<value><![CDATA[1360009800000]]></value>
<displayValue><![CDATA[02/04/2013
12:30:00]]></displayValue>
</column>
The following example shows the XML structure when the Use Query
Label As Element check box is selected. [name]_display is added to the XML results.
<column>
<field>Date</field>
<Date><![CDATA[1359964800000]]></Date>
<Date_display><![CDATA[02/04/2013]]></Date_display>
</column>
<column>
<field>DateTime</field>
<Date_Time><![CDATA[1360009800000]]></Date_Time>
<Date_Time_display><![CDATA[02/04/2013
12:30:00]]></Date_Time_display>
</column>
Schema validation is available for the XML that implements XSLT.
You can use one of the following methods to trigger schema validation:
Either - In the XSD Location field, type the URL to a public hosted schema validation.
Or - In the XSD Location field, type the path containing the full name of the XSD that is uploaded into the XSD Files field. The file in the XSD Files field must be a .zip file.
If schema errors are found during the validation, the errors are logged in the Integration instance record. If the XSD Location field is empty, no schema validation occurs.
When the Validate Only check box is selected, the records are not submitted. Instead, the information is collected, formatted, and validated against the schema. If no errors are found, the Integration
Object record returns to the Ready state and the Execute History section shows the process and that the record count is zero. If errors are found, the Integration Object record is in the Failed state and the Execute History section shows the process and a count of the errors found. The error messages are captured in the instance record.
The Http Post scheme can call out to a URL and retrieve (and process) multiple records in the response. This feature is only available when the value of Response Type is XML. No query is needed; however, if you do submit a query, it should be limited to
© Copyright IBM Corporation 2011, 2013. 51
Element
XSLT
Description
one record only as multiple records will make multiple calls. If you do not specify a query, you must set the Request Type to empty.
In the Response Map external field column, you must represent the section of the XML that is repeatable with the token [i]. If you set a key, it will update the record based on that. In the following example, to map to the Name node in the XML, you would set
//result[i]/columns/column/Name
, and to get the recordId attribute you would set //result[i]/@recordId.
<?xml version="1.0" encoding="UTF-8"?>
<query>
<continueToken/>
<results total="6">
<result recordId="11464082" associatedRecordId="null" boId="10025526">
<columns>
<column>
<field>triNameTX</field>
<Name><![CDATA[Default Map]]></Name>
<Name_display><![CDATA[Default Map]]></Name_display>
</column>
<column>
<field>triIdTX</field>
<ID><![CDATA[001]]></ID>
<ID_display><![CDATA[001]]></ID_display>
</column>
</columns>
</result>
<result recordId="11464531" associatedRecordId="null" boId="10025526">
<columns>
<column>
<field>triNameTX</field>
<Name><![CDATA[SecondMap]]></Name>
<Name_display><![CDATA[SecondMap]]></Name_display>
</column>
<column>
<field>triIdTX</field>
<ID><![CDATA[002]]></ID>
<ID_display><![CDATA[002]]></ID_display>
</column>
</columns>
</result>
...
The XSLT field is a binary field that can be used to house the style sheet to convert the default XML format from the outbound query to the format that your interface requires. This field is not required and if left blank exports the values from the query with the default XML structures. If the XSLT field is populated, you can use either the default or query label as element options to pass to your XSLT to further process or transform your data. Selecting the Use Query
Label As Element check box helps to identify the columns in your
XSLT file for processing.
You can find a utility for testing XSLT in real time at the following link: http://www.w3schools.com/xml/tryxslt.asp?xmlfile=simple&xsltfile= simple
© Copyright IBM Corporation 2011, 2013. 52
Other Ways to Trigger Integration
Integration can be triggered from the Execute action on the Integration Object form. You also can
trigger integration if you need to filter the query used for an outbound integration with data from the currently running process. Additionally, the Integration Object makes it possible for external systems to call into TRIRIGA to trigger the Execute action or to retrieve the results of a TRIRIGA query in JSON format.
Triggering Integration from an Object
The following example demonstrates how to filter a query used for an outbound integration with data from the currently running process.
For example, you made changes to a subset of records, but you only want to send a record when a user clicks an action. You can use a special Custom task object built into the Integration ClassLoader that uses workflow variables to set data. By using this feature, you can build out the subset of records in the workflow using the common methods and then pass the subset by reference to the Custom task and assign the Integration Object to trigger to a workflow variable named IntegrationObject.
The workflow below demonstrates the absolute minimum to enable this functionality to work.
Example: Basic Workflow
The Class Name field for the Custom task is set to
Integration:com.tririga.custom.integration.Parameter
. You must use this class name when implementing this method. The Parameter class inside of the Integration ClassLoader is implementing the CustomParamBusinessConnectTask Java Interface class with a signature of: public CustomParamTaskResult execute(TririgaWS client, Map params, long userId, Record[] records)
© Copyright IBM Corporation 2011, 2013. 53
The params arguments are the assigned IntegrationObject variable so that the process has the instructions it needs to continue the integration. The records argument is the Records section in the
Custom task where you assign the records to use for the workflow process.
Instead of triggering the event on one object, you are passing two sets of objects to an event.
The Parameter looks for the Integration Object from the IntegrationObject variable and processes the results in the records argument passed in by running the query specified in the Integration Object
Query for Outbound section and filtering by the record IDs of the records passed in. By doing this, you are exporting with the common utilities, but you are no longer bound by all or nothing queries or by triggering the event directly from the Integration Object Execute action.
To continue with the scenario, make the workflow asynchronous and set it to run when a person record is saved.
Example: Start Task
In the Query task named Query For Integration Object in the example, you query for the Integration
Object that you want to trigger and then filter the results of that query by name. You must have only one result.
© Copyright IBM Corporation 2011, 2013. 54
Example: Query Task named Query For Integration Object
In the Variable Definition task named Define IO as Variable in the example, you define the Integration
Object as a variable. The result of the query in the previous task is now assigned to this variable.
Example: Variable Definition Task named Define IO as Variable
© Copyright IBM Corporation 2011, 2013. 55
In the Variable Definition task named IntegrationInstance in the example, you define the Integration
Instance object as a variable. This variable is used for the return value from the Custom task at the end of the example.
Example: Variable Definition Task named IntegrationInstance
In the Query task named Query for subset of people in the example, you get the filtered set of records to be processed for the integration. The task calls a query named triEmployee – Find and filters for records where the value of the triFirstNameTX field contains Rodrigo.
© Copyright IBM Corporation 2011, 2013. 56
Example: Query Task named Query for subset of people
For any business object that is used in the Query that is passed to the Integration Object, you must include the triRecordIdSY field in the business object definition. At runtime, the Integration Object uses the triRecordIdSY field to retrieve the remaining fields in the object defined in the Data Map.
In the Custom task named Custom Task in the example, you pass the results of the Query for subset of people task as the list of records. The Class Name is
Integration:com.tririga.custom.integration.Parameter
to define the ClassLoader object named “Integration” and the path to the implementation class named “Parameter” that understands how to receive and process this information.
The Parameter class expects a variable named IntegrationObject to connect to the metadata. The return variable is needed to get the Integration Instance record. The name of the return value must be
IntegrationInstance
.
© Copyright IBM Corporation 2011, 2013. 57
Example: Custom Task
Triggering Integration from a URL
An external system can call into IBM TRIRIGA by passing parameters to trigger the Execute action of an
Integration Object or to retrieve the results of a query in JSON format.
Triggering an event externally from a URL that includes the credentials can only be performed on IBM
TRIRIGA Application Platform version 3.3 and later.
Authentication can be specified in one of three ways:
You can add the credentials to the Http Request Header in the form of Basic Authorization.
You can add USERNAME and PASSWORD parameters with their values to the header of the Http
Request in plain text.
You can add the USERNAME and PASSWORD parameters with their values to the query string of the Http Request or as Post parameters, in plain text.
© Copyright IBM Corporation 2011, 2013. 58
Triggering the Execute Action
To trigger an Integration Object externally, you set the credentials and then pass the added parameter of ioName in the query string with the name of the Integration Object. For example, to trigger a
Geocode Address Integration Object, you would call the following URL: http://localhost:8001/html/en/default/rest/Integration?USERNAME=system&PASSWO
RD=admin&ioName=Geocode +Address
This returns Successful if it was able to trigger the action on that record, or it returns the error message if there was an error.
Calling the Execute action on an Integration Object is an asynchronous event, so it is not possible to get the results of a process synchronously. Should you need more immediate feedback of the results, you could tie a notification event to the completion of the Integration Object to have the IBM TRIRIGA system notify you when the processing is complete. Another option is to poll IBM TRIRIGA for that information.
Retrieving Query Results
Any query defined in the Report Manager can be executed from a web address originating outside of
IBM TRIRIGA. To specify the query, you use following parameters:
Parameter Required / Optional
action Required
Description
Must be set to query module bo
Required if no continue token used
The name of the module of the query you are calling.
Optional The business object for the query. If there is more than one, omit this parameter. query Required if no continue token used
The name of the query to execute. f ct
Optional
Required if requesting next batch
The format you want returned. Options are:
json
– (default) minimized JSON string
pjson
– JSON string in print format that makes it easier to read
xml
– minimized XML string
pxml – XML string in print format that makes it easier to read
tab – tab delimited text
A continue token is returned when the results of the query are larger than the 1000 result default. When attempting to retrieve the next batch of records, you need to pass this parameter with the token specified in the previous response.
For example, this specifies a query for all employees: http://localhost:8001/html/en/default/rest/Integration?USERNAME=system&PASSWO
RD=admin&action=query&module=triPeople&bo=triPeople&query=triEmployee+-
+Find&f=pjson
© Copyright IBM Corporation 2011, 2013. 59
Error Handling
If there are failures during an integration, the record is not saved. The integration summary displays the errors that occurred, and each record that failed is represented as a Failure record. A Failure record contains an instance record representation that you can manually edit and resubmit.
The Resubmit Record field in an Instance Failure record is a note field that contains the key value pairs that represent the business object that you were trying to create or update. You can manually edit the data in the Resubmit Record field and then click the
ReSubmit form action to resubmit the record.
When a resubmitted record completes successfully, the name of the record changes from Failure to
Successful and the text in the Error Message field and the Resubmit Record field is cleared. The
Integration Instance records counts are updated to reflect the correct values, that is, the number in the Records Successful field is increased by one and the number in the Records Failed field is decreased by one. When the Record Failed count is equal to zero, click the Complete action on the
Integration Object form.
Geocode Example
You can set up an Integration Object record that uses the Http Post scheme to export information to an
Esri server and map data from the response back to the Location records to update the geocodes.
Note that the Http URL in this example provides Esri geocoding services through their REST API. The
Esri geocoding service expects the request to contain parameters in the string to know what addresses to geocode. The response is in JSON format. The web address in this example is http://tasks.arcgisonline.com/ArcGIS/rest/services/Locators/TA_Streets_US_10/
GeocodeServer/findAddressCandidates
Geocode Example: General Tab
© Copyright IBM Corporation 2011, 2013. 60
You use the Data Map tab to define the fields to be extracted from IBM TRIRIGA. The values in the
External column are the names used for the parameters added to the query string. In the example, there are two additional parameters, outSR and F, that specify the WKID and format that the Esri service expects. The other fields are dynamically pulled from the Location records in IBM TRIRIGA.
Geocode Example: Data Map Tab
The Response Map tab handles the response from Esri and maps the latitude and longitude to the
Location record. Note that since the response is in JSON format, the syntax in the External columns is in JSONPath.
Geocode Example: Response Map Tab
When the Execute action is triggered, the following occurs:
1. The values in the Data Map tab are used to construct a dynamic query and the query is called.
2. Because the value of the Post Type field is QUERY_STRING, each result from the query is transformed into something similar to the following URL (the actual parameters depend on the data in IBM TRIRIGA): http://tasks.arcgisonline.com/ArcGIS/rest/services/Locators/TA_Streets_
US_10/GeocodeServer/findAddressCandidates?Street=6720+Via+Austi+Pkwy&ZI
P=89119&City=Las+Vegas&State=Nevada&outSR=102100&f=json
3. The response looks like the following JSON object:
{
"spatialReference": {
"wkid": 102100
© Copyright IBM Corporation 2011, 2013. 61
},
"candidates": [{
"address": "6750 Via Austi Pky, Las Vegas, NV, 89119",
"location": {
"x": -12819797.2097,
"y": 4309906.7360000014
},
"score": 100,
"attributes": {
}
},
{
"address": "6751 Via Austi Pky, Las Vegas, NV, 89119",
"location": {
"x": -12819812.309700001,
"y": 4309948.0605999976
},
"score": 79,
"attributes": {
}
}]
}
4. The values in the Response Map tab specify that the integration needs to extract candidates[0].location.y and candidates[0].location.x from the JSON object and map them to the triGisLatitude and triGisLongitude fields in IBM TRIRIGA.
5. The Location record is updated with the new data.
6. Since no action was specified for the data being sent out of IBM TRIRIGA in the Query for
Outbound section, no actions are triggered on the Location data.
7. The final tally of the integration process is collected and an Execute History object is created with the information and any errors that may have occurred.
Additional Resources
Upgrading the TRIRIGA Integration Object
When a new installer is available for the IBM TRIRIGA Application Platform, you can specify whether the platform installer is to update the TRIRIGA Integration Object when it runs. To signal to the platform installer that it should not upgrade the TRIRIGA Integration Object, before starting the platform installer, create an Integration Object record named IGNORE_UPGRADE. Do not execute the record; the record only has to be present in the system. Then, when the platform installer runs, it does not update the Integration Object even if the platform installer build is newer than the current installed platform version.
If you do not create an Integration Object record named IGNORE_UPGRADE, when the platform installer runs, it updates the Integration Object if the platform installer build is newer than the currently installed platform version.
© Copyright IBM Corporation 2011, 2013. 62
Object Glossary
The following objects are the elements in the Integration Object. They are delivered with this adapter and are listed here for quick reference.
Object
Integration Object
(triIntegration)
Description
triIntegration
is the primary business object. It contains the integration metadata definition.
DataSource
(triDataSource)
This object contains property settings for connecting to a database. This object is referenced in the Integration Object as a single-record smart section. This allows the reuse of datasource definitions across multiple Integration Object definitions. triIntegrationI nstance
(triIntegration
Instance
Instance Failure
(triIntegration
InstanceFailure
)
)
This object contains the information about a specific instance of an integration run. It contains the counts, the time it took to run, a collection of error messages (if any), and a query section with details for each record that failed. The object has associations to records that were affected by the response.
This object is contained within the
Integration Object record as the Execute
History section.
This object contains details of a single record that failed for an inbound integration. It contains the error message for the failure and a simplified representation of the record that was submitted that can be manually edited and resubmitted.
Integration ClassLoader
The Integration Object requires the use of a TRIRIGA ClassLoader instance object named Integration. The Integration ClassLoader object is made up of three elements in the Resource Files query section. They are TRIRIGAIntegration.jar,
TRIRIGAIntegration_Assets.zip
, and jtds-1.2.5.jar.
Note
– IBM TRIRIGA is delivered with the Oracle JDBC driver, which you use when connecting to an Oracle database. IBM TRIRIGA does not include a database driver for MSSQL. If you are connecting to a MSSQL server database, you must include a MSSQL driver such as the jtds-1.2.5.jar and create a Resource File with this library included, attached to the Integration
ClassLoader object.
63 © Copyright IBM Corporation 2011, 2013.
Object Description
TRIRIGAIntegrat ion.jar
This Java jar file contains all of the classes used for the TRIRIGA Integration Object components. The Java classes in this jar are written to work in conjunction with the
TRIRIGA Integration Object. There are
Custom workflow task entry points as well as a communication layer used by the
TRIRIGAIntegration_Assets.zip
file elements.
TRIRIGAIntegrat ion_Assets.zip
This zip file contains all of the HTML,
JavaScript, CSS, and images used by the
DataMap custom tab on the Integration
Object for inbound integrations. The
JavaScript communicates with the Java API of IBM TRIRIGA Connector for Business
Applications with the use of URI-based
Servlet Proxy handles. The server side elements are contained within the
TRIRIGAIntegration.jar
. jtds-1.2.2.jar
This jar is the database driver for MSSQL server. IBM TRIRIGA does not provide this file. If you use MSSQL server, you must add the jTDS database driver.
Standard Workflows
Workflow
triIntegration -
Execute
Description
Asynchronous
This workflow is triggered when the user selects the Execute action.
This is the primary workflow. The following diagram shows the standard workflow:
© Copyright IBM Corporation 2011, 2013. 64
Workflow Description
triIntegration -
Generate Test Data
The workflow controls the status displayed to the user. The Trigger
Integration task is a Custom workflow task that calls
Integration:com.tririga.custom.integration.Integrati
on
and is the primary entry point for all Integration Objects. The information about what to do during the integration is defined in the
Integration Object and is passed by record ID to the Custom task. triIntegration -
Generate SQL for Table
Synchronous
This workflow is triggered from the Database section action to generate the SQL for use with your staging tables.
Synchronous
This workflow is triggered from the Database section action to generate randomized data that populates your staging tables to be used for testing, such as functional testing or load testing. triIntegration -
HideShow Data Sections
Synchronous
This workflow is triggered from the initial loading of a new
Integration Object as well as various elements on the form as an
OnChange workflow. This workflow shows and hides the form elements as needed for the integration you are defining.
© Copyright IBM Corporation 2011, 2013. 65
Workflow Description
Synchronous triIntegration -
PreLoad triIntegration –
Resubmit
This workflow is called when a new Integration Object is opened. It calls the triIntegration – ResetMetaData and triIntegration – HideShow
Data Section workflows. triIntegration - Reset
MetaData
Synchronous
This workflow resets the form elements that are to be blanked out.
It is called from the triIntegration – PreLoad workflow.
Asynchronous
This workflow is triggered when you resubmit a failed record from the triIntegrationInstanceFailure record. triIntegration - Test
DB Connection
Synchronous triIntegration - Test
File Access
This workflow is triggered from the Database section action to call select count(1) from {table_name}
on the database defined to validate that it can communicate and execute SQL commands on that database.
Synchronous triDataSource - Reset
Metadata
This workflow is triggered from the File section action to Create,
Read, and Delete a file to the directory or network location specified.
Asynchronous triDataSource - Test
DB Connection
This workflow resets the triDataSource record.
Synchronous
This workflow is triggered from the triDataSource record to call select count(1) from {table_name}
on the database defined to validate that it can communicate and execute SQL commands on that database
Standard Queries
Manager Default - Integration Objects
triIntegration - get Instances
triIntegration - getIntegrationObject
triDatasource - getIntegrationObject datasource
triIntegrationFailures - Get all failures
© Copyright IBM Corporation 2011, 2013. 66
Standard Lists
The lists are in the triIntegration module.
triDataConnectTypeLI
triDbDriverName
triFileExportTypeLI
triIntegrationDirection
triIntegrationFileDelimiter
triIntegrationPostTypeLI
triIntegrationType
Determining the Integration Version
To determine which version of the Integration Object you have installed, you go to the http://{localhost:8001/context}/html/en/default/rest/Integration
web address. The result displays the build date, number, and version number for the version you are currently running.
User Guides
See the following IBM TRIRIGA user guides for more information about the IBM TRIRIGA Application
Platform, such as workflows, the Data Modeler, business objects, forms, queries, state transitions, the
IBM TRIRIGA Connector for Business Applications, ClassLoaders, and Servlet Proxy.
Application Building for the IBM TRIRIGA Application Platform 3
Application Building for the IBM TRIRIGA Application Platform 3: Data Management
IBM TRIRIGA 10 Connector User Guide (this book)
IBM TRIRIGA Connector for Business Applications 3 Technical Specification
© Copyright IBM Corporation 2011, 2013. 67
Appendix A: Connector Technology
IBM TRIRIGA connectors allow extended functionality to be coded and distributed through an Object
Migration package. It uses the IBM TRIRIGA ClassLoader business object and Resource File that correspond to their IBM TRIRIGA Application Platform feature components as well as Custom workflow components such as CustomTask, CustomParameters, and CustomTransitions. The use of the Servlet
Proxy, an extension of ClassLoaders, also gives a handle to the Java IBM TRIRIGA Connector for Business
Applications (BC) API (no SOAP, just java) that allows for easy integration into external systems with custom form components via Java Servlet style programming.
The audience for this appendix should include those familiar with the IBM TRIRIGA application building tools, IBM TRIRIGA Connector for Business Applications, and the Java Programming Language. A connector can only be implemented using the Java Programming Language.
Custom ClassLoader
The IBM TRIRIGA Custom ClassLoader has two components that work in tandem to allow you to deploy
Java classes into the application server domain. Below is a diagram of how that works:
Custom ClassLoader
© Copyright IBM Corporation 2011, 2013. 68
How This Works
When you create a ClassLoader instance, you can add custom java classes to the classpath of the application server in one of three ways: Parent First, Parent Last, and Isolated. These classes can be accessed via a Custom task in workflow for programmatic interaction or can be extended to work as a
Java Servlet, extending the form capabilities for portal sections and custom tabs in objects.
To access your classes from a Custom task, loaded through the ClassLoader. Make sure that the following elements are in place:
To Access Your Classes from a Custom Task
Step 1
Your class packages can start with only one of these three structures. Everything else will be blocked.
com.tririga.ps
com.tririga.appdev
com.tririga.custom
Step 2
In the ClassName field in the IBM TRIRIGA workflow Custom task, you must specify the
ClassLoader name separated by a colon.
For example if you have a ClassLoader instance named "MyClassLoader" and your entry class is "com.tririga.custom.myclassloader.Hello" your ClassName field will look like this:
MyClassLoader:com.tririga.custom.myclassloader.Hello
This allows workflow to search for your class within the context of the ClassLoader specified.
Step 3
The last thing you need to do is implement one of the various com.tririga.workflow.pub.CustomTask
objects available from the distributed
TririgaCustomTask.jar
in the {IBM TRIRIGA_INSTALL_FOLDER}/tools/IBM
TRIRIGA Connector for Business Applications
.
For development, you need to include the TririgaBusinessConnect.jar and the
TririgaCustomTask.jar
into your IDE classpath. These two libraries should not be included into the ClassLoader business object as they will be ignored.
How to Load Your Files into the ClassLoader
Follow these steps to load your files into the ClassLoader:
To Load Your Files into the ClassLoader
Step 1
Navigate to Tools > System Setup > System > Class Loader.
Step 2
Select
ENERGY STAR.
© Copyright IBM Corporation 2011, 2013. 69
To Load Your Files into the ClassLoader
The system opens the ENERGY STAR ClassLoader form.
The ClassLoader object requires that you provide a unique name and the ClassLoader type. Inside this object is the Resource Files query section. Add your classes and form assets, such as HTML, Flash, JS, Images, properties files, in this section.
The Resource File field is of type Binary and is required. This allows you to upload the file that will be used for this ClassLoader. The Name field is required and you can make it identifiable as belonging to this ClassLoader. A Resource File object can be used in more than one ClassLoader.
Tip
– A good rule of thumb is to prefix library names with an abbreviation of the
ClassLoader and the real name of the library.
If you are uploading a *.jar file, only the *.class files will be loaded into the Classpath. For convenience, if you have many assets (for example, html, js, images) you can put them into a *.zip file and upload them as a single file. You also can upload a file individually, such as a configuration file, so that you can more easily modify just a single file.
Development
If you have access to the <IBM TRIRIGA_INSTALL_DIR>/userfiles/<ClassLoaderName> folder, you can select the check box named Development Mode on the ClassLoader object.
When this check box is checked, the ClassLoader ignores the revision number and always pulls from the
<IBM TRIRIGA_INSTALL_DIR>/userfiles/<ClassLoaderName>
directory. This gives you the freedom to change any files like HTML, JS, flash, or images and see your changes with a simple refresh of the page and not have to actually upload them to ClassLoader object.
Attention – If you clear the Development Mode check box, the system pulls the latest files from the ClassLoader and potentially overwrites all your work.
© Copyright IBM Corporation 2011, 2013. 70
Servlet Proxy
The Servlet Proxy is an extension of the ClassLoader functionality that allows you to develop Servlet style classes that can render, redirect, and communicate with form assets within your ClassLoader object. The assets must be uploaded to the ClassLoader object as Resource Files.
The following diagram shows how the Servlet Proxy works on the server:
Servlet Proxy
© Copyright IBM Corporation 2011, 2013. 71
Implementing the Hook
As with the ClassLoader objects used exclusively through the Custom task in workflow, you need to implement a Java Interface class contained in the TririgaCustomTask.jar.
To get your Servlet Proxy to render correctly and pass through your code, you will need to follow these steps:
To Get Your Servlet Proxy to Render Correctly and Pass Through Your Code
Step 1
Create a Java class in the package com.tririga.custom and implement the com.tririga.pub.adapter.IConnect
Java Interface.
Note that the package com.tririga.custom is the only package that will allow you to create an implementation class, so make sure that it is unique.
The IConnect class has one method that needs to be implemented called execute
.
If you have a class named “MyFirstConnector”, your code should look like this: public class MyFirstConnector implements IConnect { public void execute(TririgaWS tws, HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
//your code goes here.
}
}
Step 2
Looking at this method you can see that you have a handle to a TririgaWS Interface class, which is the Java Interface for the IBM TRIRIGA Connector for Business
Applications API, and you have your basic request and response that you would normally have in a Java Servlet.
Add the following code to your execute method where it says “your code goes here.”
PrintWriter out = response.getWriter(); try{ response.setContentType("text/html"); out.println("<html><head></head><body marginwidth='0' marginheight='0' style='margin:0;padding:0;border:0;'>"); out.print("Hello World"); out.println("</body></html>"); out.flush();
} finally { if(out!=null)out.close();
}
This will print out an html page with the words “Hello World”.
Step 3
Compile this class and add it to a JAR file named “MyFirstConnector.jar”.
Now navigate to System > ClassLoader and click Add.
The ClassLoader name and the Java class implementing IConnect must be named the same. You can have only one IConnect implementation class per ClassLoader object. Since this class is “MyFirstConnector”, that is what you must name your
ClassLoader instance.
© Copyright IBM Corporation 2011, 2013. 72
To Get Your Servlet Proxy to Render Correctly and Pass Through Your Code
Step 4
Add a new Resource File instance and upload your “MyFirstConnector.jar” file. Click
Save.
When you modify, add, or remove a Resource File from the ClassLoader object, it will fire a workflow that increments the revision number. A change to this revision number tells the IBM TRIRIGA Application Platform to reload this ClassLoader instance.
Step 5
Your Servlet Proxy is now configured and ready to be accessed.
Accessing a Connector
If you have configured your Servlet Proxy correctly, it will be available at the following URL: http://<yourserver>/html/en/default/rest/MyFirstConnector
.
You need to have a valid login to access this URL. The easiest way is to add this URL to an external link section for a portal section or within a custom tab external link within any form.
All access to your Servlet Proxy will now happen from the above base URL. Navigating to the base URL in this example, your screen will print out the words “Hello World.”
Should you need to access any files within your ClassLoader Resource File section, you can do so by appending the word resource to the base URL and then the path to the resource you want to load.
For example, if you have an image as a Resource File called “helloWorld.jpg” you can load this image dynamically with this URL: http://<yourserver>/html/en/default/rest/MyFirstConnector/resource/helloWorld.jpg
The server checks to see if this resource has been loaded yet and if it has not it pulls the file from the
Binary field on the Resource File object and places it into the <IBM
TRIRIGA_INSTALL_DIR>/userfiles/<ClassLoaderName>
folder. When a request is made, it checks the cache and matches it to the revision number in the ClassLoader. If they are different, it reloads all the files that are not part of a *.jar file into this directory and refers to this location for each subsequent request.
The benefit to this is that it allows your files to be available on any application servers that may be running and will automatically refresh any changes made, so that they can be seen without having to bounce the server.
Debugging
There are a couple of ways to debug the ClassLoader, the ServletProxy, and/or your custom Connector.
The following section briefly explains some common ways to achieve this.
Set Platform Logging
In the Administrator Console under the Platform Logging managed object, turn on debugging for the
Class Loader and the Servlet Proxy objects to help you debug any problems you may be having. These
© Copyright IBM Corporation 2011, 2013. 73
logs are verbose but will give you a better understanding of what the server is doing with all of the libraries and assets. The IBM TRIRIGA Application Platform 3 Administrator Console User Guide describes how to access and use the Administrator Console.
Modify CustomLogCategories.xml
You can modify the CustomLogCategories.xml file. If you have access to the <IBM
TRIRIGA_INSTALL_DIRECTORY>/config
folder, you can find a file named
CustomLogCategories.xml
. To add a custom category to the Platform Logging section in the
Administrator Console, adding the custom category to this file and restarting the server. This method is preferred, because you only need to set this up one time. If the server is ever restarted, all you need to do is select a check box to turn DEBUG back on.
© Copyright IBM Corporation 2011, 2013. 74
Appendix B: Allowed Values
The following table shows the allowed / required values for the ENERGY STAR attributes and meters. Check with https://www.energystar.gov/istar/has/ for the latest requirements and parameters available.
Object Type Field Element
Meters / Energy Logs meterEnergyType meterGenerationMethod
Allowed Values
(Verbatim)
District Chilled Water
District Hot Water
Coal (anthracite)
Coal (bituminous)
Coke
Diesel
District Steam
Electricity
Kerosene
Liquid Propane
Natural Gas
Other
Propane
Steam
Wood
Fuel Oil (No. 1)
Fuel Oil (No. 2)
Fuel Oil (No. 4)
Fuel Oil (No. 5 and No. 6)
Integration Field
Types and Defaults
Integration
Translations
© Copyright IBM Corporation 2011, 2013. 75
Object Type Field Element
meterEnergyUnit
Allowed Values
(Verbatim)
Grid Purchase *
MBtu
MLbs
MWh
Mcf ccf cf daily tons gal kBtu kLbs kWh kcf
Integration Field
Types and Defaults
Integration will default this value.
On-Site Solar
On-Site Wind
Electric-Driven Chiller
Absorption Chiller using
Natural Gas
Engine-Driven Chiller using
Natural Gas
Other
Integration will set up a properties file to map the full IBM
TRIRIGA UOM with the abbreviated ABS value, so that it can be easily modified if needed.
Integration
Translations
© Copyright IBM Corporation 2011, 2013. 76
Object Type
Computer Data
Center
Hospital (Acute Care or Children's)
Field Element
meterActiveIndicator meterAddToTotal meterReadingSetAction
Gross Floor Area
Operating Hours/Week
Gross Floor Area
Maximum Number of Floors
Number of Licensed Beds
Tertiary Care
Laboratory
Laundry Facility
Allowed Values
(Verbatim)
lbs therms ton hours tons cu m l
Y
N
Y
N
New *
ReplaceAll
ReplaceRange
0-9 numbers
0-168
0-9 numbers
0-99
0-9999
Yes/No
Yes/No
Yes/No
© Copyright IBM Corporation 2011, 2013.
Integration Field
Types and Defaults
Integration will default this value.
Number
Number
Number
Number
Number
List
List
List
Integration
Translations
Integration will translate Yes to Y and
No to N.
Integration will translate Yes to Y and
No to N.
Integration will translate Yes to Y and
No to N.
77
Object Type
Hotel
K-12 School
Field Element
Number of Buildings
Ownership Status
Food Preparation Facility
Gross Floor Area
Number of Rooms
Workers on Main Shift
Number of Refrigeration/Freezer
Units
% Heated
% Air conditioned
Average Occupancy
Laundry Facility
Guest Hours
Guest Meals
Spa Floor Area
Gym Floor Area
Laundry Quantity
% Air-Conditioned
% Heated
Cooking Facility
Gross Floor Area
Allowed Values
(Verbatim)
0-999
For Profit, Governmental,
Non Profit
Integration Field
Types and Defaults
Number list
Yes/No List
Integration
Translations
0-9 numbers
0-9999
0-9999999
0-9 numbers
0-100
0-100
0-100
<15 hours/day, 15 - 19 hours/day, 20+ hours/day
0-9 numbers
0-9 numbers
0-9 numbers
0-9 numbers
0-100
0-100
Yes/No
0-9 numbers
Number
Number
Number
Number
Number
Number
Number list
Number
Number
Number
Number
Number
Number
List
Number
Integration will translate Yes to Y and
No to N. xsd Type not looks valid.
Integration will hardcode "lbs/year" as
UOM
Integration will translate Yes to Y and
No to N.
© Copyright IBM Corporation 2011, 2013. 78
Object Type
Medical Office
Bank/Financial
Institution
Courthouse
Office
Field Element
Months in use
Number of PCs
School district
Number of Refrigeration/Freezer
Units
High School
Open Weekends
% Air-Conditioned
% Heated
Gross Floor Area
Number of Workers
Operating Hours/Week
Gross Floor Area
Number of PCs
Workers on Main Shift
Operating Hours/Week
Percent Air conditioned
Percent Heated
Gross Floor Area
Number of PCs
Workers on Main Shift
Operating Hours/Week
Percent Air conditioned
Percent Heated
Gross Floor Area
Number of PCs
Allowed Values
(Verbatim)
08-12
0-9 numbers
String
0-9 numbers
Yes/No
Yes/No
0-100
0-100
0-9 numbers
0-9999
0-9 numbers
0-9 numbers
0-9 numbers
0-9999999
0-168
0-100
0-100
0-9 numbers
0-9 numbers
0-9999999
0-168
0-100
0-100
0-9 numbers
0-9 numbers
© Copyright IBM Corporation 2011, 2013.
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
Integration Field
Types and Defaults
Number
Number
String
Number
List
List
Integration
Translations
Integration will translate Yes to Y and
No to N.
Integration will translate Yes to Y and
No to N.
79
Object Type
Parking
Other
Residence
Hall/Dormitory
Retail
Field Element
Workers on Main Shift
Operating Hours/Week
Percent Air conditioned
Percent Heated
Parking ft2 that is enclosed (with roof)
Parking ft2 that is unenclosed (with roof)
Parking ft2 that is open
Weekly Hours of Access
Gross Floor Area
Operating Hours/Week
OtherType
% Air-Conditioned
% Heated
Gross Floor Area
Number of Rooms
Dorm Computer Lab
Allowed Values
(Verbatim)
0-9999999
0-168
0-100
0-100
0-9 numbers
0-9 numbers
0-9 numbers
0-168
0-9 numbers
0-168
String
0-100
0-100
0-9 numbers
0-9999
Yes/No
Dorm Dining Hall Yes/No
Gross Floor Area
Operating Hours/Week
0-9 numbers
0-168
Open and Closed
Refrigeration/Freezer Cases
0-9 numbers
Walk-in Refrigeration/Freezer Units 0-9 numbers
Workers on Main Shift 0-999
Number of PCs 0-9 numbers
© Copyright IBM Corporation 2011, 2013.
Integration Field
Types and Defaults
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number
String
Number
Number
Number
Number list list
Number
Number
Number
Number
Number
Number
Integration
Translations
Integration will pick up from Subtype field
Integration will translate Yes to Y and
No to N.
Integration will translate Yes to Y and
No to N.
80
Object Type
Warehouse
(Refrigerated)
Warehouse
(Unrefrigerated)
Field Element
Number of Cash Registers
Percent Air conditioned
Percent Heated
Exterior Entrance
Supermarket/Grocery Percent Heated
Swimming Pool
Percent Air-Conditioned
Cooking Facilities
Allowed Values
(Verbatim)
0-9999999
0-100
0-100
Yes/No
0-100
0-100
Yes/No
Gross Floor Area
Workers on Main Shift
0-9 numbers
0-999
Operating Hours/Week 0-168
Walk-in Refrigeration/Freezer Units 0-9 numbers
Months in Use
Indoor/Outdoor
Pool Size
1-12
Indoor, Outdoor
Short course (25 yards x 20 yards), Recreational (20 yards x 15 yards), Olympic
(50 meters x 25 meters)
Gross Floor Area
Number of Workers
Operating Hours/Week
% Air-Conditioned
0-9 numbers
0-9999
0-168
0-100
% Heated
Gross Floor Area
Number of Workers
Operating Hours/Week
0-100
0-9 numbers
0-9999
0-168
Walk-in Refrigeration/Freezer Units 0-9 numbers
Number
Number
Number
Number
Number list list
Number
Number
Number
Number
Number
Number
Number
Number
Number
Integration Field
Types and Defaults
Number
Number
Number list
Number
Number list
Integration
Translations
Integration will translate Yes to Y and
No to N.
Integration will translate Yes to Y and
No to N.
© Copyright IBM Corporation 2011, 2013. 81
Object Type Field Element
Distribution Center
Multifamily Housing
House of Worship
Gross Floor Area
Number of Units
Bedrooms per Unit
Number of Floors
0-9 numbers
0-99
0-9 numbers
0-9 numbers
Percentage of square footage for living units
Number of laundry hookups in individual units
0-100
0-9 numbers
Number of common laundry hookups 0-9 numbers
0-9 numbers Number of dishwashers in individual units
% Heated
% Air Conditioned
0-100
0-100
Regulation Type Affordable, Market Rate,
Both Affordable and
Market Rate
0-9 numbers Gross Floor Area
Seating Capacity
Weekdays in Operation
Operating Hours
PCs
Commercial Food Prep
0-9999999
0,1,2,3,4,5
0-168
0-9 numbers
Yes/No
Number
Number
Number
Number
Number
Number
Number
Number
Number
Number list
Number
Number list
Number
Number list
Commercial Refrigerator/Freezers
Allowed Values
(Verbatim)
Yes/No
0-9 numbers
Integration Field
Types and Defaults
Number
Integration
Translations
Integration will translate Yes to Y and
No to N.
Number
Integration will translate Yes to Y and
No to N.
© Copyright IBM Corporation 2011, 2013. 82
INDEX
Add Security ........................................... 27
Application Settings ................................... 3
Baseline ................................................ 11
Basemaps Section .................................... 26
Blank White Screen .................................. 30
Bubble Marker ......................................... 24
Bubble Marker Label ................................. 29
Building .......................... 7, 10, 11, 12, 13, 15
Building Equipment ................................... 8
Classifications ................................... 3, 6, 8
Clear Preferences .................................... 28
Complete ............................................... 32
Constructed URL ...................................... 28
Create .................................................. 14
Creating a Custom GIS Portal Section ............. 25
Custom ClassLoader .................................. 68
Custom Widget ........................................ 27
CustomLogCategories.xml .......................... 74
Data Attribute Item for Energy Star Form ........ 7
Data Attributes Section............................... 7
Data Map Tab ..................................... 33, 44
Database Scheme ..................................... 37
DataConnect ........................................... 41
Debug ................................................... 32
Details Section ......................................... 7
Direction ............................................... 31
Duplicate Records .................................... 29
Energy Rating .................................... 10, 14
Energy Rating Alert .................................. 10
Energy Rating Certification ......................... 16
Energy Rating Comparison to Average ............ 17
Energy Rating Error .................................. 10
Energy Rating Form .................................. 13
Energy Rating Improvement ........................ 18
Energy Rating Result Section ................... 7, 15
Energy Rating Settings ................................ 3
Energy Rating Setup Section .................... 7, 10
Energy Rating Type .................................... 3
Energy Ratings Sub-Tab .............................. 8
Energy Space Type .................................... 6 energyStar.log ........................................ 10
Environmental Manager ............................. 14
Environmental Manager Portal ..................... 15
Environmental Tab .................................... 8
EPA ENERGY STAR ..................................... 2
EPA ENERGY STAR Automated Benchmarking
System ................................................ 3
Example Widgets ..................................... 27
Execute ................................................. 32
Execute History Section ............................. 32
Export .................................................. 28
External ................................................ 25
File Scheme ............................................ 39
File to DC Scheme .................................... 41
Flattened Hierarchy .................................. 29
Form Builder .......................................... 25
Generate SQL for Table ............................. 38
Generate Test Data .................................. 39
GIS ...................................................... 23
GIS Map............................................ 24, 25
GIS Performance ...................................... 29
GIS Portal Section .................................... 24
GIS Tab ................................................. 25
Grid Label ............................................. 29
Http Post Scheme .................................... 44
Icon ..................................................... 27
Initial Extents Section ............................... 26
Integration ClassLoader ............................. 63
Integration Credentials Section ..................... 3
Integration Map ....................................... 33
Integration Notification .............................. 9
Integration Object .............................. 31, 63
Integration Type ...................................... 10
Isolated ................................................ 69
Issue .................................................... 13
Layers Section ........................................ 27
Location ................................................ 29
Location Primary Use ................................. 8
Location Status ....................................... 14
Locations ................................................ 7
Map Section ........................................... 33
Metric Categories..................................... 15
Metric Details ......................................... 16
Metric ID ............................................... 15
Metric Query ..................................... 26, 29
Missing Location on GIS Map ........................ 29
No GIS License ........................................ 30
Options Tab ........................................... 27
Parent First ............................................ 69
Parent Last ............................................ 69
Pin Color ............................................... 27
Platform Logging ..................................... 73
Preview Tab ........................................... 28
Primary Use ............................................ 7
Process Type .......................................... 11
Projected Yearly Savings ....................... 15, 19
Published Name ...................................... 31
Query For Outbound Section ....................... 36
Query List Section .................................... 26
Query Standards ...................................... 29
Ranking by Quartile .................................. 21
Rate ..................................................... 22
Rating Transaction Status Section ................. 13
Response Map Tab .................................... 49
Retail Location ..................7, 10, 11, 12, 13, 15
Save Map .......................................... 35, 44
Save Preferences ................................ 24, 28
Scheme ................................................. 31
Security Group ........................................ 27
Servlet Proxy .......................................... 71
Set Baseline ........................................... 11
Show Details Tab ........................... 26, 27, 28
Show Table Tab .................................. 27, 28
Smart Section ......................................... 35
Spatial Query Data Service ......................... 23
State Geography ...................................... 22
Structure ........................ 7, 10, 11, 12, 13, 15
System Tab ............................................ 28
Target .................................................. 11
Test DB Connection .................................. 38
Token ................................................... 45 triIntegration .......................................... 63
TRIRIGA ArcGIS Connector .......................... 23
Update ................................................. 13
Utility Meter............................................ 8
Widgets Section....................................... 27
WKID .................................................... 26
Notices
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document in other countries.
Consult your local IBM representative for information about the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in this document.
The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte character set (DBCS) information, contact the IBM Intellectual
Property Department in your country or send inquiries, in writing, to:
Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan, Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan
The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the products and/or the programs described in this publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:
IBM Corporation
2Z4A/101
11400 Burnet Road
Austin, TX 78758
U.S.A.
Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.
The licensed program described in this document and all licensed material available for it are provided by
IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.
Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.
All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.
This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.
Privacy Policy Considerations
IBM Software products, including software as service solutions, (“Software Offerings”) may use cookies or other technologies to collect product usage information, to help improve the end user experience, to tailor interactions with the end user or for other purposes. In many cases no personally identifiable information is collected by the Software Offerings. Some of our Software Offerings can help enable you to collect personally identifiable information. If this Software Offering uses cookies to collect personally identifiable information, specific information about this offering’s use of cookies is set forth below.
This Software Offering does not use cookies or other technologies to collect personally identifiable information.
If the configurations deployed for this Software Offering provide you as customer the ability to collect personally identifiable information from end users via cookies and other technologies, you should seek your own legal advice about any laws applicable to such data collection, including any requirements for notice and consent.
For more information about the use of various technologies, including cookies, for these purposes, see
IBM’s Privacy Policy at www.ibm.com/privacy and IBM's Online Privacy Statement at www.ibm.com/privacy/details in the section entitled “Cookies, Web Beacons and Other Technologies” and the "IBM Software Products and Software-as-a-Service Privacy Statement" at www.ibm.com/software/info/product-privacy/ .
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business
Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at
“ Copyright and trademark information ” at www.ibm.com/legal/copytrade.shtml
.
பதிவிறக்கு
பொது இணைப்பு புதுப்பிக்கப்பட்டது
உங்கள் அரட்டைக்கான பொது இணைப்பு புதுப்பிக்கப்பட்டுள்ளது. You may view and manage your chat links after registration here.
ஆவண பொது இணைப்பு
விளம்பரம்
