Retrieve standard and custom catalogs

Before you configure agreement types and fields, retrieve your current catalog to understand the standard and custom configurations already in your account. The Docusign CLI provides two commands for this: get catalog and catalog-to-manifest.

Overview of the catalog commands

Retrieve current configuration

The get catalog command retrieves your account’s existing Agreement Manager configuration and writes it to two JSON files in your workspace. These files serve as a reference when creating your package.

Command syntax

ds agm get catalog

This command does not require any options. When you run it, the CLI fetches your existing configuration and writes two files to your workspace’s {workspace}/{project}/agreement-manager/configs/ directory:

• standard-catalog.json: Contains Agreement Manager’s out-of-the-box standard fields and standard agreement types, including any additional fields mapped to the standard types in your account.
• custom-catalog.json: Contains your account’s existing custom fields and custom agreement types, including any additional fields mapped to the custom types. This file is empty if no custom configuration exists in your account.

Standard catalog

The standard catalog describes Agreement Manager’s built-in standard agreement types and standard fields. For each standard agreement type, it lists:

• Default standard fields automatically mapped to it
• Additional standard fields mapped to it in your account
• Custom fields mapped to it in your account

The following is an example of a standard catalog entry:

{
  "standardAgreementTypes": [
    {
      "key": "ConsultingDocumentData",
      "displayName": "Consulting Agreement",
      "category": "BusinessServices",
      "fields": {
        "defaultStandardFields": ["Title", "Execution Date", "Effective Date", "Expiration Date"],
        "additionalStandardFields": [],
        "customFields": []
      }
    }
  ],
  "fields": [
    {
      "key": "EffectiveDate",
      "displayName": "Effective Date",
      "fieldType": "DateTime",
      "category": "GeneralCategory"
    },
    {
      "key": "Jurisdiction",
      "displayName": "Jurisdiction",
      "fieldType": "String",
      "category": "LegalAndComplianceCategory"
    },
    {
      "key": "Assignment",
      "displayName": "Assignment (General)",
      "fieldType": "Dropdown",
      "category": "LegalAndComplianceCategory",
      "dropdownOptions": [
        { "name": "No, or consent required", "definition": "" },
        { "name": "Silent", "definition": "" },
        { "name": "Yes", "definition": "" },
        { "name": "Yes, with conditions", "definition": "" }
      ]
    }
  ]
}

Custom catalog

The custom catalog describes the custom fields and custom agreement types that exist in your account. For each custom agreement type, it lists the standard and custom fields mapped to it, whether AI extraction is enabled, and any training documents associated with it.

The following is an example of a custom catalog entry:

{
  "customAgreementTypes": [
    {
      "key": "C_Data_Processing_Agreement",
      "displayName": "Data Processing Agreement",
      "category": "BusinessServices",
      "fields": {
        "defaultStandardFields": ["Title", "Parties", "Execution Date", "Effective Date", "Status", "Line of Business"],
        "additionalStandardFields": ["Total Contract Value"],
        "customFields": ["Supplier Name", "Supplier Address"]
      },
      "customExtractionEnabled": false
    },
    {
      "key": "C_InternshipOffer6",
      "displayName": "Internship Offer 6",
      "category": "BusinessServices",
      "fields": {
        "defaultStandardFields": ["Title", "Parties", "Execution Date", "Effective Date", "Status", "Line of Business"],
        "additionalStandardFields": ["Renewal Notice Period"],
        "customFields": ["Intern Linkedin URL"]
      },
      "customExtractionEnabled": true,
      "aiDefinition": "Internship Offer 6",
      "docs": [
        {
          "agreementUrl": "https:///agreements/",
          "docName": "Internship offer letter_Charles.pdf"
        },
        {
          "agreementUrl": "https:///agreements/",
          "docName": "Internship offer letter_Sarah.pdf"
        }
      ]
    }
  ],
  "fields": [
    {
      "key": "C_SupplierName",
      "displayName": "Supplier Name",
      "fieldType": "String",
      "customExtractionEnabled": true,
      "aiDefinition": "Supplier Name",
      "examples": {
        "en": [
          {
            "exampleText": "Supplier: High Tech LLC, Inc.",
            "confirmedValue": "High Tech LLC, Inc."
          }
        ]
      },
      "category": "GeneralCategory"
    }
  ]
}

Replicate and reuse a custom configuration

The catalog-to-manifest command converts your account’s existing Agreement Manager configuration into an agreement-manager-manifest.json file. It also downloads any training documents associated with custom agreement types that have AI extraction enabled.

Use this command when you want to build on or replicate an existing configuration, modify it, and upload it.

Command syntax and options

To retrieve your entire Agreement Manager configuration, run:

ds agm catalog-to-manifest --all

To retrieve only specific agreement types, use one or both of the following options:

ds agm catalog-to-manifest --custom-types "displayName1, displayName2"
ds agm catalog-to-manifest --standard-types "displayName3, displayName4"

What the command produces

When you run catalog-to-manifest, the CLI writes the following to the {workspace}/{project}/agreement-manager/export/ folder:

• An agreement-manager-manifest.json file populated with your existing configuration, ready to modify and upload. See the table of command options in the previous section for details.
• Any training documents associated with custom agreement types that have AI extraction enabled, downloaded from Agreement Manager.

Frequently asked questions

What is the difference between the standard catalog and the custom catalog?

The standard catalog describes Agreement Manager’s standard agreement types and standard fields that are available to all accounts. The custom catalog describes the fields and agreement types that have been added to your account. Both files are generated by the get catalog command and are for reference only.

Can I edit the files generated by the get catalog command?

No. The standard-catalog.json and custom-catalog.json files are read-only reference files. Do not modify them. Use the values in these files as inputs when writing your agreement-manager-manifest.json file. If you need an editable starting point, use the catalog-to-manifest command instead.

When should I use catalog-to-manifest instead of get catalog?

Use get catalog when you need a reference of your current configuration, for example, to look up field keys or verify that an upload was successful. Use catalog-to-manifest when you want to replicate or extend an existing configuration, such as porting a configuration from one account to another or building on top of existing customizations.

What happens if my account has no custom configuration?

If your account has no custom fields, custom agreement types, or standard agreement types with additional fields mapped to them, the custom-catalog.json file will be empty and catalog-to-manifest will not produce a manifest. In this case, create your package from scratch by writing a new agreement-manager-manifest.json file.

Do I need to run get catalog again after uploading a package?

Yes. Running get catalog after an upload is recommended to verify that your custom fields, agreement types, and field mappings were created successfully in Agreement Manager.

Next steps

• Learn how to create a package, including the manifest file and training documents required for AI extraction.
• Review the manifest reference for a complete description of all manifest file properties and an example manifest.
• Learn how to upload a package to Agreement Manager, including what to expect after a successful upload and how to resolve validation errors.