EVS IP2Archive Configurator User Manual

USER MANUAL

Configurator

Version 1.0 - July 2013



IP2Archive- User Manual- Configurator Version 1.0

Disclaimer

The information in this manual is furnished for informational use only and subject to change without notice. While every effort has been made to ensure that the information contained in this user manual is accurate, up-to-date and reliable, EVS Broadcast Equipment cannot be held responsible for inaccuracies or errors that may appear in this publication.

Improvement Requests

Your comments will help us improve the quality of the user documentation. Do not hesitate to send improvement requests, or report any error or inaccuracy on this user manual by e-mail to doc@evs.com.

Regional Contacts

The address and phone number of the EVS headquarters are usually mentioned in the Help > About menu in the user interface.

You will find the full list of addresses and phone numbers of local offices either at the end of this user manual (for manuals on hardware products) or at the following page on the EVS website: http://www.evs.com/contacts.

User Manuals on EVS Website

The latest version of the user manual, if any, and other user manuals on EVS products can be found on the EVS download center, on the following webpage:

http://www.evs.com/downloadcenter.

EVS Broadcast Equipment S.A. - July 2013 Issue 1.0.D

IP2Archive- User Manual- Configurator Version 1.0

1. About the Application

Configurator is an application which allows a system administrator to configure the IP2Archive applications. It also allows to create users for the IP2Archive system and manage their user rights.

1. About the Application 1

EVS Broadcast Equipment S.A. - July 2013 Issue 1.0.D

2. Installing the Application

2.1. How to Install the Application

To install the application, proceed as follows:

1. Double-click the IP2Archive.exe to launch the IP2Archive Setup Wizard.

The Welcome screen appears.

2. Click Nextto continue.

The End-User License Agreement screen appears.

3. Read the license agreement on using IP2Archive in your country. Accept the agreement and click Next to continue.

The Installation Folder screen appears.

2 2. Installing the Application

IP2Archive- User Manual- Configurator Version 1.0

4. Select the folder where the application has to be installed and click Next to continue.

By default, the IP2Archive applications will be installed in the following folder: C:\Program Files\EVS Broadcast Equipment\IP2Archive\(for 32-bit machines) or C:\Program Files (x86)\EVS Broadcast Equipment\IP2Archive\ (for 64-bit machines).

The Setup Type screen appears.

5. Choose a setup type and click Next to continue.

You can choose one of the following setup types:

◦ Complete: Installs all IP2Archive applications. Continue to step 7.

◦ Typical: Installs the most common IP2Archive applications, i.e. the database

client software, the Deep Archive Manager, Configurator and the EVS Software Player. Continue to step 7. By default, this installation type is selected.

◦ Custom: Allows you to select the IP2Archive applications that have to be

installed. The Custom Setup screen appears. Continue to step 6.

6. In the Custom Setup screen, select the applications that you want to install, and then click Next to continue.

2. Installing the Application 3

EVS Broadcast Equipment S.A. - July 2013 Issue 1.0.D

The Custom Setup screen shows a tree view of the IP2Archive applications that you can install. By default, Deep Archive Manager, the database client software, the EVSSoftware Player, the IP2Archive documentation and Configurator are selected. When you click a feature or subfeature, a description of the feature will be displayed and also the disk space requirements.

To add or remove a feature, click the arrow next to the feature name, and then choose one of the following options from the drop-down list:

◦ Will be installed on local hard drive: Installs the selected feature in the

location shown under Installation Folder.

◦ Entire feature will be installed on local hard disk: Installs the selected feature

and all subfeatures.

◦ Feature will be installed when required:The feature will be installed when you

perform an action that requires it.

◦ Entire feature will be unavailable: For a new installation of IP2Archive, this

option passes over the installation of the selected feature. For an existing installation, this option removes the feature from the installation. After you select this option, a red X appears on the feature tree next to the feature name.This option cannot be selected for the database client software, the EVSSoftware Player and the IP2Archive documentation.

Click the Reset button to undo your selection.

7. Do one of the following:

◦ If no database client software has been installed yet, the Database Connection

Creation screen appears.

4 2. Installing the Application

IP2Archive- User Manual- Configurator Version 1.0

Enter the IP address of the database server. The default port number, i.e. 1521, has already been entered. Click Next to continue.

◦ If the database client software has already been installed, the Database Selection

screen appears.

Select the database name from the drop-down list and enter the username and password necessary to log onto the database. You can test the connection with the database by clicking the Test Login button. Click Next to continue.

To add a new database, click the New Database button and enter the database name (by default IP2A.EVS), the IP address and port number (by default 1521) of the machine that hosts the database, and the service name (by default TOM). You can test the connection with the database by clicking the Test Login button. Click Next to continue.

