+ All Categories
Home > Documents > TIBCO €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second...

TIBCO €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second...

Date post: 17-Sep-2020
Category:
Upload: others
View: 1 times
Download: 0 times
Share this document with a friend
56
TIBCO Formvine ® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage ®
Transcript
Page 1: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Two-Second Adv

TIBCO Formvine®

Administration GuideSoftware Release 3.3.1June 2013

antage®

Page 2: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

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. FOR THE AFOREMENTIONED LICENSES "NAMED USERS" SHALL MEAN IDENTIFIABLE INDIVIDUALS DESIGNATED AS AN 'OWNER', 'DESIGNER', OR 'DATA EDITOR' ASSOCIATED WITH A CURRENT PROJECT LISTED IN THE 'ADMIN REPORT' AS MORE FULLY DESCRIBED IN THE DOCUMENTATION FOR THIS PRODUCT. THE FOLLOWING USAGE RESTRICTIONS APPLY TO YOUR USE OF THE LICENSOR SOFTWARE:1. THE MODULE OF THE LICENSOR SOFTWARE CALLED TIBCO FORMVINE® PROJECT TOOLS ALLOWS LICENSOR TO CREATE AND MANAGE TIBCO FORMVINE® PROJECTS, AND TO VIEW, EDIT AND EXPORT THE DATA HANDLED AND PROCESSED BY TIBCO FORMVINE® SERVER SOFTWARE. ONLY THE NUMBER OF NAMED USERS LISTED IN ACCEPTED ORDER FORMS WHICH INCLUDE TIBCO FORMVINE® PROJECT TOOLS SHALL HAVE RIGHTS TO USE THE "PROJECT TOOLS" AS DEFINED IN THE DOCUMENTATION. 2. THE MODULE OF THE LICENSOR SOFTWARE CALLED TIBCO FORMVINE® INTEGRATION ADD-ON ALLOWS SOFTWARE OTHER THAN TIBCO FORMVINE® PROJECT TOOLS TO EXCHANGE INFORMATION WITH THE TIBCO FORMVINE® SERVER BY WAY OF TIBCO FORMVINE® SERVER'S APPLICATION PROGRAMMING INTERFACES ("FORMVINE® APIs"). ONLY TO THE EXTENT THAT ACCEPTED ORDER FORMS INCLUDE RIGHTS TO USE TIBCO FORMVINE® INTEGRATION ADD-ON, SHALL LICENSEE HAVE RIGHTS TO USE SOFTWARE OTHER THAN THE LICENSED TIBCO FORMVINE® PROJECT TOOLS IN CONJUNCTION WITH THE FORMVINE® APIs.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, The Power of Now, Two-Second Advantage, and TIBCO Formvine® are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or 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.

Page 3: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

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 © 2013 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information6/24/13

Page 4: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Contents | 4

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Typographical conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

How to contact TIBCO support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapter 1 Using the Admin Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Admin Tool overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Securing the Admin Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Accessing the Admin Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Configuring settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Using the Formvine Admin Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Exporting and importing projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Setting the log level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Chapter 2 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Adding a superowner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Retaining projects when moving from a proof-of-concept environment to a production environment . . . . . 24

Locating projects whose owner is no longer available . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Tracking down orphaned tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

What to do on error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Finding the version and build number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Installer error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Server startup error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Formvine server operational error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Encrypting and decrypting passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Configuring logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Logging appenders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Global settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Formvine log file appender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Formvine JMS appender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Audit log file appender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Additional log file appenders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Fault codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41How fault codes are displayed in Formvine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

TIBCO Formvine Administration Guide

Page 5: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Contents | 5

Chapter 3 Adding templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Adding a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

TIBCO Formvine Administration Guide

Page 6: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Preface | 6

Preface

This document is for engineers and administrators in charge of monitoring and maintaining a TIBCO Formvine® implementation. It contains information on using the Admin Tool, troubleshooting your Formvine® implementation, and instructions on how to add templates to the template library.

Topics

• Related documentation, page 7

• Typographical conventions, page 9

• How to contact TIBCO support, page 10

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

TIBCO Formvine Administration Guide

Page 7: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Preface | 7

Related 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—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 (this document)—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 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.

TIBCO Formvine Administration Guide

Page 8: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Preface | 8

• 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.

TIBCO Formvine Administration Guide

Page 9: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Preface | 9

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:http://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.

TIBCO Formvine Administration Guide

Page 10: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Preface | 10

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.

TIBCO Formvine Administration Guide

Page 11: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

| 11

Chapter 1 Using the Admin Tool

This chapter describes the TIBCO Formvine® Admin Tool. The Admin Tool is the management tool for Formvine®. It allows you to configure the most commonly modified application properties, view a report that shows how your project owners are using Formvine, export and import project files, and determine log settings for the current session.

Changes made to the Admin Tool, including log settings, are carried forward on upgrade.

Topics

• Admin Tool overview, page 12

• Securing the Admin Tool, page 13

• Accessing the Admin Tool, page 14

• Configuring settings, page 15

• Using the Formvine Admin Report, page 17

• Exporting and importing projects, page 18

• Setting the log level, page 21

TIBCO Formvine Administration Guide

Page 12: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Admin Tool overview | 12

Admin Tool overview

Use the Admin Tool for these Formvine management functions:

• Update branding.

• Change settings, including the system URL, SMTP host configuration, registration settings, number of projects per account, and file attachment configuration.

• Generate the Admin Report containing the number of named users, the number of project owners and projects, and the number of records for each project.

• Export and import Formvine projects, settings, tasks, and data.

• Change the logging level of the Formvine logging appender.

TIBCO Formvine Administration Guide

Page 13: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Securing the Admin Tool | 13

Securing the Admin Tool

Before going into production, make sure that access to the Admin Tool is secure. This is important because the Admin Tool can re-configure some critical aspects of your Formvine implementation and because it allows access to all Formvine projects and to all data. We recommend that you limit the number of people who can access the Admin Tool to maintain data integrity and privacy.

Secure the Admin Tool

• File to edit: TIBCO_FV_HOME/config/administration.properties

• Property to edit: fv.admin.users

• Add a comma-separated list of IDs of the users permitted to access the Admin Tool. Specify IDs in the format that people use to sign in to Formvine, for example: jsmith or [email protected]

