Data Collection Toolkit Technical Reference

Introduction

This topic describes Financial Analyzer API calls that are used by the routines defined in the macro module of the sample workbook template.

Financial Analyzer API calls

The following table describes the API call that attaches the Financial Analyzer code and shared databases.

Characteristic	Description
Routine name	OFA.EXT.INIT
Purpose	Runs the Financial Analyzer startup routine. Attaches code databases and populated temporary catalogs. Attaches the shared databases and establishes permit security based on the operating system user id.
Input	Blank Path to the OFASYSCF.CFG file
Returns

The following table describes the API call that checks the Task Queue for any waiting task for a particular user.

Characteristic	Description
Routine name	TK.CHK.UNPROC
Description:	This routine takes as input an internal Financial Analyzer user name and then uses it to limit TK.PROP value USER. It then checks the TK.CATALOG for TK.PROP value STATUS of WAITING or IN PROGRESS.
Input:	Financial Analyzer internal user name (i.e., 'AA' for super user)
Returns:	YES -- Tasks are waiting to be processed for this user NO -- No tasks are waiting

The following table describes the API call that runs a solve definition on a particular financial data item.

Characteristic	Description
Routine name:	SO.RUN.DFN
Description:	This routine sets the status of a financial data item using user defined valuesets and runs a solve definition of that financial data item.
Input:	Solve definition name (SO.ENTRY) Multiline text variable containing valueset names with which to limit the financial data item's dimensions
Returns:	YES -- If successful NO -- If unsuccessful

The following table describes the API call that submits data to the shared database.

Characteristic	Description
Routine name:	SB.DATA.SHR
Description	This routine sets the status of data for the financial data item using user defined valuesets. It also submits data for the financial data item to the task queue to update the shared database
Input	Financial Analyzer financial data item Multiline text variable containing valueset names with which to limit the financial data item's dimensions
Returns	YES -- If successful NO -- If unsuccessful