Previous Topic

Next Topic

Book Contents

Book Index

Installation

To achieve a quick install go to the following page, Installation instructions & worksheet, print it and follow its instructions.

To install on a single PC go to the section Standalone PC for instructions.

Otherwise you are installing bcdDocuments to a network where one or more PCs may access the program. There are different ways to install bcdDocuments depending on the hardware architecture you have in mind.

Follow the steps below. If you make a mistake or change your installation decisions you can recover easily and without problems.

Decide what machine will be your database server.

Decide what machine(s) will be your file server for document templates and manufactured documents.

Once you have installed bcdDocuments, you need to use the ConfigManager before bcdDocuments is run. The ConfigManager will record the location of:

in the file bcdDocuments.config which is read by bcdDocuments when it starts.

Overview: bcdDocuments can be run from one or many Windows PCs, workstations. It uses MS Word as the document engine, a database and the bcdDocuments program files. Installing needs

1. MS Word installed on each PC using bcdDocs. MS Office installs MS Word.
2. Installing the database engine on a database server or workstation.
3. Copying the bcdDocs.FBDB file to the database server. This is the starting DB file.
4. Copying the bcdDocs files to a file server or workstation.
5. On each workstation run the runAdmin_bcdDocuments.exe program. This program is on the file server.

Once these steps have been done the program can be run and tested.

In This Chapter

Installation instructions & worksheet

Standalone PC

Client/Server architectures

Client

Database server

Database, program and file server(s)

Linux

Security

Program access for staff

Interfacing with other databases

ConfigManager

Previous Topic

Next Topic

Book Contents

Book Index

Installation instructions & worksheet

Follow the six steps. If you make a mistake or change any decision then back up and redo the step again. It may be helpful to print this page and fill in the blank spaces below.

If you are installing bcdDocuments to a standalone PC, use steps 1 through 5 only, where each server is the single PC you are installing to.

Decide which machines will be the data server, the program server and the file server(s). Write down the machine and folder locations as suggested below. You will need these locations at a later step when using ConfigManager.exe.

You will have bcdDocuments install files on some media. Under the source drive <Drive:> are several folders.

1. Database

The database file must be on a machine where the database engine is or will be running.

1.1 The database server is: _______________________________________________

There are other install files available for Linux and other operating systems at InterbaseDownload. The version of the Firebird server you chose can be from version 2.5.3 upwards. The suggested database folder for Windows servers is C:\Program Files\bcdDocuments\Data.
Version 2.5.3 is recommended and its install file is here: http://www.firebirdsql.org/en/firebird-2-5-3

1.3 The folder which will contain the database file is: ___________________________
This folder must be on the database server.

1.4 Copy the <Drive:>\Database\Database File\BCDDOCS.FBDB file to this folder. To back out of this step delete the file. To move this file to another folder, move this file to the new folder. After copying set the file attributes to Read and Write, remove the "Read-only" attribute. This must be done to allow the file to be written to.

2. Document Template Folder

This folder is where documents templates will be stored in files and subfolders. This folder will be the base directory or starting folder for bcdDocuments as it looks for document templates. The suggested document template folder for Windows servers is C:\Program Files\bcdDocuments\Templates.

2.1 The folder for the Document Templates is: ________________________________

2.2 Copy the files and folders in <Drive:>\Templates\ to this folder. To back out of this step delete the file. To move this file to another folder, move this file to the new folder. The files copied are sample document templates.

3. Manufactured Documents Folder

This folder is where documents made in bcdDocuments will be stored in files and subfolders. This folder will be the base directory or starting folder for bcdDocuments as it stores documents and PDF files it makes. The suggested matter documents folder for Windows servers is C:\Program Files\bcdDocuments\MatterDocuments.

3.1 The folder for Matter Documents is: __________________________________

There are no files to copy to this folder.

4. Programs Folder

The Programs Folder will hold files and subfolders comprising the main programs and files for bcdDocuments. This can be on any network file server. The suggested programs folder for Windows servers is C:\Program Files\bcdDocuments\Programs.

4.1 The Programs folder is:_________________________________________________

4.2 Copy the files and folders in directory <Drive:>\Program Files\ to this folder. To back out of this step delete the file. To move this file to another folder, move this file to the new folder.

5. Use ConfigManager

The Config manager section discusses the use of this program showing screen pictures. The ConfigManager program gathers information from you about where your bcdDocuments folders are, how your Client PCs are to run the main program and writes this to the file bcdDocuments.config. This file is read by each Client PC when it starts the main program.

5.1 In the program folder is ConfigManager.exe. From a Windows machine run this program.

