IGFC rule scripting guide for flexible output integration

Set

This statement is used to define a new variable and assign an initial value.

Examples:

set itemUnitVal = 0
set itemUnitCd = "BOX"
set custId = ""

Variable Assignment

This statement is used to define a new variable and assign an initial value.

Examples:

custId = CustomerID
salesAmount = PoLine.lnTotAmt * RateNumeric

If Else If

This statement is used to control the conditional execution of statements.

If (value_source1 == value_source2) {
// statement block
}
If (value_source1 != value_source2) {
// statement block
} else {
// statement block
}
If (value_source1 >= value_source2) {
// statement block
} else if (value_source1 < value_source2) {
// statement block
}

Examples:

If (SoLine.supplierPartyId == "VEN-100") {
// statement block
}
If (InvLine.unitPriceAmtCurr != AeCurrency) {
// statement block
} else {
// statement block
}
If (TaxRate >= 0.30) {
// statement block
} else if (TaxRate < 0.10) {
// statement block
}

For Every

This statement is used to repeat the execution of a block of statements for every occurrence of a repeating component in the input master data or transactional business document.

for every repeating_component {
// statement block
}

Examples:

for every PoLine {
// statement block
}
for every PoLineItem {
// statement block
}

Controlling the repetition of for every statement

A counter can be used to limit the execution of a block of statement in a rule script. This applies to generation of a single or limited number of a component of an output document that references a repeating attribute in the for every statement.

For example, a single header component need to be generated for the output Sales Order document, with Purchase Order as the input document. Part of the desired output header component is a field that references a value from the PurchaseOrderLine which repeats multiple times in the document. Thus, the PurchaseOrderLine component need to have its own for every statement before the attribute value assignment for the SalesOrderHeader such as:

for every PoLine {		
		"soHead": {    		
			//statement block
                }

Without a control syntax that limits the creation of the header component, the output document will have as many headers as there are input lines following above statement. Create a variable that refers to the execution count and an if condition that validates whether to execute the statement block.

Example:

set headerCount=0
	
    for every PoHead {		
        for every PoLine {		
            if (headerCount == 0) {
			                   "soHead": {    		
					                     //statement block
                		         }		
                		        "soLine": [
                    			  headerCount = 1
            			    }	
					                    //statement block
            }
          }
				                 if(headerCount == 1) {
                		         ] 
                    			  }

In the above example, an soHead component will only be created when the value of the variable headerCount equals 0. Note that after the execution of the first statement block for soHead, the headerCount is assigned with a value of 1 which stops the creation of another soHead.

Statements specific to search template type expressions with multiple search results

Specify the attribute to be retrieved by the expression among the multiple search results using the each and @ statements.

Each

This statement is used to repeat the execution of a block of statements for each search result.

@

This statement is used to assign the search result attribute to a specific variable. The syntax must include the statement "@" and the name of the expression.

each Expression {
variable_name = Expression@attributeName
variable_name = Expression@attributeName
// statement block
}

Examples

each PoItemDetail {
trackInd = PoItemDetail@itemTrackingInd
unitVal = PoItemDetail@itemUnitVal
// statement block
}

Attribute-value assignment

This statement is used to define the value for each field in the output business document. The parameters are attribute-value pairs, separated by a comma.

"grouping_element": {
"attribute": value,
"attribute": {
"attribute": value
}
},
"grouping_element": [
{
"attribute": value,
"attribute": value
}
{
"attribute": value,
"attribute": value
}
]

"grouping_element": {
                  "attribute": value,
                  "attribute": [
                      {
                          "attribute": value,
                          "attribute": value
                      },
                      {
                          "attribute": value,
                          "attribute": value
                      }
                  ],
                  "attribute": value
}

1    set salesAmount = 0
2    set trackInd = ""
3    set unitVal = ""
4       for every PoHead {
5           if (PoHead.poType == "IC") {
6               salesAmount = PoHead.extAmt * RateNumeric
7                   "soHead": {
                         "documentDate": PoHead.docDate,
                         "statusCode": PoHead.statCd,
                         "statusListId": "Sales Order Status",
                         "hdrTotAmt": salesAmount,
                         "hdrTotAmtCur": TargetBaseCur,
                         "soPoRef": {
                                 "soPoRefId": PoHead.poNuM 
                         },
8                   }
9                 "soLine": [
10                    for every PoLine {
11                    salesAmount = PoLine.lnExtAmt * RateNumeric
12                    for every PoItemId {
13                    each PoItemDetail {
                      trackInd = PoItemDetail@itemTrackingInd
                      unitVal = PoItemDetail@itemUnitVal
14                       {
15                         "itemId": ItemID,
                           "lnTotAmt": salesAmount,
                           "lnTotCur": TargetBaseCur,
                           "lnUnitTotAmt": unitVal,
                           "lnUnitTotCur": PoLine.unitPriceCur,
                           "quantity": PoLine.qty,
                           "quantityUnitCd": PoLine.qtyUCd,
                           "lnUserTrackInd": trackInd
16                                          }
17                              }
18                              }
19                           }
20                       ]
21                   }
22               }

Lines 1-3 will create three local variables, namely salesAmount, trackInd and unitVal.

Using the if condition in Line 5 that validates the transaction type for the input purchase order, an output business document will be generated with fields defined in Lines 6-16.

Line 6 defines the variable salesAmount as the product of multiplying the extended amount from the input purchase order header document with the exchange rate numeric determined by the expression RateNumeric. This variable is then assigned as the value for sales order header total amount in Line 7.

Using the for every statement in Lines 10 and 12, all assignments from Line 14 will be executed for every purchase order line and item ID from the input business document.

Line11 defines the variable salesAmount as the product of multiplying the extended amount from the input purchase order line document with the exchange rate numeric determined by the expression RateNumeric. This variable is then assigned as the value for sales order line total amount in Line 14.

Additional variable definition is stated in Line 13 that is coming from an expression that returns multiple search result. Each search result is assigned to variables trackInd and unitVal, which is then assigned as a value source in Line 14.

Statements specific to REST API type expressions with multiple result keys

REST API type expressions with multiple result keys can be assigned in the rule script as a value source for a defined variable or as a definition of an output attribute field in the attribute-value assignment statements. It can also be a value for comparison in an if condition.

To use this type of expression, specify the attribute to be retrieved by the expression among the multiple result keys using the @ statement. The attribute name refers to the values displayed in the result keys list box.

As a value source for a defined variable:

variable_name = Expression@attributeName

As a value source for an output attribute field:

“attribute”: variable_name, …

Alternatively, the expression with @ statement can also be assigned directly to the output attribute field:

If (value1 relationalOperator value2) {

//statement block