Desktop

Desktop



Desktop

Windows Desktop plugin steps are used for Windows Desktop applications automation.

Prerequisites:

  1. Windows Operating System
  2. Install jdk and set JAVA_HOME, JRE_HOME environment variables.
  3. Windows .NET framework 4.6 and above
  4. Process studio distribution full path name should not have any spaces.
  5. Chrome browser is required to run DesktopSpy for AE releases prior to 5.4.0
  6. License is required to run DesktopSpy and Desktop plugins. License can be acquired and applied by contacting AutomationEdge Inc. A description on how to Apply License is in the section below.
  7. Desktop Plugin in Release 1.3 is compatible with AutomationEdge Release 5.4.0 onwards. For applet support WebGUI Plugin1.3 is also required. Applet automation technology only works with the IE browser.
  8. Plugins1.2 and 1.3 with AutomationEdge R5.3.0 needs an extra external jar file. Please contact AutomationEdge Support for the same.
  9. Plugins1.2 and 1.3 with AutomationEdge below R5.3.0 needs multiple extra external jar files, hence not recommended.


Desktop: Apply Licence

Apply Desktop Plugins License to Process Studio

  1. Once you get the license file copy or replace it in the following locations.
  1. Process-Studio-distribution/psplugins/DesktopPlugins/desktop-engine/userdata/config(For Plugins)
  2. Process-Studio-distribution/psplugins/DesktopPlugins/desktop-spy/userdata/config (for Spy) on your local environment.
  1. Restart Process-studio and you are good to go.



  Note:

If the folders above are not present then follow the below steps:

  1. If Process-Studio-distribution/psplugins/DesktopPlugins/desktop-engine/userdata/config” is not present, run sample desktop workflow and the folder is created.
  2. If “Process-Studio-distribution/psplugins/DesktopPlugins/desktop-

spy/userdata/config(for Spy)” is not present,

Navigate to tools -> Spy -> Desktop Spy. This opens Desktop Spy and the folder is created.


Apply Desktop Plugins License to Agents

  1. Once you get the license file copy or replace it in the following location,
  1. Agent Home/psplugins/DesktopPlugins/desktop-engine/userdata/config


  Note:

If the folder above is not present then follow the below step:

  1. If Agent Home/psplugins/DesktopPlugins/desktop-engine/userdata/config” is not present, first import any desktop workflow and assign the workflow to the agent


Setup:

Process Studio DesktopSpy is used to get many of the configuration parameters of Desktop plugin steps. To be able to use DesktopSpy we need to configure Process Studio Options Desktop SPY Port and Desktop Runtime Port. This is shown in the snapshots below.

  1. In Process Studio go to Tools menu and Options sub-menu. 


  1. Set or change Desktop SPY Port and Desktop Runtime Port if required or leave it to the default values. 


  1. You are now ready to start using DesktopSpy with Desktop Plugins.
  2. Please refer Appendix 8: Desktop Spy Tutorial for complete steps to identify element locators by extracting Windows element attributes.

Limitation: Any type of UI Automation with Desktop plugin steps is not supported in Linux based OS.

Following is a description of the Desktop plugin steps.

Desktop Click

Description

The step is used to perform click action on a Windows Desktop application element.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Prefix

Prefix is populated when working with popup windows and multiple domains.  Prefix is meant to get an identifier for an instance of an application.

This field must be provided if it is returned by Desktop Spy. If Prefix is not returned by Desktop Spy it should be left blank.

If prefix is blank it assigns a default prefix.

3

Accessor/Alternative

Accessor is a Windows Desktop application element identifier for a selected prefix above.  This field is populated with Accessor or alternative Accessor.

In case the Prefix field is blank it uses the default prefix.

4

Click Type

Click Type has three options:

  1. Single Click
  2. Double Click and
  3. Right Click

5

Mode

Select ‘WINDOWS’ or ‘JAVA_APPLET’ from the drop down list.

Generally WINDOWS mode is used for .Net Windows-based applications while JAVA_APPLET is used for applet based applications(e.g. Oracle E-business suite application)


Desktop Close

Description

The step is used to close the current Windows Desktop application element.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Prefix

Prefix is populated when working with popup windows and multiple domains. Prefix is meant to get an identifier for an instance of a windows application. 

This field must be provided if it is returned by Desktop Spy. If Prefix is not returned by Desktop Spy it should be left blank.

If prefix is blank it assigns a default prefix.

3

Mode

Select ‘WINDOWS’ or ‘JAVA_APPLET’ from the drop down list.

Generally WINDOWS mode is used for .Net Windows-based applications while JAVA_APPLET is used for applet based applications(e.g. Oracle E-business suite application)


Desktop Highlight

Description

The step is used to highlight an element on a Windows Desktop Application.  This step is also useful during Process Studio Workflow development and debugging.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Prefix

