erpworks-im-config.yml

Item master configuration file

This configuration file contains options for the item master form and item master automatic notifications (distribution lists).

Primary Fields

This option contains a list of field configurations for the item master form. Unless you know what you are doing, you should not add or remove items from this list, but reordering them and modifying most fields (other than Database Column Name) is perfectly fine.

Example

Primary Fields:
  - Display Name: Planning Type
    Database Column Name: IM_PLAN_SW
    Options:
      Planned: 1
      Unplanned: 0
    Default: Planned
    Parent Default: Unplanned

  - Display Name: Classification
    # ...

Display Name

Text that will label the field in ERPWorks.

Database Column Name

Must be one of:

  • IM_PLANNER
  • IM_GL_ACCT
  • IM_PLAN_SW
  • IM_TYPE
  • IM_CLASS

Options

A set of values that this field can contain. The format is Display Name: Inserted Value for each option.

Default

The default selected option’s display name, as specified in Options. This option applies to new item masters for child items.

Parent Default

The default selected option’s display name, as specified in Options. This option applies only to new item masters for the parent item.

Distribution Lists

Distribution lists are lists of email addresses and accompanying options that will be automatically sent messages when item masters are created or product structures are changed. Update messages are filtered by the fields in an item master. For example, you could define a distribution list for item masters where the Classification field is Regular, in which case only item masters matching that criterion would be included in update messages to that distribution list. ERPWorks will attempt to use the locally installed Outlook application to send emails. If it cannot (e.g. if Outlook is not installed), it will attempt to invoke the default email handler.

Example

Distribution Lists:
  - Name: Planner/Buyer 4 Updated Item Masters
    Field: Planner/Buyer
    Value: 4
    Trigger: Update
    Addresses:
      - test1@example.com
      - test2@example.com
    Email Subject Template: "Updated Item Master - Parent Item ID {ParentItemId} or Lower Level Children"
    Email Body Template: >
      There are updated item masters that may require your attention.

      {List}

  - Name: Planner/Buyer 2 New Item Masters
    # ...

Name

The name of the distribution list that ERPWorks will use in the user interface.

Field

What is the filter field for this distribution list? This field, paired with the Value field, provide a simple filter so that you can configure different email addresses to be alerted to different types of item masters.

Value

What is the filter value for this distribution list? This distribution list can only be invoked if the value of the item master field specified in the Field option matches the contents of this field.

Trigger

When can this distribution list be notified? This field can be one of two values:

Trigger Type Function
Create ERPWorks will automatically send notifications to this distribution list whenever a new item master is created that matches the filter.
Update ERPWorks will send notifications to this distribution list only when:
  1. The product structure is updated, or a new item master is created, and
  2. The “Send Update Notifications” checkbox (on the main interface) is checked.

Addresses

The actual list of email addresses.

Email Subject Template

What will the subject of the email notifications be?

This field may contain the following replaced values:

  • {ParentItemId} Replaced with the parent item’s ID
  • {ParentItemDesc} Replaced with the parent item’s description

Email Body Template

What will the body of the email notifications be?

This field may contain the following replaced values:

  • {ParentItemId} Replaced with the parent item’s ID
  • {ParentItemDesc} Replaced with the parent item’s description
  • {List} Replaced with the list of changes that triggered this notification

Outlook Account

What Outlook account should ERPWorks use to send notifications? If this field is blank or the account associated with the email address in this field cannot be found, ERPWorks will fall back to using the local computer’s default mailto handler.

Example

Outlook Account: email@example.com

Auto Population

Set up autofilling item master field values. Note that these triggers are not invoked when the form is first loaded, only when changing the trigger field value. This is because the defaults specified when declaring the field (described in the Primary Fields section above) take precedence over the auto population configuration.

Example

Auto Population:
 - Trigger Field: Planner/Buyer
   Cases:
    - Trigger Value: 1
      Affected Values:
       Planning Type: Unplanned
       Item Type: Fab/Asm
       Classification: ASM

    - Trigger Value: 2
      Affected Values:
       Planning Type: Planned
       Item Type: Purchased
       Classification: Regular

    - Trigger Value: 3
      Affected Values:
       Planning Type: Planned
       Item Type: Purchased
       Classification: Regular

    - Trigger Value: 4
      Affected Values:
       Planning Type: Planned
       Item Type: Fab/Asm
       Classification: Make to Stock

Trigger Field

The display name (as specified in the Primary Fields section above) of the field on which we should wait for changes.

Cases

Different autofill options for each value of the trigger field.

Trigger Value

The value of the trigger field that triggers this autofill case.

Affected Values

A set of entries describing which other fields are changed when this case is triggered. The format is Field Display Name: Value Display Name.

Last modified May 19, 2020