Type Alias SharingExecutionPersist

type SharingExecutionPersist = {
    appId?: string;
    bookmarkId?: string;
    bookmarkIds?: string[];
    cancelledCount?: number;
    cancelledTime?: string;
    endTime?: string;
    errors?: SharingExecutionErrors;
    eventID?: string;
    eventTime?: string;
    failedCount?: number;
    failedTime?: string;
    failedUploadCount?: number;
    files?: SharingExecutionFile[];
    id?: string;
    ownerId?: string;
    reloadId?: string;
    reloadTime?: string;
    sharingTaskID?: string;
    startTime?: string;
    status?:
        | "initialized"
        | "in-progress"
        | "successful"
        | "failed"
        | "cancelled"
        | "invalid"
        | "presuccessful"
        | "cancelling";
    successCount?: number;
    successUploadCount?: number;
    targetUser?: TargetUser;
    tenantId?: string;
    totalCount?: number;
    totalUploadCount?: number;
    workflowID?: string;
}
Index

Properties

appId? bookmarkId? bookmarkIds? cancelledCount? cancelledTime? endTime? errors? eventID? eventTime? failedCount? failedTime? failedUploadCount? files? id? ownerId? reloadId? reloadTime? sharingTaskID? startTime? status? successCount? successUploadCount? targetUser? tenantId? totalCount? totalUploadCount? workflowID?

Properties

appId?: string

appId associated to sharing task execution

bookmarkId?: string

The ID of a filter in a reporting request

bookmarkIds?: string[]
cancelledCount?: number

Total count of cancelled reports in this execution

cancelledTime?: string

Timestamp of execution cancel

endTime?: string

Timestamp of execution successful stop

errors?: SharingExecutionErrors
eventID?: string

eventID of the trigger NATS event

eventTime?: string

eventTime of the trigger NATS event

failedCount?: number

Total count of failed reports in this execution

failedTime?: string

Timestamp of execution stop

failedUploadCount?: number

Total count of failed uploaded reports in this execution

files?: SharingExecutionFile[]
id?: string

Gets the execution identifier.

ownerId?: string

Owner of the execution

reloadId?: string

If this execution was triggered by an app reload. This will contain the reloadId from reloads service. Otherwise it is empty or omitted.

reloadTime?: string

If this execution was triggered by an app reload. This will contain the reload time to compare with reporting service when the report is requested.

sharingTaskID?: string

ID for the sharing task that this execution references

startTime?: string

Timestamp of execution start

status?:
    | "initialized"
    | "in-progress"
    | "successful"
    | "failed"
    | "cancelled"
    | "invalid"
    | "presuccessful"
    | "cancelling"

Status of the task execution

successCount?: number

Total count of successfully generated reports in this execution

successUploadCount?: number

Total count of successfully uploaded reports in this execution

targetUser?: TargetUser

User that this execution is targeting as a recipient

tenantId?: string

The tenant that this execution belongs to

totalCount?: number

Total count of reports in this execution

totalUploadCount?: number

Total count of reports to be uploaded in this execution

workflowID?: string

Workflow that the execution belongs to. Note that in a multi-recipient context we can have multiple executions (one per recipient) that share the same unique workflow.

Settings

Member Visibility

On This Page

Properties