• Red bullet denotes Forest-Service Only
 

ECAS Technical Requirements and Architecture

  1. Technical Requirements
  2. Access/Security Requirements
  3. User Interface Specifications
  4. Functional Requirements
  5. Data Requirements
  6. ECAS System Flow
  7. ECAS Status Work Flow
  8. ECAS BCTS Workflow
  9. ECAS Email Processing
  10. Screen Processing Requirements
  11. Change History

1. Technical Requirements

Overview

ECAS will utilize Ministry of Forest's WebADE architecture.

WebADE

The WebADE Java API has two objectives:

  • Provide a Java interface to the WebADE environment and functionality (such as the WebADE Directory, the Ministry security infrastructure, and database connections)
  • Provide a framework for building Web applications using Java servlets and JSPs, which standardizes the architecture for applications and provides all common functionality as reusable code.

It provides the following functionality:

  • Controlling authorization for access to application resources (such as database connections
  • Providing a DEV, TEST, and PROD environment for development isolation
  • Providing a framework for using database connection pooling
  • Utilities for generating standard blocks of HTML code

The following diagram illustrates the WebADE application architecture for the Ministry:

Struts

An established Model-View-Controller framework, the Jakarta Project's Struts provides an open source framework useful in building web applications with Java Servlet and JSP technology. Struts is a proven framework with many successful implementations and a large user base. Sun Microsystems is currently getting involved with the Struts project based on the growing popularity and success it is receiving.

Crystal Reports

Crystal Report will be used for all of ECAS reporting.

CSS

The standard Ministry of Forest's cascading style sheet will be used (MoFStyleSheet.css). There should never be html formatting done that could be in the style sheet. If one is required that is not contained within the style sheet, it will be added. An exception is table/column/row sizing.

Browser Versions

The target browser for ECAS will be Internet Explorer 6 and above as this is the current version used by the Ministry of Forests. There will be limited support for Netscape in so far as that application will not have all the bells and whistles that may be available when running the application under Internet Explorer.

Screen Resolution

The government standard for screen resolution is 800x600 and the Ministry of Forests has adopted this standard for web applications. Therefore, all screens in ECAS will be designed to work at this resolution, although screens will be optimized for a 1024x768 resolution.

Response Times

The Ministry of Forests has stated that 20-30 seconds would be an acceptable response time for a screen or report. A report that generally takes longer than 10 seconds should perhaps be an off-line report. With factors such as network latency, server traffic, etc., acceptable response time should only be used as a rough guideline.

XML Processing/Parsing

In order to satisfy the XML requirements for ECAS, the Digester package in the Jakarta Commons project will be used. In many application environments that deal with XML-formatted data, it is useful to be able to process an XML document in an "event driven" manner, where particular Java objects are created (or methods of existing objects are invoked) when particular patterns of nested XML elements have been recognized. Developers familiar with the SAX approach to processing XML documents will recognize that the Digester provides a higher level, more developer-friendly interface to SAX events, because most of the details of navigating the XML element hierarchy are hidden. For more information see: The Digestor Component at Jakarta Project.

Servlet Engine and Web Listener

JRun 3.1 enterprise and IIS 4 will be used as the servlet engine and web listener in development, test and production environments for ECAS.

Email Processing

ECAS will use the JavaMail API which utilizes SMTP email. It can be found at http://java.sun.com/products/javamail and is an open source library as such is free to download. The activation framework (javax.activation) is also required and can be obtained from the same location.

Emails sent by ECAS will follow a standard structure, that will look something similar to the message below:

-----START OF MESSAGE-----
This is an automated message from the ECommerce Appraisal System. Please do not reply to this message.

ACTION_NAME performed by: USER_WHO_PERFORMED_ACTION
This message was sent to:
To: to_email@domain.com
Cc: cc_email1@domain.com, cc_email2@domain.com

User Comments: Any comments supplied by the user for the action.
-----END OF MESSAGE-----

XML and Attachment Functionality

The ECAS XML and ADS attachments will be stored in the database. The ECAS XML and ADS attachments will be uploaded and stored as temporary files on the application server that ECAS resides on, to a directory that is described in an ECAS properties file. This will be done before saving to the database.

Downloads, except for XML uploads, will be read from the database and written as temporary files to directory described above. XML downloads will be downloaded directly from the database.

The decision to write to disk before storing or retrieving file content to/from the database is based on security concerns around the possibility of uploading viruses in the ECAS attachments directly into the database. When written to disk, an automatic virus scan is performed minimizing the risk of infection.

In addition, writing to disk and then streaming the file contents to either the client or the database (depending on the action being performed) addresses concerns that database connections may be held open for long periods as users upload or download large files.

There will be a configurable maximum on the size of files accepted for upload.

2. Access/Security Requirements

Overview

ECAS has been updated to used the WebADE4 security model where user authorizations are stored in the WebADE database and are configured using the ADAM application.

ECAS requires that a user be authorized for the same ecas roles for all Organizations (Regions, Districts, TSAs, Client Numbers). Assigning different roles by Organization may have unpredictable results in ECAS.

Org Units

If a user is authorized in ADAM to access ECAS with more than one ministry Org Unit they will not be prompted at logon to choose an org unit for their current ECAS session. The User Org Maintenance screen on the Admin menu is used to set the users Org Unit. The org unit set on this screen will persist for future ECAS sessions until set to a different value.

Forest Clients

If a user is authorized in ADAM to access ECAS with more than one Forest Client, then the Client Organization Selector will be displayed at logon to choose the client they wish to act as for their current ECAS session. The Client Organization Selector will not be displayed if the user has one Forest Client authorization. BCTS users that have Forest Client and Timber Sales Area org unit authorizations, will only be prompted to select their Timber Sales Area client number if they are authorized for more than one Timber sales Area.

Client Locations

The WebADE4 security model does not authorize a user for a client location. Client authorizations are for a Forest Client organization.

ECAS logic is dependent on the WebADE3 security model which did authorize a user for client number and location. Due to the difference in these security models, ECAS must now capture and store a Default Client Location for each user since certain ECAS processing is dependent on the client location code. A Default Client Location Selector has been created to set the users client location at logon if no default is available.

User/Function Security Matrix

A security matrix will be provided once the application's function has been established. The following is an example of such a security matrix:

Category Application Action Role1 Role2 Role3
Inbox Search ECAS30 - Inbox Search /ecas30InboxSearch x x x
  - Go button /ecas30InboxSearch/Go x x  
  - Back button /ecas30InboxSearch/Back   x  
  - Refresh button /ecas30InboxSearch/Refresh x x x

Note: The security matrix will be finalized as Coast and Interior Requirements are completed.

3. User Interface Specifications

Navigation

Menus

ECAS will use menu to navigate through the system. These menus will be located on the Header of each page. The headers of the Audit Search and INbox will have the generic header. (i.e. will not have Coast or Interior in banner). These menus will be available at all times in the application. When using the menu to go to another screen on a data entry screen, it will check whether the data needs to be saved, and prompt the user to do so.

Buttons

ECAS will use html buttons for page functions such as saving or submitting a screen. Navigation buttons will use graphical buttons such as the search image.

MoF Headers/Footers

The standard MoF Headers and Footer will also be included. The header contains links for Application Home, Log Off and Home. The footer contains links for Feedback, Disclaimer, Privacy and Copyright. The 'Application Home' link takes the user to ECAS Welcome page. The 'Log off' link takes the user back to the home page or other MOF applications link to for 'Log off'. The 'Help' link will help user with the page they are in documented in HTML for MOF customizing. The 'Home' link goes to the MOF Revenue Branch homepage. The 'Feedback' link creates a new e-mail message to the Data Custodian. The 'Disclaimer' link is to be the same as the one from the MOF website. The 'Privacy' link is to be the same as the one from MOF website. The 'Copyright' link is to be the same as the one from MOF website.

Data Entry

ECAS will use standard HTML forms for all data entry.

Date Fields

Any date fields will use a Java Applet to help entry. This Applet will make it easier for users to select a date, by providing a visual calendar to pick from. The Applet will also help enforce the correct date format to limit the chance of validation error occurring.

Field Formats

ECAS will use the following field validation formats.

Phone & Fax:

Must be numeric, valid formats are (NNN)NNN-NNNN or NNNNNNNNNN or NNN-NNN-NNNN or NNN NNN-NNNN or NNN NNN NNNN.

4. Functional Requirements

Functional Model

5. Data Requirements

Logical Data Model

Entity Definitions

Entity Definition Report.

6. ECAS System Flow

7. ECAS Status Work Flow

ECAS Status Codes

RGN Sent to Region

Business flow

  • ECAS appraisals get set to RGN status when a District Appraisal Officer presses the Send to Region button on the Interior and Coastal Control Screens.
  • Copying an Appraisal for the purposes of 'Retermination' will set the intial appraisal status to RGN with an appraisal type of 'Retermination'. This appraisal cannot be returned to the District or Licensee.
  • The status may only get changed to RGN when an Appraisal had a previous status of either: RCD - Received, RTN - Return to District
  • Once in RGN status the Regional Appraisal Officer may perform one of the following actions:
    • Verify
    • Return to District (RTN)
    • Request Licensee/BCTS Clarification(CLR)

Access/Audit

  • District, Licensee, BCTS have View Access
  • Regional Officer may make changes
  • All changes are tracked in the Audit History

Verify

Business flow

  • ECAS appraisals get set to VER status when a Regional Appraisal Officer presses the Verify button on the Interior and Coastal Control Screens.
  • The status may only get changed to VER when an Appraisal had a previous status of either: RGN - Sent to Region, SWI - Sent to Region with Issue
  • When in VER status the data is transferred to the GAS system, no updates to ECAS are supported, with one exception:
    • The ECAS administrator may change to status manually on the reference screen. This should only be done when issues arise as the GAS system will require a deletion of the current ECAS ID based on Mark/Effective Date.

Access/Audit

  • Region, District, Licensee, BCTS have View Access
  • Administrator may change the status
  • All changes are tracked in the Audit History

BUP BCTS Resubmission/Update

Business flow

  • ECAS appraisals get set to BUP status when a BCTS RPF presses the "BCTS Update" button on the Interior and Coastal acknowledgement Screens.
  • The status can only be changed to BUP from VER - Verified, for a BCTS appraisal.
  • Once in BUP status the BCTS user may update information on the BC Timber Sales, attachments and the acknowledgement screens. Once the updates have been made for the BCTS 2nd pass the following actions are available:
    • Submit the appraisal, status changes to SLD - Sold

Access/Audit

  • District View Access
  • Licensee do not have access to BCTS appraisals
  • BCTS & Regional users may make changes
  • All changes are tracked in the Audit History

CLR Clarify

Business flow

  • ECAS appraisals get set to CLR status when a Regional Appraisal Officer presses the clarify button on the Interior and Coastal Control Screens.
  • The status may only get changed to CLR when an Appraisal had a previous status of either: RGN - Sent to Region, SWI - Sent to region with Issue
  • Once in CLR status the Licensee/BCTS may perform updates to the appraisal. Once the changes have been made the following actions are available:
    • Submit the appraisal, status changes to SWI - Sent to Region with Issue

Access/Audit

  • District and Region have View Access
  • Licensee/BCTS may make changes
  • All changes are tracked in the Audit History

CON Confirmed

Business flow

  • ECAS appraisals get set to CON status when the appraisal is confirmed in GAS.
  • The status may only get changed to CON when an Appraisal had a previous status of either: VER - Verified
  • Once in CON status no changes to the appraisal are allowed in ECAS.

Access/Audit

  • All users have View access (to their own data)
  • All changes are tracked in the Audit History - none allowed

VER Verified

Business flow

  • ECAS appraisals get set to VER status when the appraisal is verified in ECAS.
  • The status may only get changed to VER when an Appraisal had a previous status RGN - Sent to Region
  • Once in VER status no changes to the appraisal are allowed from ECAS.

Access/Audit

  • All users have View access (to their own data)
  • All changes are tracked in the Audit History - none allowed

UNC Unconfirmed

Business flow

  • ECAS appraisals get set to UNC status when the appraisal is unconfirmed in GAS.
  • The status may only get changed to UNC when an Appraisal had a previous status CON - Confirmed
  • UNC is similar to RGN status - ECAS updates can be made and then VERIFIED or Returned to District for more information.

Access/Audit

  • Region has Access
  • All users have View access (to their own data)
  • All changes are tracked in the Audit History

DCL District Requested Clarification

Business flow

  • ECAS appraisals get set to DCL status when a District Appraisal Officer presses the clarify button on the Interior and Coastal Control Screens.
  • The status may only get changed to DCL when an Appraisal had a previous status of either: RCD - Received
  • Once in DCL status the Licensee/BCTS may perform updates to the appraisal. Once the changes have been made the following actions are available:
    • Submit the appraisal, status changes to SUB - Submitted

Access/Audit

  • District has View Access
  • Licensee/BCTS may make changes
  • Region has no access
  • All changes are tracked in the Audit History

DTR Determined

Business flow

  • Appraisals get set to DTR status within the GAS appliction
  • Administrator may create/update an appraisal on behalves of a Licensee/BCTS (Administrator cannot submit).
  • See GAS2 for more information on this status and the related processes

Access/Audit

  • NO Access within ECAS other than viewing
  • Changes are tracked in the Audit History

DFT Draft

Business flow

  • ECAS appraisals get set to DFT status when a Licensee/BCTS create a new appraisal by either: XML Upload, Add New, or Copy.
  • Administrator may create/update an appraisal on behalves of a Licensee/BCTS (Administrator cannot submit).
  • In DFT status the Licensee/BCTS may perform updates to the appraisal. Once the changes have been made the following actions are available:
    • Submit the appraisal, status changes to SUB - Submitted

Access/Audit

  • District and Region have NO Access
  • Licensee/BCTS may make changes
  • Changes are NOT tracked in the Audit History

SWI Sent to Region with Issue

Business flow

  • ECAS appraisals get set to SWI in one of 2 ways:
    • When a District Appraisal Officer presses the Send to Region with Issue button on the Interior and Coastal Control Screens.
    • When a Licensee/BCTS users presses the Submit button on an appraisal in CLR - Clarify status
  • Once in SWI status the Regional Officer may perform following actions:
    • Verify, status changes to VER - Verified
    • Request Clarification from Licensee/BCTS, status changes to CLR - Clarify
    • Return to District, status changes to RTN - Return to District

Access/Audit

  • Region controls processing
  • District/Licensee/BCTS have view access
  • All changes are tracked in the Audit History

RCD Received

Business flow

  • ECAS appraisals get set to RCD status when a District Appraisal Officer marks an appraisal and presses the "Mark as Received" button on the Inbox Screen.
  • The status may only get changed to RCD when an Appraisal had a previous status of either: SUB - Submitted
  • Once in RCD status the District Appraisal Officer may perform one of the following actions:
    • Send the appraisal to Region (RGN)
    • Request Licensee Clarification (DCL)
    • Send to Region with Issue(SWI)

Access/Audit

  • Region, Licensee, BCTS have View Access
  • District Officer controls the processing
  • All changes are tracked in the Audit History

RPL Replaced

Business flow

  • Not supported at this time.

RTN Returned to district

Business flow

  • ECAS appraisals get set to RTN status when a Regional Appraisal Officer presses the "Return to District" button on the Interior and Coastal Control Screens.
  • The status may only get changed to RTN when an Appraisal had a previous status of either: RGN - Sent to Region or SWI - Sent to Region with Issue
  • Once in RTN status District may review the appraisal and perform on of the following:
    • Send the appraisal to Region (no issue) (RGN)
    • Send the appraisal to Region (with issue) (SWI)
    • Request licensee clarification (DCL)

Access/Audit

  • District controls processing
  • Region/Licensee/BCTS have View Access
  • All changes are tracked in the Audit History

SCN Scenario

Business flow

  • ECAS appraisals can be created for the purpose of calculating rates with variable information. This accomplished via the "COPY" function on the Inbox Screen.
  • An appraisal in SCN status cannot be submitted as an ECAS appraisal
  • Access to this function is restricted

Access/Audit

  • District/Region access only /
  • Changes are tracked in the Audit History

SLD Sold

Business flow

  • ECAS appraisals get set to SLD status when a BCTS RPF user presses the submit button on the Interior and Coastal acknowledgement Screen.
  • The status may only get changed to SLD when an Appraisal had a previous status of BUP - BCTS Resubmission/Update
  • Once in SLD status the data is transferred to the GAS system, updates to ECAS are not supported.

Access/Audit

  • Region, District, BCTS have View Access
  • Administrator may change the status
  • All changes are tracked in the Audit History

SUB Submitted

Business flow

  • ECAS appraisals get set to SUB status when a Licensee/BCTS RPF presses the Submit button on the Interior and Coastal acknowledgement Screens.
  • The status may only get changed to SUB when an Appraisal had a previous status of: DFT - Draft
  • Once in SUB status the District Appraisal Officer may perform one of the following actions:
    • Mark as Received (RCD)
  • Once in SUB status the RPF may perform one of the following actions:
    • Recall if not yet recieved - sets back to DFT

Access/Audit

  • Region, Licensee, BCTS have View Access
  • District Officer controls the processing
  • All changes are tracked in the Audit History

EE Entered in Error

Business flow

  • ECAS appraisals can get set to EE status by Administrator only. This will be done when a submission that did not complete it's workflow is no longer required.
  • The status should only be changed to EE if it has been submitted to the ministry. If the appraisal is in DFT status it can be deleted
  • Once in EE status no appraisal data can be updated or deleted.

Access/Audit

  • Region, District, Licensee, BCTS have View Access
  • Administrator can reactivate the submission

8. ECAS BCTS Workflow

Overview

9. ECAS Email Processing

ECAS Email Processing.

10. Screen Processing Requirements

Overview

ECAS will have common screen processing for some rules throughout the application. Common processing rules that must be applied to all screens that use these fields. These fields are those such as Org Unit. This section will explain the details on what rules will be applied to these fields.

Org Unit

Format

Data Entry: XXX, Dropdown or Muli-List.

XML: XXX, case to Upper.

Default Behavior

ECAS must identify if the user logged on is a BCTS/Licensee, District, Regional or Headquarters. This will be accomplished by inspecting the WebADE Org security group.

Note: It is assumed that entries into the client security group and District security group are mutually exclusive. If entries are located in both, a system error will be raised.

District: Org unit defaults to the users rollup district code. Org cannot be changed, Org dropdown codes will be limited to the single entry. ECAS will only query ADS data associated to the rollup district code. Users are assumed to District if code prefixed with a "D".

Region: Org unit defaults to the users rollup Region code. Org may be changed to any rollup district associated with the Region, Org dropdown codes will be limited to the regional code and associated districts. Users are assumed to Region if code prefixed with a "R".

Headquarters: Org unit defaults to the users 3 letter Headquarters code (accomplished by truncating the users HQ code to 3 letters and looking up the value from ORG_UNIT. Org may be changed to any rollup Region or district, Org dropdown codes will be limited to all regional and district rollup codes. Users are assumed to District if code prefixed with a "H".

BCTS/Licensee: Org unit defaults to <blank>. Org may be changed to any rollup Region or district, Org dropdown codes will be limited to all regional and district rollup codes. Users are assumed to be BCTS/Licensee if no entries are found in the WebADE Org security group.

Validation

Data Entry: Org unit will be validated by the use of dropdowns populated by the default process. Once an ADS is approved by the district, the ADS Org unit must match the District Org Unit set in FTA for the Timber Mark.

XML: Must be a valid org unit code in ORG_UNIT.ROLLUP_DIST_CODE.

Client

Format

Data Entry:

Client: XXXXXXXX (must be numeric, left padded with zero's)
Location Code: XX (must be numeric, left padded with zero's)

XML:

Client: XXXXXXXX (must be numeric, left padded with zero's)
Location Code: XX (must be numeric, left padded with zero's)

Default Behavior

ECAS must identify which Client the logged on user belongs to. This will be accomplished by inspecting the WebADE Client Locn security group.

Note: It is assumed that entries into the client security group and District security group are mutually exclusive. If entries are located in both, a system error will be raised.

Client: Client is protected and defaults to the users client if the user is a BCTS/Licensee. A BCTS/Licensee may only query ADS data associated with their own client. Users are assumed to be a BCTS/Licensee if no entries are fou nd in the WebADE Org security group for the logged on user.

Client is not restricted at all for Ministry users. A Ministry user is one with an entry found in the WebADE Org security group.

Location Code: Location Code is not protected. A BCTS/Licensee may be restricted to their own client, but may view the data for all of their locations. Location Code is not protected for Ministry users.

Validation

Data Entry:

Client: Must be a valid client number in V_CLIENT_PUBLIC.CLIENT_NUMBER.
Client Location: Must be a valid Client and ClientLocation between V_CLIENT_PUBLIC.CLIENT_NUMBER and CLIENT_LOCATION.LOCATION_CODE

XML:

Client: Must be a valid client number in V_CLIENT_PUBLIC.CLIENT_NUMBER.
Client Location:Must be a valid Client and Client Location between V_CLIENT_PUBLIC.CLIENT_NUMBER and CLIENT_LOCATION.LOCATION_CODE

Tenure Processing

Licence: Must exist in PROV_FOREST_USE.
Cutting Permit: Cannot be entered without valid Licence. Cutting Permit / License combination must exist in TIMBER_MARK.

Screen Button Security

  • Go Buttons:
  • Add New Buttons: Navigates to the Reference Info and creates a new Appraisal. The logged on user's org unit will determine whether it will be a Coast or Interior Appraisal.
  • BCTS Update Buttons: This will only be enabled when the status is approve. Triggers display and update of 2 fields on BCTS screen (ECAS42).
  • Recall Buttons: This will only be enabled for RPF users This will only be enabled when the status is submitted.
  • Calculate Button: Initiates the Header Save Processing to do derived field calculations.
  • Browse Buttons: Allows user to browse local file system (generated from the input type="file" tag)
  • Attach Buttons: (Zip) Saves the specified file to the database.
  • Attach Buttons: (Individual) Saves the specified file to the database. Sets the associated radio button to Electronic (Attached).
  • Delete (Zip and Individual attach files) Deletes the selected file from the database, after user has confirmed the delete. Files are not physically deleted unless submission has Draft status, and may be viewed in history log.
  • Navigation to the Management Unit Search will occur when the search icon is pressed. Once a code has been selected from the search page, both the Management Unit Type and Management Unit ID will be brought back from the search.
  • Search Buttons: Executes the query and displays records in the lower region of the screen.
  • Clear Buttons: Clears all search criteria
  • Copy Buttons: Creates a new appraisal using the selected submission's data, after the user has confirmed by clicking OK in the confirm dialog box. The dialog box will require the user to enter a Effective Date for the new appraisal. After entering a valid Effective date it will also navigate to first screen of the submission details.
  • Details Buttons: Navigate to the details for that record
  • Validate Button: Validates the XML file. Note: the validation is a 2-part process. The first validation compares the uploaded file against the appropriate DTD The second part follows the same validations as the screens in draft mode.
  • Save as Draft Button: Submits the XML file to the server, forwards to acknowledgements screen. Not enabled for District.
  • Export Button: Executes the XML Export
  • Print Button: Prints the screen.
  • Close Button: Closes the browser window to return to the application
  • Delete Button: (Edit row) Deletes the current row.
  • Update Button: (Edit row) Selects current row for updating.
  • Save Button: (Edit row) Initiates Save/Update processing. Not enabled for District.
  • Maintain Appraised Roads Button: Navigate to the Appraised Roads screen.
  • Submit Button: The submit button (Reference Screen) is active only when the ADS has a status of "Draft" and is applicable to BCTS/Licensee's, Administrator and Headquarters. After it is submitted, the record is locked until the status is changed to "Received" or has been "Recalled" which sets the status back to draft.
  • Mark Files as Received Button: Changes the status of the selected records (ones that have been selected using the appropriate checkbox) to received. Note: Only displays for District Users, Administrator and Headquarters.
  • District Clarify Button: This is on the control screen and is only applicable when the ADS has a status of "Received". This function will set the ADS to a status of "Draft" so that BCTS/Licensee's, Administrator and Headquarters can update as necessary.
  • Sent to Region Button: This on the control screen and is only applicable when the ADS has a status of "Received" or "Returned". This function will send the ADS to the region inbox.
  • Region Clarify Button: This is on the control screen and is only applicable when the ADS has a status of "Sent to Region" or "Sent to Region with Issue". This can be seen by the Region, Administrator and Headquarters. It opens up the ADS so that BCTS/Licensee's, Administrator, Headquarters and Region can make updates.
  • Verify Button: This is on the control screen and is only applicable when the ADS has a status of "Sent to Region" or "Sent to Region with Issue". This function causes the ADS to be Verified.
  • Send to Region with Issue Button: By passes status of "Sent to Region" and places submission into Region's inbox (generate email to Region). Signifies that there is an issue with the submission that the District cannot resolve.
  • Return to District Button: Set ECAS status to "received". Place submission in district's inbox (generate email to district).
  • District Recall Button: Set ECAS status to "received". Only enabled when submission is in 'DCL' (District Requested Licensee Clarification) status and user is ADMINISTRATOR, HEADQUARTERS, or DISTRICT.
  • Region Recall Button: Set ECAS status to "sent with issue". Only enabled when submission is in 'CLR' (Clarify) status and user is ADMINISTRATOR, HEADQUARTERS, or REGION.
  • Save Buttons: Please refer to the specific screen documentation for details of then the Save button is active. Business rules vary between screens but general rules are:
    • Status of Draft: Enabled for the BCTS/Licensee, Administrator and Headquarters. Not enabled for District or Region.
    • Status of Submitted: Disabled.
    • Status of Received: Enabled for Region, Administrator and Headquarters. Not enabled for District except for dates on Reference screen and certain Attachments.
    • Status of Sent to Region: Enabled for Region or Administrator.
    • Status of Region Clarify: Enabled for BCTS/Licensee, Administrator and Headquarters. Not enabled for District or Region.
    • Status of Verified: Disable.
  • Comments Button: Navigate to the Comments screen. Active when:
    • Appraisal Status is DFT (draft), CLR (region clarify) or DCL (district clarify) AND the users role is ECAS_LICENSEE,ECAS_RPF,ECAS_BCTS,ECAS_BCTS_SUBMIT,ECAS_HEADQUARTERS or ECAS_ADMINISTRATOR
    • Appraisal Status is BUP (bcts update), AND the users role is ECAS_BCTS_SUBMIT or ECAS_ADMINISTRATOR
    • Appraisal Status is RCD (received) or RTN (returned by region) AND the users role is ECAS_DISTRICT,ECAS_HEADQUARTERS or ECAS_ADMINISTRATOR
    • Appraisal Status is RGN (sent to region), SWI (sent with issue), ACC (accept), FWD (forwarded) AND the users role is ECAS_REGION,ECAS_HEADQUARTERS or ECAS_ADMINISTRATOR
  • Comments Save Button: Follows same security as the regular appraisal save button.
  • Comments Edit/Print/Back Buttons: Always enabled.

Change History

14:00 November 15, 2002 — Kimberly Moulton
Screen Button Security The following buttons added with their technical definitions.
Go buttons  
Add New buttons Navigates to the Reference Info and creates a new Appraisal. The logged on user's org unit will determine whether it will be a Coast or Interior Appraisal.
BCTS Update buttons This will only be enabled when the status is approve. Triggers display and update of 2 fields on BCTS screen (ECAS42)
Recall buttons This will only be enabled for RPF users This will only be enabled when the status is submitted.
Calculate buttons Initiates the Header Save Processing to do derived field calculations.
Browse buttons Allows user to browse local file system (generated from the input type="file" tag)
Attach buttons (Zip) Saves the specified file to the web server
Attach Buttons: (Individual) Saves the specified file to the web server. Sets the associated radio button to Electronic (Attached).
Delete (Zip and Individual attach files) Deletes the selected file from the web server, after user has confirmed the delete.
Search buttons Executes the query and displays records in the lower region of the screen.
Navigation to the Management Unit Search will occur when the search icon is pressed. Once a code has been selected from the search page, both the Management Unit Type and Management Unit ID will be brought back from the search.
Clear buttons Clears all search criteria
History buttons Navigates to the audit history detail for the corresponding record
Copy buttons Creates a new appraisal using the selected submission's data, after the user has confirmed by clicking OK in the confirm dialog box. The dialog box will require the user to enter a Effective Date for the new appraisal. After entering a valid Effective date it will also navigate to first screen of the submission details.
Details buttons Navigate to the details for that record
Validate buttons Validates the XML file. Note: the validation is a 2-part process. The first validation compares the uploaded file against the appropriate DTD The second part follows the same validations as the screens in draft mode.
Save as Draft button Submits the XML file to the server, forwards to acknowledgements screen
Export button Executes the XML Export
Forward to Region buttons By passes status of "Accepted" and places submission into Region's inbox.(Generate email to Region).
Return to District buttons Set ECAS status to "received" place submission in district's inbox (generate email to district) Note: In order to "return to district" the file status must be received.
Print buttons Prints the screen.
Close buttons Closes the browser window to return to the application.
Delete buttons (Edit row) Deletes the current row.
Update buttons (Edit row) Selects current row for updating
Save buttons (Edit row) Initiates Save/Update processing
Mark Files as Received Changed button label from Received
Mark Files as Received Changed definition from: This is on the inbox for district staff only. It is only applicable to the ADS with a status of "Submitted". Once a record has been received it can only be updated by the district and region. To: Changes the status of the selected records (ones that have been selected using the appropriate checkbox) to received. Note: Only displays for District Users.
   
13:30 November 18, 2002 — Kimberly Moulton
Screen Button Security Added the following button(s).
Maintain Appraised Roads button Navigate to the Appraised Roads screen.
   
10:00 Nov 27, 2002 — Steve Taylor (as per Sabina's note of Nov 26, 4:43PM)
ECAS Email Process Changed "Region Approves ADS: No Email" to "Region Approves ADS: Email gets sent to BCTS/Licensee and Rep"
   
11:30 December 11, 2002 — Kimberly Moulton
Screen Button Security Added Administrator and Headquarters access to the following buttons:
 
  • Submit Button
  • Mark Files as Received Button
  • District Clarify Button
  • Region Clarify Button
  • Save Buttons
   
14:30 December 12, 2002 — Kimberly Moulton
Screen Button Security Change to match Security Matrix
  Added validation rule to all 'Save' functions/buttons: - Not enabled for District -.
   
13:13 January 27, 2003 — Jordan Miller
Workflow Dates in System Added Section. Lists all the Date fields in the system and their workflow.
   
8:42 Sept 4, 2003 — Johnathan Storey
CR 17 Modification: Removed the workflow date processing into Interior/Coast acknowledgement and Control specs.
   
19:00 Nov 23, 2003 — Johnathan Storey
ECAS Status Workflow Updated diagram and added status code details under section "Ecas Status Workflow".
   
Feb 10, 2005 — Bruce Macpherson
ECAS Status Workflow Updated Ecas Status information for Accept, Approve and Forward statuses. These have been chnaged to Send to Region, Verified and Send to Region with Issue, respectively.
   
March 4, 2005 — JMiller
Button Security Updated the button security to include the comments screen buttons.
   
March 7, 2005 — BMacpherson
ECAS Status Codes Added information about the Entered in Error status.
   
March 18, 2005 — BMacpherson
Comments Button Added more information about the Comments button security.
   
August 9, 2006 — BMacpherson
Access/Security Added WebADE4 related information for Org Unit, Forest Client and Client Location security.
   
October 25, 2006 — TBlanchard
Attach Buttons: (Individual) Changed text indicating files are saved to the Web server to read "Saves the specified file to the database"
Attach Buttons: (Zipl) Changed text indicating files are saved to the Web server to read "Saves the specified file to the database"
Delete (Zip and Individual attach files) Changed text to read "Deletes the selected file from the database, after user has confirmed the delete. Files are not physically deleted unless submission has Draft status, and may be viewed in history log"
   
November 1, 2006 — TBlanchard
XML and Attachment Functionality Updated to indicate uploaded and downloaded files are first written to disk before being saved to database or downloaded.
   
September 6, 2011
Email Processing Updated to indicate change to WebADE secuirty architecture.
   
April 2012 - Russell Chan
GAS2 Updates Updated to reflect changes in regards to GAS2. Added new status codes (SCN, VER, UNC, DTR, RGN).