Common Android Journey Steps

Common Android Journey Steeps can be used to create reusable Android Journey Steps that are used both across multiple Android Journey Checks and within multiple steps within a single Android Journey Check. These help reduce duplication and ease management of common steps within journeys such as logging in or accepting policies.

Adding Common Android Journey Steps

Common Android Journey Steps are able to be programmatically configured using the REST API and Terraform Provider as well as manually through the web console. This guide will go through adding a Common Android Journey Step through the web console.

Login to Web Console and select Android Journey Steps from the main menu under Common Check Steps.
Click Add located towards the top left of the web console.
The Create Common Android Journey Step window should now show. Definitions for each field can be found below under Configuration Definitions.
Click Close on any remaining open attribute windows, then click Save to save the new Common Android Journey Step itself.
Confirmation of the Common Android Journey Step successfully being added will show in the bottom-right notification area of the web console. The Common Step will be available immediately to use in any new or existing Android Journey Checks.

Amending Common Android Journey Steps

Common Android Journey Steps are able to be programmatically configured using the REST API and Terraform Provider as well as manually through the web console. This guide will go through amending a Common Android Journey Step through the web console.

Login to Web Console and select Android Journey Steps from the main menu under Common Check Steps.
Click Edit on the row of the Common Android Journey Step to amend.
The list of Common Android Journey Steps shown can be filtered by name or description using the search bar.
The Edit Common Android Journey Step window should now be shown.

Amend the step as required. Definitions of all the configuration options available are defined below.
Click Close on any remaining open attribute windows, then click Save to save the new Common Android Journey Step itself.
Confirmation of the Common Android Journey Step successfully being updated will show in the bottom-right notification area of the web console. Any checks in flight using the Common Android Journey Step will continue to use the previous configuration.

Removing Common Android Journey Steps

Common Android Journey Steps can not be removed if they're configured in any existing checks, enabled or not.

Login to Web Console and select Android Journey Steps from the main menu under Common Check Steps.
Click Remove on the row of the Common Android Journey Step to amend.
The list of Common Android Journey Steps shown can be filtered by name or description using the search bar.
Click Remove to confirm you want to delete the selected Common Android Journey Step.
Providing the Common Android Journey Step was not linked to any existing Android Journey Checks, it will now be deleted. Confirmation of this will be shown in the bottom-right notification area of the web console.
If the Common Android Journey Step was linked to an existing check, a popup error will be shown informing the common step could not be removed for this reason.

Android Journey Step Configuration Definitions

Name	Description
Name	A name to identify the common step by. This is used when searching for the step, and also in any alert notifications should the step fail.
Description	Space to provide a longer description of what the common step is doing or for any other additional information needing to be communicated.
Step Wait Time	The number of milliseconds to wait before starting the step. It can be useful to provide some time to allow the app to continue completing actions from the previous step or to finish any network requests made.
Step Checks	List of things to check on the against what the app is currently displaying. See Step Check Configuration for details.
Step Actions	List of actions to make within the app being checked, such as clicking or swiping. See Step Action Configuration for details.

Step Check Configuration Definitions

Name	Description
Description	Space to provide context of what the Step Check is doing. This is used on alerts and notifications should this check fail.
Check Type	The type of check this Step Check is to take. See Step Check Types below.
Warning Only	Toggle this on to indicate that if the Step Check fails, that it will only produce a warning and not fail the whole Android Journey check.
Attributes	Click Show to edit the specific details of the Step Check. These details will change for the given Check Type. See Step Check Type Attributes for details.

Step Check Types

Name	Description
Check for text	Check that a specific string of text is showing or not showing at this point in the journey.
Check for element	Check that specific display element is present or not present at this point in the journey. This can be useful when using a simple search by text isn't suffice. What elements are available will also be caught in the 'Captured DOMs' within the Check Results.

Step Check Type Attributes

Check Type	Name	Description
Check for text	Text To Find	The text to search for on the app display at this point in the journey.
Check for text	State	Define if the Text To Find should be present or absent from the app display.

Check for element	XPath To Find	The xpath to use to locate the element to check. If the xpath returns multiple elements, the first will be used. Using the 'Captured DOMs' in the Check Result History can help in forming the required xpath.
Check for element	Component ID	The component id of the element to check. Within the 'Captured DOMs' output, this wil be displayed as the `resource-id`. When giving the component id, the package name prefix should not be provided. For example, you may see a `resource-id` of `resource-id="com.myapplication.package:id/action_bar_root"`, so the component id here is just `action_bar_root`.
Check for element	Component Type	For future use, currently will do nothing.
Check for element	State	Present - The element searched for should be found on the current page. Absent - The element searched for should not be found on the current page.
Check for element	Object Attribute Name	Check that the found element has the given attribute name. Not applicable if the State is set to Absent.
Check for element	Object Attribute Value	Check that the attribute given in Object Attribute Name has this value.

