4
Working with Configuration Files

Chapter summary

This chapter describes a set of configuration files that are installed as part of the Financial Analyzer software. You may need to create or edit one or more of these files as part of installing and configuring a particular type of workstation.

List of topics

This chapter includes the following topics:

Purpose and Types of Configuration Files

Purpose of configuration files

The Financial Analyzer configuration files control system communication in the following ways:

They control how workstations communicate with their associated shared and code databases.
They control how Administrator workstations communicate with superior or subordinate administrators.

Types of configuration files

The following configuration files will be discussed in this chapter:

System configuration file: ofasyscf.cfg
Code configuration file: ofacdcf.cfg
Personal configuration file: personal_database_name.cfg

System Configuration File

Introduction

The system configuration file (ofasyscf.cfg) contains information that is used to populate the ofasyscf.db database at run time. The file contains three sections, which specify the following information:

The location of the shared database associated with a workstation
The location of the superior administrator's shared database
The location of the CODE, TEMPORARY, and TASKFILE directories.

File locations

The system configuration file can be installed into the following locations:

The SHARED directory of a Super administrator workstation
The SHARED directory of an Administrator workstation
The SHARED directory of a cluster
The personal directory of a thick-client workstation

File contents

The system configuration file contains the following settings. These settings require different information to be entered depending on the file's location in your system. The location of the file in your system indicates the type of workstation or configuration that is using the information in the file.

