Reason Codes: Difference between revisions

From EPOD
(Updated from Admin v3.3.0.1)
(Added details of new Service and Fleet Management codes.)
 
(12 intermediate revisions by the same user not shown)
Line 2: Line 2:


Codes are set up at many reasons, denoted by Type:
Codes are set up at many reasons, denoted by Type:
* Job - Reason Codes for cancelling whole jobs.
* ''Job'' - Reason Codes for cancelling whole jobs.
* Detail - Reason Codes for cancelling or short-delivering containers and items.
* ''Detail'' - Reason Codes for cancelling or short-delivering containers and items.
* Vehicle Damage codes - used exclusively for the bespoke Vehicle EPOD system. They are of types:
* ''Vehicle Damage codes'' - used exclusively for the bespoke Vehicle EPOD system. They are of types:
** Location
** ''Location''
** Type
** ''Type''
** Severity
** ''Severity''
* Claused Delivery reason codes - used when the system is configured for Claused Delivery codes.
* ''Claused'' Delivery reason codes - used when the system is configured for Claused Delivery codes.
* DU - Delivery Units or Asset Types
* ''DU'' - Delivery Units or Asset Types
* ''UOM'' - Unit of Measure, typically used in bespoke job upload processes.
* ''Services codes'' - used exclusively for services systems. They are of types:
** ''Service''
** ''Unit Type''
** ''System Type''
** ''Service Group''
** ''Service Product Category''
* ''Fleet management codes'' - used exclusively for Fleet Management services systems. They are of types:
** ''Tyre Actions''
** ''Tyre Removal''
** ''Tyre Work Type''


{{Note}} Typically, this static data is part of the data imported into the system from external ERP or TMS system (for example ''CALIDUS'' TMS) and would not require any further maintenance. However, if the external system does not pass this information in, or ''CALIDUS'' ePOD/eSERV is being run as a stand-alone system, this screen can be used.  
{{Note}} Typically, an external ERP or TMS system would maintain this data and send it to ''CALIDUS'' ePOD as part of the data imported into the system, for example ''CALIDUS'' TMS. This data should not require any further maintenance. However, if the external system does not pass this information in, or ''CALIDUS'' ePOD/eSERV is being run as a stand-alone system, system administrators can use this screen.  




This page provides functionality to View, Create and Edit Codes.
This screen provides functionality to view, create and edit all kinds of codes.


The screen allows users to filter data by:
You can filter data by:
* Code
* ''Code''
* Description
* ''Description''
* Type - a drop down list of the types above.
* ''Type'' - a drop down list of the types above.
* Job Group - a drop-down list of job groups.
* ''Job Group'' - a drop-down list of job groups.


Once the filter information is entered and the '''Search''' button is pressed, all matching codes are displayed in a table below.
Once you have entered the criteria, click '''Search'''. The screen will display a table of all the matching data. Any plain text boxes will match data that contains what you enter as the criterion.


[[File:EPOD-Codes1.png|600px|border]]  
[[File:EPOD-Codes1.png|900px|border]]  
<br />''Codes Search Panel and Results table''<br />
<br />''Codes Search Panel and Results table''<br />


Alternatively, clicking Create Excel Spreadsheet will export the Codes data - functionality differs per browser used to access the Admin system, the likely result being that the resulting file will be offered for download.
Alternatively, if you click '''Create Excel Spreadsheet''', the screen will export the codes data to a Microsoft Excel spreadsheet. The functionality differs per the browser you have used to access the Admin system, but the likely result is the spreadsheet file will offered for download.


A single line is displayed per Code found.


Each column can be sorted by clicking on the column header - clicking again will reverse the sort sequence.
Each code found is displayed per single line.


Details shown are:
You can choose to hide or show almost all of the columns in the results table by using the '''Select Columns''' button on the header. The columns shown are:
* Code - the code itself.
* ''Code'' - the code itself.
* Type - as detailed above.
* ''Type'' - as detailed above.
* Description - the description.
* ''Description'' - the description.
* Job Group - if this code is related to a job group, the job group will be identified here.
* ''Job Group'' - if this code is related to a job group, the job group will be identified here.
* Specific - Controls whether this code is specific to the owner of the job. If the configuration requires that only specific codes are shown on the device for these jobs, only codes marked specific will be shown.  
* ''Specific'' - Controls whether this code is specific to the owner of the job. If the configuration requires that only specific codes are shown on the device for these jobs, only codes marked specific will be shown.
 
You can sort the results table by clicking on the column header - clicking again will reverse the sort sequence.




== Uploading Codes ==
== Uploading Codes ==
The screen allows codes to be uploaded through a spreadsheet template file. This can be obtained by clicking the '''Obtain Upload Template''' button - results differ per browser used to access the Admin system, the likely result being that the template will be offered for download.
The screen allows upload functions - you can access these by pressing the '''Upload''' button. You can hide the upload buttons by pressing the '''Hide''' button.


