Intake Profile Definition
The Intake Profile Definition page is used to configure a Data Intake Profile. The page consists of three tabs containing text editors similar to the XML Source pane used to configure business rules, transactions and other entities elsewhere in the Rules Palette.
Tabs
IntakeProfileDefinition
This tab is used to configure a Data Intake Record Schema, which is used 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. For information on configuring a Data Intake Record Schema, see the XMLConfiguration Guide—navigate to Integration |Data Intake | RecordSchema.
File
This tab is used to configure a Data Intake File Definition, which allows for the creation of dynamic fields for a Data Intake File. The processing of files through Data Intake supports the writing of data back to these fields. For information on configuring a Data Intake File Definition, see the XMLConfiguration Guide—navigate to Integration |Data Intake | FileDefinition.
Record
This tab is used to configure a Data Intake Record Definition, which allows for the creation of dynamic fields for a Data Intake Record. The processing of files through Data Intake supports the writing of data back to these fields. For information on configuring a Data Intake File Definition, see the XMLConfiguration Guide—navigate to Integration |Data Intake | RecordDefinition.
Creating and Editing Intake Profile Definitions
Creating an Intake Profile Definition
- Navigate to the Admin Explorer window.
- Expand the Administration folder.
- Right-click on the Intake Profile Definition folder and select New Intake Profile Definition.
- Enter a name for the Intake Profile Definition in the Profile Definition Name field.
- Select the company to which the Intake Profile Definition should belong from the Company drop-down.
- Select a TypeCode for the IntakeProfile Definition from the Definition Type Code drop-down.
- Click Finish.
Editing an Intake Profile Definition
- Navigate to the Admin Explorer window.
- Expand the Administration folder.
- Expand the Intake Profile Definition folder.
- Expand the folder for the Intake Profile Definition that requires editing.
- Right-click on the IntakeProfile Definition's XML file and select Check out.
- Make the necessary changes.
- Right-click on the IntakeProfile Definition's XML file and select Check in.
On editing the Record Schema of any Intake profile definition, there will be an option available in PAS to update the Record Schema for their respective Intake profiles (Created via PAS before the definition was edited)
A Merge button will be provided on the Intake profile Screen in OIPA for all the profile’s for which the record schema of the definition has been updated
On click of ‘Merge’ button all the ‘New’ Fields or Entities added to the definition will be copied over from the definition (ASINTAKEPROFILEDEFINITION) to the Record Schema of the Profiles created via PAS (ASINTAKEPROFILE).
Please note that only new fields and entities will be copied and no changes would be made to an existing field (even though there was a modification done in Profile definition). If required all such changes needs to be manually done on those specific Fields or Entities via Record details tab on the Intake profile screen.
The availability of ‘Merge’ button in PAS will be controlled via security given to the ‘Merge’ button in ‘Intake Profile’ page under Company pages security.
DI Batch Processing in Parallel for a Group Customer with the Same Profile
The Data Intake solution allows to load and process the records in small batches belonging to a Group Customer with the same profile. The system processes the batch records in parallel utilizing 80% of the CPU. This increases the throughput and reduces the waiting time of the messenger tools to load DI records.
In the DI processing, when there are files for the same Group Customer and Profile,
- If the file is identified as containing Independent records, then the file is processed in parallel.
- If the file is identified as containing Dependent records, then the file is processed in sequence.
| Note | In a Dependent record, the file includes the primary member and their dependents. In this case, the primary member record is sent first for processing and in the next batch their dependent records are processed. In an Independent record, there is no dependency between the primary member and their members. Hence, each record is considered as independent. |
DI processing uses the <independent> tag to identify whether a file contains Independent or Dependent records, which is added to the file header record.
Example
<pathToMemberId>Member/Person/Fields/TaxId</pathToMemberId>
<groupCustomerNumber>2012</groupCustomerNumber> <!-- Group Customer Number-->
<profileName>DI Demo Test Profile</profileName> <!-- Name of the Profile -->
<independent>Yes</independent> <!-- Identifier whether to process records independently -->
The following properties are attached to process the message on server side:
|
PropertyName |
Property Type |
PropertyValue |
Description |
|
operation |
String |
beginLoading(hard coded string) |
Name of the operation |
|
File ID |
String |
FileID(Generated Value) |
Generated GUID value for each file |
|
groupCustomerNumber |
String |
GroupCustomerNumber (captured from Intake File) |
Customer Number |
|
profileName |
String |
ProfileName (Captured from Intake File) |
Intake Profile Name |
|
expectedRecordCount |
Integer |
expectedRecordCount (number of records in a file) |
Count of Records for each file. This can be calculated using XPATH on the input file. |
| independent | String | Y or N | Identifies whether the records are 'Independent' or 'Dependent' The attribute is optional. |
If the file is marked with independent='Y' attribute, it will be processed in parallel / immediately without waiting on another file to be loaded. If the file is marked with independent='N', the DI file is processed in sequential order.