DataGuide Data Model

DataGuide is a product built by ServiceMax that enhances the power of FieldFX. It combines the capabilities of Advanced Forms and Document Generation to guide end users to efficiently capture and present data in support of a variety of tasks such as inspection, maintenance, and safety.

This section provides information on the relationship between standard fields and custom fields of ServiceMax, Salesforce, and FieldFX objects.

The following diagram displays the relationship between the Objects and Fields used in DataGuide. The FieldFX Parent Object currently refers to either the Job object or the Ticket object. Additional object support is coming.

DataGuide FieldFX Data Model
Form Objects Report Template Objects

These objects are introduced in the DataGuide package on the Salesforce standard objects, DataGuide custom objects, and FieldFX objects.

These objects are introduced in the DataGuide package on the Salesforce standard objects, DataGuide custom objects, and FieldFX objects.

Form Objects

This section includes the field-level details of the following Report Template objects.

Application Log

API Name

SVMXDG__Application_Log__c

Number of Fields

7
Table 1. Application Log Object
Field Label Field Name Data Type Description

Standard Field

Log #

Name

AutoNumber

Name of the application log record.

Custom Relationship Field

User

SVMXDG__UserId__c

Lookup (User)

User that has generated the log entry.

Custom Fields

Application Name

SVMXDG__Application_Name__c

Picklist

The only picklist value currently is “Form Response Processing”.

Timestamp

SVMXDG__Timestamp__c

Number (18)

Time stamp of when the system generated the log.

Message

SVMXDG__Message__c

Long Text (2000)

Body/Message of the log entry.

Log Type

SVMXDG__LogType__c

Picklist

Possible values: ERROR, INFO, WARNING

Source Record Id

SVMXDG__SourceRecordId__c

Text (20)

Salesforce id of the record that generated the log entry.

Back to Object List

Content Version (Field Addition)

API Name

ContentVersion

Number of Fields

2
Table 2. Content Version (Field Addition) Objects
Field Label Field Name Data Type Description

Custom Fields

UID

SVMXDG__DG_UID__c

Text (128)
(External Id)
(Unique Case Insensitive)

This is the unique identifier for question files like images included as file attachments of the form record.

DataGuide File Type

SVMXDG__DG_File_Type__c

Picklist (Text)

Possible values: Template, Form, Form Response.

Back to Object List

Form Object

Metadata for the Advanced Forms in DataGuide.

API Name

SVMXDG__DG_Form__c

Number of Fields

10
Table 3. Form Objects
Field Label Field Name Data Type Description

Standard Field

Form Name

Name

Text (80)

Name of the Form

Custom Fields

Description

SVMXDG__DG_Description__c

Text (255)

A description of the form. Primarily for use by the form designer or to augment a name that is not easy to read.

Source Object Name

SVMXDG__DG_Source_Object_Name__c

Text (150)

The API name form’s root object.

IsActive

SVMXDG__DG_IsActive__c

Checkbox

If checked, the form is available for use.

IsArchived

SVMXDG__DG_IsArchived__c

Checkbox

If checked, the system archived the form and shouldn’t be used.

IsAvailable

SVMXDG__DG_IsAvailable__c

Long Text Area (131072)

Formula field that determines if the form is available for a user. If the formula evaluates to true, the form will be available.

The system writes the formula in the context of the Form Subject field and then the formula can reference fields on the selected object.

IsDeleted

SVMXDG__DG_IsDeleted__c

Checkbox

If checked, the system deleted the form and shouldn’t be used.

UID

SVMXDG__DG_UID__c

Text (128)
(External Id)
(Unique Case Insensitive)

For system use only. Please do not enter or modify the data in this field.

Allow Multiple Submissions

SVMXDG__DG_Multiple_Submissions__c

Checkbox

If checked, end users will be able to submit this form multiple times on the same record.

For FieldFX, this checkbox stays checked and you can’t modify it.

Filter Criteria

SVMXDG__DG_Filter_Criteria__c

Long Text Area (131072)

The filter criteria to define when a form is available based on user or form’s root object values.

Back to Object List

Form Data Object

This object stores the end-user saved or completed forms.

API Name

SVMXDG__DG_Form_Data__c

Number of Fields

14
Table 4. Form Data Objects
Field Label Field Name Data Type Description

