Application Administration Commands

The AdminSystem.exe command line utility replaces most of the functionalities available in the existing Admin.exe and includes system administration capabilities in accordance with the rest of the new Runtime API administration interface features. The Admin.exe is deprecated and removed from the future releases. The use of the administration functionalities is restricted to users with the required security privileges. The security for administration commands is controlled by using the COM+ roles. The required roles for each command are listed in the following table along with the command descriptions.

Following is the parameter list of Runtime operations utility for the application administration commands through the AdminSystem.exe.

Argument

Description

Security Privileges

/S

Displaying the status of an application

Users must be a member of one of the following COM+ roles to access this administrative function:

  • Application Operators

  • Application Administrators

/CLR

Clearing a user session

Users should be a member of the Application Administrators to access this administrative function.

/DIS

Disabling an application

Users must be a member of one of the following COM+ roles to access this administrative function:

  • Application Operators

  • Application Administrators

/ENA

Enabling an application

Users must be a member of one of the following COM+ roles to access this administrative function:

  • Application Operators

  • Application Administrators

/HAM

Setting or displaying the High Account Month (HAM)

Users must be a member of one of the following COM+ roles to access this administrative function:

  • Accountants

  • Application Administrators

/HUB

Displaying, enabling or disabling HUB

Users must be a member of one of the following COM+ roles to access this administrative function:

  • HUB Administrators

  • Application Administrators

/LAM

Setting or displaying the Low Account Month (LAM)

Users must be a member of one of the following COM+ roles to access this administrative function:

  • Accountants

  • Application Administrators

/LANG

Configuring multilanguage

Users should be member of the following Runtime Manager COM+ role to access this administrative function:

  • Runtime Administrators

/LOG

Configuring system logs

Users should be a member of the following Runtime Manager COM+ role to access this administrative function:

  • Runtime Administrators

/LIS

Listing unique Ispecs

Users must be a member of one of the following COM+ roles to access this administrative function:

  • Application Administrators

  • Application Operators

/PRNT

Configuring print properties

Users should be a member of the Editors role of the Print Configuration Manager to access this function.

/SMG

Sending a short message

Users must be a member of one of the following COM+ roles to access this administrative function:

  • Message Senders

  • Message Broadcasters

/STO

Stopping an application

Users must be a member of one of the following COM+ roles to access this administrative function:

  • Application Operators

  • Application Administrators

/UMT

Verifying user tables

To access this administrative function,

  • Users should be a member of the Runtime Administrators role of the Runtime Manager COM+ component.

  • Users should be member of Application Deployers role of the Database Reorganization COM+ component.

  • Users should be member of Application Administrators role of the deployed COM+ application.

/WHO

Displaying a list of current users

Users should be a member of the Application Administrators to access this administrative function.

Displaying the Status of an Application

The syntax of the runtime operations utility to display the status of an application is

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

If you pass valid parameters, a message specifying the status of a specified system appears. The valid system status messages are

Parameters

Argument

Description

/S <SystemName>

Specifies that a valid system name must be passed as a parameter.

Notes:

  • This argument is mandatory.

  • The system name is case-sensitive.

  • If you do not pass any value, the error message "Provide a valid Runtime System Name" appears, along with the usage of the utility.

  • If you provide empty quotes, " ", or an invalid system name, an error message specifying that the system is not available appears.

For example:

  • If you provide an incorrect system name, an error message appears.

    AdminSystem /S Sa
  • To view the system status, type

    AdminSystem /S Sample

    The message "Sample Status: Enabled and Running" appears.

/H <HostName>

Specifies the name of the machine that you want to connect.

/S /?

Displays the usage of the utility, and the utility exits without starting the process.

Clearing a User Session

The syntax of clearing a user session from the runtime application is

AdminSystem /S <SystemName> /CLR <UserName/SessionId> [/H <HostName>]

If you pass valid parameters to clear a session, the message "The session has been successfully cleared." 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.

/CLR <UserName/SessionId>

Specifies that a valid system name must be passed as a parameter.

Notes:

  • This argument is mandatory.

  • You must sign in to a user session on the system.

  • If you do not pass any value or pass an invalid option, an error message specifying that the input is invalid appears.

  • You can obtain the session number of an anonymous session by using the utility with the /WHO parameter

For example:

  • To clear a session with session id “11”, type

    AdminSystem /S Sample /CLR 11

    The message specifying that the session has been successfully cleared appears.

  • To clear a session with userid “xyz” and domain name “dn”, type

    AdminSystem /S Sample /CLR dn\xyz

    The message specifying that the session has been successfully cleared appears.

/H <HostName>

Specifies the name of the machine that you want to connect.

/CLR /?

Displays the command line syntax and its usage for clearing a user session, and the utility exits without starting the process.

Setting or Displaying the Low Account Month (LAM)

The syntax of setting or displaying the Low Account Month (LAM) for a running application is

AdminSystem /S <SystemName> /LAM <AccountMonth> [/H <HostName>]

The Low Account Month prevents an application from accepting any transactions that have an earlier date (specified by the built-in attribute ActMth value). The default value is the year and month that the application was initiated.

Any valid Low Account Month remains in effect until a new one is specified. If you pass valid parameters to run the utility, the message "Updated account month" 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.

/LAM <AccountMonth>

Specifies the year and month in the format, yymm. If no value is passed, the utility displays both the current HAM and LAM values.

Notes:

  • This argument is mandatory.

  • A Low Account Month (LAM) value might exceed the High Account Month (HAM) value to allow for a change in the century value.

  • If you pass a value not confirming to the yymm format or a value earlier than the ActMth value, the error message "Invalid account month value" appears.

  • You can obtain the session number of an anonymous session by using the utility with the /WHO parameter.

For example: To display the current LAM value for a running application, type:

AdminSystem /S Sample /LAM

/H <HostName>

Specifies the name of the machine that you want to connect.

/LAM /?

Displays the command line syntax and its usage for displaying the LAM value, and the utility exits without starting the process.

Setting or Displaying the High Account Month (HAM)

The syntax of setting and displaying the High Account Month (HAM) for a running application is

AdminSystem /S <SystemName> /HAM <AccountMonth> [/H <HostName>]

The HAM value prevents the application from accepting any transactions that have a later date (specified by the built-in attribute ActMth). The default value is the year and month that the application was initiated.

Any valid HAM value remains in effect until a new one is specified, or until the application date becomes greater than the current value, at which time its value is increased automatically. If you pass valid parameters to run the utility, the message "Updated account month" 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.

/HAM <AccountMonth>

Specifies the year and month in the format, yymm. If no value is passed, the utility displays both the current HAM and LAM values.

Notes:

  • This argument is mandatory.

  • A High Account Month (HAM) value might be less than the Low Account Month value (LAM), to allow for change in the century value.

  • If you pass a value not confirming to the yymm format or a value earlier than the ActMth value, the error message "Invalid account month value" appears.

For example: To set the HAM value for a running application, type

AdminSystem /S Sample /HAM 1402

The message "Updated account month" appears.

/H <HostName>

Specifies the name of the machine that you want to connect.

/HAM /?

Displays the command line syntax and its usage for displaying the HAM value, and the utility exits without starting the process.

Sending a Short Message

The syntax of sending a short message to other users logged on to an application is

AdminSystem /S <SystemName> /SMG /STN <Station> /MSG <message> [/H <HostName>]

If you pass valid parameters to run the utility, the message "Sent the message" 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.

/SMG

Specifies that a short message needs to be sent to other users.

/STN <Station>

Specifies a user account, terminal name, or ALL (for all users of the application).

Note: This argument is mandatory.

/MSG <message>

Specifies the text to be displayed on the status line of destination terminals.

For example: To send a short message to another user, type

AdminSystem /S Sample /SMG /STN Sample.exe /MSG Hello

The confirmation "Sent the message" appears.

/H <HostName>

Specifies the name of the machine that you want to connect.

/SMG /?

Displays the command line syntax and its usage for sending a short message, and the utility exits without starting the process.

Listing Unique Ispecs

The syntax of listing the unique ispecs in an application is

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

The list displays the alternate names of ispecs and flags the fire-up ispec. If you pass valid parameters to run the utility, the message "The following ispecs are available in the specified system", along with the list of ispecs, 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.

/LIS

You can specify this argument to list the unique ispecs.

Note: This argument is mandatory.

For example: To list the ispecs, type

AdminSystem /S Sample /LIS

/H <HostName>

Specifies the name of the machine that you want to connect.

/LIS /?

Displays the command line syntax and its usage for displaying a list of unique ispecs, and the utility exits without starting the listing process.

Displaying a List of Current Users

The syntax of listing the current users logged into the application is

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

The list displays the currently connected users of the system. The information returned includes a list of users logged into the system. If you pass valid parameters to run the utility, a list of stations connected to a runtime system appears; else, the message "No users are logged in" 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.

/WHO

You can specify this argument to list the currently connected users of the system.

