Setting up a remote Git organization

The Document Processing environment requires a Git server that is used to store project versions.

About this task

This task applies only for Authoring or Development environments.

In addition to the deployed containers, your environment should include a Git organization. When the Document Processing Designer is used for the first time, the user must configure a connection to the Git organization. In addition, the Git administrator must create a new Git repository for each project that is created in the Document Processing Designer. When you set up or designate your Git repository, capture the configuration details for your repository so that you can use them to connect your project to the repository.

In addition to preparing the Git repository for your project-specific repositories, a common repository, the Common Data Definition repository, is also required. This repository is shared, and holds the standardized data definitions that you can use across projects.

Note: If your remote Git server has been configured to automatically create repositories (if they do not already exist) when a user first pushes a file, then it is not necessary to manually create the Git repositories needed for your projects, or the Common Data Definition (CDD) repository. In the evaluation or starter configuration, a remote Gitea server is created with this automatic creation option enabled.
Tip: Visit the Git Hub docs to find information about creating organizations and personal access tokens.
Remember: The repository must be empty. During any steps to prepare a repository, do not initialize the repository with a readme or add any files.

Procedure

To set up a Git organization for Document Processing:

  1. Record the login credentials for the Git organization:
    To configure a connection with the Git server, your Document Processing Designer user needs the following settings:
    • Git server organization URL
    • Username
    • Type of credentials, either API key or Password
    • Credentials
  2. Create a repository for the Common Data Definition.
    1. In your organization, create a new repository.
    2. Name the repository CDD.
  3. Create the project repository.
    This step must happen after the initial project creation from Business Automation Studio. For more information, see Configuring a Git repository for a project.