User's manual

1. Presentation
2. Directory users
   1. User creation
   2. Back-office user search
   3. Directory publication
   4. Directory search
3. Organization chart
   1. Entity creation
   2. Back-office entity search
   3. Entity types
   4. Organization chart
      1. Virtual tree
      2. Entity organization chart" service

Presentation

plugin Directories lets you create one or more directories of people, possibly synchronized with an external data source (LDAP, Active Directory, SQL database) or with a population of users Ametys.

It can also be used to create an organizational chart of entities (divisions, departments, etc.).

Directory users

User creation

Directory users are synchronized with an external source (LDAP, database) and are automatically created or synchronized when the external source is synchronized, depending on its configuration.
See the administrator manual for configuring and synchronizing directory users.

You can also create a user from the back office, by clicking on "New user" in the Directory tab.
Please note, however, that it will not be possible to synchronize the user with an external source.

If you have several types of user content, select the type of content you wish to create

Back-office user search

Click on "Search users" in the Directory tab to open the search tool.

The tool allows you to search for all "User" type content.

Directory publication

To publish a directory on your site, select a page in the site page and click on "Directory root" in the Page tab.

For each directory root, you must define :

• The type of "User" content available in the application
• Classification metadata, used to organize people's files
• Tree depth: the tree depth corresponds to the number of intermediate pages that will be used to classify directory members. These intermediate pages are calculated on the first X letters of the classification field selected above, X being the chosen depth.
  These pages are not intended to be displayed on the site, but to preserve display performance in the case of a large directory: the more people the directory contains, the greater the depth should be.

A single root page can be defined for each "Users" content type.

In the example below, the "Agent directory" page is the root of the directory for the "Agent" content type. All its sub-pages are made up of agent records, sorted alphabetically by name, on 2 levels (depth of 2).
This is called a "virtual" tree structure, because the pages are not "physical", but automatically calculated from the members of this directory.

To modify or delete a directory root, select the root page in the sitemap, then click on "Directory root".

Directory search

Use the "Search engine" service by selecting the directory content type (e.g. agent) to search for people in a directory.

Organization chart

plugin Directory adds a new "Entity" content type, for the poles or services in your directory.
Entities are hierarchical, and each entity can be linked to a parent entity.

By default, this type of content is composed of

• a title
• a description (simple text)
• a type (reference table) (e.g. Mayor, Division, Department, etc.).
• a parent entity (optional)
• a Boolean to display or not the entity title in the dynamic flowchart
• a "repeater" for members of this entity with :
  
  • the user
  • the user's role within the entity (director, assistant, etc.)

Entity creation

Entities in the flowchart can be synchronized with a database. They will then be automatically created or synchronized when the external source is synchronized, depending on the latter's configuration.
See the administrator's manual to configure entity synchronization.

You can also create an entity from the back office, by clicking on "New entity" in the Directory tab.
Please note, however, that it will not be possible to synchronize it with an external source.

Back-office entity search

Click on "Search entities" in the Directory tab to open the entity search tool.

Entity types

Entity types are a reference table.

You can add, modify or delete entity types from the "Reference table" > "Entity type" menu.

Organization chart

Virtual tree

To manage the entity tree, select a page in the sitemap and click on "Organizational chart root".

By positioning the root of the flowchart, a virtual tree structure will be generated, corresponding to the tree of entities.
This tree structure is referred to as "virtual", because it is not a question of "physical" pages, but of pages automatically calculated from the entities.

There can only be one root page per site map.

By default, each "Entity" page displays :

• title and description of the entity
• core" members, with a non-empty role within the entity
• list of sub-entities
• list of other members

The rendering and display of this information is entirely customizable, and depends on your own graphic style and integration.

Entity organization chart" service

The "Organizational chart" service dynamically generates a complete organizational chart of all entities.

Example of a possible rendering