Newer Version Available

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

cgcloud__Tour__c

Stores the details of the tour object. 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 that a user referenced this record on.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Most recent date that a user viewed this record on.
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
RecordTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference to the record type.
This field is a relationship field.
Relationship Name
RecordType
Relationship Type
Lookup
Refers To
RecordType
cgcloud__Cancel_Note__c
Type
textarea
Properties
Create, Nillable, Update
Description
Note that can be specified if the tour is canceled.
cgcloud__Cancel_Reason__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Indicates the reason that the tour was canceled for.
Possible values are:
  • RouteClosed—Route Closed
  • VehicleProblems—Vehicle Problems
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__Completion_Release_Time__c
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
Stores the tour end release time.
cgcloud__Consider_Mileage__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies whether it's mandatory that the driver documents the odometer information when beginning and ending the tour.
Possible values are:
  • No
  • Optional
  • Yes
cgcloud__Consider_Vehicle_Status__c
Type
picklist
Properties
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 the end of the tour.
Possible values are:
  • No
  • Status—Only Status
  • StatusReason—Status + Reason
cgcloud__Consider_Vehicle__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies whether the driver must check the license plate numbers of the truck and its trailers.
Possible values are:
  • No
  • Truck
  • TruckTrailer—Truck + Trailer
  • TruckTrailers—Truck + Trailer 1,2
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_Driver__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference to the default driver of the tour.
This field is a relationship field.
Relationship Name
cgcloud__Default_Driver__r
Relationship Type
Lookup
Refers To
User
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
Reference to the 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__End_Date_Time__c
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
First date and time of validity period of the tour.
cgcloud__End_Warehouse__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference to the warehouse where the tour ended.
This field is a relationship field.
Relationship Name
cgcloud__End_Warehouse__r
Relationship Type
Lookup
Refers To
cgcloud__Warehouse__c
cgcloud__Express_Check_Out__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Specifies whether the driver is allowed to use the express checkout type.
The default value is false.
cgcloud__Has_End_Tour_Veh_Details_Rvw__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the vehicle details are reviewed (true) or not (false) during the end tour activities.
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__Message__c
Type
textarea
Properties
Create, Nillable, Update
Description
Message for the driver of the tour.
cgcloud__Multiple_Cash_Check_In_Allowed__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Defines whether multiple cash check-ins for one tour are allowed.
The default value is false.
cgcloud__Odometer_End__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Mileage of the truck after ending the tour.
cgcloud__Odometer_Start__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Mileage of the truck before starting the tour.
cgcloud__Route__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference to the route.
This field is a relationship field.
Relationship Name
cgcloud__Route__r
Relationship Type
Lookup
Refers To
cgcloud__Route__c
cgcloud__Sales_Org__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Describes the sales org that the tour 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
Show cash or expenses information in the tour summary report.
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 at the start of the day is allowed.
The default value is false.
cgcloud__Start_Date_Time__c
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
Last date and time of validity period of the tour.
cgcloud__Start_Release_Time__c
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
Stores the start release time.
cgcloud__Start_Warehouse__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference to the warehouse.
This field is a relationship field.
Relationship Name
cgcloud__Start_Warehouse__r
Relationship Type
Lookup
Refers To
cgcloud__Warehouse__c
cgcloud__Status__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Current status of the tour.
Possible values are:
  • Canceled
  • Completed
  • Initial
  • Open
  • Running
The default value is Open.
cgcloud__Tour_Template__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference to the tour template.
This field is a relationship field.
Relationship Name
cgcloud__Tour_Template__r
Relationship Type
Lookup
Refers To
cgcloud__Tour_Template__c
cgcloud__Trailer_1__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference to the truck with trailer. Reference to the vehicle.
This field is a relationship field.
Relationship Name
cgcloud__Trailer_1__r
Relationship Type
Lookup
Refers To
cgcloud__Vehicle__c
cgcloud__Trailer_2__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference to the truck with second trailer. Reference to the vehicle.
This field is a relationship field.
Relationship Name
cgcloud__Trailer_2__r
Relationship Type
Lookup
Refers To
cgcloud__Vehicle__c
cgcloud__Truck_Status_End__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of damage observed after the tour finishes.
Possible values are:
  • Brakes—Brakes are Broken
  • Lights—Lights broken
  • Mirror—Wing mirror broken
  • Misc
  • Paint—Paint scratch
  • Tires—Flat tire
  • Vehicle—Vehicle damaged
  • Wash—Screenwash empty
cgcloud__Truck_Status_Start__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of damage observed before the tour starts.
Possible values are:
  • Brakes—Brakes are Broken
  • Lights—Lights broken
  • Mirror—Wing mirror broken
  • Misc
  • Paint—Paint scratch
  • Tires—Flat tire
  • Vehicle—Vehicle damaged
  • Wash—Screenwash empty
cgcloud__Truck__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference to the truck that carries out the tour. Reference to the vehicle.
This is a relationship field.
Relationship Name
cgcloud__Truck__r
Relationship Type
Lookup
Refers To
cgcloud__Vehicle__c
cgcloud__Truck_ok_End__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies whether the truck (and its trailers) have had any damage after finishing the tour.
Possible values are:
  • 0—No
  • 1—Yes
cgcloud__Truck_ok_Start__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies whether the truck (and its trailers) had any damage before starting the tour.
Possible values are:
  • 0—No
  • 1—Yes

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__cChangeEvent
Change events are available for the object.
cgcloud__Tour__cFeed
Feed tracking is available for the object.
cgcloud__Tour__cHistory
History is available for the tracked fields of the object.
cgcloud__Tour__cOwnerSharingRule
Sharing rules are available for the object.
cgcloud__Tour__cShare
Sharing is available for the object.