Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Anchor
Creating an Application Resource Record
Creating an Application Resource Record
Creating an Application Resource Record

Step 1

From the Agents & Connections navigation pane, select System > Applications. The Applications list displays a list of all currently defined Application resource records.
 
Below the list, Application Details for a new Application resource record displays.
 

Step 2

Enter/select Details for a new Application resource record, using the field descriptions below as a guide.

  • Required fields display an asterisk ( * ) after the field name.
  • Default values for fields, if available, display automatically.

To display more of the Details fields on the screen, you can either:

  • Use the scroll bar.
  • Temporarily hide the list above the Details.
  • Click the New button above the list to display a pop-up version of the Details.

Step 3

Click a Save button. The record is added to the database, and all buttons and tabs in the Application Details are enabled.
 
When you save a new Application resource record, the Controller also automatically creates three related Application Control Tasks, one each for starting, stopping, and querying the application.

Step 4

If appropriate, repeat these steps for any additional Application resource records that you want to add.

...

Field Name

Description

General

This section contains general information about the application.

Name

Name used within the Controller to identify this resource. Up to 40 alphanumerics. It is the responsibility of the user to develop a workable naming scheme for resources.

Version

Version number of the current record, which is incremented by the Controller every time a user updates a record. Click on the Versions tab to view previous versions. For details, see Record Versioning.

Description

Include Page
UC71xIL:SummaryUC71x
IL:Summary

Member of Business Services

User-defined; allows you to select one or more Business Services that this Application resource belongs to. Click on the lock icon to unlock the field and select a Business Service.

Application Details

This section contains assorted detailed information about the application.

Anchor
Application Type
Application Type
Application Type

User-defined; Type of application.
 
Options:

  • Windows Service
  • Linux/Unix Daemon
  • z/OS Started Task

Credentials

Include Page
UC69IL:Credentials field - Application Resource - 6.4.4.0UC69
IL:Credentials field - Application Resource - 6.4.4.0

Windows Agent

If Application Resources#Application Type = Windows Service; Name of the Windows agent where the application will run.

Linux/Unix Agent

If Application Resources#Application Type = Linux/Unix Daemon; Name of the Linux/Unix agent where the application will run.

z/OS Agent

If Application Resources#Application Type = z/OS Started Task; Name of the z/OS agent where the application will run.

Environment Variables

If Application Resources#Application Type = Windows Service or Linux/Unix Daemon; Allows you to enter environment variables needed by the program to run.
 
To add a variable, click the + icon and enter a Name and Value. To delete a variable, select in the list of variables and click the - icon.
 
You can add a maximum of 4,000 characters for the combined Names and Values of all variables. The variable is listed in the space underneath.

Run as sudo

If Application Resources#Application Type = Linux/Unix Daemon; Instruction to run the command as Sudo (superuser do).

Runtime Directory

Directory where the application executes. Variables supported.

Anchor
Start Command
Start Command
Start Command

Command used to start the application. This can be any process or command that starts the application. If you try to start an application monitor that is already started, you will see the message: Application already monitored with <status> status.

Anchor
Stop Command
Stop Command
Stop Command

Command used to stop the application. This can be any process or command that stops the application.

Anchor
Query Command
Query Command
Query Command

Command used to query the application. This can be any process or command that queries the application. You must first start the application monitor from the Controller before you can query the application.

Anchor
Query Exit Code Processing
Query Exit Code Processing
Query Exit Code Processing

Specifies how the Controller should determine whether or not the application is running.
 
Options:

  • Success Exitcode Range - Application goes to or remains in Active status if its exit code falls within the range specified in the Query Exit Codes field (see below). Otherwise it has Impaired status.
  • Failure Exitcode Range - Application goes to or remains in Impaired status if its exit code falls within the range specified in the Exit Codes field (see below). Otherwise it has Active status.
  • Success Output Contains - Application goes to or remains in Active status if its output contains the text specified in the Scan Output For field (see below). Otherwise it has Impaired status.
  • Failure Output Contains - Application goes to or remains in Impaired status if its output contains the text specified in the Scan Output For field (see below). Otherwise it has Active status.

Query Exit Code

System-supplied if Application Resources#Query Query Exit Code Processing = Success Exitcode Range or Failure Exitcode Range; the most recent exit code returned by the application in response to a query.

Anchor
Output Type
Output Type
Output Type

If Application Resources#Query Query Exit Code Processing = Success Output Contains or Failure Output Contains; type of output.
 
Options:

  • Standard Output (STDOUT)
  • Standard Error (STDERR)
  • File

Scan Output For

If Application Resources#Query Query Exit Code Processing = Success Output Contains or Failure Output Contains; string that the Controller should scan for in the output.

Output File

If Application Resources#Output Output Type = File; path and name of the file.

Anchor
Startup Query Maximum
Startup Query Maximum
Startup Query Maximum

Maximum number of Query attempts to be made on the specified application.

Status

This section contains information about the current status of the task application.

Status

System-supplied; indicates the current status of the application.
 
Options:

  • Inactive - Application is not being monitored by the Controller.
  • Start Failure - Application failed to start. This may occur, for example, if you have problems with credentials or the start command itself is incorrect. When this occurs, the Controller is not monitoring the application. You should troubleshoot the problem and restart the application from the Controller.
  • Starting - Start command has been executed.
  • Active - Application has successfully started and is running, based on the parameters specified in the Exit Code processing fields.
  • Impaired - An application that is being monitored returned a response that, based on the specified exit code parameters, indicates it is not running. If this occurs, you should troubleshoot the problem and restart the application from outside the Controller. Unless you issue a stop command, the Controller continues monitoring during this process. When the application comes back up, the query process will recognize this and return the application to Active status.

Status Description

System-supplied; a more detailed status message describing why a status change occurred, in the format: "Query exit code <in-not in> <success-failure> exit code range. Query <success-failure> output not found."

Anchor
Start Time
Start Time
Start Time

System-supplied; Date and time that the application was last started by the Controller.

Last Query

System-supplied; date and time of the last query response received from the application.

Anchor
Startup Query Attempts
Startup Query Attempts
Startup Query Attempts

System-supplied; Number of queries that were executed before the Application went into Active or Impaired status.

Anchor
Query Exit Code
Query Exit Code
Query Exit Code

Required if Application Resources#Query Query Exit Code Processing = Success Exitcode Range or Failure Exitcode Range; range of exit codes. Format is numeric.
 
Use commas to list a series of discontinuous exit codes; use hyphens to specify a series of continuous exit codes. For example: 1,5,11, 22-30.

Metadata

This section contains Metadata information about this record.

UUID

Universally Unique Identifier of this record.

Updated By

Name of the user that last updated this record.

Updated

Date and time that this record was last updated.

Created By

Name of the user that created this record.

Created

Date and time that this record was created.

Buttons

This section identifies the buttons displayed above and below the Application Details that let you perform various actions.

Save

Saves a new record in the Controller database.

Save & New

Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.

Save & View

Saves a new record in the Controller database and continues to display that record.

New

Displays empty (except for default values) Details for creating a new record.

Update

Include Page
UC69IL:Update buttonUC69
IL:Update button

Anchor
Start
Start
Start

Executes the Start command associated with this Application resource and begins querying.

Anchor
Stop
Stop
Stop

Executes the Stop command associated with this Application resource. the Controller stops the application and stops querying (monitoring).

Anchor
Query
Query
Query

Executes the Query command associated with this Application resource. This allows you to get immediate status of the application instead of waiting for the next automated query.

Delete

Include Page
UC69IL:Delete buttonUC69
IL:Delete button

Refresh

Refreshes any dynamic data displayed in the Details.

Close

For pop-up view only; closes the pop-up view of the Details.

Tabs

This section identifies the tabs across the top of the Application Details that provide access to additional information about this Application resource.

Application Control Tasks

Lists all Application Control tasks associated with this Application resource.

Application Control Task Instances

Lists all Application Control task instances associated with this Application resource.

Application Monitor Triggers

Lists all Application Monitor triggers associated with this Application resource.