VICON Evoke Software User Guide

**VICON Evoke Software User Guide

**

About this guide

This guide covers the following topics:

• PC requirements for Vicon Evoke on page 3
• Install the software on page 4
• License Vicon Evoke on page 8

For information on system setup, including components, optimization, and upgrading Vicon firmware, see the Vicon documentation that was supplied with your system.

If you need further help with setting up your Vicon system, please contact Vicon Support1.

PC requirements for Vicon Evoke

The specification for a PC for use with Evoke depends on the size of the system and the quantity of data to be processed.

Note that the minimum recommended monitor resolution is 1080 pixels (1920 x 1080).

For detailed information on PC requirements, visit the Vicon website FAQs2 and select Operating systems and PC or contact Vicon Support3.

Supported operating systems for Vicon Evoke

Evoke 1.3 is supported under the following operating system:

• Microsoft Windows 10, 64-bit (this is the Vicon-recommended OS): Compatible with and fully supported and tested.

Although Evoke may install and function under other Microsoft Windows operating systems, this is not officially supported or recommended by Vicon.

For details on Vicon systems, PC setup and connectivity, see the Vicon systems setup information4 .

Install the software

Depending on the way you license Vicon Evoke, choose one of the following:

• If you want to install Evoke and manage Vicon licenses on the same PC, see Install Evoke on page 5.
• If you are setting up a network license server and you don’t want to install Evoke on that machine, see Install VAULT only on page 7 (VAULT is the Vicon Automated Unified Licensing Tool).

Install Evoke

The Evoke installer enables you to choose whether to install the following components:

• Vicon Evoke
  This option installs Vicon Evoke, supporting live VR functionality. Selected by default.

• Vicon Retarget
  Application that supports retargeting. Selected by default.

• Vicon Firmware
  Update Utility This software checks whether your Vicon hardware needs firmware updates and enables you to update the firmware whenever necessary. Selected by default.

• Vicon Pulsar
  Reprogramming Tool This software enables you to check your Vicon Pulsar firmware and to update it whenever necessary. Selected by default.

• Vicon Video
  Viewer This software enables you to play back video files captured with Vicon Evoke and other Vicon applications. Selected by default.

• Bonjour
  This option installs Bonjour networking technology software. Selected by default.

• Safenet Dongle Driver
  This option enables you to use a Safenet dongle, so is only necessary if your license uses a dongle. (You may need to reboot your PC after installation.) Cleared by default.

To install Evoke:

1. Download the Vicon Evoke software installer (if you have not received a link, contact Vicon Support5 ).

2. In Windows Explorer, go to the folder to which you downloaded the installer and double-click Vicon_Evoke_Setup.exe.
   Note
   If you attempt to install Evoke on a machine running a version of Windows that is earlier than Windows 10, you may receive an error message that halts the installation. The message instructs you to install a specified Windows update before restarting the Evoke installation. In this case:
   a. Exit the Evoke installation.
   b. Download and install the specified Windows update.
   c. Start the Evoke installation ag

3. In most cases, accept the default options to install Evoke, Retarget and

4. Bonjour. If you are using a SafeNet dongle, select the option to install the SafeNet dongle driver.

5. On the End-User License Agreement wizard page, read and acceptthe terms and click Initialize.

6. On the Evoke installation initialization wizard page, click Install.

7. The installation pages and license agreements that are displayed depend on the options you selected in Step 4.

8. Click through the installation pages, accepting any necessary license agreements.

9. On the final installation wizard page, click Finish.

Install VAULT only

1. Visit the Vicon Product Licensing6 page.

2. Download the Vicon VAULT installer.
   In Windows Explorer, go to the folder to which you downloaded the installer, unzip it, then double-click Vicon_Product_Licensing_Setup.exe.

3. Follow the onscreen instructions to install VAULT.
   Note that if an older version of the license server is already installed, it is replaced. If the same version is already installed, the license server is not installed.

Caution
Installing the Sentinel License Server also installs the License Tools. If you are already using any other version of the SafeNet licensing tools, before replacing them with the latest version, contact Vicon Support for advice.

For information on how to use VAULT to license your Evoke installation, see License Vicon Evoke on page 8.

License Vicon Evoke

For information about licensing Evoke, see the following topics:

