Fish Ticket Premiums Record View
- Janice Dannenberg (Unlicensed)
- Tom Williams
- Emma Greenwood
Premiums are most often used to represent things that increases the price you pay fishermen for their fish but they can also be configured to reduce the amount you pay. Premiums can be configured to be manually added or automated based on business rules. 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 |
|---|---|
| Delete | Deletes the transaction or master file record. When clicked, users will be prompted with: "Are you sure you want to delete this record?". Click "OK" to confirm, or "Cancel" to return without deleting. WARNING: Records cannot be recovered once they are deleted! 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 | Opens the Saved Grid Layout menu that allows the user to select another saved layout, create a new layout, save changes to a layout, or assign a saved layout as the default for the page. Once changes are made to a grid, such as columns are added or removed, the user can click the Saved Grid Layout icon and save the changes to the grid layout and name the new layout. The new layout can also be set as the default, instead of the System View. This is useful for creating specific views to separate master files or transaction types (i.e. Invoice specific vs. Credit Memo specific).
|
| Help | Opens the online WIKI help page for the current page.
|
| New | Allows the user to create a new master file record or transaction by opening a blank record view page. This icon is always enabled. |
| Save | Saves the changes made to the record.
|
| 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 |
The bolded view is the default view, which will determine the view will automatically display in when opened. Properties Tab
| Toolbar Icons | Description |
|---|---|
| Excel | Exports the contents of the grid to an Excel file that will automatically download. The contents that export are those that are visible to the user. Therefore, if the user has filtered the view only the filtered contents will be exported. |
| Fields | Description |
| Properties | Identifies the Property that is being set up. |
| Value | A text box or lookup to set the value of the property. Property values are always editable and can be changed at any time, unless otherwise specified. |
| Group: Configuration | |
| Program ID | Identifies the short description and unique identifier for Tax, Premium, Charge, Accrual and Sales Program. 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 | Identifies a long description for Tax, Premium or Sales Programs. 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. Program Classes are used to classify programs by 'Program Type' (Tax or Premium) and by Group. Fish Ticket Tax Programs can be grouped as either Borough, City, Observer, State, or Other. 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 | Identifies the date the Program starts. Tickets with a 'Landed Date' on or after the Landed Date Start date will be evaluated for the Program. 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. Identifies the date fish or shellfish are off-loaded or trans-shipped from the catcher vessel to the first purchaser. The date of lan |