66
TIBCO Formvine™ Customization Guide Software Release 2.0.5 June 2011

Tib Formvine Customize Guide

Embed Size (px)

Citation preview

Page 1: Tib Formvine Customize Guide

TIBCO Formvine™

Customization GuideSoftware Release 2.0.5June 2011

Page 2: Tib Formvine Customize Guide

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN LICENSE.PDF) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.TIB, TIBCO, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO ActiveMatrix BusinessWorks, and Formvine are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only.THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.Copyright © 1999-2011 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information

Page 3: Tib Formvine Customize Guide

Contents | iii

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Chapter 1 Customizing your Formvine implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Who does the work? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Thinking about your implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4What is your use case for Formvine? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Who can create projects?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Who can fill out forms? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Security issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Legal considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

How do you want to brand your installation? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Content and communication "voice" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Gathering requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapter 2 Implementation strategies and choices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Brand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Launch page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Questions to ask about the Formvine launch page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Formvine Author Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Formvine header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Formvine footer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Questions to ask about the Formvine Author Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Forms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Visual style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Confirmation page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Thank You page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25What can the project owner do? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

TIBCO Formvine™ Customization Guide

Page 4: Tib Formvine Customize Guide

iv | Contents

Questions to ask about Formvine forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Recommendations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Emails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Registration emails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Notification emails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32System emails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35What can the project owner do? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Questions to ask about emails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Recommendations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Appendix A Customization checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Appendix B Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Anatomy of a compound control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Questions to ask about controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Appendix C Email text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Registration emails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Notification emails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

System emails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

TIBCO Formvine™ Customization Guide

Page 5: Tib Formvine Customize Guide

Preface | v

Preface

This document is for project managers in charge of implementing TIBCO Formvine™. It contains a roadmap to guide your configuration decisions and is written with the assumption you have already read the Understanding TIBCO Formvine™ guide.

This guide details the requirements and assets you will need to customize Formvine™ for your implementation. Keeping your specific uses for Formvine in mind as you read this document will help you make customization decisions, including who will be authorized to create and manage projects, will be able to fill out forms, what type of messaging you want to convey in Formvine communications, and how your company’s legal polices might impact the application.

By the end of this document, you will have everything you need to install and implement a version of Formvine tailored to your use case, including a convenient summary checklist to use during installation.

Topics

• Related Documentation, page vi

• Typographical Conventions, page vii

For the latest version of this document, go to http://www.formvine.com/docs

TIBCO Formvine™ Customization Guide

Page 6: Tib Formvine Customize Guide

vi | Related Documentation

Related Documentation

See the following sources for additional information about Formvine:

• For concepts and an overview of the Formvine framework, see Understanding TIBCO Formvine™, available on the Formvine Documents page at: http://www.formvine.com/docs

• For instructions to the developer who will be implementing the customizations, see the TIBCO Formvine™ Implementation Notes document, also available on the Formvine Documents page.

• For installation information, see the TIBCO Formvine™ Installation and Configuration Guide on the Formvine Documents page.

• For general information and documentation on using Formvine, go to the Resource Center at http://www.formvine.com. This site hosts:

— Forums, where the people in your enterprise who create and manage projects (project owners) can ask questions and get ideas and answers from others. The Forum also hosts the Speak Geek forum for the tech-savvy folks in your company.

— Blog, where members of the Formvine team write about the product and form building in general. Project owners can add comments to join in the conversation.

— How-tos, with tips and procedures on creating projects.

— FAQs that answer questions about Formvine.

— Quick Start guide to help your project owners get started with Formvine.

TIBCO Formvine™ Customization Guide

Page 7: Tib Formvine Customize Guide

Preface | vii

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General typographical conventions

Convention Use

New term The first time a new term is introduced, it is in italic, bold font.

Information that is of special interest or importance, for example, an additional action required only in certain circumstances.

An idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result.

Potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.

TIBCO Formvine™ Customization Guide

Page 8: Tib Formvine Customize Guide

viii | Typographical Conventions

TIBCO Formvine™ Customization Guide

Page 9: Tib Formvine Customize Guide

Customizing your Formvine implementation | 1

Chapter 1 Customizing your Formvine implementation

You can customize your TIBCO Formvine™ implementation in a variety of ways, from branding to voice. What you choose to customize depends on your use case. This chapter introduces you to the customization process.

Topics

• Definitions, page 2

• Who does the work?, page 3

• Thinking about your implementation, page 4

• How do you want to brand your installation?, page 8

• Content and communication "voice", page 9

• Gathering requirements, page 10

TIBCO Formvine™ Customization Guide

Page 10: Tib Formvine Customize Guide

2 | Chapter 1 Customizing your Formvine implementation

Definitions

The following are important definitions to know for this document:

• Project owners are the people who create and deploy Formvine projects. There can be multiple project owners associated with one project, all with the same rights to change and see the project and data as the others.

• Participants are the people who fill out the forms that project owners create. Participants may be known by the system or they may be anonymous according to a setting established by the project owner.

• The Formvine Author Tool is where project owners create projects, design forms and manage results.

• Formvine Forms are opened by participants in a web browser to submit the information required by the form.

• The Formvine Resource Center is a website run by TIBCO Software Inc. for all users of Formvine—from any organization—to find information, get help, and participate in the Formvine community. The Resource Center is located at: http://www.formvine.com

This document will also discuss or use as examples different implementations of Formvine:

• The generic implementation of Formvine contains content, template and visuals with no additional customizations.

• The reference implementations have been customized to better fit that installation's use case. Two reference implementations are used as examples: the TIBCO implementation and the Formvine Trial (or simply “Trial”) implementation. Each of these has some subtle variations that are useful in illustrating different customizations available to you.

— The TIBCO implementation is the one used by TIBCO for its employees to build forms and collect results from other employees, contractors, customers, prospects and partners.

— The Trial implementation is the free, hosted service available at http://trial.formvine.com for anyone to try out Formvine.

This document is not here to suggest that you should make sweeping changes to the generic Formvine application. We just want to make sure that you are informed of the possibilities and aware of the options available to you.

TIBCO Formvine™ Customization Guide

Page 11: Tib Formvine Customize Guide

Who does the work? | 3

Who does the work?

