Referencing Configuration Parameters within Agent Builder Scripts
Technote (FAQ)
Question
How you can reference parameters that are set in the agent configuration within scripts when developing a solution using the agent builder?
Answer
There are two primary ways to reference configuration parameters within agent builder scripts. The method used will depend on the type of parameter desired to use.
Retrieving the name of the subnode is done with either $IDLABEL or %IDLABEL% , depending on the operating environment. This variable will return exactly what the subnode name has been configured to and nothing more. It will not contain the agent product code.
All other configuration parameters can be retrieved by referencing either $KXX_VARIABLE_NAME or %KXX_VARIABLE_NAME% where XX is the product code for the agent builder agent and VARIABLE_NAME is the name of the desired configuration parameter. This value is also displayed within the agent builder GUI on the "Runtime Configuration" tab under "Environment variable" as shown below:
Both of the above mentioned variables may be directly references in shell scripts or batch files run by the agent.
Product Alias/Synonym
ITM
Monitoring
AB
Agent Builder
Copyright and trademark information
IBM, the IBM logo and ibm.com are trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.
Rate this page
Please take a moment to complete this form to help us better serve you.
