FLCARODM
Syntax
>>-FLCARODM--RODMNAME=name--RODMUSER=user-----------------------> >--FUNCTION=-| FLCARodmFunctions |--+------------------+--------> '-RODMINT=interval-' >--+--------------------------+-------------------------------->< '-RODMRETRY=number_retries-' FLCARodmFunctions |--+- --'--BUILD--'-----------------------------------------------------------------------+--| | .- --CHILDREN--=--NO-------. | +- --'--DELINKA--'--+--------------------------+--+------------------------+--| Xref |-+ | '- --CHILDREN--=--+-NO---+-' '- --LOCATE--=--1STFIELD-' | | +-ONLY-+ | | '-YES--' | +- --'--DELINKAB--'--------------------------------------------------------------------+ | .- --CHILDREN--=--NO-------. | +- --'--DELOBJ--'--+--------------------------+--+------------------------+--| Xref |--+ | '- --CHILDREN--=--+-NO---+-' '- --LOCATE--=--1STFIELD-' | | +-ONLY-+ | | '-YES--' | +- --'--LOCATE--'----------------------------------------------------------------------+ +- --'--PURGE--'--| PurgeOptions |-----------------------------------------------------+ | .- --FIELDID--=--NO--. | +- --'--QUERY--'--+--------------------+--+------------------------+--| Xref |---------+ | '- --FIELDID--=--YES-' '- --LOCATE--=--1STFIELD-' | +- --'--QUERYALL--'--------------------------------------------------------------------+ +- --'--QUERYSF--'--+------------------------+--+-------------------------+--| Xref |--+ | '- --LOCATE--=--1STFIELD-' '- --SF--=--+-CHANGE----+-' | | +-NOTIFY----+ | | +-PREV_VAL--+ | | +-QUERY-----+ | | '-TIMESTAMP-' | +- --'--QUERYSTR--'--------------------------------------------------------------------+ +- --'--REBUILD--'---------------------------------------------------------------------+ | .- --CHILDREN--=--NO---. | '- --'--UPDATE--'--+----------------------+--+------------------------+--| Xref |------' '- --CHILDREN--=--ONLY-' '- --LOCATE--=--1STFIELD-' Xref |--+-------------------------------------------+----------------| '-XREF=-+-1STFIELD--+-----------------+---+-' | '-FILTER=2NDFIELD-' | '-objectname--+-----------------+-' '-FILTER=1STFIELD-' PurgeOptions .-STATUS=ALL-. .-TRACE=NO--. |--+------------+--+---------------+--+-----------+-------------> '-STATUS=val-' '-TIMESTAMP=val-' '-TRACE=YES-' >--+-----------------+--+-------------------------+-------------| '-FILTER=1STFIELD-' | .-,-------. | | V | | '-EXCLUDE=(---message-+-)-'
Operand Descriptions
- CHILDREN
- Specifies whether the operation applies to the specified children
of the object. The CHILDREN parameter cannot be specified if the XREF
parameter is specified. Use the CHILDREN parameter with the following functions:
- UPDATE
- DELINKA
- DELOBJ
- NO
- Indicates that the function is performed on the specified object, but not on its children.
- ONLY
- Indicates that the function is performed on the specified children of the object, but not on the object itself.
- YES
- Indicates that the function is performed on the object specified
and its children. Notes:
- YES is not valid with the UPDATE function.
- For the UPDATE function, only the first level of children is updated.
- EXCLUDE
- Used with the PURGE function and can be specified only when TRACE=YES is specified. The EXCLUDE option indicates which purge messages (FLC040I, FLC041I, and FLC042I) must not be issued during purge processing. If you attempt to purge an aggregate object that has many objects beneath it, you might want to receive the FLC040I and FLC042I successful purge messages and suppress the FLC041I unsuccessful purge messages (for example, EXCLUDE=FLC041I). Otherwise, you might receive many unwanted FLC041I messages. One to three of these purge messages can be specified. No other messages are permitted.
- FIELDID
-
Indicates whether the QUERY function returns field identifiers with the field names.
- NO
- Indicates that the field identifiers are not returned.
- YES
- Indicates that the field identifiers are returned.
- FILTER
- Used with the XREF parameter to filter the list of objects that
are operated on. Use the FILTER parameter with the following functions:
- DELOBJ
- DELINKA
- PURGE
- QUERY
- QUERYSF
- UPDATE
The first field on each object specification must be the field name, type, and value of the filter criteria. The FILTER value is applied only after all other functions and parameters have been processed. FILTER returns values that are either exact matches or partial matches. For example, if the field value Segment is specified and an object exists that has the value Seg, the filter matches and the object is returned.
FILTER=1STFIELD must be specified unless XREF=1STFILELD is specified. If XREF=1STFILELD is specified, FILTER=2NDFIELD must be specified. The field description must specify the following information in the order shown:- Field name
- Field data type
- Field value
- FUNCTION
- Specifies the function that is performed. For a description of each function, see FLCARODM Functions.
- LOCATE
- Specifies that the first field definition is used as the criteria
to create a list of objects. LOCATE=1STFIELD must be specified, and the first field description must specify the following information in the order listed:
- Field name
- Field data type
- Field value
Use the LOCATE parameter with the following functions:- DELINKA
- DELOBJ
- QUERY
- QUERYSF
- UPDATE
- RODMINT
- The amount of time in seconds that FLCARODM waits between retrying requests when RODM is checkpointing. The default value is five seconds.
- RODMRTRY
- The number of times FLCARODM retries a request when RODM is checkpointing. The default value is three. If RODM is still checkpointing after FLCARODM has retried the request for the number of times specified, an error is returned to the application.
- RODMNAME
- The name of the RODM to be used.
- RODMUSER
- The application name that is used to connect to RODM. The same
RODMUSER value can be used by multiple NetView® operators executing REXX programs
that call FLCARODM. However, Access cannot use the same RODMUSER value
as other applications (for example, RODMVIEW) that connect to RODM.
Create a RODMUSER value by concatenating the NetView domain name with a three-character identifier. For example, MultiSystem Manager concatenates the NetView domain name CNMO1 with MultiSystem Manager to create the RODMUSER value. For example, if the NetView domain name is CNM01, MultiSystem Manager creates a RODMUSER value of CNM01MSM.
- SF
- Indicates the subfield to be queried. Specify one of the following
values:
- CHANGE
- NOTIFY
- PREV_VAL
- QUERY
- TIMESTAMP
- STATUS
- The DisplayStatus field value used to determine whether objects
are purged by the PURGE function.
- ALL
- Indicates that an object are purged regardless of its DisplayStatus value. The TIMESTMP parameter cannot be specified when STATUS has a value of ALL.
- val
- The DisplayStatus field value of the objects that are to be deleted. The default value is 132 (unknown).
- TIMESTAMP
- The age criteria, specified in seconds, of objects to be purged. The default is 84400, which is the number of seconds in 24 hours.
- TRACE
- Specifies whether the PURGE function is run in trace mode. In
trace mode, a message is issued for every object that is purged.
- NO
- Indicates that the PURGE function is not run in trace mode.
- YES
- Indicates that the PURGE function is run in trace mode.
- XREF
- Specifies that a function is performed on a list of dynamically
acquired objects. The list of objects is defined by the field that
is specified. The field must be one of the following data types:
- ObjectIdList
- ObjectLink
- ObjectLinkList
Use the XREF parameter with the following functions:- DELINKA
- DELOBJ
- QUERY
- UPDATE
The XREF parameter cannot be specified if the CHILDREN parameter is used.
Because the XREF parameter can contain mixed-case characters, ADDRESS NETVASIS must be specified.
- 1STFIELD
- Specifies that the first field that is defined on an object is used.
- objectname
- Indicates the name of the field that is used. For objects that have dotted decimal notation names, you must use the dotted decimal name. For example, to specify the member field you must specify 2.9.3.2.7.42.