The customization changes you decide to make will have to be implemented by a team. Depending on the complexity of what you’re trying to do, you may need a copy writer, a visual designer and a web designer who is experienced with CSS, XML, and HTML. You will also need input from Marketing and Legal. All the players need to read Understanding TIBCO Formvine™.

After you and your team have read Understanding TIBCO Formvine™, everyone on the project will read this document and gather requirements. After you have all requirements and necessary assets in hand, someone from your IT department will install Formvine. You can then hand your requirements to the installer and implementor who will use the TIBCO Formvine™ Implementation Notes document and the TIBCO Formvine™ Installation and Configuration Guide to implement and configure Formvine. Be sure to thoroughly test your implementation, including the Author Tool, forms, and emails, before you roll out to project owners.

TIBCO Formvine™ Customization Guide

Page 12: Tib Formvine Customize Guide

4 | Chapter 1 Customizing your Formvine implementation

Thinking about your implementation

Thinking about and planning your Formvine implementation in advance will help your company realize the maximum benefits from Formvine and help streamline the process of deployment and configuration.

Here are the topics that this section will help you consider before you get started:

• What is your use case for Formvine?, page 4

• Who can create projects?, page 5

• Who can fill out forms?, page 6

• Security issues, page 6

• Legal considerations, page 7

• Support, page 7

What is your use case for Formvine?Your use case (or use cases) will help you determine your customization goals. For example, if Formvine is for general company use, you might decide to implement Formvine completely behind your firewall. But, if your use case is very specific, for example, "My sales department needs to gather information from customers" or "My on-the-road pre-sales specialists need to be able to fill out forms anywhere, anytime," you might decide to implement Formvine differently. If you are a customer outside of the US, you might need custom controls that collect specific data, for example, international addresses or phone numbers.

A few of the areas that you might customize system-wide can also be altered by a project owner for an individual project. For example, a project owner can override the default subject line of a notification email or add a personal message to give better context or instruction to the recipient.

When considering your implementation, be sure to take local customization into account. Because a project owner can affect settings on a project-to-project basis, your changes need to remain useful across all projects. As a reminder of these areas, look for the sections called "What can the project owner do?" at the end of the Forms (page 19) and Emails (page 28) sections in Chapter 1, Customizing your Formvine implementation.

TIBCO Formvine™ Customization Guide

Page 13: Tib Formvine Customize Guide

Thinking about your implementation | 5

For reference, here are some of the most relevant things a project owner can do:

• Choose a visual design from:

— The choices given (nine included in Formvine)

— Her own CSS file (though she may need help from an engineer)

• Insert graphics into a form using HTML

• Display data submitted to a form in a notification email

• Insert messages into:

— Notification emails

— Thank You page

— Confirmation page

You can always change your implementation of Formvine after your initial installation. However, this may require re-educating your users and interrupting their Formvine services. It is much better to consider use cases beyond the immediate one to ensure your instance can meet current and future requirements. For example, branding your instance with a project logo may limit the ability of your Formvine instance to serve other projects or departments. System-wide decisions should serve the general use case as much as possible. You can specifically customize individual forms and projects, as needed.

Who can create projects?Only registered users are allowed to create Formvine projects. Users are registered in one of two ways:

• Corporate directory: through your corporate user directory (if you have a supported one)

• Formvine directory: through Formvine's built-in registration process

If you choose the Corporate directory option, anyone with active user credentials can sign into Formvine using the Formvine URL established by the installer. If you choose the built-in Formvine registration process, any user who has the Formvine URL will be able to register and use Formvine.

TIBCO Formvine™ Customization Guide

Page 14: Tib Formvine Customize Guide

6 | Chapter 1 Customizing your Formvine implementation

Who can fill out forms?Formvine projects are created for any number of reasons by a variety of project owners across your organization. It is very important to consider who the target participants are before the system is set up. This is to ensure that these participants have access to the forms your project owners create.

Network access

If your Formvine use case is limited to participants within your company's network, you don't need to think about providing external access. If your use case involves participants outside your company's network, you must consider the security implications of where the Formvine server, the database and the directory are located. You should consult with those responsible for network security early in the process.

Number of participants

The number of possible participants is another factor that must be taken into consideration when choosing the server specification, load balancing, etc. If your Formvine installation has to support 10,000+ participants in a public questionnaire, your systems administrator might make different choices than if your installation only supports forms filled out by the 200 employees of your company.

Authorized participants

Project owners can configure their forms so that only authorized participants are able to fill them out. To do this, the participant must be present in the directory used by Formvine. If a Corporate directory is used, the participant must exist in that directory. If a Formvine directory is used, the targeted participant will have to register and sign in.

Security issuesEvery enterprise has different security policies and requirements. Formvine is enterprise-class software built to the exacting specifications of large corporations and governments. That said, choices made when considering the location of servers, databases or directories impact how Formvine operates and whether the project goals are reached. People responsible for corporate information security should review Understanding TIBCO Formvine™ and know the choices you are making for your installation well in advance of your launch date.

TIBCO Formvine™ Customization Guide

Page 15: Tib Formvine Customize Guide

Thinking about your implementation | 7

Legal considerationsYour installation of Formvine is bound by the agreements of your license. Anything in this document that conflicts with that arrangement should be disregarded as incorrect. Consult with your legal counsel well in advance of your launch date to ensure that they understand what you are planning to do with Formvine and have time to review the contract in the context of the changes you are making.

Additionally, your legal policies may require that links to Terms and Conditions, Privacy Policies or Opt-Out Policies be included with every form or email. This content must be hosted on a server accessible by project owners and/or participants. You need to add the appropriate content to templates in the Formvine implementation.

SupportSome emails contain an email link for support. You need to think of an appropriate destination for support requests and questions. This email should be monitored to ensure reasonable response time for your users. If there are other methods of getting support, that content should be added to the system-wide templates.

TIBCO Formvine™ Customization Guide

Page 16: Tib Formvine Customize Guide

8 | Chapter 1 Customizing your Formvine implementation

How do you want to brand your installation?

Formvine offers numerous opportunities for you to brand your installation with your company logo, style and messaging. You can brand:

• The Formvine launch page

• The look and feel of the Formvine Author Tool

• The forms that participants fill out

• The email messages that are sent out for administrative and notification purposes

The Formvine brand helps orient your project owners. It provides a reference point for stakeholders in your organization and connects the application with the online community services at the Formvine Resource Center.

