Getting started

This document is a quick guide that shows how to install StaffCal server data store, the data store manager and StaffCal clients.

 

StaffCal follows a client/server model, where data is held on a central server or servers and StaffCal clients connect to the servers to access data.  

 

Terminology

• Realm - A company, with one or more sites

• Site - A server with one or more groups

• Group - A set of objects (sales people, all staff, visitors, meeting rooms etc)

• Object - Anything that requires a calendar eg people (staff, visitors), room bookings, assett bookings (vehicles, machinery, whiteboards, projectors etc)

   

Software

• StaffCal Client is loaded on individual computers for users to view and change appointments etc

• StaffCal Manager is loaded on only a few machines from which the system will be managed.   Users can set up and change sites, groups and objects within groups.

 

There are three manuals for the StaffCal system.

 

Getting started - (this manual) This covers the planning and installation of the Staffcal data store, and an overview of managing the StaffCal data stores.

 

StaffCal site manager - This shows how to configure and manage StaffCal sites.

 

StaffCal client -   Shows how to use the StaffCal client effectively.

 

 

STEP 1 - Plan the layout of the StaffCal system. The division of people or objects into groups and the location of servers needs to be considered.

 

If you have a smaller business with only one location, you probably only need to install one site (server).

        For a functional diagram of this configuration see LAN Configuration

        For a diagram of the data store structure see Site Structure

 

If you have a larger business with multiple locations using a WAN (Wide Area Network) or possibly even locations connected via the Internet, you will need to configure multiple StaffCal sites.

        For a functional diagram of this configuration see WAN Configuration

        For a diagram of the data store structure see Site Structure

 

Generally speaking you should have one server for each physical site and a maximum of about 300 people or objects per server.   This however is only a guideline and if for instance you had many small sites linked by a high-speed data service to a central 'head office' ,you may need only one StaffCal server with all Staffcal clients connecting to head office.

 

Any computer connected to the network (running TCPIP) with any Windows98 or above operating system is suitable for use as a StaffCal server.   However the higher the specifications of the server the better the data transfer rate.   Other enhancements such as a good backup system, high speed network cards and RAID drives are also a plus.

 

STEP 2 - Install the StaffCal data store.

 

Run the setup file StaffCalendarDataStoreSetupx-x.exe from the setup package on the machine you wish to be the StaffCal server.

 

By default the data service will use port 2339 for communication. Make sure that if your server has a firewall, that this port is open. If you wish to change the default port, you can do so from within the StaffCal service manager.

 

NOTE: It is important to take a note of the DNS connection strings displayed in the setup, or IP connection strings if you wish to reference the StaffCal server by IP address (they are case sensitive).

These connection strings will be used in the StaffCal manager and also the StaffCal client(s).  

 

If you lose the connection strings, then you can run the file IPCFG in the StaffCal data store program group to retrieve the connection strings.

 

STEP 3 - Install StaffCal Site Manager.  

 

StaffCal Manager allows you to configure sites and add, move and delete groups and objects.   It is normally installed on the same server as the StaffCal data store (StaffCal server).   However it can be installed on any machine that it is convenient to work from.  

 

Run the setup file StaffCalendarManagerSetupx-x.exe.

Start StaffCal Site Manager, and log in.

see Login

 

Use StaffCal Manager to set up your realm, sites, groups and objects.  

See StaffCal Manager Tutorial

 

STEP 4 - Install StaffCal Client on each client machine.

 

Run the setup package StaffCalClientSetupx-x.exe on each client machine.

 

NOTE: To make distribution easier, you can specify the connection string as a parameter for the setup package. eg: Run the command line 'StaffCalClientSetupx-x.exe   Myserver:2339:User:User'.

This will automatically use the specified connection string when the user starts the StaffCal Client

 

Run StaffCal     Start/ All programs/ StaffCal/ Staffcal.

 

If you did not specify the connection string on setup, you will need to log into the site where the users object is present (Home server) using the user connection string for that site. (eg: Myserver:2339:User:User).   Note the connection string is case sensitive.

 

Please also read this section on how to use Templates