Though Qualitia covers most of the actions required for automation testing, there might still be a need to add some more actions to Qualitia based on the project requirements. Qualitia allows you to develop your own actions and make them available to use while automating test cases for the application under test.  

The custom action module allows you to develop and maintain these actions in a convenient way.  

This module provides:

• A guided and easy to follow guidelines to develop custom actions,
• Make code templates, required dependencies, and sample codes easily available to anyone who can create custom actions,
• Maintain the custom action code just like you maintain tasks and test cases using a version control tool like SVN or Git, and
• Share these custom actions with other project members for use.

Working with Custom Actions for Web and Mobile Projects

After you import all your existing custom actions in Qualitia, you can now create, modify, search, or view the custom action codes in Qualitia automation studio itself. In the cases of multi user scenario, you can share these actions easily with other team members just as you share your tasks and test cases.

Also, any of the project members can update the code using an Eclipse IDE based on the requirements. You can launch an Eclipse IDE from Qualitia automation studio itself.

Importing Existing Custom Actions Created in Previous Qualitia Versions

If you have created custom actions using a Qualitia version before v7.0.0, then you can import your existing set of custom actions into Qualitia. Importing custom actions is simple 3 step process.

Creating a Custom Action for a Web/Mobile Project

Pre-Requisites

Before you start creating custom actions in Qualitia, ensure you meet the following prerequisites 

• Eclipse IDE for Java Developers (Version 2019-03 recommended)
• JDK version 1.8 and JRE version 1.8
   Both JDK and JRE are bundled with the above Eclipse IDE version. 
• Custom Action Developer privileges in Qualitia
• Set Eclipse Path under Project Settings
• Add multiple jar files under Project Settings

Creating New Custom Actions

If you have existing set of custom actions which you are using while developing test cases and tasks, you must import them in Qualitia.

For more information on importing existing custom action code in Qualitia, click here.

After you import the existing set of custom actions in Qualitia you can start creating new actions.

For newly created projects, you can start creating custom actions right-away. 

To create new custom action in Qualitia:

1. From the Expand Menu, click Develop.
2. Click the Custom Actions tab.
3. Click the Add Button (  ) or Create Custom Action button.
   The Custom Actions screen appears.
4. Select Base Class.
    The Custom Object Class file name including its file path should not exceed 256 characters when you are using Git/Bitbucket as a source control system for maintaining project artifacts.
5. Do one of the following:
   • To add a new Qualitia Class:
     1. Click the Plus button next to Custom Object Class to add a custom object class by mapping to the Qualitia Class that you want to add.
     2. Enter the java class file name without its extension along with the package name (if required), in Qualitia Class.
   • To select a pre-defined Qualitia Class that is mapped to a Custom Object Class:

     • From the Custom Object Class drop-down list, select a pre-defined custom object class.
       The associated Qualitia Class is selected automatically.

       Points To Know

       • For example, if you add a Qualitia Class "com.security.login", then this file creates a package and a java file called as "com.security" and "login.java" respectively.
       • The Custom Object Class is a user-friendly alternate name for a Qualitia Class, which you can specify.
       
       
       
6. Enter Action Name, Description and Function Name for the action to be created.
7. In the Properties section, click Add.
   A new line will be added in the grid.
8. Add Parameter Name, Description, ArgDataType for the parameter, and select whether this parameter is mandatory.
   1. To save the action, click Save.
   2. To save the action and launch the code template in Eclipse IDE, click Save and Launch Eclipse.
9. Close the Welcome on the IDE window to see your auto-generated custom action code template.
10. Import the pre-created Custom Action Java project workspace into Eclipse workspace.
     This is a one-time activity for a project.
    
    1. To import the pre-created workspace, right-click Package Explorer, and select Import from the context-menu.
    2. On the Import window, under the General section, select Existing Projects into Workspace and then click Next.
    3. In the Select root directory section, click the Browse button, select <PROJECTNAME>_QASJavaproject and click Finish.
       You will find this directory under Qualitia project path.
       
       
       
       
