Data Payload Processor (DPP) Config Tool window

Decode Define

This tab lists the system's existing Decode Defines. Refer to Decode Define procedures.

DecodeID

The primary key of the decodeDefine table. A unique number identifying the Decode Define.

DecodeName

The name of the Decode Define.

Definition

DPP uses the Definition to find a matching record from the incoming data.

DPP only runs the associated Decode Templates if the Definition exactly matches the incoming stringKey from the rdm_readingRaw record.

Template Define

This tab lists the system's existing Decode Templates. Refer to Decode Template procedures.

DecodeTemplateID

The primary key of the decodeTemplateDefine table. A unique number identifying the Decode Template.

Name

The name of the Decode Template.

Description

A description of the Decode Template.

StoredProc

The stored procedure that the system runs when a define match occurs.

Decode Template Refer

This tab lists the fields in the DecodeTemplateRefer table. DPP uses this table to create a one to many relationship for Decode Defines and Decode Templates. A single Decode Define can have multiple associated Decode Templates.

Important: For informational purposes only. Do not edit.

decode TemplateReferID

The uniquer identifier for a Decode Template Refer record.

decodeID

The Decode Define record ID.

decodeTemplateID

The Decode Template record ID.

Method Define

This tab lists the fields in the DecodeMethodDefine table. When a define match occurs, Decode Templates use the Decode Methods listed here.

You can modify, duplicate, and delete rows via the Save Changes, Save as new Row, and Delete buttons, respectively.

DecodeMethodID

The Decode Method ID.

Type

This field indicates how DPP should process the incoming data:

• CustomSP – use a custom stored procedure that returns a value for the parameter.

• CustomSP2 – use a custom stored procedure that returns a value for the parameter.

• CustomSP3 – same as above, but allows you to use a byte string instead of a text string when passing in the payload.

• Enumeration – use values defined in the enumeration define table.

• FixedValue – apply a hard-coded value to the destination parameter for the stored procedure.

• Standard – retrieve data based on the configuration of the Decode Method's Delimiter/Byte Offset and Source fields.

• StandardDateTime – convert an incoming byte string into the standard date/time format.

InputDataType

The expected data type of the payload:

• strByte – payload consists of a string of raw bytes.

• string – payload consists of a delimited string.

OutputDataType

The type of value that DPP outputs:

• float

• string

Action

How DPP converts the incoming data.

OffsetDelimiterCount

The position of the value within the payload string. This works in conjunction with the delimiterByteCount to specify what portion of the payload belongs to what variable in the output.

delimiterByteCount

This field lists one of the following:

The number of bytes following the selected offset to translate.

The name of the delimiter used in the payload (for example, if it's "comma", the system parses the payload for ",").

Source

The source of the value.

Destination

The value in the stored procedure to which the source value maps.

ReferenceFieldName

A more specific and reader-friendly version of the Destination.

necessary

This field indicates whether or not the value for a stored procedure is required or not.

Template Method Refer

This tab lists the fields in the DecodeTemplateMethodRefer table. DPP uses this table to create a one to many relationship for Decode Templates and Decode Methods. A single Decode Template can have multiple associated Decode Methods.

Important: For informational purposes only. Do not edit.

DecodeTemplateMethodReferID

The unique identifier for a Template Method Refer record.

DecodeTemplateID

The Decode Template ID.

DecodeMethodID

The Decode Method ID.

Enumeration Define

This tab lists the fields in the DecodeEnumerationDefine table. The table lists the system's existing Enumerations.

You can modify, duplicate, and delete rows via the Save Changes, Save as new Row, and Delete buttons, respectively.

decodeEnumerationID

The Decode Enumeration ID.

value

The value in the inbound raw record.

type

The data type of the value.

enumeration

The value that DPP should return to the Decode Method parameter when it finds a value match in an inbound raw record.

Enumeration Refer

This tab lists the fields in the DecodeEnumerationMethodRefer table. This table indicates which Decode Enumeration a Decode Method uses.

Important: For informational purposes only. Do not edit.

decodeEnumerationMethodReferID

The uniquer identifier for a Decode Enumeration Refer record.

decodeEnumerationId

The Decode Enumeration ID.

decodeMethodId

The Decode Method ID.

Processing Statistics

This tab displays the processing information of different priorities.

Important: For informational purposes only. Do not edit.

Priority

The priority value of the rdm_readingRaw record.

enable

This field indicates whether or not the priority of the record is enabled for processing.

lastRun

The amount of time in seconds since the last run.

waitTime

The amount of time that has passed since the system last ran this priority. If this value exceeds the totalWait time, these records should be prioritized first.

totalWait

The amount of time to wait before prioritizing this before other records.

For example, if we have priority 1 records, but priority 4 has waited 2.5 hours (150 minutes), we will process a batch of priority 4 records.

totalFailed

The number of records of this priority that have failed.

recordsProcessed

The number of records that have been processed at the given priority. At 1 million, the number rolls over back to zero.

numRuns

The number of times a batch has ran against the specified priority.

description

A description of the priority.

Rejected Readings

When DPP encounters issues or errors with a rdm_readingRaw record, it:

• Copies the record to the rejected table.

• Removes the record from the rdm_readingRaw table.

  Important: For informational purposes only. Do not edit.

  Note: Page navigation buttons are available for the Rejected Readings tab.

rowID

The ID number of the rejected record.

templateID

The ID number of the Decode Template.

rejectedReasonCode

A three-character code defined in the rejectedReasonDesc table.

priority

The priority value of the rejected rdm_readingRaw record.

seqNo

The sequence number of the rejected rdm_readingRaw record in the krunch array.

processTime

The time at which DPP processed the record into the rdm_readingRaw table.

lastModTime

The last time at which the rejected record was modified.

xmlSource

Source column information.

xmlAudit

Audit column information.

xmlCommand

Command column information.

xmlAddressing

Addressing column information.

payLoad

The payload to which the rejected record belongs.

otherInfo

Other information related to the rejected record.

stringKey

The rejected record's stringKey against which DPP compared the applicable Decode Define's definition.

xFer1

xFer1 column information.

xFer1Time

Time at which the value was sent to the audit table.

Parameter Store Proc Define

This tab lists the available parameter types and their associated stored procedures. Refer to Parameter Stored Procedure Define.

parameterID

The ID number of the parameter.

parameter_type

The name of the parameter.

store_proc

The name of the stored procedure that the DPP process executes when a parameter is requested by Configurable Gas Load (CGL).

description

A brief description of the stored procedure.