ADDDIRE (Add Directory Entry)

ADDDIRE Command syntax diagram

 

Purpose

The Add Directory Entry (ADDDIRE) command is used to add new entries to the system distribution directory. The directory contains the user's user identifier (ID), profile name, system name, system address, mailing address, telephone numbers, and other user information. The ADDDIRE command provides a parameter for each of the fields contained in the directory.

The ADDDIRE command does not provide interactive display support. This is provided by the Work with Directory Entries (WRKDIRE) command.

An X.400 originator/recipient (O/R) name can be added to the directory with this command. X.400 is an international standard for communications and the O/R name is the addressing information used in X.400 communications. The X.400 O/R name must be in character set 1169 and code page 500. This set includes A through Z, 0 through 9, and some special characters. Additional information on characters allowed is in the Globalization topic in the Information Center.

 

Notes

1. To prevent the system from changing lowercase characters to uppercase, enclose the values in apostrophes. This does not apply to user ID/address, system name/group, department, or X.400 O/R name.
   
2. Only the user ID/address, system name/group, department, and X.400 O/R name are translated from the graphic character identifier (GCID) specified by the CMDCHRID parameter. All other parameters are stored exactly as they are entered and the GCID is stored with them. The default GCID value is taken from the QCHRID system value. The user can override the defaults by specifying a character set and code page or by specifying *DEVD for the display device description.
   
3. Double-byte character set (DBCS) characters can be entered for the following system directory entry parameters:

   USRD       LOCATION
   LSTNAM     BLDG
   FSTNAM     OFC
   MIDNAM     ADDR1
   PREFNAM    ADDR2
   FULNAM     ADDR3
   DEPT       ADDR4
   TITLE      TEXT
   CMPNY      USRDFNFLD
   

Restriction: The user of this command must have security administrator (*SECADM) authority.

 

Required Parameters

USRID

Specifies the user ID and address of the user for whom the directory entry is made. Both elements must be specified. If lowercase characters are specified, the system translates and stores them as uppercase characters. Further information about specifying the user ID and address is in the SNA Distribution Services

Element 1: User ID

*ANY: Any user ID at the address specified on Element 2 of this parameter is used. Only one *ANY is allowed for each address. This value is used to resolve a distribution that does not match a specific user ID but matches an address.

user-ID: Specify the user ID for this directory entry. Up to 8 characters can be specified. If this value is specified, an address must be specified for Element 2.

Element 2: User Address

*ANY: Any address for the user ID specified on Element 1 is used. One USRID(*ANY *ANY) entry is allowed in the directory. This value is used to resolve distributions that do not match any other directory entries.

user-address: Specify the address for this directory entry. Up to 8 characters can be specified.

USRD

Specifies the description associated with the user ID and address. For example, the description can contain the user's full name, department number, or position. Specify up to 50 characters for the description.

USER

Specifies the user profile of the user being added to the directory. If the user being added is a local user, a valid profile must exist on the local system.

A user profile is required to define a local user whose mail is sent to the remote system specified in the system name/group.

*NONE: The user being added to the directory is a remote user and has no local profile. If *NONE is specified and the SYSNAME parameter indicates the local system, an error message is returned.

user-profile-name: Specify a valid system user profile name up to 10 characters in length. The user profile name is required for all local users. If a profile name is specified for a user whose mail is sent to a remote system, the profile name must be valid on the local system.

 

Optional Parameters

SYSNAME

Specifies the one- or two-part name of the system on which the user works. If a two-part system name is specified on the command line, up to 8 characters make up both the system name and the system group name. The parts should be separated by at least one space.

A remote user can be added to the directory before the system name and system group are defined in the network tables, but distributions cannot be sent to that user until the remote system name and system group are defined. The remote system name and system group name are defined by using the Configure Distribution Services (CFGDSTSRV) command. Additional information on defining a remote system name and group name is in the SNA Distribution Services

*LCL: The system name is its local name. All local users being added to the directory should have *LCL specified as the system name.

