Saving a document processing project

You can save your changes as you work on the document types, field definitions, and data field enrichment and extraction settings. When you are ready to make your project available to collaborators, you can share it out to a Git repository. When you are ready to invite collaboration or to deploy your project, you create a version of the project.

About this task

As you create document types and create and enrich fields, all of your changes are saved in the project, to a MongoDB database and Git gateway. The local copy is available for you to continue working on. You can save your project outside of the default local save either by sharing it or by versioning it.
Share
The Share option moves a copy of your project definition JSON files, where your document types and fields are defined, out to the Git repository that is configured for your environment. You can use the Share option when you want to pause work on the project that you are creating and come back to it later.
Version
The Version option commits all the project files, including both the project definition JSON file and the machine-learning model. This option makes the files available to other users.
The Version option also creates a snapshot of your project that ties the file versions together as a consistent set.
Note: You must create a version of your project before you can deploy it.

Procedure

  • Share your project:
    1. From the Designer task list page, click Share.
  • Create a version of your project:
    1. From the Designer task list page, click Version/Deploy.
    2. On the Version and Deploy dialog, click Save as a new version.
    3. Enter any notes that you have for the version, and click Save.
      These notes help you identify the version at deployment time.
    Troubleshooting
    You might encounter an error if you save a project that previously existed in the system with the same name. For more information about the workaround, see the Known limitations.