Vico Office R6.0 MR1 Installation Guide. February

Transcription

1 Vico Office R6.0 MR1 Installation Guide February 2016

2 Vico Office Installation Guide General process for installing Vico Office: 1. Check the system requirements for installation. 2. Decide which configuration will work best for you. 3. Install the Vico components. 4. Set up the license server. Installation Checklist Use the installation checklist to ensure that you have installed Vico Office successfully and have set it up for optimal use. To view this document, Microsoft Excel must be installed on your machine. Vico Office Overview The Vico Office system consists of components that can be installed in various configurations. The three main components are: Vico Office Client (VOC) Vico Project Server (VPS) Vico License Manager (VLM) Page 2

3 Vico Office Client (VOC) The Vico Office Client is the main program in Vico s integrated solution for construction planning, controlling and constructability analysis and is needed for all users who will interact with project data. The VOC provides a basic set of functions needed for creating, viewing and reporting of projects. Vico Office modules are task-specific programs that run in the VOC. A module is activated when a license for it is available on the user s system or via a license server. Vico Project Server (VPS) The Vico Project Server manages the access and storage of project data. The VPS creates new databases for each new project and maintains the master list of projects that is visible in the Vico Office application. A VPS can be installed together with the VOC or separately on a remote server. Note: To use Vico Office, a VPS must be installed somewhere (locally or on the network). Vico License Manager (VLM) Vico licenses can be installed locally (single user licenses) or remotely (floating licenses). Floating licenses must be installed on a host with a VLM. The VLM cannot be installed on a host where the VOC has been installed. For more information, see 23. Single User Licenses (SUL) Single user licenses are installed locally on a host where the VOC has been installed. Page 3

4 Floating Licenses (FL) Floating licenses are installed on the host where the VLM has been installed. The VOC systems pull licenses from the pool of installed licenses on the VLM. Licenses installed on a license server can be managed using the License Server Administration utility, which is accessed as a webpage (Start menu > Vico Software > Vico License Manager > Server Administration). Page 4

5 System Requirements These are the current system requirements for Vico Office, along with our recommendations for the configuration. Operating System Minimum Requirements Microsoft Windows 7 64-bit Recommended Minimum Configuration Microsoft Windows 7 64-bit Microsoft Windows 10 CPU Intel CPU: Intel Pentium 4 3GHz processor Equal to or greater than Intel Core i7 Quad-Core (or equivalent) processor 3.0 GHz Clock Speed recommended RAM 4GB Equal to or greater than 16GB HDD 10GB of free space on drive C: on client computers Disk space requirement on the VPS depends on the number and size of the projects Equal to or greater than 10GB of free space on drive C: on client computers Disk space requirement on the VPS depends on the number and size of the projects Display 1600x1080 or higher Equal to or greater than 1920x1080 or higher Video Card High-end OpenGL card with at least 512 MB onboard video memory (ATI or NVIDIA) Equal to or greater than high-end OpenGL card with at least 1GB onboard video memory (ATI or NVIDIA) Note: There is a noticeable difference in performance between the minimum requirements and the recommended minimum configuration. General Requirements The Vico Office Client (VOC) can interact with a remote Vico Project Server (VPS) over a local network connection (not a WAN). For optimal performance of the system, the network connection should have the following characteristics. Page 5

6 Item Low Latency Requirements The recommended maximum value for latency is 20ms. High Bandwidth Project data must be transferred from the VPS to the VOC continuously and in high volume. For good performance of the Vico Office views, a high bandwidth connection between the VPS and VOC is therefore required. Note: A high bandwidth and low latency connection alone is insufficient for providing good performance; the physical proximity between the VOC and VPS is also important. WAN configurations are therefore not supported, even with a high bandwidth and low latency connection. Firewall Exceptions The VOC communicates with the VPS and the Vico License Manager (VLM) over a TCP/IP connection using dedicated ports. Firewall exceptions are required in Windows firewall and, if applicable, in additionally installed software and/or hardware firewalls. Vico Office Client (VOC) Requirements These are the requirements for the correct installation of the VOC. Page 6

7 Item Requirements Windows 10 Supported operating systems Windows 8/8.1 Windows 7 Windows Server 2008 R2 Windows Server 2012 R2 Hard disk usage Full installation: Minimum of 10 GB of free disk space Memory Minimum: 4 GB Recommended: 16 GB or more Video card Open port requirements A high-end OpenGL card with at least 512 MB onboard video memory (ATI or NVIDIA) Ports 20, 21, 1026, and 1027 (inbound and outbound traffic to enable crash reports to be uploaded to the Vico servers) For more information, see 13. Vico Project Server (VPS) Requirements These are the requirements for the VPS. Item Requirements Windows 7 Supported operating systems Windows 8/8.1 Windows 10 Windows Server 2008 R2 Windows Server 2012 R2 Page 7

8 Item Requirements Hard disk usage Minimum for the VPS program: 100 MB Minimum per project: 1 GB (but projects can be much larger) Shared and master databases: 20 MB Certain actions on the VOC computer(s) may require additional free space for temporary files. Packing a project may require 1 to 20 GB of free disk space, depending on the project size. Memory Minimum per concurrently used project: 300 MB Master database: 40 MB Shared database: 40 MB C:\VERSANT\8\bin\versantd.exe Firewall exceptions (Inbound and outbound rules) C:\VERSANT\8\bin\obe.exe C:\Program Files\Vico Software\Vico Project Server Admin\VPSDaemon.exe 5089 TCP/IP port For more information, see 13. Note: For good performance, a high bandwidth and low latency connection between the VOC and VPS is required. If the VOCs are having trouble connecting to the VPS, you may need to change the firewall settings. The VPS cannot be installed on a compressed drive. In the drive properties (right-click the drive > Properties > General tab), ensure that the Compress this drive to save disk space check box is not selected. Page 8

9 Vico License Manager (VLM) Requirements These are the requirements for VLM. Item Requirements Microsoft Windows 10 Supported operating systems Microsoft Windows 8 Microsoft Windows 7 Windows Server 2008 R2 Disk space 2 MB Memory 3 MB Windows Server 2012 R2 Page 9

10 Item Requirements Two ports are required: Port For establishing a connection to the VLM license server. A random port - For further communication with the VLM license server. This port can also be specified in the license file (.lic) on the license server. To specify the port in a license file (.lic) 1. Open the.lic file (C:\ProgramData\Vico Software\VicoLM) in a text editor such as Notepad. 2. In the second line of the file, add vico.opt XXXX, where XXXX is the desired port number. Open port requirements - Floating license communication Note: Note: All license files (.lic) at C:\ProgramData\Vico Software\VicoLM must be edited in the same way. After editing the file, the license server must be restarted. 3. On the VLM host, start the Server Administration page (Start menu > Vico Software > Vico License Manager > Server Administration). 4. On the Server Administration page, click Shutdown. 5. On the Server Administration page, click Reread/Restart Servers. Page 10

11 Item Open port requirements - License server webpage admin Requirements Port 9000 If needed, you can change this port to a custom port number in the XYNTService.ini file. To change the port to a custom port number 1. In Notepad, open the XYNTService.ini file. 2. Edit the port number. The server webpage admin should now refer to the same port number. Note: Licenses are stored in this location: C:\ProgramData\Vico Software\VicoLM Single user licenses and floating licenses cannot be installed on the same system. Page 11

12 Supported Publishers and Importers Vico Office is an award-winning suite of products designed specifically for general contractors and owners. Vico Office is the first integrated construction management solution with a unique BIM-neutral environment. This means that users can publish, combine, coordinate, and augment Revit, Tekla, ArchiCAD, CAD-Duct models, and even IFC files with 4D scheduling and 5D estimating data. The current publishers include: Autodesk Revit 2016 and 2017 (Architecture, MEP and Structure) Tekla Structures 21.1 and 2016 ArchiCAD 19 and 20 AutoCAD 2016 and 2017 (Architecture and MEP) Bentley AECOsim Designer and The current importers include: Sketchup: versions 6, 7, 8, 2013, 2014, 2015, and 2016 CAD-Duct - the support is via an XML file IFC2x3 and IFC4 Trimble Connect for SketchUp IFC2x3 So for example, we can synthesize the architectural model from Revit, the structural steel model from Tekla, and the MEP model from CAD-Duct. We can coordinate the models after running an elementbased clash detection, fix any problems before construction starts with streamlined constructability issue handling, and then perform a comprehensive quantity takeoff. These coordinated constructioncaliber quantities drive a much more precise schedule and estimate. And if at any time the design changes, the model is updated, and the quantities automatically reflect the changes so the schedule and estimate are also up-to-date. Now you can start "asking questions of the 5D model." What happens if we change the facade to glass? What happens to the schedule if we add a parking garage? What happens if we substitute this material for that material? In real-time, the model provides the answers of what happens to the schedule and what happens to the budget. Page 12

13 System Configuration Firewall Settings The Vico Office Client (VOC) communicates with the Vico Project Server (VPS) via the TCP/IP protocol. This communication takes place through dedicated ports, which should be open on both the VOC system and the VPS system. The Vico Office installer attempts to make required changes in the Windows firewall. Any additionally installed firewall software should be configured manually. The Vico License Manager (VLM) and the Vico Crash Reporter also require specific ports to be open. In addition to the systems on which the software is running, the VLM and Crash Reporter may require ports to be open on installed firewalls on routers and modems. This allows them to communicate respectively with the Vico Software license administration system and the Vico Crash Report server. The table below provides an overview of all open port requirements and program exceptions. Note: For the 5019, 5088, and ports/port range, we recommend setting the exception for the related.exe process. The path (for example, C:\VERSANT\8\bin) changes as the Versant version (for example, 8) changes. This applies to all programs that use the VERSANT path. Port Process Component Open on Router/Modem 5019 VersantD.exe (C:\VERSANT\8\bin) Vico Project Server No (Creating and deleting projects, packing/unpacking) Pre 5.0: NotificationDaemon.exe (C:\VERSANT\8) 5.0 and later: Vico Project VPSDaemon.exe Server (C:\Program Files\Vico Software\Vico Project Server Admin\Wow64\) VPSABackupService (C:\Program Files\Vico Vico Project Software\Vico Project Server Server Admin) No No Page 13

14 Port Process Component Open on Router/Modem Obe.exe (C:\VERSANT\8\bin) This can be defined using an environment variable called VERSANT_SERVER_ PORTS. Vico Project Server No Each project uses a dedicated port; therefore, a range is used. Vico Office 20, 21, 1026, 1027 chilkat.exe 2764 and additional random port (or specified explicitly as described in 9) 9000 (Crash Report Uploader) Vico License Manager Vico License Manager Yes No (Yes in case of WAN access to license server) No User Account Control (UAC) Settings Windows UAC can block the VPS to VOC communication in the specific case where: UAC is active. And The user account does not have administrator rights. If it is not possible to deactivate UAC or to provide the user with an administrator account, you can start Vico Office in elevated mode. To start Vico Office in elevated mode Page 14

15 1. Right-click the Vico Office program shortcut, and then click Properties. 2. On the Compatibility tab, select the Run this program as an administrator check box, and then click OK. Configuration Options The Vico Office Client (VOC), Vico Project Server (VPS), and Vico License Manager (VLM) can be installed in various configurations. Page 15

16 VOC and VPS Configuration Options Page 16

17 VLM Configuration Options Standalone Configuration A standalone configuration is recommended for demonstration and offline work only. Although this configuration can provide maximum performance, collaboration is a manual process. In this configuration, Vico Office and Vico Project Server (VPS) are installed on the same system, which means that the same computer is both server and client. Project databases, the master database, and the shared database are available without connecting to a server. Page 17

18 Both Vico Office and VPS are installed on the same machine. Note: The communication between Vico Office and VPS takes place via TCP/IP. Server and client both have the same TCP/IP address this is considered a threat by most antivirus and firewall software. If it is not possible to make adjustments to firewall and/or antivirus software, we do not recommend a standalone configuration. LAN Configuration (Recommended) A LAN configuration is recommended for most use cases. In this configuration, a dedicated system is set up as the Vico Project Server (VPS), and work stations with the Vico Office Client (VOC) installed connect to the VPS over a local area network. Multiple users can access the same project at the same time, which enables work-as-one: parallel work on a project as a team. Two options are possible for licensing: Page 18

19 1. Locally installed single user licenses 2. A license server and floating licenses Page 19

20 Users pull licenses for the various modules from a pool of licenses installed on the server. Note: Because of hardware limitations of the server (related to memory usage), a large number of users might require additional VPSs to be set up. Licensing Configuration - Vico Licensing over WAN A WAN configuration, which only applies to the VLM, provides on-site project teams access to a VLM license server that is set up in the office. The license server must be accessible from outside the office, and this can be achieved by placing the license server computer inside a DMZ. Floating licenses are typically required. Page 20

21 Setting up a license server in the DMZ can provide access to floating licenses from outside the office. In this configuration, the VPS is local for each user. Note: Other than for licensing, WAN solutions for Vico Office require virtual desktop/application solutions. Our customers have successfully used Citrix, and supplemental documentation is available. For more information, contact the Vico Office Support team. Page 21

