RPA.Robocloud.Items

NOTE: Files are not uploaded before work item is saved

Examples

*** Tasks ***
Add work item file    output.xls
Save work item

Examples

*** Tasks ***
Add work item files    %{ROBOT_ROOT}/generated/*.csv
Save work item

Examples

*** Tasks ***
Clear work item
Save work item

An output work item is always created as a child for an input item, and as such requires an input to be loaded.

All changes to the work item are done locally, and are only sent to the output queue after the keyword Save work item is called.

Examples

*** Tasks ***
${customers}=    Load customer data
FOR    ${customer}    IN    @{customers}
    Create output work item
    Set work item variables    name=${customer.name}    id=${customer.id}
    Save work item
END

Examples

*** Tasks ***
Delete work item variables    username    email
Save work item

Automatically collects and returns a list of results, switch _collect_results to False for avoiding this.

Examples

*** Tasks ***
Log Payloads
    @{lengths} =     For Each Input Work Item    Log Payload
    Log   Payload lengths: @{lengths}

*** Keywords ***
Log Payload
    ${payload} =     Get Work Item Payload
    Log To Console    ${payload}
    ${len} =     Get Length    ${payload}
    [Return]    ${len}

OR

*** Tasks ***
import logging
from RPA.Robocorp.WorkItems import WorkItems

library = WorkItems()

def log_payload():
    payload = library.get_work_item_payload()
    print(payload)
    return len(payload)

def log_payloads():
    library.get_input_work_item()
    lengths = library.for_each_input_work_item(log_payload)
    logging.info("Payload lengths: %s", lengths)

log_payloads()

Returns a list of results.

The current work item is used as the target by other keywords in this library.

Keywords Get input work item and Create output work item set the active work item automatically, and return the created instance.

With this keyword the active work item can be retrieved manually.

Examples

*** Tasks ***
${input} =    Get Current Work Item
${output} =   Create Output Work Item
Set Current Work Item    ${input}

Load the next work item from the input queue, and set it as the active work item.

Each time this is called, the previous input work item is released (as DONE) prior to reserving the next one. If the library import argument autoload is truthy (default), this is called automatically when the Robot Framework suite starts.

Get attached file from work item to disk. Returns the absolute path to the created file.

Examples

*** Tasks ***
${path}=    Get work item file    input.xls
Open workbook    ${path}

Get files attached to work item that match given pattern. Returns a list of absolute paths to the downloaded files.

Examples

*** Tasks ***
${paths}=    Get work item files    customer_*.xlsx
FOR  ${path}  IN  @{paths}
    Handle customer file    ${path}
END

NOTE: Most use cases should prefer higher-level keywords.

Examples

*** Tasks ***
${payload}=    Get work item payload
Log    Entire payload as dictionary: ${payload}

Return a single variable value from the work item, or default value if defined and key does not exist.

If key does not exist and default is not defined, raises KeyError.

Examples

*** Tasks ***
${username}=    Get work item variable    username    default=guest

Read all variables from the current work item and return their names and values as a dictionary.

Examples

*** Tasks ***
${variables}=    Get work item variables
Log    Username: ${variables}[username], Email: ${variables}[email]

Examples

*** Tasks ***
${names}=    List work item files
Log    Work item has files with names: ${names}

Examples

*** Tasks ***
${variables}=    List work item variables
Log    Available variables in work item: ${variables}

This can be released with DONE or FAILED states. With the FAILED state, an additional exception can be sent to Control Room describing the problem that you encountered by specifying a type and optionally a code and/or message. After this has been called, no more output work items can be created unless a new input work item has been loaded again.

Examples

*** Tasks ***
Login into portal
    ${user} =     Get Work Item Variable    user
    Log     Logging in ${user}
    Release Input Work Item     FAILED      exception_type=BUSINESS   code=LOGIN_PORTAL_DOWN     message=Unable to login into the portal – not proceeding  # noqa

OR

*** Tasks ***
from RPA.Robocorp.WorkItems import State, WorkItems

library = WorkItems()

def process_and_set_state():
    library.get_input_work_item()
    library.release_input_work_item(State.DONE)
    print(library.current.state)  # would print "State.DONE"

process_and_set_state()

NOTE: Files are not deleted before work item is saved

Examples

*** Tasks ***
Remove work item file    input.xls
Save work item

Examples

*** Tasks ***
Remove work item files    *.xlsx
Save work item

Save the current data and files in the work item. If not saved, all changes are discarded when the library goes out of scope.

The current work item is used as the target by other keywords in this library.

Keywords Get input work item and Create output work item set the active work item automatically, and return the created instance.

With this keyword the active work item can be set manually.

Examples

*** Tasks ***
${input}=    Get input work item
${output}=   Create output work item
Set current work item    ${input}

Convert all variables in the current work item to Robot Framework task variables.

Examples

*** Tasks ***
# Work item has variable INPUT_URL
Set task variables from work item
Log    The variable is now available: ${INPUT_URL}

NOTE: Most use cases should prefer higher-level keywords.

Examples

*** Tasks ***
${output}=    Create dictionary    url=example.com    username=Mark
Set work item payload    ${output}

Examples

*** Tasks ***
Set work item variable    username    MarkyMark
Save work item

Examples

*** Tasks ***
Set work item variables    username=MarkyMark    email=mark@example.com
Save work item