Bridge User Guide - Document Configuration

Bridge
User Guide - Document Configuration
Version 2.4.77

Version 2.4.77Bridge User GuideUser Guide - Document Configuration

Table of Contents

Introduction

Guide

Setting Up the Oceanwide Word Ribbon

System Requirements

Installing the Oceanwide Word Ribbon

Populating the Oceanwide Word Ribbon

Inserting Placeholders Into Document Templates

Inserting Placeholders

Using the Workflow Explorer

Using the Lookup Lists

Document Structure

Inserting Form Fields

Inserting Grid Fields using Repeater Structures

Repeaters Within Tables

Repeaters Within Text

Special Formatting

Applying Number, Date, and Time Formats

Configuring Digital Signatures

Triggers

Using Triggers Within Normal Content

Using Triggers Within Repeater Structures

Index

Version 2.4.77Bridge User GuideUser Guide - Document Configuration

Introduction

Welcome to the Bridge insurance access portal. The system provides a full workflow, from the administration of products and coverage, to the submission and management of individual policies.

Access to all features, options, and data are controlled by the settings in your user account. This guide is for users with product management rights, covering the creation of templates for generating dynamic documents within the Bridge system.

This guide assumes the user is familiar with the general functions of the system. For instructions on logging in and using common features throughout the system, see the User Guide - Introduction document.

Guide

Click a link to jump to the appropriate section.

Setting Up the Oceanwide Word Ribbon / Installation of the Word Ribbon plug-in, and importing the Bridge data for use in documents.
Inserting Placeholders Into Document Templates / Finding and inserting placeholders from the Word Ribbon.
Document Structure / How to structure a document using placeholders and repeater structures.
Triggers / Using triggers to create conditional text.

Version 2.4.77Bridge User GuideUser Guide - Document Configuration

Setting Up the Oceanwide Word Ribbon

The Oceanwide Word Ribbon is a plug-in for Microsoft Word. Once installed and configured, it can be used to insert placeholders into documents that will be uploaded to the Bridge system as templates. When generating documents within Bridge, these placeholders are replaced with live data from the workflow or system information.

System Requirements

In order to use the Oceanwide Word Ribbon for Bridge you will need to have MS Word 2010 or later installed on your computer.

Installing the Oceanwide Word Ribbon

Before you can begin you will need to install the latest release of Oceanwide’s Word Ribbon plug-in for MS Word.

/ Warning: If a previous release of the Oceanwide Word Ribbon is already installed on your computer you will need to uninstall it before installing the latest release.

To remove a currently installed version of the Oceanwide Word Ribbon:

Navigate to your computer’s Control Panel.

Select Add/Remove Programs or Programs and Features (Windows 7 and 8).

Locate the item Oceanwide Word Ribbon and either double click it, or right click and select uninstall, to remove the plug-in.

After any previous versions have been removed you are ready to install the latest release of the Oceanwide Word Ribbon.

The Word Ribbon installer is generally distributed as a Zip file. Contact your Oceanwide Representative for instructions on obtaining the latest installer.

Unzip the files to a folder on your computer. This will include the Setup.exe file and any supporting files.

Run the Setup.exe file to begin installation. Follow the on-screen instructions to complete the installation.

After installation is complete, the Oceanwide tab should be available in Word. It may be necessary to close and restart Word to load the plug-in.

Before the Word Ribbon can be used, the Bridge workflow data must be loaded. See Populating the Oceanwide Word Ribbon.

/ Notes:
The installation must be performed using an administrator account on the computer. If you have difficulties with the installation, please contact your local IT department for assistance.
The installation must be performed manually. The Word Ribbon cannot be installed by scripting or other automated processes.

Populating the Oceanwide Word Ribbon

Once you have the Oceanwide Word Ribbon installed, you will need to populate it with the field and system data from Bridge.

In the main menu, Select Product Design, then Export/Import. The Export / Import page opens.

Click Download in the Download Word Ribbon panel. A standard Save/Open dialogue box appears.

Save the XML file to a location on your computer where you can easily find it again later.

/ Tip: This one file contains all available workflows within the Bridge system, so it is not necessary to download multiple versions. However, if any changes are made to any of the workflows, the changes will not be available in the Word Ribbon until a new file is downloaded and imported.