11. In Eclipse IDE, from the Window menu, select Preferences.
12. Select General > Workspace > Select Refresh using native hooks or polling.
13. Click Apply and Close.
14. Ensure you do not change the method signature and provide only the method body. Changing the signature in code may break your action in Qualitia.
15. In the editor, add the custom action code in the provided template for your custom action.
16. To add the dependent jars, do the following in the order listed:
    1. Add the dependent jar files in the lib folder under the project.
       
    2. Right-click the Project, point to Build Path, and then select Configure Build Path.
    3. Click Libraries > Add JARs.
    4. Under Jar Selection window, expand the Project folder.
    5. Under the lib folder, select the dependent Jar, and click Ok. 
    6. Click Apply and Close.
17. Build the project and close the Eclipse IDE.
    To work this custom action code in the Qualitia automation test cases, you must build the project successfully.
    You can now use this newly created custom action while developing task and test cases in Qualitia.

Recommendations and Rules for Custom Actions

Generic Recommendations

For creating the custom actions for Selenium Webdriver, you need to create the action in Java and then map the action into Qualitia Automation Studio. You can use any IDE tool like Eclipse.

The following are some rules that must be considered when creating custom actions:

• The parameter data types supported by Qualitia are String and Array. If an array parameter is used in Qualitia for the custom action, then custom action parameter should be of the type Object in Custom Action function. The parameter can then be type-casted into the data type which is required in the action.
  For example, the object parameter can be type-casted into the array list.

• Based on the standard Java coding rules, actions should not be created in the default package. For better maintenance, it is recommended to use user-defined packages for development.

• It is recommended to put a prefix when defining a name for new custom actions for easy identification.

• No two custom actions can have the same function name in the same class. Function overloading is not allowed. Duplicate function names in different classes are allowed (not recommended). 

• Once the action is mapped into Qualitia and used in a test case, do not change the existing signature or other details of the actions or the classes created. The functionality of the action can be modified. Do not delete the custom actions or custom classes that are used in test cases.

• If the custom action belongs to any object type (such as WebEdit, WebElement, and so forth), ensure you add the objectInfo data type parameter while developing the code of an action.

• While mapping actions into Automation Studio, it is important to map the action using <package.class> hierarchy. 

• Objects should be added under appropriate Qualitia classes while mapping custom actions into Qualitia Automation Studio

New Recommendations from Qualitia v8.0.0

Qualitia has come up with a new set of rules for creating custom actions in Qualitia 8.0.0 and later. If you have created custom actions to Qualitia version earlier than v8.0.0, then you must edit the existing ones with the following rules.

Making a New Class for Recommendations

You can create a custom class consisting of your custom actions. The newly generated class can be added in the same package as that of the already supported actions. 

You must ensure that in the test case, the ‘name’ and ‘qClass’ fields of action are set to the correct name of the action and class containing that action respectively. Qualitia now uses the concept of java reflection through which the action mentioned in ‘name’ and class mentioned in ‘qClass’ is called directly for action execution. The following example demonstrates how to make a new class for custom actions. 

package <QASpackagename>; 

import com.qualitia.execution.ActionResponse; 
 import com.qualitia.execution.ApplicationLogger; 
 import com.qualitia.models.testcase.ExecutionResult; 
 import com.webdriverfw.Wrappers.General; 

 <QASimportlist> 

 

 public class <QASclassname> extends General { 

 

 //Define your customs actions here 

 

 }

Writing Custom Actions in the Accepted Format

Qualitia now allows to write code for a custom in the following format. 

   package <QASpackagename>; 

import com.qualitia.execution.ActionResponse;   import com.qualitia.execution.ApplicationLogger;   import com.qualitia.models.testcase.ExecutionResult;   import com.webdriverfw.Wrappers.General; 

  <QASimportlist> 

  

  public class <QASclassname> extends General { 

  

  //Define your customs actions here 

  

  }

 public ActionResponse <QASmethodname>(<QASparametername>) { 

     

     ActionResponse actionResponse = getActionResponse(); 

     ApplicationLogger applicationLogger = actionResponse.getApplicationLogger(); 

     actionResponse.setExecutionResult(ExecutionResult.FAILED); 

     try { 

               // Your code here... 

             

           applicationLogger.writeToInfoLog(""); 

           actionResponse.setMessage("Successful message"); 

           actionResponse.setExecutionResult(ExecutionResult.PASSED); 

        } catch (Exception ex) { 

           applicationLogger.writeToErrorLog("Exception message", ex); 

           actionResponse.setMessage(“Failed Message”, FailureCategory); 

           actionResponse.setExecutionResult(ExecutionResult.FAILED); 

        } 

        return actionResponse; 

}  

