Creating Custom Fields for Catalog Pages

The Overview tab of a catalog page of an Alation object (schema, table, column, etc.) is composed of fields. When you use catalog pages out of the box, they have some essential default fields, such as tags, stewards, or description. A Catalog Admin or Server Admin can customize catalog pages by creating and adding custom fields to existing object templates, creating custom templates for the article objects, and applying permissions to custom fields.

Sample catalog page of a table object:

../../_images/Custom_Page3.png

On the Customize Catalog page in Alation you can create your own custom fields and add them to the catalog page templates.

Starting with V R6 (5.10.x), you can customize the layout of the Table and Column templates. See Editing Object Template Layout. In releases before V R6, the rich text custom fields will be displayed in the main section of the page, and all other custom field types will be displayed in the right-hand section on templates for all object types.

Types of Custom Fields

Alation provides the following custom fields:

  • Dates

  • Multi-Select Pickers

  • Object Sets

  • People Sets

  • Pickers

  • References

  • Rich Texts

Icon

Custom Field type

Purpose of Custom Field Type

Example

../../_images/objectSet_icon.png

Object Sets

Use this field to link data objects, users, and articles to a specific catalog page in bulk. You can define which object types are permitted in the set. Object Sets offer one-to-many relationship, where one catalog page can point to multiple objects in the set.

../../_images/Object_Set.png
../../_images/peopleSet_icon.png

People Sets

Use this field to form groupings of users and groups. Placing this field on a template, you will be able to link relevant users or user groups.

../../_images/People_Set.png
../../_images/ref_icon.png

References

A Reference is similar to Object Sets, but provides a one-to-one reference.

../../_images/Reference.png
../../_images/picker_icon.png

Pickers

Use this field for single-select list values.

../../_images/Picker.png
../../_images/multiPicker_icon.png

Multi-Select Pickers

Use this field for multi-select lists.

../../_images/MultiPicker.png
../../_images/text_icon.png

Rich Text

Use this field for blocks of text. The text included in this field is displayed in the main section of the catalog page.

../../_images/Rich_Text.png
../../_images/date_icon.png

Dates

A Date field allows you to select a specific date. If you want to create a date range, create two date fields, one for the start and one for the end date.

../../_images/Date.png

Adding a Custom Field

To work with custom fields and templates, you need a Catalog or Server Admin admin role.

  1. Log in to Alation as a Catalog or Server Admin. Click the settings icon on the upper right of the main toolbar:

    ../../_images/Screen_Shot_2018-10-16_at_2.17.18_PM.png

    Catalog Admins - In the menu that opens, click Customize Catalog. The Customize Catalog page will open on the Custom Fields tab: Server Admins - On the Admin Settings page that opens, click Customize Catalog in the Catalog Admin section. The Customize Catalog page will open on the Custom Fields tab:

    ../../_images/customfields.png
  2. Scroll down to the type of custom field you want to add.

  3. Click the + (Add) icon. Note that depending on release, the add icon may be on the right to the field type name or at the bottom of the field list of this type. The new field editor will open on the right.

  4. Provide the required information using the prompts in Alation UI.

    Note

    Each field type has several required parameters which you will need to provide when creating the field. More complex fields will have more parameters. For example, when adding object sets and references, you will need to specify the target and source field names to create back-reference fields on the source pages. For list types (pickers and multi-pickers), you will need to create lists of available values. Rich texts and dates only require a name and optionally tooltip text.

  5. Save your field by clicking the Save icon on top-right:

../../_images/Custom_Save.png

Creating an Object Set Field

An object set field is a complex field that includes two parts: target and source. The target is the main object set field that is applied to a template and source is a back reference field that should appear on the page of the object that is referenced in the target field.

To create an object set custom field:

  1. Click the Add icon for object sets. The new field editor will open on the right. There are two sections: on the Target Page and on the Source Page:

In V R6 (5.10.x):

../../_images/Custom_createObjectSet.png

Note

In releases up to V R6 (5.10.x), the back-reference part of the field is not functional and is addressed in a future releases. Users will need to provide both target and source parameters to save the custom field.

  1. In the on the Target Page section, enter the plural and singular names for the new custom field and the tooltip text.

  2. Under the on the Source Page section, enter the Backref Name and Tooltip Text.

  3. Click the save icon to save the changes:

../../_images/Custom_Save.png

The custom field you created is added to Alation and is displayed in the list of existing fields of the object set type on the left.

Editing a Custom Field

  1. On the Customize Catalog > Custom Fields tab, find the custom field to edit.

  2. Click the custom field. The custom field editor will open on the right. Make the required changes and click the Save icon:

../../_images/customfieldsedit.png

Deleting a Custom Field

  1. On the Customize Catalog > Custom Fields tab, find the custom field to delete.

  2. Click the custom field. The custom field editor will open on the right.

  3. Click the Delete icon on top right of the editor.

../../_images/Custom_Delete.png
  1. In the confirmation dialog that opens, confirm the deletion. The field is deleted.