|
<< Click to Display Table of Contents >> RayQC > 7.3 u2 > User Guide > Troubleshooting Missing Plug-ins |
Plug-ins are an essential part of the dynamic checklist features in RayQC. They may either be missing during the checklist creation / edition within the Checklist Editor, or be out of reach for execution during the evaluation via the Checklist Viewer.
When checklist editors enable the plug-in option for an element, there are three possible sources for the offered list of plug-ins. If a plug-in is expected to be available within the plug-in selector control for a specific checklist element, but is not, the following steps lead to enlightening information that should help to solve the issue.
•Internal plug-ins
oAvailable for all checklists made with RayQC as they are delivered along with the RayQC resources and installed as mandatory feature by default.
oOpen the RayQC program directory (usually C:\Program Files (x86)\RayQC\). Check if a \Libs\ directory is present and contains a file called RayQC.plug-ins.dll.
oPlease check whether the file and folder names are correct towards case sensitive lookups.
•Global external plug-ins
oAvailable for all checklists evaluated with the local instance of RayQC, which include the plug-in prepared by any RayQC user.
oStart RayQC and then go to the Settings ->plug-ins tab. Check if the desired plug-in is listed in the plug-in manager.
oOpen the RayQC program directory (usually C:\Program Files (x86)\RayQC\). Check if a \plug-ins\ directory is present and a (matching) set of plug-in logic ([plug-inName].ps1) and interface definition (Manifest.xml) is present in a sub-directory.
•Local external plug-ins
oIt is stored within the checklist file /checklist project file
oOpen the checklist file / project in the Checklist Editor. Click on the plug-ins tab and make sure that the plug-in is shown in the manager
oAs RayQC checklist file is basically a ZIP container that contains the actual checklist.xml file, supporting files and a plug-in folder which contains the local plug-in. Extract the checklist file and go to the plug-ins folder. Verify the functions and their arguments matches in the script and its manifest.xml file.
If any of the conditions named above is not given, the plug-in resources are missing and have to be copied to or created at the specified location.
If the plug-in is available at one of the locations listed above, check whether the user that currently runs RayQC has access to the resource files. To do so, use the file / folder permission management of Windows.
Since a plug-in needs to be executed, the minimal required access level is execute.
If this condition is not meet, adjust the permissions as required and retry to use the plug-in within RayQC.
If all of the conditions named above are reviewed and regarded to be fulfilled, please contact your RaySuite / RayQC system administrator, or contact the Raynet support team via our Support Panel for further advice.
Please verify the following dependencies:
•Each external (i.e. not built-in) plug-in needs to consist of a .ps1 script and .xml manifest file. These two files must be stored in the same directory and manifest file should always be called manifest.xml file.
•The function names in the manifest file must match the respective function names in the PowerShell script. Same is true for the function arguments.
•manifest.xml file must always adhere to the structural criteria laid down by the manifest.xsd file
Actually, all scenarios given above may very well cause a plug-in to be unavailable for execution during the evaluation phase. However, there are some more which are likely and therefore worth to take a look at:
If the checklist execution has been triggered by a RayFlow tool integration command, make sure it contains all required parameters in a suiting condition.
Due to the flexible configuration and parameter injection concept of the RaySuite products, there may be issues with the provided RayQC call regarding:
•the tool integration in RayFlow itself
•the RayFlow workflow data object property values (e. g. unescaped special characters in parameter values, wrong path values, etc.)
•unavailable resources, such as network shares, which may be referenced within the plug-in definition files, the RayFlow tool integration, and the like
If a checklist template is moved from one location to another, it is mandatory to copy all local external and global external plug-in resources along to be available on the new checklist environment. (The same requirement for resource copies is given when a checklist contains relative path definitions to help files, images, and the like) As an alternative, the checklist resources may as well be stored on a shared location. Please make sure either the local or network path is correct and the required resources are there, accessible, and have not been damaged during the file transfer.