As per the previous Qualita versions prior to v8.0.0 , the actions used to return integer value i.e 0,1,2,-1  which were used to indicate PASSED, FAILED, DEFECT, NOT-EXECUTED respectively .

The return value has been changed to ActionResponse. The actions return ActionResponse which contains 2 parameters Message and ExecutionResult. Before ActionResponse is returned during the execution of action, the required message and ExecutionResult must be set properly. The primitive datatypes allowed for action parameters are String and Array. 

ApplicationLooger

For actions specific to logs, you can use ApplicationLogger.  

• applicationLogger.writeToInfoLog(""); 

• applicationLogger.writeToErrorLog(""); 

The main purpose of ApplicationLogger is to create the ogs to understand the flow of execution. There are 2 types of logs supported for Qualitia: 

• Info Log

• Error Log

Show Link of File in Info Log Section 

Some custom actions need to write a file during its execution. You can view that file inside the Info Log of that custom action. If you want to view the file contents, then you can click the Link present in the Message section of Info. 

The following function needs to be called before returning Action Response to show the link of files inside the log section. 

showLinkOfFileInLogsSection(String sourceFilePath, ActionResponse actionResponse) 

The sourceFilePath denotes the file path you write during custom action execution, and actionResponse denotes the Action Response object. 

The Error logs must be in the catch block of Action. These logs can be seen in Qualitia report which is generated after the execution of the suite. 

Setting an Execution Result

While setting ExecutionResult, you can make use of ExecutionResult enum where the required results are available. 

• ExecutionResult.PASSED is used to set when the action is passed.

• ExecutionResult.FAILED is used to set when the action is failed. 

• ExecutionResult.DEFECT is used to set when the action has a defect. 

• ExecutionResult.NOT_EXECUTED is used to set when the action halts the execution.  

The message and ExecutionResult that has been set will appear in the final Qualitia report.

 Example:- 

Here is one brief example on writing custom Actions, showcasing how it was done in old version and how it is done in Qualitia 8.0.0 version. 

If you want to write a custom action for checking two strings are equal, you can do it as:  

In Older Versions before 8.0.0 :  

    public int EqualStrings(String a, String b)  

    {  

    if(a.equals(b))  

    {  

    DataLogger.writeToDebugAndInfoLogs("they are equal");  

    return 0;  

    }  

    else  

    {  

    DataLogger.writeToDebugAndInfoLogs("they are not equal");  

    return 1;  

    }  

    }  

  

    In Qualitia 8.0.0 Version :  

    public AcionResponse EqualStrings(String a, String b)  

    {  

    ActionResponse actionResponse = getActionResponse();  

    if(a.equals(b))  

    {  

    actionResponse.setMessage("they are equal");  

    actionResponse.setExecutionResult(ExecutionResult.PASSED);  

    return actionResponse;  

    }  

    else  

    {  

    actionResponse.setMessage("they are not                                                                                equal”,FailureCategories.Category.INVALID_DATA);  

    actionResponse.setExecutionResult(ExecutionResult.FAILED);  

    return actionResponse;  

    }  

    }

 Adding a Failure Category for a Custom Action

You can add a pre-defined failure category or create a custom category for a custom action.

For more information, refer to Real Time Reporting Portal .

You can add a new category and define new enum implementing Failure Calssification Interface as: 

package com.webdriverfw.Wrappers; 

 Import com.qualitia.execution.failureclassifications.FailureClassificatio; 

 public enum MyCategoriesEnum implements FailureClassification { 

    MY_CUSTOM_CATEGORY1("This is my custom category 1"), 

    MY_CUSTOM_CATEGORY2("This is my custom category 2"); 

  

    private String name; 

  

    MyCategoriesEnum(String s) { 

        name = s; 

    } 

   public String getCategory() { 

        return name; 

    } 

}   

 

 Use it in actions as: 

actionResponse.setMessage("message",FailureCategories.CustomCategory.NEW_CUSTOM_CATEGORY1);

 You can create a new  category as shown in the following: 

 1.) Using String :  

actionResponse.setMessage("message",FailureCategory.newCategory("Categoryname")); 

2.) Using String Constant : You can define constants to customize categories in a separate class. 

