Writer instructions | |
|---|---|
Page title | For most spaces, this page must be titled Space announcements. For spaces with localized content, this page must be titled Space announcements l10n. |
Purpose | Provide an announcement banner on every page of your space. |
Location | Move this page outside of your home branch. |
Guidelines | |
Using the BTM test utility (tbtmutil)
The tbtmutil utility is used to mimic real BTM extensions for various test or support purposes. If for some reason there is a problem where the real BTM extension is not working as expected this tool can be used by BMC Customer Support to help isolate the issue and gather information for analysis.
BMC Customer Support might ask that you perform steps similar to the following.
- Configure, generate and deploy a model using a message format having issues. For this purpose you might define a model with one activity and either an input or output using a queue (resource id) that you remember.
- Locate your deployment directory, usually located in the ExtensionConfig subdirectory of the directory specified by the MQS_HOME environment variable. Otherwise, agentpref can be used to query the preferences. Look for ConfigDirectory.
agentpref --host localhost --get "BTMConfig Ext" - Copy the deployment xml (for example, mq8demo1_amqsput.xml). These files are in the lower directories and not contain filters in the name. The file has the name of the activity implementation of your model.
- Place your sample message data in a file (for example, buffer.txt). For MQ this would not include the MQMD although the tool can skip over data that is not needed like MQ headers.
- Execute the tool indicating to parse the message using the configuration from the deployment xml and the resource id of that model.
tbtmutil --v --parse --config mq8demo1_amqsput.xml --buffer buffer.txt --resource q2 - Examine the results to determine if the correct value was parsed.
- Zip up the profile export, xml and txt files along with the command used for BMC Customer Support analysis.
The following table lists the required and optional parameters for tbtmutil. See also Parameter-combinations.
Option | Argument | Description |
|---|---|---|
--v | Not applicable | Enable verbose output. |
--version | Not applicable | Output the build version. |
--parse | Not applicable | Parse the buffers using the configuration specified. |
--display | Not applicable | Display the configuration in a readable format. |
--displayFilter | Not applicable | Display the filter configuration file in a readable format. |
--load | Not applicable | Load the configuration. Useful if the configuration file is suspected to be corrupt or unloadable. |
--test | Not applicable | Test simulating the BTM WebSphere MQ exit (--mq) or test thread handling on the platform (--threads). |
--repeat | n | Repeats tests n times. |
--time | Not applicable | Outputs the time it takes to do the command. |
--config | filename | Specifies the activity implementation configuration file name. |
--buffer | filename | Specifies a file containing the message body buffer to be parsed. Only one can be specified. |
--folder | filename | Specifies an RFH2 buffer to be parsed. The content should be the xml like data and not an RFH2. If you wish to use the RFH2, place it in the --buffer file. More than one --folder can be specified. |
--mqmd | filename | Specifies a file containing a MQMD. If this is not specified a default MQMD is used. |
--mqmdFormat | format | Specifies the format copied into the MQMD format field. For example, if the --buffer file is string data you might indicate it is a string format. |
--bcid | correlation id | The broker correlation id specified in the message format. This is used in conjunction with --bcbuffer. |
--bcbuffer | filename | Specifies a file containing data that would have been parsed by the message broker for the correlation id specified by --bcid. More than one --bcid and --bcbuffer pairs can be specified. |
--endian | little | big | Specifies whether to treat the data as being in little endian or big endian format. Only used if --mqmd is not specified and --buffer does not contain a MQXQH or RFH2 from which the endianness can be derived. |
--ccsid | ccsid | Specifies what ccsid the data is in. Only used if --mqmd is not specified and --buffer does not contain a MQXQH or RFH2 from which the ccsid can be derived. |
--resource | resource id | Specifies the resource id (queue, topic, etc.) specified on the activity inputs or outputs. This determines what message formats and fields are to be parsed. Exclusive with --format, --spec, --txnid, --instid, and --payload. |
--txnid | Not applicable | Specifies to parse the data for the field specifications of the transaction id. Exclusive with --resource, --format, and --spec. |
--instid | Not applicable | Specifies to parse the data for the field specifications of the instance id. Often used with --txnid. Exclusive with --resource, --format, and --spec. |
--payload | all | name | Specifies to parse the data for the field specifications of all payload or the name specified. Often used with --txnid. Exclusive with --resource, --format, and --spec. |
--format | format name | Specifies the message format used to parse the data. Used in conjunction with --spec. Exclusive with --resource, --txnid, --instid, and --payload. |
--spec | field spec | Specifies a field specification to parse from the message format specified by --format. Exclusive with --resource, --txnid, --instid, and --payload. |
--mq | Not applicable | Specifies to simulate the BTM WebSphere MQ extension and publish touchpoint data after parsing. Requires --test, --qm, --app, – resource and --buffer. |
--qm | queue manager | The queue manager to use in the simulation when using --mq. |
--app | application | The application name to use in the simulation when using --mq. |
--createTxn | msgid | body | Creates a unique transaction identifier either in the MQMD message id field or in the body when using --mq. |
--threads | n | For development use only. Requires --test. |
--detail | name value | For development use only with --threads. |