• Read more about Automated Data Cleansing from Foundation Technology.

OutputColumnDetails

Definition

            public class OutputColumnDetails
            {
                public int FieldNumber;
                public string FieldName;
                public int Offset;
                public int Length;
                public string Description;
                public string ColumnName;
                public string TablePrefix;
                public KnownColumnTypes FieldType;
            }
        

Description

Defines the location and type of a column in a cleansed data file.

Once the calling application has downloaded a cleansed data file using the DownloadResults method, it will typically need to understand where in the file different types of data are stored in order to import the results back into a line-of-business application. This can be done by retrieving a list of OutputColumnDetails instances from the GetOutputFormat method.

Each data cleansing service typically adds one or more additional columns of data to the cleansed data file, after the columns that were in the original input data. The definitions of the columns that are added by each service can be seen in the documentation for the GetAvailableServices method.

Each of the additional columns described in the GetAvailableServices documentation contains a two-part identifier. These can be matched against the TablePrefix and ColumnName fields in the OutputColumnDetails instances to identify which column in the cleansed data file contains that data.

• The FieldNumber field contains the index of the column within the file, starting from zero.
• The FieldName field contains a value that can be used as a header for the column. If the original file contained a header line, this value will be used in the first row in the cleansed data file.
• The Offset field contains the offset of the column from the start of the row, in bytes. This is only applicable where the original file was submitted in a fixed format.
• The Length field contains the length of the column, in bytes. This is only applicable where the original file was submitted in a fixed format.
• The Description field contains a human-readable description of the contents of the column.
• The ColumnName field contains part of a unique identifier for the column.
• The TablePrefix field contains part of a unique identifier for the column.
• The FieldType field identifies the general type of data that is stored in the column. This can be one of the values from the KnownColumnTypes enum.

Results Manager documentation