IMPORTANT NOTE: You don’t have to stop and restart the server for changes to administration.properties to take effect. The list of authorized users, and changes to the list, are immediately available on file save.

TIBCO Formvine Administration Guide

Page 14: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Accessing the Admin Tool | 14

Accessing the Admin Tool

To access the Admin Tool, start Formvine and go to:

formvine_url/secure

Sign in to open the Home page. If you are not authorized to use the Admin Tool, the Formvine “Unauthorized access not allowed” page is displayed.

Figure 1 Admin Tool Home page

The Home page includes tabs for the Admin Tool functions, as well as buttons to launch Formvine, go to the Formvine Resource Center, and open a form that allows you to submit a request to Sales.

TIBCO Formvine Administration Guide

Page 15: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Configuring settings | 15

Configuring settings

The Settings tab allows you to set some of the most commonly used application properties. You can make changes on this tab while the Formvine server is running and see the change right after you click the Save settings button at the bottom of the tab. Changes are written to properties files and are retained when you restart the Formvine server.

Settings are listed in Table 2.

Table 2 Admin Tool settings

Item Description

System URL

The URL to access Formvine. This is the URL on which the Formvine application is installed or deployed. The URL is the same for authenticated and anonymous access. Note: The URL is the same for authenticated and anonymous access when Formvine is implemented using SS0.

Audit trail display

Causes audit logging to start saving to the database rather than to the log file. When on, the audit trail is exposed in the Data View. On by default.

Brand Branding options for page headers in Formvine.

• Formvine logo only (default): Display only the Formvine logo.

• Formvine: Include your company name along with the Formvine logo.

• URL to your company logo (41px high x 159px wide): Your company logo is displayed in place of the Formvine logo.

TIBCO Formvine Administration Guide

Page 16: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Configuring settings | 16

System emails

The name and email address to use as the “From” address for Formvine emails. New emails are sent out from this email address. Enter as: Name <email address>Example: Admin <[email protected]>

SMTP The SMTP server used for all Formvine emails. Host: The SMTP server host name.Port: The port on which the SMTP server is configured.User name: The user name to authenticate to the SMTP server.Password: The password to authenticate to the SMTP server.

Registration For Formvine directory installations, determine who can register Formvine.Limit registrations

• Anyone can register: Allow anyone to register.

• Limit to email addresses in these domains: Specify domains from which registrations are permitted. Separate multiple domains with a single space. For example: examplecompany1.com examplecompany2.com

Registration challenge-response

• Select the checkbox to require response to a challenge-response question to complete registration.

Number of projects per account

The maximum number of projects per project owner. To allow an unlimited number, leave the field blank (default).

File upload For forms that contain a File Upload field:

• Indicate what file types are permitted for upload (default jpg/jpeg, gif, png).

• To add file types not listed, check Other and enter the file extension as a comma-separated list, for example:txt,bmp,mov,mp3

• Choose the maximum upload file size: 1 MB, 10 MB (default), or 100 MB.

Table 2 Admin Tool settings

Item Description

TIBCO Formvine Administration Guide

Page 17: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Using the Formvine Admin Report | 17

Using the Formvine Admin Report

The Report tab displays the Formvine Admin Report, which provides summary information about the Formvine installation along with a list of all current projects.

The report also lists the number of named users for licensing purposes. Formvine is in part licensed based on the number of named users, including project owners, designers, and data editors. The total number of named users is listed in the top section of the Admin Report, as shown in Figure 2.

Figure 2 Formvine Admin Report

TIBCO Formvine Administration Guide

Page 18: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Exporting and importing projects | 18

Exporting and importing projects

The Import/Export tab allows you to export a project from one Formvine instance and import it into another instance for the same Formvine release. You can also use this tool to import a project created using Formvine 3.1.x or 3.2.x or with another Formvine 3.3 implementation.

• Export includes the confirmation page, thank you page, and other settings. It does not include the audit history or list of authorized users.

• Import includes the confirmation page, thank you page, and other settings.

— Authorized submitters are not imported and the form is set to accept only anonymous submissions.

— Audit history from the original project is not carried over.

To export a project, you need the form URL or the project’s 10-digit space ID. To import a project, you need access to the prj or zip file that was saved on project export, as well as the email address or ID of the new project owner.

Export a Formvine project

1. Locate the 10-digit space ID for the project you want to export. You can find this ID by clicking Share on the Project Home page, illustrated below.

Figure 3 Copying the project URL

For Derby and MySQL database configurations: If the project you are trying to export or import uses Chinese characters (or any other non-English characters) in the project title or description, the project name and description is displayed as ??/?? after import to Formvine 3.3. You can continue to use those projects in a Formvine 3.2 implementation.

TIBCO Formvine Administration Guide

Page 19: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Exporting and importing projects | 19

2. Paste the project’s 10-digit space ID into the Form URL / Space ID field on the Import/Export tab of the Admin tool. (You can also include the 4-digit project ID or just paste in the complete form URL.)

3. Select Include data records and tasks in export if you want to include submitted data in the export.

4. Click Export project.

Import a Formvine project

1. In the Project import area of the Import/Export tab, click Browse to locate the project file to import. A project file is a file that was previously exported with Project export and has a prj or zip extension.

2. Select the Import data records and Import tasks checkboxes if you want to include data records and tasks in the import.

3. Choose the new project owner:

— For Formvine directory implementations, enter the email address of the person who will be the new project owner in the Owner email field. The email address must be for a valid user in this Formvine instance (the instance that is target of the import).

— For Formvine LDAP implementations, enter the ID of the person who will be the new project owner in the Owner ID field. The ID must be that of a valid user in this Formvine instance (the instance that is target of the import).

4. Click Import project. (This may take a few minutes; wait for a confirmation message. Only click Import project one time.) On success, a confirmation message is displayed and the project is displayed in the owner’s My Projects list.

5. A project owner should review a newly imported project and verify settings before putting it online.

TIBCO Formvine Administration Guide

Page 20: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Exporting and importing projects | 20

The following issues pertain to imported projects:

• By default, authenticated projects are always set to anonymous submission.

• No existing settings are retained for submitter notification.

• For projects with task flows:

— If the task assignee is selected from a field on the form, the task assignee is set to “Unknown User” for existing pending tasks, even if the assignee exists in the new Formvine environment. However, for tasks created after import, the task is assigned to the assignee entered into the assigned form field.

— If the task assignee was assigned by a user ID or email address entered into the Task assignee dialog box, the task assignee is set to “Unknown User” for existing pending tasks, even if the assignee exists in the new Formvine environment. However, for tasks created after import, the task is assigned to the assigned user, if valid in the new environment. Otherwise, "Unknown User" is displayed.

• The project ID is not maintained. The URL to access the project forms is not the same as that of the exported project.

TIBCO Formvine Administration Guide

Page 21: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Setting the log level | 21

Setting the log level

Use the Change Log Level page set to logging levels for the Formvine logging appenders for the current session. Changes you make on this page apply to the current session.

The levels are listed from least restrictive logging to most restrictive. If you select a level, logs for that level and all higher levels are included. For example, the default INFO level includes INFO, WARN, and ERROR log messages.

To set the logging level, choose from the dropdown list and click Save Log Level. The new log level is shown at the top of the page.

Figure 4 Formvine appender log level

TIBCO Formvine Administration Guide

Page 22: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

| 22

Chapter 2 Troubleshooting

This chapter provides troubleshooting information for your TIBCO Formvine® installation, including how to find the Formvine® version number and how to configure logging. Server fault codes are also listed.

Topics

• Adding a superowner, page 23

• Locating projects whose owner is no longer available, page 25

• Tracking down orphaned tasks, page 26

• What to do on error, page 27

• Encrypting and decrypting passwords, page 32

• Configuring logging, page 33

• Fault codes, page 41

TIBCO Formvine Administration Guide

Page 23: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Adding a superowner | 23

Adding a superowner

Formvine supports a superowner user. A superowner has project owner access to all projects, including forms, tasks, and data. When a superowner signs in to Formvine, all projects in the database are displayed on the My Projects page.

A superowner can:

• Support other Formvine users.

• Rescue orphaned projects.

• Help with form design or any other Formvine interaction.

• Recover or take ownership of a project whose project owner is no longer available (for example, if the project owner has left the company).

• Disable or delete any projects.

Because a superowner has unrestricted rights, it’s important to limit the assignment of superowner rights to a highly responsible administrator and to protect the login credentials from being used by others. The best idea is to create an account in Formvine specifically for a superowner. Do not give an existing Formvine user superowner rights. If the number of Formvine users is large, a superowner will have access to many projects, and it might be difficult for a project owner to distinguish personally owned projects from other projects.

Add a superowner

• File to edit: TIBCO_FV_HOME/config/administration.properties

• Property to edit: fv.superowner.users

• Add a comma-separated list of IDs of the users who are granted superowner rights. Specify IDs in the format that people use to sign in to Formvine, for example: jsmith or [email protected]

IMPORTANT NOTE: You don’t have to stop and restart the server for changes to administration.properties to take effect. The list of authorized users, and changes to the list, are immediately available on file save.

TIBCO Formvine Administration Guide

Page 24: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Adding a superowner | 24

Retaining projects when moving from a proof-of-concept environment to a production environment

If you have been using a proof-of-concept Formvine environment with a local Formvine directory for user and group authentication, and then move to a corporate directory (LDAP) or external users and groups source (XUGS) for your production environment, all Formvine projects can still be accessed by signing in as a superowner. A superowner can access all forms, tasks, and data. Earlier audit logs are visible.

All previous submitters and assigned project roles are removed. All users referenced in notifications are modified. The name of each recipient is retained in the project XML file, but is not available in the Set up notifications dialog box. A superowner can rebuild the submitters list, the project roles list, as well as recreate notification settings. Alternatively, a project owner can add a project owner and that owner can edit the project.

TIBCO Formvine Administration Guide

Page 25: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Locating projects whose owner is no longer available | 25

Locating projects whose owner is no longer available

When project owners leave your enterprise, you might have projects in your database that cannot be accessed. You can locate these projects with the Admin Report. A superowner can then act on these projects, either by adding another project owner or by deleting the project.

To locate projects with unavailable owners

1. Open the Admin Tool. See the section called Accessing the Admin Tool, page 14 for information.

2. Run the Admin Report. See the section called Using the Formvine Admin Report, page 17 for information.

3. Scan the Owners column for users who are no longer with your enterprise.

TIBCO Formvine Administration Guide

Page 26: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Tracking down orphaned tasks | 26

Tracking down orphaned tasks

If a task assignee leaves your enterprise, project owners might have pending tasks that are uncompleted. As administrator, you may receive questions from project owners on how to reassign these tasks. A Formvine superowner can also reassign orphaned tasks.

Tasks can be reassigned using one of two methods:

• If task assignment was based on a form field, provide project owners with the instructions in Section A.

• If task assignment was based on an email address, provide the instructions in Section B.

Section A: Locate and reassign tasks when task assignment is based on a form field

The steps in this section can be completed by project owners or data editors.

1. Open the Project Home page for the project.

2. Click the submissions link to open the Data view.

3. Scan the column for the field on the form that is being used to collect the email address for the task assignee.

4. When you locate a record with a task assignee who is no longer with your company, click the Actions dropdown and choose Edit.

5. Click Yes, continue edit on the Warning - Record is in process dialog box.

6. Scroll to the form field that is being used to collect the task assignee email address.

7. Change it to the new task assignee and save the record.

The task is reassigned.

Section B: Locate and reassign tasks when task assignment is based on an email address

The steps in this section can be completed only by project owners.

1. Open the task form for editing.

2. Click Assignee to open the Assignee dialog box.

3. Change the task assignee in the Define task assignee box. Click Apply changes. This action reassigns all pending tasks to the new task assignee.

TIBCO Formvine Administration Guide

Page 27: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

What to do on error | 27

What to do on error

During the normal course of operations, Formvine can generate errors. You might see error messages when you install Formvine or when you start the server. You might also have to field questions from project owners, or from owners on behalf of form submitters. In addition, you might experience errors when you attempt to complete additional actions with Formvine, such as exporting projects from one Formvine instance and importing them into another.

