Skip to main content

Metadata

Description

The Metadata functionality allows expanding the Soffid objects, its attributes and its data types.

By default, there is a list of built-in objects, but it is possible to create new custom objects and add new custom attributes to each of them.

It is usual to add custom attributes in the User built-in object to hold additional information.

Each attribute has a data type, it may be a basic type as a String (simple text), integer value, date, or something more complex as a reference to a custom object, or a popup to select a manager. In this way, one can build relationships between objects.

Screen overview

Related objects

Basically, there are two types of metadata objects. The built-in objects that are part of the Soffid core, and the custom objects as new objects.

built-in objects

The built-in objects are the objects that are part of the Soffid core. It can not be removed, but more custom attributes can be added.

The following objects are Soffid well-known objects that can be customized by means of this screen. All of them are tagged as Built-in objects.

    1. Accounts:  the Account object can be reviewed in the Account's page in the Basics tab, in the password vault page and in the User's page Accounts tab.
    2. Application: the Application object can be reviewed in the Application's page.
    3. Group: the Group object can be reviewed on the Group's page.
    4. GroupUser: the GroupUser object can be reviewed in the User's page Groups tab when a user has a membership relation with a Group.Host
    5. Host:  the Host object can be reviewed in the Host's page in the Basics tab.
    6. Mail List:
    7. the MailList object can be reviewed in the MailList's page.
    8. Role
    9. RoleUser: the Role object can be reviewed in the Role's page in the Role details tab after selecting a role or in the roles tab of the applications page.
    10. User:  the User object can be reviewed in the User's page in the Basics tab.

Custom objects

The custom objects are the objects created by the administrator to extend the Soffid underlying data model. All of them are marked as  Built-in type No.

Each custom object type created by the administrator is displayed at the custom objects menu options. Unfortunately, all custom object types share the same icon.

Custom objects have two mandatory attributes: name and description. They are mandatory but can be customized.

Standard attributes

  • Code: short name used by scripts and connectors to access the underlying information. It is suggested to use short names without blanks or special characters to make it easier to use.
  • Label: text displayed just beside the attribute value. It is advised to use short descriptions in order to keep the screen cleaner.
  • Data type: The attributes can have different data types
    • Basics
      • String
      • Numeric
      • Password: a text that will be stored encrypted in the database. This field will never be displayed to the end user.
      • Binary: raw information, probably images or documents.
      • Boolean
      • Photo: an image that is displayed as a small image.
      • Date: a date with a calendar popup.
      • Date and time: a date and time with a calendar popup.
      • E-mail: a text with email format.
      • HTML: rich text.
      • Separator: a separator is a label to group attributes according to some criteria
      • SSO HTML input: used primarily for the web SSO engine includes an input field and a value.
    • Extensible built-in objects
        •  

    • Other built-in objects
      •  

    • Custom objects: any other custom object created by the administrator.
  • Required:
  • Include in quick search
  • Prevent duplicated values:
  • Multiple values:
  • Maximun number of rows to display:
  • Size:
  • Values:
  • Administrator visibility
  • User visibility
  • Visibility expression
  • Validation expression:
  • onLoad trigger
  • onChange trigger:

Actions