ObjPropertyRemove

You can use this function for Optiva Workflows, Copy Methods, and Equations.

Purpose

Clears the values of a property.

Syntax


ObjPropertyRemove(SaveMode,PropertyName,Symbol,Object, [Code, ColumnKey])

Arguments

Part Description
SaveMode Specify 0 as a placeholder. SaveMode is reserved for future use and not currently supported. Changes are saved to the database at the end of the script.
PropertyName

See ObjProperty.

Symbol Type of object. Use empty quotation marks for the current symbol for the workflow.
Object Object for which to obtain a property. Use empty quotation marks for the current object.
Code Optional. Code for the property, for example parameter for VALUE.TPALL property.
SET=parameter set code To remove parameter values, assign all parameters that are to be cleared to a set code. Then, specify "SET=set code name" here.
ColumnKey In some sections of rows, the FIELD_NAMES are not unique and the VALIDATION_SUBCODE has a value.

In this case, look for the row where:

FIELD_NAME = KEYCODE for formulas

FIELD_NAME = PARAMCODE for specifications

In that row, take the FIELD_NO value for KEYCODE or PARAMCODE and divide it by 100. Use this number for the ColumnKey argument. You can also use the FIELD_NAME (KEYCODE or PARAMCODE) as the argument.

For example, if the ColumnKey is 200, then divide it by 100 and the value is 2.

Unlike ObjProperty, Symbol and Object are required arguments. Use empty quotation marks for the workflow’s object or the new object for the copy method.

Description

ObjPropertyRemove clears the values of a property.

Note: You can override security and change a locked or read-only formula using workflow. Use discretion when overriding security.

Examples

This example removes the Mfg. Item from the Formula > Main tab. 


ObjPropertyRemove(0,"ITEMCODE","FORMULA","")

This example clears the value for the date parameter DATEPARAM1. 


ObjPropertyRemove(0,"VALUE.TPALL","","","DATEPARAM1",2)

You can clear parameter values with this function by assigning the parameters to set codes; then clear all parameters belonging to the set. When a parameter is cleared, the Level is reset to 0.

In this example, the technical parameters are removed from the ALLERGENS set. 


ObjPropertyRemove(0,"VALUE.TPALL","","","SET=ALLERGENS",2)