Using the Reporting Module

By entering ReportCmd.exe followed by the relevant options at the command line, you can generate any summary report available in Alloy Navigator.

Syntax

The following string shows the command syntax:

ReportCmd.exe /Report="Report_Name" [/File="Output_File"] [/Type="File_Type"] /AccessKey="Key_Name" [/Server="SQL_Server_Name"] [/Database="DB_Name"] [/AdditionalParamName1=Value1] [/AdditionalParamName2=Value2]...

There are two groups of command line options: parameters common for all the reports and additional parameters for a specific report. The following table lists the common command-line options:

Option Description

/Report="Report_Name"

The name of the report to generate (required). You can specify the name of any summary report that exists in Alloy Navigator.

/File="Output_File"

The full path and/or name of the output file. The default file name is the report name. You can specify a full path name, including a drive letter or UNC path. If you provide the file name only, the output file will be created here: %ProgramData%\Alloy Software\Alloy Navigator\8.0\Reports

A series of macros are available to specify the value of this option; for details, see Macros for output file names.

/Type="File_Type"

The output file type: PDF | EXCEL | EXCELOPENXML | WORD | WORDOPENXML | IMAGE

If absent, a PDF file is created (if the /File option does not specify a different type).

/AccessKey="Key_Name" The name of the Database Access Key for the Alloy Navigator database to connect.

/Server="SQL_Server_Name"

The name or network address of the SQL Server instance which hosts the Alloy Navigator database you want to connect.

Specify only if the SQL Server name differs from the SQL Server name in the Database Access Key.

/Database="DB_Name"

The Alloy Navigator database to import the data into.

Specify only if the database name differs from the database name in the Database Access Key.

All the options are case-insensitive.

For details on additional parameters, which are specific for particular reports, see Additional Command-Line Parameters.

For explanation of possible error messages, see Error Messages.

Examples

The tables below contain examples of using the utility:

Command Explanation

ReportCmd.exe /type=Excel /report="Change Request List" /AccessKey="SERVER_001 : DB_001" /Date_From=eolm /Date_To=eod /Group_By=Category /Sort_By=Date

This command creates the ChangeRequestList.xls file which contains the "Change Request List" report grouped by category and sorted by date for the period from the end of the last month to the end of the current day.

ReportCmd.exe /type=pdf /report="Open WO" /file="C:\Reports\Open_WO_%YYYY-%MM-%DD.pdf" /AccessKey="SERVER_001 : DB_001" /workstation="WS_1" /Date_From=eolm /Date_To=eod /Group_By="Project" /Sort_By="Due Date" /user=neilson /password=report

This command creates a .pdf file in the C:\Reports directory, the file name containing a report date.

ReportCmd.exe /type=pdf /report="Open WO" /file="\\db_SERVER\Reports\%ReportName.pdf" /AccessKey="SERVER_001 : DB_001" /workstation="WS_1" /Date_From=2018-01-01 /Date_To=eolm /Group_By=Project /Sort_By="Due Date" /user="reporter" /password="report"

This command creates a .pdf file in \\DB_SERVER\Reports folder for the period from the beginning of the year 2018 to the end of the last month, the file name is "Open WO.pdf".

Batch-generating and scheduling reports

You can schedule the task of batch-producing reports automatically by taking the following steps:

  1. Create a command file that starts several report-generating procedures, each producing a report in the desired format.

  2. NOTE: If you use macros in your command file (either for output file names or date-time values), the percent marks in the macro names must be doubled.

  3. Add the task of launching that file to the Scheduled Tasks to have reports generated at regular intervals.

If your users are allowed to the Web server's restricted area, you can give them access to the most recent information from the Alloy Navigator database by sending reports to a folder on your Web server.

TIP: Alternatively to scheduling reports as a Windows Scheduled Task, you can configure Alloy Navigator to regularly run a reporting job on the Automation Server. For instructions, see Scheduling reports.