Skip to main content

Getting started

This guide is for Jira administrators who create and configure FieldCraft custom fields.

If you are an end user of already-configured fields, start from the FieldCraft overview and open the feature page that matches your workflow.

Prerequisites​

  • FieldCraft is installed in your Jira Cloud site.
  • You can access Jira administration pages for custom field management.
  • You know which spaces and work types should use the new field context.

Add a custom field​

You can create and configure FieldCraft custom fields using the native Jira Custom Fields page:

  1. Log into your Jira site as an Administrator.

  2. Select Settings in the upper right corner.

  3. Select Work Items.

  4. In the left-hand panel, select Custom fields.

  5. Select Create custom field in the upper right corner.

    The Create custom field button on the Jira Custom fields page

  6. In the Select a Field Type window, select Advanced.

  7. Choose the FieldCraft field type you want to add and select Next.

    Selecting a FieldCraft field type in the Advanced tab

  8. Provide a name and optionally, a description for the custom field.

    Entering a name and description for the new custom field

  9. Select Create.

  10. Follow the steps in the next section to configure your custom field.

FieldCraft custom field configuration, step 1 FieldCraft custom field configuration, step 2 FieldCraft custom field configuration, step 3 FieldCraft custom field configuration, step 4

note

The new custom field will not calculate until its contexts have been updated. This applies even when the custom field is configured for the Default context.

Validate after setup​

After creating and configuring a custom field, validate it before rolling out broadly:

  1. Open a test work item in a space where the field context is enabled.
  2. Confirm the field is visible on the expected screen.
  3. Trigger a relevant change (for example, a status transition or field update).
  4. Refresh the work item view and confirm the field value updates as expected.
  5. If older work items still show stale values after configuration changes, run Reindex.

For known update behavior and platform constraints, review Performance and limitations.

Edit a custom field​

To edit a FieldCraft custom field:

  1. Go to the Jira Custom fields administration page.
  2. Find your custom field and select Actions.
  3. Choose an option:
    • Edit details: Update the Field Name, Description, and Search Template.
    • Contexts and default value: Add or remove contexts, configure Default Value, and access Custom field config.
    • Translation and options: Set language-specific Name and Description.
    • Associate to Screens: Add or remove screens where the field appears.
    • Move to Trash: Remove the field from all screens and move it to Trash.
note
  • Custom fields can be recovered from the Trash within 60 days.
  • After 60 days, the field will be permanently deleted and cannot be recovered.