Step Action Configuration Definitions

Name	Description
Interaction Description	Space to provide a description of what the action is doing. If the action failed, this will be what is described in the alert or notification.
Action	The type of action to perform. Descriptions of these can be found under Step Action Definitions.
Always Required	If this is toggled on, the action must always be able to run during the check. If toggled off then if it failed, it's failure will be ignored, allowing for optional actions such as closing intermittent popups.
Settings	Click Show to provide further details for the action to run, such as the element to click on or the text to enter. Definitions of these options can be found under Action Settings Definitions.

Step Action Definitions

Name	Description
Click	A single tap on an element being displayed. This should target tapping on the center of the element found by the criteria given.
Input Text	Enter text into a component within the app.
Input Password	The same as Input Text, however the text to input is encrypted as rest and also prevented from showing in other areas such as notifications and exports.
Save View Hierarchy	Save the current view hierarchy, which is an XML representation of what is currently displayed on the app. More info: https://developer.android.com/studio/profile/hierarchy-viewer
Rotate Display	Rotate the virtual device running the check between portrait and landscape. If the app being checked doesn't support the target orientation, this will always fail.
Scroll To Element	Scroll to bring an element on the current display into view.
Swipe	Perform a single finger swipe across a specified element or the whole screen in a given direction.
Take Screenshot	Save a screenshot of what is currently displayed on the virtual device running the check.
Wait	Wait for a given number of milliseconds. This can be useful if needing to add a pause between any actions that is longer than the default 500ms pause.

Action Settings Definitions

Action	Name	Description
Click	Component Id	The component id of the element to click/tap. Within the 'Captured DOMs' output, this wil be displayed as the `resource-id`. When giving the component id, the package name prefix should not be provided. For example, you may see a `resource-id` of `resource-id="com.myapplication.package:id/action_bar_root"`, so the component id here is just `action_bar_root`.
Click	Xpath	The xpath of the component to click/tap. Using the 'Captured DOMs' output in the Check History can help identify the components available.
Click	Search Text	The simplest option available is to just search for specific text on the display to click/tap on.

Input Text	Component Id	The component id of the element to identify where to input the text. Within the 'Captured DOMs' output, this wil be displayed as the `resource-id`. When giving the component id, the package name prefix should not be provided. For example, you may see a `resource-id` of `resource-id="com.myapplication.package:id/action_bar_root"`, so the component id here is just `action_bar_root`.
Input Text	Xpath	he xpath of the component to identify where to input the text. Using the 'Captured DOMs' output in the Check History can help identify the components available.
Input Text	Input Text	The text to input.

Password Input	Component Id	The component id of the element to identify where to input the password. Within the 'Captured DOMs' output, this wil be displayed as the `resource-id`. When giving the component id, the package name prefix should not be provided. For example, you may see a `resource-id` of `resource-id="com.myapplication.package:id/action_bar_root"`, so the component id here is just `action_bar_root`.
Password Input	Xpath	he xpath of the component to identify where to input the password. Using the 'Captured DOMs' output in the Check History can help identify the components available.
Password Input	Input Password	The password to input. This will be encrypted where stored, and not shown in any notifications or configuration.

Rotate Display	Rotate Orientation	The orientation to move the display to. The app being checked must support the given orientation or the action will fail.

Swipe	Component Id	The component id of the element to start the swipe action from within. The actual start position will be the extreme opposite side of the swipe direction, e.g. if swiping right, the swipe will start on the extreme left of the component given.
Swipe	Xpath	The xpath of the component to start the swipe action from within. The actual start position will be the extreme opposite side of the swipe direction, e.g. if swiping right, the swipe will start on the extreme left of the component given.
Swipe	Swipe Start Coordinates	The specific x,y screen coordinates to start the swipe from. This can be used as an alternative to needing to identify a component to swipe from.
Swipe	Swipe Direction	The direction in which the swipe will happen.
Swipe	Swipe Length	The distance the swipe action should travel across the screen in pixels. If this distance results in the swipe travelling off the screen, the action will fail.

Wait	Wait Time	The number of milliseconds to wait before continuing onto the next action or Android Journey Step if it's the last action to run.