About the xref:populateXRefRow Function

The xref:populateXRefRow function populates a cross reference column with a single value. The xref:populateXRefRow function returns a string value, which is the cross reference value being populated. For example, as shown in Table 44-8, the Order table has the following columns: EBS, Common, and SBL with values E100, 100, and SBL_001 respectively.

Table 44-8 Cross Reference Table with Single Column Values

EBS	Common	SBL
`E100`	`100`	`SBL_001`

Note:

If you find you have concurrency issues when using this function, you can also use the populateLookupXRefRow function. The populateLookupXRefRow function should only be used in cases where simultaneous updates are being made, resulting in unique constraint violations. This function is described under About the xref:populateLookupXRefRow Function.

The syntax of the xref:populateXRefRow function is shown in the following example:

xref:populateXRefRow(xrefLocation as string, xrefReferenceColumnName as string,
 xrefReferenceValue as string, xrefColumnName as string, xrefValue as string, mode
 as string) as string

Parameters

xrefLocation: The cross reference table URI.
xrefReferenceColumnName: The name of the reference column.
xrefReferenceValue: The value corresponding to the reference column name.
xrefColumnName: The name of the column to be populated.
xrefValue: The value to be populated in the column.
mode: The mode in which the xref:populateXRefRow function populates the column. You can specify any of the following values: ADD, LINK, or UPDATE. Table 44-9 describes these modes.

Table 44-9 xref:populateXRefRow Function Modes

Mode Description Exception Reasons

Mode	Description	Exception Reasons
`ADD`	Adds the reference value and the value to be added. For example, the following mode: xref:populateXRefRow("customers.xref" ,"EBS","EBS100", "Common","CM001", "ADD") Adds the reference value `EBS100` in the E`SB` reference column and the value `CM001` in the `Common` column.	Exceptions can occur for the following reasons: The specified cross reference table is not found. The specified columns are not found. The values provided are empty. The value being added is not unique across that column for that table. The column for that row already contains a value. The reference value exists.
`LINK`	Adds the cross reference value corresponding to the existing reference value. For example, the following mode: xref:populateXRefRow("customers.xref" ,"Common","CM001","SBL","SBL_ 001","LINK") Links the value `CM001` in the `Common` column to the `SBL_001` value in the `SBL` column.	Exceptions can occur for the following reasons: The specified cross reference table is not found. The specified columns are not found. The values provided are empty. The reference value is not found. The value being linked exists in that column for that table.
`UPDATE`	Updates the cross reference value corresponding to an existing reference column-value pair. For example, the following mode: xref:populateXRefRow("customers.xref" ,"SBL","SBL_001", "SBL","SBL_ 1001","UPDATE") Updates the value `SBL_001` in the `SBL` column to the value `SBL_1001`.	Exceptions can occur for the following reasons: The specified cross reference table is not found. The specified columns are not found. The values provided are empty. Multiple values are found for the column being updated. The reference value is not found. The column for that row does not have a value.

ADD

Adds the reference value and the value to be added.

For example, the following mode:

xref:populateXRefRow("customers.xref"
,"EBS","EBS100", "Common","CM001",
"ADD")

Adds the reference value EBS100 in the ESB reference column and the value CM001 in the Common column.

Exceptions can occur for the following reasons:

The specified cross reference table is not found.
The specified columns are not found.
The values provided are empty.
The value being added is not unique across that column for that table.
The column for that row already contains a value.
The reference value exists.

LINK

Adds the cross reference value corresponding to the existing reference value.

For example, the following mode:

xref:populateXRefRow("customers.xref"
,"Common","CM001","SBL","SBL_
001","LINK")

Links the value CM001 in the Common column to the SBL_001 value in the SBL column.

Exceptions can occur for the following reasons:

The specified cross reference table is not found.
The specified columns are not found.
The values provided are empty.
The reference value is not found.
The value being linked exists in that column for that table.

UPDATE

Updates the cross reference value corresponding to an existing reference column-value pair.

For example, the following mode:

xref:populateXRefRow("customers.xref"
,"SBL","SBL_001", "SBL","SBL_
1001","UPDATE")

Updates the value SBL_001 in the SBL column to the value SBL_1001.

Exceptions can occur for the following reasons:

The specified cross reference table is not found.
The specified columns are not found.
The values provided are empty.
Multiple values are found for the column being updated.
The reference value is not found.
The column for that row does not have a value.

Note:

The mode parameter values are case-sensitive and should be specified in upper case only, as shown in Table 44-9.

Table 44-10 describes the xref:populateXRefRow function modes and exception conditions for these modes.

Table 44-10 xref:populateXRefRow Function Results with Different Modes

Mode Reference Value Value to be Added Result

Mode	Reference Value	Value to be Added	Result
`ADD`	`Absent` `Present` `Present`	`Absent` `Absent` `Present`	Success Exception Exception
`LINK`	`Absent` `Present` `Present`	`Absent` `Absent` `Present`	Exception Success Exception
`UPDATE`	`Absent` `Present` `Present`	`Absent` `Absent` `Present`	Exception Exception Success

ADD

Absent

Present

Absent

Present

Success

Exception

LINK

Absent

Present

Absent

Present

Exception

Success

Exception

UPDATE

Absent

Present

Absent

Present

Exception

Success