Reprocess agreements to refine extracted data | Docusign

After you make updates to agreement or field definitions, you can reprocess to apply your updated configuration to agreements in the Agreement Manager repository.

Reprocessing reruns agreement type classification and data extraction on agreements that have already been ingested into Agreement Manager. Use the Docusign CLI reprocess command to improve extraction accuracy after you:

Modify custom or standard agreement type definitions or change field definitions in your Agreement Manager configuration
Test the configuration changes
Deploy your updated configuration package to Docusign

See Common reprocessing scenarios for examples of configuration changes that should prompt you to reprocess previously ingested agreements.

Reprocess command

Command syntax

ds agm reprocess [options]

Command options

Option	Description	Default
`--agreement-types`	You provide a list of agreement types to be reprocessed. See Reprocess by agreement type for details and an example.	N/A
`--fields`	You provide a list of fields. Docusign identifies the agreement types that contain the fields, and reprocesses agreements of these types. See Reprocess by field for details and an example.	N/A
`--custom-data`	Reprocesses custom agreement types and custom fields.	N/A
`--standard-data`	Reprocesses standard agreement types and standard fields.	N/A

When deciding whether to reprocess by agreement type or by field, choose the option that requires the shorter list in your command argument:

Reprocess by field when you add or update a small number of fields that apply to many agreement types. You supply only the field names rather than listing every affected type.
Reprocess by agreement type when you add or update many fields that apply to a small number of agreement types. You supply only the type names rather than listing every field.

These rules apply to the command options:

You must include either the --agreement-types option or the --fields option in a reprocess command, but you cannot include both.
You must include the --custom-data option, the --standard-data option, or both in a reprocess command.

Reprocess by agreement type

When you reprocess by agreement type, Docusign does the following for all agreements of the specified types:

If agreement type definitions have changed or training documents have been updated, Docusign reclassifies agreements as a different type where applicable.
Extracts field data as follows:
- For a new field, Docusign extracts data for that field in each agreement.
- For an updated field definition, Docusign re-extracts data for that field from each agreement based on the updated information in your manifest.

Example command

ds agm reprocess --agreement-types "Agreement Type 1, Agreement Type 2, Agreement Type 3" --custom-data --standard-data

The agreement types are specified using their displayName values. You can retrieve displayName values using the get catalog command.

Reprocess by field

When you reprocess by field, Docusign checks to see which agreement types contain the specified fields. For all agreements of those types, Docusign does the following:

If agreement type definitions have changed or training documents have been updated, Docusign reclassifies agreements as a different type where applicable.
Extracts field data as follows:
- For a new field, Docusign extracts data for that field in each agreement.
- For an updated field definition, Docusign re-extracts data for that field from each agreement based on the updated information in your manifest.

Example command

ds agm reprocess --fields "Field 1, Field 2, Field 3" --custom-data

The fields are specified using their displayName values. You can retrieve displayName values using the get catalog command.

Common reprocessing scenarios

This table summarizes common reprocessing scenarios and lists the command options to use in each case.

Scenario Scope of the reprocess Include these command options

Scenario	Scope of the reprocess	Include these command options
You do either or both of the following: Add a new custom agreement type Update one or more custom agreement type definitions, for example by refining the AI definition or training documents	All existing agreement types that should be reclassified	--agreement-types --custom-data For the `--agreement-types` argument, list the existing agreement types, not the types to which you expect agreements to be reclassified.
You add standard fields to one or more standard agreement types.	All standard agreement types to which standard fields have been added	--agreement-types --standard-data
You do either or both of the following: Add custom fields to one or more agreement types Update one or more custom field definitions, for example by refining the AI definition or examples	All agreement types that include the custom fields	You can reprocess by agreement type or field. If the number of affected agreement types is less than the number of custom fields added or updated, you should reprocess by agreement type. Otherwise, reprocess by field. Reprocess by agreement type: --agreement-types --custom-data Reprocess by field: --fields --custom-data

You do either or both of the following:

Add a new custom agreement type
Update one or more custom agreement type definitions, for example by refining the AI definition or training documents

All existing agreement types that should be reclassified

--agreement-types
--custom-data

For the --agreement-types argument, list the existing agreement types, not the types to which you expect agreements to be reclassified.

You add standard fields to one or more standard agreement types.

All standard agreement types to which standard fields have been added

--agreement-types
--standard-data

You do either or both of the following:

Add custom fields to one or more agreement types
Update one or more custom field definitions, for example by refining the AI definition or examples

All agreement types that include the custom fields

You can reprocess by agreement type or field. If the number of affected agreement types is less than the number of custom fields added or updated, you should reprocess by agreement type. Otherwise, reprocess by field.
Reprocess by agreement type:

--agreement-types
--custom-data

Reprocess by field:

--fields
--custom-data

Reprocessing behaviors and limits

When you enter a reprocess command, the CLI confirms the number of agreements that will be reprocessed based on the command options. It will then prompt you to either proceed with the reprocess or cancel it.

A maximum of 100,000 agreements can be processed with a single reprocess command. If you run a command that would reprocess more than 100,000 agreements, the CLI displays a warning and will not continue with the reprocess. Enter a new reprocess command with different options to reduce the number of agreements.

A successful reprocess command initiates an agreement processing job in Agreement Manager. See Job Monitoring for Agreement Uploads and Processing for details about how to view the job status.

The duration of a processing job depends on the number of agreements. See the Job size considerations section in Agreement Manager Reprocessing Experience for information.

Error messages

If a reprocess command fails, see Reprocessing errors for information about error causes and resolutions.

Frequently asked questions

How do I reprocess agreements after updating field definitions?

Run the ds agm reprocess command with either the --fields option (specifying the updated fields) or the --agreement-types option (specifying the agreement types that contain those fields). Choose the option that requires the shorter list in your command argument. Include --custom-data, --standard-data, or both depending on whether the updated fields are custom or standard.

What happens to existing agreement data when I reprocess?

Docusign reclassifies agreements under a different agreement type where applicable, based on updated type definitions or training documents. For new fields, Docusign extracts data for that field from each agreement. For updated field definitions, Docusign re-extracts data based on the updated information in your manifest.

Can I reprocess by both agreement type and field at the same time?

No. The --agreement-types and --fields options are mutually exclusive. You must include one or the other in a reprocess command, but not both. Choose the option that minimizes the size of the list you need to supply.

What is the maximum number of agreements I can reprocess?

If the number of agreements that would be reprocessed exceeds 100,000, the Docusign CLI displays a warning and does not continue with the reprocess. Enter a new reprocess command with different options to reduce the number of agreements.

How long does reprocessing take?

The duration of a processing job depends on the number of agreements. A successful reprocess command initiates an agreement processing job in Agreement Manager. See Job Monitoring for Agreement Uploads and Processing and the Job size considerations section in Agreement Manager Reprocessing Experience for details.

Next steps

Explore the AI tools available to help you build and manage your Agreement Manager configuration more efficiently.
Join the open beta to access new features early and provide feedback to the Docusign team.