Rival Help CenterWorkflow

Form elements (in-depth)

Acknowledgment

This element requires the link it displays to be clicked prior to the Form being completed. The intent with this element is that a Form could be designed that requires an employee to open multiple policy documents and they can sign off on having received them on one Form.

If you are planning to host the documents you are linking to outside the system, they should be available without requiring authentication. The Form cannot determine if any authentication was successful when the link is clicked.

Edit mode

When the acknowledgment element is first dragged onto the Form, red warning triangle icon indicates that the properties must be set. Click it or edit the properties to set the URL and link text (see below).

A form builder acknowledgment element reading Add the URL that must be reviewed, with red warning icons

Once the properties are set, the acknowledgment element displays the link text.

A Beneficiary Acknowledgement element in the form builder, with a checkbox and a gear icon

Display mode

When displayed to the user, it is indicated as required. When designing your Form, use a static text field to explain you are expecting the employee to click on each document.

A Beneficiary Acknowledgement checkbox with a Required information is missing error

After the link is clicked, the document opens in a new window and there is a green check box next to the link text.

A Beneficiary Acknowledgement checkbox that is checked

After the link is clicked, the date time is stored in the field, which can be retrieved with the Form data (GetFormXML). Date time format is YYYY-MM-DDTHH:MM:SS.sssZ. All times are stored in UTC (as indicated by the Z time zone).

Example: 2016-10-25T15:25:48.527Z

Properties

In addition to field name and help text, the acknowledgment includes the following properties:

PropertyDescription
URL to view (required)

This is the path to the document. This path opens in a new browser window or tab.

  • Browse button opens the location within the system that contains documents.
  • Clear button clears the URL.
  • Upload button uploads a new document. (Old documents are not replaced so make sure your documents have unique names.) These document types are supported: pdf, doc, and docx.
Link Text (required)Text that is displayed to the user who is filling out the Form. The user clicks on any of this text to open the linked location.
Append to PDF

When checked, acknowledged PDF is added to the end of the printed or downloaded Form.

Tip: This feature is only available for acknowledgment fields that contain pdfs; no other formats are included with the printed or downloaded document.

Date and time stampDate and time an acknowledgment link is initially checked. Turn it on by selecting (checking) the Show date and time viewed check box.

Address Block – US and CA

The Address block elements allow a United States or Canadian address to be presented in a familiar layout, which is not possible with individual text and selection fields. The difference between the US and Canadian blocks are:

  • Field labels
    • State vs Province
    • Zip vs Postal
  • Selection field values for states vs provinces
    • The state selection field is populated from the FormBuilder_address_states list.
    • The province selection field is populated from the FormBuilder_address_provinces list.
  • Validation of Zip vs postal codes

Edit mode

The text on the address block elements can be edited by clicking the text and typing.

Two address blocks in the form builder, Address Block - US and Address Block - CA, with address, city and region fields

Display mode

When displayed, it is indicated as required.

The form as the employee sees it, with the Address Block - US and Address Block - CA fields

Properties

In addition to the field name and help text, the address blocks include the following properties:

PropertyDescription
RequiredThis sets following fields to be required Address Line 1, City, State/Province, and Zip/Postal Code.
DefaultEach of the fields within the block can have its default set individually.

Banner

Every Form requires a banner. The banner contains Form title and a logo, which appears at the top of the page when the Form is displayed. The banner name defaults to the Form name. You can modify it without affecting the Form name.

Edit mode

You can edit banner text by clicking text and typing. You can use bold, italicize, underline, and change font size.

A form builder element with the SilkRoad logo and the text Beneficiaries Form, with text formatting buttons above

Display mode

A form header showing the SilkRoad logo and the text Beneficiaries Form

Properties

PropertyDescription
Field nameSystem-generated field name
Image

The path where the image is stored.

  • Browse: Displays the logos that have been uploaded on the Logos tab of the settings page.
  • Clear: Removes the current image.
Image PositionControls where the logo is displayed. Options: Left, Center, Right.
Form Name PositionControls where the form name is displayed. Options: Left, Center, Right. The image and name should not be in the same position

Date Field

Date field element is used for collecting dates.

Edit mode

Edit the Date Field prompt by selecting text and typing.

A Date Field element in the form builder with a date input and a calendar icon

