Installation and Implementation Checklists · 2015-06-09 · Installation and Implementation Checklists ... † RedHat Enterprise Linux Server 6.5 32-bit on x86 † RedHat Enterprise

Two-Second Adv

TIBCO Formvine®

Installation and Implementation ChecklistsSoftware Release 3.3.3June 2015

antage®

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 THE LICENSE FILE) 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.TIBCO, Two-Second Advantage, TIBCO Hawk, TIBCO Rendezvous, TIBCO Runtime Agent, TIBCO ActiveMatrix BusinessWorks, TIBCO Administrator, TIBCO Designer, TIBCO ActiveMatrix Service Gateway, TIBCO BusinessEvents, TIBCO BusinessConnect, and TIBCO BusinessConnect Trading Community Management are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise Edition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporation 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 © 2010-2015 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information

TIBCO Installation and Implementation Checklists

Contents | 4

Contents

Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Formvine documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Typographical conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

How to contact TIBCO support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chapter 1 System and installation requirements checklists . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapter 2 Branding checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 3 Advanced configuration checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Chapter 4 Controls customization checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Preface | 5

Preface

This document provides requirements checklists and is intended for the people installing and configuring TIBCO Formvine®. Each checklist provides a list of what to consider and the assets to gather prior to installing and configuring Formvine®.

Topics

• Formvine documentation, page 6

• Typographical conventions, page 8

• How to contact TIBCO support, page 9

For the latest version of this document, go to https://docs.tibco.com/products/tibco-formvine


Preface | 6

Formvine documentation

The following are included in the Formvine documentation set, which is available at: https://docs.tibco.com/products/tibco-formvine

• TIBCO Formvine Concepts Guide—Describes how Formvine addresses business needs and explains the characteristics of the people who use Formvine.

• TIBCO Formvine Installation and Implementation Checklists (this document)—Provides requirements checklists for installing and customizing Formvine.

• TIBCO Formvine Installation Guide—Provides installation instructions.

• TIBCO Formvine Implementation Guide—Explains options for customizing branding, the Formvine application, and Formvine controls. Provides instructions for implementing the customizations.

• TIBCO Formvine Email Customization Guide—Explains options for customizing messaging and provides instructions for implementing the customizations.

• TIBCO Formvine Administration Guide—Provides information on reporting, troubleshooting, and adding templates to your implementation

• TIBCO Formvine Application Programming Interface Reference Guide—Describes the TIBCO Formvine application programming interface (API).

• TIBCO Formvine External User Group Source Programming Interface Reference Guide—Describes the service provider interface to an external user group source.

Additional information about Formvine is available here:

• For the latest updates on Formvine installation and configuration requirements, see the readme file on the Formvine Documents page.

• For information on the current Formvine release, including closed and known issues, see the product release notes on the Formvine Documents page.

The Formvine Resource Center at resources.formvine.com hosts:

• Quick Install—Helps you install Formvine in minutes.

• Quick Start—Helps your project owners get started with Formvine.

• Help—Gives instructions on all aspects of using Formvine, and includes descriptions of all the Formvine templates.

• Videos—Links to the Formvine video channel, where you can see videos about using Formvine and integrating Formvine with other systems.


http://resources.formvine.com

Preface | 7

• TIBCOmmunity—Links to the Formvine TIBCOmmunity page, where you can get even more information about Formvine, ask questions, and participate in conversations to make the most of your Formvine installation.

• Tech Docs—Links to the Formvine documentation page at: https://docs.tibco.com/products/tibco-formvine

• Contact Us—Let us know how we can help.


https://docs.tibco.com/products/tibco-formvine

Preface | 8

Typographical conventions

The following typographical conventions are used in this manual.

Table 1 General typographical conventions

Convention Use

install_directory The directory where Formvine is installed.

TIBCO_FV_HOME The Formvine home directory: install_directory/fv/3.3

formvine_url URL for project owners to access Formvine, specified at installation:https://host:port/fv

italic font Italic font is used for new terms.

code font italic Variable name.

code font Commands, filenames, pathnames, property names and value, code examples, and command output.

bold code font Code that you type in a command window or a properties file.

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.

Security consideration. Check with your IT department and/or database administrator.


Preface | 9

How to contact TIBCO support

For comments or problems with this manual or the software it addresses, please contact TIBCO Support as follows:

• For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site:http://www.tibco.com/services/support

• If you already have a valid maintenance or support contract, visit this site:https://support.tibco.com

— Entry to this site requires a username and password. If you do not have a username, you can request one.


http://www.tibco.com/services/support

https://support.tibco.com

System and installation requirements checklists | 10

Chapter 1 System and installation requirements checklists

This chapter lists the system requirements for the TIBCO Formvine® production environment. It also includes the installation configuration checklist, a list of items you need to gather to configure your Formvine® implementation during and after the installation process.

You may want to consult with your IT department for help completing this table.

The latest Formvine system requirements are listed in the readme file. You can view the file in the Formvine home directory after extracting the Formvine archive, as described in the TIBCO Formvine Installation Guide, or go to: https://docs.tibco.com/products/tibco-formvine

Table 2 System requirements checklist

Requirement

Required operating system on Formvine machine:

• RedHat Enterprise Linux Server 6.5 32-bit on x86

• RedHat Enterprise Linux Server 6.5 64-bit on x86-64

• Microsoft Windows Server 2012 R2 64-bit on x86-64

• Microsoft Windows 7 SP1 32-bit on x86

• Microsoft Windows 7 SP1 64-bit on x86

Minimum free disk space requirements: 1GB



Requirements for available memory:

• Small installation (for proof-of-concept usage). Up to 200 projects, with an average of 1,000 records per project and 25 fields per record. Does not allow extended user concurrency

1 GB of memory with a 32-bit or 64-bit installation

• Medium installation. Up to 2,000 projects, with an average of 1,000 records per project and 25 fields per record. Allows up to 50 concurrent users

4 GB of memory and 64-bit installation.

• Large installation. More than 2,000 projects with an average of 1,000 records per project and 25 fields per record. Allows more than 50 concurrent users

8 GB of memory and a 64-bit installation

Mail server requirements:

• Access to an SMTP mail server

• Test email account (optional)

External database requirements (optional, only for installations using an external database):

• Access toOracle Database 11g 11.2.xor Microsoft SQL Server 2012or MySQL Server 5.6.x with the InnoDB Storage Engine

• Read-write access to the database

• Regular database backupsIf you are using the embedded Derby database, this access is not required.

Table 2 System requirements checklist (Cont’d)

Requirement



Source of users and groups. Read access to one of the following directories is required:

• tibbr 5.0.1 instance where users and groups are stored

• External users and groups source (XUGS) server

• Microsoft Active Directory 2003.x as corporate LDAP It is not necessary to install a new corporate directory. Formvine requires access only to an existing tibbr instance, XUGS server, or corporate directory to be able to obtain the user and group information. If you are using the Formvine directory for user registration, this access is not required.

Servlet container requirements:

• Access to the corporate servlet container (standard container that supports JDK 7 and Servlet Specification 3.0)

• Regular monitoringIf you are using embedded Tomcat, this access is not required.

Browser requirements for the project tools, used by named users to create and manage projects, flows, and data:

• Mozilla Firefox 27.0.x

• Microsoft Internet Explorer 8.0.x, 9.0.x, 10.0.x, 11.0.x

Browser requirements for the Formvine server, used to fill out forms and complete tasks:

• Mozilla Firefox 27.0.x

• Microsoft Internet Explorer 8.0.x, 9.0.x, 10.0.x, 11.0.x

• Google Chrome 32.0.x

• Apple Safari 5.1.x, Windows version, and 7.0.x, Mac version.

Table 2 System requirements checklist (Cont’d)

Requirement



The following table provides information for configuring your Formvine production environment. Consult with your IT department and corporate database administrator. For more detail about the requirements, consult the TIBCO Formvine Installation Guide at: https://docs.tibco.com/products/tibco-formvine

Table 3 Installation configuration checklist

Item Description Your values

Corporate systems engineer

Base Formvine URL URL to access Formvine for authenticated access.

Anonymous Formvine URL

URL to access Formvine for anonymous access.

Mail server • Host name

• Port

• Username

• Password

• Email account for emails generated by Formvine

• Monitored email account for support emails

• SMTP protocol: Plain/TLS/SSL

User authentication—tibbr source

• tibbr URL

• User ID for authenticate to tibbr server

• Password for account

• Recheck interval (in seconds)



User authentication—LDAP source

• URL of server

• Port

• Base DN for searching for users and groups

• Bind DN and bind password for the account that has access to users and groups

• Number of minutes after which LDAP group cache is to be reloaded

• Recheck interval (in seconds)

