Overview

These instructions are for installing OCS Client version 208.03.000

The OCS Client forms part of the OCS applications. It is installed on the clients computers and is used for connection to the OCS applications and for relaying information to PC applications, online help, client side scripts/programs, the Crystal reporting engine and other 3rd party tools and products.

The OCS Client is also used as a service on a windows XP/2003 server to allow interfacing to 3rd party tools/products that run on a server such as a reporting server, email server or e-commerce server. Currently this is used as a report processing server.

This document explains how to install the OCS Client for correct operation of the OCS applications. It does not explain how those 3rd party tools are to be installed.

The complete list of interfaces/features of the OCS Client are:

NOTE: This document refers to the PC Client or clients computer. This is the machine where the OCS Client is run, which may be the end users PC or in the case of end users running on Terminal Server it is the actual Terminal Server that is considered the client. Thus the use of a terminal server can effectively cut the number of PC's that the OCS Client must be installed on to 1.
 

Prerequisites

The prerequisites for the OCS client application are:
Microsoft Windows XP® Service Pack 3 or Microsoft Windows 2003 R2 Server
Windows Scripting Host 5.6 or later.  
Administrator permissions on the computer. 
Approximately 25 MB of free disk space on the system drive.

Other or higher prerequisites may be required for the 3rd party tools/applications.

Windows Fax Service (For faxing reports)

SMTP Service (For emailing reports)

These prerequisites must be installed in the following order.

Microsoft Universal Data Access Components 2.7   
Microsoft .NET Framework Redistributable 1.1

Crystal Decisions - Redistribution Package 9.2.0.448 dated 2004-05-19 *

* OCS's Crystal Key Code is required to install this package.

* If you have errors exporting to HTML (eg. Authorisation Emails) or any other formats, please read the following knowledge base articles from Business Objects http://support.businessobjects.com/library/kbase/articles/c2012884.asp and http://support.businessobjects.com/library/kbase/articles/c2012421.asp

If your installation of Crystal is missing any of the named files please contact OCS.

Client Installation Steps
 

1. The OCS Client is installed on the PC client by coping all files from the release OCSClient directory to the install directory. It may be installed in any directory.
    
2. A shared directory must be created that is accessible from the Buildpro/OCS server, OCS Client and OCS Service. Every user must have read/write permission to this directory. If the Buildpro/OCS server is running on unix then the appropriate directory services (eg. smb, Novell etc.) must be enabled using the appropriate software (eg. samba). This directory must contain the 2 sub directories msg and msgsrv.
    
3. An OCS Client ini file must be created, eg. OCSprod.ini. A sample ini is shown here, this illustrates a typical client/server setup:
    

;ClientServer=True/False
ClientServer=True

;Path for buildpro binaries
BinaryPath=C:\70600\bin_net

;Buildpro ini Path - only used for fat client installations
BuildProIniPath=
OldBuildProIniPath=

;Path for OCS help files
HelpPath=C:\OCS\Help

;Path for client scripts/programs
ProgramPath=C:\OCS\scripts

;ClientServer bpc settings - only used for client/server installations
AppnServiceHost=<servername>
AppnServiceName=OCS:Prod
OldAppnServiceName=OCSold:Prod

;Display Bitmap When starting OCS (True or False)
OcsBitmap=True

;Application to Start when starting OCS
OcsApplication=todayOCS

;Start Logging to a File
LogFile=

;Start the Debugger
Debugger=False

; Determines if Character Dates Are Being Used
OldSqlDates=False

 

;Determines the data base type being used: either Oracle, SQL, SE (Informix SE) or Informix (Informix Online)

Database=SE

 

;Fax Server

FaxServer=<FaxServer>

 

;Fax Sending Details

; Y or not set = Send faxes

; N = Dont send faxes

; Phone number - Send faxes to the specified number

FaxSend=Y

 

;Fax Phone Number Prefix

;Enter if a number is required for an outside line eg. 0

;Note it is better not to set this prefix and enter all numbers in Canonical Form

;This way windows dialing rules will be used.

; See http://support.microsoft.com/default.aspx?scid=kb;en-us;Q247192

FaxPrefix=<Fax Prefix>

 

;Report Path for reports to a file with no specified path

ReportPath=<Report Path>

 

;SMTP Settings

SMTPServer=<SMTP Service>

SMTPMailFrom=<From Address for SMTP Mail>

 

ocsSharePath=<Data transfer directory>

4. A windows shortcut must be created to the ocs.exe file (which is located where you installed the OCS Client) The shortcut should have the following parameters added:

OCS <ini file name> to run the OCS Application

 

Other parameters that can be used are:

 

Setup <ini file name> to run the Setup Application

Cadmin <ini file name> to run the Build Professional Connection Administrator

Administ <ini file name> to run Build Professional Administrator

6. The Help files must be copied into the help directory as specified in the HelpPath= line in the ini file.
    
7. Any client side scripts/programs called by OCS must either be copied into the directory specified in the ProgramPath= line
   or must exist in the windows users Path.

Service Installation Steps
 

1. Install the OCS Client on the Windows server that will be used for server side application interfacing as per the instructions above.
    
2. An OCS Service ini file must be created named ocsService.ini.
   The ocsService.ini file contain the service message check interval and all the OCS Client ini files to run on subsequent lines.
   A sample ocsService.ini file is shown here, this illustrates a typical site setup:-

30
ocsProd.ini
ocsTest.ini

3. Install the service from the command line using the command:

InstallUtil.exe ocsService.exe

This will ask you the user name and password of the user to run the service as. Currently the service must be run by the local or domain administrator.

NOTE:  The actual service that will appear in the Windows service is "OCS Message Service - <OCS release number>"

5. Modify the service to run under a specific user that has access to all the functions the OCS service requires, such as having access to the printers it is required to print at. 
    
6. Modify the service to automatically start up.
    
7. The OCS service can be un-installed using the command:

InstallUtil.exe /u ocsService.exe

NOTE: The ocsService.exe file used in the uninstall must be the same as the one used to install the service.

NOTE: Any errors encountered by the service are logged to the Windows Event Log.