Config API Names

Every configuration in a changeset needs a Config API Name, for example invoice-intake. The name links a configuration across orgs:

  • If the target org has a mapper or workflow with the same Config API Name, the migrated configuration is added to it as a new version, and it keeps its name.
  • If the target org has no match, a new mapper or workflow is created with that Config API Name.

Set a mapper’s Config API Name in the Config API Name column on the Document Mapper page. You can also set one for a mapper or a workflow while you create a changeset. A Config API Name can contain lowercase letters, numbers, dots, underscores and hyphens. It must be unique among the org’s mappers, or among its workflows.

The Document Mapper page with the Config API Name column, one name being edited

Create a Changeset

  1. In the source org, open Document AI → Config Migrations. The Outgoing tab lists the changesets sent from this org.

The Config Migrations page on the Outgoing tab, with the Create Changeset button

  1. Select Create Changeset and enter a Changeset Name of at least 10 characters.
  2. Select up to 25 configurations from the Document Mapper and Workflows lists. Only published workflows are listed. If a selected configuration has no Config API Name, one is suggested from its name, and you can edit it.

The Create Changeset dialog listing mappers with their source object, Config API Name and version, one mapper selected

  1. Select Next, choose the org to migrate into, and select Next again. The production org is marked Production.
  2. Review the changeset and select Create.

The review step of Create Changeset showing the changeset name, a target org marked Production, one document mapper and one workflow

A configuration that is already in an unfinished changeset to the same org can’t be added to another one until that changeset finishes.

Validation

The changeset is validated in the target org, where it appears on the Incoming tab. CloudFiles checks that the target org has every object, field, relationship and flow each configuration uses. If any configuration fails, the whole changeset fails and nothing is copied.

In the target org, open the changeset’s details from the Incoming tab and select View Details in the Validation Issues column to see what is missing. For example, FIELD_NOT_FOUND means a field the target org doesn’t have, and FLOW_NOT_FOUND means a flow that is missing, inactive or not autolaunched there. Fix the target org or the configuration, then create a new changeset.

A failed changeset in which a workflow shows Cancelled and a document mapper shows Validation failed, with a View Details link
The Validation Issues dialog for a mapper, showing Customer_Priority__c with the reason FIELD_NOT_FOUND

Deploy or Reject a Changeset

To check a changeset’s status, open Document AI → Config Migrations in the target org, select Incoming, and open the changeset’s Details from its row menu. The Match column shows the mapper or workflow in this org that each configuration will update, and an empty Match means a new one will be created.

A validated incoming changeset with a document mapper and a workflow, the Match column, and the Reject and Deploy buttons

When the status is Validated, select Deploy to copy the configurations, or Reject to cancel the changeset. When the copy finishes, the changeset shows Completed and each configuration shows Success. Each deployed mapper and workflow becomes the latest version in the target org, and deployed workflows are published. Sample files uploaded to a mapper are not copied.