Codes data may then be entered into the template and saved, external to the application. Alternatively, this template may be generated from an external system. Regardless, this data may then be uploaded into the system by selecting the file (using the '''Choose File''' selector on the screen), then clicking '''Upload Excel Spreadsheet'''
The screen allows you to upload codes through a spreadsheet template file. You can get this template by clicking the '''Obtain Upload Template''' button - results differ per browser used to access the Admin system, the likely result being that the template will be offered for download.


The success or failure of the upload will be indicated in a message on the button panel at the top of the screen and detailed results may be downloaded using the provided '''Download Results Spreadsheet''' button.
You can then enter codes data into this template and save it there, external to the ''CALIDUS'' ePOD application. Alternatively, an external system could generate a file to upload in this format. Regardless, you can then upload this data into the system by selecting the file (using the '''Choose File''' selector on the screen), then clicking '''Upload Excel Spreadsheet'''.


The screen will indicate the success or failure of the upload in a message on the button panel at the top of the screen - you can download detailed results using the provided '''Download Results Spreadsheet''' button.


== New Codes ==
== New Codes ==
The screen allows new codes to be created, by pressing the provided '''New''' button at the top of the screen.
You can create new codes by clicking the provided '''New''' button at the top of the screen.


[[File:EPOD-Codes2.png|border]]  
[[File:EPOD-Codes2.png|border]]  
<br />''New Code Pop-up''<br />
<br />''New Code Pop-up''<br />


The following details may be entered:
You can enter the following details:
* Code - the code itself. This must be unique for the type.
* ''Code'' - the code itself. This must be unique for the type.
* Type - as detailed above, selected from a drop-down list.
* ''Type'' - as detailed above, selected from a drop-down list.
* Job Group - if this code is related to a job group, select the job group from the drop-down list.
* ''Job Group'' - if this code is related to a job group, select the job group from the drop-down list.
* Owner-Specific - Controls whether this code is specific to the owner of the job. If the configuration requires that only specific codes are shown on the device for these jobs, only codes marked specific will be shown.  
* ''Owner-Specific'' - Controls whether this code is specific to the owner of the job. If the configuration requires that only specific codes are shown on the device for these jobs, only codes marked specific will be shown.  
* Description - the description.
* ''Description'' - the description.


A '''Save''' button is provided to save the entered data. Clicking '''Close''' will discard the new code.  
{{Note}} If this is a UOM-type code, the screen will also allow you to enter conversion parameters. {{Note}} These parameters affect certain bespoke job upload processes only.
* ''Conversion Type'' - what the bespoke upload process will do with the product quantities with lines of this UOM type when received - one of the following:
** ''Multiply'' - multiply the quantities by the Value parameter.
** ''Round'' - round the values to the nearest Value parameter.
** ''Exclude'' - do not upload.
** ''As Received'' - no action.
* ''Value'' - as described in ''Conversion Type'' above.
* ''Xref Code'' - this provides a drop-down list of all other UOM codes in the system for the site. If you select a code here, the UOM type will be converted to the selected UOM when received.


When changes are complete, you can click '''Save''' to save the changes, or '''Close''' to close the pop-up without saving the changes.




== View/Edit Codes ==
== View/Edit Codes ==
The codes can be viewed and edited by clicking the '''Select''' button against the line in the table. The screen will display a pop-up showing all the details of the code.
You can view and edit codes by clicking the '''Select''' button against the line in the table. The screen will display a pop-up showing all the details of the code.


[[File:EPOD-Codes3.png|border]]  
[[File:EPOD-Codes3.png|border]]  
<br />''View/Edit Code Pop-up''<br />
<br />''View/Edit Code Pop-up''<br />


The code may be edited by clicking the provided '''Edit''' button.
You can edit the code by clicking the provided '''Edit''' button.
 


You can edit the following elements:
* ''Job Group''.
* ''Owner-Specific''.
* ''Description''.


The Description may be edited here.
If this is a UOM-type code, you can also edit the following elements:
* ''Conversion Type''.
* ''Value''.
* ''Xref Code''.


A '''Save''' button is provided to save the edited values.