Notes:

  • You must sign in to a user session on the system.

  • This argument is mandatory.

For example: To list the current users, type

AdminSystem /S Sample /WHO

/H <HostName>

Specifies the name of the machine that you want to connect.

/WHO /?

Displays the command line syntax and its usage for listing the current users, and the utility exits without starting the listing process.

Stopping an Application

The syntax of the runtime operations utility for stopping an application is

AdminSystem /S <SystemName> /STO <[disable]> [/H <HostName>]

If you pass valid parameters to stop and disable an application, the message System stopped and disabled appears. If you do not pass the "disable" argument, the message "System Stopped" 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.

/STO [disable]

You can set this argument to "disable" to stop and disable an application. This prevents any users from initiating it again and all processes are stopped.

Notes:

  • If you do not pass any option or pass an invalid option, the system is stopped.

  • If you try to stop an already stopped system, the warning message "System already stopped" appears."

For example: to stop and disable an application, type

AdminSystem /S Sample /STO disable

/H <HostName>

Specifies the name of the machine that you want to connect.

/STO /?

Displays the usage of the utility and the utility exits without starting the process.

Disabling an Application

The syntax of the runtime operations utility for disabling an application is

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

If you pass valid parameters to run the utility, the message "System disabled" 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.

/DIS

You can set this argument to disable an application. This prevents any users from initiating the application that is disabled and you can attempt to stop a disabled application through the /STO parameter after disabling the application.

For example: To disable an application, type

AdminSystem /S Sample /DIS

/H <HostName>

Specifies the name of the machine that you want to connect.

/DIS /?

Displays the usage of the command line utility and the utility exits without starting the process.

Enabling an Application

The syntax of the runtime operations utility for enabling an application is

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

If you pass valid parameters to run the utility, the message "System enabled" 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.

/ENA

You can set this argument to enable an application.

For example: To enable an application, type

AdminSystem /S Sample /ENA

/H <HostName>

Specifies the name of the machine that you want to connect.

/ENA /?

Displays the usage of the utility and the utility exits without starting the process.

Displaying, Enabling, or Disabling HUB

The syntax of the runtime operations utility for enabling and disabling external automatic entries (HUB) is

AdminSystem /S <SystemName> /HUB <[Start|Stop]> [/H <HostName>]

If you pass valid parameters to run the utility, the message HUB enabled or "HUB disabled" 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.

/HUB <[Start|Stop]>

Specifies the following options for HUB Listener service to enable or disable the HUB:

  • Start: You can specify this option to start the HUB Listener service.

  • Stop: You can specify this option to stop the HUB Listener service.

Notes:

  • If a system is disabled, the error message "The application has been disabled" appears and thereby the HUB cannot be enabled.

  • If you do not pass any options with "HUB", it displays the status of the HUB for a system. This information is read-only.

For example:

  • To enable external automatic entries (HUB), type

    AdminSystem /S Sample /HUB Start
  • To disable the HUB by stopping the HUB Listener service, type

    AdminSystem /S Sample /HUB Stop
  • To check the status of the HUB, type

    AdminSystem /S Sample /HUB

/H <HostName>

Specifies the name of the machine that you want to connect.

/HUB /?

Displays the usage of the utility, and the utility exits without starting the process.

Configuring Multilanguage

The syntax of the runtime operations utility for specifying the path to the language.dll is

AdminSystem /S <SystemName> /LANG <LanguageFilePath> [/H <HostName>]

If you pass valid parameters to run the utility, the message "Successfully updated the configuration" appears.

Note: The language.dll is a resource dll that includes display information in the desired language for a deployed application. You can replace the language.dll with a new language.dll by specifying the path of the new language.dll as a parameter. The new language.dll includes the localized resource strings.For example, you can localize and display a help message in French or German.

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.

/LANG <LanguageFilePath>

Specifies the path to the language.dll file. You should specify the absolute file path. By default, the language.dll is available in the installation directory.

Notes:

  • If you provide an invalid path, the error message "Enter a valid language file path." appears.

  • If you provide a valid path and language.dll is not available in the path, the error message "Language.dll is not present in this path. Enter a valid language file path." appears.

For example: To configure a system with the language path, type

AdminSystem /S Sample /LANG C:\TEMP

/H <HostName>

Specifies the name of the machine that you want to connect.

/LANG /?

Displays the command line syntax for configuring Multilanguage along with the usage and the utility exits without starting the process.

Configuring System Logs

The syntax of the runtime operations utility that define how activities and transactions are logged to the Audit log after deployment is

