Settings for Item Data Interface

This document explains how you define settings for the item data interface.

Outcome

The item data interface provides a solution in which item data can be exchanged and enriched between M3 Business Engine and other applications or third-party products.

You can receive, use, and import items in M3 through the item data interface.

You can also perform changes and log changes for already imported items in the item import function.

For more details, see the API Repository in M3 API Tools.

Before you start

No prerequisites are needed.

Follow these steps

Basic Settings

Note: These settings are required.
  1. These basic settings are required:

    1. Start 'Item Type. Open' (CRS040). Select the item type to be used in the item data interface. On the E-panel, select the 'Item interface controlled' field. For more information about the item type, see Creating Items in Different Ways

    2. Start 'Stock Msg Partner. Open' (MMS865). Enter Message direction with I=Inbound messages. Specify a partner. Open the E-panel.

    3. Start 'Stock Msg Partner. Open' (MMS865). Here you define external systems to M3.

    4. On the B-panel, enter the message direction as I=Inbound messages. Specify a partner. Open the E-panel.

    5. Open the E-panel. Two mandatory fields are displayed: '300 Partner manager' is the person responsible for the record, and '320 Default item type' is used if no other item type is entered when you create an interface item from APIs or manually.

      The F-panel is only for outbound messages.

    6. Display the (MMS865/B) panel again. Option 12='Mail parameter' starts 'Stock Message Partner. Connect Msg Types' (MMS867). Activate the message types that should be sent for the defined external system (partner). You can also create standard messages by selecting F14=Create standard. This parameter is not used in IDI.

  2. These settings for Item Import are optional:

    1. Start 'Settings – Item Import' (MHS262). Select Partner (external system) and select the item type.

      If you do not select an item type, the setting will be valid for all item types when used in combination with the selected partner/message type.

      Option 24=Delete change log deletes the processed change log records (status 15 or 20) (MHS262CL).

    2. Open the E-panel and select the alternative in the 'Limit item/warehouse creation' field.

    3. If you will import an Interface – SKU, select alternative in the 'Limit item/warehouse creation – SKU' field.

    4. Specify the number of days when the processed change log records will be saved before they are automatically deleted.

  3. These settings are used for Change Log Control.

    Changes made to the fields that are selected for logging must be approved before they can be imported to M3. If a field is selected, any change completed through the MI program will be stored in the change log (MHS210).

    If the field is selected from the field group, changes to this field should be written to the change log.

    If the field is not selected from the field group, changes should not be written to the change log.

    1. On the (MHS262/E) panel, press F4 in the 'Change log control' field. This starts 'Interface Item Field Control. Open' (MHS263).

      Only records with control type 2=Change log control, are displayed.

    2. Enter 2 as the control type, and enter a control ID. Open the E-panel and provide a description. Display the B-panel again.

    3. Select Option 11='Control settings'. This starts 'Interface Item. Select Control Fields' (MHS264).

    4. Press F4 in the 'Field' field. You can now select a field that you want to be logged.

      The field group is ITIC2 (CRS109).

    5. When you have selected the fields to be logged, press Close. (MHS263) is displayed again.

    6. Select option 1 = Select for the created record. You return to the (MHS262/E) panel.

    7. Press Next to complete the settings.

  4. These settings are used for Import Control.

    Item import control defines how the value zero (blank) should be managed in different fields when you import an item that has already been imported.

    If the field is selected from the field group, the value from the interface item should be used even if it is zero.

    If the field is not selected from the field group, the value zero should be considered as 'No input.' Use the template item value.

    For all values other than zero, a value from the interface item always overrides a value from the template item.

    1. On the (MHS262/E) panel, press F4 in the 'Item import control' field. This starts 'Interface Item Field Control. Open' (MHS263).

      Only records with control type 1=Item import control, are displayed.

    2. Enter 1 as the control type, and enter a control ID. Open the E-panel and provide a description. Display the B-panel again.

    3. Select Option 11='Control settings'. This starts 'Interface Item. Select Control Fields' (MHS264).

    4. Press F4 in the 'Field' field. You can now select a field that you want to be included in the item import.

      The field group is ITIC2 (CRS109).

    5. When you have selected the fields to be included, press Close. (MHS263) is displayed again.

    6. Close (MHS263). Return to the (MHS262/E) panel. Select the control ID that you created in the 'Item import control' field.

    7. Press Next to complete the settings.

  5. These settings are used for Warehouse Selection Table.

    A warehouse selection table is used to define selection criteria for each warehouse indicating what should be imported and what should not be imported to M3.

    The warehouse selection table can be specified for each:

    • Interface item
    • Partner/Message type/Item type
    • Partner/Message type
    1. On the (MHS262/E) panel, press F4 in the 'Warehouse table' field. This starts 'Warehouse Selection Table. Open' (MMS033). Set the panel sequence to E,1.

    2. Enter a table ID on the (MMS033/B) panel and open the E-panel. Provide a description and press Enter. This starts 'Warehouse Selection Table. Select Fields' (MMS034).

    3. Press F4 in the 'Field' field and select a field (field group MMWH1).

    4. Select the range (from/to) for the field and specify if the field should be included or excluded in the warehouse search.

    5. Close (MMS034) and return to (MHS262/E). Select the warehouse table that you have created.

    6. Press Next to complete the settings.

Parameters to set

Program ID/ Panel Field The field indicates …
(CRS040/E) Item interface controlled

Select the check box if items with this item type should be possible to control through the item interface.

If you do not select the check box, items cannot be controlled or imported through the item interface.

(MMS865/B) Message direction

… the direction of the message.

The valid alternatives are:

I = Inbound

O = Outbound.

(MMS865/B) Partner … the ID an external partner, for example with the internal number of the customer.
(MMS865/B) Message type

… the message type, which should contain the name of the standard message to be processed.

Examples:

EDIFACT messages: ORDERS ORDRSP, etc.

ODETTE messages: DELINS AVIEXP, etc.

(MMS865/E) 300 Partner manager

… a unique user ID.

The ID is used for selection and sorting.

(MMS865/E) 305 Override mail receiver This one is not used in IDI

… whether overriding of an entered mail recipient is allowed.

The valid alternatives are:

0 = No, mail recipient will not be overridden.

1 = Yes, mail recipient will be overridden using a value in (RSS015/310).

(MMS865/E) Filing Not used in IDI

… whether the message should be archived.

The valid alternatives are:

0 = No

1 = Yes. This field is only valid for upload messages (MMS850) and (MHS850).

(MMS865/E) Days before archive/deletion Not used in IDI

… the number of days after a received and executed inventory transaction that a message is archived. When a message is archived, it is removed from production files and stored in an archiving file.

This field is only valid for upload messages (MHS850) and (MMS850).

(MHS262/B) Partner … the ID of an external partner or an external system, for example with the internal number of the customer.
(MHS262/E) Change log control

…the fields selected to be logged must be approved before they can be imported to M3. If the field is selected, any change made through the MI program will be stored in the change log (MHS210).

If the field is selected from the field group, the record should be written to the change log.

If the field is not selected from the field group, the record should not be written to the change log.

(MHS262/E) Item import control

Item import control defines how the value zero (blank) should be managed in different fields when you import an item that has already been imported.

If the field is selected from the field group, the value from the interface item should be used even if it is zero.

If the field is not selected from the field group, the value zero should be considered as 'No input.' Use the template item value.

For all values other than zero, a value from the interface item always overrides a value from the template item.

(MHS262/E) Warehouse table

Changes in this help text: See below (MMS033).

The warehouse selection table is used to define selection criteria for each warehouse, indicating what should be imported and what should not be imported to M3.

The warehouse selection table can be specified for each:

  • Partner/Message type/Item type
  • Partner/Message type
  • Partner.
(MHS262/E) Limit item/warehouse creation

…whether to limit the creation of item or warehouse records to only certain warehouses when importing an interface item to BE, even if the item type and template item include more warehouses.

Alternatives:

0 = No, create item/warehouse records for all warehouses according to the item type (MWS042).

1 = Yes, limit the creation of item/warehouse records to the warehouses where a record in (MHS002) exists. Disregard any entered warehouse selection table.

2 = Yes, limit the creation of item/warehouse records to the warehouses selected in a warehouse selection table entered in (MHS001) or (MHS262).

Note: Regardless of the method chosen, any entered values in (MHS002) are used if a record with matching warehouse (or a blank warehouse) exists.
(MHS262/E) Limit item/warehouse creation - SKU

…whether to limit the creation of item or warehouse records to only certain warehouses when you import an interface SKU to M3 BE, even if the item type and template item include more warehouses.

This field, in addition to 'Limit item/warehouse creation', is used to enable different settings for SKUs (configuration code 7) than for the styles (configuration code 6) or any other items.

One typical scenario is when the style should be created in all warehouses, or a specific selection of warehouses, while the SKUs should only be created for a limited number of those warehouses.

Alternatives:

0 = No, create item/warehouse records for all warehouses according to the item type (MWS042).

1 = Yes, limit the creation of item/warehouse records to the warehouses where a record in (MHS002) exists. Disregard any entered warehouse selection table.

2 = Yes, limit the creation of item/warehouse records to the warehouses selected in a warehouse selection table entered in (MHS001) or (MHS262)

Note:  Regardless of the method chosen, any entered values in (MHS002) are used if a record with a matching warehouse (or a blank warehouse) exists.
(MHS262/E) The number of days ...the number of days the processed change log records (status 15 or 20) will be saved before they are deleted.
(MHS263/B) Control type

... the type of field control settings.

Alternatives:

1=Import control

2=Change log control

(MHS263/B) Control ID … the ID of a field control setting. A field control setting can have different control types (see Control type).
(MHS264/B) Field

…the ID of the field that is controlled.

If the control type is 1 (Import control)

If the field is selected from the field group, the value from the interface item should be used even if it is zero.

If the field is not selected from the field group, the value zero should be considered as 'No input.' Use the template item value.

Note:  For all values other than zero, a value from the interface item always overrides a value from the template item.

If the control type is 2 (Change log control)

If the field is selected from the field group, the record should be written to the change log.

If the field is not selected from the field group, the record should not be written to the change log.

(MMS033/B) Warehouse table

The warehouse selection table is used to define selection criteria for each warehouse. The resulting warehouse selection determines for which warehouses to create item or warehouse records when importing interface items to BE. Entering a warehouse selection table only has effect in combination with 'Limit item/warehouse creation' = 2

The warehouse selection table can be specified for each:

  • Interface item
  • Partner/Message type/Item type
  • Partner/Message type
  • Partner.

If several settings exist, the priority is as listed above.

(MMS034/B) From value ...the From value for the specified object.
(MMS034/B) To value the To value for the specified object.
(MMS034/B) Include/exclude object value

Select the check box to exclude the specified selection from valid balance identities.

If you do not select the check box, the specified selection from valid balance identities are included.

Note:  You can exclude all identities if the selections are used incorrectly but it is not possible to choose include and exclude if you have the same object parameter.
Related topics