*PC: This system name is for distributed systems node executive (DSNX) users with a personal computer (PC) attached to the system.

*ERROR: This value is used when the user's network contains a central system that receives all unresolved distributions. In this type of network, distribution looping may be encountered when a distribution cannot find a specific user ID on the intended system and the intended system has an *ANY *ANY entry directing distributions to the central system. The central system also has a default *ANY address entry directing unresolved distributions to the intended system. To prevent distribution looping, specify *ERROR as the system name for the default entry being added. When a distribution cannot find a specific user ID, but matches this default entry, the distribution is handled as a user that is not valid, just as if no directory match were found.

*ERROR is valid only when USRID(*ANY address) or USRID(*ANY *ANY) is specified.

Element 1: System Name

system-name: Specify the name of the system on which the user works.

Element 2: System Group Name

group: Specify the system group name of the system on which the user works.

LSTNAM

Specifies the user's last name. If no names are provided (last, first, middle, preferred, or full), but a value is specified on the DEPT parameter, the last name will default to an asterisk (*). This is because the directory department function requires a non-blank full name when a department value is specified.

*NONE: No last name is specified.

last-name: Specify up to 40 characters for the user's last name.

FSTNAM

Specifies the user's first name.

*NONE: No first name is specified.

first-name: Specify up to 20 characters for the user's first name.

MIDNAM

Specifies the user's middle name.

*NONE: No middle name is specified.

middle-name: Specify up to 20 characters for the user's middle name.

PREFNAM

Specifies the user's preferred name. For example, "Jonathan" likes to be called "Jon".

*NONE: No preferred name is specified.

preferred-name: Specify up to 20 characters for the user's preferred name.

FULNAM

Specifies the user's full name. Directory entries are shown in the full name format when using the search and department functions. It is recommended that the user institute a consistent naming convention for the full name. Note that uppercase and lowercase alphabetic characters have different sorting sequences. Making the first character of each name uppercase and the rest that follow lowercase is the preferred format.

If FULNAM(*DFT) is specified, the following format is used to create the full name:

LAST NAME, FIRST NAME  MIDDLE NAME (PREFERRED NAME)

The preferred name is always enclosed in parentheses. If no values are specified for the last, first, and middle names, but the DEPT parameter contains a value, the last name defaults to an asterisk (*). If the user specifies FULNAM(*DFT), the full name defaults to an asterisk because it is built from the last name.

*DFT: The full name is created from the user-defined values specified on the LSTNAM, FSTNAM, MIDNAM, and PREFNAM parameters.

full-name: Specify up to 50 characters for the user's full name.

DEPT

Specifies the name of the department of which the user is a member.

*NONE: The user is not defined as a member of a department.

department-name: Specify up to 10 characters for the name of the user's department.

TITLE

Specifies the user's job title.

*NONE: No job title is added.

job-title: Specify up to 40 characters for the user's job title.

CMPNY

Specifies the name of the user's company.

*NONE: No company name is added.

company-name: Specify up to 50 characters for the name of the user's company.

TELNBR1

Specifies the primary telephone number of the user. The telephone number can be specified in any arrangement appropriate for the user, including an international telephone number.

*NONE: No primary telephone number is specified.

telephone-number-1: Specify up to 26 characters for the primary telephone number of the user.

TELNBR2

Specifies a second telephone number for the user. The telephone number can be specified in any arrangement appropriate for the user, including an international telephone number.

*NONE: No second telephone number is specified.

telephone-number-2: Specify up to 26 characters for the second telephone number of the user.

FAXTELNBR

Specifies a facsimile telephone number for the user. The facsimile telephone number can be specified in any arrangement appropriate for the user, including an international telephone number.

*NONE: No facsimile telephone number is specified.

facsimile-telephone-number: Specify up to 32 characters for the user facsimile telephone number.

LOC

Specifies the location of the user. For example, the location can specify a building and floor, a department, or a remote site.