AdminSystem /S <SystemName> /LOG [/E <true|false>] 
[/LL <Activities|Transactions|TrasactionsInNOF>] [/L <location>] [/SZ <ResetFileSize>] 
[/N <NumberOfBackups>] [/H <HostName>]

If you pass valid parameters to run the utility, the message "Successfully updated the configuration" 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.

/LOG

Specifies updating the Audit log with configuration information.

Note: If you do not pass any other arguments while executing this command, it displays the configuration details of the deployed system s audit log. This information is read-only.

For example: To display Audit log information of the Sample application, type

AdminSystem /S Sample /LOG

/E <true|false>

You can set this argument to "true" to enable configuring system logs, and vice versa. By default, the audit log configuration of the system is disabled.

For example: To enable logging for Sample, type

AdminSystem /S Sample /LOG /E true

/LL <Activities|Transactions| TrasactionsInNOF>

Specifies the various formats of logging the information. By default, the log level is disabled. The various log formats in which activities and transactions can be logged are

  • Activities: Specify this option to log the activities of an application.

  • Log Transactions: Specify this option to log the transactions of an application.

  • TransactionsInNOF: Specify this option to log the transactions of an application with the ispec data values logged in NOF format.

Note: You can only specify from one of the above-mentioned format for a particular activity to be logged. Refer to Using Administration Commands for more information about the formats of various log messages.

For example, to log the transactions with ispec data values in NOF format, type

AdminSystem /S Sample /LOG /LL TransactionsInNOF

In this scenario, the log message for the "SalesRep" ispec by the "UNISYS\Nick" user who has logged in the NOF format is

IN SalesRep USER UNISYS\Nick #2 STATION 
UNISYS\Admin [NOFDATA (58) = 
SREP T00000127APR090904ADDS1 Nick Smith 
Australia]

/L <location>

Specifies the path to the location of the audit log file. You should specify the absolute file path. The default location is Data\Public\Log\<System name>.

Notes:

  • If you provide empty quotes, "", the location that is already set previously is considered.

  • If you provide an invalid path, the error message "Unable to create directory. Enter a valid directory name." appears.

For example, to modify only the location parameter while configuring the Audit log, type

AdminSystem /S Sample /LOG /L C:\TEMP\

/SZ <ResetFileSize>

Specifies the maximum size of the audit log file.

Note: Always ensure that you enter a numeric value that is greater than zero and between 1 and 65535 inclusive.

/N <NumberOfBackups>

Specifies the number of backup files that can be created once the audit log file has reached its maximum.

Note: Always ensure that you enter a numeric value that is greater than zero and between 1 and 65535 inclusive.

For example, to modify only the number of backups of the Audit log file of the Sample application, type

AdminSystem /S Sample /LOG /N 6

/H <HostName>

Specifies the name of the machine that you want to connect.

/LOG /?

Displays the usage of the utility and the utility exits without starting the process.

Configuring Print Properties

The syntax of the runtime operations utility to configure print properties required to format the print output for a Report/Outputstream is

AdminSystem /S <SystemName> /PRNT [/PD <PageDepth>] [/PW <PageWidth>] 
[/MH <MarginsHorizontal] [/MV <MarginsVertical>] [/FN <FontName>] [/PO <PageOrientation>] 
[/PR <PrinterName>] [/RO <ReportOutputLocation>] [/RN <ReportName>] 
[/OS <OutputStream>] [/H <HostName>]

If you pass valid parameters to run the utility, a message appears as "Successfully updated the configuration".

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.

/PRNT

Specifies the print configuration properties.

Note: If you do not pass any other arguments while executing this command, the command displays the print configuration details of the deployed system. This information is read-only.

For example, to display the print properties of the Sample application, type:

AdminSystem /S Sample /PRNT

/PD <PageDepth>

Specifies the page depth value. The default page depth value is 60.

Notes:

  • To set the default page depth value, you should enter the value as -1.

    For example: To set the default page depth, type

    AdminSystem.exe /S Sample /PRNT /FN "TIMES NEW ROMAN" /PD -1
  • Always ensure that you enter a numeric value that is greater than zero and within the range, 0-9999.

For example, if you provide the page depth value as 10000, an error appears as, Page Depth. Value must be in the range of 0 to 9999".

AdminSystem.exe /S Sample /PRNT /FN "TIMES NEW ROMAN" /PD 10000

/PW <PageWidth>

Specifies the page width value. The default page width value is 132.