Return to MS Word and select the Oceanwide tab.

In the Workflow File group, click Select Workflow File to open a standard file selection window.

Locate and select the XML file saved in step 4. Click Open. The Word Ribbon updates with the downloaded workflow details.

Version 2.4.77Bridge User GuideUser Guide - Document Configuration

Inserting Placeholders Into Document Templates

This section describes how to insert placeholders into a document template using the Oceanwide Word Ribbon. Once the template is uploaded to the Bridge system, generating a document using the template will replace all placeholders with live data from the system.

Four types of data can be pulled in from the Bridge system.

Dynamic fields in panels: These are the normal fields in the submission workflow, where data is entered or selected once. These are inserted as standalone placeholders to pull in the data from the associated field.

Dynamic fields in grids: These are the fields in the submission workflow that are arranged in grids, allowing multiple entries for each field. These are inserted within "Repeater" structures that repeat the content and placeholders for each entry in the grid.

System and Transaction data: This includes system data such as the current time and date (at the time the document was generated) and transaction data such as policy details, information about the companies attached to the transaction (insurer, distributor, and client), and calculated premiums.

Triggers: Triggers are conditional controls defined within Bridge. They are used throughout the Bridge system to control data and options, and can be used in templates to define if blocks of text will be included or excluded when the document is generated.

For a complete list of system variables that can be used in documents, e-mails, and calculated fields, see Appendix B in the Bridge User Guide - Calculated Fields.

Inserting Placeholders

The Word Ribbon provides two methods of finding and inserting placeholders, the Workflow Explorer and the Lookup lists.

Using the Workflow Explorer

The Workflow Explorer is a pop-up window containing all available placeholders for fields, system data, repeater structures, and triggers, organized in a tree structure. The window can be resized and moved outside of the document window for easy access.

In the Workflow group, open the dropdown list and select the appropriate workflow.

/ Note: It is not recommended to mix fields from different workflows in one document. A generated document can only access data from the workflow where it is generated, and unrecognized placeholders will not be replaced.

In the Workflow Explorer group, click View. The Workflow Explorer window opens. If you lose track of the window, it can be found in the windows list or click View again to reset the window.

In the document window, place the cursor at the point where the placeholder should be inserted.

In the Workflow Explorer window, the top level includes groups for each panel in the selected workflow, plus standard groups for system information and triggers. Click the plus icon or double-click the title to expand the group.

Double-click the placeholder. The placeholder is inserted into the document, displayed as the name of the selected field enclosed in double chevrons.

The placeholder can be formatted using any standard formatting options within Word, and that formatting will be applied to the data that is pulled in during document generation.

/ Note: Placeholders can be copied and pasted, but trying to edit the placeholder manually could cause errors. To change a placeholder, it is best to delete the existing one and insert a new one. The exception is when editing trigger placeholders, detailed here.

Using the Lookup Lists

The Field Lookup and Trigger Lookup groups provide placeholder lists that can be filtered and searched. The Field Lookup group contains all available placeholders for workflow and system data, while the Trigger Lookup group contains all available triggers.

In the Workflow group, open the dropdown list and select the appropriate workflow.

In the document window, place the cursor at the point where the placeholder should be inserted.

In either the Field Lookup or Trigger Lookup group, click the down arrow in the dropdown list to view the available placeholders. Each option displays the name of the field followed by the related panel or system group.

If more than 1,000 placeholders exist, the list will appear empty and must be filtered to reduce the number of available placeholders to less than 1,000.

To apply or change the filter:

a)Enter one or more characters in the lookup field. If any placeholder in the list starts with the entered text, the first matching name will be filled in as a suggestion. Hit Delete to remove the suggested text.

b)Hit Enter to apply the filter. If the list was already open, it will close as the new filter is applied.

/ Note: If a matching placeholder name was suggested and the suggested portion of the text was not deleted, hitting Enter or trying to open the list will insert the suggested placeholder into the document instead of applying the filter.

c)Click the down arrow to open the filtered list. All placeholders that contain the filter text anywhere within them, including in the related panel or system group name, will be listed.

/ Tip: Once the filter has been applied, it cannot be removed. However, changing the filter text to a single space will display all available placeholders, as each option includes at least one space.