The Formvine brand is illustrated below:

Figure 1 Formvine logo

The important thing to consider here is how you want your own brand to interact with the Formvine brand for optimal recognition and comfort for project owners, management, participants, IT and support. In the next chapter, we will discuss branding in more detail and offer recommendations on how to approach the brand issues.

TIBCO Formvine™ Customization Guide

Page 17: Tib Formvine Customize Guide

Content and communication "voice" | 9

Content and communication "voice"

Various areas within Formvine provide opportunities to present your company messaging to project owners, participants and visitors to your site. What type of voice do you want to use for Formvine-related content and communication? Should it be formal and businesslike or friendly and accessible? What is your target audience, and what type of messaging are they most likely to respond to?

TIBCO Formvine™ Customization Guide

Page 18: Tib Formvine Customize Guide

10 | Chapter 1 Customizing your Formvine implementation

Gathering requirements

It will be important to get answers and buy-in on the questions we've raised from all of the key players who have a stake in your Formvine implementation. Plan to gather requirements from all of the affected organizations, including Legal, Marketing, copy writing and design. This document provides the questions to ask and also includes a checklist in Appendix A on page 39 so you can track where you are with requirements and assets collection.

TIBCO Formvine™ Customization Guide

Page 19: Tib Formvine Customize Guide

Implementation strategies and choices | 11

Chapter 2 Implementation strategies and choices

To get you started on planning your TIBCO Formvine™ implementation, we'll cover the main areas where your choices will have an impact. This chapter explains the specific system-wide customizations you can make and how each one affects your Formvine™ implementation.

Topics

• Brand, page 12

• Launch page, page 14

• Formvine Author Tool, page 17

• Forms, page 19

• Emails, page 28

TIBCO Formvine™ Customization Guide

Page 20: Tib Formvine Customize Guide

12 | Chapter 2 Implementation strategies and choices

Brand

Brands are often a big part of creating familiarity, loyalty and comfort with a product. How the various players associated with your Formvine instance see the brand can directly affect the success of the project.

For example, in our reference implementations, we use different variations, incorporating the context of the installation with the common Formvine mark. TIBCO employees might use any of those implementations or a generic one on their own testing server. It would be confusing if they all contained a simple Formvine logo in the Author Tool and it would be difficult to understand exactly where notification emails originated.

Granted, TIBCO is unique as both a Formvine user and the company that develops it, but the same idea applies to our customer implementations.

When deciding to install Formvine for TIBCO employees to use for company business, we could have used the name of our intranet, "Inside TIBCO," to draw a connection between Formvine and the other intranet services. Instead, we decided that we would add text to the logo so that anyone logged would know they were using Formvine at TIBCO.

When emails go out from that system and the recipient is aware of the tool, the emails are clearly marked with the "at TIBCO" addition. When emails go out to people that are not necessarily aware of Formvine, like prospects or applicants, we use the TIBCO logo to make sure they know what the email relates to. The following figure illustrates the Formvine at TIBCO logo.

Figure 2 Formvine at TIBCO logo in the Frutiger Light font

The Formvine TRIAL implementation is used to demonstrate the power and utility of Formvine. In that instance, we have a clear TRIAL mark next to the Formvine logo. However, the notification emails generated from the TRIAL system do not use the TRIAL mark. We want people to use Formvine Trial for real projects and highlighting that would not encourage real use cases. The following figure illustrates the Formvine TRIAL logo.

Figure 3 Formvine Trial logo

TIBCO Formvine™ Customization Guide

Page 21: Tib Formvine Customize Guide

Brand | 13

The Formvine Resource Center was created to allow users of Formvine to get help from community members, including the product developers. The Formvine logo creates a connection between your instance and this helpful, public website. The following figure shows the Formvine Resource Center logo:

Figure 4 Formvine Resource Center logo

RecommendationsWe recommend the following:

• Keep the Formvine logo but append text that would be familiar to your project owners.

• Use your own brand in places where those unfamiliar with Formvine would be confused.

• Check with your Legal department before removing or altering any Formvine or TIBCO brands and messages.

TIBCO Formvine™ Customization Guide

Page 22: Tib Formvine Customize Guide

14 | Chapter 2 Implementation strategies and choices

Launch page

When you install Formvine in your enterprise, you can customize the launch page. The launch page is what you make available to project owners. It provides a friendly introduction to Formvine and offers links to the Quick Start, the Resource Center and the Formvine Author Tool. It can provide links to Privacy Policies or to Terms and Conditions statements that might be required by your Legal department.

The launch page can be viewed as a standard HTML web page or can be embedded in an iFrame in your corporate intranet. The following figure shows the generic implementation of the launch page.

Figure 5 Launch page - generic implementation

TIBCO Formvine™ Customization Guide

Page 23: Tib Formvine Customize Guide

Launch page | 15

You can replace this page or rearrange and supplement the elements on the page. The following figure illustrates how the page was customized for the TIBCO reference implementation. Note that we added the words “at TIBCO” to the Formvine logo in the header, but kept the original version of the logo intact.

In addition, we updated the text specifically for TIBCO employees and rearranged it for readability. We added a link to the Formvine administrator and added a caveat to the Security section, stating that Formvine is available for business purposes only. We also added the TIBCO logo to the page footer.

Figure 6 Launch page - reference implementation

TIBCO Formvine™ Customization Guide

Page 24: Tib Formvine Customize Guide

16 | Chapter 2 Implementation strategies and choices

Questions to ask about the Formvine launch pageHere’s what you need to consider to get your launch page up and running:

• Do you have any legal requirements for the launch page? Does your Legal department have a Privacy Policy or Terms and Conditions statement to add to the page?

• Do you want to redesign the launch page?

• Do you want to update the text on the launch page?

RecommendationsWe recommend the following customizations for the launch page:

• Keep the Formvine logo and brand on the launch page. This allows your users to recognize the Formvine brand when going to the public Formvine Resource Center for help or when downloading and reading the Formvine Quick Start.

• Use the mark recommended in the Brand section on page 12.

• Add an email link for your Formvine administrator to the launch page.

• Update the text in each section with information specific to your enterprise.

TIBCO Formvine™ Customization Guide

Page 25: Tib Formvine Customize Guide

Formvine Author Tool | 17

Formvine Author Tool

Every page in the Formvine Author Tool, where project owners create and manage projects, has a header with a logo that identifies Formvine. Every page also has a footer with copyright information. Changes to the header and footer are system-wide; they can’t be changed on a page-by-page basis.

When you're thinking about these pages, consider your brand.

• Will all project owners be employees? If so, you can use the messaging to unify the Formvine product with other applications used in-house by employees.

• Will some project owners be outside your firewall? If project owners are not employees, you can use this opportunity to promote your company brand.

Formvine headerEach page of the Formvine Author Tool displays a header. In the standard header, the Formvine logo makes it clear that you're working in Formvine. The Formvine logo in the header links to the public Resource Center.

You also see the logo at the top of the following pages:

• Sign In page

• Additional registration-related pages (Formvine directory implementation only)

The header for the generic Formvine implementation contains the Formvine logo. Here's what the generic implementation of the header looks like.

Figure 7 Formvine header - generic implementation

The header for the TIBCO reference implementation contains a modified logo. The text "at TIBCO" has been added to the Formvine logo to identify Formvine as a product running inside the TIBCO intranet. As an alternative, you could add your company name to the upper right side of the screen, near the navigation bar.

Figure 8 Formvine header - reference implementation

TIBCO Formvine™ Customization Guide

Page 26: Tib Formvine Customize Guide

18 | Chapter 2 Implementation strategies and choices

Formvine footerThe footer on each page of Formvine shows the product name, the copyright information, and a Formvine version number. Hovering over the version number displays the build number, which is useful to know if you need to contact customer support.

Here's the generic implementation version of the footer.

Figure 9 Formvine footer - generic implementation

You can use the empty area on the right for any text you would like to add to the footer or for your company logo. You could also add links to a Privacy Policy or Terms and Conditions, if required by your Legal department.

ControlsTo support your use case, you may need to add new compound controls to the Formvine components list in the Author Tool or modify one or more of the existing compound controls. See Appendix B on page 43 for details.

Questions to ask about the Formvine Author ToolHere’s what you need to consider when updating the Formvine Author Tool:

• Do you want to add your company name (or other identifying text) to the Formvine logo in the header?

• Do you have any legal requirements for the footer? Does your Legal department have a Privacy Policy or Terms and Conditions statement to add to the page?

• Would you like to add text or your logo to the Formvine footer?

• Do you want to modify existing compound controls or add new ones?

RecommendationsWe recommend that you use the customized mark discussed in the Brand section on page 12 in the Formvine Author Tool.

TIBCO Formvine™ Customization Guide

Page 27: Tib Formvine Customize Guide

Forms | 19

Forms

Many people may be exposed to your Formvine implementation exclusively as participants (people who fill out forms). Form customization is an ideal way to extend your company branding and messaging out to participants.

Visual styleThe form visual style includes the specific color scheme and text style that is applied to the form. The generic implementation of Formvine has three types of visual styles that you can choose from, with a total of nine styles available:

• The four standard styles are sized for readability. Instructional text and hint text are shown and labels are displayed above fields. The four standard styles are white, black, yellow and blue.

• The four compact styles are sized to minimize scrolling. Instructional text is hidden but hint text is shown. Labels are displayed to the left of fields. The fonts are smaller. The four compact styles are white, gray, green and blue.

• The solitary narrow style is sized to fit into a web page. Instructional text and hint text are shown and labels are displayed above fields. The fonts are smaller. The one narrow style is white.

The visual style also controls the top of the form and the bottom of a form, that is, the header and footer on the form. The visual style is applied to all pages of a form, the form’s Confirmation page and the form’s Thank You page. To change the styles, you need to decide what you want and then change the appropriate CSS files.

TIBCO Formvine™ Customization Guide

Page 28: Tib Formvine Customize Guide

20 | Chapter 2 Implementation strategies and choices

The following image shows the generic standard black visual style applied to a form. Notice that there is no company branding. The small text in the footer "Powered by TIBCO FormvineTM" identifies the product and links to the public Formvine Resource Center, not to the Formvine implementation.

Figure 10 Standard visual style - generic implementation

TIBCO Formvine™ Customization Guide

Page 29: Tib Formvine Customize Guide

Forms | 21

For the Formvine implementation at TIBCO, we added the TIBCO logo to the visual styles, since all forms are presumably associated with company business. Adding your company logo will help your participants know that the form was generated by someone at your company.

Figure 11 Standard visual style - reference implementatione

TIBCO Formvine™ Customization Guide

Page 30: Tib Formvine Customize Guide

22 | Chapter 2 Implementation strategies and choices

Page headers for authorized participants

If your project owners create forms with authorized participants, that is, a form where only specified participants can fill it out, your participants will see an additional header on the form page. The header identifies the participant (because the participant is known, since he or she has to sign in) and offers a Sign out link. This area is the same in both the generic and reference implementations and is illustrated below.

Figure 12 Page header - generic and reference implementations

Confirmation pageEach project owner can choose to display a Confirmation page after a participant clicks the Submit button on his or her form. A project owner can customize or disable the page. The Confirmation page displays the data about to be submitted to the form and, by default, gives the participant an opportunity to go back and change answers. Any changes you make are system-wide and should be considered carefully.

The Confirmation page uses the same visual style as the form. You can choose to change the default text that's displayed on the page, though we didn’t change this text for the Formvine at TIBCO implementation. The default text is set to: "You are almost done! Please review the information below to make sure it's what you want. Click Submit if it's correct. Click Back if you need to make changes."

TIBCO Formvine™ Customization Guide

Page 31: Tib Formvine Customize Guide

Forms | 23

The following illustration shows the Confirmation page for the generic implementation. In this example, the standard blue visual style has been applied.

Figure 13 Confirmation page - generic implementation

TIBCO Formvine™ Customization Guide

Page 32: Tib Formvine Customize Guide

24 | Chapter 2 Implementation strategies and choices

Here's an example of the Confirmation page for the TIBCO implementation with the customized TIBCO blue visual style applied:

Figure 14 Confirmation page - reference implementation

TIBCO Formvine™ Customization Guide

Page 33: Tib Formvine Customize Guide

Forms | 25

Thank You pageA Thank You page is displayed for every project after the user clicks Submit, either on the form or on the Confirmation page, if used. The Thank You page thanks the participant and can display any personalized text added by the project owner. As with the Confirmation page, any changes you make are system-wide and should be considered carefully.

The Thank You page uses the same visual style as the form. Both implementations display a Formvine logo. For the Formvine at TIBCO implementation, we displayed company branding. We didn’t change the default text on the page, though you could choose to do this. The default text is set to: "Thank You. Your form has been submitted. "

Here's an example of the Thank You page for the generic implementation. The Formvine logo is not a link to the Formvine implementation, but is a link to the Formvine Resource Center.

Figure 15 Thank you page - generic implementation

TIBCO Formvine™ Customization Guide

Page 34: Tib Formvine Customize Guide

26 | Chapter 2 Implementation strategies and choices

Here's an example of the Thank You page for the TIBCO implementation.

Figure 16 Thank you page - reference implementation

What can the project owner do?For reference, here are some of the most relevant things the project owner can do:

• Choose a visual design from:

— The choices given (nine included in Formvine)

— Her own CSS file (though she may need help from an engineer)

• Insert graphics into a form using HTML

• Insert messages into:

— Thank You page

— Confirmation Page

TIBCO Formvine™ Customization Guide

Page 35: Tib Formvine Customize Guide

Forms | 27

Questions to ask about Formvine formsThe following questions will help you think about how forms appear for participants.

• Do you want to add your company logo to Formvine forms that are filled out by participants? You can add the logo to the top of the form and to the form footer.

• Do you want to change the default text on the Confirmation page or the Thank you page?

• Do you have any legal requirements for the form footer? Does your Legal department have a Privacy Policy or Terms and Conditions statement to add to the form?

RecommendationsWe recommend that you add your company logo to the visual style of forms, Thank You page and Confirmation page. This will reinforce the legitimacy of the form in relation to your company.

TIBCO Formvine™ Customization Guide

Page 36: Tib Formvine Customize Guide

28 | Chapter 2 Implementation strategies and choices

Emails

In addition to the Formvine Author Tool and Formvine forms, project owners and participants will also be exposed to your Formvine implementation through emails. During normal operations, Formvine will generate the following types of emails:

• Registration emails

• Notification emails

• System emails

Email content and styling are based on templates and, by necessity, written very generically to accommodate all use cases. Customizing these templates on a system-wide basis will make your emails more specific to your company and use case and help reinforce your company messaging and highlight your company brand.

Email customization provides another opportunity for you extend your company branding and messaging, as well as add to the credibility of the email for your participants, who may be wary of spam and phishing.

Some of the options that you might customize system-wide for registration, notification, and system emails can also be altered by the installation engineer or by the projecct owner. For example, the installation engineer can change the "From" email address for all emails, change the default subject line or email text, or add the company brand or logo to the header or footer. The project owner can change the subject line for notification emails or add additional text to the message.

TIBCO Formvine™ Customization Guide

Page 37: Tib Formvine Customize Guide

Emails | 29

The following diagram illustrates a customized notification email. Venkat, the installer, can customize some of the pieces and Marcia, the project owner, can customize others. (See Understanding TIBCO Formvine™ for a discussion of personas.) Venkat’s changes are system-wide. Marcia can use the Notification Settings page to change items that are specific to the email she generates. Marcia’s changes override Venkat’s changes.

Figure 17 Anatomy of an email

TIBCO Formvine™ Customization Guide

Page 38: Tib Formvine Customize Guide

30 | Chapter 2 Implementation strategies and choices

The following figure shows the Formvine Notification Settings page, where Marcia, the project owner, can change the subject line of her email, add a personalized message to the email, and include data with the email. The Change link and the Customize Message link display a dialog boxes where Marcia can make these changes.

Figure 18 Notification Settings page

Registration emailsIf you are using the Formvine directory for user authentication, where project owners and participants self-register, Formvine can generate the following emails:

• Registration activation

• Registration confirmed

• Password reset

These emails may be the first communication from Formvine to a project owner or participant. You can add a header and customize the footer on these emails so that your company brand is visible. You can also customize the content of the email. Appendix C on page 51 lists all default email text and points out what we changed for the reference implementations.

By necessity, registration emails must contain links back to Formvine. These links are displayed as friendly links, for example, "Formvine."

Formvine systems using your Corporate directory for users and groups will not use registration emails, as users are already authenticated.

TIBCO Formvine™ Customization Guide

Page 39: Tib Formvine Customize Guide

Emails | 31

The three registration-related emails are outlined below.

• The registration activation email is sent to a user (project owner or participant) after clicking Submit on the Registration page. The email contains a link that the user has to click to activate their registration. This is an optional email that can be turned on or off at installation. (If the email is off, the user is automatically registered and logged in after clicking Submit on the Registration page.)

• The registration confirmation email is sent when a user successfully activates his or her account. The email confirms the Formvine registration. It also introduces the new Formvine user to the public Formvine Resource Center.

• The password reset email is sent to a registered user who requests a password reset. The email contains a link that activates the Password Reset page, where the user can complete the password reset process.

For help or questions, all registration emails contain an email link to Formvine support.

Here's what the generic implementation of a registration email looks like this. There is no company logo identifying the email source.

Figure 19 Registration email example - generic implementation

TIBCO Formvine™ Customization Guide

Page 40: Tib Formvine Customize Guide

32 | Chapter 2 Implementation strategies and choices

Here's what we did with the same email for the Formvine Trial implementation. We changed the subject line and prominently displayed the Formvine Trial logo. We updated the text to including the Formvine Trial brand and also pointed the support email back to the Formvine Trial administrator. Note that the support email address is filled in for you, based on what you'll configure when you install Formvine.

Figure 20 Registration email example - reference implementation

Notification emailsA project owner can set up data notification emails that are sent when a form receives a submission. There are three types of notification emails:

• A notification to the person who submitted the form

• An additional email to the person whose email address was submitted to an email address field on the form

• A notification to a list of people, identified by email addresses. The project owner can optionally send this to herself

The project owner can add a personalized message to any of these emails and choose to include the data that was submitted to the form.

TIBCO Formvine™ Customization Guide

Page 41: Tib Formvine Customize Guide

Emails | 33

The generic implementation of these emails does not include any brand identification, as the person receiving the email might not knowwhat Formvine is. However, you should include your company logo on all these emails, so that person will know the email source.

