Fish Ticket Premiums Record View

Fish Ticket Premiums Record View

 Manually added premiums can be added to delivery tickets from the multi-select combo box on the Home tab of the delivery ticket. Automatically added premiums are automatically added to delivery tickets when the conditions defined on the premium program record are met. Premiums are automatically added to all the ticket line items that meet the premium conditions. The purpose of this page is to add, edit, remove, and activate/inactive premium programs to be used on Fish Tickets.

Once the premium has been added to the delivery ticket, the rate can be manually edited.

Software Version: 2021.03.05 and newer

Page Header

Header Toolbar

Toolbar Icons

Description

Toolbar Icons

Description

Delete

Programs used on a Fish Ticket will not be able to be deleted. The message "This Program is used on a Delivery Ticket and cannot be deleted." will be displayed. Additionally, only the latest version of a program will be allowed to be deleted. If the user selects a prior version of a program to delete, the message "([Program ID]) cannot be deleted because it is not the latest version of this program." will be displayed.

Grid Layout

Help

New

Save

Fields

Description

Program

A non-editable text box to display "[Program ID] - [Description]" of the Premium Program. This defaults to blank for a new Premium Program and is always updated after initial Save. This field is never editable. When users update the value in the 'Program ID' field or the 'Description' field, the Fish Ticket Premiums record view page will refresh to display the updated Premium Program.

Database Field: ERPx_APProgram.APProgramID - ERPx_APProgram.APProgramName

Type

A non-editable text box to display "Premium". This defaults to blank for a new Premium Program and is always updated after initial Save. This field is never editable.

This text box contains the value in the APProgramType Enumeration Class where APProgramType = 1.

Database Field: ERPx_APProgram.APProgramTypeEN

Properties Tab 

Toolbar Icons

Description

Toolbar Icons

Description

Excel

Fields

Description

Properties

Value 

Group: Configuration

Program ID

This is a text box that is required. It defaults to blank for new records. If not assigned, the message "Program ID is required." will be displayed on Save. This value must be unique. If not, the message "Duplicate Program ID's are not allowed for the same Program Type." will be displayed on Save. This field is always editable and must be <= 50 characters. 

Database Field: ERPx_APProgram.APProgramID

Description

This is a text box that is required. If not assigned, the message "Description is required." will be displayed on Save. It defaults to blank for new record and duplicate values are allowed. This field is always editable and must be <= 100 characters. 

Database Field: ERPx_APProgram.APProgramName

Class

Identifies the Program Class associated with the Premium record. This is a single-select lookup that is required. If missing, the message "Class is required." will be displayed on Save. It defaults to blank and is always editable.

The lookup contains a blank value, the current assigned values and all the records in the Tax & Premium Classes list view with a 'Program Type' of "Premium". 

Database Field: ERPx_APProgram.APProgramClassSK

Landed Date Start

This is a date picker that is required. If missing, the message "Landed Date Start is required." will be displayed on Save. This defaults as blank on new records and is always editable. Fish Tickets with a Landed Date before the 'Landed Date Start' will not be evaluated for the Premium. Else the message "[Program ID] Version [Version - 1]'s Landed Start and End Dates may not overlap other version of the same Program." will be displayed on Save.

Database Field: ERPx_APProgram.APProgramStart

Landed Date End

This is a date picker that is not required. This defaults as blank and is always editable. A blank value assumes the Premium never ends, but if a date is entered it must be >= the 'Landed Date Start' field. Else the message "Landed Date End must be on or after Landed Date Start." will be displayed on Save.  Fish Tickets with a Landed Date after the 'Landed Date End' will not be evaluated for the the Premium, even if the Premium Program is still Active. Else the message "[Program ID] Version [Version + 1]'s Landed Start and End Dates may not overlap other version of the same Program." will be displayed on Save.

 

Database Field: ERPx_APProgram.APProgramEnd

Inactive

 This is a Yes/No lookup that is required. it defaults to "No" and is always editable. This field is not visible until after the record is initially saved.

Database Field: ERPx_APProgram.IsInactive

Group: Assign Rules

How this Program is assigned to Tickets?