Setting	Required Information
`[Shared]`
`SHAREDACCESS`	`DIRECT` (if the shared databases are on the same server as the workstations using this configuration file) or `REMOTE` (if the shared databases are on a different server as the workstations using this configuration file)
`SHAREDCFGPATH`	path of the shared configuration file or shared databases
`SHAREDHOST`	name of the server where the instance of Express Server associated with the shared databases is running
`SHAREDPORT`	the XCA port number for the instance of Express Server associated with the shared databases
`SHAREDHOSTTYPE`	NT or UNIX (the server type on which the shared databases are located)
`[Super]`
`SUPERACCESS`	`DIRECT` (if the superior administrator's shared databases are on the same server as the subordinate administrator's shared databases) or `REMOTE` (if the superior administrator's shared databases are on a different server from the subordinate administrators shared databases)
`SUPERCFGPATH`	path of the superior administrator's shared configuration file
`SUPERHOST`	name of the server where the instance of Express Server associated with the superior administrator's shared databases is running
`SUPERPORT`	the XCA port number for the instance of Express Server associated with the shared databases of the superior administrator
`SUPERHOSTTYPE`	`NT` or `UNIX` (The server type on which the shared databases of the superior administrator are located)
`[Path]`
`CODECFGPATH`	path of the code configuration file
`TMPFILEPATH`	path of the `TEMPORARY` directory
`TASKFILEPATH`	path of the Task Processor file directory

Specifications for the ofasyscf.cfg file in the SHARED directory of a Super administrator workstation

Specify the following settings for the system configuration file located in the SHARED directory of a Super administrator workstation.

Setting	Required Information
`[Shared]`
`SHAREDACCESS`	`DIRECT`
`SHAREDCFGPATH`	path of the shared directory of the Super administrator
`SHAREDHOST`	name of the server where the instance of Express Server associated with the shared databases of the Super administrator is running
`SHAREDPORT`	XCA port number for the instance of Express Server associated with the Super administrators shared databases
`SHAREDHOSTTYPE`	the server type on which the shared databases of the Super administrator are located
`[Super]`
`SUPERACCESS`
`SUPERCFGPATH`
`SUPERHOST`
`SUPERPORT`
`SUPERHOSTTYPE`
`[Path]`
`CODECFGPATH`	path of the `CODE` directory of the Super administrator
`TMPFILEPATH`	path of the `TEMPORARY` directory of the Super administrator
`TASKFILEPATH`	path of the `TASKFILE` directory of the Super administrator

Specifications for the ofasyscf.cfg file in the SHARED directory of an Administrator workstation

Specify the following settings for the system configuration file located in the SHARED directory of an Administrator workstation.

Setting	Required Information
`[Shared]`
`SHAREDACCESS`	`DIRECT`
`SHAREDCFGPATH`	path of the shared directory of the Administrator
`SHAREDHOST`	name of the server where the instance of Express Server associated with the shared databases of the Administrator is running
`SHAREDPORT`	XCA port number for the instance of Express Server associated with the administrator's shared databases
`SHAREDHOSTTYPE`	the server type on which the shared databases of the administrator are located
`[Super]`
`SUPERACCESS`	`DIRECT` or `REMOTE`
`SUPERCFGPATH`	path of the `SHARED` directory of the superior administrator
`SUPERHOST`	name of the server where the instance of Express Server associated with the shared databases of the superior administrator is running
`SUPERPORT`	XCA port number for the instance of Express Server associated with the superior administrator's shared databases
`SUPERHOSTTYPE`	the server type on which the shared databases of the superior administrator are located
`[Path]`
`CODECFGPATH`	path of the `CODE` directory of the Administrator
`TMPFILEPATH`	path of the `TEMPORARY` directory of the Administrator
`TASKFILEPATH`	path of the `TASKFILE` directory of the Administrator

Specifications for the ofasyscf.cfg file in the SHARED directory of a cluster

Specify the following settings for the system configuration file located in the SHARED directory of a cluster.

Setting	Required Information
`[Shared]`
`SHAREDACCESS`	`REMOTE`
`SHAREDCFGPATH`	path of the shared directory of the Administrator into which the cluster reports
`SHAREDHOST`	name of the server where the instance of Express Server associated with the shared databases of the Administrator into which the cluster reports is running
`SHAREDPORT`	XCA port number for the instance of Express Server associated with the shared databases of the administrator into which the cluster reports
`SHAREDHOSTTYPE`	the server type on which the shared databases of the Administrator into which the cluster reports are located
`[Super]`
`SUPERACCESS`
`SUPERCFGPATH`
`SUPERHOST`
`SUPERPORT`
`SUPERHOSTTYPE`
`[Path]`
`CODECFGPATH`	path of the `CODE` directory of the cluster workstations
`TMPFILEPATH`	path of the TEMPORARY directory of the cluster workstations
`TASKFILEPATH`

Specifications for the ofasyscf.cfg file in the personal directory of a thick-client workstation

Specify the following settings for the system configuration file located in the personal directory of a thick-client workstation.

Setting	Required Information
`[Shared]`
`SHAREDACCESS`	`REMOTE`
`SHAREDCFGPATH`	path of the shared directory of the Administrator into which the thick client reports
`SHAREDHOST`	name of the server where the instance of Express Server associated with the shared databases of the administrator into which the thick client reports is running
`SHAREDPORT`	XCA port number for the instance of Express Server associated with the shared databases of the administrator into which the thick client reports
`SHAREDHOSTTYPE`	the server type on which the shared databases of the administrator into which the thick client reports are located
`[Super]`
`SUPERACCESS`
`SUPERCFGPATH`
`SUPERHOST`
`SUPERPORT`
`SUPERHOSTTYPE`
`[Path]`
`CODECFGPATH`	path of the code directory of the thick-client workstation, such as `oracle_home``/olap/ofa``xxx``/client/`
`TMPFILEPATH`	path of the temporary directory of the thick-client workstation, such as `oracle_home``/olap/ofa``xxx``/client/thick/``database_name``/` where database_name is the name of the thick-client workstation
`TASKFILEPATH`

Code Configuration File

Introduction

The code configuration file (ofacdcf.cfg) contains information about the location of the code databases and allows the declaration of a primary custom database. It also contains information that is used to populate the ofacdcf.db database at run time.

File contents

The code configuration file contains the following settings.

Setting	Required Information
`[Code Databases Path]`
`OFACODEPATH`	location of the `CODE` directory
`[Primary Custom Database]`
`OFALCNAME`	name of the primary custom database, which should be located in the `CODE` directory (required only if you have a custom database to attach)

Personal Configuration File

Introduction

A personal configuration file (database_name.cfg) exists for each personal database in a Financial Analyzer system. It contains information about the location of the system configuration file that is used by that workstation. The personal configuration file for a Super administrator workstation also specifies whether the Oracle General Ledger Integration Module is installed.

File contents

The personal configuration file contains the following settings.

Setting	Required Information
`OFASYSCFPATH`	path to the `ofasyscf.cfg` file used by the workstation. (For a thin-client workstation, it references the `ofasyscf.cfg` file located in the `SHARED` directory of the administrator to which the workstation reports. For a thin-client workstation in a cluster, it references the `ofasyscf.cfg` file in the `SHARED` directory of the cluster. For a thick-client workstation, it points to the `ofasyscf.cfg` file in the personal directory of the client.)
`USEORAGL`	`YES` (for a Super administrator workstation with the Oracle General Ledger Integration Module installed) or `NO` (for all other workstations and for a Super administrator workstation that does not have the Oracle General Ledger Integration Module installed)

Setting

Required Information

OFASYSCFPATH

path to the ofasyscf.cfg file used by the workstation. (For a thin-client workstation, it references the ofasyscf.cfg file located in the SHARED directory of the administrator to which the workstation reports. For a thin-client workstation in a cluster, it references the ofasyscf.cfg file in the SHARED directory of the cluster. For a thick-client workstation, it points to the ofasyscf.cfg file in the personal directory of the client.)

USEORAGL

YES (for a Super administrator workstation with the Oracle General Ledger Integration Module installed)

NO (for all other workstations and for a Super administrator workstation that does not have the Oracle General Ledger Integration Module installed)

4 Working with Configuration Files

Chapter summary

List of topics

Purpose and Types of Configuration Files

Purpose of configuration files

Types of configuration files

System Configuration File

Introduction

File locations

File contents

Specifications for the ofasyscf.cfg file in the SHARED directory of a Super administrator workstation

Specifications for the ofasyscf.cfg file in the SHARED directory of an Administrator workstation

Specifications for the ofasyscf.cfg file in the SHARED directory of a cluster

Specifications for the ofasyscf.cfg file in the personal directory of a thick-client workstation

Code Configuration File

Introduction

File contents

Personal Configuration File

Introduction

File contents

4
Working with Configuration Files