AutoVue Integration SDK Version: 19.1 / Version: 1.0
AutoVue Integration Certification Test Plan
1Introduction......
1.1Overview......
2Integration Components......
3Implemented features......
4Integration Test Conditions......
4.1Installation Tests......
4.1.1Environment Verification......
4.1.2Installation - Automated......
4.1.3Installation - Manual......
4.1.4Installation Verification......
4.1.5Integration Servlet Verbosity......
4.1.6Un-installation......
4.2Customization to launch AutoVue......
4.2.1For Multiple Versions
4.3DMS Properties......
4.3.1Mandatory Properties......
4.3.2Optional Properties......
4.4Printing with DMS Attributes......
4.5File Browsing......
4.5.1Accessing Local Files......
4.5.2Accessing DMS Files......
4.5.2.1From DMS Browse......
4.5.2.2From DMS Search......
4.6Viewing Files with XREFs......
4.7Metafiles......
4.7.1Metafile Creation and Check-in......
4.7.2Metafile Validity......
4.8Markups......
4.8.1Regular Markups......
4.8.2Master Markup......
4.8.3Markup Consolidation......
4.8.4Markup Deletion......
4.8.5Markup Promotion......
4.9Creating Renditions......
4.10Comparison......
4.10.1File Versions......
4.10.2Comparing with other DMS files using DMS Browse......
4.10.3Comparing with other DMS files using DMS Search......
4.10.4Comparing with local files......
4.10.5Comparing with URL files......
4.10.6Miscellaneous Compare Tests......
4.11Batch Printing......
4.11.1Printing a batch of DMS files using DMS Browse......
4.11.2Printing a batch of DMS files using DMS Search......
4.11.3Printing a batch of local files......
4.11.4Adding URLs to the Batch Print list......
4.12Overlays......
4.12.1Overlay with DMS files using DMS Browse......
4.12.2Overlay with DMS files using DMS Search......
4.12.3Overlay with local files......
4.12.4Overlay with URL files......
4.13DMU......
4.13.1DMU with DMS files using DMS Browse......
4.13.2DMU with DMS files using DMS Search......
4.13.3DMU with local files......
4.13.4DMU with URL Files......
4.14Cross-probe......
4.14.1Cross-probe with DMS files using DMS Browse......
4.14.2Cross-probe with DMS files using DMS Search......
4.14.3Cross-probe with local files......
4.14.4Cross-probe with URL Files......
4.15HTTPS Support......
4.16Real Time Collaboration......
4.16.1Inviting DMS Users......
4.16.2Viewing another DMS file......
4.16.3Creating Markups......
4.16.4Saving Session Markups......
4.17Remote Sites......
4.17.1Remote Sites DMS Verification
4.17.2Configuration of the Integration for Remote Sites
4.17.3Viewing Files from a Remote Location
4.17.4Saving Markups from a Remote Location
5Feature to Issues Summary......
6Detailed List of Issues:......
7Execution Summary:......
Release History
Release Number / Date(mm.dd.yy) / Brief Summary of Changes (Editor)
1.00 / 05.04.07 / First version released (Cimmetry Systems, Corp)
1Introduction
1.1Overview
This test plan applies to any third-party integration developed using the AutoVue Integration SDKto work with AutoVue, Client-Server Edition (CSE). This document is divided into the following sections:
- Integration components: Use this first sectionto identify theintegration system requirements and related components, such asServer platform, the DMS/EDM/PLM system, the application server, the web server, and any other component needed for the DMS/EDM/PLM System and/or the integration.
System requirements should bedocumented in the installation/administration guide and/or the release notes.
- Implemented Features: All features implemented with the integration areidentified in this section. Features are classified into three categories:
- Mandatory features:Features that must be implemented; Test conditions for mandatory features should meet the pass criteria in order to be Cimmetry certified.
- Optional features:Features that are “nice-to-have” implementations in the integration. If an optional feature has been implemented, test conditions for the optional feature must meet the pass criteria.
- Conditional features:Features that become mandatory based on an optional feature that has been implemented. For example, enabling the integration for Remote Sites is an optional feature. If you decide to implement this feature, implementing saving markups for files from remote locationsbecomes mandatory.
- Integration Tests:
This section covers all test conditions for the integration verification. This includes installation, file viewing, and markup.
Test conditions related to mandatory features must pass verification.
If an optional feature is implemented, test conditions related to the optional feature must pass verification.
If a conditional feature is implemented, test conditions related to the conditional feature must pass verification.
The pass/fail criteria for the certification will be outlined in the contractual agreement between you (the Customer) and Cimmetry Systems Corp. (Cimmetry).
2Integration Components
Identify yourintegration system requirements and related componentsand filloutthe information in table below. Systemrequirements should be documented in the Installation Guide and/or the Release Notes. All system requirements must be satisfied before you starttesting. Please use this table as a check list and verify that each component installed in the test environment is the same as listed here.
ComponentsEnvironment / Server Platform / DMS (List all components and versions) / JDK Version / AutoVue Server Version and License Type / Application Server Name and Version / Client Platforms and Browsers
Environment 1
Environment 2
Environment 3
Table 1: AutoVue Integration Components
3Implemented features
All features that can be implemented with the AutoVue Integration SDK are categorized as Mandatory, Optional and Conditional.
The followingtable maps features with Optional, Mandatory, or Conditional tags. Use the Implemented? column toidentify whether or not a feature has been implemented with your integration.
In section 5. “Feature to Issues Summary”, you should identify the implemented features and the number and importance of bugs open for these features. This list will help Cimmetry determine whether or not the integration can be certified. The pass and fail criteria are included in the contractual agreement between you (the Customer) and Cimmetry Systems Corp.
CategoryFeature / Mandatory / Conditional / Optional / Implemented?
Yes/No
Installation / Yes
Environment Verification / Yes
Installation - Automated / Yes
If installation is automated
Installation - Manual / Yes
If installation is manual
Installation Verification / Yes
Integration Servlet Verbosity / Yes
Un-installation / Yes
Customization to launch AutoVue / Yes
For Multiple Versions / Yes
DMS Properties
Mandatory Properties / Yes
Optional Properties / Yes
Printing with DMS Attributes / Yes
File Browsing
Accessing Local Files / Yes
Accessing DMS Files: From DMS Browse / Yes
Accessing DMS Files: From DMS Search / Yes
Viewing files with XREFs / Yes
Metafiles / Yes
Metafile Creation and Check-in / Yes
Metafile Validity / Yes
Conditional on Metafile creation and check-in
Markups / Yes
Regular Markups / Yes
Conditional on Markup Basics / Yes
Master Markups / Yes
Markups Consolidation / Yes
Markups Delete / Yes
Markup Promotion / Yes
Conditional on Customization to launch AutoVue for Multiple Versions
Creating Renditions / Yes
Comparison
File Versions / Yes
Comparing with other DMS Files using DMS Browse / Yes
Comparing with other DMS Files using DMS Search / Yes
Comparing with local files / Yes
Comparing with URL files / Yes
Batch Printing
Printing a batch of DMS files using DMS Browse / Yes
Printing a batch of DMS files using DMS Search / Yes
Printing a batch of local files / Yes
Printing a batch of URL files / Yes
Overlays / Yes
Overlay with DMS Files using DMS Browse / Yes
Overlay with DMS Files using DMS Search / Yes
Overlay with local files / Yes
Overlay with URL Files / Yes
DMU / Yes
DMU with DMS Files using DMS Browse / Yes
DMU with DMS Files using DMS Search / Yes
DMU with local files / Yes
DMU with URL Files / Yes
Cross-probe / Yes
Cross-probe with DMS Files using DMS Browse / Yes
Cross-probe with DMS Files using DMS Search / Yes
Cross-probe with local files / Yes
Cross-probe with URL Files
HTTPS Support / Yes
Real-Time Collaboration / Yes
Inviting DMS Users / Yes
Viewing another DMS File / Yes
Creating markups / Yes
Saving Markup Files / Yes
Remote Sites / Yes
DMS Verification / Yes
Conditional on remote sites integration
Configuration of the Integration / Yes
Conditional on remote sites integration
Viewing Files from a remote location / Yes
Conditional on remote sites integration
Saving Markups from a remote location / Yes
Conditional on remote sites integration
Table 2. Feature Implementation
4Integration Test Conditions
4.1Installation Tests
Youcanchoose to install Integration components manually or through an installer:
Sl. No / Test Condition / Expected Results / Actual ResultsInstallation
Installation of Integration components maybe manual or automated. / Installation instructions should indicate whether the installation is manual or automated.
4.1.1Environment Verification
Sl. No / Test Condition / Expected Results / Actual ResultsVerify DMS
Before Installing the Custom Integration, verify that your installation of the DMS/EDM/PLM system works fine. / File check-in/check-out, folder creation, and document details should all work properly.
Verify AutoVue Server
Before installing the Custom Integration, verify your installation of AutoVue Server. / Verify that you can startup the AutoVue Server, open client connections to the server, and load files licensed by the license key you were provided.
Verify System Requirements
Verify your system requirements match what is documented in the release notes or Installation Guide. / All components (versions, SPs) should match the documented system requirements.
4.1.2Installation - Automated
Follow the test cases in this section if the installation of your integration is partly or fully automated.
Sl. No / Test Condition / Expected Results / Actual ResultsInstaller – Documentation
Verify Documentation / Documentation should contain instructions for running the installer. Any mandatory steps following installation should be clearly indicated in the document.
Run Installer
Follow installer screens or steps. / Installer Instructions should be clear. There should be no typographical errors in the installer screens or steps.
Any pre-requisites should be clearly mentioned.
Installer Summary
At the end of installation, the installer summary should be displayed. / The summary screen/text should display whether or not the installation was successful.
In case of failure, the reason for failure should be displayed or the location of a log file that contains the failure message should be displayed.
Post Installer Steps
Any mandatory or manual steps that need to be performed after running the installer are indicated in the installer. / The installer screen/steps should clearly indicate if there are any more operations that need to be completed before using the Custom Integration.
DMS Files Backup
The installer should have backed up any files that are updated to enable the Integration with AutoVue. / Verify that backup copies exist for all files updated by the installer.
4.1.3Installation - Manual
Follow the test cases in this section if the installation of your integration is manual.
Sl. No / Test Condition / Expected Results / Actual ResultsInstallation Steps
Verify Documentation / Documentation should contain instructions for installing and enabling the integration with AutoVue.
Instructions should include restarts to Application/Web Server and include instructions on backing up files that are being modified.
Install the Integration
Follow instructions in the document. / Instructions should be clear and contain complete steps for installing the integration.
Installation should be completed as per the documented instructions.
4.1.4Installation Verification
Follow the test cases in this section after you complete the automated or manual installation of the Integration:
Sl. No / Test Condition / Expected Results / Actual ResultsVerify DMS/EDM/PLM System
After installation of the Integration is complete, verify that your DMS/EDM/PLM System is still functioning normally as before. / Make sure you can still check-in/checkout files, create folders, and use your DMS system as you could before you installed the Integration.
Verify AutoVue Server
Under normal circumstances, installing the Integration should not impact AutoVue server installation. / Verify that you are able to start up the AutoVue Server, open client connections to the server and load files licensed by the license key provided to you.
Verify Integration Servlet
Startup the Application Server. Enter the URL into the Integration Servlet. / Documentation and/or the Installer should indicate what the URL should be.
On successful installation of the Integration, the Servlet URL should return a page indicating the version, build number of the Servlet and Init parameters, if any.
4.1.5Integration Servlet Verbosity
Sl. No / Test Condition / Expected Results / Actual ResultsEnable Verbosity
Follow instructions for enabling verbosity for the integration Servlet. / Documentation should contain instructions on enabling Servlet verbosity.
Verify Log
Log file generated should contain customer DMS-specific messages (on top of messages provided by the integration SDK). / Logging should follow log4j structure and should contain messages specific to your integration along with messages from the Integration.
4.1.6Un-installation
Sl. No / Test Condition / Expected Results / Actual ResultsDocumentation
Documentation should provide instructions for un-installing the integration. / Whether the installation was manual or automated, documentation should provide complete instructions on un-installing the integration.
Automated
Follow through the instructions for an automated uninstall. / All files modified by the installer as part of the installation should be restored to their previous state.
Any new files created by the installer should be deleted by the uninstaller.
Manual
Follow through the manual steps to uninstall the integration. / Steps should include restoring backed up files and deleting any new files that were created as part of the installation.
Verification
After the integration is uninstalled, verify your DMS/EDM/PLM system. / Make sure you can still check-in/checkout files, create folders and use your DMS system as you could before you installed the Integration.
4.2Customization to launch AutoVue
Sl. No / Test Condition / Expected Results / Actual ResultsDocumentation
Documentation should indicate how to launch AutoVue for any viewable file that is in the DMS/EDM/PLM system / The launch mechanism could be an AutoVue shortcut next to the file or an icon/shortcut from the document details page or could be a menu item. The mechanism should be clearly mentioned in the document.
Mechanism to Launch AutoVue
Login to your DMS/EDM/PLM system. Navigate to a file. / There should be a mechanism to launch AutoVue for the file.
Launch AutoVue
Launch AutoVue for the file. / Selected file should display in AutoVue. Verify file display and properties to ensure that the correct file is displayed.
AutoVue Version
From the AutoVue client, select Help -> About. / The version and build information displayed here should correspond to the AutoVue version you are certifying against. Report version, build number and date in the actual results.
4.2.1For Multiple Versions
Sl. No / Test Condition / Expected Results / Actual Results1 / Customization in Version Details Page
Select a file that has multiple versions and go to the version details page. / There should be customization(s) to launch AutoVue for each version.
2 / Launching AutoVue
Launch AutoVue for an older version of the document. / Selected version should display in AutoVue. Verify the file display to make sure the correct file is displayed.
4.3DMS Properties
4.3.1Mandatory Properties
Sl. No / Test Condition / Expected Results / Actual ResultsDMS tab in file properties dialog
Launch AutoVue for a file within the DMS and select Properties from the File menu. / The File properties dialog should contain a DMS tab.
Mandatory Contents of the DMS tab
The DMS tab should contain the following attributes pertaining to the file that is currently viewed in AutoVue: Document name, File size, Last modified Date. / The results displayed here should accurately reflect the values in the DMS.
4.3.2Optional Properties
Sl. No / Test Condition / Expected Results / Actual ResultsOptional Contents of the DMS tab
In addition to the mandatory properties, the DMS tab can contain optional information such as File Version, Document owner, Revision History and anything else that is necessary for your integration / The results displayed here should accurately reflect the values in the DMS
4.4Printing with DMS Attributes
Sl. No / Test Condition / Expected Results / Actual ResultsDMS Attributes in Headers/Footers and Watermarks tab
Load AutoVue for a file in the DMS. Select Print from the File menu. Select the headers/footers tabs and the watermark tab / A drop-down list of allowed DMS attributes should be displayed in these tabs.
Printing with DMS Attributes
Select some attributes to print as header/footer/watermark. Print the document, / The correct values for these attributes should be printed. Make sure the selected document also prints completely.
4.5File Browsing
4.5.1Accessing Local Files
Local FilesSelect Open from the File menu. A browse dialog appears. Browse to a file on your local file system and select the file. / Selected file should display in AutoVue.
URLs
Select Open URL from the File menu. A dialog appears that lets you enter a URL to a file. Type in the complete URL to a file to load and click OK. / Specified file should display in AutoVue
4.5.2Accessing DMS Files
Sl. No / Test Condition / Expected Results / Actual ResultsFile Open URL dialog customization
If you enabled DMS Browse and DMS Search capability in your integration, the File Open URL dialog should have buttons to invoke Browse and Search. / The File Open URL dialog has buttons that lets you Browse or search your DMS system. The names for these buttons should be customized for your DMS.
4.5.2.1From DMS Browse
Sl. No / Test Condition / Expected Results / Actual ResultsDMS browse button
Invoke the File Open URL dialog from the AutoVue Client / A DMS Browse button must exist on the File Open URL dialog.
Invoke DMS Browse dialog
Click DMS Browse from the File Open URL dialog. / A dialog should appear displaying the top-level directory structure of the DMS.
(Note: The top-level directory structure will vary depending on user’s access levels)
Browse through the DMS
In the Browse folder, browse through the DMS and select a file to display. / Selected File should display in the AutoVue window. Verify file display and properties to make sure the correct file is displayed.
4.5.2.2From DMS Search
Sl. No / Test Condition / Expected Results / Actual ResultsDMS Search button
Invoke the File Open URL dialog from the AutoVue Client / A DMS Search button must exist on the File Open URL dialog.
Invoke DMS Search dialog
Click DMS Search from the File Open URL dialog. / A dialog should appear that lets you specify search criteria.
Specify Search Criteria
Specify a search criteria and click OK / Files matching the search criteria should be listed in the results section.
Select from Search Results
Select a file to display from the search results. / Selected File should display in the AutoVue window. Verify file display and properties to make sure the correct file is displayed.
4.6Viewing Files with XREFs
Sl. No / Test Condition / Expected Results / Actual Results1 / Defining XREF Relationship
Check-in a file with XREFs into your DMS/EDM/PLM system and make sure XREF relationship is defined.
Check-in files that have XREFs. Define the XREF relationship. View the base file in AutoVue. / Defining relationship can be handled by the CAD Application that works with your DMS/EDM/PLM system or it can be manual.
If definition is to be created manually, documentation should contain instructions.
2 / Viewing Files with XREFs
View the file from the previous step. / File should display completely, along with its XREFs. Verify file properties to make sure there are no missing resources.
Verify Cache folder of the AutoVue Server to make sure the base file and all the XREFs have been downloaded into the Cache folder.
4.7Metafiles
4.7.1Metafile Creation and Check-in
Sl. No / Test Condition / Expected Results / Actual ResultsMetafile creation
Check-in a file into the DMS. View the file. Close file. / Check that a metafile is generated in AutoVue server>\bin\cache folder. Make sure the metafile is checked into the DMS.
4.7.2Metafile Validity
Sl. No / Test Condition / Expected Results / Actual ResultsLoading from Metafile
Delete Server Cache. Reload file for which a metafile exists. / File should load from metafile. Check File Properties to confirm that file is indeed loaded from metafile.
No re-downloads
Enable verbosity for the Servlet. Reload file from step 1. / Metafile should not be re-downloaded into the server cache. Check the logs to confirm that there is no re-download.
4.8Markups
Sl. No / Test Condition / Expected Results / Actual ResultsEnter Markup Mode
Launch AutoVue for a file in the DMS. Enter Markup mode by clicking the Markup button in the toolbar or by selecting File > Markup. / AutoVue should enter markup mode. You should be able to create markup entities in this mode.
Markup Create
Create markup entities. Save as a new markup file. / AutoVue should prompt you to enter a name for the markup file. Markup should be saved in the DMS with the specified name,
Markup red-bulb icon
Open a file with existing markup entities in AutoVue. / A red-bulb icon should be displayed at the bottom left of the AutoVue window indicating that markups exist for this file.
Markup Open
Click the markup bulb icon or enter markup mode by clicking the Markup icon. / The Markup Open dialog appears listing all existing markups for the file. Selected markup displays in AutoVue.
4.8.1Regular Markups