• Request a license on page 9
• Activate a license on page 11
• Set the license server on page 12
• Use a commuter license on page 14
• License Evoke with a Safenet dongle on page 20
• View information about license servers on page 21

Request a license

To request a license, you start Evoke and supply the relevant details.

In addition to the procedure for accessing licensing described below, you can also manage licensing in the following ways:

• After you have licensed Evoke, start Evoke and on the Help menu, click Licensing; or
• To run the Vicon Automated Unified Licensing Tool (VAULT) independently of Evoke, click the Windows button, then on the START menu, click Vicon and then Vicon Product Licensing.

To request a license from Vicon Support:

1. If you are using a SafeNet dongle to license your machine, insert the dongle.
2. On the machine for which you want the license (either a networked license server or a standalone machine), start Evoke and at the left of the dialog box, click Request License.
3. At the top of the Request a License dialog box, from the Product andProduct Version menus, ensure Evoke and 1.x are selected.
4. In the appropriate fields, enter your contact details.
5. In the Options area, select whether to request:
   • Standalone license locked to local PC name: for use by the PC from which you are sending this request only
   • Network license locked to license server name: for use on the license server machine from which you are sending this request by one or more PCs on the same network
   • Standalone license locked to a dongle: for use with the specified dongle on a single PC. In the Dongle ID field, type the ID, which is found on the dongle.
6. For network/server based licenses only: if necessary, change the value for the Number of Seats.
7. Leave the settings in the Machine area at their default values unless you are asked to change them by Vicon Support (for example, if you are using a dual-booting system or have had to reinstall Windows).
8. Do one of the following:
   • If you can currently email your license request, click the Email Request button; or
   • If email is currently unavailable, click Save Request to a file, so that you can send the request later. Type or browse to a suitable location and click OK.
     The file is saved as ViconLicenseRequest*.xml. When possible, email the file to Vicon Support8

Activate a license

After you have received a license file from Vicon Support, you must activate it before you can start using Vicon Evoke

To activate a license:

1. Check your email for a message from Vicon Support. The license file (named Evoke.lic) is attached to the email. If you have not received a license file, request one as described in Request a license on page 9.
2. Save the license file (*.lic) to the Windows desktop of the machine for which you have a license (or any other suitable location).
3. Start Evoke and in the Vicon Automated Unified Licensing Tool dialog box, click Activate License.
4. Depending on whether you are using the file as it was received from Vicon Support or as a text string copied from the file
   • In the License File Activation field, type or browse to the location of the license file (.lic) and click Activate from File; or
   • Copy the text to the License Activation string field and click Activate from String
5. Click OK.

Tip
You can only deactivate a network license from the relevant license server machine, not from any of the client machines.

Set the license server

If a server provides licenses to client PCs on your network, to enable a client PC to find its license quickly, specify the license server for Evoke.

If you use standalone licensing, Evoke should automatically find its license. If not, or if you need to change the license server, follow the steps below

To enable Evoke to find its license

1. Ensure you have installed Evoke as described in Install Vicon Evoke on page 4. Depending on the type of license you have, ensure that your system is ready:
2. If your PC obtains its license from a license server, ensure that Evoke is licensed on the relevant server.
3. If you are using a standalone license, ensure that you have requested, saved, and activated your license on this machine.
4. Start Evoke and depending on whether or not a license is found: If the Vicon Automated Unified Licensing Tool dialog box opens, click Set License Server; or
5. If Evoke opens and you want to view or change the current license server:
   • On the Help menu, click About and in the dialog box, click Licensing.
   • In the Vicon Automated Unified Licensing Tool dialog box, go to the Product License Location list (in the lower half of the dialog box), and right-click on the line that shows the relevant Evoke license and then click Set License Type.
6. In the Change License Server dialog box, do one of the following:
   • To use standalone licensing, click Use Standalone/Commuter Licenses Only and then click OK.
   • To obtain a license from any available license server (local or on a network), click Use Standalone/Commuter Licenses Or Scan for a License Server and then click OK.
   • To select a specific license server from a list of available servers: Click Discover. Both local and network licenses are shown.
   • In the Available Servers list, double-click the required license server and then click OK.
   • To specify a license server, click Use a Specific Network License Server, type the name in the License Server field, and click OK.

Tip
You can instead select the required license server by going to the License Server list (in the upper half of the dialog box), rightclicking on the line that shows the relevant Evoke license and then clicking Use This License for Evoke.

