View source for Workflow start Portlet

[[Category:Portlets]]
[[Category:Portal builders]]
{{FeatureInfo
|editions=wcm,ecm,comm
|fromversion=6.0
|wikicomplete=100%
|interest=builder
|enduserlink=
|builderlink=
|developerlink=
|sysoplink=
}}
 
{{SNTOC}}

=Overview=
{{LeadImage|Workflows-registration.png|Start registration}} '''Workflow start''' [[Portlet]] is designed for portal builders who want to display a page where users can start a [[Workflow]]. The portlet is a special kind of [[Creator Portlet|content creator portlet]] that starts a workflow. Portal builders should provide a few information about workflows for this portlet to work:
*Content Type name of the workflow to start
*Where to put the started workflows
*Confirmation content if needed
{{clear}}

=Details=
The '''Workflow start Portlet''' is a [[Portlet#Context bound portlets|Context bound portlet]] meaning that it is able to start workflows anywhere in the system. You have to bind the portlet to a container where you want the started workflow instances to be created. In case of [[Registration workflow sample|public registration]] the portlet is placed onto a page and the registration workflows will be created under the page into a system folder called ''Workflows''.

==Content View for the portlet==
The displayed content view is automatically selected based on the given workflow type. The portlet displays the content view called '''StartWorkflow.ascx''' for that type - in case of RegistrationWorkflow, the following view will be displayed:
* ''/Root/Global/contentviews/RegistrationWorkflow/StartWorkflow.ascx''

If you provided a custom content view using the '''ContentViewPath''' property, than it will be loaded instead of the start workflow view. About creating content views for workflows see [[How to create initial and start views for a workflow|this page]].

=Properties=
Below you can see the editable properties of this portlet: 

== Own properties ==

=== Workflow ===
{|class="sn-table" width="90%"
! width="20%" | Property
! width="20%" | Property name for embedding
! width="15%" | Possible values
! width="45%" | Description
|-
| Workflow type
| WorkflowType
| one of the available workflow type names
| If you leave this entry empty, the portlet will behave like a simple add content portlet
|-
| Start the workflow on the current content
| StartOnCurrentContent
| true/false
| If set the workflow will start on the current content. Use this option when you are building a smart application page.
|-
| Workflow container path
| WorkflowContainerPath
| Repository path
| Container folder for the started workflow instances. If you leave this entry empty, the system will place the workflow content under the current content.
|-
| Workflow template path
| WorkflowTemplatePath
| Repository path
| Template workflow content that contains all the initial data. If the workflow does not need any initial data you can leave this entry empty.
|}

=== User interface ===
{|class="sn-table" width="90%"
! width="20%" | Property
! width="20%" | Property name for embedding
! width="15%" | Possible values
! width="45%" | Description
|-
|Confirmation content path
|ConfirmContentPath
|path of the confirmation content
|Define a content that will be displayed to the user after the workflow is started
|}

==Inherited properties ==

=== User interface ===
{|class="sn-table"  width="90%"
! width="20%" | Property
! width="20%" | Property name for embedding
! width="15%" | Possible values
! width="45%" | Description
|-
| Contentview path
| ContentViewPath
| Repository path
| Path of the contentview which renders the selected content. Leave it empty for automatic resolution by type
|-
| Portlet title
| Title
| text
| Sets the visible title of the current portlet. Title header visibility is controlled with Appearance property
|-
| Appearance 
| ChromeType
| Default<br />None<br />TitleAndBorder<br />TitleOnly<br />BorderOnly
| Controls title and border visibility. By default both are visible
|-
| Portlet skin css prefix
| SkinPreFix
| text
| When set portlet container div gets an extra css class. Ie. 'skinexample' adds css class 'skinexampleSkin' to container div
|}

=== Context binding ===
{|class="sn-table"  width="90%"
! width="20%" | Property
! width="20%" | Property name for embedding
! width="15%" | Possible values
! width="45%" | Description
|-
| Bind Target
| BindTarget
| Unselected<br />CurrentContent<br />CurrentSite<br />CurrentPage<br />CurrentUser<br />CurrentStartPage<br />CustomRoot<br />CurrentWorkspace
| Select the bound content. Set it to CustomRoot to select a content with absolute path regardless of the context
|-
| Custom root path
| CustomRootPath
| Root relative Repository path
| Define bound content with absolute path when Bind Target is set to CustomRoot
|-
| Ancestor selector index
| AncestorIndex
| positive whole number
| Set the bound content to the ancestor of Bind Target specified by index. 0 leaves the bound content as specified above, 1 selects parent, higher value selects higher order ancestor
|-
| Relative content selector path
| RelativeContentPath
| relative Repository path
| Sets the bound content relative to the above settings with a relative path. Ie.: 'CustomChildFolder/CustomNode' selects 'CustomNode' from Bind Target's 'CustomChildFolder' child folder. Relative to ancestor when Ancestor selector index is set
|}

=== New content ===
{|class="sn-table" width="90%"
! width="20%" | Property
! width="20%" | Property name for embedding
! width="15%" | Possible values
! width="45%" | Description
|-
| Create relative path if not exist
| CreateRelativePath
| true/false
| If the given relative subpath (defined with context binding) does not exist the portlet creates the structure
|-
| Relative container type name
| RelativeContentTypeName
| text
| If you selected the 'Create relative path' option, this content type will be used to create the containers. Default is Folder.
|}

=User group information=

== for Portal builders ==
If you want to embed your Workflow start portlet into your [[PageTemplate]]s somewhere, look at the following markup. The attributes/options and the range of their accepted values are the same as above.(Don't forget to include a unique ID and runat="server" attributes!)

<source lang="asp">
<snpe:StartWorkflowPortlet 
   Title="Some Portlet Title" 
   BindTarget="CurrentContent"
   RelativeContentPath="Workflows"
   CreateRelativePath="True"
   RelativeContentTypeName="SystemFolder"
   WorkflowType = "RegistrationWorkflow"
   ConfirmContentPath="/Root/Sites/MySite/Confirm/ConfirmText"
   ID="WfStartPortlet" 
   runat="server"
/>
</source>

=Example/Tutorials=
*[[How to start a standalone workflow]]
*[[How to create initial and start views for a workflow]]

=Related links=
*[[:Category:Portlets | Sense/Net Porlets ]]
*[[Workflow]]

=References=