This document outlines the different repositories and folders that are in use by APEX. The purpose and functions of each repository are documented individually.
APEX uses a variety of local folders, some of them appear on list of Local Payloads in the APEX UI and others do not. All folders that are used by APEX originate with a base folder that is configured based the organization the user is associated with. (Agent or County). The individual folders and sub-folders are outlined later in this document.
Remote payloads represent transaction records that are in a specific status within the CeRTNA ERDS or G2G database. Depending on your user role may see list items for Submitted, Retrieved By County, Returned By County, Retrieved By Submitter, or Archived as shown in the diagram below:
Each of these remote payload categories will be explained in the following sections:
Information about the Submitted queue will be placed here.
Information about the Retrieved By County queue will be placed here.
As the name indicates, this queue contains a list of transactions that are currently in Returned By County status. When you click the Returned By County list item in the Remote Payloads section of the Repositories container, the Returned By County detail panel is displayed in the Detail Pane on the right side of the APEX UI as shown below:
The following grid describes each of the number items in the preceding diagram:
Item# | Description |
---|---|
1 | To display a list of transactions that are currently in Retrieved By County status, click the item labeled Returned By County in the list of Remote Payloads. The item selected will be highlighted. |
2 | When a Remote Payload status name has been selected, the Detail Panel will be displayed and the status name will be visible at the top of the panel. |
3 | This 'minus sign' icon ('collapse icon') is displayed when the document list for a transaction has been expanded to show the list of documents associated with the selected transaction. |
4 | When the transaction list is initially displayed, the document list for each transaction is hidden. To expand the document list, click the 'plus sign' icon ('expand icon'). The XML with the document information for the selected transaction will be retrieved. |
5 | This icon is used when a document has been recorded. |
6 | For recorded documents, the recording information is displayed as shown. |
7 | This icon is used when a document has been rejected. |
8 | For rejected documents, the reject information is displayed as shown. |
9 | To view/print a recorded document, select a row by clicking it and then click the 'View' icon. The recorded TIFF image will be opened in the default TIFF Viewer that is configured in their Windows environment. |
A new feature has been added to APEX. Transactions are displayed in the Returned By County or Archived repository list and have been recorded, will have a 'View First Pages' icon displayed at the transaction level as shown below:
If you click the 'View First Pages' icon that is displayed at the transaction level, APEX will iterate through each document associated with the selected recorded transaction and it will capture the first page of each recorded document and present all of the first pages in your configured TIFF viewer. This will allow you to print the group of first pages quickly and easily.
In the preceding screen shot, you can see that there are five documents in the transaction, with varying page counts. Three of the documents are 'recordable' documents so APEX has launched the configured image viewer and displayed the first page of the three 'recordable' documents in the image viewer.
Information about the Retrieved By County queue will be placed here.
Information about the Retrieved By County queue will be placed here.
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}\DRAFTS\ | Used by APEX for Direct-Entry draft transactions. |
{base}\INVALID\ | Folder for XML files that cannot be sent. (Note 5) |
{base}\APEX_WORK\ | Used by APEX Sender for lock files. (Note 6) |
{base}\APEX_WORK\RETRIEVED\ | Used by APEX Retriever for lock files. (Note 7) |
{base}\APEX_WORK\PROCESSED\ | Used by APEX Sender for lock files. (Note 8) |
{base}\APEX_WORK\INVALID\ | Used by APEX Sender for lock files. (Note 9) |
{base}\APEX_WORK\TEMP\ | Used by APEX for converting Base64 strings to TIFF images. (Note 10) |
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 | The APEX Direct-Entry UI provide a way for submitters/agents to assemble transactions before sending them to the County Recorder. As Draft transactions are being assembled, their information is temporarily stored in the local DRAFTS subfolder. After the Draft transaction is selected to be Sent, the DRAFTS transaction is removed. |
5 | 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. |
6 | 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.) |
7 | 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.) |
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.) |
9 | This folder holds lock files for the XML files that are being moved to the INVALID subfolder. (This folder is intended to be used exclusively by APEX.) |
10 | The TIFF images from recorded transactions can be viewed. APEX uses the TEMP subfolder as a work folder when converting Base64 to TIFF. The temporary folder/file path is passed to Windows to allow the default TIFF image viewer to display the recorded TIFF image.) |