Open topic with navigation

Other Functions

Calculated Attribute expressions can be written using the following available functions. Examples follow the Available Functions table.

Note: Adding a new line by pressing the Enter key or adding "\n" within the Function Editor template allows the resulting values to display in multiple lines.

For more extended scenarios and function templates, see the available Calculated Attribute Use Case Examples in the Calculated Attributes section of the System Setup / Super User Guide documentation here.

Also refer to the Insert Templates topic in the System Setup / Super User Guide documentation for more information here.

Available Functions

Use Cases

For an example using overrides, see Use Case: Calculated Attribute for Overrides here.

For an example using classifications, see Use Case: Calculated Attribute for Classifications here.

For an example using classifications, see Use Case: Calculated Attribute for References here.

Examples

The examples below assume a setup including these attributes and products:

Copy and paste any of the following examples into the Function Editor and then evaluate against the specified object to get the defined result.

or((value('TEXT1id')= 'p1 value'), (value('NUMBER1id')= '4')) // = 1 (TRUE) evaluated P1id

or((value('TEXT1id')= 'p0 value'), (value('NUMBER1id')= '3')) // = 0 (FALSE) evaluated P1id

and((value('TEXT1id')= 'p1 value'), (value('NUMBER1id')= '4')) // = 1 (TRUE) evaluated P1id

and((value('TEXT1id')= 'p0 value'), (value('NUMBER1id')= '3')) // = 0 (FALSE) evaluated P1id

not(value('TEXT1id')= 'p1 value')) // = 0 (FALSE) evaluated P1id

not(value('TEXT1id')= 'p0 value')) // = 1 (TRUE) evaluated P1id

stepid() // = 'P1id' evaluated P1id

stepname() // = 'P1' evaluated P1id

stepname('step://product?id=P1id') // = 'P1' evaluated P1id

stepurl() // = 'step://product?id=P1id' evaluated P1id

stepurl('Product','P1id') // = 'step://product?id=P1id' evaluated P1id

stepobjecttype() // = 'Item' evaluated P1id

stepobjecttype('step://product?id=P1id') // = 'Item' evaluated P1id

iterate(stepurl2objid(stepurl('Product','Level1-109267')),'stepname()')

// = 'P1id' evaluated on some product node.

list(iterate(children(),'concatenate(stepname())'),', ') // = 'P1, P2, P3' evaluated P-Family since these are products

list(iterate(subproducts(),'concatenate(stepname())'),', ') // = 'P1, P2, P3' evaluated P-Family since these are products

list(iterate(children(),'concatenate(stepname())'),', ') // = 'E1, E2, E3' evaluated entity with three children, none of which are products

list(iterate(subproducts(),'concatenate(stepname())'),', ') // = '' evaluated entity with three children, none of which are products

list(iterate(iterate(references('product', 'BillOfMaterials'),'referencetarget()'),'stepname()'),', ') // = 'P3' evaluated against P1 when P1 has a BillOfMaterials reference to P3

parentid() // = 'P-family' evaluated P1id 

list(iterate(path(),'concatenate(stepname())'),', ') // = 'Primary Product Hierarchy, Products, P-family' evaluated P-Family 

isbelow('step://product?id=P1id') // = 0 (FALSE) evaluated P-Family

isbelow('step://product?id=P-Family') // = 1 (TRUE) evaluated P1id

list(iterate(revisions(), 'revisioncreatedate()'), ', ') // = '2016-04-20 17:18:42, 2016-04-22 09:44:36, 2016-04-25 09:34:36, 2016-05-06 11:04:09' evaluated P-Family

revisionname() // = '0.3' evaluated P-Family

revisioneditedby() // = 'USER' evaluated P-Family

revisioncomment() // = 'Auto Generated' evaluated P-Family

revisionismajor() // = '0' (FALSE) evaluated P-Family

revisioncreatedate() // = '2016-04-25 09:34:36' evaluated P-Family

revisioneditdate() // = '2016-04-25 16:16:30' evaluated P1

firstrevisioncreatedate() // = '2016-04-20 17:20:41' evaluated P1

completeness() // = '51.282051282051284601948282215744' evaluated P1 

round(completeness(),0) // = '51' evaluated P1 

workflowids() // = 'ItemCreationOrderProcessWorkflow' evaluated P1 (2 workflows returned: Item Creation and Order Process Workflow)

currentworkflowstates('OrderProcessWorkflow') // = 'State-2'  evaluated P1 

list(iterate(classifications(), "stepid()"), "/ ") // = Classification1/ Classification2 evaluated product that exists in two classifications

• The following template returns the value of the metadata on the attribute 'TEXT1id' as well as the value of the attribute on the evaluated object

{meta := iterate(stepurl2objid(stepurl('attribute','TEXT1id')), 'value("Attribute Description")'),val := value('TEXT1id')}

concatenate("\'", meta,"\'", " is the metadata on the \'TEXT1id\' attribute which contains the value: ", val) 

/* "'TEXT1 description' is the metadata on the 'TEXT1id' attribute which  contains the value: family value" evaluated P-family*/

• The following templates use the product folder 'Batteries' (child of 'Battery Items') which is overridden by 'Batteries Override 1', 'Batteries Override 2', and 'Batteries Override 3'.

overriddenproduct('BatteriesOverride1ID')

Evaluated on Batteries Override 1: Batteries

overriddenproduct('Batteries')

Evaluated on Batteries Override 1: N/A

{

x := listlen(overriddenby()),

z := iterate(overriddenby(), 'stepname()'),

z := list2multivalue(z),

z := substitute(z, "<multisep/>", "

")

}

concatenate("This product is overridden by ", x, ", product override(s):

", z)

Evaluated on Batteries: This product is overridden by 3 product override(s): 

Batteries Override 2 

Batteries Override 1 

Batteries Override 3

{

x := iterate(overriddenproductobject(), 'stepname()'),

z := listitem(x,1)

}

concatenate('This PO overrides the product "', z, '"')

Evaluated on Batteries Override 1: This PO overrides the product "Batteries"

list(iterate(productoverrideparents(), "stepid()"), "/ ")

Evaluated on Battery Items: BatteriesOverride2ID/BatteriesOverride1ID/BatteriesOverride3ID

• The following templates use this lookup table data.

REPLACEVALUEBYLOOKUP('UOMLookupTable','EACH') // = 'Ea.' evaluated P1 

REPLACEWORDBYLOOKUP('UOMLookupTable','EACH, DOZEN, CASE') // ='Ea., Dz., Case' evaluated P1

• The following template returns name and ID of parent product. Use -2 (instead of -1) to get name / ID of grandparent, etc.

{i:=path(), parent:=listitem(i,listlen(i)-1)} iterate(parent, 'concatenate("name=",stepname(),"; id=", stepid())') // = 'name=P-family; id=P-family-id' evaluated P1 

• The following template returns the value for attribute ID 'BrandName' that occurs the most times in its children.

{

all:=iterate(subproducts(), "prodval('BrandName')"),

unique:=unique(all),

oftenIndex:=1,

oftenCount:=0,

dummy:=iterate(unique, '

{

curval:=item,

count:=listlen(filter(all,"exact(curval,item)"))

}

if (count>oftenCount, concatenate(

oftenCount:=count,

oftenIndex:=index),

0)')

}

if (oftenCount>0, listitem(unique,oftenIndex), "")

• The following template extracts values for attribute 'grandchildattrid' of all grandchildren into a list.

Note: Use cautiously. This operation can drain system CPU since all grandchildren are read for each product.

{attrid:='grandchildattrid'}listconcatenate(iterate(subproducts(), 'iterate(subproducts(),"prodval(attrid)")'))

• The following template compares the value of 'RemovalDate' attribute on the child objects and returns the one that is closest to the current date while still less than the current date. Returns 'None Newer' if no such child exists.

{

msg := "Closest Date That Is Less Than The Current Date Is: ",

datenow := left(substitute(now(), "-", ""), 8),

datelist := filter(iterate(children(), 'value("ISODate")'), 'substitute(item, "-", "") <lt/> datenow'),

neardate := listitem(reverse(sortnumeric(datelist)), 1)

}

if(exact(neardate, "N/A"), "None Newer", concatenate(msg, neardate))

2017, Stibo Systems