Note that these emails don't need support email links or links to Formvine, for two reasons:

• The person receiving the email might not know what Formvine is, or need to know. The project owner's personalized message will help orient the reader.

• The person receiving the email might be outside your firewall or Corporate directory. Depending on how Formvine is implemented, any link back to Formvine provided in the email might not work. And the support email, to your internal IT department, would not make sense to an external user. Additionally, if you're using a Formvine directory, you might not want the person receiving the email to have the Formvine URL, which would allow him or her to register and create projects.

Here's what the generic implementation of a notification email looks like this. There is no company logo that identifies the email source.

Figure 21 Notification email example - generic implementation

TIBCO Formvine™ Customization Guide

Page 42: Tib Formvine Customize Guide

34 | Chapter 2 Implementation strategies and choices

Here's what we did with the same email for the Formvine at TIBCO implementation. We prominently displayed the TIBCO company logo, so that the submitter would know the email was from TIBCO. We updated the text to make it a bit friendlier. And, we added the Formvine logo to the footer. This email includes the data submitted to the form as well as a personalized subject line.

Figure 22 Notification email example - reference implementation

Appendix C on page 51 lists all default email text and points out what we changed for the reference implementations.

TIBCO Formvine™ Customization Guide

Page 43: Tib Formvine Customize Guide

Emails | 35

System emailsFormvine generates system emails when a project owner adds an additional owner to a project or removes another owner from a project. The email return address is that of the project owner making these changes, not the Formvine reply-to email.

When considering these emails, it's important to realize that the person being added as an owner might not be familiar with Formvine. He or she might not have even used it.

By necessity, system emails must contain links back to Formvine. These links are displayed as friendly links, for example, "Formvine." For help or questions, these emails contain an email link to Formvine support.

Here's what the generic implementation for a system email looks like this. There is no logo that identifies the email source, though the return email address is from the project owner and the word "Formvine" is used in the subject line.

Figure 23 System email example - generic implementation

TIBCO Formvine™ Customization Guide

Page 44: Tib Formvine Customize Guide

36 | Chapter 2 Implementation strategies and choices

Here's what we did with the same email for the Formvine at TIBCO implementation. We prominently displayed the Formvine at TIBCO logo, so that the recipient would know the email was from a Formvine project owner at TIBCO. We also added the TIBCO company logo to the footer.

Figure 24 System email example - reference implementation

Appendix C on page 51 lists all default email text and points out what we changed for the reference implementations.

What can the project owner do?A project owner can insert personalized messages into the notification email and choose to display the data submitted to the form in the email.

Questions to ask about emailsHere's what you need to consider as you think about how to customize emails.

Registration emails

• Do you want to add your company name to the subject line? Or, change the default subject line entirely?

• Do you want to add the Formvine logo with your company name (or other identifying text) to the email header?

• Do you want to add your company name to the link text?

• Would you like to personalize the email text?

TIBCO Formvine™ Customization Guide

Page 45: Tib Formvine Customize Guide

Emails | 37

• Do you have any legal requirements for the email? Does your Legal department have a required Privacy Policy or Terms and Conditions statement?

Notification emails

• Do you want to add your company name to the subject line? Or, change the default subject line entirely?

• Do you want to add your logo to the top of the email for immediate recognition?

• Would you like to personalize the email text?

• Do you want to add the Formvine logo to the email footer?

• Are there any legal requirements?

System emails

• Do you want to add your company name to the subject line? Or, change the default subject line entirely?

• Do you want to add the Formvine logo with your company name (or other identifying text) to the email header?

• Would you like to personalize the email text?

• Do you want to add the Formvine logo to the email footer?

• Are there any legal requirements?

RecommendationsWe recommend the following system-wide customizations for all emails:

• Emails that go to your Formvine users should be branded with the combination of Formvine and the text incorporating the company or intranet name.

• Personalize the text to make it just right for your company messaging.

• Personalize the friendly link to Formvine for your company.

• Emails that go to participants unfamiliar with the Formvine brand should have your company logo or other familiar mark to give the participant context and confidence.

TIBCO Formvine™ Customization Guide

Page 46: Tib Formvine Customize Guide

38 | Chapter 2 Implementation strategies and choices

TIBCO Formvine™ Customization Guide

Page 47: Tib Formvine Customize Guide

Customization checklist | 39

Appendix A Customization checklist

This appendix lists the categories of customizations in a checklist. The checklist is organized by the people you need to collect data from. After you’ve gathered the information, check it off.

When you have everything you need, refer to the TIBCO Formvine™ Implementation Notes document. This document provides instructions to the developers who will be implementing these changes in your local Formvine™ installation.

Everything in this list is optional. You don’t need to make any changes. This options are simply available to customize Formvine for your implementation and use case.

Table 2 Customization checklist

Category Description

Legal

❑ Brand Corporate branding guidelines for use in Formvine.

More information:

How do you want to brand your installation?, page 8

Brand, page 12

❑ Launch page Requirements for a company-specific Terms and Conditions page or a Privacy Policy page.

More information:

Legal considerations, page 7

Launch page, page 14

TIBCO Formvine™ Customization Guide

Page 48: Tib Formvine Customize Guide

40 | Appendix A Customization checklist

Visual designer

❑ Brand for launch page, Formvine header, and emails

Graphic file of Formvine logo with company name (or other identifying text), sized to 159x41 pixels.

More information:

How do you want to brand your installation?, page 8

Brand, page 12

Launch page, page 14

Formvine header, page 17

Registration emails, page 30

Notification emails, page 32

System emails, page 35

❑ Launch page Customized visual design.

More information:

Launch page, page 14

❑ Visual styles and emails

Graphic file with company logo for visual style and/or email header and footer, sized to 125x27 pixels for the header and 67x15 pixels for the footer.

Note that the image size is flexible. If the size is different than this default, code in the CSS or email CSS or HTML file will require modification by your implementer.

More information:

Visual style, page 19

❑ Emails, footer Graphic file with company logo, sized to 67x15 pixels for the footer.

More information:

Registration emails, page 30

Notification emails, page 32

System emails, page 35

Table 2 Customization checklist (Cont’d)

Category Description

TIBCO Formvine™ Customization Guide

Page 49: Tib Formvine Customize Guide

Customization checklist | 41

Copy writer

