Managing Attributes

Document created by user.oxriBaJeN4 Employee on Sep 14, 2015Last modified by user.oxriBaJeN4 Employee on Nov 6, 2018
Version 11Show Document
  • View in full screen mode

Attributes can be used to define a specific property or characteristic of a user email. When attributes are created they are applied to both internal and external email domain users. Examples of attributes include names, titles, email addresses, and telephone numbers. Attributes can be used, for example, to populate a business card component in a stationery layout, allowing administrators to select which user attributes are assigned to the email signature.

It's 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.

Managing Attributes

 

Attributes can be managed in two ways:

  1. Manually as local attributes in Mimecast. This must be managed in Mimecast directly, but you can use the spreadsheet import utility to create and populate the attribute data. Manual attributes offer the administrator more control and are useful when adding 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's the most efficient way of supplying attribute data to Mimecast, as the directory is a centrally managed data source.
When an attribute is created, the field is immediately visible in all domain user profiles but won't be populated. This requires a Directory Synchronization to be performed. 

Add AttributeAdding an Attribute

 

To add an attribute:

  1. Log on to the Administration Console.
  2. Click on the Administration toolbar button. A drop down menu displays.
  3. Click on the Directory | Attributes menu item. A list of the current attributes displays.
  4. Click on the Add Attribute button. The Attribute Details dialog displays.
  5. Complete the dialog as follows:
    Field NameDescription
    Name (Prompt)Enter the reference name that Mimecast will use to retrieve the attribute data. 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 more information.
    Group

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

    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 drop down 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 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 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).
    Directory 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. When configuring LDAP attributes, it's mandatory that the Prompt field (see above) is 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 read the Directory Synchronization page.
    OrderThis determines the order the attribute values are displayed in the Group field (see above). If no order is entered, the attributes are listed in alphabetical order.
    OptionsThis determines the values displayed in the Simple Selection and Complex Selection fields (see above).
  6. Click on the Save button. The new attribute displays.
    The Group column indicates whether the attribute is manually created or synchronized with a directory, shown as either "Manual Attributes" or "General Attributes" respectively.

Editing an Attribute

Edit Attribute

 

To edit an attribute:

  1. Log on to the Administration Console.
  2. Select the Administration toolbar button. A drop down menu displays. 
  3. Click on the Directory | Attributes menu item. A list of the current attributes displays.
  4. Select the Attribute to be changed. The Attribute Details panel displays.
  5. Click on the Edit button. 
  6. Change the Attribute fields as required.
  7. Click on the Save button.

 

Edit AttributeAlternatively, you can:

  1. Click on the Menu Icon icon to the right of the attribute to be edited.
  2. Select the Edit Attribute menu item. The Attribute Details dialog displays.
  3. Change the settings as required.
  4. Click on the Save button.

 

Deleting an Attribute

 

To delete an attribute:

  1. Log on to the Administration Console.
  2. Click on the Administration toolbar button. A drop down menu displays.
  3. Click on the Directory | Attributes menu item. A list of current attributes displays.
  4. Select the Attribute to be deleted. The Attribute Details panel displays.
  5. Click on the Delete button. A popup box displays.
  6. Click on the Delete button to confirm.

 

Alternatively, you can:

  1. Click on the Menu Icon icon to the right of the attribute to be removed.
  2. Select the Delete Attribute menu Item. A popup box displays.
  3. Click on the Delete button to confirm.

 

Disabling an Attribute

The Status column indicates whether the attribute is currently enabled or disabled.

Enable Disable AttributeTo disable an attribute:

  1. Log on to the Administration Console.
  2. Click on the Administration toolbar button. A drop down menu displays.
  3. Click on the Directory | Attributes menu item. A list of current attributes displays.
  4. Click on the Menu Icon icon to the right of the required attribute.
  5. Select the Disable Attribute menu item.

 

Enabling an Attribute


Enable AttributeTo enable an attribute:

  1. Log on to the Administration Console.
  2. Click on the Administration toolbar button. A drop down menu displays.
  3. Click on the Directory | Attributes menu item. A list of current attributes displays.
  4. Click on the disabled Attribute. The Attribute Details panel displays.
  5. Click on the Edit button.
  6. Select a new value from the Type drop down menu.
  7. Click on the Save button.

 

See Also...

 

1 person found this helpful

Attachments

    Outcomes