2. Installing the Application 5

EVS Broadcast Equipment S.A. - July 2013 Issue 1.0.D

8. Click Install to start the installation.

The selected applications will be installed.

6 2. Installing the Application

IP2Archive- User Manual- Configurator Version 1.0

9. If the installation has been completed, click Finish to exit the Setup Wizard.

◦ If the View Readme File check box is selected, a text file containing the

IP2Archive release notes will be opened.

◦ If the second check box is selected, the Configurator application will be launched.

This application will allow to configure the installed applications.

The installed IP2Archive applications and a link to the IP2Archive documentation will appear in the Windows Start menu.

10. Open the IP2Archive installation folder, and right-click the application you want to create a shortcut to.

11. Click Create Shortcut.

12. Drag the shortcut to the Desktop.

2. Installing the Application 7

EVS Broadcast Equipment S.A. - July 2013 Issue 1.0.D

2.2. How to Modify, Repair or Remove the Installation

To modify, repair or remove the installation of the application, proceed as follows:

1. Double-click the IP2Archive.exe to launch the IP2Archive Maintenance Wizard.

The Welcome screen appears.

2. Click Next to continue.

The Modify, Repair or Remove Installation screen appears.

3. Do one of the following:

◦ If you want to modify the IP2Archive installation, e.g. add or remove certain

applications, select Modify and click Next. Continue to step 4.

◦ If you want to repair the IP2Archive installation, e.g. fixing missing or corrupt files,

shortcuts and registry entries, select Repair and click Next. Continue to step 6.

8 2. Installing the Application

IP2Archive- User Manual- Configurator Version 1.0

◦ If you want to remove the IP2Archive installation, select Remove and click Next.

Continue to step 7.

4. In the Custom Setup screen, select the applications that you want to (de)install.

The Custom Setup screen shows a tree view of the IP2Archive applications that you can install and deinstall. By default, Deep Archive Manager, the database client software, the EVSSoftware Player, the IP2Archive documentation and Configurator are selected. When you click a feature or subfeature, a description of the feature will be displayed and also the disk space requirements.

To add or remove a feature, click the arrow next to the feature name, and then choose one of the following options from the drop-down list:

◦ Will be installed on local hard drive: Installs the selected feature in the

location shown under Installation Folder.

◦ Entire feature will be installed on local hard disk: Installs the selected feature

and all subfeatures.

◦ Feature will be installed when required:The feature will be installed when you

perform an action that requires it.

◦ Entire feature will be unavailable: For a new installation of IP2Archive, this

Click the Reset button to undo your selection. Click Next to continue.

5. Click Install to start the installation.

2. Installing the Application 9

EVS Broadcast Equipment S.A. - July 2013 Issue 1.0.D

Any features that you have added in the Custom Setup screen will be installed. Any features that you have removed will be uninstalled. The installed features that you haven't modified will be skipped. Continue to step 8.

6. Click Repair to repair the installation of EVS IP2Archive. Continue to step 8.

7. Click Remove to remove IP2Archive from your computer.

10 2. Installing the Application

IP2Archive- User Manual- Configurator Version 1.0

8. Click Finish to exit the Setup Wizard.

2. Installing the Application 11

EVS Broadcast Equipment S.A. - July 2013 Issue 1.0.D

3. Starting the Application

3.1. After Installation

Double-click the Configurator icon on your desktop to start the application. You can also start the application by double-clicking the executable file (.exe) in the installation folder.

The splash screen appears.

The application logs into the database. Then, the Settings window appears allowing you to configure the application.

See section "Settings Window" on page 60.

3.2. After Configuration

Double-click the Configurator icon on your desktop to start the application. You can also start the application by double-clicking the executable file (.exe) in the installation folder.

The splash screen appears. The application logs into the database.

Then, a Login dialog box appears.

12 3. Starting the Application

IP2Archive- User Manual- Configurator Version 1.0

To be able to log into the application, you need to belong to a user group that has a role which allows to use the application.

Enter your username and password and click Login. The main window of the application opens.

You get an error notification if:

• you have entered a wrong username or password.

• you have omitted your username.

• you have insufficient user rights.

• your user account has expired.

3. Starting the Application 13

EVS Broadcast Equipment S.A. - July 2013 Issue 1.0.D

3.3. Main Window Overview

General Description

The main window allows you to view and switch between the various setup panes of Configurator.

Illustration

The main window contains the areas highlighted on the screenshot below:

Area Description

The table below describes the various parts of the main window:

Part Name Description

1. Menu Bar The menu bar contains three menus: File, Settings and Help.

2. Selected Setup Pane This area displays the selected setup pane. Each setup pane allows you to configure specific settings.

3. Navigation bar The Navigation bar allows you to navigate between the eight Setup panes. They can be accessed by clicking the corresponding icon.