❑ Launch page Updated text for launch page.

More information:

Launch page, page 14

❑ Confirmation page, Thank You page

Default text displayed system-wide to all participants.

More information:

Confirmation page, page 22

Thank You page, page 25

❑ Registration emails Updated subject line with company name.

Text to extend brand to project owners and participants who need to register to fill out forms.

More information:

Registration emails, page 30

Appendix C on page 51

❑ Notification emails Updated subject line with company name.

Text to extend brand to people being notified of a form submission who may not be familiar with Formvine.

More information:

Notification emails, page 32

Appendix C on page 51

❑ System emails Updated subject line with company name.

Text to extend brand to new project owners who may not be familiar with Formvine.

More information:

System emails, page 35

Appendix C on page 51

Table 2 Customization checklist (Cont’d)

Category Description

TIBCO Formvine™ Customization Guide

Page 50: Tib Formvine Customize Guide

42 | Appendix A Customization checklist

TIBCO Formvine™ Customization Guide

Page 51: Tib Formvine Customize Guide

Controls | 43

Appendix B Controls

Controls are the elements in TIBCO Formvine™ that collect results. Controls are used by project owners when designing forms. Controls are either single-field controls or compound controls, composed of more than one single-field control.

Compound controls are dragged to the Formvine™ canvas as a single control. The results collected from participants are shown as one column per subfield in the Formvine Results table.

The table below lists the Formvine single-field controls that are the building blocks for compound controls.

Table 3 Formvine controls that can be used in compound controls

Control Results collected by control

Single Line Text Single line of text.

Multi-Line Text Multiple lines of text.

Single Check Box True/False (on/off) setting of check box.

Dropdown List One option from a list of options.

Date Single date, formatted as MM/DD/YYYY. Numeric format.

TIBCO Formvine™ Customization Guide

Page 52: Tib Formvine Customize Guide

44 | Appendix B Controls

This table lists the Formvine compound controls, that is, controls that are made up of one or more single-field controls. These controls collect multiple pieces of data, like an address or the parts of a name.

Time Time to hours and minutes. 12-hour clock.

Image Upload Validated image file (png, jpg, gif).

Radio Button Group One option from a list of options.

Table 3 Formvine controls that can be used in compound controls

Control Results collected by control

Table 4 Formvine controls

Control Results collected by control Control components

Short Name First and last name. First name field, last name field.

Long Name Title, first name, middle initial, last name.

Title dropdown with Mr, Mrs, and Ms options. First name field, middle initial field, last name field.

US Address Standard US address. Two street address fields, City field, State dropdown, Zip field.

Zip+4 Validated zip +4 zip code. Zip code field for 5 digits, additional field for 4 digits.

TIBCO Formvine™ Customization Guide

Page 53: Tib Formvine Customize Guide

Controls | 45

You can’t add or modify the single-field controls. However, you can modify the existing compound controls or add your own. For example, you might want to modify the US Address control to support an international format. Or, you might need to add a suffix to the Long Name control.

Modifying or adding a compound control requires some thought and is a team effort. You need to consult with your project owners to determine the requirements for the control. Then, your visual designer will need to design the control. And your copy writer will have to create all associated text. Finally, your engineer will have to assemble the pieces using XML.

TIBCO Formvine™ Customization Guide

Page 54: Tib Formvine Customize Guide

46 | Appendix B Controls

Anatomy of a compound control

Before you can modify an existing compound control or create a new one, you need to understand how they’re put together. The diagram below illustrates how a compound control is assembled.

Figure 25 Anatomy of a compound control

As the illustration shows, a compound control consists of a number of simple controls that have been assembled into a single control. You need to think about how you want your new control to be put together. How many lines does it span? Are multiple single fields on one line? If so, how much space do they take as a percentage of the whole line?

There are several icons to create: one icon is displayed in Formvine’s components list in the canvas, when the project owner is designing the form. Another icon is displayed when the project owner drags the control to the form. This icon is also displayed in the control spyglass.

TIBCO Formvine™ Customization Guide

Page 55: Tib Formvine Customize Guide

Anatomy of a compound control | 47

Finally, you need to think about text. You need a name for the control. You also need to label each part of the control so the participant will know what data is being asked for. And, you need to provide default instructional and hint text, or use the standard Formvine placeholder text. In addition, you will have to develop an error message for each piece of data that does not meet validation requirements.

TIBCO Formvine™ Customization Guide

Page 56: Tib Formvine Customize Guide

48 | Appendix B Controls

Questions to ask about controls

As you consider new compound controls, think about the following questions:

• What kind of data do you want to collect?

• Do any of the existing compound controls (address, phone, long name) have some of what you want?

• What do you want to call your new or modified control?

• What simple controls does it consist of?

• What parts of it are required if the project owner marks the field as a required field on the form?

• What validations does the control need?

TIBCO Formvine™ Customization Guide

Page 57: Tib Formvine Customize Guide

Recommendations | 49

Recommendations

Though we can’t make recommendations about what kind of compound controls you need for your use case, we can suggest that you do this work before Formvine is up and running. This is important because:

• Adding in a new compound control later, after project owners have been designing forms, will require a stop and re-start of your Formvine server.

• The new control is added to the components list. It does not affect forms that have already been authored and deployed. To use it on projects that are already up and running, the project owner would be required to redesign the form. This might interfere with results already collected.

TIBCO Formvine™ Customization Guide

Page 58: Tib Formvine Customize Guide

50 | Appendix B Controls

TIBCO Formvine™ Customization Guide

Page 59: Tib Formvine Customize Guide

Email text | 51

Appendix C Email text

This appendix outlines the text used in emails generated by TIBCO Formvine™. The tables outline the text used in the generic implementation and the text used in the reference implementation (either Formvine™ Trial or Formvine™ at TIBCO). The angle brackets (< >) indicate places in the email where the text is filled in by Formvine, based on parameters given at installation or when the user completed the Registration page.

TIBCO Formvine™ Customization Guide

Page 60: Tib Formvine Customize Guide

52 | Appendix C Email text

Registration emails

Registration emails are sent when a user registers with a Formvine implementation using the Formvine directory for registration, where users and authorized participants self-register.

This table shows the subject line and text for the registration email for both the generic implementation of Formvine and the Formvine Trial reference implementation. You can see how we updated text for the Formvine Trial.

