section 185 fee program€¦ · web viewsection 185 fee program. webpage specifications. version...

Section 185 Fee Program

Webpage Specifications

Version #: [version]

Updated: [Pick the date]

Jet Software Solutions, Inc.


Table of ContentsAdd Account............................................................................................................................................................................................... 4

Webpage Procedure Name................................................................................................................................................................................... 4

Overview................................................................................................................................................................................................................ 4

User Interface........................................................................................................................................................................................................ 5

Business Rules...................................................................................................................................................................................................... 5

Fields and Controls Properties.............................................................................................................................................................................. 8

Navigation Bar.......................................................................................................................................................................................... 20

User Interface...................................................................................................................................................................................................... 20

Business Rules.................................................................................................................................................................................................... 21

Fields and Controls Properties............................................................................................................................................................................ 21


Add Account

Webpage Procedure NameFTA0500 Section 185 Program Add Account

OverviewThe purpose of this webpage is to allow the users to create a new Section 185 Account. This webpage will be flowed to by clicking

Add Account link on the Navigation Bar.


User Interface

Business RulesBusiness Rule 1

Regulated Entities list requirements

1. The list will not have paging.


2. The list will be a scrollable region (as opposed to extending the length of the page based on the number of Regulated Entities in the list) and the height of the list will display 10 records.

3. The list will display a list of all EI_PT_SOURCE_ACCTs that the user has selected from the Regulated Entity Search modal pop-up.

4. The default sort order for the list is RN # (ascending).

5. The list can be dynamically sorted (ascending/descending) by clicking on any of the following column headers:

5.1. RN #

5.2. Air Acct #

5.3. Site Name

5.4. Last EI Date

6. The user will be able to flow back and forth between this web page and the Regulated Entity Search web page in order to select EI_PT_SOURCE_ACCTs Entities for different search criteria that will be associated with the EI_SECT_185_ACCOUNT being created and this page will maintain the list of selected EI_PT_SOURCE_ACCTs without any intervening actions required on the part of the user.

Business Rule 2

At least one EI_PT_SOURCE_ACCT is required. If the Regulated Entities list is empty and the user clicks on the Save push button, an error message (“A Regulated Entity is required. Please make sure you select at least one Regulated Entity.”) will be displayed.

Business Rule 3

Attachments list requirements

1. The list will not have paging.

2. The list will display a list of all Files that the user has selected from the Choose File to Upload window.

3. The user will be able to flow back and forth between this web page and the Choose File to Upload window in order to select files from different subdirectories that will be associated with the EI_SECT_185_ACCOUNT being created and this page will maintain the list of selected Attachments without any intervening actions required on the part of the user.

Business Rule 4

Save push button requirements

1. If the AR EF is blank perform the following

1.1. Retrieve FE_FEE_GROUP where its GRP_CD = ‘FTA’

1.2. Create a new BT_ARS

1.2.1. Set its AR_NUM to the current FE_FEE_GROUP.LAST_AR_NUM plus 1

1.2.2. Set its AR_SUFFIX_TXT to ‘ ‘ (spaces)

1.2.3. Set its CUST_EXTRACT_FLG = ‘N’

1.2.4. Set its ADDR_ID to 0

1.2.5. Set its ADDR_CHG_DT to 01/01/0001 (null)

1.2.6. Set its DISPUTE_CD to ‘ ‘ (spaces)

1.2.7. Set its DISPUTE_DT to 01/01/0001 (null)

1.2.8. Associate it with the specified EI_ORG (set its CUST_ID = EI_ORG.ORG_ID)

1.2.9. Associate it with a FE_FEE where that FE_FEE’s FEE_CD = ‘FTA’ and that FE_FEE is associated with an FE_FEE_GROUP and that FE_FEE_GROUP’s GRP_CD = ‘FTA’.

1.3. Update FE_FEE_GROUP where its GRP_CD = ‘FTA’

1.3.1. Set its LAST_AR_NUM to its LAST_AR_NUM plus 1


2. Create a new EI_SECT_185_ACCOUNT

2.1. Set its AREA_TYPE_CD to the GEN_CD_TXT associated with the NAME_TXT value selected in the Area drop down.

2.2. Set its TYPE_CD to the GEN_CD_TXT associated with the NAME_TXT value selected in the Type drop down.

2.3. Set its BASIS_CD to the GEN_CD_TXT associated with the NAME_TXT value selected in the Basis drop down.

2.4. Set its BASELINE_PERIOD_START_DT to the Period Start Date EF

2.5. Set its BASELINE_PERIOD_END_DT to the Period End Date EF

2.6. Set its ASSESSED_IND to ‘NO’

2.7. Set its ACCOUNT_SEQ_NUM using the Oracle Sequence EI_S185_ACCOUNT_NUM_S

3. Create a new EI_SECT_185_ACCOUNT_ORG

3.1. Set its EFFECTIVE_DT to 1/1/1800

3.2. Set its DEACTIVATION_DT to 12/31/3000

3.3. Associate it with the specified EI_ORG

3.4. Associate it with the new EI_SECT_185_ACCOUNT

4. Create a new BT_AR_INTFS

4.1. Set its ENT_NAME to ‘EI_SECT_185_ACCOUNT’

4.2. Set its AR_INTF_START_DT to 1/1/1800

4.3. Set its AR_INTF_END_DT to 01/01/0001 (null)

4.4. Set its REBILL_FLG to ‘N’

4.5. Set its INCLUDE_NEXT_BILLING_FLG to ‘N’

4.6. Associate it with the new EI_SECT_185_ACCOUNT (Set its ENT_ID to EI_SECT_185_ACCOUNT.SECT_185_ACCOUNT_ID).

4.7. Associate it with the specified BT_ARS or the new BT_ARS (if one was created above).

5. For each EI_PT_SOURCE_ACCT in the Regulated Entities list

5.1. If the specified EI_PT_SOURCE_ACCT is already associated (via EI_SECT_185_ACCT_PT_SRC_ACCT where that EI_SECT_185_ACCT_PT_SRC_ACCT’s EFFECTIVE_DT <= Current Date and that EI_SECT_185_ACCT_PT_SRC_ACCT’s DEACTIVATION_DT >= Current Date) with a different EI_SECT_185_ACCOUNT and (either the new EI_SECT_185_ACCOUNT has a TYPE_CD = ‘VOC NOX’ or its existing EI_SECT_185_ACCOUNT has a TYPE_CD = ‘VOC NOX’ or one of its existing EI_SECT_185_ACCOUNT(s) has the same TYPE_CD as the new EI_SECT_185_ACCOUNT), an error message (“One of the selected Regulated Entities is currently associated with another Section 185 Account and either its Type is the same as the new Account’s Type, or it has a Type of VOC/NOx or the new Account has a Type of VOC/NOx.”) will be displayed

5.2. If the specified EI_PT_SOURCE_ACCT is associated with an EI_SITE (via EI_ACCT_ORG_SITE where that EI_ACCT_ORG_SITE’s EFF_DT <= Current Date and that EI_ACCT_ORG_SITE’s DEACT_DT >= Current Date) and that EI_SITE is associated with an EI_AREA_CNTY (EI_SITE.CNTY_FIPS_CD = EI_AREA_CNTY.CNTY_FIPS_CD and where that EI_AREA_CNTY’s EFF_DT <= Current Date and that EI_AREA_CNTY’s DEACT_DT >= Current Date) and that EI_AREA_CNTY’s AREA_TYP_CD is not equal to the new EI_SECT_185_ACCOUNT’s AREA_TYPE_CD, an error message (“One of the selected Regulated Entities is not currently associated with specified Area.”) will be displayed

5.3. If the specified EI_PT_SOURCE_ACCT has never been associated with an EI_SECT_185_ACCOUNT (i.e. there are no EI_SECT_185_ACCT_PT_SRC_ACCT records associated with it that are associated with a EI_SECT_185_ACCOUNT with a TYPE_CD = ‘VOC NOX’ or a TYPE_CD = the new EI_SECT_185_ACCOUNT’s TYPE_CD)

5.3.1. Create a new a EI_SECT_185_ACCT_PT_SRC_ACCT

5.3.1.1. Set its EFFECTIVE_DT to 1/1/1800

5.3.1.2. Set its DEACTIVATION_DT to 12/31/3000

5.3.1.3. Associate it with the specified EI_PT_SOURCE_ACCT

5.3.1.4. Associate it with the new EI_SECT_185_ACCOUNT

5.4. Else


5.4.1. If the new EI_SECT_185_ACCOUNT.TYPE_CD = ‘VOC NOX’

5.4.1.1. Retrieve the EI_SECT_185_ACCT_PT_SRC_ACCT’s associated with the specified EI_PT_SOURCE_ACCT sorted by DEACTIVATION_DT (descending) and use the first one returned

5.4.2. Else

5.4.2.1. Retrieve the EI_SECT_185_ACCT_PT_SRC_ACCTs associated with the specified EI_PT_SOURCE_ACCT where it is associated with a EI_SECT_185_ACCOUNT with a TYPE_CD = ‘VOC NOX’ or a TYPE_CD = the new EI_SECT_185_ACCOUNT’s TYPE_CD sorted by DEACTIVATION_DT (descending) and using the first one returned

5.4.3. Create a new a EI_SECT_185_ACCT_PT_SRC_ACCT

5.4.3.1. Set its EFFECTIVE_DT to the DEACTIVATION_DT from Business Rule 4 section 5.4.1.1 or section 5.4.2.1 plus 1 day

5.4.3.2. Set its DEACTIVATION_DT to 12/31/3000

5.4.3.3. Associate it with the specified EI_PT_SOURCE_ACCT

5.4.3.4. Associate it with the new EI_SECT_185_ACCOUNT

6. If the Comment EF is not equal to spaces, using the Comment web service perform the following:

6.1. Set CT_COMNT_SET.TYP_CD = ‘COMMENT’

6.2. Associate the CT_COMNT_SET to the new EI_SECT_185_ACCOUNT (set its PARENT_ID = EI_SECT_185_ACCOUNT. SECT_185_ACCOUNT_ID)

6.3. Set CT_COMNT_HEADER.CREATE_APP_TXT = ‘FTA’

6.4. Splice the text in the Comment EF into 3500 character blocks and for each block

6.4.1. Create a new CT_COMNT

7. If the Attachments list is not empty, using the Document web service perform the following:

7.1. Set DM_DOC_SET.TABLE_NAME = ‘CT_COMNT_HEADER’

7.2. Associate the DM_DOC_SET with the new CT_COMNT_HEADER (set its DENORMALIZED_ID = CT_COMNT_HEADER.COMNT_HEADER_ID)

7.3. For each Attachment in the Attachment list

7.3.1. Set DM_DOC_HEADER.TYP_CD = ‘COMMENT’

7.3.2. Create a new DM_DOC

Fields and Controls PropertiesElement

Label Database Name/Data Source Destination Table/Field Type

Mandatory

Functionality Behavior

Use Case Requirement

1 N/A N/A N/A WP N/A On open, makes a call to security server Cssvsvrm and the Add Account web page will be displayed. All of the entry fields will be set to spaces, and the Regulated Entities and Attachments lists will be initialized. The Area, Type, and Basis drop downs will be populated with their list of


Element


Mandatory



respective values, which are defined in the referenced tables, and they will be set to spaces.

2 CN EI_ORG.CUST_REF_NUM EI_ORG.CUST_REF_NUM:NUM EF Yes If a number is entered, when the user tabs off this field, check that the number entered is valid. If valid populate the Name and AR (see below) fields.

If the format of the CN entered isn’t correct (an 11 character CN Number), an error message (“The CN length is not valid.”) will be displayed.

If a record doesn’t exist in EI_ORG for the CN entered an error message (“The CN provided doesn’t exist.”) will be displayed.

If more than one records exists in EI_ORG for the CN entered an error message (“Multiple CN records returned.”) will be displayed.

If a value is not selected/entered and the user clicks on the Save push button an error message (“CN is required. Please make sure you enter a CN.”) will be displayed.

Always enabled.

Dolmain: CVisibility:

123


Element


Mandatory



3 Name EIORG.ORG_NAME_TXT BT_ARS_AR_NUM RO Yes Display of the Name of the selected CN

123

4 ... N/A N/A PB Flows the user to the Organization Search modal pop-up to allow the user to search for an EI_ORG by various criteria.

If an Organization was selected, upon return to this web page the CN, Name, and AR (see above) fields will be populated.

Always enabled.

123

5 AR BT_ARS_AR_NUM BT_ARS_AR_NUM RO Yes Retrieve BT_ARS where it is associated with the specified EI_ORG (EI_ORG.ORG_ID = BT_ARS.CUST_ID) and that BT_ARS is associated with a FE_FEE and that FE_FEE’s FEE_CD = ‘FTA’.

123

6 Area EI_SECT_185_ACCOUNT.AREA_TYPE_CD

BT_ARS_AR_NUM DD Yes Display relevant NAME_TXTs from the Reference tables.

If a value is selected and it is different than the previous value selected, the Regulated Entities list will be cleared out.

Always enabled.

123

7 Type EI_SECT_185_ACCOUNT.TYPE_CD EI_SECT_185_ACCOUNT.TYPE_CD DD Yes Display relevant NAME_TXTs from the Reference tables.

If a value is selected and it is different than the previous value selected, the Regulated

1345


Element


Mandatory



Entities list will be cleared out.

Always enabled.

8 Basis EI_SECT_185_ACCOUNT.BASIS_CD EI_SECT_185_ACCOUNT.BASIS_CD DD No Display relevant NAME_TXTs from the Reference tables.

If a value is selected and it is not spaces, a Period Start Date and Period End Date are required. If a value is selected and Period Start Date and/or Period End Date are blank and the user clicks on the Save push button the appropriate error message(s) (“Period Start Date is required if a Basis has been selected. Please make sure you enter a Period Start Date.” and/or “Period End Date is required if a Basis has been selected. Please make sure you enter a Period End Date.”) will be displayed.

Always enabled.

123

9 Period Start Date

EI_SECT_185_ACCOUNT.BASELINE_PERIOD_START_DT


DF/DT

No If a Period Start Date is entered a Basis must be selected and a Period End Date must be entered. If a Period Start Date is entered and a Basis is not selected and/or a Period End Date is not entered and the user clicks on the Save push button the appropriate error message(s) (“Basis is required if a Period Start Date


Element


Mandatory



has been entered. Please make sure you select a Basis.” and/or “Period End Date is required if a Period Start Date has been entered. Please make sure you enter a Period End Date.”) will be displayed.

Display format is MM/DD/YYYY

Always enabled.

10 Date Picker

N/A N/A PB No Brings up a date picker calendar

N/A

11 Period End Date

EI_SECT_185_ACCOUNT.BASELINE_PERIOD_END_DT


EF No If a Period End Date is entered a Basis must be selected and a Period Start Date must be entered. If a Period End Date is entered and a Basis is not selected and/or a Period Start Date is not entered and the user clicks on the Save push button the appropriate error message(s) (“Basis is required if a Period End Date has been entered. Please make sure you select a Basis.” and/or “Period Start Date is required if a Period End Date has been entered. Please make sure you enter a Period Start Date.”) will be displayed.Period End Date must be greater than or equal to the Period Start Date, if not when the user clicks on the Save push button an error message (“Period


Element


Mandatory



End Date must be greater than or equal to Period Start Date.”) will be displayed.Display format is MM/DD/YYYYAlways enabled.

12 RN # (Regulated Entities List)

EI_PT_SOURCE_ACCT.REG_ENT_REF_NUM

N/A RO Yes Retrieve...

Hyperlink to dynamically sort the Regulated Entities table by RN#

123

13 Air Acct # (Regulated Entities List)

EI_PT_SOURCE_ACCT.ACCT_NUM N/A RO No Retrieve...