Display mode

Date Field includes a calendar icon that opens a date picker.

A Date Field input with a calendar icon beside it

A Date Field with a calendar date picker open, showing July 2015 and Today and Clear buttons

Properties

In addition to the field name, required, date format, and help text the date field includes the following properties:

PropertyDescription
DefaultList of fields that can be used to default a date field are limited to date fields on the Employee Profile.
ValidationList of available validation functions are limited to the functions that recognize dates

Electronic Signature

The element provides options for how employees can sign Forms. When included on a Form, an electronic signature is required before an employee can save and complete the Form.

Properties

In addition to the field name and date format, the electronic signature includes the following properties:

PropertyDescription
Allow ‘wet’ signatureA wet signature is when an employee signs a paper form with a pen. This is what is traditionally considered a signature. To use this signature type, your employee needs access to a printer. Wet signature is selected by default.
Allow Cursor SignA cursor signature is when an employee uses the cursor and mouse to draw a signature on the page. This method captures an image of the employee signature, which is stored with the Form.
Allow Keyboard SignA keyboard signature is when an employee types in their name to sign the Form.
Allow PDF Sign Service

Uses a third-party signing solution for the electronic signature. Options:

  • No: A third-party signing solution is not used.
  • Electronic signature: A Sign & Sign button appears on the Form. After a user clicks it, signing happens using the third-party signing solution.
  • Digital signature: The Form is sent to a third-party signature provider with instructions to apply a digital signature to the Form document.

Tip: If you select the Allow PDF Sign Service option, it is recommended that you do not select any of the other three signing options: wet signature, cursor sign, and keyboard sign.

Force Login when signingCheck to require a user signing the form to re-authenticate (or login) when initiating the signing process. (For clients using Rival Authentication.)
Check Validity on Reopen

Checks the validity of the employee's printed name when the task/Form is reopened.

Example: When an employee completes a Form and enters their printed name, it is stored on the Form when, where, and how they signed it. If the employee's profile name changes (say from Mary Smith to Mary Smith-Jones), the employer may opt to reopen that task/Form to capture the name change. Upon reopening the task, the employee receives an alert and must re-sign the Form.

Keyboard Verification (required)

Select the name that you want to use to verify the electronic signature when an employee signs by typing in their name.

  • Formatted Account Name: Uses the First, Middle and Last names from the user account, of the logged in employee, formatted based on the setting for displaying names in your system. See Configure Settings Employees page.
  • Employee – Full Legal Name: If a field on the employee profile is named "Full_Name" exists it can be used to verify the benefiter’s name.
  • Blank can also be selected to not verify the name that is typed in against any existing value.

Footer

The footer contains information such as when the form was updated, internal identifier of forms printed, and so on. It appears at the bottom of each printed page.

Edit mode

Click footer text to edit it and type over the text.

An editable form title field reading Form Bene-2015 in the form builder

Display mode

The footer appears above the buttons.

The bottom of a form with Close, Delete and Save & Complete Later buttons and a Powered by SilkRoad logo

Properties

PropertyDescription
Field nameSystem-generated field name
Form Name PositionControls where the form name is displayed. Options: Left, Center, Right

Full Name

This element allows a name to be horizontal, which is not possible with individual text fields. In addition to a field for first, middle, and last names, a salutation and suffix selection field can be added to the display.

Edit mode

Click text and type to edit the element.

Two name elements in the form builder: Basic Full Name and Full Name with all fields

Display mode

The full name is required by default. Red bars appear beside required fields.

The two name fields on the form, each showing a Required information is missing error

Properties

PropertyDescription
Field nameSystem-generated field name
RequiredSets the first and last name fields to be required. (You cannot require the middle name, salutation or suffix.)
Show Salutation

When checked, salutation selection is displayed.

Tip: The selection field is populated from the "FormBuilder_fullname_prefix" list.

Show Suffix

When checked, the suffix selection is displayed.

Tip: The selection field is populated from the "FormBuilder_fullname_prefix" list.

Help TextHelp text to describe this element.
Default

The first, middle and last name in the Details section of an employee account is used to default the correct field of the full name. The only options for defaulting the full name field are:

  • Benefiter: The employee going through the event.
  • Event Coordinator: The employee who is overseeing the event.
