Environment variables

Overview of all environment variables that are available to the Agent when executing the script.

The environment variables available to the Agent during Job execution includes:

  • TTH_URL
    • URL of Typhoon Test Hub
  • TTH_JOB_NAME
    • Name of the executed job
  • TTH_EXECUTION_ID
    • Identifier of the execution
  • TTH_EXECUTION_NUMBER_ID
    • Number of execution of the executed job
  • TTH_EXECUTION_NAME
    • Name of the execution
  • TTH_PIPELINE_EXECUTION_ID
    • Identifier of the pipeline to which the execution of the executed job belongs to
  • TTH_TRIGGER_ID
    • Identifier of the trigger that was used to start the execution
  • TTH_TRIGGER_NAME
    • Name of the trigger that was used to start the execution
  • TTH_AGENT_ID
    • Identifier of the agent running the execution
  • TTH_AGENT_NAME
    • Name of the agent running the execution
  • TTH_AGENT_WORKSPACE
    • Path of the workspace of agent running the execution
  • TTH_AGENT_OS
    • Operating system of agent running the execution
  • TTH_SETUP_ID
    • Identifier of the setup that is used during the execution
  • TTH_SETUP_NAME
    • Name of the setup that is used during the execution
  • TTH_SETUP_HIL_IP
    • List of IP addresses of the HIL devices that belong to the setup that is used during the execution
  • TTH_SETUP_HIL_SN
    • List of serial numbers of the HIL devices that belong to the setup that is used during the execution
  • TTH_SETUP_DUT
    • List of all DUTs that belong to the setup
  • TTH_SETUP_DUT_{DUT_CATEGORY_NAME}
    • List of all DUTs that belong to the setup having same category
  • TTH_SETUP_DUT_{DUT_CATEGORY_NAME}_{PARAMETER_NAME}
    • List of all DUTs that belong to the setup having same category parameter
  • TTH_GIT_REPOSITORY_NAME_{CLONE_REPOSITORY_JOB_STEP_ORDER}
    • Name of the Git repository that is cloned during the execution
  • TTH_GIT_REPOSITORY_URL_{CLONE_REPOSITORY_JOB_STEP_ORDER}
    • URL of the Git repository that is cloned during the execution
  • TTH_GIT_BRANCH_{CLONE_REPOSITORY_JOB_STEP_ORDER}
    • Branch of the Git repository that is cloned during the execution
  • TTH_GIT_DEPTH_{CLONE_REPOSITORY_JOB_STEP_ORDER}
    • Depth of the Git repository that is cloned during the execution
  • TTH_GIT_REPOSITORY_DESTINATION_{CLONE_REPOSITORY_JOB_STEP_ORDER}
    • Destination where the Git repository is cloned during the execution
  • TTH_GIT_REPOSITORY_CLEAR_CACHE_{CLONE_REPOSITORY_JOB_STEP_ORDER}
    • Indicator whether the Git cloning cache is deleted for the Git repository before it is cloned during the execution
  • TTH_GIT_COMMIT_{CLONE_REPOSITORY_JOB_STEP_ORDER}
    • Hash of the latest commit to the Git repository that is cloned during the execution
  • TTH_GIT_COMMIT_MSG_{CLONE_REPOSITORY_JOB_STEP_ORDER}
    • Message of the latest commit to the Git repository that is cloned during the execution

Besides built-in environment variables, the environment includes variables whose names match the execution parameters' names.