Show TOC

Background documentationReplaceable Parameters Locate this document in the navigation structure

 

Replaceable parameters are variables that you can use in the system.

You create a replaceable parameter by surrounding the uppercase name of an element with percentage signs (%):

%FIELD_NAME%

When the system reads the percentage signs (%), it replaces the field name with the value of the field.

The following table describes replaceable parameters you can use as prefixes and suffixes to create a numbering pattern in Next Number Maintenance (see Next Number Maintenance):

Replaceable Parameters for Use in Next Number Maintenance

Replaceable Parameter

System Value

%ACTIVITY%

The ID or the activity that released the SFC number

%DATE_TIME.[timepatternstring]%

The date and time the SFC number was acted upon (released, nonconformed, and so on), in the form and format specified by timepatternstring

For example: On January 2, 2010, %DATE_TIME.[yddd]% generates 10002.

%ITEM_BO.(1)%

The site where the material is being released

%ITEM_BO.(2)%

The material being released

%ITEM_GROUP_BO.(1)%

The site where the material group of the material being released is produced

%ITEM_GROUP_BO.(2)%

The material group for the material being released

%ONEDIGITYEAR%

The last digit of the current year

%WEEKOFYEAR%

The current week of the current year

For example: On January 19, 2010, %WEEKOFYEAR% generates week 4.

%PARENT_SHOP_ORDER_BO.(1)%

The site of the shop order's immediate parent

%PARENT_SHOP_ORDER_BO.(2)%

The shop order's immediate parent

%PRIORITY%

The priority of the shop order

%SHOP_ORDER_BO.(2)%

The shop order of the SFC number

%SFC_BO.(2)%

The original SFC number

Note that this parameter is used when the system generates serialized SFC numbers.

%SITE%

The site at which the release is taking place

%USER_BO.(1)%

The site of the user ID of the person performing the action

%USER_BO.(2)%

The user ID of the person performing the action (release, logging of the nonconformance, and so on)

Caution Caution

When using replaceable parameters that contain numbers such as %USER_BO.(2)%, do not change the number; otherwise, the system may produce unpredictable results.

End of the caution.

The following table describes common replaceable parameters you can use with messages:

Common Replaceable Parameters for Use with Messages

Replaceable Parameter

System Value

%.ALL.%

All available information for the message

%BODY%

The text provided by the application that creates the message

%BUY_OFF_ID%

The buyoff associated with the message

%CREATED_DATE_TIME%

The date when the message occurred

%DC_GROUP_REV%

The DC group version associated with the message

%MESSAGE_TYPE%

The type of message

%OVERRIDE_USER%

An operator who performed the DC group override

%SEVERITY%

The severity of the message

%SITE%

The site for the message

%SLOT%

The slot associated with the message

%SOURCE%

The source where the message occurred

%USER_BO%

The user from whom the message originated

%UNIT_ITEM%

The material associated with the message

%UNIT_OPERATION%

The operation during which the message occurred

%UNIT_SFC%

The SFC number associated with the message

%UNIT_SHIFTID%

The shift when the message was triggered

%WORK_CENTER%

The work center where the message occurred

Note Note

The %COMMENTS% replaceable parameter can be used in the Change Equipment Status  messages.

End of the note.

The following table describes nonconformance-related replaceable parameters you can use with messages:

Nonconformance-Related Replaceable Parameters for Use with Messages

Replaceable Parameter

System Value

%COMMENTS%

Text entered by the operator

%COMP_CONTEXT_GBO.(1)%

If the identifier associated with the NC entry is an SFC number, the site of the SFC number

If the identifier associated with the NC entry is an inventory ID, the inventory ID of the material

%COMP_CONTEXT_GBO.(2)%

The NC entry's SFC number

Use only when the identifier associated with the NC entry is SFCBO

%COMPONENT_BO.(1)%

The site of the component that was nonconformed

%COMPONENT_BO.(2)%

The component that was nonconformed

%COMPONENT_BO.(3)%

The component version

%DATE_TIME.[timepatternstring]%

The date and time the SFC number was acted upon (released, nonconformed, and so on), in the form and format specified by timepatternstring

For example: On January 2, 2010, %DATE_TIME.[yddd]% generates 10002.

See also: INCIDENT_DATE_TIME

%FAILURE_ID%

The failure ID associated with the nonconformance

%IDENTIFIER%

The component or inventory ID against which the nonconformance was logged

%INCIDENT_DATE_TIME.[timepatternstring]%

The date and time when the original incident was logged

See also: DATE_TIME

%INVENTORY_BO.(1)%

The inventory ID or the SFC number

%ITEM_BO.(1)%

The site of the material produced by the SFC number, or the component being nonconformed

%ITEM_BO.(2)%

The material produced by the SFC number, or the component being nonconformed

%ITEM_BO.(3)%

The version of the material or nonconformed component

%NC_CODE_BO.(1)%

The site where the NC code is defined

%NC_CODE_BO.(2)%

The NC code

%NC_CONTEXT_GBO.(1)%

The site of the SFC number against which the NC was logged

%NC_CONTEXT_GBO.(2)%

The SFC number against which the NC was logged

%OPERATION_BO.(1)%

The site of the operation at which the NC was logged

%OPERATION_BO.(2)%

The operation at which the NC was logged

%QTY%

The number of pieces of the SFC number that were nonconformed

%REF_DES%

The reference designator of the nonconformed component

%RESOURCE_BO.(1)%

The site of the resource at which the NC was logged

%RESOURCE_BO.(2)%

The resource at which the NC was logged

%SFC_BO.(1)%

The site of the SFC number against which the NC was logged

%SFC_BO.(2)%

The SFC number against which the NC was logged

%WORK_CENTER_BO.(1)%

The site of the work center from which the SFC number was nonconformed

%WORK_CENTER_BO.(2)%

The work center from which the SFC number was nonconformed

Procedure

Each type of message definition can have its own set of data, and therefore its own set of replaceable parameters available for inclusion in the message.

To obtain a complete listing of the replaceable parameters available for use with messages, proceed as follows:

  1. On the Main tab page of Message Type Maintenance, edit an existing FREE_FORM message type definition (see Message Type Maintenance).

  2. Enter the replaceable parameter %.ALL.% in the Message Body field.

    Note Note

    The %.ALL.% replaceable parameter sends all available information in the message.

    End of the note.
  3. Save your entries.

  4. Use the Create Message plug-in to trigger the message, and in Message Board POD, read the message, which will display both the replaceable parameter names and their values.

  5. On the Main tab page of Message Type Maintenance, edit the message type definition, and modify the body of the message to use the specific replaceable parameters that you want. Surround each replaceable parameter with percent signs (for example, %UNIT_ITEM%).

  6. Repeat steps 3–4 to review results.