Previous Topic: arwfserver: Server Management ToolNext Topic: Managing Reports


arwfutil: A Utility Tool

You can use the arwfutil tool to manage server cache, refresh the server, shutdown the server, read the server configuration information, such as protocol configurations and server statistics.

You can run the tool in interactive mode or directly access the commands.

To run the arwfutil tool:

  1. Navigate to the location where the tool is available:
  2. You can run the tool either:

    The following table lists the command options provided by the arwfutil tool:

Option

Description

Server Management Operations

cr

Refreshes the cache of the AuthMinder Server instance. You must enter the instance IP and the server management port number.

After successful operation, the message "The operation was successful" is displayed and a transaction ID is returned.

Syntax:

arwfutil cr <AuthMinder Server IP> <Server Management port>

Example:

arwfutil cr localhost 9743

dc

Downloads the server configuration cache to a file called arcotwebfortcache-<transaction ID>.log.

This file is available in the following directory:

For Windows: <install_location>\Arcot Systems\logs

For UNIX-Based Platforms: <install_location>/arcot/logs

Every time you download the server configuration cache, a new file will be created with the unique transaction identifier.

Syntax:

  • arwfutil dc
    Prompts whether to download the complete or partial cache. Enter 1 for complete cache or 0 for partial cache.
  • arwfutil dc <AuthMinder Server IP> <Server Management port>
    Downloads the complete cache.

Example:

arwfutil dc localhost 9743

gss

Generates a file called wf-server-stats-<dd>-<mmm>-<yy>.xml, which lists the server statistics.

This file is available in the following directory:

For Windows: <install_location>\Arcot Systems\logs

For UNIX-Based Platforms: <install_location>/arcot/logs

The statistics file includes the following information for each protocol:

  • Number of requests received
  • Number of successful transactions
  • Number of failed transactions
  • Minimum time taken to process requests
  • Maximum time taken to process requests
  • Total time taken to process all requests
  • Average time required to process a request

After successful operation, the message "The operation was successful" is displayed and the transaction details are returned.

Syntax:

arwfutil gss

sd

Shuts down the AuthMinder Server instance. You must enter the instance IP and the server management port number.

After successful operation, the message "The operation was successful" is displayed and the transaction details are returned.

Syntax:

  • arwfutil sd
  • arwfutil sd <AuthMinder Server IP> <Server Management port>

Example:

arwfutil sd localhost 9743

ssc

Sets the AuthMinder Server configuration. You need to provide the IP address of the AuthMinder Server and port number of the Server Management protocol.

Syntax:

arwfutil -i

ssc <AuthMinder Server IP> <Server Management port>

Example:

arwfutil -i

ssc localhost 9743

Note: It is recommended that you run this command in the interactive mode, else the server configurations that are set using this command cannot be used by the other commands.

Setup Validator Operations

vah

Validates the ARCOT_HOME by computing hex-encoded MD5 of AuthMinder Server files.

This command generates a file called arcotwebfort-vah-<dd>-<mmm>-<yy>.txt, which lists the MD5 of AuthMinder files.

This file is available in the following directory:

For Windows: <install_location>\Arcot Systems\logs

For UNIX-Based Platforms: <install_location>/arcot/logs

Syntax:

arwfutil vah

vdb

Validates the AuthMinder database tables. This command generates a file called arcotwebfort-vdb-<dd>-<mmm>-<yy>.txt, which lists the AuthMinder database tables.

This file is available in the following directory:

For Windows: <install_location>\Arcot Systems\logs

For UNIX-Based Platforms: <install_location>/arcot/logs

Syntax:

arwfutil vdb

vsetup

Validates the ARCOT_HOME by computing hex-encoded MD5 of AuthMinder Server files and the AuthMinder database tables.

This command generates a file called arcotwebfort-setup-<dd>-<mmm>-<yy>.txt, which lists the MD5 of AuthMinder files and the database tables.

This file is available in the following directory:

For Windows: <install_location>\Arcot Systems\logs

For UNIX-Based Platforms: <install_location>/arcot/logs

Syntax:

arwfutil vdb

Utility Operations

??

Searches the commands based on the pattern you provide.

For example, if you enter ?? ss, then all the commands that contain ss in their names are displayed.

Syntax:

arwfutil ?? <seach text>

Example:

arwfutil ?? SS

The preceding command fetches the following options:

  • gss
  • ssc

?

Lists the commands supported by arwfserver. If you provide the command name along with this option, then the tool provides the help on command usage.

Syntax:

  • arwfutil ?
    Lists all the supported commands
  • arwfutil ? <command_option>
    Provides help on the command usage.

Example:

arwfutil ? ssc

Explains the usage of Set Server Configuration (SSC) command.

help

Provides the help on the command usage.

Syntax:

help <command_option>
Provides help on the command usage.

Example:

arwfutil help ssc

Explains the usage of Set Server Configuration (SSC) command.

q

Closes the interactive mode.

rai

Reads the additional input that you want to include when you invoke other commands. Before you run this command, you must add the additional input name-value pairs as follows:

  • 1. Navigate to the following location:
    On Windows: <install_location>\Arcot Systems\conf
    On UNIX Platforms: <install_location>/conf
  • 2. Open the arcotcommon.ini file in a text editor.
  • 3. Add a section called [arcot/webfort/tool/additionalInputs].
  • 4. Include the name-value pairs in the section that you added in the preceding step.
  • 5. Save and close the arcotcommon.ini file.

Syntax:

rai