_actions

class appian_locust._actions._Actions(interactor: appian_locust._interactor._Interactor)

Bases: appian_locust._base._Base

get_action(action_name: str, exact_match: bool = False) → Dict[str, Any]

Get the information about specific action by name.

Parameters:

  • action_name (str) – Name of the action

  • exact_match (bool) – Should action name match exactly or to be partial match. Default : True

Returns (dict): Specific Action’s info

Raises: In case of action is not found in the system, it throws an “Exception”

Example

If full name of action is known, with the opaque ID,

>>> self.appian.action.get_action("action_name:igB0K7YxC0UQ2Fhx4hicRw...", exact_match=True)

If only the display name is known, or part of the display name

>>> self.appian.action.get_action("action_name")
>>> self.appian.action.get_action("actio")
get_actions_feed(locust_request_label: str = 'Actions.Feed') → Dict[str, Any]
get_actions_interface(locust_request_label: str = 'Actions') → Dict[str, Any]
get_actions_nav(locust_request_label: str = 'Actions') → Dict[str, Any]
get_all(search_string: str = None, locust_request_label: str = 'Actions') → Dict[str, Any]

Retrieves all the available “actions” and associated metadata from “Appian-Tempo-Actions”

Note: All the retrieved data about actions is stored in the private variable self._actions

Returns (dict): List of actions and associated metadata

Examples

>>> self.appian.action.get_all()
start_action(action_name: str, skip_design_call: bool = False, exact_match: bool = False) → requests.models.Response

Perform the post operation on action’s API to start specific action. Actions that do not have a UI can be called directly without using “GET” to retrieve the UI. this is controlled by the optional skip_design_call parameter

Parameters:

  • action_name (str) – Name of the action

  • skip_design_call (bool, optional) – to skip the “GET” call for the action’s UI. Default : False

  • exact_match (bool, optional) – Should action name match exactly or to be partial match. Default : True

Returns: NONE

Example

>>> self.appian.action.start_action("action_name")
visit(action_name: str, exact_match: bool = False, label: str = '') → Dict[str, Any]

This function calls the API for the specific action to get its “form” data

Parameters:

  • action_name (str) – Name of the action to be called. Name of the action will be in the below pattern. “displayLabel::opaquqId”

  • exact_match (bool, optional) – Should action name match exactly or to be partial match. Default : True

Returns (dict): Response of actions’s Get UI call in dictionary

Examples

If the full name of the action is known, with the opaque ID,

>>> self.appian.action.visit("action_name:igB0K7YxC0UQ2Fhx4hicRw...", exact_match=True)

If only the display name is known, or part of the display name

>>> self.appian.action.visit("action_name")
>>> self.appian.action.visit("actio")
visit_and_get_form(action_name: str, exact_match: bool = False, locust_request_label: str = '') → appian_locust.uiform.SailUiForm

Gets the action by name and returns the corresponding SailUiForm to interact with

If the action is activity chained, this will attempt to start the process and retrieve the chained SAIL form.

Parameters:

  • action_name (str) – Name of the action

  • exact_match (bool) – Should action name match exactly or to be partial match. Default : True

  • locust_request_label (str, optional) – label to be used within locust

Returns: SailUiForm