Mapping tags to data and events

You can map tags that you give meaningful names to data in events to display information in the Completed file transfers view, Completed processes view, or both, that is relevant to your business needs.

  1. Identify information that you want to display in the Completed file transfers view or the Completed processes view in the web console.
  2. Specify labels for user-defined fields. The labels you specify are displayed in the list of available tags when you are mapping data in events.

After you assess the data, events, and user-defined fields that are needed to include information that you want to see in the views, you can begin mapping the elements.

Tag mappings, which map user-defined labels to data and events, can be created so that they apply to both file transfers and processes, or only file transfers, or only processes. If you want to extract a piece of data from an event to store alongside file transfers from a particular type of server, you can define the mapping once by selecting Both processes and file transfers. This action saves you the trouble of defining the mapping twice.

You can create mappings that apply to processes, transfers, or both coming from any type of server. If you have a piece of data that is not limited to a particular type of server, you can define the mapping under Defaults for all server types.

If a mapping is defined for a process, file transfer, or both but does not end up matching the event that is specified in the mapping, the field is not populated. You can define a mapping that matches only sometimes. If the mapping matches, the field is populated. If the mapping does not match, the field is not populated. As a result, you can define two mappings for the same tag that are mutually exclusive. For example, Tag 2 might be populated sometimes by mapping 1 and sometimes by mapping 2.

There are six levels of tag mappings:
  1. Any server type / Any server / Any event
  2. Any server type / Any server / Specific event
  3. Specific server type / Any server / Any event type
  4. Specific server type / Any server / Specific event type
  5. Specific server type / Specific server / Any event type
  6. Specific server type / Specific server / Specific event type

If you define mappings at all six levels for Tag 1, they are processed in the order listed: least specific to most specific, with the most specific taking precedence over the least specific. However, if you have 4 mappings for Tag1 and the mapping at level 4 matches an event but the event is not populated with data or is populated with a null value, then the value found in events that were matched at levels 1, 2, and 3 take precedence.

Attention: After you create a tag mapping, it affects only new processes and file transfers. New tag mappings have no affect on processes and file transfers that are already summarized in the views.

To map tags so that they can be displayed in the Completed file transfers view, Completed processes views, or both:

  1. From the web console, click Menu button, which contain system settings, placed at the extreme right hand side of the screen (Menu button) > System Settings > Custom Views.
  2. From the navigation tree, expand one of the individual server types or Defaults for all server types.
  3. Expand Tag mappings.
  4. Click either Any event type or one of the event types in the list.
    A tag mappings page displays that lists the tags that are defined for the server type you selected.
  5. Click the plus sign icon.
  6. Type a name for the new tag mapping.
  7. Select the type of summary the tag mapping applies to: Both processes and file transfers, File transfers, or Processes. The default is Both processes and file transfers.
  8. Select a tag for the mapping. User-defined fields, or tags, that you customized are available for selection. If you did not customize tags, they have the default names: Tag 1, Tag 2, and so on.
  9. You have the option of specifying one or more events to which this mapping applies.
    • To look for every occurrence of the event type you selected in the tree, for example, every Process step started event, you do not need to specify a particular event.
    • To look for a particular event, select the Attribute, Relation, and Value for the event you want to target.
    • To combine event criteria using OR, click Switch to advanced. You are able to configure the event criteria by selecting an ID (a token of A, B, C, D, and E), Attribute, Relation, and Value for each criterion. Then, you can use the tokens to create the final expression using AND and OR and parentheses as shown in the following example:
      A OR (B AND E) OR (C AND D)
      One or more attributes can be defined. When multiple attributes are defined, they are evaluated as AND.
  10. Click Select data to specify the value you want to extract from the event. If the value you want to extract from the event is contained in an XML string, Click XML fields and type the XML field name.
  11. You can specify a fallback value to populate if the value that you specified in the previous step is not found. You can also use this field to hardcode a value for the criteria you specified, for example, Payroll.

Configure the Completed file transfers view or the Completed processes view to include the tag mappings in the web console.