cgc_sync__Sync_Mobile_App_Installation__c

Contains information about the user to whom the deployment package is to be distributed. This object is available in API version 53.0 and later.

Supported Calls 

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields 

LastReferencedDate 
  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: Most recent date on which a user referenced this record.

LastViewedDate 
  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: Most recent date on which a user viewed this record.

Name 
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: Unique identification of the record.

OwnerId 

  • Type: reference

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Description: ID of the record owner.

    This is a polymorphic relationship field.

  • Relationship Name: Owner

  • Relationship Type: Lookup

  • Refers To: Group, User

cgc_sync__API_Calls_Down__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Number of API calls that are grouped by downloads since either the first installation or the last reset.

cgc_sync__API_Calls_Everything__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total number of API calls made during installation.

cgc_sync__API_Calls_Misc__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total number of API calls not considered during upload, download, and NFT (Named Fetch Tree) syncs since either the first installation or the last reset.

cgc_sync__API_Calls_NFT__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total number of all API calls that are grouped by NFT synchronizations since either the first installation or the last reset.

cgc_sync__API_Calls_Up__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total number of API calls that are grouped by upload synchronizations since either the first installation or the last reset.

cgc_sync__Avg_API_Calls_Down_Per_Day__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Weighted average of the API calls that are down per day.

cgc_sync__Avg_API_Calls_Everything_Per_Day__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Weighted average of API calls per day.

cgc_sync__Avg_API_Calls_Misc_Per_Day__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Weighted average of all API calls that aren’t considered during upload, download, or NFT syncs.

cgc_sync__Avg_API_Calls_NFT_Per_Day__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Weighted average of API calls for NFT syncs.

cgc_sync__Avg_API_Calls_Up_Per_Day__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Weighted average of API calls for upload. It’s calculated only on the view, and not on the persistent fields.

cgc_sync__Client_App_ID__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Client app ID that the device uses and the user combination for a specific sync App_Installation__c record.

cgc_sync__Deployment_Package__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Name of the deployment package that’s installed on the device.

cgc_sync__DeviceId__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Installation ID of the device.

cgc_sync__Device_Model__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Model number of the client device.

cgc_sync__Device_OS_Version__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Operating system that runs on the client device.

cgc_sync__Encryption_Key__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Encryption key of the client device.

cgc_sync__Event_Period_Length_Hours__c 
  • Type: double
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Description: Time duration (in hours) for controlling maximum event quantity limitations.

cgc_sync__Free_Persistent_Storage_Space__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Available storage space (in bytes) of the device.

cgc_sync__Installation_Date_Time__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Timestamp when the package was installed.

cgc_sync__Installed_App_Version__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Version of the application installed on the client device.

cgc_sync__IsEncrypted__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the database on the client device is encrypted (true) or not (false).
  • Default value: false

cgc_sync__Last_Connection_At__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Timestamp of the last attempted upload or download.

cgc_sync__Last_Failed_Sync_At__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Timestamp of the last failed sync.

cgc_sync__Last_Reset_At__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Timestamp when the last reset was performed.

cgc_sync__Last_Successful_Download_At__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Timestamp of the last successful download.

cgc_sync__Last_Successful_FSOD_At__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Timestamp of the last successfully executed First Sync of Day.

cgc_sync__Last_Successful_Upload_At__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Timestamp of the last successful upload.

cgc_sync__Link_to_Device_Details__c 

  • Type: string

  • Properties: Filter, Nillable, Sort

  • Description: Link to the device details record.

    This is a calculated field.

  • Formula:

    1HYPERLINK(LEFT($Api.Partner_Server_URL_260, FIND( '/services', $Api.Partner_Server_URL_260)) + '/'+ Id +
2'/e?retURL=/one/one.app#/alohaRedirect/apex/AppInstallations', 'Device Details', '_blank')

cgc_sync__Link_to_Device_Logs__c 

  • Type: string

  • Properties: Filter, Nillable, Sort

  • Description: Link to the device logs.

    This is a calculated field.

  • Formula:

    1HYPERLINK(LEFT($Api.Partner_Server_URL_260, FIND( '/services', $Api.Partner_Server_URL_260)) + '/lightning/r/Report/'+$Setup.cgc_sync_Sync_Report_Links__c.cgc_sync_Device_Event_Logs_Id__c+'/view?fv0=' + cgc_sync_DeviceId__c, "Logs", "_blank") & " | " & 
2HYPERLINK(LEFT($Api.Partner_Server_URL_260, FIND( '/services', $Api.Partner_Server_URL_260)) + '/lightning/r/Report/'+ $Setup.cgc_sync_Sync_Report_Links__c.cgc_sync_Sync_History_Id__c +'/view?fv1=' + cgc_sync_DeviceId__c, "Sync History", "_blank") & " | " & 
3HYPERLINK(LEFT($Api.Partner_Server_URL_260, FIND( '/services', $Api.Partner_Server_URL_260)) + '/lightning/r/Report/'+  $Setup.cgc_sync_Sync_Report_Links__c.cgc_sync_KPI_Id__c  +'/view?fv0=' + cgc_sync_DeviceId__c, "KPIs", "_blank")

cgc_sync__Link_to_the_Record__c 

  • Type: string

  • Properties: Filter, Nillable, Sort

  • Description: Link to the sync record.

    This is a calculated field.

  • Formula:

    1LEFT($Api.Partner_Server_URL_260, FIND( '/services', $Api.Partner_Server_URL_260)) + Id

cgc_sync__Local_Database_Record_Count__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Number of records on the local database of the device.

cgc_sync__Max_Error_Events_Per_Period__c 
  • Type: double
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Description: Maximum number of error events that a device can send over a period of time (set in Events Period field), when Log Level field is set as Error.

cgc_sync_Max_Other_Events_Per_Period__c 
  • Type: double
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Description: Maximum number of events that a device can send over a period of time (set in Events Period field), when Log Level field is set as either Debug, Info, or Log.

cgc_sync_Number_Of_Resets__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total number of resets performed.

cgc_sync_Pending_Record_Count__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Number of records that are yet to be synced.

cgc_sync_Permission_Set_Assigned__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether a permission set is assigned (true) or not (false).
  • Default value: false

cgc_sync_Platform__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Platform of the device.

cgc_sync_Record_Error_Count__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Number of errors detected.

cgc_sync_Remote_Procedure_Call_Log__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: List of command instances executed by the client. .

cgc_sync_Remote_Procedure_Call_Queue__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A semicolon-separated list of command instances (in order of insertion). Clients can use this list to determine the remote procedures that are called from the back end.

cgc_sync_Remote_Procedure_Call_Supported_Commands__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A semicolon-separated list of command code names. Clients can populate this list to determine the remote procedures that can be called from the back end.

cgc_sync_Schemaless_Extension_JSON__c 
  • Type: textarea
  • Properties: Create, Defaulted on create, Nillable, Update
  • Description: User or project-specific data that’s associated to a specific application without a schema.

cgc_sync_Status_BL__c 

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description: Indicates the functional state of the business logic.

  • Default value: G

  • Possible values:

    • G—OK
    • R—Error
    • Y—Warning

cgc_sync_Status_FW__c 

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description: Indicates the function state of the Consumer Goods Cloud offline mobile app framework using a traffic light indicator. This field derives values from the Device Status picklist.

  • Default value: G

  • Possible values:

    • G— OK
    • R— Error
    • Y— Warning

cgc_sync_Status_Sync__c 

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description: Indicates the function state of the Sync engine using a traffic light indicator. This field derives values from the Device Status picklist.

  • Default value: G

  • Possible values:

    • G—OK
    • R—Error
    • Y—Warning

cgc_sync_Sync_Error_Message__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Message to display when an error occurs during sync.

cgc_sync_Sync_Status__c 

  • Type: string

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Status of the latest sync process.

  • Possible values:

    • SyncError
    • Synchronized
    • Synchronizing
    • AwaitingSynchronization

cgc_sync_TechPanel__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Toggle to enable (true) or disable (false) the tech panel on the mobile device. ’\.
  • Default value: false