Use a commuter license

You can check out (borrow) a seat from a network license so that it can be used for the number of days that you specify, on a machine that is not connected to the license server network. You can check out a seat to:

• A machine on your network (see Check out to a network machine on page 15), so that Evoke can subsequently be used when the machine is no longer connected to your network; or
• A machine that is not connected to your network (see Check out to a remote machine on page 16)

When a commuter license is no longer needed, it is checked back in again, so that it can be used from the license server network as usual. Licenses are automatically checked in at the end of a specified check-out period, or can be manually checked in early (not applicable to remotely checked-out licenses). For more information, see Check in a commuter license on page 19

Check out to a network machine

You can check out a seat from an existing license for use on a machine on your license server network, so that Evoke can subsequently be used on the machine when it is no longer connected to your network.

To ch eck out a seat to a machine on the license server network:

1. On a network machine that you want to use remotely, open the advanced Vicon Automated Unified Licensing Tool dialog box by doing one of the following:

   • Start Evoke. On the Help menu, click About. In the dialog box, click
   • Licensing; or Click the Start button, then All Programs > Vicon > Licensing >

2. Product Licensing.
   In the License Server list in the top part of the dialog box, right-click on the license that has the seat that you want to check out and click Check Out.

3. In the Check Out License dialog box, specify the number of days for the license to be used remotely and then click Check Out. Checked out licenses are flagged with Commuter in the Type column in the License Server list in the top part of the Vicon Automated Unified Licensing Tool dialog box.

Check out to a remote machine

In addition to checking out a license to a network machine (see Check out to a network machine on page 15), you can also check out a license to a machine that is running the Vicon Automated Unified Licensing Tool (VAULT), but is not connected to the network containing the license server. This involves the following procedures:

• On the remote machine: Generate a locking code on page 16 and send it to a user of a machine on the license server network.
• On a network machine: Check out a commuter license on page 17 and send it to the remote user.
• On the remote machine: Save and activate the commuter license on page 18

On the remote machine: Generate a locking code

1. To open the advanced Vicon Automated Unified Licensing Tool dialog box, do one of the following:
2. Start Evoke and in the Vicon Automated Unified Licensing Tool dialog box click Advanced Licensing; or Click the Start button, then All Programs > Vicon > Licensing > Product Licensing.
3. In the Vicon Automated Unified Licensing Tool dialog box, click View Remote Locking Code.
4. In the Current Machine Locking Code dialog box, type the email address of a person to whom the network license server is available, and click Send, or to save it to a string to send later, type or browse to the required location and filename, click Save to File and close the dialog box.
   The person with access to the license server can then check out a commuter license for use on the remote machine, as described in the following steps.

On a network machine: Check out a commuter license

1. To open the advanced Vicon Automated Unified Licensing Tool dialogbox, do one of the following:

2. Start Evoke. On the Help menu, click About. In the dialog box, clickLicensing; or

3. Click the Start button, then All Programs > Vicon > Licensing > Product Licensing.

4. In the License Server list at the top of the dialog box, right-click on alicense that permits commuter licensing for the required product.

5. If the selected license permits commuter licensing, the context menu displays a Check Out option and at the bottom of the dialog box, a

6. Check Out button is displayed.

7. Click Check Out and in the Check Out License dialog box:

8. Specify the number of days for which you want to use the license remotely.

9. Expand the Advanced Options by clicking the downward pointing arrow on the right, and click Remote Check Out.
   Caution
   Do not overestimate the number of days for which the license will remain checked out. After a remote check out, youIn the Remote Commuter License Check Out dialog box, enter the
   locking code string for the remote machine that was sent by the user
   of the remote machine, as described in On the remote machine:
   Generate a locking code on page 16, and click Check Out. cannot check the license back in again until the number of days that you specified has expired.

10. In the Remote Commuter License Check Out dialog box, enter the locking code string for the remote machine that was sent by the user of the remote machine, as described in On the remote machine: Generate a locking code on page 16, and click Check Out.

11. In the Save Commuter License dialog box, type or browse to a path and filename for the saved commuter license, click Save to File and then close the dialog box. The commuter license is saved as a license file (*.lic)

12. Email the saved commuter license file to the remote user. The remote user can then save and activate the checked-out commuter license on the remote machine, as described in the following steps.

