To import the Universal Template into your Controller, follow the instructions here.
When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.
Configure Universal Task
For the new Universal Task type, create a new task and enter the task-specific details that were created in the Universal Template
The input fields for this Universal Extension are described below.
Available Action is:
Checkout action clones a Git repository branch locally if the target directory pointed by Path does not exist. The new directory is named after the repository name.
If the repository exist in the Path, a git pull <repository> operation is performed to bring the latest revision locally. If differences exist between local and remote repositories, the remote repository will overwrite the local directory.
Available authentication methods are :
HTTP/HTTPS (Access Token)
HTTP/HTTPS (User and Password)
SSH authentication is available only on Linux Agents.
When the authentication method is HTTP/HTTPS (Access Token) or HTTP/HTTPS (User and Password) , the valid format of repository url is : https://host/path/to/repo.git
When the authentication method is SSH, the valid format of repository is : user@host/path/to/repo.git
A dynamic drop-down list with all the branches from the remote repository. The agent and Credentials on which the task runs on should be specified, so that it looks up the branches on the repository
Local path where the repository directory will be created. The local path resides on the execution environment of the Universal Agent.
Be sure to check your access rights on this location.
Access Token to be used to establish a Token Based authentication. Mandatory only for HTTP/HTTPS (Access Token) authentication method.
The Token field is not available on UAC7.0 or Agents 7.0. Please use the Runtime Password field to enter the Token. There is backwards compatibility from UAC7.1 to UAC7.0
Credentials (User/Password) to be used for HTTP or HTTPS authentication to the Repository Service. Mandatory only for HTTP/HTTPS (User and Password) authentication method
SSH Credentials include the Key Location of the Private Key, with chmod permission 400 and a Passphrase if set.
Key Location field can be left empty only in case the user requires the key to be retrieved by the default user SSH key location (the user's .ssh folder) and the key is created without a passphrase.
Available only for Linux Agents: Mandatory only for SSH Authentication Method
Applicable only for SSH authentication method.
If "No" is selected, ssh will not automatically add host keys to the known_hosts file, and refuses to connect to hosts whose host key has changed.
If "Yes" is selected, ssh will automatically add new host keys to the user known_hosts files
Output Only Fields
The output fields for this Universal Extension are described below.
Last commit revision during the Checkout action.
Checkout action with Access Token
Checkout action with HTTP(s) User and Password
Checkout action with SSH
Depending on the Authentication Method (Access Token, SSH, User and Password) use the respective fields as noted in the parenthesis below. Make sure to fill the required fields(*). All fields also can be filled if required.
The Token field is not present on UAC7.0 or Agents 7.0. Please use the Runtime Password field instead to enter the Token.
Branch Field Dialog
After pressing the search icon of branch field , and fill the fields as seen below, wait few second for the branch fields list to be populated.
Branch Field Choice Population dialog with Access Token