2 Installation 2.1 SYSTEM REQUIREMENTS STRUCTURE OF PROGRAM DIRECTORY SUMMARY OF INSTALLATION PROCEDURES CSA DATABASE SETUP 7

Transcription

1 2 Installation 2.1 SYSTEM REQUIREMENTS STRUCTURE OF PROGRAM DIRECTORY SUMMARY OF INSTALLATION PROCEDURES SINGLE-USER LICENSE NETWORK-USER LICENSE CSA DATABASE SETUP DEFAULT DATABASE SETUP PROCEDURES MULTIPLE DATABASES CSA EXPERT SETUP SETUP PROCEDURES SYSTEM HARDLOCK HARDLOCK DEVICE (THE HARDWARE) HARDLOCK DRIVER FOR SERVER (THE SOFTWARE) CSA SYSTEM MANAGER SYSTEM MAINTENANCE DATABASE MAINTENANCE WORKSTATION SETUP WHERE AND WHAT TO INSTALL? SETUP PROCEDURES HL-SERVER ADMINISTRATION SETUP PROCEDURES 24

2 2.1 System Requirements The System Hardlock To use CSA, a USB dongle and its driver program need to be installed. It is conventionally called the "CSA Hardlock. For single-user license, the Hardlock must be installed to the computer where your CSA is resided. For network-user license, it can be installed in the network server or one of its workstations. Microsoft SQL Server CSA Expert adopts Microsoft SQL Server 2008 or later as its data platform. If you do not have Microsoft SQL Server, you may purchase one or download the FREE SQL Server Express from Microsoft. Download link: SQL Server Express is limited to one processor, 1 GB of memory, and a maximum database size of 10 GB. The default collation registry entry is SQL_Latin1_General_CP1_CI_AS. For more licensing information, please refer to the SQL Server Licensing Database on the SQL Server website: Microsoft SQL Server Management Studio is also necessary for data management. It is a FREE tool which can be downloaded at. System Requirements for Workstation The following system requirements are recommended: Processor Memory Initial disk space Operating system Display Printer Other collaborative programs 2GHz processor or higher 2GB RAM or higher - 1GB for application files and document templates; - Minimum 15GB for SQL Server, system and pre-defined data Microsoft Windows XP or above 1024 x 768 or higher resolution 600 dpi (laser printer is recommended) - Java Runtime Environment Download link: - Versitech e-form Filler Download link: - Microsoft Word 2000 or above for generating documents and reports - Microsoft Excel 2000 or above (or Microsoft Visio) for generating group structure chart * Office Starter version is NOT supported 2-1

3 2.2 Structure of Program Directory CSA Expert is a Client / Server application. For network-user license, CSA should be located in a file server or a dedicated workstation, and is shared by all users. For single-user license, CSA usually resides in the user's local hard disk. The directory structure of CSA Expert has many levels. The highest level (root) is named "PNL" which means the product family and resources developed by P & L Associates. The folder of the CSA program is at the second level, named "CSAEXP". If this folder is resided in the server, it should be assigned to all workstations with a common logical driver letter. Typical folder names of CSA program are: Single-user: C:\PNL\CSAEXP Network-user: F:\PNL\CSAEXP (suppose the server is Drive F) CSA folders can be categorized into four major types according to their natures namely, resources, settings, format files and output files. Folder Type Content Example Resources Program executable and F:\PNL\CSAEXP resources files Settings System and users settings F:\PNL\CSAEXP\Settings Format Files Document templates and F:\PNL\CSAEXP\SYSFMT cache images Output Files Output documents generated by the program F:\PNL\Document\<Client ID> 2-2

