Legacy - Import application or application-customization from source control

Import an application or application-customization from a source control repository to continue developing it on this instance.

Avant de commencer

Important :

Starting with the Xanadu release, the legacy version of ServiceNow Studio is being prepared for future deprecation. It will be hidden and no longer activated on new instances but will continue to be supported. For details on the deprecation process, see the Deprecation Process [KB0867184] article in the Now Support Knowledge Base.

Try building and editing apps in the current version of ServiceNow Studio instead. For more information, see ServiceNow Studio.

• Role required: admin or source_control
  • Restrict permissions on the access token to allow read and write access to the Git repository.
  • The repository user credentials must grant read and write access.
  For more information, see Link an application or application-customization to source control.
• 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 (ServiceNow sys_user) record that they use in their commits to the Git repository.
• Learn more about application-customizations Managing application-customizations.

Pourquoi et quand exécuter cette tâche

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 the ServiceNow Store.

Procédure

1. Navigate to All > System Applications > Studio.
   The system displays the Welcome to Studio page.
2. Click Open Studio > Go.
   The system opens Studio and the Switch Applications window.
3. Click Import from Source Control.
   Studio displays the Import from Source Control fields.

   

4. Enter the following field values.

   Tableau 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. Remarque : 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.
   Credential	Select the credential for your Git repository. (See Getting started with Credentials.) Remarque : 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.
   Branch	The repository branch to work on within the application. Remarque : The default branch is named after your instance. If you do not choose a name, the branch defaults to master.
   MID Server Name	Select an existing MID Server to link to a Git repository stored behind your corporate firewall. Remarque : Use a separate MID Server to prevent conflicts with Discovery activities.
   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 check box.

   Remarque :

   All application developers on the instance share the credential used to link a Git repository to an application.
5. Click Import.
   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.
6. Click Select Application.
   Studio displays the application as a new choice in the Switch Applications window.

Que faire ensuite

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

Information associée

• MID Server
• Getting started with credentials