Import an app from source control in ServiceNow Studio

Importing an application from source control results in a new application being created in your ServiceNow instance based on the remote repository you specify. The account credentials you supply must have read access to the remote repository, and the remote repository you specify must contain a valid ServiceNow application.

Before you begin

• Verify that the non-production instance has network access to the Git repository.
• Verify that the repository contains a valid application.
• Ensure that users add the email address to their respective Users table [sys_user] record that they use in their commits to the Git repository.
• Learn more about application-customizations Manage customizations to applications.
• Role required: admin

About this task

The source control integration does not support importing an application on a production instance. Instead, install applications on a production instance from the application repository, an update set, or ServiceNow Studio.

Procedure

1. Navigate to All > App Engine > ServiceNow Studio.
2. Select the Create dropdown list on the home page, and select Import app.

   

   

3. On the form, fill in the fields.

   Table 1. Import from source control fields

   Field	Description
   Network protocol	Https or ssh credential type that enables secure channel data exchange.
   URL	The URL to the Git repository where the application files reside. Note: If the Git repo URL for SSH provided by your Git server does not work, check with your Git server owner or provider for the correct URL. There may be additional specifications such as scheme protocol prefixes, port numbers, and so on, required for your Git repo URL to function.
   Branch	The repository branch to work on within the application. Note: The default branch is named after your instance. If you do not choose a name, the branch defaults to master.
   Connect with a MID Server	Option to opt in and select an existing MID Server to link to a Git repository stored behind your corporate firewall. Note: Use a separate MID Server to prevent conflicts with Discovery activities. See MID Server for more information.
   Default email	The committer email address is defined by the sys_user record if available. But if a committer's sys_user record email field is empty, the system generates an alternate email ([e-mail]). You can also enter a default email address and change it later. To use that default email address in all cases, select the Always use this email for commits from all developers check box.
   Credential	Select the credential for your Git repository. For more information, see Getting started with Credentials. Note: If you select the ssh network protocol, enter a valid credential of the SSH Private Key type. If you select the https protocol, enter a valid credential of the Basic Auth Credentials type.

   Note:

   All application developers on the instance share the credential used to link a Git repository to an application.
4. Select Import app.
   The system compares the checksum in the checksum.txt file to current checksum. When the checksum values match, the integration skips validation and imports the application. When the checksum values do not match, the integration first validates and sanitizes the application files before importing them.
5. Select Select Application.

Result

ServiceNow Studio displays the application as a new choice in the Switch Applications modal.

What to do next

• Review the upgrade logs for any sanitization applied to application files during the import.
• Select the imported application to edit it.