4 You may setup different folder permission to control user access CSA program folder, the following table will list the minimum right for user in each folder. CSA Expert has the following directory structure: Level Content Suggested Permission PNL The Root Directory Read & Execute Document Output Documents Full Control [...] Individual Client Folder (name after Client IDs and / or Client Name) Wallpaper Wallpapers Full Control CSAEXP CSA Expert Program Read & Execute Settings System Settings Read & Execute (ini file must be Full Control Right ) Users CSA Users Read & Execute [...] Individual User Folder (name after User IDs) SYSFMT Standard Format Files Read & Execute FRM LTR HKG PRC TWN HKG PRC CMR efm IRD NCR NIR SFC AIC MEA [...] Statutory Forms Hong Kong Companies Registry C/R e-forms Inland Revenue Department New C/R Forms New IRD Forms Securities and Futures Commission Mainland China Administration For Industry & Commerce You may create sub-folders for other AIC agencies. The followings are reserved names: - NAT (State) - PEK (Beijing) - SHA (Shanghai) - CAN (Guangzhou) - SZE (Shenzhen) Taiwan Ministry of Economic Affairs Covering Letters for Jobs Hong Kong Mainland China 2-3

5 Level MIN RPT SPC SYS BVI BVI CYM HKG PRC Content Minutes and Resolutions British Virgin Islands Management Reports Non-statutory Forms British Virgin Islands Cayman Island Hong Kong Mainland China System Documents Suggested Permission CUSFMT Custom Format Files Full Control [...] Same sub-directory structure as SYSFMT IMGFMT Cache for Format Files Full Control [...] Same sub-directory structure as SYSFMT 2-4

6 2.3 Summary of Installation Procedures The CSA program and its database can be stored together in a single computer, or it can be resided separately for security, performance, or backup purposes. For network-user license, please make sure that all CSA users have sufficient rights to access directories where CSA is installed. section 2.2 Structure of Program Directory Single-user license CSA program, SQL Server for database and the Hardlock are all installed in the same computer. (1) Set up SQL Server / SQL Server Express Appendix B: Installation Guide of SQL Server Express (2) Set up Database in Microsoft SQL Server. Section 2.4: CSA Database Setup (3) Install CSA program (insert installation disc) Section 2.5: CSA Expert Setup (4) Plug the Hardlock to user s computer Section 2.6: System Hardlock (5) Run CSA System Manager to create tables of database and validate Hardlock setting (F:\PNL\CSAEXP\CSAExpMan.EXE) Section 2.7: CSA System Manager (6) Run CSA Workstation Setup program: (F:\PNL\CSAEXP\CSAExpStation.EXE) to install the database driver, hardlock driver and create short-cuts Section 2.8: Workstation Setup Network-user License CSA program and SQL Server for database installed in the server. Hardlock is installed in the server or a workstation. (1) Set up SQL Server / SQL Server Express Appendix B: Installation Guide of SQL Server Express (2) Set up Database in Microsoft SQL Server Section 2.4: CSA Database Setup (3) Install CSA program (insert installation disc) Section 2.5: CSA Expert Setup (4) Plug the Hardlock to the server or a workstation that is served as a Hardlock Server Section 2.6.1: Hardlock Device (The Hardware) (5) Run CSA Workstation to install hardlock driver at the Hardlock Server (F:\PNL\CSAEXP\CSAExpStation.EXE) Section 2.6.2: Hardlock Driver for Server (The Software) 2-5

7 (7) Run CSA System Manager to create tables of database (F:\PNL\CSAEXP\CSAExpMan.EXE) Section 2.7: CSA System Manager (8) Share the CSA directory to all users with full access rights. Map the same drive letter for all users, for example, F:\PNL. (9) Run CSA Workstation Setup program (F:\PNL\CSAEXP\CSAExpStation.EXE) at each user s workstation to install the database driver, hardlock driver and create shortcuts Section 2.8: Workstation Setup 2-6

8 2.4 CSA Database Setup Default Database CSA Expert adopts Microsoft SQL Server as its data platform, and uses TCP/IP connection to operate the database. The default database name is "CSA Expert Data" Setup Procedures CSA Login screen (1) Install SQL Server or SQL Server Express Appendix B Installation Guide of SQL Server Express (2) Run the Microsoft SQL Server Management Studio. (3) Create a Database called "CSA_Expert_1" CSA supports up to 9 databases, the number n in CSA_Expert_<n> is the index number of databases 1 9. (i) Right-click Database, select New Database (ii) Add a new database CSA_Expert_1 2-7