Prefix is populated when working with popup windows and multiple domains.  Prefix is meant to get an identifier for an instance of an application.

This field must be provided if it is returned by Desktop Spy. If Prefix is not returned by Desktop Spy it should be left blank.

If prefix is blank it assigns a default prefix.

3

Accessor/Alternative

Accessor is a Windows Desktop application element identifier for a selected prefix above.  This field is populated with Accessor or alternative Accessor.

In case the Prefix field is blank it uses the default prefix.

4

Mode

Select ‘WINDOWS’ or ‘JAVA_APPLET’ from the drop down list.

Generally WINDOWS mode is used for .Net Windows-based applications while JAVA_APPLET is used for applet based applications(e.g. Oracle E-business suite application)



Desktop MouseAction

Description

The step is used to perform Mouse Actions on Windows Desktop application elements.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Prefix

Prefix is populated when working with popup windows and multiple domains.  Prefix is meant to get an identifier for an instance of an application.

This field must be provided if it is returned by Desktop Spy. If Prefix is not returned by Desktop Spy it should be left blank.

If prefix is blank it assigns a default prefix.

3

Accessor/Alternative

Accessor is a Windows Desktop application element identifier for a selected prefix above.  This field is populated with Accessor or alternative Accessor.

In case the Prefix field is blank it uses the default prefix.

4

MouseAction Type

Choose a value from the drop down list from the following values.

  1. Drag & Drop
  2. Mouse Hover

5

Destination prefix

If Drag & Drop is chosen above Destination prefix becomes active. Provide a value for the destination elements prefix.

6

Destination Accessor/Alternative

If Drag & Drop is chosen above Destination Accessor/Alternative also becomes active. Provide a value for the destination elements Accessor/Alternative.

7

Mode

Select ‘WINDOWS’ or ‘JAVA_APPLET’ from the drop down list.

Generally WINDOWS mode is used for .Net Windows-based applications while JAVA_APPLET is used for applet based applications(e.g. Oracle E-business suite application)


Desktop Open

Description

The step is used to open a Windows Application.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Prefix

In this plugin Prefix is usually the title for the application window.

If we need to specify a wait time for an application window (with a specified prefix) to open then provide values in prefix as well as Windows load timeout field below. Both are mandatory.


Note: If the application window with the specified prefix is already open or not found in the provided time then the step as well as workflow fails.

2

Path of Application

Provide the full path of the Windows Desktop Application executable.

3

Windows load timeout

This is maximum time provided after opening the application to load application window elements.

4

Mode

Select ‘WINDOWS’ or ‘JAVA_APPLET’ from the drop down list.

Generally WINDOWS mode is used for .Net Windows-based applications while JAVA_APPLET is used for applet based applications(e.g. Oracle E-business suite application)


Desktop Read

Description

The step is used to read value of any element on the Windows Application.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Prefix

Prefix is populated when working with popup windows and multiple domains.  Prefix is meant to get an identifier for an instance of an application.

This field must be provided if it is returned by Desktop Spy. If Prefix is not returned by Desktop Spy it should be left blank.

If prefix is blank it assigns a default prefix.


Read Parameter Tab:

No.

Field Name

Description


Input Fields:


1

Accessor/Alternative

Accessor is a Windows Desktop application element identifier for a selected prefix above.  This field is populated with Accessor or alternative Accessor.

In case the Prefix field is blank it uses the default prefix.

2

Read Type

Read Type can be Text or Value depending on the element type. (For e.g. for Button Label Read Type is text and for field Read Type is value).

3

Output

Provide a name of a field to store the value read.

4

Mode

Select ‘WINDOWS’ or ‘JAVA_APPLET’ from the drop down list.

Generally WINDOWS mode is used for .Net Windows-based applications while JAVA_APPLET is used for applet based applications(e.g. Oracle E-business suite application).


Desktop Start

Description

This step is a start node to be able to use any succeeding Desktop plugin steps in a workflow.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Start node

Enable the checkbox if this step is the first step in the workflow.

3

Applet Support

Enable checkbox for Applet support in the workflow.

4

Open Application  

If this checkbox is enabled the three fields below are also enabled else the three fields below are disabled.


If this checkbox is disabled this step is used to simply starts Desktop plugin driver.

However, If this checkbox is enabled it starts Desktop plugin driver. Additionally, the step can be used to open any Windows Application.

5

Prefix

Prefix is populated when working with popup windows and multiple domains. Prefix is meant to get an identifier for an instance of an application window. Prefix is usually the title for the application window.

This field must be provided if it is returned by Desktop Spy. If Prefix is not returned by Desktop Spy it should be left blank.

If prefix is blank it assigns a default prefix.


If we need to specify a wait time for an application window (with a specified prefix) to open then provide values in prefix as well as Windows load timeout field below. Both are mandatory.


