The Desktop UI node is used to automate the user interface of any desktop applications like notepad, wordpad etc.

Familiarizing The Desktop Application

Jiffy UI automation framework allows user to automate user interface pages for any application. Consider a scenario of automating a Desktop application.

Creating A Desktop Application

To start with Desktop UI automation, the user must create a desktop application first. To create a desktop application, do the following:

1. Double-click on the Desktop UI node.

2. To create a new Desktop Application, click on the New Desktop Application radio button. Add the following details:

   • App: Type the Desktop URL to be automated.
   • App Name: Type the desired name of the desktop application.
   • Cluster: Select the required cluster from this drop-down. This is applicable only when the task is being executed using an Execution Bot

   Leave cluster name blank when the task is being executed using a [Developer BOT](/admin_guide/tenant-admin-activities/bot-management/developer-bots/).

3. Alternatively, select any existing desktop application in the Desktop Application drop-down if it matches the criteria of the user.

4. Click on the CREATE & RECORD button to create the desktop application and begin recording the desktop application.

   After the App and the Configuration are created, if the App name is Demo, the name of the Configuration name will be concatenated with the App name and type of UI automation. Eg: Demo_desktop.

Setting Up Desktop UI Configuration:

1. Double-click on the Desktop UI node and then click on the Configurations tab.

2. Click on the + icon to create a new configuration if required.

   Add the following details:

   • Configuration Name: Type a unique configuration name.
   • App: Select the Desktop UI related application from this drop-down.
   • Application Path: Path of the desktop application to be familiarized.
   • Clusters: Select the required cluster from this drop-down.

3. Alternatively, select any existing configuration in the Configuration drop-down if it matches the criteria of the user.

   The user can also edit, copy or delete the existing configuration by clicking on the Edit, Copy and Delete icons displayed against each configuration, respectively.

4. The created configuration will be listed in the Configuration tab.

Recording The Desktop Application

After creating the desktop application, the steps for automation need to be recorded. Recording can be either of the following ways:

1. Click on the RECORD button in the Configurations tab.
2. Click on the Start Recording button in the Actions tab.

3. Click on the CREATE & RECORD button while creating a new desktop application.

   The Developer Bot must be running while recording the desktop application. Read how to start the Developer Bot here.

   After the recording begins, a Jiffy UILearn tab opens. Do the following to continue with the recording:

4. On clicking the RECORD button, a floating window of Jiffy UILearn opens for recording the actions performed on the required fields in the desktop application based on the URL mentioned in the Configuration tab which will be captured as the UI controls.
   

   Make sure that the desktop application to be recorded is open before starting the recording. The UI Learn floating window can be minimized, maximized and closed using the buttons provided on the right top corner of the Jiffy UILearn floating window.

5. Give a name for the Screen Ex: Screen1

6. Learn the UI elements by placing the mouse pointer on the required field and then pressing the ctrl key. The selected UI element will be highlighted in Red colour.

   For the Notepad app, click on Save As button to save the notepad and then in the file explorer, click on the Name text field and the Save button to save the note.

7. The controls familiarized will be listed under the Screen1 screen. The names and actions of the controls can be edited as required.

8. Click on the Stop Recording button on the Jiffy UILearn floating window after recording is completed.

9. Edit the lines of action that are recorded to finetune the performance of the desktop application as required. Read how to Design the desktop application.

Properties Of Desktop UI Node

General Properties

1. Name: Name of the node. A default name is displayed in this field, which the user can edit according to the task and the intent of using the node.
2. Description: A short note on the purpose of the node.
3. Close Application: After completion of Desktop UI run, then it will close the Desktop Application that is launched during the execution of the task when the Close Application toggle button is in ON state. When the user wants to retain a Desktop Application to perform actions on it, then select the Close Application toggle button must be in OFF state.
4. Close Application on Error: If it is ON, then the desktop application or Desktopsite which is launched during execution will close in case of any error in the flow of execution.
5. Mark run Failure on Node Fail: When the Mark run Failure on Node Fail field is ON, if the node execution fails then the complete task execution is marked as fail.
6. Continue on Failure: When the Continue on Failure field is ON, even if the node fails, the execution will continue to the next node. When the Continue on Failure field is OFF, if the node fails, the execution will not continue to the next node.

Advanced Properties

1. Run Mode: The user can select any one of the following options from the Run Mode drop-down:
   1. Run if locked: The task runs even if the machine is locked.
   2. Unlock and run: Unlocks the machine and runs the task.
2. Lock After Run: Locks the machine after the node execution.
3. Take Screen Shots: The user can select either Always or On Error option.
   • If the user selects Always, then the user can see the screenshot of every UI event step output in the form of images (Desktop Application) after a run.
   • If the user selects On Error, the user can see the screenshot of the step which is failed. In case of any popup messages or any crash on the desktop application, the user can identify it from the screenshot. These images can be passed to next node for further use.
   • If the user selects Off, no screenshots will be taken during the execution.