Skip to main content

Create freeform fields

Types of freeform fields

You can create single line fields and multiline fields. The main difference between the two types of fields is that you can use Markdown and rich content editing tools to enhance the content of a multiline field to create a richer experience for the users of the catalog.

custom_fields.png

Creating free form fields

To create a free form field: 

  1. On the Organization profile page, go to the Overview tab or Resources tab. Click the New resource button and select Other resources.

  2. In the Add new resource window, set the following and click Continue.

    • In the Title field, provide a name of the field you want to add. For example, let us add a field called Review date.

    • From the Choose type section, select the Metadata field - freeform option.

    • From the Choose one or more collections dropdown, select the Metadata profile collection.

  3. In the Edit resource window, set the rest of the properties for the field and click the Save button.

    • Display order: Set the order for the field.

    • Page visibility: Select if the field should be always displayed on the resource page or if should be hidden when it is empty.

    • Edit modal visibility: For fields that are used less often, define them as additional properties so that they show as secondary field under an Add new field dropdown on the page where the field values are defined and edited.

    • Edit permissions: Select Can edit if users should be able to edit the value from the UI. Otherwise, set it to Read only.

    • Hover hint: Provide a help text to give context to your users about the field when they are viewing the field values.

    • Edit hint: Provide a help text to give context to your users for what values they should provide while they are editing the field.

    • External access: Select Access through API if you want the field to be available for use by APIs.

    • Filter by this field in search: This allows you to make the field available as a filter on the search results page. We recommend not enabling this for freeform fields.

    • Field size: Select from Multiline or Single line. Note that Multiline fields support Markdown content and rich content editing tools for creating a richer experience. For Single line fields, users can use simple markdown syntax, such as, hyperlinks.

  4. On the free form field page that you just created, go to the Related tab.

  5. Click Add related resource and select, Type. In the window that opens, select the resources that should use this field. By default, the field gets added to the Informational section. You can change it from the Sections tab of the window.

  6. Publish the change.

  7. In the Sandbox organization, go to the resource page for which you added the date field. You can now use the special field with the date field control and set the value.

In this section: