Documentation Center

BackgroundTask 2.5 CreateBackgroundTask

Creates a new background task which can be started immediately


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services, making this parameter redundant.
psEventTypeStringInThe type of the event (e.g PUBLISH)
pbInputDataBlobInThe input data for the background task
plOutProgressIdLongInOutThe unique identifier of the new event.
psHashIdStringInThe string with the hashId, this will be used to skip older background task for the same action. For instance, synchronizing the same language object only once to SDL LiveContent.
plOutTaskIdLongOutThe unique identifier of the new background task.

Note that:

  • The following fields are set automatically:
    • The initial status is set to "Pending'"
    • The userid is set to the current user
    • The creation date and modification date are initialized to the current UTC date (and time)
    • The trackingid is set to the progressid
    • The current attempt is set to "1"
  • Normally the event log is already started via EventMonitor.StartEvent, however if no progressId is provided a new event log record will be created with the following parameters:
    • psEventType: The provided psEventType
    • psDescription: The provided psEventType
    • plParentProgressId: 0, so indicating that there is no parent event
    • piMaximumProgress: 1