Home → Using LincDoc 3.0 → Printer Friendly Version
LincDoc is a comprehensive software tool which broadly covers these tasks:
This book will go over the details of using LincDoc from the perspective of an administrator responsible for setting up the system for use by the general user community at any given organization. More specifically, it will cover:
There are many new features in LincDoc 3.0 that greatly improve the entire LincDoc experience. At the highest level the new features can be broken down into two main areas, usability and administration. In the usability camp, LincDoc 3.0 introduces LincDoc Mobile offline. This offers enhanced usability by allowing users to complete, sign, and synchronize forms in an offline mode. No longer do you need a 3/4G (or WiFi) connection to harness the power to LincDoc. This re-architecture will enable LincDoc to be quickly customized to meet the changing demands of our customers.
Build all your forms online as usual, but then enable mobile usage. This unlocks the power of LincDoc's new framework. Next, download and install the Offline iPad app and you're ready to go. Point your app to your LincDoc server and the app will take care of the rest. The app will download all mobile forms and instantly convert them to a native iPad application. Once downloaded, you can now disconnect from your network and start processing forms.
This is great for any mobile worker that needs to do any data gathering in the field. From generating sales quotes or contracts that can be signed on the spot, to healthcare workers dealing with patients in their homes. LincDoc Mobile provides the same user guided interface and signing capability, without requiring a network connection. Once the user gets back to the office they can easily synchronize the generated documents to the LincDoc server for further processing.
When we saw the first prototypes of this feature we all said ... "Dang, that's really cool!". DANG is a computer language interpreter that allows you to build a condition for your form that is evaluated by LincDoc, and then based on the result executes a particular action. This replaces the need for any custom scripting as required in earlier LincDoc releases. DANG is controlled by a sophisticated user interface that walks you through the details, and prevents "shoot yourself in the foot" situations that can easily arise in traditional scripting methods.
Need an easy way to do an email workflow for approval of a form? Enter LincDoc Actions. Actions are steps executed based on a certain condition of a field (or fields) or form being true. The conditions are configured within DANG and executed at certain times of form processing.
It is now trivial to add custom buttons to any form; each button is completely configurable to perform any set of actions desired. So for example, the "submit" button can send an email, save the document to the database, display an alert message, or whatever other actions you want.
LincDoc now allows you to setup multiple repositories that documents and data are written to, and pulled from when using LincDoc's search capability.
LincDoc now has a more robust user and group administration interface, even more tightly integrated with Microsoft Active Directory when using the AD Integration module.
Create your fields one time and reuse them across all your similar forms. Using the new Global Fields Interface allows an administrator to create a field (or field name pattern) with all attributes related to that field. When importing a new PDF or Word document into LincDoc, LincDoc will compare the field names in the document with the global fields and then apply all attributes to those fields. The result is much faster and more accurate forms setup.
We've created a tool we call the "Magic Button": it is a custom button that installs into the Laserfiche toolbar. By simply selecting any LincDoc-generated document in Laserfiche, the button creates a flyout menu for the user to quickly edit or sign that document. 3.0. The HTML/XHTML file concept is now eliminated, replaced by HTML hyperlinks. Finally, the system offers significantly better error/exception handling to help quickly identify common issues (e.g., show a particular template field that is not long enough to hold the data being written to it from LincDoc).
The process of setting up codelists, including dynamic codelists that depend on other codelists, has been streamlined. There is now a "basic" interface for simpler codelists, and "advanced" where you can have full control of codes, labels, sort order, and descriptions.
Earlier releases of LincDoc required that administrators use a third party tool called TortoiseSVN. This is a robust and comprehensive tool, however LincDoc uses a fraction of its capabilities. The burden of learning this tool was deemed to be outside the scope of the LincDoc experience, so the core functionality has been directly integrated into LincDoc itself.
This is a list of the most common terms used throughout this documentation:
action |
Actions are units of work that are fired in response to form events. For example, sending an email containing a hyperlink to a document or displaying an alert message. |
alert |
A message box that is displayed to the end user during the data entry process. |
boolean logic |
A rule based on true or false, yes or no or the presence of one of two clearly opposed values. |
calculated field |
A field that is calculated by, or from a value(s) of another field. |
click wrap signature |
A type of signature whereby a user enters in their name and it is inserted into the generated document. |
client ID |
A container within LincDoc that stores all field definitions, source documents, generated documents and data. |
codelist (code list) |
Codelists are objects within LincDoc that drive drop down choice lists, e.g., a form question that has a yes/no answer. There are multiple types of codelists available, including simple, advanced, and JDBC. |
condition |
Conditions are boolean expressions that are evaluated throughout the lifecycle of an eForm in response to form events. When the conditions are true, then certain actions are allowed to happen based on the configuration of the eForm. |
condition to display (sometimes abbreviated as c2d) |
Logic used to conditionally display or hide a field or section |
conditional text/paragraph |
Refers to a snippet of text inside a Microsoft Word (or OpenOffice) source document that is conditionally shown in a generated document. The condition of the text is evaluated at document generation time, if the condition is true then the text is included else it is not included. |
CSV |
Comma Separated Values a type of text output where each field's value is separated by a comma. Values that may contain commas may be surrounded by double quote characters. For example: "Jane","Smith","123 Main Street","Southtown","IL","65099" |
DANG |
Data And Number Generator a key component of the LincDoc administrator UI used to create conditions, actions, and calculations |
data entry |
The term used to describe the process of an end user filling out the form fields of a particular eForm or document package. |
DDL |
Acronym for drop down list. |
document inclusion logic |
Boolean logic rule that selects a document based on the existence of a specific field or fields. |
document package |
Extends what an eForm can do by allowing one or many related Word or PDF source documents to be assembled based on predefined business logic. Enterprise Edition only. |
document repository |
A searchable storage area where documents and data are saved. LincDoc has its own internal document repository, and third party repositories such as Laserfiche are also supported. |
document viewer |
The window that the generated document is displayed in. |
DRAT |
Document Refinement Annotation Transformer. An extension of the LincDoc markup language for more sophisticated field resolution scenarios. |
drop down list (DDL) |
A form control that when clicked on presents a list of choices from which the user must choose one. |
eForm |
An electronic web form composed of a single Microsoft Word or PDF document. The document contains zero or more field placeholders. An eForm is also comprised of field details, sections, conditions, actions, events, and lookups. |
end user |
Any person who uses LincDoc to complete a preconfigured eForm or document package. |
event |
Events help describe significant points in time during the lifecycle of an eForm or document package. Examples of events include "on load" which fires when an eForm is first executed, or "on generate" which fires when the end user has completed the data entry process and is ready to generate their document. |
field |
A placeholder inside a source document for the purpose of filling with data either manually or from a database. |
fields document |
A source document used for the sole intention of field placeholders only, it is never meant to be part of a generated document. This technique is often used with more complex document packages which have many source documents: the fields document consolidates LincDoc fields to a single entity. |
flattening |
The processes of removing the ability to change field values in a PDF form |
function |
A system calculation that returns a single value given zero or more inputs. |
global field |
Field definitions that can be applied to any field of the same name or pattern when creating a new eForm. |
inclusion logic |
The use of Boolean logic to determine if a paragraph or document should be included when generating a new document. |
input constraint |
A simple input mask or regular expression that can be applied to a field to enforce what data is allowed for a field. |
JDBC |
Acronym for Java Database Connectivity. |
LDAP signature |
A type of signature in LincDoc whereby the user "signs" the document by being prompted to re-enter their LDAP password at the time of signing. Often used in combination with the Active Directory integration module. |
LDAR |
An acronym that stands for "LincDoc Archive". An eForm definition can be exported as a .ldar file, then imported to another LincDoc VM. |
LincDoc administrator |
The person responsible for creating eForms and corresponding field elements, conditions, lookups, actions, etc. within the LincDoc system for the end user community. |
LincDoc markup language |
The term used for "<<...>>" and "<<<...>>>" expressions inside Microsoft Word documents that respectively identify fields and conditional paragraphs. |
lookup |
A query that searches for data in an external system. |
LWSA |
LincWare System Administration Portal. Portal for all server level configuration options. |
multi-phase signatures |
The term is used to describe a document that contains multiple signature fields, and those signatures are not all signed in the same browser session: the signatures happen in different phases. |
multivalue (or multirow or pound) field |
This is the terms used to refer to the concept of fields that take on multiple values. For example, an eForm that captures a list of part numbers. These are sometimes called "pound fields" because in the LincDoc markup language they always are terminated by a pound sign. |
OpenForm |
The term used to describe when an eForm is launched in a separate browser window (or iframe), and none of the normal LincDoc desktop controls are present (e.g., no top toolbar with buttons for search, run, help, logout, etc.). This is the preferred way to run eForms for end users because it is very directed in the sense that all they can do is complete the form in front of them. |
paragraph inclusion logic |
A condition that shows or hides a paragraph in a generated document. Only applies to Word source documents. Enterprise Edition only. |
parse/reparse |
The process of resolving/finding fields in a document. A reparse operation typically takes place whenever a source document is altered. |
|
Acronym for "portable document format". |
pound field |
Synonym for multivalue field. |
required condition |
This refers to a condition attached to a particular field that determines if the field must be non-blank before proceeding. Just before document generation time the condition is evaluated. If it is true and the corresponding field is blank then processing stops the user is shown a warning message that they must fill in the field before proceeding. |
section |
The term for a container/area within an eForm that contains one or more related fields. |
source document |
A Microsoft Word or PDF document containing zero or more fields. In the case of Word, the LincDoc markup language is used to denote fields. For PDF, FDF fields are used. Adobe Lifecycle forms are also supported. |
source document library (templates) |
The library of documents available to users in LincDoc. |
subject matter expert |
When designing a new eForm, this is the person who has the knowledge and expertise to provide guidance on the finer details of the form. This person also has a thorough understanding of the business processes and high level workflow logic that often accompany an eForm. |
synchronization/sync/on sync |
An event indicating that a mobile device (e.g. iPad) is pushing locally saved forms/data to a LincDoc server. |
TIFF |
Acronym for "tagged image file format". |
token based name |
The term used to describe the process of substituting tokens for form field values, especially in the case of naming a generated document. For example, the admin can create a token based name in which one of the tokens is the "lastName" field collected from an eForm, plus other tokens for the current date, followed by the file type ".pdf". |
Topaz signature |
A type of signature using one of the supported devices offered by Topaz. |
TortoiseSVN |
An optional third-party plugin for MS Windows Explorer that allows administrators to check-in and check-out documents and eForms. |
UI |
Acronym for "user interface". |
use case |
This term refers to describing a situation that highlights a particular set of features and/or requirements of an eForm. For example, a form that requires several signatures from the same signee is a good "use case" for LincDoc's bulk signing feature. |
user |
Shorthand for "end user". |
user profile |
Stores Name, email address, password, and password reset question |
LincDoc is a comprehensive software system that provides the following core functions:
There are 3 product offerings: Freeform, SE, and EE. Please see http://www.lincware.com for details, and case studies.
LincDoc EE is our premier product offering for eForms and content assembly. Please refer to our website for details.
Please refer to our website for details.
FreeForm is our fast and light cloud eForms solution. Please refer to our website for details.
The LincDoc User Interface (UI) has eight components. In unison, they enable the quick, accurate creation of electronic documents and eForms and access to simple management features.
1. eForm/Document Package DDL
The primary option in the UI is the eForm and Document Package drop down list (DDL) box which contains the unique identifier and full description of each eForm or Document Package accessible by the user. Upon selection, the user can run (start), edit or delete an eForm or document package. A user can also search for documents generated from the selected eForm or Document Package definition.
2. Run
Once an eForm or Document Package has been selected, choosing run will begin data entry. If needed, a user can open multiple data-entry windows at one time.
3. Search
Search allows the user to retrieve previously saved documents or eForms. After selecting a specific eForm or document package, selecting search will list all relevant content to which the specific user has access. The user may select from previously saved search parameters or create new criteria. The search screen is configured by adding parameters under the Search tab in the Admin interface. See the Search chapter for more information.
4. Admin
The admin option allows for the creation, modification and deletion of eForms and Document Packages. The admin option also gives the ability to import or export eForms and Document Packages. Administration is further explained in eDoc Administration.
5. User Profile
The user interface is also defined by individual user profile parameters, which can be established according to the user's role within the organization's LincDoc community. To access the profile settings:
Profile setting | Function |
Username | Stores the user's identity for use in logging into LincDoc (cannot be changed) |
Full name | Saves a user's actual full name (cannot be changed) |
Email address | Captures a user's email address |
Change/reset password | Creates new or alters current password |
Password reset question | Serves as a security feature to verify authenticity of user |
Password reset question answer | Provides answer to password reset question |
Re-enter password reset question answer | Redundancy feature for additional verification of password reset question |
The System option provides a method for maintaining individual and group access to documents and monitoring LincDoc connectors. For administrators, the ability to maintain the LincDoc appliance is provided through this option. The current LincDoc version information can also be found here.
7. Help
The Help option provides a method for getting help about the UI, viewing the documentation for LincDoc, or opening a support ticket with the development staff.
8. Windows
The windows option provides the user to select from the list of currently opened windows and optionally tile the open windows on the workspace.
9. Logout
Closes the current LincDoc session.
LincDoc is a fully contained 64 bit Linux virtual appliance which is supported on the following platforms:
Most of administering LincDoc is through a web browser. We strongly recommend Google Chrome 15+ or Firefox 9+ for administering the LincDoc system. The reason for this is that the admin UI is highly Javascript intensive, and those particular browsers have more powerful Javascript engines. Note that for end users the UI is less complex and so it is OK to use older browsers. Administering LincDoc from a mobile web browser is not supported.
LincDoc can work with these types of source documents:
There are some limitations to be aware of when choosing your forms authoring tool. This table summarizes those differences.
Source document format | .doc | .docx | .odt | |
Supports multirow? |
yes |
yes |
yes |
no |
Can produce TIFF output? |
yes |
yes |
yes |
yes |
Can produce PDF output? |
yes |
yes |
yes |
yes |
Can produce DOC output? |
yes |
no |
no |
no |
Can produce DOCX output? |
no | yes | no | no |
Can produce ODT output |
no | no | yes | no |
Supports conditional paragraphs? (LincDoc EE only) |
yes | yes | yes | no |
Supports cryptographic digital signatures? (requires the LincDoc signature module) |
only when converted to PDF at generation time | only when converted to PDF at generation time | only when converted to PDF at generation time | only when saved as PDF at generation time |
Can be used for iPad-based forms? |
no | no | no | yes |
Supports repagination?(LincDoc EE only) |
yes | yes | yes | no |
LincDoc Connector software is used to write out documents and data to third party platforms. Currently there are connectors for writing out to a Windows file share, and Laserfiche. The connector software installs as a Windows service to the server on which the documents and data are being written to. The service is written in Java (Java 6 to be precise), so Java must be pre-installed to the Windows server first.
The only software requirement for end users is for a relatively modern web browser. Here are the minimum required versions:
There are 2 versions of LincDoc on Apple iPad that are compatible with LincDoc 3.0, both are available in the Apple App Store. When browsing apps, they are labelled LincDoc 3.0 Mobile and LincDoc Mobile Offline.
LincDoc 3.0 Mobile is the "always online" version of LincDoc: you must always be on a wifi or 3G network connection in order to use the app. It is compatible on an iPad (1st or 2nd generation) running iOS 4 or 5.
This version supports working in an "offline" mode: forms can be completed without a wifi or 3G connection; documents and data are synchronized back to the LincDoc VM when a wifi or 3G connection is available. This app is compatible on any iPad (1st or 2nd generation) running iOS 4 or 5.
For pre-3.0 LincDoc VMs, the only supported iPad app is the one in the App Store labelled LincDoc Mobile. It requires a wifi or 3G connection at all times. It requires a 1st or 2nd generation iPad running iOS 4.
Paper vs. electronic
Field naming
Conditional logic
Use case
Actors - person filling out the form vs. person receiving the form
Calculations
Alerts
Workflow - email action
Processing - editing
Prepopulating data - JDBC
Writing data to external systems
Note: At this point in the documentation you should have executed the steps required to prepare the administrator's workstation.
Here you will start to use the LincDoc admin interface to create your forms. eForms are created by following four basic steps:
Using a PDF as a source document provides some advantages over the use of a Word document - including the ability to set source level constraints on the layout of the document, utilize certified digital signatures and more. However, the use of a PDF source document is not without a unique set of challenges. This page will provide information about setting up a PDF document, the challenges that appear and possible solutions.
Before adding fields to a new PDF, please optimize the size of the document by following the recommendations in the Best Practices chapter.
To create a field in a PDF source document, follow these steps:
Note: These steps assume Adobe Acrobat software. Please consult the documentation for your PDF creation software if using an alternative.
PDF documents provide enhanced methods for securing data. For an overview of Digital Signatures and LincDoc, see here.
A PDF document's fields cannot be modified by LincDoc during execution of the data entry process. What this means is that if the amount of data being input into a field exceeds the available space provided by the PDF field in the source document, data will be lost from the final, generated document. (Note however the full data is still captured in the LincDoc database repository.) To avoid this problem, there are two options which can be enabled inside of Acrobat which will allow text fields to adapt to the amount of data being entered.
In order to maximize the amount of data displayed (and simulate a text area), you should enable both of these options. However, this combination must be evaluated for its effect on the readability of generated documents.
Adobe LiveCycle forms are created using LiveCycle Designer, a product which is included with Acrobat (since version 7). See this link for a little more background/history on XFA forms.
LiveCycle forms (also known as XFA forms) can be used as LincDoc source documents only if they are static PDF documents. LincDoc will basically handle these types of forms in the same way as traditional AcroForms (Adobe's original interactive form technology).
LiveCycle has 2 formats, dynamic and static. If a LiveCycle form is added to LincDoc in the dynamic format, LincDoc will not be able to parse the fields and nothing will appear in the fields/section. You can find the format by editing the PDF in the LiveCycle designer and select form properties.
If the form is dynamic you will need to "Save As" and save the format as Static.
Note: All fields must have a title, otherwise the parsing engine will not detect the field when it is imported into LincDoc.
This page describes the syntax used by the LincDoc system when marking up a Microsoft Word or OpenOffice source document.
These fields never display in a generated document, but they will be part of the data entry process: <<firstName[hidden]>>
There are 2 types of field widgets backed by a codelist: listboxes and comboboxes. By default, when a document is generated the code is inserted; in order to insert the actual code this syntax should be used (assume we have a field called product): <<product.code>> Similarly the label can be explicitly set like this: <<product.label>> The multi-value fields syntax for using the code is this: <<product#.code>>
Sometimes a document needs to query the user to input multiple values for a particular set of fields that are to go into a table in the final document, and the number of values required is only known when executing the eForm. LincDoc will recognize this situation when any source document contains a simple 2 row table with the first row being a header row and the second row containing a template which describes what values are to be gathered at data entry time. Here is a simple example of such a table:
First Name | Middle Initial | Last Name |
<<fname#>> | <<minitial#>> | <<lname#>> |
Note how the field references end with a pound sign which tells the LincDoc system that these fields are to contain multiple values. At data entry time the user will have the capability to enter as many rows of values as necessary.
First Name | Middle Initial | Last Name |
<<fname1#>> | <<minitial1#>> | <<lname1#>> |
Name | Age | Address |
<<name#>> | <<age#>> | Street: <<street#>> City: <<city#>> State: <<state#>> Zip code: <<zip#>> |
Conditional text allows you to dynamically include paragraphs or text in your completed documents. This functionality is only available in document packages in LincDoc's Enterprise Edition. See Document Package Markup for more details.
In this section, you will create a new eForm using the LincDoc admin interface.
For example, Lorraine has been tasked to streamline collection of W4 data for her company's employees. She enters "W4" as the unique identifier and the description of "W4 Employee's Withholding Allowance Certificate".
The first panel or tab of the eForm definition is eForm. This section contains the basic parameters that govern the eForm's general description, state, and output format.
Item | Description |
Description: | The description of the eForm previously entered in the "Creating an eForm" step. |
Status: | eForms may be in a test or production status. eForms that are in testing status are not generally visible to end users. LincDoc administrators will also see the field names for each data prompt when running or executing an eForm. Production status publishes the eForm definition for general use (as permitted by the eForm's security settings). |
Allow mobile use? | This option publishes the eForm definition for use on mobile devices. |
This field allows you to name the generated documents using various predefined and form-specific tokens. In addition, you can specify any desired sub-directories, and if they do not exist, LincDoc will create them.
For example, say that there is a form where a user is prompted to input first and last name (fname and lname respectively), among other data. Using the string illustrated above, suppose that the user John Doe has submitted the form. The file that will appear in the system will be: John_Doe_01_01_2010.pdf. This allows you to easily configure LincDoc on a form by form basis to name files according to your organization's conventions.
Notes:
Token tips:
Token | Description |
<<LDuserid>> | The id of the currently logged in user. |
<<YYYY>> | The current year in 4 digit format (ie. 1999) |
<<YY>> | The last two digits of the current year |
<<MO>> | The two digits of the current month |
<<DY>> | The two digits of the current date |
<<HR24>> | The hour that the document was created (in Military/24 hour format) |
<<HR12>> | The hour that the document was created (in standard time) |
<<MI>> | The minute that the document was created |
<<SE>> | The second that the document was created |
This option specifies the document type of the generated documents. Please reference the Source Format table for format limitations.
Flattening a PDF does not allow the user to modify any data elements in the output document.
This setting controls the format of your section headers. See Data entry sections for more detail.
The display of your field help entries may be customized. See for Context sensitive help for more information.
You have the ability to control the left and right images when running an eForm. See Data entry images for more information.
Click on the Source Docs tab. On the left pane you see a list of all uploaded source documents that exist across all forms in the system. The right hand pane shows the source document being used for the particular form you are editing. Notice this implies that the same source document can be used with multiple eForms: if you change something in the source document and re-upload it, it will affect all eForms that reference it.
From the Source Docs tab, simply press the button. Use the file selection dialog to choose the source document file you wish to upload. Once the document file has been uploaded you are given the option to add a version history comment. Version history comments can be added to initial and subsequent document file versions to clarify your audit trail of updates. To view the audit trail, right click on the source document and choose version history.
When you want to make a change to an existing source document, right-click on it in the left pane of the Source Docs tab and choose . Proceed to edit the file using your forms authoring tool. When you are satisfied with the changes, re-upload it.
Select a document on the left hand pane, then press the
button. Notice that you can add multiple documents to an eForm, but only the first one in the list is used at generation time. Also note that even though only the first document is used at generation time, all fields from all selected source documents are configurable within the eForm.Select the desired document in the right hand pane and press Fields/Sections tab (exception: if a field is referenced by another source document that is part of the eForm definition then it remains in the Fields/Sections tab).
. Notice that all fields from that source document will disappear (permanently, once saved) from the
Notice there is a Fields/Sections tab where you get to specify the finer details of section and field objects in the eForm. Refer to the chapter on Field Attributes for the details of setting individual field configuration items.
The left hand pane of the Fields/Sections tab shows all of the eForm's sections and fields in a simple tree structure. The order of the items in this tree dictates what the end user sees when completing the eForm. Field sections may be collapsed or expanded by toggling the arrow icon that immediately precedes the section name.
Simply press the
button. This will immediately add a new section to the tree, and it will be labelled NEW SECTION by default.To delete a section grouping, right-click on the section name and select delete section. All of the sections fields will be moved to the OTHER section.
There is a special section that always exists in any eForm called OTHER. This a just a placeholder section to hold fields that have not yet been configured: whenever a new document is added into an eForm, all the fields go into OTHER. Notice that this section is never shown at run time: in order for an end user to interact with any field it must first be moved to some other section.
Notice that fields and sections in the tree can be dragged with the mouse to re-order the items. Multiple fields can be selected by holding down the control key and left clicking on each item. The selected fields can either be dragged into position or moved to a different section by pressing the move field(s) button and choosing the new section.
Use the
button to force the system to rescan a modified (re-uploaded) source document. Any new fields that are detected will automatically go into the OTHER section. Any removed fields will disappear from the field/section tree.Conditional text/paragraphs are only used in document packages, not eForms. Refer to the chapter on document package administration (link) for further details.
The global fields library.
button allows you to quickly apply preconfigured field information from theAfter a user has completed the data entry process, sometimes it is desirable to run one or more checks to ensure the data being submitted meets predefined requirements. This is where the
button comes in to play. By pressing this button you are presented with a dialog in which you can configure one or more conditions to be checked at submit time. If one or more conditions fail, you can display a customized alert message showing instructions to the user on what they need to do to proceed.Section attributes are available whenever a section is selected in the left hand pane.
Item | Description |
Section name: | The section identifier. The section name displays as the header during completion of the eForm. |
Section long description: | Section introduction. The description displays immediately under the section name within the body of the section. HTML syntax may be used to format the description's appearance. |
Condition to display: | The configured condition to display or not display the section. See Condition to Display for further details. |
Calculated heading? | Calculated headings are dynamic based upon an evaluated condition or data entered by the end user in a previous section of the eForm. |
Column widths: | Column widths control the width of the label and data input columns. |
Break after this section in LincDoc Mobile? | This option splits the subsequent sections during data entry into another "page" or tab on a mobile device. |
The Search tab is used to configure various options available to end users when they search a document repository. Note: searches are done by choosing an eForm from the eForm pick list (on the left side of the top desktop toolbar), then pressing the button.
You can choose up to five fields that an end user can use to help define filter criteria when they search the document repository for previously generated documents. The order of the search results columns will mirror the order of your current search indexes. Similar to the Source Docs tab, choose a field on the left pane and press to make it a searchable field. To remove a field index, select the field on the right pane and press .
Note: Adding or removing index fields will result in a global change to all users who can search the form.
A multirow field may not be used as a searchable index and are grayed out in the left pane.
Notice several checkboxes in the lower left corner of the Search tab:
There are further controls that apply to searching in the Security tab, discussed later in this chapter (link).
The Repositories tab configures the storage place for the eForm's generated documents. Repository options include the standard LincDoc repository as well as Laserfiche. Please refer to the Repositories chapter for further information.
The Actions tab contains two panels that configure the steps taken on form completion. Actions may be attached to direct user requests (button definitions) or events that occur during the processing of a form.
The button tree
The left hand pane of the Actions tab shows all of the eForm's buttons in a simple tree structure. The order of the items in this tree dictates the order of the eForm's buttons from left to right. Button definitions may be collapsed or expanded by toggling the arrow icon that immediately precedes the button name.
In the example on the right, Submit is the name of the first data input button. Always is the button's display condition. There are four associated actions with the submit button: clear hidden fields, validate, save, and view document. There is an additional button named Cancel that is always displayed and has an action of close.
To add a button, click on the arrow submenu on the Data Input line and select
. This will immediately add a new button to the bottom of the tree, and it will be labelled NEW by default.For a button press to have meaning, it should have one or more associated actions.
To add an action click on the arrow submenu on the button's definition line and select Actions chapter.
. Select the desired action from the submenu. Each action is detailed in theCertain actions may have attributes that may be edited. To edit these action types, click on the arrow submenu on the action's definition line and select
.To delete an action click on the arrow submenu on the action's definition line and select
. The action will be removed from the button definition.To edit a button, select the button's arrow submenu and select edit. A window with the button's attributes will be displayed. Each button has the following general attributes:
To delete a button, select the button's arrow submenu and select delete. The button's definition will be removed from the eForm.
Notice that button, actions, and rule definitions in the tree can be dragged with the mouse to re-order the item's precedence.
The right hand pane of the Actions tab shows all of the eForm's events and related rules or actions in a simple tree structure. Event definitions may be collapsed or expanded by toggling the arrow icon that immediately precedes the event name. Follow the instructions above the configure the actions associated with an event. There are three events displayed on the example shown on the right, After signing, On sync, and After viewing document. After signing has two associated actions of save and view document. After viewing document has a two conditional actions (set confirm close message and show HTML) based on the rule function of isOpenForm.
The Security tab grants access control to a document package or eForm to configured groups that have been created under the system's user/group maintenance option. See the chapter on Security for instructions on group maintenance.
The major document package rights in LincDoc:
LincDoc component | Right |
Groups with admin access: | Allows users to edit or delete this eForm |
Groups with test access: | Allows access to the eForm when it is in the test status |
Groups with run access: | Allows the user to run the eForm or document package |
Groups with view access: | Allows the user to see the eForm or document package |
Groups with edit access: | Allows the user to edit the eForm or document package |
Groups with delete access: | Allows the user to delete the eForm or document package. |
Groups with search access: | Allows the user to search for generated eForms |
Groups with view access to all users' documents: | Allows the user to view all user generated documents. |
Groups with edit access to all users' documents: | Allows the user to edit all user generated documents. |
LincDoc allows you to export your document packages and eForms to a compact, portable archive file that can then be imported into another client ID or LincDoc installation.
To export a document package or eForm, perform the following steps:
|
Your downloaded file will have a file extension of LDAR to identify it as a LincDoc document package archive. The name of the archive file is based on the Client ID, the document package ID, and a randomly generated four-character value, separated by underscores.
You can import downloaded document package archives to a new client ID or LincDoc installation by completing these steps:
A resolution list is reported when an item in the import file (a document package, business rule, code list or source document) has the same name as one that is already in the system. For each problem item, your choices to resolve the problem are:
An example will help to make the choices clearer. Let's say you're importing a new document package that uses a code list called "beverageTypes", which includes the codes "Coffee", "Tea" and "Soda". When you start the import process, a problem is reported, indicating that a code list called beverageTypes already exists in the system. The beverageTypes code list currently in the system includes the codes "Hot", "Dairy", and "Carbonated". If you choose the Rename option, the beverageTypes code list in the import file will be renamed to beverageTypes2. After the import, you will have a beverageTypes code list with "Hot", "Dairy", and "Carbonated", and a beverageTypes2 code list with "Coffee", "Tea" and "Soda". The newly imported document package will use the beverageTypes2 code list. If you choose the Keep option, the beverageTypes code list in the import file will be discarded, and the newly imported document package will use the existing beverageTypes code list with the "Hot", "Dairy", and "Carbonated" codes. If you choose the Replace option, the existing beverageTypes code list will be overwritten with the one in the import file. After the import, you will have a beverageTypes code list with the codes "Coffee", "Tea" and "Soda". Any existing document packages that use the beverageTypes code list will now show "Coffee", "Tea" and "Soda" as the available choices.
Document packages extend eForm functionality by allowing even finer control in the generation of form documents. This control is on the individual document level (dynamic control of form language with conditional paragraphs) and on the document set itself (document inclusion logic).
LincDoc Enterprise Edition (EE) offers additional markup capabilities in order to enhance your document creation process. By providing these additional constructs, LincDoc EE allows you to add business logic into your forms with a much finer granularity than SE.
NOTE: conditional text is only available in LincDoc's Enterprise Edition and when the form is a document package.
Conditional text uses a triple bracket notation, and a condition ID. The condition ID is a small string which will later be turned into a LincDoc condition. Consider this example: you are creating a document package to generate a student waiver document. You only want to show a particular sentence if the creator of the document is under 18 years old. Here is how it would look inside the source document:
<<< is_under_18 ? You must provide a note from your parent (or guardian) stating you have permission to attend.>>>
From this you should note the conditional text is comprised of the following:
Once you save these changes to the source document:
It is fine to have nested conditional text in your document. Keep in mind that a closing >>> will always match back to the most recent <<<. Here is an example. The nested conditional text is shown in yellow, while the outer conditional text is in light green. Note that in order for the yellow text to even have a chance to render to the generated document, the outer condition must first be true.
<<< tax_year_before_2000 ?
Prior to the year 2000 you must also submit an itemized list for all capital expenditures that were the result of an IRA distribution.
<<< multiple_dependents ? Note that you are possibly eligible for further tax credits for your dependents, please call 585-555-1212 to see if you qualify.>>> Once you have completed your itemized list, please refer to Publication 5223 (Early Retiree Credits) to determine the proper set of next steps.>>>
Multiple documents are added to the document package on the
tab of the Admin window. Three options control the behavior of the document within the package:A document package consists of multiple forms that may or may not appear in the completed document set. For example, there may be addenda that only apply in a given situation. Consider a rental company whose standard lease package includes documents pertaining to garage rentals or additional pet fees. On properties where garages are not available or pets are not allowed these documents should be suppressed. This is accomplished through document inclusion logic.
Inclusion logic is configured on the Source Docs tab of the administrator's document package setup. Right click on the document that should be optionally included and select
from the menu. This displays a dialog box where the user may select a previously configured condition or create new one. If the condition evaluates as true, the document will be included. Otherwise, the document will not appear.
Sometimes there is a need for a source document to be repeated 1 or more times, but it is only known how many times it will be repeated once the user completes their data entry. Assume you are creating a document package to generate an apartment lease for 1-4 residents. The package is composed of 2 source documents: a base lease agreement and a resident application form. The base lease agreement contains a multi-value table to collect the 1-4 resident names, which we want displayed in the base lease. We make hidden fields to collect further details for each resident: we don't want to display the details in the base lease agreement, instead they will be shown in the application forms which will follow the base lease.
Resident name | Resident address |
<<res_pn#>> | <<res_addr#[hidden]>><<res_city#[hidden]>><<res_state#[hidden]>><<res_zip#[hidden]>> |
In the application form we might have something like this:
Resident name: <<res_pn#>>
Address: <<res_addr#>>
City, State Zip: <<res_city#>>, <<res_state#>> <<res_zip#>>
To include a document for each resident:
Global fields allow the administrator to configure multiple fields with a single button click. This is done by configuring a field pattern to match against, along with the appropriate field attributes to be set with the matched fields. For example, you could have a pattern of *_dt to signify all date fields. The *_dt pattern would be configured with the date field type and a label of Date. When the apply global fields button is clicked, anything matching that pattern will have those field attributes applied to it.
Use these steps to set up a global field using the example mentioned in the overview.
Edit any eForm that contains one or more fields whose names end in _dt. Go to the Fields/Sections tab and press apply global fields. When prompted, choose to apply to all fields. All the matching fields should now be labelled Date, and have their types set to date.
Notice that when you press apply global fields there is an option to only apply the global field settings to new fields. New fields arise when you have an existing eForm and its source document is modified to add one or more new fields. Once the source document is saved and re-uploaded, press the reparse button on the Fields/Sections tab and the new fields will appear in the OTHER section. At this point you can now press apply global fields, and utilize the option to just apply the settings to new fields.
NOTE: changing the attributes of an existing global field has no effect on any field that was previously matched against that global field. The only time global field settings are applied is by pressing the apply global fields button.
Field attributes define the data entry widget type and how that widget performs in a LincDoc form. For example, you may have a phone number or date field in your form and you want the user to enter the correct number of digits in the number and pick a date from a pick list. Setting the field attributes will control how this field performs. In addition, there are other attributes that control how and when the field is displayed in the form.
The following are a list of the most common field attributes:
Item | Description | Advanced |
Field name: | The name of the field as configured from the source document. | |
Appears in: | Lists the first source document encountered that contains the field. | X |
Label: | Enter the Label that appears to the user in the data entry process. | |
Short label: | Defines the label that appears for this field when performing searches or modifying the set of index fields. | X |
Field type: | This is a drop down list of the data types of each field in the data entry process. See Field Types for further information. | |
Maximum number of rows | This option is available only on multiline fields and controls the maximum number of repeating sets that may be entered by the end user. | |
Condition to display: | Defines whether a field is displayed or not. The default selection of Always will display the field to the end user. Never will not display the field. Conditions may be configured to dynamically display the field based upon previous input. See Condition to Display for more information. | |
Required: | A value of Always/Never defines whether or not the field must be completed before proceeding in the data entry process. Conditions may be configured to dynamically require the field based upon previous input. Required conditions are discussed further here. | |
Read Only: | A value of Always/Never defines whether or not the field value may be entered by the user. Conditions may be configured to dynamically prevent the field from being edited. See Read Only Conditions for more information. | X |
Input constraint: | Defines the format criteria on how the user must enter a value in a field. For example, entering the value of "###-###-####" the user must enter a numeric value of 555-555-5555. '#' signs denote numeric characters, 'X' denotes alpha characters. Typical Input constraints descriptions can be found in the Custom Strings documentation. Other options include and . All caps forces entered text to capital letters. Proper name forces the capitalization of the first letter of each word. | |
Constraint warning message: | Defines the text that is displayed to the user if the Input constraint is not entered correctly. | |
Alert condition: | Defines a message box alert and its triggered condition. Alert messages are warnings for the end user. They do not prevent the user from continuing. To create an alert condition, select | from the option menu and configure the condition with the condition wizard. Once the condition or the standard Always option is selected, select to enter the alert text. The alert text can contain previously entered user data.X |
Width: | Numeric value that defines how wide the field text area. | X |
Max length: | Numeric value that defines the maximum number of characters that can be entered in a text area. | X |
Calculated field? | Calculated fields are values generated by the system in response to some user input. See Calculated Fields for more information. | X |
Button calculation? | Calculations that are executed in response to a button press. | X |
Default calculation? | Defaults a fixed or dynamic value in the field. See Default Calculations for more information. | X |
Clear value when hidden: | When selected, this option will clear the field's value from being saved if its condition to display becomes false during user entry. | X |
Actions and Buttons: | Configures the actions executed in relation to a user's interaction with the field. For example, an action may be triggered by the | event of a field.X |
Exempt from flattening: | A value of Always/Never defines whether or not the field is flattened. Conditions may be configured to dynamically prevent the field from being flattened. | X |
Field help: | Context senstitive help that appears to the end user. When this is defined for a field a help icon will automatically appear to the right of the field. HTML syntax can be used to configure the text that is displayed. |
Watch this video to learn more about field attributes.
LincDoc provides a rich set of field types to choose from. Setting the field types is a critical step in the forms setup process, because it will dictate how each field can be used in the DANG system.
TIP: the field types for all fields should be assigned very early on in the setup process, as changing field types later in an eForm can lead to confusing behavior, in particular when the field is used in calculations for other fields.
The field types fall into these basic categories:
Checkboxes are not directly selectable as a field type. See here for details.
See here for an in depth coverage of signature fields.
Code 128, Code 39, and PDF 417 barcodes are supported; use a calculation to control the data going in to the barcode.
There are options also for orientation, alignment, and scaling. Generally the defaults are acceptable.
This allows users to upload a file.
NOTE: uploaded files are NOT inserted into the generated document, only the names of the files will show.
LincDoc fields may be assigned to be either a codelist, or codelist-custom, field type. Codelists present themselves as drop down choices for the user to select one particular value. Custom codelists are exactly the same, but they also allow the user to type in a value that does not appear in the choice list.
Internally, codelists are database objects that consist of an ordered list of codes and descriptions of those codes. They may reside either inside LincDoc's internal database, or in one of the supported 3rd party databases (currently Oracle, Microsoft SQL Server, MySql, and PostgreSQL).
NOTE: a 3rd party database can only be used if the Database Integration module has been purchased and configured.
Open any form for editing. Go to the Fields/Sections tab. Select any field. In the right pane, click on the drop down list in the codelist(s) section; choose new. You are then prompted to enter an ID for this codelist, and you must select a type:
NOTE: the JDBC types can only be used if the Database Integration module has been purchased and configured.
There are two types: simple and advanced.
Simple codelists are codelists which contain codes (or short text phrases) that have obvious meaning to the user, and therefore do not require a description. For example, a yes/no codelist:
Enable the advanced checkbox and you can now edit a description and a label:
At run time, this is what the user sees:
Conditional codelists allow a field to present a different choice list to the user based on one or more conditions. For example, imagine a scenario where the field make asks the user to choose a particular copier manufacturer. Then the field model is a list of models from the manufacturer. The model's codelist depends on the copier manufacturer; it is conditional based on the value of make. To configure a conditional codelist, click on the advanced checkbox as shown here, then press the configure button:
Note the codelists behind a conditional codelist may be a mix of manual entry and JDBC.
There is an alternate method to create a conditional codelist. When creating the codelist, the type will be JDBC Advanced:
When you get to the configuration screen, choose your data source. Then type in your query. LincDoc field names can be used in the where clause to conditionally select data. Just delimit each LincDoc field with << >>, as shown below for field city.
Once you have the query typed in press refresh, if there are no syntax errors then you be able to map database fields to the code, label, and description attributes of the codelist. Note that you can re-use the same database column for both the code and label. Also note that mapping the description is optional.
The where clause is free to use any function supported by the underlying database; refer to your database's documentation for details. Here is an example (building on the example shown above) assuming your database is Microsoft SQL Server: suppose you want to select only those companies that are in cities whose name contains the string as typed by the user into LincDoc field "city", and it should match case insensitively: select * from dbo.companyinfo where lower(city) like '%' + lower(<<city>>) + '%'. So if the user had typed in for into field city, this query would return companies in Fort Worth, Rockford, New Hartford, Fort Lauderdale, etc.
As another example, consider a situation where you have a table of copier manufacturers, called manufacturers, with column manufacturer:
manufacturer |
Kanon |
Tosheeba |
Parasonic |
Then another table of manufacturers' copiers (table name copiers) with columns manufacturer and copier_model. This table relates manufacturers to their respective copier models:
manufacturer | copier_model |
Kanon | K-310 |
Kanon | K-320 |
Kanon | K-330 |
Tosheeba | TS-5-A |
Tosheeba | TS-5-B |
Parasonic | Genesis I |
Parasonic | Genesis II |
Further assume you have a LincDoc eForm with fields of the same names as the database columns. The LincDoc field manufacturer would be set up as a simple codelist to the manufacturers table, and a "JDBC advanced" codelist would be used for LincDoc field copier_model. To select copiers based on the currently selected manufacturer the "JDBC advanced" codelist would use the query: select * from copiers where manufacturer=<<manufacturer>>
.
Checkboxes are represented by two special field types in LincDoc: a checkbox "grouper" field, and 1 or more checkbox items which compose the group. The grouper field type allows LincDoc to logically group the individual checkboxes and present them to the user when completing an eForm. The way in which this is accomplished is by using checkboxes in the source document, and applying a special naming pattern to the checkboxes. The method varies depending on the source document type.
Follow these steps to define checkboxes in an MS Word document.
NOTE: there are two types of checkboxes in MS Word, legacy and ActiveX. A legacy check box must be used.
Use the following steps (note: these steps were written using MS Word 2007).
Follow these steps to define a group of checkboxes in a PDF document.
LincDoc does not have a radio button widget, but radio button functionality can be implemented using a combination of PDF radio buttons in a source document and a drop down list in LincDoc. This will allow the user to select one and only option. Use the following instructions to enable radio button functionality in your form (NOTE: for XFA forms see the section below):
Your radio button group will now be controlled by the list box that was just created.
NOTE: XFA forms are only supported in LincDoc 2.2 or higher. As noted above, LincDoc does not currently have a radio button widget, but a drop down list can be used to select a specific radio button in an XFA form. There are a few configuration steps that need to be followed to enable the use of XFA radio buttons. The first is to create an exclusion group that will contain all the radio buttons for a specific LincDoc field. An exclusion groupis Adobe's term for a group of radio buttons. Only one radio button in the exclusion group can be selected at a time. The exclusion group name will be the name of the field that appears in LincDoc. Create a code list containing the unique values for each radio button in the exclusion group.
In the example below we have an XFA form that has 3 radio buttons, Red, Green and Blue. We have a LincDoc form that will select one of those colors in the PDF when generated. You can download and import this example into your clientID by clicking this link. Follow these instructions to import this test form. Watch this video to see how to prepare your radio buttons in Adobe Livecycle. Watch this video to see how to create the code list in LincDoc and the resulting output.
The following page gives a brief overview of the use of digital and electronic signatures in LincDoc. LincDoc has four digital signature types (or signature providers): Topaz pad signatures, LDAP signatures (authenticated), mouse signatures, mobile signatures, and one electronic signature type, clickwrap.
NOTE: it is assumed that the terms final document or generated document as used below refer to a PDF generated by LincDoc.
A Topaz signature pad captures the user's handwriting/signature and converts it into an electronic format. This process creates an image and captures biometric data of the signature. When using a Topaz pad to sign documents in LincDoc, LincDoc will capture this image and biometric data and store it in the generated PDF document. The biometric data that is collected by the Topaz pad is also encrypted with the unsigned document. This means that not only can this method be used to verify that someone has signed the document, but we can also verify that this is the document that they signed and that the biometric data has not been tampered with.
This signature process begins after the data entry steps are complete and the user has reviewed the draft copy of the document. The following is breakdown of the steps:
This is best illustrated in an example. Sally Jones comes into the office and sits down with John Doe (assume he is an office clerk) to complete an application. The data is gathered and the document is ready to be signed.
Click here for configuration details...
NOTE: you must have purchased the LDAP Integration Module in order to do LDAP signatures.
An LDAP signature validates the user by challenging that user for his password when he executes an LDAP signature. Once validated, LincDoc will apply a digital signature certificate to digitally lock the document. This signature process begins after the data entry steps are complete and the user has reviewed the draft copy of the document. The following is breakdown of the steps:
Click here for configuration details...
The mouse signature applies the same process that Topaz uses but instead of using a Topaz pad, the user simply uses their mouse to draw their signature on the signature canvas. The type of signature requires the use of an HTML5 compliant browser:
The following is breakdown of the steps:
Click here for configuration details...
Currently, LincDoc only supports iPads for use with Mobile signatures but will be coming out with support for the iPhone, and all mobile devices that support a webkit browser. This type of signature allows the user to complete a form on their iPad and have a user sign directly on the screen of that device, as illustrated above.
The user must download and install the LincDoc Mobile iPad application. Once installed and configured with an activation key, the user is able to access the forms on their LincDoc Server.
The following is breakdown of the steps:
Clickwrap signatures are electronic signatures that do not require a digital certificate or signature capture pad. Clickwrap signatures in LincDoc offer a simple method of obtaining electronic evidence of user acceptance to the data entered into a LincDoc form. The data entry question/answer process ensures a level of authentication that the user is who he/she says they are. This can be configured in LincDoc to collect any information including:
Once the user provides this information, the data is written to the document, and cannot be changed because it is written to an image format or a secured, read-only PDF document.
Click here for configuration details...
DANG is LincDoc business logic engine that is the driving force behind all the conditions, actions, events and calculations contained within a LincDoc form. This is the replacement for the custom scripting that was done in Javascript in earlier releases of LincDoc.
To understand DANG, it is important to first know certain terminology:
Conditions are user configured boolean (true or false) expressions that drive system behavior. A condition statement or clause may be singular or may be evaluated in conjunction with other clauses using AND (All of the following) or OR (Any of the following) to create more complex expressions.
Each condition must have a unique name. Once the condition is defined it is available throughout the eForm or Document package's condition lists.
The comparison field is selected from the eForm's field set. The field's type controls the operator list and comparison values. For example, if the comparison field is numeric, numeric comparisons are available. If the comparison field is a drop down list, the comparison values are automatically filled with the drop down list's options.
The operator controls the type of comparison.
Operator | Description | Available |
After |
True if the comparison field's value is after the comparison value. |
date, time |
All |
True if all of the checkbox group items have been selected. |
checkbox groups |
Any |
True if any of the checkbox group items have been selected. |
checkbox groups |
Before |
True if the comparison field's value is before the comparison value. |
date, time |
Between |
True if the comparison field's value is equal to either of the two comparison values or within the range of the two comparison fields. |
numeric - (integer, decimal) |
BetweenDate |
True if the comparison field's value is equal to either of the two comparison values or within the range of the two comparison fields. |
date, time |
Contains |
True if the value of the comparison field includes the comparison value text. |
alphanumeric (text) |
EndsWith |
True if the value of the comparison field concludes with the comparison value text. This is a case sensitive comparison. |
alphanumeric (text) |
Equal |
True if the value of the comparison field is the same as the comparison value. This comparison is case-sensitive. |
alphanumeric (text, numeric, checkbox, code list) |
EqualNoCase |
True if the value of the comparison field is the same as the comparison value. This comparison is not case-sensitive. This is available in advanced conditions only. |
alphanumeric (text, numeric, checkbox, code list) |
Greater |
True if the value of the comparison field is larger than the comparison value. |
numeric - (integer, decimal) |
GreaterOrEqual |
True if the value of the comparison field is the same or larger than the comparison value. |
numeric - (integer, decimal) |
IsEmpty |
True if the value of the comparison field has a blank value. |
alphanumeric (text, integer, decimal, date, checkboxes, code list) |
IsGuestUser |
True if the user is the guest user. (Advanced condition) |
none |
IsInGroup |
True if the value of the user is a member of the comparison value's LDAP or AD group. |
alphanumeric (text) |
IsNotEmpty |
True if the value of the comparison field is not blank. |
alphanumeric (text, integer, decimal, date, checkboxes, code list) |
IsNull |
True if the value of the comparison field has a no value. This operator should only be used in advanced comparisons. |
alphanumeric (text, date, checkbox) |
IsOpenForm |
True if the eForm is running in OpenForm mode. (Advanced condition) |
none |
IsSigned |
True if the document has been signed. (Advanced condition) |
none |
LastMonth |
True if the comparison field's date occurs within last month. |
date, time |
LastSixMonths |
True if the comparison field's date occurs within the last 6 months. |
date, time |
LastTwoWeeks |
True if the comparison field's date occurs within the last 14 days. |
date, time |
LastWeek |
True if the comparison field's date occurs within the last 7 days. |
date, time |
LastYear |
True if the comparison field's date occurs within the last 365 days. |
date, time |
Less |
True if the value of the comparison field is smaller than the comparison value. |
numeric - (integer, decimal) |
LessOrEqual |
True if the value of the comparison field is the same or smaller than the comparison value. |
numeric - (integer, decimal) |
None |
True if none of the checkbox group items have been selected. |
checkbox groups. |
Not |
True if checkbox is not selected. |
checkboxes. |
NotAll |
|
checkbox groups. |
NotEqual |
True if the value of the comparison field is not the same as the comparison value. |
alphanumeric (text, integer, decimal, checkboxes, code list) |
OneOf |
True if the value of the comparison field is found in the set of comparison values. |
alphanumeric (text, integer, decimal, checkboxes, code list) |
OnOrAfter |
True if the comparison field's value is after the comparison value or equals the comparison value. |
date, time |
OnOrBefore |
True if the comparison field's value is before the comparison value or equals the comparison value. |
date, time |
StartsWith |
True if the value of the comparison field begins with the comparison value text. This is a case sensitive comparison. |
alphanumeric (text) |
Comparison values may be any constant value such as a given text string or number. They may also be other eForm fields.
A simple example of a condition would be a test of a field's value. For example, evaluate the value of a preferred contact list (shown below).
Here the condition's name is contact_ph_required. The condition's field is contact_optlist. Its operator is set to Equal, and its value is the "Home Phone" selection.
A more complex example, would involve displaying a preferred contact time if the user entered a home phone number or a cell phone number. Note in the example below "Any of the following" is selected.
The Condition to display option is used to dynamically display or hide a field or section based on a value or condition of another field. This option evaluates to true or false, depending on the condition. If the result is true, then the field is displayed but if the result if false, then the field is not displayed.
For example: Let's say you would to display fields based on the type of leave an employee is requesting. If the leave type is Personal, only display the personal fields. If the leave type is Professional, then only display the professional fields.
Thus, when a user selects "Personal" from the leave_type drop down list in the data entry process, the section that contain the fields for personal leave will be displayed. If the user selects "Professional" then the section containing the fields for professional leave will be displayed. This streamlines data entry to the point where only the necessary fields are presented to the user for a cleaner and clearer data input.
Required conditions allow the administrator to force entry of a field's value based upon information only available during execution of an eForm.
For example, consider the situation where multiple points of contact for a customer are desired, but you would only require them to enter one. The required contact point is designated by the user as their preferred point of contact. In this example, the form would have data fields for home phone (contact_ph), email (contact_email), and cell phone (contact_cell_ph). There is an additional list (contact_optlist) where the user selects the best contact option from the three. The field that is required is based on the user's selection.
Read only conditions dynamically prevent the end user from editing a field's value based on information available only on execution of a form. This functionality is useful when a field's defaulted value is based on your best business practice. However, there are situations where you may allow its value to be overridden by the user. The field's read only condition gives you the ability to allow edits only when necessary.
Document inclusion rules control the presence of each of the documents included in a document package. The logic to include or exclude is executed when running a document package. For example, a generic lease package may contain multiple addenda that should be included based on property characteristics.
Calculated field values are derived from previously entered data or system functions. To configure a calculated field select the
checkbox on the field's attributes panel. Access the submenu arrow and select . The calculation wizard guides you through the setup of one of 4 calculation scenarios.Select the "Set the field value to a manually entered value" option. Enter the constant in the value field and press
to continue. In the example below the preferred contact method option list is defaulted to the Cell Phone selection.Select the "Set the field to the value of another field." option. Select the source field for the current field's value. Press
to continue.Function based calculations are found under the "Set the field based on a function" option. In this example, the contact's age is calculated from the entered birth date.
The If/Then/Else calculation choice enables the user to use cascading boolean logic to determine the field's value. In the example below, if the contact has entered a preferred contact method (contact_optlist) of home phone or cell phone, then schedule a follow up call in a week. Otherwise, default the scheduled follow up to the day the contract information was entered (contact_entry_dt).
You may also directly edit the calculation without using the calculation wizard. This method gives you full control over the calculation's definition.
In the example below, the contact_optlist is the target field that will be set to the calculation's output value. The calculation is configured to set the contact_optlist field to a manually entered value or constant of "Cell Phone". Manual value entries are accessed using the pencil icon to the right of the value field.
Here is an example of defaulting a date field to the current date. The function CUR_DATE is made available in the value field by selecting the function icon .
Functions may require zero or more input values or parameters. In the example above, the current date function (CUR_DATE) does not need an input value. An age calculation using the YearsSince function has one input value, the contact's birth date (contact_birth_dt) field. Fields are listed in the input value list when the field option button is selected.
In the case of the implementation of a W4 form, lineH is the sum of lines A through G. Additional values were created by clicking the plus button on the value field row.
Certain calculations may entail multiple steps that require temporary fields to hold interim values. For example, a payment may be due on the last day of the month, but you may wish to schedule it for the day before.
In this case you need a variable field to temporarily store the end of month date. You can then use this field in the MinusDays function to calculate your final answer.
The following string functions are available:
Function |
Inputs |
Output |
CityStateZip |
City, State, and Zip |
Formatted string -- city, state zip. |
Concat |
Two or more strings |
Single string composed of the multiple inputs |
ConcatWithSeparator |
Two or more strings plus a separator string |
Single string composed of the multiple string inputs separated by the specified separator |
Csv |
Two or more strings |
Single string composed of the multiple string inputs surrounded by double quotes and separated by commas. i.e., "Sam Smith","123 Main Street","Anytown","NY","12345","02/02/1968", |
DecimalToString |
Single decimal |
Converts the decimal for use as a string |
DoubleQuote |
Single string |
Input string surrounded by double quotes |
Drat |
DRAT expression (for internal use only) |
DRAT expression output |
DurationBetween |
Two times |
Duration between the two time values in HH:MM format. |
EMPTY_STRING |
None |
Returns a zero length string value. |
FirstWord |
Single string |
Excerpt of input string taken from the beginning to its first space character. If the input string does not contain any spaces, it returns the full input string. |
FullName |
Two strings, first name and last name |
Concatenation of the first name input, a space character, and the last name input. |
IntToString |
Single integer |
Converts the integer for use as a string |
LastWord |
Single string |
Excerpt of input string taken from its last space character. If the input string does not contain any spaces, it returns the full input string. |
Left |
Single string, integer length of excerpt |
Excerpt of input string taken from its start. |
LowerCase |
Single string |
Input string with each uppercase character converted to lowercase. |
NamedBytesName |
Single upload file field |
Filename of the uploaded file. |
ParseDelimited |
Single string (phrase), separating character (delimiter) defined with regular expression, integer index position |
(Index position is zero based. Inputs of Here,is,another,string,phrase with a comma delimiter and an index of 2 returns a value of another.) |
ParseWord |
Single string (phrase), integer index position of word |
Word from the input phrase at the indicated position. (Index position is zero based. Inputs of Here is an example phrase and an index position of 3 returns a value of example.) |
RandomString |
integer length |
String composed of the input length number of random characters |
Replace |
Input string, undesired character string, desired character string |
Input string updated with new characters where the old characters previously existed. |
Right |
Single string, integer length of excerpt |
Excerpt of input string taken from its end. |
SingleQuote |
Single string |
Input string surrounded by single quotes |
Spaces |
integer number of spaces |
String value comprised of the input number of space characters |
Substring |
Single string, integer start position, integer length of excerpt |
Excerpt of input string. (Index start position is zero based. An input string of 1234567890abcdefg, start position of 6, length of 8 gives an output of 7890abcd.) |
TitleCase |
Single string |
Input string with the first character converted to upper case as well as all characters immediately preceded by a space. |
ToString |
Single string, integer, decimal, boolean, or date |
Input value converted for use as a string |
Trim |
Single string |
Input string with preceding or trailing space characters removed. |
UpperCase |
Single string |
Input string with each lowercase letter converted to uppercase. |
UserAttribute |
attribute (username, full name, email address) |
Value of the selected attribute |
Boolean functions are described in the condition operator's table.
The following numeric functions (integer, decimal) are available. Decimal fields retain precision. Integer fields results are rounded to the nearest integer. 2.5 is rounded to 2.
Function |
Inputs |
Output |
Add |
Two or more numeric values |
Sum of the inputs. |
Average |
Two or more numeric values |
Average of the inputs. |
Ceil |
Single numeric |
Number always rounded up, i.e., input: 2.3, output 3 input 2.0, output 2 input 2.1, output 3 |
DayOf |
Single date |
Day of the month |
DayOfWeekOf |
Single date |
Day of the week, where 1 is Sunday, 2 is Monday, 3 is Tuesday and so on. |
DaysBetween |
Two date fields |
Number of days between the dates not including the start date or end date. |
DaysInMonth |
Single date |
Number of calendar days in the month |
DaysSince |
Single date |
Number of days since the input date. |
Divide |
Two numeric values |
The division result of the inputs. |
Floor |
Single numeric |
Number always rounded down, i.e. input: 2.3, output 2. input 2.0, output 2. input 2.99, output 2 |
HourOf |
Single time |
Hour in military time, midnight is 0, noon is 12. |
HoursBetween |
Two time values |
Difference of hours between the times. |
Int |
Single numeric |
Number always rounded down, similar to the floor output |
Length |
Single string |
Length of the string |
Max |
Two numeric values |
The greater of the inputs |
Min |
Two numeric values |
The lesser of the inputs |
MinuteOf |
Single time value |
The minute of the hour |
MinutesBetween |
Two time values |
The number of minutes between the times. |
MonthOf |
Single date |
The numeric value of the month, i.e., February is 2 |
Multiply |
Two or more numeric values |
The multiplication result of the inputs |
NamedBytesSize |
Single upload file field |
The size of the upload file in bytes |
Pos |
String phrase, matching string |
The index of the matching string starting from the end of the string, i.e, string is abc de abe deabc, matching string is de output is 4. Where the matching string is not found, the output is -1. |
QuarterOf |
Single date |
The quarter of the year, i.e., 2/29 is in quarter 1 |
Round |
Single numeric to round, integer of decimal places |
Rounds to specified number of decimal places. |
RowCount |
Single multi value field |
The number of instances of the multi value field. For example, on an expense report with repeating expense fields, the number of expenses that have been entered. |
RPos |
String phrase, matching string |
The index of the matching string starting from the end of the string, i.e, string is abc de abe deabc, matching string is de output is 11. Where the matching string is not found, the output is -1. |
StringToDecimal |
Single numeric |
The decimal value of the input |
StringToInt |
Single numeric |
The integer value of the input |
Subtract |
Two numeric values |
The result of the subtraction |
Sum |
Two or more numeric values |
Sum of the inputs |
YearOf |
Single date |
The year of the input field |
YearsBetween |
Two date values |
The difference between the years |
YearsSince |
Single date |
The number of years since the input date |
Default calculations allow you to pre fill field values to streamline data input. For example, consider the situation of a company monthly expense report. You may wish to default the start date to the first of the current month and the end date to the last day of the month. This is accomplished by setting up default calculations.
Actions are units of work in LincDoc that are conditionally triggered by form or field events or button clicks. An action can be something as simple as saving data to a database or generating a document. This allows the user the ultimate flexibility by allowing the user to fire specific actions at different parts of the form process.
Some common actions include:
Action | Description | Available |
clear hidden fields |
Sets all field values where the field is not displayed to null. |
Form |
close |
Closes the form, typically without saving the data. i.e., a cancel button. See Close for more information. |
Field, Form |
|
Emails recipients with a dynamic message and possible document attachments. See Email for more information. |
Field, Form |
execute stored procedure |
|
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 |
Form |
|
lookup |
Merge data option from a search of an external data source. Refer to the Database Lookups chapter for more information. |
Field, Form |
run a doc package or eForm |
Opens the configured eForm or document package for data entry. |
Field, Form |
save |
Saves the inputted data to the LincDoc database. |
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. See Show HTML for more information. |
Form |
show a message |
Opens a message box with a configured message to the user. |
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 |
Buttons
Buttons may be associated with a particular field's row or on the form itself. Form level buttons are configured on the Actions tab of the admin interface. Field level buttons are configured from the field's definition pane.
To edit a button, select the button's arrow submenu and select edit. A window with the button's attributes will be displayed. Each button has the following general attributes:
Select
to apply your button attribute changes.A button's definition is removed by selecting its submenu arrow and selecting
.Events occur on both a field and eForm basis. Each event can be configured to perform one or more actions. These actions may also be subject to a rule evaluation or condition. The following events are available in LincDoc:
Event | Type | Description |
On blur | Field | This event triggers when the user exits a field and the field loses focus. |
On change | Field | This event triggers when the value of a field changes. |
After signing | Field/eForm | |
On sync | eForm | This event triggers when the data is synchronized to the server in LincDoc's mobile implementation. |
After viewing document | eForm | This event triggers when the document viewer is exiting. |
Certain actions may be needed at multiple points during an eForm's lifecycle. A shortcut to defining repeated actions is available in LincDoc as a "named action". Named actions are saved action configurations that may be reused or act as a defaulted template for new action definitions.
A rule is a configured action or set of actions dependent upon an evaluated condition.
A rule definition may be attached to a button click or event or even to another rule .
To create a new rule:
To edit a rule's attributes, select its arrow submenu and choose
.To delete a rule definition, select its arrow submenu and choose
.A named rule has been assigned a unique name through the
option on its attributes. Once named, the rule definition is available for reuse on other buttons, events, or rules.
The close action exits the data entry window and is generally associated with a Cancel button.
The close action has an attribute of "Prompt before closing". If selected, before the user can close the data entry window they must confirm the message:
The email action sends an email to a configurable set of recipients. The email may have the generated document as an attachment.
The email action has the following attributes:
Item | Description |
From | The From entry is required and must be a valid email address. |
To | The recipient list may have multiple entries. The TO drop down list also allows you to add CC and BCC entries by pressing the plus button to the right of the address row. |
Subject | The email's subject may be static text or it may contain eForm data. To add eForm field data, select the eForm field in the drop down list to the right of the subject field. The selection will be automatically inserted into your subject definition. |
Body | The email's body may be plain text or may be defined as HTML. The drop down list on the body row automatically inserts the selected eForm field into your body definition. |
Attachments | The document or document package may be attached to the email in PDF, TIFF, XML, or CSV format. |
The
action writes a copy of the generated document or document set to Windows share.Access to the share and the path name are configured in the action's attributes.
Item | Description |
Server/Port | The name and access port of the Windows server. |
Domain/Username/Password | The security credentials having write access to the Windows share. |
Share | The share name. |
Path | The destination directory path. The drop down list on the this row automatically inserts the selected eForm field into your path definition. |
Format | The document or document package may be written in PDF, TIFF, XML, or CSV format. |
The OpenForm mode. The webpage may include any combination of static and dynamic text based upon the user's input. You may also redirect a user to another site, for example:
action opens a browser window with the specified HTML. This action is typically used when an eForm is executed in<head>
<meta http-equiv="refresh" content="1;url=http://www.anysite.com">
</head>
The HTML is configured in the action's attributes. A drop down list is provided that contains the eForm's data and system fields. Selecting a field will insert its definition mapping into the HTML window. Link references are available for mapping as well.
Repositories are configured in the system settings of LincDoc. To create a new repository select
under the system icon of your administrator interface.Select the new icon at the top right corner to open the Create new repository window.
Name your repository by entering a unique id. Select the repository type and click on the
button to add the new repository definition.A LincDoc Repo repository type does not need further configuration. See the LaserFiche repository page for more information.
Laserfiche repository settings control the import of your completed LincDoc documents into your Laserfiche system. This includes document storage considerations such as the folder destination as well as document indexing.
You should have completed the following steps before configuring your Laserfiche repository mapping for your eForm.
Select the arrow submenu button to define the field mapping from the LincDoc data entry process to the Laserfiche template fields.
The configuration screen has two parts. The LincDoc fields contained within the current eForm and the Laserfiche template fields that are read from the currently selected Laserfiche template.
Select the arrow submenu button to define the path location and file names LincDoc will use to write the eForm or document package to the Laserfiche environment.
This configuration screen is broken down into 3 panels. The first panel displays the Laserfiche directory structure as read in real time. The sections to the right define the token based file name and subdirectory definitions.
Other tokens:
Token Name | Token | Description |
username | ($LDuserid$) | The LincDoc user name |
document Package ID | $docpkgid$ | Uses the current LincDoc eForm or Document Package ID |
backslash | \ | separator that can be used to define a subdirectory |
hyphen | - | separator that can be used in a file name |
underscore | _ | separator that can be used in a file name |
4 digit year | ($YYYY$) | The current four digit year defined by the server clock time |
2 digit year | The current two digit year | |
month | The current two digit month | |
day | The current two digit date | |
hour (0-23) | 24 hour clock time | |
hour (01-12) | 12 hour clock time | |
AM/PM | ||
minute | ||
second | ||
day in year | ||
week in year | ||
day in week | ||
custom string | Gives the ability to create a string to define a file name or subdirectory |
Check this option if you would like uploaded documents for this form or document into Laserfiche.
.
.
This feature tells LincDoc to convert any uploaded PDF files to TIFFs, and then append them to the generated file for storage into Laserfiche. Note: This only works when the output format for the eform is set to TIFF.
Access control to a document package or eForm is configured using group settings created under System, User/Group maintenance.
The major document package rights in LincDoc:
LincDoc component | Right |
Groups with admin access: | Allows users to edit or delete this eForm |
Groups with test access: | Allows access to the eForm when it's in the test status |
Groups with run access: | Allows the user to run the eForm or document package |
Groups with view access: | Allows the user to see the eForm or document package |
Groups with edit access: | Allows the user to edit the eForm or document package |
Groups with delete access: | Allows the user to delete the eForm or document package. |
Groups with search access: | Allows the user to search for generated eForms |
Groups with view access to all users' documents: | Allows the user to view all user generated documents. |
Groups with edit access to all users' documents: | Allows the user to edit all user generated documents. |
The users are created and assigned to particular groups to control access.
Once a group is created, system groups can be added to the newly created group to allow inheriting of rights that are assigned to those groups.
System Group:
Group Name | Description |
guest | Allows members to access the form from a direct URL (openform) |
login | Allows members to login to LincDoc |
User | Allows members to access LincDoc and execute an eForm |
Form Admin | Allows members to create, edit or delete and execute a document package |
Admin | Allows members to create, edit, delete, execute and create new users in LincDoc. |
To create a group:
To access secure forms in LincDoc, individual users must be created and assigned to groups with rights to access various parts of the system.
To create a new user:
You must first go to LWSA and configure a "bind" account to Active Directory. The steps are:
In order for an AD user to login, they must first be granted the "login" role. To set this up, click on the System icon (upper right) and choose User/Group Maintenance.
You can prepopulate LincDoc fields from attributes from the logged in user's Active Directory record.
In Admin / Edit / Fields/Sections, in Advanced Field Attributes, check Default Calculation to be on, then hit the "details" arrow on the right, select Edit Calculation, make sure the function icon is selected, , and then select the UserAttribute function from the drop-down. Then select the desired attribute in the new drop-down. Currently, only username, full name, or email address are available.
LincDoc 3.0 has the ability to configure and save searches. This will provide more flexibility when trying to find previously saved documents and eForms.
The search is executed at the form level and shows results for only that particular form.
The search documents window is accessed by selecting the desired form in the form selection listbox and clicking on the search icon on the LincDoc Desktop. The search window contains three components, the search definition, search criteria, and the search results table.
The search filter definition automatically defaults to Default Search. The Default Search criteria filters the search results to documents generated by the current user within the past two weeks. The result listing is not generated until the user selects the search button on the top right hand side of the window.
Search results are controlled by the listed search queries. Multiple search queries may be defined to narrow the search results. Results will be returned if they match any of your criteria (Any of the following) or if they match all of your criteria (All of the following). In the example below, two have been set: the document's user must be equal to docUser and the document must have been created or modified within the last two weeks.
Queries may be added or removed using the plus or minus buttons to the far right of the row. A query consists of a searchable field selection, a comparison operator, and optional comparison values.
String fields have the following operator options:
Date fields may use:
Each user has the ability to define custom search definitions and save them for executing at a later date. Users may update the Default Search definition or create additional definitions for each form. Once the search is defined, click on the sub arrow button to the right of the search definition drop down list to access the search option menu. Select save to store your search parameters under a new name or overwrite the selected search criteria. Selecting
will immediately remove the search definition. The option clears any search criteria currently selected. The limits the number of results that are displayed on each page of the search.Search results are displayed that match the criteria when the user clicks the Search button.
The results display table includes three system columns by default: username, last_modified, and filename. The user has the ability to change the order of these fields by dragging and dropping them to the desired location. The column's up/down arrows control the column's sort behavior. This will only effect your user session and will not impact another user.
Additional columns are made available in the configuration of the eForm or document package. Refer to the eForm Administration's Search configuration page for more information.
Depending upon the eForm's security and search settings the user may have a combination of the following options in the search results window:
Select a document in the results window and click on
to execute the form with the data from the original document pre filled in a new document's window.Select a document in the results window and click on
to open the original form for editing. Changes will be overwrite the original document's data.The retrieve button opens the selected document for viewing.
If a eForm or document package has files attached that were uploaded by the user, the files button gives the user the option to download them to the local computer.
The remove button deletes the selected documents from the system.
The selected document's field data is exported in CSV format when the user clicks on the export csv file. The exported data file is named with the eForm or document package identifier and has a file extension of .csv.
The following page gives a brief overview of the use of digital and electronic signatures in LincDoc. LincDoc has four digital signature types (or signature providers): Topaz pad signatures, LDAP signatures (authenticated), Mouse signatures, Mobile signatures, and one electronic signature type, Clickwrap. Each type of signature is outlined below but please see the individual signature type documentation for more information. Note:it is assumed that the terms final document or generated document as used below refer to a PDF generated by LincDoc.
A Topaz signature pad captures the user's handwriting/signature and converts it into an electronic format. This process creates an image and captures biometric data of the signature. When using a Topaz pad to sign documents in LincDoc, LincDoc will capture this image and biometric data and store it in the generated PDF document. The biometric data that is collected by the Topaz pad is also encrypted with the unsigned document. This means that not only can this method be used to verify that someone has signed the document, but we cal also verify that this is thedocument that they signed and that the biometric data has not been tampered with. This signature process begins after the data entry steps are complete and the user has reviewed the draft copy of the document. The following is breakdown of the steps:
This is best illustrated in an example. Sally Jones comes into the office and sits down with John Doe (assume he is an office clerk) to complete an application. The data is gathered and the document is ready to be signed.
Click here for configuration details...
An LDAP signature validates the user by challenging that user for his password when he executes an LDAP signature. Once validated, LincDoc will apply a digital signature certificate to digitally lock the document. This signature process begins after the data entry steps are complete and the user has reviewed the draft copy of the document. The following is breakdown of the steps:
Click here for configuration details...
The mouse signature applies the same process that Topaz uses but instead of using a Topaz pad, the user simply uses their mouse to draw their signature on the signature canvas. The type of signature requires the use of an HTML5 compliant browser. This excludes the use of Internet Explorer as it does not follow the industry standards that Chrome, Firefox and Safari follow. The following is breakdown of the steps:
Click here for configuration details...
Currently, LincDoc only supports iPads for use with Mobile signatures but will be coming out with support for the iPhone, and all mobile devices that support a webkit browser. This type of signature allows the user to complete a form on their iPad and have a user sign directly on the screen of that device, as illustrated above.
The user must download and install the LincDoc Mobile iPad application. Once installed and configured with an activation key, the user is able to access the forms on their LincDoc Server.
The following is breakdown of the steps:
Clickwrap signatures are electronic signatures that do not require a digital certificate or signature capture pad. Clickwrap signatures in LincDoc offer a simple method of obtaining electronic evidence of user acceptance to the data entered into a LincDoc form. The data entry question/answer process ensures a level of authentication that the user is who he/she says they are. This can be configured in LincDoc to collect any information including:
Once the user provides this information, the data is written to the document, and cannot be changed because it is written to an image format or a secured, read-only PDF document. Click here for configuration details...
LincDoc supports the use of Topaz signature pads with PDF source documents. In order to use this technology, several steps must be followed to properly configure your form, the LincDoc application and Adobe Reader. Currently we support SignatureGem and SigLite pads. For a list of Topaz products please visit click here.
Defines the type of signature. Types of signatures can be:
Defines the field value that will be used in the signature signing process. This must either be the current LincDoc user or a field in the document that will be filled out with the signer's name. For example, suppose a document has a field called "first_signer", which will be filled with the name of the person who will be signing the document. By placing first_signer into Signer name field, when the user selects sign inside the generated document, the name typed into first_signer will be used to populate the list of signature fields to sign.
When using LincDoc on mobile devices, the signature type specified in the form by the form administrator is overridden to use a method native to the mobile device. Currently, only the iPad is supported by LincDoc.
In LincDoc's administrator interface (using the standard LincDoc application), complete the following
Defines the field value that will be used in the signature signing process. This must either be the current LincDoc user or a field in the document that will be filled out with the signer's name. For example, suppose a document has a field called "first_signer", which will be filled with the name of the person who will be signing the document. By placing first_signer into Signer name field, when the user selects sign inside the generated document, the name typed into first_signer will be used to populate the list of signature fields to sign.
Note: These options only affect the ability of the PDF to be modified through Adobe Acrobat.
These are the fields that will be locked which prevents the user from changing the values after a signature has been applied to the document. Consider the following:
In this example, once the signature is applied, the fields Order_Number and Total_Price will be locked. They can no longer be edited through Adobe Acrobat. If a document is reopened in LincDoc, the signature is removed the document is no longer signed.
This must be selected for any signature field if flatten generated PDFs is checked under PDF options on the Other Options tab. If it is not, the signing process will fail and an error will be shown.
LincDoc 2.0 supports signatures with a mouse through HTML5′s canvas. This means that this signature method is available only if you use an HTML5 compliant browser.
Defines the type of signature. Types of signatures can be:
Defines the field value that will be used in the signature signing process. This must either be the current LincDoc user or a field in the document that will be filled out with the signer's name. For example, suppose a document has a field called "first_signer", which will be filled with the name of the person who will be signing the document. By placing first_signer into Signer name field, when the user selects sign inside the generated document, the name typed into first_signer will be used to populate the list of signature fields to sign.
Note: These options only affect the ability of the PDF to be modified through Adobe Acrobat.
These are the fields that will be locked which prevents the user from changing the values after a signature has been applied to the document. Consider the following:
In this example, once the signature is applied, the fields Order_Number and Total_Price will be locked. They can no longer be edited through Adobe Acrobat. If a document is reopened in LincDoc, the signature is removed the document is no longer signed.
This must be selected for any signature field if flatten generated PDFs is checked under PDF options on the Other Options tab. If it is not, the signing process will fail and an error will be shown.
Clickwrap signatures are electronic signatures that do not require a digital certificate or signature capture pad. Clickwrap signatures in LincDoc offer a simple method of obtaining electronic evidence of user acceptance to the data entered into a LincDoc form. The data entry question/answer process ensures a level of authentication that the user is who he/she says they are. This can be configured in LincDoc to collect any information including:
Once the user provides this information, the data is written to the document, and cannot be changed because it is written to an image format or a secured, read-only PDF document.
A LincDoc LDAP signature is available for all browsers without any additional equipment. This type of signature involves the signer proving their identity by providing LDAP credentials. Currently this only allows the currently logged in LincDoc user to sign, future enhancements will be made to provide both username and password to allow multiple people to sign from one LincDoc session.
Defines the type of signature. Types of signatures can be:
Defines the field value that will be used in the signature signing process. This must either be the current LincDoc user or a field in the document that will specify the signer's name.
Note: These options only affect the ability of the PDF to be modified through Adobe Acrobat.
These are the fields that will be locked from user changing the values after a signature has been applied to the document.
This must be selected for any signature field if flatten generated PDFs is checked under PDF options on the Other Options tab. If it is not, the signing process will fail and an error will be shown.
This page describes what to do if your signatures have a Validity unknown mark on them.
If signatures show as "Validity Unknown", like this:
then your PDF application does not have the proper Certificate Authority certificate.
For a certificate provided by LincWare, by clicking on the Validity Unknown button on the generated form, you will have access to a download button which will allow you to download a .fdf file. This file contains information which reduces the complexity of importing the signature certificate into Adobe Acrobat and Reader.
Open with Adobe Reader.
Click "OK".
Click "Add Contacts to List of Trusted Identities..."
Select "lincware.com" in the Contacts list.
Select "lincware.com" in the Certificates list.
Click "Trust..."
Check "Use this certificate as a trusted root"
Click "OK"
Click "Import".
Click "OK"
Close Adobe Reader.
Click on the signature. It should now look like this:
This page documents the process of adding a digital signature field to a document in Adobe Acrobat.
LincDoc database lookups are designed to read data from external databases and prepopulate data into a LincDoc form. A lookup can be configured on one or many fields to refine a search to a single or many records. To enable a lookup, a LincDoc administrator must first fully understand the data being read and the field types being prepopulated in the LincDoc form. The process starts by configuring a datasource at the LincDoc server level using the LWSA screen. Once configured, a lookup can be defined and configured on a specific field in a LincDoc form; the same lookup can also be used on multiple fields inside multiple forms.
A datasource defines the connection parameters to the database server. This database name is used to refer to the database when performing a query.
To configure a datasource:
When you select JDBC Advanced as the lookup type when creating a lookup, the lookup definition window gives you control over the query itself. Enter a description and select a data source as you would for a JDBC lookup. For help on defining the query, see below.
The query is a standard SQL SELECT statement. Each column returned by the query can be mapped to a LincDoc field.
A special property of lookup queries is that you can use field names from your LincDoc form in WHERE clauses. Field names should be bracketed with double less-than and greater-than symbols (for example <<name>>).
Some example queries will help to explain the functionality. Let's say you wanted to lookup applicant information from a permit application based on the application number entered on your form in a field called app_number. You might enter a query like the following:
SELECT applicant, app_city, app_prov, total FROM demo.permit_app WHERE app_no=<<app_number>>
You could then map applicant, app_city, app_prov and total to fields on your LincDoc form.
Let's say that the user completing the form does not know the application number and wants to choose an application from a list of HVAC permits filled out in the last 30 days. To do this, you would set the On multiple results option to Prompt to Select One and provide a query like the following:
SELECT app_no,applicant,app_city,app_prov,app_zip,hvac_fee,total,CURRENT_DATE-CAST(app_dt as date) as "age" FROM demo.permit_app where disciplines='HVAC' and (CURRENT_DATE-cast(app_dt as date))<=30 order by age
Several interesting features are being used here.
The CAST() function is a good way to make sure that the data type of the database column matches the data type of the field on the form. For example, if the app_zip column in the database is an integer field and the zip code field on your LincDoc form is a string, you could use CAST(app_zip, VARCHAR(5)) to convert the column to a string type.
Let's say that you wanted to search for records based on a partial match of a person's last name. Assuming that your LincDoc form has a field called lastname and your database table has columns called person_first, person_last and person_city, you could use a query like the following:
SELECT person_first, person_last, person_city FROM demo.job_apps WHERE LOWER(person_last) LIKE LOWER(<<lastname>>)
The first thing to notice is that we've made the search case-insensitive by using the SQL LOWER function on both the database column and the field from the LincDoc form. So a database record with the value "Smith" in the person_last column will be included in the query results regardless of whether the user types "smith", "SMITH" or "Smith" in the lastname field on the LincDoc form.
The second thing to notice is that we have allowed partial matches by using the SQL LIKE keyword. It is very important to note that using LIKE will perform exact matches unless there is at least one SQL wildcard character in the search string. So in our example above, if the user types "Smit" in the lastname field on the form, the query results will not include the record where the person_last column is "Smith". To make the partial match, the user will need to type something like "Smit%" in the lastname field. The percent sign wildcard matches multiple characters at any point in a string, so our "Smith" record would be included in the results if the user typed "s%h", "%mit%" or "%ith" in the lastname field on the form.
As a final example, let's say that your query is likely to return more than one result, but that you wanted to choose one of the results automatically rather than having the user pick from a list. You could accomplish this with a combination of an SQL ORDER BY clause and an SQL LIMIT clause, as in the following query:
SELECT app_dt,app_no,applicant,app_city,app_prov,app_zip FROM demo.app_permit WHERE disciplines=<<permit_type>> ORDER BY app_dt DESC LIMIT 1
This will cause only the first result to be returned, thus preventing a list of results from being presented to the user. In this case, the first result will be the most recent application because of the ORDER BY clause.
(Note: Older versions of Microsoft's SQL Server do not support the LIMIT clause. To get the same functionality, you would use "SELECT TOP 1 ...")
When setting up a lookup using a multivalue field, it is important to note the syntax don't include the # inside of the lookup query. Take the example. Suppose that there are three fields in a multivalue group: description, upc, and price. In the database, the fields are item_description,item_upc, and item_price. In order to do a lookup for the price based on the entered UPC, the necessary query would be:
select item_price from price_table where item_upc = <<upc>>
Normally, when working with multivalue fields, you would have done upc#. But that will not work with lookups.
The LincDoc Connector is a Java-based Windows service that allows LincDoc to write documents and data to external systems. In this documentation, Laserfiche connectivity will be discussed in detail. Other connectivity includes file share access, as well as other document management systems. The connector has an auto-update feature which communicates with your LincDoc server to retrieve the most up-to-date version for your software configuration. The high level steps to set up Laserfiche communication are:
LincDoc is based on Linux and Java. Laserfiche is based on Windows. In order for LincDoc to effectively integrate with Laserfiche, it must work with the Laserfiche Toolkit which is also based on (Windows only) COM technology.
This machine must already have the Laserfiche (thick) client installed (or more typically, it can be a Laserfiche server machine).
Note: if the LincDoc Connector configuration screen does not launch it is because a valid Java Runtime Environment is not installed.
The LincDoc Connector - Service Configuration is a small Java application which allows an administrator to start and stop the 3rd party windows service, as well as configure the LincDoc connector.
The first thing to do upon executing the configuration application is to set the URL of your LincDoc VM. Select
to determine if the URL that you have entered is correct, and that the LincDoc server is running. The next step is to ensure that the Windows Service is registered. To check this, look at the Status information. If the connector is registered, the status will be either Stopped or Running.Note: When the connector is installed, it should automatically register the service. However, if it is unregistered for any reason, simply click
to register the service with windows.The LincDoc connector has two components to its configuration, a handler and a connector. A handler defines the configuration of the local system LincDoc needs to write to. In this case, Laserfiche is the local system. The handler defines the server, path locations, and user credentials used to access the Laserfiche system. The connector defines the configuration parameters for connecting to the LincDoc system. Once both of these components are defined, the handler can be mapped to an individual connector.
Once the connector is configured, you can use LincDoc to view any sessions using the connection. Additionally, you can set up a monitor to send out an alert if the connector can no longer communicate with the external system. Both of these actions are accomplished through LincDoc's connector menu.
Attribute | Description |
Handler ID | This is unique identifier that is used by the connector; note that this id is case sensitive |
Version | The Laserfiche version (7.2 and higher is supported) |
Server | This is the Laserfiche server name (127.0.0.1 can be used if installing directly on the Laserfiche server). |
Repository | The Laserfiche repository where the documents will be stored |
Username | The Laserfiche username that will be used to write the forms |
Password | The password for the above username |
Volume | The Laserfiche volume where the documents will be written. |
LF Temp Folder | The folder location where the connector will temporarily write forms prior to moving them to the final location. This is to address any LF workflow locking issues. |
Max Connections | Maximum number of connections made from the Connector to Laserfiche |
Max Wait (sec) | Maximum number of seconds the Connector will wait for a connection to Laserfiche to free up |
Allow LincDoc to override username | This gives the connector the ability to use the username and password of the current LincDoc user |
Attribute | Description |
LincDoc URL | The URL of the LincDoc server. Note the full path location (http://<yourservername>/lincdoc) |
Client ID | The unique customer ID for your LincDoc server provided by LincWare. |
Connector ID | The unique ID for this connector - must be set for each form in LincDoc that will use this connector |
Password | The passphrase for the connector generated from inside LincDoc (from the connectors menu) |
Handler | The unique identifier create for the Laserfiche handler configuration |
Description | Description assigned to the connector that will be used for logging purposes |
Connections | The number of connections the connector will make to the LincDoc server |
Enabled | Check Enabled to enable the connector. If it is not enabled, LincDoc will report an error when trying to use the connector. |
This page describes steps to take when troubleshooting connectivity issues between LincDoc and Laserfiche. The basic goal to be accomplished is to get to a known state. Some of these steps may seem superfluous, and all are not absolutely necessary, but should guarantee getting things running again. With that in mind, these are the steps to follow (in this order):
System log files exist under c:\Program Files (x86)\LincWare\Connector\log. The service.log file captures messages when the connector service is running. You may want to open this file in notepad and look for the phrases "exception", "error", and "permission denied".
If you see this in service.log (see above), or in a warning dialog:
Error: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
it means you should stop the connector service if it is running, close the connector configurator window, and use Windows Task Manager to ensure all java.exe and javaw.exe processes are stopped (by force if necessary). Next, go in to LWSA, download the SSL .exe installer, and run that .exe:
Restart the connector service and/or the connector configurator. Similarly, if you press the test button:
And you get this warning:
It means you must follow the same steps noted above to run the .exe.
You have the ability to change the LincDoc user interface images to your own branding. There are three main images that can be changed. The logo on the LincDoc Desktop and the two images in the data entry interface.
Use the following steps to change the data entry images to a custom image (.jpg, .gif, or .png) for each form.
You have the ability to provide a long description for a section or field. LincDoc provides you with a WYSIWYG editor to give you real time feedback while creating this description. Once the description is to your liking, save and test.
You may control the width of the section's long description and its border. The setting for this is found on the eForm tab in the Data entry customization section. Select the arrow submenu button and set the width in pixels and add an optional border.
You can create automated help screens to assist a user in better understanding the purpose or intent of a specific field. To enable context sensitive help, simply add the help language or explanation to the Field help: attribute. This attribute can be found by clicking the advanced checkbox at the top of the Field attributes: window. When this attribute is active, LincDoc will display a help icon to the right of the field in the User interface. LincDoc will then display that text in a help window when the user clicks the icon. This display of the text can be controlled using our WYSIWYG editor.
You can also control the width and border of your Field help window. These settings are accessible in the eForm tab's Data entry customization section:
The final output looks like this:
Overview
There are three points of consideration when creating an eForm that is intended for mobile deployment.
Documents produced on the iPad may have a source type of Word or PDF. However, if the document source is Word, the iPad user will be unable to view the generated document. PDFs do not have that limitation.
Consider that mobile users will be working in either online or offline environments. If they are offline, they will not have access to database lookups. To set up the eForm for online mobile lookups:
Mobile signatures are used with iPad documents. Please refer to Mobile signatures for more information.
A number of options are available for controlling the behavior of your mobile devices. The
menu is accessed from the system menu.Setting | Description |
Enable auto-login |
Auto login bypasses user authentication once the user initially logs into the app. Credentials are stored and used for subsequent server access. |
Disable logout when switching away from app |
If selected, the user will not be prompted to re-authenticate when the app loses focus. |
Disable e-mail on document viewer |
If selected, user will not have the email option on the document viewer's toolbar. |
Disable automatic radio buttons for combos |
If selected, combo lists will not be automatically converted to individual checkboxes on the iPad |
Background image |
Upload a background image to use as the app's workspace. |
For special version installations, the app may be downloaded and installed from the lincware server. Prior to downloading, the UUID of the iPad device must be sent to lincdoc support. Once the UUID has been registered, follow the installation steps below.
Note: Deleting the LincDoc app will delete all data associated with LincDoc (all documents, folders, settings, etc.).
Whenever you open the LincDoc app you will be prompted to log in.
eForm definitions are locally stored on your iPad to allow you to work offline. These definitions are automatically downloaded to your device the first time you log into a new client site. The updating forms window will appear with a download status bar. Wait for it to complete and tap the OK button.
After logging in, you are presented with the iPad workspace. Placed at the top of the workspace is the LincDoc toolbar. Here is where you will access forms, update and sync your documents, and configure your mobile client.
The forms button is your access point to all eForms that have been downloaded to your iPad. Here you can run a new eForm, organize your eForm definitions, and search for previously completed documents. See the Forms page for more information.
The update button connects to your LincDoc server and downloads all eForm definitions to bring them up to date. It also refreshes server configuration settings that control security. See offline settings for more information. Tap the button and tap Yes when you are prompted with the Update forms from the server? confirmation message. The updating forms window will appear with a download status bar. Wait for it to complete and tap the OK button.
The sync button uploads all of your completed documents to your LincDoc server for further processing.
The options button lets you view program information, change settings, and log out.
The Program Information tab summarizes the current state of your mobile client. The UserName, Host, and ClientID display the current connection parameters are in use. Build reports your LincDoc mobile version number. Forms is a total of your downloaded eForm definitions. Saved Docs is a total of all locally saved documents that have yet to be uploaded to the server.
The wallpaper option lists standard backgrounds that you can pick to customize the look of your LincDoc workspace.
To change your LincDoc password, select the Change Password option. Enter your current password, and your new password (twice for confirmation of entry) and select the Save button.
The log out option logs you out of your mobile client and presents you with the log in screen.
If you wish, you can completely close the app by clicking the Home button to return you to the home screen. Click the Home button twice and a list of your running apps will appear at the bottom of the screen. Tap and hold on the LincDoc icon until a red minus sign appears on its top left corner. Tap on the minus sign to close the app.
The help button accesses the online help screens.
The Forms tab is your access point to run an eForm, open and edit previously created documents, or search for documents on your iPad or the LincDoc server.
The forms screen is the heart of LincDoc mobile. From here you can manage and run your forms, search for information, and view, edit, sync, and delete saved documents.
All Forms lists the form definitions that are available on your iPad.
You may organize your forms into folders. For installations that include pages of forms, folders allow you to easily locate the forms you need.
Creating a folder
Forms are moved into folders by tapping on the Form and holding your selection until it turns grey. Then, drag your selection into your folder or move it to a new place in the list. To move the form out of the folder, tap on the form name and quickly swipe left.
Editing a folder
Deleting a folder
This is where you can search for forms and saved documents.
A list of all of your forms, with the ones you use most often at the top.
To run an eForm or create a new document, simply open the Forms tab, navigate to the form listing and tap to open. The form opens in a new document page for your completion.
The iPad form layout is optimized to make data entry quick and efficient. There are a number of field types that aid you in entering data.
In the example on the right, an expense report form is being entered. There is a lookup action available for the Payee Name field. Tap on the Payee Name field to enter the name and then tap on the lookup icon to retrieve the payee details. If found, contact fields will be auto-completed. Date fields may be typed in manually or selected using the calendar widget. Multiple entries, such as the expense items, are created by tapping the green plus icon at the end of each row. Tap the red minus icon to delete the expense row. The image button allows you to attach supporting image entries to your expense item.
Note: If a field's background turns yellow, your entry is not valid. Please correct the entry before saving the form.
The form's cancel button will close the form without saving your data. The finish button will save the document and open it in the document viewer.
Note: The document will save in an incomplete state if you switch to another iPad app or close the LincDoc app without tapping the Finish button.
When you finish a document entry, the document will automatically open in the document viewer. In the document viewer you may close, sync, sign, view attachments, and email the document.
Tap on the
button to upload your document to the server and close the viewer.Document signatures are entered at the point of viewing the completed document. When the form has a signature field, the document viewer will have a pen option button on the bottom toolbar.
To sign a document:
Document attachments are listed when you tap the camera button. Tap on the attachment entry in the list to open it for viewing.
Tapping on the email button will open an email message with the document embedded as an image.
Documents that have not been uploaded to the server are stored on your iPad. These are called Saved Documents. Saved Documents may be viewed, edited, or synced to the server.
Saved documents are accessed and grouped by their form listing.
Depending on a document's state, you have the option to View, Edit, Delete, or Sync your local document.
LincWare is dedicated to providing its customers with the most efficient and affordable pathway to benefiting from our products. Each LincDoc solution is designed around ease of use, exceptional cost-to-benefit value and rock-solid architecture.
Backing those product principles is a knowledgeable, 24/7 web based technical support structure dedicated to solving any issue that arises in as little time as possible. In fact, one call is typically all it takes.
If a support ticket needs to be opened, the entire process is monitored by upper management through a series of automated ticket reports. If it any time your problem is not solved to your satisfaction, the chain of command is readily available to address it.
As always, do not hesitate to contact support@lincware.com.
LincWare has the ability to quickly and easily troubleshoot any issues you may have by communicating with your local LincDoc VM through our LincWare Management Server (LMS). This server allows LincWare technical support personnel to remote in and review trouble logs, assess the state of the VM, and make any appropriate adjustments. This allows LincWare and the LincWare reseller community to be proactive, instead of reactive when any issues arise. To enable communication to the LMS the LincDoc administrator must turn on the LincWare remote administration service on the LincWare System Administration (LWSA) screen. This page can be found at https://<lincdoc-server>>/lwsa/.