How To Install Sedar On A Workstation

Transcription

1 SEDAR Client Installation Guide Version 1.2 January 27,

2 Contents About This Guide... 2 Assumptions... 3 Date Format Synchronization... 3 Before You Begin the Installation Test of the SEDAR Client... 4 Workstation Setup... 4 Hardware Requirements... 4 Software Requirements... 5 Additional Software Requirements... 5 Uninstalling the Current SEDAR Client... 6 Windows 7 / Windows Vista... 6 Windows XP... 9 Installing the New SEDAR Client Additional Installation Test Information Reconfiguration of Firewalls Post Installation Production Code Update and Configuration First-time Execution of the SEDAR Client Date Format Synchronization Support Services SEDAR Client Installation Guide 1 January

3 About This Guide As a result of the transition of support services for the CSA National Applications (SEDI, NRD, and SEDAR) from CDS to CGI as of January 13, 2014, certain changes have been made to the SEDAR desktop client. This document provides guidance in the follow areas: 1. In the past, revisions to the SEDAR client have occurred through downloadable software updates to the existing installed client. For all SEDAR users attempting to use SEDAR for the first time as of January 27, the legacy client must be completely removed, and replaced with a new client. 2. Some firms may need to make firewall changes in order for the new SEDAR client to access the SEDAR system (which will now be hosted on different IP addresses). 3. When installing the new SEDAR client on the user s workstation there will be a need for firsttime installation, code update and configuration to each production workstation. 4. Contact information is provided for support services and or to obtain answers to questions during the user-workstation installation process. SEDAR Client Installation Guide 2 January

4 Assumptions This installation procedure assumes: You are familiar with the Windows environment. You know how to configure system files, install and uninstall software. Date Format Synchronization The date format in the SEDAR client must remain at the default setting of mm/dd/yyyy, and the Windows environment must match this same date format in the Region / Short Date settings. Failure to do this may cause the SEDAR client to misinterpret dates entered on cover page 2 of certain filing types where a financial period or meeting date is required. For example, a date of 01/10/2013 may be interpreted as October 1, 2013 instead of January 10, This date format synchronization should be confirmed before you start using the SEDAR client. SEDAR Client Installation Guide 3 January

5 Before You Begin the Installation Test of the SEDAR Client Before beginning the installation on any workstation, ensure that you have the proper workstation setup as well as the minimum hardware, software and Internet connectivity needed to run SEDAR. Workstation Setup Prepare your workstation as follows: Ensure that your workstation, where SecureClient is installed, does not have any other VPN client (e.g. Cisco VPN client) software installed. Your workstation must not be in the subnet of If a personal or corporate firewall is installed on your workstation, it must be configured so that IPSec and IKE ports are not blocked. If Internet gateways (e.g. Netgear, Linksys or D-Link) are used, ensure that IPSec and IKE ports are not blocked. Ensure that the firewall allows you to download the SEDAR installation executable file. The file size is approximately 55 MB for Windows 7/Vistaand approximately MB for Windows XP (due to a different version of Checkpoint VPN client). The SEDAR installation must be run under the administrator user account. This is a requirement for the IBM WebSphere MQ Series software, which is installed as part of the overall SEDAR installation. Hardware Requirements To install SEDAR on a workstation, the following hardware is required: Windows XP Pentium 233-megahertz (MHz) processor or faster (300 MHz is recommended) At least 64 megabytes (MB) of RAM (128 MB is recommended) At least 1.5 gigabytes (GB) of available space on the hard disk CD-ROM or DVD-ROM drive Keyboard and a Microsoft Mouse or some other compatible pointing device Video adapter and monitor with Super VGA (800 x 600) or higher resolution Sound card Speakers or headphones Windows 7 1 gigahertz (GHz) or faster 32-bit (x86) or 64-bit (x64) processor 1 gigabyte (GB) RAM (32-bit) or 2 GB RAM (64-bit) SEDAR Client Installation Guide 4 January

