reviewshare server and reviewshare replication server 2.1 install guide

8/12/2019 ReviewShare Server and ReviewShare Replication Server 2.1 Install Guide

1/68

AVEVA ReviewShare Server 2.1& AVEVA ReviewShare Replication Server 2.1

Installation Guide


2/68

Disclaimer

1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free from

viruses.

1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses; loss of

anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or information; any

special, indirect, consequential or pure economic loss, costs, damages, charges or expenses which may be

suffered by the user, including any loss suffered by the user resulting from the inaccuracy or invalidity of any data

created by the AVEVA software, irrespective of whether such losses are suffered directly or indirectly, or arise in

contract, tort (including negligence) or otherwise.

1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the

performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the user's

claim is brought.

1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.

1.5 In the event of any conflict between the above clauses and the analogous clauses in the software licence under

which the AVEVA software was purchased, the clauses in the software licence shall take precedence.

Copyright

Copyright and all other intellectual property rights in this manual and the associated software, and every part of it

(including source code, object code, any data contained in it, the manual and any other documentation supplied

with it) belongs to, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.

All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this document

is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without

the prior written permission of AVEVA Solutions Limited. Where such permission is granted, it expressly requires

that this copyright notice, and the above disclaimer, is prominently displayed at the beginning of every copy that is

made.

The manual and associated documentation may not be adapted, reproduced, or copied, in any material orelectronic form, without the prior written permission of AVEVA Solutions Limited. The user may not reverse

engineer, decompile, copy, or adapt the software. Neither the whole, nor part of the software described in this

publication may be incorporated into any third-party software, product, machine, or system without the prior written

permission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictly

prohibited, and may give rise to civil liabilities and criminal prosecution.

The AVEVA software described in this guide is to be installed and operated strictly in accordance with the terms

and conditions of the respective software licences, and in accordance with the relevant User Documentation.

Unauthorised or unlicensed use of the software is strictly prohibited.

Copyright 2008 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA shall

not be liable for any breach or infringement of a third party's intellectual property rights where such breach results

from a user's modification of the AVEVA software or associated documentation.

AVEVA Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom

Trademark

AVEVA and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use of

the AVEVA or Tribon trademarks is strictly forbidden.

AVEVA product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or its

subsidiaries, registered in the UK, Europe and other countries (worldwide).

The copyright, trademark rights, or other intellectual property rights in any other product or software, its name or

logo belongs to its respective owner.

AVEVA Solutions Limited


3/68

Revision Sheet

Date Version Comments / Remarks

September 2011 1.4 Issued

February 2013 2.1 Updates incorporated

ReviewShare Server Installation Guide


4/68



5/68

ReviewShare ServerInstallation Guide

Contents Page

2.1i


Copyright 2008 to current year.AVEVA Solutions Limited and its subsidiaries.All rights reserved.

AVEVA ReviewShare Server 2.1

& AVEVA ReviewShare Replication Server 2.1

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Windows XP and Windows Server 2003 Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Server Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1

ReviewShare Server Speci fications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1

ReviewShare Replication Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2

Set up a ReviewShare Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Server Preparation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

AVEVA Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Configure IIS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Install ReviewShare Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4

Retrieving the IP Address. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5

Sharing the Storage Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6

ReviewShare Server Admin Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7

Server Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8

Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8

Service Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:9

Connection Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:11

Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:12Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:12

Model Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:14


6/68

2.1ii



Published Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:15

Troubleshooting ReviewShare Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:16

Sett ing up a ReviewShare Replication Server . . . . . . . . . . . . . . . . . 4:1

Prerequis ites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

Install the Windows FTP Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2

Create an FTP Site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:4

Enable Basic Windows Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:7

Create a Folder to be Monitored . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8

Replication Server Admin Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:10

Test the Replication Server is live . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:15

Trouble shooting Replication Server Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . 4:15

Network Layout Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1

Single Server LAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1

Open Access Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:2

VPN Access Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:3

Internal and External Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:4

Running IIS and ReviewShare Server . . . . . . . . . . . . . . . . . . . . . . . .A:1

Configure dual IP Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:1

Replication Server XML File Format . . . . . . . . . . . . . . . . . . . . . . . . .B:1

Re-Starting the Replication Server Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B:3

Generate Timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B:4

Generate Timestamps unchecked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:4

Switching between modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:5

RVMtoZGL Select ionID Conf iguration. . . . . . . . . . . . . . . . . . . . . . . .C:1

Data Injection via Portal Import tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C:2Header Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C:2

Data Rows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C:2

Multiple CSVs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C:3

#COLOUR Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C:3

#MATERIAL Column. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C:3

Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C:3

ReviewShare Server Manual Configuration . . . . . . . . . . . . . . . . . . .D:1

Working Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D:1

Testing the ReviewShare Server is Live . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D:1


7/68

2.1


ii i Copyright 2008 to current year.AVEVA Solutions Limited and its subsidiaries.All rights reserved.

Registry Customisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D:2

Changing the IP Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D:2

Specifying Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D:2Re-Starting the ReviewShare Server Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D:2


8/68

2.1iv




9/68


10/68


11/68


12/68

2.12:2


Server Specifications


2.2 ReviewShare Replication Server

Minimum Specification for running ReviewShare Replication Server:

If installed on a separate machine the HDD configuration is recommended to be greater on

a Replication Server due to its likely hood of having multiple Workstations accessing large

uncompressed files simultaneously.

The following specification is recommended for optimum performance of the ReviewShare

Replication Server.

CPU 1 GHz 32-bit (x86)

RAM 1 GB of system memory

CPU 2 GHz 32-bit (x86)

RAM 2 GB DDR-2


13/68


14/68

2.13:2


Set up a ReviewShare Server


If web hosting is required on the same machine a second IP address must be assigned to

allow both services to run. Refer to Running IIS and ReviewShare Serverand continue to

Sharing the Storage Area.

If the service is not required then the following steps describe how to check if the service is

running and if so, how to disable the service.

1. On the Windows taskbar click Start, point to Control Panel, and click.

2. Double clickAdd or Remove Programs .

3. ClickAdd/Remove Windows Components.

4. If running Microsoft Windows XP Pro skip to step 6.

5. In the Components list, highlightAppl ication Serverand then click Details.

6. Highlight Internet Information Services (IIS)(do not alter the check box).


15/68



2.13:3 Copyright 2008 to current year.AVEVA Solutions Limited and its subsidiaries.All rights reserved.

.

7. Click Details.

8. Click to clear the World Wide Web Service check box.

9. Click OK

10. Click again on OK

Note: A progress bar may appear indicating that the service is being stopped and removed.


16/68

2.13:4




3.2 Instal l ReviewShare Server

The ReviewShare Server is shipped with a standard Windows Install Wizard, follow the on

screen prompts during the install process.


17/68




3.2.1 Retrieving the IP Address

During the installation process the user will be prompted to supply the IP address or

Hostname of the machine.

A static IP address should only be specified if it will not change for the lifetime of 3D models

hosted on the server. Specifying a hostname is the preferred method.

To obtain the Server Hostname conduct the following steps:

1. On the Windows taskbar select Start>Run.

2. When prompted enter the text CMD.

3. At the command prompt enter the text HOSTNAME.

4. The hostname of the Server will be returned (If the Server is configured to supply fileson the Internet it is recommended to specify the IP address).

To obtain the Server IP Address conduct the following steps:

1. On the Windows taskbar select Start>Run.

2. When prompted enter the text COMMAND.

3. At the command prompt enter the text IPCONFIG.

The IP Address of the Server will be returned.

Note: After running the Install Wizard it is necessary to configure the server before the

service will function.


18/68

2.13:6




3.3 Shar ing the Storage Area

During installation a folder will be created which will be monitored by the ReviewShare

Server. This folder will be used to distribute and convert ReviewShare files.

The default path will be:

C:\AVEVA\ReviewShareServer\Data

If the ReviewShare Server is used in a DMZ, WAN or large network configuration then the

user may need to setup a Replication Server and FTP access to the ReviewShare Server

Data directory (refer to Setting up a ReviewShare Replication Server). In this case it will not

be necessary to share the Data folder.

It is possible to create multiple work folders below Data folder which will be monitored

automatically.

1. In Data create a sub folder RS.

The Data folder should be shared on a network so that client workstations can readand write freely to this folder.

2. In the file browser right click on the newly created folder and select Properties.

3. In the Propertieswindow click on the SharingTab

4. Click Share this fo lder option button.


19/68




5. Leave the Share name as Data

6. Click the Permissions button

7. In the Permissions Window add the Usersand Groupsthat are to be allowed accessto the Data folder. In the following example Everyonehas been granted Full Control,this will allow all users on the network to read and write to the Data folder.

3.4 ReviewShare Server Admin Tool

An administration tool is installed with the ReviewShare Server that allows the user to

configure the server.Click Start > All Programs> AVEVA > ReviewShare Server > Admin Tool .


20/68

2.13:8




The user interface is divided into different areas.

3.4.1 Server Status

The Status of the ReviewShare Server is displayed in the top left area of the user interface.

The Statusof the ReviewShare Server service can be either Runningor Stopped.

If the service is running the user can click Stop service. Once the service is stopped the

user can click Start Service to resume the service.

The user can only make a configuration change when the service is stopped and any

changes will not take effect until they are applied by clickingApply Changes.

Changes to the configuration can be discarded by clicking Revert Changes.

3.4.2 Diagnostics

The user can perform a diagnostic on the ReviewShare Server service.

The service status must be Running to be able to complete a diagnostic.


21/68




Click Test Serviceto perform a series of automated diagnostic actions on the service.

When a the user begins a test the service will write a simple file to the data directory and

wait until it detects that it has been successfully processed and published. When the test is

finished the test file is deleted.

A test will take seconds to complete and the result will be displayed in the Test Results

area.

3.4.3 Service Configurat ion

Configuration is arranged in a series of tabs to allow the user to set up various environment

settings and parameters.

From the Servicetab the user can control common attributes of the ReviewShare Server

service.

Working Directory

A ReviewShare Server has two modes of processing data files, standalone and distributed.

In Standalone Servermode the local machine handles all processing of data - this is the

default state when first installed.


22/68

2.13:10




The Distributed Processingmode allows multiple servers to process the same data folder

on a shared network location, increasing the maximum number of simultaneous publishing

processes. Distributed Processing can lead to faster publishing times by spreading server

work load.

In Distributed Processing mode there must be one 'master' server and any number of

'remote' servers. The master controls the marshalling of data between all the servers and

also the viewer client connections. The remote servers will typically perform only data

processing.

Standalone

The Working Directory should be set to local install path of the server

Distributed mode (Master)

The Working Directoryshould be set to a UNC path that is equivalent to the localserver installation path for example \\server\aveva\ReviewShareServer

Distributed mode (Remote)

The Working Directory should be set to a UNC path that is equivalent to themaster server installation path for example \\server\aveva\ReviewShareServer

When using distributed mode the user must make sure the local service account has read/

write access to the UNC path for the data directory. The user can configure the service to

log on as a different user that has required permissions - this must be done in the Windows

services manager.

Machine Address

The IP address or Hostname of the server can be manually defined in the Machine Address

box. Typically this is the local host name.

Parameters

The number of server components can be configured:

Test Distributed Processing

Testing the configuration for a distributed setup can be difficult as multiple machines are

involved and due to the nature of the distributed setup multiple machines are processing the

same data.

To setup and test distributed processing follow the steps below:

Executors The maximum number of simultaneous publishing

processes allowed, the default is 2.

File Managers The number of file manager processes available. Only one

can be active at any one time and is used to marshal access

to the data directory, the default is 1.

Having more than one may be useful in case one process

crashes. Setting this to 0 is advisable for remote servers in

distributed mode.Connection Servers The number of processes that handle viewer client

connections. This may be set to 0 for remote servers in

distributed mode.


23/68




Distributed Master Server

Make sure all servers are stopped.

Configure working directory and make sure the Number of Executors is set to > 0.

Test the service.

Distributed Remote Server

Make sure all servers are stopped

On the master server, make sure it is configured as distributed service and thatNumber of Executors is set to 0.

Start master server

On the remote server, ensure that both the number of connection servers and filemanagers are set to 0. Ensure that number of Executors is > 0.

Test the remote server

Following this method will ensure that the master set up is correct in the first instance andthat remote servers are able to process data.

Stopping all servers except the one being tested and setting num executors to 0 ensures

that the server doing the publishing is the one currently being tested.

3.4.4 Connection Conf igurat ion

The Connection tab allows configuration of how client computers can connect to the server.

This configuration is passed to each client as soon as they connect. Once received, a client

will then modify its connection method to conform to the server connection configuration.

Al low HTTP

Specifies that the server will accept client connections using the HTTP protocol overport 80.


24/68

2.13:12




When disabled clients should not attempt to connect using this method and the serverwill reject any clients that do.

Al low TCP Specifies that the server will accept direct client connections on available ports

When disabled clients should not attempt to connect using this method and the serverwill reject any clients that do.

Al low HTTP Connect

Specifies that clients will attempt to make a direct connection the server, via a proxy,using the proxy specific CONNECT protocol. Note that Allow TCP must be enabled toallow this connection method.

When disabled clients should not attempt to connect using this method.

Default number of connections per client

Specified how many concurrent connections a client should make to the server whenstreaming model data.

Specifying a greater number of connections can help improve performance on highlatency environments though may increase overall bandwidth.

Note: This setting is a server default and can be overridden by clients.

3.4.5 Reporting

The administration tool provides reporting based on logs and/or data available in the server.

There are three sub tabs for reporting, these are Logs, Model Data andPublished Data.

Below the sub tabs a disk usage panel will display information about the disk spaceavailable.

Click the down arrow ( ) to reveal a detailed summary of disk usage:

Logs

The server produces log files on a daily basis. These logs provide information ranging from

the behaviour of the server down to the access of specific files/models.


25/68




Logs are divided into four categories:

Log entries

The first three categories (Connection Server, Executor and File Manager logs) will display

the data arranged in the following columns:

The tree view on the left hand side allows selection of a specific log file from a category.

Logs are only displayed when the top node is expanded. Expanding a top node triggers a

folder read.Selecting a top node - after being expanded - will display all the entries available for such

category.

Filtering

Entry filtering is available based on the type of event (e.g. Error, Warning, or Information).

These filters are applied to any of the log files from the first three log categories (Connection

server, Executor or File manager log).

Sorting

Log entries can be sorted by column. The initial appearance of a log will present the entries

sorted by date, with the most recent entry at the top.

Connection server logs Registers information regarding certificates, server

connectivity, and licencing amongst others.

Executor logs Records basic information about operations.

File manager logs Lists all the operations regarding file publishing, file access,

etc.

Usage logs Enters information regarding model usage.

Date accessed The date and time of the event.

Event type The severity of the event, ranging from Error, Warning to

Information .

Event ID An internal identifier used to select the type of message to

be registered.

Message A basic description of the event.


26/68

2.13:14




Usage Logs

Data in the Usage Logs is displayed differently to the first three types of log. There is no

concept of event type or event id.

The columns of data displayed for Usage logs are as follows:

Model Data

Click the Model Data tab to display information about the files located under the "data"

folder of ReviewShare Server.

Date accessed Registers the time and date of the connection to the server.

Model name Identifies the model being accessed or displayed.

Data Transferred The amount of data transferred during the recorded session.

Peak connections The number of HTTP connections during the recorded

session.

Duration The length of time that the recorded session lasted.

IP address The IP address of the computer requesting a connection to

the server.


27/68




Click the Watch Folder box to enable monitoring of the data folder. The list will update

whenever a data file has been created, deleted or modified.

The Models tab will display a list of what files can be published to the server (and copied to

the "cache" folder).

Amongst other factors, the list presents:

Date accessed - Shows the last accessed time and date of the model,

Model name - Displays the name of the file,

Type - Shows the extension of the model file,

Size - Displays round-up size of the model file in Kbytes.

Publishable - Indicates whether the file can be published to the server.

The number of model files found and the total size of model data is displayed.

Published Data

The Published Data tab shows a list of models that have been published. These files are

collected under the "cache" folder, and organized in subfolders based on internal hash

functions.

As with the Model Data tab, the Published Data tab also enables folder watch.

Data deletion

In addition to displaying basic information about the published data, the Data deletion tab

provides basic file management. Users can select one or multiple files and delete them.

Deletion of files can be triggered by clicking Delete Selected, or by a "context menu". Users

are prompted for confirmation to avoid deleting files inadvertently.

In the event of deleting a published file, the server will try to republish it the next time it is

started. It the deleted file is part of a group of files related to a particular model file, all

related these related files will be deleted, and republished.


28/68

2.13:16




Orphan data, that is data that is not linked to a model in the "data" folder, can be deleted

immediately. Orphan data can be simply data left behind. This helps with the keeping of the

disk space.

The Publish Data Listing provides basic information about the size and date of access,

namely:

Date accessed - Displays the last accessed time and date of the published file.

Path (Uri) - Shows the actual file address presented in full.

Type - Published files fall into three types

ZGL - Graphical related data.

VS - VizStream data.

VI - Visual indexing information, and

APX - Information related to internal geometry approximation.

Not all published models will create these types.

Model name - This column shows the source of the published file. It only shows themodel name if it is present in the "data" folder. Otherwise, it can be classified as"orphan data".

Size - Highlights the size of the published file. It is presented in Kbytes.

3.5 Troubleshooting ReviewShare Server

Log Files

The ReviewShare Server records various types of troubleshooting and debugging

information in files located in a sub-directory of the default install path called Log.

The log files use the following naming conventions: ACTION-YYYYMMDD.log where

ACTION is the task taking place when the error was encountered. The format of this log is

undocumented, but in some situations it may contain useful information.

The most common problems are related to file system errors. These errors are recorded in a

file with the action FileManager.

A common FileManager error is an Out of disk space error. ReviewShare Server requires at

least 4% disk space free to process new geometry data.


29/68




If the user is shown out of disk space errors and have multiple drives then it maybe that the

disk with the temp directory is nearly full.

If during publishing of very large models the disk becomes full, then the publish will fail and

then the temp files are removed. This may result in the appearance that the disk has enough

free space, when in fact it does not.

An Out of disk space error can be resolved by installing the server on a larger disk drive and

assigning the system TEMP environment variable to a drive with more than 4% free. As a

guideline the amount of free disk space should be at least five times the size of the data

directory and the amount of free space is at least 100 times the size of the largest model the

user is publishing.

ReviewShare Server is divided into four main components each running as a separate

process. There are 2 Executor processes, 1 Connection Server, 1 File Manager.

A fifth process, the Process Watcher will monitor the four components, if one fails the

watcher will restart that process automatically. This can result in a continuous loop where a

process will fail and then be instantly restarted by the process watcher. Further diagnosis of

the problem can be made by then viewing the appropriate log file in the Logfolder.

Coordination of Service Log On and Temp Paths

It is recommended to set the service to 'Log on as:' the 'Local System account' (this is the

default installation):


30/68

2.13:18




(In the services windows, launched from services.msc, right click on the ReviewShare

Server instance and select Properties).

The Local System Account uses the System temp environment variables, whereas if

running under a user account it uses the user's temp environment variables.

The account under which the service is logged on as needs access to the TEMP folder,

otherwise errors will occur while publishing. Access to the TEMP folder will be fixed by

changing the system TMP and TEMP environment variables to a folder that the service has

access to.

Conflicting Ports

The server may be running a firewall that is disabling access to the ReviewShare Serverports. Refer to Specifying Portsfor a detailed explanation of how to change the default ports

used by ReviewShare Server.

IP Addresses

If the log files do not indicate a software fault then the next step in diagnosing a problem is

to inspect the network configuration.

Open a Windows Command prompt and type ipconfig /all (see also Retrieving the IP

Address) to determine what network interfaces are available. If the server is configured to

use a particular address, this will be stored in the following registry key:

HKEY_LOCAL_MACHI NE\ SYSTEM\ Cur r ent Cont r ol Set \ Servi ces\ Vi zSt r ea

m Ser ver \ Par amet er s\ I PAddr ess


31/68




This entry can also contain a Hostname. If it is an IP address, then this address should be a

static IP address. If this address cannot be static, either use a Hostname or do not specify

the address. When it is not specified the server will use the first available address on the

machine.

Once the user has determined the ipaddress the server is using, the user can test the

connection to the server by typing http://ipaddress/test in internet explorer on the server

machine (refer to Testing the ReviewShare Server is Live).

The user can also use http://ipaddress/license to test the licensing and the connection. If

either of these results in a 404 page, then the server is not configured correctly and may be

due to one of the following common scenarios.

The most common problem is an ip conflict with a Webserver. This can diagnosed by first

stopping the webservice and then restarted the ReviewShare Server Service (refer to Re-

Starting the ReviewShare Server Service). If either of connection tests work, then the

problem has been located.

If the web service is needed, then the user needs to follow the instructions Running IIS and

ReviewShare Server. If the service is not needed, then either stop and disable the service of

uninstall the component as detailed in Configure IIS.

License

Problems can arise if ReviewShare does not have a valid license. The ReviewShare Server

is not licensed by itself. When unlicensed it will only allow one connection. Any other client

that connects will get a license violation message.

Ultimately, the vslicense.dll will delegate to FlexMan to determine the license available. The

user must check that this is configured correctly by running the FlexMan Configuration Utility

(see AVEVA Licensing). This can be found on the Review DVD or via the global support

site.) The user must make sure to set a system level environment variable or registry entry.This is needed since the service (by default) runs under the system account.

The user can check the status of server licensing by typing http://ipaddress/license in

internet explorer. If licensing is place for a ReviewShare Server, it should look like the

following example:

Regi st ered Name: AVEVA Sol ut i ons Li mi t ed

Expi r at i on Dat e: 1/ 1/ 3000

Ser ver Ver si on: 3. 10

Maxi mum Number of Vi zSt r eam Connect i ons: 9999

Maxi mum Number of Spi cer Connect i ons: 9999

Maxi mum Number of Cat i a Connect i ons: 9999

Maxi mum Number of Messagi ng Connect i ons: 9999

Speed: Opt i mal

Li cense I nf o: Revi ewShar e Li cense

VSLi cense DLL I nf o: Val i d Li cense DLL

Eval uat i on Message:

Tr ust ed Aut hor i t i es:


32/68

2.13:20




AVEVA Sol ut i ons Li mi t ed

Li censed Appl i cat i ons:

Al l Aut hor i t i es Tr ust ed

Observe the list of Trusted Authorities. The authority should be the same as the certificate

that is on the VSLicense.dll. This test is simply a report that the server recognises a valid

vsplatform.lic and vslicense.dll. It does not indicate whether a license will be obtained when

a client connects.

If the license is not configured correctly, it will often look like a network problem since the

client will report no connection. Often there will be many connection server restarts in the

log. If the user suspects this, rename both the license files and restart the service. Then try

to connect one client.


33/68


Setting up a ReviewShare Replication Server


4 Setting up a ReviewShare Replication Server

The ReviewShare Replication Server is an optional component which a system

administrator can install when the network infrastructure dictates. Example of Network

Layout Scenariosare discussed in later sections of this manual.

Although the ReviewShare Server and ReviewShare Replication Server can be installed onthe same machine it is recommended they are ultimately installed on separate nodes as

follows:

User Workstation running the AVEVA Review application.

ReviewShare Replication Server with a shared folder that Review will save its files to,when the user wants to publish the model.

ReviewShare Server also running an FTP service to allow the file replication server toupload rvm/rvz files to this server.

The purpose of the ReviewShare Replication Server is two-fold:

The server uploads files to a ReviewShare server for publishing.

The Replication server maintains information for Review about ReviewShare server so

that ReviewShare files get generated with the correct server references.

A ReviewShare Replication Server will monitor folders on a local network and upload files

with a specified extension directly to a ReviewShare Server. Links to these files are also

managed so they resolve correctly to the specified ReviewShare Server resource.

The following section details how an administrator should set up and configure a

ReviewShare Replication Server.

The ReviewShare Replication Server is shipped with a standard Windows Install Wizard but

this must not be run before the following Prerequisites have been met.

4.1 Prerequisites

Note: This section describes how to set up an FTP site using Microsoft XP Professional.

The process can vary depending on the Operating System in use and it is outside the

scope of this guide to describe all variations. The user is advised to refer to the

official Mircosoft documentation or web site for further advice when configuring an

FTP site.

The ReviewShare Replication Server uses FTP to copy files between locations, because of

this it is necessary to conduct the following tasks on the machine running ReviewShare

Server prior to continuing configuration of the ReviewShare Replication Server:

Install the Windows FTP Service

Create an FTP Site

Enable Basic Windows Authentication


34/68

2.14:2




Conduct the steps detailed in Install the Windows FTP Service, Create an FTP Site and

Enable Basic Windows Authenticationon the machine running ReviewShare Server then

proceed to Create a Folder to be Monitored to continue configuration of ReviewShare

Replication Server:

Note: If the ReviewShare Server and ReviewShare Replication Server are installed on the

same machine then the following steps still apply.

4.1.1 Install the Windows FTP Service


2. Double clickAdd or Remove Programs .

3. ClickAdd/Remove Windows Components.

4. If running a non Microsoft Windows Server OS such as Microsoft Windows XP Pro skipto step 6.

5. In the Components list, highlightAppl ication Serverand then click Details.

6. Highlight Internet Information Services (IIS) (do not alter the check box), and thenclick Details.


35/68




.

7. Click to select the following check boxes (if they are not already selected):Common FilesFile Transfer Protocol (FTP) ServiceInternet Information Services Manager.

8. Click OK.

9. Click Next


36/68

2.14:4




10. Insert the Windows CD if requested and click OK

11. Once files have been copied click Finish to complete installing the FTP Serverprocess.

4.1.2 Create an FTP Si te

Once the FTP service has been installed an FTP site should be created in IIS.


2. Double clickAdminist rat ive Tools.

3. Double click Internet Information Services (IIS) Manager.

Note: If running XP double click on Internet Information Services.

4. Right-click the Default FTP site,click New, click Virtual Directory.


37/68




5. Name the Virtual Directory ReviewShare and click Next.

6. Map the ReviewShare Virtual Directory to the RS folder created in Sharing theStorage Areaand click Next.


38/68

2.14:6




7. The user must grant the Write permission on the Virtual Directory by checking theWritecheck box. Click Nextto continue.

Once the new directory is created the following branch should be visible.


39/68




8. Right click on the Default FTP Siteand click Properties.

9. A Default FTP Site Propertieswindow will appear. Click on the Security AccountsTab.

10.On the Security Accountstab for the FTP site, make sure that theAl low anonymousconnectionscheck box is not selected.

11. Click OK.

4.1.3 Enable Basic Windows Authentication

After removing the Anonymous Connections check box the FTP server will use Basic

Windows Authentication.

It is necessary to set up a Windows Account for the FTP server to authenticate against.



3. Double click Computer Management.

4. In the console tree, expand System Tools, expand Local Users and Groups, and

then click Users.


40/68

2.14:8




5. On theAc tion menu, click New User.

6. Type the user name ftpuser, enter Full name as FTP Server Login, and Description ofthe user account as FTP Service Accoun t.

7. In Password type Ftpus3rand Confirm password by re-entering.

8. Check Password never expiresand uncheck all other boxes.

9. Click Create, and then click Close.

Note: After creating the user configure NTFS permissions for the directory or files for which

the user wants to control access by removing Everyonegroup and adding the newly

created ftpuser.

4.2 Create a Folder to be Monitored

On the machine with the ReviewShare Replication Server installed:

1. In the root create the following folder:

C:\ReplicationDirectory

The folder should be shared on the network so that other workstations can write freelyto this path:

2. In the file browser right click on the newly created folder and select Properties.

3. In the properties window click on the SharingTab.

4. Click the Share this fo lder option button.


41/68


42/68

2.14:10




4.3 Replicat ion Server Admin Tool

The ReviewShare Replication Server is shipped with a standard Windows Install Wizard,

follow the on-screen prompts during the install process.

After the Wizard has completed installing the necessary Replication Server files an Admin

Tool will be run allowing the user to configure the server to point to the monitored directory

and the destination FTP server that have been installed in the previous steps.

The tool will create an xml file containing all the configuration settings required for the

Replication server to run correctly. For advanced users details of the xml file structure are

covered in a later appendix.

The Admin Tool can also be run by clicking Start > All Programs> AVEVA > ReviewShare

Replication Service > Admin Tool .

When the Admin Tool is run for the first time a check will take place to detect if the xml

configuration file is present. If it is not then the following prompt will be displayed:


43/68




Click OK to create a new xml configuration file that will be editable in the admin tool. By

default the tool will create an xml file named FileReplicationService.exe.config and this will

be located in the default install directory of the Replication Server.

If a configuration file already exists then the following form will open without prompt and will

be fully populated with the contents of the xml configuration file. In the form, Generate

Timestamp checkbox will be selected as default, but the user has the option to remove it, if

required. For further details refer to Generate Timestamp.

Server ConfigIn the Server Config part of the form specify details of the FTP server that the ReviewShare

Replication Server will upload to.


44/68


45/68




By default the form will be pre-populated with sample data. This should be updated as

follows:

Testing Configuration

After the fields in the Admin Tool have been populated the user can conduct a test

connection to the FTP server.

Add Click add to insert a new line in the list of folders to be

monitored. When an entry is inserted the list will initially

populate with pre-set values which can then be changed

by editing the fields listed below.

Remove Remove a monitored directory from list.

Monitored Directory The shared directory where RVM, RVZ and ZGL files are

placed and referenced with Review locally.

Click Browse to open a standard Windows file browser

dialogue box.

In the case of the example made in Setting up a

ReviewShare Replication Serverthis should be populated

as C:\ReplicationDirectory

FTP Folder The Virtual directory on FTP site on the ReviewShare

Server.

In the case of the example made in Create an FTP Site

this should be populated as ReviewShare.

VizStream Directory The relative path to the files in the ReviewShare Server

data directory.

In the case of the example made in Sharing the Storage

Areathis should be populated as RS.

Apply Changes Click to store the values that have been input in the above

fields.


46/68

2.14:14




Click Test Settingsto attempt to make a connection to the FTP server.

If the connection is successful then a report will display as follows:

Conf i g: [ C: \ Repl i cat i onDi r ect or y; Revi ewShar e; RS ]

FTP Upl oad St at us: Successf ul l y compl et ed upl oad test .

Publ i sh St at us: The t est f i l e was successf ul l y publ i shed

on t he ser ver !

If a connection to the FTP server could not be established the following error will be

returned:

Fai l ed t o compl et e upl oad t est usi ng[ C: \ Repl i cat i onDi r ect or y; Revi ewShar e; RS]

Er r or : Fai l ed t o connect t o f t p: / / ukcamd1642/ Revi ewShar e

If a connection to the FTP service is successful then the Admin tool will attempt to publish a

file to test that the ReviewShare server responds. If there is a problem the following error will

be returned:

Conf i g: [ C: \ Repl i cat i onDi r ectory; r evi ewshar e; r s ]FTP Upl oad St at us: Successf ul l y compl et ed upl oad test .

Publ i sh St at us: The t est f i l e publ i shi ng t i med out .

Publ i sh Er r or : Unknown er r or

A l og of net wor k event s i s avai l abl e unt i l t he next t estr un at : C: \ TEMP\ 3e5do2n0. a00\ Net workEvent s. Log

In the case of a Publish error a log file is written which can be used to help trouble shoot

network errors.

If there is a license violation then the following error will be returned:

Li cence Vi ol at i on Detected: ukcamd3466: Cl i ent I D notl i censed f or vi ewi ng

Publ i sh Er r or : Unknown er r or

A l og of net wor k event s i s avai l abl e unt i l t he next t estr un at : C: \ TEMP\ sql 35myb. usk\ NetworkEvent s. Log

ReviewShare Replication Service

Once the a test connection has been conducted and a suitable monitored directory has

been set up, the user can then start the Replication Server service.


47/68




Click on Start to run the Replication Server service.

Click Stop to stop the service.

Note: It may take several seconds for the Replication Service to come to a stop or start

again. During this time the Status will display StopPending and StartPending

respectively.

Save and Restore

To reset the fields in the form to a default set of values click on the Restore Defaults button.

Click Save All Changes to write the contents of the form to the configuration xml file.

Note: For saved changes to take effect the Replication service must be stopped and then

restarted.

4.4 Test the Replication Server is l iveConduct the following steps to test that the Replication Server is running correctly.

Test the replication service by placing an RVM file in the replication directory. If theReplication Server is monitoring the correct directory it will automatically create a filewith the extension.RS. To show all hidden files open Windows Explorer and selectTools > Folder Options, then click Viewand under File and Folder optionsselect

Show hidden files and folders.

Test that the replication directory is available from other computers by navigating overthe network to the shared directory.

Test the FTP service is running by connecting to the FTP folder on the ReviewShareserver. If the user followed the above example the user should be able to type ftp://localhost/reviewshare in Microsoft Internet Explorer.

4.5 Trouble shooting Replication Server Errors.

The ReviewShare Replication Server will track errors which have been generated in the

Windows event log.

To view the event log:

1. On the Windows taskbar clickStart, point to Control Paneland click.

2. ClickAdminist rat ive Tools.

3. Double click on Event Viewerto open the following window.


48/68

2.14:16




4. Under the Event Viewer (local)selectAVEVA.

5. View errors that have been logged by the ReviewShare Replication Service by doubleclicking on an entry to open the following window

In the Description part of the Event Propertieswindow a detailed summary of the error will

be logged. This can be used to help troubleshoot most errors.


49/68


Network Layout Scenarios


5 Network Layout Scenarios

Consideration should be made to the type of network that is in place when installing the

ReviewShare Server and ReviewShare Replication Server.

This section illustrates various scenarios that may be put in place.

5.1 Single Server LAN

The following example illustrates the results of the install of the ReviewShare Server on a

small LAN. All machines in this configuration are placed on the same domain.


50/68

2.15:2




5.2 Open Access Model

In the following example a ReviewShare Server is placed in a simple DMZ (demilitarized

zone), allowing the server to be publicly available on the Internet while simultaneouslyavailable to an Intranets subnetwork.

When this configuration is used the ReviewShare Server should be on an IP address

accessible from the Internet.

The ReviewShare Replication Server is placed within the Intranet subnet and will FTP files

up to the ReviewShare Server.


51/68




5.3 VPN Access Model

The following example illustrates a layout with a ReviewShare Server and ReviewShare

Replication Server placed behind a VPN.

In this case it will be necessary to tunnel requests through the VPN and forward port traffic

to the respective IP addresses of the servers.

In the case of Microsoft VPN solutions it may be necessary for ports 47 and 1723 to be open

on a firewall.


52/68


53/68


54/68

2.1A:2


Running IIS and ReviewShare Server


5. Right click on the Default Web Siteand select Properties.

6. From the Web Sitetab and in the IP Addressfield type in the first IP address bound tothe network interface card.

7. ClickApply, and then OK.