9 (iii) Create a SQL Server Login User called "CSA_Admin" with the password "Pnl# ". (iii) Under Database role membership for: CSA_Expert_1, check the box db_owner 2-8

10 2.4.3 Multiple Databases Normally, it is good enough to run a centralized database for all of your Clients. In some situations, you may want to have separated databases for different Clients and Users. Only the authorized Users have the right to login to the assigned database and access to a particular group of Clients. Steps to add additional database CSA Login Select database to login (1) Repeat the steps in the above section to add another database, e.g. CSA_Expert_2. (2) Edit the CSA configuration file (F:\PNL\CSAEXP\SETTINGS\CSAExp.INI) to change the names of databases. For example: [DATA] DATA1=CSA Expert Data 1 DATA2=CSA Expert Data 2 [DATA1] SERVER= \SQLEXPRESS DATABASENAME=CSA_Expert_1 BACKUP_SERVER_DIR=C:\DBBackup BACKUP_CLIENT_DIR= ENTDOC=F:\PNL\CSAEXP\ENTITY_DOC\ USERDOC=F:\PNL\CSAEXP\USER_DOC\ CLIDOC=F:\PNL\DOCUMENT\ [DATA2] SERVER= \SQLEXPRESS DATABASENAME=CSA_Expert_2 BACKUP_SERVER_DIR=C:\DBBackup BACKUP_CLIENT_DIR= ENTDOC=F:\PNL\CSAEXP\ENTITY_DOC\CSA_Expert_2 USERDOC=F:\PNL\CSAEXP\USER_DOC\CSA_Expert_2 2-9

11 CLIDOC=F:\PNL\DOCUMENT\ (3) Run CSA System Manager to create tables of database for all databases (F:\PNL\CSAEXP\CSAExpMan.EXE) Section 2.6: CSA System Manager (4) Run CSA Expert, login to the new database. Create the User ID and assign the access rights for the users whom can access to it. Chapter 3: User Login. 2-10

12 2.5 CSA Expert Setup Important You must have Administration s right to install CSA. You either login Windows as Administration or run the setup program as Administrator. Before starting the CSA Expert setup, make sure the SQL Server has been installed and its configurations have no problem. CSA program can be installed in a file server or one of the workstations. For network-user license, all users share the same program. Ensure you map the same network driver to them and grant full access rights to the PNL folder Setup Procedures (1) Insert the setup CD in the CD-ROM drive and run the setup program (CSAExpSetup.EXE). (2) Click [ Next ] on the welcome screen to start the setup program. (3) Enter the location where you want the CSA program to be installed, for example, F:\PNL. Then click on [ Next ]. 2-11

13 (4) Enter the IP address or computer name of the computer which installed SQL Server. (e.g \SQLExpress or STAFF-PC\SQLExpress ) then click [ Next ]. (5) Check the appreciate box(es) to install the driver(s). Click [Next]. License Green / Blue USB (ver. 1.0) Red / Purple USB (ver. 2.0) Single Install Hardlock Driver Driver 1.0 Network This computer runs CSA - Install Hardlock Driver Driver 1.0 This computer has Hardlock - Install Hardlock Server 1.0 This computer runs CSA and has Hardlock Install Hardlock Driver Driver 1.0 Install Hardlock Server 1.0 Install Hardlock Driver Driver

14 (6) The setup program takes a few seconds to install the CSA program onto the file server. (7) Then the setup program continues on driver installation. (8) Press [Finish] to configuration of database. (9) After installation of CSA program, edit settings file (F:\PNL\CSAExp\SETTINGS\ CSAExp.ini) to enter the location of hardlock server. 2-13

15 IP address of the Hardlock Server? Normally, the installation of the Hardlock Server program is automatically done by the CSA Setup program. You need to add the IP address of the computer which is plugged. The IP address is recorded in the configuration file (INI file). (F:\PNL\CSAExp\SETTINGS\CSAExp.ini). For example, if the IP Address is , the related section in the INI file looks like this: Hardlock 1.0 Hardlock 2.0 [HLSERVER] 1=ADDRESS=CSASERVER 2= [LDK] ip= hosts=csaserver You may use computer name instead of IP address. 2-14

