Use > OO Designer > Author in OO Designer > Author Flows > Extract and Modify Output Values

Extract and Modify Output Values

You can extract and modify parts of an output, using python.

For example, if you only want the maximum, minimum, and average round-trip times for a ping operation to a server, you can isolate and extract all three pieces of information from the operation’s raw output.

Another example is to extract the HTTP code from an HTTP response.

See https://github.com/CloudSlang/cloud-slang-content/tree/master/content/io/cloudslang/base/xml.

ClosedExtract and modify the output value
  1. In the Step Properties pane, under Outputs, or in the Flow Properties pane, under Outputs, select the output and click the Edit button.

  2. In the Expression Editor, enter the python expression to manipulate the output value.

    Example: To convert the output to lowercase, you just need to copy the following expression in the OO Designer UI:

    output1.lower()

    if the original expression was:

    pub1: ${output1.lower()}
  3. Click Save.

Examples of Using Python to Manipulate Outputs

  • ClosedDiff Case

    Diff Case changes all the characters in the string either to upper case or to lower case.

    Example:

    # to change to lowercase
    output1.lower()
    # to change to uppercase
    output1.upper()
  • ClosedExtract Number

    Extract Number extracts the first number found in the result. It treats an unbroken series of integers as a single number.

    Example:

    To extract the number “123” from the strings “123Test” or “Test123”:

    # extract first number
# requires another step
    - extract_first_number:
        do:
          strings.match_regex:
            - regex: '\d+'
            - text: ${var_name}
        publish:
          - first_number: ${match_text}
        navigate:
          - MATCH: MATCH
          - NO_MATCH: NO_MATCH
  • ClosedFormat

    Format attaches text to a result or output or replaces the original content of the result or output with the text that you specify.

    • To attach the text to the front of the existing text, use prepend.

      Example: 

      # prepend
'xyz' + output1

    • To add the text to the back of the existing text, use append.

      Example: 

      # append
output1 + 'xyz'

    • To replace the output with the text, use replace.

      Example: 

      # replace
output1.replace('old', 'new')
  • ClosedLine Count

    Line Count outputs the total number of lines of the result.

    Example: 

    # string line count
len(output1.split('\n'))
  • ClosedLoop

    Loop is synchronous. It will act like ordinary loop in other languages (such as java). It runs over a collection of items and executes the step mentioned inside (operation or flow).

    • ClosedFor

      The variable name that is assigned the current value from the collection that is defined in the In section. This variable is available in the current running of the inner step as flow variable. In case of iterating map there will be two variable names, for the key and value. This variable is required.

      Supported characters: A to Z, a to z, 0 to 9, _ variable name starting with letter or underscore.

      Example: 

      for: "value in '1','2','3'"

      or

      for: "value in '1,2,3'"

      to actually enter a constant in the expression editor

      for: 'k,v in {"key1":"val1","key2":"val2"}'
    • ClosedIn

      The collection to be iterated on. You can use any python expression that results in a list or map. The In section contains dropdowns that contain SP and flow variables. Click the Edit button to open the expression dialog where you can insert any string. This variable is required.

      Example:

      • Array: ['1','2','3','4'] or ['a','b','c','d']
      • Python expression: map(str,range(1,5)) to return a string collection.
      • Map: {"key1":"value1","key2":"value2"}
      • Comma delimited strings: which would be split automatically into a list: "1,2,3"
      • Flow variable: select it from the drop down (all step published outputs and flow inputs).
      • System property: select it from the drop down.
    • ClosedBreak

      A loop exits when either the collection being looped has been exhausted or the operation or subflow called returns one of the results mentioned in the break section. The break section is a property of a loop, which is mapped to a list of results on which to break out of the loop. The list of results is a subset of the results of the inner step.

      When the operation or subflow of the iterative task returns a result in the break list, the iteration halts and the iterative task navigation logic is run.

      If there is no break section in the YAML, by default FAILURE breaks the loop. In Java-based operations and in Python, FAILURE result is added by default to the Break list. You can delete FAILURE.

    • ClosedPublish

      The publish output is set like a regular step (In the step properties). At runtime, it will contain the value from the last iteration of the loop (make sure the 'publish' key is inside the loop).

      You can also aggregate outputs from a loop. To do so, put a python expression that will aggregate the outputs.

      Example:

      The sum is calculated in each iteration and at the end provides the sum of all iterations.

      - aggregate:
    loop:  
      for: "value in '1','2','3'"
      do:
        square:
          - to_square: ${value}
          - sum
      publish:
        - sum: ${sum + squared}
    • ClosedNavigate

      The navigation logic runs when the last iteration of the step is completed or after exiting the iteration due to a break. The navigation runs according to the last iteration of the loop.

      For keys, the supported characters: A to Z, a to z, 0 to 9.

      For values, restricted to step/result names.

      Example:

      - custom3:
    loop:
      for: "value in '1','2','3','4','5'"
              do:
          custom3:
            - text: ${value}							
        do:
          break:
            - CUSTOM
          publish:
            - CUSTOM: aggregate
            - SUCCESS: skip_this

      You can also use: for: "value in '1,2,3,4,5'"

  • ClosedParallel Loop

    A Parallel loop runs over a collection in an asynchronous way, meaning that each execution of the step is run simultaneously and in a different context. A new branch is created for each value in a list and the branches run in parallel. The various branches running the flow will run in parallel and the rest of the flow will continue only after all the branches have completed.

    • ClosedFor

      The variable name that is assigned the current value from the collection that is defined in the In section. This variable is available in the current running of the inner step as flow variable. In case of iterating map there will be two variable names, for the key and value. This variable is required.

      Supported characters: A to Z, a to z, 0 to 9, _ variable name starting with letter or underscore.

      Example: 

      for: "value in '1','2','3'"

      or

      for: "value in '1,2,3'"

      to actually entering a constant in the expression editor.

      for: 'k,v in {"key1":"val1","key2":"val2"}'
    • ClosedIn

      The collection to be iterated on. You can use any Python expression that results in a list or map. The In section contains drop downs that contain SP and flow variables. Click the Edit button to open the expression dialog where you can insert any string. This variable is required.

      Example:

      • Array: ['1','2','3','4'] or ['a','b','c','d']
      • Python expression: map(str,range(1,5))
      • Map: {"key1":"value1","key2":"value2"}
      • Comma delimited strings: which would be split automatically into a list: "1,2,3"
      • Flow variable: select it from the drop down (all step published outputs and flow inputs).
      • System property: select it from the drop down.
    • ClosedPublish

      The publish mechanism defines the step aggregation logic, generally making use of the branches_context construct.

      The branches context is a list that includes all the contexts of all the iterations. It is set according to the order of execution, meaning that the execution that finishes first gets the first place in the list and so on.

      After all branches of a Parallel Loop have completed, the execution of the flow continues with the publish section. The expression of each output pair is evaluated and published to the flow scope.

      In Parallel Loops, the publish keyword is at the loop level in the YAML and not as in a Loop where it is inside the loop, in line with the do keyword.

      In a Parallel Loop, there is no publish section inside the inner step. Instead, it publishes all the outputs of the inner step by default to the branches_context, allowing for aggregation.

      The aggregation syntax should be a python expression.

      Example:

      • Retrieves the name variable from the first branch to finish:

        - publish:
  - first_name: '${str(branches_context[0]["name"])}'

      • Publishes an aggregate output (it iterates over the :', which contains a list of all the iterations of the Parallel Loop, and takes the value of 'name' from each branch):

        - publish:
  - name_list: '${str([str(x["name"]) 
        for x in branches_context])}'

      • Creates a list of branch results (as branches of a Parallel Loop complete, branch results get placed into the branches_context list under the branch_result key):

        - publish:
  - result_status_list: '${str([str(x["branch_result"]) 
         for x in branches_context])}'
    • ClosedNavigate

      The navigation logic runs after the last branch has completed. If any of the branches return a result of FAILURE, the flow will follow the navigation path of FAILURE. Otherwise, the flow will follow the SUCCESS navigation path. Any other result beside SUCCESS and FAILURE will be evaluated as SUCCESS.

      For keys, the supported characters: A to Z, a to z, 0 to 9.

      For values, restricted to step/result names.

      • If the inner step does not contain a FAILURE result, the navigation (ports) do not contain a FAILURE port, but only a SUCCESS port.

      • If a step has a custom result, after setting it in a parallel loop, the ports change to be SUCCESS and FAILURE. After removing the step from the parallel loop, the original ports of the step is returned.

      Example:

      - print_values: 
    parallel_loop:
	for: value in values
	do:
	   print_branch:
             - ID: ${value}							do:
    publish:
	- name_list: '${str([str(x["name"]) 
            for x in branches_context])}'
    navigate:
	- SUCCESS: print_list
	- FAILURE: FAILURE
  • ClosedRegular Expression

    Regular Expression filters the raw results using a regular expression (regex).

    Example: 

    # regular expression
# as above, requires another step
base.string.match_regex:
  - regex: '<expression>'
  - text: ${output1}
  • ClosedReplace

    Replace replaces the first or last instance or all instances of one string with another string.

    • Use First, All, or Last, to define which instances of the target string to replace.

      Example: 

      # replace first
output1.replace('old', 'new', 1)
    • To make the search not case-sensitive, use Ignore case.

    Example: 

    'abcabdAb'.lower().replace('ab'.lower(), 'XX')
  • Closed Round Number

    Round Number rounds numbers up or down.

    • Use Number of Decimal Places to define the number of decimal places the number should be rounded to.

      Example: 

      # round
# note: float function call is not always needed
# note: python rounding of floats sometime returns 
# unexpected results
# see https://docs.python.org/2/library/functions.html#round
round(float(output1), <number_of_decimal_places>)

    • Round rounds the number up if the last significant digit is 5 or more, and down otherwise

    Example: 

    round(2.734) -> 2.73 
    round(2.734, 2) -> 2.73
  • ClosedSelect Range

    Select Range defines a string that you want to extract from the input data. The two criteria for defining the string are its length in characters and the position of its first character from the start of the input data.

    • Use Start to specify the zero-based start position of the string.

    • Keep in mind that a new line may count as one or two characters, depending on the operating system from which you obtain the data you’re filtering.

    Example: 

    # select range
    # note: <end> is not included in the selection
    output1[<start>:<end>]
  • ClosedSorted

    Sorted orders the lines of input data by the first character in each line.

    • To specify the direction of the sort, use Ascending.

    • To order the data by ASCII order, use Treat as Numbers.

      Note that ascending ASCII order is roughly as follows, for English characters:

      • White space
      • Symbols
      • Numbers
      • Alphabetic characters

    Example: 

    # sort lines
# note: returns a list, can be joined to a single string using join function
sorted(output1.split('\n'))
  • ClosedStrip

    Strip strips characters from the beginning or end of the raw results.

    • Use Strip Method to specify how you want the filter to strip the raw results:
      • All Characters Up To the string.
      • All Characters Up To And Including the string.
      • All Characters After the string.
      • All Characters After And Including the string .
    • Use Characters to Strip to specify the string to find.

    Example: 

    # strip other characters
# note: can also be used with lstrip and rstrip
output1.strip(<characters_to_strp>)
  • ClosedStrip Whitespace

    Strip Whitespace removes all the whitespace characters from the front and the end of the raw results.

    Example: 

    # strip whitespace from both sides
output1.strip()
# strip whitespace from left side
output1.lstrip()
# strip whitespace from right side
output1.rstrip()
  • ClosedTable

    Table does not convert the raw results into a table, but enables you to manipulate the raw results as if they were a table, including sorting columns and selecting columns, rows, and blocks.

    • Use Column Delimiter to specify the character that will serve to divide the data into columns in a meaningful way.

    • Use Row Delimiter to specify the character that will serve to divide the data into rows in a meaningful way.

      Note Two or more consecutive whitespaces count as a single whitespace, so a column may be occupied by data that you expected to find in a column to the right. For example, this behavior will appear if you apply this filter to the output of a “dir” command-line command with whitespace specified as the column delimiter.

    • Use First Row is Header to treat the members of the first row as column headers, .
    • Use Strip First Row of Result to remove the first row.

    • Use Sort On Column to sort on a column, by specifying the (1-based) column number.

      Tip The value -1 means do not sort on any column.

    • Use Ascending to specify the ascending order. By default, the sort order is descending.
    • To select the row that you want the filter to extract, specify the row number with Select Row (-1 selects all the rows) and specify the number of columns in that row that you want extracted using Select Width (-1 selects all the remaining columns to the right of the column specified by Select Col).
    • To select the column that you want the filter to extract, specify the column number with Select Col (-1 selects all the columns) and specify the number of rows in that column that you want extracted using Select Height (-1 selects all the remaining columns to the right of the column specified by Select Row)

    Example:

    To extract the first 5 rows of the 2nd through 4th columns, you would specify the following:

    Select Row= 0
