Artifact/File Sync is an advanced feature that allows you to sync your artifact/file of a project located on a Web domain to another project on a different Opkey Web domain. In case you need to sync desired artifact(s) then it is recommended to sync the required Artifacts only instead of the whole project.
Need of Artifact/File Sync:
While working with Opkey Web, users usually need to sync their artifacts/files existing on one Opkey Web Domain to another Opkey Web domain. In this case, it’s not feasible to sync the whole project when you need to sync just a few artifacts/files. Opkey users can now sync their files and folders 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.
Let us see how to sync a folder (containing a few files) from a project to another project existing in the same domain.
Steps to be followed:
Suppose you want to sync a folder from the E-learning project to the Test1010 project.
Select the e-learning project.
Navigate to the Project Workspace, right-click on the folder, and then click on the Sync option.
Now choose the Domain (same or other)
Select the project where you want to sync your file. Here we will select test1010 as our project.
You can save the entered credentials in Sync Wizard by marking the Remember Me checkbox.
Click on the Sync button.
The sync process gets started. Here, you can view the destination URL, user name, project name, files with count, and sync logs.
Please wait until the sync process is completed.
Note :- It checks if the syncing file(s) & folder(s) are existing. Enter the Data Encryption password of the Source Project and click on Submit to proceed sync process.
Here, you can see that the sync process has been completed. Click on the Close button.
Here, you can have a look at the synced folder that now exists in another project (test1010) on the same Opkey domain.
Thus, the sync process has now been completed successfully. Similarly, you can sync files and folders from one domain to another domain.
Common Syncing Error Scenarios
Function Library
While syncing a FL, if any other file with the same name and a different type exists at the destination location then the error occurs.
Example:
Syncing file: The name of the syncing file is “FL1” and the type is “Function library”.
Syncing location: The name “FL1” already exists at the destination location with the 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 an error message will be displayed and syncing will be canceled.
If no. of output parameters in FL at the syncing location is more and FL is also used in the higher component then an 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 the syncing location then the error occurs.
Example:
syncing file: The name of the syncing file is “CFL1” and the type is “Coded Function Library”.
syncing location: The name “CFL1” already exists at the syncing location with the 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 an 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 an error message will be displayed and syncing will be canceled.
Service Repository
While syncing a SR file, If any other file with the same name and different type exists at the syncing location then the error occurs.
Example:
syncing file: The name of the syncing file is “SR1” and the type is “Service Repository”.
syncing location: The name “SR1” already exists at the syncing location with the 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: The Service Repository named “SR1” already exists but a 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 the syncing location then an error will occur.
If no. of input parameters in the SR method at the syncing location is more and the SR method is also used in the higher component then an error message will be displayed and syncing will be canceled.
Suite
If any other file with the same name and different type exists at the syncing location then the error will occur.
Example:
syncing file: The name of the syncing file is “Suite1” and the type is “Suite”.
syncing location: The name “Suite1” already exists at the syncing location with the type “Function Library”.
Object Repository
If any other file with the same name and different type exists at the syncing location then the error will occur.
Example:
syncing file: The name of the syncing file is “OR1” and the type is “Object Repository”.
syncing location: The name “OR1” already exists at the syncing location with the type “Function Library”.
Global Data Repository
If any other file with the same name and different type exists at the syncing location then the error will occur.
Example:
syncing file: The name of the syncing file is “GDR1” and the type is “Global Data Repository”.
syncing location: The name “GDR1” already exists at the syncing location with the type “Function Library”.
Test Case
If any other file with the same name and different type exists at the syncing location then the error will occur.
Example:
Syncing file: The name of Syncing file is “TC1” and the type is “Test Case”.
Syncing location: The name “TC1” already exists at the syncing location with the 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: The Test case is named “TC1”.
Syncing location: The test case named “TC1” already exists but is restricted to the user who syncs it.
Important Points:
Files having Custom Keywords will be synced only when they are used within the corresponding artifacts.
Only used Global Variables within the corresponding artifacts will be synced.
If the artifact of a Project of Master database has been synced within a Project of the Slave database then the synced artifact cannot be re-synced within any project of the same Slave database.
If there are two users in the source (Master) database having Admin & Non-Admin privileges whereas there are no users in the destination (Slave) database then after syncing the artifacts, both of the users will be Non-Admin users, and their passwords will be 8 characters of their email id, starting from beginning.
