externalize() Function

Function

Copy link to clipboard

externalize( value )

Converts the given value to a string representation so that it can be saved externally. The externalized string must only be used in conjunction with internalize() and must be internalized on the same server. Moreover, the type id of the value is embedded in the externalized string.

See also: internalize()

Parameters

Copy link to clipboard

Returns

Copy link to clipboard

Text

Usage considerations

Copy link to clipboard

Convert back to original value

Copy link to clipboard

The returned value can later be converted back to the original value using internalize(). For example, the text returned by externalize(pv!myUserPv) could be stored in an external database and later assigned back to a user process variable by passing the externalized representation of the value to internalize().

Externalize record data

Copy link to clipboard

This function cannot be used with record data. Instead, you can use a!toJson() to create a text representation of record data to be stored outside Appian. The JSON can then be cast to a record data type with a!fromJson().

This example shows how to cast a JSON string to the Address record type. When casting JSON data to a record type, Appian automatically matches the keys to the record type's fields. Any non-matching key names are ignored.

1
2
3
4
5
6
7
cast(
  recordType!Address,
  a!fromJson(
      "{""addressId"":301,""addressLine"":""7950 Jones Branch Dr"",
      ""city"":""McLean"",""stateProvinceId"":75,""postalCode"":""22102""}"
  )
)
Copy

Examples

Copy link to clipboard

Serialize text

Copy link to clipboard

1
externalize("Hello World!")
Copy

Returns 000000010000003000000000000000030000000448656C6C6F20576F726C6421000000000000000000000001000000030000000100000002. In some cases, primitive types can be used across different environments.

Serialize a map

Copy link to clipboard

1
externalize(a!map(key1: "value1", key2: "value2"))
Copy

Returns 000000010000009000000000000000030000000000000004FFFFFFFC000000026B657931006B657932000000000000000000000600000000000000000000000200000000000000020000000476616C756531000000000000000000010000000300000000000000020000000476616C7565320000000000000000000100000003000000060000000000000001000000FC0000000100000002.

Serialize a process variable of type User

Copy link to clipboard

1
externalize(pv!user)
Copy

Returns 000000010000002800000000000000030000000475736572330000000000000000000001000000040000000100000002 when pv!user is User Mike Smith whose username is user3.

Feature compatibility

Copy link to clipboard

Feedback

Copy link to clipboard