Table 5 Registration activation email

Default subject line

Formvine Trial subject line

Default email text Formvine Trial email text

Formvine registration

Formvine Trial registration activation

Hello <full name>,

Thanks for registering with Formvine! Click the link below to confirm your registration: <Confirm registration>

If you did not sign up for an account, ignore this message and the account will not be created.

Questions? Email your administrator at: <support email>

Hello <full name>,

Thanks for registering with TIBCO Formvine Trial! Click the link below to confirm your registration: <Confirm registration>

If you did not sign up for an account at Formvine Trial, ignore this message and the account will not be created.

Questions? Email Formvine Trial support at: <support email>

TIBCO Formvine™ Customization Guide

Page 61: Tib Formvine Customize Guide

Registration emails | 53

This table shows the subject line and text for the confirmation email for both the generic and reference implementation.

Table 6 Registration confirmation email

Default subject line

Formvine Trial subject line

Default email text Formvine Trial email text

Formvine registration confirmed

Formvine Trial registration confirmed

Hello <full name>,

Welcome! Your registration with Formvine has been confirmed and you're ready to start creating projects.

To access Formvine, click the link below: <Formvine>

Questions? Email your administrator at: <support email>

You can visit the Formvine Resource Center at http://www.formvine.com to learn about the product and get involved with the community.

Hello <full name>,

Thank you for registering for the TIBCO Formvine Trial. You are ready to start creating free online forms. If you are interested in a 45-day onsite installation or a price quote for your project, department or entire enterprise, contact us.

<License details>

To go to Formvine Trial, click here: <Formvine Home>

Looking for inspiration or help building forms? Visit the Formvine Resource Center for tips, help, and a community of other Formvine users.

Questions? Email Formvine Trial support at: <support email>

TIBCO Formvine™ Customization Guide

Page 62: Tib Formvine Customize Guide

54 | Appendix C Email text

The table below shows the password reset email for both implementations.

Table 7 Password reset email

Default subject line

Formvine Trial subject line

Default email text Formvine Trial email text

Formvine password reset

Formvine Trial password reset

Hello <full name>,

You have requested a password reset for your Formvine account. Click the link below to start your password reset process: <Password Reset >

Questions? Email your administrator at: <support email>

Hello <full name>,

You have requested a password reset for your Formvine Trial™ account. Click the link below to start your password reset process: <Reset Password>

Questions? Email Formvine Trial support at: <support email>

TIBCO Formvine™ Customization Guide

Page 63: Tib Formvine Customize Guide

Notification emails | 55

Notification emails

Notification emails are sent by Formvine at the option of the project owner. Different notification emails, with different default subject line and text, are sent to:

• The person who submitted the form

• The person whose email address was submitted to an email address field on the form

• A list of people, identified by email addresses. The project owner can optionally send this to herself

The project owner can add a personalized message to these emails and choose to display the data submitted to the form.

The table below shows the email notification to the form submitter. We edited the default text slightly for the Formvine at TIBCO implementation.

The table below shows the subject line and text for the notification email sent to an email address submitted to the form. We did not change the email text for the Formvine at TIBCO implementation.

Table 8 Notification to form submitter

Default subject line

Formvine at TIBCO subject line

Default email text Formvine at TIBCO email text

Thank you for your response

Thank you for your response

This email was generated to let you know that your response has been received.

This email was generated to let you know your response was received.

Table 9 Notification to email address submitted to form

Default subject line

Formvine at TIBCO subject line

Default email text Formvine at TIBCO email text

A response was received

A response was received

This email was generated as an automatic receipt for a form submission. Part of that submission included your email address as one to receive this notice.

This email was generated as an automatic receipt for a form submission. Part of that submission included your email address as one to receive this notice.

TIBCO Formvine™ Customization Guide

Page 64: Tib Formvine Customize Guide

56 | Appendix C Email text

The table below shows the subject line and text for the notification email that’s sent to a list of people added by the project owner, and optionally, to herself. We edited the text slightly for the Formvine at TIBCO implementation.

Table 10 Notification to list of email addresses

Default subject line

Formvine at TIBCO subject line

Default email text Formvine at TIBCO email text

A new response was received for "<project>"

A new response was received for "<project>"

A response was submitted for "<project>"

Results were submitted for the Formvine project: "<project>"

TIBCO Formvine™ Customization Guide

Page 65: Tib Formvine Customize Guide

System emails | 57

System emails

Formvine generates system emails when a project owner adds another owner to a project or removes an owner from a project.

The table below shows the subject line and text for the system email that’s sent when a project owner adds another project owner. We did not change the text from the generic text for the Formvine at TIBCO implementation.

Table 11 Project owner add email

Default subject line

Formvine at TIBCO subject line

Default email text Formvine at TIBCO email text

You have been added to the Formvine project “<project>”

You have been added to the Formvine project “<project>”

Hello <full name>,

This email was generated to let you know that you have been added as an owner of the Formvine project “<project>”.

To access this project, click the following link and sign in if required: <Formvine>

Questions? Email your administrator at: <support email>

Hello <full name>,

This email was generated to let you know that you have been added as an owner of the Formvine project “<project>”.

To access this project, click the following link and sign in if required: <Formvine>

Questions? Email your administrator at: <support email>

TIBCO Formvine™ Customization Guide

Page 66: Tib Formvine Customize Guide

58 | Appendix C Email text

The table below shows the subject line and text for the system email that’s sent when a project owner removes another project owner. We did not change this text for the Formvine at TIBCO implementation.

Table 12 Project owner remove email

Default subject line

Formvine at TIBCO subject line

Default email text Formvine at TIBCO email text

You have been removed from the Formvine project “<project>”

You have been removed from the Formvine project “<project>”

Hello <full name>,

This email was generated to let you know that you have been removed as an owner from the Formvine project “<project>”

If you feel you have been removed in error, you should contact one of the project owners.

You can access your remaining projects by clicking here and signing in, if required: <Formvine>

Questions? Email your administrator at: <support email>

Hello <full name>,

This email was generated to let you know that you have been removed as an owner from the Formvine project “<project>”

If you feel you have been removed in error, you should contact one of the project owners.

You can access your remaining projects by clicking here and signing in, if required: <Formvine>

Questions? Email your administrator at: <support email>

TIBCO Formvine™ Customization Guide