5.2 In the "Database" tab insert the database information requested. Test it and save it.

5.3 In the "Directories" tab insert the folders or directories information requested. Test it and save it. The Program Folder 4.1 location is not required here, but is required to set up a Client PC.

5.4 In the "Insert User" tab insert the Windows logon name for a staff member who will be a bcdDocuments Administrator.

An administrator will run the bcdDocuments program and use the Staff Assistant to enter other staff user Windows logon names. The first bcdDocuments Administrator must do this before other staff can use the program. The last remaining bcdDocuments Administrator cannot be deleted. A logon name with bcdDocuments Administrator privileges can be entered at any time.

5.5 The information you have entered is saved to file bcdDocuments.config in the program folder.

5.6 For a standalone PC only. If you are setting up a standalone PC make a shortcut to the bcdDocuments.exe program in the Program Folder. When this shortcut is run the main program runs. This completes the installation for a standalone PC.

Close the ConfigManager program

6. Set up a Client PC

The recommended options here will reduce your maintenance task to a minimum and reduce your network traffic, once past the first client install. The recommended options are:

run_bcdDocuments install diagram

These options can be changed using ConfigManager.exe when it is run from the affected client PC.

6.1 If you choose not to alter these default settings ignore his step. If you want to change these options, from the Client PC run program Run_bcdDocuments.exe from its location in the Program Folder and make changes in tab "Run From". Changes will be saved to the file bcdDocuments.config which affect each client according to the settings saved for each client.

6.2 On each Client PC, make a shortcut to Run_bcdDocuments.exe in the Program Folder. When this shortcut is run the program files will, if you have used the default settings, be copied to the client and the main program run. Consult an experienced user or the Windows help file, using [Start - Help] if you are not sure how to make a shortcut.

This ends the setup for one client. Cycle step 6 for each client PC.

See Also

Installation

Standalone PC

Client/Server architectures

Client

Database server

Database, program and file server(s)

Linux

Security

Program access for staff

Interfacing with other databases

ConfigManager

Previous Topic

Next Topic

Book Contents

Book Index

Standalone PC

If you will be using bcdDocuments on a standalone PC using MS Windows, in the configuration illustrated below, follow the instructions for installing the package to a Windows client-server network, and treat the client and the server as your single PC.

The database server will be your PC. The file server will be your PC. This configuration is available only for a PC Using a Windows operating system.

See Also

Installation

Installation instructions & worksheet

Client/Server architectures

Client

Database server

Database, program and file server(s)

Linux

Security

Program access for staff

Interfacing with other databases

ConfigManager

Previous Topic

Next Topic

Book Contents

Book Index

Client/Server architectures

bcdDocuments can be run

The bcdDocuments package gives you flexibility in managing directories. If you use the package on a single machine you use it in a standalone manner. If you use the package on a network with many staff using the package at the same time you use it in a client-server manner. The machine containing the database file is the server and any machine running the main program is a client.

Installation requirements:

  1. A database server contains the database file and the database engine. This server can be your standalone machine, a Windows workstation, a Windows server or a Linux (or equivalent operating system supporting Windows clients and with a Firebird installation)
  2. A file server for MS Word document templates and for documents you make as Matter documents: DOC, DOCX and PDF files. This file server can be your database server or your standalone machine. So a file server can use Windows, Linux or equivalent operating system supporting Windows clients. You may use separate servers for templates and matter documents.

If you use a Windows workstation the operating system limit the number of concurrent connections to 10 (using Windows Vista and below) or 20 (using Windows 7 or above).

The diagram below illustrates a bcdDocuments network installation.

You choose whether the Database server and File and Program Server are one and the same server or two separate servers.

See Also

Installation

Installation instructions & worksheet

Standalone PC

Client

Database server

Database, program and file server(s)

Linux

Security

Program access for staff

Interfacing with other databases

ConfigManager

Previous Topic

Next Topic

Book Contents

Book Index

Client

The client PCs are those which will run the bcdDocuments program. They use a Windows operating system from Windows XP upwards. They can be used after the installation has been done for the database server and the file server(s).

To setup a client PC you make a shortcut on the client PC to the Run_bcdDocuments.exe program and run this program. File Run_bcdDocuments.exe stays on the file server.

On the first run it will download the required files from the file server to the client and run the bcdDocuments.exe program from its location on the client. Between 30 and 35 MBytes of disk space are required on the client disk are required. The client PC must have MS Word installed before it can be used to make documents.

On subsequent runs it will ensure the latest files are on the client and then run the bcdDocuments.exe program from the client.