14 3. Starting the Application

IP2Archive- User Manual- Configurator Version 1.0

Menu Bar

The menu bar contains three menus: File, Settings and Help.

The File menu contains only one command: Exit. It is used to exit the application. Click the File menu or use the keyboard shortcut keys ALT + F or F10 + F to open it. Click Exit or use the keyboard shortcut key X to exit the application.

The Settings menu doesn’t contain any commands. It immediately gives access to the application settings. Click the Settings menu or use the keyboard shortcut keys ALT + S or F10 + S to access the settings.

The Help menu contains the following commands: About and Help. With the About command the application splash screen can be opened. The splash screen displays the application software version, the name of the database the application is logged on to and the login name used. With the Help command you can open the application help file. Click the Help menu or use the keyboard shortcut keys ALT + H or F10 + H to open it. Click About or use the keyboard shortcut key A to open the splash screen. Click Help or use the keyboard shortcut key H to open the application help file.

Setup Categories

The settings are grouped according to three setup categories:

Setup Category Description

Connections Settings related to the connection between IP2Archive and

IPDirector, and between IP2Archive and the HSM system.

Settings Settings related to specific IP2Archive applications.

Rights Settings related to user rights.

Setup Panes

The following table briefly describes each Setup pane:

Setup Pane Description

IPDirector This pane allows you to configure the connection between

IPDirector and particular IP2Archive applications. See section "Configuring the Connection with IPDirector" on page 17.

HSM This pane allows you to configure the connection between

IP2Archive and the hierarchical storage management system (HSM). See section "Configuring the HSMConnection" on page

24.

General This pane allows you to configure settings specific to the Deep

Archive Manager. See section "Configuring Deep Archive Manager" on page 33.

Application Monitor

3. Starting the Application 15

This pane allows you to configure the Application Monitor. See section "Configuring Deep Archive Manager" on page 33.

EVS Broadcast Equipment S.A. - July 2013 Issue 1.0.D

Setup Pane Description

Relations This pane allows you to create and manage users and contacts for

the IP2Archive system, and to assign user rights and resources to them. See section "Managing Relations" on page 44.

Roles This pane gives an overview of the user rights (=roles). It allows

you to add a description to each user right. See section "Managing User Rights" on page 53.

Groups This pane gives an overview of the existing user groups. It allows

you to create new user groups and delete existing ones. See section "Managing User Rights" on page 53.

16 3. Starting the Application

IP2Archive- User Manual- Configurator Version 1.0

4. Configuring Connections

4.1. Configuring the Connection with IPDirector

4.1.1. Introduction

The connection between IPDirector and IP2Archive can be configured in the IPDirector setup pane.

It allows you to:

• create a connection with an IPDirector in your setup

• configure the connection between the SOAPAPI of the IPDirector of your choice and

the IP2Archive applications

• configure the connection between the local SOAP notification server of IP2Archive

Communicator and IPDirector

• specify the archive and process bins in IPDirector IP2Archive Communicator has to

monitor

• specify the archive metadata userfields in IPDirector IP2Archive Communicator and

Deep Archive Sync have to update.

4.1.2. Creating an IPDirector Connection

If your setup has more than one IPDirector, Configurator allows you to create and configure a connection between IP2Archive and each of these IPDirectors. The creation is done in the IPDirector Name area.

4. Configuring Connections 17

EVS Broadcast Equipment S.A. - July 2013 Issue 1.0.D

To create a connection with a particular IPDirector, click the New button. Enter a name for the IPDirector you want to connect with and click the OK button. The name will appear in the IPDirector Name field. You can now start configuring the connection.

To switch between the connection settings of two IPDirectors, select the name of the desired IPDirector from the IPDirector Name drop-down list.

To delete a particular connection, select the name of the desired IPDirector from the IPDirector Name drop-down list and click the Delete button. Click OK to confirm your action. Note that if you delete a connection, all corresponding settings will be lost.

4.1.3. Configuring the Connection with the IPDirector API

The API tab allows you to configure the connection between the IPDirector SOAP API and the IP2Archive Applications (Deep Archive Manager, Deep Archive Sync, IP2Archive Communicator, Deep Archive Controller).

In the IPDirector API Settings group box you have to enter the data these applications need to be able to communicate with the IPDirector API.

The following data has to be entered:

• APIHost: The IP address or hostname of the server that hosts the IPDirector API.

• Login: The login necessary to log into the IPDirector API.

• Password: The password necessary to log into the IPDirector API.

• WSDL: The path to the IPDirector API .wsdl file. This path is is automatically entered

based on the IP address of the server that hosts the IPDirector API.

18 4. Configuring Connections

+ 51 hidden pages