Form tab

Use the Form tab to select a form for recipients to use to action the task.

Example of a configured Form tab

See How To: Create Embedded Signatures with DocuSign for an example of using a Basic Task Form in a workflow.

  1. Select the Task step and click the Form tab.

    2. The following table explains the options available on this tab:

    Option Explanation How to Use
    Form Type

    Use this to specify the form used to complete the task. Select one of the following options:

    • Basic Task form
    • SmartForm
    • Custom
    • (No Form)

    By default, Basic Task Form is selected. You can not edit the Basic Task Form but you can use it to interact with in your workflow.

    Click the Form Type menu and select an option.

    Select Custom to enable the URL field. Enter the URL of the form into the field.

    Form

    The Form option is available when you select the SmartForm Type. Use this to select the form the recipient needs to complete.

    Browse to the form or select from the recently used forms in the menu.

    Click Form and select a form.

    Click Browse to navigate to the form or select one from the recently used forms.
    Parameters

    Parameters of the form allow you to specify the task serial number and other information that you've designed the form to handle. Be sure to match the data type of the parameter.

    Parameter information is sent to the form as it loads and can be used by rules and controls on the form. The standard form parameters include the following parameters, and if your form has other parameters, you will see them in the SmartForm Parameter Mapper once you select the form:

    • Serial Number - By default, this parameter populates with the Task Serial Number.
    • Content Title - drag Functions, Fields, SmartObjects and Workflow related items from the Context Browser into this field.
    • Content URL - drag Functions, Fields, SmartObjects and Workflow related items from the Context Browser into this field.
    • Embedded Content on the Form - drag Functions, Fields, SmartObjects and Workflow related items from the Context Browser into this field.
    • _state - This parameter loads the form with an existing state.

    Serial Numbers are always bound to a task for a workflow. A Serial number is formatted as follows - "123_456" where the "123" is the workflow instance ID and the "456" is the activity ID. If a workflow has multiple task steps, you could have multiple activity destination IDs, all starting with the same workflow instance ID, e.g. "123_..."

    When you integrate a workflow with a custom form, a new state can be added. The Basic Task Form only has one state, so it is not necessary to specify one.  When you configure a Task with a form, you can change the value you see in the _state parameter field.

    Note: Different parameters show depending on the form you select.

    Type or click and drag items into the parameter field.
  2. Select the type from the Form Type menu.
  3. For detailed information on each of the available Form Types, see the links below:
    1. From the Form Type menu, select the Basic Task Form option. This option is selected by default.
    2. The Parameters section contains parameters that exists on the Basic Task Form.

      3. The following table explains the options available on this tab:

      OptionExplanationHow to Use
      Serial NumberThe Serial Number populates automatically and indicates the specific workflow instance.Automatically populated.
      Parameters

      Parameters of the form allow you to specify workflow instance information or other information that the form is designed to handle. Be sure to match the data type of the parameter.

      The following parameters are available:

      • Serial Number - By default, this parameter populates with the Task Serial Number
      • Content Title - Use this to specify a title within the content area of the task form
      • Content URL - Use this to add a URL to display in the content area of the task form
      • Embedded Content on the Form - Use this to specify if content can display in the task form by adding a True or False value

      Note: Parameters are not required. Different parameters show depending on the form type you select.

      Type or click and drag Functions, Fields, SmartObjects and Workflow related items from the Context Browser into this field.

    3. In this example, the parameters are configured as follows:
    4. In this example, add an instruction to the task on the Task tab.
    5. At runtime, the task is sent to a user and shows on their task list in K2 Workspace (Desktop). Notice the added Instruction, Content Title, and URL on the Basic Task Form.
    6. Click the Comments tab. This tab forms part of the Basic Task Form. Add a comment and click the Add Comment button. An audit trail is kept of these comments.
    7. Click the Attachments tab. This tab forms part of the Basic Task Form. Click the Click here to attach a file link to select the file and click Add Attachment to add it. An audit trail is kept of these attachments.
    8. To view the attachment, click on the file link.
    9. On the Task tab of the Basic Task Form select an Action and click the Submit button.

    10. Your changes are automatically saved.

    1. From the Form Type menu, select the SmartForm option.
    2. From the Form menu select Browse and navigate to the location of the form.
    3. Select the form and click OK.

      4. For more information about the different browse states and errors, see the Browse States topic.

      For more information on how to use the breadcrumb bar, see the How to use the Breadcrumb topic.

    4. The Open Task on a Form page displays the References as follows:

      5. This page inspects the form to determine the data sources. Use this to populate references within the workflow. Any view data source to item reference matches are grouped together.

      If no matching data sources are found, any unmatched View Data Sources are set to Create Item Reference. If matching data sources are found, any unmatched View Data Sources are set to Do Not Create Item Reference.

    5. In this example, four data sources were found on the form. Click the deselect icon to deselect and not create item references.
    6. Click Next. The Open Task on a Form page opens.

      7. In this example, an Open Worklist Item rule action was not found. The table below explains the available Open Worklist Item options:

      OptionExplanation
      Do it for me

      The K2 Workflow Designer configures the Open Worklist Item rule action for you. This is the default option.

      Help me configure it

      The K2 Workflow Designer adds additional steps to assist you in configuring the Open Worklist Item rule action.

      I will do it myself later

      You will configure the Open Worklist Item rule action at a later time.

    7. In this example, select Help me configure it and click Next.
    8. From the Workflow View section, configure the Form State to contain the Open Worklist Item rule action.

      9. If an existing rule action is found, the page shows the current setting of the rule action. If no existing rule action is found, the default settings are as follows:

      • Use the workflow view
      • Allocate the task
      • Create a new State (Workflow Task)

      The following table explains the available options:

      OptionExplanationHow to Use
      Create a new State

      Form states are typically used when different tasks (client events) in a workflow use the same form for different events. Each form state has its own fules but all states inherit the base state rules.

      Select this option to create a new state. You will typically use this option if the form is also used as a task form.

      The Create a new State option is the default, with a state name of Workflow Task.

      Select the option.

      Type a name for the new state.

      Use an existing State

      Select this option if an existing state is available.

      Select the radio button.

      Select the state from the menu.

      Click the Refresh link to refresh list of available states.

      What are states and how are they used? A state is a specific format and set of behaviors applied to a form, generally through rules. A form can have multiple states, with each state rendering the same form but with different configurations. Example: A form may have a state called Read-Only and for that state the form controls are disabled and the submit button hidden. The same form may have another state called User Input where the form controls are active and the submit button is displayed. Generally speaking, a new state is created for each task because you potentially have different requirements depending on various tasks that use the same form. The User Input state has all of the form controls active, but perhaps in a Manager Approval state only the Comments control is active. The two most common methods for creating states are from the form's rules page when editing the form and from Task / Form settings configuration discussed here.

      See the following resources for more information:
    9. In this example, select the Create a new State option and click Next. To see the options for the Workflow View, scroll down the page. You can choose where to show it on your form and if the task must be allocated to the user when opened.
    10. The Open Task on a Form - Open Task Rule Action page enables you to select the rule and the location within the rule to define actions to open the task.

      11. The table below explains the available options:

      OptionExplanationHow to Use
      Form Rules

      Default rules are added to identify which rule should start the workflow.

      Select a rule to execute the workflow from the menu.

      Click the Refresh link to refresh available form start rules.

      Actions

      Rule action execution can be customized within the workflow.

      Click and drag the open task rule action to the desired location within the rule.

    11. Click the menu to view available start rules. In the Actions section you can click and drag the actions to reorder them.
    12. Click Next. The Open Task on a Form - After Submit Action page displays. Here you decide what happens on the form after the task is submitted.

      13. The table below explains the available options:

      OptionExplanationHow to Use
      Show a Message

      Select this to show a message after the task is submitted.

      Select the radio button.

      Type the message into the text box area.

      Call a Rule

      Select this to call another rule after the task is submitted.

      Select the radio button.

      Select rule from the menu.

      Navigate toSelect this to navigate to a SmartForm.
      When using this option, keep in mind that the system uses the form’s URL in the current environment. When you use the Package and Deployment tool to migrate applications between environments, this URL is no longer valid in the new environment and must be updated. If you’re planning to migrate the solution to another environment, we recommend using the Navigate to a URL rule action instead to navigate to a SmartForm. See Package and Deployment Considerations for steps to configure the rule.

      Select the radio button.

      Select the SmartForm from the menu, or click to Browse to a form.
    13. In this example, select the Show a Message option. Click Next.
    14. The Almost Done... page is shown. Click Save and Finish.
    15. Changes are made, and then the Success page displays. Click OK.
    16. Notice the State parameter is populated with the default state.
    17. If you need to edit the form, click the Configure... button to run through the form wizard again. Click the Edit Form link to open the form for editing.

    18. Your changes are automatically saved.

    1. From the Form Type menu, select the Custom option.
    2. Type a URL into the field. Use the URL of the custom form. You can drag a reference from the Context Browser into this field if you need to use dynamic values in the URL.
    3. Use Add to add parameters.

      By default, the Task SerialNo field is automatically added for the Serial Number parameter. This serial number uniquely identifies the user task and s

      serial numbers are always bound to a task in a workflow instance. Serial numbers are formatted as follows - "123_456" where the "123" is the workflow instance ID and the "456" is the activity ID. If a workflow has multiple task steps, you could have multiple activity destination IDs, all starting with the same workflow instance ID, such as "123_..."

    4. Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields.

      5. At runtime the form URL looks similar to the following: https://k2/denallix.com/Runtime/Runtime/Form/Sales+Orders+Form/?SerialNo=14_17&_CustomerId=123

      For more information on how to use Smartfields, see the Smartfields topic.

    5. Your changes are automatically saved.

    4.
    1. From the Form Type menu, select the (No Form) option.
    2. Using this option allows you to make a formless task, which is sometimes helpful when people will always action their tasks using the worklist or SmartActions.

    3. Your changes are automatically saved.

  4. Your changes are automatically saved.