AddressScreen
The Address screen allows for multiple addresses to be saved for
The AddressRoleCode, CountryCode, EffectiveDate and ExpirationDate fixed fields cannot be disabled by any type of configuration.
Element/Tag | Attribute | Definition | Element/Attribute Value and Description |
---|---|---|---|
<AddressScreen> |
The start and end tag of the business rule configuration. |
|
|
<CountryCodeOrdinal> | Optional: A sub-element to AddressScreen, containing the CountryCodeOrdinal. | SQL Statement. Output must return two columns, the CountryCode and CountryLongName If not used, countries will be ordered in alpha order by code value (as is today). | |
TITLE | Optional element: Allows a Display Name to be configured. | String: This option is effective only if TYPE is equal to SQL, if the option is not used, the system will show the default behavior. | |
TYPE | Optional element: Allows population of CountryCode with a SQL statement. | SQL | |
<DisplayPhoneScreen> |
Optional element: Specifies whether the Phone screen should be enabled or disabled. |
Yes: The Phone screen will be enabled. No: The Phone screen will be disabled. This is the default value. |
|
<AllowExpiration> |
This tag indicates the ability to provide the customer with automated functionality to expire mailing addresses based on date criteria and a contingent value established to introduce an active or inactive status. It also controls the visibility of EffectiveDate and ExpirationDate Fixed Fields.
|
Indicates the ability to add another column named "Status", and will be displayed beside the Address. Example: <AllowExpiration>Yes</AllowExpiration> or <AllowExpiration>No</AllowExpiration> Yes: Indicates the ability to Expire the Address when the expiration date of the address is set to a date before or equal to the system date. The Address is not deleted but the 'Status' column displays as 'Expired' and the address fields are disabled (except the Expiration Date field). No: The "Status" column is not displayed beside the Address(es). The user should be able to delete the address associated with a Client |
|
<Address> |
Required and Repeatable Element: Indicates the start of address definition for fields and validations applying to a client |
||
<AddressType> |
|
Required and Repeatable: A sub-element to Address, containing the Address Type Code. |
|
VALUE |
Attribute containing Address Type Code. |
Value from the AsCodeAddressRole column of the AsCode table: ‘01’, ‘02’, etc. |
|
NAME |
Optional: Used to help configuration analyst to identify Address Types. Not recognized by the system |
Home, Residence, Bank, EFT, etc. |
|
<CountryCode> |
Required and Repeatable: A sub-element to AddressType, containing the Country Code. |
Value from the CountryCode column of the AsCountry table, a two-character alpha or numeric country code: e.g. ’01’, ’02’, ‘US’, ‘JP’, etc. |
|
NAME |
Optional: Used to help configuration analyst to identify Countries. Not recognized by the system. |
USA, Canada, Japan, etc. |
|
<FixedFields> |
|
Repeatable element: Allows configuration of 'above the line' fields. See Fields Element. |
String: The fields must correspond to a column in the AsAddressField database table. The following Fixed Fields are configurable: AddressLine1, AddressLine2, AddressLine3, AddressLine4, AddressLine5, AddressLine6, RegionCode, MunicipalityCode, City, StateCode, PostalID, Email, PhoneNumber, FaxNumber, EffectiveDate, ExpirationDate. AddressRoleCode and CountryCode are non-configurable Fixed Fields. |
<MultiFields> |
Optional element; Allows configuration of MultiFields in the screen. See MultiFields element for additional information. |
||
<Events> |
|
See Action/Events section. |
This rule may contain multiple configuration sectors based on different address types, each containing its own Events section, which will act only on the Fields and MultiFields configured within the same sector. |
<Event>
|
ONSUBMIT ONLOAD ONCHANGE |
|
|
<ScreenMath> |
|
See ScreenMath Element. | |
<Actions> |
|
See Action/Events section. |
|
<Spawns>
|
This is the start and end element for the Spawns element. |
Client level spawning is supported on these screens. |
|
<Spawn> |
Required element: Opening element that defines the transaction to spawn and its data. |
||
IF |
Optional attribute: Condition that when true initiates the spawn. If not present spawn will generate under all conditions. |
String:Go to Operators available for EXPRESSION Writing to see what operators you may use for condition writing. |
|
<Transaction> |
String:Name of the transaction to be spawned. |
||
FIELD |
Required: This attribute provides the spawned activity’s effective date. |
String:A screen math variable or field containing a date value. |
|
SPAWNCODE |
As defined by codename in AsCodeSpawn in AsCode table. Determines effective date of spawned transaction. |
Code: '03'Note: Other spawn codes not supported. |
|
<SpawnFields> |
|
Opening and closing tags identify the SpawnField section of the spawn. |
|
<SpawnField> |
|
Required, Repeatable: Identifies and defines the fields that will be spawned and value populated when Spawn section of the AddressScreen business rule processes. |
|
<From> |
|
Required: Designates the names of Fields and/or MathVariables to be passed to the spawned activity |
Name of FixedField, Field, or ScreenMath MathVariable within <Address> section |
<To> |
|
Required: Defines the field in the spawned activity to be populated. |
Name of ActivityField or MathVariable in the spawned activity. |
<DataType> |
|
Required: Defines the value of the DataType for the spawned Activity field. |
Date
|
<ScreenMath> |
|
See ScreenMath Element. |
|
<Actions> |
|
See Action/Events section. |
|
<DisplayFormat> |
Required, Repeatable: The opening and closing tag for the Parts section, which designates Address Fields’ order, alignment, and any symbols or codes for the viewable address. |
||
<Part> |
Required. Repeatable: <Part> sub-elements define individual parts of the finished product, visible in the Address Summary table, Client Search Results table, |
||
PRE |
Optional A delimiter that precedes the contents of the field . |
Comma, hyphen, space, slash, etc. |
|
POST |
Optional A delimiter that follows the contents of the field. |
Comma, hyphen, space, slash, etc. |
XML Example
<AddressScreen>
<AllowExpiration>Yes</AllowExpiration>
<Address>
<AddressType VALUE="03" NAME="Residence">
<CountryCode>US</CountryCode>
<CountryCode>GB</CountryCode>
<CountryCode>CA</CountryCode>
<CountryCode>ES</CountryCode>
</AddressType>
<AddressType VALUE="04" NAME="Billing">
<CountryCode>US</CountryCode>
<CountryCode>GB</CountryCode>
<CountryCode>CA</CountryCode>
<CountryCode>ES</CountryCode>
</AddressType>
<AddressType VALUE="05" NAME="Mailing">
<CountryCode>US</CountryCode>
<CountryCode>GB</CountryCode>
<CountryCode>CA</CountryCode>
<CountryCode>ES</CountryCode>
</AddressType>
<MultiFields RULE="MultiField-Phones">Yes</MultiFields>
<FixedFields>
<Field>
<Name>AddressLine1</Name>
<Display>Address</Display>
<Expanded>Yes</Expanded>
</Field>
<Field>
<Name>AddressLine2</Name>
<Display></Display>
<Expanded>Yes</Expanded>
</Field>
<Field>
<Name>AddressLine3</Name>
<Display></Display>
<Expanded>Yes</Expanded>
</Field>
<Field>
<Name>AddressLine4</Name>
<Display></Display>
<Expanded>Yes</Expanded>
</Field>
<Field>
<Name>City</Name>
<Display>City</Display>
</Field>
<Field>
<Name>StateCode</Name>
<Display>State</Display>
<Query TYPE="SQL">Select CodeValue, SHORTDESCRIPTION
from AsCode where CODENAME = 'AsCodeState' order by CodeValue</Query>
</Field>
<Field>
<Name>PostalID</Name>
<Display>Zip</Display>
</Field>
<Field>
<Name>Email</Name>
<Display>Email</Display>
</Field>
<Field>
<Name>FaxNumber</Name>
<Display>Fax Number</Display>
</Field>
<Field>
<Name>EffectiveDate</Name>
<DataType FORMAT="USDateFormat">Date</DataType>
<Display>Effective Date</Display>
</Field>
<Field>
<Name>ExpirationDate</Name>
<DataType FORMAT="USDateFormat">Date</DataType>
<Display>Expiration Date</Display>
</Field>
</FixedFields>
<Fields>
<Field>
<Name>BankAccountNumber</Name>
<Display>Bank Account Number</Display>
<DataType>Text</DataType>
</Field>
<Field>
<Name>ReturnMailIndicator</Name>
<Display>Return Mail Indicator</Display>
<DataType>Check</DataType>
<DefaultValue>CHECKED</DefaultValue>
</Field>
<Field>
<Name>ReturnedMailDate</Name>
<Display>Returned Mail Date</Display>
<DataType>Date</DataType>
<Hidden>Yes</Hidden>
</Field>
<Field>
<Name>LetterMailDate</Name>
<Display>Address Update Mail Date</Display>
<DataType>Date</DataType>
<Hidden>Yes</Hidden>
</Field>
<Field>
<Name>CostOfStamp</Name>
<Display>Cost Of Stamp</Display>
<DataType>Money</DataType>
<DefaultValue>0</DefaultValue>
</Field>
<Field>
<Name>TestInteger</Name>
<Display>Integer</Display>
<DataType>Integer</DataType>
<DefaultValue>0</DefaultValue>
</Field>
<Field>
<Name>TestDecimal</Name>
<Display>Decimal</Display>
<DataType>Decimal</DataType>
<DefaultValue>0</DefaultValue>
</Field>
<Field>
<Name>ClientGUID</Name>
<Display>Client</Display>
<DataType>Combo</DataType>
<Query TYPE="SQL">SELECT ClientGUID, FirstName || ' ' || LastName From AsClient Where ClientGUID = '[ClientGUID]'</Query>
<Expanded>Yes</Expanded>
<Disabled>Yes</Disabled>
</Field>
<Field>
<Name>SystemDateGSM</Name>
<Display>System Date</Display>
<DataType>Date</DataType>
<Disabled>Yes</Disabled>
</Field>
</Fields>
<Events>
<Event TYPE="ONLOAD">
<Math ID="EventMath"></Math>
<ActionSet ID="OnLoadActionSet"></ActionSet>
</Event>
<Event TYPE="ONLOAD">
<Math ID="SpawnMath"></Math>
<ActionSet ID="LetterDateActionSet"></ActionSet>
</Event>
<Event TYPE="ONCHANGE" FIELD="ReturnMailIndicator">
<Math ID="EventMath"></Math>
<ActionSet ID="OnChangeActionSet"></ActionSet>
</Event>
<Event TYPE="ONCHANGE" FIELD="StateCode">
<ActionSet ID="DelawareZips" FIELD="PostalID"></ActionSet>
</Event>
<Event TYPE="ONSUBMIT">
<Math ID="SpawnMath"></Math>
<ActionSet ID="FinalValidation"></ActionSet>
<Spawns>
<Spawn IF="Not IsEmpty(SpawnMath:MVAddressGUID)">
<Transaction SPAWNCODE="03" FIELD="LetterMailDate">ClientAddressChangeLetter</Transaction>
<SpawnFields>
<SpawnField>
<From>SpawnMath:MVClientGUID</From>
<To>ClientGUID</To>
<DataType>Text</DataType>
</SpawnField>
<SpawnField>
<From>SpawnMath:MVAddressGUID</From>
<To>AddressGUID</To>
<DataType>Text</DataType>
</SpawnField>
<SpawnField>
<From>SpawnMath:MVTestInteger</From>
<To>TestInteger</To>
<DataType>Integer</DataType>
</SpawnField>
<SpawnField>
<From>SpawnMath:MVSystemDateGSM</From>
<To>SystemDateGSM</To>
<DataType>Date</DataType>
</SpawnField>
<SpawnField>
<From>SpawnMath:MVTestDecimal</From>
<To>TestDecimal</To>
<DataType>Decimal</DataType>
</SpawnField>
<SpawnField>
<From>SpawnMath:MVCostOfStamp</From>
<To>CostOfStamp</To>
<DataType>Money</DataType>
</SpawnField>
<SpawnField>
<From>AddressLine1</From>
<To>AddressLine1</To>
<DataType>Text</DataType>
</SpawnField>
<SpawnField>
<From>City</From>
<To>City</To>
<DataType>Text</DataType>
</SpawnField>
<SpawnField>
<From>StateCode</From>
<To>StateCode</To>
<DataType>Combo</DataType>
</SpawnField>
<SpawnField>
<From>PostalID</From>
<To>PostalID</To>
<DataType>Text</DataType>
</SpawnField>
<SpawnField>
<From>LetterMailDate</From>
<To>LetterMailDate</To>
<DataType>Date</DataType>
</SpawnField>
</SpawnFields>
</Spawn>
</Spawns>
</Event>
</Events>
<ScreenMath>
<Math ID="EventMath">
<MathVariables>
<MathVariable VARIABLENAME="MVReturnMailIndicator" TYPE="EXPRESSION" DATATYPE="TEXT">ReturnMailIndicator</MathVariable>
</MathVariables>
</Math>
<Math ID="SpawnMath">
<MathVariables>
<MathVariable VARIABLENAME="MVClientGUID" TYPE="EXPRESSION" DATATYPE="TEXT">ClientGUID</MathVariable>
<MathVariable VARIABLENAME="MVAddressGUID" TYPE="EXPRESSION" DATATYPE="TEXT">AddressGUID</MathVariable>
<MathVariable VARIABLENAME="MVTestInteger" TYPE="EXPRESSION" DATATYPE="INTEGER">TestInteger</MathVariable>
<MathVariable VARIABLENAME="MVTestDecimal" TYPE="EXPRESSION" DATATYPE="DECIMAL">TestDecimal</MathVariable>
<MathVariable VARIABLENAME="MVCostOfStamp" TYPE="EXPRESSION" DATATYPE="CURRENCY">CostOfStamp</MathVariable>
<MathVariable VARIABLENAME="MVSystemDateGSM" TYPE="SYSTEMDATE" DATATYPE="DATE"></MathVariable>
</MathVariables>
</Math>
</ScreenMath>
<Actions>
<ActionSet ID="OnLoadActionSet">
<Action ACTIONTYPE="SHOW" FIELD="ReturnedMailDate"></Action>
</ActionSet>
<ActionSet ID="OnChangeActionSet">
<Condition IF="EventMath:MVReturnMailIndicator='UNCHECKED'">
<Action ACTIONTYPE="HIDE" FIELD="ReturnedMailDate"></Action>
<Else>
<Action ACTIONTYPE="SHOW" FIELD="ReturnedMailDate"></Action>
</Else>
</Condition>
</ActionSet>
<ActionSet ID="LetterDateActionSet">
<Condition IF="Not IsEmpty(SpawnMath:MVAddressGUID)">
<Action ACTIONTYPE="SHOW" FIELD="LetterMailDate"></Action>
<Else>
<Action ACTIONTYPE="HIDE" FIELD="LetterMailDate"></Action>
</Else>
</Condition>
<Condition IF="Not IsEmpty(SpawnMath:MVSystemDateGSM)">
<Action ACTIONTYPE="ASSIGN" FIELD="SystemDateGSM">SpawnMath:MVSystemDateGSM</Action>
</Condition>
</ActionSet>
<ActionSet ID="DelawareZips">
<Condition IF="StateCode='08'">
<Action ACTIONTYPE="ASSIGN" FIELD="PostalID">'19702'</Action>
</Condition>
</ActionSet>
<ActionSet ID="FinalValidation">
<Condition IF="Not IsEmpty(SpawnMath:MVAddressGUID) And IsEmpty(LetterMailDate)">
<Action ACTIONTYPE="ERROR">Address Update Mail Date is a required field.</Action>
</Condition>
<Condition IF="IsEmpty(AddressLine1)">
<Action ACTIONTYPE="ERROR">Address Line 1 is a required field.</Action>
</Condition>
<Condition IF="IsEmpty(City)">
<Action ACTIONTYPE="ERROR">City is a required field.</Action>
</Condition>
<Condition IF="IsEmpty(StateCode)">
<Action ACTIONTYPE="ERROR">State is a required field.</Action>
</Condition>
<Condition IF="IsEmpty(PostalID)">
<Action ACTIONTYPE="ERROR">Zip Code is a required field.</Action>
</Condition>
</ActionSet>
</Actions>
<DisplayFormat>
<Part>AddressLine1</Part>
<Part PRE=", ">AddressLine2</Part>
<Part PRE=", ">AddressLine3</Part>
<Part PRE=", ">AddressLine4</Part>
<Part PRE=", ">City</Part>
<Part PRE=", ">StateCode</Part>
<Part PRE=", ">PostalID</Part>
</DisplayFormat>
</Address>
<Address ROLE="05" NAME="Mailing">
<Fields>
<Field>
<Name>SeqID</Name>
<Display>SeqID</Display>
<DataType>Identifier</DataType>
<Parts>
<Part TYPE="SEQUENCE" FORMAT="0000000000">SeqID</Part>
</Parts>
<Hidden>No</Hidden>
</Field>
<Field>
<Name>BankAccountNumber</Name>
<Display>Bank Account Number</Display>
<DataType>Text</DataType>
</Field>
</Fields>
<Events>
<Event TYPE="ONLOAD">
<ActionSet ID="DisableFields"></ActionSet>
</Event>
</Events>
<Actions>
<ActionSet ID="DisableFields">
<Condition IF="PreferenceOne ='Test'">
<Action ACTIONTYPE="DISABLEALL"/>
</Condition>
</ActionSet>
</Actions>
</Address>
</AddressScreen>
XML Schema
<AddressScreen>
<CountryCodeOrdinal TITLE="String" TYPE="SQL">String</CountryCodeOrdinal>
<AllowExpiration>Yes|No</AllowExpiration>
<Address>
<AddressType VALUE="[AsCode.AsCodeAddressRole value]"{ NAME="[literal]}">
<CountryCode>[AsCountry.CountryCode value]</CountryCode>
</AddressType>
<FixedFields>[Fields Elements]</FixedFields>
<Fields>[Fields Elements]</Fields>
<Events>[Action/Events]</Events>
<ScreenMath></ScreenMath>
<Actions>[Action/Events]</Actions>
<DisplayFormat>
<Part{ PRE="[padding characters]"}{ POST="[padding characters]"}>[field name]</Part>
</DisplayFormat>
</Address>
</AddressScreen>