{"id":31018,"date":"2022-08-17T23:04:49","date_gmt":"2022-08-17T23:04:49","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=31018"},"modified":"2022-12-23T05:47:45","modified_gmt":"2022-12-23T05:47:45","slug":"xl-release-tutorial-variables","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/xl-release-tutorial-variables\/","title":{"rendered":"XL Release Tutorial: Variables"},"content":{"rendered":"\n

Using a List variable as a value in the List box variable types<\/h2>\n\n\n\n

You can create a List variable and use it as a possible value for a List box variable.<\/p>\n\n\n\n

  1. Create a global variable<\/a> or a release variable<\/a> with the type List<\/strong>.<\/li>
  2. When you create a new variable and select the type List box<\/strong>, click the button next to the Possible values<\/strong> to switch between a list of normal values or a variable of type List<\/strong>.\"List<\/li>
  3. Select the second option and choose a List<\/strong> type variable.<\/li>
  4. Click Save<\/strong>.<\/li><\/ol>\n\n\n\n

    You can use the List box<\/strong> variable in templates, releases, or tasks allowing users to select the values from predefined List<\/strong> variable.<\/p>\n\n\n\n

    Using lists of Applications or Environments in the List box variable types<\/h2>\n\n\n\n

    You can choose a list of Applications or Environments to be used as possible values for a List box<\/strong> variable.<\/p>\n\n\n\n

    Please specify the run-as user and password on the template properties as those credentials will be used to retrieve the available Applications and Environments.<\/p>\n\n\n\n

    Note<\/strong>: Applications or environments will only be retrieved when the new release is being created and during the User Input task. In all other cases – such as manually changing variable values in either a Template or Release – the list of values will be empty.<\/p><\/blockquote>\n\n\n\n

    Dynamically populating a List box variable type using a custom script<\/h3>\n\n\n\n

    You can use a script to dynamically retrieve possible values inside a List box variable.<\/p>\n\n\n\n

    1. Create a new List box variable.<\/li>
    2. Select Value provider<\/strong> as the Value provider type.\"List<\/li>
    3. Select the Script value provider<\/strong>.<\/li>
    4. Depending on the selected script, you will have different input fields. The script will be evaluated when creating a release.<\/li>
    5. Click Save<\/strong>.<\/li><\/ol>\n\n\n\n

      Note<\/strong>: Applications or environments will only be retrieved when the new release is being created and during the User Input task. In all other cases – such as manually changing variable values in either a Template or Release – the list of values will be empty.<\/p><\/blockquote>\n\n\n\n

      Creating a custom script value provider<\/h2>\n\n\n\n

      Creating a new script value provider is similar to the Plugin tasks<\/a>. For a more detailed explanation of how to extend the Release type system, see Defining a custom task<\/a>.<\/p>\n\n\n\n

      Example script value provider<\/h5>\n\n\n\n

      In the synthetic.xml<\/code> file, you must extend xlrelease.JythonProvider<\/code> or xlrelease.GroovyProvider<\/code>:<\/p>\n\n\n

      <synthetic<\/span> xmlns:xsi<\/span>=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"<\/span>\n       xmlns<\/span>=\"http:\/\/www.xebialabs.com\/deployit\/synthetic\"<\/span>\n       xsi:schemaLocation<\/span>=\"http:\/\/www.xebialabs.com\/deployit\/synthetic synthetic.xsd\"<\/span>><\/span>\n\n  <type<\/span> type<\/span>=\"test.Test2ValueProvider\"<\/span> extends<\/span>=\"xlrelease.JythonProvider\"<\/span> label<\/span>=\"Sample value provider with CI ref\"<\/span>\n            description<\/span>=\"This value provider has CI ref parameter that points to JIRA server.\"<\/span>><\/span>\n      <property<\/span> name<\/span>=\"jiraServer\"<\/span> label<\/span>=\"JIRA server\"<\/span> referenced-type<\/span>=\"jira.Server\"<\/span> kind<\/span>=\"ci\"<\/span> description<\/span>=\"JIRA server to use\"<\/span> \/><\/span>\n      <property<\/span> name<\/span>=\"username\"<\/span>  required<\/span>=\"false\"<\/span> description<\/span>=\"Overrides the username used to connect to the server\"<\/span>\/><\/span>\n      <property<\/span> name<\/span>=\"password\"<\/span> password<\/span>=\"true\"<\/span> required<\/span>=\"false\"<\/span> description<\/span>=\"Overrides the password used to connect to the server\"<\/span>\/><\/span>\n  <\/type<\/span>><\/span>\n\n<\/synthetic<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
      You can store value provider scripts in the ext<\/code> or plugins<\/code> directory of the Release server.<\/p>\n\n\n\n
      • Use ext<\/code> when you are developing a custom value provider. The ext<\/code> directory contains custom type definitions in the synthetic.xml<\/code> file. Scripts are placed in the subdirectories of ext<\/code>.<\/li>
      • The plugins<\/code> directory contains bundled plugins that are packaged in a single zip file with the .jar<\/code> extension.<\/li><\/ul>\n\n\n\n
        For the value provider defined above, Release will try to find and execute the python script at this location: test\/Test2ValueProvider.py<\/code>. Value provider scripts must return a list of objects in the variable named result<\/code>.<\/p>\n\n\n\n
        Note:<\/strong> The properties of the value provider will be injected into the script as well as a dictionary<\/strong>. As a result, you do not need to access the properties as valueProvider.jiraServer<\/code> but use jiraServer<\/code>, instead.<\/p><\/blockquote>\n\n\n\n
        The following script can be used to display the title of the JIRA server passed as a parameter to the value provider defined above:<\/p>\n\n\n
        # let's connect to the provided jiraServer<\/span>\nfrom xlrelease.HttpRequest import HttpRequest\n# example of request to the Jira server<\/span>\nreq = HttpRequest(jiraServer)\n# ...<\/span>\nresult = [jiraServer[\"title\"<\/span>]]\n# or<\/span>\n# result = [valueProvider.jiraServer.title]<\/span><\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
        You can add the following properties to the <type><\/code> element to further customize your value provider:<\/p>\n\n\n\n
        • scriptLocation<\/code>: Specifies a custom script location that overrides the default rules.<\/li><\/ul>\n\n\n\n
          This is an example of a value provider that generates a range of numbers:<\/p>\n\n\n
          <synthetic<\/span> xmlns:xsi<\/span>=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"<\/span>\n       xmlns<\/span>=\"http:\/\/www.xebialabs.com\/deployit\/synthetic\"<\/span>\n       xsi:schemaLocation<\/span>=\"http:\/\/www.xebialabs.com\/deployit\/synthetic synthetic.xsd\"<\/span>><\/span>\n\n    <type<\/span> type<\/span>=\"test.TestValueProvider\"<\/span> extends<\/span>=\"xlrelease.JythonProvider\"<\/span> label<\/span>=\"Sample script value provider\"<\/span>\n          description<\/span>=\"This value provider has two parameters for range.\"<\/span>><\/span>\n        <property<\/span> name<\/span>=\"param1\"<\/span> label<\/span>=\"Lower bound\"<\/span> default<\/span>=\"1\"<\/span> description<\/span>=\"Minimum value.\"<\/span> required<\/span>=\"false\"<\/span> \/><\/span>\n        <property<\/span> name<\/span>=\"param2\"<\/span> label<\/span>=\"Upper bound\"<\/span> default<\/span>=\"5\"<\/span> description<\/span>=\"Maximum value.\"<\/span> required<\/span>=\"false\"<\/span> \/><\/span>\n    <\/type<\/span>><\/span>\n\n<\/synthetic<\/span>><\/span>\n\nPlace the corresponding script into test\/TestValueProvider.py:\n<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n
          def generateRange():\n    t = range(long(valueProvider.param1), long(valueProvider.param2))\n    return<\/span> t\n\nresult = generateRange()<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
          Refernce<\/p>\n\n\n\n
          • https:\/\/docs.digital.ai\/bundle\/devops-release-version-v.22.2\/page\/release\/how-to\/configure-global-variables.html<\/li><\/ul>\n","protected":false},"excerpt":{"rendered":"
            Using a List variable as a value in the List box variable types You can create a List variable and use it as a possible value for a List box variable. Create a global variable or a release variable with the type List. When you create a new variable and select the type List box, click the button next to the Possible…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"_kad_post_classname":"","_joinchat":[],"footnotes":""},"categories":[2],"tags":[],"class_list":["post-31018","post","type-post","status-publish","format-standard","hentry","category-uncategorised"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/31018","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=31018"}],"version-history":[{"count":2,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/31018\/revisions"}],"predecessor-version":[{"id":31020,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/31018\/revisions\/31020"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=31018"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=31018"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=31018"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}