Newer Version Available

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

DataDetectJobSession (Beta)

Represents a run of a DataDetect scan policy that's triggered manually. This object is available in API version 63.0 and later.

Data Detect is a pilot or beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer's sole discretion.

Note

To opt in for beta, contact your Salesforce account executive. After the org permission is enabled, users can access the Data Detect app from the App launcher.

Supported Calls

delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete()

Fields

Field Details
DataDetectPolicyId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the scan policy associated with this job session.

This field is a relationship field.

Relationship Name
DataDetectPolicy
Refers To
DataDetectPolicy
DataDetectPolicySnapshotId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the snapshot of the scan policy associated with this job session.

This field is a relationship field.

Relationship Name
DataDetectPolicySnapshot
Relationship Type
Master-Detail
Refers To
DataDetectPolicySnapshot
EndTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Time and date when the data scan completes.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Auto-generated name of the job session.
NamedEntityCount
Type
int
Properties
Create, Filter, Nillable, Update
Description
Aggregate count of PII found during the data scan.
PolicyJobStatus
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Status of the data scan. Valid values are:
  • Completed and CsvNoPiiData
  • Completed and CsvUploadFailed
  • Completed and CsvUploadInProgress
  • Completed and CsvUploadSuccess
  • Failed and CsvNoPiiData
  • Failed and CsvUploadFailed
  • Failed and CsvUploadInProgress
  • Failed and CsvUploadSuccess
  • PartialSuccess and CsvNoPiiData
  • PartialSuccess and CsvUploadFailed
  • PartialSuccess and CsvUploadInProgress
  • PartialSuccess and CsvUploadSuccess
  • Scheduled

The default value is Scheduled.

RunByUser
Type
string
Properties
Filter, Group, Nillable, Sort
Description
User who started the job session or data scan.
StartTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Time and date when the data scan begins. Data scan can start anytime within a 30-day window from the current date.

Associated Objects

This object has this associated object. If the API version isn’t specified, it's available in the same API version as this object. Otherwise, it's available in the specified API version and later.

DataDetectJobSessionFeed
Feed tracking is available for the object.