This section gives you some resources to start tracking down the source of error messages. If you have to contact Support, you will be asked for your Formvine version and build number. Support might also request that you email log files.

Finding the version and build numberThe Formvine version number is displayed in the footer on each Formvine page, on forms submitters fill out, and on tasks that task assignees complete. To view the build number, hover over the version number, as illustrated below.

Figure 5 Version and build number in Formvine footer

The version and build are also displayed in the Admin Report.

Figure 6 Version and build number in Admin Report

TIBCO Formvine Administration Guide

Page 28: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

What to do on error | 28

Installer error messagesThe Formvine installer generates an error if the data entered does not meet validation. For example, if you remove the value specified for a Tomcat port field on the Embedded Tomcat Settings screen or enter a non-integer value, you’ll see an error.

If you inadvertently enter data into the installer that is not valid for your implementation, such as conflicting port numbers or an invalid SMTP host, the Formvine server might fail on startup. It is also possible to install Formvine without specifying an SMTP host or other details. These types of errors are not flagged at installation, but are flagged when you start the server.

Server startup error messagesWhen you start the Formvine server, the startup batch file displays the progress of the startup routine. Messages are displayed on the console on a Windows platform. On a Linux platform, these messages are available in the catalina.log file.

SMTP connection errors on startup

If you did not complete the details on the SMTP page of the installer and did not subsequently set these properties in the email.properties file, you’ll see the following error message displayed in a Windows console when you start the server.

Figure 7 SMTP connection errors on startup

If you see this error, open the TIBCO_FV_HOME/config/email.properties file and verify the SMTP server details. For more details, see the installation chapter in the TIBCO Formvine Installation Guide.

TIBCO Formvine Administration Guide

Page 29: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

What to do on error | 29

You might also see this error if the SMTP server is not accessible, if you provided the wrong authentication information, or if the port is blocked by the firewall or virus scanners.

Some anti-virus programs deny access to the mail port by default. This causes the SMTP server configuration to fail on Formvine server start up. You might have to modify anti-virus settings.

Authentication errors on startup

Startup errors can also be displayed if you are connecting to an LDAP or XUGS server for the source of users and groups and there are problems with the connection. If you see LDAP or XUGS connection errors, open the TIBCO_FV_HOME/config/usergroupsource.properties file and verify the LDAP or XUGS server details. For more details, see the installation chapter in the TIBCO Formvine Installation Guide.

JMS connection errors on startup

You can also see startup errors if you are connecting to a JMS endpoint and there are problems with the connection, for example, if the server is not started or the credentials are incorrect. The following example shows error messages on a Windows platform related to a JMS endpoint.

Figure 8 JMS connection errors on startup

If you see these types of errors, open the TIBCO_FV_HOME/config/jms.properties file and verify the endpoint details. Make sure the JMS server is running. For more details, see the section on configuring a JMS server connection in the TIBCO Formvine Installation Guide.

TIBCO Formvine Administration Guide

Page 30: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

What to do on error | 30

tibbr connection errors on startup

If you are connecting to a tibbr endpoint and there are problems with the connection, for example, if the server is not started or the credentials are incorrect, you might see errors on startup. An example of tibbr connection errors on startup on Windows is displayed below.

Figure 9 tibbr connection errors on startup

If you see these types of errors, open the TIBCO_FV_HOME/config/tibbr.properties file and verify the endpoint details. Make sure the tibbr server is running. For more details, see the section on configuring a tibbr server connection in the TIBCO Formvine Installation Guide.

Formvine server operational error messagesVarious error messages can be displayed at registration, for example, if the email address is already registered or if the password and confirm password don’t match. When someone is signing in to use the project tools, fill out an online form, or complete a task, error messages similar to "Username and password don’t match an existing account" might be displayed. These types of errors are displayed right on the form and can be fixed immediately.

If there are errors when a project owner or form designer tries to save a form, a server error with an identifying number and information message is displayed in a dialog box. If you need more information about the error, have the error number in hand when you contact Support.

Errors can also occur when a submitter is filling out a form and does not complete all required fields. In this case, Formvine displays a "Required field is missing" error. If data does not meet validation requirements, Formvine generates a validation error message with guidance on what type of data is accepted, allowing the submitter to fix the error immediately.

TIBCO Formvine Administration Guide

Page 31: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

What to do on error | 31

A form submitter might also see a server error if there’s a problem with the server, for example, if the server stopped running while the submitter was filling out a form. Other error conditions include too many characters in a Single-Line Text field or an error on file upload. Some of these errors can be fixed immediately; others might require input from you, as the Formvine administrator.

TIBCO Formvine Administration Guide

Page 32: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Encrypting and decrypting passwords | 32

Encrypting and decrypting passwords

On Formvine server startup, all password properties set in various configuration files and the log.lcf file are encrypted. If the server cannot start due to a critical configuration error, you must fix the error and restart the server. However, at this point, passwords are encrypted. There is no way to recover the clear text password.

The encryptor utility in the TIBCO_FV_HOME/bin folder can decrypt and encrypt passwords in the TIBCO_FV_HOME/config folder.

Decrypt and encrypt passwords

1. Navigate to the TIBCO_FV_HOME/bin folder.

2. Run the encryptor utility, putting the input strings in double quotes, followed by the argument:

— -e: encrypts the input string

— -d: decrypt the input string

3. The encrypted or decrypted string is returned.

Examples

encryptor.bat "abc123" -e

encryptor.bat "enc://1k6vo6n58uk=" -d

encryptor.sh "abc123" -e

encryptor.sh "enc://1k6vo6n58uk=" -d

TIBCO Formvine Administration Guide

Page 33: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Configuring logging | 33

Configuring logging

The Formvine application and its components generate multiple log files. Logs are generated by Formvine itself and by third-party components that Formvine uses. Log file configuration follows the log4j configuration standards. Refer to log4j documentation for detailed information on configuration parameters.

The log files created by Formvine are written to the TIBCO_FV_HOME/logs folder. If you contact TIBCO support, your support representative will most likely ask you to send the appropriate log file.

Set a background job to continually parse the log files searching for error conditions, indicated by [ERROR]. When an error condition is discovered, it is usually accompanied by stack trace.