*NONE: No location is specified.

location: Specify up to 40 characters for the location of the user.

BLDG

Specifies the name of the building in which the user works.

*NONE: No building name is added.

building-name: Specify up to 20 characters for the name of the building in which the user works.

OFC

Specifies the name of the office in which the user works.

*NONE: No office name is added.

office-name: Specify up to 16 characters for the name of the office in which the user works.

ADDR1-ADDR4

These four parameters specify the mailing address of the user. Up to 40 characters of data can be specified in each of these fields.

*NONE: No address lines are specified.

address-line-1-4: Specify the user's mailing address in any arrangement, up to 40 characters per line.

INDUSR

Specifies whether the user being added to the directory is an indirect user. An indirect user is a local user who does not sign on the system to receive mail but receives printed mail. An indirect user is a local user and must have a profile on the local system.

*NO: The user is not an indirect user.

*YES: The user is an indirect user.

PRTPERS

Specifies whether private mail for an indirect user is printed. Consideration should be given to restricting public access to the printer when private mail is printed.

*NO: No private mail is printed for this indirect user.

*YES: Private mail is printed for this indirect user.

PRTCOVER

Specifies whether a cover page is printed when the user's mail is printed.

*YES: The cover page is printed.

*NO: The cover page is not printed.

NFYMAIL

Specifies whether the user is notified of the arrival of mail.

*SPECIFIC: The user is notified of the arrival of specific types of mail. The types of mail are specified on the NFYPTYPERS parameter and the NFYMSGS parameter.

*ALLMAIL: The user is notified of the arrival of all types of mail.

*NOMAIL: The user is not notified of the arrival of mail.

NFYPTYPERS

Specifies whether the user is notified of the arrival of priority, private, and important mail.

Note:

This parameter is valid only if NFYMAIL(*SPECIFIC) is specified.

*YES: The user is notified of the arrival of priority, private, and important mail.

*NO: The user is not notified of the arrival of priority, private, and important mail.

NFYMSGS

Specifies whether the user is notified of the arrival of messages.

*YES: The user is notified of the arrival of messages.

*NO: The user is not notified of the arrival of messages.

NETUSRID

Specifies the unique network user ID for this directory entry. This ID is used during directory shadowing to uniquely identify a user in a network.

*USRID: Set the network user ID to the user ID and address associated with this directory entry.

network-user-ID: Specify the network user ID for the user. A maximum of 47 characters can be specified.

TEXT

Specifies any additional information to describe the directory entry. More information is in Commonly used parameters.

*NONE: No text is specified.

'description': Specify up to 50 characters of text to describe additional information about the user.

CMDCHRID

Specifies the character identifier (graphic character set and code page) for data being specified as parameter values on this command. This character identifier (CHRID) is related to the display device used to specify the command. More information about CHRID processing is in the Application Display Programming

book.

*SYSVAL: The system determines the graphic character set and code page values for the command parameters from the QCHRID system values.

*DEVD: The system determines the graphic character set and code page values for the command parameters from the display device description where this command is entered. This option is supported only when the command is entered from an interactive job. If this option is specified in a batch job, an error message is returned.

Element 1: Character Set

graphic-character-set: Specify the character set used to create the command parameters. Valid values range from 1 through 9999 characters.

Element 2: Code Page

code-page: Specify the code page. Valid values range from 1 through 9999.

COUNTRY

Specifies the country or region code part of the X.400 O/R name.

*NONE: No country or region code is specified.

country-code: Specify an ISO 3166 Alpha-2 code or a CCITT country or region code. More information on this parameter is in Commonly used parameters.

ADMD

Specifies the administrative management domain part of the X.400 O/R name.

*NONE: No administrative management domain is specified.

administrative-management-domain: Specify a 1- to 16-character administrative management domain name. An administrative management domain is a public organization that handles a management domain. A management domain is a set of message transfer agents and user agents that comprise a system capable of handling messages.

