Create and publish schemas create-publish

Create and manage schemas create-schemas

You can create new schemas, extend existing schemas, and access external databases.

NOTE
This capability is only available for a set of organizations (Limited Availability), and will be rolled out globally in a future release.

Create or extend a schema create-new

To create or extend a schema:

  1. Navigate to Administration > Schemas.

  2. Click Create schema.

    Schema creation dialog

  3. Enter a namespace for your schema (for example, cus for custom schemas).

  4. Enter a unique name and label, and choose if you want to create a new schema or extend an existing one.

  5. Click Create.
    Schema creation dialog

The schema is created and the generated schema structure is displayed.

By default, the schema is empty. You now need to add the fields you want to include in your schema using the schema editor:

  1. Click the pencil icon in the Content section of the schema details screen.

  2. Add the needed elements and save. Here is an example of a custom schema structure:

    Schema creation dialog

The system automatically validates the XML structure and generates the schema.

Define the screen edition define-attributes

After creating the schema, you need to define the screen edition.

For more information on the screen definition screen and how to access it, refer to the Access the screen definition section.

In our example, we simply add two custom fields:

  1. Click the Screen edition button in the schema details view to access the screen definition.

  2. Click the ellipsis icon above the List of custom fields table and choose Select attributes.

  3. Select the custom fields you want to add and confirm.

    Schema creation dialog

Publish and synchronize schemas publish

After creating or modifying a schema, you need to publish it to synchronize the logical schema with the physical database structure.

Publish schema changes publish-changes

CAUTION
Publishing schema changes modifies the database structure. Make sure you understand the impact of these changes before confirming the publication.

To publish your schema changes:

  1. Navigate to Administration > Schemas to access the schema list.

  2. Click Publishing and confirm.

    Schema publication dialog showing changes to be applied

  3. Select, in the list, the schema you want to synchronize.

    Schema publication dialog showing changes to be applied

  4. Review the SQL script that will be executed to update the database structure.

  5. Click Publish and confirm to proceed with the publication.

NOTE
The process may take some time depending on the size of your database and the complexity of the changes.

Create a navigation entry navigation

After publishing a custom schema, you can create a navigation entry in the Explorer to access your custom data:

  1. Navigate to the Explorer menu and select a folder where you want to place your custom schema.
  2. Click the ellipsis icon, and click Create new folder.
    Navigation entry creation for custom schema
  3. Add a label and choose your schema in the Folder type field.
    Navigation entry creation for custom schema
  4. The custom schema will now be accessible from the Explorer view.

From the new folder, you can:

  • View the list of records in your custom schema.
  • Create new records.
  • Edit and delete existing records.
  • Customize which columns are displayed by default in the list view.
recommendation-more-help
c39c2d00-ba9a-424b-adf9-66af58a0c34b