You can use this process to set up Visual Test and Repair
(VTR) activity (see Visual Test and Repair Plug-In).
You have downloaded and installed the SAP Visual Enterprise Viewer
component.
The VTR Model Viewer
uses a separate component, SAP Visual Enterprise Viewer, which must be installed on each client device that will be used to run VTR.
Download the SAP Visual Enterprise Viewer
installation program from SAP Service Marketplace and store it in a network share directory.
Note
If you use SAP HTML5 Visual Enterprise Viewer, you do not need to download or install any software to the client PC to view models in the .vds
file format.
To view ECAD models, an ECAD Add-in Module
must be licensed, installed and activated. For information about installing the ECAD Add-in Module
, see the Administrator Guide for SAP Visual Enterprise Viewer 7.1
that is available on SAP Service Marketplace at http://service.sap.com/instguides.
Note
For information about installation of the SAP Visual Enterprise Viewer
(ActiveX version) component and ECAD file converters, see the SAP ME Test and Repair Feature (Optional)
subsection of the Post Installation
section of SAP ME Installation Guide
at .
In System Rule Maintenance
, you define the location (host:port and optionally, path) for VTR model files in VTR Model Location
rule (see Visual Test and Repair Rules).
This system rule is used to specify the location of the models to be displayed by the VTR Model Viewer
. It is used in conjunction with the Drawing Name
value from the material to create a URL for the model file.
The VTR Model Location
is a text string that provides access to the folder containing the VTR model files. This can be a text string of the form \\computer\foldera\folderb\
, which specifies the computer name and path to a shared folder accessible on the network. Or it can be a text string of the form http://computer/folder/
, if a Web server, such as IIS or SAP NetWeaver, is used to provide access to the model files.
Either the VTR Model Location
value must end with the \ or / character or the Drawing Name
value must begin with the \ or / character to ensure that the combined string forms a valid URL. Both upper and lower case characters can be used in the text string. If a network shared folder is used, the folder containing the models must be accessible to every user who will use VTR.
An example of a VTR Model Location
value for a shared folder is: \\USPHLVM123X\SAP\VTR\MODELS\
.
An example of a VTR Model Location
value when using a Web server is: http://usphlvm123x/models/
.
Recommendation
We recommend that you use Web server to provide access to the model files. This is more reliable and more easily controlled than a file share. File shares sometime have Internet Explorer permissions issues.
Note
SAP HTML5 Visual Enterprise Viewer is built with JavaScript (UI5). Store models that you use in SAP ME on the SAP NetWeaver server or make them available to the SAP NetWeaver server.
In System Setup Maintenance
, you retrieve data for Property
type and define the mapping of the VTR element attributes for NC data type fields (see System Setup Maintenance). The initial mapping for VTR is the following:
vtr.viewer.vendor.fields=refdes,deviceref vtr.viewer.me.fields=REF_DES,COMPONENT
vtr.viewer.me.fields
This property specifies the SAP ME data fields to which the metadata fields from the model will be mapped. The mapping between the SAP ME data fields and the metadata fields is based upon matching the positions in the lists of fields for the properties. SAP ME supports up to two fields.
This property value is a comma separated text string containing the names of SAP ME data fields (see Data Field Definition Maintenance). One of the fields must be the Ref_Des
field. It must be mapped to the metadata field that contains the unique identifier for the model element.
The SAP ME data fields must be assigned to an SAP ME data type whose category is NC (see Data Field Assignment Maintenance). The SAP ME data type is then assigned to one or more NC codes (see NC Code Maintenance). When the NC code is selected in the NC Selection
plug-in, the data fields are displayed in the NC Data Entry
plug-in.
An example of a vtr.viewer.me.fields
string is: Ref_Des,Component
vtr.viewer.vendor.fields
This property specifies the model metadata fields which will be mapped to SAP ME data fields. The mapping between the model metadata fields and the SAP ME data fields is based upon matching the positions in the lists of fields for the properties. SAP ME supports up to two fields.
For ECAD files, the metadata field that contains the unique identifier for the model element is Ref Des. The metadata field that contains the component ID is deviceref
.
This property value is a comma separated text string containing the names of model metadata fields. One of the fields must be the unique identifier for the model element. It must be mapped to the SAP ME Ref_Des
data field.
An example of a vtr.viewer.vendor.fields
string is: refdes,deviceref
.
Recommendation
If you are going to use VTR for both ECAD models and 3D models for the same site, set up the 3D models to also use the refdes
and deviceref
metadata fields. For 3D models, the SAP Visual Enterprise Viewer products, Deep Exploration and Deep Server, can be used to create metadata fields and assign them values, for each object in the model.
In Material Maintenance
, you define file name of VTR model in Drawing Name
field. Optionally, you can define path to the VTR model (see Material Maintenance).
The Drawing Name
field on the Main
tab page in Material Maintenance
is used to specify the file name for the ECAD or 3D object model for the material. It is used in conjunction with the VTR Model Location
system rule to create a URL for the model file.
The Drawing Name
value is a text string, typically of the form <modelname.ext>
, that specifies the filename and extension of the model file. It can also contain part of the path to the folder where the model is stored. This is useful for situations where models are stored in different folders.
Either the VTR Model Location
value must end with the \ or / character or the Drawing Name
value must begin with the \ or / character to ensure that the combined string forms a valid URL. Both upper and lower case characters can be used in the text string. If a network shared folder is used, the folder containing the models must be available to every user who will use VTR.
Examples of Drawing Name
values are the following:
GRDemo.gcm
3D_MODELS\Main Gear.rh
In POD Maintenance
, you create a button associated with Visual Test and Repair
activity (MODEL_VIEWER
) and assign it to your layout (see Adding POD Button Activities to Your PODs).
Note
If you plan to set up SAP ME Visual Test and Repair
(MODEL_VIEWER
) as a popup, see SAP Note 2266537.
A POD with at least the following plug-ins is needed in order to utilize VTR:
Model Viewer
NC Selection
(see NC Selection)
NC Data Entry
(see Log NC (NC Data Entry))
In order to log defects or repairs, you also need the NC Tree
plug-in (see NC Data Tree).
A default VTR POD is predefined in SAP ME. It uses the 3 panel horizontal layout. For more information, see Visual Test and Repair (VTR) POD.
This may not be optimal for viewing your models. If you need to set up a new VTR POD, POD Maintenance
provides a lot of flexibility in configuring a POD.
Recommendation
The Operation
POD definition that has proven effective for viewing several types of models is described in the following tables. You can use this configuration as a starting point. It uses the 6 panel vertical layout.
The following table provides the data on the Buttons
tab page:
Button Label | Button Type | Activity |
---|---|---|
| Normal |
|
| Normal |
|
| Normal |
|
| Normal |
|
| Group | See |
| Group | See |
These activities are included under the Activities
button:
Activity ID | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These reports are included under the Reports
button:
Activity ID | Report Name |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This table represents the data on the Layouts
tab page:
Panel | Type | Default Plug-In | Other Plug-Ins |
---|---|---|---|
A | Fixed |
| |
B | Fixed |
| |
C | Fixed |
| |
D | Fixed |
| |
E | Fixed |
| |
F | Fixed | ||
Popup | All above activities and reports |
If you need to enable interaction with Log NC
, proceed as follows:
In Data Field Definition Maintenance
, you define up to two fields to be used for mapping VTR elements. To do this, you can use pre-loaded REF_DES
and COMPONENT
fields or define other fields. In Data Field Assignment Maintenance
, you associate these data fields with a data type of NC category (see Data Field Definition and Assignment). Other fields can be also included in this data type.
In NC Code Maintenance
, you assign NC data types that contain fields mapped to VTR elements to NC codes.
Each NC code must be associated with SAP ME data type. The data type identifies the data entry fields to be displayed in the NC Data Entry
plug-in for the NC code. If you need to define a new NC code, see NC Code Maintenance.
To specify the SAP ME data type for an NC code, retrieve the NC code in NC Code Maintenance
and select the desired data type in the Data Type
dropdown list on the Main
tab page.
The figure below illustrates the setup process of VTR: