Managing Attributes

Document created by user.oxriBaJeN4 Employee on Sep 14, 2015Last modified by user.Yo2IBgvWqr on Jul 13, 2017
Version 10Show Document
  • View in full screen mode

 

Attributes can be managed in two ways:

  1. Manually as local attributes in Mimecast. Manual attributes must be managed in Mimecast directly, but you can use the spreadsheet import utility to create them there and populate their data. Manual Attributes are useful to add a customized property field to a user email address (e.g. Market Vertical, Promotion Code or Gender).
  2. Synchronized from a network directory using LDAP (e.g. Microsoft Active Directory). Data synchronized using LDAP cannot be edited in Mimecast. However it is the most efficient way of supplying attribute data to Mimecast, as the directory is a centrally managed data source.
It is not necessary to add an attribute for the property of a user's email address. This is automatically collected by Mimecast for every user, and stored as a variable.

Adding an Attribute

 

To add an attribute:

  1. Log in to the Administration Console.
  2. Click on the Administration toolbar button. A menu drop down is displayed.
  3. Click on the Directory | Attributes menu item. A list of the current attributes is displayed.
  4. Click the Add Attribute button. The Add Attributes dialog is displayed.
  5. Complete the dialog as follows:

    Field NameDescription
    Description

    This is the attribute description. For a manual attribute, enter a name that best describes the attribute you are creating. For LDAP directory linked attributes, enter the defined attribute name in the directory (e.g. Microsoft Active Directory). See the Directory Linked Attribute field below for further details.

    PromptThis is a unique reference that Mimecast uses to retrieve the attribute data (see the Directory Linked Attribute field below).
    Prompt Group

    Specifies a title for grouped attributes. For example, two attributes belonging to a Prompt Group called Contact Information can be grouped together in the email user profile (see the Prompt Order field below).

    Prompt Type

    This defines both the type and appearance of the attribute field. The following options are available:

    OptionDescription
    Small Text Capture (50 Pixels)A text string, with a maximum length of 50 pixels.
    Small Text Capture (100 Pixels)A text string, with a maximum length of 100 pixels.

    Text Capture

    (150 Pixels)

    A text string, with a maximum length of 150 pixels.

    Text Capture

    (200 Pixels)

    A text string, with a maximum length of 200 pixels.
    Large Text Capture (250 Pixels)A text string, with a maximum length of 250 pixels.
    Large Text Capture (300 Pixels)A text string, with a maximum length of 300 pixels.
    Yes/No CheckboxA dropdown field, containing options for "Yes" and "No".
    Simple Selection

    A list of values allowing one to be selected.

    The list values are defined in the Prompt Options field (see below) with each value separated by a comma (e.g. Red,White,Blue).
    Complex Selection

    A list of values, but allowing multiple values to be selected. This option also allows you to store one value, but display another (e.g. store values 1,2,3, but display Red,White,Blue). This enables the displayed value to be changed, without altering the stored value.

    The list values are defined in the Prompt Options field (see below) with each value defined by the value, a full stop, and the display value (e.g. 1.Red,2.White,3.Blue).
    LDAP Linked Attribute

    This creates a directory linked attribute which synchronizes the data from the directory to Mimecast. It is not possible to edit the data value of this attribute in Mimecast, as it is extracted from the Directory.

    A directory connection must be configured to periodically synchronize attribute data prior to using this option. If a directory attribute is configured, but the attribute does not match the prompt used in the directory, the attribute data will not synchronize. When configuring LDAP attributes, it is mandatory that the Description and Prompt fields (see above) are identical to the prompt of the directory attribute. For example, Microsoft Active Directory uses the 'cn' prompt to display the Common Name of the user, and 'facsimiletelephonenumber' for the Fax Number of the user. For more information on directory connections, read the Directory Synchronization page.
    Prompt OrderThis determines the order the attribute values are displayed in the Prompt Group field (see above). If no Prompt Order is entered, the attributes are listed in alphabetical order.
    Prompt OptionsThis determines the values displayed in the Simple Selection and Complex Selection fields (see above).
  6. Click the Save and Exit button. The field is immediately visible in all domain user profiles, but will not be populated yet. This requires a Directory Synchronizaion to be performed. An icon on the right of the listing identifies whether it is a manual or LDAP attribute.

 

attribute_types.png

 

Changing an Attribute

 

To change an attribute:

  1. Log in to the Administration Console.
  2. Click on the Administration toolbar button. A menu drop down is displayed.
  3. Click on the Directory | Attributes menu item. A list of the current attributes is displayed.
  4. Select the Attribute to be changed.
  5. Click the Edit Attribute button.
  6. Change the attribute as required.
  7. Click the Save and Exit button.

 

Deleting an Attribute

 

To delete an attribute:

  1. Log in to the Administration Console.
  2. Click on the Administration toolbar button. A menu drop down is displayed.
  3. Click on the Directory | Attributes menu item. A list of the current attributes is displayed.
  4. Right click on the Attribute to be deleted.
  5. Click the Delete this Attribute menu item.

 

See Also...

 

Attachments

    Outcomes