HomeUsing LincDoc 3.1+ActionsList of Available Actions

11.3. List of Available Actions

The following actions are available in the application.
 
Action Description Available

add multi-value row

Add a row to any multi-value table that is part of the currently running eForm (or Document Package).

 Field, Form

append uploaded file to document

Uploads a file, which, at generation time, is appended to the end of the normal, generated document. There are limitations based on the type of file being uploaded, as well as the type of file being generated. These limitations can be seen when you set a form's Field type setting to upload, and include not only the type of file but also the maximum size of the file.

Form

checkboxes to multivalue field

Controls the displayed forms, when your form is actually comprised of many small forms, and different combinations of these forms need to be easily accessible.

This action is for specialized use cases. For more information, contact Technical Support.
Field, Form

clear hidden fields

Sets all field values where the field is not displayed to null.

Form

clear multi-value table

Clear all values from a specific multi-value table.

Field, Form 

clear signatures

After a signature is completed, certain fields may be automatically locked. This action allows you to unlock these fields, if necessary, by removing the signatures internally.

Field, Form 

close

Closes the form, typically without saving the data. i.e., a cancel button.

For more information, see Close

Field, Form

edit/view/sign a document

Edit, view, or sign an eForm or Document Package that has been launched using the Run a Doc Package or eForm action.

Field, Form 

email

Emails recipients with a dynamic message and possible document attachments.

For more information, see Email.

Field, Form

execute stored procedure

Executes a database stored procedure. This stored procedure is passed as a single argument - an XML string that contains a snapshot of all the data in the current form. The stored procedure can optionally return a single result, which may be stored in one of the current form's fields.

Field, Form

export to Windows share

Saves a copy of the generated document to the configured share.  See File share for more information.

Form

flatten signatures

Takes all signature fields whose mode is set to "image" and places the signatures inside of the corresponding PDF.

Note: This action only applies to specific situations and is rarely needed. For more information, contact Technical Support.

Form

force regeneration

Clears (forcibly) any previously generated documents that exist in the current DocumentContext object. This object is present when a form is running. It holds, among other things, a snapshot of all fields and their current values, and may contain other items (such as the generated document or a user-uploaded document).

Note: This action only applies to specific situations and is rarely needed. For more information, contact Technical Support..

Field, Form

logout

Force a log out of the LincDoc application.

Form 

lookup

Merge data option from a search of an external data source.

For more information, see Database Lookups.

Field, Form

multi-value loop

Execute a multi-value group's child actions for each row in a multi-value table.

Form 

register a user

Register new users into the LincDoc system.

Field, Form 

run a doc package or eForm

Opens the configured eForm or document package for data entry.

Field, Form

run script

  Field, Form 

save

Saves the inputted data to the LincDoc database.

Field, Form

set confirm close message

Sets the message to be displayed when closing the eForm.

Form

set document owner

Updates the document owner attribute to a text value, the current user, or the one of the form's field values.

Form

set field value

Sets the specified field to a text value, one of the form's field values, or the result of a function.

Form, Field

show HTML

Opens a browser window with the configured HTML.

For more information, see Show HTML.

Form

show a message

Opens a message box with a configured message to the user.

Field, Form

show messages now

   

show signature receipt

  Field, Form

validate

Executes the validation checks.

Field, Form

view document

Opens the generated document in the file viewer (for PDF or TIFF output) or downloads the document for .DOC or .ODT output.

Form

This page was: Helpful | Not Helpful