Offline Client to Jvue server for Matrix



Utility for Caching

Metafile Renditions

For eMatrix

 

 

 

 

 

 

March 01, 2002

 

 

 

 

Cimmetry Systems Inc.

 

Copyright Notice

All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of Cimmetry Systems, Inc.

Cimmetry Systems, Inc. makes no claims with respect to the adequacy of this documentation, programs, or hardware that it describes for any particular purpose or respect to the adequacy to produce any particular result. Information in this document is subject to change without notice. In no event shall Cimmetry Systems, Inc. be held liable for special, direct, indirect or consequential damages, losses, costs, charges, claims, demands, or claim for lost profits, fees, or expenses of any nature or kind.

AutoVue, AutoVue Professional, AutoVue SolidModel, AutoVue SolidModel Professional, Panoramic! and VueLink are trademarks of Cimmetry Systems, Inc. All other company names and product names mentioned herein are trademarks of their respective companies.

 

Copyright © 2002 All Rights Reserved

Cimmetry Systems, Inc.

678 Massachusetts Avenue, Suite 501, Cambridge, MA 02139, USA

6700 Côte-de-Liesse, Suite 206, St-Laurent, QC H4T 2B5, Canada

Table of Contents

Introduction 4

How it works? 4

What is a metafile? 4

Supported Document Formats for Metafile Renditions 4

Steps for Creating Metafiles 5

i. For 3D Assemblies 5

ii. For 2D Master Drawings with XRefs 6

Architecture 7

Administrator Guide 8

System Requirements 8

Installation 8

Manual Setup 9

Starting the Utility 11

Configuration 12

Setting Trigger Mechanisms in eMatrix 12

iii. On-Demand Mechanism 12

iv. Event-Based Mechanism 13

Enabling Icon Mail for eMatrix Users 15

Feedback Section 16

v. Cimmetry Systems, Inc. 16

vi. General Inquiries: 16

vii. Sales Inquiries: 16

viii. Technical Support: 16

Introduction

This utility uses jVue server as a rendition tool to generate and check-in metafiles into eMatrix PDM - Product Data Management system. Once a metafile rendition is added to the native document, the next time file is viewed in jVue Applet, jVue server fetches the metafile rendition instead of native file.

How it works?

Here is a brief description of how the utility handles requests for creating metafile renditions:

1. The client application sends the rendition request to the PDM server.

The actual request dispatched by the client depends on the triggering mechanism, which can be configured on the PDM server side. Examples of triggering mechanisms include check-in, promotion or on-demand actions.

2. The Server stores the request in a special queue item.

Each queue item represents a request made by a client to generate a metafile rendition of the native file.

3. The utility polls the queue items from the PDM at predefined intervals, and retrieves any pending requests.

4. The utility then sends relevant information of each request to jVue server to generate the metafile rendition.

5. The utility then asks jVue server to check-in the metafile rendition to the PDM.

JVue server in turn passes the request to the Vuelink to add the metafile as a rendition to the native document object in the PDM.

What is a metafile?

A metafile is a true replica of the original file. It is a lightweight format developed by Cimmetry. Its main advantage is performance enhancement of document viewing on the client side.

Supported Document Formats for Metafile Renditions

The utility generates metafile renditions for all Engineering and Vector formats that are supported by AutoVue for Java. Currently, AutoVue for Java supports many file formats including 2D engineering drawings as well as 3D assemblies.

Steps for Creating Metafiles

For 3D Assemblies

Special care is given when creating a metafile for 3D assemblies. For the utility to properly generate a metafile for a particular assembly, follow these steps:

1. Launch eMatrix client application and login.

2. Check in all the individual Parts of the assembly into eMatrix, one part per business object. eMatrix AEF (Application Exchange Framework) provides MCAD Component type for part files.

3. Check in the Assembly file into eMatrix in its own business object. eMatrix AEF provides MCAD Assembly type for assembly files.

4. Create the proper relationship between each Part and the Assembly. For example, default eMatrix AEF defines ‘CAD SubComponent’ as the relationship to use for connecting parts with assemblies.

