cgcloud__Tour_Template__c

Stores the details of the tour template object that’s to be used for tours. This object is available in API version 54.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: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
  • 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 field is a polymorphic relationship field.

  • Relationship Name: Owner

  • Relationship Type: Lookup

  • Refers To: Group, User

cgcloud__Active__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Active flag.
  • Default value: true

cgcloud__Cash_Check_In_Required__c 

  • Type: picklist

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

  • Description: Defines whether the cash check-in at the end of each tour is mandatory.

  • Possible values:

    • Mandatory
    • Optional

cgcloud__Cash_Handling_Required__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Specifies whether the driver can perform cash-related actions during the tour execution.
  • Default value: false

cgcloud__Consider_Mileage__c 

  • Type: picklist

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

  • Description: Specifies whether it’s mandatory for the driver to document odometer information when beginning and ending the tour.

  • Default value: No

  • Possible values:

    • No
    • Optional
    • Yes

cgcloud__Consider_Multiple_Warehouses__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Defines if more than one warehouse must be considered for the tour.
  • Default value: false

cgcloud__Consider_Vehicle_Status__c 

  • Type: picklist

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

  • Description: Specifies whether the driver must check and document the status or damages of the truck (and its trailers) at the beginning and end of the tour.

  • Default value: No

  • Possible values:

    • No
    • Status—Only Status
    • StatusReason—Status + Reason

cgcloud__Consider_Vehicle__c 

  • Type: picklist

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

  • Description: Specifies the vehicle that the driver has to provide identification (license number) for.

  • Default value: Truck

  • Possible values:

    • No
    • Truck
    • TruckTrailer—Truck+Trailer
    • TruckTrailers—Truck + Trailer 1,2

cgcloud__Creation_Platform__c 

  • Type: picklist

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

  • Description: Defines the platform on which the template can be used for creating tours.

  • Possible values:

    • Laptop
    • Mobility
    • Both

cgcloud__Default_Currency__c 

  • Type: picklist

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

  • Description: Defines the default currency of the tour template.

  • Possible values:

    • CAD
    • CHF
    • EUR
    • GBP
    • JPY—Yen
    • NOK
    • RUB
    • USD

cgcloud__Default_Tour_Visit_Duration__c 
  • Type: number
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The duration for creating tour-related visits based on the sequence. It’s measured in minutes.
  • Default value: 30

cgcloud__Description_Language_1__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Stores the description of language 1.

cgcloud__Description_Language_2__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Stores the description of language 2.

cgcloud__Description_Language_3__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Stores the description of language 3.

cgcloud__Description_Language_4__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Stores the description of language 4.

cgcloud__Description__c 

  • Type: string

  • Properties: Filter, Nillable, Sort

  • Description: Description based on the user-specified language.

    This field is a calculated field.

  • Formula:

    1CASE($User.cgcloud__Language_Postfix__c,
2"Language1", cgcloud__Description_Language_1__c,
3"Language2", BLANKVALUE(cgcloud__Description_Language_2__c,cgcloud__Description_Language_1__c),
4"Language3", BLANKVALUE(cgcloud__Description_Language_3__c,cgcloud__Description_Language_1__c),
5"Language4", BLANKVALUE(cgcloud__Description_Language_4__c,cgcloud__Description_Language_1__c),
6cgcloud__Description_Language_1__c)

cgcloud__Express_Check_Out__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Specifies whether express checkout is allowed for this template.
  • Default value: false

cgcloud__Is_Odometer_Photo_Required__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Specifies whether the user documents the odometer reading at the start and the end of the day with a picture.
  • Default value: false

cgcloud__Mobility_User_Guidance_End_of_Day__c 

  • Type: picklist

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

  • Description: Mobility user guidance for the end of the day process.

  • Default value: None

  • Possible values:

    • Delivery
    • None

cgcloud__Mobility_User_Guidance_Start_of_Day__c 

  • Type: picklist

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

  • Description: Mobility user guidance for the start of the day process.

  • Default value: None

  • Possible values:

    • Delivery
    • None

cgcloud__Multiple_Cash_Check_In_Allowed__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Defines whether the multiple cash check-ins for one tour are allowed.
  • Default value: false

cgcloud__Should_Allow_End_Day_Geofencing__c 
  • Type: Boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Specifies whether the validation of the user’s GPS location against warehouse location is enabled at the end of the day.
  • Default value: false

cgcloud__Should_Allow_End_Day_GPS_Tracking__c 
  • Type: Boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Specifies whether GPS tracking is allowed at the end of the day.
  • Default value: false

cgcloud__Should_Allow_End_Day_Time_Tracking__c 
  • Type: Boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Specifies whether end-of-day time tracking is allowed.
  • Default value: false

cgcloud__Should_Allow_Seal_Scanning__c 
  • Type: Boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Specifies whether the user validates a list of seals through scanning or manual entry. This field is applicable only when the Express Check-Out field is selected.
  • Default value: false

cgcloud__Should_Allow_Start_Day_Geofencing__c 
  • Type: Boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Specifies whether the validation of the user’s GPS location against warehouse location is enabled at the start of the day.
  • Default value: false

cgcloud__Should_Allow_Start_Day_GPS_Tracking__c 
  • Type: Boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Specifies whether GPS tracking is allowed at the start of the day.
  • Default value: false

cgcloud__Should_Allow_Start_Day_Time_Tracking__c 
  • Type: Boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Specifies whether the day and time tracking for the start of the day is allowed.
  • Default value: false

cgcloud__Sales_Org__c 

  • Type: picklist

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

  • Description: Describes the sales org that the tour template belongs to.

  • Possible values:

    • 0000
    • 0001
    • 0002
    • 0003

cgcloud__Show_Cash_Info__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Shows cash and expenses information in the tour summary report.
  • Default value: false

cgcloud__Sync_Options__c 

  • Type: picklist

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

  • Description: Specifies whether an immediate background synchronization is to be started after a special event.

  • Default value: No

  • Possible values:

    • No
    • OnTourEnd—On Tour End
    • OnTourEndStart—On Tour End/Start
    • OnTourStart—On Tour Start

Associated Objects 

Associated Objects 

This object has these associated objects. If the API version isn’t specified, they’re 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
Direct Store Delivery
Custom Objects for Direct Store Delivery
cgcloud__Route__c
cgcloud__Route_Template__c
cgcloud__Tour__c
cgcloud__Tour_Check__c
cgcloud__Tour_Object_Reference__c
cgcloud__Tour_Template__c
cgcloud__Tour_Template_Object_Reference__c
cgcloud__Tour_Template_Tour_Check__c
cgcloud__Tour_Tour_Check__c
cgcloud__Vehicle__c
cgcloud__Vehicle_Warehouse__c
cgcloud__Route_Account__c
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