RECOMMENDATION: If you are using a version of The Portal Connector higher than 4.0, we strongly recommend utilizing the MVC based widgets and components to create your site. This documentation is for legacy purposes only and will soon be deprecated.
Widget Type:
Form Widgets
TPC Version:
  • 4.0
workflowlogovideologos
The CRM Workflow form widget allows you to execute any on-demand Microsoft Dynamics CRM workflows related to the chosen entity for the form. The workflow will work with the record that you are currently editing.

Configuration

Basic

Click and drag the Workflow widget from the Portal Connector widget list into the body of your form. Then, click on the edit button to display the properties prompt.  

The basic settings of the widget include a dropdown list which will be populated with all on-demand workflows related to the entity configured for the form.

You can also set the text of the workflow button as well as the execution stage of the workflow.
workflow-instructions1

Widget Properties

Basic Properties

Select a Workflow

The Select a Workflow drop down list will allow you to choose from a list of on-demand workflows to run from your form. Please note that workflows are filtered by entity.

Button Text

The Button Text property allows you to change the text that appears inside of a button associated with the widget.

Workflow Execute Stage

The Workflow Execute Stage property allows you to determine when an on-demand workflow will fire once you submit the form. Applicable choices include: Pre Submit and Post Submit.

Hidden

The Hidden checkbox will hide the widget from the page when checked.

Submit Form

The Submit Form checkbox will submit the form on the button click of the widget when checked.

Tool Tip

The Tool Tip allows you to add a description or Hint to your widget.

ToolTipPosition

This property determines the position of the tool tip. By default this property is set to "Auto". You can change this to Left , Right , Top , Bottom. 

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

Select a Workflow

The Select a Workflow drop down list will allow you to choose from a list of on-demand workflows to run from your form. Please note that workflows are filtered by entity.

Button Text

The Button Text property allows you to change the text that appears inside of a button associated with the widget.

Workflow Execute Stage

The Workflow Execute Stage property allows you to determine when an on-demand workflow will fire once you submit the form. Applicable choices include: Pre Submit and Post Submit.

Hidden

The Hidden checkbox will hide the widget from the page when checked.

Submit Form

The Submit Form checkbox will submit the form on the button click of the widget when checked.

Tool Tip

The Tool Tip allows you to add a description or Hint to your widget.

ToolTipPosition

This property determines the position of the tool tip. By default this property is set to "Auto". You can change this to Left , Right , Top , Bottom. 

API

get_model()

Returns the model object of the widget, which contains a number of useful properties. 

Returns

Object

get_value()

Returns the file name of a selected file.

Returns

String

toggle()

Toggles the visibility of the widget.

Returns

None

get_element()

Returns the element of the widget.

Returns

jQuery Object

set_value()

Sets the value of the widget.

Returns

None

hide()

Hides the widget from the form.

Returns

None

show()

Shows the widget on the form.

Returns

None

get_input()

Returns the input element of the widget.     

Returns

jQuery Object

get_type()

Returns the widget type.

Returns

String

get_container()

Returns the container element of the widget.

Returns

jQuery Object