Address Element

The Address element provides the ability to add a client address through an activity. This element triggers the display of the Address tab during the user's data entry session. When the Activity is saved, the Address is also saved to the Address database table. During Activity processing, the new Address must be linked to a Client through the CreateClientAddress attached business rule. If the intention of the Activity is to replace an existing Address with a new Address, the Activity must further expire the old Address; preferably the Address copied by the COPYSOURCEADDRESSGUID attribute.

AddressElement: Elements and Attributes

Element

Parent Element

Attribute

Description

<Address>

<Transaction>

  

Optional:

This element is the trigger for the Activity Address feature. The feature adds a single new Address record to be saved with the Activity. This new Address may be a replacement for an existing Client's Address or it may be an entirely new Address with an AddressRole that does not currently exist for a Client.
 

 

COPYSOURCEADDRESSGUID

Optional:

This attribute copies the address content from the AddressGUID and displays it on the Activity entry's Address tab.  When this attribute exists in the configuration, the existing address can be modified and the <AddressTypes> element structure and DEFAULTADDRESSTYPE attribute are ignored.

Values:

  • field

    • The field must reference an existing AddressGUID.
 

 

DEFAULTADDRESSTYPE

Optional:

This attribute provides the initial AsCodeAddressRole code selection on screen load. It must be an address role code provided by the <AddressTypes> structure below. This element will be ignored when COPYSOURCEADDRESSGUID is defined.

Values:

  • literal

    • This must be an existing CodeValue from AsCodeAddressRole.

<AddressTypes>

<Address>

  

Optional:

This element structure provides one or more Address Roles eligible for the Activity to add from which one would be selected by the user.

<AddressType>

<Address>

  

Required, Repeatable:

The value of this element is a single address role code and it identifies the address's field definition for data entry.  This element is repeated for each address role available for creation by this Activity from which the user will select one from a combo box.

Values:

  • literal code value

    • This must be an existing CodeValue from AsCodeAddressRole

XML Schema

<Transaction>
...        
    <Address DEFAULTADDRESSTYPE="[code value]">
        <AddressTypes>
            <AddressType>[code value]</AddressType>
            <AddressType>...</AddressType>
        </AddressTypes>
    </Address>
...
</Transaction>

OR

<Transaction>
...
    <Address COPYSOURCEADDRESSGUID="[field name]"></Address>
...
</Transaction>

XML Example

<Transaction>
...
    <Address DEFAULTADDRESSTYPE="02">
        <AddressTypes>
            <AddressType>01</AddressType>
            <AddressType>02</AddressType>
            <AddressType>03</AddressType>
            <AddressType>04</AddressType>
            <AddressType>05</AddressType>
        </AddressTypes>
    </Address>
...
</Transaction>

XML Example - 2

<Transaction>
...
    <Fields>
        ...
        <Field>
            <Name>AddressGUID</Name>
            ...
        </Field>
        ...
    </Fields>
    ...
    <Address COPYSOURCEADDRESSGUID="AddressGUID"/>
...
</Transaction>