The Zimbra Connectors supports both Provisioning and Identity.
- The Provisioning functionalities of this connector enable exporting and importing user accounts and distribution lists on a Zimbra system.
- The Identity functionalities of this connector enable you as an Identity administrator to configure Zimbra as a connected system and then make Identity users part of the Zimbra system. This enables the user or Identity administrator to reset Zimbra account passwords. This also enables you to enable/ disable a user account.
Functionalities
Provisioning Integration
Data Format |
Export |
Create |
Modify |
Delete |
Trigger |
User |
Yes |
Yes |
Yes |
Yes |
No |
DistributionList |
Yes |
Yes |
Yes |
Yes |
No |
Identity Integration
Product Feature |
Supported |
Authenticate (test connection) |
Yes |
Validate User |
Yes |
Enable/Disable User |
Yes |
Reset Password |
Yes |
Expire Password immediately |
No |
Expire Password by date |
No |
Prerequisites
Ensure that these prerequisites are satisfied:
- Zimbra Version 7.0 or later is installed, configured, and running.
- An administrator account that can be used to establish a connection and has the appropriate privileges to manage accounts on the connected system.
- If the connector will be managing accounts across multiple domains, the service account must be a global administrator. If the connector will be managing accounts across a single domain, the service account can be either be a domain administrator or a global administrator.
- If you are using a self-signed certificate, the trusted CA certificate of the Zimbra Server must be added to the keystore used by the IdM Suite. Note: If the CA is well known, (i.e., VeriSign, Entrust, etc.), there is no need to perform these steps because the Root CA will already be present in the keystore.
-
Determine which keystore is used by Identity or Provsioning. The keystore path can be found in these locations:
- For Identity - \Fischer\IdM\identity\config\prio.properties
- For Provisioning - \Fischer\Provisioning\dataforum\config\prio.properties
- For a standalone Workflow and Connectivity Studio installation -
\Fischer\Provisioning\designer\config\studio.properties)
This file should contain content similar to this:#Path of the keystore file containing trusted CA certificates
TruststorePath=c\:\\Program Files (x86)\\Java\\jdk1.8.0_11\\jre\\lib\\security\\cacerts
- Get the trusted CA certificate from Zimbra (for example, exported from a browser).
-
Add the trusted CA certificate to the truststore. It can be done using keytool with the command line, for example:
keytool -import -trustcacerts -file <C:\certificate.cer> -keystore <keystore file> -storepass <password>
Where:
<C:\certificate.cer> is the path to the certificate that has been saved from Zimbra.
<keystore file> is the name of the keystore used by Identity, which can be found in the file
\\Fischer\IdM\identity\config\prio.properties.<password> is the password of the keystore (the default password is changeit).
Creating the Connected System in the Admin UI
Log in to Identity Administration and click the Systems tab.
On the Connected System View page, click the Add button and select the Zimbra connected system from the Type drop-down list. The Connected System Details page displays the default values:
-
Enter the desired information:
Definition Supported Connectors
Displays whether the connected system is Identity only, Provisioning only, or both. Password Policy Displays the name of the password policy associated with the connected system.
Type Select the connected system type. Locale
Select the preferred language (default: English). Locale specific information such as Display Name and Description can be added only while modifying the connected system. Name The name for this connected system. Note: The name cannot be modified later. Display Name The display name of the new connected system. Description The description of the connected system. Associated With
Select how the connector associated with this system will run:
- Server (default) - Runs locally on the Provisioning/Identity Server.
- Global Identity Gateway - Runs remotely on a Global Identity Gateway cluster member. Note: Only GIG clusters that have at least one registered and enabled member will display in this list.
- See Using the Global Identity Gateway with Connected Systems for additional information.
Password Reset By Enables administrators to configure password management functions normally available to Users and OBO (On Behalf Of) Users: - OBO User Only - Connected system and account association information is displayed only in Self-Service user management (for OBO Users). OBO Users can reset passwords for accounts on this connected system. Administrators can perform all user management functions for this connected system (e.g., enable/disable, validate, associate user, and password reset). End users will not see their accounts on this connected system in Self-Service and Kiosk; therefore, they cannot reset passwords for accounts on this connected system.
- Users and OBO User - Connected system and account association information is displayed in Self-Service password reset, Self-Service - Kiosk, and Self-Service user management. Self-Service users, Kiosk users, and OBO Users can reset passwords for accounts on this connected system. Administrators can perform all user management functions for this connected system (e.g., enable/disable, validate, associate user, and password reset).
- External - Connected system and account association information is not displayed in Self-Service password reset, Self-Service - Kiosk, and Self-Service user management. Self-Service users, Kiosk users, and OBO Users cannot reset passwords for accounts on this connected system.
Note: When user management configuration enables OBO Users to perform password resets, this definition must be set to OBO User Only or Users and OBO User. For connectors that support Provisioning only, there is no password reset capability.
Provisioning Option Select the provisioning option: - Automated (default) - The connected system functions as a normal connected system; there are no restrictions.
- Administrative - The connected system cannot be used as an object in a workflow.
Enable HPAM Support Select to make the connected system HPAM enabled (default: cleared). Note: This can only be set for systems that support Identity. Connection Information Service URL The URL of the Zimbra Server. To enable SSL protection, use the HTTPS protocol.
Note: This connector uses the Java keystore for SSL communication with the system. See the guide Configuring SSL for additional information about enabling SSL.
Service Account Name The name of the administrative user account used to connect to the server.
Service Account Password The administrative user password.
Password Expiration Support Expiration Options For Admin/OBO User Password Reset Specify the password expiration: None or Immediate. System Owner Adds or removes users assigned as the owners of the system. Displays the Connected System Owner Search page for selecting users. The HPAM column indicates whether the system owner is authorized to use the HPAM feature. The Approvers column indicates whether the system owner is an approver in the approval process.
Add PswdPolicy / Remove PswdPolicy Adds/removes a password policy to/from this connected system. If the connected system is associated with a Connected System Group, the buttons will be unavailable - all password policy assignments are defined at the group level (refer to Admin UI _ Systems _ Groups option).
-
Click the Test Connection button to test the Connection Information:
- If successful, one or both of these messages may display:
Message: Connection from Provisioning to the connected system was established successfully.
Message: Connection from Identity to the connected system was established successfully.- If unsuccessful, one or both of these messages may display:
Error: Failed to establish connection from Provisioning to the connected system.
Error: Failed to establish connection from Identity to the connected system.
Note: If the connection fails, additional messages may display providing more information regarding the failure, and additional information may be posted to the Provisioning and Identity logs. -
(Optional) To select owners of the system, click the System Owner Add button. The Connected System Owner Search page displays:
-
Select the owners and then click the Select button. The system owner displays under the System Owner section:
Note: More than one user can be assigned as an owner.
To add additional system owners, click the Add button.
-
- On the Connected System Details page, click the Add button to save the configured connected system. The Object Category Association page displays a list of categories that are already associated and/or can be selected to add additional associations to this connected system:
Select one or more available object categories or provide search criteria and click the Search button to find specific categories to select. If there are no available categories to select, proceed to Step 7.
Click the Add Association button to associate the selected object categories to the connected system.
Click the Back button to return to the Connected System View page. The new connected system displays in the list.
See Copying, Modifying, and Deleting Connected Systems for additional information.
Creating the Connected System in the Studio
- Log in to the Workflow and Connectivity Studio and click Connectivity ► Add Systems on the menu bar. The Add Connected Systems window displays.
- Select the Zimbra connected system from the Type drop-down list. The default values display.
-
Enter the desired information:
Definition Type Select the connected system type. Locale
Select the preferred language (default: English). Locale specific information such as Display Name and Description can be added only while modifying the connected system. Name The name for this connected system. Note: The name cannot be modified later. Display Name The display name of the new connected system. Description The description of the connected system. Supported Connectors
Displays whether the connected system is Identity only, Provisioning only, or both. Associated With
Select how the connector associated with this system will run:
- Server (default) - Runs locally on the Provisioning/Identity Server.
- Global Identity Gateway - Runs remotely on a Global Identity Gateway cluster member. Note: Only GIG clusters that have at least one registered and enabled member will display in this list.
- See Using the Global Identity Gateway with Connected Systems for additional information.
Password Reset By Enables administrators to configure password management functions normally available to Users and OBO (On Behalf Of) Users: - OBO User Only - Connected system and account association information is displayed only in Self-Service user management (for OBO Users). OBO Users can reset passwords for accounts on this connected system. Administrators can perform all user management functions for this connected system (e.g., enable/disable, validate, associate user, and password reset). End users will not see their accounts on this connected system in Self-Service and Kiosk; therefore, they cannot reset passwords for accounts on this connected system.
- Users and OBO User - Connected system and account association information is displayed in Self-Service password reset, Self-Service - Kiosk, and Self-Service user management. Self-Service users, Kiosk users, and OBO Users can reset passwords for accounts on this connected system. Administrators can perform all user management functions for this connected system (e.g., enable/disable, validate, associate user, and password reset).
- External - Connected system and account association information is not displayed in Self-Service password reset, Self-Service - Kiosk, and Self-Service user management. Self-Service users, Kiosk users, and OBO Users cannot reset passwords for accounts on this connected system.
Note: When user management configuration enables OBO Users to perform password resets, this definition must be set to OBO User Only or Users and OBO User. For connectors that support Provisioning only, there is no password reset capability.
Provisioning Option Select the provisioning option: - Automated (default) - The connected system functions as a normal connected system; there are no restrictions.
- Administrative - The connected system cannot be used as an object in a workflow.
Enable HPAM Support Select to make the connected system HPAM enabled (default: cleared). Note: This can only be set for systems that support Identity. Connection Information Service URL The URL of the Zimbra Server. To enable SSL protection, use the HTTPS protocol.
Note: This connector uses the Java keystore for SSL communication with the system. See the guide Configuring SSL for additional information about enabling SSL.
Service Account Name The name of the administrative user account used to connect to the server.
Service Account Password The administrative user password.
Password Expiration Support Expiration Options For Admin/OBO User Password Reset Specify the password expiration: None or Immediate. - Click the Connect button to test the Connection Information:
- If successful, one or both of these messages may display:
Connection from Studio to the connected system was established successfully.
- If unsuccessful, one or both of these messages may display:
Failed to establish connection from Studio to the connected system.
Note: If the connection fails, additional messages may display providing more information regarding the failure.
-
Click the Apply button to apply changes. The Category Association window displays.
Select one or more object categories from the Available Categories list or enter a category name and click the Search button to find a specific category to select. If there are no available categories to select, proceed to Step 6.
Click the Add button to associate the selected object categories to the connected system.
Click OK to accept selected categories.
See Copying, Modifying, and Deleting Connected Systems for additional information.
Using the Connected System for Identity
Perform these procedures to configure the connector:
- Connector Details for Identity
- Identity Password Management
Connector Details for Identity
This table lists values to enter when associating the Identity user with an existing user in the connected system:
Field |
System Attribute |
Example Value |
Login ID |
accountName |
|
Account ID |
accountName |
Identity Password Management
See User Management for details on password management.
Using the Connected System for Provisioning
Perform these procedures to configure the connector:
- Configuring for Export
- Configuring for Import
- Connector Details for Provisioning
Note: If the number of records to be processed exceeds one thousand, we recommend configuring the workflow to use bulk mode, which lowers the memory consumption of the system by streaming data to files. Because data is streamed for every task, performance of the workflow execution will be decreased due to increased read-write operations. See the Workflow and Connectivity Studio document for details on how to configure bulk mode.
Configuring for Export
Perform these procedures to configure the connector for data export:
- Configuring the Export Connector
- Configuring the Export Link
From the Workflow and Connectivity Studio, select the Zimbra UserExport workflow listed under the projects folder.
If a workflow does not already exist, create an export workflow. See Workflow and Connectivity Studio for details on creating export workflows.
Configuring the Export Connector
- In the Design pane, double-click the export object (the first workflow object after the Start object). The Configure Data Source window displays:
-
From the Configure Plug-in tab, set these properties as required:
Associated Connected System
Select the connected system from the list. The export operation will be done from this connected system. Data Formats Select the type of data format to use: User(default) or DistributionList DeltaExportMode Select the type of attribute to export if a change takes place (this works in conjunction with ExportMode when DeltaExport is selected):
- OnlyChangedAttributes - Performs a partial export of only the changed attributes from the last time the query was run.
- ChangedAndMandatoryAttributes (default) - Performs a partial export of both changed and mandatory attributes from the last time the query was run. Mandatory attributes are exported whether they have been changed or not.
- AllAttributes - Performs a full export of all attributes that contain a value.
DynamicConnectedSystem Select the global variable to use as the dynamic connected system name. This works in conjunction with DynamicCon- nectedSystemOption when GlobalVariable is selected.
DynamicConnectedSystemOption Select how to control Dynamic System Support:
- None - There will not be any Dynamic System Support.
- Transaction-SystemName - The value of the Transaction- SystemName attribute in data will be used as the dynamic connected system. The connected system name must be passed as the value of the attribute Transaction- SystemName; if it is missing in data, the operation will fail.
- GlobalVariable - Select a global variable to use as the dynamic connected system name from the property DynamicConnectedSystem.
ExportMode Select the type of data to export:
- FullExport - Exports all
- DeltaExport - Exports changed, mandatory, or all attributes, depending on the DeltaExportMode property setting.
Filter Specify a filter to return only those entries that match the search criteria. This property is available only for Worker data format. Use the Set Filter button that becomes active to create a filter (see Set Filter below).
ItemsPerPage
Specify a limit to the number of items exported per call (default: 500).
SubscriberReferenceID Specify a limit to the number of items exported per call (default : 500).
UsePaging Select whether to use paging (default: FALSE). Note: Hover the pointer over a property to view its description.
Set Filter
-
Setting the filter is a means to narrow the search scope and return specific results:
Element Description Attribute Select the attribute of the filter. This represents the attribute name for searching the Zimbra directory.
Comparison Select the operator value for this filter. Value Enter the required result value.
AND Condition List Creates an AND statement comparing selected conditions. If there is more than one condition in this list box, all conditions must be true.
OR Condition List Creates an OR statement comparing selected conditions. If there is more than one condition in this list box, one of the conditions must be true.
Filter Syntax Displays the filter syntax used to retrieve entries from the LDAP directory and to build the export list. Edit Filter Manually Check this box to manually edit the filter in the Filter Syntax to build complex filters.
- Using logical AND/OR, generate the complex filter to narrow the search result.
-
Click OK when complete to return to the Configure Data Source
- Using logical AND/OR, generate the complex filter to narrow the search result.
-
(Optional) Select the Attributes tab. Only standard attributes display:
Modify schema attributes using these buttons.
Description Add
Adds additional attributes to the list. The Add New Attribute dialog displays.Export
Exports the schema list to an XML file.Import
Imports the schema list from an XML file.Refresh Schema
Dynamically discovers the schema from the connected system. It also includes local as well as global attributes added in the Studio.Reset Schema
Resets the schema definition to the default schema prepackaged with the IdM Suite, plus any global variable added. - Optional) Select the Appearance tab to change how the Connected System object displays in the Design pane.
-
Click OK to save any changes and return to the Workflow and Connectivity Studio window.
Configuring the Export Link
-
In the Design pane, double-click the export link between the export object (the first workflow object after the Start object) and the Data Mapper object. The Configure Link window displays:
Element Description Source Attributes Select the attributes to export.
Selected Attributes Displays default attributes and those attributes that have been selected from the Source Attributes.
Notes: The check boxes are used only for delta export operations. These checked attributes will always be exported whether they were changed or not. Usually, the attributes that are selected as mandatory attributes help in identifying or verifying an entry when completing mapping functions.
Format Displays the Format Date window to specify a date/time format to be applied to the selected date type attribute, for example, whenChanged. During export, the attribute’s value is converted to the specified format. See the Format Date steps below for additional information.
Notes:
- The Format button is only enabled for date attributes.
- The Refresh Schema button on the Configure Data Source window’s Attributes tab must be used to refresh the schema and enable the Format button for date attributes
Advanced Settings Displays the Configure Attributes window for selecting any attributes that need to be encrypted. - From the Attribute Selection tab, select attributes to export.
- (Optional) Click the Format button to specify a date/time format to be applied to the selected date type attribute. The Format Date window displays.
- Select the Include Time check box to add the timestamp with the date.
- Select the 24 Hour or 12 Hour option button and then select the required date/time format.
- Click OK to save the selected format. The Configure Link window displays.
- Click OK to save any changes and return to the Workflow and Connectivity Studio window.
- Deploy the workflow by selecting Deploy ► New Deployment. See the Workflow and Connectivity Studio documentation for details of deployment options.
- Manage and run the deployed workflow from the Admin UI ► Server tab. See the Identity Suite Administration documentation for details.
Configuring for Import
Perform these procedures to configure the connector for data import:
- Configuring the Import Connector
- Configuring the Import Link
From the Workflow and Connectivity Studio, select the Zimbra UserAdd, UserModify, or UserDelete workflow listed under the projects folder.
If a workflow does not already exist, create an import workflow. See the Workflow and Connectivity Studio documentation for details on creating import workflows.
Configuring the Import Connector
- In the Design pane, double-click the import object (the last workflow object). The Configure Data Source window displays:
-
From the Configure Plug-in tab, set these properties as required:
Element Description Associated Connected System Select the connected system from the list. The import operation will be done to this connected system. Data Formats Select the type of data format to use: Worker. DynamicConnectedSystem Select the global variable to use as the dynamic connected system name. This works in conjunction with DynamicConnectedSystemOption when GlobalVariable is selected. DynamicConnectedSystemOption Select how to control Dynamic System Support (DSS): - None - There will not be any Dynamic System Support.
- Transaction-SystemName - The value of the Transaction-SystemName attribute in data will be used as the dynamic connected system. The connected system name must be passed as the value of the attribute Transaction-SystemName; if it is missing in data, the operation will fail.
- GlobalVariable - Select a global variable to use as the dynamic connected system name from the property DynamicConnectedSystem.
See the Dynamic System Support appendix in the Workflow and Connectivity Studio document for additional information.
Id * Enter the attribute that contains the value used to uniquely identify the user account user ID on the connected system (ACCOUNT_ID column of the FISC_USER_ACCOUNT table).
loginId * Enter the attribute that contains the value used to uniquely identify the user account login ID (uniqueId) on the connected system (ACCOUNT_USERNAME column of the FISC_USER_ACCOUNT table). Notes:
* Id and loginId are used by the Provisioning Policy and IdentityHub features to populate the ACCOUNT_ID and ACCOUNT_USERNAME columns of the FISC_USER_ACCOUNT table of the Product database. See the ‘Provisioning Policy’ and ‘Provisioning Using the IdentityHub’ chapters of the Identity Suite Administration Guide for details.
Hover the pointer over a property to view its description.
(Optional) Select the Attributes tab. Only standard attributes display:
Modify schema attributes with the buttons.- (Optional) Select the Appearance tab to change how the Connected System object displays in the Design pane.
-
Click OK to save any changes and return to the Workflow and Connectivity Studio window.
Configuring the Import Link
-
In the Design pane, double-click the import link between the Data Mapper object and the import object (the last workflow object). The Configure Link window displays:
Element Description Source Attributes Select the attributes to import.
Check for attribute-level auditing If auditing is enabled and these attributes below are checked, Provisioning will log all events for auditing purposes.
Selected Attributes Displays default attributes and those attributes that have been selected from the Source Attributes. Check the box of any attribute required for attribute-level auditing.
Format Displays the Format Date window to specify a date/time format to be applied to the selected date type attribute, for example, BirthDate. During import, the attribute's value is converted to the specified format.
Notes: The Format button is only enabled for date attributes.
Advanced Settings Displays the Configure Attributes window for selecting any attributes that need to be encrypted. Audit Key Select the attribute to associate with the Audit Key. From the Attribute Selection tab, select attributes to import.
(Optional) Select the Appearance tab to change how the link displays in the Design pane.
- Click OK to save any changes and return to the Workflow and Connectivity Studio window.
Deploy the workflow by selecting Deploy ► New Deployment. See the Workflow and Connectivity Studio for details of deployment options.
Manage and run the deployed workflow from the Admin UI ► Server tab. See the Identity Suite Administration documentation for details.
Connector Details for Provisioning
Configuration import properties accountDN, Id, and loginId are used by the Provisioning Policy and IdentityHub features to populate the ACCOUNT_DN, ACCOUNT_ID, and ACCOUNT_USERNAME columns of the FISC_USER_ACCOUNT table of the Product database. See the ‘Provisioning Policy’ and ‘Provisioning Using the IdentityHub’ chapters of the Identity Suite Administration Guide for details.
This table shows the default attributes specified for these properties for the connected system:
Import Property |
System Attribute |
Id |
accountName |
loginId |
accountName |
Connector Attributes
The items in the Export, Create, Modify, and Delete columns have these meanings:
- Y = Yes (attribute is supported for this operation)
- N = No (attribute is not supported for this operation)
- Highlighted cells show differences in operations
User Data Format
Name |
Description |
Multi-valued |
Create |
Modify |
Delete |
Mandatory |
ZimbraAccountStatus |
Account status (active, maintenance, locked, closed, lockout, pending). |
N |
Y |
Y |
N |
N |
ZimbraId |
Zimbra account identifier. |
N |
N |
N |
N |
N |
accountName |
Name of the account to log in to Zimbra. |
N |
Y |
Y |
N |
Y |
Original_accountName * |
Original Account Name for rename operations. |
N |
N |
Y |
N |
Y |
city |
Locality which this object resides in. |
N |
Y |
Y |
Y |
N |
company |
Companies. |
N |
Y |
Y |
Y |
N |
country |
Friendly country name. |
N |
Y |
Y |
Y |
N |
description |
Descriptive information. |
N |
Y |
Y |
Y |
N |
displayName |
Preferred name to be used when displaying entries. |
N |
Y |
Y |
Y |
N |
facsimileTelephoneNumber |
Facsimile (Fax) Telephone Number. |
N |
Y |
Y |
Y |
N |
firstName |
First name(s) for which the entity is known by. |
N |
Y |
Y |
Y |
N |
homePhone |
Home telephone number. |
N |
Y |
Y |
Y |
N |
initials |
Initials of some or all of names, but not the surname(s). |
N |
Y |
Y |
Y |
N |
lastName |
Last (family) name(s) for which the entity is known by. |
N |
Y |
Y |
Y |
N |
mobile |
Mobile telephone number. |
N |
Y |
Y |
Y |
N |
oldAccountName |
Renames accountName. When modifying accountName, oldAccountName must contain the name of the account to modify. accountName will contain the new name given to the account. |
N |
N |
Y |
N |
N |
pager |
Pager telephone number. |
N |
Y |
Y |
Y |
N |
physicalDeliveryOfficeName |
Physical delivery office name. |
N |
Y |
Y |
Y |
N |
postalAddress |
Postal address. |
N |
Y |
Y |
Y |
N |
postalCode |
Postal code. |
N |
Y |
Y |
Y |
N |
postOfficeBox |
Post office box. |
N |
Y |
Y |
Y |
N |
state |
State or province which this object resides in. |
N |
Y |
Y |
Y |
N |
street |
Street address of this object. |
N |
Y |
Y |
Y |
N |
streetAddress |
Street address of this object. |
N |
Y |
Y |
Y |
N |
telephoneNumber |
Telephone Number. |
N |
Y |
Y |
Y |
N |
title |
Title associated with the entity. |
N |
Y |
Y |
Y |
N |
userPassword |
Password of user. Stored encoded as SSHA (salted-SHA1). |
N |
Y |
Y |
N |
N |
ZimbraACE |
Zimbra access control list. |
Y |
Y |
Y |
Y |
N |
ZimbraCOSName |
COS ZimbraID. |
N |
Y |
Y |
Y |
N |
ZimbraIsAdminAccount |
Set to true for admin accounts. |
N |
Y |
Y |
Y |
N |
ZimbraMailAddress |
E-mail address of this recipient for accepting mail. |
Y |
Y |
N |
N |
N |
ZimbraMailingList |
List of the mailing lists the user subscribed to. |
Y |
Y |
Y |
Y |
N |
ZimbraMailAlias |
List of the aliases associated to the user. |
Y |
Y |
Y |
Y |
N |
* The rename operation requires an additional attribute Original_accountName, which specifies the uniqueid of the entry being renamed.
Distribution List Data Format
Name |
Description |
Multi-valued |
Create |
Modify |
Delete |
Export |
Mandatory |
ZimbraId |
Zimbra id. |
N |
N |
N |
N |
Y |
N |
distributionListDisplayName |
RFC2798: preferred name to be used when displaying entries. |
N |
Y |
Y |
Y |
Y |
N |
distributionListName |
Distribution list name. |
N |
Y |
Y |
N |
Y |
Y |
Original_distributionListName * |
Original distributionListName. To be used when renaming a distribution list. |
N |
N |
Y |
N |
N |
N |
description |
Description. |
N |
Y |
Y |
Y |
Y |
N |
ZimbraMailStatus |
mail delivery status (enabled/ disabled). |
N |
Y |
Y |
N |
Y |
N |
ZimbraNotes |
Administrative notes. |
N |
Y |
Y |
Y |
Y |
N |
sendShareMessageToNewMe mbers |
Whether to send an e-mail with all the shares of the group when a new member is added to the group. If not set, default is to send the e- mail. |
N |
Y |
Y |
N |
Y |
N |
ZimbraIsAdminGroup |
Set to true for admin groups. |
N |
Y |
Y |
N |
Y |
N |
ZimbraLocale |
Locale of entry (e.g., en_US). |
N |
Y |
Y |
Y |
N |
N |
users |
Users that are enrolled in the distribution list. |
Y |
Y |
Y |
Y |
Y |
N |
distributionListAlias |
Aliases of the distribution list. |
Y |
Y |
Y |
Y |
Y |
N |
* The rename operation requires an additional attribute Original_distributionListName, which specifies the uniqueid of the entry being renamed.
Lookup Data
To find existing users and return specific attribute values for users, use the Data Mapper rule Lookup Data.
- Log in to the Workflow and Connectivity Studio and double-click the Data Mapper object on the Design pane. The Configure Data Mapper window displays.
- Select the Lookup Data rule under the Mapping Rule column, and then click the Source Value. The Configure Lookup window displays.
-
Select the Zimbra system from the Select System drop-down list:
- In the Enter Lookup Prefix field, enter the prefix to be added to the Lookup fields.
- Select the Lookup Type from the drop-down list.
-
Click the FieldsPick button to select the attributes to be fetched after a successful lookup. The Lookup Configuration window displays:
Select the attribute(s) from the Selected Attributes list that require a date and/or time format, and click the Format button. The Format Date window displays.
Select the Include Time check box to use a date and time format. Select the required date/time format for your target database (shown above), and then click OK.
- Click the Filter Build button, and then from the Set Filter window, generate the search filter, for example:
See Set Filter for a description of this window.
Click OK. The updated Configure Lookup window displays, for example:
Select the Exit as Mapper Task Failed on Lookup Failure check box to exit the task with Failed status on lookup failure. It will not process the succeeding entries and will ignore the already processed entries and will not return any data. This is selected by default.
Click OK.