Applying a user-defined property override

You can apply a user-defined property override by using the IBM® App Connect Enterprise administration REST API.

Before you begin

Read the following topics:

About this task

You can use the apply-global-udp-override method to create an override value for a named user-defined property. When an override value is created, the value is seen anywhere that the user-defined property is referenced in the message flow, both in the main flow and in subflows, including:

ESQL: DECLARE myVar EXTERNAL datatype defaultValue
Java: MbNode.getUserDefinedAttribute()
.NET: NBNode::GetUserDefinedProperty
Mapping node access to user defined properties

User-defined property overrides are not persistent, which means that they must be reapplied after the integration node or server is restarted. You can configure the integration server to make the overrides persistent by modifying the UserVariables section in the server.conf.yaml file, as shown in the following example:


UserVariables: 
  udp-persist-global-overrides: true

The apply-global-udp-override action takes the following query parameters:

Parameter Description

name* The name of the user-defined property for which an override is to be applied. This parameter is required.

value

Parameter	Description
name*	The name of the user-defined property for which an override is to be applied. This parameter is required.
value	The value of the user-defined property override. If the value includes characters that are not supported in REST URIs, these characters must be URI encoded. For example, a space in a value must be encoded as `%20`. This parameter is optional; if it is not supplied, the default for the datatype is used.
type	The datatype of the user-defined property override (matching ESQL datatypes). This parameter is optional; if it is omitted, the datatype of the existing override is used. If this parameter is omitted and there is no existing override, `CHARACTER` is used by default.

The value of the user-defined property override.

If the value includes characters that are not supported in REST URIs, these characters must be URI encoded. For example, a space in a value must be encoded as %20.

This parameter is optional; if it is not supplied, the default for the datatype is used.

type

The datatype of the user-defined property override (matching ESQL datatypes).

This parameter is optional; if it is omitted, the datatype of the existing override is used. If this parameter is omitted and there is no existing override, CHARACTER is used by default.

The following examples show how to use the apply-global-udp-override method:

apiv2/applications/UDPAPP/messageflows/FLOWWITHUDP/apply-global-udp-override?name=myCharUDP&value=NewValue&type=CHARACTER

apiv2/applications/UDPAPP/messageflows/FLOWWITHUDP/apply-global-udp-override?name=myBoolUDP&value=TRUE&type=BOOLEAN

apiv2/applications/UDPAPP/messageflows/FLOWWITHUDP/apply-global-udp-override?name=myIntUDP&value=350&type=INTEGER

apiv2/applications/UDPAPP/messageflows/FLOWWITHUDP/apply-global-udp-override?name=myCharUDP&value=NewValue

apiv2/applications/UDPAPP/messageflows/FLOWWITHUDP/apply-global-udp-override?name=myCharUDP&value=New%20Value%20with%20spaces

For more information about how to set user-defined property overrides, see Example: setting user-defined property overrides.

You can also remove a user-defined property override by using the IBM App Connect Enterprise administration REST API, as described in Removing a user-defined property override.