Newer Version Available

This content describes an older version of this product. View Latest

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

Field Details
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.
The default value is 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 are:
  • 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.
The default value is 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.
Possible values are:
  • No
  • Optional
  • Yes
The default value is No.
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.
The default value is 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.
Possible values are:
  • No
  • Status—Only Status
  • StatusReason—Status + Reason
The default value is No.
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.
Possible values are:
  • No
  • Truck
  • TruckTrailer—Truck+Trailer
  • TruckTrailers—Truck + Trailer 1,2
The default value is Truck.
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 are:
  • 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 are:
  • 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.
The default value is 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.
The default value is 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.
The default value is 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.
Possible values are:
  • Delivery
  • None
The default value is 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.
Possible values are:
  • Delivery
  • None
The default value is 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.
The default value is 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.
The default value is 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.
The default value is 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.
The default value is 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.
The default value is 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.
The default value is 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.
The default value is 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.
The default value is 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 are:
  • 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.
The default value is 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.
Possible values are:
  • No
  • OnTourEnd—On Tour End
  • OnTourEndStart—On Tour End/Start
  • OnTourStart—On Tour Start
The default value is No.

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.

cgcloud__Tour_Template__cChangeEvent
Change events are available for the object.
cgcloud__Tour_Template__cFeed
Feed tracking is available for the object.
cgcloud__Tour_Template__cHistory
History is available for the tracked fields of the object.
cgcloud__Tour_Template__cOwnerSharingRule
Sharing rules are available for the object.
cgcloud__Tour_Template__cShare
Sharing is available for the object.