A '''Delete''' button is provided to delete the code.
When changes are complete, you can click '''Save''' to save the changes. If you don't want to save your changes, you can click '''Cancel''' to stop editing, or '''Close''' to close the pop-up without saving the changes.


Changes may be discarded by clicking the '''Close''' or '''Cancel''' buttons.
You can click the '''Delete''' button to delete the code - the screen will ask you to confirm before the code is deleted.




[[Category:UG 291094 EPOD Admin User Guide|300_100]]
[[Category:UG 291094 EPOD Admin User Guide|300_100]]

Latest revision as of 10:33, 6 August 2024

This screen provides all details of the codes in the CALIDUS ePOD system.

Codes are set up at many reasons, denoted by Type:

  • Job - Reason Codes for cancelling whole jobs.
  • Detail - Reason Codes for cancelling or short-delivering containers and items.
  • Vehicle Damage codes - used exclusively for the bespoke Vehicle EPOD system. They are of types:
    • Location
    • Type
    • Severity
  • Claused Delivery reason codes - used when the system is configured for Claused Delivery codes.
  • DU - Delivery Units or Asset Types
  • UOM - Unit of Measure, typically used in bespoke job upload processes.
  • Services codes - used exclusively for services systems. They are of types:
    • Service
    • Unit Type
    • System Type
    • Service Group
    • Service Product Category
  • Fleet management codes - used exclusively for Fleet Management services systems. They are of types:
    • Tyre Actions
    • Tyre Removal
    • Tyre Work Type

Note Note: Typically, an external ERP or TMS system would maintain this data and send it to CALIDUS ePOD as part of the data imported into the system, for example CALIDUS TMS. This data should not require any further maintenance. However, if the external system does not pass this information in, or CALIDUS ePOD/eSERV is being run as a stand-alone system, system administrators can use this screen.


This screen provides functionality to view, create and edit all kinds of codes.

You can filter data by:

  • Code
  • Description
  • Type - a drop down list of the types above.
  • Job Group - a drop-down list of job groups.

Once you have entered the criteria, click Search. The screen will display a table of all the matching data. Any plain text boxes will match data that contains what you enter as the criterion.

EPOD-Codes1.png
Codes Search Panel and Results table

Alternatively, if you click Create Excel Spreadsheet, the screen will export the codes data to a Microsoft Excel spreadsheet. The functionality differs per the browser you have used to access the Admin system, but the likely result is the spreadsheet file will offered for download.


Each code found is displayed per single line.

You can choose to hide or show almost all of the columns in the results table by using the Select Columns button on the header. The columns shown are:

  • Code - the code itself.
  • Type - as detailed above.
  • Description - the description.
  • Job Group - if this code is related to a job group, the job group will be identified here.
  • Specific - Controls whether this code is specific to the owner of the job. If the configuration requires that only specific codes are shown on the device for these jobs, only codes marked specific will be shown.

You can sort the results table by clicking on the column header - clicking again will reverse the sort sequence.


Uploading Codes

The screen allows upload functions - you can access these by pressing the Upload button. You can hide the upload buttons by pressing the Hide button.

The screen allows you to upload codes through a spreadsheet template file. You can get this template by clicking the Obtain Upload Template button - results differ per browser used to access the Admin system, the likely result being that the template will be offered for download.

You can then enter codes data into this template and save it there, external to the CALIDUS ePOD application. Alternatively, an external system could generate a file to upload in this format. Regardless, you can then upload this data into the system by selecting the file (using the Choose File selector on the screen), then clicking Upload Excel Spreadsheet.

The screen will indicate the success or failure of the upload in a message on the button panel at the top of the screen - you can download detailed results using the provided Download Results Spreadsheet button.

New Codes

You can create new codes by clicking the provided New button at the top of the screen.

EPOD-Codes2.png
New Code Pop-up

You can enter the following details:

  • Code - the code itself. This must be unique for the type.
  • Type - as detailed above, selected from a drop-down list.
  • Job Group - if this code is related to a job group, select the job group from the drop-down list.
  • Owner-Specific - Controls whether this code is specific to the owner of the job. If the configuration requires that only specific codes are shown on the device for these jobs, only codes marked specific will be shown.
  • Description - the description.

Note Note: If this is a UOM-type code, the screen will also allow you to enter conversion parameters. Note Note: These parameters affect certain bespoke job upload processes only.

  • Conversion Type - what the bespoke upload process will do with the product quantities with lines of this UOM type when received - one of the following:
    • Multiply - multiply the quantities by the Value parameter.
    • Round - round the values to the nearest Value parameter.
    • Exclude - do not upload.
    • As Received - no action.
  • Value - as described in Conversion Type above.
  • Xref Code - this provides a drop-down list of all other UOM codes in the system for the site. If you select a code here, the UOM type will be converted to the selected UOM when received.


When changes are complete, you can click Save to save the changes, or Close to close the pop-up without saving the changes.


View/Edit Codes

You can view and edit codes by clicking the Select button against the line in the table. The screen will display a pop-up showing all the details of the code.

EPOD-Codes3.png
View/Edit Code Pop-up

You can edit the code by clicking the provided Edit button.


You can edit the following elements:

  • Job Group.
  • Owner-Specific.
  • Description.

If this is a UOM-type code, you can also edit the following elements:

  • Conversion Type.
  • Value.
  • Xref Code.


When changes are complete, you can click Save to save the changes. If you don't want to save your changes, you can click Cancel to stop editing, or Close to close the pop-up without saving the changes.

You can click the Delete button to delete the code - the screen will ask you to confirm before the code is deleted.