Job Management Partner 1/Software Distribution Administrator's Guide Volume 1

[Contents][Glossary][Index][Back][Next]

3.3.2 Creating user inventory items

To collect user inventory information, you must first create a list of user inventory items on the managing server and then distribute it to the clients.

By creating user inventory items, you specify the particular items to be reported by the client users and how they are to be entered. You can create a maximum of 255 user inventory items.

Organization of this subsection
(1) Creating user inventory items
(2) Restriction on the characters that client users are permitted to enter
(3) Associating user inventory items with one another
(4) Notes on selection items
(5) Procedure for creating hierarchical user inventory items
(6) Importing and exporting user inventory items
(7) Merging user inventory items in a hierarchical system of managing servers
(8) Notes on creating user inventory items

(1) Creating user inventory items

To create user inventory items:

  1. In the System Configuration, Destination, Package, Job Definition, Job Status or Directory Information window, from the Options menu, choose Define User Inventory.
    The Define User Inventory dialog box appears.

    Figure 3-34 Define User Inventory dialog box

    [Figure]

  2. Select Items in the Item field, and then choose Add.
    The Add Item dialog box appears.

    Figure 3-35 Add Item dialog box

    [Figure]

  3. Enter an item name.
    Enter an item name as up to 64 characters. Trailing spaces are ignored. The following special characters and the tab character are not permitted:
    \ / * " ' : ; , &, %
    Item names are used as key names for management purposes. Once specified, they cannot be changed. An item name that duplicates another user inventory item name cannot be specified.
    You must specify names that are different from those used in the system information and registry information. If you specify names that are the same as the system information or registry information, Inventory Viewer might not execute information display and collection correctly.
  4. Choose OK.
    The Edit dialog box appears.

    Figure 3-36 Edit dialog box

    [Figure]

  5. Configure settings for the item, such as how the client users are to enter the item.
    Item
    Displays the item name specified in the Add Item dialog box. You cannot change the item name.
    Label
    A label is a name displayed on the managing server and clients. You cannot specify a label that duplicates the label assigned to any other user inventory item.
    You can specify a label as up to 64 characters. The following special characters and the tab character are not permitted:
    \ / * " ' : ; , &, %
    Any spaces at the end of a character string are ignored.
    Comment
    You can enter a comment of up to 255 characters. Semicolons (;), percent signs (%), and tab characters are not permitted.
    Any spaces at the end of a character string are ignored.
    Input method
    Specify the entry method to be used at the clients.
    Text
    Select this method to have a user at the client machine enter a character string such as a terminal user name.
    List
    Select this method to have a user at the client machine select an item such as a group name.
    List (Text is possible)
    Select this method to have a user at the client machine select from fixed items or enter text. If you select this option, it is advisable to provide guidance information for the user in the Comment box.
    Specify the selection item(s)
    If you selected List or List (Text is possible), specify the selection items here.
    You can specify a maximum of 255 selection items with each item consisting of no more than 200 characters. A maximum of 200 characters can be entered for each selection item. You can create as many selection items as you wish as long as the total value of all of the selection items does not exceed 51,254 bytes.
    An example of a formula for estimating the total value follows:
    [Figure]
    The following special characters and the tab character are not permitted:
    \ / * " ' : ; , &
    Any spaces at the end of a character string are ignored.
    To create a selection item, enter the item and then click the Add button. To delete a selection item, select the item in the list box and click the Delete button.
    Add button
    To create a selection item, enter a selection item and then click the Add button. If the total value of all of the selection items does not exceed 51,254 bytes, you cannot add the entered selection item, even if you click the Add button.
    Delete button
    Deletes the selected selection item.
    Sort
    The Sort button is available when List or List (Text is possible) is selected. Click this button to sort the listed items by name. This button toggles between sorting in ascending order and sorting in descending order. Once you click the Sort button, you cannot change back to the original order unless you click the Cancel button. Therefore, when you finish entering items, it is a good idea to first click OK and save the items before sorting the list.
    Limit the characters that can be entered
    When Text or List (Text is possible) is selected, this check box is enabled so that you can limit the characters that the client users can enter. For details about how to limit the characters that client users can enter, see (2) Restriction on the characters that client users are permitted to enter below.
    Make an entered item required
    When this check box is selected, the item becomes a required item that the client users must enter.
  6. Choose OK.
    The specified items are added to the Define User Inventory dialog box.

    Figure 3-37 Define User Inventory dialog box

    [Figure]

