[checked revision]

Revision as of 15:08, 21 January 2015

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:

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. when `sstIsCompany: TRUE`). Or in case of a person (`sstIsCompany: FALSE`), the organisation name would be set to: Surname, Name (The content of the attributes `surname` and `givenName`).
description	MAY				The description of the leaf.
sstIsCompany	MUST	x			Is the entry a company? Either `TRUE` (yes) or `FALSE` (no).
sstIsActive	MUST	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. In this case, the attribute `uid` and `sstBelongsToResellerUID` must match with each other!

Legend:

x: Mandatory in all cases.

Mail Reseller Logout-Redirection

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

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 configuration.

The following table describes the different attributes:

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

Legend:

x: Mandatory in all cases.

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/

The following table describes the different attributes:

Attribute	Existence	Mandatory	Self-Service	Changeable	Description
ou	MUST	x			This leaf (ou: Organizational Unit), contains the logout-redirect related configuration for a specific fully qualified domain name (fqdn). For example: groupware.stoney-cloud.org.
description	MAY				The description of the leaf.
sstWebsiteURL	MUST	x			The URI the user is redirected to, after they log out from the groupware application. For example: http://www.stoney-cloud.org/ or https://www.stoney-cloud.org/.

Legend:

x: Mandatory in all cases.

@@ Line 167: / Line 167: @@
 === Mail Reseller Logout-Redirection ===
-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 configuration:
   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.
+  description: The sub tree for the reseller logout-redirect specific stoney mail service configuration.
 The following table describes the different attributes:
@@ Line 185: / Line 185: @@
 | style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 | style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
-| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| This reseller leaf (ou: Organizational Unit), collects the stoney mail service reseller related configuration.
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| This logout-redirect leaf (ou: Organizational Unit), collects the stoney mail service reseller logout-redirect related configuration.
 |-
@@ Line 206: / Line 206: @@
   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/
+The following table describes the different attributes:
+{| style="border-spacing:0;"
+| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| '''Attribute'''
+| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>'''Existence'''</center>
+| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>'''Mandatory'''</center>
+| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>'''Self-Service'''</center>
+| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>'''Changeable'''</center>
+| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''
+|-
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| ou
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| This leaf (ou: Organizational Unit), contains the logout-redirect related configuration for a specific fully qualified domain name (fqdn). For example: groupware.stoney-cloud.org.
+|-
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| description
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The description of the leaf.
+|-
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstWebsiteURL
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
+| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The URI the user is redirected to, after they log out from the groupware application. For example: http://www.stoney-cloud.org/ or https://www.stoney-cloud.org/.
+|}
+Legend:
+* '''x''': Mandatory in all cases.
 [[Category:stoney mail]][[Category:OpenLDAP directory]]

Difference between revisions of "stoney mail: OpenLDAP directory data organisation"

Revision as of 15:08, 21 January 2015

Contents

Abstract

Data Organisation

Mail

Mail Configuration

Mail Reseller

Mail Reseller Logout-Redirection

Navigation menu

Personal tools

Namespaces

Variants

Views

Actions

Search

Navigation

Wiki

Tools