DocsMarshal /ActivityLibrary /Tasks /UserTaskV5

This activity has been deprecated so it won’t receive any update any more. It's not visible in the workflow designer but workflows which are using it will continue to work fine. There is a new version of the activity named UserTaskV6. Use it to take advantage of the new features

UserTaskV5

Description

This activity allows to create a new DocsMarshal Task and to send it to a user, group or business role.

Since the parameters this activity accepts are many, they have been grouped into different categories and tabs in the designer in order to simplify their use. It is therefore strongly recommended to use the graphical interface instead of the side panel to set the various fields. The latter is divided into three areas: in the first it is possible to set the recipient user (directly or dynamically), the deadlines and notifications, in the second it is possible to set general information such as the name and description. In the last, instead, you can add elements to the task such as variables, outcomes and operations, through the use of other activities.

Below is a detailed description of each of the sections:

  1. Direct / Dynamic assign: here you can set the recipient of the task which can be a user / business role or a group directly or dynamically based on the tab you have selected. If the task is to be assigned to a single user, simply select it from the "Directly assign to a user" drop-down menu, if it is to be assigned to a group, "Keep in charge" must be enabled and then the group must be selectd from the combo box. Dynamic assignment works the same way. Dynamic assignment works the same way.
  2. Deadlines: it is possible to set all the deadlines of the task (both those to take charge of it and the date by which it must be completed). This section is divided into two sub-categories: in the first you set the time within which the task must be taken in charge (expressed in days, hours and minutes), while on the second page you can set the date by which the task will be closed.
  3. Notifications: in the section dedicated to notifications, you can tell DocsMarshal to send an email or a text message to the recipient of the task to notify them. This screen contains two sub-tabs for emails and text messages.
  4. General information: here you can set the name and description of the task or get, as a result, the id of the user who performed the task.
  5. Variables: in this area it is necessary to drag the activity TaskVariableV2 for as many times as there are variables to be inserted.
  6. Operations: in this area it is necessary to drag the activity TaskOperations for as many times as there are operations to be performed in the task. There are multiple activities to create task operations based on what you need to perform. Below is the list of supported operations grouped by the elements they work on (check out their documentation for more information).
  7. Outcome: use this area to add buttons to be used to close the task using the OutComeV2 activity for each outcome you want to insert.

Additional info

Notes InArgument<String>

The notes of the task.

External display page

CustomUrl InArgument<String>

The address of an external page used to show the task.

Look at the UserTaskV5 description for more informations.

ReturnUrl InArgument<String>

The address where to redirect users when they exit from the external page used to show the task.

Look at the UserTaskV5 description for more informations.

StaticSessionId InArgument<String>

The static session id used to authenticate in the external page.

Look at the UserTaskV5 description for more informations.

Info

DomainId InArgument<Int32?>

The id of domain where to assign the task.

LanguageId InArgument<Int32?>

The id of the language of the task.

TaskDescription InArgument<String>

The description of the task.

TaskExternalId InArgument<String>

The ExternalId of the task.

TaskName InArgument<String> REQUIRED

The display name of the task.

TaskPriority InArgument<Int32>

The priority indicates how important a task is and is used by DocsMarshal to show them to the user in order of priority. It can be assigned to any integer value (even negative) so be sure to assign it so that less important tasks do not prevail on the most important ones.

Layout - General

Layout ETaskLayout

The layout that should be used when displaying the task

ShowSaveAndClose InArgument<Boolean>

If this is set to False, then the "Save and Close" button is hidden

VisibleSections ETaskSection

The sections of the task that should be visible

Layout - Sections priority

NotesPriority InArgument<Int32>

The priority of the variables section. Sections with a higher priority appear first. The default value is 1.

OperationsPriority InArgument<Int32>

The priority of the variables section. Sections with a higher priority appear first. The default value is 3.

SearchPriority InArgument<Int32>

The priority of the variables section. Sections with a higher priority appear first. The default value is 2.

VariablesPriority InArgument<Int32>

The priority of the variables section. Sections with a higher priority appear first. The default value is 4.

Notifications - Email

ExternalIdMailAccount InArgument<String>

The external id of the mail account to use to send the emails.

MailBcc InArgument<String>

The address that should receive the email as blind carbon copy.

MailBody InArgument<String>

The body of the email to be sent.

MailCc InArgument<String>

The address that should receive the email as carbon copy.

MailFrom InArgument<String>

The address from which to send the email.

MailSubject InArgument<String>

The subject of the email to be sent.

MailTo InArgument<String>

The address that should receive the email.

SendEmail Boolean

Set as true to send a notification email when the task is taken in charge. In this case EmailTo argument must be set.

SendEmailToAllUserOfTask Boolean

If set as true DocsMarshal will notify all users involved in the activity using an email. In this case it is not necessary to specify the fields MailTo, MailCc and MailBcc as the activity takes them from the users configuration and sends a single email with many recipients.

Notifications - Sms

SendSms Boolean

Set as true to send a notification sms when the task is taken in charge. Sms contacts parameters (SmsNumber, SmsSender ecc..) must be set.

SendSmsToAllUserOfTask Boolean

If set as true DocsMarshal will notify all users involved in the task using an email. In this case it is not necessary to specify the fields SmsNumber since the activity takes it from the users configuration.

SmsNumber InArgument<String>

The phone number of the recipients.

SmsPassword InArgument<String>

The password of the sms service authentication.

SmsSender InArgument<String>

The phone number from which to send the message.

SmsText InArgument<String>

The text of the sms message to send.

SmsUserId InArgument<String>

The id of the user of the sms service authentication.

Performing info

Outcome OutArgument<String>

The Value of the the outcome that was used to complete the task.

PerformerUserId OutArgument<Int32>

The ID of the user which performed the task. It is especially useful if the task has been taken in charge by a group.

Search details

HideTaskToSecurityIdentities InArgument<List<Int32>>

Enter here the list of users, groups business roles code that you want to hide the task from

Tags InArgument<List<String>>

A list of tags used to improve the search options.

Take in charge - Expiration

TakeInChargeExpirationDays InArgument<Int32>

The maximum number of days a user can take to take in charge the task.

TakeInChargeExpirationHours InArgument<Int32>

The maximum number of hours a user can take to take in charge the task.

TakeInChargeExpirationMinutes InArgument<Int32>

The maximum number of minutes a user can take to take in charge the task.

Take in charge - Settings

DynKeepInChargeSecurityIdentityId InArgument<Int32?>

The ID of the group which have to take in charge the task. KeepInCharge or DynKeepInCharge must be TRUE. Use this argument if the value you want to assign is stored in a variable.

KeepInChargeSecurityIdentityId Int32?

The ID of the group which have to take in charge the task. KeepInCharge or DynKeepInCharge must be TRUE. Use this argument if the value you want to assign is static.

Take in charge - User

DynTaskSecurityIdentityId InArgument<Int32?>

The ID of the user or the business role which have to take in charge the task. KeepInCharge or DynKeepInCharge must be FALSE. Use this argument if the value you want to assign is stored in a variable.

TaskSecurityIdentityId Int32?

The ID of the user or the business role which have to take in charge the task. KeepInCharge or DynKeepInCharge must be FALSE. Use this argument if the value you want to assign is static.

Take in charge - User Groups

DynKeepInCharge InArgument<Boolean?>

Set this argument as true if the Task have to be taken in charge by a user group. Use this argument if the value you want to assign is stored in a variable.

KeepInCharge Boolean

Set this argument as true if the Task have to be taken in charge by a user group. Use this argument if the value you want to assign is static.

Task - Expiration

DeadLine InArgument<DateTime?>

The date of the deadline to complete the task.