Table 44 summarizes the Debugging profile domain’s specific
gates. It shows the level-1 trace point IDs of the modules providing the functions
for the gates, and the functions provided by the gates.
Table 44. Debugging profile domain’s specific gates
Gate |
Trace |
Function |
XPI |
DPFM |
DP 0300
DP 0301
|
GET_DEBUG_PROFILE
SAVE_DEBUG_PROFILE
DELETE_DEBUG_PROFILE
ACTIVATE_DEBUG_PROFILE
INACTIVATE_DEBUG_PROFILE
REPLACE_DEBUG_PROFILE
START_PM_BROWSE
READNEXT_PM_PROFILE
END_PM_BROWSE
|
No |
DPIQ |
DP 0A00
DP 0A01
|
INQUIRE_PARAMETERS
SET_PARAMETERS
INQUIRE_DEBUG_TASK
SET_DEBUG_PROFILE
|
No |
DPLM |
DP 0200
DP 0201
|
STARTBR_DEBUG_PROFILES
READNEXT_DEBUG_PROFILE
READNEXT_INPUT
ENDBR_DEBUG_PROFILES
RESTARTBR_DEBUG_PROFILES
UPDATE_PROFILE_IN_LIST
|
No |
DPPM |
DP 0800
DP 0801
|
PATTERN_MATCH_TASK
PATTERN_MATCH_PROFILE
|
No |
DPUM |
DP 0500
DP 0501
|
GET_USER_DEFAULTS
SAVE_USER_DEFAULTS
|
No |
DPWD |
DP 1100
DP 1101
|
PROCESS_PAGE
PROCESS_SUBMIT
|
No |
DPWE |
DP 0F00
DP 0F01
|
PROCESS_PAGE
PROCESS_SUBMIT
|
No |
DPWJ |
DP 1000
DP 1001
|
PROCESS_PAGE
PROCESS_SUBMIT
|
No |
DPWL |
DP 0E00
DP 0E01
|
PROCESS_PAGE
PROCESS_SUBMIT
|
No |
DPXM |
DP 0900
DP0901
|
INIT_XM_CLIENT
BIND_XM_CLIENT
RELEASE_XM_CLIENT
|
No |
Retrieve a debugging profile from the debugging profile data set.
Input parameters
- OWNER_USERID
- The userid of the debugging profile's owner
- PROFILE_NAME
- The name of the debugging profile
- [BEAN_BLOCK]
- A block of storage containing the bean name
- [CLASS_BLOCK]
- A block of storage containing the class name
- [METHOD_BLOCK]
- A block of storage containing the method name
- [IP_NAME_OR_ADDR_BLOCK]
- A block of storage containing the IP name or IP address
- [LE_OPTIONS_BLOCK]
- A block of storage containing Language Environment options
Output parameters
- [TRANID]
- The transaction ID specified in the debugging profile
- [TERMID]
- The terminal ID specified in the debugging profile
- [PROGRAM]
- The program name specified in the debugging profile
- [COMP_UNIT]
- The compile unit name specified in the debugging profile
- [TYPE]
- The type of debugging profile. Values are C | E | J | LE
- [USERID]
- The user ID specified in the debugging profile
- [NETNAME]
- The terminal's network name specified in the debugging profile
- [APPLID]
- The Applid specified in the debugging profile
- [SESSION_TYPE]
- The session type specified in the debugging profile. Values are LU3270 | TCP
- [PORT]
- The port number specified in the debugging profile
- [LU_3270_DISPLAY]
- The 3270 display terminal to be used by Debug Tool
- [JVM_PROFILE]
- The JVM profile specified in the debugging profile
- [TEST_LEVEL]
- The test level specified in the debugging profile. Values are ALL | ERROR | NONE
- [COMMAND_FILE]
- The command file specified in the debugging profile
- [PROMPT]
- The prompt specified in the debugging profile
- [PREFERENCE_FILE]
- The preference file specified in the debugging profile
- [STATUS]
- The status of the debugging profile. Values are ACTIVE | INACTIVE
- [PATTERN_MATCH_NUMBER]
- A metric computed from the contents of the debugging profile, which
is compared with the pattern match number form other profiles to determine
which of the profiles is the best match for a program instance.
- [ACTIVATE_USERID]
- For an active debugging profile, the user ID of the user who made it
active.
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
PROFILE_NOT_FOUND
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Save a debug profile on the debug profile data set.
Input parameters
- OWNER_USERID
- The userid of the profile's owner
- PROFILE_NAME
- The name of the debugging profile
- [TRANID]
- The transaction ID specified in the debugging profile
- [TERMID]
- The terminal ID specified in the debugging profile
- [PROGRAM]
- The program name specified in the debugging profile
- [COMP_UNIT]
- The compile unit name specified in the debugging profile
- [TYPE]
- The type of debugging profile. Values are C | E | J | LE
- [BEAN_BLOCK]
- A block of storage containing the bean name
- [CLASS_BLOCK]
- A block of storage containing the class name
- [METHOD_BLOCK]
- A block of storage containing the method name
- [USERID]
- The user ID specified in the debugging profile
- [NETNAME]
- The terminal's network name specified in the debugging profile
- [APPLID]
- The Applid specified in the debugging profile
- SESSION_TYPE
- The session type specified in the debugging profile. Values are LU3270 | TCP
- [IP_NAME_OR_ADDR_BLOCK]
- A block of storage containing the IP name or IP address
- [PORT]
- The port number specified in the debugging profile
- [LU_3270_DISPLAY]
- The 3270 display terminal specified in the debugging profile to be used
by Debug Tool
- [JVM_PROFILE]
- The JVM profile specified in the debugging profile
- [TEST_LEVEL]
- The test level specified in the debugging profile. Values are ALL | ERROR | NONE
- [COMMAND_FILE]
- The command file specified in the debugging profile
- [PROMPT]
- The prompt specified in the debugging profile
- [PREFERENCE_FILE]
- The preference file specified in the debugging profile
- [LE_OPTIONS_BLOCK]
- A block of storage containing Language Environment options
Output parameters
- MANGLE_CODE
- Values are PROPERTY_ACC | UNDERSCORE | IDL_KEYWORD | MANGLED_TO_SELF
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
DUPLICATE_PROFILE
PROFILE_NAME_BLANK
PROFILE_NAME_INVALID
TRANID_INVALID
TERMID_INVALID
PROGRAM_INVALID
COMP_UNIT_INVALID
USERID_INVALID
NETNAME_INVALID
APPLID_INVALID
JVM_PROFILE_INVALID
CMD_FILE_INVALID
PREF_FILE_INVALID
CLASS_INVAL_FOR_TYPE_E
BEAN_INVAL_FOR_TYPE_J
BEAN_INVAL_FOR_TYPE_C
METHOD_INVAL_FOR_TYPE_J
CLASS_INVALID
BEAN_INVALID
METHOD_INVALID
PROMPT_INVALID
FILE_ERROR
FILE_FULL
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Delete a debugging profile from the debugging profile data set.
Input parameters
- CURRENT_USERID
- The userid of the user making the request
- OWNER_USERID
- The userid of the profile's owner
- PROFILE_NAME
- The name of the debugging profile
Output parameters
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
PROFILE_NOT_FOUND
PROFILE_ACTIVE
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Input parameters
- CURRENT_USERID
- The userid of the user making the request
- OWNER_USERID
- The userid of the profile's owner
- PROFILE_NAME
- The name of the debugging profile
- [SESSION_TYPE]
- The session type specified in the debugging profile. Values are LU3270 | TCP
- [IP_NAME_OR_ADDR_BLOCK]
- A block of storage containing the IP name or IP address
- [PORT]
- The port number specified in the debugging profile
- [LU_3270_DISPLAY]
- The 3270 display terminal specified in the debugging profile to be used
by Debug Tool
Output parameters
- [PATTERN_MATCH_NUMBER]
- A metric computed from the contents of the debugging profile, which
is compared with the pattern match number form other profiles to determine
which of the profiles is the best match for a program instance.
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
REASON |
EXCEPTION |
PROFILE_NOT_FOUND
ALREADY_ACTIVE
FILE_ERROR
FILE_FULL
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Inactivate a debug_profile on the debugging profile data set.
Input parameters
- CURRENT_USERID
- The userid of the user making the request
- OWNER_USERID
- The userid of the profile's owner
- PROFILE_NAME
- The name of the debugging profile
Output parameters
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
PROFILE_NOT_FOUND
ALREADY_INACTIVE
FILE_ERROR
FILE_FULL
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Replace a debug_profile on the debugging profile data set.
Input parameters
- OWNER_USERID
- The userid of the profile's owner
- PROFILE_NAME
- The name of the debugging profile
- [TRANID]
- The transaction ID specified in the debugging profile
- [TERMID]
- The terminal ID specified in the debugging profile
- [PROGRAM]
- The program name specified in the debugging profile
- [COMP_UNIT]
- The compile unit name specified in the debugging profile
- [TYPE]
- The type of debugging profile. Values are C | E | J | LE
- [BEAN_BLOCK]
- A block of storage containing the bean name
- [CLASS_BLOCK]
- A block of storage containing the class name
- [METHOD_BLOCK]
- A block of storage containing the method name
- [USERID]
- The user ID specified in the debugging profile
- [NETNAME]
- The terminal's network name specified in the debugging profile
- [APPLID]
- The Applid specified in the debugging profile
- [SESSION_TYPE]
- The session type specified in the debugging profile. Values are LU3270 | TCP
- [IP_NAME_OR_ADDR_BLOCK]
- A block of storage containing the IP name or IP address
- [PORT]
- The port number specified in the debugging profile
- [LU_3270_DISPLAY]
- The 3270 display terminal specified in the debugging profile to be used
by Debug Tool
- [JVM_PROFILE]
- The JVM profile specified in the debugging profile
- [TEST_LEVEL]
- The test level specified in the debugging profile. Values are ALL | ERROR | NONE
- [COMMAND_FILE]
- The command file specified in the debugging profile
- [PROMPT]
- The prompt specified in the debugging profile
- [PREFERENCE_FILE]
- The preference file specified in the debugging profile
- [LE_OPTIONS_BLOCK]
- A block of storage containing Language Environment options
Output parameters
- NEW_PROFILE_CREATED
- Indicates whether a new profile was created. Values are YES | NO
- [MANGLE_CODE]
- Values are PROPERTY_ACC | UNDERSCORE | IDL_KEYWORD | MANGLED_TO_SELF
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
REASON |
EXCEPTION |
PROFILE_NAME_BLANK
PROFILE_NAME_INVALID
TRANID_INVALID
TERMID_INVALID
PROGRAM_INVALID
COMP_UNIT_INVALID
USERID_INVALID
NETNAME_INVALID
APPLID_INVALID
JVM_PROFILE_INVALID
CMD_FILE_INVALID
PREF_FILE_INVALID
CLASS_INVAL_FOR_TYPE_E
BEAN_INVAL_FOR_TYPE_J
BEAN_INVAL_FOR_TYPE_C
METHOD_INVAL_FOR_TYPE_J
CLASS_INVALID
BEAN_INVALID
METHOD_INVALID
PROMPT_INVALID
FILE_ERROR
FILE_FULL
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Start a browse for pattern matching.
Input parameters
- [MATCH_TYPE]
- Values are TYPE_LE | TYPE_J
Output parameters
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
NO_PROFILES
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
INVALID |
|
KERNERROR |
|
PURGED |
|
Read the next profile on the debugging profile data set for pattern match.
Input parameters
- [BEAN_BLOCK]
- A block of storage containing the bean name
- [CLASS_BLOCK]
- A block of storage containing the class name
- [MANGLED_METHOD_BLOCK]
- A block of storage containing the mangled method name
- [IP_NAME_OR_ADDR_BLOCK]
- A block of storage containing the IP name or IP address
- [LE_OPTIONS_BLOCK]
- A block of storage containing Language Environment options
Output parameters
- OWNER_USERID
- The userid of the profile's owner
- PROFILE_NAME
- The name of the debugging profile
- TRANID
- The transaction ID specified in the debugging profile
- TERMID
- The terminal ID specified in the debugging profile
- PROGRAM
- The program name specified in the debugging profile
- [COMP_UNIT]
- The compile unit name specified in the debugging profile
- TYPE
- The type of debugging profile. Values are C | E | J | LE
- USERID
- The user ID specified in the debugging profile
- NETNAME
- The terminal's network name specified in the debugging profile
- APPLID
- The Applid specified in the debugging profile
- SESSION_TYPE
- The session type specified in the debugging profile. Values are LU3270 | TCP
- PORT
- The port number specified in the debugging profile
- LU_3270_DISPLAY
- The 3270 display terminal specified in the debugging profile to be used
by Debug Tool
- JVM_PROFILE
- The JVM profile specified in the debugging profile
- TEST_LEVEL
- The test level specified in the debugging profile. Values are ALL | ERROR | NONE
- COMMAND_FILE
- The command file specified in the debugging profile
- PROMPT
- The prompt specified in the debugging profile
- PREFERENCE_FILE
- The preference file specified in the debugging profile
- PATTERN_MATCH_NUMBER
- A metric computed from the contents of the debugging profile, which
is compared with the pattern match number form other profiles to determine
which of the profiles is the best match for a program instance.
- [ACTIVATE_USERID]
- For an active debugging profile, the user ID of the user who made it
active.
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
END_OF_PROFILES
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
End the browse for pattern matching.
Input parameters
None
Output parameters
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Inquire DP domain parameters.
Input parameters
None
Output parameters
- [DEBUGTOOL]
- The value of the DEBUGTOOL system initialization parameter. Values are DEBUGTOOL_YES | DEBUGTOOL_NO
- [DTLEVEL]
- Specifies whether the level of Debug Tool supports the CADP transaction.
Values are DTNEW_YES | DTNEW_NO
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
Set DP domain parameters.
Input parameters
- DEBUGTOOL
- The value of the DEBUGTOOL system initialization parameter. Values are DEBUGTOOL_YES | DEBUGTOOL_NO
Output parameters
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
Inquire DP domain debug settings.
Input parameters
None
Output parameters
- [DEBUG_TASK]
- Specifies whether Debug Tool is to be used to debug an application.
Values are YES | NO
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
Set DP domain parameters.
Input parameters
- [DEBUG_PROFILE]
- Values are YES | NO
Output parameters
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
Creates an in-memory linked list copy of the debug profiles from the
debug profile data set. The list is filtered and sorted as requested. A browse_list_token
which uniquely identifies the list on subsequent requests to process it is
returned.
Input parameters
- CURRENT_USERID
- The userid of the user making the request
- FILTER_ACTIVE
- Specifies whether the list contains active profiles only, or active
and inactive profiles. Values are ACTIVE_P | ALL_P
- FILTER_USER
- Specifies whether the list contains profiles for just the current user,
or all users. Values are CURRENT_USER | ALL_U
- SORT_TYPE
- Specifies the field used to sort the list. Values are OWNER | NAME
| TRAN | STAT | PROG | TERM | USER | APPL | NETN | COMP_U | TYP
Output parameters
- BROWSE_LIST_TOKEN
- A token which uniquely identifies the list of profiles.
- [NUMBER_IN_LIST]
- The number of profiles in the list
- [CURRENT_PAGE]
- Specifies which page of the list of profiles is currently displayed
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
NO_PROFILES
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Returns one profile to the caller for display on the screen. Largely for
the benefit of the 3270 version of CADP, the readnext can optionally position
itself based on a page size parameter so that it is possible to easily implement
scrolling up and down. The default if no position is specified is to return
the next profile.
Input parameters
- BROWSE_LIST_TOKEN
- A token which uniquely identifies the list of profiles.
- [PAGE_SIZE]
- The number of profiles which can be shown on a page of the display
- [POSITION]
- Specifies the position in the list of the next profile to be read. Values
are TOP | TOP_CURRENT_PAGE | NEXT_PROFILE | PAGE_FORWARD | PAGE_BACK
- [BEAN_BLOCK]
- A block of storage containing the bean name
- [CLASS_BLOCK]
- A block of storage containing the class name
- [METHOD_BLOCK]
- A block of storage containing the method name
- [MANGLED_METHOD_BLOCK]
- A block of storage containing the mangled method name
- [LE_OPTIONS_BLOCK]
- A block of storage containing Language Environment options
Output parameters
- INPUT
- The action specified for the profile. Values are ACTIVATE | INACTIVATE
| COPY | DELETE | CLEAR
- OWNER_USERID
- The userid of the profile's owner
- PROFILE_NAME
- The name of the debugging profile
- TRANID
- The transaction ID specified in the debugging profile
- TERMID
- The terminal ID specified in the debugging profile
- PROGRAM
- The program name specified in the debugging profile
- COMP_UNIT
- The compile unit name specified in the debugging profile
- TYPE
- The type of debugging profile. Values are C | E | J | LE
- USERID
- The user ID specified in the debugging profile
- NETNAME
- The terminal's network name specified in the debugging profile
- APPLID
- The Applid specified in the debugging profile
- JVM_PROFILE
- The JVM profile specified in the debugging profile
- TEST_LEVEL
- The test level specified in the debugging profile. Values are ALL | ERROR | NONE
- COMMAND_FILE
- The command file specified in the debugging profile
- PROMPT
- The prompt specified in the debugging profile
- PREFERENCE_FILE
- The preference file specified in the debugging profile
- STATUS
- The status of the debugging profile. Values are ACTIVE | INACTIVE
- PATTERN_MATCH_NUMBER
- A metric computed from the contents of the debugging profile, which
is compared with the pattern match number form other profiles to determine
which of the profiles is the best match for a program instance.
- [PROFILE_NUMBER]
- The position of the current profile in the list
- [CURRENT_PAGE]
- Specifies which page of the list of profiles is currently displayed
- [ACTIVATE_USERID]
- For an active debugging profile, the user ID of the user who made it
active.
- [INVALID_INPUT]
- Whatever was (invalidly) typed as an input
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
END_OF_PROFILES
ALREADY_AT_TOP
ALREADY_AT_BOTTOM
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
When inputs are typed in against profiles they are saved with the profile
in the linked list so that they are still retrievable for redisplay after
scrolling up and down. Readnext_input allows easy retrieval of just those
profiles with inputs against them so that they can be processed when enter
is pressed. All the data in the profile is returned as it is required if the
input to be processed is COPY.
Input parameters
- BROWSE_LIST_TOKEN
- A token which uniquely identifies the list of profiles.
- [POSITION]
- Specifies the position in the list of the next profile to be read. Values
are TOP | NEXT_PROFILE
- [INPUT_FILTER]
- Specifies profiles of interest, based on any actions that have been
specified for the profile. Values are ACTIVATES | INACTIVATES | COPIES
| DELETES | ALL_INPUTS
- [BEAN_BLOCK]
- A block of storage containing the bean name
- [CLASS_BLOCK]
- A block of storage containing the class name
- [METHOD_BLOCK]
- A block of storage containing the method name
- [MANGLED_METHOD_BLOCK]
- A block of storage containing the mangled method name
- [LE_OPTIONS_BLOCK]
- A block of storage containing Language Environment options
Output parameters
- INPUT
- The action specified for the profile. Values are ACTIVATE | INACTIVATE
| COPY | DELETE | CLEAR
- OWNER_USERID
- The userid of the profile's owner
- PROFILE_NAME
- The name of the debugging profile
- TRANID
- The transaction ID specified in the debugging profile
- TERMID
- The terminal ID specified in the debugging profile
- PROGRAM
- The program name specified in the debugging profile
- COMP_UNIT
- The compile unit name specified in the debugging profile
- TYPE
- The type of debugging profile. Values are C | E | J | LE
- USERID
- The user ID specified in the debugging profile
- NETNAME
- The terminal's network name specified in the debugging profile
- APPLID
- The Applid specified in the debugging profile
- JVM_PROFILE
- The JVM profile specified in the debugging profile
- TEST_LEVEL
- The test level specified in the debugging profile. Values are ALL | ERROR | NONE
- COMMAND_FILE
- The command file specified in the debugging profile
- PROMPT
- The prompt specified in the debugging profile
- PREFERENCE_FILE
- The preference file specified in the debugging profile
- STATUS
- The status of the debugging profile. Values are ACTIVE | INACTIVE
- [PATTERN_MATCH_NUMBER]
- A metric computed from the contents of the debugging profile, which
is compared with the pattern match number form other profiles to determine
which of the profiles is the best match for a program instance.
- [ACTIVATE_USERID]
- For an active debugging profile, the user ID of the user who made it
active.
- [INVALID_INPUT]
- Whatever was (invalidly) typed as an input
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
END_OF_INPUTS
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
INVALID |
|
KERNERROR |
|
PURGED |
|
Frees the in-memory list of debug profile records.
Input parameters
- BROWSE_LIST_TOKEN
- A token which uniquely identifies the list of profiles.
Output parameters
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
A new in_memory list of the debug profiles is created from the profiles
on the data set but the previous filter, sort and position in the list currently
displayed are maintained. The position may alter if the underlying list has
changed dramatically (due to additions/deletions of profiles via other
CADP transactions). Outstanding actions are preserved, and copied to the new
list.
Input parameters
- BROWSE_LIST_TOKEN
- A token which uniquely identifies the list of profiles.
- CURRENT_USERID
- The userid of the user making the request
Output parameters
- [NUMBER_IN_LIST]
- The number of profiles in the list
- [CURRENT_PAGE]
- Specifies which page of the list of profiles is currently displayed
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
NO_PROFILES
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Update the specified in-memory linked list element with the input supplied
so that it may be kept until ready to process later. CLEAR may be
used to clear an input that has been handled.
Input parameters
- BROWSE_LIST_TOKEN
- A token which uniquely identifies the list of profiles.
- OWNER_USERID
- The userid of the profile's owner
- PROFILE_NAME
- The name of the debugging profile
- INPUT
- The action specified for the profile. Values are ACTIVATE | INACTIVATE
| COPY | DELETE | CLEAR
Output parameters
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
REASON |
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Determines if an active debugging profile matches the parameters supplied.
Input parameters
- TRANID
- The transaction ID to be matched with the corresponding field in the
active debugging profiles
- TERMID
- The terminal ID to be matched with the corresponding field in the active
debugging profiles
- USERID
- The user ID to be matched with the corresponding field in the active
debugging profiles
- NETNAME
- The terminal's network name to be matched with the corresponding field
in the active debugging profiles
- APPLID
- The APPLID to be matched with the corresponding field in the active
debugging profiles
Output parameters
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
NO_MATCH
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Determines if an active debugging profile matches the parameters supplied.
Input parameters
- [MATCH_TYPE]
- Values are LE | NON_LE
- [TRANID]
- The transaction ID to be matched with the corresponding field in the
active debugging profiles
- [TERMID]
- The terminal ID to be matched with the corresponding field in the active
debugging profiles
- [PROGRAM]
- The program name to be matched with the corresponding field in the active
debugging profiles
- [COMP_UNIT]
- The compile unit name to be matched with the corresponding field in
the active debugging profiles
- [CLASS_BLOCK]
- A block of storage containing the class name to be matched with the
corresponding field in the active debugging profiles
- [MANGLED_METHOD_BLOCK]
- A block of storage containing the mangled method name to be matched
with the corresponding field in the active debugging profiles
- [IP_NAME_OR_ADDR_BLOCK]
- A block of storage containing the IP name or IP address
- [LE_OPTIONS_BLOCK]
- A block of storage containing Language Environment options
- [USERID]
- The user ID to be matched with the corresponding field in the active
debugging profiles
- [NETNAME]
- The terminal's network name to be matched with the corresponding field
in the active debugging profiles
- [APPLID]
- The Applid to be matched with the corresponding field in the active
debugging profiles
Output parameters
- [PROFILE_TRANID]
- The transaction ID specified in the matching profile
- [PROFILE_TERMID]
- The terminal ID specified in the matching profile
- [PROFILE_PROGRAM]
- The program name specified in the matching profile
- [PROFILE_COMP_UNIT]
- The compile unit name specified in the matching profile
- [PROFILE_USERID]
- The user ID specified in the matching profile
- [PROFILE_NETNAME]
- The terminal's network name specified in the matching profile
- [PROFILE_APPLID]
- The Applid specified in the matching profile
- [SESSION_TYPE]
- The session type specified in the debugging profile. Values are LU3270 | TCP
- [PORT]
- The port number specified in the debugging profile
- [LU_3270_DISPLAY]
- The 3270 display terminal specified in the debugging profile to be used
by Debug Tool
- [JVM_PROFILE]
- The JVM profile specified in the debugging profile
- [TEST_LEVEL]
- The test level specified in the debugging profile. Values are ALL | ERROR | NONE
- [COMMAND_FILE]
- The command file specified in the debugging profile
- [PROMPT]
- The prompt specified in the debugging profile
- [PREFERENCE_FILE]
- The preference file specified in the debugging profile
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
NO_MATCH
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Get user defaults. If none already, returns global defaults.
Input parameters
- CURRENT_SESSION_TYPE
- The session type specified for the current user. Values are LU3270
| TCP
- CURRENT_USERID
- The userid of the user making the request
- [IP_NAME_OR_ADDR_BLOCK]
- A block of storage containing the IP name or IP address
- [LE_OPTIONS_BLOCK]
- A block of storage containing Language Environment options
Output parameters
- [SUPPRESS_PANEL]
- Specifies whether the debugging device panel is to be suppressed. Values
are SUPPRESS | NOSUPPRESS
- [SESSION_TYPE]
- The session type specified in the debugging profile. Values are LU3270 | TCP
- [PORT]
- The port number specified in the debugging profile
- [LU_3270_DISPLAY]
- The 3270 display terminal specified in the debugging profile to be used
by Debug Tool
- [JVM_PROFILE]
- The JVM profile specified in the debugging profile
- [TEST_LEVEL]
- The test level specified in the debugging profile. Values are ALL | ERROR | NONE
- [COMMAND_FILE]
- The command file specified in the debugging profile
- [PROMPT]
- The prompt specified in the debugging profile
- [PREFERENCE_FILE]
- The preference file specified in the debugging profile
- [FILTER_ACTIVE]
- Specifies whether the list contains active profiles only, or active
and inactive profiles. Values are ACTIVE_P | ALL_P
- [FILTER_USER]
- Specifies whether the list contains profiles for just the current user,
or all users. Values are CURRENT_USER | ALL_U
- [SORT_TYPE]
- Specifies the field used to sort the list. Values are OWNER | NAME
| TRAN | STAT | PROG | TERM | USER | APPL | NETN | COMP_U | TYP
- [TYPE]
- The type of debugging profile. Values are C | E | J | LE
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Save user defaults. Never returns duplicate response - saves or updates.
Input parameters
- CURRENT_USERID
- The userid of the user making the request
- [SUPPRESS_PANEL]
- Specifies whether the debugging device panel is to be suppressed. Values
are SUPPRESS | NOSUPPRESS
- [SESSION_TYPE]
- The session type specified in the debugging profile. Values are LU3270 | TCP
- [IP_NAME_OR_ADDR_BLOCK]
- A block of storage containing the IP name or IP address
- [PORT]
- The port number specified in the debugging profile
- [LU_3270_DISPLAY]
- The 3270 display terminal specified in the debugging profile to be used
by Debug Tool
- [JVM_PROFILE]
- The JVM profile specified in the debugging profile
- [TEST_LEVEL]
- The test level specified in the debugging profile. Values are ALL | ERROR | NONE
- [COMMAND_FILE]
- The command file specified in the debugging profile
- [PROMPT]
- The prompt specified in the debugging profile
- [PREFERENCE_FILE]
- The preference file specified in the debugging profile
- [LE_OPTIONS_BLOCK]
- A block of storage containing Language Environment options
- [FILTER_ACTIVE]
- Specifies whether the list contains active profiles only, or active
and inactive profiles. Values are ACTIVE_P | ALL_P
- [FILTER_USER]
- Specifies whether the list contains profiles for just the current user,
or all users. Values are CURRENT_USER | ALL_U
- [SORT_TYPE]
- Specifies the field used to sort the list. Values are OWNER | NAME
| TRAN | STAT | PROG | TERM | USER | APPL | NETN | COMP_U | TYP
- [TYPE]
- The type of debugging profile. Values are C | E | J | LE
Output parameters
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
3270_DISPLAY_BLANK
3270_DISPLAY_INVALID
PORT_BLANK
PORT_INVALID
IP_BLANK
IP_INVALID
JVM_PROFILE_INVALID
CMD_FILE_INVALID
PROMPT_INVALID
PREF_FILE_INVALID
FILE_ERROR
FILE_FULL
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Process a request for an html page in the following format:
http://mvs_address:port/CICS/CWBA/dfhdpwb?options
The input
options will be read by the page processor from ITOKEN. The page processor
will generate an output page request in OTOKEN.
Input parameters
- PAGE
- The page to be processed
- ITOKEN
- A token representing a chain of input values. These are name-value pairs
from either the page options, or from the form.
- [MSG_TYPE]
- The type of message to be displayed when the page is formatted, in the
absence of a more serious message. If this value is not present then by default
no message is displayed. Values are INFO | ERROR
- [MSG_NUM]
- The message number of a message to be displayed when the page is formatted.
- [MSG_INSERT1]
- An insert for the message. If this field is null there is no first insert.
- [MSG_INSERT2]
- An insert for the message. If this field is null there is no second
insert.
Output parameters
- OTOKEN
- A token representing a chain of output html tags.
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Process a submitted form request. The input options will be read by the
page processor from ITOKEN. The page processor will generate an output page
request in OTOKEN.
Input parameters
- BUTTON
- The action button used to submit the form.
- ITOKEN
- A token representing a chain of input values. These are name-value pairs
from either the page options, or from the form.
Output parameters
- OTOKEN
- A token representing a chain of output html tags.
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Process a request for an html page in the following format:
http://mvs_address:port/CICS/CWBA/dfhdpwb?options
The input
options will be read by the page processor from ITOKEN. The page processor
will generate an output page request in OTOKEN.
Input parameters
- PAGE
- The page to be processed
- ITOKEN
- A token representing a chain of input values. These are name-value pairs
from either the page options, or from the form.
- [MSG_TYPE]
- The type of message to be displayed when the page is formatted, in the
absence of a more serious message. If this value is not present then by default
no message is displayed. Values are INFO | ERROR
- [MSG_NUM]
- The message number of a message to be displayed when the page is formatted.
- [MSG_INSERT1]
- An insert for the message. If this field is null there is no first insert.
- [MSG_INSERT2]
- An insert for the message. If this field is null there is no second
insert.
Output parameters
- OTOKEN
- A token representing a chain of output html tags.
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Process a submitted form request. The input options will be read by the
page processor from ITOKEN. The page processor will generate an output page
request in OTOKEN.
Input parameters
- BUTTON
- The action button used to submit the form.
- ITOKEN
- A token representing a chain of input values. These are name-value pairs
from either the page options, or from the form.
Output parameters
- OTOKEN
- A token representing a chain of output html tags.
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Process a request for an html page in the following format:
http://mvs_address:port/CICS/CWBA/dfhdpwb?options
The input
options will be read by the page processor from ITOKEN. The page processor
will generate an output page request in OTOKEN.
Input parameters
- PAGE
- The page to be processed
- ITOKEN
- A token representing a chain of input values. These are name-value pairs
from either the page options, or from the form.
Output parameters
- OTOKEN
- A token representing a chain of output html tags.
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Process a submitted form request. The input options will be read by the
page processor from ITOKEN. The page processor will generate an output page
request in OTOKEN.
Input parameters
- BUTTON
- The action button used to submit the form.
- ITOKEN
- A token representing a chain of input values. These are name-value pairs
from either the page options, or from the form.
Output parameters
- OTOKEN
- A token representing a chain of output html tags.
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Process a request for an html page in the following format:
http://mvs_address:port/CICS/CWBA/dfhdpwb?options
The input
options will be read by the page processor from ITOKEN. The page processor
will generate an output page request in OTOKEN.
Input parameters
- PAGE
- The page to be processed
- ITOKEN
- A token representing a chain of input values. These are name-value pairs
from either the page options, or from the form.
- [MSG_TYPE]
- The type of message to be displayed when the page is formatted, in the
absence of a more serious message. If this value is not present then by default
no message is displayed. Values are INFO | ERROR
- [MSG_NUM]
- The message number of a message to be displayed when the page is formatted.
- [MSG_INSERT1]
- An insert for the message. If this field is null there is no first insert.
- [MSG_INSERT2]
- An insert for the message. If this field is null there is no second
insert.
Output parameters
- OTOKEN
- A token representing a chain of output html tags.
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
Process a submitted form request. The input options will be read by the
page processor from ITOKEN. The page processor will generate an output page
request in OTOKEN.
Input parameters
- BUTTON
- The action button used to submit the form.
- ITOKEN
- A token representing a chain of input values. These are name-value pairs
from either the page options, or from the form.
Output parameters
- OTOKEN
- A token representing a chain of output html tags.
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
FILE_ERROR
|
DISASTER |
ABEND
INTERNAL_ERROR
DISASTER_PERCOLATION
|
The INIT_XM_CLIENT call flows from the transaction manager to the DP Domain
during transaction initialization. The DP domain allocates
the DP domain transaction lifetime control block, and anchors it in the AP
domain's transaction token.
Input parameters
- [PRINCIPAL_USER_TOKEN]
- The token which represents the characteristics of the principal user
of the transaction.
Output parameters
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
REASON |
EXCEPTION |
INVALID_USER_TOKEN
|
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The BIND_XM_CLIENT call flows from the transaction manager to the DP Domain
during transaction initialization after Recovery Manager initialisation
is complete. The DP domain does a scan of the active debugging profiles to
determine if it is possible that debugging could be required in this transaction.
If it is not then DP domain is not invoked again until transaction termination.
Input parameters
- [PRINCIPAL_USER_TOKEN]
- The token which represents the characteristics of the principal user
of the transaction.
Output parameters
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
INVALID_USER_TOKEN
|
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The RELEASE_XM_CLIENT call is made from the transaction manager to the
DP Domain during transaction termination. DP domain transaction lifetime resources
are released.
Input parameters
- [PRINCIPAL_USER_TOKEN]
- The token which represents the characteristics of the principal user
of the transaction.
Output parameters
- RESPONSE
- The domain's response to the call. Values are OK | EXCEPTION |
DISASTER | INVALID | KERNERROR | PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
REASON |
EXCEPTION |
INVALID_USER_TOKEN
|
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
[[ Contents Previous Page | Next Page Index ]]