Naming and configuring the agent

Use the Agent wizard to name your agent, set its version, supported operating systems, and other configuration settings.

1. Use one of the following ways to start the new agent wizard:
   1. Click the Create New Agent icon on the toolbar.
   2. From the Main menu, select File > New > Agent.
   3. From the Main menu, select File > New > Other. In the Select a Wizard page, double-click the Agent Builder folder, then double-click Agent.
   The Agent wizard opens.
2. Click Next.
3. In the New Agent Project page, set the name of the project in the Project name field. Agent Builder uses this name for the folder that contains the agent files. You can optionally change the following settings:
   • If you want to store the agent files in a different location, clear Use default location and click Browse to select the new directory in the Location field.
   • You can change how the Eclipse Navigator View displays resources by adding them to various working sets. For more information, see the Eclipse help. To add the agent to Eclipse working sets, select Add project to working sets and click the Select button to add the sets to the Working sets field.
4. Click Next.
5. In the General Information page, configure the following settings:
   • Type the copyright statement that you want to use for your new agents in the Copyright field. This statement must meet your legal requirements for copyrights. This copyright statement is inserted into all files that are generated for the agent; you can edit it later.
   • Select the operating systems for which you want your agent to be built.
     Important: If you want to run a full test of the agent inside Agent Builder (for instructions, see Full agent testing), ensure that:

     • If you are running Agent Builder on Windows, the 32-bit version of the operating system is installed.
     • If you are running Agent Builder on Linux®, the 64-bit version of the operating system is installed.
     Important: In some rare cases, you might need to install your agent on a 64-bit system where only a 32-bit operating system agent is installed. In this case, ensure that the 64-bit version of the operating system is not selected and the 32-bit version is selected.
     Important: 64-bit Windows Server 2003 R2 and earlier Windows systems are not supported by the agents created using Agent Builder.
6. Click Next.
7. In the Agent Information page, configure the following settings:
   • Set the service name for the agent in the Service name field. The name is displayed in the Manage Tivoli Monitoring Services window in an IBM® Tivoli® Monitoring environment and in the Manage Monitoring Services utility and Threshold editor in an IBM Cloud Application Performance Management. On Windows systems, it is also the name of the Windows service that runs the agent. The full service name always starts with Monitoring Agent for. You enter the remaining part of the name, which normally describes the service that this agent monitors. The name can contain letters, numbers, spaces, and underscores.
   • Set a three-character product code for the agent in the Product code field. A product code is required for both IBM Tivoli Monitoring and IBM Cloud Application Performance Management. A range of product codes is reserved for use with the Agent Builder. The permitted values are K00-K99, K{0-2}{A-Z}, and K{4-9}{A-Z}.
     Important: These values are for internal use only and are not intended for agents that are to be shared or sold outside your organization. If you are creating an agent to be shared with others, you must send a note to toolkit@us.ibm.com to reserve a product code. The request for a product code must include a description of the agent to be built. A product code is then assigned, registered, and returned to you. When you receive the three-letter product code, you are told how to enable the Agent Builder to use the assigned product code.
   • Set a string that uniquely identifies the organization that develops the agent in the Company identifier field (IBM is reserved). You can take it from the URL of your company; for example, if the company website is mycompany.com, use the text mycompany.
   • Set a string that uniquely identifies the agent in the Agent identifier field. By default, Agent Builder sets the Agent identifier to be the same as the Product code.
     Important: The combined length of the Agent identifier field and the Company identifier field cannot exceed 11 characters.
   • Set the agent version in the Version field. The agent version contains three digits in the format V.R.R, where:
     • V = Version
     • R = Release
     • R = Release
     For displaying in the monitoring environment, the V.R.R value is converted into the following format: 0V.RR.00.00
     Tip: In the agent editor, a patch level field is available. The patch level field can be used when you release a fix for an agent, without updating the version.
   • If you want your agent to support multiple instances, select the Support multiple instances of this agent check box. You can use multiple instances of an agent to monitor several instances of an application on the same host, or to use an agent installed on one host to monitor several software servers on different hosts. When you install an agent that support multiple instances, you can create and configure as many instances as necessary.