Newer Version Available

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

WaveAutoInstallRequest

Provides access the concrete object that represents an Analytics auto install request. The auto install request tracks the progress of Analytics applications created from Analytics templates by the automated process user. This object is available in API version 38.0 and later.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Special Access Rules

Einstein Analytics must be enabled in your org. A user must have the Auto Install permission enabled.

Fields

Field Details
Configuration
Type
textarea
Properties
Create, Nillable
Description
Analytics application configuration for the auto install request.
FailedReason
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
If the Analytics application fails to complete successfully, this value is the reason why the failure occurred. Values can be OrganizationIncompatible, RetriesExhausted, RequestCancelled, AppCreateFailure, AppUpdateFailure, AppConstructionFailure, WaveDisabled, CancelFailed, DeleteFailed, DependencyFailure, DependencyCancelled, FailedToEnqueue, and FailedOther
FolderId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The ID of the Analytics application created by the auto install request.
IsLocked
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates if the auto install request is locked or not.
MayEdit
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates if the auto install request can be edited or not
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the auto install request, provided at creation by the user.
RequestLog
Type
textarea
Properties
Create, Nillable, Update
Description
A log of the auto install progress and completion results.
RequestStatus
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The status of the auto install request. Values can be New, Enqueued, Cancelled, In Progress, AppInProgress, Failed, and Success.
RequestType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
The type of auto install request. Values can be WaveEnable, OrgCompatibilityCheck, WaveAppCreate, WaveAppUpdate, WaveAppDelete, and StartDataflow.
TemplateApiName
Type
string
Properties
Create, Filter, Group, Nillable, Sort
Description
The API name of the Analytics template to create the Analytics app from.
TemplateVersion
Type
string
Properties
Create, Filter, Group, Nillable, Sort
Description
The version of the Analytics template to create the Analytics app from.

Usage

Use this object to query and create auto install requests for Analytics applications in your org. This object is useful to troubleshoot issues with templated applications that are created by the automated process user.