All logging configuration is customized in the TIBCO_FV_HOME/config/log.lcf file. Use this file to set up and customize logging appenders. By default, logging for the Formvine application is enabled. In addition to Formvine logging, the servlet container in which Formvine is hosted also generates its own log. Logs from the embedded Tomcat servlet container are written to the TIBCO_FV_HOME/tomcat/logs folder.

Logging appendersThe Formvine application can generate the following types of logging appenders:

• The Formvine log file appender enables the Formvine application log to be written to the TIBCO_FV_HOME/logs folder. This appender is always enabled.

• The Formvine JMS appender enables Formvine to send all logging activities as JMS messages. This appender is not enabled by default.

• The Formvine audit log appender records transactions, either to the database or to a file.

• The Formvine audit log appender records transactions to a file. This appender is always enabled. When audit logging is set to the database, this appender does not log any activity in the file. All transactions are logged to the database. (This property is configured in the TIBCO_FV_HOME/config/features.properties file.)

• Additional log appenders are created by third-party client libraries, such as JPA, Spring, and JMS. These appenders are always enabled.

TIBCO Formvine Administration Guide

Page 34: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Configuring logging | 34

Global settingsYou can enable multiple logging appenders in addition to the formvine appender. To add additional logging appenders, add their names to the log4j.rootLogger property in the Global Settings section of the log.lcf file. See the comments in the log.lcf file for more information.

You can also set the global logging level for all appenders. Logging levels are TRACE, DEBUG, INFO, WARN, ERROR and FATAL. TRACE is the least restrictive and FATAL is the most restrictive. For diagnostics, set the logging level to DEBUG or TRACE. For production mode, set the level to INFO.

Set the logging level and appenders

File to edit: TIBCO_FV_HOME/config/log.lcf

Section to edit: Formvine Application Log - Global Settings

After editing, save the file and restart the server.

Global logging levels apply to all logging appenders. In case an individual logging appender overrides the global level by specifying a threshold, then the more restrictive logging level of the two is applied to that logging appender.

Property Configuration information

Logging level Default global logging level. Change default value (in bold) only if needed.

log4j.rootLogger = INFO, formvine

Global log level

Specifying a level includes all higher levels. The list below displays options, in order from lowest (least restrictive) to highest (most restrictive):TRACE: Records fine-grained informational events.DEBUG: Records fine-grained informational events that help in debugging. Useful for diagnostics.INFO: Records informational messages that highlight the progress of the application. Useful for production mode.WARN: Records potentially harmful situations.ERROR: Records error events harmful enough to prevent the application from running.FATAL: Designates very severe error events that will presumably lead the application to fail.

TIBCO Formvine Administration Guide

Page 35: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Configuring logging | 35

Appender Name of default appender. Change default value (in bold) only if needed.

log4j.rootLogger = INFO, formvine

Appenders

A comma-separated list of one or more appenders to enable. By default, only the Formvine log file appender, formvine, is included. More appenders, such as Formvine JMS appenders can be added to this list. (Note that some appenders, such as audit and third-party client library appenders are enabled whether these names are added to this list or not).

Property Configuration information

TIBCO Formvine Administration Guide

Page 36: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Configuring logging | 36

Formvine log file appenderAll application activity, from user sign in to sign out, is written to the Formvine log file appender. Output is formatted according to settings in the log.lcf file.

Configure the Formvine appender

File to edit: TIBCO_FV_HOME/config/log.lcf

Section to edit: Formvine Application Log - File Appender

After editing, save the file and restart the server.

Property Configuration information

Log filename and location

Absolute path to the log file. Change default value (in bold) only if needed.

log4j.appender.formvine.File = ${TIBCO_FV_HOME}/logs/formvine.log.

Output format Pattern of output written to log file. Change default value (in bold) only if needed.

log4j.appender.formvine.layout.ConversionPattern = %d{ISO8601} [%t] [%c] [%p] - %m%n

Where: %d{ISO8601}: The date of the logging event, followed by the date format specifier, in braces.[%t]: The thread that generated the logging event.[%c]: The category of the logging event.[%p]: The priority of the logging event.-%m%n: The application supplied message (%m) associated with the logging event, followed by the platform-dependent line separator character (%n).Note: For additional information on the output format, see http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/PatternLayout.html

Maximum file size

