Create a Decode Define

Follow this procedure to create a definition against which Data Payload Processor (DPP) matches an inbound raw record.

To create a Decode Define

1. On the Data Payload Processor (DPP) Config Tool window, select New > New Decode Define.

   The New Decode Define dialog box opens.

   

2. (Optional) DPP automatically generates the Decode ID. If you want to use a different ID, enter it in the Decode ID field.

   Note: If you enter an ID that belongs to an existing Decode Define, DPP updates the fields on the New Decode Define dialog box with information specific to that Decode Define. If you plan on using a custom ID, always enter it as the first step in creating a new Decode Define to avoid losing changes to the fields described below.

3. Enter a Decode Name that helps to identify the Decode Define's purpose.

4. Enter a Decode Description.

5. In the Decode Definition field, enter the definition used by DPP to find a matching record from the incoming data.

   When it parses a record, DPP uses a string comparison to determine which decode configuration to use. DPP compares the Decode Definition to the stringKey column in the incoming rdm_readingRaw record.

   A good practice is to upload a record without the Decode/Template Define. DPP will complain that no match is found in the log file (%DNADataRoot%\RealTime\log\DataPayloadProcessor.log). The following is a typical error message in the log file after one such upload:

   2016-08-11 16:45:27.653 [TID=0x1133c] ALWAYS: Decode match not found for

   <source><proto><name>totalflow2</name><command>upload meter hourly history</command>

   <load></load><dpploadtype></dpploadtype></proto></source>

   {C:\Source\Historical\Service\source\Historical\DataPayloadProcessor\KrunchProcess.cs:188}

   This alerts you to the fact that:

   • They need to define a match for the totalflow2 hourly meter records.

   • The matching string is:

     <source><proto><name>totalflow2</name><command>upload meter hourly history</command><load></load><dpploadtype></dpploadtype></proto></source>

     You can then copy the above string into the Decode Definition field on the New Decode Define dialog box.

6. In the Add Templates section, select the Decode Templates you want to attach to the Decode Define and select Add.

   When DPP matches an inbound raw record to this particular Decode Define, it runs the Attached Templates. You can add as many Decode Templates as desired to a single Decode Define.

7. Select Save.

8. Back on the DPP Config Tool window, select Refresh.

   The new Decode Define should now appear in the Decode Define tab of the DPP Config Tool window.