Skip to main content

Zarafa Connector

Introduction

Description

Zarafa Connector could manage a Zarafa mail server.

Managed System

This connector is specific for integration with a  Zarafa mail server.

For more information about the Zarafa, please visit the following page: Zarafa

For more information to check if your system may be synchronized with this connector you do not hesitate to contact us through our Contact form

Prerequisites

A Soffid Synchronization Server must be installed on the Zarafa server.

Download and Install

This addon is located in the Connectors section and its name is Zarafa Connector.

For more information about the installation process you can visit the Addons Getting started page.

Agent Configuration

Basic

Generic parameters

After the installation of the addon, you may create and configure agent instances.

To configure this Zarafa Connector you could select "Zimbra Agent" or the "Customizable Zimbra Agent" in the attribute "Type" of the generic parameters section in the agents page configuration.

The difference between both agents is that "Customizable Zimbra Agent" allows "Attribute mapping" and to include "Account metadata".

For more information about how you may configure the generic parameters of the agent, see the following link: Agents configuration

Custom parameters

Below there are the specific parameters for this agent implementation:

Parameter

Description

Zimbra admin tool (zmprov)

Zarafa command line tool (this uses to be zarafa-admin)

Zimbra mailbox tool (zmmailxbox)

Existing role in Soffid to be mapped with the Zarafa administrator role. Every user who has this role granted will be created in Zarafa with the administrator flag on

Create alias profile

Values [ true , false ].

Fullname expresssion (only for Zimbra Agent)

Delete accounts (only for Customizable Zimbra Agent)

Values [ true , false ]. If "true" it allows to delete account in Zarafa when the account is deleted in Soffid.

Attribute mapping

This connector could manage Users, Groups and Roles.

Users

  • Every task is done using zarafa-admin tool. So its behavior depends on zarafa server availability.
  • Zarafa needs every user to have a email address. If a user has no email or shortname, it's name will be used as mail address.
  • Soffid passwords expiration date will be managed by Soffid. So, Linux won't be notified about when those passwords needs to be expired.

Groups

  • Groups will be created and removed as zarafa groups.
  • Currently, the group hierarchy is not registered into Zarafa.

Roles

  • Roles bound to this system will be created as zarafa groups.
  • Any removed role will trigger the bound zarafa group to be removed.

The "Attribute Mapping" tab is only accessible for the "Customizable Zimbra Agent".

Properties

No properties are defined in for this agent.

Attributes

You can map user, groups and role objects. These are some of the attributes to be mapped in those objects:

System attribute

Description

zimbraAccountStatus

accountDisabled ? "closed": "active"

givenName

firstName

displayName

fullName

sn

lastName

zimbraAccount

accountName

For more information about how you may configure attribute mapping, see the following link: Soffid Attribute Mapping Reference

For instance:

Zafara Connector - example.png

Triggers

&&TODO&&Pending to be documented.

Load triggers

&&TODO&&Pending to be documented.

Account metadata

&&TODO&&Pending to be documented.

Accounts are default objects in Soffid. Agents allow you to create additional custom data, on the "Account metadata" tab, to customize the accounts created only for that agent.

The attributes which you define here, will be shown when you click on the proper account, on the Accounts Tabs at user page.

At this tab you could add or delete custom attributes. You can visit the Metadata page for more information about the standard attributes.

Operational

Monitoring

After the agent configuration you could check in the monitoring page if the service is running in the Synchronization Server, please go to:

  • Start Menu > Administration > Monitoring and reporting > Syscserver monitoring

Tasks

Authoritative

If you are checked "Authorized identity source", an automatic task to load identities from the managed system to Soffid is available, please go to:

  • Start Menu > Administration > Monitoring and reporting > Scheduled tasks

And you will something like "Import authoritative data from <AGENT_NAME>".

Reconcile

If your are configured the "Attribute Mapping" tab with some of our objects: "user, account, role, group or grant", an automatic task to synchronize these objects from the managed system to Soffid is available, please go to:

  • Start Menu > Administration > Monitoring and reporting > Scheduled tasks

And you will something like "Reconcile all accounts from <AGENT_NAME>".

Synchronization

About the synchronization of the objects, there are two possible options:

  • If you are checked the generic attribute "Read Only" in the "Basics" tab, only the changes in the managed systems will be updated in Soffid. We recommend this options until the global configuration of Soffid will be tested.
  • If you are not checked the generic attribute "Read Only" in the "Basics" tab, all the changes in Soffid or the managed system will be updated in the other. Note that this synchronization must be configured in the "Attribute mapping" tab correctly.

For more information about how you may configure the generic parameters of the agent, see the following link: Agents configuration


Back to top