Page tree
Skip to end of metadata
Go to start of metadata

Version Warning

The content below is for Apache Syncope <= 1.2 - for later versions the Reference Guide is available.

Introduction

A Schema is a collection of properties of a certain attribute managed by Syncope.

The relationship that are between a schema and its corresponding attribute is quite the same that are between a Java class and its corresponding instantiate object.

We can say that the schema is a description of a certain type and the corresponding attribute is the instance of this type.

Schemas can be divided into:

  1. Schemas (used for normal attributes);
  2. Derived Schemas (used for derived attributes);
  3. Virtual Schemas (used for virtual attributes).

For each managed entity (user, role and memberships) can be defined a set of schemas.

For more conceptual information take a look at Schema, attributes and mapping.

This wiki page aims to show how to manage schemas via administration console.

Create a new Schema

Following User Schema creation steps have been provided.

To create a Role Schema or a Membership Schema follow the same steps into the corresponding subtabs of the main tab Schema.

  1. Click on Schema tab.
  2. Click on Attributes tab.
  3. Click on Create new attribute button and provide the following information.

    Name
    name of the attribute.
    Conversion pattern
    conversion patter to serialize Long, Double and Date object into strings.
    Validator class

    class to be used to validate the input (see Attribute Validator Class for implementation details).
    Type
    Type of the attribute.
    Mandatory condition
    true for mandatory attribute;
    false for not mandatory attribute;
    a condition on other attributes for a conditional mandatory (for example, a condition gender can be: gender=='male').
    Accepted values
    to be valued in case of Enum type.
    Multivalue
    check it create an attribute multivalue.
    Read-only
    check it to create an attribute read-only.
  4. Click on Save button.

Create a new Derived Schema

Following User Schema creation steps have been provided.

To create a Role Schema or a Membership Schema follow the same steps into the corresponding subtabs of the main tab Schema.

  1. Click on Schema tab.
  2. Click on Derived attributes tab.
  3. Click on Create new attribute button and provide the name and the JEXL Expressions.
  4. Click on Save button.

Create a new Virtual Schema

Following User Schema creation steps have been provided.

To create a Role Schema or a Membership Schema follow the same steps into the corresponding subtabs of the main tab Schema.

  1. Click on Schema tab.
  2. Click on Virtual attributes tab.
  3. Click on Create new attribute button and provide the name.
  4. Click on Save button.

Edit Schema

Following User Schema modification steps have been provided.

To modify a Role Schema or a Membership Schema follow the same steps into the corresponding subtabs of the main tab Schema.

  1. Click on Schema tab.
  2. Click on Attributes tab.
  3. Click on Edit link and provide information as described above.
  4. Click on Save button.

Steps are quite the same for derived and virtual attribute schemas.

Delete Schema

Following User Schema deletion steps have been provided.

To delete a Role Schema or a Membership Schema follow the same steps into the corresponding subtabs of the main tab Schema.

  1. Click on Schema tab.
  2. Click on Attributes tab.
  3. Click on Delete link.
  4. Confirm operation.

Steps are quite the same for derived and virtual attribute schemas.