System Keys: Difference between revisions

From Commander4j
Newer edit →
Created page with " <img width="913" alt="System Keys1" src="https://github.com/C4J/Commander4j/assets/20553038/5b6482e3-7fb5-4c68-872b-4b5f1761b13b"><br><br> System Keys are a set of global settings used by the application to determine how certain functions work. These settings will include such items as :- | System Key | Typical Value | Description | | - |- | :- | | BATCH EXPIRY TIME | - | A flag which is used to determine how the time portion of the Expiry Date is calculated. Can be..."
 
No edit summary
Line 1: Line 1:




<img width="913" alt="System Keys1" src="https://github.com/C4J/Commander4j/assets/20553038/5b6482e3-7fb5-4c68-872b-4b5f1761b13b"><br><br>
<img width="913" alt="System Keys1" src="https://github.com/C4J/Commander4j/assets/20553038/5b6482e3-7fb5-4c68-872b-4b5f1761b13b"><br><br>


System Keys are a set of global settings used by the application to determine how certain functions work. These settings will include such items as :-
System Keys are a set of global settings used by the application to determine how certain functions work. These settings will include such items as :-




| System Key | Typical Value | Description |
{| class="wikitable" style="margin:auto"
| - |- | :- |
|+ Caption text
| BATCH EXPIRY TIME | - | A flag which is used to determine how the time portion of the Expiry Date is calculated. Can be - = or + |
|-
| BATCH FORMAT | {YEAR1}{JULIAN_DAY}{PLANT} | Used to construct the batch number when creating/printing new Pallet Tickets (SSCC's) |
! Name !! Description
| BATCH REGEX | - |Optional Regular Expression which can be used to validate the Batch Number after user has edited by hand. |
|-
| COMPANY NAME | My Company | Text that you want to appear at the top of reports. |
| [https://github.com/C4J?tab=repositories All Projects] || Overview of all Projects
| DEFAULT BATCH STATUS | Restricted | Deprecated - no longer used. Now held in Material Master record. |
|-
| DEFAULT HELPSET ID | Deprecated - no longer used. Help now linked to Wiki pages. |
| [https://github.com/C4J/Commander4j/releases Commander4j] || Commander4j Core Application
| DEFAULT PALLET STATUS | Unrestricted | Deprecated - no longer used. Now held in Process Order record. |  
|-
| DEFAULT_LOCATION | MYLOCATION | Should be a valid Location Id from the locations screen and is used by the Despatch function |
| [https://github.com/C4J/Commander4j-Middleware/releases Middleware] || Middleware for message translation to external systems
| DESPATCH NUMBER | 1 | Used to determine the numeric element of the next despatch number. |
|-
| DESPATCH NUMBER FORMAT | XX{NNNNNN} | Defines the structure of the Despatch Number. {NNN} indicates the number above. XX is a literal prefix. |
| [https://github.com/C4J/Commander4j-AutoLab/releases AutoLab4j] || Automatic Label Application triggered by MODBUS
| EXPIRY DATE MODE | BATCH | Can be either BATCH or SSCC. This value should be set before go-live and not changed.<br>BATCH will store the Expiry Date in the Batches table using the MATERIAL/BATCH NUMBER as the key.<br> All production which shares the same Material and Batch will therefore have the same Expiry (Best Before End) date.<br> The format of the Batch Number is defined above and can include a Julian Date component so that it automatically changes at midnight.<br>SSCC mode will store the Expiry Date in the PALLET record and as such allow you to change the expiry date independently of the Batch Number. |
|-
| HELPSET FILENAME | help/helpset.hs | Deprecated - no longer used. Help now linked to Wiki pages. |
| [https://github.com/C4J/sftpSend/releases SFTP Send] || Utility to send files automatically via SFTP
| INTERFACE LOG ID | 1 | Sequential Unique ID used to record all Interface activity (Inbound and Outbound). |
|-
| INTERFACE REQUEST ID | 1 | Sequential Unique ID used by outbound interface queue. |
| [https://github.com/C4J/sftpGet/releases SFTP Get] || Utility to collect files automatically via SFTP
| LABEL_HEADER_COMMENT | Free Format Text | Optional free format text than can appear on Finished Goods Label. |
|}
| MAIL_POP_AUTH_PWD | password | Not currently used. |
 
| MAIL_POP_AUTH_USER | user | Not currently used. |
 
| MAIL_POP_HOST_NAME | host.com | Not currently used. |
{| class="wikitable" style="margin:auto"
| MAIL_SMTP_AUTH_PWD | password | SMTP password. |
|+ Caption text
| MAIL_SMTP_AUTH_REQD | true | Indicates if SMTP server requires authentication. |
|-
| MAIL_SMTP_AUTH_USER | user | SMTP username |
! System Key !! Typical Value !! Description
| MAIL_SMTP_FROM_ADDRESS | user@me.com | Specifies SMTP sending email address. |
|-
| MAIL_SMTP_HOST_NAME | host.com | SMTP Host Name |
| BATCH EXPIRY TIME ||  || A flag which is used to determine how the time portion of the Expiry Date is calculated. Can be - = or +  
| MAIL_SMTP_MSG_TYPE | text/plain | Format of mail message |
|-
| MAIL_SMTP_PORT | 25 | SMTP Port Number |
| BATCH FORMAT || {YEAR1}{JULIAN_DAY}{PLANT} || Used to construct the batch number when creating/printing new Pallet Tickets (SSCC's)  
| MHN INITIAL DECISION | Pending | Master Hold Notice default/starting decision for Pallet. |
|-
| MHN NUMBER FORMAT | XX{NNNNNN} | Defines the structure of the Master Hold Notice Number. {NNN} indicates the numeric element. XX is a literal prefix. |
| BATCH REGEX || - || Optional Regular Expression which can be used to validate the Batch Number after user has edited by hand.  
| PASSWORD ATTEMPTS | 3 | Maximum number of invalid password attempts before an account is locked out. |
|-
| PASSWORD EXPIRY | 30 | Number of days before a users password expires and they are prompted to change it. |
| COMPANY NAME || My Company || Text that you want to appear at the top of reports.  
| PLANT | 1234 | Deprecated - no longer used. |
|-
| PROCESS ORDER NUMBER | 1 | Used to determine the numeric element of the next Process Order number (when created manually). |
| DEFAULT BATCH STATUS || Restricted || Deprecated - no longer used. Now held in Material Master record.  
| PROCESS ORDER NUMBER FORMAT | {NNNNNN} | Defines the structure of the Process Order Number. {NNNNNN} indicates the number above. |
|-
| PROGRAM VERSION | 3.63 | Stores the current version of the Application. Users are warned if they attempt to connect with different version. |
| DEFAULT HELPSET ID || Deprecated - no longer used. Help now linked to Wiki pages.  
| REPORT REQUEST ID | 3.63 | Used internally for queuing report requests generated by user of the web interface on RF Barcode Scanners. |
|-
| RESOURCE LIST | \01\02\03\04\ | Delimited list of values. User can select these values when using the Process Order Barcode printing facility. |
| DEFAULT PALLET STATUS || Unrestricted || Deprecated - no longer used. Now held in Process Order record.  
|-
| DEFAULT_LOCATION || MYLOCATION || Should be a valid Location Id from the locations screen and is used by the Despatch function  
|-
| DESPATCH NUMBER || 1 || Used to determine the numeric element of the next despatch number.  
|-
| DESPATCH NUMBER FORMAT || XX{NNNNNN} || Defines the structure of the Despatch Number. {NNN} indicates the number above. XX is a literal prefix.  
|-
| EXPIRY DATE MODE || BATCH || Can be either BATCH or SSCC. This value should be set before go-live and not changed.<br>BATCH will store the Expiry Date in the Batches table using the MATERIAL/BATCH NUMBER as the key.<br> All production which shares the same Material and Batch will therefore have the same Expiry (Best Before End) date.<br> The format of the Batch Number is defined above and can include a Julian Date component so that it automatically changes at midnight.<br>SSCC mode will store the Expiry Date in the PALLET record and as such allow you to change the expiry date independently of the Batch Number.  
|-
| HELPSET FILENAME || help/helpset.hs || Deprecated - no longer used. Help now linked to Wiki pages.  
|-
| INTERFACE LOG ID || 1 || Sequential Unique ID used to record all Interface activity (Inbound and Outbound).  
|-
| INTERFACE REQUEST ID || 1 || Sequential Unique ID used by outbound interface queue.  
|-
| LABEL_HEADER_COMMENT || Free Format Text || Optional free format text than can appear on Finished Goods Label.  
|-
| MAIL_POP_AUTH_PWD || password || Not currently used.  
|-
| MAIL_POP_AUTH_USER || user || Not currently used.  
|-
| MAIL_POP_HOST_NAME || host.com || Not currently used.  
|-
| MAIL_SMTP_AUTH_PWD || password || SMTP password.  
|-
| MAIL_SMTP_AUTH_REQD || true || Indicates if SMTP server requires authentication.  
|-
| MAIL_SMTP_AUTH_USER || user || SMTP username  
|-
| MAIL_SMTP_FROM_ADDRESS || user@me.com || Specifies SMTP sending email address.  
|-
| MAIL_SMTP_HOST_NAME || host.com || SMTP Host Name  
|-
| MAIL_SMTP_MSG_TYPE || text/plain || Format of mail message  
|-
| MAIL_SMTP_PORT || 25 || SMTP Port Number  
|-
| MHN INITIAL DECISION || Pending || Master Hold Notice default/starting decision for Pallet.  
|-
| MHN NUMBER FORMAT || XX{NNNNNN} || Defines the structure of the Master Hold Notice Number. {NNN} indicates the numeric element. XX is a literal prefix.  
|-
| PASSWORD ATTEMPTS || 3 || Maximum number of invalid password attempts before an account is locked out.  
|-
| PASSWORD EXPIRY || 30 || Number of days before a users password expires and they are prompted to change it.  
|-
| PLANT || 1234 || Deprecated - no longer used.  
|-
| PROCESS ORDER NUMBER || 1 || Used to determine the numeric element of the next Process Order number (when created manually).  
|-
| PROCESS ORDER NUMBER FORMAT || {NNNNNN} || Defines the structure of the Process Order Number. {NNNNNN} indicates the number above.  
|-
| PROGRAM VERSION || 3.63 || Stores the current version of the Application. Users are warned if they attempt to connect with different version.  
|-
| REPORT REQUEST ID || 3.63 || Used internally for queuing report requests generated by user of the web interface on RF Barcode Scanners.  
|-
| RESOURCE LIST || \01\02\03\04\ || Delimited list of values. User can select these values when using the Process Order Barcode printing facility.  
|}

Revision as of 16:22, 19 August 2024



<img width="913" alt="System Keys1" src="https://github.com/C4J/Commander4j/assets/20553038/5b6482e3-7fb5-4c68-872b-4b5f1761b13b">


System Keys are a set of global settings used by the application to determine how certain functions work. These settings will include such items as :-


Caption text
Name Description
All Projects Overview of all Projects
Commander4j Commander4j Core Application
Middleware Middleware for message translation to external systems
AutoLab4j Automatic Label Application triggered by MODBUS
SFTP Send Utility to send files automatically via SFTP
SFTP Get Utility to collect files automatically via SFTP


Caption text
System Key Typical Value Description
BATCH EXPIRY TIME A flag which is used to determine how the time portion of the Expiry Date is calculated. Can be - = or +
BATCH FORMAT {YEAR1}{JULIAN_DAY}{PLANT} Used to construct the batch number when creating/printing new Pallet Tickets (SSCC's)
BATCH REGEX - Optional Regular Expression which can be used to validate the Batch Number after user has edited by hand.
COMPANY NAME My Company Text that you want to appear at the top of reports.
DEFAULT BATCH STATUS Restricted Deprecated - no longer used. Now held in Material Master record.
DEFAULT HELPSET ID Deprecated - no longer used. Help now linked to Wiki pages.
DEFAULT PALLET STATUS Unrestricted Deprecated - no longer used. Now held in Process Order record.
DEFAULT_LOCATION MYLOCATION Should be a valid Location Id from the locations screen and is used by the Despatch function
DESPATCH NUMBER 1 Used to determine the numeric element of the next despatch number.
DESPATCH NUMBER FORMAT XX{NNNNNN} Defines the structure of the Despatch Number. {NNN} indicates the number above. XX is a literal prefix.
EXPIRY DATE MODE BATCH Can be either BATCH or SSCC. This value should be set before go-live and not changed.
BATCH will store the Expiry Date in the Batches table using the MATERIAL/BATCH NUMBER as the key.
All production which shares the same Material and Batch will therefore have the same Expiry (Best Before End) date.
The format of the Batch Number is defined above and can include a Julian Date component so that it automatically changes at midnight.
SSCC mode will store the Expiry Date in the PALLET record and as such allow you to change the expiry date independently of the Batch Number.
HELPSET FILENAME help/helpset.hs Deprecated - no longer used. Help now linked to Wiki pages.
INTERFACE LOG ID 1 Sequential Unique ID used to record all Interface activity (Inbound and Outbound).
INTERFACE REQUEST ID 1 Sequential Unique ID used by outbound interface queue.
LABEL_HEADER_COMMENT Free Format Text Optional free format text than can appear on Finished Goods Label.
MAIL_POP_AUTH_PWD password Not currently used.
MAIL_POP_AUTH_USER user Not currently used.
MAIL_POP_HOST_NAME host.com Not currently used.
MAIL_SMTP_AUTH_PWD password SMTP password.
MAIL_SMTP_AUTH_REQD true Indicates if SMTP server requires authentication.
MAIL_SMTP_AUTH_USER user SMTP username
MAIL_SMTP_FROM_ADDRESS user@me.com Specifies SMTP sending email address.
MAIL_SMTP_HOST_NAME host.com SMTP Host Name
MAIL_SMTP_MSG_TYPE text/plain Format of mail message
MAIL_SMTP_PORT 25 SMTP Port Number
MHN INITIAL DECISION Pending Master Hold Notice default/starting decision for Pallet.
MHN NUMBER FORMAT XX{NNNNNN} Defines the structure of the Master Hold Notice Number. {NNN} indicates the numeric element. XX is a literal prefix.
PASSWORD ATTEMPTS 3 Maximum number of invalid password attempts before an account is locked out.
PASSWORD EXPIRY 30 Number of days before a users password expires and they are prompted to change it.
PLANT 1234 Deprecated - no longer used.
PROCESS ORDER NUMBER 1 Used to determine the numeric element of the next Process Order number (when created manually).
PROCESS ORDER NUMBER FORMAT {NNNNNN} Defines the structure of the Process Order Number. {NNNNNN} indicates the number above.
PROGRAM VERSION 3.63 Stores the current version of the Application. Users are warned if they attempt to connect with different version.
REPORT REQUEST ID 3.63 Used internally for queuing report requests generated by user of the web interface on RF Barcode Scanners.
RESOURCE LIST \01\02\03\04\ Delimited list of values. User can select these values when using the Process Order Barcode printing facility.
Retrieved from ‘https://wiki.commander4j.com/index.php?title=System_Keys&oldid=180’