ObjProperty

Examples

Example 1: (Header Data Examples) Retrieving the value of STATUS for formula PIZZA/0001

Let us consider the table under VALID_CODE for DTLCODE STATUS: G.OBJSTATUS

propertyName: STATUSIND.STATUS (FIELD_NAME - STATUSIND, DTLCODE - STATUS)

objSymbol: FORMULA

objectKey: PIZZA\0001

rowkey: Not a table value, so not needed

keycol: Not a table value, so not needed

Function Call: ObjProperty("STATUSIND.STATUS", "FORMULA", "PIZZA\0001");

object oStatus = ObjProperty("STATUSIND.STATUS", "FORMULA", "PIZZA\0001");

Example 2: (Header Data Examples) Retrieving the value of CLASS for any Item

Note the Data Names possibly including a custom label

Let's consider the table under VALID_CODE for DTLCODE STATUS : G.OBJSTATUS

In this case, CLASS is the propertyName but users see a custom label. They have written the request as a requirement to get the “Item Type”. The Field Label table tells us the standard name and field name for the attribute.

As this is a basic field, no rowKey or keyCol entries are needed.

propertyName:CLASS

objSymbol: ITEM

objectKey: Empty quotations to resemble current object.

rowkey: Not a table value, so not needed

keycol: Not a table value, so not needed

Function Call: ObjProperty("CLASS", "ITEM", "");

object sItemClass = ObjProperty("CLASS", "ITEM", "");
MessageList("The item type is: ",  sItemClass.ToString());

Example 3 : Retrieving the value of DESCRIPTION for any ITEM

propertyName: DESCRIPTION

objSymbol: ITEM

objectKey: Empty quotations to resemble current object.

rowkey: Not required

keycol: Not required

Function Call: ObjProperty("DESCRIPTION", "ITEM", "");

Code: string itemDescr = ObjProperty("DESCRIPTION", "ITEM", "").ToString();
	   MessageList("Header description Curr obj: " + itemDescr);

Example 4: Retrieving the value of DENSITY parameter for any ITEM/FORMULA

Let's consider the table under VALID_CODE for DTLCODE TPALL : G.TECHPVAL

When reviewing the table, note that the VALIDATION_SUBCODE acts as a unique identifier for differentiating fields that share the same name.

This is important because certain field names, such as VALUE, can appear multiple times for different parameters.

For our specific parameter, the VALIDATION_SUBCODE is DENSITY.

The corresponding Field Name is VALUE. As per the objectdtlinfo table, the DTLCODE is TPALL.

propertyName: VALUE.TPALL (FIELD_NAME - VALUE, DTLCODE - TPALL)

objSymbol: Empty quotations to resemble current symbol.

objectKey: Empty quotations to resemble current object.

rowke: It Indicates the key (Parameter code) - DENSITY

keycol: Preferred method - What is the DB_FIELD_NAME of the column where the code "DENSITY" is found? PARAM_CODE.

Less preferred, historically used method: Take the value of DB_FIELD_NO for the desired field, Divide it by 100 -> DB_FIELD_NO/100 => 200/100 = 2.

Code Snippet:

object oDens = ObjProperty("VALUE.TPALL", "", "", "DENSITY", "PARAM_CODE");
If (IsBlank(oDens) == 0)    
    MessageList("Density value is : " + oDens.ToString());

FSSPECIFICATIONSTATUS  
    

Let's consider the table under VALID_CODE for DTLCODE TPALL : G.OBJECTCONTEXT (The Validation details for Context are global to all object types)

As per our requirement we can choose the field name related to the specific Attribute code, in this case C_BRAND. The Field name available for the attribute types is ATTRIBVAL

propertyName: ATTRIBCODE.CONTEXT (FIELD_NAME - ATTRIBCODE, DTLCODE - CONTEXT)

objSymbol: SPECIFICATION

objectKey: SPEC/0001

rowkey: It Indicates the key (ATTRIB_CODE) - C_BRAND

keycol: Brand, Selling Location, etc. are attribute codes, so the keycol is the DB_FIELD_NAME ATTRIB_CODE.

Function Calls: ObjProperty("ATTRIBVAL.CONTEXT", "SPECIFICATION", "SPEC/0001", "C_BRAND", "ATTRIB_CODE");

var oAttribVal = ObjProperty("ATTRIBVAL.CONTEXT", "SPECIFICATION", "SPEC/0001", "C_BRAND", "ATTRIB_CODE");
        MessageList("context val: " + oAttribVal.ToString());

The data resulting from this ObjProperty call is nothing/null if there are no Brands, a string if there is only one Brand, and an array if there are multiple.

Therefore, the use of the oAttribVal variable needs to be tested before passing to an alert message or other code, and often the simplest approach is to always create an array from the result such as this example that converts the ObjProperty result into an array of either 1 or multiple values.

	var RawValue = ObjProperty("ATTRIBVAL.CONTEXT", "", "", "MFGLOC", "ATTRIB_CODE");
				if (RawValue is not null && RawValue is Array)
				{
					string[] ContextValues;
					if (RawValue is Array)
					{
						ContextValues = (string[])RawValue;
					}
					else
					{
						ContextValues = new string[1];
						ContextValues[0] = RawValue.ToString();
					}
				}

Example 4.1: Retrieving the Context attributes of all codes for SPECIFICATION SPEC/0001

In order to retrieve all the context attributes (of all codes) for any specific object, use below code -

				//Retrives all the attribute codes as an array of type Object.
				object[] attribCodes = (object[])ObjProperty("ATTRIBCODE.CONTEXT", "SPECIFICATION", "SPEC/0001", "*", 1L);
				//Retrives all the attribute values as an array of type Object.
				object[] attribValues = (object[])ObjProperty("ATTRIBVAL.CONTEXT", "SPECIFICATION", "SPEC/0001", "*", 1L);

				if(attribCodes!=null)
				{
				for (int i = 0; i<attribCodes.Length;i++)
					{
						MessageList("ATTRIBCODE: " + attribCodes[i] + "ATTRIBVAL: " + attribValues[i]);
					}
				}

Example 5: The following example demonstrates how to call functions to retrieve all Ingredients (Items) and their corresponding quantities for any formula:

Detail Code: INGR – Represents the Item Lines tab.

Field Names: ITEMCODE – Used to retrieve the Item Code (ingredient name), QUANTITY – Used to retrieve the Item Quantity. These are the names for the rows where the value exists.

By using these field names in the function calls, you can extract both the ingredient details and their quantities efficiently.

object[] lines = (object[])ObjProperty("ITEMCODE.INGR", "FORMULA", "", "*", 1L);
				object[] qty = (object[])ObjProperty("QUANTITY.INGR", "FORMULA", "", "*", 1L);
				

Example 6: Retrieve all References and types from any object

• In this case, the rowKey = *will retrieve all rows of the table in the chosen column(s).
• The data result is an array unless there are no rows of the table, in case the result is null in C#.
• REF is the detail code for References referenced in any object.

propertyName: OBJECTCODE.REF (FIELD_NAME - OBJECTCODE, DTLCODE - REF)

objSymbol: Empty quotations to resemble current symbol.

objectKey: Empty quotations to resemble current object key.

rowkey: *

//Retrives all the reference codes as an array of type Object.
				string[] oRef = (string[])ObjProperty("OBJECTCODE.REF", "", "", "*");
				//Retrives all the reference types as an array of type Object.
				string[] oRefType = (string[])ObjProperty("OBJECTTYPE.REF", "", "", "*");
				for (int y = 0; y < oRef.Length; y++)
				{
					MessageList($"Referenced {oRefType[y]} is {oRef[y]}");
				}

Example 6.1: Retrieve Reference(s) of any specific type for any object

propertyName: OBJECTCODE.REF (FIELD_NAME - OBJECTCODE, DTLCODE - REF)

objSymbol: Empty quotations to resemble current symbol.

objectKey: Empty quotations to resemble object key.

rowkey: VENDOR

keycol: R_OBJECT_TYPE

				var objCodes = ObjProperty("OBJECTCODE.REF", "", "", "VENDOR", "R_OBJECT_TYPE");

				if (objCodes is Array refCodeArray && refCodeArray.Length > 0)
				{
					for (int i = 0; i < refCodeArray.Length; i++){
						
						string firstRefCode = refCodeArray.GetValue(i).ToString();
						// Use firstRefCode as needed here
						MessageList($"RefCode: {firstRefCode}");
					
					}
				}
				else
				{
					MessageList($"The Referenced Object is {objCodes}");
				}

Example 7: Retrieving values from Extension Table (Matrix)

propertyName: Field<#>.MATRIX.V\DM<Symbol#>

The first argument is made up of three parts. Each part tells the system which data to retrieve and from where.

1. FIELD<#> – FIELD refers to a column name in a data grid (matrix).
   • The details associated to this data grid can be found in the object specific MATRIX tables in the database.
   • Example: FS_FORMULAMATRIX_0 resembles first matrix table associated with the formula.
   • The <#> is a number that tells the system which column to use.
   • Columns are numbered internally, starting from 1.
   • Example: FIELD1 → first column, FIELD2 → second column etc.
2. MATRIX is the name of detail code for Extension Table
3. V\DM<Symbol#> - This tells the system exactly which Data Matrix table to use.
   • Data Matrix tables are given internal numbers by the system.
   • To reference a specific table, use the prefix "V\DM", followed by the symbol name, and then a table number.
   • The table numbers start at 0.
   • Example: First table → V\DMProject0, Second table → V\DMProject1 etc.
4. Points to remember:
   • To find the correct Data Matrix table number, check the FsDataMatrix table.
   • This table shows how many Data Matrix tables exist for each symbol.
   • Example: Let's consider for the Project symbol, the below table indicates that there are two Data Matrix tables.

Use the value in the VIEW_ID column as the table number. First table → V\DMProject0 resembles SAMPLE SHIPMENTS table.

Example 7.1: Retrieving all the Values of a column in an Extension Table

ObjProperty(@"FIELD2.MATRIX.V\DMPROJECT0", "", "", "*");

class ActionScript : FcProcFuncSetEventWF
				{

					public long wf_start()
					{
						var extensionTableData = ObjProperty(@"FIELD2.MATRIX.V\DMPROJECT0", "", "", "*");
						if (extensionTableData is Array dataArray && dataArray.Length > 0)
								{
									MessageList("Values of Column FIELD2 :");
									for (int i = 0; i < dataArray.Length; i++){
										
										string fieldVal = dataArray.GetValue(i).ToString();
										// Use Values as needed here
										MessageList($"Value {i} : {fieldVal}");
									}
								}
								else
								{
									MessageList($"The Data is {extensionTableData}");
								}
						return 111L;
					}
				}

Example 7.2: Retrieving a Value from an Extension Table

This example demonstrates to retrieve the brand value of Lauren Vendor.

Here, the column names of Line ID, Brands, Vendor are FIELD1, FIELD2, FIELD3 respectively as per FS_PROJECTMATRIX_0 table.

This example retrieves the value from the second column (FIELD2) of the row where the FIELD3 value is LAUREN.

Function Call: ObjProperty(@"FIELD2.MATRIX.V\DMPROJECT0", "", "", "LAUREN", "FIELD3");

1. property Name : "FIELD2.MATRIX.V\DMPROJECT0" (FIELD2 → Specifies the second column to retrieve, MATRIX → Indicates the data comes from a Data Matrix, V\DMPROJECT0 → Identifies the Project Data Matrix table, table number 0)
2. objSymbol : Empty quotations to resemble current symbol.
3. objectKey: Empty quotations to resemble object key.
4. rowkey - LAUREN
5. colKey - FIELD3

Process:

1. Look in Project Data Matrix table 0 (V\DMPROJECT0).
2. Find the row where FIELD3 equals "LAUREN".
3. From that row, return the value in FIELD2 (the second column).

class ActionScript : FcProcFuncSetEventWF
			{

				public long wf_start()
				{
					var tbl = ObjProperty(@"FIELD2.MATRIX.V\DMPROJECT0", "", "", "LAUREN", "FIELD3");
					MessageList(tbl.ToString());
					return 111L;
				}
			}