Hyperlink to dynamically sort the Regulated Entities table by Air Acct

123

14 Site Name (Regulated Entities List)

EI_SITE.SITE_NAME_TXT N/A RO No Retrieve EI_SITE where it is associated with an EI_ACCT_ORG_SITE and that EI_ACCT_ORG_SITE’s EFF_DT <= Current Date and that EI_ACCT_ORG_SITE’s DEACT_DT >= Current Date and that EI_ACCT_ORG_SITE is associated with an EI_PT_SOURCE_ACCT and that EI_PT_SOURCE_ACCT’s REG_ENT_REF_NUM = specified RN #.

15 Last EI Date (Regulated Entities List)

EI_PT_SOURCE_ACCT.LAST_EI_DT RO No Retrieve

Display format is MM/DD/YYYY

Display as blank/spaces if = 01/01/0001 (null).

16 X (Regulated Entities

N/A N/A PB No Displays a remove confirmation pop-up message (“Do

1235


Element


Mandatory



List) you want to remove the selected Regulated Entity?”) with OK and Cancel PBs. On confirmation, removes the specified row from the Regulated Entities list.

Enabled if the list contains one or more records.

17 Add... N/A N/A PB No Flows the user to the Regulated Entity Search modal pop-up to allow the user to search for an EI_PT_SOURCE_ACCTs by various criteria.

If one or more Regulated Entites were selected, upon return to this web page they will be added to the Regulated Entities list.

Enabled if an Area (not equal to spaces) and a Type (not equal to spaces) have been selected fro mthe Area drop down and Type drop down.

7896

18 Comment

CT_COMNT.COMNT_TXT CT_COMNT.COMNT_TXT:Comment EF No The user can copy and paste text into the Comment EF.

The Comment text can combine upper/lower case letters and word wrapping will be allowed.

When the user clicks the Save push button, the text will be spliced into 3500 character blocks. Each block will be saved as a

456


Element


Mandatory



separate comment.

Always enabled.

19 Attachment (Attachments List)

DM_DOC.FILENAME_TXT DM_DOC.FILENAME_TXT RO No If a one or more Attachments have been seleced for upload a Comment is required. If one or more Attachments have been seleced for upload and Comment is blank and the user clicks on the Save push button an error message (“A Comment is required in order to attach a document. Please make sure you enter a Comment.”) will be displayed.

159

20 Browse... (Attachments List)

N/A N/A PB No Opens the Choose File to Upload window to select an attachment.

Only one file can be selected at a time.

If a file was selected, upon return to this web page a new row will be added at the bottom of the Attachments list so that the user can select another attachment if desired.

Always enabled.

753

21 Save N/A N/A PB N/A See Business Rule 4 for the details.

When the save is complete, and if no errors were encountered, the user will flow to the Account


Element


Mandatory



Detail web page and the specified EI_SECT_185_ACCOUNT will be displayed so they can make any necessary edits. If one or more errors were encountered, the user will remain on this page so that they can address the issues identified.

Always enabled.

22 Clear N/A N/A PB N/A Resets all of the fields to their default value/spacesand initializes the Regulated Entities and Attachments lists.

Always enabled.

23 Cancel N/A N/A PB N/A Displays a cancel confirmation message (“Do you want to cancel your changes and navigate to the Account Search page?”), on confirmation flows the user to the Account Search page.

Always enabled.


Navigation Bar

User Interface


Business Rules

Fields and Controls PropertiesElement

Label Type


1 Logout HL Logs the user out of the system and returns to the landing page

2 Account Search HL Opens the Account Search page

3 Add Account HL Opens the Add Account page

4 Fee Equivalencies List HL Opens the Fee Equivalencies List page

5 Add Fee Equivalency HL Opens the Add Fee Equivalency page

6 Fee Schedules List HL Opens the Fee Schedules List page

7 Add Fee Schedule HL Opens the Add Fee Schedule page

8 Billing HL Opens the Section 185 Billing page

9 Reports HL Opens the Reports page

section 185 fee program€¦ · web viewsection 185 fee program. webpage specifications. version...

Documents