package com.webdriverfw.Wrappers; 

 public class MyCategoriesConstants { 

   public static final String MY_CUSTOM_CATEGORY3 = "This is my custom category 1"; 

    public static final String MY_CUSTOM_CATEGORY4 = "This is my custom category 2"; 

} 

Use it in actions as:- 

actionResponse.setMessage("message",FailureCategory.newCategory(MY_CUSTOM_CATEGORY3)); 

Qualitia Public APIs for Custom Actions

Qualitia has shared the APIs to create custom actions. Earlier, Qualitia used to provide with public static variables and methods.

Debugging a Custom Action

You need to download the TestHarness.Java file, and download and extract the Config Folder file.

To debug a custom action

1. Do in the following order listed to create necessary test artifacts:

   1. Create a test case and include the custom action that you want to debug at the appropriate step. For more information, refer to /wiki/spaces/T2/pages/2681539278

   2. From the test case editor, click Run to dry run the test case to verify whether the custom action is hit.

   3. Create a test suite that contains the test case. For more information, refer to Creating a Suite.

   4. Create an offline suite using the test suite. For detailed instructions, refer to Creating an Offline Package.

2. To add the required files for debugging the custom action:

   1. Open the custom action you want to debug in the Eclipse project.

   2. Add the TestHarness.Java file for the custom action in the Eclipse project.

   3. Add the Config Folder in the Eclipse project.

   4. In the config folder, open the startupSettings.json file, and specify the location of the offline suite for “SuitesDir”.
      For example: "SuitesDir":"D:/Qualitia Offline/Suite1"

3. Insert a breakpoint at an appropriate line number in the custom action.

4. Start debugging the TestHarness.Java file.

5. The test suite execution starts.
   When the custom action is executed, the execution stops at the breakpoint you have inserted.
   You can go ahead and debug the custom action.

Troubleshooting (Custom Action Module)

You might get following errors while importing custom actions in Qualitia automation studio. You must fix these errors to complete the import procedure. 

Import Custom Action Cannot be continue due to following errors;...

You will get this error in case the directory you have selected to import custom actions is missing one or more required sub-folders. 

Resolution:

To resolve this error, ensure you have selected the right directory to import custom actions and the selected directory has all the sub-folders created in it.

Updating Qualitia Project Path

After you change the project path in Qualitia, you must re-import the java project from the new directory into the existing java workspace.

To re-import the project:

1. Ensure you clone all the project data to the new directory.
   This includes Test cases, Tasks, Custom actions, and Java project folders (which hold all the latest custom action code).
2. Remove the existing project from the workspace.
3. To import the cloned java project from the new directory, right-click Package Explorer, and select Import from the context menu.
4. On the Import window, under the General section, select Existing Projects into Workspace and then click Next.
5. In the Select root directory section, click the Browse button, select <PROJECTNAME>_QASJavaproject and click Finish.
   This is in the new directory where you have cloned the Qualitia project data.
6. Select General > Workspace > Select Refresh using native hooks or polling.
7. Click Apply and Close.

Custom Action Custom Files are Not Pushed to Project Path GIT Repository

Problem: While editing or adding a custom action, if you encounter the following message:

“The method or operation is not implemented.”

Summary: This error occurs because the custom action class files are not pushed to the Project path GIT Repository.

Solution:

Perform the following steps:

1. Open the Eclipse Project.

2. Click Windows > Preferences > Teams > Git > Projects.

3. In the right side of the Preference dialog box, under Projects, deselect the Automatically ignore derived resources by adding them.gitignore checkbox.

Other Validations

While importing custom actions code into automation studio, Qualitia validates certain things. In case some files or code is missing, Qualitia gives the list of issues to fix to continue importing custom actions.

Here is the complete list of validations and resolutions to be done.

Once you have fixed all the errors mentioned above, you can continue importing custom actions in Qualitia. 

Working with Custom Actions for Desktop Projects

After you import all your existing custom actions in Qualitia, you can now create, modify, search, or view the custom action codes in Qualitia automation studio itself. In the cases of multi user scenario, you can share these actions easily with other team members just as you share your tasks and test cases.

Also, any of the project members can update the code using an Eclipse IDE based on the requirements. You can launch an Eclipse IDE from Qualitia automation studio itself.

Importing Existing Custom Actions Created in Previous Qualitia Versions

If you have created custom actions using a Qualitia version before v7.0.0, then you can import your existing set of custom actions into Qualitia. Importing custom actions is simple 3 step process.

