PhoneScreen
The PhoneScreen business rule defines the format of the Phone screen that can be invoked from the Client, Address, and Group Customer screens.
Element/Tag | Attribute | Definition | Element/Attribute Value and Description |
---|---|---|---|
<PhoneScreen> |
|
|
|
<DefaultType> |
Optional element: Sets the default phone type. Note: While defining a default phone type, the configuration must be available, or an error results. |
A TypeCode from the AsCodePhoneType code name. |
|
<DefaultCountry> |
|
Optional element: Sets the default country. Note: When defining a default country, the configuration must be available, or an error results. |
Two-character alpha or numeric country codes from the CountryCode column of the AsCountry table (e.g. ’01’, ’02’). |
<AutoResetCallingCode> |
|
Optional element: Automatically resets the calling code (from the CallingCode column of AsCountry). |
Yes | No Yes: the system ‘resets’ the calling code (i.e. sets the code again) whenever the phone type or country code drop-down is changed for a phone number. No: the system does not set the calling code when a user attempts to create a new phone number |
<Phone> |
|
Repeatable element: Opening and closing element for each Phone Type and Country combination. |
|
<PhoneType>
|
|
Repeatable element: Opening and closing element for each Phone Type. |
|
VALUE |
Attribute specifying the Phone Type Code. |
A TypeCode from the AsCodePhoneType code name. |
|
NAME |
Optional attribute: Provides a descriptive name for the Phone Type for the configuror's reference. This attribute is for informational purposes only, and is not used by the system. |
A descriptive name for the Phone Type. |
|
<CountryCode>
|
|
Required. repeatable element: Contains a Country Code. The fields defined in this <Phone> element are defined for the country codes entered. |
ALL, or a two-character alpha or numeric country code from the AsCountry database table. |
NAME |
Optional attribute: Provides a descriptive name for the country for the configuror's reference. This attribute is for informational purposes only, and is not used by the system. |
A descriptive name for the country. For example, Canada, Nigeria, etc. |
|
<FixedFields> |
|
Repeatable element: See Fixed Fields. |
|
<DisplayFormat> |
|
Required, repeatable element: The opening and closing tag for the Parts section, which designates the format of the phone number. |
|
<Part>
|
|
Required, repeatable element: <Part> sub-elements define individual parts of the phone number. |
|
PRE |
Optional attribute: An optional delimiter preceding the phone number part. |
Comma, hyphen, or other delimiting character. |
|
POST |
Optional attribute: An optional delimiter following the phone number part. |
Comma, hyphen, or other delimiting character. |
XML Example
<PhoneScreen>
<DefaultType>01</DefaultType>
<DefaultCountry>01</DefaultCountry>
<AutoResetCallingCode>Yes</AutoResetCallingCode>
<Phone >
<!-- Phone Type Value below is AsCodePhoneType. CountryCode
values are from AsCountry. NAME is an information only attribute-->
<PhoneType VALUE="01" NAME="Home">
<CountryCode>01</CountryCode>
<CountryCode>05</CountryCode>
</PhoneType>
<!--These fields apply only to the Countries
specified in the country codes and Phone Type above -->
<FixedFields>
<Field>
<Name>CallingCode</Name>
<Display>Country Code</Display>
</Field>
<Field>
<Name>PhoneNumber</Name>
<Display>Phone Number</Display>
<Datatype MASK="PHONE">Text</Datatype>
</Field>
</FixedFields>
<DisplayFormat>
<Part>CallingCode</Part>
<Part PRE="-">PhoneNumber</Part>
</DisplayFormat>
</Phone>
<Phone>
<PhoneType VALUE="02" NAME="Work">
<CountryCode>02</CountryCode>
<CountryCode>08</CountryCode>
</PhoneType>
<FixedFields>
<Field>
<Name>CallingCode</Name>
<Display>Country Code</Display>
<Length>3</Length>
</Field>
<Field>
<Name>PhoneNumber</Name>
<Display>Phone Number</Display>
<Length>10</Length>
</Field>
<Field>
<Name>Extension</Name>
<Display>Ext</Display>
<Length>5</Length>
</Field>
</FixedFields>
<DisplayFormat>
<Part>CallingCode</Part>
<Part PRE="-" POST="-">PhoneNumber</Part>
<Part> Extension</Part>
</DisplayFormat>
</Phone>
<Phone>
<PhoneType VALUE="02" NAME="Work">
<CountryCode>11</CountryCode>
</PhoneType>
<PhoneType VALUE="01" NAME="Home">
<CountryCode>11</CountryCode>
</PhoneType>
<PhoneType VALUE="01" NAME="Mobile">
<CountryCode>11</CountryCode>
</PhoneType>
<FixedFields>
<Field>
<Name>CallingCode</Name>
<Display>Country Code</Display>
<Length>3</Length>
</Field>
<Field>
<Name>PhoneNumber</Name>
<Display>Phone Number</Display>
<Length>10</Length>
</Field>
<Field>
<Name>Extension</Name>
<Display>Ext</Display>
<Length>5</Length>
</Field>
</FixedFields>
</Phone>
<Phone>
<PhoneType VALUE="03" NAME="Pager">
<!-- Using default CountryCode -->
</PhoneType>
<FixedFields>
<Field>
<Name>CallingCode</Name>
<Display>Country Code</Display>
<Length>3</Length>
</Field>
<Field>
<Name>PhoneNumber</Name>
<Display>Phone Number</Display>
<Length>10</Length>
</Field>
<Field>
<Name>Extension</Name>
<Display>Ext</Display>
<Length>5</Length>
</Field>
</FixedFields>
</Phone>
</PhoneScreen>