To extract data via UltiPro® reports as part of a chain, add a step that includes an UltiPro connection command. By leveraging the integration between this and other applications' connections, you can integrate UltiPro data in a variety of use cases, from key performance indicator (KPI) dashboards and mashups, to data replication and custom reporting front-ends.
Connection Properties
To enable these commands, an IT admin first creates an UltiPro connection and configures its credentials and properties.
Note: To enable integration, the UltiPro Reports-as-a-Service API provides a programmatic interface to the UltiPro Business Intelligence Reports via a SOAP-based web service. To connect to UltiPro's API, the connection uses basic authentication.
| Input |
Detail |
| Username |
Enter the UltiPro API username to authenticate with |
| Password |
Enter the UltiPro API password to authenticate with |
| Customer API Key |
Enter the customer API key, such as AAAAA
|
| User API Key |
Enter the user API key, such as AAA9A000000
|
| Host URL |
Enter the URL for the UltiPro API, such as https://service4.ultipro.com
|
Note: All sensitive credentials are automatically encrypted and stored at 2,048-bit encryption.
Execute Report
Runs a report request, and downloads the contents of the report to a comma-separated values (CSV) file
Inputs
| Input |
Detail |
| Report Path |
Enter the path to the report. To find the path in UltiPro, on the report's properties page, click View the search path, and copy the Search path. |
| Parameters |
Enter the parameters to pass to the report. If none, leave blank. |
Outputs
| Output |
Output Type |
| Report |
File |
| Report Key |
String |
| Report Size (Bytes) |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error running the command |
| 2 |
Error |
Unable to authenticate with UltiPro |
Get Report List
Returns a list of the public IBM Cognos® reports
Inputs
| Input |
Detail |
| Name Filter |
Enter the name — or part of the name — of the reports to retrieve (optional). Case-insensitive. |
Outputs
| Output |
Output Type |
| Reports |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error running the command |
| 2 |
Error |
Unable to authenticate with UltiPro |
Get Report Parameters
Retrieves a list of parameters for a report
Inputs
| Input |
Detail |
| Report Path |
Enter the path of the report with the parameters to retrieve. To find the path in UltiPro, on the report's properties page, click View the search path, and copy the Search path. |
Outputs
| Output |
Output Type |
| Report Parameters |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error running the command |
| 2 |
Error |
Unable to authenticate with UltiPro |