Creating a Custom Action for a Web/Mobile Project

Pre-Requisites

Before you start creating custom actions in Qualitia, ensure you meet the following prerequisites 

• Eclipse IDE for Java Developers (Version 2019-03 recommended)
• JDK version 1.8 and JRE version 1.8
   Both JDK and JRE are bundled with the above Eclipse IDE version. 
• Custom Action Developer privileges in Qualitia
• Set Eclipse Path under Project Settings
• Add multiple jar files under Project Settings

Creating New Custom Actions

If you have existing set of custom actions which you are using while developing test cases and tasks, you must import them in Qualitia.

For more information on importing existing custom action code in Qualitia, click here.

After you import the existing set of custom actions in Qualitia you can start creating new actions.

For newly created projects, you can start creating custom actions right-away. 

To create new custom action in Qualitia:

1. From the Expand Menu, click Develop.
2. Click the Custom Actions tab.
3. Click the Add Button (  ) or Create Custom Action button.
   The Custom Actions screen appears.
4. Select Base Class.
    The Custom Object Class file name including its file path should not exceed 256 characters when you are using Git/Bitbucket as a source control system for maintaining project artifacts.
5. Do one of the following:
   • To add a new Qualitia Class:
     1. Click the Plus button next to Custom Object Class to add a custom object class by mapping to the Qualitia Class that you want to add.
     2. Enter the java class file name without its extension along with the package name (if required), in Qualitia Class.
   • To select a pre-defined Qualitia Class that is mapped to a Custom Object Class:

     • From the Custom Object Class drop-down list, select a pre-defined custom object class.
       The associated Qualitia Class is selected automatically.

       Points To Know

       • For example, if you add a Qualitia Class "com.security.login", then this file creates a package and a java file called as "com.security" and "login.java" respectively.
       • The Custom Object Class is a user-friendly alternate name for a Qualitia Class, which you can specify.
       
       
       
6. Enter Action Name, Description and Function Name for the action to be created.
7. In the Properties section, click Add.
   A new line will be added in the grid.
8. Add Parameter Name, Description, ArgDataType for the parameter, and select whether this parameter is mandatory.
   1. To save the action, click Save.
   2. To save the action and launch the code template in Eclipse IDE, click Save and Launch Eclipse.
9. Close the Welcome on the IDE window to see your auto-generated custom action code template.
10. Import the pre-created Custom Action Java project workspace into Eclipse workspace.
     This is a one-time activity for a project.
    
    1. To import the pre-created workspace, right-click Package Explorer, and select Import from the context-menu.
    2. On the Import window, under the General section, select Existing Projects into Workspace and then click Next.
    3. In the Select root directory section, click the Browse button, select <PROJECTNAME>_QASJavaproject and click Finish.
       You will find this directory under Qualitia project path.
       
       
       
       
11. In Eclipse IDE, from the Window menu, select Preferences.
12. Select General > Workspace > Select Refresh using native hooks or polling.
13. Click Apply and Close.
14. Ensure you do not change the method signature and provide only the method body. Changing the signature in code may break your action in Qualitia.
15. In the editor, add the custom action code in the provided template for your custom action.
16. To add the dependent jars, do the following in the order listed:
    1. Add the dependent jar files in the lib folder under the project.
       
    2. Right-click the Project, point to Build Path, and then select Configure Build Path.
    3. Click Libraries > Add JARs.
    4. Under Jar Selection window, expand the Project folder.
    5. Under the lib folder, select the dependent Jar, and click Ok. 
    6. Click Apply and Close.
17. Build the project and close the Eclipse IDE.
    To work this custom action code in the Qualitia automation test cases, you must build the project successfully.
    You can now use this newly created custom action while developing task and test cases in Qualitia.

Recommendations and Rules for Custom Actions

Generic Recommendations

For creating the custom actions for Selenium Webdriver, you need to create the action in Java and then map the action into Qualitia Automation Studio. You can use any IDE tool like Eclipse.

The following are some rules that must be considered when creating custom actions:

• The parameter data types supported by Qualitia are String and Array. If an array parameter is used in Qualitia for the custom action, then custom action parameter should be of the type Object in Custom Action function. The parameter can then be type-casted into the data type which is required in the action.
  For example, the object parameter can be type-casted into the array list.