Notes:

  • To set the default page width value, you should enter the value as -1.

    For example: To set the default page width, type

    AdminSystem.exe /S Sample /PRNT /PW -1
  • Always ensure that you enter a numeric value that is greater than zero and within the range, 0-9999.

For example, if you provide the page width value as 15000, an error message appears as, Page Width. Value must be in the range of 0 to 9999".

AdminSystem.exe /S Sample /PRNT /FN "TIMES NEW ROMAN" /PW 15000

/MH <MarginsHorizontal>

Specifies the horizontal margin value. The default horizontal margin value is 0.

Notes:

  • To set the default horizontal margin value, you should enter the value as -1.

    For example: To set the default horizontal margin value, type

    AdminSystem.exe /S Sample /PRNT /MH -1
  • Always ensure that you enter a numeric value that is greater than zero and within the range, 0-9999.

For example, if you provide the horizontal margin value as 10000, an error appears as, Margin Horizontal. Value must be in the range of 0 to 9999".

AdminSystem.exe /S Sample /PRNT /MH 10000

/MV <MarginsVertical>

Specifies the vertical margin value. The default vertical margin value is 0.

Notes:

  • To set the default vertical margin value, you should enter the value as -1.

    For example: To set the default vertical margin value, type

    AdminSystem.exe /S Sample /PRNT /MV -1
  • Always ensure that you enter a numeric value that is greater than zero and within the range, 0-9999.

/FN <FontName>

Specifies the desired font name for printing. The default font type is LincDefault New.

Notes:

  • To set the default font type, you should enter the value as -1.

    For example: To set the default font type (LincDefault New), type

    AdminSystem.exe /S Sample /PRNT /FN -1
  • If you do not specify the font name, the font specified previously is used for all the reports.

For example, if you provide an invalid font name, an error message appears as "Font is not available in the system. Provide a valid font name."

AdminSystem.exe /S Sample /PRNT /FN "TIMES"

/PO <PageOrientation>

Specifies the page orientation. The default page orientation is Portrait.

Note: To set the default page orientation, you should enter the value as -1.

For example: To set the default page orientation, type

AdminSystem.exe /S Sample /PRNT /PO -1

/PR <PrinterName>

Specifies the default printer name.

For example: to provide a value of a server printer as the printer name, type

AdminSystem /S Sample /PRNT  /PR "\\172.22.243.137\HP Laser"

/RO <ReportOutputLocation>

Specifies the path to the location of the report output file. You should specify the absolute file path.

Notes:

  • If you provide empty quotes, "", the location that is already set previously is considered.

  • If you provide an invalid path, an error message appears as, Unable to create output directory. Enter a valid directory name.

For example: to modify only the report output location parameter while configuring the print properties, type

AdminSystem /S Sample /PRNT /RO C:\TEMP\

/RN <ReportName>

Specifies the available report name in the system. The default value is All Reports.

/OS <OutputStream>

Specifies the available OutputStream within a report. The default value is All OutputStreams within the system (All Reports).

For example, to configure the print properties for OutputStream1, type

AdminSystem /S Sample /PRNT /RN SampleReport /OS OutputStream1

/H <HostName>

Specifies the name of the machine that you want to connect.

/PRNT /?

Displays the command line syntax for configuring Print properties along with the usage and the utility exits without starting the configuring process.

Verifying User Tables

The syntax of the runtime operations utility for checking the consistency of user maintained tables in the deployed system is

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

If you pass valid parameters to run the utility, the message "User Maintained Tables consistency check for the relevant system has passed successfully." appears.

Note: The User Maintained Tables (UMT) command specifies whether a database table is reorganized by a user or by the system during deployment. This command is available for persistent AB Suite entities such as ispecs (tables), profiles (indexes), events and Classes with no stereotype. By marking an AB Suite entity as User Maintained ensures that AB Suite deployment does not create or modify the related database structures. These structures are also not available to Administration Client for modification. So, you must ensure to create and modify these database structures manually through SQL Server Database.

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.

/UMT

Specifies whether a database table is reorganized by a user or by the system during deployment.

Note: If you reorganize a database table, ensure that the user-maintained tables are consistent and reorganized with corresponding class definitions, else the error "User Maintained Tables consistency check for the relevant system has failed. See DBReorg.log for details." appears.

For example: To check the consistency of user-maintained tables of the Sample system, type

AdminSystem /S Sample /UMT

/H <HostName>

Specifies the name of the machine that you want to connect.

/UMT /?

Displays the command line syntax for verifying user tables along with the usage and the utility exits without starting the process.