Versions Compared

Old Version 1

changes.mady.by.user Adriane Hunt

Saved on

compared with

New Version Current

changes.mady.by.user Adriane Hunt

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Standard Smart Text placeholders in FactoryLogix are shown like this: <$Type$> where Type identifies the type of Smart Text required, for example Assembly, Barcode, Batch Name, and so on.

In some cases, FactoryLogix allows you to manually edit Smart Text by adding additional processing instructions to the Smart text placeholders (that is, instead of only being able to select a Smart Text placeholder from a drop-down). If you want to add additional processing instructions to a Smart Text placeholder, use this format:

Code Block
<$Type [|Function,Parameters [...]]$>

Element

Description

Type

Type identifies the information that will replace the Smart Text placeholder. Type is the only required element. 

| (pipe character)

Identifies the start of an additional processing instruction.

Function

Identifies any additional processing that will be applied to the value that replaces the Smart Text placeholder. These functions are supported:

  • SUBASSY

Info

...

...

Important

...

The SUBASSY function is limited to use with the <$Barcode$> Smart Text placeholder only.

  • SUBSTR

  • REPLACE

Parameters

A comma-separated list of values that varies depending on the function.

Any Smart Text placeholder can include zero or more additional processing instructions where each processing instruction uses three elements:

| Function,Parameters

  • If you don't define any additional processing instructions, the Smart Text placeholder uses the standard format:

Code Block
<$Type$>

  • If you define one or more additional processing instructions, each instruction is processed in order, from left to right.

  • To use one processing instruction, use the following format:

Code Block
<$Type|Function,Parameters$>

  • To use multiple processing instructions, specify each additional processing instruction to the right of the previous instruction:

Code Block
<$Type|Function,Parameters|Function,Parameters$>

SUBASSY, SUBSTR, and REPLACE functions

Function

Description

SUBASSY

Info

...

Important

...

The SUBASSY function is limited to use with the <$Barcode$> Smart Text placeholder only.

When a <$Barcode$> Smart Text placeholder is resolved, it is replaced with the UID of the targeted item.

  • <Reference Designator> is the only parameter for the SUBASSY function. The <Reference Designator> parameter identifies the location where the sub-assembly whose barcode will be returned. 

  • When the SUBASSY function is applied, it directs the additional processing to return the UID of the sub-assembly directly attached to the targeted item at the location identified by the <Reference Designator> parameter.

  • If a sub-assembly isn't present at the location identified by the reference designator recorded for parameter 1, the resolved value is a string length of zero.

  • Example: <$Barcode|SUBASSY,SUB1$>

    In the example, the barcode returned is the barcode of the sub-assembly at the location SUB1 on the unit being worked on.

SUBSTR

The SUBSTR function returns a substring of the resolved Smart text value. Th SUBSTR function has two parameters:

  • The first parameter identifies the index of the first character in the string to be returned.

  • The second parameter identifies the length of the string to be returned. The first character in a string is located at index 1.

  • Example: <$Batch|SUBSTR,3,7$>

    In the example, if the Batch Name is ABCDEFGHIJKL, the Smart Text placeholder is replaced with the string CDEFGHI.

REPLACE

The REPLACE function returns the resolved value having replaced every instance of the string defined in the first parameter with the string defined in the second parameter. This function has two parameters:

  • The first parameter identifies the string to be replaced.

  • The second parameter is the string to be substituted for each occurrence of the first parameter found in the resolved value.

  • Example: <$Batch|REPLACE,ABC,x$>

    In the example, if the Batch Name is ABCDEFABCJKL, the Smart Text placeholder is replaced with the string xDEFxJKL.