Note: If the application window with the specified prefix is already open or not found in the provided time then the step as well as workflow fail. 

6

Path of Application

Provide the full path of the Windows Desktop Application executable

7

Windows load timeout(in millisecond)

This is maximum time provided after opening the application to load application window elements.

8

Mode

Select ‘WINDOWS’ or ‘JAVA_APPLET’ from the drop down list.

Generally WINDOWS mode is used for .Net Windows-based applications while JAVA_APPLET is used for applet based applications(e.g. Oracle E-business suite application)



Desktop Stop

Description

The step is used to stop Desktop plugin engine.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Desktop Utilities

Description

The step is used to check the status of Desktop utilities.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Prefix

Prefix is populated when working with popup windows and multiple domains.  Prefix is meant to get an identifier for an instance of an application.

This field must be provided if it is returned by Desktop Spy. If Prefix is not returned by Desktop Spy it should be left blank.

If prefix is blank it assigns a default prefix.

3

Accessor/Alternative

Accessor is a Windows Desktop application element identifier for a selected prefix above.  This field is populated with Accessor or alternative Accessor.

In case the Prefix field is blank it uses the default prefix.

4

Utilities Type

Select a value from the drop down list.

  1. Exists
  2. Is Checked
  3. Is Enabled
  4. Is Visible
  5. Application Exists

5

Output

Provide a field name to store the value of output. This is a Boolean value.

6

Mode

Select ‘WINDOWS’ or ‘JAVA_APPLET’ from the drop down list.

Generally WINDOWS mode is used for .Net Windows-based applications while JAVA_APPLET is used for applet based applications(e.g. Oracle E-business suite application)



Desktop WaitUntil 

Description

The Desktop WaitUntil step waits until a desktop application window is open or exists or element is present, visible, checked or enabled on the desktop application window in Desktop automation. The maximum wait time is until the timeout specified. The Desktop WaitUntil step can also wait for reverse of the above conditions.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow. 

2

Prefix

Prefix is populated when working with popup windows and multiple domains.  Prefix is meant to get an identifier for an instance of an application.

This field must be provided if it is returned by Desktop Spy. If Prefix is not returned by Desktop Spy it should be left blank.

If prefix is blank it assigns a default prefix.

3

Accessor/Alternative

Accessor is a Windows Desktop application element identifier for a selected prefix above.  This field is populated with Accessor or alternative Accessor.

In case the Prefix field is blank it uses the default prefix.

4

Wait until condition

Specify the wait condition for the element.


Application Exists

Check if an Application with specified Prefix exists.

Exists

Check if element with specified Prefix and Accessor/Alternative exists. 

Is Visible

Check if element with specified Prefix and Accessor/Alternative is visible.

Is Checked

Check if element with specified Prefix and Accessor/Alternative is checked.

Is Enabled

Check if element with specified Prefix and Accessor/Alternative is enabled.


5

reverse of above condition

Enable checkbox to check the reverse of the above conditions. In other words it checks the following, 


Application does not Exists

Check if an Application with specified Prefix does not exist.

Not Exists

Check if element with specified Prefix and Accessor/Alternative does not exist. 

Is Not Visible

Check if element with specified Prefix and Accessor/Alternative is not visible.

Is Not Checked

Check if element with specified Prefix and Accessor/Alternative is not checked.

Is Not Enabled

Check if element with specified Prefix and Accessor/Alternative is not enabled.


6

Timeout (in seconds)

Maximum time in seconds to wait for the expected wait until condition else to timeout and fail the step.

7

Mode

Select ‘WINDOWS’ or ‘JAVA_APPLET’ from the drop down list.

Generally WINDOWS mode is used for .Net Windows-based applications while JAVA_APPLET is used for applet based applications(e.g. Oracle E-business suite application)



Desktop Write

Description

The step is used to write text in a windows desktop application.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Prefix

Prefix is populated when working with popup windows and multiple domains.  Prefix is meant to get an identifier for an instance of an application.

This field must be provided if it is returned by Desktop Spy. If Prefix is not returned by Desktop Spy it should be left blank.

If prefix is blank it assigns a default prefix.


Write Parameter Tab:

No.

Field Name

Description


Fields:


1

Accessor/Alternative

Accessor is a Windows Desktop application element identifier for a selected prefix above.  This field is populated with Accessor or alternative Accessor.

In case the Prefix field is blank it uses the default prefix.

2

Write Type

Write Type can be Set New Text or Append Text depending on the activity required. 

3

Input Text

Provide the Text to be set as New Text or to Append.

4

Mode

Select ‘WINDOWS’ or ‘JAVA_APPLET’ from the drop down list.

Generally WINDOWS mode is used for .Net Windows-based applications while JAVA_APPLET is used for applet based applications(e.g. Oracle E-business suite application)




      Links to better reach 

            Bot Store

             EPD