PRMD

Specifies the private management domain part of the X.400 O/R name.

*NONE: No private management domain is specified.

private-management-domain: Specify a 1- to 16-character description of the private management domain. A private management domain is a private company or a non-commercial organization that handles a management domain. A management domain is a set of message transfer agents and user agents that comprise a system capable of handling messages.

SURNAM

Specifies the X.400 last name part of the personal name within the X.400 O/R name.

*NONE: No surname is specified.

*LSTNAM: The last name of the user specified in the directory entry is used as the surname.

surname: Specify up to 40 characters for the surname.

GIVENNAM

Specifies the X.400 user first name part of the personal name within the X.400 O/R name.

*NONE: No given name is specified.

*FSTNAM: The user first name specified in the directory entry is used as the given name. It is truncated to 16 characters.

given-name: Specify up to 16 characters for the given name.

INITIALS

Specifies the initials part of the personal name within the X.400 O/R name. For example, the initials for John Henry Smith are JH.

*NONE: No initials are specified.

initials: Specify up to 5 characters for the initials.

GENQUAL

Specifies the generation qualifier part of the personal name within the X.400 O/R name.

*NONE: No generation qualifier is specified.

generation-qualifier: Specify up to 3 characters for the generation qualifier.

ORG

Specifies the organization part of the X.400 O/R name.

*NONE: No organization name is specified.

'organization': Specify an organization name of up to 64 characters.

ORGUNIT

Specifies the organization-defined unit part of the X.400 O/R name.

*NONE: No organizational unit is specified.

'organizational-unit': Specify up to 32 characters for the name of an organizational unit. Up to 4 organizational units can be listed in order of descending significance.

DMNDFNATR

Specifies the type and value of a domain-defined attribute not specified by X.400 standards but allowed in the X.400 O/R name to accommodate existing message handling systems. Up to 4 sets of attributes can be specified.

Element 1: Domain-Defined Attribute Type

*NONE: No domain-defined attribute type is specified.

'attribute-type': Specify up to 8 characters for the description of the domain-defined attribute type.

Element 2: Domain-Defined Attribute Value

*NONE: No domain-defined attribute value is specified.

'value': Specify up to 128 characters for the description of the domain-defined attribute value.

MSFSRVLVL

Specifies the mail server framework service level for a local user. This value is ignored for a remote user. It indicates where mail is stored on the system.

*USRIDX: The mail is stored in a user index. OfficeVision* mail users should specify this option.

*SYSMS: The mail is stored on the system supported message store. The system message store can be accessed by Ultimedia Mail/400, or by industry standard mail APIs that are used on the client. Ultimedia Mail/400 users should specify this option.

*DOMINO: The mail is stored in the Lotus Domino mail database.

Element 1: Mail service level field-name

field-name: Specify the field name of another mail service for this user, if one is used. Specify up to 10 characters for the field name. This value should contain a user-defined field in the system directory that has been defined by the Change System Directory Attributes (CHGSYSDIRA) command in the USRDFNFLD parameter with a field type of *MSFSRVLVL. The user-defined field specified here should then contain information needed by the mail server framework user exit program when the program is determining where to store the mail. The address resolution exit point name is QIBM_QZMFMSF_ADR_RSL. See the AnyMail/400 Mail Server Framework Support book for more information. This field could just be used as an indicator and the value does not have to be a user-defined field. Whenever possible, the value specified here should be a user-defined field.

Element 2: Mail service level product-ID

*NONE: No user-defined field product ID is specified.

Product-ID: Specify up to 7 characters for the user-defined field product ID.

PREFADR

Specifies the preferred address for a user. This tells the mail server framework what fields to use in the system distribution directory for the preferred address of a user. Specify *USERID for OfficeVision and SNADS. SNADS handles all the mail that goes to a user index including the gateway for X.400 O/R names and Simple Mail Transfer Protocol (SMTP) names.

*USRID: The user ID/address is the preferred address for this user.

