XFM0020
For each EDI flow, you need to set up core information such as which package to run and at what time and frequency. There is also the requirement to enter directory and reporting parameters. These are configured in the XF monitor screen. There are multiple tabs to set up dependent on requirements.
XF Monitor – Setup tab
Field Name | Description | Options | Generic Value |
---|---|---|---|
Process Code ** | Uses the process code as specified in xf command/resequence and adds the company, owner and warehouse | Must have been set up in xf command and xf resequence | Defined by the client, but dependent on message flow may require a defined code. See table below. |
Process Description ** | A description of the process code | 60 character free text field | Defined by the client |
Process Id | If using EDI running processes, gives the message a unique system generated process id | No entry required – generated by the system | N/A |
Transfer Method ** | How the EDI will be transmitted | EDI or Non-EDI | EDI |
Transfer Type ** | Specifies in what format the files will be generated | EDI Transfer / FTP Transfer / Unix Transfer or N/A | EDI or FTP dependent on whether the file will be picked up from a remote server or sent to a remote server. |
Send/Receive ** | Specifies whether the file is to be received or sent (inbound or outbound) | Send or Receive | Determined by the message |
Process Type ** | This is where you specify how you want the flow to run and when. If you set the process type to interval – you will need to put in an interval time in the Interval (mins) field – in the example above, this will run every 15 minutes. If you set this to Time (24hr) – you will then be asked for which days and what time. This will cause the flow to run, say every day at 21:00 | Interval / Time (24hr) | Defined by the client |
Interval (mins)/Frequency | If set to Interval, the number of minutes before the process should start again. If set to Time, you will see a box for a time and every day of the week which can be checked to enable the run at a specific time for specific days | 0 – 999999 | Defined by the client |
Process Command ** | The package id as entered in the process code at header level | Must have been set up in xf command and xf resequence | Defined by the client |
File Retention Days | If archiving, the number of days files that will be kept | N/A | N/A |
UOM Flag (F/S 231470) | Used to allow the WMS system to work in a different UOM than the clients system. | N - No conversion required
C - Convert units to cases U - Convert cases to units R - Convert units to cases round up N - No conversion required||Defined by Client | |
EDI File Separator | Specifies what delimiters the EDI files will be using, used for configurable messages. | ’ etc | Defined by the client |
Reports Flag | Specifies whether you wish upload and exception reports to be produced | Yes / No | Defined by the client |
Process State | Shows whether the EDI message is running on a process or not | Display only – Stopped, Running or Broken | N/A |
Start Date | If you click the ‘Start Process’ button – this will display the date the process was started | Display only | N/A |
Started By | The user id of the person who has started the process running | Display only | N/A |
Next Run | Calculates the date/time the next process will run based on the last run plus the interval | Display only | N/A |
Inbound File Formats | The format of the incoming file | CSV / Fixed Length / Syspro / Attribute based XML | Defined by the client |
Element based XML | Defined by the client | N/a | N/a |
Format code | Defined by the client | N/a | N/a |
Buttons | Description |
---|---|
Force Run | Enables a ‘one off’ EDI poll |
Start Process | Begins the polling process that will trigger the message to be uploaded/sent at the relevant time. |
Stop Process | Stops the frequency/interval from running |
NB: Generic EDI flows must have a Process Code (Within XFMonitor, XFM0020) that start with the following string of characters.
Process Command Must Begin With - | Flow |
---|---|
SOP | Sales Order |
PRE_ADV | GRN Upload |
PROD_LOAD | Stock Upload |
GEN_ALLOC | Outbound Sales Order Allocation Message |
GEN_CANC | Outbound Order Cancellation Message |
GEN_PICK | Outbound Pick Message |
GEN_DESP | Outbound Despatch Message |
GEN_RCPT | Outbound General Receipt |
SADJ | Outbound Serial Number Adjustment |
HOLD_LOAD | Inbound Holds |
ORDMGT | Order Management |
NB: The process command can be any length within the screen limitation, but for i.e. sales orders the process command must be like ‘SOP’, ‘SOP1’ etc
‘1SOP’ will not be seen as a sales order upload.
XF Monitor Parameters Tab
The parameter tab controls the storage and the naming convention of the produced files. If the transfer type is set to FTP within the setup tab then the ftp control fields will be displayed.
Field Name | Description | Options | Generic Value |
---|---|---|---|
File Directory ** | This is the directory the WMS will search for the message file | This must be a valid directory set up on the Unix box | Defined by the client |
File Pattern or Template id | File pattern is used for standard EDI messages. For an increased configurable file name then select Template id. Allows for the inclusion of user definable Date/Time stamps etc within the file name format. | File Pattern or Template id | Reference XFM0030 File name construction if template id selected |
File Pattern ** | The EDI package will upload any file starting with these characters, i.e. as above, anything starting with XXADESP_ | The file pattern will be determined by the system architects who are creating the EDI files | Defined by the client |
Archive Directory ** | The directory that all processed files will move to | This must be a valid directory set up on the Unix box | Defined by the client |
FTP Parameters | |||
FTP Address ** | The I.P. address of the target server | Must be a valid I.P. address that is accessible by the WMS server. | Defined by the client |
FTP Username ** | User or account name set up on the target server | Must be a valid user id set up on the target server. | Defined by the client |
FTP Password ** | Password for user or account on target server | Valid password for the username account. | Defined by the client |
FTP Final Directory ** | Directory where files are to be sent | Valid and accessible account (i.e. permissions must be set to allow files to be copied) | Defined by the client |
FTP Put Directory | Temporary work directory on the target server | If required it must be valid and accessible. | Defined by the client |
Log File Settings Directory ** | Which directory all processed log files will be sent to | This must be a valid directory set up on the server | Defined by the client |
Log File Settings Filename ** | The name of the log file to be produced | Can be any file name the user sets up | Defined by the client |
Report Directory | Directory name and path where system produced reports will be stored | This must be a valid directory set up on the server | Defined by the client |
XF Monitor - Tracking Tab
An enquiry screen that shows the status of all files that have been processed via the XF Monitor. It also has the function to enquire on files which have failed to upload with the option to resolve errors via the relevant validation screen.
Field Name | Description | Options | Generic Value |
---|---|---|---|
Date Run | Date and Time stamp of when the process ran | Display Only | N/A |
Process ID | Unique Process identifier assigned when the EDI Process is started or ran using Force Run option. | Display Only | N/A |
Login Id | User id of the person who ran the process | Display Only | N/A |
I/O | Inbound or Outbound Indicator | Display Only | N/A |
Process Detail | Indicates whether the FTP process was called | Display Only | N/A |
Run Time m/s | The process run time in milliseconds | Display Only | N/A |
Files Processing | The number of files processed in that particular process run. | Display Only | NA |
Transient Table Successful / Failed (Inbound Only) | Indicates whether the file was successfully loaded onto the working tables ready for upload into the WMS.(Process checks the physical characteristics of the file. I.E. record length. | Display Only | N/A |
WMS Successful / Failed | Indicates whether the file was successfully loaded into the WMS. (Process checks mandatory data that is validated within the WMS, such as Owner code or Product code). | Display Only | N/A |
Buttons | |||
Control Numbers | Unique number for each file that is uploaded on to the Transient Table | Display Only – Only if the file has failed to upload onto the WMS will a control number be displayed | N/A |
Filter Data – Show Errors Only / Show all Records / Exclude empty records | All records are displayed in the Tracking Form, the Show Errors button allows for files to be filtered down | Drop down box to make required selection | N/A |
Date From | Gives the option to enter a past date for the search and retrieval of data up to the present date (system default is 7 days) | N/a | N/a |
Refresh | To initiate the search | N/a | N/a |
Errors | Button that will only be displayed if a process is highlighted which is at error. The button will call the relevant validation screen and record for resolution. | N/a | N/a |
XF Monitor - Emails Tab
Email maintenance screen, where you set up the email addresses of any users requiring reports and audit files to be emailed to them.
NB: For the successful production and emailing of reports the database and O/S on the server require the emailing function to be enabled.
Ensure the Reports tick box is enabled on the front tab and the report directories have been created and specified in the Parameters Tab.
Reports are only generated for Inbound Messages.
Field Name | Description | Options | Generic Value |
---|---|---|---|
User Id | User id of the person who ran the process as held on the WMS | Must have been set up in user maintenance | Defined by the client |
Full Names | Full Name of the recipient of the reports | Full name for information purposes | Defined by the client |
Email Address | Email address where the reports are to be sent | Valid email address | Defined by the client |
EDI Reports | Required report to be sent via Email | Report Options Include -
No EDI Rpts Audit Statistics Rpt Only Critical Errors Rpt Only Data Errors Rpt Only Audit and Critical Errors Rpt Audit and Data Errors Rpt Critical and Data Errors Rpt All Three Rpts||Defined by the client |
In Addition to the above configuration the system requires additional parameters to be set at server level.
Within System Registry / Global / GeneralSettings the following values must be entered with the relevant data values.
- AppServerConnectString = sce/password@database name
- AppServerFloc = /u02/oraapp/xxx/xxxdev/forms
- AppServerPort = 7777
- AppServerHost = 10.43.0.70 or 127.0.0.1
- AppServerReportServer = repxxxdev
- DefaultDirectory = /tmp
XF Monitor - Reports Tab
Report parameter maintenance screen to specify what kind of reports are to be produced by the system if required and where they are to be sent to.
NB Reports are only generated for inbound messages.
Field Name | Description | Options | Generic Value |
---|---|---|---|
Process Audit Report Settings | |||
Transfer Type | Option to specify how and where the reports are to be sent. Depending on the option selected additional information will be prompted for. | FTP
N/A Printer Unix File |
Defined by the client |
Process Error Report Settings | |||
Transfer Type | Option to specify how and where the reports are to be sent. Depending on the option selected additional information will be prompted for. | FTP
N/A Printer Unix File |
Defined by the client |