IBM Support

Additional information about the ARSRPT command

White Papers


Abstract

Provide additional clarification on the proper usage of some of the parameters for the ARSRPT command and an example.

Content

Parameters

The following information provides further clarification on some of the parameters for the ARSRPT command. Before reviewing this information, see the product documentation in IBM Documentation for details regarding the ARSRPT command.

-h instance

The name of the Content Manager OnDemand instance to process. The ARSRPT command locates the specified instance name in the ARS.INI file (for all servers but Windows) or the registry (for Windows servers) to obtain the TCP/IP address, host name or host name alias of the system on which the instance is running. If the ARSRPT command cannot locate the instance name in the ARS.INI file, then the specified value is treated as a host name. You must specify this parameter and name the instance in the following situations:

  • The name of the default instance is not ARCHIVE (on Multiplatforms or z/OS servers) or QUSROND (on IBM i servers).
  • You are running more than one instance on the same system and you want to process an instance other than the default instance.
  • You are running the ARSRPT command on a system other that the system on which the instance that you want to process is running.

If you are running multiple instances of Content Manager OnDemand, always specify the -h parameter to identify the name of the instance that you want to process.

Verify that the system is configured with the correct information for all instances of Content Manager OnDemand. For information about configuring instances, see IBM Content Manager OnDemand Installation or Configuration Guide for Multiplatforms, z/OS, or IBM i.

-I instance

Same as -h parameter.

-p password

Specify one of the following options for password:

  • The name of the stash (encrypted password) file that contains the password for the user ID specified with the -u parameter.
  • The password for the Content Manager OnDemand user ID specified with the -u parameter. If the user is not assigned a password, enter a null password (that is, specify -p "").

Example

This example shows how to generate a monthly report showing loads by data type. You can program this example in several different ways. The list describes the tasks your program must perform:

  1. Collect the XML reports for the target month.
  2. Process each report and extract the load information. In the ARSRPT XML file, load messages are identified by the XML tags LOAD and LOAD_TYPE. The following example highlights these tags:

    <LOAD>
    <LOAD_TYPE>LOAD</LOAD_TYPE>
    <APPL_GROUP>test-decfloat</APPL_GROUP>
    <APPL>test-decfloat</APPL>
    <TIME>2.788</TIME>
    <INPUT_SIZE>726135</INPUT_SIZE>
    <OUTPUT_SIZE>98561</OUTPUT_SIZE>
    <ROWS>236</ROWS>
    </LOAD>

  3. Collect the application group and application name information for each load as well as a count for each unique pair. The unique application group and application pairs will map to a unique data type. Keep this information for later use.
  4. Generate a separate XML file containing the unique applications formatted for use with the ARSXML command. For this example, the following lines illustrates the format: <onDemand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="c:\program files\ibm\ondemand for windows\bin\xml\ondemand.xsd">
    <application name="application_1" appGroup="applicationgroup_1"></application>
    <application name="application_2" appGroup="applicationgroup_2"></application>
    ...
    <application name="application_n" appGroup="applicationgroup_n"></application>
    </onDemand>
  5. Run the ARSXML command using the new XML file as input and export all the application definitions from the OnDemand server instance, similar to the following example: arsxml export -e c -h ARCHIVE -u <stash_file_name> -i input.xml -o output.xml, where <stash_file_name> is the name of the stash file that contains the OnDemand user ID and password.
  6. Process the output.xml file from the ARSXML command. Look up the information for each application in the file and associate the data type to each of the unique application group and application.

    The following file shows a sample XML file format and is best viewed in a monospace font: sample XML format.txt

    The following list shows the tags and attributes from the sample XML file that contain the relevant information.

    • name attribute of <application> tag
    • appGroup attribute of <application> tag
    • dataType attribute of <application> tag
    • <udData> tag
  7. Run through the list of unique application groups and applications and generate a count of total loads for each unique data type. Note: The data type of some of the application group and application combinations might not be available because their definitions might have been deleted on the server. User-defined data types have an associated extension which can identify them.
  8. Format and output the information. The following file shows sample output and is best viewed in a monospace font: sample ARSRPT.txt

[{"Type":"MASTER","Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSEPCD","label":"Content Manager OnDemand for Multiplatforms"},"ARM Category":[{"code":"a8m0z0000001gP1AAI","label":"technote"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"},{"Type":"MASTER","Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSB2EG","label":"Content Manager OnDemand for i"},"ARM Category":[{"code":"a8m0z0000001gP1AAI","label":"technote"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"},{"Type":"MASTER","Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSQHWE","label":"Content Manager OnDemand for z\/OS"},"ARM Category":[{"code":"a8m0z0000001gP1AAI","label":"technote"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

Modified date:
20 June 2023

UID

swg27027027