Button Element Properties

With the Button element, you can create a custom button in a form. The button can be configured to perform the functions below.

Back to Form Elements

Related topic: Element Properties

Button Description

Approve

Approves the form and moves it to the next step in the workflow.

Cancel

Cancels action taken on the form and returns without submitting the form.

Complete

Completes the form.

Reject

Rejects the form and moves it to the next step in the workflow.

Save

Saves the work performed on the form. This allows task assignees to save their work on a form and complete it at a later time. No action is taken with respect to the currently executing workflow.

Save and route

Saves and routes the form through the workflow.

Run embedded plug-in

Runs an embedded plug-in using thefield, operator,function, and/ornode(s) specified in Edit Arguments.

(See Arguments for more information about configuring Arguments, options, and related topics.)

Tip : Only plug-ins that do not run in background will respond immediately if they are used with the Embedded Plug-in button behavior (see below for a list). For this reason, we recommend using only those plug-ins that do not run in the background (such as Execute Powershell Script) with the Embedded Plug-in button behavior.

Example: Custom Send Email Plug-in

PluginName=Send Email,server=exchange.winshuttle.com,to=testuser1@example.com,from=workflowuser@example.com,subject=hi,body=hello

PluginName=Set SharePoint Column,site=http://example-server.domain.local/Formex,list=SetSharepointColumn1,column=sz,value=qwertyNew,query=Empid==2

PluginName=Create Folder,rootfolder=http://example-server.domain.locall/Formex/qwerty/,name=newflo

Delete

Deletes the current workflow item, i.e the current workflow process and its corresponding list item.

Custom

Use a custom rule to assign to the button nearly any function, which can be used to perform a wide range of tasks, such as running a Web service, and changing field data.

See Rules for more information about rules.

 

Name

Value Type

Description

Name

Text

The internal name for an element in the form.

Label

Text

The label of the control.

Column Span

Number (1-6)

The number of columns the element will span. Applies to Basic and Helper elements only. If a Group is configured to have more than one (1) column, the Column Span property on any element within the group will span the set number of columns.

Button Behavior

Cancel | Complete | Reject | Save | Save and Run | Run Embedded plug-in | Delete | Custom

Sets button behavior to a preset (Cancel, Save, etc.) or customized function.

Selecting Custom enables the Rules option so you can create a custom rule that will govern the button's behavior.

Rules

Special

Click to view (or create) any Rules (logic, formulas, etc.) applied to an element.

Class Names

Text

Space-separated CSS class names to be used to customize the look of the element.

Propagate Changes to all Views

True | False

When you change style or properties for common labels in a Composer form with multiple views, you will be prompted by a dialog box asking if you want to apply the changes to all views. Setting this option to True automatically propagates style or property changes to all applicable views.

The following plug-ins are not recommended for use with Embedded Plug-in button behavior because they run in background. This may create unwanted delays in processing for the person using the form.

Deferred Update Due Date

Copy Document

Copy Attachment

Deferred Copy Document

Copy Form

Form Process Launch

Update Item Permissions

Rename Process

Send Email

Set Column

Set Form Data

Wait for Child Process

Winshuttle AutoRun

Winshuttle Update