Disable socket pooling on the Server Machine as follows (for IIS 6.0 skip to step 2):

1. Refer to instructions detailed in Microsoft knowledge base article 238131 Disablesocket pooling (http://support.microsoft.com/kb/238131).

2. Refer to instructions detailed in Microsoft knowledge base article 813368 (http://support.microsoft.com/kb/813368). Use the first IP Address again for the httpcfgcommand. Test with netstat -anto check if 0.0.0.0:80 is listed. If it is still listed, a serverreboot may be necessary.

The anonymous IIS login needs to be set to a user that has read and write access to the

SQL Server. This can be set as follows:

1. On the Windows taskbar click Start, point Settingsthen Control Panel and click.2. Double click onAdminist rat ive Tools.

3. Double click Internet Information Services (IIS) Manager (Internet InformationServices in XP).

4. Select servername, which is the name of the Server Machine.

5. Right click on the Default Web Siteand select Properties.

6. From the Directory Securitytab click Edit.

7. Click Editand type in the name of a user with the correct access rights.

8. Make sure to uncheckAl low IIS to control passwords .

9. Click OKand restart the web service.


55/68


Replication Server XML File Format

2.1B:1 Copyright 2008 to current year.AVEVA Solutions Limited and its subsidiaries.All rights reserved.

B Replication Server XML File Format

When the Replication Server Admin Tool is launched a configuration file (FileReplication

Service.exe.config) is created in the default install path:

C:\AVEVA\ReviewShareReplicationService

The Admin Tool will allow easy configuration of the file but this appendix details the structureof the xml content. Using this it will be possible to manually edit the configuration file using a

standard text editor such as Notepad.

Note: The ReviewShare Replication Service must be stopped before the config can be

edited.

The following tables list the XML attributes within the config file which must be edited

manually:

As well as configuring the monitored folder locations details of the ReviewShare Server are

specified in the following XML attributes:

MonitoredDirectory The shared directory where RVM, RVZ and ZGL files are

placed and referenced with Review locally.

In the case of the example made in Setting up aReviewShare Replication Serverthis should be populated

as C:\ReplicationDirectory

FtpFolder The Virtual directory on FTP site on the ReviewShare

Server.

In the case of the example made in Create an FTP Site

this should be populated as ReviewShare.

VizStreamDirectory The relative path to the files in the ReviewShare Server

data directory.

In the case of the example made in Sharing the Storage

Areathis should be populated as RS.

VizStreamServer The IP address or network name of the ReviewShare

Server.

In the case of the example made in Retrieving the IP

Address this should be populated with the IP Address or

Hostname of the ReviewShare Server.

MaxFileTransferThreads The maximum number of FTP uploads that can happen at

one time.


56/68


57/68




If more scanned directories are added then the user must specify a distinct FTP folder and

the VizStreamDirectory name, if this is not the case then the service will not start and an

error will be written to the Windows Event Log (see Trouble shooting Replication Server

Errors.). If this is the case then a new Virtual Directory must be created on the FTP server

as detailed in Create an FTP Site.

The following example illustrates a config file that will monitor two folders.

B.1 Re-Starting the Replication Server ServiceOnce the ReviewShare Replication Server has been installed and configured the service

should be stopped and restarted for the changes to take effect.

1. On the Windows taskbar clickStart, point to Control Paneland click.

2. ClickAdminist rat ive Tools.

3. Click Services.

4. In the list highlight ReviewShare File Replicatior.


58/68


59/68




B.2.2 Switching between modes

If the user has models published with Generate Timestampson, then turns the setting off

and restarts their replication service, then the timestamp files will remain, but there will be

non-timestamped versions uploaded, so that if the user turns Generate Timestamps back

on, it wont have to upload those files again.


60/68


61/68


RVMtoZGL SelectionID Configuration

2.1C:1 Copyright 2008 to current year.AVEVA Solutions Limited and its subsidiaries.All rights reserved.

C RVMtoZGL SelectionID Configuration

This section applies equally to RVMtoZGL and AVEVA.Portal.Import.Review.exe.

RVMtoZGL.selection.xml

The RVMtoZGL.selection.xml configuration file can be used to better identify selectable

elements within the 3D view.

The RVMtoZGL.selection.xml file is the default configuration file supplied with the server. It

is a simple XML file consisting of a list of PDMS database elements type to 'INCLUDE' as

part of a select action in the view and a list of element types to 'EXCLUDE'.

Additionally, there is an option to include or exclude element types by default.

If configured to include by default, only the exclude list will be used. If the default is to

exclude then only the include list is needed.

When an element is discovered in the RVM its name is parsed to find the element nearest to

the root (highest in the hierarchy) whose element type satisfies the INCLUDE criteria.

If no match occurs the translator will simply fall back looking for '/' in the element name.For instance, given an element whose name is "TEE 1 of BRAN /Pipes";

With no configuration, this will have the SelectionID "/Pipes", matching only the '/' in thename as an included component

With configuration, this will have SelectionID "TEE 1 of BRAN /Pipes", matching the'TEE' element in the include but not the 'BRAN' element

RVMtoZGL

Due to being unable to pass command line arguments to this translator it will automatically

search for configuration files and use them if found. The default configuration can be

overridden with a user defined configuration if preferred.

The translator will then, in order of preference, use the following configuration files.

1. User.selection.xml

2. Rvmtozgl.selection.xml

If both are discovered, the user defined file will be used and the rvmtozgl.selection.xml will

not be parsed.

If nether are present the behaviour will default to looking for '/' characters in names.

AVEVA.Por tal.Impor t.Review.exe

No default configuration is used for this translator to ensure backwards compatibility with

previous versions.


62/68

2.1C:2




Instead a new command line argument "-p" should be used to specify the configuration file

to use.

The file "rvmtozgl.selection.xml" can be used from the Server if desired.

User defined element types

Any User defined element types(UDETs) should be added to the configuration to make sure

the translators can make an informed decision about selection.

End users must add both the description of the UDET (short name and full name) to the

configuration file.

When using rvmtozgl it is recommended to copy the default configuration to

"user.selection.xml" so that the configuration will persist if the server is uninstalled/

reinstalled.

C.1 Data Injection via Portal Import toolThe Data Injection mechanism allows a user to modify how a RVM is translated to ZGL and

introduce custom colouring and/or data tags to the resultant ZGL.

AVEVA.Por tal.Impor t.Review.exe

This translator converts from RVM to ZGL and takes a number of arguments. This feature

introduces a new argument "-d " that specifies an external data source to use when

translating the model.

This flag may be used multiple times and can contain wildcards.

Any external data file specified should be in the format of a CSV (comma separated values)

file.

When parsing the model the translator will match object names with names stored in the

CSV file(s) and if a match is found add all relevant associated external data to the resultant

ZGL with respect only to that object.

CSV Format

The CSV format is well known and easy to read/write but for our purposes any external data

file must conform to the following specification.

Header Row

The first line of the file must define the number of columns and their names for theentire file. These will be the column 'headers'.

There must be at least one header column '#NAME'. This identifies this column asbeing the one to look in when matching names in the RVM/ZGL

Header column names "#MATERIAL" and "#COLOUR" are reserved to allow changingthe colour of elements via the CSV.

Any other values for the column name will be used as arbitrary text data that is mergedinto the ZGL

Data Rows

Every following row should contain the exactly the number of columns as defined in theheader row. Even empty columns must be specified (eg. ",,")


63/68


64/68

2.1C:4





65/68


ReviewShare Server Manual Configuration

2.1D:1 Copyright 2008 to current year.AVEVA Solutions Limited and its subsidiaries.All rights reserved.

D ReviewShare Server Manual Configuration

The user can make configuration changes to AVEVA ReviewShare Server by making direct

alterations outside of the ReviewShare Server Admin Tool.

D.1 Working DirectoryThe following registry key string value must be set to point to the folder where the

ReviewShare Server files have been installed:

1. On the Windows taskbar select Start, point to Run and click OK.

2. When prompted enter the text REGEDIT

3. In the Registry Editor navigate to the following branch:HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\VizStreamServer\Parameters\WorkingDirectory

In the case of a default installation the value should be:

C:\AVEVA\ReviewShareServer

If a change is made to this value the ReviewShare Server must be stopped and re-started,

refer to Re-Starting the ReviewShare Server Service

D.2 Testing the ReviewShare Server is Live

To check if the ReviewShare Server is running correctly, on a client PC connect to the server

using a web browser.

Go to the IP address http://xxx.xxx.xxx.xxx/test where xxx.xxx.xxx.xxx is the IP address of

the server, this can be retrieved by referring to Retrieving the IP Address.

If the server is functioning correctly, a message similar to below will be displayed.

Vi zSt r eam Pl at f or m 3. 12

Funct i oni ng: GMT 16: 10 on 11/ 14/ 2007

SSL Not Conf i gur ed

HTTP/ 1. 1 header s f r om 10. 0. 100. 186

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

accept : i mage/ gi f , i mage/ x- xbi t map, i mage/ j peg, i mage/ pj peg,appl i cat i on/ x- shockwave- f l ash, appl i cat i on/ vnd. ms- excel ,appl i cat i on/ vnd. ms- power poi nt , appl i cat i on/ mswor d,appl i cat i on/ xaml +xml , appl i cat i on/ vnd. ms- xpsdocument ,appl i cat i on/ x- ms- xbap, appl i cat i on/ x- ms- appl i cat i on, */ *


66/68

2.1D:2




accept - l anguage: en- gb

accept - encodi ng: gzi p, def l at e

user - agent : mozi l l a/ 4. 0 ( compat i bl e; msi e 6. 0; wi ndows nt5. 1; sv1; . net cl r 1. 1. 4322; . net cl r 2. 0. 50727; . net cl r3. 0. 04506. 30)

host : 10. 0. 100. 186

connect i on: keep- al i ve

D.3 Registry Customisation

Aspects of a ReviewShare server can be customised after installation. These changes can

be made by altering values in the Windows Registry. All changes made should be followed

by a ReviewShare Server restart.

D.3.1 Changing the IP Address

The IP address or Hostname entered during the install process can be changed by editing

the following value in the Windows Registry:

1. On the Windows taskbar select Start, point to Run and click OK.

2. When prompted enter the text REGEDIT

3. In the Registry Editor navigate to the following branch:HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\VizStreamServer\Parameters\

4. Double click the entry for IPADDRESS.

5. Enter a valid IP address or Hostname.

D.3.2 Specifying Ports

By default, the ReviewShare Server uses ports 80, 1557, 554, and 443. It uses these ports

to enable clients to connect through whatever firewall and proxy servers they may have. The

ReviewShare client, attempts to use whichever of these ports it determines will be the most

effective.

Although it is not recommended for servers which will be used from the Internet, the ports

that the ReviewShare uses are configurable.

To specify the ports that the ReviewShare Server uses, create a registry value named,

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\VizStream

Server\Parameters\PortNumbers if one does not already exist.

Set the value of this key to be a comma delimited list of the port numbers to use. The list of

ports should be a subset of those available to the ReviewShare Client to function correctly.

The actual port used by the ReviewShare Client can later be checked by viewing the

Performance > Network Status window in the Client application. For details of the

ReviewShare Client refer to the ReviewShare User Guide.

D.3.3 Re-Starting the ReviewShare Server Service

The ReviewShare Server must be stopped and restarted for the changes to the Windows

Registry take effect.



67/68



2.1D:3 Copyright 2008 to current year.AVEVA Solutions Limited and its subsidiaries.All rights reserved.


3. Click Services.

4. In the list of services highlight ReviewShare Server.

5. In the Services window toolbar, click the Restart button

A progress bar may be visible during a restart this is because the service will finish anycommitted actions before shutting down.


68/68



reviewshare server and reviewshare replication server 2.1 install guide

Documents