Chapter 20 - Managing Attribute Collection and Display
After you define and assign attribute values to StreetTalk objects on your network, you need to configure the STDA services to collect and display these values. This section describes procedures and guidelines to configure master and satellite STDA services that collect attribute values from StreetTalk databases and other STDA services. It also describes how to limit a user's access to an STDA service.
After you specify the attributes you want collected and displayed, the STDA master service downloads them when it downloads data from the designated servers. This information is included in the satellite's database when it rebuilds.
As a general rule, minimize the variation among the attributes you define, collect, and display.
STDA services collect attribute values directly from StreetTalk databases or from other STDA services. The type of service determines where values are collected from.
Master services collect attribute values from StreetTalk databases on servers. The exception are inclusions and their attributes, which are submitted as files to the master service.
An individual master service can collect data from any or all servers on the network. While master services can display resource and attribute information, normally they are used to collect information for downloading to other STDA services.
Satellite services collect values from other STDA services, either satellite or master.
After you specify which attributes you want collected from a service, you can specify which of the collected attributes are displayed. Attributes can be displayed in two modes that correspond to functions available from STDA client applications: lookup and index.
Attributes configured for lookup display appear when users run STDA client programs (using F3 or an equivalent command in a third-party application).
Lookup information provides attribute values for users who access a resource needing a specific piece of information. For example, you can configure STDA to display names and phone numbers when a user displays another user's name. You can configure STDA to collect both names and phone numbers but display only names.
As a rule, the attributes that you display for lookup display are the same as those that you specified for collection.
Attributes configured for index display appear when users use attribute values to search for resources from STDA clients (using F4 or an equivalent command in a third-party application). You specify which attributes are to be indexed. For example, if you do not want users to be able to search on phone numbers to find usernames, do not index the phone number attribute.
Example Finding Resources Using Attribute Indexes
John Carville in the Chicago office of WCTUS wants to find a user in the company's Belgian office, but only knows that he is responsible for gold futures trading in that office.
If the QuickPick attribute collection is included in the AVD used on the network, Carville can press F4 and search on the attribute values in that collection for "Primary Project." If attribute <0:125> is assigned the value "gold futures" for every user who deals in gold and that attribute is specified for index display, Carville sees a list of all users whose primary project is gold futures trading. If this information is still not enough, Carville can specify Location from "Quick Pick" and use both criteria.
Up to five values can be used at the same time in a search. In the absence of an index, users enter values to search instead of selecting from a list.
Some Index Guidelines
Although every network is unique, consider the following guidelines when you index attributes:
Build an index whose values have a one-to-many relationship with StreetTalk resources, such as addresses, membership in specific groups, and primary responsibilities. Avoid indexing attributes that have a one-to-one correspondence with StreetTalk resources, such as phone numbers or social security numbers. If users on your network access attribute information through STDA client applications, consider indexing attributes with more than 10 characters in the value to take advantage of the keysearch, or typedown, feature that progressively searches a list based on keys entered. Like attribute collection, STDA client display of attributes is specified on a service-by-service basis. Menus, formatting rules, and procedures for configuring display are identical for master and satellite services.
You enter collection parameters in StreetTalk Explorer windows or MSERVICE menus to enable an STDA service to collect and display attribute information.
As an administrator, entering the parameters is fairly straightforward after you plan your collection and display setup. In those cases where a close correspondence exists between attributes collected and those displayed, you can also read and write parameter lists to and from files.
You can use parameters to specify which
Attributes are collected and stored. STDA client programs do not have to display all values that an STDA service collects. Attributes are collected and stored for lookup by STDA client programs. Attribute indexes are collected and stored for display by STDA client programs.
Collection and display functions in STDA services share a common set of syntax elements and formatting conventions. You can:
Edit attributes, consistent with formatting and syntax rules. Write attribute lists to files. Replace attribute lists with files.
In many cases, you may use the same or similar attribute lists you construct for collecting, looking up, and indexing. The STDA software lets you read and write attributes collections to and from files. You can make simple modifications to existing lists, adding or subtracting entries depending on your needs. This feature is particularly helpful if you use a consistent set of attribute collections across your network.
STDA services that download from other STDA services or poll StreetTalk services designate which <v:a> indentifiers are to be included in the database constructed by the service according to the class of the identifier.
Collection parameters in the STDA configuration window or screen file are in the form of a list and have the following format:
class: <vendor number:attribute number>
Where class represents the STDA class for which the attribute value is collected.
The following STDA classes can be used to specify attribute collection:
FILES - File volume services
LISTS - List names
NICKS - Nicknames
OTHER - Services other than print queues or file volumes
PRINT - Print services
USERS - User names
ALL - All StreetTalk names in the network
For example, specifying StreetTalk USERS objects means that attribute pairs associated with object names of the class USERS are downloaded or collected by the service and appear in the next rebuild of the service. Specifying ALL means that attributes from every class appear in the next rebuild, and so on.
The range of vendor numbers for attributes and their application are described in Chapter 15.
Note: Memory limits prevent you from entering more than 1 KB of information (1024 characters) in an STDA attribute collection list.
Procedures for Configuring Attribute Displays
You can use StreetTalk Explorer or MSERVICE to configure attribute displays.
From StreetTalk Explorer, after you select an STDA Service and display Properties, you can click the Attribute Collection tab to open the Attribute Collection folder.
From the Attribute Collection folder, you can:
Add Attributes to the attribute collection list Modify attributes already added to the attribute collection list Remove attributes from the attribute collection list Read an attribute collection list from a file Write an attribute collection list to a file
Figure 20-1 shows the Attribute Collection Folder.
Adding Attributes
From StreetTalk Explorer:
To add attributes to the list of attributes to be collected:
1. Display the Attribute Collection page.
2. Select a class of attribute collections from the Class drop-down list.
3. Select an attribute collection in the Collection list box to display the attributes for the collection in the Attributes list box.
4. Click an entry, one at a time from the Attributes list box and click Add.
5. Select the Display or Index checkboxes or both. The attribute <v:a> identifier is displayed in the <v:a> Number text box. Or, type the <v:a> number into the <v:a> Number box.
6. Click Apply.
7. Repeat these steps to designate other attributes to be collected.
8. Click OK when you are done.
Modifying Attributes
To modify attributes already added to the attribute collection list.
From StreetTalk Explorer:
1. Display the Attribute Collection page.
2. Select a class of attribute collections from the Class drop-down list.
3. Selct an attribute entry in the collected attribute list box under the Class drop-down list.
4. Click Modify.
5. Select the Display checkbox ON or OFF to specify whether you want to allow a lookup by STDA client programs.
6. Select the Index checkbox ON or OFF to specify whether you want to index the attribute so it can be retrieved faster.
7. Click Apply or OK.
Removing Attributes
To remove an attribute already added to the list of attributes to be collected:
From StreetTalk Explorer:
1. Display the Attribute Collection page.
2. Select a class of attribute collections from the Class drop-down list.
3. Select an attribute entry in the collected attribute list box under the Class drop-down list.
4. Click Remove.
5. Click Apply or OK.
Reading Attributes from a File
From StreetTalk Explorer:
1. Display the Attribute Collection folder.
2. Configure the attributes for Collection and for display or indexing from the Read Attributes window.
You can also select to not write over existing attributes.
3. Specify the directory and file to read from and click Open.
StreetTalk Explorer reads the file and the attributes display in the window.
Writing Attributes to a File
From StreetTalk Explorer:
1. Display the Attribute Collection page.
2. Select the class of attributes from the Class drop-down list.
3. Click Write to File.
4. Select which attributes you want to write and click OK.
5. Specify a directory and a file name and click Save in the Save As dialog box.
From MSERVICE, separate editing screens exist for each category of attribute management. These screens can be accessed individually through a series of common MSERVICE menus.
Specify in the Define Attribute Collection screen which attributes are available for display by that service. An STDA client program does not have to display all values collected by the service. Specify in the Define Attribute Lookup screen which attributes are collected and stored for lookup by STDA client programs. Attributes collected from this screen are a subset of attributes specified in the Define STDA Attribute Collection screen. Specify in the Define Attribute Indices screen which attributes are indexed by STDA client programs. Attributes collected from this screen are a subset of attributes specified in the Define STDA Attribute Collection screen.
Choices made in one collection menu can inadvertently affect the display of attributes defined from another menu. Therefore, give careful thought to planning the collection and display of attribute values before entering any actual parameters.
To Access the Configure STDA Service Menu
To access the Configure STDA Service menu, follow these steps:
1. Enter MSERVICE at the system prompt. The Manage Services menu appears.
2. From the list of services available, select the STDA master or satellite service you want to configure. You can also use the SEARCH function to search for a service on another server.
3. Select CONTROL the service. The Control A Service menu appears.
4. Select CONFIGURE service. The Configure STDA Service screen appears.
To Access Individual Editing Screens
Use one of the following procedures to access individual editing screens:
Select DEFINE Attribute Collection to access the Define Attribute Collection screen. Select Configure STDA Display -> Configure STDA Display to access the DEFINE attribute lookup screen. Select Configure STDA display -> Configure STDA Display to access the DEFINE Attribute Indices screen.
To Edit a Collection List
1. After you access the appropriate editing screen, enter your collection parameters or edit existing parameters according to the rules established in the preceding section.
When specifying attributes, enter class objects and attribute designators one to a line in the appropriate attribute collection screen with the following format:
class: <vendor number:attribute number>
Be sure that you enter all colons, greater than (>), and less than (<) characters in their proper order.
2. When you finish your edits, press F10 to save your edits.
If your edits contain syntax errors, error messages appear and the cursor appears next to the entry. If you do not enter a ">" before a <v:a> identifier, this error message appears:
Syntax error - attribute should be specified as <#:#>
The cursor is repositioned at the offending line.
3. After you make all the appropriate corrections to the collection parameters, press F10 to save the file.
To Write an Attribute Collection to a File
1. From the Configure STDA Service menu select either:
- DEFINE attribute collection to edit the service's collection
- CONFIGURE STDA display to access the Define Attribute Lookup or Indices menus
2. After you finish editing attributes in the appropriate editing screen, press F2. The Write STDA Attribute Rules to a File screen appears.
3. Enter a file name at the prompt and press ENTER. The program assumes that the file is located in the current directory unless you specify a full pathname. If you do not specify a correct pathname, an error message appears.
To Read or Replace an Attribute Collection from a File
1. From the Configure STDA Service menu, select either:
- DEFINE attribute collection to edit the service's parameter collection list
- CONFIGURE STDA display to access the Define Attribute Lookup or Indices menus
2. Press F4. The Replace STDA Attribute Rules with a File screen appears.
3. Specify the name of the file containing the attribute rules you want applied and press ENTER. The program assumes that the file is located in the current directory unless you specify a full pathname. If you do not specify a correct pathname, an error message appears.
Under normal circumstances, you can effectively manage XSTD displays using various combinations of attribute collection and display parameters. Under some circumstances, however, it may be appropriate to specify which users can connect to an STDA service. You do this by entering a name pattern that limits the users who can access the service. The name pattern that you enter must follow the rules established for StreetTalk templates.
Guidelines for Setting User Patterns
Consider limiting user access to an STDA service in the following circumstances:
Only administrators should be allowed to connect to master services that collect portions of StreetTalk service data. In this way, users do not receive partial views of the network if they pick up one of these masters as their STDA service. Users should not be allowed to connect to STDA services that are coming back on line but have not been fully rebuilt. Again, this prevents users from receiving partial views of the network if they pick up the service as their STDA service. If your network has backup STDA services that duplicate master or satellite services, set the user pattern to your name. In the event a service fails or goes off line, you can simply change the name pattern entered for the backup satellite to the pattern previously entered for the failed service. This restores STDA information to the appropriate users. In situations where sensitive data such as human resources information is maintained, you may want to specify a name pattern that allows access only to persons in the group who need to access the information. Note that restricting users in this way does not guarantee the security of the data maintained in the service.
Formatting Rules for User Patterns
Patterns are always matched against the full three-part name of the user attempting to access the service. You enter user patterns through screens resembling those used to read and write files. The following rules govern setting STDA user patterns for a service:
The pattern's syntax and formatting must follow rules established for StreetTalk names. Use any three-part StreetTalk name or a partial name containing wildcard asterisks (*) or at-signs (@) to set a pattern. For instance, all of the following names are valid patterns: *
Susan*
Susan *@*
*S*@mkt@wctus
Entering patterns that do not correspond to valid StreetTalk user patterns prevents any user, including the administrator, from accessing the service. Enter only one template pattern for a given service. An empty string (or blank line) matches all users in the group. If you want all users to access the service, leave the entry blank. You cannot enter the name of a list.
From StreetTalk Explorer:
1. From the right pane, select an STDA service and display the Users folder.
2. Click in the User pattern text box and the enter the user pattern for those users who can access the service.
3. Click OK. If you set a pattern and find you cannot access the service after you save the change, return to the Users or the Summary folder and check your entry.
From the System Prompt:
1. From the Configure STDA Service menu, select CONFIGURE STDA display. The Configure STDA Display menu appears.
2. Select SET user pattern. The Define STDA User Pattern screen appears.
3. Enter the desired pattern and press F10 to save the pattern. If you set a pattern and find you cannot access the service after you save the change, return to the Define Set User Pattern screen and check your entry.