Configure your pipeline environments

  • Release version: Xanadu
  • Updated August 1, 2024
  • 1 minute to read
  • Set up your App Engine Studio (AES) production and non-production (for example, development, test, and/or staging) environments by adding the URLs and credentials used to access each instance.

    Before you begin

    Role required: admin
    Note:
    Only users with the System Administrator (admin) role can define instance credentials for environments. Users with the App Engine Administrator [sn_app_eng_notify.app_engine_admin] role can view environment records; however, the Instance credential field is not visible.

    Procedure

    1. In your production instance, navigate to All > App Engine > Pipelines and Deployments > Environments.
    2. Select New.
      Figure 1. Environment - new record
      Creating a new environment
    3. On the form, fill in the fields.
      Table 1. Environment form
      Field Description
      Name Name of the environment. Enter a name that distinguishes the instance as a development, test, or production environment. For example, if you're defining a development environment, you could include Dev in the name.
      Instance Type The type of environment you are defining:
      • Sandbox
      • Development
      • Testing
      • Staging
      • Production
      Instance URL

      Web address of your ServiceNow instance.

      Instance ID The instance_id sys_property for the instance.
      Note:
      The Instance ID is automatically generated when you complete all of the other fields and select Validate.
      Application Application scope of the environment.
      Instance credential Authentication data related to the instance that you're configuring as an environment.
      Note:
      If you are using OAuth 2.0 credentials, select the appropriate credential for the instance record. For example, on your development instance record, select the OAuth Dev credential, and for your test instance record, select the OAuth Test credential.
      Is Controller? Identifies if this instance is a controller. This should be selected for the production environment record where you plan to manage deployment requests. For more information, see Configure your controller instance.
    4. Select Submit.
    5. Repeat the previous steps as you define each remaining environment in your pipeline.
      For example, if you defined a production environment, repeat the procedure again to define a development environment. Then repeat the procedure once more to define a test environment.