How can I add a custom data column to summaries of completed file transfers or completed processes?
As an IBM® Control Center Monitor administrator, you can include the data that you want to see in the summaries of completed file transfers or completed processes by configuring a tag mapping. The tag mapping can be applied to a server, server type, or all servers for all users to see.
- Applicable for processes from any type of server.
- Applicable only for processes from a particular type of server.
- Applicable only for processes from a specific server.
- Run traffic on your server and observe the related processes in the IBM Control Center Monitor web console.
- Select a Process ID, which has particular data that you want to view as a column in the Completed processes view or Completed file transfers view.
- In the Process dialog, click the Events tab, and
select a Message ID. In the Event dialog, view the
More information section.Tip: For example, property names that are prefixed with "Gm /" are specific to Global Mailbox.
- Find and record the field name or property name so you can create a tag with the same name.
Also, record the event type for when you map the tag.Restriction: Currently, for dynamically discovered servers, such as Global Mailbox, the field name or property name in the More information section is not the same as the XML field name. You must have direct SQL access to the events table in the IBM Control Center Monitor relational database management system (RDBMS). Then, you can query the events table for the specific event and look in the XML_STRING column for the XML field name.
For example, by default the payload ID of Global Mailbox servers or data centers are not
displayed in the Completed processes views. You can create a Payload ID tag and map it to the XML
gm.payloadId. Then, you can customize your views to include the Payload ID
column when you view only Global Mailbox servers
or data centers.
As another example, by default the consumer and producer organization keys of Sterling File Gateway servers are not displayed in either the Completed file transfers or Completed processes views. In this scenario, you configure a tag label for all Sterling File Gateway servers and name the tag Producer. Then, you map the tag label used for file transfers and for all event types to all Sterling File Gateway servers. You map the Producer tag label to the producer organization key. Lastly, you customize views by adding the Producer column to the summary of Completed file transfers.
Configure the tag label.
- Log in to the IBM Control Center Monitor web console. In the menu bar, hover over your user name and go to .
In the navigation tree on the Customize views with server-specific data
page, expand the B2B Integrator/Sterling File Gateway server type.
Attention: For dynamically discovered servers, such as Global Mailbox, a heartbeat at a minimum must be posted so that IBM Control Center Monitor can dynamically discover the server type. Then, that server type is displayed in the Customize views with server-specific data page.
Click Tag labels.
The Configure tag labels page is displayed.
- Type Producer in the File transfers field for one of the tags.
- Click Save.
Map the tag label to data and events.
- In the navigation tree under B2B Integrator/Sterling File Gateway, expand Tag mappings.
Click Any server, then click the Create a new tag
The Create a new tag mapping page is displayed.
- In the Name field, type a name, such as SFG file transfer Producer mapping.
- Select File transfers for the type of summary to apply the mapping.
- Select the Producer tag for the tag that you want to populate.
- Optional: Select an attribute, relation, and value from each list to define the events that you want to be tagged. In this scenario, ensure that the Preview is All Events.
To select the data that you want extracted from the selected event, click Select
The Select attribute dialog is displayed.
Expand File Gateway stat (fgStat) and click Prod org key
The Select attribute dialog is closed.Tip: For dynamically discovered servers, such as Global Mailbox, click XML fields, type the name of the XML field that you want extracted from the event, then click OK. Do not include xmlString in the XML field name because it is automatically affixed to the XML field after you click OK.
Type Not found as the value that you want extracted if
fgStat.prodOrgKeyis not available.
The Tag mappings for B2B Integrator/Sterling File Gateway page is displayed.
Customize the Completed file transfers view to display the field that is mapped to the
- In the navigation tree under B2B Integrator/Sterling File Gateway, expand Views.
Click Completed file transfers.
The Completed file transfers page is displayed.
- In the Fields available list, select Producer and either drag it to the Fields to display list or click the Move right icon.
- Optional: In the Fields to display list, click Producer, then click the Move up or Move down icons to change the order of the columns in the Completed file transfers summary.
- Click Save.
To view a video of this scenario, see the IBM Control Center Monitor community blog on developerWorks and download the attached video.