(2) Restriction on the characters that client users are permitted to enter

When you select Limit the characters that can be entered in the Edit dialog box, the dialog box is expanded as shown below. The expanded area lets you define restrictions on the characters that can be used by the client users in making the entry.

You can restrict the types of characters that client users are permitted to enter. For example, you can restrict input to uppercase or lowercase letters. This increases the usefulness of the user inventory information collected for counting or other purposes. For example, for counting user inventory information, you can use this feature to prevent items that differ only in case from being treated as different items.

Figure 3-38 Edit dialog box

[Figure]

To define restrictions on the characters that the client users can use:

  1. In the Choose a sample from the following list box, select a sample.
    The items in the Characters that can be entered pane are automatically set to be consistent with the sample you selected.
  2. Change the settings in the Characters that can be entered pane as required.
    Client users can enter only the selected characters. Regardless of the settings here, trailing spaces are ignored and client users cannot use the tab character or the following special characters:
    \ / * " : ; , &
    Any spaces at the end of a character string are ignored.
    Selecting All other characters except above in the Characters that can be entered pane enables you to enter symbols other than those listed above.
    Note that when List (Text is possible) is selected as the Input method, the characters used to create the list must not conflict with the restrictions defined here.

(3) Associating user inventory items with one another

You can assist client users to enter data by associating user inventory items with one another. For example, consider the organizational chart shown in the figure below, with Department and set as user inventory items in the normal way. No matter what department the client user selects as the applicable user information, eight items will be displayed in the list of sections. However, if you associate the selection items for Department and according to the organizational chart, when the client user enters user information, the field will list only the sections in the selected department.

Figure 3-39 Associating user inventory items

[Figure]

In this way, you associate one user inventory item with a lower user inventory item and interrelate them appropriately. This is known as creating hierarchical user inventory items. By arranging user inventory items in a hierarchy, you enable client users to more easily find the relevant selection items among a restricted range, thus reducing the incidence of invalid entries.

You can create up to 10 hierarchical levels for user inventory items. This applies only to items for which List is selected as the Input method. Create the items from the highest level down. You cannot create the highest- and lowest-level items, and then create the intermediate items.

(4) Notes on selection items

You should note the following points about creating hierarchical user inventory selection items.

(a) When selection items overlap with each other

Except at the lowest level, you must specify different sets of selection sets for an inventory item. That is, you cannot specify two identical sets of lower-level selection items for one upper-level inventory item. However, if the sets of selection items are at the lowest level, then you can specify the same set of selection items for different upper-level selection items. The following figure illustrates how duplicated sets of selection item values are handled.

Figure 3-40 Handling of duplicated sets of selection items

[Figure]

If entities at middle layers of the organizational structure have the same name, distinguish them by prefixing the selection item names with the name of the selection item at the higher level, as shown in the following figure.

Figure 3-41 Example of naming selection items

[Figure]

You cannot directly associate a higher selection item with a lower one, skipping the intermediate selection items.

(b) Limit on the total size of selection items

There is a limit on the total size of selection items that can be set for each user inventory item. When selection items are created, their total size is calculated. If this total exceeds the limitation, no more selection items can be created.

When selection items are created for a hierarchical user inventory item, the total size of selection items is checked in two stages.

  1. Total size of selection items within the hierarchy
    First, the total size of the selection items within the hierarchy is checked. Only this check is applied to the selection item at the top of the hierarchy.
  2. Total size of selection items at a lower level
    Next, for the second and lower layers, the total size of the selection items, including those in the hierarchy immediately above, is checked.

Use the following formulas for estimating the total size of selection items:

If the total size of selection items exceeds either the total-size-of-selection-items-within-the-hierarchy or total-size-of-selection-items-at-a-lower-level, or both, a warning message is displayed in the window. Take an action according to the warning message.

(c) When there are no associated lower-level selection items

If there are no associated lower-level selection items, the item is disabled for client user entry of user information. For example, in Figure 3-39, if you select GenAffairs (Department) and then Secretariat (Section), the Unit item is disabled and there is no need for you to enter anything.

(5) Procedure for creating hierarchical user inventory items

This section explains how to create hierarchical user inventory items. Create user inventory items beginning with the highest-level item. You cannot create intermediate-level items after creating the highest-level item and the lowest-level item.

(a) Creating the highest-level item

You must create hierarchical user inventory items in order beginning with the highest-level items. To create a highest-level item, use the same procedure as for an ordinary user inventory item (see (1) Creating user inventory items above). Once you have added a selection item, you edit it using the same procedure as for a lower item (see (b) Creating the lowest-level item below).

You should note the following points about creating a highest-level item:

(b) Creating the lowest-level item

To create a lower-level inventory item:

  1. In the System Configuration, Destination, Package, Job Definition, Job Status or Directory Information window, from the Options menu, choose Define User Inventory.
    The Define User Inventory dialog box appears.
    The hierarchical items appear in a tree structure in the Item field. The number in the icon preceding each item name shows the item's level in the hierarchy.

    Figure 3-44 Define User Inventory dialog box

    [Figure]

  2. In the Item field, select a higher-level item and choose Add.
    The Add Item dialog box appears.

    Figure 3-45 Add Item dialog box

    [Figure]

  3. Make sure that the A lowest level item check box is selected in the Add the item as area, and then enter the item name in the box.
    Item
    Enter an item name as up to 64 characters. Trailing spaces are ignored. The following special characters and the tab character are not permitted:
    \ / * " ' : ; , &, %
    Item names are used as key names for management purposes. Once specified, they cannot be changed. An item names that duplicates another user inventory item name cannot be specified.
    Add the item as
    Specify whether to arrange the item hierarchically. This item is enabled only when an item that is set in List under Local server in the Define User Inventory dialog box is selected.
    An independent item
    Adds the item as an ordinary user inventory item, unrelated to any other user inventory items.
    A lowest level item
    Adds the item at the lowest level under the item selected in the Define User Inventory dialog box.
  4. Choose OK.
    The Edit dialog box appears.

    Figure 3-46 Edit dialog box

    [Figure]

  5. Enter a label and comment.
    Item
    Displays the item name specified in the Add Item dialog box. You cannot change the item name.
    Label
    A label is a name displayed on the managing server and clients. You cannot specify a label that duplicates the label assigned to any other user inventory item.
    You can specify a label as up to 64 characters. The following special characters and the tab character are not permitted:
    \ / * " ' : ; , &, %
    Any spaces at the end of a character string are ignored.
    Comment
    You can enter a comment of up to 255 characters. Semicolons (;), percent signs (%), and tab characters are not permitted.
    Any spaces at the end of a character string are ignored.
  6. Set the selection items.
    The Specify the selection item(s) field is an editable list of all the selection items related to the item you just added. The number in the icon preceding each item name is the item's level in the hierarchy.
    You can specify a maximum of 200 characters for each selection item name. Trailing spaces are ignored. The following special characters and the tab character are not permitted:
    \ / * " ' : ; , &
    Any spaces at the end of a character string are ignored.
    Add
    To add a new selection item, select the selection item with which you wish to associate a new selection item as a lower item, and click the Add button. The Add Selection Items dialog box appears. Enter a name for the selection item, and then click OK to export the item back to the Specify the selection item(s) field.
    You can enter multiple selection items as a batch operation in the Add Selection Items dialog box. All characters up to a linefeed are regarded as a single selection item. You can also copy and paste text data or CSV-formatted data into the dialog box.
    If the total value of the selection items exceeds the upper limit when you are trying to add multiple selection items in the Add Selection Items dialog box, you can select whether to add only those that are within the upper limit. For details about the upper limit, (4)(b) Limit on the total size of selection items.
    Change
    To modify a selection item, select the item and click the Change button.
    If the total value of the selection items exceeds the upper limit when you are trying to change the name of a selection item, the name of that selection item cannot be changed. Adjust the size of the selection item name and re-enter it. For details about the upper limit, (4)(b) Limit on the total size of selection items.
    Delete
    To delete a selection item, select the item and click the Delete button. This button deletes the selected selection item and all lower selection items related to it.
    [Figure] and [Figure]
    Select a selection item and then click the up or down arrow to move its display order in the list. All related lower selection items also move. The display order in this dialog box determines the order in which users will enter user information in the Update User Information dialog box at the client side.
    Sort
    Select a selection item, and then click this button to sort the related lower selection items by name. This button toggles between sorting in ascending order and sorting in descending order. Once you click the Sort button, you cannot change back to the original order unless you click the Cancel button. Therefore, when you finish entering items, it is a good idea to first click OK and save the items before sorting the list.
    Properties
    This button displays information about the user inventory item to which the selected selection item belongs, including its name and label, and the number of selection items that have been created.
    In the Specify the selection item(s) field, you can copy or move selection items by drag-and-drop within the same user inventory item (within the same level in the hierarchy). All related lower selection items move with the selection item you are moving.
    If the total value of the selection items exceeds the upper limit when you are trying to copy selection items, you can select whether to copy only those that are within the upper limit. For details about the upper limit, (4)(b) Limit on the total size of selection items.
  7. When you finish setting selection items, click OK.
    The items you have set are added to the Define User Inventory dialog box.
