public class Workflow
{
public string Name;
public string Description;
public string[] EmailAddresses;
public GoneawayServices[] GoneawayServices;
public MoversServices[] MoversServices;
public NCOAProcessingType MoversProcessing;
public DeceasedServices[] DeceasedServices;
public bool Deduplicate;
public bool TelNoUplift;
public bool TelNoCompare;
public bool TelephoneValidation;
public bool MPS;
public bool GenderDetection;
public bool NameAnalysis;
public bool AddressCleanse;
public bool Profile;
public bool ResidencyVerification;
public bool TelNoAppendOSIS;
public bool TelNoAppendLifestyle;
public bool TelNoAppendDebtSearch;
public bool TPSOSIS;
public bool TPSExisting;
public bool TPSLifestyle;
public bool TPSDebtSearch;
public bool EmailValidation;
public string[] StopFileNames;
}
Describes a workflow definition, including a list of services that should be applied as part
of a data cleansing job.
-
The Name field defines the unique name used to identify this workflow definition.
-
The Description field contains a human-readable description of this workflow definition.
-
The EmailAddresses field contains an array of email addresses to which a notification email
should be sent when a job created with this workflow has finished.
-
The GoneawayServices field contains an array indicating the data sources to be used when identifying
goneaways. Each item in the array can be one of the types listed in the
GoneawayServices enumeration. If goneaway screening is
not required, this can be set to an empty array.
Statistics Section - Goneaway
- ForenameLevelMatches - indicates how many records are identified as goneaway with a full forename level match.
- InitialLevelMatches - indicates how many records are identified as goneaway with an initial level match.
- SurnameLevelMatches - indicates how many records are identified as goneaway with a surname level match.
-
The MoverServices field contains an array indicating the data sources to be used when identifying movers.
Each item in the array can be one of the types listed in the MoverServices
enumeration. If mover identification is not required, this can be set to an empty array.
Statistics Section - Movers
- ForenameLevelMatches - indicates how many records are identified as movers with a full forename level match.
- InitialLevelMatches - indicates how many records are identified as movers with an initial level match.
- SurnameLevelMatches - indicates how many records are identified as movers with a surname level match.
-
The MoversProcessing field indicates how any record identified as being a mover is handled by the rest of the
workflow. This field can be set to one of the values listed in the NCOAProcessingType
enumeration.
-
The DeceasedServices field contains an array indicating the data sources to be used when identifying deceased records.
Each item in the array can be one of the types listed in the DeceasedServices
enumeration. If deceased screening is not required, this can be set to an empty array.
Statistics Section - Deceased
- ForenameLevelMatches - indicates how many records are identified as deceased with a full forename level match.
- InitialLevelMatches - indicates how many records are identified as deceased with an initial level match.
- SurnameLevelMatches - indicates how many records are identified as deceased with a surname level match.
-
The Deduplicate field indicates if data cleansing jobs created using this workflow should be created with a
deduplication step.
Statistics Section - Deduplicate
- RecordsKeptAtForename - indicates how many records are retained after removing any unnecessary duplicates with full forename level matching.
- RecordsKeptAtInitial - indicates how many records are retained after removing any unnecessary duplicates with initial level matching.
- RecordsKeptAtSurname - indicates how many records are retained after removing any unnecessary duplicates with surname level matching.
-
The TelNoUplift field is obsolete and can be ignored.
-
The TelNoCompare field is obsolete and can be ignored.
-
The TelephoneValidation field indicates if data cleansing jobs created using this workflow should be created with
a telephone validation step, validating any existing telephone numbers in the user's data.
Statistics Section - TelephoneValidation
- BlankNumbers - indicates how many telephone number fields are blank.
- ForeignNumbers - indicates how many telephone number fields contain a foreign number.
- InvalidNumbers - indicates how many telephone number fields contain invalid numbers.
- ValidNumbers - indicates how many telephone number fields contain valid (or blank) numbers.
-
The MPS field indicates if data cleansing jobs created using this workflow should be created with an
MPS step, checking if any of the records in the user's data are present on the Mailing Preference Service file.
Statistics Section - MPS
- HouseholdMatches - indicates how many records matched to the MPS file at household level.
- InitialLevelMatches - indicates how many records matched to the MPS file at initial level. Obsolete - use PersonalMatches instead.
- PersonalMatches - indicates how many records matched to the MPS file at personal level.
- RecordsMatched - indicates how many records matched to the MPS file in total.
-
The GenderDetection field indicates if statistics should be generated identifying what proportion of the user's
data is male and what proportion is female.
Statistics Section - Gender
- Male - indicates how many records have been identified as being male.
- Female - indicates how many records have been identified as being female.
-
The NameAnalysis field indicates if statistics should be generated identifying what proportion of the user's data
contains a full name, what proportion contains only a first initial and surname, and what proportion contains only
a surname.
Statistics Section - NameAnalysis
- ForenameLevel - indicates how many records contain a full forename and surname.
- InitialLevel - indicates how many records contain only an initial and surname.
- SurnameLevel - indicates how many records contain only a surname.
- NoName - indicates how many records contain no name information.
-
The AddressCleanse field indicates if data cleansing jobs created using this workflow should be created with
an address cleansing step, checking and correcting addresses against the Royal Mail's PAF file.
Statistics Section - AddressCleanse
- PostallyCorrectBefore - indicates how many records already contained a valid address.
- PostallyCorrectAfter - indicates how many records contain a valid address after being cleansed.
- PostallyCorrectableBefore - indicates how many records contained an invalid address that can be corrected.
- PostallyIncorrectable - indicates how many records contained an invalid address that cannot be corrected.
- PostcodeIdentifiedBefore - indicates how many records already contained a full postcode.
- PostcodeIdentifiedAfter - indicates how many records contained a full postcode after being cleansed.
- SectorIdentifiedBefore - indicates how many records already contained a postcode sector.
- SectorIdentifiedAfter - indicates how many records contained a postcode sector after being cleansed.
- DistrictIdentifiedBefore - indicates how many records already contained a postcode district.
- DistrictIdentifiedAfter - indicates how many records contained a postcode district after being cleansed.
- AreaIdentifiedBefore - indicates how many records already contained a postcode area.
- AreaIdentifiedAfter - indicates how many records contained a postcode area after being cleansed.
- NoPostcodeIdentifiedBefore - indicates how many records already contained a blank postcode.
- NoPostcodeIdentifiedAfter - indicates how many records contained a blank postcode after being cleansed.
- ForeignIdentifiedBefore - indicates how many records could be identified as being foriegn.
-
The Profile field is obsolete and can be ignored.
-
The ResidencyVerification field is obsolete and can be ignored.
-
The TelNoAppendOSIS field indicates whether additional telephone numbers should be obtained by matching against the BT OSIS
file.
Statistics Section - TelNoAppendOSIS
- DEMatched - indicates the number of records for which a telephone number is available from the BT OSIS file.
-
The TelNoAppendLifestyle field indicates whether additional telephone numbers should be obtained by matching against various lifestyle
databases.
Statistics Section - TelNoAppendLifestyle
- LandlinesSurname - indicates the number of records for which a landline telephone number is available from the lifestyle database with a surname level match.
- MobilesInitial - indicates the number of records for which a mobile telephone number is available from the lifestyle database with an initial level match.
-
The TelNoAppendDebtSearch field indicates whether additional telephone numbers should be obtained by matching against various debt-related
databases.
Statistics Section - TelNoAppendDebtSearch
- RecordsMatched - indicates the number of records for which a telephone number is available from the debt databases.
-
The TPSOSIS field indicates whether telephone numbers appended from the BT OSIS database should be screened against the TPS file.
No statistics are available for these matches due to BT licencing restrictions. However, we normally estimate that 70-75% of all
telephone numbers generated from the BT OSIS file will be on the TPS.
-
The TPSExisting field indicates whether telephone numbers supplied by the user should be screened against the TPS file.
Statistics Section - TPS
- OwnNumbersMatched - indicates the number of previously unprocessed telephone numbers that were matched against the TPS.
- OwnNumbersProcessed - indicates the number of previously unprocessed telephone numbers that were supplied.
- OwnNumbersWithoutReprocessingMatched - indicates the total number of telephone numbers that were matched against the TPS.
- OwnNumbersWithoutReprocessingProcessed - indicates the total number of telephone numbers that were supplied.
- ReprocessedNumbersMatched - indicates the number of previously processed telephone numbers that we matched against the TPS.
- ReprocessedNumbersProcessed - indicates the number of previously processed telephone numbers that were supplied.
-
The TPSLifestyle field indicates whether telephone numbers appended from the lifestyle files should be screened against the TPS file.
Statistics Section - TPS
- LifestyleNumbersMatched - indicates the number of telephone numbers that were matched against the TPS.
-
The TPSDebtSearch field indicates whether telephone numbers appended from the debt databases should be screened against the TPS file.
No statistics are available for these matches due to licencing restrictions. However, we normally estimate that 70-75% of all
telephone numbers generated from the debt databases will be on the TPS.
-
The EmailValidation field indicates whether email addresses supplied by the user should be validated.
Statistics Section - EmailValidation
- BlankAddresses - indicates how many email address fields are blank.
- InconclusiveAddresses - indicates how many email address fields could not be conclusively shown to be either valid or invalid.
- InvalidAddresses - indicates how many email address fields contain invalid addresses.
- ValidAddresses - indicates how many email address fields contain valid (or blank) addresses.
-
The StopFileNames field contains an array indicating the user stop files to match against.
If stop file screening is not required, this can be set to an empty array.
No statistics are currently available for these matches - detailed statistics will be available in a future release.