Report Administration Commands

Following is the parameter list of Runtime operations utility for the report administration commands along with the required roles for each command.

Argument	Description	Security Privileges
/REP	Displaying the status of reports	Users must be a member of one of the following COM+ roles to access this administrative function: Report Runners (only able to obtain information on reports they have initiated) Report Monitors Report Recoverers Report Recovery Operators Report Recovery Administrators Application Administrators
/DEL	Deleting report recovery information	Users must be a member of one of the following COM+ roles to access this administrative function: Report Runners (can delete the information of reports they have initiated) Report Recovery Operators Report Recovery Administrators Report Administrators Application Administrators
/RUN	Running or recovering a report	Users must be a member of one of the following COM+ roles to access this administrative function: Report Runners Report Administrators Application Administrators
/STR	Stopping a report	Users must be a member of one of the following COM+ roles to access this administrative function: Report Runners (only able to stop reports they have initiated) Report Operators Report Administrators Application Administrators
/TER	Terminating an active report	Users must be a member of one of the following COM+ roles to access this administrative function: Report Runners (only able to stop reports they have initiated) Report Operators Report Administrators Application Administrators
/WUP	Reactivating a report suspended by a previous Sleep or CriticalPointLogic	Users must be a member of one of the following COM+ roles to access this administrative function: Application Administrators Report Administrators Report Operators Report Recovery Administrators Report Recovery Operators Report Runners

In all the report administration commands, the /S argument is mandatory. This argument specifies a valid system name. Additionally, the argument that specifies the report name is a mandatory argument in most of the report administration commands. Refer to Displaying the Status of an Application for more information about the /S argument. Refer to Running or Recovering a Report for more information about the report name argument.

Displaying the Status of Reports

The syntax of displaying information about the running reports and reports waiting for recovery in an application is

AdminSystem /S <SystemName> /REP [/H <HostName>]

The information displayed includes

Username: User account
Report Name: Name of the report
Process ID: Process ID of the report
Report Status: Status of the report
ID: The Session ID / recovery key of the report

Parameters

Argument	Description
/S <SystemName>	Specifies that a valid system name must be passed as a parameter. Refer to Displaying the Status of an Application for more information about the /S argument. *Note:* This argument is mandatory.
/REP	You can specify this argument to display information about the reports in an application. *Note:* A key value for recovery information is displayed for each report awaiting recovery. You can use this key value with the /DEL parameter of the command to remove recovery information, or with the /RUN parameter of the command to run a report that is awaiting recovery. For example: To display information about the running reports and reports awaiting recovery, type AdminSystem /S Sample /REP RECOVER
/H <HostName>	Specifies the name of the machine that you want to connect.
/REP /?	Displays the command line syntax and its usage for displaying the report information, and the utility exits without starting the process.

Running or Recovering a Report

The syntax of the runtime operations utility to initiate a report or to recover a report with recovery information is

AdminSystem /S <SystemName> /RUN <ReportName> [/REC key] [/DEV] [/TR] [/LA <lang>] 
[/PA <param>][/H <HostName>]

Parameters

Argument	Description
/S <SystemName>	Specifies that a valid system name must be passed as a parameter. Refer to Displaying the Status of an Application for more information about the /S argument. *Note:* This argument is mandatory.
/RUN <ReportName>	Specifies the name of a report. *Notes:* This argument is mandatory. If you do not pass any value, the error message Provide a valid Report Name , along with the usage of the utility appears. If the specified report name does not exist, an error message specifying that the report does not exist and the name should be checked appears. If you provide empty quotes, " ", or an invalid report name, an error message specifying that the Report is not available appears. If a system is already disabled, the error message "The application has been disabled." appears. For example: To initiate a report with a valid report name and system name, type AdminSystem /S Sample /RUN SampleReport
/REC key	Specifies a unique key value for the recovery information, which is the session id of a recoverable report. For example: To run a report that is awaiting recovery, type AdminSystem /S Sample /RUN SampleReport /REC 43
/DEV	Specifies a device type that overrides a device type set for a report. The valid device type options are LP — Piped to the command defined by the LP alias TP — Piped to the command defined by an alias EX — Output to an alias VD — Output to a temporary file (the name is displayed when the report is initiated) DI — Direct output to an alias DP — Direct output to Enterprise Output Manager *Note:* If you provide invalid device type options, an error message appears.
/TR	Specifies whether tracing is enabled for a report. The default value is "off". For example: To run a report with tracing enabled, type AdminSystem /S Sample /RUN SampleReport /TR on
/LA <lang>	Specifies the language defined for an application *Note:* While setting the language, you should use the language id, such as 1033 for English.
/PA <param>	Specifies a parameter to be passed to a report. *Note:* You can pass a string literal with a maximum of 254 characters to a report. If the string literal contains embedded spaces, enclose the string in quotation marks (""). For example: To run a report by passing a report parameter, "SampleName", type AdminSystem /S Sample /RUN SampleReport /PA SampleName
/H <HostName>	Specifies the name of the machine that you want to connect.
/RUN /?	Displays the command line syntax and its usage for running a report, and the utility exits without starting the process.

Stopping a Report

The syntax of the runtime operations utility for stopping a report is

AdminSystem /S <SystemName> /STR <ReportName> [/MIX <ProcessId>] [/H <HostName>]

You can use the command to stop reports that are either waiting for input or contain the following logic commands:

Sleep
CriticalPoint with the Sleep command option

This command has no effect on a running report that is not sleeping. If you pass valid parameters to run the utility, the message "Report has been requested to stop" appears.

Parameters

Argument	Description
/S <SystemName>	Specifies that a valid system name must be passed as a parameter. Refer to Displaying the Status of an Application for more information about the /S argument. *Note:* This argument is mandatory.
/STR <ReportName>	Specifies the name of a report. Refer to Running or Recovering a Report for more information about the report name argument. For example: To stop a report with a valid report name, type AdminSystem /S Sample /STR SampleReport
/MIX <ProcessId>	Specifies the process ID of a report.
/H <HostName>	Specifies the name of the machine that you want to connect.
/STR /?	Displays the command line syntax and its usage for stopping a report, and the utility exits without starting the process.

Terminating an Active Report

The syntax of the runtime operations utility for terminating an active report is

AdminSystem /S <SystemName> /TER <ReportName> [/MIX <ProcessID>] 
[/REC <NORECOVERY|RECOVER|DISCARD>] [/H <HostName>]

You can use the command to terminate an active report immediately. This command is useful if a report is looping or has been started accidentally. You can terminate any inquiry reports without affecting the remainder of the application.

Notes:

It is recommended for a report to detect error conditions and terminate normally. A report containing the Sleep or Accept logic command reflects the following behavior:

If a report contains Sleep logic statements, transactions prior to the last Sleep logic statement are committed to the application database.
If a report with a Sleep logic statement that is initiated from a client session is terminated, it is recommended to terminate the client session manually either from the task manager or with other user commands.
If a report with an Accept logic statement that is initiated from a client session is terminated, the client session might wait for your input to end the session. This is applicable only for reports initiated from the command prompt. A report that is initiated from the GUI clients behaves differently as you can continuously supply commands without waiting for the report completion.
If you pass valid parameters to run the utility, the message "Report has been requested to terminate" appears.

Parameters

Argument	Description
/S <SystemName>	Specifies that a valid system name must be passed as a parameter. Refer to Displaying the Status of an Application for more information about the /S argument. *Note:* This argument is mandatory.
/TER <ReportName>	Specifies the name of a report. Refer to Running or Recovering a Report for more information about the report name argument. For example: To stop a report with a valid report name and system name, type AdminSystem /S Sample /TER SampleReport
/MIX <ProcessId>	Specifies the process ID of a report. *Note:* This argument is optional and takes the value of the user account that initiated the report, if not specified.
/REC <NORECOVERY\| RECOVER\|DISCARD>	Determines the handling of any transaction in progress. You can use one of the following recovery options to terminate a report. NORECOVERY — Use, if the report is not to be rerun. Any recovery information saved for the report is deleted, unless extended recovery is in use. This is the default option DISCARD — Use if the report is not to be rerun. Any recovery information saved for the report is deleted RECOVER — Use to rerun the report, attempting to recover up to and including any transaction it might have been processing when the command was executed. Two attempts are made to recover the report. If both fail, a message is sent to the error log and no further attempts are made. *Note:* If you provide invalid options for recovery mode, the error message "Invalid input specified" appears. For example: To terminate a report by enabling the recovery mode, "RECOVER", type AdminSystem /S Sample /TER SampleReport /REC RECOVER
/H <HostName>	Specifies the name of the machine that you want to connect.
/TER /?	Displays the command line syntax and its usage for terminating a report, and the utility exits without starting the process.

Waking Up a Report

The syntax of the runtime operations utility for waking up a report is

AdminSystem /S <SystemName> /WUP <ReportName> [/PA <param>] [/H <HostName>]

The command reactivates a report that is suspended by a previous Sleep or CriticalPoint logic command. When a Wake logic statement is executed, a Wake message is sent to the specified report. The Wake messages are sent to any reports with the same repository path, segment name, and report name that are suspended on the same workstation. If you pass valid parameters to run the utility, the message "Report invoices woken up" appears. If a report to be reactivated is not available, the message "Failed To Wake Up Report" appears.

Parameters

Argument	Description
/S <SystemName>	Specifies that a valid system name must be passed as a parameter. Refer to Displaying the Status of an Application for more information about the /S argument. *Note:* This argument is mandatory.
/WUP <ReportName>	Specifies the name of a report. Refer to Running or Recovering a Report for more information about the report name argument. For example: To wake up a report with a valid report name and system name, type AdminSystem /S Sample /WUP SampleReport
/PA <param>	Specifies a parameter to be passed to a report. *Note:* You can pass a string literal with a maximum of 254 characters to a report. If a numeric value is used, it converts to text.
/H <HostName>	Specifies the name of the machine that you want to connect.
/WUP /? /	Displays the command line syntax and its usage for waking up a report, and the utility exits without starting the process.

Deleting Report Recovery Information

The syntax of the runtime operations utility to delete recovery information for a report that is identified in a session is

AdminSystem /S <SystemName> /DEL <SessionId> [/H <HostName>]

If you pass valid parameters to run the utility, the message "Report recovery information deleted" appears. Prior to using the Runtime API command with the /DEL parameter, you can use the /REP parameter to obtain the SessionId value.

Parameters

Argument	Description
/S <SystemName>	Specifies that a valid system name must be passed as a parameter. Refer to Displaying the Status of an Application for more information about the /S argument. *Note:* This argument is mandatory.
/DEL <SessionId>	Specifies the session ID of a report. You can use this value to remove the recovery information of a report that is awaiting recovery. *Note:* This argument is mandatory. A session ID is a unique integer for every session. If the value is invalid or null, an error message specifying that the Input string is not in the correct format appears. For example: To delete the recovery information of a report identified by a session ID, type AdminSystem /S Sample /DEL 47
/H <HostName>	Specifies the name of the machine that you want to connect.
/DEL /?	Displays the command line syntax and its usage for deleting recovery information of a report, and the utility exits without starting the process.

Troubleshooting — Error Messages

This topic provides a list of error messages you might encounter while attempting to use AdminSystem.exe.

If you provide incorrect option for an argument, an error message specifying that the argument is invalid appears, along with the argument and the usage of the utility, for reference.
If you pass an incorrect command, the error message "Invalid input specified" appears.
If you pass an incorrect argument, an error message specifying that the input is invalid appears, along with the argument and the usage of the utility, for reference.
If you do not pass the mandatory argument or arguments to the command line utility, an error message specifying that the mandatory input is missing or invalid appears, along with the usage of the utility for the relevant runtime administration operations or report administration operations, for reference.
If system is disabled for any of the command line function, an error message specifying that the specified system has been disabled appears. You must enable the system to proceed with runtime or report administrative functions.
If you pass an incorrect value for an argument, an error message specifying that the input is invalid appears, along with the argument and the usage of the utility, for reference.
If you pass duplicate arguments, the error message "Encountered duplicate arguments. Please address the duplicates before proceeding" appears.