Additional extended attribute settings files

Format

To Page Top

Parameters by type

Required parameters:

None

Custom parameters:

None

To Page Top

File names

recv_add_extattr (file for transfer reception)

send_add_extattr (file for event registration)

add_extattr.model (model file for an additional extended attribute settings file)

To Page Top

Storage destination directory

For Windows:

folder-specified-in-event-server-index-file\

shared-folder\jp1base\event\ (in a cluster configuration)

In the initial settings of the event server index file (index), the specified folder is installation-folder\conf\event\servers\default\.

For UNIX:

directory-specified-in-event-server-index-file/

shared-directory/event/ (in a cluster configuration)

In the initial settings of the event server index file (index), the specified directory is /etc/opt/jp1base/conf/event/servers/default/.

To Page Top

Description

Additional extended attribute settings files are used to set the conditions for JP1 events to which extended attributes are to be added, and to set the names and values of the extended attributes. There are additional extended attribute settings files for transfer reception (recv_add_extattr) and for event registration (send_add_extattr).

The settings in additional extended attribute settings files are required to define through referring to the Recommended definition method below. In the initial state, these files are not provided.

If the additional extended attribute settings file for transfer reception (recv_add_extattr) is created, extended attributes are added based on the definitions in the file when transferred JP1 events are received. If the additional extended attribute settings file for event registration (send_add_extattr) is created, extended attributes are added based on the definitions in the file when JP1 events are registered in the event database.

The following table describes the JP1 events to which extended attributes are added by a definition file.

To Page Top

Application of settings

The settings are applied when the event service is started or restarted, or when an additional extended attribute settings file is reloaded by the jevextreload command. For details about this command, see jevextreload in 15. Commands. Note that if the event service is restarted, all services that use the event service must also be restarted.

To Page Top

Definition details

The following conventions apply to entries in the additional extended attribute settings files (recv_add_extattr and send_add_extattr):

• These files are text files in which each line can have 1,023 or fewer bytes.

• Separate parameter keywords with a space (code 0x20) or a tab (code 0x09).