On the remote machine: Save and activate the commuter license

1. Save the file that was sent to you as described in On a network machine: Check out a commuter license on page 17 above to the Windows desktop (or any other suitable location).
2. To open the advanced Vicon Automated Unified Licensing Tool dialog box, either:
3. Start Evoke and in the Vicon Automated Unified Licensing Tool dialog box click Activate License; or
4. Click the Start button, then All Programs > Vicon > Licensing >
5. Product Licensing, and then click Activate License.
6. Depending on whether you are using the file as it was received from the license network user or a text string copied from the file, either:
7. In the License File Activation field, type or browse to the location of the license file (.lic) and click Activate from File; or Copy the text to the License Activation string field and click Activate from String.
   • Close the Activate a License dialog box.
8. In the License Server list in the top part of the Vicon Automated Unified Licensing Tool dialog box, checked out licenses are flagged with Commuter in the Type column.

Check in a commuter license

Licenses that have been checked out are checked back in and made available for use from the network in either of the following ways:

• If the specified check-out period has expired, the license isautomatically checked back in.
• If the license is no longer needed for remote use, you can check it back in early.

Note
This does not apply to licenses that were checked out using Remote Check Out, which remain checked out until their checkout period expires.

To check in a license manually:

1. To open the advanced Vicon Automated Unified Licensing Tool dialog
   box, do one of the following: Start Evoke. On the Help menu, click About. In the dialog box, click Licensing; or Click the Start button, then All Programs

   Vicon > Licensing > Product Licensing.

2. In the top part of the dialog box, click on the license you want to check in and then click Check In Licens

Important
You cannot check in a license that was checked out using Remote Check Out before its check-out period has expired. You set the check-out period when you check out a license. To see how many days are left on a commuter license, in the License Server list in the top part of the Vicon Automated Unified Licensing Tool dialog box, find the relevant license and look at the date in the Expiry column.

License Evoke with a Safenet dongle

If you have received a SafeNet dongle for use with your Vicon Evoke license, you must request a license, download and install the appropriate drivers, and activate the license that you receive from Vicon Support.

To use a SafeNet dongle for licensing:

1. Insert the SafeNet dongle into a USB port on the PC.
2. Ensure you have downloaded and installed the latest drivers for the dongle onto the PC on which you will run Evoke. You can either
3. choose the option for dongle drivers when you install Evoke, or run the
4. Evoke installer at any time, or you can download the drivers from the Vicon website9.
5. Check your email for a message from Vicon Support with the ID of your dongle (of the form UBnnnnnn) in the Subject line. The license file  (named Evoke.lic) is attached to this email. If you have not received alicense file, request one (see Request a license on page 9).
6. Save the file Evoke.lic that you are sent by Vicon Support to your Windows desktop (or any other suitable location).
7. Activate the license as described in Activate a license on page 11.
8. You can now run Evoke.

To use your dongle on a different computer, repeat the above process on the new PC.

View information about license servers

In the Vicon Automated Unified Licensing Tool dialog box, you can view information about all available license servers without affecting the license server that is currently in use. To do this:

1. Open the advanced Vicon Automated Unified Licensing Tool dialog box by doing one of the following:
2. Before licensing Evoke, start Evoke and in the Vicon Automated  Unified Licensing Tool dialog box click Advanced Licensing; or
3. After Evoke is licensed, start Evoke and on the Help menu, click About. In the dialog box, click Licensing to open the Vicon Automated Unified Licensing Tool dialog box; or Click the Windows Start button, then All Programs > Vicon >  Licensing > Product Licensing.
4. In the Vicon Automated Unified Licensing Tool dialog box, if the required license server is not displayed in the License Server field at the top, click Change at the top right of the dialog box. In the Options area of the Select License Server dialog box, do one of the following:
5. To view local standalone licenses and commuter licenses, select View Licenses from the Locally Installed License Server; or To view licenses on a specified license server, type the name of the required server in the License Server field. If you don’t know the license server’s name, click Discover and in the Available Servers list, double-click a license server.
6. Click OK.
   In License Server list at the top of the dialog box, licenses from the specified license server are displayed

Tip
Changing the license server that is displayed in the License Server list does not affect the license server that is used for licensing, shown in the Product License Location list in the lower part of the dialog box. To change the license server that is used for licensing, see Set the license server on page 12.

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>