Settings for Event Based Document Control

This document explains how you define the settings for Event Based Document Control (EDC).

Note: This document does not explain the specific settings for TEI (Transportation Execution Interface) which use the EDC functionality for creating documents.

Outcome

An allowed document is produced when a given event occurs. The document media is defined (printed, sent by mail etc) and also if the document should be produced immediately (synchronous) or sent to a queue and produced later, via an auto start job (asynchronous).

Defining settings for Event Based Document Control (EDC) updates the following:

  • CREVNT – Document Events

    This file contains a list of the events to which documents can be attached for automatic creation and printing.

  • MDOCEV – Event Controlled Documents

    This file is used to define that when a given event occurs, and the context matches the stored object values, the defined list of documents/variants will be produced according to the corresponding media definition.

  • MDOCEO - Documents to produce for an Event Occurrence

    This file will store all data needed to produce any of the triggered documents for a given event occurrence, when the document is to be produced synchronously.

EDC is used in the dispatch flow to produce:

  • Picking list
  • Address label
  • Package label
  • Delivery note
  • Dispatch advice
  • Loading list
  • Unloading list

Before you start

  • The settings for the dispatch flow must have been defined. The settings and values depend on how the dispatch flow should be executed. Dispatch descriptions, instructions, settings and references to other documents is found in Dispatch Handling.
  • The documents to be used must be defined in 'M3 Document. Open' (CRS928) and in 'Standard Document. Open' (CRS027). See more in Manage Delivery Documents and Labels.
  • The Object control parameter records, on the (CMS016/B) panel, must be generated so all available objects are displayed. Press F14=Generate data.
  • The Field groups must be generated for applicable fields in (CRS108) and (CRS109). Press F14=Generate data.
  • If using the SHIPMENT_ISSUED event, you must have the auto start jobs 'DRS900 – Monitoring Shipment' and 'DRS901 – Process Shipment Time Triggers'. If sending documents to a queue and get produced later, via an auto start job (asynchronous), you must have the auto start job 'MWS974 –Manage Event Based Documents' running.
  • The process enables you to send document output via different kinds of media, such as a printer, e-mail, fax or electronic data interchange (EDI).

Follow these steps

Create an object control table

  1. Start 'Available Object Control Parameters. Open' (CMS016). Select SCE Event Document and select option 11=Object table detailed lines.

  2. 'Generic Object Control Table. Open' (CMS017/B) is started.

    Set the 'Panel sequence' field to E (T) 1.

  3. Enter (MWS145) and select 'Create'.

  4. On the (CMS017/E) panel enter:

    • If sending documents to a queue and get produced later, via an auto start job (asynchronous), you must have the auto start job 'MWS974 –Manage Event Based Documents' running. Select event
    • Select sequence no. If you leave this field blank, the system takes the next higher number.
    • Set to Status 20 - Active
    • Priorities from 0 to 9 in the Priority fields.

      By default, sequence 10 corresponds to priority 0, 20 to priority 1 and so on up to sequence 100, which corresponds to priority 9.

    • The 'Field 1(2, 3 and 4)' fields with the selected fields from the field group (EVT01=Release pick, EVT02=Delivery issued, EVT03=Shipment issued). Press F4 to select valid fields.
  5. Select fields and redisplay (CMS017/E).

  6. Press Enter until you start 'Delivery Process Document Control. Open' (MWS145).

Create values for the object control table

  1. You must define values for the defined control fields. You must repeat this for each priority. To the right on the 'Priority' field you can see all priorities defined for this event/sequence no.

  2. On the (MWS145/B) panel, define values for the fields.

  3. The 'Value 1, (2, 3 and 4)' fields are the first, second, third and fourth values to be compared with the contents of a control object.

  4. Fill in the 'From date' field.

    Note: F15=Delete old, can be used on the B panel to remove all expired document triggers.
  5. On the (MWS145/E) panel, fill in the following fields:

    • To date - The document trigger applies up to and including this date.
    • Send to ASJ - Select the check box to produce the documents asynchronously (via auto start job).

      If producing documents via ASJ, then you need to have the ASJ (MWS974) running.

    • Check CSFDEF - whether a check should be made that the output controls for each document are valid when retrieving each document trigger. I they are not valid, a M3 mail message is sent to the responsible person, defined in the 'Responsible' field.
  6. See descriptions in the parameter list for Doc number, Doc variant, doc name.

  7. Printer file, Work station and User settings

    This combination points to one or more entries in 'Output Media Selection. Open' (MNS205).