• Do not insert a space or any other characters in front of the parameter name and hash mark (#) (code 0x23) at the start of a line.

• A hash mark (#) (code 0x23) at the start of a line indicates a comment.

• Letters are case sensitive.

add ... end-add [exit]

A sequence of entries from add to end-add is an attribute addition setting block, which contains a filter block and extended attribute specification. You can specify multiple attribute addition setting blocks. If multiple attribute addition setting blocks are specified, JP1/Base processes them in the order they are specified (the first block is processed first). Note that the keyword end-add can be followed by the keyword exit. If the condition specified in an attribute addition setting block is satisfied and exit is specified in that block, processing of the subsequent attribute addition setting blocks is skipped. If the filter block is omitted, JP1/Base assumes that the condition is satisfied. You cannot omit both the filter block and extended attribute specification.

filter ... end-filter

A sequence of entries from filter to end-filter is a filter block, which specifies a definition for filtering JP1 events to which an extended attribute is to be added. The following shows the format of a filter block:

filter
event-filter
end-filter

If the filter block is omitted, all JP1 events are subject to conversion. For the event filter, you can also specify an exclusion condition. For details about the writing format of an event filter, see Event filter syntax.

E.extended-attribute-name attribute-value

This is an extended-attribute specification parameter. Specify the name and value of an extended attribute (user-specific information) to be added to JP1 events. By specifying multiple extended-attribute specification parameters, you can add multiple extended attributes to one JP1 event. Each JP1 event can have a maximum of 100 extended attributes (calculated as the combined total of the common information and user-specific information). However, the total length of extended attribute values that can be defined for JP1 events cannot exceed 10,000 bytes. You can add extended attributes as long as these limitations are not exceeded. Note that in one attribute addition setting block, you cannot specify the same extended attribute name more than once.

You can omit the extended-attribute specification parameters. To exclude specific JP1 events from being the targets for addition of extended attributes, define the condition that identifies the target JP1 events in the event filter, and then specify exit after end-add of the attribute addition setting block.

Note

If you specify a multi-byte character as an extended attribute value, when the JP1 event character code is C, the specified character becomes garbled. If you want to specify a multi-byte character, add character code (B.CODESET) conditions to the event conditions, with different character strings defined for the character code 8859_1 (C) and other character codes.

E.extended-attribute-name

Following the string E., specify the name of the extended attribute to be added. The name can be a maximum of 32 bytes. You can use uppercase letters, numeric characters, and underscores (_). Note that the first 7 bytes of each extended attribute name is fixed to JP1ADD_. That is, you can specify a maximum of 25 bytes after E.JP1ADD_.

attribute-value

Specify the value of the extended attribute whose name is specified by the E.extended-attribute-name entry. You can enter a character string that is from 1 to 255 bytes. For the value of an extended attribute, you cannot specify a blank (null string). You cannot specify a value that includes line breaks, either.

To Page Top

Notes

• If an extended attribute is added to a JP1 event that already has that extended attribute, the extended attribute is updated with the new value.

• When a JP1 event with extended attributes added is transferred, the added extended attributes are also transferred together.

To Page Top

Recommended definition method

• Though attribute addition can be done on an agent host, we recommend that you do it on the manager host in order for integrated management of events to add attributes.

• The processing for adding extended attributes affects the event registration performance in proportion to the number of attribute addition setting blocks multiplied by the number of events. Therefore, we recommend that you consider the following notes when defining the additional extended attribute settings file. Note that in the processing for adding extended attributes, attribute addition setting blocks are processed from the beginning for each JP1 event.

  • When JP1/IM - Manager is running in a hierarchical structure of three or more levels, configure the additional extended attribute settings file in the site manager or sub manager.

  • You can reduce the processing for adding extended attributes by defining an attribute addition setting block at the beginning that includes a condition for JP1 events to which extended attributes are not added.

  • Conditions for all the JP1 events and for JP1 events that occur frequently must be defined as higher levels in the additional extended attribute settings file.

  • Specify exit after end-add in each attribute addition setting block, except when adding a different attribute for each condition to a single JP1 event.

  • The total number of attribute addition setting blocks defined in the additional extended attribute settings file must be no more than 2,500. Although an error does not occur even if you define 2,500 or more attribute addition setting blocks, the event registration performance might degrade and operation might be affected.

To Page Top

Definition examples

The following is an example definition that adds the name of a business group to which the agent host belongs as an extended attribute to JP1 events received on the manager side.

Conditions for adding the extended attribute for the integrated manager (jp1-mgr)

• The extended attribute is added to JP1 events whose severity (SEVERITY) is not Information and Notice.

• Business group name jp1-grp1 is added to JP1 events transferred from agents (jp1-agt001 to jp1-agt100) in business group 1 as extended attribute JP1ADD_GROUPNAME.

• Business group name jp1-grp2 is added to JP1 events transferred from agents (jp1-agt101 to jp1-agt200) in business group 2 as extended attribute JP1ADD_GROUPNAME.

  Figure 16‒5: Flow of JP1 event transfer in the definition example

Example definition of the additional extended attribute settings file (recv_add_extattr) for transfer reception in the integrated manager (jp1-mgr)

# Exclude JP1 events whose severity is Information or Notice from the target of extended attribute addition.
add
filter
E.SEVERITY IN Information Notice
end-filter
end-add exit
# Add business group name jp1-grp1 as extended attribute JP1ADD_GROUPNAME
#  to JP1 events transferred from agents (jp1-agt001 to jp1-agt100).
add
filter
B.SOURCESERVER RANGE jp1-agt001 jp1-agt100
end-filter
E.JP1ADD_GROUPNAME jp1-grp1
end-add exit
# Add business group name jp1-grp2 as extended attribute JP1ADD_GROUPNAME
#  to JP1 events transferred from agents (jp1-agt101 to jp1-agt200).
add
filter
B.SOURCESERVER RANGE jp1-agt101 jp1-agt200
end-filter
E.JP1ADD_GROUPNAME jp1-grp2
end-add exit

To Page Top