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
Clears the staging table data based on the rule code supplied
Inputs
| Input | 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 |
Get Reports List
Gets a list of available reports
Inputs
| Input | Detail |
|---|---|
| Search Folder | Enter the folder to for reports in |
| 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
Gets the version of your Planful instance
Inputs
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
Loads data into staging tables of the Planful application
Inputs
| Input | Detail |
|---|---|
| Rule | Enter the name (code) of the rule to load data into |
| Data | Enter the file containing the data to load into the Rule. Each line should be a separate entry. |
| Delimiter | Select the delimiter used within each line to separate the 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
Retrieves the collection of GLData objects to meet the filter criteria supplied. Each object returned corresponds to a row of GL Data in the database.
Inputs
| Input | 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
Retrieves the collection of Segment1 objects that meet the filter criteria supplied. Each object returned corresponds to a data row of segment1 in the database.
Inputs
| Input | 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
Retrieves the collection of Segment2 objects that meet the filter criteria supplied. Each object returned corresponds to a data row of segment2 in the database.
Inputs
| Input | 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
Retrieves the collection of Segment3 objects that meet the filter criteria supplied. Each object returned corresponds to a data row of segment3 in the database.
Inputs
| Input | 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
Retrieves the collection of Segment4 objects that meet the filter criteria supplied. Each object returned corresponds to a data row of segment4 in the database.
Inputs
| Input | 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
Retrieves the collection of Segment5 objects that meet the filter criteria supplied. Each object returned corresponds to a data row of segment5 in the database.
Inputs
| Input | 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
Retrieves the collection of Segment6 objects that meet the filter criteria supplied. Each object returned corresponds to a data row of segment6 in the database.
Inputs
| Input | 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
Retrieves the collection of Segment7 objects that meet the filter criteria supplied. Each object returned corresponds to a data row of segment7 in the database.
Inputs
| Input | 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
Retrieves the collection of Segment8 objects that meet the filter criteria supplied. Each object returned corresponds to a data row of segment8 in the database.
Inputs
| Input | 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
Runs a report and returns its results in a JSON format
Inputs
| Input | Detail |
|---|---|
| Report Code | Enter the code of the report to run |
| Lineage | Enter where the report lives in Planful |
| 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
Transfers the staging table data to the destination table in Planful based on the rule code
Inputs
| Input | 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 |