• User attributes for the Auto-Fill control

User authentication—XUGS source

• URL of server

• User ID for authentication to XUGS server

• Password for account

• Clearance setting for individual users (when on, users are cleared for activities in specific project spaces)

JMS notifications • JMS endpoint ID

• Title of JMS server

• JMS provider (Java class used by Formvine to connect to the JMS server)

• JMS server URL

• User name and password for authentication to the JMS server

• JMS topic to publish notifications

Table 3 Installation configuration checklist (Cont’d)




Impersonation • IDs of one or more users allowed to impersonate other Formvine users

• If a challenge-response image is enabled for impersonated users

• If a registration verification email is generated for an impersonated session

tibbr notifications • tibbr endpoint ID

• Name of tibbr instance

• tibbr server URL

• User name and password for the tibbr instance (identity is used for all tibbr posts).

File locations • Location where project files and attachments are stored (default is Formvine home directory)

• Location of temp files (default is inside Formvine home directory)

Access to Admin tool IDs of users who are permitted to access the Formvine Admin Tool. The Admin Tool is used to configure settings, including logging configuration, generate the Admin Report, and export and import projects.

Superowner IDs of users who are superowners. Superowners have access to all projects, data, and tasks.





Named users IDs of users who will be allowed to create projects.

Database administrator

External database • Database driver name

• Host name

• Port

• Database instance name

• Account credentials for user with read/write access




Branding checklist | 17

Chapter 2 Branding checklist

This checklist summarizes the assets you need to gather to customize the visual design and branding for TIBCO Formvine®. The checklist is organized by the people you need to collect data from. After you’ve gathered the requested information, work with your implementation engineer to apply the branding changes to Formvine®.

For more information, see the chapter called “Branding your Formvine implementation” in the TIBCO Formvine Implementation Guide, available on the Formvine Documents page at: https://docs.tibco.com/products/tibco-formvine

All customizations are optional. Options are available if you want to customize Formvine for your implementation and use case.

Table 4 Visual design and branding checklist

Category Description

Legal

Brand Corporate branding guidelines for use in Formvine.

Brand: Branding the Formvine Form Designer with your company name

This option adds your company name to the Formvine logo in the Form Designer, for example: Formvine at Example Company

Jot down the name exactly as you want it to appear in Formvine. If you use this option, Formvine determines how the name will be displayed.

Visual designer

Brand: Branding the Formvine Form Designer with your customized Formvine logo

This option allows you to use your customized brand in the Formvine Form Designer.

For this option, you need to host the new branded logo on a public website and point to the URL. The new branded logo must be a maximum of 41 pixels in height, but there is no restriction on width.


Branding checklist | 18

Brand: Replacing the Formvine logo in the entire application with your own logo

This option completely replaces the Formvine branded logo with your own logo. It’s replaced on the launch page, in the Form Designer, and in the header on user account and system emails. (You can also create a visual style for online forms using this logo.)

For this option, you need the graphic file for the Formvine logo with your company name (or other identifying text) that is 41 pixels high and 159 pixels in width. The Formvine logo (sized to 159x41 pixels) that will be replaced is located here:<TIBCO_FV_HOME>/WebContent/versionedfiles/images/logos/fv159x41.png

A 2x pixel version of this file is also needed for use in high resolution devices, like the iPhone 4+. File is located here:<TIBCO_FV_HOME>/WebContent/versionedfiles/images/logos/fv159x41_r.png

Back up files before changing.

Brand: Company logo for the header in notification emails

You can add your company logo to notification emails that are generated by Formvine.

You need the graphic file with your company logo. Height must be 41 pixels, width is variable.

Brand: Company logo for the footer in forms and notification emails

You can add your company logo to the footer of forms that users fill out and to the footer of notification emails.

You need the graphic file with your company logo, sized to 15 pixels high. The width is variable.

Brand: Visual style for submitter forms

You can design new styles for forms that users fill out. A new style can be exposed to all projects in the Form Designer or applied an individual project.

CSS for the specific style and color.

Copywriter

Footer links for launch page, Form Designer, online forms

Link text.

Table 4 Visual design and branding checklist (Cont’d)

Category Description


Advanced configuration checklist | 19

Chapter 3 Advanced configuration checklist

This checklist summarizes the assets you need to gather for setting advanced configuration properties for TIBCO Formvine®. The checklist is organized by the people you need to collect data from. After you’ve gathered the requested information, work with your implementation engineer to put the configurations in place.

