DokuWiki

Site Tools

Trace:
guides:apex_user_guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
guides:apex_user_guide [2017/11/02 23:00] – brett.zamoraguides:apex_user_guide [2022/11/10 18:22] (current) – brett.zamora
Line 2: Line 2:
  
  
-==== Overview ====+This document is a consolidation of the information that is contained in several other smaller documents. It contains information about how to install APEX, getting around the user interface (UI), and detailed information about the various modules that are available in APEX, for example the APEX Transport module and the APEX Reports module. 
 + 
 + 
 +===== Overview =====
  
  
Line 8: Line 11:
  
   * Secure transport of XML transaction files.   * Secure transport of XML transaction files.
-  * Reporting (Work in progress.) +  * Reporting 
-  * Administration (Work in progress.) +  * Administration 
-  * Direct Order Entry (Work in progress.)+  * Direct Order Entry
  
 Other lower level features include:  Other lower level features include: 
Line 22: Line 25:
  
  
-==== HW & OS Requirements ====+===== HW & OS Requirements =====
  
  
Line 28: Line 31:
  
  
-==== APEX Installation ====+===== APEX Installation =====
  
  
Line 34: Line 37:
  
  
-==== APEX Getting Started ====+===== APEX Getting Started =====
  
  
Line 40: Line 43:
  
  
-==== APEX Transport Module ==== +===== APEX Direct-Entry Module =====
- +
- +
-The APEX Transport Module facilitates the sending and retrieving of transactions, also referred to as 'payloads' and/or XML files. Transactions can only be sent and retrieved on a registered and/or certified ERDS or G2G workstation.  +
- +
-If you are logged into APEX on a registered ERDS or G2G workstation and your user role is authorized to start/stop the APEX transport processes you will see the Start Payloads Send and Start Payloads Retriever buttons on the Actions ribbon as shown below: +
- +
- +
-{{ :guides:images:APEX_Transport-010.png |}} +
- +
- +
-When the Sender and/or Retriever processes are not active/running, the Retriever Manager and Sender Manager rows in the APEX Health component will be red to indicate that those processes are stopped. +
- +
-Click the Start Payloads Sender button to start the Sender and click the Start Payloads Retriever button to start the respective processes. Once the Retriever/Sender processes are running, the APEX UI will change as shown below: +
- +
- +
-{{ :guides:images:APEX_Transport-020.png |}} +
- +
- +
-The APEX detail panel is used to review the list of transactions that are in specific statuses. To view transactions that are in a specific status, click one of the status lines in the Remote Payloads section of the Repositories component.  A list of XML files that are in the local file system can be seen by clicking one of the line items listed in the Local Payloads section of the Repositories component as shown below: +
- +
- +
-{{ :guides:images:APEX_Transport-040.png |}} +
- +
- +
-As can be seen, APEX will display an icon next to files that are currently being transported. +
- +
-An alternative way to see APEX activity is to use the Dashboard View. The Dashboard is accessed by clicking the Dashboard tab as shown below: +
- +
-{{ :guides:images:APEX_Transport-030.png |}} +
- +
- +
-The Dashboard view, shows the list of Retriever/Sender processes (threads) that are currently running. Each process (thread) will identify the specific transaction that it is sending or retrieving. +
- +
-When a process is not actively sending or retrieving a transaction, its status will show as Idle. A process that is Idle is active but it is waiting for a unit of work to become available. +
- +
-All transaction flow is logged to the Log Panel as shown below: +
- +
- +
-{{ :guides:images:APEX_Transport-050.png |}} +
- +
- +
-The Log panel shows separate for when the transaction Sending and/or Retrieving starts and when the transaction Sending and or Retrieving completes. +
- +
-Retriever and Sender processes are managed independently. In other words you can start and/or stop the processes individually by clicking their respective buttons on the Actions Ribbon. When a Retriever or Sender process is stopped, its corresponding status indicator will turn red as shown below: +
- +
- +
-{{ :guides:images:APEX_Transport-060.png |}} +
- +
- +
-To start or stop a Sender or Retriever process, click its corresponding button on the Actions ribbon. +
- +
- +
-==== APEX Reports Module ==== +
- +
- +
-Reports are available in APEX via the APEX Reports feature, which is accessible on the Feature Selector in the left content panel. +
- +
-To see the reports that you are authorized to access, click the Reports selector as shown below: +
- +
- +
-{{ :guides:images:APEX_Reports-010.png |}} +
- +
- +
-APEX Reports are served up via CeRTNA Microsoft SQL Server Report Services (SSRS). The reports in APEX will look and behave exactly like they did in the CeRTNA web client application.  +
- +
-When you select a report a parameter section and a standard toolbar will displayed as shown below: +
- +
- +
-{{ :guides:images:APEX_Reports-020.png |}} +
- +
- +
-The report tool bar has many features.  You can move between pages using the arrows or by typing in a page number to advance to the desired page. You can select an export format from the drop down menu, refresh the report or print the report by clicking one of the buttons. +
- +
-Several formats are available for exporting reports as seen below: +
- +
- +
-{{ :guides:images:APEX_Reports-030.png |}} +
- +
- +
- +
-=== Activity Detail Report === +
- +
- +
- +
-The Activity Detail Report is intended to provide totals of activity by various selection criteria.  The Activity Detail Report provides a baseline management tool to monitor activity for the ERDS, Counties, and Submitters.  This report includes the Transaction ID, County, Originator Name, Customer Reference, County Fees, Instrument Numbers or Rejection Codes and a Status. +
- +
-Parameter selection is based on your user role: +
- +
- +
-**Agent Role Parameters:** +
- +
- +
-{{ :guides:images:APEX_Reports-040.png |}} +
- +
- +
-**County Role Parameters:** +
- +
- +
-{{ :guides:images:APEX_Reports-050.png |}} +
- +
- +
-After the report options have been selected, click the View Report button to generate the Activity Detail Report as shown below: +
- +
- +
-{{ :guides:images:APEX_Reports-060.png |}} +
- +
- +
-Clicking on one of the Transaction ID's will cause the Transaction Audit Report to be displayed in a pop-up window as shown below: +
- +
- +
-{{ :guides:images:APEX_Reports-070.png |}} +
- +
- +
- +
-=== Activity Summary Report === +
- +
- +
- +
-The Activity Summary Report is intended to provide totals of activity by various selection criteria.  The Activity Summary Report provides a baseline Management tool to monitor activity for the ERDS, Counties and Submitters.  This report will list the Submitter and give the total Count, Recording Fee and Tax totals. +
- +
-This report is produced by selecting a Start Date and End Date. Click View Report to view the Activity Summary Report. +
- +
-Depending on your role, you will see one of the following formats: +
- +
-**Agent Role:** +
- +
- +
-{{ :guides:images:APEX_Reports-080.png |}} +
- +
- +
- +
-**County Role:** +
- +
- +
-{{ :guides:images:APEX_Reports-090.png |}} +
- +
- +
- +
-=== Recordation Report === +
- +
- +
- +
-As the name implies, the Recordation Report is intended to provided detailed recording information based on a variety of user specified criteria. +
- +
-This report shows information about the County, Submitter, Transaction ID, Primary & Secondary Reference Numbers, Recording Fees, Taxes, Date/Time of Recording, Document Type and Recorded Instrument Number. +
- +
-This report provides summary information at both county and submitter levels and all totals are rolled into a grand total for the report. +
- +
-The report can be restricted to a specific date range, selected counties or submitters and depending your role, grouping options may be available. +
- +
-Output for the Recordation Report is based on your user role. +
- +
- +
-**Agent Role Samples:** +
- +
- +
-Agent Recordation Report grouped by County: +
- +
- +
-{{ :guides:images:APEX_Reports-100.png |}} +
- +
- +
-Example of summary lines for an Agent Recordation Report grouped by County: +
- +
- +
-{{ :guides:images:APEX_Reports-110.png |}} +
- +
- +
-Agent Recordation Report grouped by Submitter: +
- +
- +
-{{ :guides:images:APEX_Reports-120.png |}} +
- +
- +
-Example of summary lines for an Agent Recordation Report grouped by Submitter: +
- +
- +
-{{ :guides:images:APEX_Reports-130.png |}} +
- +
- +
-**County Role Samples:** +
- +
- +
-County role users do not see a Grouping field. The County view of the Recordation Report is automatically grouped by Submitter. Sample layouts are shown below: +
- +
- +
-{{ :guides:images:APEX_Reports-140.png |}} +
- +
- +
-Example of summary lines for a County Recordation Report: +
- +
- +
-{{ :guides:images:APEX_Reports-150.png |}} +
- +
- +
- +
-=== Reject Detail Report === +
- +
- +
- +
-The Rejection Detail Report is intended to provide rejection details to Submitters and County.  This report includes Transaction ID, County, Submitter, Primary Reference, Last Modified, Doc Type, Rejection Code, Rejection Code Description and Rejection Message.   +
- +
-Parameter selection is based on your user role: +
- +
- +
-**Agent Role Parameters:** +
- +
- +
-{{ :guides:images:APEX_Reports-160.png |}} +
- +
- +
-**County Role Parameters:** +
- +
- +
-{{ :guides:images:APEX_Reports-170.png |}} +
- +
- +
-After the report options have been selected, click the View Report button to generate the Reject Detail Report as shown below: +
- +
- +
-{{ :guides:images:APEX_Reports-180.png |}} +
- +
- +
- +
-=== Status Detail Report === +
- +
- +
- +
-The Status Detail Report shows a summary of all payloads by Status.  This will give the Submitter or County user a snapshot of the activity for a time period and the total number of payloads in any given status. +
- +
- +
-Like the other reports, parameter selection is based on your user role: +
- +
- +
-**Agent Role Parameters:** +
- +
- +
-{{ :guides:images:APEX_Reports-190.png |}} +
- +
- +
-**County Role Parameters:** +
- +
- +
-{{ :guides:images:APEX_Reports-200.png |}} +
- +
- +
-After the report options have been selected, click the View Report button to generate the Status Detail Report as shown below: +
- +
- +
-{{ :guides:images:APEX_Reports-210.png |}} +
- +
- +
-The Transaction History for individual transactions can be viewed by clicking a specific Transaction ID that appears in the detail of the Status Detail Report. When you click a Transaction ID the Transaction history is shown in a pop-up report window as shown below: +
- +
- +
-{{ :guides:images:APEX_Reports-220.png |}} +
- +
- +
- +
-=== Status Summary Report === +
- +
- +
- +
-The Status Summary Report shows summary counts for each of the major transaction statuses. (Draft, Submitted, RetrievedByCounty, ReturnedByCounty, RetrievedBySubmitter, and Archived. The Status Summary Reports can be grouped based on your role. For Agent Roles, the report can be grouped by County or Submitter. For County Roles the report can be grouped by Agent or Submitter. If you are a System Administrator Role you can group the report by County, Agent, or Submitter. +
- +
-Following are samples for Agent and County roles: +
- +
-Agent Role - Grouped by County: +
- +
- +
-{{ :guides:images:APEX_Reports-230.png |}} +
- +
- +
-County Role - Grouped by Agent: +
- +
- +
-{{ :guides:images:APEX_Reports-240.png |}} +
- +
- +
-County Role - Grouped by Submitter: +
- +
- +
-{{ :guides:images:APEX_Reports-250.png |}} +
- +
- +
-Agent Role - Grouped by Submitter: +
- +
- +
-{{ :guides:images:APEX_Reports-260.png |}} +
- +
- +
-If you click a summary value that is greater than zero, the Status Detail Report is displayed in a pop-up report windows for the selected items as shown below: +
- +
- +
-{{ :guides:images:APEX_Reports-265.png |}} +
- +
- +
- +
-=== Transaction Audit Report === +
- +
- +
- +
-The Transaction Audit Report reflects the history of a transaction.  All activity is logged by date, time and user.  The report provides a history of each of the status changes associated with the specific transaction.  This report includes the Type, Reference, Status, Agent, Submitter, County, Created By and Modified By for each status change of the transaction. +
- +
-To generate the Transaction Audit Report enter the Transaction_Id and click View Report.  The report will be generated and displayed as shown below: +
- +
- +
-{{ :guides:images:APEX_Reports-270.png |}} +
- +
- +
- +
-=== Transaction History Report === +
- +
- +
- +
-The Transaction History Report provides a flexible way to review the history of multiple transactions within a single report.  All activity is logged by date, time and user.  The report provides a history of each of the status changes associated with each transaction that meets the filtering criteria.  This report includes the Type, Reference, Status, Agent, Submitter, County, Created By and Modified By for each status change of the transaction. +
- +
-Report sorting and filtering options vary based on user role. +
- +
-Agent role users can sort by County/Submitter or Submitter/County and they can filter based on Start Date, End Date, County, and Submitter as shown below: +
- +
- +
-**Agent Role Samples:** +
- +
- +
-Agent Role sorting by County/Submitter: +
- +
- +
-{{ :guides:images:APEX_Reports-280.png |}}+
  
  
-Agent role sorting by Submitter/County:+{{page>[:guides:apex_direct_entry_ui_guide&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
  
  
-{{ :guides:images:APEX_Reports-290.png |}}+===== APEX Transport Module =====
  
  
-**County Role Samples:**+{{page>[:guides:apex_transport_guide&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
  
  
-County Role sorting by Agent/Submitter:+===== APEX Repositories & Folders =====
  
  
-{{ :guides:images:APEX_Reports-300.png |}}+{{page>[:guides:apex_repositories_guide&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
  
  
-County role sorting by Submitter/Agent:+===== APEX County Admin Module =====
  
  
-{{ :guides:images:APEX_Reports-310.png |}}+{{page>[:guides:apex_county_administrator_guide&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
  
  
 +===== APEX Reports Module =====
  
  
 +{{page>[:guides:apex_reports_guide&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
  
-Continue documentation here. 
  
  
guides/apex_user_guide.1509663604.txt.gz · Last modified: by brett.zamora