5. If On-Demand trigger mechanism is setup, select the Assembly business object, click right mouse button and choose ‘Execute ( csiCreateQueueItemOnDemand’ from the popup menu.

6. If Event-Based trigger mechanism is setup, check out the Assembly and check it back into eMatrix.

For 2D Master Drawings with XRefs

Special care is given when creating a metafile for 2D Master Drawings, which have External Reference Files (XRefs) associated with them. For the utility to properly generate a metafile for a particular master drawing, follow these steps:

1. Launch eMatrix client application and login.

2. Create a business object and check in the 2D Master Drawing file into eMatrix.

3. Check in all the individual XRefs into eMatrix into same business object as Master Drawing.

4. Create the proper relationship between each XRef and the Master Drawing.

a. Click right mouse button on the business object and select ‘Properties ( Attributes’ from the popup menu.

b. List the filenames of each XRef in the ‘Description’ field. Use the following syntax

|X:basefile:xref1;xref2;xref3… |

where: X tells eMatrix that you are about to specify a link to an external reference file; basefile is the filename for the Master Drawing and xrefs1;xref2;xref3… are the filenames for each XRef file associated with the Master Drawing.

Multiple XRefs should be separated by a semicolon ‘;’.

For detailed description, please, refer to Vuelink manual, ‘Completing the Configuration for External Reference Files’ section.

c. Save the Master Drawing properties.

5. If On-Demand trigger mechanism is setup, select the Master Drawing business object, click right mouse button and choose ‘Execute ( csiCreateQueueItemOnDemand’ from the popup menu.

6. If Event-Based trigger mechanism is setup, check out the Master Drawing and check it back into eMatrix.

Architecture

Whenever a predefined event occurs, for e.g. a file check-in, eMatrix invokes a server side custom program called csiCreateQueueItem, which creates a custom object inside an eMatrix vault. This custom object represents a unique Rendition Request.

Meanwhile, a polling application retrieves these queue items from eMatrix, using API provided by Vuelink, extracts information from the QueueItem to identify the checked-in document. This information is added to an internal Queue, which is polled by a QueueReader. Each entry retrieved by the QueueReader is then dispatched to AutoVue for Java Server using Vuebean API. Thereafter, the metafile is created and checked into eMatrix by AutoVue for Java server, which interacts with Vuelink for eMatrix for this purpose. The status of the rendition, whether it was “Errored” or was “Successful” is then sent back to the user by the Polling Application using eMatrix Icon Mail.

The Polling Application and the QueueReader run asynchronously and thereby leads to greater efficiency.

Administrator Guide

System Requirements

The utility itself is a java application program and therefore can be run on any platform equipped with Java Virtual Machine – JVM.

The following software must be already installed on the machine hosting this utility:

• Sun’s Java Runtime Environment (JRE) v1.3.1 or higher

• eMatrix Thick Client Applications v 9.5.0.2+

- at least the MQL Application (ex. mql.exe) should be installed

The following software must also be available the utility to work but may be installed on a different machine than the one hosting the utility:

• AutoVue for Java v16+

• eMatrix Collaboration Kernel v9.5.0.2+

• Vuelink for eMatrix v16+

• eMatrix Application Exchange Framework AEF v9.2.0.2+

• eMatrix Engineering Central v9.0.2.0+

Installation

Metafile utility requires jVue Server and Vuelink. Before attempting to install Metafile Utility with eMatrix, ensure that eMatrix, AutoVue for Java, and Vuelink for eMatrix are properly installed and configured on your system, according to the manufacturer’s instructions, and are operating correctly.

To install the Utility for caching metafiles for eMatrix, complete the steps outlined under the following sections:

1. Manual Setup

2. Setting Trigger Mechanism in eMatrix

3. Enabling Icon Mail for eMatrix Users

4. Starting the Utility

Manual Setup

1. Create a folder called /cimmetry/metafile_utility. For example, c:/program files/cimmetry/metafile_utility.

2. Copy the content of ‘metafile_utility’ folder found on the distribution CD to the folder created in previous step.

3. Open ‘run.bat’ file found under /metafile_utility/bin folder in any text editor and modify the following settings

|JDK_DIR |Full path to the root folder where Sun’s JRE is installed. Example, c:\jdk1.3.1 |

|JARDIR |Full path to the folder that contains metafile.jar along with other JAR files. |

|PASSWORD |Password of a valid eMatrix account with administrative privileges. |

|MX_CLIENT_JAR |There are two entries in run.bat. You need to uncomment one entry only based on version of eMatrix you have |

| |installed. If you are using eMatrix v9.5.2.0+, eMatrixServletRMI.jar should be in the classpath. Otherwise, |

| |eMatrixAppletDownloadXML.jar should be in the classpath. |

Note

By default, csiqcmatrix.properties file is located under same folder as metafile.jar. If this file is moved to another location, then you need to set the full path to PROPFILE.

|PROPFILE |Full path to csiqcmatrix.properties file. |

4. Open ‘csiqcmatrix.properties’ file found under /metafile_utility/bin folder in any text editor and modify the following settings

|JVUE_HOST |The host server Name or IP where AutoVue for Java Server is running. |

|JVUE_PORT |The Port Number to which AutoVue for Java Server is listening. By default, this value is 5099. |

|MAX_THREADS |For each request for rendition, the utility creates a new thread (process) that interacts with jVue Server to |

| |perform the rendition as well as the check-in of the metafile. The maximum number of such threads that the |

| |polling client can run simultaneously is configured here. Increasing this number leads to quicker rendition |

| |because more number of files may be rendered at the same time. But it also leads to greater load on the machine |

| |hosting this utility as well as the machine hosting jVue Server. This number cannot exceed the number of seats |

| |procured for AutoVue for Java Server. For e.g. if you are running AutoVue for Java server with a 50 user license,|

| |then the value supplied in this text field may never exceed 50. |

|QUEUE_CLIENT_PROP |Full Path to csimfmatrix.properties properties file. |

5. Open ‘csimfmatrix.properties’ file found under /metafile_utility/bin folder in any text editor and modify the following settings

|MX_HOST |The host server Name or IP where the Application Server (e.g. Weblogic) hosting eMatrix Thin Client applications is |

| |running. |

|MX_PORT |Any eMatrix Thin Client installation needs a Webserver to be the point of entry for all requests. The Webserver then |

| |transfers requests to the underlying application server. For e.g. when Weblogic server is installed, it comes with a |

| |default Webserver that listens to port 7001 by default and transfers all requests to Weblogic. |

| |The value supplied in this text field should be the port number that the Webserver is listening to. |

|MX_CONNECT |eMatrix Collaboration Kernel type. RMI, EJB or CORBA. Default is RMI. |

|MX_RMIPORT |Port number if eMatrix RMI server is used. Default is 1099. |

|MX_USER |Name of valid eMatrix user with Administrative Privileges to Application Centrals. Default is Test Everything. The |

| |utility needs to sign into eMatrix to access Rendition Requests. This user ID should have permissions to read and |

| |modify Business Objects of type csiQueueItem. It should also have permissions to send icon mail notifications to users|

| |about the status of their rendition requests. |

|MX_VAULT |eMatrix vault name, which contains all the csiQueueItems. Care should be taken to ensure that this is the same Vault |

| |that contains Vuelink for Matrix specific business objects. |

|MX_CSI_CONFIG |This object (Cimmetry Configuration Business Object) is created when Vuelink for Matrix is installed. It contains all|

| |the required meta-data for Vuelink functionality. Since this utility depends on Vuelink to function (please refer to |

| |the architecture diagram), the object name specified here should be accurate. |

6. Open ‘schemaCreateBC.txt’ file found under /metafile_utility/bin folder in any text editor and modify the following settings

|context_user |Replace "__USER__" with the name of valid Matrix user who has administrative privileges. Default is creator. |

|context_password |Replace "__ PASSWORD __" with the password of valid Matrix user who has administrative privileges. Default is empty. |

|context_vault |Replace "__VAULT__” with eMatrix Vault name. |

|store_name |Replace "__STORE__" with eMatrix Store name. |

7. Launch eMatrix MQL Application (mql.exe) and run the script contained in ‘schemaCreateBC.txt’ file. For example, at MQL prompt, type run c:/temp/schemaCreateBC.txt.

Starting the Utility

Invoke ‘run.bat’ from the command line. It queries the user for a password. The password supplied here should belong to a valid Matrix user who has administrative privileges.

Make sure that Application Server (Weblogic or WebSphere) is running before invoking ‘run.bat’.

Configuration

Setting Trigger Mechanisms in eMatrix

Metafile Utility for Matrix takes advantage of the event mechanism provided by eMatrix. Two kinds of triggering mechanisms are employed with Metafile Utility.

❑ The On-Demand (explicit) mechanism, metafile request is implemented with Matrix Thick-client. The user can initiate a metafile request whenever is needed. The metafile Utility will take care of that request and create the metafile.

Note

• The On-Demand mechanism is recommended for 3D file formats.

❑ The Event-based (implicit) mechanism, the triggering method is involved with registering with a particular event such as the check-in event. That means once a document is checked in, an event, which is defined by eMatrix is fired which invokes ‘csiCreateQueueItem’ program.

Note

• The Event-Based mechanism is recommended for 2D file formats.

On-Demand Mechanism

The script file creates a program called ‘csiCreateQueueItemOnDemand’ within Matrix. This program functions exactly like the program “csiCreateQueueItem”. The difference is that “csiCreateQueueItem” is meant to be associated with Business Objects as a trigger while this program is to be associated with Business Objects as a method. The administrator may also associate the program “csiCreateQueueItem” with Business Object types other than CAD Model.

1. Run eMatrix Business application (ex. business.exe)

2. Open the eMatrix ‘CAD Model’ type in edit mode

3. The ‘Edit’ window appears. Click the ‘Methods’ tab

[pic]

4. Click on the “Add” button

5. Type in “csiCreateQueueItemOnDemand” in the “Name” field

6. Click on “Ok”.

Event-Based Mechanism

The script file creates a program called ‘csiCreateQueueItem’ within Matrix. This program, when invoked, creates a Business Object, which represents a request for Metafile Rendition. The ‘Check-in’ trigger on CAD Model Business Objects can be set to invoke this program. The eMatrix Administrator may choose to associate the program with any other trigger.

In addition to this, the administrator may also associate the program “csiCreateQueueItem” with Business Object types other than CAD Model.

1. Run eMatrix Business application (ex. business.exe)

2. Open the eMatrix ‘CAD Model’ type in edit mode

3. The ‘Edit’ window appears. Click the ‘Triggers’ tab

[pic]

4. If the trigger you want is not in the list, click ‘Add’ button and then double click on the desired trigger

5. The ‘Edit Trigger’ window appears. Type in the program name, i.e. csiCreateQueueItem, into the Action text field.

[pic]

Enabling Icon Mail for eMatrix Users

Once the utility is installed successfully, you need to enable icon Mail for all users who will be creating Rendition Requests. This is needed because the utility relies on icon mail to send notification to users about the status of their requests.

1. Run eMatrix Business application (ex. business.exe)

2. Select Object ( Find from main menu

3. Select Person from Object list and click Find button

4. From search result, select the user who needs icon mail enabling

5. Select Object ( Open ( Edit from main menu

6. The ‘Edit’ window appears. Make sure the Icon Mail box is checked.

[pic]

Feedback Section

Cimmetry System products are designed according to your needs. We would appreciate your feedback, comments and suggestions. We can be contacted by fax, e-mail or telephone. A new addition to our Web page is a feedback button that activates an easy-to-use feedback form. Let us know what you think!

Cimmetry Systems, Inc.

General Inquiries:

Telephone: (514) 735-3219

Fax: (514) 735-6440

E-mail: info@

Web Site:

Sales Inquiries:

Telephone: (514) 735-3119 or 1-800-361-1904

Fax: (514) 735-6440

E-mail: sales@

Technical Support:

Telephone: (514) 735-9941

Fax: (514) 735-6440

E-mail: techsup@

................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download