22 Installing Vico Office The Vico Office installer guides you through the steps for installing Vico Office components. To install Vico Office components 1. Open the Vico Office setup file. The Vico Office installer appears. 2. Select the language, and then click Next. The installer checks to ensure that your machine has the required system components. If any are missing, it will list them so that when you click Next, they are downloaded and installed. Note that you need Internet access to download these prerequisites. If your machine does not have Internet access, you can use another machine with Internet access to download the prerequisites from the Downloads page of SupportLink. Unzip the downloaded file and place the prerequisites next to the Vico Office setup file. The installer will automatically pick up these prerequisites and install them during the Vico Office installation. Prerequisites next to setup file If the required system components are up-to-date, the disk space requirements are displayed. 3. Click Next. The license agreement appears. 4. Read the license agreement, select the I accept the terms of the License Agreement check box, and then click Next. Note: The Next button is enabled only after you have scrolled to the bottom of the agreement. 5. Select the desired installation option(s). 6. Click Next. Note that Vico License Manager cannot be installed at the same time as Vico Office. 7. Select which features will be installed. When you click a feature, its description appears below the item. 8. Click Next. Page 22

23 9. Read the Trimble Solution Improvement invitation. You are encouraged to participate in the program. When you select 'Yes', a crash report is automatically sent to Trimble. Only necessary information required by developers to help them understand why a crash occurred is included in the report. When you select 'No', a crash report is NOT automatically sent to Trimble. However, you can still send this report manually. A prompt will be available on the UI after the crash has occurred. Important: If you are installing Vico Office in a Citrix environment, the option to send crash reports is not available. To enable this feature, see "Sending Crash Reports in a Citrix Environment" on page 28. Attention Administrators: If you previously added the registry setting CrashReportSettings: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Vico Software\Report settings Please remove it or set it to <empty>. Otherwise, this setting might prevent crash reports from being sent to Trimble. 10. Click Next. The screen displays a confirmation that all the required information has been provided. 11. Click Next to install selected options and features. This may take several minutes. When the process is completed, you must restart your computer. To view the ReadMe, you must have a PDF reader. 12. Click Restart Now or Restart Later. Licensing Process The licensing process for Vico software consists of the following steps: 1. Receive a license installation utility file (.liu). This can be a new license or an existing license that is reassigned using the Customer Portal. 2. Copy the.liu file to the target computer. For single user licenses, this is the VOC computer. For floating licenses, this is the VLM computer. The VOC or VLM installation must be completed before continuing with license installation. 3. Initiate the license generation process by double-clicking the.liu file. Page 23

24 The License Installation Utility (part of Vico Office) connects with the Vico License Distribution Service and generates a hardware-specific license file. The resulting license file (.lic) is stored in the following location: C:\ProgramData\Vico Software\VicoLM Vico License Distribution Service Connection Failure If a Vico License Distribution Server connection fails, the License Installation Utility displays a message and automatically generates a license request file for 'offline' license installation. To receive a license file 1. In the Vico Software License Request Problem message, click OK to save the license request file. 2. Attach the license request file to an empty , and send it to licensing@vicosoftware.com. Important: The request file should be the only attachment to an otherwise empty . If the is edited or additional attachments are added, the automatic process will fail. After the request file is received, an with the license file is automatically sent by the Vico License Distribution Service. 3. Save the license file on the target computer. 4. To finish the installation, double-click the file. Page 24

25 Hardware ID (HWID) Vico licenses are hardware-dependent, which means that a unique HWID is generated and copied to the license file during installation. This ID is compared to the one that is generated when a Vico product is started. If they match, the license can be checked out. Note: Changes to the hardware or operating system may result in a new HWID, which invalidates existing licenses. HWID generation is affected by the following: Hardware changes on the host computer OS upgrades on the host UAC settings For virutal machines: OS upgrades on the virtual machine Virtualization software upgrades (potentially) Migration to a new host Setting Up the License Server To set up a license server 1. Decide which computer will act as the license server. 2. Open the Vico Office setup file, and select Vico License Manager (VLM) to install the VLM on that machine (server). Page 25

