Professional Documents
Culture Documents
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
Contents iii
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
How do you want to brand your installation? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Content and communication "voice" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Gathering requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
iv
| Contents
Questions to ask about Formvine forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Emails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Registration emails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Notification emails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . System emails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . What can the project owner do? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Questions to ask about emails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 30 32 35 36 36 37
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 companys 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. For the latest version of this document, go to http://www.formvine.com/docs
Topics
Related Documentation, page vi Typographical Conventions, page vii
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.
Preface vii
Typographical Conventions
The following typographical conventions are used in this manual. Table 1 General typographical conventions Convention New term Use 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.
viii
| Typographical Conventions
Chapter 1
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
| Chapter 1
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 Formvinefrom any organizationto 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.
| Chapter 1
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.
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.
| Chapter 1
Security issues
Every 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.
Legal considerations
Your 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.
Support
Some 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.
| Chapter 1
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.
10
| Chapter 1
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.
Chapter 2
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
12
| Chapter 2
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
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
Recommendations
We 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.
14
| Chapter 2
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
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
16
| Chapter 2
Recommendations
We 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.
Formvine header
Each 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
18
| Chapter 2
Formvine footer
The 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.
Controls
To 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.
Recommendations
We recommend that you use the customized mark discussed in the Brand section on page 12 in the Formvine Author Tool.
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 style
The 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 forms Confirmation page and the forms Thank You page. To change the styles, you need to decide what you want and then change the appropriate CSS files.
20
| Chapter 2
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
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 implementation
e
22
| Chapter 2
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 page
Each 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 didnt 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."
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
24
| Chapter 2
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
Forms 25
26
| Chapter 2
Here's an example of the Thank You page for the TIBCO implementation. Figure 16 Thank you page - reference implementation
Forms 27
Recommendations
We 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.
28
| Chapter 2
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.
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.) Venkats changes are system-wide. Marcia can use the Notification Settings page to change items that are specific to the email she generates. Marcias changes override Venkats changes. Figure 17 Anatomy of an email
30
| Chapter 2
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 emails
If 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.
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
32
| Chapter 2
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 emails
A 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.
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
34
| Chapter 2
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.
Emails 35
System emails
Formvine 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
36
| Chapter 2
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.
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 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? 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?
Recommendations
We 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.
38
| Chapter 2
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 youve gathered the information, check it off. Everything in this list is optional. You dont need to make any changes. This options are simply available to customize Formvine for your implementation and use case. 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. Table 2 Customization checklist Category Legal Description
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
40
| Appendix A
Customization checklist
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
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
Customization checklist 41
Launch page
Updated text for launch page. More information: Launch page, page 14
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
42
| Appendix A
Customization checklist
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 Single Line Text Results collected by control Single line of text.
Multi-Line Text
Dropdown List
Date
44
| Appendix B
Controls
Table 3 Formvine controls that can be used in compound controls Control Time Results collected by control Time to hours and minutes. 12-hour clock.
Image Upload
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. Table 4 Formvine controls Control Short Name Results collected by control First and last name. Control components First name field, last name field.
Long Name
Title dropdown with Mr, Mrs, and Ms options. First name field, middle initial field, last name field. Two street address fields, City field, State dropdown, Zip field.
US Address
Standard US address.
Zip+4
Controls 45
You cant 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.
46
| Appendix B
Controls
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 Formvines 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.
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.
48
| Appendix B
Controls
Recommendations 49
Recommendations
Though we cant 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.
50
| Appendix B
Controls
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.
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 Formvine Trial subject line Formvine Trial registration activation
Default email text 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>
Formvine Trial email text 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>
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 Formvine Trial subject line Formvine Trial registration confirmed
Default email text 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.
Formvine Trial email text 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>
54
| Appendix C
Email text
The table below shows the password reset email for both implementations. Table 7 Password reset email Formvine Trial subject line Formvine Trial password reset
Default email text 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>
Formvine Trial email text 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>
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. Table 8 Notification to form submitter Formvine at TIBCO subject line Thank you for your response
Default email text This email was generated to let you know that your response has been received.
Formvine at TIBCO email text This email was generated to let you know your response was received.
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 9 Notification to email address submitted to form Formvine at TIBCO subject line A response was received
Default email text 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.
Formvine at TIBCO email text 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.
56
| Appendix C
Email text
The table below shows the subject line and text for the notification email thats 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 Default subject line A new response was received for "<project>" Notification to list of email addresses Formvine at TIBCO subject line A new response was received for "<project>"
Formvine at TIBCO email text Results were submitted for the Formvine project: "<project>"
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 thats 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 Default subject line You have been added to the Formvine project <project> Project owner add email Formvine at TIBCO subject line You have been added to the Formvine project <project>
Default email text 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>
Formvine at TIBCO email text 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>
58
| Appendix C
Email text
The table below shows the subject line and text for the system email thats sent when a project owner removes another project owner. We did not change this text for the Formvine at TIBCO implementation. Table 12 Default subject line You have been removed from the Formvine project <project> Project owner remove email Formvine at TIBCO subject line You have been removed from the Formvine project <project>
Default email text 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>
Formvine at TIBCO email text 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>