Profiles

Profiles are used to configure entry allocation within Transaction Server. These profiles contain information about how entry allocation is performed. An entry services profile can contain multiple profiles for configuring different entry allocation processes. Each profile must start with a profile element.

profile Element

The profile element of the entry services profile is used to enable a specific Transaction Server entry allocation process. The profile contains detailed information about how entry allocation is performed. The profile element contains attributes for uniquely identifying and configuring a profile. The following table shows the attributes for the profile element.
Table 1. Attributes for the profile element
Attribute Required Values or example Description
type Yes type="ENTRY"
Note: Other entry allocation types to be defined later.
Identifies the type of entry allocation for which this profile is to be used. This attribute should always be ENTRY.
name Yes name="My entry profile"
Note: Maximum of 50 characters
Unique name that is given to this profile for identification purposes.
parameterSet No parameterSet="my parameters" Name of the parameterSet element that is defined.

Example profile element definition

<profile type="My Entry"
     name="my default profile"
     parameterSet="sample set of parameters"/>

sources Element

The sources element holds a list of valid source types. A source type identifies how data comes into the FTM database. A source is defined by using a type element. The following table shows the type values that can be used for the sources element.
Table 2. Valid source types
Source type Description
1 Sync
2 Electronic file
3 Gateway message queue
4 Business Rules

During the entry allocation process, entry services considers marking batches (ICLs) that come into the FTM database by any one of the defined source types only.

Sample sources element definition

<sources>
   <type>2</type>
   <type>3</type>
</sources>

collectionTypes Element

The collectionTypes element contains a list of valid collection types to include for this entry services profile. Each valid collection type is defined by using a type element. Any batch (ICL) that is available for entry allocation must belong to one of the listed collection types before it is considered for marking.
Note: The collectionTypes definition is ignored if no aggregation rules are defined.

Sample collectionTypes element definition

<collectionTypes>
   <type>0</type>
   <type>4</type>
   <type>9</type>
</collectionTypes>

sortPatterns Element

The sortPatterns element contains a list of sort patterns to include for this entry services profile. Each sort pattern is defined by using a pattern element. Any batch (ICL) that is available for entry allocation must belong to one of the listed patterns before it is considered for marking.
Note: The sortPatterns definition is ignored if no aggregation rules are defined.

Sample sortPatterns element definition

<sortPatterns>
   <pattern>108</pattern>
   <pattern>205</pattern>
</sortPatterns>

conditions Element

The conditions element contains a list of valid states to which a batch (ICL) must be set before it is considered for marking. Each valid condition is defined by using a column element. The value of the column element must be a valid database column that is found in the presentment database table and must be defined by using a timestamp data type. In order for a condition to be satisfied, the value for the specified column must not be null (containing a valid timestamp). All defined conditions must be satisfied for a batch (ICL) before it is considered for marking.

Sample conditions element definition

<conditions>
   <column>LOADED</column>
   <column>REPAIRED</column>
</conditions>

fileTypes Element

The fileTypes element contains a list of transmission type IDs to include for this entry services profile. Each transmission type ID is defined by using a type element. Any batch (ICL) that is available for entry allocation must be one of the listed transmission types before it is considered for marking. Transmission type IDs are defined in the File_type table.

Sample fileTypes element definition

<fileTypes>
   <type>6</type>
   <type>7</type>
</fileTypes>

aggregationRules Element

The aggregationRules element contains the rules on how to aggregate batches (ICLs) that are to be entry allocated. When marking batches (ICLs), one or more rules might be applied to help narrow the scope of the entry allocation unit. Thresholds can also be applied to limit the number of batches (ICLs) that are to be marked for each entry allocation. The following table shows the attributes for the aggregationRules element.
Table 3. Attributes for the aggregationRules element
Attribute Required Values or example Description
type Yes type="single presentment"

type="rule based"

Identifies the type of aggregation the entry allocation is to follow. Valid values are:
Single presentment
Each batch (ICL) that satisfies the current profile criteria is marked individually to its own entry. Any aggregation rules that are defined for this profile are ignored.
Presentment group
Each transmission that satisfies the current profile criteria is marked individually to its own entry.
Rule based
The entry allocation uses the provided aggregation rules that are defined for this profile. A minimum of one rule must exist.

Sample aggregationRules element definition (single batch (ICL))

<aggregationRules type="single presentment">
</aggregationRules>

Sample aggregationRules element definition (transmission)

<aggregationRules type="presentment group">
</aggregationRules>

Sample aggregationRules element definition (rule based)

<aggregationRules type="rule based">
   <rule name="My rule">
      .
      .
   </rule>
</aggregationRules>

Sample rule element definition

<rule name="My rule">
     .
     .
</rule>

groupSortPatterns element

The groupSortPatterns element indicates whether the entry marker treats the sort patterns as if they are uniform for the entire transmission. This element requires that the aggregation rules type attribute be set to presentment group and at least one sort pattern be defined. The only attribute for groupSortPatterns is a boolean value, which determines whether this functionality is enabled or not.

Sample groupSortPatterns element definition

<aggregationRules type="presentment group">
<groupSortPatterns value="true"/>
</aggregationRules>

key element

The key element contains a list of origins to include in the entry allocation process. A rule can contain multiple keys if needed, and each key can narrow the origins by their origin type. The following table shows the origin types for the key element.
Table 4. Origin types for the key element
Attribute Required Values or example Default Description
originType No originType="1" All origin types Identifies the type of the origins that are found in this key element. Valid values for origin type are:
1
Routing Number
2
DUNS Number
3
Federal Tax ID

Sample key element definition

<aggregationRules type="rule based">
   <rule name="My rule">
      <key originType="1">
         <origin>AAAA</origin>
         <origin>BBBB</origin>
         <origin>CCCC</origin>
      </key>
      <key>
         <origin>DFDDD</origin>
      </key>
   </rule>
</aggregationRules>