• Based on the standard Java coding rules, actions should not be created in the default package. For better maintenance, it is recommended to use user-defined packages for development.

• It is recommended to put a prefix when defining a name for new custom actions for easy identification.

• No two custom actions can have the same function name in the same class. Function overloading is not allowed. Duplicate function names in different classes are allowed (not recommended). 

• Once the action is mapped into Qualitia and used in a test case, do not change the existing signature or other details of the actions or the classes created. The functionality of the action can be modified. Do not delete the custom actions or custom classes that are used in test cases.

• If the custom action belongs to any object type (such as WebEdit, WebElement, and so forth), ensure you add the objectInfo data type parameter while developing the code of an action.

• While mapping actions into Automation Studio, it is important to map the action using <package.class> hierarchy. 

• Objects should be added under appropriate Qualitia classes while mapping custom actions into Qualitia Automation Studio

New Recommendations from Qualitia v8.0.0

Qualitia has come up with a new set of rules for creating custom actions in Qualitia 8.0.0 and later. If you have created custom actions to Qualitia version earlier than v8.0.0, then you must edit the existing ones with the following rules.

Making a New Class for Recommendations

You can create a custom class consisting of your custom actions. The newly generated class can be added in the same package as that of the already supported actions. 

You must ensure that in the test case, the ‘name’ and ‘qClass’ fields of action are set to the correct name of the action and class containing that action respectively. Qualitia now uses the concept of java reflection through which the action mentioned in ‘name’ and class mentioned in ‘qClass’ is called directly for action execution. The following example demonstrates how to make a new class for custom actions. 

package <QASpackagename>; 

import com.qualitia.execution.ActionResponse; 
 import com.qualitia.execution.ApplicationLogger; 
 import com.qualitia.models.testcase.ExecutionResult; 
 import com.webdriverfw.Wrappers.General; 

 <QASimportlist> 

 

 public class <QASclassname> extends General { 

 

 //Define your customs actions here 

 

 }

Writing Custom Actions in the Accepted Format

Qualitia now allows to write code for a custom in the following format. 

   package <QASpackagename>; 

import com.qualitia.execution.ActionResponse;   import com.qualitia.execution.ApplicationLogger;   import com.qualitia.models.testcase.ExecutionResult;   import com.webdriverfw.Wrappers.General; 

  <QASimportlist> 

  

  public class <QASclassname> extends General { 

  

  //Define your customs actions here 

  

  }

 public ActionResponse <QASmethodname>(<QASparametername>) { 

     

     ActionResponse actionResponse = getActionResponse(); 

     ApplicationLogger applicationLogger = actionResponse.getApplicationLogger(); 

     actionResponse.setExecutionResult(ExecutionResult.FAILED); 

     try { 

               // Your code here... 

             

           applicationLogger.writeToInfoLog(""); 

           actionResponse.setMessage("Successful message"); 

           actionResponse.setExecutionResult(ExecutionResult.PASSED); 

        } catch (Exception ex) { 

           applicationLogger.writeToErrorLog("Exception message", ex); 

           actionResponse.setMessage(“Failed Message”, FailureCategory); 

           actionResponse.setExecutionResult(ExecutionResult.FAILED); 

        } 

        return actionResponse; 

}  

As per the previous Qualita versions prior to v8.0.0 , the actions used to return integer value i.e 0,1,2,-1  which were used to indicate PASSED, FAILED, DEFECT, NOT-EXECUTED respectively .

The return value has been changed to ActionResponse. The actions return ActionResponse which contains 2 parameters Message and ExecutionResult. Before ActionResponse is returned during the execution of action, the required message and ExecutionResult must be set properly. The primitive datatypes allowed for action parameters are String and Array. 

ApplicationLooger

For actions specific to logs, you can use ApplicationLogger.  

• applicationLogger.writeToInfoLog(""); 

• applicationLogger.writeToErrorLog(""); 

The main purpose of ApplicationLogger is to create the ogs to understand the flow of execution. There are 2 types of logs supported for Qualitia: 

• Info Log

• Error Log

Show Link of File in Info Log Section 

Some custom actions need to write a file during its execution. You can view that file inside the Info Log of that custom action. If you want to view the file contents, then you can click the Link present in the Message section of Info. 

The following function needs to be called before returning Action Response to show the link of files inside the log section. 

showLinkOfFileInLogsSection(String sourceFilePath, ActionResponse actionResponse) 