26 3. To install the floating licenses on the server computer, open the.liu license installation files and wait for 15 to 20 seconds. Example license names are: VO R5 Takeoff Manager VO R5 Cost Planner VO R5 Cost Explorer Note: The.liu files should be associated with the Vico License Installation Utility (LIU). If the file association is missing, download and install the License Installation Utility separately. 4. To start the Server Administration page on the license server, click the Start menu > Vico Software > Vico License Manager > Server Administration. 5. On the left, click Reread/Restart Servers, and then click Reread/Restart. The license server should be up and running. Connecting to the VLM To install the VOC and connect to the VLM 1. Install the VOC on each user's computer. We recommend that you restart your system after the installation. 2. To install the VOC license on the client computer(s), execute the license installation file (.liu file attached to license notification), and wait for 15 to 20 seconds. Page 26

27 3. On the Dashboard in Vico Office, set the connection to the VLM in the VLM Server field, and restart Vico Office. When you start Vico Office, it will check out the Vico Office Client license locally and should be able to check out the module licenses from the server. To install Schedule Planner Standard and connect to the VLM 1. Install Schedule Planner Standard on each user's computer. 2. On each user's computer, download and install the Vico Office Utility, which is available on the Downloads page of SupportLink. 3. On the License server access step, enter the name or IP address of the server computer during installation. The VLM connection information is stored in an Environment Variable that you can also create manually. Reverting (Rolling Back) to a Previous Vico Office Version If there is a need to revert back to a previous Vico Office release on your machine, some files have to be removed manually, as the Vico Office database files are not backward compatible. Please follow these Page 27

28 steps to avoid any database conflict. To revert to a previous Vico Office version 1. Back up your database. 2. Uninstall Vico Office and all related components (Vico Project Server, Schedule Planner Standard). 3. Delete the Vico Office installation folder: C:\Program Files\Vico Software 4. Delete the Versant installation folder: C:\VERSANT Important: This step will permanently remove all Vico Office projects from your machine. Please proceed only If you have backups for the projects you would like to keep. 5. Delete the following database profile files: C:\osc Note: This folder is hidden by default. To display hidden folders, select this option 'Show hidden files, folders, or drives' (File Explorer > Organize > Folder Options > View). C:\Users\<CURRENT_USER>\osc Note: Your user profile folder might be set to a different (network) drive. If you type %HOMEDRIVE%%HOMEPATH% in File Explorer, it will point you to the user profile folder. Sending Crash Reports in a Citrix Environment During the Vico Office installation, you are invited to participate in the Trimble Solution improvement program. This program is available only to the system administrator who installed Vico Office. Due to the nature of a Citrix environment, this program is not automatically available to the rest of the Citrix users. There are two ways to participate in the program: one will require Citrix users participation and the other will require the Citrix Administrator to modify the registry settings. Attention Administrators: If you previously added the registry setting CrashReportSettings: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Vico Software\Report settings Please remove it or set it to <empty>. Otherwise, this setting might prevent crash reports from being sent to Trimble. Citrix Users 1. When a crash occurs while using Vico Office, a warning icon will appear on the top-right corner of the window. Page 28

29 2. Click on the warning icon. A 'Send Error Info' dialog appears. 3. Click on the 'Send and don't ask me before sending in future.' Citrix Administrators 1. Start Registry Editor and locate the following: Computer\HKEY_CURRENT_USER\Software\Vico Software\Vico Office 2. Change the CrashReportSend Data value to 'AutoSend'. Page 29

30 Troubleshooting Problem Cause/Notes Resolution Test for Problem Antivirus or firewall itest v blocks the connection. Set exceptions for the following files: <SERVER_ C:\VERSANT\8\bin\versantd.exe NAME> Note: Multiple Vico Office (TCP/IP port 5019) (DOS command firewalls/antivirus can cannot connect to C:\VERSANT\8\bin\obe.exe (TCP/IP line function) be present on a local or network port range ) machine VPS (Versant C:\VERSANT\8\NotificationDaemon.exe Check the database). (TCP/IP port 5088) Control Panel -> Versant database is not installed properly/ versantd service is not running Reinstall VPS/start versantd service Administrative tools -> Services -> VersantD TCP/IP networking is not set up properly ipconfig Vico Office (DNS name Set up TCP/IP networking (ask your crashes during resolution). administrator) startup TCP is broken or there (DOS command is no network adapter line function) in the machine Run the following commands in User must have Vico Office drops Set proper rights on the Versant DB Command permissions to write E7031 error directory in Windows Explorer Prompt: Versant DB directory during startup (C:\Versant\db) (usually c:\versant\db) makedb testdb createdb testdb Page 30