16 2.6 System Hardlock Hardlock Device (the Hardware) What is a Hardlock? CSA uses a USB dongle as a system key called the Hardlock to ensure only the legal owner of CSA can use the program. CSA cannot be executed without the Hardlock. This USB Hardlock is different from the common USB flash drive that it does not have any data storage. It is just a key to open the CSA system. This Hardlock is installed for your system security as well as for our license control. Please take great care of it. A malfunctioned or damaged Hardlock can be replaced at a nominal cost; but if it is lost, you are required to re-purchase the whole system. We have two versions of hardlock and they look slightly different: USB hardlock(1.0) USB hardlock(2.0) What does the Hardlock Server Program do? It installs a Hardlock Server program to the Hardlock Server (HL-Server). It is a memoryresident program which manages the functions of the Hardlock and makes them available to the network clients. At the client side, it enables the workstation to communicate with the HL-Server. Where should the Hardlock be installed? Single-user license It must be plugged to the computer intended to use the CSA program Network-user license Only one hardlock is required. It can be plugged to network server or any of its workstations which is accessible via TCP/IP. 2-15

17 2.6.2 Hardlock Driver for Server (the Software) Which computer needs to install? The server or workstation plugged with the hardlock need to install the Hardlock Driver. How to install the Hardlock Driver? (1) Run F:\PNL\CSAEXP\CSAExpStation.EXE with Administrator s right. (2) At the prompt Setup Components, select the appropriate hardlock driver: License Green / Blue USB (ver. 1.0) Red / Purple USB (ver. 2.0) Single Install Hardlock Driver Driver 1.0 Network This computer runs CSA - Install Hardlock Driver Driver 1.0 This computer has Hardlock - Install Hardlock Server 1.0 Install Hardlock Driver Driver 2.0 This computer runs CSA and has Hardlock Install Hardlock Driver Driver 1.0 Install Hardlock Server

18 2.7 CSA System Manager After installation of CSA program, run the utility CSA System Manger (F:\PNL\CSAExp\ CSAExpMan.exe) to create data files (tables) for the databases System Maintenance The "System" tab of CSA System Manager. In the System tab, the tree-view diagram shown under database is an index of all available CSA databases. If the database is connectible, it is flagged with a leading "tick". On clicking a node (the "+" symbol), it will be expanded to show detailed information of the database as in the right-hand side diagram. This information includes the database type, SQL server name, the database name in the SQL server, and the paths of backup data (if any) at the server and workstation respectively. 2-17

19 2.7.2 Database Maintenance The Database tab is for maintaining data files (tables) of databases. You can create tables, validate and update table structures, and browse records in a particular table. The "Database" tab of CSA System Manager. (1) Select the desired database if you have more than one. (2) Click [ Open ] to open/connect database (3) Click [ Update Table Structure ] to update structure of database tables. (4) Repeat the above steps for each database if you have multi-databases 2-18

20 2.8 Workstation Setup Where and what to install? The Workstation is used to create the program shortcut, install the database driver and the hardlock driver for detecting the hardlock card in the hardlock server. The hardlock driver installs a virtual device driver (HL-Client) to the workstation that is intended to use CSA. It enables the workstation to communicate with the HL-Server. Single-user License Run Workstation Setup (CSAEXPStation.EXE) at the CSA user s computer to install the following: - Java Environment Settings - CSA Shortcuts - Hardlock Driver (can be skipped if you have already installed in the Program Setup CSAEXPSETUP.EXE ) - SQL Native Client Driver Network-user License Run Workstation Setup (CSAEXPStation.EXE) at the each computer that will run CSA, with or without hardlock - Java Environment Settings - CSA Shortcuts - Hardlock Driver - SQL Native Client Driver Setup Procedures (1) Start the Setup Program - Go to the computer that will run CSA. - Open Computer, go to the F:\PNL\CSAEXP - Run the execute file CSAExpStation.EXE - Click [ Next ] on the welcome screen to start the setup program 2-19