Maximum file size in MB. Change default value (in bold only if needed.

log4j.appender.formvine.MaxFileSize = 100MB

Maximum number of backups

Number of backups before a new file is created. Change default value (in bold) only if needed.

log4j.appender.formvine.MaxBackupIndex = 5

TIBCO Formvine Administration Guide

Page 37: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Configuring logging | 37

Logging level Logging level. Change default value (in bold) only if needed.

log4j.appender.formvine.threshold = TRACE

Specifying a level includes all higher levels. The more restrictive level, between this level and the global setting, applies.Options are the following, in order from lowest (least restrictive) to highest (most restrictive):TRACE: Records fine-grained informational events.DEBUG: Records fine-grained informational events that help in debugging. Useful for diagnostics.INFO: Records informational messages that highlight the progress of the application. Useful for production mode.WARN: Records potentially harmful situations.ERROR: Records error events harmful enough to preventthe application from running.FATAL: Designates very severe error events that will presumably lead the application to fail.

Property Configuration information

TIBCO Formvine Administration Guide

Page 38: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Configuring logging | 38

Formvine JMS appenderThe Formvine JMS appender enables Formvine to send all logging activities as JMS messages. Examples of JMS log file appenders are in the Formvine Application Log - A Sample JMS Appender and the Formvine Application Log - Another Sample JMS Appender sections of the log.lcf file. The first example is configured for the TIBCO JMS server and the second example is configured for the Apache ActiveMQ server.

Set up logging

1. Navigate to the TIBCO_FV_HOME/config folder.

2. Open features.properties and set the fv.resources.external.lib property to point to the location of Formvine’s external libraries. Save the file.

3. Copy required libraries to the external library location:

— For the TIBCO JMS server, copy tibjms.jar, tibcrypt.jar (if using SSL) and jms.jar.

— For Apache ActiveMQ, copy activemq-all-5.6.0.jar (or any other version, as appropriate).

4. Open log.lcf and scroll to the section of the log configuration file for the JMS server you’re using. Uncomment all lines of code in this section. See the comments in the log file for information on properties.

— Note that the more restrictive level for the property (specified here and in the Global Settings section of the file) applies.

5. Add the name of this appender to the Global Settings section of the file in the <appender(s)> list. The name of JMS appenders s the one that you use in the name of these properties. For example, the names of the appenders in the sample JMS appender sections are tibcorporate and mqmarketing.

6. Save the file and restart the server.

TIBCO Formvine Administration Guide

Page 39: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Configuring logging | 39

Audit log file appenderThe audit log file appender records audit information in the TIBCO_FV_HOME/logs/audit.log file. This appender is active only if the fv.audit.db.logging property in the TIBCO_FV_HOME/config/features.properties file is set to false. If this property is set to true, audit logs are stored in the Formvine database and not in the audit log file. If this property is set to false, configure the audit log file appender, as outlined below.

Configure the audit log

File to edit: TIBCO_FV_HOME/config/log.lcf

Section to edit: Formvine Audit Log

After editing, save the file and restart the server.

Property Configuration information

Appender accumulation

The addtivity property for the custom AUDIT logging level. Change default value (in bold) only if needed.

log4j.additivity.AUDIT = false

Log filename and location

The filename and path to the audit log file. Change default value (in bold) only if needed.

log4j.appender.audit.File = ${TIBCO_FV_HOME}/logs/audit.log.

Output format Pattern of output written to log file. Change default value (in bold) only if needed.

log4j.appender.audit.layout.ConversionPattern = %d{ISO8601} [%t] [%x] [%p] - %m%n

Where: %d{ISO8601}: The date of the logging event, followed by the date format specifier, in braces.[%t]: The thread that generated the logging event.[%x]: The nested diagnostic context (NDC) associated with the thread that generated the logging event.[%p]: The priority of the logging event.-%m%n: The application supplied message (%m) associated with the logging event, followed by the platform-dependent line separator character (%n).Note: For additional information on the output format, see http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/PatternLayout.html

TIBCO Formvine Administration Guide

Page 40: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Configuring logging | 40

Additional log file appendersAdditional logging appenders are created by third-party client libraries used by Formvine, including Spring, JPA, the TIBCO JMS server, and ActiveMQ. There are sections for these appenders in the log.lcf file for customizing filename, layout, size, number of backups, logging level. Refer to the log.lcf file for details.

Maximum file size

Maximum file size in MB. Change default value (in bold only if needed.

log4j.appender.audit.MaxFileSize = 100MB

Maximum number of backups

Number of backups. Change default value (in bold) only if needed.

log4j.appender.audit.MaxBackupIndex = 5

Custom logging level

Creates the custom logging level. Do not edit this property.

log4j.logger.AUDIT = AUDIT#com.tibco.fv.utils.log.log4j.CustomLogLevel,audit

Threshold Logging level. Change default value (in bold) only if needed.log4j.logger.MODEL = TRACE

The more restrictive level for this property (specified here and in the Global Settings section of the file) applies.Options are the following, in order from lowest (least restrictive) to highest (most restrictive):TRACE: Records fine-grained informational events.DEBUG: Records fine-grained informational events that help in debugging. Useful for diagnostics.INFO: Records informational messages that highlight the progress of the application. Useful for production mode.WARN: Records potentially harmful situations.ERROR: Records error events harmful enough to preventthe application from running.FATAL: Designates very severe error events that will presumably lead the application to fail.

Property Configuration information

TIBCO Formvine Administration Guide

Page 41: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Fault codes | 41

Fault codes

This section contains the full list of possible fault codes that can be returned by Formvine services. Fault codes are numbered according to the service to which they apply. (A service is a Web API service exposed by the Formvine server.)

Table 3 shows the correspondence between the fault code ranges and services, and Table 4 lists all of the fault codes.

Table 3 Fault codes ranges

Code Service

100-199 Data store

200-299 Task manager

300-399 Server

400-499 User

500-599 Data service

600-699 Group

700-799 Reserved for future use

800-899 Space

900-999 Common

TIBCO Formvine Administration Guide

Page 42: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Fault codes | 42

Table 4 Formvine fault codes

Code Fault Detailed Message

Data store mesages

101 Invalid data type

The indicated value cannot be set for the indicated type field. Value: {0} Type field: {1}

102 Data field not found

The indicated data field cannot be found in the indicated project. Data field: {0} Project: {1}

103 Data record not found

The indicated data record cannot be found. Data record ID: {0}

104 File not added The file attachment could not be added to the record.

105 Could not read multipart file

An error occurred while reading the indicated file. File: {0}

106 Not original submitter

Only the original submitter can update or remove the record.

107 Field size limit exceeded

Your entry exceeded the maximum number of characters allowed for a single-line text box. Enter your answer again. Maximum characters: {0}

108 Partial submission not allowed

This project does not accept partial submissions.

109 Cannot changed submitted to partial

A submitted record cannot be changed back to a partial state.

110 Record in process

This record is in process; it cannot be modified or deleted.

111 Finalized record

This record is finalized. It cannot be modified or deleted.

112 Finalize not allowed

This record is not allowed to be finalized.

TIBCO Formvine Administration Guide

Page 43: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Fault codes | 43

113 File not uploaded

The indicated file attachment could not be uploaded. File: {0}

115 Invalid record state

A record state was specified that is invalid. Record state: {0}

116 Partial record cannot complete

This partical record could not be completed.

151 Data column not found

The indicated data column could not be found in the indicated project. Data column: {0}; Project: {1}

Task manager messages

201 Task not pending

The indicated task is not pending; it is complete or cancelled. Task ID: {0}

202 Task not found

The specified task could not be found.

Server messages

301 Captcha service unavailable

The Captcha service is not enabled for this installation.

User messages

401 User not found

Sorry, we cannot find an account for the specified user. User: {0}

402 User not confirmed

The specified email address has not been confirmed. Open the registration email and click the Confirm Registration link. Email address: {0}

403 User has already registered

The specified email address is already registered. Email address: {0}

Table 4 Formvine fault codes (Cont’d)

Code Fault Detailed Message

TIBCO Formvine Administration Guide

Page 44: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Fault codes | 44

404 User has already been confirmed

The specified email address is already confirmed. Go to the Sign in page to sign in. If required, you can click the "Forgot your password?" link to reset your password. Email address: {0}

405 User and password invalid

The user and password combination doesn’t match an existing user account.

406 User and confirmation key invalid

Check your email to make sure that the confirmation link was not corrupted and click the link again.

407 User, password, and confirmation key invalid

The password does not match the email address.

408 User password incorrect

The password provided for the specified user is incorrect. User: {0}

409 Password reset period expired

The password reset period is expired. Send a new request to reset your password.

410 Setting not found

Could not find a setting with the specified ID. ID: {0}

411 Invalid password

The password is invalid.

412 Operation not applicable for user type

This operation is not applicable for this type of user. User: {0}

413 Another user's email

The specified email address belongs to another user and cannot be used. Email address: {0}

414 The email domain not allowed

The email address associated with this domain is not allowed to register on Formvine. Email address: {0}; Domain: {1}

Table 4 Formvine fault codes (Cont’d)

Code Fault Detailed Message

TIBCO Formvine Administration Guide

Page 45: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Fault codes | 45

415 Invalid impersonatee ID

The user being impersonated is invalid. ID: {0}

416 Not authorized to impersonate

The user is not allowed to impersonate another user.

418 Multi- property user search unsupported

This Formvine configuration does not support user searches on multiple user properties.

419 Search by like user search unsupported

This Formvine configuration does not support user searches with wildcard matches.

420 Invalid user search property

The property used for the user search query is unsupported.

421 User suspended

This action is not allowed for suspended users. Email Formvine support at {0}..

451 Password not matched

The password is incorrect for this user account. User: {0}

452 Invalid confirmation key

The confirmation key is invalid for the specified user. User: {0}

453 Remove user not supported

Removing the indicated user is not supported. User: {0}

454 Create user not supported

Creating the indicated user is not supported. User: {0}

455 Update user not supported

Updating the indicated user is not supported. User: {0}

456 Cannot assign task to specified user

No task assignee can be found for the task with the specified ID. ID: {0}; Task assignee: {1}; Data submitted to this form: {2}

Table 4 Formvine fault codes (Cont’d)

Code Fault Detailed Message

TIBCO Formvine Administration Guide

Page 46: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Fault codes | 46

Data service messages

501 Data table does not exist

The specified data table does not exist. Data table: {0}

502 Data service does not exist

The data service for the indicated space and project does not exist. Data service: {0}; Space ID: {1}; Project ID: {2}

504 Data service offline

The action could not be performed because the service definition is offline.

505 Incomplete data

The indicated field does not contain a value. The record could not be saved to the indicated service. Field: {0}; Service: {1}

506 Data assignment error for read only field

The indicated field in the indicated service is read-only. The value could not be saved. Field: {0}; Service: {1}

507 Multiple records not allowed

The current user is trying to create multiple records for the indicated service. This is not permitted. Service: {0}

Group messages

601 Disabled group factories

All applicable group factories are disabled.

602 Add LDAP member not supported

Adding members to an LDAP group is not supported through this application.

603 Disabled LDAP factory

A method on a disabled LDAP group factory was called.

Table 4 Formvine fault codes (Cont’d)

Code Fault Detailed Message

TIBCO Formvine Administration Guide

Page 47: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Fault codes | 47

604 Create LDAP group not supported

Creating an LDAP group is not supported through this application.

605 Remove LDAP group not supported

Removing an LDAP group is not supported through this application.

606 Remove LDAP member not supported

Removing members from an LDAP group is not supported through this application.

607 Update LDAP group not supported

Updating an LDAP group is not supported through this application.

608 Invalid method on local group factory for given group

The method called on the local factory is not valid for the given group or name.

609 Invalid group name

Invalid group name for the local group factory.

610 Add member not allowed on system group

Adding members to the indicated system group is not allowed. System group: {0}

611 Disabled system factory

A method on a disabled system group factory was called.

612 Invalid method on system group factory for given group

The method called on the system group factory is not valid for the given group or name.

613 Create system group not allowed

Creating a new system group is not allowed. System group: {0}

Table 4 Formvine fault codes (Cont’d)

Code Fault Detailed Message

TIBCO Formvine Administration Guide

Page 48: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Fault codes | 48

614 Retrieve members not allowed

Retrieving members from the indicated system group is not allowed. System group: {0}

615 Remove system group not allowed

Removing the indicated system group is not allowed. System group: {0}

616 Remove system group member not allowed

Removing members from the indicated system group is not allowed. System group: {0}

617 Update system group not allowed

Updating the indicated system group is not supported. System group: {0}

618 Disabled XUGS factory

A method on a disabled XUGS group factory was called.

Space messages

801 Project count exceeded

You have exceeded the maximum number of allowed projects. You must delete a project before creating a new one. Maximum projects: {0}

802 Invalid space ID

No space could be located using the ID: {0}

803 Invalid project ID

No project could be located using the indicated space and project ID. Space ID: {0}; Project ID: {1}

804 Space owner is not removed

You cannot remove all owners for a space. You are trying to remove the only owner for this space.

805 Not permitted to specify rules

The user is not permitted to set or modify the project rules.

806 Import tasks without records failed

Tasks cannot be imported without records.

Table 4 Formvine fault codes (Cont’d)

Code Fault Detailed Message

TIBCO Formvine Administration Guide

Page 49: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Fault codes | 49

807 Import failed Could not import space. Space ID : {0}

808 Export failed Could not export space.

809 Import record failed

Could not import the indicated record. Record ID : {0}

810 Export record failed

Could not export records.

817 Project model not found

The specified project model could not be found. Space ID: {0}; Project ID: {1}

819 Multi-choice length or number of options exceeded

The total length of options for this multichoice field has been exceeded the limit of 250 characters. Keep the size of ID for each option within {0} and number of options within {1}.

820 Invalid file format

The file being imported is invalid.

Common messages

901 Internal server error

The server experienced an internal error and could not complete the request.

902 Feature not implemented

The specified feature was not implemented. Feature: {0}; {1}

904 Not signed in You must be signed in to perform this action.

905 Not signed in to this space

The specified user is currently signed in to a different space, so operations for this space cannot be performed. User: {0}; Space: {0}

906 Incomplete input

The operation could not be completed because one or more parameters contain invalid data or are missing data.

907 Parameter constraint check failed

This operation could not be completed because the indicated parameter has a value that is incorrect or out of range. Parameter: {0}

Table 4 Formvine fault codes (Cont’d)

Code Fault Detailed Message

TIBCO Formvine Administration Guide

Page 50: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Fault codes | 50

908 Invalid path An invalid path was specified. Path: {0}

909 Challenge response error

The response to the challenge question is incorrect.

910 Authorization failed

The user is not authorized to perform this action. Action: {0}

912 Space authorization failed

The user is not authorized to access items in this space. Space: {0}

913 CSRF risk The response could not be processed due to a possible security risk.

914 Maximum file upload size exceeded

The file you are trying to upload exceeds the allowed maximum file size. Allowed maximum file size (MB): {0}

915 Search criteria error

A search criteria error was found with this description. Description: {0}

916 Invalid item ID

No item could be located with this ID. ID: {0}

917 Invalid item name

No item could be located with this name. Name: {0}

918 Item already exists

An item with this ID already exists. ID: {0}

919 Item does not exit

An item with this ID does not exist. ID: {0}

921 Optimistic lock failed

Data has been modified by another user since you started working on it. Please reload and start again.

922 Operation not permitted

This operation is not permitted.

923 Feature not supported

This feature is not supported.

Table 4 Formvine fault codes (Cont’d)

Code Fault Detailed Message

TIBCO Formvine Administration Guide

Page 51: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Fault codes | 51

924 Logged in as invalid user

Not logged in as a valid Formvine user. Please sign in again.

951 Resource bundle not found

Formvine was unable to load the indicated resource bundle in the indicated directory. Resource bundle: {0}; Directory: {0}

952 Endpoint [{0}] not found for [{1}]

Provided ID [{0}] could not be found in 'endpoint.ids' for {1}

953 Connection information missing

{0} could not be found in properties file.

954 Invalid encrypted string.

String {0} is not properly encrypted.

955 Configuration error

A configuration error was found. Error description: {0}

Table 4 Formvine fault codes (Cont’d)

Code Fault Detailed Message

TIBCO Formvine Administration Guide

Page 52: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Fault codes | 52

How fault codes are displayed in FormvineWhen an error is detected, Formvine displays a dialog box with the error. In some cases, a stack trace of the error is also displayed. Here’s an example of a 901 server error.

Figure 10 Server error display

TIBCO Formvine Administration Guide

Page 53: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Adding templates | 53

Chapter 3 Adding templates

This chapter explains how to add new templates to TIBCO Formvine®.

Topics

• Adding a template, page 54

IMPORTANT NOTE: You must reimplement the customizations described in when you install a new version of Formvine®. For this reason, we recommend that you record all of the changes you make to the system.

TIBCO Formvine Administration Guide

Page 54: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

54 | Chapter 3 Adding templates

Adding a template

A project owner in your company can request to make a Formvine project available to other project owners as a template.

Add a template to Formvine

1. Ask the project owner for the following items.

— Link to the project: The project owner can click Share on the Project Home page and email you the link to the form.

— The title of the project.

— A description of the project.

— The template category the project belongs to. (The project owner can also suggest a new template category.)

2. Locate the project_model.xml file for the project either through the file system (by navigating to the directory) or by inspecting the online form with Firefox. To locate the file through the file system:

— Navigate to the TIBCO_FV_HOME/files folder of your Formvine installation.

— Locate the space and project ID given in the link.

— Drill down to the project_model.xml file.

3. Copy the project_model.xml file to the following folder location: TIBCO_FV_HOME/WebContent/versionedfiles/prefab/xml

4. Change the name of the file to something you'll remember, for example, the name of the person who submitted the template to you, or the name of the project. The XML filename is not displayed in Formvine; the XML filename is for your reference.

5. Close the browser.

Adding a template to Formvine requires you to close the browser, clear the cache, and restart the browser.

Make sure that the project owner has deleted all data associated with the project; otherwise the data is included as part of the template. (The project owner can copy the project to create a new one without data.)

TIBCO Formvine Administration Guide

Page 55: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

Adding a template | 55

6. Navigate to the TIBCO_FV_HOME/WebContent/versionedfiles/prefab folder.

7. Open rss.js in a text editor. Add a record for your template by copying an existing record and updating it. Save the file when you’re done.

— You can add the record anywhere in the file. Although the existing records are in alphabetical order by template name, you can add new records anywhere in the file. (Record details are below.)

8. Clear the cache and restart the browser.

The new template is displayed in the selected category or categories in the Choose a template dialog box.

A record for a template in the rss.js file is illustrated below. This example shows the record for the Account Representative Evaluation template:

{

"code":"1106",

"title":"Account Representative Evaluation",

"description":"Ask customers to evaluate their account representative. Gauge the level of service provided, the representative’s product and company knowledge, and the ease of the transaction. ",

"tags":"Survey; Evaluation survey",

"thumb":"",

"detail":"",

"category":"Sales",

"url":"prefab/xml/accountrepeval.xml"

},

The following table explains the elements in the record.

The new template is not be available in the public Formvine Resource Center (http://resources.formvine.com).

Table 5 Elements in rss.js record

Element Description Required? (Y/N)

code 4 digit template code. Not currently used.

N (keep element as empty string)

title Template title. Y, string

TIBCO Formvine Administration Guide

Page 56: TIBCO  €¦ · TIBCO Formvine® Administration Guide Software Release 3.3.1 June 2013 Two-Second Advantage®

56 | Chapter 3 Adding templates

description Template description. Y, string

tags Tags for the template. Not currently used.

N (keep element as empty string)

thumb Template thumbnail. Not currently used.

N (keep element as empty string)

category The category assignment for the template. Can be an existing category or a new category. Multiple categories are comma separated. Existing categories are:

• Administrative

• Customer Support

• Facilities

• Finance

• Human Resources

• Industry Specific

• Information Technology

• Legal

• Marketing/PR (enter as Marketing\/PR)

• Miscellaneous

• Sales

Y, string

URL The URL to the new template. Substitute the name of the new template file for the existing filename.

Y, URL

Table 5 Elements in rss.js record (Cont’d)

Element Description Required? (Y/N)

TIBCO Formvine Administration Guide


Recommended