serializeReferenceToJSON

The serializeReferenceToJSON function is used to serialize a single reference from an object.

Syntax

c4i:serializeReferenceToJSON(reference [, lov] [, units] [, values] [, keyMetaAttribute] [, displayReferenceTarget] [, keysOrder])

Parameters

reference

XPath to the reference

lov (optional) :

  • Indicates how to represent LOV values
  • The authorized values are "DISPLAY_LOV_VALUE_LABEL" (default), "DISPLAY_LOV_VALUE_ID" or "DISPLAY_BOTH"

unit (optional)

  • Indicates how to represent units
  • The authorized values are "NO_UNITS" (default), "DISPLAY_UNIT_ID", "DISPLAY_UNIT_LABEL"

value (optional) :

  • Indicates if values and units should be concatenated or separated
  • The authorized values are "CONCAT_VALUE_UNIT" (default) or "ISOLATE_VALUE"

keyMetaAttribute (optional)

  • By default, attributes are indexed using their attribute ID
  • If this parameter is supplied, attributes will be indexed using a meta-attribute value, if it is present

displayReferenceTarget (optional)

  • Indicates whether to display reference target ID or key value
  • The authorized values are "BY_ID" (default) or "BY_KEY"

keysOrder (optional)

  • Indicates the order in with the keys should be used when an object has multiple key values
  • Separate keys using a comma (,). Example : "Key1,Key2"

Return value

A JSON document containing the reference and associated meta-data.

Jsdoc

The return type to use in scripts is SingleContextReference, where the metaData field will be of type Values.

Examples

Given the following STEP XML:

<STEP-ProductInformation>
    <AttributeList>
        <Attribute ID="ATT2">
            <Validation BaseType="number">
                <UnitLink UnitID="unece.unit.KTM"/>
            </Validation>
        </Attribute>
    </AttributeList>
    <Products>
        <Product ID="PRD1">
            <ProductCrossReference Type="Accessory" ProductID="PRD2">
                <MetaData>
                    <MultiValue AttributeID="ATT1">
                        <Value ID="VAL_1">Value 1</Value> 
                        <Value ID="VAL_2">Value 2</Value> 
                    </MultiValue>
                    <MultiValue AttributeID="ATT2">
                        <Value UnitID="unece.unit.KTM">16</Value>
                        <Value UnitID="unece.unit.KTM">12</Value>
                    </MultiValue>
                </MetaData>
            </ProductCrossReference>
            <AssetCrossReference Type="PrimaryImage" AssetID="IMG1"/>
        </Product>
    </Products>
</STEP-ProductInformation>

The following YAML configuration will produce the following output :

c4i:serializeReferenceToJSON(ProductCrossReference[@Type="Accessory"][0])
{
  "target":  "PRD2",
  "metaData": { "ATT1" :  ["Value 1", "Value 2"], "ATT2" : [16.0, 12.0]}
}

Please refer to the documentation of multiValuesToJSON for more info on using the parameter values of this function.

Last Updated: