Go to primary content
Agile Engineering Data Management AutoVue Integration Installation and Administration Guide
Release e6.2.0.0
E52552-02
  Go To Table Of Contents
Contents

Previous
Previous
 
 

5 Installing Offline Metafile Cache Service

This section describes the manual installation of the Offline Metafile Cache Service.


Note:

Further information about Metafile Cache Service can also be found in the latest AutoVue Client/Server Deployment Installation and Configuration Guide on OTN (http://www.oracle.com/technetwork/documentation/autovue-091442.html).

5.1 Requirements and Assumptions

  • Batch Client has to run as service

  • JVue bean as control interface of the AutoVue server

  • VueLink DMS as data source and used to check-in the metafile

  • AutoVue batch engine implemented in Java (JVue bean control)

  • Timezone settings for remote AutoVue locations


    Note:

    On remote locations with a different timezone than the central location, the tomcat must be configured with the timezone setting of the central location. That is necessary for AutoVue in order for the Metafile Caching to work correctly.

    Surrounding text describes ch6_timezone_setting.png.

Note:

The Offline Metafile Cache Service uses a 64 bit JVM.


Note:

DFM replication is not supported; all files have to be replicated with the standard replication feature before the file can be cached on remote locations. The system checks if all files are replicated and sets an error code if not all files are available on the remote location.

5.2 Extract the Installation Package

The installation package of the Offline Metafile Cache Service is located on the package directory and named AutoVueBatch.zip.


Note:

The JAR files are provided within in the ZIP package.

  1. Extract the package to your installation directory.

    In this installation example, the installation path is (the AutoVueBatch path is the base path in the package):

    Windows Oracle Linux
    C:\Program Files\Agile_e6\AutoVueBatch /home/plm/Agile_e6/AutoVueBatch

  2. Unzip.

    Windows Oracle Linux
    ..\package\AutoVueBatch.zip -d "c:\Program Files\Agile_e6" ../package/AutoVueBatch.zip -d "/home/plm /Agile_e6"

    The installation package contains the following directories:

    • AutoVue Service Root (C:\Program Files (x86)\Agile_e6\AutoVueBatch)

      • axalant

        -bin

             - intel-ms-nt6.1 (Windows FMS Client binaries)

             - i686-linux-ol6 (Oracle Linux FMS Client binaries)

             - java (Java archives)

        - cmd (Windows scripts)

        - ini (Configuration files)

        - batch (Batch service files)

        - scripts (Oracle Linux scripts)

      • ext

        - bin

             - intel-ms-nt6.1 (external Windows binaries)

             - i686-linux-ol6 (external Oracle Linux binaries)

             - java (external Java archives)

      • tmp (Logging directory)

5.3 Adapting the Installation

You need to adapt the start-up script to setup the 64-bit Java Runtime (JRE) and the installation path of the Offline Metafile Cache Service.

Windows Oracle Linux
The scripts are located in the axalant/cmd sub directory of the installation. The vuelink_batch.bat script contains the following basic configuration settings: set JAVA_HOME=<JAVA_HOME>set ep_root=<ROOT DIRECTORY OF THE OFFLINE METAFILE CACHE SERVICE>Example: set JAVA_HOME=C:\Program Files\Java\jre7set ep_root=C:\Program Files\Agile_e6\AutoVueBatch The scripts are located in the axalant/scripts sub directory of the installation. The vuelink_batch script contains the following basic configuration settings: JAVA_HOME=<JAVA_HOME>export JAVA_HOMEExample:

set JAVA_HOME=/usr/local/java/jre7


5.4 Adapting the Service Settings

The vuelink.properties file is located at the axalant/batch sub directory of the installation.

These files set the environment variables needed by the Offline Metafile Cache Service.


Note:

The Offline Metafile Cache Service needs both parameters.

  • EP_DDM_SITE=<DFM SITE>

    Checks in the metafile that was downloaded from the AutoVue server.

  • EP_PVM_SITE=<PVM SITE>

    Defines the AutoVue server.

The following properties must be adapted. The other properties should not be changed:

#
# ECI connection
 #
 host=<HOSTNAME OF THE ECI DAEMON>
 port=<PORT OF THE ECI DAEMON>
 env=<PLM APPLICATION ENVIRONMENT>
 scope=BATCH
 #
 # Directories
 #
 varenv.ep_root=<ROOT DIRECTORY OF THE AUTOVUE SERVICE>
 varenv.axalant_root=<AXALANT DIRECTORY OF THE AUTOVUE SERVICE>
 varenv.$TMP=<PDF WORK DIRECTORY OF THE PDF SERVICE>
 #
 # Platform
 #
 varenv.EP_MACH=<EP_MACH>
 #
 # Environment
 #
 varenv.EP_DDM_SITE=<DFM SITE>
 varenv.EP_PVM_SITE=<PVM SITE>
 #
 # PLM Client
 #
 client1=<PLM USER_with_manager_privilege>,<encryptedPASSWORD>,com.agile.AutoVue.VueLinkBatch

Note:

The password has to be encrypted with the batchkeytool. For further information please refer to the Security Guide for Agile e6.2.0.0.

Windows Example (Extract from vuelink.properties) Oracle Linux Example (Extract from vuelink.properties)
#
# ECI connection
 #
 host=khe-plm
 port=20001
 env=plm_ref
 scope=BATCH
 #
 # Directories
 #
 varenv.ep_root=C:/Program Files/Agile_e6/AutoVueBatch
 varenv.axalant_root=C:/Program Files/Agile_e6/AutoVueBatch/axalant
 varenv.$TMP=C:/Program Files/Agile_e6/AutoVueBatch/tmp
 #
 # Platform
 #
 varenv.EP_MACH=intel-ms-nt6.1
 #
 # Environment
 #
 varenv.EP_DDM_SITE=ep
 varenv.EP_PVM_SITE=ep
 #
 # PLM Client
 #
 client1=USER_NAME_MGR,{AES-128}L8zdgjaiHx6RczOA+grCgVnNnpAdc=,com.agile.AutoVue.VueLinkBatch
#
# ECI connection
 #
 host=khe-plm
 port=20001
 env=plm_ref
 scope=BATCH
 #
 # Directories
 #
 varenv.ep_root=/home/plm/Agile_e6/AutoVueBatch
 varenv.axalant_root=/home/plm//Agile_e6/AutoVueBatch/axalant
 varenv.$TMP=/home/plm//Agile_e6/AutoVueBatch/tmp
 #
 # Platform
 #
 varenv.EP_MACH=i686-linux-ol6
 #
 # Environment
 #
 varenv.EP_DDM_SITE=ep
 varenv.EP_PVM_SITE=ep
 #
 # PLM Client
 #
 client1=USER_NAME_MGR,{AES-128}L8zdgjaiHx6RczOA+grCgVnNnpAdc=,com.agile.AutoVue.VueLinkBatch

5.4.1 Runtime

The Offline Metafile Cache service uses the same mechanism as the Java Daemon to install, remove, start, and stop the service.

5.4.2 Install as Windows Service

The configuration of the Windows service registration can be found in the vuelink_wrapper.conf file which is located in the axalant/batch sub-directory of the installation.

#********************************************************************
# Wrapper NT Service Properties
 #********************************************************************
 # WARNING - Do not modify any of these properties when an application
 #  using this configuration file has been installed as a service.
 #  Please uninstall the service before modifying this section.  The
 #  service can then be reinstalled.
 
 # Name of the service
 wrapper.ntservice.displayname=AgilePLM_AutoVue_Batch_Service
 
 # Display name of the service
 wrapper.ntservice.displayname=AgilePLM_AutoVue_Batch_Service
 
 # Description of the service
 wrapper.ntservice.description=Offline Metafile Cache for Agile PLM
 
 # Service dependencies.  Add dependencies as needed starting from 
wrapper.ntservice.dependency.1=
 # Mode in which the service is installed.  AUTO_START or DEMAND_START
 wrapper.ntservice.starttype=AUTO_START
 
 # Allow the service to interact with the desktop.
 wrapper.ntservice.interactive=false
 
 wrapper.ntservice.account=.\axalantrt
 wrapper.ntservice.password=********

To install the Offline Metafile Cache service as a Windows service use the vuelink_batch.bat command script located in the axalant\cmd sub directory of the installation.

vuelink_batch.bat -i
Services directory

5.4.3 Remove Service

To install the Offline Metafile Cache service as Windows service use the vuelink_batch.bat command script located in the axalant\cmd sub directory of the installation.

vuelink_batch.bat -r

5.5 Run as Console Application

To run the Offline Metafile Cache service as console application use:

Windows Oracle Linux
The vuelink_batch.bat command script located in the axalant\cmd sub directory of the installation.
vuelink_batch.bat -c

Parameters list for vuelink_batch.bat:

-c / -t / -p /-i /-r

(console, start, stop, install, remove)

The vuelink_batch.bat command script located in the axalant\cmd sub directory of the installation.
./vuelink_batch console

Parameters list for vuelink_batch:

console / start / stop / restart / dump


5.5.1 Why to Check-in a Metafile into the Vault?

The local cache on the AutoVue server may be cleaned or crashed. In this case, the AutoVue server can download all native files and the metafile from the EDM system and does not need to create a new metafile.


Note:

The conversion process from the native format to the AutoVue metafile format is a time consuming process.

5.5.2 In Which Vault will the Metafile be Checked-In?

The system uses the DFM feature to specify the target vault for metafiles.

The integration sets the following properties:

  • File Type: META

  • File Format: Same as the base file or NAT if not set

  • Creation System: AUTOVUE

5.6 Order Queue

The Offline Metafile Cache feature uses an order queue to send the native files and the checked-in metafile (if available) to the AutoVue server (System->AutoVue->Batch Orders).

An order has one or more order elements, or order positions, which contain the necessary document and file data.

The state shows the current working state of the order.

Batch order

5.6.1 Order Positions

The order positions are assigned to the order and specify which files should be cached on the AutoVue server.

It is only necessary to add the base file of a 3D assembly. The batch job caches all related native files on the AutoVue server to pre-cache the assembly.

The state shows the current working state of the order position.

batch order position

5.7 Creating an Offline Metafile Cache Order

The system provides two userexits to add documents and files to the Offline Metafile Cache:

  • xpvm_bat_doc

    Creates a new order and adds all assigned files which are viewable with AutoVue to an order position.

    This userexit is used for document masks.

  • xpvm_bat_fil

    Creates a new order and adds the specified file to an order position.

    This userexit is used for Document - File relation masks.


    Note:

    Both userexits are select-menu userexits.

    It is also possible to create orders and elements via LogiView by creating records in the order and order position masks.

5.7.1 Adding All Files of a Document

In the standard installation, the userexit xpvm_bat_doc is available on the document master form.

document master form

5.7.2 Adding a Specific File

In the standard installation, the userexit xpvm_bat_fil is available on the document file sub list.

document file sub list

5.7.3 Batch Process

  • The Offline Metafile Cache feature uses the Batch Client to control the caching process.

  • The main loop is implemented on the Batch Client to reduce the load on the EDM server machine.

  • The sleep interval length can be configured in the Batch Client settings.


Note:

The batch process is available on Windows and Oracle Linux only and should be installed on a machine near to the AutoVue server to reduce the network traffic.

The batch process can be installed as a Windows Service or run as a console program.

Further information about the Batch Client can be found in the Batch Client Guide for Agile e6.