(c) Arranging existing user inventory items in a hierarchy

You can arrange previously created user inventory items into a hierarchy. This applies only to items for which List is selected as the Input method at the client side. The setting for the Make an entered item required attribute is inherited from the highest-level item.

To arrange existing user inventory items in a hierarchy:

  1. In the System Configuration, Destination, Package, Job Definition, Job Status or Directory Information window, from the Options menu, choose Define User Inventory.
    The Define User Inventory dialog box appears.
  2. In the Item field, drag-and-drop the user inventory item that you wish to set as a lower item onto the user inventory item that is to be the higher item.
    The Edit dialog box appears.

    Figure 3-47 Edit dialog box

    [Figure]

    The higher selection items appear in the Specify the selection item(s) area, and the lower selection items appear in the Unrelated selection items area below. However, if there are any higher selection items not yet associated, they are also listed in the Unrelated selection items area. The number in the icon preceding each item name is its level in the hierarchy.
  3. Associate lower selection item(s) with a higher selection item.
    From the Unrelated selection items field, move one or more selection items by drag-and-drop to a selection item listed in the Specify the selection item(s) area that you want to make the higher item. You cannot move items to a different level.
    If the same selection item already exists at the move destination, it remains in the Specify the selection item(s) area, while the item you selected disappears from the Unrelated selection items area.
  4. Click the Delete button to erase any unnecessary selection items remaining in the Unrelated selection items area.
    If any selection items remain in the Unrelated selection items area when you finish editing, they will appear as lower selection items at input of user information at the clients regardless of the selection items you have set for the higher item.
    If the same item appears at the same level in both areas of the dialog box, the duplicate is erased from the Unrelated selection items area when you save your work.
  5. Choose OK.
    The user inventory items are arranged in a hierarchy.
    If you click the Cancel button instead of OK, the drag-and-drop operations you performed in the Define User Inventory dialog box are canceled.
(d) Removing user inventory items from a hierarchy

You can remove lowest-level items from a hierarchical user inventory item and change them back to independent items.

When you do this, the selected lower-level items are disassociated from all higher-level items and become ordinary selection items. Duplicate selection items that are associated with different higher-level items become a single selection item. The Make an entered item required attribute is inherited from the original highest-level item.

To reset a hierarchical user inventory item as an independent item, drag-and-drop the lowest level items in the Item field to the Items area of the Define User Inventory dialog box.

Figure 3-48 Define User Inventory dialog box

[Figure]

(6) Importing and exporting user inventory items

When you use the Define User Inventory dialog box in creating user inventory items, you have to enter items one by one. This makes use of the Define User Inventory dialog box laborious. However, by editing user inventory items in a file, you can create the selection items and other user inventory items all at once.

The following describes how to update existing user inventory items and how to create new user inventory items.

(a) Updating existing user inventory items

To update the existing user inventory items, export them to a file, edit the file, and then re-import the file you edited:

  1. Use the Export button in the Define User Inventory dialog box to output the file to the desired location.
  2. Open the file with a text editor.
    Before editing the file, back it up under a different name. After backing up the file, delete the lines except those you want to copy or change.
  3. Edit the lines and save the file.
  4. Use the Import button in the Define User Inventory dialog box to import the edited file and update the user inventory items.
    The following restrictions apply to user inventory items created from an imported file:
    • You cannot update items managed on the higher server or items managed on higher and local servers. You cannot output items managed on the higher server or managed on higher and local servers by exporting them.
    • A comment cannot include a linefeed character.
    • You cannot restrict the characters that can be entered at the clients. However, when you update the existing items, the restrictions on the characters that can be used are maintained. For new items, no restrictions can be placed on the usable characters.
    • You cannot add, change, or delete the selection items at a higher level of user inventory items that are already arranged in a hierarchy.
    If the above restrictions are not acceptable in our situation, you must use the Define User Inventory dialog box to re-edit the user inventory items.
(b) Creating new user inventory items

To create new user inventory items, first create one item and then copy it. You can also create and import a parameter file to create new user inventory items. For details about creating a parameter file, see (c) Format of import and export files below.

To create new user inventory items:

  1. In the Define User Inventory dialog box, create only one user inventory item.
  2. Click Export to export the user inventory item to a file at a location of your choice.
  3. Open the file with a text editor, and use copy-and-paste editing to add new items.
  4. Use the Define User Inventory dialog box to import the file you edited.
    The new items are added at the end of the list.
(c) Format of import and export files

The file formats for importing or exporting user inventory items are shown below. The file formats differ for ordinary user inventory items and hierarchical user inventory items.

For details about the parameter setting rules, see 4.26 Creating a parameter file in the manual Administrator's Guide Volume 2.

File format for ordinary user inventory items
USER_INVENTORY { { item = item-name label = label comment = comment require = Y-or-N insert = Y-or-N select = selection-item-1; selection-item-2; selection-item-3; ...} }
 
  • item = item-name
    Specify up to 64 characters as the item name. The maximum number of item names is 255. The following special characters and the tab character are not permitted:
    \ / * " ' : ; , &, %
    Any spaces at the end of a character string are ignored. Item names are used as key names for management purposes. Therefore, once specified, they cannot be changed.
  • label = label
    Specify a label of up to 64 characters. The following special characters and the tab character are not permitted:
    \ / * " ' : ; , &, %
    Any spaces at the end of a character string are ignored.
    The label is a name displayed on the managing server and clients.
  • comment = comment
    Specify an optional comment of up to 255 characters. Semicolons (;), percent signs (%), and tab characters are not permitted.
    Any spaces at the end of a character string are ignored.
  • require = Y(y)-or-N(n)
    Specify whether or not this item is required on the client side. Omitting this entry or specifying N (or n) indicates an optional item.
  • insert = Y(y)-or-N(n)
    Specify whether or not text may be entered in addition to selecting a list item. Omitting this entry or specifying N (or n) indicates that only selection from a list is permitted.
  • select = selection-item-1; selection-item-2; selection-item-3;
    Specify one or more selection items. If you specify multiple selection items, separate them with the semicolon (;) or a linefeed.
File creation example (ordinary user inventory items)
The following shows an example of file creation for ordinary user inventory items.

Figure 3-49 Example of file creation (ordinary user inventory items)

[Figure]