Select Height= 5
Select Col= 2
Select Width= 3

    In these settings, the first two settings define the selected rows, and the last two settings define the selected rows.

  • ClosedXML 

    XML enables you to parse XML within a step, the XML being obtained from the step’s input or output. The XML Get Attribute filter extracts the value for each of one or more instances of the attribute that you specify. You can control which instance of the attribute the filter is applied to by specifying an element path to the attribute.

    You can obtain the value for a single instance of the attribute or for multiple instances, returned in a table. In such a table, the columns are comma-delimited and the rows are new line-delimited.

    • Using Element Path, specify the path of the element that contains the attribute whose value you want to extract. Use forward slashes to separate the parts of the path to the element.

      • To control which instance of the element the filter gets the attribute’s value from, add a specification such as [2] or [3]. The numbering of elements is 1-based (starts with [1]). Thus to specify the second instance of an element, you would use [2].

    • To search child elements of the element you’ve specified, use Include sub-elements.
    • Using Attribute Name, specify the name of the attribute whose value you want.

    • For Result, use one of the following:

      • To restrict the result extracted to the value of a single instance of an attribute, use Single Match.
      • To extract the value of all the instances of the attribute you have named, use As Table.

    Example: 

    # xml
# requires another step
base.xml.xpath_query:
  - xml_document: ${output1}
  - xpath_query: <query>
  - query_type: <node|value|nodelist>
  • ClosedXML Get Element

    XML Get Element enables you to extract an element in its entirety (including child elements, values, and attributes) by describing it in any of the following ways:

    • Use Element Path to specify an absolute path to the element.

      • ../ specifies the parent of the last-named element.
      • ./ specifies the last-named element.

      You can specify a particular instance of any element in the path with an integer inside square brackets.

      Example:

      /tickets/ticket/details/comment specifies all the comments in the details for all the tickets.

      /tickets/ticket/details/comment[2] specifies the second comment for each ticket.

      /tickets/ticket[2]/details/comment specifies all the comments for the second ticket.

    • Use Child Named to specify the name of an element that is a child of the element (or elements) that you want to extract. If the child element has a value, you can narrow the results by specifying that value using Value.

      • Child Named works for only one level of child elements. The filter only returns the direct parent of the child element that you specify.
      • Value is intended for brief values. The value that you type there must be an exact match of the value of the child element of the element that you want to extract.

    • Using Attribute Named, specify the name of an attribute that is unique to the element you want to extract. To further narrow the results, you can give a value of the attribute for Value.

    Example: 

    # xml
# requires another step
base.xml.xpath_query:
  - xml_document: ${output1}
  - xpath_query: <query>
  - query_type: <node|nodelist>
  • ClosedXML Get Element Value

    XML Get Element Value enables you to get the value of a specific element.

    Use Element Path to specify the path to the element whose value you're interested in.

    As with the other filters, if there are multiple instances of an element, the filter returns the first one, unless you specify a different instance.

    Example: 

    # xml
# requires another step
base.xml.xpath_query:
  - xml_document: ${output1}
  - xpath_query: <query>
  - query_type: <node|value|nodelist>
  • ClosedXPath Query

    XPath Query enables you to extract data from the result with queries that use the standard XPath syntax, which you define for XPath Query .

    • The path that precedes the square brackets identifies the scope of the query with which you are narrowing the results.
    • Square brackets contain the filtering portion of the query. There can be more than one set of filters in a query.

    Example: 

    # xml
# requires another step
base.xml.xpath_query:
  - xml_document: ${output1}
  - xpath_query: <query>
  - query_type: <node|value|nodelist>

Send Help Center feedback