Skip to main content Skip to complementary content
Qlik Resources
Loading SearchUnify's search If you need assistance with your product, please contact Qlik Support.
Qlik Customer Portal
Loading SearchUnify's search If you need assistance with your product, please contact Qlik Support.
Qlik Customer Portal

Promotion rules

Promoting objects from a source to a target environment follows pre-configured rules.

Personal spaces cannot be promoted.

If you are promoting objects that contain webhooks, ensure that the source and target environment names do not contain any special characters, only alphanumeric characters and underscores.

Objects are generally matched by name, and the rules determine whether each matched object is created, updated, overwritten, or kept in the target environment.

The following sections describe the promotion rules by object type.

Job artifact and task

  • The Job artifact or task is created when it does not exist in the target environment.
    • If the target environment name is the same as a context environment in Talend Studio, the artifact or task is created with context parameter values of the design pulled from Talend Studio.
    • The target task has the same tags as the source task.
    • If the source task uses the option to automatically update to the latest version of its artifact, it is not enabled in the target task.
  • The Job artifact or task is updated when it exists in the target environment.
    • Existing parameter values remain unchanged. If a new version of the artifact or task has new parameters, they are added to Parameters.
    • If the target environment name is the same as a context environment in Talend Studio, the values for the new parameters are pulled from Talend Studio. Otherwise, they correspond to the values set in the source environment.
    • The target task is updated with the tags of the source task.
    • For an artifact promotion, tasks do not use promoted artifacts even if they are set to use the latest artifact version, because this latest artifact version only refers to versions of the published artifact. You must test the promoted artifact before eventually publishing this artifact for your tasks to use it.
    • If the target task uses a specific version of the artifact, it keeps using this version and the option to automatically update it is not selected. If the target task uses the option to automatically update the artifact version, the version is updated to the one used by the source task and the option remains enabled.
Information noteNote:

The promotion workflow is designed to prevent unintended artifact updates when your tasks are promoted.

For this reason, when a promoted task is created in the target environment for the first time, the auto-update option, Always use the latest available artifact version, is automatically deactivated.

This ensures that your task is not inadvertently updated to a new artifact version before you have a chance to review and test the promoted task and confirm the correct artifact version to be used.

Pipeline artifact and task

  • The pipeline artifact or task is created when it does not exist in the target environment.
    • The target task has the same tags as the source task.
    • If the source task uses the option to automatically update to the latest version of its artifact, it is not enabled in the target task.
  • The pipeline artifact or task is updated when it exists in the target environment.
    • Existing parameter values remain unchanged.
    • The target task is updated with the tags of the source task.
    • If the target task uses a specific version of the artifact, it keeps using this version and the option to automatically update it is not selected. If the target task uses the option to automatically update the artifact version, the version is updated to one used by the source task and the option remains enabled.

Plan

  • The plan is created when it does not exist in the target environment.
  • The plan is updated when it exists in the target environment.

Studio connection

  • The Studio connection is created with the same name and type when it does not exist in the target environment.
  • The Studio connection is updated with the same name and type when it exists in the target environment.
    • Parameters are unchanged.
    • If a Studio connection with the same name but different type exists in the target environment, the promotion analysis displays an error. The promotion report displays an error and the task is not promoted.
    • For security reasons, secured parameter values are reset to <change me> in the target environment. You must enter them again manually.

Studio resource

  • The Studio resource is created when it does not exist in the target environment.
  • Override or Keep target:

    • The resource is overwritten (Override) with the values from the source environment, when it exists in the target environment.

    • The resource stays unchanged and remains assigned to its tasks (Keep target), when it exists in the target environment.
    Information noteTip: If you use the API for promotion, set keepTargetResources=false to override the target resources, or set keepTargetResources=true to keep the existing target resources. For more information, see Execute a promotion.

Task scheduler

  • The task scheduler is created when it does not exist in the target environment.
  • The task scheduler is updated when it exists in the target environment.

Space

  • The space is created with empty roles when it does not exist in the target environment.

    Administrators must create roles in the target environment.

  • The space is updated when it exists in the target environment.

    The objects in the space are updated according to the promotion rules specific to each object type.

Remote Engine or Remote Engine Gen2 included in a promoted task, space, or environment

  • Remote Engine or Remote Engine Gen2 is created when it does not exist in the target environment.

    New Remote Engines must be paired after promotion.

  • Remote Engine or Remote Engine Gen2 is updated when it exists in the target environment.

Remote Engine cluster

  • Remote Engine cluster is created when it does not exist in the target environment.

    Remote Engines are not promoted or created during the cluster promotion. They must be added to the promoted cluster in the target environment.

  • Remote Engine cluster is reused when it exists in the target environment.

Run profile

  • The run profile is created with the same name as in the source environment, when it does not exist in the target environment.

    If the related task in the target environment already has a run profile with a different name assigned, this newly created run profile from the source environment replaces it. The target run profile is unassigned and retained.

  • Override or Keep target when a run profile with the same name exists in the target environment:

    • The run profile is overwritten (Override) with the values from the source environment.

    • The run profile stays unchanged and remains assigned to its tasks (Keep target).
  • Regardless of the option selected, run profiles that already exist in the target environment are not deleted during promotion.
    • If overridden, the existing target run profiles with the same name are unassigned but retained. Orphan run profiles may accumulate in the target environment over time.
    • If kept, the existing target run profiles remain assigned to their tasks.
Information noteTip: If you use the API for promotion, set keepTargetRunProfiles=false to override the target run profiles, or set keepTargetRunProfiles=true to keep the existing target run profiles. For more information, see Execute a promotion.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here