cgc_sync_Total_API_Calls_Down__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total number of API calls made during sync between Salesforce back-end and the mobile device since the first installation. This value is not affected by a reset.

cgc_sync_Total_API_Calls_Everything__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total number of API calls since the first installation. This value is not affected by a reset.

cgc_sync_Total_API_Calls_Misc__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total numer of API calls since the first installation, not considered in upload, download, or NFT syncs. This value is not affected by a reset.

cgc_sync_Total_API_Calls_NFT__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total number of API calls used to sync NFT (Named Fetch Tree) data since the first installation. This value is not affected by a reset.

cgc_sync_Total_API_Calls_Up__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total number of API calls grouped by upload syncs since the first installation. This value is not affected by a reset.

cgc_sync_TraceModeTill__c 
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Date until which the trace mode will be active on the mobile device.

cgc_sync_Trace_Mode_Area__c 

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description: Area on which trace mode is active.

  • Default value: Application

  • Possible values:

    • All
    • Application
    • Synchronization

cgc_sync_Trace_Mode_Duration__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total number of hours for which trace mode logging can remain active on the mobile device.

cgc_sync_Trace_Mode_On__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Enable (true) or disable (false) trace mode.
  • Default value: false

cgc_sync_User__c 

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Information about the app user.

    This is a relationship field.

  • Relationship Name: cgc_sync_User__r

  • Relationship Type: Lookup

  • Refers To: User

cgc_sync_minCacheLogLevel__c 
  • Type: double
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Description: Minimum cache log level.

cgc_sync_minPrintLogLevel__c 
  • Type: double
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Description: Minimum print log level.

cgc_sync_minSubmitLogLevel__c 
  • Type: double
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Description: Minimum submit log level.

Associated Objects 

Associated Objects 

This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

Get Started with Consumer Goods Cloud
Retail Execution
Standard Objects for Retail Execution
Associated Objects for Retail Execution
Custom Objects for Retail Execution
Standard DLO to DMO Mappings
Retail Execution Standard Metadata APIs
Retail Order Customization
Sync Management
Custom Objects for Sync Management
cgc_sync__Sync_API_Log__c
cgc_sync__Sync_Client_App_Profile_Mapping__c
cgc_sync__Sync_Client_Registration__c
cgc_sync__Sync_Config__c
cgc_sync__Sync_ID_Mapping__c
cgc_sync__Sync_History__c
cgc_sync__Sync_History_Detail__c
cgc_sync__Sync_Message__c
cgc_sync__Sync_Message_Translation__c
cgc_sync__Sync_Metadata_Changes__c
cgc_sync__Sync_Mobile_App_Component__c
cgc_sync__Sync_Mobile_App_Domain__c
cgc_sync__Sync_Mobile_App_Depl_Pkg__c
cgc_sync__Sync_Mobile_App_Depl_Pkg_As__c
cgc_sync__Sync_Mobile_App_Depl_Pkg_Inst__c
cgc_sync__Sync_Mobile_App_Installation__c
cgc_sync__Sync_Mobile_App_Log__c
cgc_sync__Sync_Mobile_App_Macro__c
cgc_sync__Sync_Mobile_App_PL_Config__c
cgc_sync__Sync_Mobile_App_PL_Map__c
cgc_sync__Sync_Mobile_App_PL_Map_Ext__c
cgc_sync__Sync_Mobile_App_PL_Repo__c
cgc_sync__Sync_Mobile_App_Theme__c
cgc_sync__Sync_Named_Fetch_Tree_Nodes__c
cgc_sync__Sync_Named_Query__c
cgc_sync__Sync_Remote_Request__c
cgc_sync__Sync_Report_Links__c
cgc_sync__Sync_Tracked_Object_Config__c
Custom Metadata Types in Sync Management
Direct Store Delivery
Einstein Visit and Activity Recommendation
Trade Promotion Management
Custom Objects for Retail Execution and Trade Promotion Management
Standard and Custom Objects for Future Use
API End-of-Life Policy
Previous Versions