EncryptEncrypts the data when the Form is saved. Encryption translates data into another form, or code, so that the data is protected.

Section

The selection element is used to visually breakup the Form and for controlling who can fill out the fields within it.

Edit mode

Edit text by clicking the text and typing. (Can do this on section title and body text.)

The form builder with Section Title, Static Text, Text Input and Date Field elements

Editing fields within a section (indented) can be controlled by the properties of the section.

Display mode

Section title is in a light gray bar. All the fields within that section are indented to show they are part of that section.

The form with a Section Title, Static Text, Text Input, Date Field and Selection fields

Properties

In addition to the field name, the section includes the following property:

PropertyDescription
Permissions

Controls who can edit fields within that section on the Form. Options are:

  • Everyone / [Blank]: There is no specific control of the fields within this section; this has the same effect as if the fields were not within a section.
  • Benefiter: Only the employee going through the event can edit the fields within the section.
  • Assignee: Only the employee who is assigned the task, but not the benefiter, can edit fields within the section.

Selection

The Selection field presents a limited set of values to be selected. Lists used for this element are managed from the Lists tab of the Forms Administration page.

Edit mode

When a selection field is first placed on the Form, no list is associated with it and one must be selected. You'll see this message:

A Selection element with red warning icons and a message to choose a list for the selection

Click red warning triangle icon or edit properties to select the list.

Once the properties have been set, the selection element displays the list in either a drop-down, radio buttons, or check boxes.

Form builder elements for Drop Down, Radio button, Check Box and Type and Search selections

Display mode

When displayed, a user can pick from the selection list.

The form with drop-down, radio button, check box and type-and-search selections, with matching suggestions listed

Properties

In addition to the field name, required, and help text, the selection includes the following properties:

PropertyDescription
Option Type (required)

How options are presented:

  • Drop-down (default): Only one value can be selected from a list.
  • Radio Buttons: Only one value can be selected, but all are displayed.
  • Check boxes: Many options can be selected and all are displayed
  • Type and search: Easy way to limit search results. As you type, the search checks the beginning of each word in the description including text following dashes (-) and underscores (_). The top 10 results are displayed. Only one value can be selected. (This option is also known as type ahead search.)
Value List (required)List of values presented on the Form. Options in this list are managed from the Lists tab of the Forms Administration page.
Default

When using a default with a selection field, the value is only selected if it appears in the list that is being used for options of the selection field. For the most reliable pre-population of default values for a selection element, use the same list for the selection element and the source field for the default values.

Example: A selection field for relationship includes options for spouse, child and parent. The field providing the default contains sibling. No value is selected when the Form is opened because the selection element list does not include sibling.

Static Text

This element allows the entry of a large block of text that can be formatted for display on the Form. When you click within the element's text area, a tool bar appears with formatting options.

Edit mode

As text is entered, the element expands to accommodate the text that is entered.

A rich text element in the form builder with a formatting toolbar and sample bold, italic and linked text

Text can be formatted using toolbar options. Links can be added/removed. Spell Check is available.

Text can be pasted from other applications; however, formatting that is not consistent with what is allowed in the editor may be removed.

Display mode

The form showing bold text, italic text and a link as the employee sees them

Properties

This element only has the field name property.

Text Input

This element is for collecting text input. It can be text or numerical data.

Edit mode

Edit by selecting text and typing.

A Text Input element in the form builder with an editable title and an empty input box

Display mode

A Text Input field with an empty box as shown on the form

Properties

In addition to the field name, required, default, validation and help text, this field includes the following properties:

PropertyDescription
RowsNumber of text rows allowed
ColumnsWidth of the text field (as it displays)
Max LengthMaximum number of characters allowed
Hidden

Controls if a field displays on the Form when an employee fills it out.

A hidden field cannot be required or have validation.

Example: A hidden field is useful when it is defaulted with an employee identifier like Employee ID or SSO ID. Field is delivered with the Form data to an integration that collects the data.

Read OnlyCannot be edited by any user who opens the Form no matter the permissions of the section that the field appears in. Sections that are set as read only prevent any user who opens the Form from editing any of the fields in that section.
Place Holder TextPlace holder text displays in light gray until user enters text.
Input MaskControls of format of text entered into the field as text is typed. Can also be used to restrict the types of characters that can be entered.