Once the lookup list is open and displaying a range of placeholders, with or without a filter applied, the content can be searched.

Begin typing in the lookup field. As text is entered, the list will jump to the first placeholder that begins with that text, and that placeholder will be displayed in the lookup field.

Once the necessary placeholder has been found, hitting Enter will select the highlighted placeholder, or a different placeholder in the list can be selected using the arrow keys or mouse. The placeholder is inserted into the document, displayed as the name of the selected field enclosed in double chevrons.

/ Note: To insert the same placeholder multiple times in a row, it may be necessary to refresh the filter. Deleting the last character (the closing bracket of the group or panel name) and hitting Enter will achieve this.

The placeholder can be formatted using any standard formatting options within Word, and that formatting will be applied to the data that is pulled in during document generation.

Version 2.4.77Bridge User GuideUser Guide - Document Configuration

Document Structure

This section covers how to structure text around placeholders for both standard form fields and repeater structures for grid data.

Inserting Form Fields

Using form fields is very straightforward. While entering text, position the cursor and insert the placeholder. See the section on Inserting Placeholders Into Document Templates for instructions on finding and inserting placeholders.

When the document is generated, the data being pulled in replaces the placeholder exactly. No extra spaces will be added, so the necessary spaces should be included in the template text, particularly when using multiple placeholders one after the other.

/ Example:
If the template includes the sentence "Contact <firstname<lastname> for details.", the generated document would contain the following:
Contact JohnSmith for details.
With the text "Contact <firstname> <lastname> for details.", the text would appear properly:
Contact John Smith for details.

Version 2.4.77Bridge User GuideUser Guide - Document Configuration

Inserting Grid Fields using Repeater Structures

If a placeholder for a grid field is inserted in normal text without the repeater structure, it will be replaced with the data from the first entry in the grid, and all other entries will be ignored.

To display multiple entries from a grid, the placeholders and any surrounding text must be enclosed in a repeater structure. This will display all enclosed text and placeholder data for the first entry, then repeat the content again using placeholder data from the second entry, and so on.

Triggers can be applied within the repeater structure to determine if each entry in the grid should be included in the output or left out. See the section on Using Triggers Within Repeater Structures for instructions.

In the Word Ribbon, each panel that contains grid data also includes Table Start and Table End placeholders.

Insert the Table Start and Table End placeholders to mark the beginning and end of the repeater structure. All content between the two placeholders will be repeated for each valid entry in the grid.

/ Note: The start and end placeholders, as well as any grid field placeholders, must be from the same panel or group. Form field placeholders can be used within a repeater structure, although they will pull in the same data for each repetition.

Repeater structures are commonly created as tables to present the data in a grid structure, however the data can also be presented in standard text. Both approaches are described in the following sections.

Repeaters Within Tables

To build a repeater table, create a table with one row for data plus any additional rows for headers or footers.

Insert the Table Start placeholder in the first column of the data row, immediately followed by any text or placeholders for that column.

Add any required text or placeholders to the remaining columns.

In the last column, insert the Table End placeholder immediately after the content.

/ Example: A table is built with columns for each type of premium data available in the Premium Information group. The appropriate placeholders are inserted in each column, and color coded.
The Table Start and Table End placeholders are inserted before the content of the first column, and after the content of the last column.
When the document is generated, the placeholders are replaced with the premium data one row at a time.

Repeaters Within Text

Using repeater structures within normal text is fairly straightforward. Insert the Table Start and Table End placeholders in the text, then insert text and placeholders in-between.

/ Example: A placeholder for each type of premium data available in the Premium Information group is entered on a separate line.
The Table Start and Table End placeholders are inserted before and after the content.
When the document is generated, the placeholders are replaced with the premium data one row at a time, as shown to the right.
Note: All content within the start and end placeholders will be repeated, including hidden formatting characters such as tabs and line breaks . In the example above, a line break is placed before the Table End placeholder, but not after the Table Start placeholder. This causes one blank line to be included with each group of premium details.
To view the formatting characters, click the Show/Hide iconin the Word toolbar.

All special characters will be displayed, allowing you to verify the position of the line breaks (¶).

Version 2.4.77Bridge User GuideUser Guide - Document Configuration