Identifies how the Premium Program is assigned to Fish Tickets. This is single-select lookup that is required. If missing, the message "How this Program is assigned to Tickets is required." will be displayed on Save. This defaults to blank and is always editable. It can be set to one of the following values:

  • Auto Assign - All Tickets: This will be auto assigned to all ticket lines that match the Program criteria.

  • Auto Assign - Dock Delivery Tickets: This will be auto assigned to all ticket lines that match the Program criteria and where the 'Dock Delivery' ticket property set to "Yes".

  • Auto Assign - Floating Tickets: This will be auto assigned to all ticket lines that match the Program criteria and where the 'Floating' ticket property set to "Yes". 

  • Manually Assigned: This must be manually assigned to a ticket and if manually assigned will apply to all tickets lines that match the Program criteria. 

This lookup contains the values in the APAssignmentMethod Enumeration Class.

Database Field: ERPx_APProgram.AssignmentMethodEN

Assign Rules By

Specifies how premiums are assigned fish tickets. This is a multi-select lookup where at least one selection is required. If missing, the message "Assign Rules By is required." will be displayed on Save. This field defaults as blank and is always editable. When one or more values are selected, on Save, additional tabs for each of the selected items will be added to the record view.

This lookup contains all the values in the APProgramAssignBy Enumeration Class.

Database Field: ERPx_APProgram.AssignRulesByEN

Assign Rate By

Specifies where the Premium Rate comes from. This is a single-select standard lookup that is required. It defaults to "GLOBAL" and is always editable. If it is changed from "GLOBAL", it must match one of the values in the 'Assign Rules By' Property. If not, the message "Assign Rate By must be assigned by one of the Assign Rules By values." will be displayed on Save.

This lookup contains all the values in the APProgramAssignBy Enumeration Class except 'Stat Area' and includes an option for GLOBAL.

Database Field: ERPx_APProgram.AssignmentMethodEN

Default Rate

 This is a text box that is required. If missing, the message "Rate is required." will be displayed on Save. It defaults to "0.000000" and is always editable.

 Leaving this as 0.000000 and the 'Assign Rate By' to "GLOBAL" and the 'Calculated On' on anything other than "Fixed Amount" will result in no tax being calculated.

 If the 'Assign Rate By' is anything other than 'GLOBAL" this is only represents the Default Rate. The actual rates may be different. 

Database Field: ERPx_APProgram.Rate

Calculated On

 This is a single-select standard lookup that is required. If missing, the message "Calculated On is required." will be displayed on Save. It defaults to blank and is always editable.

This lookup contains all the values in the APProgramCalcMethod Enumeration Class where APProgramCalcMethod = 2,3,5.

Database Field: ERPx_APProgram.APProgramCalcMethodEN

Group: Accounting

Premium Expense GL Account

This is a single-select lookup that is required.  If missing, the message "Premium Expense GL Account is required." will be displayed on Save. This defaults as blank and is always editable.

The lookup contains a list of all the 'Active' GL Accounts.

Database Field: ERPx_APProgram.DRAccountSK

Chill_Type Tab 

This tab will only be visible if "Chill Type" is selected in the 'Assign Rules By' property.

Toolbar Icons

Description

Toolbar Icons

Description

Excel

Delete

New

Fields

Description

Checkbox

Chill Type

Identifies the Chill Type that the Premium Program applies to. This is a single-select standard lookup that is required to save a line item. By default, when a new Premium Program is created, all Chill Types are assigned. If you want only specific Chill Types to apply to the Premium Program, click the ‘New’ icon and manually add the Chill Type(s) that you wish to apply. This field defaults as blank and is editable.

This lookup contains a list of all the 'Active' records in the Chill Type Master List.

Database Field: ERPx_APProgramEntity.EntitySK where ERPx_APProgramEntity.ProgramEntityEN = 7

Premium Expense GL Account

This is single-select standard lookup that is not required. This field is only enabled when "Chill Type" is selected as the 'Assign Rate By' value in the Properties tab. This field defaults to the 'Premium Expense GL Account' value selected in the Properties tab and is always editable.

The lookup contains a list of all the 'Active' GL Accounts.

Database Field: ERPx_APProgramEntity.ExpenseAccountSK where ERPx_APProgramEntity.ProgramEntityEN = 7

Rate

This is a text box that is not required. This field is only enabled when "Chill Type" is selected as the 'Assign Rate By' in the Properties tab. The Rate defaults to the 'Default Rate' value entered in the Properties tab and is always editable. If the field is enabled and left blank, it will default to "0.000000" on Save.

Database Field: ERPx_APProgramEntity.CompanyRate where ERPx_APProgramEntity.ProgramEntityEN = 7

Fishermen Tab 

This tab will only be visible if "Fishermen" is selected in the 'Assign Rules By' property.