The sourceFilePath denotes the file path you write during custom action execution, and actionResponse denotes the Action Response object. 

The Error logs must be in the catch block of Action. These logs can be seen in Qualitia report which is generated after the execution of the suite. 

Setting an Execution Result

While setting ExecutionResult, you can make use of ExecutionResult enum where the required results are available. 

• ExecutionResult.PASSED is used to set when the action is passed.

• ExecutionResult.FAILED is used to set when the action is failed. 

• ExecutionResult.DEFECT is used to set when the action has a defect. 

• ExecutionResult.NOT_EXECUTED is used to set when the action halts the execution.  

The message and ExecutionResult that has been set will appear in the final Qualitia report.

 Example:- 

Here is one brief example on writing custom Actions, showcasing how it was done in old version and how it is done in Qualitia 8.0.0 version. 

If you want to write a custom action for checking two strings are equal, you can do it as:  

In Older Versions before 8.0.0 :  

    public int EqualStrings(String a, String b)  

    {  

    if(a.equals(b))  

    {  

    DataLogger.writeToDebugAndInfoLogs("they are equal");  

    return 0;  

    }  

    else  

    {  

    DataLogger.writeToDebugAndInfoLogs("they are not equal");  

    return 1;  

    }  

    }  

  

    In Qualitia 8.0.0 Version :  

    public AcionResponse EqualStrings(String a, String b)  

    {  

    ActionResponse actionResponse = getActionResponse();  

    if(a.equals(b))  

    {  

    actionResponse.setMessage("they are equal");  

    actionResponse.setExecutionResult(ExecutionResult.PASSED);  

    return actionResponse;  

    }  

    else  

    {  

    actionResponse.setMessage("they are not                                                                                equal”,FailureCategories.Category.INVALID_DATA);  

    actionResponse.setExecutionResult(ExecutionResult.FAILED);  

    return actionResponse;  

    }  

    }

 Adding a Failure Category for a Custom Action

You can add a pre-defined failure category or create a custom category for a custom action.

For more information, refer to Real Time Reporting Portal .

You can add a new category and define new enum implementing Failure Calssification Interface as: 

package com.webdriverfw.Wrappers; 

 Import com.qualitia.execution.failureclassifications.FailureClassificatio; 

 public enum MyCategoriesEnum implements FailureClassification { 

    MY_CUSTOM_CATEGORY1("This is my custom category 1"), 

    MY_CUSTOM_CATEGORY2("This is my custom category 2"); 

  

    private String name; 

  

    MyCategoriesEnum(String s) { 

        name = s; 

    } 

   public String getCategory() { 

        return name; 

    } 

}   

 

 Use it in actions as: 

actionResponse.setMessage("message",FailureCategories.CustomCategory.NEW_CUSTOM_CATEGORY1);

 You can create a new  category as shown in the following: 

 1.) Using String :  

actionResponse.setMessage("message",FailureCategory.newCategory("Categoryname")); 

2.) Using String Constant : You can define constants to customize categories in a separate class. 

package com.webdriverfw.Wrappers; 

 public class MyCategoriesConstants { 

   public static final String MY_CUSTOM_CATEGORY3 = "This is my custom category 1"; 

    public static final String MY_CUSTOM_CATEGORY4 = "This is my custom category 2"; 

} 

Use it in actions as:- 

actionResponse.setMessage("message",FailureCategory.newCategory(MY_CUSTOM_CATEGORY3)); 

Qualitia Public APIs for Custom Actions

Qualitia has shared the APIs to create custom actions. Earlier, Qualitia used to provide with public static variables and methods.

Debugging a Custom Action

You need to download the TestHarness.Java file, and download and extract the Config Folder file.

To debug a custom action

1. Do in the following order listed to create necessary test artifacts:

   1. Create a test case and include the custom action that you want to debug at the appropriate step. For more information, refer to /wiki/spaces/T2/pages/2681539278

   2. From the test case editor, click Run to dry run the test case to verify whether the custom action is hit.

   3. Create a test suite that contains the test case. For more information, refer to Creating a Suite.

   4. Create an offline suite using the test suite. For detailed instructions, refer to Creating an Offline Package.

