Packet Viewer

Prerequisites

Basics

The Packet Viewer is a tool in the Audit Log that displays the contents of sync packets.

  • A sync packet contains changes made in FieldFX Mobile since the last sync.

  • Sync packets get uploaded to FieldFX Back Office when you sync.

  • Every Pre-Sync Upload, SyncUploadComplete, and SyncUploadError entry contains a sync packet.

Use the Packet Viewer to reprocess sync packets that didn’t upload to FieldFX Back Office successfully.

Getting There

Open an Audit Log entry and click Packet Viewer.

Details Panel

The Details panel displays your username and information about your org.

Screenshot of the Packet Viewer’s details section
Figure 1. Details display a summary of your org

Audit Log Detail Tab

Basics

The Audit Log Detail tab displays the Audit Log entry for the sync packet.

Screenshot of a sync packet’s audit log details
Figure 2. Audit Log Details summarize information about a particular sync packet

Fields

  • Event ID: displays the ID of the event that caused a sync upload error for this sync packet.

  • Type: displays the activity recorded by the Audit Log entry:

    Type Description

    AgreedToLicense

    User agreed to the FieldFX License Agreement

    LoggedOutWithData

    User logged out of FieldFX Mobile and had unsynced data

    LoggedOutWithNoData

    User logged out of FieldFX Mobile and didn’t have any unsynced data

    Pre-Sync Upload

    User started a sync

    SyncDownloadComplete

    Data downloaded successfully from FieldFX Back Office during a sync

    SyncPreCheckFailed

    User failed the pre-sync check and couldn’t sync

    SyncUploadComplete

    Data uploaded successfully to FieldFX Back Office during a sync

    SyncUploadError

    Data didn’t upload successfully to FieldFX Back Office during a sync

  • Originating Audit Log: displays a link to Audit Log entry from which this entry was created.

    • This field only displays data if you reprocessed a sync packet and are viewing the reprocessed sync packet.

  • New Audit Log: displays a link to the Audit Log entry created from this entry.

    • This field only displays data if you reprocessed a sync packet and are viewing the original sync packet.

  • Cleared: indicates whether the sync packet was reprocessed successfully.

    • This checkbox gets selected automatically after you reprocess a sync packet successfully.

      Users cannot rerun packets that are marked Cleared.

  • Date: displays the date and time of the activity.

  • User: displays the user responsible for the activity.

Sync Packet Tab

Basics

The Sync Packet tab displays the contents of a sync packet.

Screenshot of the Sync Packet tab
Figure 3. See the contents of a sync packet in the Sync Packet tab

This tab is where you can edit and reprocess sync packets.

Events

Basics

An event is an action performed by a user.

Sync packets feature an event for every action performed since the last sync.

The following actions get recorded in sync packets:

Action Description

create Attachment

User attached an FX Report to a record

create FX5__Job__c

User added a job

update FX5__Job__c

User edited a job

create FX5__Ticket__c

User added a ticket

update FX5__Ticket__c

User edited a ticket

create FX5__Ticket_Item__c

User added a ticket item

update FX5__Ticket_Item__c

User edited a ticket item

delete FX5__Ticket_Item__c

User deleted a ticket item

create FX5__Quote__c

User added a quote

update FX5__Quote__c

User edited a quote

create FX5__Quote_Item__c

User added a quote item

update FX5__Quote_Item__c

User edited a quote item

delete FX5__Quote_Item__c

User deleted a quote item

create FXFORMNAMEHERE__c

User added an FX Form

update FXFORMNAMEHERE__c

User edited an FX Form

Event Colors

The color of an event lets you know a number of important details.

Gray Events

Gray events processed successfully and the data uploaded to FieldFX Back Office.

Screenshot of a gray event
Figure 4. Successfully processed events are gray

When you reprocess a sync packet successfully, all of the events that display turn to gray.

Pink Events

Pink events caused a sync upload error and the data didn’t upload to FieldFX Back Office.

Screenshot of a pink event
Figure 5. Events with errors are pink
You need to resolve the sync upload error caused by pink events before you can reprocess a sync packet successfully.

Click the Tracking Number or Sync ID link on a pink event to view the referenced records.

Orange Events

Orange events didn’t process and the data didn’t upload to FieldFX Back Office.

Screenschot of an orange event
Figure 6. Orange events did not successfully process or upload data to FieldFX Back Office

These events didn’t process due to one of the following reasons:

  • record doesn’t exist: an earlier event to add a record didn’t process successfully

    In this scenario, reprocessing the packet will fix the issue.

  • record was deleted: a user deleted the record in FieldFX Back Office

    In this scenario, undelete the record from the Salesforce recycle bin to fix the issue.
You need to resolve the sync upload error in the sync packet before you can reprocess orange events.
Green Events

Green events didn’t process and the data didn’t upload to FieldFX Back Office.

Screenshot of a green event
Figure 7. Green events did not successfully process or upload data to FieldFX Back Office
You need to resolve the sync upload error in the sync packet before you can reprocess green events.

Click the Tracking Number or Sync ID link on a green event to view the referenced records.

Event Status Indicators

Errored

Displays on events that caused sync upload errors.

Screenshot of the Errored indicator
Figure 8. An indicator tag displays for events with errors

Select this indicator to view the reason for the error.

Animated GIF of selecting the indicator
Figure 9. Selecting the tag displays information about the error
Modified

Displays on events you have edited.

Screenshot of a modified indicator
Figure 10. A yellow banner with an asterisk (*) indicates a modified event
Ignored

Displays on events you selected to ignore.

Screenshot of the gray ignored banner
Figure 11. A gray Ignored banner appears on events that have been marked as ignored

Select the checkbox next to an event to ignore it.

GIF of ignoring an event
Figure 12. Select the checkbox to ignore an event
Run From Here

Displays on events that caused sync upload errors.

Screenshot of the Run From Here banner
Figure 13. The green Run From Here displays for events that caused sync upload errors

Also displays on events you choose to reprocess.

GIF of selecting a radio button to Run From Here
Figure 14. Select the radio button for an event to be able see the Run From Here button

Select this indicator to reprocess the event and every unprocessed event after it.

Refer to the Reprocessing a Sync Packet section on this page for detailed instructions on how to reprocess a sync packet.

Event Details

Click Details on an event to display the Event Details window.

Screenshot of an event’s Details button
Figure 15. The Details button accesses a window with more information about the event

The Event Details window displays the fields completed during an event.

Screenshot of an event’s Details window
Figure 16. The Details window shows more details about the event

Click Edit to make changes to the event data.

When editing an event, click Delete next to a field to remove it from the sync packet.

Click Show Raw to view the event data in JSON (JavaScript Object Notation) form.

Click Edit to make changes to the event data in JSON format.

This is not recommended.

FX Reports

Click View on a create Attachment event to view the FX Report attached to a record during that event.

Screenshot of the FX Report View button for an event
Figure 17. For a create Attachment event, click on the View button to see the report record for the event

You can then print or save the report.

Raw Data Tab

The Raw Data tab displays the contents of the sync packet in JSON (JavaScript Object Notation) form.

Screenshot of an event’s Raw Data tab
Figure 18. Display the event in JSON format in the Raw Data tab

Click Edit to make changes to the sync packet.

Use with extreme caution. This is not recommended, and should only be done under guidance from LiquidFrameworks.

Step-by-Step Guides

Editing an Event

  1. Open the Audit Logs tab

  2. Open the Audit Log entry for the sync packet containing the event

  3. Click Packet Viewer

  4. Click Details on the event

  5. Click Edit

  6. Make changes

    Click Delete next to a field to remove it from the sync packet.

  7. Click Back

  8. Click Close

    The yellow modified indicator banner displays on the event.

Exporting an FX Report from an Event

  1. Open the Audit Logs tab

  2. Open the Audit Log entry

  3. Click Packet Viewer

  4. Locate the create Attachment or Report Attached to Ticket event for the report

  5. Click View on the event

  6. Save the report

Restoring a Deleted Record

  1. Open the Audit Logs tab

  2. Open the Audit Log entry

  3. Click Packet Viewer

  4. Locate an event that features the deleted record

  5. Click the link to the deleted record

  6. Select the checkbox next to the deleted record

  7. Click Undelete

Reprocessing a Sync Packet

  1. Open the Audit Logs tab

  2. Open the Audit Log entry for the sync packet

  3. Click Packet Viewer

  4. Resolve the sync upload error:

    1. Move to the pink event

    2. Select the Errored indicator to view the reason for the error

      GIF of selecting the Errored indicator
      Figure 19. Hovering over the Errored indicator for the event reveals the error message in a popup message

    3. Complete the following:

      • If the error states that a record was deleted or no longer exists, restore the deleted record and proceed to step 5.

      • If the error states that a field contains invalid data, correct the data and proceed to step 5.

      • If there are no obvious issues with the fields or records in the event, proceed to step 5.

  5. Reprocess the sync packet and upload unprocessed events to FieldFX Back Office:

    1. Complete one of the following:

      1. Reprocess All Events
        Click Run from here.

        • The Packet Viewer attempts to upload the events to FieldFX Back Office and creates a new Audit Log entry to show the results.

        • The Last Modified timestamp for the data in the events now displays your user name, instead of the original user.

        • The New Audit Log window displays once the process is complete.

      2. Reprocess Selected Events

        1. Select the checkbox next to events you don’t want to process

          GIF of selecting an event’s checkbox
          Figure 20. Use the checkbox to mark events to ignore

        2. Select the first event you want to process

          GIF of selecting a radio button to Run From Here
          Figure 21. Select an event’s radio button to access the Run From Here banner

        3. Click Run from here

          • The Packet Viewer attempts to upload the events to FieldFX Back Office and creates a new Audit Log entry to show the results.

          • The Last Modified timestamp for the data in the events now displays your user name, instead of the original user.

          • The New Audit Log window displays once the process is complete.

    2. Select Click here to go to the new Audit Log

    3. Review the new Audit Log entry:

      • If every event is gray, the sync packet reprocessed successfully and no further action is required.

      • If there is a pink event, repeat steps 4 & 5 until you reprocess the sync packet successfully.

      • If you are unable to reprocess the sync packet successfully after multiple attempts, contact LiquidFrameworks Support for further assistance.

Recommended Reading