×
Menu

Command Line Processing

 

Command Line Help

 
Help can be accessed on the command line by using the -h param:-
 
gemma.exe -h
 
 
 

Submitting Manifests

 
There are three required parameters:
 
Parameters
Definition
Example
\Manifests=<path>
Path containing manifests to be submitted
\Manifests=C:\GeMMA\Manifests
\Completed=<path>
Path to output successfully submitted manifest logs
\Completed=C:\GeMMA\Completed
\Failed=<path>
Path to output unsuccessfully submitted manifest logs
\Failed=C:\GeMMA\Failed
 
 
There are three optional parameters:
 
Parameters
Definition
Example
Defaults
\Reports=<path>
Copies the submitted manifest report to the defined path
\Reports=C:\GeMMA\Reports
 
\HandOverDate=CCYYMMDD
Sets an explicit Handover Date to be used for eMHS Submissions
\HandOverDate=20161208
The default behavior if this parameter is not used is to apply a Handover Date according to the Handover Date Control including any Network Access logic.
\Confirm=Yes|No
Yes = Automatically confirms a manifest after being submitted
\Confirm=Yes
The default behavior if this parameter is not used is No. Do not automatically confirm a manifest after being submitted.
 
 

Usage Examples:-

 

Submit all manifests found in the manifests path. The handover date will be set automatically by the Handover Date Control.

 
gemma.exe "\Manifests=C:\GeMMA\Manifests" "\Completed=C:\GeMMA\Completed" "\Failed=C:\GeMMA\Failed"
 

Submit all manifests found in the manifests path and create a copy of the submmission report in the reports path. The handover date will be set automatically by the Handover Date Control.

 
gemma.exe "\Manifests=C:\GeMMA\Manifests" "\Completed=C:\GeMMA\Completed" "\Failed=C:\GeMMA\Failed" "\Reports=C:\GeMMA\Reports"
 

Submit all manifests found in the manifests path with an explicit handover date and confirm the manifests.

gemma.exe "\Manifests=C:\GeMMA\Manifests" "\Completed=C:\GeMMA\Completed" "\Failed=C:\GeMMA\Failed" "\HandoverDate=20161208" "\Confirm=Yes"
 

Logs

 
A log file is produced for each individual manifest. The log contains details pertaining to the successful (completed) or unsuccessful (failed) submission and are output to the Completed or Failed path depending on the submission status.
 
 

Confirming Manifests

 
This method can be used to confirm an eManifest that has already been submitted to Royal Mail.
 
There are two required parameters:
 
Parameters
Definition
Example
\SCID=
Enter a valid SCID
\SCID=1234567
\HandOverDate=
Enter a valid HandOverDate
\HandOverDate=20190321
 

Usage Examples:-

 
Confirm an eManifest that has been submitted to RM with and SCID of 1234567 and a Handover Date of 21st March 2019.
gemma.exe \SCID=12345678 \HandOverDate=20190321
 
 

Return Codes

 
A Return Code is used to show the status at the end of each submission and is output to the log file.
 
Return Codes
Definition
0
Uploads Completed Successfully
-1
Carrier not specified (retired - no longer in use)
-2
No Manifests found in defined manifests folder
-3
Licence has expired
-4
Licence is invalid
-5
Licence not found
-6
No UK Mail Login Details found
-7
No Royal Mail Login Details found
-8
Another instance of GeMMA is already running
-9
GeMMA Central is running
-10
Folder Structure Invalid
-11
Schema not found in Application Folder
-12
Database not found in Database Folder
-13
Incorrect Database Version
-14
Database Structure Invalid
-15
Unable to retrieve Active Supply Chains from eMHS Server
-16
Invalid Parameter
-17
Defined Manifest Folder does not exist
-18
Unable to create defined Completed Folder
-19
Unable to create defined Failed Folder
-20
One or More Uploads Failed
-21
Must Update GeMMA
-22
Cannot connect to UK Mail
-23
Invalid Handover Date
-24
Reports folder does not exist
-25
Not Licensed
-26
Not Licensed for Carrier
-27
Error Reading Config
-28
No Free Leases
-29
Internet Error
-30
No Grace Days
-31
Invalid SCID
-32
SCID Requires Handover Date and No other options
-33
No eManifest Found
-34
eManifest Confirmation Failed