See Also

Installation

Installation instructions & worksheet

Standalone PC

Client/Server architectures

Database server

Database, program and file server(s)

Linux

Security

Program access for staff

Interfacing with other databases

ConfigManager

Previous Topic

Next Topic

Book Contents

Book Index

Database server

A database server for bcdDocuments is a machine running the Firebird database engine supporting Windows clients using the TCP/IP protocol. This machine holds the database file named BCDDOCS.FBDB in some folder.

An installation executable file for Firebird 5.2.3 is available at http://www.firebirdsql.org/en/firebird-2-5-3. If your intended database server is running another operating system which can run the Firebird database you can obtain an installation program from http://www.firebirdsql.org/ or from http://sourceforge.net/projects/firebird/.

Once the database engine has been installed the database file must be installed to a directory on the database server using <Drive:>\Database\Database File\setup.exe.

See Also

Installation

Installation instructions & worksheet

Standalone PC

Client/Server architectures

Client

Database, program and file server(s)

Linux

Security

Program access for staff

Interfacing with other databases

ConfigManager

Previous Topic

Next Topic

Book Contents

Book Index

Database, program and file server(s)

There is at least one and up to four servers for bcdDocuments. If you use the program in a standalone manner the single PC serves all functions required.

Folders required:

a database folder on the database server

This folder contains the database file BCDDOCS.FBDB and the machine containing it runs the Firebird database engine. Each time the database is used by a client PC the machine hosting the database is required to perform database work. The routine hourly load on this machine depends on the number of users connected to the database and the type of work they are performing. The machine with this folder is the database server.

a program folder on the program server

This folder contains the Run_bcdDocuments.exe program and other folders and files which will be loaded to each client PC. The first time a client PC uses Run_bcdDocuments.exe between 30 and 35 MBytes will be downloaded to the client's disk. The subsequent uses will load only this program (500 KBytes) and new files to the client. The routine hourly load on this program server therefore depends on how many program starts there are in the hour. The machine with this folder is the program server.

a document template folder on a file server

This folder contains the document template folders and files used by bcdDocuments. Each time a template is required by a client PC the server hosting these file will download it to the client. The routine hourly load on this file server depends on how many requests there are for document templates. The machine with this folder is a file server.

a matter document folder on a file server

This folder contains the documents manufactured by bcdDocuments and their containing folders. Each time a template is required by a client PC makes a document or a PDF from a document the server hosting these files will receive he file from the client PC. The routine hourly load on this file server depends on how many requests there are to receive a file. The machine with this folder is a file server.

Suggested "rule of thumb":

The ConfigManager.exe program on the program server is used to specify these locations. The settings at a site depend on many factors. Network speed, server and client CPU speed and memory are "more is better" factors.

See Also

Installation

Installation instructions & worksheet

Standalone PC

Client/Server architectures

Client

Database server

Linux

Security

Program access for staff

Interfacing with other databases

ConfigManager

Previous Topic

Next Topic

Book Contents

Book Index

Linux

ou may use a Linux PC as your database server and/or your file server.

If you are using a Windows only setup then this page is not relevant.

There are many internet sources for this. Firebird also runs on

At http://www.ibphoenix.com there are install files for Firebird for these operating systems.

The diagram below shows one network configuration using a Linux database server. It looks the same as a windows network. The file server can also be a Linux box. All client PC's will be using a Windows OS.

Linux DB Server

See Also

Installation

Installation instructions & worksheet

Standalone PC

Client/Server architectures

Client

Database server

Database, program and file server(s)

Security

Program access for staff

Interfacing with other databases

ConfigManager

Previous Topic

Next Topic

Book Contents

Book Index

Security

The main programs are run only on Windows Client PCs. On such a PC the Windows logon name is used to allow or prevent the program running. If the logon name is not already in the bcdDocuments database the program will start, announce the name is not registered and stop. If the logon name is registered with bcdDocuments the program will run.

A newly installed program will have no logon names registered. The first staff logon name to be registered is entered using the ConfigManager.exe program and that user has all permissions to the bcdDocuments main program. So anyone able to use the ConfigManager program can enter and give any logon name bcdDocuments Administrator privileges.

Each logon name registered using the Staff Assistant is given a user type ranging from Performer to Administrator, each having increasing privileges. See Enter and edit all users.

The last remaining Administrator logon name cannot be deleted. A logon name with bcdDocuments Administrator privileges can be entered using ConfigManger.exe at any time.

So there is simple security in managing who is allowed to run the program on a network.

See Also

Installation

Installation instructions & worksheet

