Help Desk

Submit a ticket My Tickets
Welcome
Login

Planful Command Reference

The Planful BizApp enables communication with your Planful environment via Web Services.

Connections

Planful

Basic authentication connection. The entered user must have Enable Web Services Access enabled, and your Planful environment must have Web Services enabled.

Inputs

Input Type Detail Notes
Login Name TextField The Login Name for the user in Planful
Password TextField The password for the user in Planful
Tenant code TextField The tenant code for the Planful tenant you are connecting to.
Server address TextField The URL of your Planful tenant (Ex. https://traininglabs.planful.com)

Commands

Clear Data

Clears the staging table data based on the rule code supplied

Inputs

Input Type Detail Notes
Rule TextField The name (Code) of the Rule to load data into

Outputs

None

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Get Reports List

Get a list of available reports

Inputs

Input Type Detail Notes
Search Folder TextField The folder in which to look for reports
Report Type TextField The type of report to filter on

Outputs

Output Output Type Notes
Reports Json

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Get Version

Get the version of your HostAnalytics instance

Inputs

None

Outputs

Output Output Type Notes
Application Name String
Version String

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Load Data

Loads data into staging tables of the Planful application

Inputs

Input Type Detail Notes
Rule TextField The name (Code) of the Rule to load data into
Data FileField The file containing the data to load into the selected Rule. Each line should be a separate entry.
Delimiter TextField The delimiter used within each line to separate the data into columns.

Outputs

Output Output Type Notes
Record Count Integer

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Retrieve GL Data

Retrieves the collection of GLData objects that meet the filter criteria supplied. Each GLData object returned corresponds to a row of GL Data in the database

Inputs

Input Type Detail Notes
Filters GroupField The filters to apply when retrieving GL Data

Outputs

Output Output Type Notes
GLData (CSV) File
Record Count Integer

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Retrieve Segment1 Data

Retrieves the collection of Segment1 objects that meet the filter criteria supplied. Each segment1 object returned from this method corresponds to a data row of segment1 in the database

Inputs

Input Type Detail Notes
Filters GroupField The filters to apply when retrieving GL Data

Outputs

Output Output Type Notes
Segment1 Data (CSV) File
Record Count Integer

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Retrieve Segment2 Data

Retrieves the collection of Segment2 objects that meet the filter criteria supplied. Each Segment2 object returned from this method corresponds to a data row of Segment2 in the database

Inputs

Input Type Detail Notes
Filters GroupField The filters to apply when retrieving GL Data

Outputs

Output Output Type Notes
Segment2 Data (CSV) File
Record Count Integer

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Retrieve Segment3 Data

Retrieves the collection of Segment3 objects that meet the filter criteria supplied. Each segment3 object returned from this method corresponds to a data row of segment3 in the database

Inputs

Input Type Detail Notes
Filters GroupField The filters to apply when retrieving GL Data

Outputs

Output Output Type Notes
Segment3 Data (CSV) File
Record Count Integer

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Retrieve Segment4 Data

Retrieves the collection of Segment4 objects that meet the filter criteria supplied. Each segment4 object returned from this method corresponds to a data row of segment4 in the database

Inputs

Input Type Detail Notes
Filters GroupField The filters to apply when retrieving GL Data

Outputs

Output Output Type Notes
Segment4 Data (CSV) File
Record Count Integer

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Retrieve Segment5 Data

Retrieves the collection of Segment5 objects that meet the filter criteria supplied. Each segment5 object returned from this method corresponds to a data row of segment5 in the database

Inputs

Input Type Detail Notes
Filters GroupField The filters to apply when retrieving GL Data

Outputs

Output Output Type Notes
Segment5 Data (CSV) File
Record Count Integer

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Retrieve Segment6 Data

Retrieves the collection of Segment6 objects that meet the filter criteria supplied. Each segment6 object returned from this method corresponds to a data row of segment6 in the database

Inputs

Input Type Detail Notes
Filters GroupField The filters to apply when retrieving GL Data

Outputs

Output Output Type Notes
Segment6 Data (CSV) File
Record Count Integer

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Retrieve Segment7 Data

Retrieves the collection of Segment7 objects that meet the filter criteria supplied. Each segment7 object returned from this method corresponds to a data row of segment7 in the database

Inputs

Input Type Detail Notes
Filters GroupField The filters to apply when retrieving GL Data

Outputs

Output Output Type Notes
Segment7 Data (CSV) File
Record Count Integer

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Retrieve Segment8 Data

Retrieves the collection of Segment8 objects that meet the filter criteria supplied. Each segment8 object returned from this method corresponds to a data row of segment8 in the database

Inputs

Input Type Detail Notes
Filters GroupField The filters to apply when retrieving GL Data

Outputs

Output Output Type Notes
Segment8 Data (CSV) File
Record Count Integer

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Run Report

Runs a report and returns the report in a JSON format.

Inputs

Input Type Detail Notes
Report Code TextField The code of the report
Lineage TextField Where the report lives in Planful
Cube Name TextField The name of the Cube the report is associated with
Filters GroupField Filters to apply to the report
Apply Filters DropdownField Whether or not to apply the filters

Outputs

Output Output Type Notes
Report Json
Report (CSV) File
Record Count Integer

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command

Transfer Data

Transfers the staging table data to the destination table in Planful based on the rule code

Inputs

Input Type Detail Notes
Rule TextField The name (Code) of the Rule to load data into

Outputs

None

Exit Codes

Code Type Detail
0 Success Command ran successfully
1 Error Error running command
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.