Apache Directory Studio

+ + Apache Directory Studio + Schema Editor User's Guide + Version 1.0.0 + + 2007 + Apache Software Foundation + + + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + + + + + + Getting started + + This part of the guide provides you a sum up of the basic concepts of the Schema Editor Plugin. + + + +

+ Download and installation + + Beside the integration in Apache Directory Studio the Apache Directory Studio Schema Editor can also be installed + as a plug-in into a regular Eclipse installation. This section describes this + alternative. + + + Using the Eclipse Install/Update Manager is the easiest way to + install the Apache Directory Studio Schemas Editor plug-in. + From workbench menu choose + + + Help + Software Updates + Find and Install... + + + . + + + In the opened wizard choose + Search for new features to install + and click Next. + + + + + + + + + + Next please specify the Apache Directory Studio update site. Click the New Remote Site... button. + In the dialog input the following and press OK: + + Name: Apache Directory Studio Update Site + URL: http://directory.apache.org/studio/update/1.x + + + + + + + + + + + Make sure the new update site is checked an press + Finish. + + + + + + + + + + Now the install manager checks the update site and presents the search results. Select the + feature you want to install - of course the Apache Directory Studio Schema Editor - and click + Next. + + + + + + + + + + Accept the license agreement, the Apache Directory Studio Schemas Editor is distributed under the + Apache License, Version 2.0. + + + + + + + + + + In the next dialog ensure that the Apache Directory Studio Schema Editor feature is selected and + click to Finish. + + + + + + + + + + Now the install manager loads the necessary files. When download is finished + you have to verify the installation, please click to + Install. + + + + + + + + + + After installation it is recommended to restart the Eclipse workbench. + +

+ + +

+ Views + + +

+ Hierarchy view + The Hierarchy view shows the hierarchy of an element (attribute type or object class). + Here is what the Hierarchy view looks like: + + + + + + + + + Toolbar + The toolbar of the Hierarchy view contains the following actions: + + + + + - + Show the Supertype Hierarchy: Shows the supertype hierarchy. + + + + + - + Show the Subtype Hierarchy: Shows the subtype hierarchy. + + + + + - + Link with Editor: Links the view with the editor. + + + + Menu + The menu of the Hierarchy view contains the following actions: + + + + + - + Show the Supertype Hierarchy: Shows the supertype hierarchy. + + + + + - + Show the Subtype Hierarchy: Shows the subtype hierarchy. + + + + + - + Link with Editor: Links the view with the editor. + + + Preferences: Displays the preferences dialog for the Hierarchy view. + + + + Icons + The following icons can appear in the Hierarchy view: + + + + + + + + Icon + Description + + + + + + + + + + + + Attribute type (operational) + + + + + + + + + + Attribute type (user) + + + + + + + + + + Object class (abstract) + + + + + + + + + + Object class (auxiliary) + + + + + + + + + + Object class (structural) + + + + + +

+ + +

+ Problems view + The Problems view displays errors and warnings associated with a resource. + Here is what the Problems view looks like: + + + + + + + + + Icons + The following icons can appear in the Problems view: + + + + + + + + Icon + Description + + + + + + + + + + + + Error + + + + + + + + + + Warning + + + + + +

+ + +

+ Projects view + The Projects view shows all the Schema projects of the workspace. + Here is what the Projects view looks like: + + + + + + + + + Toolbar + The toolbar of the Projects view contains the following actions: + + + + + - + New Schema Project: Opens the New Schema Project wizard. + + + + Icons + The following icons can appear in the Projects view: + + + + + + + + Icon + Description + + + + + + + + + + + + Closed project + + + + + + + + + + Open project + + + + + +

+ + +

+ Schema view + This Schema view shows all the schemas of the currently opened project. + Here is what the Schema view looks like: + + + + + + + + + Toolbar + The toolbar of the Schema view contains the following actions: + + + + + - + New Schema: Opens the New Schema wizard. + + + + + - + New Attribute Type: Opens the New Attribute Type wizard. + + + + + - + New Object Class: Opens the Object Class wizard. + + + + + - + Collapse All: Collapse all the node of the tree. + + + + + - + Link with Editor: Links the view with the editor. + + + + Menu + The menu of the Schema view contains the following actions: + + + + + - + Sorting...: Opens the Sorting dialog for this view. + + + + + - + Link with Editor: Links the view with the editor. + + + Preferences: Opens the Preferences dialog for this view. + + + + Icons + The following icons can appear in the Schema view: + + + + + + + + Icon + Description + + + + + + + + + + + + Attribute type (operational) + + + + + + + + + + Attribute type (user) + + + + + + + + + + Object class (abstract) + + + + + + + + + + Object class (auxiliary) + + + + + + + + + + Object class (structural) + + + + + + + + + + Indicates an error on the resource + + + + + + + + + + Indicates a warning on the resource + + + + + +

+ + +

+ Search view + The Search view displays the results of a search. + Here is what the Search view looks like: + + + + + + + + + Toolbar + The toolbar of the Search view contains the following actions: + + + + + - + Show Search Field: Shows the search field in the Search view. + + + + + - + Run the Current Search Again: Runs the current search again. + + + + + - + Search History: This command allows you to browse previously conducted searches and repeat a previous search. You can select a previous search from the drop-down menu or clear the search history. + + + + Menu + The menu of the Search view contains the following actions: + + + + + - + Sorting...: Opens the Sorting dialog for this view. + + + Preferences: Opens the Preferences dialog for this view. + + + + Icons + The following icons can appear in the Search view: + + + + + + + + Icon + Description + + + + + + + + + + + + Attribute type (operational) + + + + + + + + + + Attribute type (user) + + + + + + + + + + Object class (abstract) + + + + + + + + + + Object class (auxiliary) + + + + + + + + + + Object class (structural) + + + + + +

+ +

+ + +

+ Editors + + +

+ Attribute type editor + The attribute type editor is the one-stop shop where you can define all aspects of your attribute type. + + + + + + + + + + The Overview page is where the user can edit the properties of the attribute type. + User can edit: + + + the name + the OID + the description + the superior type + the usage + the syntax and syntax length + if the attribute type is obsolete + if the attribute type is single-value + if the attribute type is collective + if the attribute type is no-user-modification + all the matching rules (equality, ordering, substring) + + + + + + + + + + + + The Source code page is where the user can see the result of his actions in the Overview page and what source code will be generated in the schema file. + + + + + + + + + + The Used By page is where the user can see in which object class(es) is used this attribute type (as mandatory or optional attribute type). +

+ + +

+ Object class editor + The object class editor is the one-stop shop where you can define all aspects of your object class. + + + + + + + + + + The Overview page is where the user can edit the properties of the object class. + User can edit: + + + the name + the OID + the description + the superior class + the class type + if the object class is obsolete + the mandatory attributes (add and remove) + the optional attributes (add and remove) + + + + + + + + + + + + The Source code page is where the user can see the result of his actions in the Overview page and what source code will be generated in the schema file. +

+ + +

+ Schema editor + The schema editor displays all the attribute types and the object classes that contains a schema file. + + + + + + + + + + The Overview page is where the user can see all the attribute types and object classes of the schema. + + + + + + + + + + The Source Code page is where the user can see all the attribute types and object classes of the schema in their OpenLDAP code representation. +

+ +

+ + + + + + Tasks + + +

+ Creating a new project + To create a new project, in the Projects view toolbar, click on the + + + + New Schema Project button. + + + The creation of a new Schema Project is a two-step process: + + + Define the name of the project. + + + Select the 'core' schema files to import. + + + + + Page 1 + + The first page allows you to enter a project name. + + + + + + + + + + + + + + + + + + + Option + Description + Default + + + + + Name + + The name of the project. In the + Projects view the project is + listed with this name. The name must be + unique. + + empty + + + + + + + + Page 2 + + The second page allows you to select the 'core' schema files to import. + + + + + + + + + + + + Check the 'core' schema files you want to import. + + +

+ + +

+ Importing projects + To import schema projects choose one of the following options: + + In the Projects view, choose Import > + + + + Schema Projects from the context menu. + In the Workbench menu bar select File > Import... and choose + + + + Schema Projects + + + The following wizard appears: + + + + + + + + + + Select the directory from which import the schema project files and then check each schema project file you want to import. +

+ + +

+ Exporting projects + To export schema projects choose one of the following options: + + In the Projects view, choose Export > + + + + Schema Projects from the context menu. + In the Workbench menu bar select File > Export... and choose + + + + Schema Projects + + + The following wizard appears: + + + + + + + + + + Check each schema project you want to export and then select the directory where to export these schema project files. +

+ + +

+ Creating a new schema + To create a new schema, in the Schema view toolbar, click on the + + + + New Schema button (a project must be opened). + + The following wizard appears: + + + + + + + + + + Give a name to the schema. + + + + + + + + + Option + Description + Default + + + + + Name + + The name of the schema. In the + Schema view the project is + listed with this name. The name must be + unique. + + empty + + + + + +

+ + +

+ Importing schemas + + +

+ Importing schemas from XML files + To import schemas from XML files choose one of the following options: + + In the Schema view, choose Import > + + + + Schemas from XML file(s) from the context menu. + In the Workbench menu bar select File > Import... and choose + + + + Schemas from XML file(s) + + + The following wizard appears: + + + + + + + + + + Select the directory from which import the schema files and then check each schema file you want to import. +

+ + +

+ Importing schemas from OpenLDAP files + To import schemas from OpenLDAP files choose one of the following options: + + In the Schema view, choose Import > + + + + Schemas from OpenLDAP file(s) from the context menu. + In the Workbench menu bar select File > Import... and choose + + + + Schemas from OpenLDAP file(s) + + + The following wizard appears: + + + + + + + + + + Select the directory from which import the schema files and then check each schema file you want to import. +

+ +

+ + +

+ Exporting schemas + + +

