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

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

cgcloudActivec

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Active flag.
Default value: 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.
Default value: 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.
Default value: Planned
Possible values:
- Abandoned
- Completed
- Planned

cgcloud__Cancel_Reason_Required__c

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the user must provide a reason for visit cancellation.
Default value: false

cgcloud__Capture_Proceeding_Time__c

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Captures the start and end time of a visit.
Default value: 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.
Default value: false

cgcloud__Cmpl_Vst_Geolc_Validation__c

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: Specifies the validation type when a user completes a visit, based on the comparison between their GPS location and the geolocation of the store.
Default value: None
Possible values:
- Error
- None
- Warning

cgcloud__Company_Required__c

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: Required company details.
Default value: Not required
Possible values:
- Mandatory
- 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.
Default value: true

cgcloud__Creation_Platform__c

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: Creation platform.
Default value: Both
Possible values:
- Both
- Laptop
- Mobility

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.
Default value: 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.

cgcloudDescriptionc

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.
Default value: false

cgcloud__Does_Show_Read_Only_Visit_Info__c

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Determines whether the users sees an information message that indicates that the visit hasn’t started and is in read-only mode.
Default value: 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.
Default value: No
Possible values:
- All
- No
- SameMeta—Same Template

cgcloud__Is_Start_Visit_Rqr_To_Check_In__c

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Determines whether a user needs to start a visit before visit execution.
Default value: false

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:
- All—All KPIs

cgcloud__Limit_To_One_Visit_In_Progress__c

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Prevent users from executing multiple visits at the same time.
Default value: false

cgcloud_Location_Capture_at_Start__C

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates if a user’s GPS location is captured at the start of a visit. This field applies only to Direct Store Delivery and Van Sales processes.
Default value: false

cgcloud__Loc_Capture_During_Cancel__c

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the user’s GPS location is recorded during visit cancellation.
Default value: false

cgcloud__Loc_Capture_During_Complete__c

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the GPS location of the user is captured at visit completion.
Default value: 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.
Default value: Call
Possible values:
- Call
- DeliveryVisit—Delivery Visit
- Merchandising
- Phone
- Service
- VanSales—Van Sales

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:
- 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.
Default value: 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.
Default value: Sales
Possible values:
- Delivery
- Merchandizing
- NonCustomer
- 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:
- 0000
- 0001
- 0002
- 0003

cgcloudSortc

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__Start_Vst_Geolc_Validation__c

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: Specifies the validation type when a user starts a visit, based on the comparison between their GPS location and the geolocation of the store.
Default value: None
Possible values:
- Error
- None
- Warning

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:
Default value: No
Possible values:
- CancelCall
- CompleteCall
- CompleteCancelCall
- 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.
Default value: 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.
Default value: 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
Default value: 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:
- 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.

cgcloud__Visit_Template__c

Supported Calls

Fields

LastReferencedDate

LastViewedDate

Name

OwnerId

cgcloud__Active__c

cgcloud__Add_Job_Policy__c

cgcloud__Auto_Status__c

cgcloud__Cancel_Reason_Required__c

cgcloud__Capture_Proceeding_Time__c

cgcloud__Check_Overlap__c

cgcloud__Cmpl_Vst_Geolc_Validation__c

cgcloud__Company_Required__c

cgcloud__Consider_POS_Check__c

cgcloud__Creation_Platform__c

cgcloud__Default_Duration__c

cgcloud__Delete_Allowed__c

cgcloud__Description_Language_1__c

cgcloud__Description_Language_2__c

cgcloud__Description_Language_3__c

cgcloud__Description_Language_4__c

cgcloud__Description__c

cgcloud__Display_Promotions__c

cgcloud__Does_Show_Read_Only_Visit_Info__c

cgcloud__Historical_Products__c

cgcloud__Is_Start_Visit_Rqr_To_Check_In__c

cgcloud__KPI_Relevant__c

cgcloud__Limit_To_One_Visit_In_Progress__c

cgcloud_Location_Capture_at_Start__C

cgcloud__Loc_Capture_During_Cancel__c

cgcloud__Loc_Capture_During_Complete__c

cgcloud__Max_Pictures__c

cgcloud__Meta_Type__c

cgcloud__Mobility_Color__c

cgcloud__Mobility_Relevant__c

cgcloud__Mobility_User_Guidance__c

cgcloud__Promotion_Finding_Lead_Time__c

cgcloud__Sales_Org__c

cgcloud__Sort__c

cgcloud__Start_Vst_Geolc_Validation__c

cgcloud__Sync_Options__c

cgcloud__Tag_Media_Date_Time__c

cgcloud__Tag_Media_Geo_Location__c

cgcloud__Update_Planned_Times__c

cgcloud__User_Roles__c

Associated Objects

Associated Objects

cgcloudActivec

cgcloudDescriptionc

cgcloudSortc