Custom Relationship Fields

Form Version

SVMXDG__DG_Form_Version__c

Lookup (Form Version)

This is a link to the version of the form that matches the data in this Form Data record.

Form

SVMXDG__DG_Form__c

Lookup (Form)

This is a link to the form that matches the data in this Form Data record.

Started By

SVMXDG__DG_Started_By__c

Lookup (User)

User who started the form.

Standard Field

Form Data Name

Name

AutoNumber

Custom Fields

LastSavedOn

SVMXDG__DG_Last_Saved_On__c

Date/Time

Date and Time when the end user last saved the form.

CompletedOn

SVMXDG__DG_Completed_On__c

Date/Time

If this field has a value, then it shows the end date and time of form completion.

Form Result

SVMXDG__DG_Form_Results__c

Long Text Area (131072)

Not Used.

IsCompleted

SVMXDG__DG_Is_Completed__c

Checkbox

If checked, the end user has completed the form.

If not checked the work on the form is still in progress.

IsDeleted

SVMXDG__DG_IsDeleted__c

Checkbox

If checked, the system deleted the form and shouldn’t be used.

SyncID

SVMXDG__DG_SyncID__c

Text (50)
(External ID)
(Unique Case Insensitive)

System Field.

Used by the FieldFX Mobile application to assign a unique id to the form data record before the form is synced.

Started On

SVMXDG__DG_Started_On__c

Date/Time

Date and Time when the system started the form data record.

What Id

SVMXDG__DG_What_Id__c

Text (40)

18 Digit Salesforce Id of the record when the system saved or submitted the form.

Status

SVMXDG__DG_Status__c

Picklist

Status of the form data record:

  • Open: when the system saved the form.

  • Submitted: when the system completed the form.

Id Mapping

SVMXDG__DG_Id_Mapping__c

TextArea (131072)

System Field. Links form data parent form id to form data reference SObject id.

Back to Object List

Form Expression Object

API Name

SVMXDG__DG_Form_Expression__c

Number of Fields

3
Table 5. Form Expression Object
Field Label Field Name Data Type Description

Custom Relationship Field

Parent Form Version

SVMXDG__DG_Form_Version__c

Master Detail (SVMXDG__DG__Form_Version__c)

Standard Field

Form Expression Name

Name

Auto Number

Custom Field

Process ID

SVMXDG__DG_Process_ID__c

Text(150)

Back to Object List

Form Response Object

Object that stores each question-answer pair of form data records that have a parent version set to generate a form response (this is enabled via a Form Action on the Form Version through the Form Designer).

API Name

SVMXDG__DG_Form_Response__c

Number of Fields

15
Table 6. Form Response Objects
Field Label Field Name Data Type Description

Custom Relationship Fields

Form Data

SVMXDG__DG_Form_Data__c

Lookup (Form Data)

Reference to the form data record submitted by the end user.

Form Version

SVMXDG__DG_Form_Version__c

Lookup (Form Version)

Reference to the parent version of the form data record submitted and created the form response record.

Form

SVMXDG__DG_Form__c

Lookup (Form)

Reference to the form template.

Completed By

SVMXDG__DG_Completed_By

Lookup (User)

Reference to the user that completed the form data record.

Standard Field

Form Response Name

Name

AutoNumber

Name of the form response record.

Custom Fields

WhatId

SVMXDG__DG_What_Id__c

Text (40)

18-digit Salesforce Id of the record for the form data saved or submitted.

Question

SVMXDG__DG_Question__c

TextArea (255)

Name of the question as defined in the Form Designer.

Row

SVMXDG__DG_Row__c

Text (255)

Not Used.

Title

SVMXDG__DG_Title__c

Text (255)

Not Used.

Answer

SVMXDG__DG_Value__c

TextArea (255)

Answer to the questions provided by the end user when filling the form.

Answer

SVMXDG__DG_Answer__c

TextArea (131072)

Comment or long answers provided by the end user when filling the form.

Answer Number

SVMXDG__DG_Value_Number__c

Formula (Number)

Answer to number-type questions.

Answer Date

SVMXDG__DG_Value_Date__c

Formula (Date)

Answer to date-type questions

Answer Datetime

SVMXDG__DG_Value_Datetime__c

Formula (DateTime)

Answer to datetime-type questions.

Answer Boolean

SVMXDG__DG_Value_Boolean__c

Formula (Boolean)

Answer to Boolean-type questions

Completed On

SVMXDG__DG_Completed_On__c

DateTime

Date and Time stamp of when the system generates the form response record.

Back to Object List

Form Version Object

This is a child of the Form object and contains the actual form definition to be used with the metadata in the Form object.

API Name

SVMXDG__Form_Version__c

Number of Fields

9
Table 7. Form Version Objects
Field Label Field Name Data Type Description

Custom Relationship Fields

Form

SVMXDG__DG_Form__c

Master-Detail (Form)

Indicates the form record that the version belongs to.

Standard Field

Form Version Name

Name

AutoNumber

Custom Fields

Description

SVMXDG__DG_Description__c

Text (255)

A description of the form version. Primarily used by the form designer.

Form Version Number

SVMXDG__DG_Version_Number__c

Number (18,0)

Version number of the form.

Mapping

SVMXDG__DG_Mapping__c

Long Text Area (131072)

IsActive

SVMXDG__DG_IsActive__c

Checkbox

If checked, this field indicates the form version is available for use.

IsArchived

SVMXDG__DG_IsArchived__c

Checkbox

If checked, the system archived the form version and it’s no longer in use.

IsDeleted

SVMXDG__DG_IsDeleted__c

Checkbox

If checked, the system deleted the form version and shouldn’t be used.

UID

SVMXDG__DG_UID__c

Text (128)
(External Id)
(Unique Case Insensitive)

For system use only.

Do not enter or modify the data in this field.

Back to Object List

Report Template Objects

This section includes the field-level details of the following Report Template objects.

These fields are introduced in the DataGuide package on the Salesforce standard and DataGuide custom objects.

Report Template

API Name

SVMXDG__DG__Report_Template__c

Number of Fields

5
Table 8. Report Template Objects
Field Label Field Name Data Type Description

Standard Field

Name

Name

Text(80)

Name of the document template

Custom Fields

Report Template ID

SVMXDG__DG_Report_Template_ID__c

Auto Number

SObject

SVMXDG__DG_SObject__c

Text (255)

The API name of object to which this form is dependent.

UID

SVMXDG__DG_UID__c

Text (128)
(External ID)
(Unique Case Insensitive)

Description

SVMXDG__DG_Description__c

Text (255)

Descriptive text explanation on the template.

Back to Report Template Objects

Report Template Expression

API Name

SXVMXDG__DG__Report_Template_Expression_c

Number of Fields

3
Table 9. Report Template Expression Objects
Field Label Field Name Data Type Description

Custom Relationship Field

Rendition Id

SVMXDG__DG_Rendition_Id__c

Master-Detail
(Report Template Rendition)

Custom Fields

Process ID

SVMXDG__DG_ProcessID__c

Text (50)

Report Expression Name

Name

Text (80)

Back to Report Template Objects

Report Template Rendition

Report template rendition stores the multi-lingual template content relation for the templates.

API Name

SXVMXDG__DG__Report_Template_Rendition__c

Number of Fields

4
Table 10. Report Template Rendition Objects
Field Label Field Name Data Type Description

Custom Relationship Field

Parent Report

SVMXDG__DG__Parent_Report__c

Master-Detail (SVMXDG__DG__Report_Template__c)

Report template associated to the renditions

Standard Field

Rendition Number

Name

Auto Number

Custom Fields

Language

SVMXDG__DG__Language__c

Text (5)

Language code for the language the template is associated with.

Mapping

SVMXDG__DG_Mapping__c

Long Text Area (131072)

Back to Report Template Objects

Form Report Template

API Name

SXVMXDG__DG__Form_Report_Template_c

Number of Fields

2
Table 11. Form Report Template Objects
Field Label Field Name Data Type Description

Custom Relationship Fields

Parent Form Version

SVMXDG__DG_Form_Version__c

Master-Detail (SVMXDG__DG_Form_Version__c)

The Form Version salesforce record Id

Report Template Id

SVMXDG__DG_Report_Template__c

Lookup (SVMXDG__DG_Report_Template __c)

The Report Template salesforce record id

Back to Report Template Objects