To enable communication with your Planful®—formerly Host Analytics®—environment via the service's published REST API interface as part of a chain, add a step with a Planful connection command.
To enable these commands, an IT admin first creates a Planful connector.
Clear data
To clear the staging table data based on a rule code, use a Clear Data command.
Properties
| Property |
Detail |
| Rule |
Enter the name or code of the rule to load data into. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Get reports list
To retrieve a list of available reports, use a Get Reports List command.
Properties
| Property |
Detail |
| Search folder |
Enter the folder to retrieve reports from. |
| Report type |
Enter the type of report to filter on. |
Outputs
| Output |
Output type |
| Reports |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Get version
To retrieve the version of your Planful instance, use a Get Version command.
Properties
None
Outputs
| Output |
Output type |
| Application name |
String |
| Version |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Load data
To load data into staging tables of the Planful application, use a Load Data command.
Properties
| Property |
Detail |
| Rule |
Enter the name or code of the rule to load data into. |
| Data |
Enter the file containing the data to load into Rule. Each line should be a separate entry. |
| Delimiter |
Select the delimiter used within each line to separate Data into columns. |
Outputs
| Output |
Output type |
| Record Count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Retrieve GL data
To retrieve the collection of GLData objects based on filter criteria, use a Retrieve GL Data command. Each object returned corresponds to a row of GL Data in the database.
Properties
| Property |
Detail |
| Filters |
Enter the test filters. |
Outputs
| Output |
Output type |
| GLData (CSV) |
File |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Retrieve Segment1 data
To retrieve a collection of Segment1 objects based on filter criteria, use a Retrieve Segment1 Data command. Each object returned corresponds to a data row of segment1 in the database.
Properties
| Property |
Detail |
| Filters |
Enter the test filters. |
Outputs
| Output |
Output type |
| Segment1 data (CSV) |
File |
| Record count |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Retrieve Segment2 data
To retrieve a collection of Segment2 objects based on filter criteria, use a Retrieve Segment2 Data command. Each object returned corresponds to a data row of segment2 in the database.
Properties
| Property |
Detail |
| Filters |
Enter the test filters. |
Outputs
| Output |
Output type |
| Segment2 data (CSV) |
File |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Retrieve Segment3 data
To retrieve a collection of Segment3 objects based on filter criteria, use a Retrieve Segment3 Data command. Each object returned corresponds to a data row of segment3 in the database.
Properties
| Property |
Detail |
| Filters |
Enter the test filters. |
Outputs
| Output |
Output type |
| Segment3 data (CSV) |
File |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Retrieve Segment4 Data
To retrieve a collection of Segment4 objects based on filter criteria, use a Retrieve Segment4 Data command. Each object returned corresponds to a data row of segment4 in the database.
Properties
| Property |
Detail |
| Filters |
Enter the test filters. |
Outputs
| Output |
Output type |
| Segment4 data (CSV) |
File |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Retrieve Segment5 data
To retrieve a collection of Segment5 objects based on filter criteria, use a Retrieve Segment5 Data command. Each object returned corresponds to a data row of segment5 in the database.
Properties
| Property |
Detail |
| Filters |
Enter the test filters. |
Outputs
| Output |
Output type |
| Segment5 data (CSV) |
File |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Retrieve Segment6 data
To retrieve a collection of Segment6 objects based on filter criteria, use a Retrieve Segment6 Data command. Each object returned corresponds to a data row of segment6 in the database.
Properties
| Property |
Detail |
| Filters |
Enter the test filters. |
Outputs
| Output |
Output type |
| Segment6 data (CSV) |
File |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Retrieve Segment7 data
To retrieve a collection of Segment7 objects based on filter criteria, use a Retrieve Segment7 Data command. Each object returned corresponds to a data row of segment7 in the database.
Properties
| Property |
Detail |
| Filters |
Enter the test filters. |
Outputs
| Output |
Output type |
| Segment7 data (CSV) |
File |
| Record count |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Retrieve Segment8 data
To retrieve a collection of Segment8 objects based on filter criteria, use a Retrieve Segment8 Data command. Each object returned corresponds to a data row of segment8 in the database.
Properties
| Property |
Detail |
| Filters |
Enter the test filters. |
Outputs
| Output |
Output type |
| Segment8 data (CSV) |
File |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Run report
To run a report and return its results as JSON, use a Run Report command.
Properties
| Property |
Detail |
| Report code |
Enter the name or code of the report to run. |
| Lineage |
Enter where the report lives in Planful. Use // as separators in the path. |
| Cube name |
Enter the name of the cube associated with the report. |
| Filters |
Enter the filters to apply to the report. |
| Apply filters |
Select whether to apply the filters. |
Outputs
| Output |
Output type |
| Report |
JSON |
| Report (CSV) |
File |
| Record count |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Transfer data
To transfer the staging table data to the destination table in Planful based on a rule code, use a Transfer Data command.
Properties
| Property |
Detail |
| Rule |
Enter the name (code) of the rule to load data into |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |