Profiles

Profiles are used to enable the extract processes within the Transaction Server. These profiles contain instructions on what kind of data to extract and how to process the data. The extraction profile can contain multiple profiles for extracting different kinds of data. Each profile must start with a profile element.

profile Element

The profile element of the extraction profile is used to enable a specific Transaction Server extract. The profile contains a detailed configuration that defines the kind of data to extract and how to process the data. The profile element contains attributes that are used to uniquely identify and configure 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="" Note: Other extraction types are to be defined later.	Identifies the type of extraction for which this profile is to be used.
name	Yes	name="`My extraction profile`" Note: Maximum of 50 characters	Unique name given to this profile for identification purposes.
exec	Yes	exec=	Name of the Java™ implementation class that is to perform the extract.
parameterSet	No	parameterSet="`my parameters`"	The name of the `parameterSet` element that is defined.

sources Element

The sources element holds a list of valid source types. A source type identifies how the data has come into the Transaction Server. 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
2	Electronic file
3	Gateway message queue
4	Business Rules

During the extraction process, the extraction only considers extracting batches (ICLs) that come into the Transaction Server by any one of the defined source types.

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 extraction profile. Each valid collection type is defined using a type element. Any batch (ICL) that is available for extraction must belong to one of the listed collection types before it is considered to be extracted.

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 extraction profile. Each sort pattern is defined using a pattern element. Any batch (ICL) that is available for extraction must belong to one of the listed patterns before it is considered to be extracted.

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 to be extracted. Each valid condition is defined using a column element. The value of the column element must be a valid database column found in the presentment database table and must be defined 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 time stamp). All of the defined conditions must be satisfied for a batch (ICL) before it is considered for extraction.

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 extraction profile. Each transmission type ID is defined using a type element. Any batch (ICL) that is available for extraction must have one of the listed transmission types before it is considered for extraction. 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 the batches (ICLs) that are to be extracted. When extracting batches (ICLs), one or more rules may be applied to help narrow the scope of the extraction. Thresholds may also be applied to limit the number of batches (ICLs) that are to be extracted. 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 extraction is to follow. Valid values are: single presentment Each batch (ICL) that satisfies the current profile criteria is extracted individually to its own file for processing by the host. Any rules defined for this profile are ignored. presentment group Each transmission that satisfies the current profile criteria is extracted individually to its own file. rule based The extraction uses the provided rules 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 sort patterns are treated 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.

Sample groupSortPatterns element definition:

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

key element

The key element contains a list of origins you wish to include in your extraction 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 the 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>