RecordSchema

A Data Intake Record Schema contains XML configuration to define all of the fields contained in an incoming record, and is configured to define all of the field names that can be received in a record.

RecordSchemaDefinition Elements/Attributes

Element/Tag Attribute Definition Element/Attribute Value and Description

< RecordSchema>

 

Required element:   

Opening and Closing tag of the Record definition.

 

<Entity>   Required element: The opening and closing tag of the schema  
  TYPE Required attribute: Identifies the entity for the field grouping.

PERSON

ADDRESS

POLICY

POLICYROLE

SEGMENT

SEGMENTROLE

CLASS

CLIENTRELATIONSHIP

PAYMENT

PAYMENTREFERENCE

  NAME

Required attribute:

Assigns a name to the field grouping. The name will be used to differentiate between record sets. This value must be unique within a single Record Schema

A string.

Note: This value must be unique for each entity type.

<Fields>

 

Opening and closing tag of the fields configuration. Standard fields configuration applies, although only the <Name>, <Display> and <DataType> sub-elements can be used. See the page Fields Elements for more information.

 

<Field>  

Repeatable element:

Standard fields configuration applies—see the Fields element page for more information.

 
<Name>  

Required element:

Standard fields configuration applies—see the Fields Elements page for more information..

 
<DataType>  

Required element:

Standard fields configuration applies—see the Fields Elements page for more information.

DATE

DECIMAL

INTEGER

PERCENT

MONEY

TEXT

<Defaultvalue>   Standard fields configuration applies—see the Fields Elements page for more information  
<Currency>   Standard fields configuration applies—see the Fields Elements page for more information  
<Constraints>   Optional element: The opening and closing tag for constraint configuration, which is used to validate the data being received.  
<Constraint>   Defines a single constraint  
  TYPE Specifies the type of constraint being utilized

REQUIRED: Used to enforce that a particular field in the schema must be provided in the incoming record. REQUIRED can be used for all field datatypes.

RANGE: Used to validate that a received value is within a configured range of values. If RANGE is used, two properties must be configured: one with NAME="MIN" and one with NAME="MAX" to specify the minimum and maximum values, respectively.

LENGTH: Used to impose restrictions on the number of characters within the value of a particular field in the incoming record. If LENGTH is used, two properties must be configured: one with NAME="MIN" and one with NAME="MAX" to specify the minimum and maximum values, respectively. LENGTH is only applicable to text fields.

VALIDVALUES: Used to validate that a value received for a field is on a configured list of acceptable values. If VALIDVALUES is used, two properties must be configured.

The first must have NAME="LOOKUP" and VALUE equal to the type of lookup to be used: FIXEDLIST, CODENAME or SQL.

The second should have NAME equal to the type of lookup being used to generate the valid values list.

This second property's NAME value will work as follows:

  • If FIXEDLIST is used, the <List> sub-element must be configured within the <Property> element, with repeatable <Value> elements specifying the individual values that must exist in the record.
  • If CODENAME is used, the <Property> element must have a value that is a code name from AsCode. The code values for the specified code will represent the list of valid values.
  • If SQL is used, the <Property> element must have a value that is a SQL query that retrieves the listing of valid values.
  • A <Property> element with NAME="INCLUDES" can be used in conjunction with the CODENAME lookup type. INCLUDES can be used to restrict the valid values to only those code values specified in the includes list.

VALIDVALUES is only applicable to text fields.

PATTERN: Uses regular expressions to impose constraints on the data received for a particular field. The expression will be used to validate that the received data adheres to the specified pattern. If PATTERN is used, a property must also be configured with NAME="REGEX".PATTERN is only applicable to text fields

  ONFAIL Specifies whether a warning or an error is returned when data does not satisfy the configured constraint

WARNING: A warning will be returned. A warning will not interrupt the intake process.

ERROR: An error will be returned. An error will interrupt the intake process.

<Property>   Defines details pertaining to the constraint being utilized by the field.

A string explaining the constraint.

Example: "Received value does not fit acceptable length."

  NAME Specifies a single property for the constraint.
  • VALUE
  • MIN
  • MAX
  • LOOKUP
  • LIST
  • REGEX
  • FAILUREMESSAGE
  • CODENAME
  • FIXEDLIST
  • SQL

The value of a property's NAME element is dependent on the type of constraint being used. See the explanation of the <Constraint> element's TYPE attribute above

<List>   When using a property with NAME="FIXEDLIST" or NAME="LIST", this element contains the values that must be listed in the configuration being processed through Data Intake  
<Value>   Specifies the value that must be configured in the list. The value that must be configured in the list.

 

XML Example

<RecordSchema>
<Entity TYPE="Person" NAME="Member">
<Fields>
<Field>
<Name>TaxId</Name>
<DataType>Text</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="ERROR">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">Tax Id field is required.</Property>
</Constraint>
<Constraint TYPE="LENGTH" ONFAIL="ERROR">
<Property NAME="MIN">9</Property>
<Property NAME="MAX">12
</Property>
<Property NAME="FAILUREMESSAGE">Received value does not fit acceptable length</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>LastName</Name>
<DataType>Text</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="WARNING">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">Last Name field was not provided</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>FirstName</Name>
<DataType>Text</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="WARNING">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">First Name field was not provided</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>MiddleInitial</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>Prefix</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>Suffix</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>Sex</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>DateOfBirth</Name>
<DataType>Date</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="ERROR">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">Date of Birth field is required.</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>DateOfDeath</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>LegalResidenceCountryCode</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>Email</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>TypeCode</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>SponsorId</Name
<DataType>Text</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="ERROR">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">Sponsor ID is required</Property>
</Constraint>
</Constraints>
</Field>
</Fields>
</Entity>
<Entity TYPE="Address" NAME="Member">
<Fields>
<Field>
<Name>RoleCode</Name>
<DataType>Text</DataType
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="WARNING">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">Address Role Code field is required.</Property>
</Constraint>
<Constraint TYPE="VALIDVALUES" ONFAIL="WARNING">
<Property NAME="LOOKUP">FIXEDLIST</Property>
<Property NAME="FIXEDLIST">
<List>
<Value>02</Value>
<Value>05</Value>
</List>
</Property>
<Property NAME="FAILUREMESSAGE">Address Role Code field value is invalid.</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>DefaultFlag</Name>
<DataType>ListBox</DataType>
</Field>
<Field>
<Name>EffectiveDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>ExpirationDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>AddressLine1</Name>
<DataType>Text</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="ERROR">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">Address Line 1 field is required.</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>AddressLine2</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>AddressLine3</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>AddressLine4</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>City</Name>
<DataType>Text</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="ERROR">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">City field is required.</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>CountryCode</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>StateCode</Name>
<DataType>Text</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="ERROR">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">State Code field is required.</Property>
</Constraint>
<Constraint TYPE="VALIDVALUES" ONFAIL="WARNING">
<Property NAME="LOOKUP">CODENAME</Property>
<Property NAME="CODENAME">AsCodeState</Property>
<Property NAME="FAILUREMESSAGE">State Code field value is invalid.</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>PostalId</Name>
<DataType>Text</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="ERROR">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">Postal Id field is required.</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>EMail</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>PhoneNumber</Name>
<DataType>Text</DataType>
</Field>
</Fields>
</Entity>
<Entity TYPE="IndividualRelationship" NAME="Member">
<Fields>
<Field>
<Name>RelationshipCode</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>ActiveFrom</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>EffectiveFrom</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>EffectiveTo</Name>
<DataType>Date</DataType>
</Field>
</Fields>
</Entity>
<Entity TYPE="Policy" NAME="Member">
<Fields>
<Field>
<Name>PolicyNumber</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>PolicyName</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>IssueStateCode</Name>
<DataType>Text</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="WARNING">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">Issue State field is required.</Property>
</Constraint>
<Constraint TYPE="VALIDVALUES" ONFAIL="WARNING">
<Property NAME="LOOKUP">CODENAME</Property>
<Property NAME="CODENAME">AsCodeState</Property>
<Property NAME="FAILUREMESSAGE">State Code field value is invalid.</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>PlanDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>CreationDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>ActivationDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>UnisexIndicator</Name>
<DataType>Check</DataType>
</Field>
<Field>
<Name>PaymentMode</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>PaymentMethod</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>EmployeePremiumAmount</Name>
<DataType>Money</DataType>
</Field>
<Field>
<Name>EmployerPremiumAmount</Name>
<DataType>Money</DataType>
</Field>
<Field>
<Name>AnnualPremium</Name>
<DataType>Money</DataType>
</Field>
</Fields>
</Entity>
<Entity TYPE="Segment" NAME="Member">
<Fields>
<Field>
<Name>EffectiveDate</Name>
<DataType>Date</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="WARNING">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">Effective Date field is required.</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>SegmentName</Name>
<DataType>Text</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="WARNING">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">Segment Name field is required.</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>StatusCode</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>IssueDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>CoverageCode</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>SegmentActiveCode</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>SegmentIssueDate</Name>
<DataType>Date</DataType>
</Field
<Field>
<Name>SegmentFaceAmount</Name>
<DataType>Money</DataType>
</Field>
<Field>
<Name>CoverageStartDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>CoverageEndDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>CoverageTier</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>SegmentUWClass</Name>
<DataType>Text</DataType>
</Field>
<Field
<Name>SegmentTobaccoPremBasis</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>SegmentTableRating</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>CoverageStatus</Name>
<DataType>Text</DataType>
</Field>
</Fields>
</Entity>
<Entity TYPE="SegmentRole" NAME="Member">
<Fields>
<Field>
<Name>RoleCode</Name>
<DataType>Text</DataType>
<Constraints>
<Constraint TYPE="VALIDVALUES" ONFAIL="WARNING">
<Property NAME="LOOKUP">FIXEDLIST</Property>
<Property NAME="FIXEDLIST">
<List>
<Value>72</Value>
<Value>73</Value>
<Value>74</Value>
</List>
</Property>
<Property NAME="FAILUREMESSAGE">Role Code field value is invalid.</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>RoleAmount</Name>
<DataType>Money</DataType>
</Field>
<Field>
<Name>RolePercent</Name>
<DataType>Percent</DataType>
</Field>
<Field>
<Name>StudentStatusIndicator</Name>
<DataType>ListBox</DataType>
</Field>
<Field>
<Name>StudentStatusConfirmedDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>EffectiveDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>TerminationDate</Name>
<DataType>Date</DataType>
</Field>
</Fields>
</Entity>
<Entity TYPE="PolicyRole" NAME="Member">
<Fields>
<Field>
<Name>RoleCode</Name>
<DataType>Text</DataType>
<Constraints>
<Constraint TYPE="VALIDVALUES" ONFAIL="WARNING">
<Property NAME="LOOKUP">FIXEDLIST</Property>
<Property NAME="FIXEDLIST">
<List>
<Value>71</Value>
</List>
</Property>
<Property NAME="FAILUREMESSAGE">Role Code field value is invalid.</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>RoleAmount</Name>
<DataType>Money</DataType>
</Field>
<Field>
<Name>RolePercent</Name>
<DataType>Percent</DataType>
<Constraints>
<Constraint TYPE="RANGE" ONFAIL="ERROR">
<Property NAME="MIN">0.0</Property>
<Property NAME="MAX">100.0</Property>
<Property NAME="FAILUREMESSAGE">Received value does is not valid</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>StudentStatusIndicator</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>StudentStatusConfirmedDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>EffectiveDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>TerminationDate</Name>
<DataType>Date</DataType>
</Field>
</Fields>
</Entity>
<Entity TYPE="Class" NAME="Member">
<Fields>
<Field>
<Name>ClassName</Name>
<DataType>Text</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="ERROR">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">Class Name field is required.</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>TypeCode</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>EffectiveFrom</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>EffectiveTo</Name>
<DataType>Date</DataType>
</Field>
</Fields>
</Entity>
<Entity TYPE="GroupCustomerRelationship" NAME="Member">
<Fields>
<Field>
<Name>GroupCustomerNumber</Name>
<DataType>Date</DataType>
<Constraints>
<Constraint TYPE="REQUIRED" ONFAIL="ERROR">
<Property NAME="VALUE">True</Property>
<Property NAME="FAILUREMESSAGE">Group Customer Number field is required.</Property>
</Constraint>
</Constraints>
</Field>
<Field>
<Name>ActiveFrom</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>EffectiveFrom</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>EffectiveTo</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>BusinessUnit</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>CustomerEmploymentStatusCode</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>EmployeeCategory</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>EmployeeDepartmentNumber</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>EmployeeIdentifier</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>EmployeePayFrequency</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>EmployeeSalary</Name>
<DataType>Money</DataType>
</Field>
<Field>
<Name>SalaryMultiplier</Name>
<DataType>Integer</DataType>
</Field>
<Field>
<Name>SalaryEffectiveDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>PastSalary</Name>
<DataType>Money</DataType>
</Field>
<Field>
<Name>EmploymentDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>ExpatriationIndicator</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>ExpatriationStatusDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>HireDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>JobClass</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>JobGrade</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>JobLocation</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>JobStatus</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>JobStatusEffectiveDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>MonthsOfService</Name>
<DataType>Integer</DataType>
</Field>
<Field>
<Name>RetirementDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Name>UnionNonUnionIndicator</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>UnionCode</Name>
<DataType>Text</DataType>
</Field>
<Field>
<Name>PayGroup</Name>
<DataType>Text</DataType>
</Field>
</Fields>
</Entity>
</RecordSchema>

 

 

 

 

Oracle Insurance Logo Copyright © 2017, Oracle and/or its affiliates. All rights reserved. About Oracle Insurance | Contact Us