+ Exporting schemas as XML files + To export schemas as XML files, choose one of the following options: + + In the Schema view, choose Export > + + + + Schemas as XML file(s) from the context menu. + In the Workbench menu bar select File > Export... and choose + + + + Schemas as XML file(s) + + + The following wizard appears: + + + + + + + + + + Check each schema you want to export and then select the directory where to export each schema as a separate file or a single destination file. +

+ + +

+ Exporting schemas as OpenLDAP files + To export schemas as OpenLDAP files, choose one of the following options: + + In the Schema view, choose Export > + + + + Schemas as OpenLDAP file(s) from the context menu. + In the Workbench menu bar select File > Export... and choose + + + + Schemas as OpenLDAP file(s) + + + The following wizard appears: + + + + + + + + + + Check each schema you want to export and then select the directory where to export each schema as a separate file. +

+ + +

+ Exporting schemas for Apache DS + To export schemas for Apache DS, choose one of the following options: + + In the Schema view, choose Export > + + + + Schemas for Apache DS from the context menu. + In the Workbench menu bar select File > Export... and choose + + + + Schemas for Apache DS + + + The following wizard appears: + + + + + + + + + + Check each schema you want to export and then select the directory where to export each schema as a separate file or a single destination file. +

+ +

+ + +

+ Creating a new attribute type + To create a new attribute type, choose one of the following options: + + In the Schema view, choose New > + + + + New Attribute Type from the context menu. + In the Schema view, click the + + + + New Attribute Type button in the toolbar. + In the Workbench menu bar select File > New... and choose + + + + New Attribute Type + + + + The creation of a new attribute type is a three-step process: + + + Select the schema in which insert the new attribute type and specify its naming and description information (OID, aliases and description) + + + Specify the attribute type content such as superior and usage, as well as syntax and properties + + + Specify the equality, ordering and/or substring matching rules + + + + + Page 1 + + The first page allows you to select the schema in which insert the new attribute type and specify its naming and description information (OID, aliases and description). + + + + + + + + + + + + + + + + + + + Option + Description + Default + + + + + Schema + + The schema in which insert the new attribute type. + + empty + + + OID + + The OID of the new attribute type. The OID must be + unique. + + empty + + + Aliases + + The aliases (or names) of the new attribute type. Each alias (or name) must be + unique. + + empty + + + Description + + The description of the new attribute type. + + empty + + + + + + + + Page 2 + + The second page allows you to specify the attribute type content such as superior and usage, as well as syntax and properties. + + + + + + + + + + + + + + + + + + + Option + Description + Default + + + + + Superior + + The superior attribute type of the new attribute type. + + empty + + + Usage + + The usage of the new attribute type. + + User Applications + + + Syntax + + The syntax of the new attribute type. + + (None) + + + Syntax Length + + The syntax length of the new attribute type. + + 0 + + + Obsolete + + Indicates the new attribute type is obsolete. + + Not checked + + + Single Value + + Indicates the new attribute type is single value. + + Not checked + + + Collective + + Indicates the new attribute type is collective. + + Not checked + + + No User Modification + + Indicates the new attribute type is no user modification. + + Not checked + + + + + + + + Page 3 + + The third page allows you to specify the equality, ordering and/or substring matching rules. + + + + + + + + + + + + + + + + + + + Option + Description + Default + + + + + Equality + + The equality matching rule of the new attribute type. + + (None) + + + Ordering + + The ordering matching rule of the new attribute type. + + (None) + + + Substring + + The substring matching rule of the new attribute type. + + (None) + + + + + + +

+ + +

+ Creating a new object class + To create a new attribute type, choose one of the following options: + + In the Schema view, choose New > + + + + New Object Class from the context menu. + In the Schema view, click the + + + + New Object Class button in the toolbar. + In the Workbench menu bar select File > New... and choose + + + + New Object Class + + + + The creation of a new object class is a four-step process: + + + Select the schema in which insert the new object class and specify its naming and description information (OID, aliases and description) + + + Specify the object class content such as superiors, class type and properties + + + Specify the mandatory attribute types of the new object class + + + Specify the optional attribute types of the new object class + + + + + Page 1 + + The first page allows you to select the schema in which insert the new object class and specify its naming and description information (OID, aliases and description). + + + + + + + + + + + + + + + + + + + Option + Description + Default + + + + + Schema + + The schema in which insert the new object class. + + empty + + + OID + + The OID of the new object class. The OID must be + unique. + + empty + + + Aliases + + The aliases (or names) of the new object class. Each alias (or name) must be + unique. + + empty + + + Description + + The description of the new object class. + + empty + + + + + + + + Page 2 + + The second page allows you to specify the object class content such as superiors, class type and properties. + + + + + + + + + + + + + + + + + + + Option + Description + Default + + + + + Superiors + + The superiors object classes of the new object class. + + empty + + + Class Type + + The class type of the new object class. + + Structural + + + Obsolete + + Indicates the new object class is obsolete. + + Not checked + + + + + + + + Page 3 [... 306 lines stripped ...]