EDP EDD Status Widget
Copyright © 2019 EarthSoft, Inc • Modified: 31 May 2019
Users can view the status of EDDs that have been submitted and processed by Enterprise EDP with the EDP EDD Status widget. The widget can be viewed on the standard EDP dashboard or can be added to a user dashboard. Users with both EDD Viewer and Facility Viewer permissions will see all EDDs processed by Enterprise EDP; otherwise, they will only see EDDs that they have submitted.
The list of EDDs can be sorted or filtered based on status, file name, channel, date, facility, and submitter. The columns are sortable by clicking on the column header (click again to reverse the sort). Use the Status drop-down menu to filter the returned records based on the status of the EDD (All, Successful, Errors, or In Progress). To filter the EDDs by file name, channel, date, facility, or submitter, enter a search term (one or more characters) in the appropriate search box beneath the column header.
Channel denotes how the EDD was submitted:
•EML – One of the email retrieval agents
•FTP – File Transfer Protocol site
•Web – Enterprise EDP
•Pro – Professional EDP (EDDs that have been uploaded directly to the database via Professional EDP will only be displayed if the EQuIS Professional check box has been selected in the Widget Editor).
The bottom of the widget contains paging controls for displaying a limited number of EDDs at a time, as described below.
Arrows – Use the left/right arrows to navigate through pages.
Go to Page List – Select a specific page to navigate directly to that page.
Rows per Page – Change the number of EDDs to be displayed per page by using the drop-down menu.
Count of Pages and Total Items – This control indicates the total number of EDDs available in the widget, how many pages to display the EDDs, and which page is currently selected.
There are four operations used by Enterprise EDP when processing an EDD as defined in the ST_WORKFLOWSTEP table:
1.File Monitor – Adds the file to the database and creates tasks for the next operation.
2.File Validate – Validates that the file follows the correct naming convention. Checks the user certificate to validate the user and verify that they have permissions to the specified facility.
3.File Process – Processes the data in the EDD by checking for errors and committing the data to the database.
4.Event Monitor – Reviews EIAs and conditionally creates tasks for report generator.
The status of the EDD is defined as "Successful", "Errors", or "In Progress". The status column will have a green light if the EDD successfully passed all operations performed by Enterprise EDP. If the EDD did not successfully pass all operations, the status column displays a red light. By clicking the triangle to the left of the traffic light in the status column, details about all Tasks and Notices associated with the job that loaded the EDD will be displayed. The EDD can be downloaded by clicking the hyperlinked EDD file name. Any reports generated by the EDD can be downloaded by clicking the hyperlinked report file name.
To change properties of the EDP EDD Status widget, open the Widget Editor by selecting the More Options icon in the upper right corner of the widget to display the drop-down menu and then select the Edit menu option.
Widget Title – By default, the widget title is EDP EDD Status. The title can be modified.
Widget Color – The color of the widget can be changed using the Change Widget Themeicon to the left of the widget title.
Facility – Use the Facility Chooser to limit the results to those EDDs submitted to a single facility.
Status – The Status drop-down menu can be set to filter the returned records based on the status of the EDD (All, Successful, Errors, or In Progress).
Date – The Date drop-down menu can be set to filter the records based on the date submitted. The options include Today, Last 7 Days, Last Month, Last 3 Months, and All.
EDD Format Definition – Enter the EDD format to restrict EDD status display to only the specified EDD format.
EQuIS Professional Check Box – Select this option to also display EDDs that have been uploaded directly to the database via Professional EDP rather than an Enterprise method. These EDDs will be denoted with "Pro" in the Channel column.
Cancel – Select the Close without Saving button to exit the Widget Editor without saving changes.
Save – Changes will be applied to the widget by clicking on the Save button. The Widget Editor screen will close after the save operation is complete.
An EDD is considered fully processed after it has passed all steps—File Monitor, File Validate, and File Process. The 'Accepted' notice is generated after the File Validate step, but before the File Process step that actually loads the EDD and commits it to the database.
Each of these steps work independently and will sleep for a configured time between tasks to allow other agents CPU time. The default sleep time is 5 minutes. The time it takes an EDD to pass all three steps may vary between the sum of the time it takes all three agents to process (e.g., 15 minutes) plus the sum of the time it takes each individual agent to process. To reduce the time it takes to run each agent, go to the workflow settings and reduce the sleep seconds for optimal performance.
Sleep Seconds sets the minimum number of seconds the service will sleep. For example, if in the File Monitor tab a Sleep Seconds value of 300 used in conjunction with a Max Tasks value of 1, the File Monitor service will process at most 1 (Max Tasks = 1) EDD every 5 minutes (Sleep Seconds = 300). This setting can be modified by administrator users as described in the Workflow widget article.
Note: After an EDD has passed through the File Process step and is marked as "Successfully Completed" in the EDP EDD Status widget, EarthSoft recommends opening the attached Commit log to verify that all records included in the EDD were processed as expected.