6 16 GB available hard disk space (32-bit) or 20 GB (64-bit) DirectX 9 graphics device with WDDM 1.0 or higher driver. Software Requirements To install the SEDAR client on a workstation, one of the following operating systems is required: Microsoft Windows XP Professional Microsoft Window 7 Professional (32 or 64-bit) Microsoft Windows Vista Business (32-bit) Note: Microsoft Windows 8 is not supported. Additional Software Requirements The following software is also required: Adobe Acrobat or other software application capable of producing documents in portable document format (PDF). Note: Adobe Postscript is not an acceptable format. SEDAR Client Installation Guide 5 January

7 Uninstalling the Current SEDAR Client Before installing the new SEDAR client on a workstation, any previously installed version must be removed from that workstation. This is a one-time change from previous software updates, which had only required that a downloadable update be executed. Previously installed versions should be removed using the Windows uninstaller, which differs slightly depending on the version of Windows. Windows 7 / Windows Vista 1. Navigate to the Start Menu and click on Control Panel. SEDAR Client Installation Guide 6 January

8 2. In the Control Panel, click on Programs and Features. SEDAR Client Installation Guide 7 January

9 3. In Programs and Features, select the SEDAR client program then click Uninstall. 4. After the uninstallation is complete, you will be prompted to restart your workstation; click the Yes button and the workstation will be restarted. 5. To finalize the uninstallation, delete the SEDAR folder from the root of the C:\ drive. SEDAR Client Installation Guide 8 January

10 Windows XP 1. Navigate to the Start Menu and click on Control Panel. Windows XP SEDAR Client Installation Guide 9 January

11 2. In the Control Panel, click on Add or Remove Programs. SEDAR Client Installation Guide 10 January

12 3. In Add or Remove Programs, select the SEDAR client program then click the Remove button. 4. After the uninstallation is complete, you will be prompted to restart your workstation; click the Yes button and workstation will be restarted. 5. To finalize the uninstallation, delete the SEDAR folder from the root of the C:\ drive. SEDAR Client Installation Guide 11 January

13 Installing the New SEDAR Client The following steps describe the installation of the new SEDAR client on a workstation. These same steps apply when installing the new SEDAR client in a test environment, and when installing it on a user s workstation. 1. When logged in to the workstation as an Administrator, run the SEDAR client installation file for the appropriate Windows environment: Windows 7 (32-bit) SEDAR_Win7_32_Setup.exe Windows 7 (64-bit) SEDAR_Win7_64_Setup.exe Windows Vista SEDAR_Vista_Setup.exe Windows XP DiskCreation4.exe 2. Select the language for the installation. SEDAR Client Installation Guide 12 January

14 3. If the IBM WebSphere MQ Series software is not already installed on the workstation, the following screen will display. Ensure that the MQ Series check box is checked then click the Next button to continue. SEDAR Client Installation Guide 13 January

15 4. On the Welcome screen, click the Next button to begin the SEDAR client installation. SEDAR Client Installation Guide 14 January

16 5. Select the options you want to install. Click the Next button to continue. SEDAR Client Installation Guide 15 January

17 6. On the Begin Installation screen, click the Install button. SEDAR Client Installation Guide 16 January

18 7. The Installation Progress screen will display during the installation process. SEDAR Client Installation Guide 17 January

19 8. Once finished, the following screen will display; click the Close button. SEDAR Client Installation Guide 18 January

20 9. The following screen will display prompting you to restart the workstation. Click the Yes button to restart and complete the installation process. SEDAR Client Installation Guide 19 January

21 Additional Installation Test Information Reconfiguration of Firewalls Some firms may need to reconfigure their firewalls and proxy servers to allow the VPN client and/or SEDAR client to access the production SEDAR system. These changes must be made prior to deploying the new SEDAR client to the users workstations. The required IP and DNS addresses for the SEDAR client are: SEDAR Client DNS mq.sedar.com SEDAR Client IP SEDAR Client IP The required IP and DNS addresses for the VPN client are: VPN Client DNS vpn.sedar.com VPN Client IP VPN Client IP The required ports for the VPN client are: UDP RDP (necessary only for MEP resolving and dynamic interface resolving) TCP Topology download TCP In Visitor Mode, all VPN traffic is tunneled through port 443 UDP IKE TCP IKE over TCP IP protocol 50 - ESP (the actual encrypted data; not necessary to allow this, if using UDP encapsulation) UDP UDP encapsulation (encapsulates protocol 50 ESP packets) UDP NAT-T port for industry standard udp encapsulation SEDAR Client Installation Guide 20 January

