FormulaGuidelineCheck
Purpose
This scripting function returns the data set after performing a guideline check on a formula object.
Syntax
Dim result As DataSet = FormulaGuidelineCheck(objectKey,guidelineCheckOptions,contextOptions)Arguments
| Argument | Description |
|---|---|
objectKey |
Formula object on which to apply the method. Use empty quotation marks for the current object for the workflow. |
guidelineCheckOptions |
List of KeyValuePair objects where Key is the Item, Parameter,Status Options
Code in Guideline Check form and Value is the Selection State
of check boxes. For example, 1 for Selected, 0
for Unselected. |
contextOptions |
List of KeyValuePair objects where Key is the Context Type and Value is an
Array where First Value represents the Selection
State of Include Context check box. For example, 1
for Selected, 0 for Unselected and Second Value
is the Context Attribute values in the
Guideline Check form. |
Description
The FormulaGuidelineCheck method is used to perform a guideline check on a
formula object. It takes the Object Key, Item, Technical Parameter, Status, Context options
as input, executes the GLRECHECK method with these inputs and returns the
resultant data set as output.
If objectKey is empty, then the method takes current object as default
value. If objectKey is invalid, then the method returns nothing. Both
guidelineCheckOptions and contextOptions are optional
parameters. If guidelineCheckOptions and contextOptions
are not specified, the method takes the default options as input and returns the resultant
data set.
guidelineCheckOptions available:| Option Name (Key/Attribute Name) | Description (Option in PLM Process UI) |
|---|---|
SHOWITEMIND |
Show Item Guidelines |
ITEMPCTIND |
Match Formula Item Percentage |
ITEMMISSINGSTMTIND |
Show Items with Undefined Guidelines |
ITEMSHOWINFOSTMTIND |
Show Informational Guidelines |
SHOWTPIND |
Show Parameter Guidelines |
TPVALIND |
Match Formula Parameter Value |
TPMISSINGSTMTIND |
Show Parameters with Undefined Guidelines |
TPSHOWINFOSTMTIND |
Show Informational Guidelines |
ITEMSTATSIND |
Exclude Statuses for Item Options |
TPSTATSIND |
Exclude Statuses for Parameter Options |
VALIND |
Limit Result to Guidelines with Explicitly Defined Context Attributes |
contextOptions available:| Option Name (Key/Attribute Name) | Description (Context Type Option in PLM Process UI) |
|---|---|
SELLOCATION |
Selling Location |
MFGLOCATION |
Mfg. Location |
BRAND |
Brand |
PRODTYPE |
Product Type |
ENDUSE |
End Use |
End Use |
End User |