DML functions: B2Bi user attributes

B2Bi user attributes

getInboundUserAttribute

getOutboundUserAttribute

B2Bi user attributes

In B2Bi interface, user attributes can be set at various levels:

  • Community / Partner
  • Inbound Agreement / Outbound Agreement / Metadata Profile
  • Document Agreement
  • Service

It is possible to access these user attributes via DML functions which have been defined in the DML Map.

The user attributes are strings,they can be one value, or a list of values. If the attribute is a list of values, the values need to be separated by commas.

When a DML expression is defined that contains the two functions, the result will be the value(s) of the attributes.

getInboundUserAttribute

getInboundUserAttribute Comment

Description

getInboundUserAttribute is used to retrieve the values of a specific attribute related to a message which has been matched against a specific inbound agreement or metadata profile.

Syntax

getInboundUserAttribute (name, domain)

Return

  • If attribute is found, an array containing the values of the requested attribute is returned.
  • If the attribute is not found, an empty array is returned.

Parameters

name (String): Name of the attribute to be retrieved.

domain (String): Defines the type of the attribute that is to be retrieved.

Defined domain values:

  • B2BI.Message.$UserAttribute_Domain_Agreement
    Return inbound agreement defined attributes.
  • B2BI.Message.$UserAttribute_Domain_Sender
    Return sender defined attributes.
  • B2BI.Message.$UserAttribute_Domain_Receiver
    Return receiver defined attributes.
  • B2BI.Message.$UserAttribute_Domain_DocAgreement
    Return document agreement defined attributes.
  • B2BI.Message.$UserAttribute_Domain_DocumentService
    Return document service defined attributes.
  • B2BI.Message.$UserAttribute_Domain_MetadataProfile
    Return metadata profile defined attributes.

 

Example

getInboundUserAttribute ("SenderName", "B2BI.Message.$UserAttribute_Domain_Sender"):

returns the value of the attribute with the key "SenderName"

getOutboundUserAttribute

getOutboundUserAttribute Comment

Description

getOutboundUserAttribute is used to retrieve the values of a specific attribute related to a message which is handled by a specific outbound agreement.

The statement can be used in any user created enveloping stage, it can also be used in a post-enveloping or post-transfer stage.

Syntax

getOutboundUserAttribute (name, domain)

Return

  • If attribute is found, an array containing the values of the requested attribute is returned.
  • If the attribute is not found, an empty array is returned.

Parameters

name (String): Name of the attribute to be retrieved.

domain (String): Defines the type of the attribute that is to be retrieved.

 

Defined domain values:

  • B2BI.Message.$UserAttribute_Domain_Agreement
    Return inbound agreement defined attributes.
  • B2BI.Message.$UserAttribute_Domain_Sender
    Return sender defined attributes.
  • B2BI.Message.$UserAttribute_Domain_Receiver
    Return receiver defined attributes.
  • B2BI.Message.$UserAttribute_Domain_DocumentService
    Return document service defined attributes.

Example

getOutboundUserAttribute ("SenderName", "B2BI.Message.$UserAttribute_Domain_Sender"):

returns the value of the attribute with the key "SenderName" .

Related Links