Toolbar Icons

Description

Toolbar Icons

Description

Excel

Delete

New

Fields

Description

Checkbox

Fisherman

Identifies the Fisherman, Fisherman & Tender or Tender that the Premium Program applies to. This is a single-select standard lookup that is required to save a line item. By default, when a new Premium Program is created, all Fishermen, Fishermen & Tenders, and Tenders are assigned. If you want only a specific Fisherman, Fisherman & Tender or Tender to apply to the Premium Program, click the ‘New’ icon and manually add the Fisherman, Fisherman & Tender or Tender that you wish to apply. This field defaults as blank and is editable.

This lookup contains a list of all the 'Active' Fishermen, Fishermen & Tenders and Tenders.

Database Field: ERPx_APProgramEntity.EntitySK where ERPx_APProgramEntity.ProgramEntityEN = 4

Premium Expense GL Account

This is single-select standard lookup that is not required. This field is only enabled when "Fishermen" is selected as the 'Assign Rate By' value in the Properties tab. This field defaults to the 'Premium Expense GL Account' value selected in the Properties tab and is always editable.

The lookup contains a list of all the 'Active' GL Accounts.

Database Field: ERPx_APProgramEntity.ExpenseAccountSK where ERPx_APProgramEntity.ProgramEntityEN = 4

Rate

This is a text box that is not required. This field is only enabled when "Fishermen" is selected as the 'Assign Rate By' in the Properties tab. The Rate defaults to the 'Default Rate' value entered in the Properties tab and is always editable. If the field is enabled and left blank, it will default to "0.000000" on Save.

Database Field: ERPx_APProgramEntity.CompanyRate where ERPx_APProgramEntity.ProgramEntityEN = 4

Gear Tab 

This tab will only be visible if "Gear" is selected in the 'Assign Rules By' property.

Toolbar Icons

Description

Toolbar Icons

Description

Excel

Delete

New

Fields

Description

Checkbox

Gear

Identifies the Gear that the Premium Program applies to. This is a single-select standard lookup that is required to save a line item. By default, when a new Premium Program is created, all Gear are assigned. If you want only specific Gear to apply to the Premium Program, click the ‘New’ icon and manually add the Gear that you wish to apply. This field defaults as blank and is editable.

This lookup contains a list of all the 'Active' records in the Gear Master List.

Database Field: ERPx_APProgramEntity.EntitySK where ERPx_APProgramEntity.ProgramEntityEN = 2

Premium Expense GL Account

This is single-select standard lookup that is not required. This field is only enabled when "Gear" is selected as the 'Assign Rate By' value in the Properties tab. This field defaults to the 'Premium Expense GL Account' value selected in the Properties tab and is always editable.

The lookup contains a list of all the 'Active' GL Accounts.

Database Field: ERPx_APProgramEntity.ExpenseAccountSK where ERPx_APProgramEntity.ProgramEntityEN = 2

Rate

This is a text box that is not required. This field is only enabled when "Gear" is selected as the 'Assign Rate By' in the Properties tab. The Rate defaults to the 'Default Rate' value entered in the Properties tab and is always editable. If the field is enabled and left blank, it will default to "0.000000" on Save.

Database Field: ERPx_APProgramEntity.CompanyRate where ERPx_APProgramEntity.ProgramEntityEN = 2

Management_Programs Tab 

This tab will only be visible if "Management Program" is selected in the 'Assign Rules By' property.

Toolbar Icons

Description

Toolbar Icons

Description

Excel

Delete

New

Fields

Description

Checkbox

Management Program

Identifies the Management Program that the Premium Program applies to. This is a single-select standard lookup that is required to save a line item. By default, when a new Premium Program is created, all Management Programs are assigned. If you want only specific Management Programs to apply to the Premium Program, click the ‘New’ icon and manually add the Management Program(s) that you wish to apply. This field defaults as blank and is editable.

This lookup contains a list of all the 'Active' records in the Management Programs Master List.

Database Field: ERPx_APProgramEntity.EntitySK where ERPx_APProgramEntity.ProgramEntityEN = 5

Premium Expense GL Account

This is single-select standard lookup that is not required. This field is only enabled when "Management Programs" is selected as the 'Assign Rate By' value in the Properties tab. This field defaults to the 'Premium Expense GL Account' value selected in the Properties tab and is always editable.

The lookup contains a list of all the 'Active' GL Accounts.

