stoney mail: OpenLDAP directory data organisation

From stoney cloud
Revision as of 13:20, 21 January 2015 by Michael (Talk | contribs)


Jump to: navigation, search

Abstract

This document describes the OpenLDAP directory data organisation for the stoney mail service, including groupware functionality based on Open-Xchange.

Data Organisation

The following chapters explain the data organisation of the stoney cloud OpenLDAP directory, in this case we looking at the stoney mail service.

Mail

The following LDIF shows the mail entry of the whole OpenLDAP directory tree for the stoney cloud: 

dn: ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: organizationalUnit
objectclass: top
ou: mail

Mail Configuration

The sub tree for the configuration of the stoney mail service: 

dn: ou=configuration,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: configuration
description: The sub tree for the configuration of the stoney mail service.

The following table describes the different attributes:

Attribute
Existence
Mandatory
 Description
ou
MUST
x
 This configuration leaf (ou: Organizational Unit), collects the stoney mail service related configuration.
description
MAY
x
 The description of this leaf.

Legend:

  • x: Mandatory in all cases.

Mail Reseller

The sub tree for the reseller specific stoney mail service configuration: 

dn: ou=reseller,ou=configuration,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: reseller
description: The sub tree for the reseller specific stoney mail service configuration.

The following table describes the different attributes:

Attribute
Existence
Mandatory
 Description
ou
MUST
x
 This reseller leaf (ou: Organizational Unit), collects the stoney mail service reseller related configuration.
description
MAY
x
 The description of this leaf.

Legend:

  • x: Mandatory in all cases.

The sub tree for the specific stoney mail service settings for the reseller Reseller Ltd. with the uid 4000000. 

dn: uid=4000000,ou=reseller,ou=configuration,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstReseller
objectclass: sstServiceConfigurationObjectClass
uid: 4000000
o: Reseller Ltd.
description: The sub tree for the specific stoney mail service settings for the reseller Reseller Ltd. with the uid 4000000.
sstIsActive: TRUE
sstIsDefault: TRUE
sstBelongsToResellerUID: 4000000

The following table describes the different attributes: The following table describes the different attributes:

Attribute
Existence
Mandatory
Self-Service
Changeable
 Description
uid
MUST
x
A unique integer value with 7 digits or more. For example: 4000000.
organizationName
MAY
x
The organisation name of the reseller. For example: Reseller Ltd. (sstIsCompany: TRUE), in case of a person Surname, givenName (sstIsCompany: FALSE) or in case of a brand a freely choosable string like Super Dooper Web Hosting (sstIsCompany: FALSE).
description
MAY
The description of the leaf.
sstIsCompany
MUST
x
Is the entry a company? Either true (yes) or false (no).
sstIsActive
MAY
x
Is the entry active? Either true (yes) or false (no).
sstExternalID
MAY
The ID (or number) of a customer, person or product in an external database (for example: 234567).
sstIsDefault
MAY
Contains the leaf a default entry? Either TRUE (yes) or FALSE (no). If sstIsDefault is set to TRUE, this entry acts as a fall back configuration. In other words: If a reseller doesn't have his own (online) backup service configuration, then this on will be used.
sstBelongsToResellerUID
MUST
x
Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000000.

Legend:

  • x: Mandatory in all cases.

Mail Reseller Logout-Redirection

The sub tree for the reseller logout-redirect specific stoney mail service settings: 

dn: ou=logout-redirect, ou=reseller,ou=configuration,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: logout-redirect
description: The sub tree for the reseller logout-redirect specific stoney mail service settings.

The sub tree for the reseller logout-redirect specific stoney mail service settings, coming from the fully qualified domain name (fqdn) groupware.stoney-cloud.org. 

dn: ou=groupware.stoney-cloud.org,ou=logout-redirect, ou=reseller,ou=configuration,ou=mail,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstLogoutRedirect
ou: groupware.stoney-cloud.org
description: The sub tree for the reseller logout-redirect specific stoney mail service settings, coming from the fully qualified domain name (fqdn) groupware.stoney-cloud.org.
sstWebsiteURL: http://www.stoney-cloud.org/
Retrieved from "https://wiki.stoney-cloud.org/mediawiki/index.php?title=stoney_mail:_OpenLDAP_directory_data_organisation&oldid=4504"