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 22:32] – [APEX Reports Module] 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 ===== 
  
 {{page>[:guides:hw_and_os_reqs&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}} {{page>[:guides:hw_and_os_reqs&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
  
  
-==== APEX Installation ==== +===== APEX Installation =====
- +
- +
-APEX is based on the Microsoft "Click-Once" software architecture. This means that the installation files are accessed over the Internet. You can initiate the installation of APEX by clicking on the following URL: +
- +
-https://dev-ws02.certna.org/APEX/Setup/index.html +
- +
-The following page is displayed in your browser: +
- +
- +
-{{ :guides:images:APEX_Install-010.png |}} +
- +
- +
-Click the Install button. You should see the following prompt at the bottom of the browser window: +
- +
- +
-{{ :guides:images:APEX_Install-020.png |}} +
- +
- +
-Click the Run button. +
- +
-Applications that are installed over the Internet should be signed so that you know that the application software is distributed by a trusted source. The following Application Install Security Warning is displayed: +
- +
- +
-{{ :guides:images:APEX_Install-030.png |}} +
- +
- +
-Optionally, you can display the CeRTNA Code Signing Certificate by clicking the link labeled California Electronic Recording Transaction Network Authority. If you click the link, the following panel is displayed to so CeRTNA's code signing certificate information: +
- +
- +
-{{ :guides:images:APEX_Install-040.png |}} +
- +
- +
-When you are finished viewing the certificate details, click the Ok button to close the window. +
- +
- +
-From the Application Install Security Warning window, click the Install button. The APEX application will be installed and a progress window will be displayed as shown below: +
- +
- +
-{{ :guides:images:APEX_Install-050.png |}} +
- +
- +
-Once the installation completes, the APEX client application will automatically launch as shown below: +
- +
- +
-{{ :guides:images:APEX_Install-060.png |}} +
- +
- +
- +
-This completes the APEX Installation process. +
- +
- +
-==== APEX Login Panel ==== +
- +
- +
-To access the APEX Login Panel, click the User Login button, located on the main APEX ribbon: +
- +
- +
-{{ :guides:images:APEX_Login-010.png |}} +
- +
- +
-The following Login Panel will be displayed: +
- +
- +
-{{ :guides:images:APEX_Login-020.png |}} +
- +
- +
-**Field Descriptions:** +
- +
- +
- +
-{{tablelayout?colwidth="150px,500px"&rowsFixed=1&rowsVisible=10&float=left}} +
-^ Field          ^ Description     ^ +
-| User Name | This is your CeRTNA ERDS or G2G userid. | +
-| Password | This is your CeRTNA ERDS or G2G password. (Not your token password.) | +
-| Platform | Select from the list or type in Production-ERDS or Production-G2G | +
-| Status Icon | When you select or type in a Platform value, APEX will verify that it can communicate with the selected platform. A green circle with a white checkbox, means APEX communicate with the selected Platform. A red circle with an X means APEX is not able to communicate with the selected platform. | +
-| Refresh Icon | This icon can be clicked to tell APEX to try communicating with the selected platform again. | +
-| Show Password | Clicking this checkbox will cause your password to be displayed in plain text. | +
-| Forgot Password | Click this link if you need to reset your password. (More detail later in this document.) | +
-| Register Workstation | In order to use APEX for sending or retrieving transactions, your workstation must be a registered, certified ERDS workstation. Use this link to submit a registration request for your workstation. (More detail later in this document. | +
-| Login Button | Once a userid, password, and valid Platform name have been entered, this button will be enabled. Click this button to continue logging into the CeRTNA ERDS and/or G2G workstation. | +
-| Cancel Button | Click this button to Cancel and close the Login Panel. | +
- +
- +
-After you have entered your User Name, Password, and Platform you can click the Login button. APEX will then initiate a variety of actions including, verifying your credentials, retrieving and verifying configuration information associated with your user and your organization and APEX will retrieve and verify your PKI Authentication Certificate. +
- +
-While APEX is performing these actions, the following panel will be displayed: +
- +
- +
-{{ :guides:images:APEX_Login-060.png |}} +
- +
- +
-During the login verification process, you may be prompted to enter the password (PIN) for your USB token. If your token password is required, the following pop-up window will be displayed.  +
- +
- +
-{{ :guides:images:APEX_Login-080.png |}} +
- +
- +
-Enter your token password, click the Ok button, and the login verification process will continue forward. +
- +
- +
-Once the login initialization and verification process completes, you will be presented with the main APEX UI as shown below: +
- +
- +
-{{ :guides:images:APEX_Login-070.png |}} +
- +
- +
- +
-Documentation for the APEX UI can be found further down in this document. +
- +
- +
- +
-==== Forgot Password Panel ==== +
- +
- +
-When you click Forgot Password link on the main Login Panel, the following pop-up window is displayed: +
- +
- +
-{{ :guides:images:APEX_Login-030.png |}} +
- +
- +
-In the User Name field, enter the userid for the platform that you selected on the Login Panel and then click the Request Password Change button. +
- +
-A temporary password will be sent to the e-mail address that is associated with the userid that you entered. +
- +
-When you receive the temporary password, enter the temporary password into the Password Change Code field and then enter your new password into the New Password and the Confirm New Password fields. +
- +
-If you are uncertain about the password formatting rules, you can click the question mark icon and the following pop-up window will be displayed, showing you the rules for creating a password: +
- +
- +
-{{ :guides:images:APEX_Login-040.png |}} +
-  +
- +
-If you have entered a new password that meets the password formatting requirements, the Change Password button will become enabled and you can click it to change your password. +
- +
- +
-==== Register Workstation Panel ==== +
- +
- +
-Workstations that are used to transmit ERDS or G2G transactions (payloads) **must** be certified by CeRTNA. The certification process includes a verification that the workstation is configured as outlined in the document Preparing For A System Audit and that an acceptable Microsoft Baseline Security Analyzer report has been submitted to CeRTNA. +
- +
-The Register Workstation process is the method that APEX uses to ensure that only 'certified' workstations are used for transmitting ERDS or G2G transactions (payloads). If you have installed APEX on a workstation that has not been registered, the buttons for sending and retrieving transactions will not be displayed, which means you will not be able to send and/or retrieve transactions. +
- +
-If you are installing APEX on a workstation that has been certified by CeRTNA, you can register the workstation by clicking the Register Workstation link on the Login Panel. When you click the Register Workstation link, the following pop-up window is displayed: +
- +
- +
-{{ :guides:images:APEX_Login-050.png |}} +
- +
- +
-All fields are required. Once you have completed filling in the form, click the Register Workstation button and a workstation registration request will be created. CeRTNA staff will receive an e-mail notification that the workstation registration request has been created and a staff member will verify that the ERDS or G2G workstation has been certified. If the workstation has been certified, CeRTNA staff will approve the workstation registration request and this will cause APEX to enable the functionality required to send and retrieve ERDS or G2G transactions. +
- +
-A confirmation e-mail will be sent to the address provided in the registration request to inform the requester about the status of their registration request. +
- +
- +
-==== APEX UI Overview ==== +
- +
- +
-Once a CeRTNA ERDS or G2G user has successfully logged into APEX, they will be presented with the main APEX User Interface (UI). +
- +
- +
-The APEX UI is managed dynamically based on each users role, organization, and individual permissions. At a high level, the APEX UI is constructed based on the following UI map: +
- +
- +
-{{ :guides:images:APEX_UI-010.png |}} +
- +
- +
- +
-As shown, the main APEX UI contains a series of Containers, Components, and Selectors. Containers will contain one or more APEX functional components. Selectors provide a way to switch between different functional components. +
- +
- +
- +
-The following table describes each item: +
- +
- +
-{{tablelayout?colwidth="50px, 200px,400px"&rowsFixed=1&rowsVisible=14&float=left}} +
-^ Item ^ Name ^ Description ^ +
-| 1 | Ribbon Container | This section holds various ribbon components. These components may be buttons that trigger actions or components that simply provide static information. | +
-| 2 | Feature Container | This area serves as a navigation area for the various features offered by APEX. As described earlier, the features that will be visble will be driven by the users role and organization. Some initial features may include Repository View, Reports, and Administration. The APEX Health feature is a static feature that is visible at all times. | +
-| 3 | Detail Container | This section contains components that respond dynamically based on feature that has been selected in the Feature Container. | +
-| 4 | Log Container | This area currently holds the APEX Log Panel. This area may also house the announcements and/or system alerts component.  | +
-| 5 | Actions Component | This ribbon component contains buttons that drive actions.  | +
-| 6 | SysInfo Component | This ribbon component provides static systems information about the current user and the current APEX session.   | +
-| 7 | Health Component | This is a static component that remains visible whenever the APEX window is visible and it provides information about the Health of the current APEX session. | +
-| 8 | Repositories Component | This component provides a list of both APEX local and remote transaction repositories. Clicking on one of the repository names will cause the Detail Container to update based on the selected repository. | +
-| 9 | Repository Detail Component | This component provides a list of the item contained in the selected Repository. | +
-| 10 | Log Panel Component | This is a scrolling log panel that contains real-time event activity.  | +
-| 11 | Ribbon Selector | This selector is used to switch between different Ribbon views.  | +
-| 12 | Log Filter Selector | This selector is used to filter which log messages/events are displayed in the Log Panel container. | +
-| 13 | Feature Selector | This selector is used to switch between different APEX functional features.  | +
- +
-Additional detail describing each components specific functionality is contained in their respective sections in this document. +
- +
- +
-==== APEX Transport 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 ===+{{page>[:guides:apex_installation_guide&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
  
  
 +===== APEX Getting Started =====
  
-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.+{{page>[:guides:apex_getting_started_guide&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
  
-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 sorting by County/Submitter:+===== APEX Direct-Entry Module =====
  
  
-{{ :guides:images:APEX_Reports-280.png |}}+{{page>[:guides:apex_direct_entry_ui_guide&noheader&noindent&nofooter&nouser&nodate&noeditbtn&nopermalink]}}
  
  
-Agent role sorting by Submitter/County:+===== APEX Transport Module =====
  
  
-{{ :guides:images:APEX_Reports-290.png |}}+{{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.1509661945.txt.gz · Last modified: by brett.zamora