Database Field: ERPx_APProgramEntity.ExpenseAccountSK where ERPx_APProgramEntity.ProgramEntityEN = 5

Rate

This is a text box that is not required. This field is only enabled when "Management Programs" is selected as the 'Assign Rate By' in the Properties tab. The Rate defaults to the 'Default Rate' value entered in the Properties tab and is always editable. If the field is enabled and left blank, it will default to "0.000000" on Save.

Database Field: ERPx_APProgramEntity.CompanyRate where ERPx_APProgramEntity.ProgramEntityEN = 5

Site_Processed Tab 

This tab will only be visible if "Site Processed" is selected in the 'Assign Rules By' property.

Toolbar Icons

Description

Toolbar Icons

Description

Excel

Delete

New

Fields

Description

Checkbox

Premium Expense GL Account

This is single-select standard lookup that is not required. This field is only enabled when "Site Processed" is selected as the 'Assign Rate By' value in the Properties tab. This field defaults to the 'Premium Expense GL Account' value selected in the Properties tab and is always editable.

The lookup contains a list of all the 'Active' GL Accounts.

Database Field: ERPx_APProgramEntity.ExpenseAccountSK where ERPx_APProgramEntity.ProgramEntityEN = 8

Rate

This is a text box that is not required. This field is only enabled when "Site Processed" is selected as the 'Assign Rate By' in the Properties tab. The Rate defaults to the 'Default Rate' value entered in the Properties tab and is always editable. If the field is enabled and left blank, it will default to "0.000000" on Save.

Database Field: ERPx_APProgramEntity.CompanyRate where ERPx_APProgramEntity.ProgramEntityEN = 8

Site

Identifies the Site that the Premium Program applies to. This is a single-select standard lookup that is required to save a line item. By default, when a new Premium Program is created, all Sites are assigned. If you want only specific Sites to apply to the Premium Program, click the ‘New’ icon and manually add the Site(s) that you wish to apply. This field defaults as blank and is editable.

This lookup contains a list of all the 'Active' records in the Sites list view.

Database Field: ERPx_APProgramEntity.EntitySK where ERPx_APProgramEntity.ProgramEntityEN = 8

Species Tab 

This tab will only be visible if "Species" is selected in the 'Assign Rules By' property.

Toolbar Icons

Description

Toolbar Icons

Description

Excel

Delete

New

Fields

Description

Checkbox

Premium Expense GL Account

This is single-select standard lookup that is not required. This field is only enabled when "Species" is selected as the 'Assign Rate By' value in the Properties tab. This field defaults to the 'Premium Expense GL Account' value selected in the Properties tab and is always editable.

The lookup contains a list of all the 'Active' GL Accounts.

Database Field: ERPx_APProgramEntity.ExpenseAccountSK where ERPx_APProgramEntity.ProgramEntityEN = 1

Rate

This is a text box that is not required. This field is only enabled when "Species" is selected as the 'Assign Rate By' in the Properties tab. The Rate defaults to the 'Default Rate' value entered in the Properties tab and is always editable. If the field is enabled and left blank, it will default to "0.000000" on Save.

Database Field: ERPx_APProgramEntity.CompanyRate where ERPx_APProgramEntity.ProgramEntityEN = 1

Specie

Identifies the Specie that the Premium Program applies to. This is a single-select standard lookup that is required to save a line item. By default, when a new Premium Program is created, all Species are assigned. If you want only specific Species to apply to the Premium Program, click the ‘New’ icon and manually add the Specie(s) that you wish to apply. This field defaults as blank and is editable.

This lookup contains a list of all the 'Active' records in the Species Master List.

Database Field: ERPx_APProgramEntity.EntitySK where ERPx_APProgramEntity.ProgramEntityEN = 1

Stat_Areas Tab 

This tab will only be visible if "Stat Areas" is selected in the 'Assign Rules By' property.

Toolbar Icons

Description

Toolbar Icons

Description

Excel

Delete

New

Fields

Description

Checkbox

Premium Expense GL Account

This is a non-editable text box that is not required. The value for this field is saved from the 'Premium Expense GL Account' value selected in the Properties tab, but is not displayed and is not enabled in the Stat Area grid.

Database Field: ERPx_APProgramEntity.ExpenseAccountSK where ERPx_APProgramEntity.ProgramEntityEN = 3

Rate

This is a non-editable text box that is not required. The value for this field is saved from the 'Default Rate' value entered in the Properties tab, but is not displayed and is not enabled in the Stat Area grid.