*ORNAME: The X.400 O/R name is the preferred address for this user.

*SMTP: The SMTP name is the preferred address for this user.

Element 1: Preferred address field-name

field-name: Specify up to 10 characters for the field name. This value should contain an IBM-defined or a user-defined field in the system directory that has been defined by the Change System Directory Attributes (CHGSYSDIRA) command in the USRDFNFLD parameter with a field type of *ADDRESS. The field specified here should then contain information needed by the mail server framework user exit program when the program is determining what address to use when sending the mail. This field could just be used as an indicator and the value does not have to be an IBM-defined or user-defined field. Whenever possible, the value specified here should be an IBM-defined or a user-defined field.

Element 2: Preferred address product-ID

*NONE: No user-defined field product ID is specified.

*IBM: The field name is an IBM-defined field in the system distribution directory. Allowed IBM-defined field names are:

• USER (user profile)
  
• CCMAILADR (cc*Mail** address)
  
• FULNAM (full name)
  
• NETUSRID (network user ID)
  
• TELNBR1 (telephone number 1)
  
• TELNBR2 (telephone number 2)
  
• FAXTELNBR (facsimile telephone number)

Product-ID: Specify up to 7 characters for the user-defined field product ID.

Element 3: Preferred address address-type

address-type: Specify up to 8 characters for the address type. The address type is a mail server framework type name that is specified on the Add Mail Framework Type Configuration (QzmfAddMailCfg) API. Whenever possible, this value should be one of the mail server framework configuration type names. When an address type is specified for a preferred address that is a special value, specify *N for the product ID.

CCMAILADR

Specifies the cc*Mail** address for this user.

*NONE: No cc*Mail** address is specified.

'cc*Mail-address': Specify the cc*Mail** address. The address field has a maximum of 126 characters. If the address includes both a remote post office name and an alias name, the limit is 126 characters for each, with a space separating them (total 253 characters). If the remote post office name contains spaces, the name must be enclosed in quotation marks. This adds two characters to the limit for a total of 128 characters or 255 characters with the alias name.

CCMAILCMT

Specifies the cc*Mail** comment for this user.

*NONE: No cc*Mail** comment is specified.

'cc*Mail-comment': Specify up to 126 characters for the cc*Mail** comment field.

USRDFNFLD

Specifies the user-defined field names and values. A list of these user-defined field names can be displayed using CHGSYSDIRA and prompting with the F4 key. Up to 100 user-defined fields can be specified.

Note:

The following SMTP user-defined fields are not always displayed when the CHGSYSDIRA command is prompted, but they can still be used in the user-defined field (USRDFNFLD) parameter to add SMTP information to the system distribution directory. SMTPAUSRID SMTP SMTPDMN SMTP SMTPRTE SMTP

*NONE: No user-defined fields are specified.

Element 1: User-Defined Field Name

field-name: Specify up to 10 characters for the user-defined field name.

Element 2: User-Defined Field Product ID

*NONE: No user-defined field product ID is specified.

product-ID: Specify up to 7 characters for the user-defined field product ID.

Element 3: User-Defined Field Value

'value': Specify up to 512 characters for the value of the user-defined field value. Blanks are padded on the right.

ALWSYNC

Specifies whether synchronization of this entry with other directories should be allowed.

*YES: Synchronization is allowed.

*NO: Synchronization is not allowed.

DLOOWN

Specifies if the user profile or the group profile will be assigned the ownership of the document library objects (DLOs) for this directory entry.

*USRPRF: The user profile associated with this directory entry is the owner of the newly created Document Library Objects (DLOs).

*GRPPRF: The group profile specified in the user profile associated with this directory entry is made the owner of newly created DLOs and has all authority to the DLOs. If the group profile value is *NONE in the user profile, then the owner of the DLO is the user profile.

Examples for ADDDIRE

Example 1: Adding a Local User

