Skip to main content

Make fields and resources read-only

Why would I do this?

Sometimes, the information in your catalog may have an outside source, and you should not change it on data.world. If you want to stop changes to specific property or entire categories of resources on the data.world website, you can set up a source of record and define what specific fields (both custom and out-of-the-box) or resources cannot be edited within data.world.

What can I make read-only?

Using this feature you can make the following objects read-only:

  • Resources pages

  • Glossary pages

  • Custom fields

  • Out-of-the-box fields - Title, Description, Summary, Status, and Tags.

What is not supported?

  • You cannot use this feature to make Relationships and Collections field read-only.

Example for read-only out-of-the-box fields:

read-only-oob.png

Example for read-only custom fields:

read_only_custom_fields.png

Example of read-only resource page:

read-only-custom-resources.png

STEP 1: Create a source of record

To create a source of record:

  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.

    1. In the Title field, provide a name for the source of record.

    2. From the Choose type section, select the Read-only source option.

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

  3. Click Skip on the next screen. The new source of record is ready for use.

Step 1: Make custom fields read-only and set a source of record

Important

Make sure the fields you are making read-only have data populated from another data source.

  1. Follow these steps to create custom fields. In the Edit permissions field make sure to set the value as Read only.

  2. Optionally, assign a Source of record for the field. By default, the system shows the text This field is automatically synced from an automation or source. You can change the last part of the sentence an automation or source to say something like Official 8Bank terms . The value will look like This field is automatically synced from an Official 8Bank terms

  3. Publish your changes. See: Publishing changes.

View the results

The read-only custom field appears in the UI.

read_only_custom_fields.png

STEP 2: Make out-of-the-box fields read-only

Follow these instructions to make an out-of-the-box field read-only. You can make the following out-of-the-box fields read-only - Title, Description, Summary, Status, Tags.

To make out-of-the-box fields read-only:

  1. In the Catalog Configuration organization, go to the Organization profile page. Locate the resource type for which you want to make the out-of-the-box fields read-only. This can be a custom resource or an out-of-the-box resource. You can also do this while creating new custom resource types.

  2. On the resource page, click the Edit button.

  3. In The Edit Type window, go to the Read-only fields tab. Select the out-of-the-box fields that should be read-only for end users.

  4. Click Save changes.

  5. Optionally, assign a Source of record for the field. By default, the system shows the text This field is automatically synced from an automation or source. You can change the last part of the sentence an automation or source to say something like Official 8Bank terms . The value will look like This field is automatically synced from an Official 8Bank terms

  6. Click Save changes.

  7. Publish the changes. See: Publishing changes.

View the results

The read-only out-of-the-box fields appear in the UI.

read-only-oob.png

STEP 3: Make entire resources read-only

Follow these instructions to make an an entire resource page read-only. You can do this for out-of-the-box or custom resource pages.

To make an entire resource read-only:

  1. In the Catalog Configuration organization, go to the Organization profile page. Locate the resource you want to make read-only. This can be a custom resource or an out-of-the-box resource. You can also do this while creating new custom resource types.

  2. On the resource page, click the Edit button.

  3. In The Edit Type window, on the Overview tab, locate the Edit permissions field. Select the Read-only option to make the resource read-only.

  4. Click Save changes.

  5. Optionally, assign a Source of record for the resource. By default, the system shows the text This resource is automatically synced from an automation or source. You can change the last part of the sentence an automation or source to say something like Official 8Bank system . The value will look like This resource is automatically synced from an Official 8Bank system

  6. Publish the changes. See: Publishing changes.

View the results

The read-only resource will appear in the UI.

read-only-custom-resources.png