Standalone PC

Client/Server architectures

Client

Database server

Database, program and file server(s)

Linux

Program access for staff

Interfacing with other databases

ConfigManager

Previous Topic

Next Topic

Book Contents

Book Index

Program access for staff

Staff are registered with bcdDocuments by their Windows logon names. Each staff registered is given a user type. Each type has different access permissions to areas of the program.

User type

Program access

Performer

These staff cab be assigned events to perform. They may access reports, matters and may set events to done or not done.

Standard user

These are Performers who may also make matters and insert clients. They may edit client, site and matter data.

Tester

These are Standard Users who may also use Applications and documents whose status is TEST. They may delete matters and clients. They may insert and delete application, client and site fields. They may use all features of the Client, Client-Matter and Pick Lists Assistants. They may use some of the Maintenance menu items

Manager

These are Standard Users who can also make applications but not register users. They may use all the assistants and all the Maintenance menu items.

SuperManager

Super Managers are Managers who can also register users.

Administrator

An Administrator is a Super Manager whose name cannot be deleted if there are no other Administrators. At least one Administrator will always exist after the first one is entered.

See Also

Installation

Installation instructions & worksheet

Standalone PC

Client/Server architectures

Client

Database server

Database, program and file server(s)

Linux

Security

Interfacing with other databases

ConfigManager

Previous Topic

Next Topic

Book Contents

Book Index

Interfacing with other databases

If you need to import data from other databases for use in bcdDocuments or export data from bcdDocuments to another database please contact support@beldingcd.com to pursue this.

See Also

Installation

Installation instructions & worksheet

Standalone PC

Client/Server architectures

Client

Database server

Database, program and file server(s)

Linux

Security

Program access for staff

ConfigManager

Previous Topic

Next Topic

Book Contents

Book Index

ConfigManager

This program assists you in configuring bcdDocuments. This ConfigManager program should be used only by persons with bcdDocuments Administrator privileges as these users can insert other bcdDocuments' users.

Before you use this program correctly you must have:

  1. Installed the Firebird database engine on a database server.
  2. Copied the database file, BCDDOCS.FBDB to a directory on your database server.
  3. Installed the program files on a file or program server.
  4. Determined the directories you will use for document templates and for manufactured documents.

The main file locations needed by bcdDocuments are shown in the diagram below.

bcdDocuments Places

The ConfigManager program asks for file locations and decisions from you on its pages. The information you supply, when saved, is written to the file bcdDocuments.config and read by the main program each time it runs. You can bypass the ConfigManage program and edit the bcdDocuments.config file with a text editor. It is safer to use the ConfigManager program to effect configuration changes.

In This Section

Database page

Directories page

Insert user page

Run from page

Maintenance page

Menu access page

Locks page

Edit Masks page

See Also

Installation

Installation instructions & worksheet

Standalone PC

Client/Server architectures

Client

Database server

Database, program and file server(s)

Linux

Security

Program access for staff

Interfacing with other databases

Previous Topic

Next Topic

Book Contents

Book Index

Database page

This is where you set the values required for the database. More detailed instructions are contained in the window in the green and/or gray panels.

DBPage

See Also

ConfigManager

Directories page

Insert user page

Run from page

Maintenance page

Menu access page

Locks page

Edit Masks page

Previous Topic

Next Topic

Book Contents

Book Index

Directories page

This is where you specify the paths to the Document Templates and the Manufactured Documents. Use Windows syntax here.

The program uses these paths as base folders to locate templates and to place documents made by bcdDocuments.

You also may specify how folders (or subdirectories) are named in the Manufactured Documents directory in one of two ways.

DirectoriesPage

The Document Templates Folder will be the parent directory for all document templates you develop. The Manufactured Documents Folder will be the parent directory for all documents made.

By using these two parent folders you can change these locations in a few minutes. For example, suppose you have these two folders on file server FSA and on file server FSB you have a backup copy of both directories. If FSA fails you could use ConfigManager to change these two locations from FSA to FSB and the next time bcdDocuments is run on any client PC the new config file would be copied to the client PC and operations are restored.

The document storage options give you two ways to select the names of subfolders where documents made in the program are stored. These are two convenient options. If your firm requires a different option for storing manufactured documents, to conform to your internal document management practice, contact us to arrange that option.

For an illustration of these options suppose you have a client named "Jill Bloggs" and she has a matter you have named "JBLOGGS PURCHASE 001".