ADDDIRE   USRID(HURST PAYROLL)
  USRD('Manager of Payroll')
  USER(ABHURST)
  LSTNAM(Hurst)
  FSTNAM(Arthur)
  PREFNAM(Art)
  DEPT(55K)
  ADDR1('Dept55K/025-3')
  ADDR2('IBM Rochester')
  ADDR3('Highway 52 North')
  ADDR4('Rochester, MN 55904')
  LOC('Main Office')
  BLDG(025-3)
  OFC(E219)
  TELNBR1('435-422-2120')
  TELNBR2('435-422-1012')
  FAXTELNBR('435-422-3296')
  DLOOWN(*GRPPRF)

This command adds a local user to the distribution directory by allowing the system name parameter to default to *LCL. Since this is a local user, the user profile is specified. Address lines, location, and telephone numbers have been specified. Since the TEXT parameter is not used, it defaults to *NONE. This user is not an indirect user since the INDUSR parameter defaulted to *NO.

The user's last, first, and preferred names are specified. The full name was not specified, so FULNAM(*DFT) is used and will be created as, 'Hurst, Arthur (Art)'. This user has been added as a member of the department named 55K. If this department is searched, then 'Hurst, Arthur (Art)' will be included on the search list.

Any newly created DLOs associated with this directory entry, HURST PAYROLL, will be owned by the group profile specified in the Group Profile field in user profile ABHURST. The user entry is added to the directory if each one of the following is true:

1. A user ID and address HURST PAYROLL is not already in the directory.
   
2. The user profile name ABHURST is not already in the directory.

Example 2: Adding a Remote User

ADDDIRE   USERID(BYRD NEWYORK)
  USRD('Arthur J. Byrd')
  USER(*NONE) SYSNAME(BOCA)
  LOC('Boca Raton, Florida')
  DEPT(61Q)

This command adds a remote user entry to the distribution directory. Since this is a remote user, the USER(*NONE) parameter is specified. The system name without the system group is specified. Except for the location, all of the parameters use default values. If the user-ID and address are unique, the user entry is added to the directory as a remote user.

If you are using directory shadowing, you do not need to add remote users as these users can be shadowed to your system.

If a department value is specified for this user, but no user name is specified, the last name is set to '*'. The full name is also '*' because it is created from the last name. This is done because the directory requires a non-blank name with department.

Additional Considerations

Multiple descriptions can be associated with a given user ID and address. For example, HURST DEPT48K can have an entry with the description Arthur B. Hurst and an entry with the description Manager of Dept. 48K. The ADDDIRE command does not support adding another description to a user-ID. The Work with Directory Entries (WRKDIRE) is used for adding multiple descriptions for a user.

For local users, there is a one-to-one correspondence between the user ID and address and the user profile. Only one user ID and address can be associated with a user profile name, and only one user profile name can be associated with a user ID and address. If a user profile name is specified on the ADDDIRE command that is already associated with an existing user ID and address in the directory, an error message is returned.

This should not cause a problem for remote users since the user profile name is not specified. However, if the profile is specified, it is verified to determine that the profile name is not already in the directory. If the profile is in the directory, an error message is returned.

Error messages for ADDDIRE

*ESCAPE Messages

CPF8360

Not enough storage for commitment control operation.

CPF89A3

Operation not successful due to authority reasons.

CPF89A4

Operation not successful due to data validation reasons.

CPF8AA1

Library QUSRSYS not completely installed.

CPF90A8

*SECADM special authority required to do requested operation.

CPF9009

System requires file &1 in &2 be journaled.

CPF9024

System cannot get correct record to finish operation.

CPF905C

Error occurred trying to find a translation table.

CPF9082

User ID and address &1 &2 not added to directory.

CPF9096

Cannot use CMDCHRID(*DEVD), DOCCHRID(*DEVD) in batch job.

CPF9810

Library &1 not found.

CPF9838

User profile storage limit exceeded.

CPF9845

Error occurred while opening file &1.

CPF9846

Error while processing file &1 in library &2.