runAprioriReport.cmd

To generate spreadsheet reports from the command line, you run the runAprioriReport.cmd command, which is found in

apriori_install\version\install\bin

This command takes seven arguments which must be provided in the exact order shown below. Only the seventh (final) argument is optional.

Syntax

runAprioriReport.cmd co_type co_name xml_report_file xls_output_file
[ scenario_name ]username password

Arguments

co_type -- Cost object type: either part, assembly, rollup, or dynamicRollup .

co_name -- Cost object name:

xml_report_file -- The full pathname to the XML spreadsheet report definition file.

xls_output_file -- The full pathname to the Excel file to be populated.

scenario_name -- [Optional] If scenario_name is omitted, "initial" is assumed.

username -- The aPriori log-in account name to use for this report session.

password -- The associated aPriori password.

Notes:

1. The order of arguments has changed as of aPriori Release 2018 R1 for compatibility with Single Sign On (SSO): If the optional scenario_name argument is used; it must precede any username and password credentials. If you have existing scripts from release prior to 2018 R1, you must ensure that these arguments follow the new ordering when upgrading.

2. If username and password are not specified as arguments on the command line, the report utility looks for them in the properties file. If not found there, and if your aPriori administrator has implemented Single Sign On (SSO), the report utility attempts to use the currently logged-in user’s Windows credentials.

Examples

To run a custom report named "XYZ" that resides in folder named C:\Files, from the command line, and generate an Excel file named "results" in the same folder, for a part named "r5":

runAprioriReport.cmd part R5 C:\Files\XYZ.watchpoints.xml C:\Files\results.xls initial user1 user1passwd

To run the system-defined Cost Driver report from the command line and generate an Excel spreadsheet in a folder named "files", for a part named R6:

runAprioriReport.cmd part R6 “apriori_install\ext\cost-watchpoint-report\watchpoints\Cost Driver.watchpoints.xml” c:\files\results.xls initial user1 user1passwd