Test Payload

Test a payload to verify that the results generate successfully.

After testing a payload, you can view the payload transport details using the Monitor Activity tile on the dashboard. On the Monitor Activity page, the Payload Transport tab displays the payload details by payload transport ID for payloads generated through a publish subscribe activity.

To test a payload:

  1. On the dashboard, choose the Payload tile.

    The Payload List page opens.

  2. Choose the payload name hyperlink you want to test.

    The Payload Detail page opens.

  3. On the upper-right side of the page, choose Test.

    The Test Payload dialog box opens.

  4. In the Object Ref field, enter the document ID of the document you want to populate in the payload.

    You can specify the document ID for any document of the base module that was selected for the payload. You can copy the document ID from the corresponding Detail page in the application. For a Work Order or SOW, the latest document ID is pulled.

  5. Choose Test.

    The process runs and the results display in the Test Payload dialog box.

    To view the payload transport details, see Monitor Activity.

To format the results, copy and paste the string into any JSON formatting tool, such as the JSON Viewer plugin in Notepad ++ or use a free formatting tool available online.

The following sample code shows formatted results.