DokuWiki

This is an old revision of the document!

APEX Folder Structures

CeRTNA uses a pair of 'shared' folders for exchanging XML files between the APEX application and the Agent or County. In the CeRTNA environment, each submitter, agent, and county is configured with a 'base' shared folder that serves as the 'root' for a set of subfolders that are used by the APEX application. The 'base' folder can be a local drive, a network drive, or a UNC path.

The following folder/subfolder structures are used by APEX:

Folder/Path	Description
{base}\	Used by the APEX Sender (Note 1)
{base}\RETRIEVED\	Used by the APEX Retriever (Note 2)
{base}\PROCESSED\	For files that have been sent. (Note 3)
{base}\INVALID\	Folder for XML files that cannot be sent. (Note 4)
{base}\APEX_WORK\	Used by APEX Sender for lock files. (Note 5)
{base}\APEX_WORK\RETRIEVED\	Used by APEX Retriever for lock files. (Note 6)
{base}\APEX_WORK\PROCESSED\	Used by APEX Sender for lock files. (Note 7)
{base}\APEX_WORK\INVALID\	Used by APEX Sender for lock files. (Note 8)

The following table contains more descriptive notes for each of the folders referenced in the previous table:

Note	Comments
1	The APEX Sender looks in this folder for XML files that have been placed here by Agent or County interface programs or by the APEX Direct-Entry UI.
2	The APEX Retriever process places XML files in this folder thereby 'handing off' the file to an Agent or County interface program.
3	After the APEX Sender process finishes sending an XML file to the server, it moves the file to this subfolder.
4	Part of the 'sending' process is to perform a variety of validation checks. If the sending validation check returns validation errors, the XML file is moved to this subfolder and an alert message is logged in the APEX Log Panel.
5	APEX processes use a locking mechanism to assign a Sender thread to a specific XML file. This folder holds the lock files created by the APEX Sender processes. (This folder is intended to be used exclusively by APEX.)
6	APEX processes use a locking mechanism to assign a Retriever thread to a specific ERDS or G2G transaction. This folder holds the lock files for the APEX Retriever processes. (This folder is intended to be used exclusively by APEX.)
7	This folder holds lock files for the XML files that are being moved to the PROCESSED subfolder. (This folder is intended to be used exclusively by APEX.)
8	This folder holds lock files for the XML files that are being moved to the PROCESSED subfolder. (This folder is intended to be used exclusively by APEX.)