22 Post Installation Production Code Update and Configuration This section of the document discusses the steps necessary to follow when loading the new SEDAR client onto a user s workstation. After a successful installation of the new SEDAR client and restart of the workstation, the SEDAR client is ready to be launched for the first time. Prior to using the SEDAR client on a user s workstation, there are a few initial setup steps that must be completed. Note: These steps are specific to each workstation and must be done after installation. That is, they cannot be part of a standard disk image or push installation process. Note: If using VPN Connect, establish the connection now before proceeding to the First-time Execution steps below. To start VPN Connect go to Windows Start, click All Programs, then click SEDAR, then click VPN Connect. First-time Execution of the SEDAR Client 1. To launch the SEDAR client, click on the SEDAR.EXE shortcut icon that the installation process placed on the workstation s desktop. 2. The first screen will simply announce the first-time configuration. Click OK to continue. SEDAR Client Installation Guide 21 January

23 3. On the next screen, the SEDAR client will prompt the user for their current login credentials (Userid and Password) as well as requiring that a new Password be entered. Leave the checkbox at the bottom unchecked or you will be prompted for credentials every time you save data. Note: This is a standard step that must be done following the installation of the SEDAR client, even if you are not a first-time user and/or another version of the SEDAR client has been used on the same workstation in the past. Note: At this point, the SEDAR client will need to access the SEDAR server and database. If the connection cannot be made, you may see any or all of the following messages. Before contacting Technical Support, please ensure any required firewall changes (see page 20 above) have been made. SEDAR Client Installation Guide 22 January

24 SEDAR Client Installation Guide 23 January

25 4. If the credentials and the new password have been verified, and the connection to the SEDAR server and database is successful, the SEDAR client will check for any available updates that need to be downloaded and applied. 5. When the download has completed, the SEDAR client will prompt the user to run the SEDAR client Code Update to apply the required changes. Click OK to continue. 6. The next screen will confirm that the first-time configuration has completed. SEDAR Client Installation Guide 24 January

26 7. Before the SEDAR client can be run again, the downloaded SEDAR client updates must be applied by running the Code Update feature. Navigate to the Start Menu and click on All Programs, then SEDAR, then Code Update. 8. The updates will be applied to the SEDAR client. SEDAR Client Installation Guide 25 January

27 9. Once completed, the following screen will be displayed confirming that the updates were applied. Click OK to continue. The SEDAR client is now ready to be run on this workstation. Date Format Synchronization The date format in the SEDAR client must remain at the default setting of mm/dd/yyyy, and the Windows environment must match this same date format in the Region / Short Date settings. Failure to do this may cause the SEDAR client to misinterpret dates entered on cover page 2 of certain filing types where a financial period or meeting date is required. For example, a date of 01/10/2013 may be interpreted as October 1, 2013 instead of January 10, This date format synchronization should be confirmed before you start using the SEDAR client. Setting the SEDAR Client Date Format 1. Launch the SEDAR client by clicking on the SEDAR.EXE shortcut icon on the workstation s desktop. SEDAR Client Installation Guide 26 January

28 2. On the main SEDAR screen, click User Profile and Defaults. 3. On the User Profile and Defaults screen, click User Defaults SEDAR Client Installation Guide 27 January

29 4. The default date format is mm/dd/yyyy, and should not be changed. See the Date Format Synchronization section for further details. Setting the Windows Date Format 1. Navigate to the Start Menu, click on Control Panel and select Region and Language. See the section Uninstalling the Current SEDAR Client above, for a diagrammatic representation of this step. SEDAR Client Installation Guide 28 January

30 2. On the Region and Language screen, set the Short date date format to M/dd/yy and click OK. Support Services Firms having issues with the SEDAR client installation on the users workstations are requested to call the CSA Service Desk at or Questions will be addressed by the CSA Service Desk, or where requested or appropriate, a conference call or webinar session will be set up. SEDAR Client Installation Guide 29 January