Login
    Contenu x
    taskExecute (Command)
    • 19 Dec 2024
    • 2 Minutes à lire
    • Sombre
      Lumière
    • PDF
    Contenu

    taskExecute (Command)

    • Mis à jour le 19 Dec 2024
    • 2 Minutes à lire
    • Sombre
      Lumière
    • PDF
    The content is currently unavailable in French. You are viewing the default English version.
    Résumé de l’article

    The taskExecute command executes server task–related administrative operations.

      Table: taskExecute commands
    CommandDescription
    TASKCMD_CANCELCancels a server task (see  TASKCMD_CANCEL).
    TASKCMD_DELETEDeletes a server task (see  TASKCMD_DELETE).
    TASKCMD_RESUMEEnables (resumes) a suspended task (see  TASKCMD_RESUME).
    TASKCMD_SUSPENDDisables (suspends) a server task (see  TASKCMD_SUSPEND).
    TASKCMD_UPDATEUpdates task field details (see  TASKCMD_UPDATE).
    TASKCMD_VIEWRetrieves the settings of the specified server task (see  TASKCMD_VIEW).

    Parameters

      Table:  taskExecute field attributes
    Attribute nameData typeDescription
    TASKFLD_CREATE_TIMEDateTimeThe date and time the data record was created.
    TASKFLD_DESCRIPTIONStringThe server-generated task description, e.g. the specific report name.
    TASKFLD_DOMAIN_NAMEStringThe domain in which the task has been created.
    TASKFLD_END_TIMEDateTimeThe date and time during task processing and the time the task is finished.
    TASKFLD_FEATURESString

    The scheduling features supported by the command.

    Possible values:

    • Non
    • scheduled
    • recurrent
    TASKFLD_MODEString

    The task processing mode. This defines which server instance(s) should executed the task.

    Possible values:

    • Specific
    • Any
    • All
    TASKFLD_MODIFY_TIMEDateTimeThe date and time the data record was last modified.
    TASKFLD_PROGRESSUnsigned Integer

    The task progress.

    Possible values: 0–10000

    TASKFLD_SCHEDULEBoolean

    Indicates whether the task is scheduled.

    Possible values:

    • true
    • false
    TASKFLD_SCHEDULE_DATEString

    The scheduled date if TASKFLD_SCHEDULE_RECURRENCE is set to None.

    Format: DD/MM/YYYY

    Example: 20/07/2013

    TASKFLD_SCHEDULE_MONTHDAYInteger

    Day of the month for which the task is scheduled, if recurring monthly.

    Possible values: 1–31

    TASKFLD_SCHEDULE_MONTHSString

    Scheduled month for the recurring task. Space-separated list of applicable months.

    Possible values:

    • January
    • February
    • March
    • April
    • May
    • June
    • July
    • August
    • September
    • October
    • November
    • December
    TASKFLD_SCHEDULE_NOTIFYString

    Method of notification.

    Possible values:

    • None
    • SMS
    • Email
    TASKFLD_SCHEDULE_RECURRENCEString

    Recurrence type.

    Possible values:

    • None
    • Daily
    • Monthly
    TASKFLD_SCHEDULE_TIMEString

    The scheduled time of the day to execute the task.

    Format: hh:mm

    Use 24-hour time. For example: 21:00

    TASKFLD_SCHEDULE_WEEKDAYSString

    The scheduled day of the week for a recurring task. Space-separated list of applicable days.

    Possible values:

    • Monday
    • Tuesday
    • Wednesday
    • Thursday
    • Friday
    • Saturday
    • Sunday
    TASKFLD_SERVER_IDStringThe IP address of the server instance the task has been assigned to.
    TASKFLD_START_TIMEDateTimeDate and time when task processing was started.
    TASKFLD_STATUS

    String

    Current task status as combination of different states.

    • Scheduled
    • Disabled
    • Running
    • Cancelling
    • Canceled
    • Finished
    • Failed
    TASKFLD_STATUS_INFORMATIONString

    Status information.

    TASKFLD_TASK_IDStringThe unique task ID generated by OneSpan Authentication Server.
    TASKFLD_TASK_TYPEStringThe (server-generated) task type.
    TASKFLD_USER_IDStringThe ID of the user who created the server task.

    TASKCMD_VIEW

    Only the TASKFLD_TASK_ID attribute can be specified in the attributeSet input parameter of this command. This attribute is mandatory.

    The following attributes will be specified in the results output parameter of this command:

      Table: TASKCMD_VIEW (Supported output attributes)
    Attribute nameReturned
    TASKFLD_CREATE_TIMEAlways
    TASKFLD_DESCRIPTIONAlways
    TASKFLD_END_TIMEIf defined
    TASKFLD_FEATURESAlways
    TASKFLD_MODEAlways
    TASKFLD_MODIFY_TIMEAlways
    TASKFLD_PROGRESSIf defined
    TASKFLD_SERVER_IDAlways
    TASKFLD_SCHEDULEAlways
    TASKFLD_SCHEDULE_DATEAlways
    TASKFLD_SCHEDULE_MONTH_DAYAlways
    TASKFLD_SCHEDULE_MONTHSAlways
    TASKFLD_SCHEDULE_NOTIFYAlways
    TASKFLD_SCHEDULE_RECURRENCEAlways
    TASKFLD_SCHEDULE_TIMEAlways
    TASKFLD_SCHEDULE_WEEKDAYSAlways
    TASKFLD_START_TIMEIf defined
    TASKFLD_STATUSAlways
    TASKFLD_STATUS_INFORMATIONAlways
    TASKFLD_TASK_IDAlways
    TASKFLD_TASK_TYPEAlways
    TASKFLD_USER_IDAlways

    TASKCMD_DELETE

    Only the TASKFLD_TASK_ID attribute can be specified in the attributeSet input parameter of this command. This attribute is mandatory.

    This command returns no result attributes.

    TASKCMD_UPDATE

    The following attributes can be specified in the attributeSet input parameter of this command:

      Table: TASKCMD_UPDATE (Supported input attributes)
    Attribute nameOptionality
    TASKFLD_SCHEDULEOptional
    TASKFLD_SCHEDULE_DATEOptional
    TASKFLD_SCHEDULE_MONTHSOptional
    TASKFLD_SCHEDULE_MONTH_DAYOptional
    TASKFLD_SCHEDULE_NOTIFYOptional
    TASKFLD_SCHEDULE_RECURRENCEOptional
    TASKFLD_SCHEDULE_TIMEOptional
    TASKFLD_SCHEDULE_WEEKDAYSOptional
    TASKFLD_TASK_IDMandatory

    The following attributes will be specified in the results output parameter of this command:

      Table: TASKCMD_UPDATE (Supported output attributes)
    Attribute nameReturned
    TASKFLD_DESCRIPTIONAlways
    TASKFLD_DOMAIN_NAMEAlways
    TASKFLD_END_TIMEIf defined
    TASKFLD_FEATURESAlways
    TASKFLD_MODEAlways
    TASKFLD_PROGRESSIf defined
    TASKFLD_SCHEDULEAlways
    TASKFLD_SCHEDULE_TIMEAlways
    TASKFLD_SCHEDULE_DATEAlways
    TASKFLD_SCHEDULE_MONTHSAlways
    TASKFLD_SCHEDULE_MONTH_DAYAlways
    TASKFLD_SCHEDULE_NOTIFYAlways
    TASKFLD_SCHEDULE_RECURRENCEAlways
    TASKFLD_SCHEDULE_WEEKDAYSAlways
    TASKFLD_SERVER_IDAlways
    TASKFLD_START_TIMEIf defined
    TASKFLD_STATUSAlways
    TASKFLD_STATUS_INFORMTIONAlways
    TASKFLD_TASK_IDAlways
    TASKFLD_TASK_TYPEAlways
    TASKFLD_USER_IDAlways

    TASKCMD_CANCEL

    Only the TASKFLD_TASK_ID attribute can be specified in the attributeSet input parameter of this command. This attribute is mandatory.

    This command returns no result attributes.

    TASKCMD_RESUME

    This resumes a suspended server task.

    Only the TASKFLD_TASK_ID attribute can be specified in the attributeSet input parameter of this command. This attribute is mandatory.

    This command returns no result attributes.

    TASKCMD_SUSPEND

    This disables (suspends) a server task.

    Only the TASKFLD_TASK_ID attribute can be specified in the attributeSet input parameter of this command. This attribute is mandatory.

    This command returns no result attributes.

    Cet article vous a-t-il été utile ?
    What's Next
    Change password!
    Changing your password will log you out immediately. Use the new password to log back in.
    Change profile
    Success!
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    Logout
    ESC

    Ozzy, facilitant la découverte de connaissances grâce à l’intelligence conversationnelle