Controlling pick lists

  • (MWS010) - Picking lists can only be produced via EDC if the auto-level of the relevant dispatch policies is 3=Issue made automatically when picking list reported.
  • (MMS040) - The media control settings work for pick-lists ONLY if the Printer field on all relevant stock zones is left blank.
  • (MWS010) - Using this functionality it is possible to have more than one pick list variant used for the same dispatch policy. It is recommended that you have parameter 100 – 'Auto print of pick lists' (MWS010) switched off in all relevant dispatch policies; otherwise there is a danger of producing twice.
  • (MWS010) – Parameter '120 Document variant'. Document variant 50 and 60 have been introduced for picking lists:

    50 – Pick list download

    60 – As for variant <blank> but with showing unallocated lines.

    You could trigger more than one variant at the same time. For example, you might want to produce both the download and a printed pick list.

  • (MWS420) - It is possible to produce a copy of a pick-list with a different variant than that set for the document trigger by going to (MWS420), then take option 27=Plan pickers. Change the document variant (and set a printer ID if you need to) in (MWS415/E), return to (MWS420) and then take option 66=Print copy for the pick list.
  • (MWS415) - Note that if reprinting pick lists (from MWS420) you may need to set the printer in (MWS415/E). The reason for this is that the document event trigger media setting will not be used; rather, normal media controls will be used.
  • If controlling all pick list output via stock zone (the printer set in (MMS040)) that will be OK, but if printer is blank in (MMS040) (that is., you are relying on (MNS204)/(MNS205) settings) then the media control could be different. The USID/DEVD used will be the ones for your current session rather than the ones that may have originally been used based on the trigger in (MWS145/E).

Use of the SHIPMENT_ISSUED event

To determine that a shipment is fully issued requires two criteria to be fulfilled.

  • Firstly, all deliveries that are connected to the shipment need to have been completed. This can be seen by looking at the high/low status for the shipment, which should be 60/60=Shipment reported.
  • Secondly, the shipment must not be available for more deliveries to be added to it (since this might change the status of first criteria). The second criterion is fulfilled when the deadline date/time to be passed. You can see when this has occurred (and the ASJ has recognized it) by looking at the 'Manual connect only' field on the shipment (DRS100/E, field DAMANC) which will have a value of 2=Manual (ASJ), after the ASJ has processed the shipment.

Same event issued twice

It is possible that the same event could occur twice. The most likely instance of this is the "RELEASE_PICK" event. This could occur, for example, when a delivery has closing point 1= Close when all picking lists are delivered, (MWS010/G, the 'Closing point' field). If this is the case, the delivery stays open (for new delivery lines to be added) even after the "RELEASE_PICK" event occurs.

For this reason, the "RELEASE_PICK" event is triggered for the range of suffixes that was released rather than for the whole delivery. Documents are then only triggered (where possible) for that range of suffixes.

There is a risk that package related documents could be produced more than once in the above case. The reason for this is that goods from the newly released range of suffixes could be auto-packed into the same packages as were used for a range of suffixes that were released earlier.

Debug messages can be displayed in the server view

Some debug messages are issued to the server view. These enable you to see:

  • what events have occurred for a given entity
  • which document triggers have been found and executed
  • which document have been produced

Examples of these are found below:

  • 050705 030624 2132 D Event RELEASE_PICK has been triggered for shipment, delivery 2502942, picking list 1 to 1
  • 050705 030624 2132 D Document trigger activated for priority 1, event RELEASE_PICK , sequence 0, key: obj1=005 , obj2=04 , obj3= , obj4=
  • 050705 030625 2132 D Document 120 variant 60 produced via EDC for userid GRAPAU0
  • 050705 030627 2132 D Document 912 variant 01 produced via EDC for userid GRAPAU0

Parameters to set

Basic settings for pick lists

Program ID/ Panel

Field

The field indicates …

(MWS010/B)

Auto level

… the auto level, which mainly regulates when the stock issues are made

Picking lists can only be produced via EDC if the auto-level of the relevant dispatch policies is 3=Issue made automatically when picking list reported.

(MWS010/E)

Auto print of pick lists

… whether picking lists are printed automatically when they are created.

It is recommended that you have parameter 100 – 'Auto print of pick lists' (MWS010) switched off in all relevant dispatch policies; otherwise there is a danger of producing twice

(MWS010/E)

Document variant

… the document variant used when a picking list is printed.

Document variant 50 and 60 have been introduced for picking lists:

50 – Pick list download

60 – As for variant <blank> but with showing unallocated lines.

You could trigger more than one variant at the same time. For example, you might want to produce both the download and a printed pick list.

(MMS040/E)

Printer

… the printer on which the printout should be printed. The media control settings work for pick-lists ONLY if the Printer field on all relevant stock zones is left blank.

If controlling all pick list output via stock zone (the printer set in (MMS040)) that will be OK, but if printer is blank in (MMS040) (i.e., you are relying on (MNS204)/(MNS205) settings) then the media control could be different. The USID/DEVD used will be the ones for your current session rather than the ones that may have originally been used based on the trigger in (MWS145/E).

Settings for specifying the objects to control the document output

Program ID/ Panel

Field

The field indicates …

(CMS016/B)

Object control parameter

... the available object control parameter, where you can define your objects and values.

Select SCE Event Documents - (MWS145).

These values are generated automatically when you first enter (CMS016) for the installation. If you have upgraded (CMS016) you may need to press F14 to create any new values.

(CMS017/B)

View

... the view.

Views are user-defined, and determine what fields are to be displayed as well as how the data is to be calculated. They are defined in (CRS020). See .

(CMS017/B)

Program name

… the program that is used for the object control table. In this case it is (MWS145).

(CMS017/B)

Event/Start value 1

... an event, which is a defined point in time when a M3 entity (such as a delivery) reaches a certain status. They are specified in Event. Open (CRS019).

By using the event-controlled document functionality, it is possible to have certain documents automatically produced when one of these defined events occurs.

Examples:

DELIVERY_ISSUED

This event occurs when the status of a delivery becomes greater than or equal to 60.

RELEASE_PICK

This event occurs when a picking list or group of picking lists is created after a delivery is released for picking.

Note: This event may occur more than once depending on the closing point of the delivery. The event applies to picking lists that attain a status of 40 or greater for the first time. This means that the event is deemed to have occurred for picking lists going through pick resource planning only after release from pick resource planning.

SHIPMENT_ISSUED

This event occurs when a shipment is in status 60/60=Shipment reported, AND the shipment deadline has passed; that is, when all deliveries within the shipment are fully issued and no more deliveries may be automatically added to the shipment.

Note: The SHIPMENT_ISSUED event requires that the auto start jobs (ASJ) (DRS900) and (DRS901) are running.

(CMS017/E)

Sequence no/Start value 2

... the sequence number.

The sequence number allows you to specify different sets of controlling objects for the same event. You might, for example, want to control pick lists with one set of objects and address labels with another.

If you don't specify a sequence number, one will be selected for you automatically. The system will take the next higher number for the event.

(CMS017/E)

Status

… the status for the object control setting.

10 = Preliminary

20 = Definite

90 = Blocked/expired.

Only status 20 is used in the dispatch flow.

(CMS017/E)

Field sequence no

… the order in which each information field should be displayed.

Example:

To move an object control line from priority 2 to 1, assign the sequence number for the line a number between 11 and 19. Press ENTER. The line is then placed in the correct order.

(CMS017/E)

Priority

… a priority for the selected fields.

The object lookup is always performed in priority order. If no qualified objects are found according to priority one, M3 will try to find matching objects according to priority two, etc.

(CMS017/E)

Field 1, 2 ,3 ,4

… a field or data element from a specific file.

It is used to create keys or search paths for user defined tables and also to create the contents of user defined files.

Note: These fields will be protected if entries are found in (MWS145). That means that you cannot enter these fields if they are 'in use'.

(CRS109/B)

Field group

… a grouping of several fields from different files that regulate matrix entries. In this case, the EVT01/2/3 field group will be selected.

Field groups are system-defined and cannot be changed.

Settings for which documents should be produced and how (through ASJ or immediately)

Program ID/ Panel

Field

The field indicates …

(MWS145/B)

Priority

… the table priority from the table in (CMS017). When searching after document event triggers, object value entries are searched in priority sequence, from 0 to 9, until a matching set of object values is found.

All available priorities are displayed to the right and are separated with a slash, such as 1/2/5.

(MWS145/B)

Value 1, 2, 3, 4

These are the values that must match for the given event to cause the documents specified in the corresponding (MWS145/E) panel to be produced.

Example: A setting is made here for event RELEASE_PICK. If the control objects are warehouse and stock zone, and the values stated here are 001 and AA, then the warehouse and stock zone for the picking list must be 001/AA for the documents in the corresponding (MWS145/E) panel to be produced.

Example: Start value 1 could be Warehouse (OQWHLO). Select a warehouse by pressing F4=Prompt.

Start value 2 could be stock zone (PISLTP). Select a stock zone by pressing F4.

(MWS145/B)

From date

… the date from which the document trigger will be active.

(MWS145/E)

To date

… the valid to date. The document trigger applies up to and including this date.

(MWS145/E)

Send to ASJ

whether the production of the specified documents for this event trigger will be produced synchronously or asynchronously.

If the documents are to be produced asynchronously, then the task is sent to an auto-start job (batch job). Otherwise, the print program is started and the flow must wait for the print program to finish.

Select the check box to produce the documents asynchronously (via auto start job).

(MWS145/E)

Check CSFDEF

…whether a check should be made that the output controls for each document are valid when retrieving each document trigger.

The check made is that at least one output media selection entry exists in (MNS205) for this key. If no such entry exists, a message is sent to the M3 mailbox for the person who is responsible, as indicated in the trigger definition (MWS145/E).

Select the check box if a check should be made.

(MWS145/E)

Responsible

… a unique user ID.

The person responsible entered here will receive any M3 Mail for errors related to this document trigger.

(MWS145/E)

Doc number

Doc variant

Doc name

… the Document number and document variant together determines a specific variant/type of document.

Only documents defined for the event in (CRS019) may be used.

The following documents are valid in EDC:

RELEASE_PICK: Picking list (120), Address labels (913), Package labels (912)

DELIVERY_ISSUED: Delivery Note (900), Dispatch Advice (901), Address labels (913), Package labels (912)

SHIPMENT_ISSUED: Loading list (909/00), Unloading list (909/01), Dispatch Advice (901), Delivery Note (900)

(MWS145/E)

Printer file

Work station

User

… the combination of printer file, work station and user.

This combination points to one or more entries in 'Output Media Selection. Open' (MNS205).

When the connected document is produced, it will use this (or these) output services and media type(s).

Note: For picking lists, the media control entered here is only used if the printer specified for all relevant stock zones is set to blank.

(MWS145/E)

Log level

… the log level.

If this check box is selected, then delivery documents produced via event-controlled documents functionality will update delivery document history and be visible in the connected delivery documents sorting order (MWS260).

Select the check box to update delivery document history.

This is only valid for certain documents.

Media control settings for the documents

The process enables you to send document output via different kinds of media, such as a printer, e-mail, fax or electronic data interchange (EDI).