2. To add the required files for debugging the custom action:

   1. Open the custom action you want to debug in the Eclipse project.

   2. Add the TestHarness.Java file for the custom action in the Eclipse project.

   3. Add the Config Folder in the Eclipse project.

   4. In the config folder, open the startupSettings.json file, and specify the location of the offline suite for “SuitesDir”.
      For example: "SuitesDir":"D:/Qualitia Offline/Suite1"

3. Insert a breakpoint at an appropriate line number in the custom action.

4. Start debugging the TestHarness.Java file.

5. The test suite execution starts.
   When the custom action is executed, the execution stops at the breakpoint you have inserted.
   You can go ahead and debug the custom action.

Troubleshooting (Custom Action Module)

You might get following errors while importing custom actions in Qualitia automation studio. You must fix these errors to complete the import procedure. 

Import Custom Action Cannot be continue due to following errors;...

You will get this error in case the directory you have selected to import custom actions is missing one or more required sub-folders. 

Resolution:

To resolve this error, ensure you have selected the right directory to import custom actions and the selected directory has all the sub-folders created in it.

Updating Qualitia Project Path

After you change the project path in Qualitia, you must re-import the java project from the new directory into the existing java workspace.

To re-import the project:

1. Ensure you clone all the project data to the new directory.
   This includes Test cases, Tasks, Custom actions, and Java project folders (which hold all the latest custom action code).
2. Remove the existing project from the workspace.
3. To import the cloned java project from the new directory, right-click Package Explorer, and select Import from the context menu.
4. On the Import window, under the General section, select Existing Projects into Workspace and then click Next.
5. In the Select root directory section, click the Browse button, select <PROJECTNAME>_QASJavaproject and click Finish.
   This is in the new directory where you have cloned the Qualitia project data.
6. Select General > Workspace > Select Refresh using native hooks or polling.
7. Click Apply and Close.

Custom Action Custom Files are Not Pushed to Project Path GIT Repository

Problem: While editing or adding a custom action, if you encounter the following message:

“The method or operation is not implemented.”

Summary: This error occurs because the custom action class files are not pushed to the Project path GIT Repository.

Solution:

Perform the following steps:

1. Open the Eclipse Project.

2. Click Windows > Preferences > Teams > Git > Projects.

3. In the right side of the Preference dialog box, under Projects, deselect the Automatically ignore derived resources by adding them.gitignore checkbox.

Other Validations

While importing custom actions code into automation studio, Qualitia validates certain things. In case some files or code is missing, Qualitia gives the list of issues to fix to continue importing custom actions.

Here is the complete list of validations and resolutions to be done.

Once you have fixed all the errors mentioned above, you can continue importing custom actions in Qualitia. 

Modifying Custom Actions

Over the course of the project, you might want to update the custom action code to handle more scenarios with the same action. You can modify the custom action code in such cases.

Modify Custom Action Metadata

To edit custom action metadata:

1. From the Expand Menu, click Develop.
2. Click the Custom Actions tab.
3. In the left pane, click the desired custom action which you want to update.
   Custom action details will appear in the right pane.
4. Click Edit.
5. Update Action Name, Description, Function Name, and parameters details based on the requirements.
6. Click Save and Launch Editor.
   

   For desktop project custom action developed in VB, you cannot add or remove parameters from the mapped function for an unused cutsom action from Qualitia client.  To work around this issue, launch the associated VBS file from Qualitia client, add or remove parameters for the mapped function, and remap the function to the custom action from Custom Action window.

Modify Custom Action Code

You can modify existing custom action code using the Eclipse IDE.

1. From the Expand Menu, click Develop.
2. Click the Custom Actions tab.
3. In the left pane, select the desired custom action which you want to update.
   Custom action details will appear in the right pane.
4. Click View Code.
   The code appears in the different section.
5. To update the code in the Eclipse IDE, click Edit Code.
   The code template with an existing code opens in the Eclipse IDE.
6. Update the code based on the requirements.
7. Build the project and close Eclipse IDE.
   

   Once you close the Eclipse IDE, Qualitia automatically commits the code to the version control system like Bitbucket or SVN (if configured) and makes the code available to other Qualitia project members.

Deleting Custom Actions

You can delete the custom actions only if they are not used in any of the test case or task.

To delete the custom action:

1. From the Expand Menu, click Develop.
2. Click the Custom Actions tab.
3. Search the desired custom action.
4. Select the action in the left pane.
   Custom action details will appear in the right pane.
5. Click Delete.