24. Commonly Used Features
SMTP Settings
SMTP Settings is an advanced feature of OpKey which enables you to send your execution result to someone by applying SMTP Settings. To apply SMTP Settings, click SMTP Settings under Tools menu.
SMTP Settings page opens. Fill all required fields and then save it. You can send a Test Mail to the added email id.
SMTP Settings in Execution Wizard
In case, you have not configured SMTP Settings from Tools menu then you can apply SMTP Settings also from Execution Wizard. Make sure that you have checked Show Advanced Settings option to show Advanced Execution Settings page having SMTP Settings.
- Check Show Advanced Settings checkbox and click Next.
- Click on SMTP Settings to apply it.
Share/Unshare OR
In OpKey Web, Multilingual websites can be tested by using SetOR keyword for which the OR needs to be shared. To share an OR file, right click on OR file in Project Workspace and click Share option.
Adding Comment keyword
Now, the user can add comments between the Test Steps in Test Case/Function Library file. It is helpful in categorizing Test Steps as per requirement. There will be no effect on the execution of the added comments.
Execution Report
Execution Report contains crucial information about the test execution session. There are two types of Execution Result Reports in OpKey Web – Summary Report & Detailed Report. The Summary Report displays the name of the Test Case(s) with their status i.e whether the Test Case is Pass or Fail in the Execution. However, the Detailed Report displays information like the name of the Test Case(s), their Test Step(s) along with their status (Pass or Fail during Execution). Click on Export Report button to do so.
Note: For details about the Execution Result Reports, kindly refer: Execution Result Reports
Other Settings
Clicking on the More Settings icon displays the following checkboxes.
- All Continue on Error
Selecting this checkbox allows the execution to be continued even if an error occurs.
- All want Snapshot
Selecting this Checkbox captures snapshot for all/Selected the Test Steps.
- All is Negative
Selecting this Checkbox alters the result of all/Selected the Test Steps from Pass to Fail.
Decrypt Result
Now, OpKey Web users can decrypt their Execution Result by using Decrypt Result button. The encrypted information of execution result will be decrypted in readable format.
- Open your execution result and click on Decrypt Result button.
- Enter Decryption Password and click on OK.
- The encrypted execution result information has been decrypted into readable format.
“OpkeyIsBest” is the default Data Encryption Password.
Open in New Tab
Open in New Tab in Execution Dashboard
Execution Result Dashboard is the main page of Execution Result which shows a graphical representation of test executions having a different status. This page contains a Test Execution Analytics section which shows completed Test execution sessions (Passed, Failed, InComplete, NotExecuted, & Total). You can view mapped artifacts associated with the selected session.
Right click on the desired session and click Open in New Tab.
Open in New Tab in Project Workspace
Open in New Tab feature allows you to open selected folder/artifact in a new tab. Select desired folder/artifact, right on it and select Open in New Tab option.
The desired folder/artifact will get open in a new tab.
Open in New Tab in Project Workspace Dashboard
Project Workspace Dashboard is the Home Page which shows a graphical representation of Project Workspace and Test Executions. This page contains Recently used artifacts in folder: Project Workspace section which includes recently used artifacts of Project Workspace. You can right click on the desired artifact and click Open in New Tab.
State Management
State Management is an advanced feature which allows you to change the state of the artifact i.e. lock or unlock the artifact. There are 4 states of an artifact: Draft, Review, Approved and Published.
When your file is in Draft state then it can be edited by any user (Admin or Non-Admin) but when state gets changed from Draft to any other states (Review, Approved or Published) then the file will get freezed (locked) and no further editing can be done by the user (Admin or Non-Admin) in that state. However, Admin user can change its state to Draft and then further editing can be done.
A non-admin cannot change freezed (locked) state (Review, Approved or Published) of the file while an admin user can do that. If state of an upper artifact/file (like Suite) file is being changed then the state of all the mapped lower artifacts/files (like TC, FL, OR, GDR etc.) with Suite will get changed automatically. If there is a Function Library file which is already mapped with a Test Case and you are adding/editing Input Parameters & changing the state of Function Library file then State of the Test Case (in which that Function Library is mapped) will get changed as per the final state of the Function Library.
Let us see how State Management feature works…
- When you create a new artifact then it comes to the draft state which can be edited & updated. Here all the buttons are enabled you can perform any task.
- When you switch from Draft to the next state as Review, a popup message appears as shown below:
- Click on Yes to continue.
- The Review state locks your artifact and no further editing can be done in this state. But, you can execute this artifcat as Run Now button is enabled.
- However, Admin user can change its state to Draft and then further editing can be done.
- When you switch from Review to the next state as Approved, a popup message appears as shown below:
- Click Yes to continue.
- This Approved state locks your artifact and no further editing can be done in this state. But, you can execute this artifcat as Run Now button is enabled.
- However, Admin user can change its state to Draft and then further editing can be done.
- When you switch from Approved to the next state as Published, a popup message appears as shown below:
- Click Yes to continue.
- This Published state locks your artifact and no further editing can be done in this state. But, you can execute this artifcat as Run Now button is enabled.
- However, Admin user can change its state to Draft and then further editing can be done.
In addition, you can add your own States at Project level from the Manage State tab under the Project Management section from OpKey Admin Panel. Draft, Review, Approved and Published states are System Defined and cannot be modified and deleted. Review, Approve and Published state will lock files and only Admin will have rights to unlock them. Name of the newly added States (User Defined) cannot be matching with the System Defined state (like Draft, Review, Approved or Published) names. If you have your existing User defined states with the same name matching with the new System Defined state (like Review & Approved) names added then any changes in States results locking of the artifact/file as per the rule of System defined states.
Attachment Management
This feature allows you to upload the documents within OpKey. These documents could be of any type like excel, word, image, pdf, etc. but it should not be an executable file. You can use your uploaded document in your Test Script as per your requirement. The uploaded file(s) get saved under the DB, if the File Store Management under the agent utility is chosen as Store in Database otherwise it get stored under the Shared File Storage.
- Click on ‘Attachment Management‘ link under Tools menu.
- Attachment Manager window opens. Browse & select your file to be uploaded.
The added file(s) can be deleted, updated, exported or searched by using corresponding buttons on Attachment Manager window.
There are 11 keywords which have been changed/added because of this feature. They are as follows:
- CopyFile
- GetCellValueFromExcel
- GetFileExtension
- GetFileName
- GetFileNameWithoutExtension
- GetFileSize
- GetValueFromCSV
- ReadTextFile
- CheckFileExist
- SearchTextInFile
- GetFilePath
Data input parameters has been changed in the above keywords. A new Data Type File has been added. A new tab of Data Input Arguments has been added with the name of Attachment.
New data type can be seen in below mentioned components:
- While creating Global Variables.
- While adding an input parameter under Function Library.
- While creating a custom keyword.
Files with size upto 4 MB can be uploaded in DB. For uploading files more than 4 MB size, user will have to change the “File Store Management” to store in Shared File Storage under the Admin utility.
A Practical Scenario:
In this practical scenario, let us get file name of an attached image file by using GetFileName keyword.
- First of all, upload that required image file on the storage location as described above.
- Go to Tools Menu > Attachment > Upload your file.
- Let us create a Test Case file by adding a Test step having GetFileName keyword. Go to the right pane for providing Data Input Argument and provide path of your file from Attachment tab as shown below:
- Execute this Test Case by clicking on Run Now button.
- Once your execution process gets completed, you can see the execution result and analyse it.
In the result, in Output column you get file name of attached image file by using ‘GetFileName‘ keyword. In the same way you can use the other keywords related to file attachment feature.
Export AuditTrails of Artifact
Now, OpKey Web users will be able to export AuditTrails of the artifact to the Excel file. To do so, navigate to the dockable panel of the artifact, click on AuditTrails tab and then click on Export Audit Trails.
A new window of Export to Excel opens from where you can provide Report Name, select a Date Range of maximum 90 days and click on Export. You can view your exported Audit Trails Excel file.
Now, view the exported audit trails in excel form.
Remove Object Mapping
Now, OpKey user can remove the mapping of the associated object from the test step. To do so, you just need to select the desired test step having associated object and click on the Remove Mapping button under the Object Repository tab.
Export Artifact & Folder
This is one of the most awaited feature of OpKey Web. Now, OpKey users can export existing artifacts from one OpKey domain and import the exported artifact(s) to another OpKey web domain. By using this feature, you can share desired artifact(s) to someone on OpKey Web working on different OpKey web domain.
- Right click on the selected artifact folder and click on Export.
- Have a look at the Artifact Exporting Details. Artifact exporting process is going on.
- Here, you can have a look at your exported artifact.
- This exported artifact is portable and you can import it at any other (destination) OpKey Web environment.
Import Artifact & Folder
Let us see how to import the exported artifact folder.
- Go to the destination OpKey Web domain, navigate to Project Workspace tab & click on Import Artifact button.
- Import/Replica wizard opens. Select Import option and click on OK.
- Browse & select the exported artifact compressed folder and click on Open.
- Artifact Import wizard opens. Just within few moments your artifact(s) get imported to the destination OpKey domain.
- Click on Refresh button in Project Workspace to view the imported artifacts.
- Here, you can view that the desired artifacts have been imported to the destination OpKey domain.
- In case of duplicate artifacts exiting at destination end of OpKey domain then those artifacts are skipped while exporting artifacts. In this case, you may get a notification message as shown below:
Note: You can not import exported artifact(s) on the same domain so far i.e. source and destination domain of OpKey must be different.
Making Artifact & Folder Replica
OpKey allows its users make replica of the required artifact(s) in same or different OpKey domain, as required. There are two ways to make replica of the artifact: Copy/Paste and Import/Replica but both ways are fundamentally same. You can make replica of the exported artifact as well as make replica of the copied artifact.If you have exported artifact in compressed form then go to the Import Artifact button at Project Workspace in the destination OpKey domain (same or different).
- Import/Replica wizard opens. Select Replica option and click on OK.
- From here, you can choose or create a folder in which you want to make artifact replica.
- Click Next to continue.
Copy artifact and make replica
- You can copy any desired artifact or folder and then make its replica in the desired folder.
- Select the desired (destination) folder, right click on it and then choose Replica option.
- If you want to add tags then you can add them from here. Click on Add Tags button, add tag keys and values.
- You can retain original tags of the artifacts by checking Retain Original tag(s) checkbox.
- Click Apply to continue.
- Process of making replica has now completed successfully. You can view complete logs here.
- Click on Finish.
- Replica of the desired artifact(s) has been created successfully. Here, you can view the entire artifacts.
Note:
- When you make replica of copied test case which is mapped with any other artifact (like OR, DR, FL etc.) file then all the associated artifacts are also copied and pasted at desired location in the auto-created folder named as Dependent_Artifacts. Thus, this replica test case will be independent test case file and there will be no relation between this test case file and the earlier mapped artifacts.
- You can copy child & parent node but you can paste or make replica of copied parent/child node only within a parent node. In case of making duplicate (Copy & Paste) artifacts, when you copy a test case file which is mapped with any other artifact (FL, OR, DR etc.) file then you are able to paste that test case file at desired location and it will remain mapped with the earlier mapped artifact file.
- There is a notification message with checkbox that “Folder containing Gherkin/Sparkin file will not be replicated with any data. Only blank Gherkin/Sparkin file will be created at the destination end.” You can uncheck this checkbox, if required.
File and folder sync
OpKey users can now sync their files and folder from one project to another project in the same or different OpKey domain. In this way, all your file(s) and folder(s) will get exported and synced with the desired project existing on the targeted OpKey domain.
- Navigate to the Project Workspace, right click on the folder and the click on Sync option.
- Enter OpKey URL Name (domain name), User Name, Password, select Project and click on Sync in sync wizard.
- You can save the entered credentials in Sync Wizard by marking Remember Me checkbox. If you want to sync file or folder without syncing user(s) then you can mark Sync without user(s) checkbox.
- Sync process gets started. Here, you can view the destination url, user name, project name, files with count and sync logs.
- Sync process is going on. Please wait until the sync process gets completed.
- In this step, it checks if the syncing file(s) & folder(s) are existing. Enter Data Encryption password of the Source Project and click on Submit to proceed sync process.
- Here, you can view that the sync process has completed. Click on Finish.
- Here, you can have a look at the synced folder is now existing in another project on the same OpKey domain.
Note:
- The algorithm of syncing files or folder in the OpKey Web has now been improved. Now, if any conflict occurs during the syncing process (due to any reason like mapped Global Variables, Custom Keywords, etc.) the whole syncing process gets stopped and you are not allowed to resume syncing process by skipping the occurred conflict/error. Here the complete syncing process gets stopped and there will be no synced data at the destination side. Earlier to this, you were able to skip the conflict/error that occurred during the syncing process and continue the syncing of the file or folder.
- In case of syncing an artifact in the OpKey Web having used GDR column data, the user can view only the mapped GDR column data at the destination environment after completing the syncing process. The unused synced (unmapped) GDR column data would not be visible to the user at the destination environment which results in significant improvement of the overall syncing process.
- Thus, the sync process has now completed successfully.
Common Syncing Error Scenarios
Function Library
- While syncing an FL, if any other file with the same name and different type exists at destination location then the error occurs.
Example:
Syncing file: Name of the syncing file is “FL1” and type is “Function library”.
Syncing location: Name “FL1” already exists at the destination location with type “Test Case”.
- Function libraries are not allowed to sync if the data type of input parameters are incompatible and the Error message will be displayed in logs.
- Function libraries are not allowed to sync if the data type of output parameters are incompatible and the Error message will be displayed in logs.
- If no. of input parameters in FL at the syncing location is more and FL is also used in the higher component then error message will be displayed and syncing will be canceled.
- If no. of output parameters in FL at syncing location is more and FL is also used in the higher component then error message will be displayed and syncing will be canceled.
Coded Function Library
- While syncing a Coded FL file, if any other file with the same name and different type exists at syncing location then the error occurs.
Example:
syncing file: Name of the syncing file is “CFL1” and type is “Coded Function Library”.
syncing location: Name “CFL1” already exists at syncing location with type “Function Library”.
- Coded Function libraries are not allowed to sync if the data type of input parameters are incompatible. The error message will be displayed in logs.
- Coded Function libraries are not allowed to sync if the data type of output parameters are incompatible. The error message will be displayed in logs.
- If no. of input parameters in CFL at the syncing location is more and CFL is also used in the higher component then error message will be displayed and syncing will be canceled.
- If no. of output parameters in CFL at the syncing location is more and CFL is also used in the higher component then error message will be displayed and syncing will be canceled.
Service Repository
- While syncing an SR file, If any other file with the same name and different type exist at syncing location then the error occurs.
Example:
syncing file: Name of the syncing file is “SR1” and type is “Service Repository”.
syncing location: Name “SR1” already exists at syncing location with type “Function Library”.
- If the syncing location has a different type of service added with the same name.
Example:
syncing file: Service Repository named “SR1” and REST service named “Service1”.
syncing location: Service Repository named “SR1” already exist but SOAP service named “Service1” is added.
- If the input parameter of the added SR method in the test case or function library is incompatible at syncing location then an error will occur.
- If no. of input parameters in the SR method at syncing location is more and the SR method is also used in the higher component then error message will be displayed and syncing will be canceled.
Suite
- If any other file with the same name and different type exist at the syncing location then the error will occur.
Example:
syncing file: Name of the syncing file is “Suite1” and type is “Suite”.
syncing location: Name “Suite1” already exists at the syncing location with type “Function Library”.
Object Repository
- If any other file with the same name and different type exist at the syncing location then the error will occur.
Example:
syncing file: Name of the syncing file is “OR1” and type is “Object Repository”.
syncing location: Name “OR1” already exists at syncing location with type “Function Library”.
Global Data Repository
- If any other file with the same name and different type exist at the syncing location then the error will occur.
Example:
syncing file: Name of the syncing file is “GDR1” and type is “Global Data Repository”.
syncing location: Name “GDR1” already exists at the syncing location with type “Function Library”.
Test Case
- If any other file with the same name and different type exist at the syncing location then the error will occur.
Example:
Syncing file: Name of Syncing file is “TC1” and type is “Test Case”.
Syncing location: Name “TC1” already exists at the syncing location with type “Function Library”.
Permission related error
- If the original file of the version is restricted for the user during sync back then the error will occur.
Example:
Syncing file: Test case named “TC1”.
Syncing location: Test case named “TC1” already exists but is restricted for the user who syncs it.
Create Branch & Merge Branch
Create Branch feature helps you to create a new project of an existing folder in your Project Workspace. Let us see how you can easily create branch of a folder, containing few artifacts.
- Right click on the desired folder and select Create Branch option, as shown below.
- Enter the name of Branch (Project name to be created) and Data decryption password and then click Create.
- The branch has been created successfully.
- Now, you can see that your project has been created and its showing in the Project list.
- Here, you can view that the artifacts of the newly created project are showing in project workspace.
Merge Branch:
- Click on the Merge Branch under the Tools menu, as shown below.
- Click on the project dropdown list and select the desired project to be merged. (here RSP_Branch Test).
- Select the name of your project (here Test001) in which you want to merge the the Project (here RSP_Branch Test) and click Merge.
- The Project has been merged successfully.
- Now, here you can view that the folders with artifact of the desired project (here RSP_Branch Test) has been merged to your new project (here Test001).