21 (2) Your required components are detected automatically. For the workstation without hardlock card, the following components are selected: Modify Java Environment Settings Create CSA Shortcut to Start Menu and Desktop Install Hardlock Driver ( select the appropriate hardlock driver) Install SQL Native Client Driver 2-20

22 (4) Review the installation options, click [ Install ] to start the installation. (5) Enter CSA program path for the shortcut. (6) Install Hardlock Device Driver - The Setup program will then install the Hardlock Device Driver onto the workstation. Click [ Next ] to continue. - When the installation is completed, click [ Finish ] to exit. 2-21

23 HL Driver 1.0 HL Driver 2.0 (7) When the installation complete, click [ Finish ] to exit Assign Trusted Sites in Internet Explorer Before you run CSA, assign the trusted sites in Internet Explorer; otherwise, you may encounter an "Open File Security Warning" message from Windows on accessing the network drive for CSA, add the network drive to the list of "Trusted Sites" in Internet Explorer. 2-22

24 Internet Options in Internet Explorer. (8) To add the network drive to the list of "Trusted Sites" in Internet Explorer: (i) Run Internet Explorer. (ii) On the menu bar, select { Tools > Internet Options }. (iii) In the "Security" tab, select "Local Intranet", then click [ Sites ] (iv) At the next prompt, click [ Advanced ] (v) (vi) At the next prompt, enter the network drive of CSA (e.g. F:\) in the field Add this website to the zone, then click [ Add ]. Click [ OK ] when you return to the previous prompt to exist Internet Options 2-23

25 2.9 HL-Server Administration Important For green / blue USB hardlock (version 1.0) only HL-Server Administration (F:\PNL\CSAExp\SETTINGS\HLSAdmin.exe) is a utility for adding module address for Hardlock Server. After adding the module address, the program will show you how many users can access the CSA program and how many users are using it Setup Procedures (1) On the menu, select { Edit > Add Hardlock }. (2) Enter the Module Address 32109, then click [ Add ]. (3) After module address is successfully added, name of the Hardlock Server will be shown in the grey area 2-24

26 (4) Select { File > Exit } to close HL-Server Administration and continue the CSA installation. Single-user License - Install Hardlock Driver (HLDRV32.EXE) to the computer running CSA and plugged with the Hardlock. Location: F:\PNL\CSAEXP\SETTINGS\HKDRV32.EXE Network-user license Hardlock Server Install Hardlock Server (HLSW32.EXE) to the server / workstation plugged with the Hardlock. Location: F:\PNL\CSAEXP\SETTINGS\HLSW32.EXE Workstation Install Hardlock Driver (HLDRV32.EXE) to each workstation that will run CSA. Location: F:\PNL\CSAEXP\CSAExpStation.EXE Select appropriate driver(s) in Setup program For your convenient, the CSA Setup program F:\PNL\CSAEXP\CSASETUP.EXE and CSA Workstation Setup program both have included the drivers. You can select the appreciate driver(s) to install while you are installing the program or setting up a workstation. The option Hardlock Driver is the driver for workstation (HLDRV32.EXE). The option Hardlock Sever is the driver for Hardlock (HKSW32.EXE). What does the Hardlock Server Program do? The HLSW32.EXE file installs a Hardlock Server program (HL-Server) to the Hardlock Server. It is a memory-resident program which manages the functions of the Hardlock and makes them available to the network clients. The HLDRV32.EXE file installs a virtual device driver (HL-Client) to the workstation that is intended to use CSA. It enables the workstation to communicate with the HL-Server. IP address of the Hardlock Server? Normally, the installation of the Hardlock Server program is automatically done by the CSA Setup program. During setup, it asks you for the computer in which the Hardlock will be installed, and searches for the IP address of that computer. Then it records the IP address in a settings file. (F:\PNL\CSAExp\SETTINGS\ CSAExp.ini). For example, if the IP Address is , the related section in the settings file looks like the following. You may use computer name instead of IP address. [HLSERVER] 1=ADDRESS=CSASERVER 2=