Response body attributes for list resource monitor
When we use the HTTP GET method with the monitor object to request information about
resource monitors, the following attributes are returned within named JSON objects.
The following objects are available:
- name
- String.
- The unique name of the resource monitor
- Type
- String.
- Type of the resource monitor
- The value is one of the following values:
- directory
- The type of the resource to be monitored is file system directory.
- queue
- The type of the resource to be monitored is an IBM MQ queue.
- agentName
- String.
- Name of the agent that owns the resource monitor.
- State
- String.
- State of the monitor.
- The value is one of the following values:
- started
- The monitor is running.
- stopped
- The monitor is stopped.
general
Group element that defines the other high level attributes of monitor.
- pollInterval
- Integer.
- Frequency at which a monitor polls a resource. The unit of time that is used for this value is
specified in the pollIntervalUnit attribute.
- pollIntervalUnit
- String.
- Specifies the time interval for the pollInterval attribute. Possible values
are seconds, minutes, hours, days.
- matchesPerTask
- Integer.
- Maximum number of trigger matches to include in a single task.
resource
Group element that defines the monitored resource.
The name attribute in this object is always returned.
- name
- String.
- Specifies either the absolute path of a file system directory, or a queue name.
- This attribute is always returned.
- recursionLevel
- Integer.
- Specifies the number of subdirectories to search to find a matching trigger file. This attribute
is valid, only for a directory type of resource monitor.
transferDefinition
A list of items that are transferred when a trigger event fires. There is at least one item in
the response.
- destinationAgent
- Group element that contains elements that define a destination agent.The
name and the qmgrName attributes in this object are always returned.
- qmgrName
- String.
- The name of the queue manager on the destination system.
- name
- String.
- The name of the agent on the destination system.
- job
- A group that contains the following attribute, which is always returned:
- name
- String.
- User defined job name for the transfer.
- originator
- Group element that contains the elements that specify the originator of the transfer
request.The host and userid attributes in this object
are always returned.
- host
- String.
- The host name of the system where the source file is located.
- userid
- String.
- The user ID that originated the file transfer.
- sourceAgent
- Group element that contains the elements that define a source agent.The
name and the qmgrName attributes in this object are always returned.
- qmgrName
- String.
- The name of the queue manager on the source system.
- name
- String.
- The name of the agent on the source system.
- transferSet
- Group element that contains the elements that specify a transfer request.The
item attribute in this object is always returned.
- priority
- Integer (optional).
- Priority assigned to the transfer request. If no value is set, the default is zero.
- userProperties
- Object (optional).
- User defined properties specified in the transfer request.
- item
- Object.
- Array of group elements that describe the source and destination item configuration to
transfer.
-
- source
- Object.
- Group element that contains the attributes of a source item.
-
The name and type attributes in this object are always returned.
- name
- String.
- Specifies the absolute path of the file, directory, data set, partitioned data set, or queue at
source end.
- type
- String.
- The type of source. The value is one of the following values:
- queue
- Specifies an IBM MQ queue as the source.
- file
- Specifies a file as the source.
- directory
- Specifies a directory as the source.
- sequentialDataset
- Specifies a z/OS sequential data set as the
source.
- partitionedDataset
- Specifies a z/OS partitioned data set as the
source.
- recursive
- Boolean (optional).
- Specifies that files are transferred recursively in subdirectories when the source element is a
directory, or contains wildcard characters.
- disposition
- String (optional).
- Specifies the action that is taken on the source element when a source has successfully been
transferred to its destination. The value of disposition is one of the following values:
- leave
- The source files are left unchanged.
- delete
- The source files are deleted from the source system after the source file is successfully
transferred.
- encoding
- String (optional)
- Specifies which character encoding to use to read the source file when performing character
conversion. This option is only applicable to text files and the possible value is any valid code
page number.
- datasetExtended
- Object (optional).
-
Group element that defines additional attributes of the source specification, if the source is a
z/OS data set in a transfer request.
The hexDelimiters and delimiterPosition attributes in
this object are always returned.
- keepTrailingSpaces
- Boolean (optional).
- Describes the action that is taken if there are trailing spaces in the source records that are
read from a fixed-length-format record-oriented file (for example, a z/OS data set) as part of a text mode transfer.
- hexDelimiters
- String.
- For source files that are record oriented (for example, z/OS data sets), specifies one or more byte values to insert
as the delimiter when appending records into a binary file. Each value is represented as two
hexadecimal digits in the range 00-FF, prefixed by x.
- delimiterPosition
- String.
- Specifies the position of insertion for source text and binary delimiters. The value is one of
the following values:
- prefix
- The delimiters are inserted at the start of each record.
- postfix
- The delimiters are inserted at the end of each record. This option is the default option.
- queueExtended
- Object (optional).
-
Group element that defines additional attributes of a source specification, if the source is an
IBM MQ queue in a transfer request.
The useMessageGroup and grouplD attributes in this
object are always returned.
- useMessageGroup
- Boolean.
- Specifies that the messages are grouped by IBM MQ group ID. The first complete group is written to the destination file. If this parameter is not
specified, all messages on the source queue are written to the destination file.
- grouplD
- String.
- Group ID to be used when getting messages from a queue.
- textDelimiters
- String (optional).
- Specifies a sequence of text to insert as the delimiter, when appending multiple messages to a
text file.
- hexDelimiters
- String (optional).
- Comma separated string of hexadecimal bytes to use, when appending multiple messages to a file.
For example x12 or x03,x7F.
- delimiterPosition
- String (optional).
- Defines where the delimiters are positioned in the message being put to the source queue.
Possible values are:
- prefix
- Before the beginning of the message body.
- postfix
- After the end of the message body; this is the default option.
- messageArrivalWaitTime
- Integer.
- Time in seconds, to wait for arrival of messages in the source queue.
- destination
- Object.
- Group element that contains the attributes of a destination item.
-
The name and type attributes in this object are always returned.
- name
- String.
- Specifies the absolute path of the file, directory, data set, partitioned data set, or queue at
the destination end.
- type
- String.
- The type of destination. The value is one of the following values:
- queue
- Specifies an IBM MQ queue as the destination.
- file
- Specifies a file as the destination.
- directory
- Specifies a directory as the destination.
- sequentialDataset
- Specifies a z/OS sequential data set as the
destination.
- partitionedDataset
- Specifies a z/OS partitioned data set as the
destination.
- actionIfExists
- String(optional).
- Specifies the action that is taken if a destination file exists on the destination system. The
value is one of the following values:
- error
- Reports an error and the file is not transferred; this is the default value.
- overwrite
- Overwrites the existing destination file.
- encoding
- String (optional).
- Specifies which character encoding to use to read the source file when performing character
conversion. This option is only applicable to text files and the possible value is any valid code
page number.
- endOfLine
- String (optional).
- Specifies the end-of-line characters that are used when the file is written at the destination.
This option is applicable to text files only.
- userId
- String (optional).
- The name of the user whose destination file space the files are transferred into.
- datasetExtended
- Object (optional).
- Group element that defines additional attributes of the destination specification, if the
destination is a z/OS data set in a transfer request.
- truncateRecords
- Boolean.
- Specifies that destination records longer than the LRECL data set attribute are truncated. If
this parameter is not specified, the records are wrapped. This parameter is valid only for text mode
transfers where the destination is a data set.
- queueExtended
- Object (optional).
-
Group element that defines additional attributes of a destination specification, if the
destination is an IBM MQ queue in a transfer
request.
The messagePersistence and delimiterType attributes in
this object are always returned.
- messagePersistence
- String.
- Defines if the message put to the destination queue is persistent or non-persistent. The value
is one of the following values:
- persistent
- Messages are persistent.
- nonPersistent
- Messages are non-persistent.
- asQueueDefault
- Message persistency is set, depending on the queue definition.
- delimiterType
- String.
- Defines the type of delimiter to use when splitting incoming data into messages. The value is
one of the following values:
- size
- Split based on given size.
- binary
- Split based on given delimiters.
- hexDelimiters
- String (optional).
- Comma separated string of hexadecimal bytes to use when splitting messages. For example
x12 or x03,x7F.
- textDelimiters
- String (optional).
- Specifies the Java regular expression to use
when splitting a text file into multiple messages.
- includeDelimitersInMessage
- Boolean.
- Defines whether delimiters are included in a message being put to the destination queue.
- delimiterPosition
- String.
- Defines where the delimiters are positioned in the message being put to the destination queue.
The value is one of the following values:
- prefix
- Before the beginning of the message body.
- postfix
- After the end of the message body; this is the default option.
- setMQProperties
- Boolean (optional).
- Valid only when the destination is a queue. The value is one of the following values:
- true
- Sets message properties on the first message that is created by the transfer.
- false
- Does not set message properties on the first message that is created by the transfer.
- messageSize
- Integer.
- Defines a size in bytes to split the incoming data into the message.
- checksum
- String (optional).
- Checksum method for verifying data integrity. The value is one of the following values:
- md5
- MD5 algorithm used for integrity validation.
- none
- No checksum validation.
- mode
- String (optional).
- Specifies the transfer mode as either binary or text. The value is one of the following values:
- text
- Data is transferred as text.
- binary
- Data is transferred in binary.
- recoveryTimeout
- Integer (optional).
- Time in seconds to wait for a transfer to recover.
- -1 is the default value.
- preSourceCall
- Object (optional).
- Group elements that contain the elements for program invocation before a transfer begins at the
source. These group elements are not present if a resource monitor is not
configured to use any program invocation.
- type
- String (optional).
- Defines the type of the program to be invoked. The value is one of the following values:
- executable
- This value is the default value.
-
Defines attributes for a platform specific executable program:
- name
- String.
- Name of the program to process.
- arguments
- String (optional).
- Argument or arguments to be passed to the program being invoked.
- antScript
-
Defines attributes for Ant Script:
- name
- String.
- Name of the Ant script to process.
- target
- String (optional)
- Target to invoke in the specified Ant
script. Attribute is not present in the JSON response, if the default target is to
be invoked.
- arguments
- String (optional).
- A list of user defined custom data in space separated key=value pair of type
String. For
example:
“arguments":“coffeeType=Arabica teaChoice=lemon”
- jcl
-
Defines attributes for z/OS JCL to submit.
- name
- String.
- Name of the JCL to submit.
- retryCount
- Integer (optional).
- A positive number of attempts to run the command before ceasing.
- retryWait
- Integer (optional).
- Amount of time to wait, in seconds, between two retry attempts.
- successReturnCode
- String (optional).
- Reason code that is returned when transfer is complete. This is looked for before running the
specified program, script, or JCL. This return code is a combination of an operator and value in the
form of “[>|<|!] value”. Note that it is valid to have a combination of more
than one operator, for example “>= 40”.
- postSourceCall
- Object (optional).
- Group elements that contain the elements for program invocation after a transfer completes at
source. This object contains the same elements as preSourceCall.
- preDestinationCall
- Object (optional).
- Group elements that contain the elements for program invocation before a transfer begins at the
destination. This object contains the same elements as preSourceCall.
- postDestinationCall
- Object (optional).
- Group elements that contain the elements for program invocation after a transfer completes at
the destination. This object contains the same elements as preSourceCall.
triggerCondition
Group element that defines details of a trigger condition used by a resource monitor.
- type
- String.
- Indicates the type of matching done, to decide on triggering a transfer. The value is one of the
following values:For resource type Directory:
- matchAll
- Must match the value specified for the includePattern and
excludePattern attributes.
- matchNone
- None of the files in the monitored directory match the value specified for the
includePattern and excludePattern attributes.
- noChangeInSize
- Initiate a transfer, if the size of the file being monitored does not change for a specified
number of poll intervals.
- sizeGreaterOrEqualTo
- Initiate a transfer, if the size of the file being monitored is greater than or equal to a
specified size.
For resource type Queue:
- queueNotEmpty
- Queue must have at least one message.
- completeMessageGroups
- Queue must have at least one group of messages.
- noFileSizeChangePollCount
- Integer.
- Refers to the number of polling intervals during which the size of the monitored file does not
change. Used in conjunction with the noChangeInSize attribute
- fileSize
- Integer.
- Refers to the size of the trigger file being monitored, whose size is equal to or greater. Used
in conjunction with the sizeGreaterOrEqualTo attribute.
- fileSizeUnit
- String.
- Defines the unit for the fileSize attribute. The value is one of the
following values:
- bytes
- File size unit is in bytes
- kilobytes
- File size unit is in kilobytes
- megabytes
- File size unit is in megabytes
- gigabytes
- File size unit is in gigabytes
- includePattern
- String.
- A pattern of the name, or names, of files to be included, while doing match for a trigger
condition.
- excludePattern
- String.
- A pattern of the name, or names, of files to be excluded, while doing match for a trigger
condition.
- matchPattern
- String.
- Indicates how to interpret the contents of the includePattern and
excludePattern attributes. The value is one of the following values:
- wildcard
- - Indicates the includePattern and excludePattern
attributes contain wildcard characters, for example, *.
- regularExpression
- Indicates the includePattern and excludePattern
attributes contain Java regular expressions.
triggerFileContentFormat
A trigger file defines a list of files transferred when a trigger condition is satisfied. The
trigger file might define only the source path, or both source and destination paths. Each line in a
trigger file points to a file to transferred.
This object is valid only for triggerCondition.type of
matchAll and noChangeInSize.
- groupOrder
- String.
- The trigger file contains names of source file names, destination file names, or both. This
attribute defines the order of the source file names, destination file names, or both. The value is
one of the following values:
- sourceDestination
- Source file name appears first, followed by destination file name.
- destinationSource
- Destination file name appears first followed by source file name.
- customPattern
- String (optional).
- A Java regular expression to apply, while parsing trigger file contents for generating a list of
files to transfer.
Parent topic: GET
Related reference
Related information