The Standard option works like this. Client "Jill Bloggs" has an internal ID, suppose it is "45678". Her matter also has an internal ID, suppose it is "24680". Then any document made as part of the matter will be stored in folder
...Manufactured Documents Folder\Client45678\Matter24680\
and any document made for the client, not part of a matter, would be stored in folder
...Manufactured Documents Folder\Client45678\

The ...\ClientName\MatterName option, if selected, would cause any document made as part of the matter to be stored in folder
...Manufactured Documents Folder\Jill Bloggs\JBLOGGS PURCHASE 001\
and any document made for the client, not part of a matter, to be stored in folder
...Manufactured Documents Folder\Jill Bloggs\.

See Also

ConfigManager

Database page

Insert user page

Run from page

Maintenance page

Menu access page

Locks page

Edit Masks page

Previous Topic

Next Topic

Book Contents

Book Index

Insert user page

On installation bcdDocuments has no users. Here you can insert a user who has administrator privileges. The name entered should be the Windows logon name of the first bcdDocuments Administrator. This use must enter the names of other staff using the Staff Assistant.

You must be able to connect to the database before using this feature.

InsertUserPage

See Also

ConfigManager

Database page

Directories page

Run from page

Maintenance page

Menu access page

Locks page

Edit Masks page

Previous Topic

Next Topic

Book Contents

Book Index

Run from page

Use this page to change the way the main program is run from a client.

The default setting is to copy files required to run bcdDocuments to a directory on each client and run programs from the client, as this usually saves network bandwidth and reduces startup time compared to running the main program from its server.

To run bcdDocuments from this client PC leave this unchecked. In doing so you will likely use less network bandwidth and bcdDocuments will start and run faster. This is the recommended option.

To always run bcdDocuments from the file server, check [ ] Always Run From Server, which appears at the bottom of the window. Using this option will increase network traffic and startup time.

When newer program files are present they will be copied to a directory on this client PC. The default target directory is:

C:\Program Files\bcdDocuments\

You may change this default directory for this client only by entering a new directory in the edit control at the bottom of the window

The file Run_bcdDocuments.exe should not be copied to the client directory; it should only be run from the file server. This program is run to start the main program on a client. Before it starts the main program it copies any newer program files to the client. So the update task for bcdDocuments is reduced to copying new files to their location in the Program Folder.

RunFromPage

See Also

ConfigManager

Database page

Directories page

Insert user page

Maintenance page

Menu access page

Locks page

Edit Masks page

Previous Topic

Next Topic

Book Contents

Book Index

Maintenance page

This page allows you to import or export non-working date sets to the database.

MaintenancePage

See Also

ConfigManager

Database page

Directories page

Insert user page

Run from page

Menu access page

Locks page

Edit Masks page

Previous Topic

Next Topic

Book Contents

Book Index

Menu access page

The Menu access page is where you set access to bcdDocuments menu items for the various types of users. The user types are Performers, Standard User, Tester, Managers, SuperManager and Administrator. Each type of user may have access to different menu items. The reason for having different user types is to allow you to control access to the parts of the bcdDocuments program. You may take the default settings or tailor access to your own needs.

MenuAccessPage

In the Assistants - staff area you set Windows logon names and user types for each user of bcdDocuments.

See Also

ConfigManager

Database page

Directories page

Insert user page

Run from page

Maintenance page

Locks page

Edit Masks page

Previous Topic

Next Topic

Book Contents

Book Index

Locks page

Use this page to turn edit locks on or off. Edit locks are available for Matters, Client Data and Applications.

The lock for matters ensures only one operator may open a particular matter at one time.
The lock for client data ensures only one operator may edit a particular client's data ot one time.
The applications lock ensures only one operator may edit a particular application at one time.

Each lock may be on or off independently of the other locks. The ConfigManager program may be used to remove locks which should not be there. For example if a client PC placed a matter lock and then the PC was removed from the network before it removed the lock, the lock would require removing using ConfigManager. When another operator tried to open the locked matter they would be told the lock was present, the name of the operator who set the lock, the PC which set the lock, when the lock was set and the last date and time that PC reaffirmed the lock was valid.

LocksPage

See Also

ConfigManager

Database page

Directories page

Insert user page

Run from page

Maintenance page

Menu access page

Edit Masks page

Previous Topic

Next Topic

Book Contents

Book Index

Edit Masks page

Edit masks allow you to specify the format of client numbers and matter numbers. Details about edit masks are here: edit masks.

For example, if you require your client numbers to be like "ABCDEF-1234" you can achieve this by using this page to specify "LLLLLL-0000".

EditMasks

See Also

ConfigManager

Database page

Directories page

Insert user page

Run from page

Maintenance page

Menu access page

Locks page