Skip to main content

Add custom resource types (CTK)

Why would I add custom resources?

One of the primary ways of organizing data in data.world is by resource types such as tables, datasets, and projects. If there is a specific type of resource not included with data.world that you would like to use, then you can create a custom resource type.

Planning your custom resources

  1. Plan the list of custom resources you need for your organization.

  2. Define the type of custom resources.

  3. Specify the custom resources users can create from the UI.

    add_custom_resources.png

Add a custom resource

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

  2. On the Create a new resource page, in the Select type tab, select Type. Click the Continue to configure fields button.

    The Create a new Type page opens.

  3. In the Configure fields tab, set the following in the About section.

    • In the Title field, provide a name of the relationship you want to add. For example, let us add a type called Bank account.

    • From the Collections dropdown, select the Metadata profile collection.

    • In the Description field, provide a concise description of the resource that will appear in resource creation window.

  4. In the Configure fields tab, set the following in the More information section.

    • Plural: Provide a plural for the field name. For example, Bank accounts.

    • Ability to create in the UI: Set this to Allow UI creation if you want users to be able to create these type of resources from the UI.

    • Edit permissions: Specify whether the entire type should be editable or read-only in the UI. Note: If set to Read only, users will not be able to make ANY edits in the UI for resources of this type. Default behavior is Can edit.

    • Read-only fields: Specify whether any default fields should be read-only in the UI.

    • Read-only sources: If you are making the entire resource read-only, you can specifiy what source defines the values of the resource fields. If nothing is selected, the default read-only source text reads as an automation or source.

    • Resource icon: Select a custom resource icon for the resource type. This is optional.

  5. Click Continue to review type.

  6. In the Review type tab, check the configuration details for any possible errors before saving it. If adjustments are needed, click Back to edit the configuration.

  7. Click Create Type. The creation page is closed and you are taken to your new Resource type page.

Publish the changes

View the results

  1. In the Sandbox Organization, on the Organization profile page, go to the Overview tab.

  2. Click the New resource button and select Catalog resource.

  3. On the Create a new resource page, you will notice that the new custom resource is available.

Enhance the custom resource page

  • Go back to the Catalog configuration organization and add the custom field Steward to the Bank accounts custom resource. Publish the changes to the Sandbox organization and see the enhanced custom resources page.