Newer Version Available

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

cgcloud__Visit_Template__c

Template that describes the basic call behavior. 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 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__Add_Job_Policy__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether tasks and survey questions can be manually added to visits.
The default value is false.
cgcloud__Auto_Status__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Visit status set when call will be planned automatically.
Possible values are:
  • Abandoned
  • Completed
  • Planned
The default value is Planned.
cgcloud__Cancel_Reason_Required__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Required reason for the cancellation.
The default value is false.
cgcloud__Capture_Proceeding_Time__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Capture proceeding time.
The default value is false.
cgcloud__Check_Overlap__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether to check for overlaps while creating calls. If this option is selected, the system checks if a current visit overlaps with any other visits. Only visits in Planned state are considered.
The default value is false.
cgcloud__Company_Required__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Required company details.
Possible values are:
  • Mandatory
  • Not required
The default value is Not required.
cgcloud__Consider_POS_Check__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
If its value is true, then the Call considers POS in its questions.
The default value is true.
cgcloud__Creation_Platform__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Creation platform.
Possible values are:
  • Both
  • Laptop
  • Mobility
The default value is Both.
cgcloud__Default_Duration__c
Type
double
Properties
Create, Defaulted on create, Filter, Sort, Update
Description
Visit default duration in minutes.
cgcloud__Delete_Allowed__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether a visit can be deleted using a mobile device.
The default value is false.
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 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),
6      cgcloud__Description_Language_1__c)
cgcloud__Display_Promotions__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether valid promotions for the customer selected for a visit creation are shown in the Promotions tab of the Visit Detail page.
The default value is false.
cgcloud__Historical_Products__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Determines whether and how historical products are considered when determining the list of products to be surveyed in a visit.
Possible values are:
  • All
  • No
  • SameMeta—Same Template
The default value is No.
cgcloud__KPI_Relevant__c
Type
multipicklist
Properties
Create, Filter, Nillable, Restricted picklist, Update
Description
Defines whether a call is relevant for KPI calculation for the selected KPIs.
Possible values are:
  • All—All KPIs
cgcloud__Loc_Capture_During_Cancel__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Location capture during the cancellation process.
The default value is false.
cgcloud__Loc_Capture_During_Complete__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Location capture during the completion process.
The default value is false.
cgcloud__Max_Pictures__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Maximum number of pictures.
cgcloud__Meta_Type__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Defines another level of abstraction - categorizes templates into template templates. For example, is it a template for a Call, a Delivery Visit, a Van Sales, a Merchandising, a Service, or a Phone.
Possible values are:
  • Call
  • DeliveryVisit—Delivery Visit
  • Merchandising
  • Phone
  • Service
  • VanSales—Van Sales
The default value is Call.
cgcloud__Mobility_Color__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Field that defines the color of call on a mobility device.
Possible values are:
  • 003344—ink blue
  • 008899—sea green 2
  • 20B2AA—light sea green
  • 467596—grey blue
  • 551155—red violet
  • 6495ED—corn flower blue
  • 6688BB—periwinkle blue
  • 77AA99—sage green
  • 87CEEB—sky blue
  • 87CEFA—light sky blue
  • 8FBC8F—dark seagreen
  • AA1133—cranberry red
  • ADD8E6—light blue
  • B0C4DE—light steel blue
  • BBBB00—lime green 2
  • BC8F8F—rosy brown
  • D1DDEC—sky blue 2
  • DAA520—golden rod
  • DD4411—dark orange
  • DDECD1—turquoise 2
  • E9967A—dark salmon
  • EE9B38—yellow orange
  • EED2E0—plum
  • F08080—light coral
  • F4A460—sandy brown
  • F7EBD9—khaki 2
  • FA8072—salmon
  • FF7F50—coral
  • FFA07A—light salmon
  • FFD700—gold
cgcloud__Mobility_Relevant__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether a visit created can be executed using mobile devices.
The default value is false.
cgcloud__Mobility_User_Guidance__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Process navigation (user guidance) that is used on mobility devices.
Possible values are:
  • Delivery
  • Merchandizing
  • NonCustomer
  • Sales
The default value is Sales.
cgcloud__Promotion_Finding_Lead_Time__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Number of days that specifies future time range for finding of planned promotions.
cgcloud__Sales_Org__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Defines the Sales Organization in which the template can be used.
Possible values are:
  • 0000
  • 0001
  • 0002
  • 0003
cgcloud__Sort__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
On Selection of visit template (For example, when creating a new visit): Defines the order of the templates.
cgcloud__Sync_Options__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Defines when a visit based on this template will be synced automatically:
Possible values are:
  • CancelCall
  • CompleteCall
  • CompleteCancelCall
  • No
The default value is No.
cgcloud__Tag_Media_Date_Time__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether date and time of media captured during visit execution on mobile devices is stored.
The default value is false.
cgcloud__Tag_Media_Geo_Location__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether GPS coordinates of media captured during visit execution on mobile devices is stored.
The default value is false.
cgcloud__Update_Planned_Times__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates if the Start or End datetimes and duration of the visit should be set
The default value is false.
cgcloud__User_Roles__c
Type
multipicklist
Properties
Create, Filter, Nillable, Update
Description
User roles that are assigned to the Order Template. Note: Ensure that the master picklist values exactly match the technical name of the permission sets. Select the user value in translation. For example, if CGCloud_Master_Data_Admin is the master picklist value, then Master Data Admin is the translated value.
Possible values are:
  • CGCloud_KAM—KAM
  • CGCloud_Master_Data_Admin—Master Data Admin
  • CGCloud_Retail_Admin—Retail Admin
  • CGCloud_Sales_User—Sales User
  • CGCloud_Security_Admin—Security Admin
  • CGCloud_Supervisor—Supervisor
  • CGCloud_Tour_User

Associated Objects

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

cgcloud__Visit_Template__cChangeEvent
Change events are available for the object.
cgcloud__Visit_Template__cFeed
Feed tracking is available for the object.
cgcloud__Visit_Template__cHistory
History is available for the tracked fields of the object.
cgcloud__Visit_Template__cOwnerSharingRule
Sharing rules are available for the object.
cgcloud__Visit_Template__cShare
Sharing is available for the object.