More information is located in the “Advanced configuration options for the Formvine application” chapter of the TIBCO Formvine Implementation Guide, available on the Formvine Documents page at: https://docs.tibco.com/products/tibco-formvine

All configurations are optional. Options are available if you want to customize Formvine® for your implementation and use case.

Table 5 Advanced configuration checklist

Category Item Description Your values

Corporate systems engineer

User session Sign-in cookie limit

The number of days the sign-in cookie is remembered.

User session Sign-in cookie domain

The domain for the sign-in cookie.

User session Hash algorithm for sign-in cookie

Hash algorithm for user sign-in cookie checksum.

User session Length of HTTP session

The maximum number of minutes the Formvine HTTP session can remain inactive. After the specified amount of time, the session is released from memory.



User session Cache expiration

The maximum number of minutes after which the signed in user information cached in the HTTP session, including properties, status, and groups, expires.

Security Email domains for user registration

List of domains to accept or reject for user registration (Formvine directory implementations only).

Security Location of keystore file

Location of the file that contains encryption keys used by Formvine for encrypting passwords in properties files.

Security Encryption key

The key used for encryption and decryption of passwords in properties files.

Security Embedding of Formvine

Setting that controls embedding of Formvine in other applications.

Google analytics

Google analytics tracking

Track Formvine traffic (for both project owners and submitters).

Date and time format

Date and time display

The date and time format.

External library location

Path Path to location of vendor-specific third-party library.


Usage limits Projects per user

The maximum number of projects allowed per Formvine user.

Usage limits Fields per form

The maximum number of fields allowed on a Formvine form.

Table 5 Advanced configuration checklist (Cont’d)




Usage limits Size of Single Line Text field

The maximum number of characters allowed as data entry to a Single Line Text field. Between 100 and 255 characters.

User registration

Registration activation email

If enabled, requires that new registrants confirm their registration by clicking the activation link in an auto-generated registration email. (Formvine directory implementations only.)

User registration

Registration link

If enabled, displays link to Registration page on Sign-in page.

User registration

Password reset timeout

The number of hours during which the password reset link (sent in the reset password email) is active.

User registration

Hash algorithm for user password

Hash algorithm for encrypting user passwords in the Formvine user registration database (Formvine directory implementations only).

Challenge- response

CAPTCHA provider

The CAPTCHA provider, either Formvine or Google’s reCAPTCHA service.

Challenge- response for form submitters

Anonymous form security

Challenge-response image available for display on anonymous submitter forms.





Challenge- response for registration

Registration security

Challenge-response image enabled on Formvine registration page for registration security. (Formvine directory implementations only.)

Audit trail Audit log display

Allows audit logs to be stored in the Formvine database and makes the audit logs for the data records available in the Data view.

Legal

User registration

Click-through agreements

Text of agreement, formatted as an HTML page.

Copywriter

User registration

Click-through agreements

Link text for click-through agreement.

Notifications Missing variable

Default text to substitute in email notifications for variables corresponding to fields that no longer exist on the form.




Controls customization checklist | 23

Chapter 4 Controls customization checklist

This checklist contains summarizes the assets you need to gather for customizing TIBCO Formvine® controls. The checklist is organized by the people you need to collect data from. After you’ve gathered the requested information, work with your implementation engineer to put the customizations in place.

More information is located in the “Customizing controls” chapter of the TIBCO Formvine Implementation Guide, available on the Formvine Documents page at: https://docs.tibco.com/products/tibco-formvine

All customizations are optional. You don’t need to make any changes. These options are simply available to customize Formvine® for your implementation and use case.

Table 6 Control customization checklist

Category Description Your values


File upload Types of files that can be uploaded by submitters.

File upload Maximum file size.

Phone control Validation for locale.

Compound control types

Types of data that can be collected.


Controls customization checklist | 24

Visual designer

Compound control images

Visual design for image in spyglass thumbnail, sized to 240 pixels wide. Height is variable.

Visual design for image in Form Designer field list, sized to 24x24 pixels.

Note: The spyglass thumbnail is optional. However, you must have an image in the field list. You can just create a blank image and size it to 24x24 pixels.

Copywriter

File upload text

Text for help text on hover and instructional text.

Compound control text

Text for control name, labels for fields in control, help text on hover, instructional text and validation error text.

Table 6 Control customization checklist (Cont’d)

Category Description Your values