File format of hierarchical user inventory items
USER_INVENTORY { { item = item-name label = label comment = comment require = Y-or-N select = selection-item-1; selection-item-2; selection-item-3; ... upper_item = upper-item relation { { upper_select = upper-selection-item selectable = selection-item-associated-with-upper-selection-item } } } }
 
  • item = item-name
    Specify up to 64 characters as the item name. The maximum number of item names is 255. The following special characters and the tab character are not permitted:
    \ / * " ' : ; , &, %
    Any spaces at the end of a character string are ignored. Item names are used as key names for management purposes. Therefore, once specified, they cannot be changed.
  • label = label
    Specify a label of up to 64 characters. The following special characters and the tab character are not permitted:
    \ / * " ' : ; , &, %
    Any spaces at the end of a character string are ignored.
    The label is a name displayed on the managing server and clients.
  • comment = comment
    Specify an optional comment of up to 255 characters. Semicolons (;), percent signs (%), and tab characters are not permitted.
    Any spaces at the end of a character string are ignored.
  • require = Y(y)-or-N(n)
    Specify whether or not this item is required on the client side. Omitting this entry or specifying N (or n) indicates an optional item. The same value specified for the upper item must be specified for its lower items.
  • select = selection-item-1; selection-item-2; selection-item-3;
    Specify one or more selection items. If you specify multiple selection items, separate them with the semicolon (;) or a linefeed.
  • upper_item = upper-item-name
    Specify the name of the upper item. You can specify this name only for a selection item. The upper item name is required for a lower item.
  • relation
    Specifies association between selection items. This item is required for lower items. Specify upper_select and selectable as a pair within the curved braces ({ }).
  • upper_select = upper-selection-item
    Specify an upper selection item. An upper selection item is required for a lower item.
  • selectable = selection-item-associated-with-upper-selection-item
    Specify a selection item that is associated with the upper selection item specified by upper_select. To specify multiple selection items, separate them with the semicolon (;) or a linefeed. This setting is required for a lower item.
File creation example (hierarchical user inventory items)
The file format is described below using three hierarchical user inventory items as an example.

Figure 3-50 Example of a hierarchy of user inventory items

[Figure]

Figure 3-51 File creation example (hierarchy of user inventory items)

[Figure]
(d) Notes on importing and exporting user inventory items

(7) Merging user inventory items in a hierarchical system of managing servers

In a hierarchical system of managing servers, the user inventory items created at the central manager may differ from those created at the relay managers.

(a) Merging user inventory items at a relay manager

When user inventory items are transferred from the central manager, the relay manager merges them into its user inventory items according to the following rules:

You can view the merge results in the Define User Inventory dialog box.

Figure 3-52 Define User Inventory dialog box

[Figure]

The Managed on field displays the source of each user inventory item as follows:

Higher server
Item collected by the central manager.

Local server
Item collected by the relay manager.

Local and higher servers
Item collected by both the central manager and relay manager.
(b) Changing the attribute of an item managed at a relay manager

You can change at the relay manager the attribute of an item managed at the relay manager. That is, you can change the attribute of an item from item managed on higher server to item managed on local and higher servers, and vice versa.

You cannot delete the higher servers or local and higher servers, and you cannot change their settings. However, you can change an optional item into a required item to make it into an item managed on local and higher servers. If you want to change the item back to an item managed on higher server, you must first change it into an optional item.

You cannot add or delete hierarchical user inventory items in an item created at the higher manager. To change the attribute of the managed item, change the attribute at the highest-level item. Lower items inherit the attribute from the highest-level item.

Regardless of the attribute of the managed items, you can sort the list with the [Figure] and [Figure] buttons.

To change the attribute of a managed item:

  1. In the Define User Inventory dialog box, select the item whose attribute you want to change, and then choose Change.
    The Edit dialog box appears.

    Figure 3-53 Edit dialog box

    [Figure]

  2. Under Access, select or deselect the Enable the user inventory definition of managing servers option.
    The Enable the user inventory definition of managing servers option is enabled when the target item is an item managed on higher server or item managed on local and higher servers. To change an item managed on higher server to an item managed on local and higher servers, select this option. The item managed on higher server is changed to an item managed on local and higher servers. Conversely, if the local server no longer needs to manage an item managed on local and higher servers, deselect this option. The item is changed to an item managed on higher server.
  3. Select or deselect the Make an entered item required check box as required.

(8) Notes on creating user inventory items