206
Create!form ® Director User Guide

Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Embed Size (px)

Citation preview

Page 1: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form® Director

User Guide

Page 2: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April
Page 3: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

April 2007

Create!form Director

User Guide

Order Number: DR6WN-U11C

Operating Environment: Windows 2000/2003/XP

Software Version: 6.2

Page 4: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April
Page 5: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Copyright Notice

Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April 2007]

Order Number: DR6WN-U11C

The information in this document is subject to change without notice and does not represent a commitment on the part of Bottomline Technologies (de), Inc. The software described in this document is furnished under a license or non-disclosure agreement. The software may be used or copied only in accordance with the terms of the agreement. It is against the law to copy the software onto magnetic tape, disk or any other medium for any purpose other than in accordance with the agreement. It is against the law to copy or distribute this document other than in accordance with the agreement. All rights reserved.

© Copyright 1987-2007 Create!form International, Inc. and Bottomline Technologies (de), Inc. All rights reserved. Create!form, Create!print, Create!flash, Create!stream, Create!fax, Create!email, Create!pdf server and Create!archive are trademarks of Create!form International, Inc. and Bottomline Technologies (de), Inc. which may be registered in certain jurisdictions. PeopleSoft, EnterpriseOne, J.D. Edwards, OneWorld and ERP 8 are trademarks of PeopleSoft, Inc. Adobe, Acrobat, Acrobat Distiller, Acrobat Exchange, Acrobat Reader and PostScript are trademarks of Adobe Systems Incorporated. All other brand/product names are trademarks or registered trademarks of their respective holders.

WARNING. This document is protected by copyright law and international treaties. Unauthorized reproduction or distribution of this document, or any portion of it, may result in civil or criminal liability. Bottomline Technologies (de), Inc. will prosecute and defend its copyrights to the fullest extent of the law.

Page 6: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April
Page 7: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 7

Contents

1 Introducing Create!form Director 151.1 Who is this Guide For? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.2 Create!form Director Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.3 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.4 Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

1.5 User Guide Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.6 Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.7 Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181.7.1 Create!form Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191.7.2 Create!form Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

2 Installing and Configuring 232.1 Installation Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

2.2 Installing Create!form Director . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

2.3 Starting Create!form Director. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

3 Getting Started 273.1 What is a Project? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

3.2 Project Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283.2.1 Project Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283.2.2 Common Project Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

3.3 Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293.3.1 New Project wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293.3.2 Input file type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303.3.3 DataMap options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Page 8: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

8 Create!form Director

3.3.4 Project type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

3.4 Design Flowcharts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

3.5 Saving a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

3.6 Opening a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

3.7 Printing and Previewing Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

3.8 Packing Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

3.9 Transferring Projects to the e-forms Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

3.10 Managing Project Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

4 Viewing and Navigating 374.1 Understanding the Screen Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

4.1.1 Design Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .394.1.2 Input Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .394.1.3 Input Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .394.1.4 Input File Source View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .394.1.5 Status Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

4.2 Navigating the Input File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .404.2.1 Jumping directly to a set or page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .414.2.2 Moving between sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

5 Input Design 435.1 Before You Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44

5.1.1 Using the Create!form sample projects . . . . . . . . . . . . . . . . . . . . . . . . .445.1.2 Selecting a different input file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .445.1.3 Viewing the input file source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

5.2 Key Input Design Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .455.2.1 What is a DataMap? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .455.2.2 What is a set?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .465.2.3 What is a section? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .465.2.4 What is a data variable? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46

Page 9: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 9

5.2.5 What is a derived variable? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

5.3 DataMap Types and Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475.3.1 Embedded and shared DataMaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475.3.2 DataMap options when creating a new project . . . . . . . . . . . . . . . . . . 485.3.3 DataMap options while designing a project. . . . . . . . . . . . . . . . . . . . . 48

5.3.3.1 Edit an embedded DataMap . . . . . . . . . . . . . . . . . . . . . . . . 495.3.3.2 Copy a DataMap from another project . . . . . . . . . . . . . . . . 495.3.3.3 Share a DataMap with other projects . . . . . . . . . . . . . . . . . 495.3.3.4 Edit a shared DataMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495.3.3.5 Use a shared DataMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505.3.3.6 Embed a DataMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

5.4 Designing for CSV Input Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515.4.1 CSV file structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525.4.2 Input file properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525.4.3 Defining sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545.4.4 Defining sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555.4.5 Working with data variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

5.4.5.1 Data variables in the input header section . . . . . . . . . . . . . 565.4.5.2 Data variables in detail sections . . . . . . . . . . . . . . . . . . . . . 565.4.5.3 Changing the properties of columns . . . . . . . . . . . . . . . . . . 565.4.5.4 Changing the input data format . . . . . . . . . . . . . . . . . . . . . 57

5.5 Designing for Text Input Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575.5.1 Input sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595.5.2 Examining how sections are populated . . . . . . . . . . . . . . . . . . . . . . . . 615.5.3 Design principles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

5.5.3.1 Designing from the top-down . . . . . . . . . . . . . . . . . . . . . . 615.5.3.2 Design flowchart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

5.5.4 Setting the input page size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625.5.4.1 How the page size is calculated . . . . . . . . . . . . . . . . . . . . . 645.5.4.2 Other input file settings . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

5.5.5 Defining sets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675.5.6 Working with data variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

5.5.6.1 Set input data formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685.5.6.2 Create data variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Page 10: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

10 Create!form Director

5.5.6.3 Create data variables in a detail section. . . . . . . . . . . . . . . .715.5.6.4 Make data variables expandable . . . . . . . . . . . . . . . . . . . . .72

5.5.7 Common input section tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .735.5.7.1 Display and edit input section properties. . . . . . . . . . . . . . .735.5.7.2 Controlling when an input section is generated. . . . . . . . . .755.5.7.3 Working with multiple input sections . . . . . . . . . . . . . . . . .755.5.7.4 Deleting input sections . . . . . . . . . . . . . . . . . . . . . . . . . . . .76

5.5.8 Working with the input file header section . . . . . . . . . . . . . . . . . . . . . .765.5.9 Working with input header sections . . . . . . . . . . . . . . . . . . . . . . . . . . .77

5.5.9.1 Adjust the input header section size . . . . . . . . . . . . . . . . . 775.5.9.2 Make an input header section expandable . . . . . . . . . . . . . .785.5.9.3 Add input header sections . . . . . . . . . . . . . . . . . . . . . . . . . .805.5.9.4 Rules for creating multiple input header sections . . . . . . . .81

5.5.10 Working with detail sections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .825.5.10.1 About defining detail sections . . . . . . . . . . . . . . . . . . . . . . 825.5.10.2 Add detail sections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .835.5.10.3 Make a detail section expandable . . . . . . . . . . . . . . . . . . . .865.5.10.4 Rules for creating multiple detail sections. . . . . . . . . . . . . .87

5.5.11 Working with input footer sections . . . . . . . . . . . . . . . . . . . . . . . . . . . .875.5.11.1 Adjust the input footer section size . . . . . . . . . . . . . . . . . . 875.5.11.2 Add input footer sections. . . . . . . . . . . . . . . . . . . . . . . . . . .885.5.11.3 Rules for creating multiple input footer sections. . . . . . . . .90

5.6 Designing for XML Input Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .915.6.1 XML file structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .925.6.2 Input file properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .935.6.3 Defining sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .945.6.4 Defining sections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .945.6.5 Working with data variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96

5.6.5.1 Changing the properties of data variables . . . . . . . . . . . . . 965.6.5.2 Changing the input data format . . . . . . . . . . . . . . . . . . . . . .97

5.7 Designing for JDE PDF Input Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .975.7.1 Input file properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .985.7.2 Defining sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .995.7.3 Input sections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99

Page 11: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 11

5.7.4 Data variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

5.8 Creating Derived Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

6 Nodes 1016.1 Key Design Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

6.1.1 About nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1036.1.2 About parent, sibling and child relationships. . . . . . . . . . . . . . . . . . . 1046.1.3 Sequence and timing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056.1.4 Using variables and expressions to control actions . . . . . . . . . . . . . . 105

6.2 Adding Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

6.3 Selecting and Editing Nodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1086.3.1 Select nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1086.3.2 Insert nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1086.3.3 Edit nodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1106.3.4 Move nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1106.3.5 Copy and paste nodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1106.3.6 Delete nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

6.4 Node Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1126.4.1 Send node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

6.4.1.1 Preview Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1176.4.2 Condition node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1176.4.3 Split node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1186.4.4 Sort node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1196.4.5 Sub project node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1206.4.6 Merge node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1216.4.7 Transform node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226.4.8 Update node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226.4.9 Get File node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1236.4.10 Delete File node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1246.4.11 Run Program node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

6.5 Window Display Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Page 12: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

12 Create!form Director

7 Methods and Procedures 1277.1 Input Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128

7.2 Key Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1287.2.1 Design methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1297.2.2 Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1317.2.3 Splitting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1337.2.4 Sorting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1347.2.5 Duplicating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1357.2.6 Merging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135

7.2.6.1 Merge configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . .1367.2.7 Transforming. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1367.2.8 Defining destinations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137

7.2.8.1 Types of destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1377.2.8.2 Naming destination documents . . . . . . . . . . . . . . . . . . . . .1387.2.8.3 Defining login details . . . . . . . . . . . . . . . . . . . . . . . . . . . .1397.2.8.4 Defining destinations by address . . . . . . . . . . . . . . . . . . . .1397.2.8.5 Defining named destinations . . . . . . . . . . . . . . . . . . . . . . .1407.2.8.6 Defining destinations by expression . . . . . . . . . . . . . . . . .141

7.2.9 Working with job tickets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1427.2.10 Using multiple Create!form Director projects . . . . . . . . . . . . . . . . . .1437.2.11 Publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1437.2.12 Working with databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1437.2.13 Triggering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144

7.3 Output Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1457.3.1 Output formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1457.3.2 Recursion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1467.3.3 Output to file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1467.3.4 Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1467.3.5 Fax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1477.3.6 Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1477.3.7 Archiving. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147

Page 13: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 13

8 Variables 1498.1 About Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

8.2 Data Variables, Derived Variables and Section Variables . . . . . . . . . . . . . . . . 150

8.3 User Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

8.4 Global User Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

8.5 System Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

8.6 Lookup Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

8.7 Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

8.8 Job Ticket Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

9 Expressions and Conditions 1559.1 Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

9.1.1 Building Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1569.1.2 Using the Expression Builder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1569.1.3 Navigating and Editing Expressions . . . . . . . . . . . . . . . . . . . . . . . . . 157

9.2 Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1579.2.1 Building Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1589.2.2 Using Expressions as Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

9.3 Building Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1589.3.1 Boolean Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1599.3.2 Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1599.3.3 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1619.3.4 Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1659.3.5 System Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

9.4 Syntax and Order of Precedence Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1679.4.1 Mixed Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1679.4.2 Addition Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1679.4.3 Subtraction Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1689.4.4 Comparing Text Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1689.4.5 Order of Precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Page 14: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

14 Create!form Director

9.4.6 Nested Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1699.4.7 Parsing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1699.4.8 Names of Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .170

10 Customizing 17110.1 About User Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172

10.2 General Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17310.2.1 Section Borders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17310.2.2 Input Source Preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .174

10.3 Design Window Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17410.3.1 Design Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175

10.4 Input Window Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17510.4.1 CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17510.4.2 JDE PDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .176

10.4.2.1 JDE PDF Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17710.4.3 Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .177

10.4.3.1 Text Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17810.4.4 XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .179

AppendicesA Glossary 183

A.1 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184

B Quick Guide 187B.1 Quick Guide to Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .188

B.2 Quick Guide to Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193B.2.1 Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193B.2.2 Dialog Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194

B.3 Quick Guide to Tutorials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .196

Page 15: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

1

Create!form Director 15

Introducing Create!form DirectorCreate!form Director is a design component of the Create!form™ Distributed OutputManagement (DOM) system that allows you to prepare the output from yourenterprise server for merging, emailing, faxing and archiving.

The following topics are covered in this chapter:

Who is this Guide For?

Create!form Director Features

Requirements

e-forms server

Getting Help

User Guide Conventions

Terminology

Product Overview

Page 16: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 1: Introducing Create!form Director

16 Create!form Director

1.1 Who is this Guide For?This user guide is for people who design projects with Create!form Director.

1.2 Create!form Director Features With Create!form Director you can customize your documents without makingmodifications in your enterprise server. The following examples introduce some ofthe features that Create!form Director offers.

Printing, faxing and emailingDirect the printer output from your enterprise server to multiple, customized mergeforms that are selected automatically based on who generated the output and thecontents of the output. The merged documents can then be duplicated and sent tomultiple destinations for print, email, fax and archive.

TransactionsXML transaction data can be captured and the data presented in graphical forms andpublished to a URL, and emailed to individual email addresses, and transformed intoCSV format for use in a spreadsheet or database.

DatabasesData from any database can be extracted and merged with other documents as theoutput is generated for print, email, fax and archive. Databases can also be updatedusing data captured from transactions and the printed or file output of any third partyapplication.

ArchivesWhen information is printed, faxed, emailed, added to databases, stored on disk, orpublished to a web site, the same data can be automatically archived in the same or adifferent form and format.

1.3 RequirementsThe following are required before you can begin designing your project:

Prerequisites• basic familiarity with Windows concepts• basic familiarity with word-processing or publishing software

Page 17: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 17

1.4 Getting Help

• familiarity with report printing on your enterprise server

Design workstationFor information on system and hardware requirements, refer to Section 2.1.

Enterprise serverCreate!form Director can work with the following types of spool files:

• plain ASCII text files (with or without a job header)• CSV data files• XML transactional data files• PeopleSoft EnterpriseOne reports (JDE PDF): B73.3.2 (cum 2) SP14.2 or

B73.3.3 (Xe) and above

Depending on the capabilities of the program used, it may be possible to configure theserver application to attach the job header parameters to the spool file, or you mayneed to install the Create!send utility, which is available for sending spool files fromOS/400, UNIX, Windows and VMS platforms.

For more information, refer to the implementation road map in the Create!form Serveruser guide.

e-forms serverBefore you can commence printing, you must install and configure Create!formServer on the network e-forms server. For more information see the Create!formServer user guide. Depending on your preferred output format, you may also need toinstall other Create!form components. You will find an overview of how to install andconfigure your e-forms production system in the implementation road map in theCreate!form Server user guide.

1.4 Getting Help Help is available in both Portable Document Format (PDF) and as online help.

To view and print the PDF user guide:• Open the file Create!form Director 6.2.pdf with Adobe Reader from the \Manuals

directory on the installation CD, or• From the Windows Start menu, select:

Programs Create!form Manuals Create!form Director

Page 18: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 1: Introducing Create!form Director

18 Create!form Director

To view the online help:• Start Create!form Director and select Help Help Topics from the Main menu.

1.5 User Guide ConventionsSection headings are listed at the front of each chapter to assist you in finding therelevant information. In the electronic version of this document, clicking on these andother cross references will take you to the appropriate section. The followingtypographical conventions are used:

1.6 TerminologyThroughout this user guide, you will see references to many different terms, some ofwhich may be new to you. To familiarize yourself with the terminology used in thismanual, please read the definitions provided in Appendix A.

1.7 Product Overview Create!form Director is part of the Create!form Distributed Output Management(DOM) system: a suite of products that allow users to prepare, format, produce,distribute and administer the transactional and document output of your enterpriseserver.

Convention Convention UsageBold Screen items and buttons.cross reference Short-cut or reference to the document, chapter or section.Courier Font Commands entered by a user.

Additional information relating to the topic.

Critical information relating to the use of the product.

Item Sub-Item Menu selection; i.e. select the menu Item and then select the Sub-Item from the drop-down list, e.g., File New.

Numbering (1.) Step-by-step procedures. To perform an action, follow these instructions in the sequential order given.

Try this... Step-by-step instructions on applying the procedures described in the current topic to a specific example.

Page 19: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 19

1.7 Product Overview

What would you like to know about?• Create!form Workflow (Section 1.7.1)• Create!form Components (Section 1.7.2)

1.7.1 Create!form WorkflowCreate!form operates in conjunction with the print spooler, native to the installationplatform. The output from your enterprise server is spooled to a Create!form Serverprint queue for processing. How the job will be processed is determined by headerinformation, which can be added to the spool file by the application, or by sending thejob initially to specially configured print queues, which tag and route the job to theappropriate Create!form Server print queue. This process of tagging and routing jobsis performed by Create!send.

Create!form Server monitors the jobs submitted to print queues, intercepting any jobsthat are tagged for processing. There are three types of projects that Create!formServer can apply to the spool file, which are built with Create!form companionproducts:

• The spool file can be pre-processed and split into components by applyingprojects created with Create!form Director.

• The spool file can be restructured and converted into a different format like aCSV or XML by applying projects created with Create!form Transform.

• The spool file can be merged with customized forms, known as form projects, byapplying projects created with Create!form Designer.

As jobs are submitted to different print queues, Create!form Server determines whichproject it should be processed with and builds an output file that can then be printed,faxed, e-mailed or archived using other Create!form products – as described in Figure1-1. The output file format is typically PostScript or PDF, depending on its intendeddestination, but other formats are supported.

Page 20: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 1: Introducing Create!form Director

20 Create!form Director

Figure 1-1: Create!form workflow

1.7.2 Create!form Components

The following Create!form products may be installed:

Create!form DesignerCreate!form Designer is the product you use to design form projects, whichCreate!form Server merges with the output of your enterprise server. The form projectallows you to reformat and enhance the output of your enterprise server, incorporatinglogos, images and drawing objects, as well as formatted text.

Create!form TransformCreate!form Transform is the product you use to design projects with whichCreate!form Server transforms the output of your enterprise server. The project allowsyou to restructure and reformat the output of your enterprise server, which mayinclude text, CSV, XML and other file formats.

Create!form Director Create!form Director is the product you use to design projects with which Create!formServer splits and processes the output of your enterprise server, ready for merging,transforming, emailing, faxing and archiving.

e-forms serverenterprise server production printing

faxdesign

archive email

Pos

tScr

ipt,P

DF

spool files PostScript,PCL,PDF

PDF

PostScrip

t

projects

Page 21: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 21

1.7 Product Overview

The types of action that Create!form Director performs include:

• splitting the spool file into multiple spool files• sending particular parts of the spool file to particular directories or queues • extracting data for use in reports • creating backup copies of the spool file • adding job ticket templates (JTTs) that determine various parameters used in

processing by other Create!form products

Create!form ServerCreate!form Server is the central processor, which handles the output from yourenterprise server, and applies the appropriate project designed with either Create!formDesigner, Create!form Transform or Create!form Director. The output fromCreate!form Server can be printed, faxed, e-mailed or archived using otherCreate!form products.

Create!printCreate!print is called by Create!form Server to print the merged documents, and isinstalled automatically with Create!form Server on the e-forms server. Create!print iscontrolled and activated by Create!form Server without user interaction. ACreate!print license is required for each print queue/device. To obtain additionalCreate!print licenses, contact your Create!form distributor.

Create!sendCreate!send is a utility that inserts job information in the spool file as it is printed fromyour enterprise application. You can use Create!send to insert job header parametersthat allow Create!form Server to process the job. Create!send is available for sendingspool files from OS/400, UNIX, Windows and VMS platforms.

Create!emailCreate!email lets you automatically e-mail the merged documents. For moreinformation on Create!email, contact your Create!form distributor.

Create!faxCreate!fax lets you automatically fax the merged documents. For more information onCreate!fax, contact your Create!form distributor.

Page 22: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 1: Introducing Create!form Director

22 Create!form Director

Create!archiveCreate!archive lets you automatically archive the merged documents on an intranet orthe internet, where they can be accessed under secure, password control. For moreinformation on Create!archive, contact your Create!form distributor.

Create!form BindCreate!form Bind is an optional module that takes a collection of files, typically acollection of Invoices and Purchase Orders for a single client, and produces a singlePDF. The bound document can then be sent to Create!form Server for processing.

Create!micrCreate!micr lets you print documents containing MICR (Magnetic Ink CharacterRecognition) text, which is used in the banking industry for check/cheque printing.The evaluation version of Create!micr can be installed from the installation CD.

Create!pdf serverCreate!pdf server lets you create documents in PDF output format, which is typicallyrequired for sending documents to Create!email, Create!archive and PDF enabledprint devices. Create!pdf server is installed with the Windows version of Create!formServer and requires a separate license. To obtain a license for Create!pdf server,contact your Create!form distributor.

Page 23: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

2

Create!form Director 23

Installing and Configuring Create!form Director is installed on a Windows workstation from the Create!forminstallation CD.

The following topics are covered in this chapter:

Installation Requirements

Installing Create!form Director

Starting Create!form Director

Page 24: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 2: Installing and Configuring

24 Create!form Director

2.1 Installation RequirementsCreate!form Director requires the following:

• Microsoft Windows 2000/2003/XP• Microsoft Internet Explorer 5.0 or greater• Adobe Reader 4 or greater (for viewing the User Guide)• approximately 30 MB of free hard disk space• a PostScript level 2 or greater printer is recommended

2.2 Installing Create!form DirectorYou will find an overview of how to install and configure your e-forms productionsystem in the implementation road map in the Create!form Server user guide.

For information on upgrading from an earlier version, see the release notes, located inthe \Readme directory of the installation CD.

To install Create!form Director:1. Insert the installation CD.

The installation screen should be displayed automatically. If it isn’t, run theCForm.exe program located in the root directory of the installation CD.

2. Select the Install Products button, and then select Create!form Director fromthe menu.

3. If no other Create!form product is installed, you will be prompted to select theinstallation directory. If not, the installation directory is already defined.

4. Specify the default location for saving your project files by specifying the projectdirectory.By default, the WorkDir directory in the Create!form Director installationdirectory will be used. If this is the first Create!form product you have installed,it is recommended that you accept the default setting. For more informationabout project directories, see Section 3.2.1.

5. The Setup program allows you to choose between a Typical or a Custominstallation.• Select Typical to automatically install the program, all help files, sample files,

and the English-UK and English-US spelling dictionaries.• Select Custom to install specific options such as particular spelling

dictionaries.

Page 25: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 25

2.3 Starting Create!form Director

6. After specifying the location for the program icon on the Start menu, verify thatall settings are correct and click Next to complete the installation.

7. Return to the main menu and click Exit when you have finished installingCreate!form products.

2.3 Starting Create!form Director

From the Windows Start menu• click the Start menu and select

Programs Create!form Create!form Director 6

For information on screen elements and toolbars, see Chapter 4.

For information on getting started with Create!form Director, see Chapter 3.

Page 26: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April
Page 27: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

3

Create!form Director 27

Getting StartedYour design is recorded in a project, which contains information about how the inputdata will be mapped and processed. Each project consists of several files, located in anumber of folders, which are required whenever the project is opened, saved, movedor transferred.

The following topics are covered:

What is a Project?

Project Directories

Creating a Project

Design Flowcharts

Saving a Project

Opening a Project

Printing and Previewing Projects

Packing Projects

Transferring Projects to the e-forms Server

Managing Project Files

Page 28: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 3: Getting Started

28 Create!form Director

3.1 What is a Project? A project is a record of the way you want to process input data files. Because yourenterprise server may output a variety of different documents, you will need to createa project for each of these variations.

A project consists of an input design, which describes the structure of the input file,and an output design, which describes how the input file will be processed. The inputdesign will be displayed in the Input Window, and the output design will be displayedin the Design Window.

3.2 Project DirectoriesThe project files are stored in the following folders:

• Project Directory• Common Project Directory

The project also uses resources from a number of system folders.

3.2.1 Project Directory Each project has a project directory. This is the location where you save the projectand where its components are stored. When Create!form Director is installed, a defaultproject directory is created: <install dir>\WorkDir. This is where you will be prompted tosave all new projects. During the installation or at a later time, you can change thisdefault project directory.

To change the default project directory:1. From the Main menu, select Tools Preferences.

The Preferences dialog will be displayed.

2. Set the Default Project directory.

3. Click OK.

It is recommended that you use separate directories for design projects and productionprojects. For example, use \WorkDir for your design work and create a new directory\ProdDir for completed, live projects.

Page 29: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 29

3.3 Creating a Project

3.2.2 Common Project Directory

Project components that are shared between projects are stored in the common projectdirectory. When Create!form Director is installed a default common project directoryis created: <Install dir>\CommonProject. At a later time, you can specify another locationfor the common project directory.

To change the common project directory:1. From the Main menu, select Tools Preferences.

The Preferences dialog will be displayed.

2. Set the Common project directory.

3. Click OK.

3.3 Creating a Project Before creating a project, you must choose a suitable input file. The input file shouldbe representative of the files likely to be encountered in a production environment andshould contain all possible variations of content and format. The elements andstructures of the input file, which you identify during the input design process, arerecorded in a DataMap. For information on creating a DataMap, see Chapter 5.

The New Project wizard (Section 3.3.1) will guide you through the process of creatinga new project. You will be given a number of options by the wizard, which mayinclude:

• Input file type (Section 3.3.2)• DataMap options (Section 3.3.3)• Project type (Section 3.3.4)

To complete your design, follow the steps described in the design flowchart(Section 3.4) relevant to the input file type you have selected.

3.3.1 New Project wizard

The New Project wizard will guide you through the process of creating a new project.

To start the New Project wizard:1. From the Main menu, select File New, or click the New Project button ( ).

The New Project Wizard dialog will be displayed.

Page 30: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 3: Getting Started

30 Create!form Director

2. From the Type drop-down, select the type of source file from the available filetypes (Section 3.3.2).

3. From the File/Data source drop-down, select the input source file you wish toopen, from the current project directory. If the file you want is not listed, click( ) to display the Select Input File dialog. Locate the input file from thisdialog and click Open to select the file.

4. Click Next.The sequence and content of dialogs displayed by the wizard will varydepending on the type of input file selected in the first dialog.

5. Continue to follow the wizard instructions and click Finish when you havecompleted all options.

For descriptions of these options, refer to:

• DataMap options (Section 3.3.3)• Project type (Section 3.3.4)

3.3.2 Input file type

The New Project wizard will give you the option of selecting from the available inputfile types. The input file types supported by Create!form include text, CSV, XML andothers. For more information, refer to Chapter 5.

3.3.3 DataMap options

The New Project wizard gives you the option of creating a new DataMap, copying theDataMap from another project, or using a shared DataMap.

Create a new DataMap• Choose the Create a new DataMap option if you have not previously created a

DataMap for an input file of this type and structure.

If a suitable DataMap does exist, you can choose to either copy the DataMap, or, if ithas already been shared, you can share the DataMap with other projects.

Copy a DataMap from another project• Choose the Copy a DataMap from another project option if you need to

modify the DataMap in any way.

Page 31: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 31

3.4 Design Flowcharts

Select a shared DataMap• Choose the Select a shared DataMap option if the DataMap can be used

without modification.

For a full description of these options, refer to Section 5.3

3.3.4 Project type

When you are working with a text input file, you can choose the type of project youwant to create. The New Project wizard gives you the option to create either a standardor a simple project:

Standard project Create a standard project when the input page structure is variable. In a standardproject you can utilize Create!form Director’s many features to map any data from theinput file to the project, and then manipulate the input data in the project.

Simple projectCreate a simple project if the input page structure is uniform. In a simple project, theentire input page is mapped as one section, which you can selectively map as datavariables.

3.4 Design Flowcharts The following flowcharts list the steps required to create projects for the main inputfile types.

Page 32: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 3: Getting Started

32 Create!form Director

CSV

Figure 3-1: An overview of the design processes for CSV input files.

Text

Figure 3-2: An overview of the design processes for text input files.

Define setsSection 5.4.3

Set the input file propertiesSection 5.4.2

Create a process designChapter 6

Create a process designChapter 6

Standard Project:Create a DataMap

Chapter 5

Define setsSection 5.5.5

Set the input page sizeSection 5.5.4

Simple Project:Create data variables

Section 5.5.6.2

Page 33: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 33

3.5 Saving a Project

XML

Figure 3-3: An overview of the design processes for XML input files.

JDE PDF

Figure 3-4: An overview of the design processes for JDE PDF input files.

3.5 Saving a Project You should regularly save your work. You can store projects in any directory, butCreate!form Director looks in only two directories for the files used in each project:

• the <Install dir>\CommonProject directory, which typically contains items commonto various projects; or

• a project directory dedicated to particular projects. You can create as manyproject directories as you want. On install, one project directory exists, called<Install dir>\Workdir.

Define setsSection 5.6.3

Create a process designChapter 6

Define input sectionsSection 5.6.4

Define setsSection 5.7.2

Create a process designChapter 6

Page 34: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 3: Getting Started

34 Create!form Director

To save a project:• From the Main menu, select File Save, or click ( ) on the Main toolbar.

If you are saving a project for the first time, the Save As dialog will bedisplayed.

Unless you have selected the Save to common project directory checkbox,Create!form Director will save the project and the DataMap to the current projectdirectory. For more information about the files created by Create!form Director,see Section 3.10.

3.6 Opening a ProjectTo view, edit, print or transfer a project, you must open the project with Create!formDirector.

To open a project:1. From the Main menu, select File Open or click ( ) from the Main toolbar.

The Open dialog will be displayed and show files from the current projectdirectory. To display files in the \CommonProject directory, select the Look incommon project directory checkbox.

2. Select the project and click Open.

3.7 Printing and Previewing ProjectsProject designs can be previewed on-screen and printed locally to a PostScript printer.

To print a project:1. From the Main menu, select File Print.

The Print dialog will be displayed.

2. Select the required printing options.

3. Click OK.

When moving a project to another location, save it as a packedproject file type (Section 3.8).

Page 35: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 35

3.8 Packing Projects

To preview a project:• From the Main toolbar, click ( ) on the Main toolbar or select File Print

Preview from the Main menu.

3.8 Packing Projects Because projects are made up of several different files (the project file, input data file,DataMap, etc.), Create!form Director allows you to save all associated files into asingle packed project. The entire project can then be easily moved and opened on anycomputer.

To save a project as a packed project:1. Open the project.

2. From the Main menu, select File Save As The Save As dialog will be displayed.

3. In the Save as type field, select Packed director project files (*.dpp6).

4. Click Save.The packed project is saved with the specified name, with an .dpp6 extension. Tosend the packed project, simply email it as an attachment.

To open a packed project, from the Open dialog, select Packed director project files(*.dpp6) from the Files of type field.

3.9 Transferring Projects to the e-forms ServerBefore the project can be used for production printing, you must transfer the projectand its associated resources to the e-forms server. You will find a complete discussionon transferring projects in the Create!form Server user guide.

To transfer a project to the e-forms server:1. From the Main menu, select Tools Transfer

The Transfer to Server dialog will be displayed.

2. Select the project to be transferred and its destination.

You will find a complete discussion on transferring projects and the options displayedon the Transfer to Server dialog in the Create!form Server user guide.

Page 36: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 3: Getting Started

36 Create!form Director

3.10 Managing Project FilesCreate!form Director creates and uses a number of different file types that can beidentified by their icons and filename extensions:

The project files may be located in either the project directory or the common projectdirectory.

Care should be taken when deleting, moving or renaming project files as this maycorrupt the project. Whenever you move, copy or send a project to another location,you should pack the project first.

File Type Icon Extensions Created By

Project .cdp6 File Save and File Save As

Project backup .cdp6bak See Section 10.2

DataMap

.dmp6 (text)

.cmp6 (CSV)

.xmp6 (XML)

.jmp6 (JDE PDF)

File Save and File Save As

DataMap backup .dmp6bak etc See Section 10.2

Packed project .dpp6 See Section 3.8

Input file various external source

Page 37: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

4

Create!form Director 37

Viewing and NavigatingCreate!form Director allows you to interact with and navigate through your projectswith a familiar, graphical and easy to use interface, which can be customized to suityour needs.

The following topics are covered in this chapter:

Understanding the Screen Elements

Navigating the Input File

Page 38: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 4: Viewing and Navigating

38 Create!form Director

4.1 Understanding the Screen ElementsThe Create!form Director interface can be customized to suit your needs. Thefollowing graphic shows the basic screen elements.

Figure 4-1: The Create!form Director screen.

Input File Source View(Section 4.1.4)

Main toolbar

Navigation toolbar(Section 4.2)

Design toolbar

Currently active screen element

Current project

Design Window (Section 4.1.1)

Note that the appearance and position of each element may vary, depending on screen size and the current view and customization settings.

Status bar (Section 4.1.5)

Input Window (Section 4.1.2)

Click to display the Input Tree (Section 4.1.3)

Page 39: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 39

4.1 Understanding the Screen Elements

The following topics describe the function of the different windows and views indetail.

4.1.1 Design Window The Design Window displays the project design as a flowchart or process treeconsisting of nodes and connectors. The nodes represent actions and destinations bywhich the input file can be split, sorted, merged, printed, copied and otherwiseprocessed. These nodes are created by selecting tools from the Design toolbar. Whenyou float the cursor over nodes in the design, information about the type of processwill be displayed.

You cannot hide the Design Window, but you can customize its look and feel(Sections 10.3 and 10.3.1).

4.1.2 Input Window

The Input Window displays the input design. When you float the cursor over data inthe Input Window, the name of the data variable will be displayed (text and JDE PDFinput files only).

To show or hide the Input Window, click the Input Window ( ) on the Main toolbaror select View Input Window from the Main menu. Several task shortcuts areavailable by right-clicking on items in the Input Window.

You can customize the look and feel of the Input Window (Section 10.1).

4.1.3 Input Tree

The Input Tree displays the logical structure of the input file. It provides details aboutthe input file as a whole and individual sections within it. Several task shortcuts areavailable by double-clicking and right-clicking on items in the Input Tree.

To show or hide the Input Tree, click the Input Tree ( ) on the Main toolbar or selectView Input Tree from the Main menu.

4.1.4 Input File Source View

The Input File Source View displays the raw input file.

To show or hide the Input File Source View, select View Input File Source from theMain menu.

Page 40: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 4: Viewing and Navigating

40 Create!form Director

4.1.5 Status Bar

The Status bar provides a variety of information about the project. The informationdisplayed will depend on the current active screen element.

When the Input Window is active:

Figure 4-2: Information displayed in the Status bar when the Input Window is active.

When the Design Window is active:

Figure 4-3: Information displayed in the Status bar when the Design Window is active.

4.2 Navigating the Input FileThe section tabs on the Status bar only appear when the Input Window is active, andonly sections on the current page are displayed. To locate occurrences of somesections, you may need to browse the pages of the input file.

The name of the section the cursor is currently above.

The number of the set and the total number of sets in the project.

The page number of the set and the total number of pages in the set.

The size of currently selected section.

The page number in the input file and the total number of pages.

The page coordinates of the cursor.

The type of section currently selected.

Tabs are displayed for each of the section types on the current page. The selected section is highlighted.

The type of node the cursor is currently above.

The type of node currently selected.

Page 41: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 41

4.2 Navigating the Input File

To navigate to other pages or sections of the input file:• Click the appropriate button from the Navigation toolbar.

The Input Window must be active:

Figure 4-4: The buttons on the Navigation toolbar.

These commands are also available through the main menu.

4.2.1 Jumping directly to a set or page

To go to a specified page number:1. From the Main menu, select Page Go To.

The Go To Page dialog will be displayed.

2. Enter the page number to go to, or select the page number from the drop-down.

3. Click OK.The page selected will be displayed.

4.2.2 Moving between sections

In order to edit sections, they must be selected. To select sections, the Input Windowmust be current. You can select sections in the following ways:

• Click on the section.• Press the arrow keys to move up or down one section.• Press the TAB key to move to the next occurrence of that section and SHIFT+TAB

to move to the previous occurrence of that section.• Click on the section tab on the Status bar.

All sections that are displayed on the current page will have tabs.

Go back one page.

Go to last page.

Go to the next occurrence of the current section.

Go back to a previous occurrence of the current section.

Go to the first page of the previous set.

Go to the first page of the next set.

Go to the first page.

Go forward one page.

Page 42: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 4: Viewing and Navigating

42 Create!form Director

• Select the section in the Input Tree.• Use the buttons on the Navigation toolbar.

Page 43: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

5

Create!form Director 43

Input DesignThe input design process involves identifying and labelling the different parts orelements of the input file. The way in which you identify, label and organize the datain the input file is recorded in the DataMap.

The following topics are covered in this chapter:

Before You Start

Key Input Design Concepts

DataMap Types and Options

Designing for CSV Input Files

Designing for Text Input Files

Designing for XML Input Files

Designing for JDE PDF Input Files

Creating Derived Variables

Page 44: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

44 Create!form Director

5.1 Before You StartThe following topics contain information about some basic procedures, which youmay find useful:

• Using the Create!form sample projects (Section 5.1.1)• Selecting a different input file (Section 5.1.2)• Viewing the input file source (Section 5.1.3)

Before proceeding to the details of designing for a particular file type, you must alsobe familiar with:

• Key Input Design Concepts (Section 5.2)• DataMap Types and Options (Section 5.3)

5.1.1 Using the Create!form sample projectsSample input files have been provided with the installed software so that you canpractice performing the tasks described in this user guide. The samples can be foundin the <install dir>\CF6Samples\Tutorials folder. You can view the text, CSV and XMLsample files with any text editor. You should complete each task in sequence as latertasks may assume that earlier tasks have already been completed.

Tutorials are provided for selected topics and appear as:

You will find a complete index to tutorials in Appendix B.

5.1.2 Selecting a different input file

If the input file you chose for the input design is unsuitable, or if you want to test yourinput design on another sample file, you can select a new input file at any time.

To select a different input file:1. From the Main menu, select Project Select Input File.

The Select Input File dialog will be displayed.

2. Navigate to the folder where the file is located and select the new input file.

3. Click Open.

Try this...The exercises in these sections of the chapter will help you to apply what you have learnt, step by step, on a sample project.

Page 45: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 45

5.2 Key Input Design Concepts

The project will refresh with the new data.

5.1.3 Viewing the input file source

To view the input file source, select the View Input File Source command from themain menu.

5.2 Key Input Design ConceptsBefore you begin your design, you must be familiar with the following key concepts:

• What is a DataMap? (Section 5.2.1)• What is a set? (Section 5.2.2)• What is a section? (Section 5.2.3)• What is a data variable? (Section 5.2.4)• What is a derived variable? (Section 5.2.5)

5.2.1 What is a DataMap?The input design process involves identifying and labelling the different parts orelements of the input file such as header data, line items and footer text. The input filemay be an unstructured text file, for which you must create rules that identify each partof the file, or the file may be structured, like the CSV and XML formats, which arelargely self-defining, but may still require some editing or relabelling. The way inwhich you identify, label and organize the data in the input file is recorded in theDataMap. You must define a DataMap for every project; however, where the input filestructure is the same, you can share the same DataMap between several projects.

The information recorded in the DataMap will include:

• the properties of the input file• how sets are defined• how sections are defined• how data variables are defined• how derived variables are defined

For more information about creating, editing and sharing DataMaps, refer to Section5.3.

Page 46: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

46 Create!form Director

5.2.2 What is a set?

Where the input file contains sequential related pages or blocks of data, such asaccount statements for multiple customers, you can group these pages or data togetheras sets.

During production printing, each set can be treated as a self-contained document.Defining sets also allows you to make use of various pre-defined system conditions,which can be used to apply different formats, or insert extra pages at the start and endof each set.

For more information about defining sets, refer to Section 5.4.3 (CSV), Section 5.5.5(text), Section 5.6.3 (XML) and Section 5.7.2 (JDE PDF).

5.2.3 What is a section?

A section describes a repeated group of data in the input file. For example, in a textfile, the rows that contain header text at the top of each page will form a section, whilein a CSV file, each row will form a section.

By describing all the different types of data in the input file in this way, theinformation contained in each section can be more easily reorganized and reformattedin the project.

For more information about defining sections, refer to Section 5.4.4 (CSV), Section5.5.1 (text), Section 5.6.4 (XML) and Section 5.7.3 (JDE PDF).

5.2.4 What is a data variable?

Input sections can be composed of several different types of information, for example,the input header sections might contain names, addresses, dates and various referencenumbers. A data variable specifies a particular field of data in each section.

Input data cannot be displayed or used in the project unless the data has been identifiedas a data variable in the input file. The process of defining data variables will varyaccording to the type of input file you are processing. For more information, refer tothe relevant input format type in the sections that follow.

For more information about creating data variables, refer to Section 5.4.5 (CSV),Section 5.5.6 (text), Section 5.6.5 (XML) and Section 5.7.4 (JDE PDF).

Page 47: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 47

5.3 DataMap Types and Options

5.2.5 What is a derived variable?

You can combine and manipulate data variables, in user defined expressions that arecalled derived variables. Examples of how derived variables can be used include:

• to retrieve a substring of characters from a data variable• to concatenate two or more data variables into one string of characters• to convert the format of dates• to find abbreviations and substitute with the expanded text• to derive values from an arithmetic formula using one or more data variables

Derived variables will appear as data variables in the project.

The properties of derived variables and how they are defined are described in Section5.8.

5.3 DataMap Types and OptionsYou can use either an embedded DataMap, or share a DataMap with other projects,which can be selected when you create the project, or later while designing the project.

What would you like to know about?• Embedded and shared DataMaps (Section 5.3.1)• DataMap options when creating a new project (Section 5.3.2)• DataMap options while designing a project (Section 5.3.3)

5.3.1 Embedded and shared DataMapsA DataMap can be either:

• EmbeddedAn embedded DataMap is associated with a single project, and can be edited andsaved without reference to other projects. When you create a new DataMap, orcopy a DataMap from another project, the DataMap status is set to embedded.

• SharedA shared DataMap can be used by multiple projects. Any changes made to ashared DataMap will affect every project that uses it.

To confirm the status and name of a DataMap:1. From the Main menu, select the Project Change DataMap command.

The Change DataMap dialog will be displayed.

Page 48: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

48 Create!form Director

2. The status of the DataMap is displayed, and• if the status is shared, the name of the shared DataMap is also shown.• if the status is embedded, the name of the DataMap can be determined by

adding the appropriate extension to the stem of the project name e.g. if theinput file type is CSV, the project MyProject.cdp6 creates an embedded CSVtype DataMap with the name MyProject.cmp6. For information about file names,refer to Section 3.10.

5.3.2 DataMap options when creating a new project

The New Project wizard gives you the option to:

• Create a new DataMapChoose this option if you have not previously created a DataMap for the type ofinput file you are working with.

• Copy a DataMap from another projectChoose this option if you have previously created a DataMap in another projectfor the same input file, which you want to modify for the new project.

• Select a shared DataMapChoose this option if you are able to use a DataMap from another project withoutmodification. You must share the DataMap (Section 5.3.3.3) before it can beselected.

5.3.3 DataMap options while designing a project

In an existing project, you can edit the DataMap or change the status of the DataMapin several ways:

What do you want to do?• Edit an embedded DataMap (Section 5.3.3.1)• Copy a DataMap from another project (Section 5.3.3.2)• Share a DataMap with other projects (Section 5.3.3.3)• Edit a shared DataMap (Section 5.3.3.4)• Use a shared DataMap (Section 5.3.3.5)• Embed a DataMap (Section 5.3.3.6)

Page 49: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 49

5.3 DataMap Types and Options

5.3.3.1 Edit an embedded DataMapYou can edit an embedded DataMap at any time. The DataMap will change wheneverthe input design is changed.

5.3.3.2 Copy a DataMap from another project1. From the Main menu, select the Project Change DataMap command.

The Change DataMap dialog will be displayed.

2. Select the Copy from another DataMap option.

3. Click Select and locate the DataMap file you want to copy.

4. Click OK.

The existing DataMap will be overwritten and the status remains embedded.

5.3.3.3 Share a DataMap with other projects1. From the Main menu, select the Project Change DataMap command.

The Change DataMap dialog will be displayed.

2. Select the Share this DataMap as option.

3. The name of the shared DataMap is displayed, and can be edited.

4. Click OK.

The DataMap will be moved to the \CommonProject directory and renamed. TheDataMap status will be changed to shared.

5.3.3.4 Edit a shared DataMapYou can edit a shared DataMap from any project that uses the DataMap. When youedit a shared DataMap, the changes will be applied to all projects that use thatDataMap. A warning will be displayed before the edited DataMap is applied to otheropen projects.

You must exercise care when changing the DataMap in an existingproject, to ensure that the input sections, data variables and derivedvariables defined in the new DataMap are compatible with yourexisting design.

Page 50: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

50 Create!form Director

5.3.3.5 Use a shared DataMapBefore you can use a shared DataMap, you must first share the DataMap from theoriginal project. For information on how to share a DataMap, refer to Section 5.3.3.3.

To use a shared DataMap:1. From the Main menu, select the Project Change DataMap command.

The Change DataMap dialog will be displayed.

2. Select the Select a shared DataMap option.

3. Click Select and locate the DataMap file you want to use.Shared DataMaps are stored in the project and common project directories.

4. Click OK.

The DataMap status will be changed to shared.

To select a different shared DataMap:1. From the Main menu, select the Project Change DataMap command.

The Change DataMap dialog will be displayed.

2. Select the Select a different shared DataMap option.

3. Click Select and locate the DataMap file you want to use.Shared DataMaps are stored in the project and common project directories.

4. Click OK.

5.3.3.6 Embed a DataMapIn a project that uses a shared DataMap, you can embed either the shared DataMap, ora DataMap from another project.

To embed a DataMap:1. From the Main menu, select the Project Change DataMap command.

The Change DataMap dialog will be displayed.

2. Select one of the following options:• Embed DataMap into project• Embed copy of another DataMap into project

3. If selecting another DataMap, click Select and locate the DataMap file you wantto use.

Page 51: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 51

5.4 Designing for CSV Input Files

4. Click OK.

The DataMap is copied into the Project Directory and named according to the projectstem and DataMap type (Section 3.10). The DataMap status will be changed toembedded.

5.4 Designing for CSV Input FilesThe input design process for CSV files involves identifying the row and columnstructure of the CSV input file; this information is recorded in the DataMap. ADataMap for an CSV input file is denoted by the .cmp6 file name extension.

What would you like to know about?• CSV file structure (Section 5.4.1)• Input file properties (Section 5.4.2)• Defining sets (Section 5.4.3)• Defining sections (Section 5.4.4)• Working with data variables (Section 5.4.5)

To create the CSV sample project:1. To start the wizard, click the New Project button ( ) on the Main toolbar.

2. From the Type drop-down, select CSV from the available file types.

3. Click ( ) to display the Select Input File dialog and select the fileChapter5Sample.csv from the <install dir>\CF6Samples\Tutorials folder.

4. Click Next.

5. Select the Create a new DataMap radio button and click Next.A new DataMap will be created.

6. Click Finish.The new sample project will be displayed in the Input Window.

Page 52: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

52 Create!form Director

5.4.1 CSV file structure

A CSV file contains repeated rows of data, with each field in a row separated by aparticular character called the delimiter. Typically fields are separated by a comma,but other characters can be used, including spaces and tabs. The file may also containa header section, and a column heading row. The important elements of a CSV file aredemonstrated in sample comma delimited file below:

Figure 5-1: CSV input file structure

Note that text values that contain the delimiter character are enclosed by quotationmarks, which is referred to as the text qualifier.

Paginated CSV FilesIf the CSV input file is paginated and contains page header and footer sections, youmust treat the input as a text file, in which you will be able to define the page lengthand separately identify the detail sections from the header and footer sections. In a textinput file, you can create a data variable that contains the entire data row, and then usethe retrieve function to extract the delimited field values as user variables. For moreinformation, refer to Section 5.5.

5.4.2 Input file properties

The input file properties determine how the structure of the CSV input file will beinterpreted.

To change the input file properties:1. Select the Input Window by clicking anywhere inside the input window frame.

Extract from contacts database 9/18/05**********************************************Autodial,Name,Tel2,Div,Address,City,State,Zip,Country26002,A&E Job,,Division 1,345 Main Street,Birmingham,AL,65034,USA5577,"Abbot, Clarice",,Clarice Abbot,1407 West Chenango,Englewood5619,"Abbot, Jamie",,Jamie Abbot,1407 West Chenango,Englewood,C5532,"Abbot, Mark",,Mark Abbot,1407 West Chenango,Englewood,CO6002,"Abbott, Dominique",,Dominique Abbott,1407 West Chenango,En1538,Abernathy & Hitch,212 234-1887,Abernathy & Hitch,5907 Fifth Av6044,"Abrams, Brooke",,Brooke Abrams,"1082 S. Broadway, Apt. 721",7392,Accounts Receivable Department,,Accounts Receivable Departm17002,Acme Department Store #68,,Acme Department Store #68,1790

Header rows

Data rows

Column headings

Page 53: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 53

5.4 Designing for CSV Input Files

2. From the Main menu, select Input File Properties.The Input File Properties dialog will be displayed.

Figure 5-2: CSV Input File Properties dialog

3. In the Delimiter section, select a delimiter character and a text qualifier.

4. In the Header section, select the number of header rows and indicate whetherthe file contains a column heading row.

5. In the Data format section, select the format used for date and decimal values inthe input file.

6. Click OK.

The changes will be applied to the input file and the input window will be refreshed.

Page 54: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

54 Create!form Director

5.4.3 Defining sets

You can use the following means to determine when a new set starts:

• the entire input file can be treated as one set (default setting)• when the value in one or more columns changes• or, one set per row

Try this...Follow the instructions in Section 5.4 and create a new sample CSV input project.In the sample project, the wizard applies the default input file property settings, and the input window should appear as shown below:

If you need to change how the input file is interpreted.

1. Click anywhere inside the Input Window.

2. From the Main menu, select Input File Properties.The Input File Properties dialog will be displayed.

3. In the Delimiter section, select the comma (,) as the field delimiter, and the doublequotation mark (“) as the text qualifier.

4. In the Header section, set the number of header Lines to 2, and select the Columnheadings checkbox.

5. Click OK.

Page 55: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 55

5.4 Designing for CSV Input Files

To define sets: 1. From the Main menu, select Project Define Set.

The Define Set dialog will be displayed.

2. Select one of the radio button options to determine when a new set starts:• Treat entire spool file as one set.• When values change in marked columns:

Select one or more columns.• One set per row

3. Click OK.

5.4.4 Defining sections

Sections are created automatically from the structure defined by the Input FileProperties dialog (Section 5.4.2):

• InputHeader1The optional section at the top of the file that contains header text

• Detail The repeating rows in the body of the file that contain the delimited data

The sections created are displayed in the Input Window.

Page 56: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

56 Create!form Director

5.4.5 Working with data variables

Data variables are created automatically from the structure defined by the Input FileProperties dialog (Section 5.4.2). The data variables created are shown in the InputTree view:

Figure 5-3: Data variables created from the sample CSV input file

What would you like to know about?• Data variables in the input header section (Section 5.4.5.1)• Data variables in detail sections (Section 5.4.5.2)• Changing the properties of columns (Section 5.4.5.3)• Changing the input data format (Section 5.4.5.4)

5.4.5.1 Data variables in the input header sectionIn the input header section, a data variable will be created for each header line.

5.4.5.2 Data variables in detail sectionsIn detail sections, a data variable will be created for each column. The column headingwill be used as the data variable name.

5.4.5.3 Changing the properties of columnsYou can change the name, type and other properties of columns that define datavariables.

Page 57: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 57

5.5 Designing for Text Input Files

To change the properties of a column:1. In the Input Window, click the column heading you wish to edit.

The Column Properties dialog will be displayed.

2. To change the column heading and the name of the data variable, type a newname in the Name field.

3. In the Type field, select text, numeric or date as the data type.

4. To repeat the last non-blank value in blank fields, select the Repeat previousvalue if blank checkbox.

5. Click OK.

5.4.5.4 Changing the input data formatCreate!form Director interprets dates and numeric data in the input file using the dataformats defined by the input file properties. For example, you can change the decimalseparator to a comma, or the date order from year-month-day to month-day-year.

To change the input data format:1. From the Main menu, select Input File Properties.

The Input File Properties dialog will be displayed.

2. From the Date order drop-down, select the required date format.

3. From the Decimal symbol drop-down, select the required numeric format.

4. Click OK.

5.5 Designing for Text Input FilesThe input design process for text files involves identifying and labelling the differentparts or sections of the input file such as header text, line items and footer text. Youmust create rules that identify each of these parts of the input. These rules are recordedin the DataMap. A DataMap for a text input file is denoted by the .dmp6 file nameextension.

The information recorded in the DataMap includes:

• classification of rows on each page into input sections• input file page properties• grouping of pages as sets• mapping of the contents of input sections as data variables

Page 58: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

58 Create!form Director

• definition of derived variables

What would you like to know about?• Input sections (Section 5.5.1)• Examining how sections are populated (Section 5.5.2)• Design principles (Section 5.5.3)• Setting the input page size (Section 5.5.4)• Defining sets (Section 5.5.5)• Working with data variables (Section 5.5.6)• Common input section tasks (Section 5.5.7)• Working with input header sections (Section 5.5.9)• Working with detail sections (Section 5.5.10)• Working with input footer sections (Section 5.5.11)

To create the text sample project:1. To start the wizard, click the New Project button ( ) on the Main toolbar.

2. From the Type drop-down, select Text from the available file types.

3. Click ( ) to display the Select Input File dialog and select the fileChapter5Sample.txt from the <install dir>\CF6Samples\Tutorials folder.

4. Click Next.

5. Select the Create a new DataMap radio button and click Next.A new DataMap will be created.

6. Select the Standard radio button and click Next.This option will permit you to fully define the structure of the input file.

Page 59: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 59

5.5 Designing for Text Input Files

7. Click Finish.The new sample project will be displayed in the Input Window.

Figure 5-1: Input Window showing the sample project input file.

For more information about screen elements in the Input Window, see Section 4.1.

5.5.1 Input sections

There are four types of sections used to define the structure of the input file:

• Input file header section (Section 5.5.8)A non-repeating section at the start of the file that contains header text.

• Input header section (Section 5.5.9)A section at the top of each page that contains header text.

• Detail section (Section 5.5.10)Used to define repeating rows within the body of the page.

• Input footer section (Section 5.5.11)A section at the bottom of each page that contains footer text.

The following graphic displays the way you would define the sections of the samplefile that are repeated on each page of the input file. The input file header section occursonce, at the start of the file.

Horizontal ruler measures page width in characters.

Vertical ruler measures page length in lines.

The page is divided into sections. Section boundaries are shown as dashed lines.

Page 60: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

60 Create!form Director

Figure 5-2: Input page structure

Each section in the input file has a different set of properties, as described in Section5.5.7.1.

Try this...Follow the instructions in Section 5.5 and create a new sample text input project.In the sample project, the wizard creates input header, detail and input footer sections:

1. In the Input Window, click inside the first five rows to select the input header sectioncreated by the wizard.

2. Click below the input header section to select one of the repeated detail sections in thebody of the file.

3. Scroll down to the bottom of the page and click anywhere inside the last five rows of thepage to select the input footer section.

Note how the active section border and section tabs on the Status Bar change to indicate the selected section.

Input header section

Detail sections

Input footer section

Page 61: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 61

5.5 Designing for Text Input Files

5.5.2 Examining how sections are populated

To assist you in the design process, you can examine all the instances of the samesection in the input file with the Input Show All Instances command. In this viewmode, all non-blank characters in all instances of the selected section will be markedwith an “X”.

Figure 5-3: Examining all instances of a section in the input file

5.5.3 Design principles

Create!form Director can handle a variety of input file structures, from simple tablesto complex and irregular forms. This section introduces the design principles that formthe foundation for the procedures described later in this chapter.

5.5.3.1 Designing from the top-down The most important principle, when preparing the input file, is to approach the designfrom the top-down. As depicted in the Design flowchart, start with the input headersection on the first page and make any adjustments needed to the section beforelooking at the next section. Scan the page from the top-down and locate the firstanomaly. Resolve the anomaly, then move down the page to the next anomaly. Whenthe design is correct on the first page, view the second page, again from the top-down.Proceed through the file until the design is complete from start to finish — from topto bottom.

Populated column positions are marked with an X

Page 62: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

62 Create!form Director

5.5.3.2 Design flowchartThe following flowchart describes the main tasks associated with input design.

Figure 5-4: Input design flowchart.

5.5.4 Setting the input page size

Create!form Director can handle fixed or variable page lengths, and widths of up to2048 characters. You can define the input file page length in the following ways:

• by a form feed character (default setting)• the page has a fixed number of lines• by a page number• by a specified character or character string

Define Input Header Section(Section 5.5.9)

Define Detail Sections(Section 5.5.10)

Define Input Footer Section(Section 5.5.11)

Define Sets(Section 5.5.5)

Define Page Size(Section 5.5.4)

Top of File

Bottom of File

Repeat until design is complete.

Section 5.5.7.3

Repeat until all detail sections on page are complete.

Page 63: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 63

5.5 Designing for Text Input Files

The input page size is set from the Input File Properties dialog:

Figure 5-5: Input page size options on the Input File Properties dialog.

To define the input file page width and length: 1. From the Main menu, select Input File Properties.

The Input File Properties dialog will be displayed.

2. In the Lines field, type the page length in lines.

3. In the Columns field, type the line width in characters.If you are unsure of the page length or line width, click the Recalculate button toscan the input file and find the maximum page length and line width in the file.Refer to Section 5.5.4.1 for details of how the page size is calculated.

4. In the End of page section, select one of the following radio button options:• Form feed

A new page will be generated whenever a form feed character is encountered.• Fixed number of lines

A new page will be generated according to the Lines field above.

Sets the input page length.

Sets the input page width.

Scans the input file to determine page length and width.(Section 5.5.4.1)

Sets how the end-of-page or start-of-page is identified.

Only required when a custom end-of-file character is used in the input file.

For information on other input file properties, refer to Section 5.5.4.2

Page 64: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

64 Create!form Director

• CharactersA new page will be generated when the specified characters or character stringis encountered.In the Characters field, type the character or character string.If the string is in a specific location, type the starting position of the string inthe at column field; all other occurrences of the string will be ignored.Select the appropriate radio button to determine how the character string willbe applied:select define the first line of a page if the new page begins at the start of theline containing the string;select define the last line of the page if the new page begins at the start of thenext line following the line containing the string;select terminate the page if the new page begins at the next characterfollowing the string.

5. Click OK.

5.5.4.1 How the page size is calculatedOnce Create!form Director has calculated the page size for a project, it remainsunchanged until the Page size fields are edited, or the Recalculate button is selected.

When creating a new projectWhen creating a new standard or simple project, Create!form Director will read thefirst 10 pages of the file to determine the maximum lines and columns per page. If thenumber of lines is less than the current default value, the default will be used. If thenumber of columns is less than the current default value, the default will be used.

Try this...In the sample project,

1. From the Main menu, select Input File Properties. The Input File Properties dialog will be displayed.By default, the Form feed option is selected to control page length. Using a text editor like Notepad, open the input file Chapter5Sample.txt and verify that a form feed character occurs at the end of each page. Count the rows between each form feed.

2. Return to Create!form Director, and click the Recalculate button on the Input FileProperties dialog to determine the maximum page width and length in the sample file.

3. Click OK.In this example, the maximum page length is 27 lines. If you use a different page length, the input footer section will always ‘sink’ to the bottom of the page.

Page 65: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 65

5.5 Designing for Text Input Files

When recalculating the page sizeWhen you click the Recalculate button, Create!form Director will read the first 10pages of the file to determine the maximum lines and columns per page. Thecalculated page size is displayed and the default values are ignored.

To change the default number of lines and columns1. In the Lines and Columns fields, type the new default values.

2. Review the other settings in the Input File Properties dialog and set defaultvalues as appropriate.

3. Click the Set as Default button.

The default settings may be applied when a new project is created (see above) orwhenever the Reset from Default button is selected.

5.5.4.2 Other input file settingsIn addition to page size settings, the following properties are also set from the InputFile Properties dialog:

• Data formatSets the formats used by data variables (Section 5.5.6.1).

• Ignore leading blank pagesSelect to ignore blank pages at the start of the input file.

• File starts with document headerCreates an input file header section (Section 5.5.8).

Page 66: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

66 Create!form Director

• Ignore bold and underline formattingWhen processing OS/400 spool files, if the spool file contains bold and underlineoverstrike control characters, you can choose to either ignore overstriking orconvert the overstrike characters into PostScript. Previously this option couldonly be set in the writer properties on the server.

Figure 5-6: The Input File Properties dialog.

To define input file properties: 1. From the Main menu, select Input File Properties.

The Input File Properties dialog will be displayed.

2. Select options as required.

3. Click OK.

Sets the formats used by data variables (Section 5.5.6.1).

Ignores blank pages at start of input file.

Ignores overstrike characters in OS/400 spool files.

Creates an input file header section (Section 5.5.8).

For information on page size settings, refer to Section 5.5.4

Page 67: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 67

5.5 Designing for Text Input Files

5.5.5 Defining sets

Defining sets involves specifying when a new set will commence. Typically a new setcommences every time the page numbering restarts, but you can also specify that anew set commences when data such as the customer number or invoice numberchanges.

You can use the following means to determine when a new set starts:

• at the start of each page in the input file (default setting)• when the page number in the input file is equal to 1• when the value of a specified character string on the input page changes• when a specified condition tests TRUE• or, the entire input file can be treated as one set

To define sets: 1. From the Main menu, select Project Define Set.

The Define Set dialog will be displayed.

2. Select one of the radio button options to determine when a new set starts:• One set per input page• When page number = 1 at:

In the Input Window, click-and-drag a box around the page number. Thecharacter position and length of the page number field will be displayed in theDefine Set dialog.

• When value changes at:In the Input Window, click-and-drag a box around the value. The characterposition and length of the value field will be displayed in the Define Setdialog.

• On condition:Click the ( ) button to display the Condition Builder dialog (Section 9.2).A new set will start when the condition tests TRUE.

• Treat entire spool file as one set.

3. Click OK.

Page 68: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

68 Create!form Director

5.5.6 Working with data variables

5.5.6.1 Set input data formatsBefore you start creating data variables, you must set the data formats that Create!formDirector will use to recognize dates and numeric data in the input file. For example,you can change the decimal separator to a comma, or the date order from year-month-day to month-day-year.

To change the input data format:1. From the Main menu, select Input File Properties.

The Input File Properties dialog will be displayed (Figure 5-5).

2. From the Date order drop-down, select the required date format.

3. From the Decimal symbol drop-down, select the required numeric format.

4. Click OK.

5.5.6.2 Create data variablesTo selectively map particular data from the input, for use in the project, you mustcreate data variables around the data.

Try this...In the sample project,

1. From the Main menu, selectProject Define Set.The Define Set dialog will be displayed.

2. Select the When value changes at: radiobutton.

3. In the Input Window, click-and-drag a boxaround the invoice number in the top rightcorner of the page. The character positionand length of the value field will bedisplayed in the Position box in the dialog.

4. Click OK.A new set will now be created in the project every time the invoice number changes.

Page 69: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 69

5.5 Designing for Text Input Files

To create a data variable:1. In the Input Window, select the section containing the data you want.

2. Click-and-drag a box around the area that contains the information you want tostore in the variable.The Data Variable Properties dialog will be displayed.

Figure 5-7: Creating a data variable

3. In the Name field, type a name for the data variable. The variable name must start with an alphabetic character and then be followedby any combination of alphabetic (a-z, A-Z) and numeric (0-9) characters andunderscores. Names are not case sensitive. Naming of variables is entirely at thediscretion of the user; however the convention of naming variables to representthe data they contain is recommended. You should think of a name that you willbe able to recognize and distinguish from all other data variables in the section.

4. Select a data type from the Type drop-down list.

5. Click OK.

The area defining the variable will appear highlighted.

To change the size and position of a data variable:1. In the Input Window, select the data variable.

2. Click-and-drag the resize handles to change the box size, or click-and-draginside the box to reposition the box.

When sizing a data variable, use the Show All Instances command(Section 5.5.2) to examine the extents of the data in all instances ofthe section in the input file.

The box can be dragged diagonally from any corner.

Page 70: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

70 Create!form Director

To display and edit data variable properties:1. Display the Data Variable Properties dialog by doing one of the following:

• Double-click the data variable in either the Input Window or the Input Tree.• Right-click the data variable in either the Input Window or the Input Tree and

select Properties from the shortcut menu.

Figure 5-8: The Data Variables Properties dialog.

2. With the Data Variable Properties dialog you can:• Change the name of the data variable by typing a new name in the Name field.• Select the data type from the Type drop-down.

See also Section 5.5.6.1 for information on how Create!form Directorrecognizes date and numeric formats.

• Change the position and size of the data variable in the Row, Column, Depthand Length fields.Row and column positions are defined relative to the origin (top left corner) ofthe selected section.

• Select the Trim spaces checkbox to remove leading and trailing spaces fromthe text string.

• Select the Expandable checkbox to make the data variable expand with thesection (Section 5.5.6.4).

To delete a data variable:1. Select the data variable in the Input Window or Input Tree.

2. Press the DEL key.

Page 71: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 71

5.5 Designing for Text Input Files

5.5.6.3 Create data variables in a detail sectionAny data variables created in one occurrence of the detail section will be appliedautomatically to all other occurrences of the same detail section.

For information on creating data variables, see Section 5.5.6.2.

Try this...In the sample project,

1. Double-click the input header section to display the Input Section Properties dialog.

2. Type 9 (rows) in the Size field.

3. Click OK.This will increase the size of the input header section, allowing you to identify all the data variables it contains.

4. Create the data variables in the input header section as shown in the graphic below

The variables in this example are used to define data values in the input header section of each invoice:• BillTo — text type variable containing the billing address• OrderNo — text type variable containing the shipping order number• InvNo — text type variable containing the invoice number• InvDate — date type variable containing the invoice date• PageInfo — text type variable containing the information about page numbers• CustRef — text type variable containing the customer numberThe names used above have no special significance, for example, “PageInfo” could be changed to “PgNum” or perhaps “Page_Number”.In the figure above, observe how some of the data variables have been defined larger than the data appearing in the input header section. This anticipates where the data can expand in size in other occurrences of the section, for example, the PageInfo data variable could be “Page 12 of 32”. You can use the Trim spaces option (see below) to remove any extra spaces.You can display the name of a data variable by moving the cursor over the data variable box. Data variables are also listed in the Input Tree (Section 4.1.3).

InvNo

CustRef

BillTo

InvDate

OrderNo

PageInfo

Page 72: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

72 Create!form Director

The area defining the variable will appear highlighted and will be displayed in eachoccurrence of the same detail section:

Figure 5-9: Creating a data variable in a detail section.

5.5.6.4 Make data variables expandable Data variables defined in expandable sections (Section 5.5.9.2 and 5.5.10.3) can bemade to expand as the section expands. For example, you could define an expandabledata variable on the first row of an expandable detail section so that when the sectionexpands to two or more rows, the data variable will contain the extra rows. Anexpandable data variable will always expand to the bottom of the section.

Try this...In the sample project, create the data variables in the detail section as shown:

The variables in this example are used to define the following values in each line item:• ProdNo — text type variable containing the product number• ProdDesc — text type variable containing the product description• UnitPrice — numeric type variable containing the unit price• Qty — numeric type variable containing the quantity• TotalPrice — numeric type variable containing the total price

Data variable.

Selected detail section.

Repeated occurrences of the same detail section.

Data variable is displayed in all other occurrences.

Qty

TotalPriceProdDesc

UnitPrice

ProdNo

Page 73: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 73

5.5 Designing for Text Input Files

To define an expandable data variable:1. Create a data variable (Section 5.5.6.2) in an unexpanded occurrence of an

expandable input section.The Data Variable Properties dialog will be displayed.

2. Type the data variable name in the Name field, and edit other properties asrequired.

3. Select the Expandable checkbox.

4. Click OK.

5.5.7 Common input section tasks

The following tasks are applicable to all input sections (header, detail and footer).

What do you want to know about?• Display and edit input section properties (Section 5.5.7.1)• Controlling when an input section is generated (Section 5.5.7.2)• Working with multiple input sections (Section 5.5.7.3)• Deleting input sections (Section 5.5.7.4)

For tasks specific to each section type, refer to:

• Working with the input file header section (Section 5.5.8)• Working with input header sections (Section 5.5.9)• Working with detail sections (Section 5.5.10)• Working with input footer sections (Section 5.5.11)

5.5.7.1 Display and edit input section propertiesInput section properties can be displayed so that you can:

• change the name of the section• change the size of the section• control where this type of section is applied in the input file• control when this type of section is generated• associate which types of sections can follow this section• control the order in which following sections are tested

When you change the properties of a section, the changes are applied to alloccurrences of that section in the file.

Page 74: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

74 Create!form Director

To display the Input Section Properties dialog:Do one of the following:

• With the section active, select Input Section Properties from the Main menu.• Double-click the selected section.• Right-click the selected section and select Section Properties from the shortcut

menu.• Double-click the section tab on the Status bar.

Input Section Properties dialog controls:

Figure 5-10: The Input Section Properties dialog.

For information on creating expandable sections, see Section 5.5.9.2 and 5.5.10.3.

Section name.

For examples of how to use conditions, see Section 5.5.9.3, 5.5.10.2 and 5.5.11.2.

For information on using the Condition Builder, see Chapter 9.

Minimum size.

Makes the section extend over the entire page.

Use these controls to change the order in which sections are tested in the Followed By list.

The Followed By list.

For information on how to use the Followed By list, see

Click to display the sections available to be added to the

For information on controlling when a section is generated, see Section 5.5.7.2.

Use these controls to add or remove sections from the Followed By list.

Page 75: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 75

5.5 Designing for Text Input Files

5.5.7.2 Controlling when an input section is generatedYou can use the Generate Section options in the Input Section Properties dialog(Figure 5-10) to control when an input section is generated in the project. If the sectionis not generated, the position on the input page where the section would have beendisplayed is reserved. Changing the Generate Section options will not alter thesequence in which sections are applied to the input page.

To control when an input section is generated:1. In the Input Window, double-click the section.

The Input Section Properties dialog will be displayed.

2. Select one of the radio buttons in the Generate Section field:• Always — the section will always be generated if valid.• Never — the section will never be generated even if valid.• If not empty — the section will only be generated if it contains printable

characters.

5.5.7.3 Working with multiple input sectionsIn cases where input pages begin with different header text, or end with differentfooter text, or contain different line items, you can define and use additional inputsections that accommodate these anomalies. Note that:

• All input header sections are listed in the input headers control list(Section 5.5.9.3).

• All detail sections are listed in the Followed By list on the relevant InputSection Properties dialog.

• All input footer sections are listed in the input footers control list (Section 5.5.11).

Page 76: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

76 Create!form Director

For each page, the logic of which section appears where, is summarized in thefollowing flowchart:

Figure 5-11: This logic must be applied to each page in the input.

5.5.7.4 Deleting input sectionsYou can delete the selected input section with the Input Delete Section command. Ifthe section is not visible on the current page, select the section in the Input Tree. Youshould exercise great care when deleting an input section, as this can disrupt the logicand continuity of how other sections are applied.

5.5.8 Working with the input file header section

You can create an input file header section to contain non-repeating data at the start ofthe input file.

To create an input file header section: 1. From the Main menu, select Input File Properties.

The Input File Properties dialog will be displayed.

2. Select File starts with document header checkbox.

3. Click OK.

Apply first valid input header section in the input headers

control list.

Apply first valid detail section in input header Followed By list.

Apply first valid detail section in previous section Followed By list.

Repeat for each row.

Apply first valid input footer section in the input footers control list.

Page 77: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 77

5.5 Designing for Text Input Files

To adjust the input file header section size: 1. Select the input file header section.

2. Click-and-drag the resize handle on the bottom of the section to reduce orincrease the section size.

You can also double-click the section in the Input Window and set the number of rowsfrom the Input Section Properties dialog.

5.5.9 Working with input header sections

What do you want to do?• Adjust the input header section size (Section 5.5.9.1)• Make an input header section expandable (Section 5.5.9.2)• Add input header sections (Section 5.5.9.3)

What do you want to know about?• Rules for creating multiple input header sections (Section 5.5.9.4)

5.5.9.1 Adjust the input header section sizeTypically when you start a new project, the default size of the input header section willbe too big or too small for the header text in the input file. You must adjust the inputheader section so that it contains all the header text and only the header text.

To adjust the input header section size: 1. Select the input header section.

2. Click-and-drag the resize handle on the bottom of the section to reduce orincrease the section size.

Use the Show All Instances command (Section 5.5.2) to examine allinstances of the section in the input file.

Page 78: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

78 Create!form Director

5.5.9.2 Make an input header section expandableBy default, input header sections have a set size. That is, all instances of that sectionwill have the same size regardless of their content. Where the size of the text in aninput header section varies between instances, you can make the section dynamicallyexpand around the relevant text. The section becomes “expandable”.

To make an input header section expandable:1. In the Input Window, double-click the input header section.

The Input Section Properties dialog will be displayed.

2. In the Size field, type the minimum size of the section in rows.

3. Select the Expandable checkbox.

4. Click OK.The section size will be reset to the minimum size.Select the first detail section below the input header section and identify whichdata variable can be used to test when this detail section is valid. The datavariable will be used to build a condition that tests TRUE in the detail section andFALSE in the expanded rows of the input header section.

5. Double-click the first detail section below the input header section.The Input Section Properties dialog will be displayed.

6. Click the ( ) button next to the Condition field.Use the Condition Builder (Chapter 9) to create a valid condition, using theidentified variable, for this detail section.

7. Click OK.The input header section will now automatically expand in size, testing each rowbelow the section, until the condition in a following detail section tests TRUE.

8. Ensure that all sections that are permitted to follow the header section, contain asuitable condition that will distinguish header rows from detail rows.

The sections that are permitted to follow the input header section are listed in the Thissection can be followed by field on the input header Input Section Properties dialog— also referred to as the Followed By list. The input header section will not expand ifany of the sections in the Followed By list do not contain a condition, or the conditionalways tests TRUE.

Page 79: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 79

5.5 Designing for Text Input Files

You can also make data variables expandable in an expandablesection (Section 5.5.6.4).

Try this...In the sample project, click anywhere inside the Input Window, then navigate to the second page of the input file. Observe that the input header contains 9 rows on the first page, and 6 rows on the second page; because of this, the mapping of the data variables is now incorrect. This is typical of a continuation header. Observe also that the invoice numbers on both pages are the same; they belong to the same set.To make the input header section expandable, firstly set the minimum size:

1. In the Input Window, on page 2, adjust the input header section size to 6 rows.Next, create a data variable that can be used to distinguish header rows from detail rows (if you have already created the TotalPrice data variable, you can skip to step 6):

2. Select the next detail section.

3. Create a data variable around the price field at the end of the row. Note that the headerrows do not contain a decimal point in this position. There are many other possible tests,but we’ll use the decimal point.The Data Variable Properties dialog will be displayed.

4. Type TotalPrice in the Name field.

5. Click OK.Next, create a condition in the detail section that tests for a decimal point:

6. Double-click the detail section, making sure that you select the section clear of anydefined data variables.The Input Section Properties dialog will be displayed.

7. Click the ( ) button and use the Condition Builder to create the expressioncontains(TotalPrice,".") in the Condition field. This condition will be TRUE whenthe data variable TotalPrice contains the “.” character.

8. Click OK.Finally, make the input header section expandable:

9. Double-click the input header section to display the Input Section Properties dialog.

10. Select the Expandable checkbox.

11. Click OK.Now navigate back to page 1 and observe that the input header section has expanded to 9 rows, but is still 6 rows on page 2.

Page 80: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

80 Create!form Director

5.5.9.3 Add input header sectionsIn cases where the content of the input header section changes between pages, or anexpandable header section cannot be used, you can add additional header sections.Only one input header section can be used on a page.

To create an additional input header section:1. From the Main menu, select Input Input Headers.

The Input Headers Control List dialog will be displayed.

2. Click the Add Row button ( ).The New Header Section dialog will be displayed.

3. In the Name field, type the new input header section name.

4. In the Size field, type the number of rows required.

5. Using the controls provided, add one or more detail sections to the This sectioncan be followed by list. If there are no sections in the Followed By list, or if the sections listed are notvalid when tested, no detail sections will be created on the page.

6. Click OK to close the New Header Section dialog. Do not close the InputHeaders Control List dialog.

The input headers control list will now have two input header sections defined.Both input header sections are unconditional (the Condition field is empty onthe Input Section Properties dialog). If the first input header in the list isunconditional, it will always be created. So the first input header must beconditional. If the condition tests TRUE then the first input header is applied, if thetest fails then the second input header is applied.

7. Click the Edit button ( ) next to the first input header in the control list.The Input Section Properties dialog will be displayed.

8. Click the ( ) button next to the Condition field.Use the Condition Builder (Chapter 9) to create a valid condition for this inputheader section. If you wish to use a data variable in the condition, you mustcreate the data variable first.

9. Check that the detail sections in the This section can be followed by list arevalid and in the correct order.

10. Click OK to close the Input Section Properties dialog.

Page 81: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 81

5.5 Designing for Text Input Files

11. Click the Edit button ( ) on the second (unconditional) input header todisplay the Input Section Properties dialog.

12. Check that the detail sections in the This section can be followed by list arevalid and in the correct order.

13. Click OK to close the Input Section Properties dialog.

14. Click OK to close the Input Headers Control List dialog.

The definition of the new input header section will be applied to the entire file.

To delete an input header section:Care should be taken whenever a input header section is deleted as this will alter notonly which input header section is applied, but may also change the way detail sectionsare applied to the rest of the page. Always review the Followed By lists on the otherinput header sections, and the order of the input headers control list, before deleting ainput header section.

1. From the Main menu, select Input Input Headers.The Input Headers Control List dialog will be displayed.

2. Select the input header section in the control list.

3. Click the Delete Row button ( ).

4. Confirm that you wish to delete this section.

5. Click OK.

The change will be applied to the entire file.

5.5.9.4 Rules for creating multiple input header sectionsThe procedures detailed in Section 5.5.9.3 can be applied when adding further inputheader sections. The rules applying to multiple input header sections are:

• The last header in the input headers control list should be unconditional. • All other headers in the list should be conditional.• The first header that tests TRUE in the list is applied.

The Condition Builder makes available a number of useful systemvariables and conditions, for example the conditionSys.FirstPageOfDoc will test TRUE on the first page of the document.

Page 82: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

82 Create!form Director

• If none of the headers in the control list test TRUE on a page, then no header willbe created on that page.

• Input header sections can be expandable (Section 5.5.9.2).

The detail section that follows the input header section, will be the first valid detailsection in the Followed By list of the input header section.

5.5.10 Working with detail sections

What do you want to do?• Add detail sections• Make a detail section expandable

What do you want to know about?• About defining detail sections• Rules for creating multiple detail sections

5.5.10.1About defining detail sectionsYou can create additional detail sections when the content of line items varies withinthe page. For example, an invoice may contain subtotal lines, blank lines ordescription lines in addition to the regular line items. Three different detail sectiontypes are shown in the following example.

Figure 5-12: An example of irregular line items.

Page 83: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 83

5.5 Designing for Text Input Files

The details of lines are as follows:

• type 1 is the primary line item containing the item details, quantity and price• type 2 is a descriptive line relating to the previous type 1 line• type 3 is a subtotal line

In particular note that:

• type 1 lines are not always followed by type 2 lines• type 2 lines can only follow type 1 lines• type 2 lines always contain “***” at the start of each line• type 2 can be one or more lines• type 3 is always two lines• type 3 lines can follow either type 1 or 2 lines• type 3 lines can occur at any position• type 3 lines always contain the text string “Subtotal”

These observations form a set of rules that define the input file structure. The processof building a DataMap involves translating these observations or rules into sectionproperties. You must create a new section for each of the line types you observe in thefile.

5.5.10.2Add detail sectionsThere are many possible ways of creating DataMaps for the same input file. The typeof sections defined will depend not only on the content of the input file, but also onhow the input data will be used in the project.

To define additional detail sections:1. Identify the first instance where a new section is required.

2. Select the section immediately before (above) where the new section is required.

3. From the Main menu, select Input New Section After.The New Data Section dialog will be displayed.

4. In the Name field, type the name of the new section.

5. In the Size field, type the size of the section in rows.

Use the Show All Instances command (Section 5.5.2) to examine allinstances of the section in the input file.

Page 84: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

84 Create!form Director

6. Click OK.The new section will be displayed in the Input Window.

7. Select the new section.

8. Create the data variables (Section 5.5.6.3) required to define the data in the newsection.

9. Create any additional data variables that are required to assist in distinguishingthis section from all other detail sections. You only need to create additional datavariables if the data variables created in the previous step are not suitable.For example, you might test when a particular character position is blank, orwhen a character string contains a particular substring, or a combination of testsusing boolean operators (Section 9.3.1).

10. From the Main menu, select Input Section Properties.The Input Section Properties dialog will be displayed.

11. Click the ( ) button to display the Condition Builder dialog and create acondition that tests TRUE when this section is valid. For information on creating conditions, see Chapter 9.

12. Define the sections that can follow this section in the This section can befollowed by field by adding, removing and ordering sections with the controlsprovided (Section 5.5.7.1).The order in which the sections appear in this list is very important: the firstvalid section in this list will be the next section created after this section.

13. Click OK.

The definition of the new section will be applied to the entire file and displayedin the Input Window.

It is good design practice to create a positive condition for everydetail section you create, even if the condition is not immediatelyrequired to identify the section.

Page 85: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 85

5.5 Designing for Text Input Files

Try this...In the sample project, navigate to page 2 of the input file.

1. Select the first detail section below the input header section and, if you have not alreadydone so, create data variables to define the contents of the row (Section 5.5.6.3).

In Section 5.5.9.2 we set a condition for the Detail section such that the TotalPrice data variable must contain a decimal point. Observe that the condition fails at row 9, where a different type of line item is encountered. A new detail section must be created for this type of line.

2. Select row 8, the row immediately above where the new section will be created.

3. Right-click inside the section border, but away from any of the data variables, and selectNew Section After from the shortcut menu.The New Data Section dialog will be displayed.

4. Define a section named Comment, of one row in size, which can only be followed by aDetail section, and click OK.

Now create a data variable in the Comment section that you can use to positively test the type of section:

5. Create a data variable named CommentVar1 in columns 2-7, and another namedCommentVar2 in columns 9-53.

6. Double-click the Comment section to display the Input Section Properties dialog.

7. Using the Condition Builder, create the condition:CommentVar1=="" AND CommentVar2!="", which tests that CommentVar1 is blank andCommentVar2 is not blank; both conditions must be true for a Comment section to becreated.

8. Click OK.The sections are now correctly applied from the top of the page down to row 11. The next line is blank, and neither of the two sections we have created are valid, so no further sections are created on this page.In the Input Window, navigate back to page 1 and check that the changes you have made to the section properties have been correctly applied there as well.

Page 86: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

86 Create!form Director

5.5.10.3Make a detail section expandable In cases where the number of rows in a detail section is variable, e.g. repeatedcomment lines, you can make the detail section expandable.

To make a detail section expandable:1. In the Input Window, double-click the detail section.

The Input Section Properties dialog will be displayed.

2. In the Size field, type the minimum size of the section in rows.

3. Select the Expandable checkbox.

4. Click OK.

The section will now automatically expand in size, testing each row below thesection, until a condition in a following detail section tests TRUE. Ensure that allsections that are permitted to follow the section contain a suitable condition.

You can also make data variables expandable in an expandablesection (Section 5.5.6.4).

Try this...In the sample project, navigate to page 3 of the input file. Observe that the input sections defined so far have been correctly applied down to row 15. Also observe that Comment sections can be larger than a single row. This can be handled in several different ways, depending on how you intend to use the data in the project:You can change the Comment section Followed By list to include itself:

1. Double-click any Comment section to display the Input Section Properties dialog.

2. Add Comment to the This section can be followed by list.

3. Click OK to apply the change.Alternatively, you can make the Comment section expandable:

1. Double-click any Comment section to display the Input Section Properties dialog

2. Select the Expandable checkbox

3. Click OK to apply the change.Try both methods and see how these changes are applied on the previous pages.

Page 87: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 87

5.5 Designing for Text Input Files

5.5.10.4Rules for creating multiple detail sectionsThe procedures detailed in Section 5.5.10.2 can be applied when adding further detailsections. The rules applying to multiple detail sections are:

• The detail section that follows the input header section, will be the first validdetail section in the Followed By list of the input header section.

• The first valid detail section in the previous detail section Followed By list isapplied next.

• An unconditional detail section will always be applied if tested in the previousdetail section Followed By list.

• If there are no valid sections in the last Followed By list, no further detailsections will be applied to that page.

• Detail sections can be expandable (Section 5.5.10.3).

5.5.11 Working with input footer sections

What do you want to do?• Adjust the input footer section size• Add input footer sections

What do you want to know about?• Rules for creating multiple input footer sections

5.5.11.1Adjust the input footer section sizeAs with the input header section, you must adjust the size of the input footer sectionso that it contains all footer text and no text that belongs in a detail section.

To adjust the input footer section size: 1. Select the input footer tab on the Status Bar to select and display the input footer

section.

2. Click-and-drag the resize handle on the top border of the input footer section tomake the section bigger or smaller.

Use the Show All Instances command (Section 5.5.2) to examine allinstances of the section in the input file.

Page 88: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

88 Create!form Director

5.5.11.2Add input footer sectionsIn cases where the content of the input footer section changes between pages, you canadd and use additional input footer sections. The additional input footer sections willbe added to the input footers control list. Only one can be used on each page.

To define additional input footer sections: 1. From the Main menu, select Input Input Footers.

The Input Footers Control List dialog will be displayed.

2. Click the Add Row button ( ) to display the New Footer Section dialog.

3. In the Name field, type the footer section name.

4. In the Size field, type the number or rows required for the new input footersection.

5. Click OK to close the New Footer Section dialog. Do not close the InputFooters Control List dialog.

The input footers control list now has two input footer sections defined. Bothinput footer sections are currently unconditional (the Condition field is empty).If the first in the list is unconditional, it will always be created. So the first footermust be conditional. If the condition tests TRUE then the first input footer isapplied, if the test fails then the second input footer is applied.

6. Click the Edit button ( ) for the first input footer to display the InputSection Properties dialog.

Try this...In the sample project,

1. Navigate to page 1 in the Input Window.

2. Drag the input footer border down so that the section size is 2 rows:

The adjusted footer section should start at row 26, just below the last line item.

Page 89: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 89

5.5 Designing for Text Input Files

7. In the Condition section, click the ( ) button to display the ConditionBuilder dialog and create a condition that tests TRUE when this section is valid. For information on creating conditions, see Chapter 9.

8. Click OK to close the Input Section Properties dialog.

9. Click OK to close the Input Footers Control List dialog.

The definition of the new input footer section will be applied to the entire file.

The Condition Builder makes available a number of useful systemvariables and conditions, for example the conditionSys.LastPageOfSet will test TRUE on the last page of each set.

Try this...In the sample project, navigate to page 2 of the input file. Observe that rows 24 and 25 should be part of the input footer section, as they appear on pages 1 and 3. Pages 1 and 3 are the first pages of a new set, whereas page 2 is a continuation page. The existing input footer section is being applied correctly on the first page of each set, but incorrectly on the continuation pages.Firstly, create a condition that tests TRUE on the first page of each set.

1. Double-click the input footer section.The Input Section Properties dialog will be displayed.

2. Click the ( ) button and use the Condition Builder to create the expressionSys.FirstPageOfSet in the Condition field.

3. Click OK.Now, create a continuation page footer which will be applied when the test for InputFooter1 fails.

4. From the Main menu, select Input Input Footers.The Input Footers Control List dialog will be displayed.

5. Click the Add Row button to display the New Footer Section dialog.

6. Type ContFooter in the Name field.

7. Type 5 in the Size field.

8. Click OK to close the New Footer Section dialog.

9. Click OK to close the Input Footers Control List dialog.The input footers control list now has two input footer sections defined. The first footer in the control list (InputFooter1) is conditional. If the condition tests TRUE then InputFooter1 (with 2 rows) is applied, if the test fails then ContFooter (with 5 rows) is applied.

Page 90: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

90 Create!form Director

5.5.11.3Rules for creating multiple input footer sectionsThe procedures detailed in Section 5.5.11.2 can be applied when adding further inputfooter sections. The rules applying to multiple input footer sections are:

• The first input footer that tests TRUE in the control list is applied.• If none of the input footers in the control list test TRUE on a page, then no input

footer will be created on that page.

Try this...

After creating data variables in the input header, detail and input footer sections, the sample project should now look like this:

1. Select View Input Tree to display the Input Tree (Section 4.1.3).

2. Expand the input header, detail and input footer sections in the Input Tree to display thedata variables you have defined.

3. Navigate through each page of the input file to verify that the sections you have definedhave been correctly applied on every page.

Your input design is now complete.If you haven’t already done so, save your project.

Page 91: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 91

5.6 Designing for XML Input Files

5.6 Designing for XML Input FilesThe input design process for XML files involves identifying the different elements ofthe XML input file; this information is recorded in the DataMap. A DataMap for anXML input file is denoted by the .xmp file name extension.

What would you like to know about?• XML file structure (Section 5.6.1)• Input file properties (Section 5.6.2)• Defining sets (Section 5.6.3)• Defining sections (Section 5.6.4)• Working with data variables (Section 5.6.5)

To create the XML sample project:1. To start the wizard, click the New Project button ( ) on the Main toolbar.

2. From the Type drop-down, select XML from the available file types.

3. Click ( ) to display the Select Input File dialog and select the fileChapter5Sample.xml from the <install dir>\CF6Samples\Tutorials folder.

4. Click Next.

5. Select the Create a new DataMap radio button and click Next.A new DataMap will be created.

6. Click Finish.The new sample project will be displayed in the Input Window.

Page 92: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

92 Create!form Director

5.6.1 XML file structure

To be properly interpreted, the XML file should be “well-formed” and adhere to theW3C standards published by World Wide Web Consortium. An example of a well-formed XML file is shown below:

Figure 5-13: Example of a well-formed XML file

The elements and structure of the XML file are interpreted according to an underlyingset of rules that determine how the XML elements will be applied in the output project.These initial settings can be changed with the following commands:

XML Element Type Line XML SourceXML declaration 1 <?xml version="1.0" encoding="ISO8859-1" ?>

comment 2 <!-- Ghoul Club Member Updates-->

root tag with attribute 3 <update total="2">

child element start tag with attribute 4 <member count="1">

subchild element tag 5 <ID>1984</ID>

subchild element start tag 6 <changes>

nested subchild element tag 7 <street>1667 Elm Street</street>

nested subchild element tag 8 <email>[email protected]</email>

subchild element end tag 9 </changes>

child element end tag 10 </member>

child element start tag with attribute 11 <member count="2">

subchild element tag 12 <ID>1886</ID>

subchild element start tag 13 <changes>

nested subchild element tag 14 <title>Mr</title>

nested subchild element tag 15 <first>Edward</first>

nested subchild element tag 16 <last>Hyde</last>

nested subchild element tag 17 <email>[email protected]</email>

subchild element end tag 18 </changes>

child element end tag 19 </member>

end root tag 20 </update>

To do this SelectChange formats of date and numeric data Input File Properties (Section 5.6.2)Ignore selected XML tags in source file Input File Properties (Section 5.6.2)Change how sets are created Project Define Set(Section 5.6.3)Change how sections are created Input Tag Properties (Section 5.6.4)

Page 93: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 93

5.6 Designing for XML Input Files

5.6.2 Input file properties

The input file properties determine the input format for dates and numbers, and whichtags will be ignored when the input file is processed.

To change the input file properties:1. Select the Input Window by clicking anywhere inside the input window frame.

2. From the Main menu, select Input File Properties.The Input File Properties dialog will be displayed.

Figure 5-14: XML Input File Properties dialog

3. In the Data format section, select the format used for date and decimal values inthe input file.

4. In the Ignored Tags section, use the toolbar buttons to add the tags you want toignore or remove the tags you want to include.

5. Click OK.

The changes will be applied to the input file and the input window will be refreshed.

Rename a section Input Tag Properties (Section 5.6.4)

To do this Select

Page 94: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

94 Create!form Director

5.6.3 Defining sets

You can select one tag to indicate where a new set will be created:

To define sets: 1. From the Main menu, select Project Define Set.

The Define Set dialog will be displayed.

2. Select the tag that defines the start of a new set.

3. Click OK.

5.6.4 Defining sections

You can select one or more tags to indicate where a new data section will be created:

To define sections: 1. In the Input Window, select a tag that defines the start of a new section.

2. From the Main menu, select Input Tag Properties. The Tag Properties dialog will be displayed.

3. Select the Create section checkbox and type the section name.

4. Click OK.

Follow the same procedure to unselect section tags.

To rename a section: 1. In the Input Window, select the tag that defines the start of the section.

2. From the Main menu, select Input Tag Properties. The Tag Properties dialog will be displayed.

3. Type the new name in the Name field.

4. Click OK.

Page 95: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 95

5.6 Designing for XML Input Files

Try this...Follow the instructions in Section 5.6 and create a new sample XML input project.In the sample project, the wizard applies a standard set of rules to interpret the XML input file and create sets, sections and data variables. These initial settings are displayed in the Input Window.Firstly, look at how sets are defined:

1. From the Main menu, select the Project Define Set command.The Define Set dialog will be displayed with the <order> tag highlighted.A new set will be created wherever the <order> tag occurs in the input file, which is the setting we want.

Now, look at how sections are created:In the Input Window, note that some tags are ticked, and others are not. The tick marks indicate which tags are being used to create sections in the output. In this case, we only want the <order> and <item> tags to create sections, so we need to turn off section creation on the <name> and <address> tags as these belong in the same section as the order number.

1. In the Input Window, click the <name> tag.

2. From the Main menu, select Input Tag Properties.The Tag Properties dialog will be displayed.

3. Clear the Create section checkbox and click OK.Repeat steps 1 to 2 and turn off section creation for the <address> section.

Page 96: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

96 Create!form Director

5.6.5 Working with data variables

Data variables are created automatically from the tag attributes and data elements inthe input file. The data variables created are shown in the Input Tree view:

Figure 5-15: Data variables created from the sample XML input file

What would you like to know about?• Changing the properties of data variables (Section 5.6.5.1)• Changing the input data format (Section 5.6.5.2)

5.6.5.1 Changing the properties of data variables

To change the properties of data variables:1. In the Input Window, double-click the data variable.

The Data Variable Properties dialog will be displayed.

2. With the Data Variable Properties dialog you can:• Change the name of the data variable by typing a new name in the Variable

name field.• Select the data type from the Data type drop-down.

See also Section 5.6.5.2 for information on how Create!form Directorrecognizes date and numeric formats.

Page 97: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 97

5.7 Designing for JDE PDF Input Files

3. Click OK.

Figure 5-16: Data Variable Properties dialog

5.6.5.2 Changing the input data formatCreate!form Director interprets dates and numeric data in the input file using the dataformats defined by the input file properties. For example, you can change the decimalseparator to a comma, or the date order from year-month-day to month-day-year.

To change the input data format:1. From the Main menu, select Input File Properties.

The Input File Properties dialog will be displayed (Figure 5-14).

2. From the Date order drop-down, select the required date format.

3. From the Decimal symbol drop-down, select the required numeric format.

4. Click OK.

5.7 Designing for JDE PDF Input FilesThe J.D. Edwards PDF format is a self-defining proprietary PDF format generated byPeopleSoft EnterpriseOne. The contents of the PDF file are pre-mapped, whichCreate!form Director automatically translates into sections and data variables.

The input design process for JDE PDF files involves defining how sets are created anddefining any derived variables that are required in the project; this information isrecorded in the DataMap. A DataMap for an JDE PDF input file is denoted by the .jmp6file name extension.

To view the input file elements mapped by the DataMap:• Click the Input Tree ( ) on the Main toolbar or select View Input Tree from

the Main menu.

Page 98: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

98 Create!form Director

What would you like to know about?• Input file properties (Section 5.7.1)• Defining sets (Section 5.7.2)• Input sections (Section 5.7.3)• Data variables (Section 5.7.4)

5.7.1 Input file properties

Use the Input File Properties. command to change the following input fileproperties:

• Non-breakable sectionsWhen the file is repaginated, any input section defined as a non-breakablesection will not be permitted to span a page break.

• Date orderSelect the date order format used in the input file.

• Can contain duplicatesIf the input file can contain duplicates, this option forces a scan for EOF markersand records the number of duplicates in the Sys.PDFNumCopies system variable.

To add and remove non-breakable input sections:1. Select the Input Window by clicking anywhere inside the input window frame.

2. From the Main menu, select Input File Properties.

3. To add section to the Non-breakable sections, click the Add Row button ( ),click the drop-down button on the new row, and select the section from the list.

4. To remove a section, select the section in the Non-breakable sections list, andclick the Delete Row button ( ).

5. Click OK.

To change the input file date format:1. Select the Input Window by clicking anywhere inside the input window frame.

2. From the Main menu, select Input File Properties.

3. Select the required format from the Date order field.

4. Click OK.

Page 99: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 99

5.7 Designing for JDE PDF Input Files

5.7.2 Defining sets

Defining sets involves specifying when a new set will commence. Typically a new setcommences every time the page numbering restarts, but you can also specify that anew set commences when data such as the customer number or invoice numberchanges.

You can use the following means to determine when a new set starts:

• when the value of a page number variable is equal to 1• when the value of a variable changes• one set per page• no sets

To define sets: 1. From the Main menu, select Project Define Set.

The Define Set dialog will be displayed.

2. Select one of the radio button options to determine when a new set starts:• This project does not contain sets• New set occurs when:

From the Section drop-down, select the name of the section containing thevariable you want to use to define sets, then an option and the requiredvariable from the Condition field:Page number variable ... equals 1Value of variable ... changes

• New set starts on every page.

3. Click OK.

5.7.3 Input sections

Input sections are created automatically from the pre-mapped contents of the inputfile. The sections defined in the input file are shown in the Input Tree view. Theproperties of input sections in a JDE PDF input file cannot be edited.

5.7.4 Data variables

Data variables are created automatically from the pre-mapped contents of the inputfile. The data variables are shown in the Input Tree view. The properties of datavariables in a JDE PDF input file cannot be edited.

Page 100: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 5: Input Design

100 Create!form Director

You can also create your own variables from expressions containing data variablesand other types of information Section 5.8.

5.8 Creating Derived VariablesDerived variables are expressions that are used to combine and manipulate the valuesof data variables. To create a derived variable, select Input Derived Variables fromthe Main menu to display the Derived Variables dialog. For information on creatingexpressions, see Section 9.1.

Examples:

For information on how to use derived variables in the project, see Section 8.2.

Derived Variable ExpressionTotalPrice (UnitPrice+SalesTax)*Qty

LastChar substring(ProdDesc,length(ProdDesc),1)

AddressLine1 Title+FirstName+LastName

DaysInMonth Day(date(year(Sys.Today),month(Sys.Today)+1,1)-1)

Page 101: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

6

Create!form Director 101

NodesNodes define the actions you want the server to perform on the input file and thedestinations it will be sent to.

The following topics are covered in this chapter:

Key Design Concepts

Adding Nodes

Selecting and Editing Nodes

Node Properties

Window Display Preferences

Page 102: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 6: Nodes

102 Create!form Director

6.1 Key Design ConceptsA Create!form Director project defines the sequence and logic for processing, mergingand delivering input files. The procedures for designing a project involve creating aflowchart constructed from nodes and connectors. Each node represents either anaction, a destination or a decision, which is applied to the input file. The project iscreated and edited graphically in the Design Window. In the sample project shownbelow, the data in the input file is transformed, merged, faxed, emailed, printed,archived and extracted:

Figure 6-1: Sample design

Page 103: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 103

6.1 Key Design Concepts

What do you want to know about?• About nodes (Section 6.1.1)• About parent, sibling and child relationships (Section 6.1.2)• Sequence and timing (Section 6.1.3)• Using variables and expressions to control actions (Section 6.1.4)

6.1.1 About nodesThere are three types of nodes:

• Destination - sends data to a destination• Decision - redirects data by applying a condition• Action - performs an action on the data

The nodes available in a Create!form Director project are summarized below:

Icon Node Type DescriptionSend to Current Device Destination Sends data to the current device

Send to Queue Destinationa Sends data to a print queue

Send to Folder Destination Sends data to a network folder

Send to FTP Destination Sends data to an FTP address

Send to HTTP Destination Sends data to an HTTP address

Condition Decision Redirects by applying a condition

Split Action Partitions the input file into subdocuments

Sort Actionb Sorts input file partitions

Sub Project Action Processes data through another Create!form Director project

Merge Action Merges data with a Create!form Designer project

Transform Action Transforms data with a Create!form Transform project

Update Action Updates an external database

Get File Action Terminates data flow and opens a new file

Page 104: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 6: Nodes

104 Create!form Director

Notes:

a. A merge action can also be performed at a print queue (see Send node).

b. A split action can also be performed at a Sort node.

6.1.2 About parent, sibling and child relationships

Relationships between nodes are described respective to the selected or referencenode, and can be either a parent, a sibling or a child. The types of node relationshipsare demonstrated in the diagram below:

Figure 6-2: Types of node relationships

Delete File Action Deletes any file

Run Program Action Runs an external program

Icon Node Type Description

Parent

Sibling before

Sibling after

Child

“Yes” Child

“No” Child

Reference

Reference

Page 105: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 105

6.1 Key Design Concepts

When you insert a node in the Design Window, you can choose the type of relationshipthe new node has with the reference node by:

• Using the Insert menu• By cursor positioning

For more information, refer to Section 6.3.2.

6.1.3 Sequence and timing

The sequence of processing is determined by the position of the node in the design.Processing starts at the root node at the top left corner and proceeds down and acrosseach branch. Processing will not start in a lower branch until processing at the last(right-most) node in the branch above has ended. Processing at destination nodes endsas soon as the input file has been delivered to the folder, queue or URL.

When considering sequence and timing issues at a destination node, the time the jobwaits on the queue, and the time the job takes to be merged and output by the queue,does not affect the time at which processing starts at the next node.

6.1.4 Using variables and expressions to control actions

An expression combines and manipulates data from variables, which can be used tocontrol actions or supply values to other processes. When the value returned by anexpression is either “true” or “false”, the expression is referred to as a condition. Youcan use expressions and conditions to control how the input file is processed,including:

• to split the input file into subdocuments • to filter what is processed at a node • to change the destination of the output when certain conditions are met• to select an action based on the properties of the input file• to provide values for database updates• to select which database should be updated• to select another spool file• to set options when running external programs

Page 106: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 6: Nodes

106 Create!form Director

The types of variables available, and when to use them, are summarized below:

For information on how to build expressions and conditions using these variables,refer to Chapter 9.

For examples of how expressions can be used to control actions, refer to:

• Design methods (Section 7.2.1)• Filtering (Section 7.2.2)• Splitting (Section 7.2.3)• Sorting (Section 7.2.4)• Duplicating (Section 7.2.5)• Merging (Section 7.2.6)• Transforming (Section 7.2.7)• Defining destinations (Section 7.2.8)• Working with job tickets (Section 7.2.9)• Using multiple Create!form Director projects (Section 7.2.10)• Publishing (Section 7.2.11)• Working with databases (Section 7.2.12)

6.2 Adding NodesYou can add nodes using the tools on the Design toolbar. The way in which the nodewill be added or inserted into the design will be indicated by the shape of the cursor(Section 6.3.2). There are some restrictions on where you can add certain types ofnodes: the cursor indicates that you cannot add the selected node type at thecurrent cursor position.

Use To providesection variables information derived from the input file (Section 8.2)

user variables user defined expressions that combine and manipulate other variables and values (Section 8.3)

global user variables information that relates to the input file as a whole (Section 8.4)

system variables page numbers, date, time, file and user attributes (Section 8.5)

lookup variables information extracted from external databases (Section 8.6)

environment variables information derived from the production environment (Section 8.7)

Page 107: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 107

6.2 Adding Nodes

To create a node:1. From the Design toolbar, select the tool for the type of node you want to create.

2. In the Design Window, position the cursor over an existing node or connector.The shape of the cursor will change, indicating whether to new node will beinserted as a parent, sibling or child node. For information on what these cursorshapes represent, refer to Section 6.3.2.

3. Click to insert the node.

Design tools

Tool Command Usage

Select Select a node Section 6.3.1

Send Send data to an output destination Section 6.4.1

Condition Redirect by applying a condition Section 6.4.2

Split Partition the input file as subdocuments Section 6.4.3

Sort Sort input file partitions Section 6.4.4

Sub Project Process data through another Create!form Director project Section 6.4.5

Merge Merge data with a Create!form Designer project Section 6.4.6

Transform Transform data with a Create!form Transform project Section 6.4.7

Update Update an external database Section 6.4.8

Get File Terminate data flow and open a new file Section 6.4.9

Delete File Delete any file Section 6.4.10

Run Program Run an external program Section 6.4.11

Page 108: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 6: Nodes

108 Create!form Director

6.3 Selecting and Editing NodesYou can edit your project in the Design Window by selecting, inserting, moving,copying and deleting nodes with the cursor.

What do you want to do?• Select nodes (Section 6.3.1)• Insert nodes (Section 6.3.2)• Edit nodes (Section 6.3.3)• Move nodes (Section 6.3.4)• Copy and paste nodes (Section 6.3.5)• Delete nodes (Section 6.3.6)

6.3.1 Select nodesUse the Selection tool ( ) to select a node. Only one node can be selected at a time.

6.3.2 Insert nodes

When you insert new nodes with the Design tools, you can control where the new nodeis inserted in one of two ways:

• by selecting a command from the Insert menu; the new node will be positionedrelative to the selected node.

• by positioning the cursor over existing nodes and connectors; the new node willbe positioned according to the current cursor shape; the selected node is ignored.

Using the Insert menu1. Select the node you want to insert adjacent to.

2. Select a tool from the Design toolbar.

3. To insert the node, select a command from the Insert menu:

Command Usage

Insert Sibling Before Paste before as sibling of current node.

Insert Sibling After Paste after as sibling of current node.

Insert Parent Paste before as parent of current node.

Page 109: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 109

6.3 Selecting and Editing Nodes

By cursor positioning1. Select a tool from the Design toolbar.

2. Move the cursor over an existing node or connector until the required action isindicated by the cursor shape in the table below.

3. Click to insert the node.

For information about relationships between nodes, refer to Section 6.1.2.

Insert Child Paste after as child of current node.

Insert Child if “Yes” Paste as “Yes” child of condition node.

Insert Child if “No” Paste as “No” child of condition node.

Cursor Usage

Insert as sibling before next node.

Insert as sibling after next node.

Insert as parent of next node.

Insert as child of nearest node.

Insert as “Yes” child of previous condition node.

Insert as “No” child of previous condition node.

Not allowed at current cursor position.

Command Usage

Page 110: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 6: Nodes

110 Create!form Director

6.3.3 Edit nodes

The properties of the node can be displayed in several ways:

• by double-clicking the node.• by right-clicking the node, and choosing Properties from the short-cut menu.• by selecting the node, and choosing Properties from the Node menu.

Choose the method that best suits the way you work.

For information about editing the properties of nodes, refer to Section 6.4.

6.3.4 Move nodes

Use the Selection tool to click-and-drag the node over the connector where you wantto insert the node. Observe how the cursor changes shape to indicate how the node willbe inserted, depending on which part of the connector the cursor is over. Forinformation on what these cursor shapes represent, refer to Section 6.3.2.

6.3.5 Copy and paste nodes

You can use the following commands from the Edit menu, or shortcut menu to cut,copy and paste nodes from one location to another in the project.

Tool Command Usage

Cut Copy selected node to clipboard and delete.

Copy Copy selected node to clipboard.

Paste As Sibling Before Paste before as sibling of current node.

Paste As Sibling After Paste after as sibling of current node.

Paste As Parent Paste before as parent of current node.

Paste As Child Paste after as child of current node.

Paste As Child if “Yes” Paste as “Yes” child of condition node.

Paste As Child if “No” Paste as “No” child of condition node.

Page 111: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 111

6.3 Selecting and Editing Nodes

To copy and paste a node:1. Select the node to copy.

2. To copy the node without deleting, • from the Main menu, select Edit Copy, or • from the shortcut menu, select Copy, or• press CTRL+C.

3. To copy and delete the node, • from the Main menu, select Edit Cut, or • from the shortcut menu, select Cut, or• press CTRL+X.

4. Right-click the node where you want the copied node to be inserted before orafter.

5. From the shortcut menu, select a command from the Paste As menu (see tableabove).

To drag and drop a copy of a node:1. While pressing the CTRL key, click-and-drag the node away from the original.

2. Drag the node over the connector where you want to insert the copied node.Observe how the cursor changes shape to indicate how the node will be inserted,depending on which part of the connector the cursor is over. For information onwhat these cursor shapes represent, refer to Section 6.3.2.

6.3.6 Delete nodes

Use the Selection tool to select the node, then press the DEL key, or select the Deletecommand from either the shortcut menu, or the Edit menu. All nodes downstreamfrom the deleted node will also be deleted.

Page 112: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 6: Nodes

112 Create!form Director

6.4 Node PropertiesThe properties of a node control the actions performed by the node and the location ofdestinations.

What do you want to know about?• Send node (Section 6.4.1)• Condition node (Section 6.4.2)• Split node (Section 6.4.3)• Sort node (Section 6.4.4)• Sub project node (Section 6.4.5)• Merge node (Section 6.4.6)• Transform node (Section 6.4.7)• Update node (Section 6.4.8)• Get File node (Section 6.4.9)• Delete File node (Section 6.4.10)• Run Program node (Section 6.4.11)

For examples of how to apply these nodes in a project, refer to Chapter 7.

Page 113: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 113

6.4 Node Properties

6.4.1 Send nodeUse the Send node to output the spool file to a destination. The destination can be afolder, URL, printer port (current device only), package and /or a print queue. To editthe properties of an existing node, double-click the node in the Design Window; theSend dialog will be displayed from which you can view and edit the properties of thenode:

Figure 6-3: Send dialog with Folder as destination type.

Page 114: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 6: Nodes

114 Create!form Director

Figure 6-4: Send dialog with Package as destination type,

DescriptionThe node name, supplied by the user.

Destination typeThe destination can be either the current device, a network folder, an FTP address, anHTTP address, package and /or a print queue. For more information, refer to Section7.2.8.1.

ImageClick the Browse button to display the Select Image dialog, from which you can selecta different icon and import new images.

Package Destination TypeThis will save the current data stream to memory and append to any other previouslysaved package data for future sending to a physical destination type. The package willget reset every time a new set of data is loaded into Director or when Empty Packageafter Send is selected. This is typically used when using Merge Nodes to create eachpage of a document because it will allow the concatenating of all output (Postscript)into one print stream or the conversion to one output document.

Page 115: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 115

6.4 Node Properties

Select named destination• To specify an explicit queue name, pathname or address for the destination, clear

the checkbox.• To select the queue name, pathname or address from a list of pre-defined named

destinations, select the checkbox.

Folder name(Destination type is Folder and Select named destination option is cleared)

The pathname of the destination folder is displayed. This may be defined by anexpression, or by the actual pathname. For information on defining folder names, referto Section 7.2.8.

Destination name(Select named destination option is selected)

The name of the destination is displayed. From this field you can:

• select New to define a new named destination• select Manage to manage the list of named destinations• select a different named destination from the list• edit the current named destination by clicking the Edit button

For more information on defining named destinations, refer to Section 7.2.8.5.

Document nameThe name of the destination file is displayed. This may be defined by an expression,or by the actual file name. To create or edit an expression, click the Expression Builderbutton . For information about building expressions, refer to Section 9.1.1.

For more information about defining destination documents, refer to Section 7.2.8.2.

Append to file(Destination type is Folder)

• To overwrite an existing file, clear the checkbox.• To append to an existing file, select the checkbox.

Send from PackageThis option will take the current datastream that is in the memory package and sendthat to whatever physical destination is chosen.

Page 116: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 6: Nodes

116 Create!form Director

Output FormatThe choices are Postscript, which is the default, PDF or PCL. This will take thePostscript that is in the package and convert it to PDF or PCL. Note that all packagedata should be postscript or text.

Empty Package after SendThis option will clean out the package cache, which will also happen when each newset arrives in Director.

Copies• Destination type is Queue

The number of copies generated at the destination queue is displayed. This maybe defined by an expression, or by typing in the number of copies. To create oredit an expression, click the Expression Builder button . For moreinformation about building expressions, refer to Section 9.1.1.

• Destination type is Package

Copies the current data stream (output page(s)) the specified number of times.

Job ticket onlySelect the checkbox to output only the information contained in the job ticket usingthe template specified in the Template field. For more information about the differentways you can use job tickets, refer to Section 7.2.9.

TemplateThe template used to create the job ticket is displayed. From this field you can:

• select (none) to output without a job ticket• select New to create a new job ticket template• select an existing job ticket template from the list• edit the current template by clicking the button

For more information, refer to Section 7.2.9.

The default template Default.jtt will prevent recursion of the inputfile. For more information, refer to Section 7.3.2.

Page 117: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 117

6.4 Node Properties

ParameterThe job ticket parameters defined in the current template are displayed. To add orremove parameters from the template, click the button next to the Template field.For more information about job ticket parameters, refer to Section 7.2.9.

ExpressionThe expressions that define the values of job ticket parameters in the current templateare displayed. To edit the expression, click the Expression Builder button adjacentto the expression. For more information about building expressions, refer to Section9.1.1.

User VariablesClick the User Variables button to edit and create user variables used at this node.

6.4.1.1 Preview Node

This menu item is available when you right-click on a Send Node. When selected andconditions allow, it will create a preview PDF for the chosen Send Node.

6.4.2 Condition node

The input file is directed to one of two possible processing paths depending onwhether the specified condition is true or false. If true, the file is sent to the “Yes” childnode, if false, to the “No” child node. For information on node relationships, refer toSection 6.1.2.

Depending on the input file and the conditions for the selectedDirector project, this option might not return any preview.

Page 118: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 6: Nodes

118 Create!form Director

DescriptionThe node name, supplied by the user.

ConditionThe logical expression that determines which processing path the file is sent to. Tocreate or edit the expression, click the Condition Builder button .

For more information about building conditions, refer to Section 9.2.1.

User VariablesClick the User Variables button to edit and create user variables used at this node.

6.4.3 Split node

The input file is partitioned into sub-documents. Each partition is processedsequentially downstream from the Split node and may be filtered into differentprocessing paths at Condition nodes.

DescriptionThe node name, supplied by the user.

Split bySelect the method by which the file will be partitioned:

• Project setThe file will be split into sets, which is defined by the Project Define Setcommand. For more information about defining sets for different types of inputfiles, refer to Chapter 5.

• ConditionThe file will be split when the condition tests true. For example, you can test thevalue of a data variable or a user variable as it changes section by section or pageby page. To create or edit the expression, select the radio button and click theCondition Builder button . For more information about building conditions,refer to Section 9.2.1.

Page 119: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 119

6.4 Node Properties

6.4.4 Sort node

The input file is sorted by partition using one or more sorting levels.

DescriptionThe node name, supplied by the user.

Partition bySelect the method by which the file will be sorted:

• Project setThe file will be sorted by set, which is defined by the Project Define Setcommand. For more information about defining sets for different types of inputfiles, refer to Chapter 5.

• ConditionThe file will be sorted into partitions determined when the condition tests true.For example, you can test the value of a data variable or a user variable as itchanges section by section or page by page. To create or edit the expression,select the radio button and click the Condition Builder button . For moreinformation about building conditions, refer to Section 9.2.1.

(sorting options)Select the method by which the file will be sorted:

• LevelThe file can be sorted into one or more levels. For example, you can set Level 1to sort sets into States, and Level 2 to sort the sets within each State by theirZipcodes.

• Sort on variableThe data variable you want to sort or group by.

• Sort orderSelect either Ascending or Descending order.

Page 120: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 6: Nodes

120 Create!form Director

• Sort modeThe following table demonstrates the ASCII, regional and numeric sort modes.

The sort order when using regional mode can vary with your Windows locale.

Split by partitionYou can optionally split the sorted file into the same partitions used for sorting. Seealso Section 6.4.3.

6.4.5 Sub project node

The input file is passed to another Create!form Director project for processing andthen passed back to the current project.

DescriptionThe node name, supplied by the user.

Director projectThe name of the Create!form Director project is displayed. This may be defined by anexpression, or by the selecting the project file with the browse button . To createor edit an expression, click the Expression Builder button . For information aboutbuilding expressions, refer to Section 9.1.1.

To open the selected project in Create!form Director, click the button.

Unsortedsample

Sort mode

ASCII Regional Numeric(space)

0210123ABCac

(space)021

1023ABCac

(space)021

1023AaBCc

(space)ABCac1

0223

10

Page 121: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 121

6.4 Node Properties

User VariablesClick the User Variables button to edit and create user variables used at this node.

6.4.6 Merge node

An in-line merge is performed allowing the merged output to be processed furtherdownstream. This performs the same function as a Send to (merge) Queue node,except the Send node terminates processing of the file on that branch.

DescriptionThe node name, supplied by the user.

Form projectThe name of the Create!form Designer project is displayed. This may be defined byan expression, or by the selecting the project file with the browse button . To createor edit an expression, click the Expression Builder button .For information aboutbuilding expressions, refer to Section 9.1.1.

To open the selected project in Create!form Designer, click the button.

If the selected form project is a JDE 3.X Project, check the Choose JDE PDF 3.XProject option below the Form project dropdown list.

ConfigurationThe merge configuration used in the merge is displayed. For more information onmerge configurations, refer to Section 7.2.6.1 or the Create!form Server user guide.

Additional Merge ParametersThe job ticket attached to the merged output is defined in this section. These JobTickets can also be used for passing parameters to the merge engine and they can bereferenced via the Createform Designer project. An example of why you might wantto do this would be for page numbering when merge nodes are used with differentprojects for each page.

These parameters are only used in the creation and output of PDFdocuments to define security options and number of copies.

Page 122: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 6: Nodes

122 Create!form Director

User VariablesClick the User Variables button to edit and create user variables used at this node.

6.4.7 Transform node

An in-line transform is performed allowing the transformed output to be processedfurther downstream. This performs a similar function to the Merge node, except theinput file is transformed into a new format e.g. CSV or XML, instead of being mergedwith a form.

DescriptionThe node name, supplied by the user.

Transform projectThe name of the Create!form Transform project is displayed. This may be defined byan expression, or by the selecting the project file with the browse button . To createor edit an expression, click the Expression Builder button .For information aboutbuilding expressions, refer to Section 9.1.1.

To open the selected project in Create!form Transform, click the button.

User VariablesClick the User Variables button to edit and create user variables used at this node.

6.4.8 Update node

Adds and updates records in a database. The Update node is typically used inconjunction with the Transform node (to create a CSV update file) and the Get Filenode (to open the update file).

Before you can select the database from the Update Database dialog, you must firstcreate a DSN.

DescriptionThe node name, supplied by the user.

DatabaseThe DSN details are displayed.

Page 123: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 123

6.4 Node Properties

Connection stringThe connection string is generated for you when you select the DSN. To select theDSN, click the Select DSN button adjacent to the Connection string field andsupply your login details when prompted.

TableSelect the table you want to update.

ActionThe action performed by the update is displayed. Select from the options displayed:

• Add onlyUse this option to add new records to the database without changing any existingdatabase records.

• Update onlyUse this option to update existing records in the database without adding anynew database records.

• Add/UpdateUse this option to update existing records in the database and add any newrecords.

User VariablesClick the User Variables button to edit and create user variables used at this node.

6.4.9 Get File node

The current input file will be terminated and a new input file is opened and processedon the current branch.

DescriptionThe node name, supplied by the user.

Folder nameThe pathname of the target folder is displayed. This may be defined by an expression,or by the selecting the folder with the browse button . To create or edit anexpression, click the Expression Builder button .For information about buildingexpressions, refer to Section 9.1.1.

Page 124: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 6: Nodes

124 Create!form Director

File nameThe name of the target file is displayed. This may be defined by an expression, or bythe selecting the file with the browse button . To create or edit an expression, clickthe Expression Builder button .For information about building expressions, refer toSection 9.1.1.

Keep trying for ... secondsThe action will time-out if it cannot be performed within the specified time period.

User VariablesClick the User Variables button to edit and create user variables used at this node.

6.4.10 Delete File node

The specified file will be deleted.

DescriptionThe node name, supplied by the user.

Folder nameThe pathname of the target folder is displayed. This may be defined by an expression,or by the selecting the folder with the browse button . To create or edit anexpression, click the Expression Builder button .For information about buildingexpressions, refer to Section 9.1.1.

File nameThe name of the file to be deleted is displayed. This may be defined by an expression,or by the selecting the file with the browse button . To create or edit an expression,click the Expression Builder button .For information about building expressions,refer to Section 9.1.1.

Keep trying for ... secondsThe action will time-out if it cannot be performed within the specified time period.

User VariablesClick the User Variables button to edit and create user variables used at this node.

Page 125: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 125

6.5 Window Display Preferences

6.4.11 Run Program node

An external program is run using the options defined in the command line.

DescriptionThe node name, supplied by the user.

Executable fileThe name of the program file is displayed. This may be defined by an expression, orby the selecting the file with the browse button . To create or edit an expression,click the Expression Builder button .For information about building expressions,refer to Section 9.1.1.

Command lineThe command line options used by the program are displayed. This may be defined bytyping the actual text string, or by an expression, To create or edit an expression, clickthe Expression Builder button .For information about building expressions, refer toSection 9.1.1.

Keep trying for ... secondsThe action will time-out if it cannot be performed within the specified time period.

User VariablesClick the User Variables button to edit and create user variables used at this node.

6.5 Window Display PreferencesYou can customize the way nodes are edited and displayed by selecting theTools Preferences command. With the options displayed in the panes of thePreferences dialog, you can:

• turn on and off rulers• turn on and off tooltips• select how nodes are annotated

Processing at the next node in the project will occur immediately,without waiting for a response from the external program.

Page 126: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 6: Nodes

126 Create!form Director

• customize the color of connectors, annotation and the window background• customize node icons

Page 127: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

7

Create!form Director 127

Methods and ProceduresThe design process involves combining the different types of nodes available toachieve a desired workflow. Create!form Director allows you to customize yourdesign to cope with different input formats, processing methods and destination types.

The following topics are covered in this chapter:

Input Options

Key Tasks

Output Options

Page 128: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 7: Methods and Procedures

128 Create!form Director

7.1 Input OptionsThe input file type, the structure of the input file and how its contents are mapped asvariables are defined by the project DataMap. You can create a DataMap for eachproject, or share DataMaps with other Create!form projects, including Create!formDesigner and Create!form Transform projects. To learn more about DataMap options,refer to Section 5.3.

The DataMap of a Create!form Director project is specified independently of anymerge projects or Create!form Director sub-projects that may be used in the project.

To create a new DataMap for a project, refer to the following topics:

• Designing for CSV Input Files (Section 5.4) • Designing for Text Input Files (Section 5.5) • Designing for XML Input Files (Section 5.6) • Designing for JDE PDF Input Files (Section 5.7)

7.2 Key Tasks

What do you want to know about?• Design methods (Section 7.2.1) • Filtering (Section 7.2.2) • Splitting (Section 7.2.3) • Sorting (Section 7.2.4) • Duplicating (Section 7.2.5) • Merging (Section 7.2.6) • Transforming (Section 7.2.7) • Defining destinations (Section 7.2.8) • Working with job tickets (Section 7.2.9) • Using multiple Create!form Director projects (Section 7.2.10) • Publishing (Section 7.2.11) • Working with databases (Section 7.2.12) • Triggering (Section 7.2.13)

Page 129: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 129

7.2 Key Tasks

7.2.1 Design methodsEach node in the project design defines a specific task that you want to perform on theinput file. For example, you may wish to split the input file into separate invoices, sothat each split can be merged with a particular invoice form, and delivered to aparticular printer. You can design your project so that the same task is performed onevery input file, and delivered to the same destinations, or you can define conditionsand expressions so that the project treats input files in different ways, depending onthe contents and properties of the file.

By way of example, consider the above case where the input file needs to be split byinvoice, merged with different form projects and sent to multiple destinations. Thiscan be achieved in a variety of ways, depending on the structure of your input file. Inthis particular case, assume that a DataMap has been created, and the DataMap definesindividual invoices as sets, and the zip code on the first page of each invoice has beenmapped as a data variable named Zip_Code. In this case, we also know that the inputfile always arrives with a job ticket that has been attached by Create!send, whichprovides information supplied by the originating application. The parameters in thisparticular job ticket are the host system name (%cpSystem:), the user name (%cpUser:),the input file name (%cpFileName:) and the project name (%cpParam:-s):

Figure 7-1: Sample job ticket

Here are three different methods you can use to create your design, which achieveexactly the same outcome:

Use condition nodes with multiple send nodes:1. Split the input file by invoice (Section 7.2.3).

2. Use condition nodes to direct invoices to different send nodes (Section 7.2.2).

3. Merge each split with the required region invoice form (Section 7.2.6).

4. Output to the required printer in each district office (Section 7.2.8).

%cpBegin%cpSystem:JACARANDA%cpUser:Western%cpFileName:stdinvoice.txt%cpParam:-sSTDINVOICE%cpEnd<text file>

Page 130: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 7: Methods and Procedures

130 Create!form Director

In this case, the Condition nodes use expressions that test the value of Zip_Code in eachinvoice partition, which are then directed to the required Send node. The merge projectand the destination are explicitly defined at each Send node.

Use an expression to select merge projects and use condition nodes to select destinations:1. Split the input file by invoice (Section 7.2.3).

2. Send all sets to a merge node and use an expression to select the required mergeproject (Section 7.2.9).

3. Use condition nodes to direct merged invoices to different Send nodes(Section 7.2.2).

Split Send Print

by invoice Eastern

Mid West

Western

South West

Boston

Phoenix

Condition

Midwest.cfp6

Western.cfp6

Southwest.cfp6

Eastern.cfp6

Zip?

Zip?

Zip?

Split Merge Print

by invoice Invoices

Eastern.cfp6Midwest.cfp6Western.cfp6Southwest.cfp6

Condition

Boston

Phoenix

Send

Zip?

Zip?

Page 131: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 131

7.2 Key Tasks

In this case, the %cpUser: job ticket variable is used in an expression that defines thename of the merge project (%cpUser:Western means that the spool file only contains“Western” region invoices), and the merged output is filtered on Zip_Code throughCondition nodes to the required Send node. The destination is explicitly defined ateach Send node.

Use expressions to merge and send from the same node:1. Split the input file by invoice (Section 7.2.3).

2. Send all invoices to a send node with one merge project that employs variablesubforms and alternate sections to customize the form for each regional office.For more information, refer to Create!form Designer user manual.

3. Use an expression to select a destination (Section 7.2.8).

In this case, the %cpUser: job ticket variable is used by the merge project to select therequired letterhead subform for each regional office, and in the expression thatconstructs the name of the destination print queue.

7.2.2 Filtering

Condition nodes act as filters on the spool file so that you can direct either the entirespool file, or parts of the spool file to different nodes downstream for furtherprocessing. Consider the two projects shown in the diagram below:

Split

by invoice

Print

Boston

Phoenix

Send

Invoices

Invoices.cfp6

Page 132: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 7: Methods and Procedures

132 Create!form Director

In project A, the test will be applied to the entire spool file, which will be directed toone of two child nodes. Typically the test would be applied on the value of a globalvariable or a job ticket variable, which identifies how the spool file should beprocessed. For example, the job ticket variable %cpOutQName might have two possiblevalues “Invoices” or “Dockets”. In this case, you can use a Condition node with thecondition %cpOutQName=="Invoices" which, if true, will direct the spool file to theInvoices sub-project, and, if false, to the Dockets sub-project.

In project B, the spool file is first split into sets, and the test will be applied to each setin the spool file. Typically the test would be applied on the value of a data variable oruser variable defined in the DataMap, which changes with each set in the spool file.For example, a data variable Region_Code might be defined in the DataMap, which hasfive possible values “USA”, “CAN”, “CH”, “UK” or “AUS”. In this case, you can usea Condition node with the condition Region_Code=="USA" OR Region_Code=="CAN"which, if true, will direct the spool file to the NAM merge queue, and, if false, to theINT merge queue.

The variables available to you when creating conditions are listed in the Variablesection of the Condition Builder, which include:

• Section variables: data variables and derived variables defined by the DataMap.• User variables: user defined expressions that can vary by node or set.• Global user variables: user defined expressions that relate to the entire the spool

file e.g. global variables may be constant or can accumulate values set to set, ornode to node.

• Lookup variables: values extracted from external databases.

Split NAM

INT

Invoices

Dockets

Condition

B

A

Condition

Region_Code==”USA” OR Region_Code==”CAN”

%cpOutQName==”Invoices”

Y

N

N

Y

Page 133: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 133

7.2 Key Tasks

• System variables: system defined values relating to the spool file, sets, the serverand other information.

• Job ticket variables: values derived from the spool file job ticket that apply to theentire spool file.

• Environment variables: user defined values that apply to the entire productionsystem, or to specific destinations.

To create a condition:• Click the Condition Builder button on the Condition dialog.

For information on using the Condition Builder, refer to Chapter 9.

To create a user variable you can use in a condition:• Click the User Variables button on the Condition dialog.

The User Variables dialog will be displayed. For more information on using theExpression Builder, refer to Chapter 9.

For information on all other variables, including creating global variables andenvironment variables, refer to Chapter 8.

7.2.3 Splitting

A common reason for using a split action is to distribute different parts of a documentto different destinations. For example you may want to send the data relating toparticular states to different print queues. When a spool file is split, the variablesassociated with the spool file, like job ticket variables and global variables, will remainavailable to each part of the file as they are processed downstream from the split node.

You can split the spool file by set, or by defining a condition:

Splitting by setSets are defined by the project DataMap. For information on defining sets, refer toChapter 5.

Splitting by conditionWhen you use a condition to split the spool file, the split occurs when the conditiontests true. For example, you might test when the page number equals 1 with theexpression: Page_No == "1" or when the invoice number changes with the expression:changed("Inv_No").

Page 134: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 7: Methods and Procedures

134 Create!form Director

In these examples, the section variables Page_No and Inv_No would be defined in theproject DataMap. The variables available to you when creating conditions are listed inthe Variable section of the Condition Builder.

Splitting can also be used to group sets of documents together. For example, if you areoutsourcing your printing, you might need to limit the size of each print batch. Thesplit needs to occur at the start of the first set that follows a specified page limit. Youcan create a global variable in the merge project that is reset to 1 when both of theseconditions are met, and then test when this occurs at the split node.

About the order in which splits are processedWhen the spool file is split, each part of the file will be processed in turn: the projectwill start processing the next part as soon as the preceding part has been delivered toa Send node. If the parts of the file are delivered to different print queues, the order inwhich printing each part is completed will depend on the number of print jobs in eachqueue, the size of each print job, and the relative speed of each printer. For moreinformation on the sequence and timing of processes, refer to Section 6.1.3.

7.2.4 Sorting

You can re-order the contents of the spool file using a sort node. Typically, this is doneso that sets are presented to the printer in a particular order, or to group sets togetherbefore the spool file is split. When sorting a spool file, you must specify how the filewill be partitioned, and how these partitions will be ordered. For example you canpartition the file by sets, and then order the sets using a section variable, like an invoicenumber or customer code. Alternatively, you can perform a multi-level sort that ordersthe sets, first by zip code, and then alphabetically by customer name. The variablesyou use to control the sorting must be defined in the project DataMap.

Sort and splitYou can also split the spool file at a sort node if the sorting and splitting partitions arethe same. For example, you can partition the spool file by set, sort by a date variable,and then split by set. To sort and split with different partitions, sort the spool file at asort node, then split the file at a split node:

You can also split the spool file at a Sort node (Section 7.2.4).

Page 135: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 135

7.2 Key Tasks

7.2.5 Duplicating

Duplication is commonly used when the same spool file needs to be output in multipleformats to multiple destinations. For example, when a document is printed to aPostScript printer, you can also create a PDF copy of the document for archiving.

You can duplicate the spool file by inserting multiple sibling nodes. Consider theexample in the diagram below:

In this project, the spool file is processed at node 1 (the parent node), then at node 2 (achild of node 1) and then at node 3 (a child of node 2). When node 4 is inserted as asibling of node 2, the spool file will be duplicated and also processed at node 4. Theduplicate is processed at node 4 as soon as processing has completed on all child nodesof higher sibling nodes i.e. when processing at node 3 is completed.

7.2.6 Merging

Merging is the process by which a spool file is reformatted and reorganized with aCreate!form Designer project. For information on how to create merge projects, referto the Create!form Designer user guide.

To duplicate pages at the printer, modify your merge project usingthe Project Properties command in Create!form Designer. Formore information, refer to the Create!form Designer user guide.

SortA Split

Partition by: setSort on: Zip_Code

Split by: State_Code

Send

Publish into individual state folders

Split by: State_Code

node 4

node 2

node 1A

node 3

Page 136: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 7: Methods and Procedures

136 Create!form Director

A Create!form Designer project allows you to create customized forms in which thecontents of the input file will be reformatted and reorganized, with additional text,graphics, barcodes and other objects. Typically, Create!form Designer projects areused for invoices, picking slips, letters, delivery dockets and other forms requiring agraphical layout.

DataMapsWhen you design a Create!form Designer project, you must also define a DataMap,which describes the structure and contents of the input file, so it can be mapped to theoutput form. The DataMap you create or select for your Create!form Designer projectsis independent of the DataMap you create or select for the Create!form Directorproject, but they can be shared. To learn more about DataMap options, refer to Section5.3.

In-line MergeYou can use a Merge node to merge the input file with a Create!form Designer projectand then continue processing the merged output in the Create!form Director project.

Merging at a QueueYou can use a Send node to merge the input file with a Create!form Designer projectat a Create!form Server merge queue.

7.2.6.1 Merge configurationsMerge configurations are named configuration settings that define the merge andoutput settings used by Create!form Server. You can create merge configurations inany Create!form project i.e. Create!form Director, Create!form Designer andCreate!form Transform projects. Project merge configurations will be copied to theserver when the project is transferred.

7.2.7 Transforming

A Create!form Transform project allows you create text output files in which thecontents of the spool file is reorganized and reformatted. Typically, Create!formTransform projects are used for creating CSV files for database updates, XMLtransaction files and other formatted text messages. For example, with Create!formTransform you can:

• extract summary data from the spool file, and output the data as a CSV file toperform a database update.

Page 137: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 137

7.2 Key Tasks

• generate usernames and passwords, which are sent to customers by email to gainaccess to protected PDF statements.

For information on how to create Transform projects, refer to the Create!formTransform user guide.

7.2.8 Defining destinations

The destination of the processed and merged spool file is defined at the Send node.The way in which you define destinations will depend on the type of destination youare sending the spool file to. For information about destinations types, refer to(Section 7.2.8.1).

Once you have selected the destination type, you may be required to provideadditional information for:

• Naming destination documents (Section 7.2.8.2)• Defining login details (Section 7.2.8.3)

You can then define the destination in several ways:

• by address (Section 7.2.8.4)• by name (Section 7.2.8.5)• by expression (Section 7.2.8.6)

7.2.8.1 Types of destinationsThe spool file can be sent to the following destination types:

• Current device

A Create!form Director project is called from a specific print queue. When theprint queue is created, a printer port is defined, such as a network printer or aCreate!form fax, email or archive port. The current device of a Create!formDirector project is the printer port of the print queue from which the project iscalled.

• Folder

A local or network folder, where the spool file can be saved to file.

• FTP

An FTP address, where the spool file can be saved to file.

• HTTP

An HTTP address, where the spool file can be saved to file.

Page 138: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 7: Methods and Procedures

138 Create!form Director

• Queue

A local or network print queue, where the spool file can be

• merged with a Create!form Designer or Create!form Transform project andprinted to a print device or a Create!form port, or

• processed with another Create!form Director project, or• printed without merging or further processing.

• Package

Saves the current data stream to memory and appends to any other previouslysaved package data for future sending to a physical destination type. Forinformation about using this destination type, refer to Section 6.4.1.

7.2.8.2 Naming destination documentsCertain types of destinations allow you to name the file that will be created at theselected destination folder or address.

To define an explicit file name:Type the full pathname in the file name field.

To define the file name by expression:You can use an expression to define the destination file name.

Click the Expression Builder button . The expression must generate the fullpathname, and account for exceptions that might occur in the input data. Forinformation about building expressions, refer to Section 9.1.1.

If you do not specify a document name:If a document name is required, and has not been specified, Create!form Director willautomatically generate file names in the form stem-nnnnn.xxx, where stem is the stem ofthe input file name, nnnnn is a sequential file partition number, and xxx is the file nameextension determined by the output format, e.g. StdInvoice-00234.pdf.

If the named file already exists at the destination, select or clear theAppend to existing file checkbox to append the data to the existingfile, or overwrite it.

Page 139: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 139

7.2 Key Tasks

7.2.8.3 Defining login detailsCertain types of destinations require you to specify a login name and password to viewor write to the selected destination folder or address. When prompted, type the Loginname and Password in the Login dialog.

7.2.8.4 Defining destinations by addressThe options displayed on the Send dialog will vary depending on the type ofdestination you have selected.

To select a printer:1. Double-click the Send node.

The Send dialog will be displayed.

1. From the Destination type dropdown list, select Queue.

2. Clear the Select named destination checkbox.

3. Click the browse button next to the Queue name field.The Select Printer dialog will be displayed.

4. From the Name field, select the printer name and click OK.

5. Click OK.

To select a folder:1. Double-click the Send node.

The Send dialog will be displayed.

1. From the Destination type dropdown list, select Folder.

2. Clear the Select named destination checkbox.

3. Click the browse button next to the Folder name field.The Select Destination Folder dialog will be displayed.

4. Select the folder, or create a new folder, and click OK.

5. If required, define the document name (Section 7.2.8.2) in the Document namefield.

6. Click OK.

Page 140: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 7: Methods and Procedures

140 Create!form Director

To select FTP and HTTP addresses:1. Double-click the Send node.

The Send dialog will be displayed.

1. From the Destination type dropdown list, select FTP or HTTP.

2. Clear the Select named destination checkbox.

3. In the FTP/HTTP address field, type the full address, e.g. ftp://www.newworld.com/private.

4. Select the folder, or create a new folder, and click OK.

5. If required, define the document name (Section 7.2.8.2).

6. If required, define the login name and password (Section 7.2.8.2) required toaccess this address.

7. Click OK.

7.2.8.5 Defining named destinationsNamed destinations are provided for ease of identification of print queues, folderpathnames and URL addresses. Instead of selecting from a list of obscure printeraddresses like “\\Flyingfox\Lexmark Optra S 2450 PS”, you can give each destinationa meaningful name like “HR Dept”, “Fax server” and “Archive folder”.

Named destinations only need to be created once in the project and will be availablein all send nodes of the same type. Named destinations can be assigned to alldestination types: folder, FTP, HTTP and queue.

Working with named destinations on the serverNamed destinations are saved to the configuration file destinations.data in the\SystemResource folder. When the project is transferred to the server, the destinationsfile on the server will be overwritten. It is recommended practice, before you begindefining named destinations, to copy the destinations file from the server to the designworkstation. This will ensure that, when the project is transferred, any newdestinations will be added and all existing destinations will be preserved.

To create a named destination:1. In the Design Window, double-click the send node where the destination is will

be specified. The Send dialog will be displayed.

Page 141: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 141

7.2 Key Tasks

2. Select the Select named destination checkbox.

3. From the Destination name drop-down list, select New...The <destination type> Destination dialog will be displayed.

4. Click the Browse button next to the <destination type> name field.The Select Printer dialog will be displayed.

5. From the Name dropdown list, select the printer e.g. \\server.co.hr5\HP4050T,and click OK.

6. In the Destination name field, type the name you want to use for this destinatione.g. Denver Accounts, and click OK.

7. Repeat steps 3 through 6 until each destination has been named.

To use a named destination:1. In the Design Window, double-click the send node where the destination is

specified. The Send dialog will be displayed.

2. Ensure the Select named destination checkbox is selected.

3. From the Destination name dropdown list, select the destination name.

7.2.8.6 Defining destinations by expressionYou can use an expression to select the destination. For example, say the job ticketvariable %cpParam:-s has values of “Denver”, “Seattle” or “Phoenix”, which is used toselect the merge project at a Send node e.g. Seattle.cfp6; and the output from each ofthese projects is sent to different print queues. In this case, you would create adestination variable whose value was conditional on the value of the %cpParam:-s jobticket variable. The steps involved in this particular case would be:

1. Double-click the send node where the merge occurs.The Send dialog will be displayed.

2. Click the User Variables button.The User Variables dialog will be displayed.

Page 142: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 7: Methods and Procedures

142 Create!form Director

3. Define the user variable Print_To, whose value is conditional on the value of the%cpParam:-s job ticket variable, as shown in Figure 7-2:

Figure 7-2: Defining a destination variable

4. Click OK to close the User Variables dialog.

5. On the Send dialog, clear the Select named destination checkbox.

6. Click the Expression Builder button next to the Queue name field.The Expression Builder dialog will be displayed.

7. From the Variable field, select the user variable Print_To.

8. Click OK.

7.2.9 Working with job tickets

A job ticket can be added to the input file, and is used to pass information to otherCreate!form components when merging, faxing, emailing and archiving the output.The information required by the output component is defined by a job ticket template.Standard templates for printing, faxing and emailing are provided, but you cancustomize these templates for specific output tasks and types of data.

Default TemplateWhen a new Send node is created, the template Default.jtt is initially selected. Thistemplate contains the %cpBegin and %cpEnd tags, which causes the %cpOrigProject tag tobe added when processed by Create!form Server. This tag tells the server that the filehas already been processed as a safeguard against recursion.

For information about the content and format of templates, refer to the user guides forthe respective output components.

Page 143: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 143

7.2 Key Tasks

7.2.10 Using multiple Create!form Director projects

You can pass the input file to another Create!form Director project at a Sub Projectnode. This is typically used in conjunction with Condition nodes to determine whichCreate!form Director project the input file should be processed by:

7.2.11 Publishing

Publishing is the process of generating output to multiple merge queues from a singleproject. The methods used to publish data are described in this user guide. Apublishing licence is required to output to multiple merge queues.

7.2.12 Working with databases

You can extract information from databases for use in the project, as well as updatedatabases from the project.

Extracting information from a database for use in the project:You can use lookup variables at nodes in the project to extract information stored inan external database. To create a lookup variable at a project node, refer to Section 8.6.

Updating a database with information extracted from the spool file:You can use an Update node to add and update records in a database. The Update nodeis typically used in conjunction with the Transform node (to create a CSV update file)and the Get File node (to open the update file).

Project1

ConditionA

Condition

Y

N

N

Y

Project2

Project3

Page 144: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 7: Methods and Procedures

144 Create!form Director

7.2.13 Triggering

You can trigger other workflow events in several ways. For example, you might sendan email, run an external program, or send a file to a watch folder. These actions canbe initiated by the Run Program and Get File nodes. Consider the examples below, inwhich different actions are triggered after a spool file merge has been completed:

In project A, once the spool file has been merged and sent to the print queue, a messagefile is opened by the Get File node and sent by email as a notification.

In project B, as soon as the send node prints a delivery docket, the materials safety datasheet is printed to the same printer by running MS Word in command line mode froma Run Program node.

When triggering actions, it is important that they are performed in the correctsequence; for information about sequence and timing of actions, refer to Section 6.1.3.

By combining these basic mechanisms with other Create!form Director functions, youcan customize your projects to trigger a wide range of workflow processes, actions andevents, as demonstrated in the diagram below:

Send

A

Get File Send

email

PrintNotice.txt

Send

B

Run WINWORD

MaterialsSafetyDataSheet.doc

Page 145: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 145

7.3 Output Options

7.3 Output Options

What do you want to know about?• Output formats (Section 7.3.1) • Recursion (Section 7.3.2) • Output to file (Section 7.3.3) • Printing (Section 7.3.4) • Fax (Section 7.3.5) • Email (Section 7.3.6) • Archiving (Section 7.3.7)

7.3.1 Output formatsThe output format from a Create!form Director project is determined by the processesdefined in the project. A wide variety of formats can be generated, including text,PDF, CSV, PostScript or PCL, and depends on the format required at the destinationdevice or output port.

The output format can be controlled at the following types of nodes:

• Merge nodeThe output format is determined by the merge configuration specified at thenode.

Send

C

Update Database

Transform

Newcustomer?

Y Generate username and password

Get File Send

Send

Publish customer statement to web site

Customer login details

Notify customer by email

Page 146: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 7: Methods and Procedures

146 Create!form Director

• Transform nodeThe output format is determined by the Create!form Transform project specifiedat the node.

• Send to Queue nodeThe output format is determined by the merge configuration specified at thequeue.

7.3.2 Recursion

Recursion is the process by which a project can call itself. This can occur when theoutput is sent to the same queue from which the project was called. You can preventrecursion by selecting the default template (Default.jtt) at a Send node (Section 6.4.1).When Create!form Server encounters the default template, the project setting at thatqueue will be ignored and the file will be output.

7.3.3 Output to file

Use the following destination types at a Send node to output to file:

• Folder• FTP• HTTP

7.3.4 Printing

Specify the output format in the merge configuration at Merge and Send nodes:

• PostScript• PCL• PDF

To print to the current device:1. Double-click the Send node in the Design Window.

The Send dialog will be displayed.

2. In the Destination type field, and select Current Device from the drop-down.

To print to a different print device:1. Double-click the Send node in the Design Window.

The Send dialog will be displayed.

Page 147: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 147

7.3 Output Options

2. In the Destination type field, and select Queue from the drop-down.

7.3.5 Fax

Use a Send to Queue node to output to a Create!fax port. For more information, referto the Create!fax user guide.

7.3.6 Email

Use a Send to Queue node to output to a Create!email port. For more information, referto the Create!email user guide.

7.3.7 Archiving

You can send the output to Create!archive by either:

• Use a Send to Folder node to output to a Create!archive watch folder.• Use a Send to Queue node to send the output to a Create!archive port.

For more information, refer to the Create!archive user guide.

Page 148: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April
Page 149: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

8

Create!form Director 149

VariablesYou can use variables as arguments in expressions and conditions that control howdata is processed in a project.

The following topics are covered in this chapter:

About Variables

Data Variables, Derived Variables and Section Variables

User Variables

Global User Variables

System Variables

Lookup Variables

Environment Variables

Job Ticket Variables

Page 150: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 8: Variables

150 Create!form Director

8.1 About VariablesVariables can be used as arguments in conditions and expressions defined in projectnodes. There are several different types of variables that you can use in a project; thetype of variable you use will depend on where you want to source your data and howit will be applied in the project:

• Data Variables, Derived Variables and Section Variables (Section 8.2)• User Variables (Section 8.3)• Global User Variables (Section 8.4)• System Variables (Section 8.5)• Lookup Variables (Section 8.6)• Environment Variables (Section 8.7)• Job Ticket Variables (Section 8.8)

8.2 Data Variables, Derived Variables and Section VariablesData variables and derived variables are created in the input design (Chapter 5) and areavailable as Section Variables at nodes. You can view the variables defined in theinput design from the Input Tree (Section 4.1.3).

8.3 User VariablesUser Variables are defined by users and derive their value from functions andexpressions using other variables as arguments. User variables are created at andbelong to a node. They can be used for a wide variety of tasks.

For example, you might create a user variable to construct an output filename. Theuser variable can take data from the input file, and use the text functions available tocreate a unique filename.

To create a user variable:1. Select the node you want the user variable to be available in.

2. From the Main menu, select Node User Variables.The User Variables dialog will be displayed.

3. If required, click the Add Row button ( ) A new variable is created.

Page 151: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 151

8.4 Global User Variables

4. To create a condition, click the Condition button ( ) in the Condition columnand see Section 9.2 for information on creating conditions.

5. In the Variable Name column, type a name for the user variable.

6. Click the Expression button ( ) to create the expression that will generate thevariable value.The Expression Builder will be displayed. For information on buildingexpressions, see Section 9.1.2.

7. Click OK.Once you have created a user variable, you can use it to build other expressionsor conditions defined from the node dialog.

8.4 Global User Variables Global user variables enable you to create a variety of dynamic fields and use them inany node in the project. Global user variables have an initial value and are passedsequentially from node to node. At each node they can have their value changed.

Global user variables are typically used in conjunction with user variables. Global uservariables can provide values for user variables, or derive values from user variables.

To create a global user variable: 1. From the Main menu select Project Global User Variables.

The Global User Variables dialog will be displayed.

2. Click the Add Row button.

3. In the Variable Name column, type a name.

4. In the Initial Value column, type an initial value.

5. Click OK.

Global variables can be used in conditions and expressions at any node.

Page 152: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 8: Variables

152 Create!form Director

8.5 System VariablesCreate!form Director provides pre-defined variables that you can use to determineinformation about the project and the operating environment. The following tabledescribes the system variables available in the input and output of the design:

System variables can be used in expressions and conditions at any node.

8.6 Lookup VariablesLookup variables retrieve values from external databases. For example you can uselookup variables to retrieve a customer telephone number from a database. Lookupvariables are defined at and belong to a node in the project.

System Variable Description

Inpu

t

Out

put

Sys.DeviceName Name of destination port, queue or device. 4 4

Sys.DocName Name of spool file. 4 4

Sys.DocPageNum Current page number in the document. 4

Sys.DocSetNum Current set number in the document. 4

Sys.Hostname Name of host server where queue resides. 4 4

Sys.OSVersion Version of operating system running on host. 4 4

Sys.PDFNumCopies Section 5.7.1 4

Sys.PreviousSection Name of previous detail section. 4

Sys.ProductVersion Details about Create!form Server installed on host. 4 4

Sys.ProjectName Name of current project. 4 4

Sys.QueueName Name of print queue where merge occurs. 4 4

Sys.RandomString Returns a random test string. 4 4

Sys.SplitPageNum Current page number in the split. 4

Sys.SpoolID Spool file ID on the merge queue. 4 4

Sys.Time Time of merge supplied by the system. 4 4

Sys.Today Current date value supplied by the system. 4 4

Sys.Username Username property of spool file. 4 4

Page 153: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 153

8.6 Lookup Variables

RequirementsTo use lookup variables you require a DSN connection to an ODBC database. Toenable production printing, you must also create a permanent connection between thee-forms server and the database(s). For more information see the Create!form ServerUser Guide.

To create a lookup variable: 1. From the Create!form Director main menu, select Node Lookup Variables.

The Lookup Variables dialog will be displayed.

Figure 8-1: The Lookup Variables dialog.

2. From the drop-down list under the Database (DSN) field, select the DSN for thedatabase you want to retrieve data from, or click New to create a new DSN. Setup procedures for databases will vary.

3. If multiple tables/views exist in the database, select the appropriate one from theTable/view drop-down.

4. In the Select records where field, define a query by selecting: • the Database Field from the database table that will be searched in and;• the Variable from the project containing the value that will be searched with.

Ensure the query will only match with one record. If you need to add furtherqualifiers, clicking the Add Row button ( ) and select further fields andvariables.

Page 154: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 8: Variables

154 Create!form Director

5. In the Assign to variables field, define the response to the above query by: • typing the Variable Name in the project to assign to and;• selecting the Database Field from the database table to assign from.

It is possible to return more than one response from that particular record inthe database by clicking the Add Row button and defining further VariableNames and Fields.

8.7 Environment VariablesEnvironment variables are common to all projects in the production environment.Environment variables may be the same for all output destinations, or can be changedfor individual print queues. Typical uses of environment variables include settingvalues that are used in all projects, like a company name, or using a different mergeproject depending on whether the destination is a printer, fax, email or archive serverport.

StorageEnvironment variables are stored in the EnvironmentVars.data file in the SystemResourcefolder. This file will be uploaded to the e-forms server when the project is transferred.

To create an environment variable:1. From the Main menu, select Tools Environment Variables.

The Environment Variables dialog will be displayed.

2. To create a new environment variable, click the Add Row button ( ).

3. Type the name of the environment variable in the Name field.

4. Type the value of the environment variable in the Value field.

5. Click OK.

8.8 Job Ticket VariablesAll the job ticket values passed through with the spool file, or added by the e-formsserver are available wherever system variables are available in the design. The jobticket variables available to a project must be defined in the following configurationfiles found in the Win32User folder:

• Text, CSV and XML input files: HeaderParams.cfg• JDE PDF input files: JDEHeaderParams.cfg

Any changes you make to configuration files on the design workstation will betransferred to the e-forms server with the project (Section 3.9).

Page 155: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

9

Create!form Director 155

Expressions and ConditionsYou can create expressions and conditions to combine and manipulate text, calculatevalues, summarize data in tables and test when objects, sections and pages should bedisplayed.

The following topics are covered in this chapter:

Expressions

Conditions

Building Blocks

Syntax and Order of Precedence Rules

Page 156: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 9: Expressions and Conditions

156 Create!form Director

9.1 Expressions

What do you want to know about?• Building Expressions (Section 9.1.1)• Using the Expression Builder (Section 9.1.2)• Navigating and Editing Expressions (Section 9.1.3)

9.1.1 Building Expressions Expressions are built using the Expression Builder dialog (referred to as theExpression Builder), which is opened whenever you click the button from eitherthe Derived Variables dialog (input) or the User Variables dialog (output). TheExpression Builder provides a range of operators and functions used to buildexpressions that evaluate values, called arguments, in a specific order, or syntax.

Expressions are evaluated from left to right subject to the syntax and order ofprecedence rules detailed in Section 9.4.

9.1.2 Using the Expression Builder

You must build an expression in a particular order. Generally you will follow the listboxes from left to right. The operators, functions and variables available to you arecontext sensitive. For example, when you select a variable with a numeric value, onlyfunctions that can process numbers will be available to you.

The following procedure explains how to build a simple expression to add the text“Inc.” to a derived variable called “Company_Name”.

1. From the Main menu, select Node User Variables.

2. From the User Variables dialog, in the Variable Name field, type the name ofthe variable you want to create.

3. Click to open the Expression Builder.

4. From the Expression Builder, click concat in the Function section.

5. In the Variable section, expand and select the user variable.

6. Click on the Edit Value button ( ) and type the text you want to add to theuser variable. The Expression Builder will display: concat(Company_Name," Inc.")

7. Click OK to close the Expression Builder.

Page 157: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 157

9.2 Conditions

When you close the Expression Builder, you will be returned to the DerivedVariables dialog where the expression will be displayed in the Value field, and thevalue the expression returns in the current section will be displayed in the Contentfield. The same procedure applies when building expressions from the User Variablesdialog.

To enable direct editing of the expression in the dialog that calls the ExpressionBuilder, refer to Section 10.2.

9.1.3 Navigating and Editing Expressions

• To move around the expression, use the arrow buttons, keyboard arrow keys andthe cursor.

• To expand or reduce the selection, use the Level Up button ( ) or the LevelDown button ( ).

• To add text or number values, use the Edit Value button ( ).• To delete parts of an expression, select the part of the expression to be deleted

and click the Delete button ( ).• To enclose parts of an expression in parentheses, select the part of the expression

to be enclosed and click the Group button ( ).

You can also enable direct editing of the expression in the dialog that calls theExpression Builder (Section 10.2).

9.2 ConditionsA condition is a special type of expression which produces a TRUE or FALSE value.Conditions allow you to vary the output of the project, depending on data within theinput file. For more information about the ways you can use conditions, see the usageexamples below.

Usage examplesConditions can be used to determine:

• when input sections are created (Section 5.5.10.2 and 5.5.11.2)• when sets are created (Section 5.5.5)• when defining derived values• when calculating values or manipulating data in user variables

What do you want to know about?• Building Conditions (Section 9.2.1)

Page 158: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 9: Expressions and Conditions

158 Create!form Director

• Using Expressions as Conditions (Section 9.2.2)

9.2.1 Building Conditions The Condition Builder is used to build and edit expressions in much the same fashionas the Expression Builder (Section 9.1). The Condition Builder can be opened fromnumerous dialogs, either by clicking the Edit button next to a condition field, or byclicking the button.

The following procedure explains how to build a simple condition to test whether theuser variable called “Item_type” contains the word “new”.

1. From the Condition Builder, click contains in the Function section.

2. In the Variable section, expand and select the user variable.

3. Click on the Edit Value button ( ) and type “new”. The Condition Builder will display: contains(Item_type,"new")

4. Click OK to close the Condition Builder.

When you close the Condition Builder, you will be returned to the originating dialogwhere the expression will be displayed. To enable direct editing of the expression inthe dialog that calls the Condition Builder, refer to Section 10.2.

9.2.2 Using Expressions as Conditions

Any expression that evaluates to a non-zero value when true can be used as acondition. For example, the expression A-B is equivalent to the condition A!=B as bothexpressions return a zero value when A equals B and a non-zero value when A is notequal to B.

9.3 Building BlocksThe Expression Builder and Condition Builder dialogs contain list boxes containingthe building blocks from which you can build an expression. The content of thesedialogs is context sensitive; the building blocks displayed or available will depend onthe task you are performing:

• Boolean Operators (Section 9.3.1)• Operators (Section 9.3.2)• Functions (Section 9.3.3)• Variables (Section 9.3.4)• System Conditions (Section 9.3.5)

Page 159: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 159

9.3 Building Blocks

9.3.1 Boolean OperatorsBoolean operators are only available in the Condition Builder. The syntax of anexpression involving boolean operators begins with the first argument, followed bythe operator, and the second argument, separated by spaces:

condition1 OPERATOR condition2

Arguments can be other user defined conditions or system conditions. The followingtable describes the boolean operators available.

Other boolean operations can be performed by combining AND and OR operators inexpressions with the negation operator NOT (Section 9.3.2); for example, a booleandifference operation is performed by the expression:

NOT condition1 AND condition2

9.3.2 Operators

The usual syntax of an expression involving operators begins with the first argument,followed by the operator, and the second argument, with or without separating spaces:

argument1OPERATORargument2

Boolean operator Meaning Syntax and usage

ANDlogical AND(intersection)

condition1 AND condition2

Returns TRUE if both condition1 and condition2 are true.Example:contains(Price,".") AND contains(Price,"0") returns TRUE if the data variable Price contains both "." and "0".

ORlogical OR(union)

condition1 OR condition2

Returns TRUE if either condition1 or condition2 are true.Example:Sys.FirstPageOfDoc OR Sys.FirstPageOfSet returns TRUE on the first page of the document and the first page of each set.

Page 160: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 9: Expressions and Conditions

160 Create!form Director

The negation operators are the only exceptions to this rule, as they precede a singleargument. Arguments can be numbers, text strings, variables or other functions orexpressions. The following table describes the operators available.

For the syntax rules governing the evaluation of expressions using parentheses,multiple operators and mixed data types, see Section 9.4.

Operator Meaning Syntax and usage

== equal to

A==BCompares the values of two numbers or two strings and returns TRUE if equal. Case sensitive when comparing strings.

!= not equal to

A!=BCompares the values of two numbers or two strings and returns TRUE if not equal. Case sensitive when comparing strings.

> greater than A>BCompares the values of two numbers and returns TRUE if A is greater than B.

< less thanA<BCompares the values of two numbers and returns TRUE if A is less than B.

>= greater than or equal toA>=BCompares the values of two numbers and returns TRUE if A is greater than or equal to B.

<= less than or equal toA<=BCompares the values of two numbers and returns TRUE if A is less than or equal to B.

* multiply A*BMultiplies two numbers.

/ divide A/BDivides A by B.

+ add A+BAdds two numbers, or concatenates two strings.

- subtract A-BSubtracts B from A.

NOT logical negation NOT conditionReverses the logical value of an expression.

- (neg) arithmetic negation -BReverses the sign of a numeric value, i.e. -B=-1*B

Page 161: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 161

9.3 Building Blocks

9.3.3 Functions

The syntax of a function begins with the function name, followed by an openingparenthesis, the arguments for the function separated by commas, and a closingparenthesis.

function(argument1,argument2,...)

Arguments can be numbers, text strings, variables, functions and expressions. Thefollowing tables describe the functions available.

Logical functionsLogical functions can be used as conditions returning a TRUE or FALSE value. Whenused as arguments in expressions, logical functions return a value of 1 if true, and 0 iffalse.

Function Syntax and usage

changedchanged(name)Returns TRUE if the variable name is not equal to the value in the previous occurrence. Equivalent to the expression name!=previous(name).

containscontains(string,find_text)Returns TRUE if string contains find_text.Example: contains("Heath;Adele;Mrs;;;OK;;","OK") = TRUE

existsexists(name)Returns TRUE if the variable name exists.

isfileisfile(filename)Returns TRUE if the file filename exists.

isfolderisfolder(foldername)Returns TRUE if the folder foldername exists.

isnumeric

isnumeric(name)Returns TRUE if the variable name contains at least one numeral and any of the characters , . ( ) + - $ % or space. The test will fail if the variable contains any other character.Examples:isnumeric("$ 1,234.56") = TRUEisnumeric("$US1,234.56") = FALSE

Page 162: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 9: Expressions and Conditions

162 Create!form Director

Text and numeric functions

Function Syntax and usage

aswords

aswords(number,option)Converts a number into words. Specifying "a" in the second argument will generate a number phrase with “and” e.g. “Five hundred and twenty seven”Examples:aswords("123","") = "One hundred twenty three"aswords("123","a") = "One hundred and twenty three"

at

at(row,column,length)Returns a string of a specified length, starting at the specified row and column position in the current input page.Example: if row 5 of the input page contains the letters of the alphabet in columns 1 to 26, thenat(5,12,3) = "LMN"

concatconcat(string1,string2)Joins two text strings.Example: concat("Adele ", "Heath") = "Adele Heath"

concatlistconcatlist(list_var,separator)Returns a string containing all occurrences of the variable list_var separated by the character/string separator.

externalexternal(pathname,command_line)Runs an external process using the specified pathname and command line.

find

find(string,find_text,start_char)Finds one text string within another text string, starting from character position start_char, and returns the starting position. The first character in string is position 1. Returns 0 if find_text is not found in string.Example: find("Mrs Adele Heath"," ",5) = 10

lengthlength(string)Returns the length of a text string, including spaces.Example: length("Mrs Adele Heath") = 15

lowerlower(string)Converts a text string to lower case.

ltrimltrim(string)Trims leading spaces from a text string.Example: ltrim(" left trim ") = "left trim "

modmod(number,base)Returns the remainder after number is divided by base.Example: mod(51,7) = 2

Page 163: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 163

9.3 Building Blocks

num

num(string)Converts a text string into a number.Examples:num("12ab3") = 123num("18+9/3") = 1893num("nine") = 0

pad

pad(string,length)If string is shorter than length, extends string to length with spaces.If string is longer than length, truncates string to length.Examples:pad("abc","6") = "abc "

pad("abc",1) = "a"

pad("abc",-2) = "abc"

pad("abc","def") = ""

properproper(string)Capitalizes the first letter of each word in a text string.

previousprevious(var_name)Returns the value of variable var_name in the previous occurrence of the current section.

previousatpreviousat(row,column,length)Returns a string of a specified length, starting at the specified row and column position in the previous input page.

retrieve

retrieve(string,ordinal_position,delimiter_char)Extracts text from delimited fields in a text string. When the space character is used as a delimiter, leading spaces are ignored and sequential spaces are treated as a single delimiter.Examples:retrieve("Abc;De;F;;;Ghij;;",6,";") = "Ghij"retrieve(" Abc De F",2," ") = "De"

Use the following arguments when specifying these delimiters:ArgumentDelimiter\nnew line\ttab\"double quotation mark (")\\backslash (\)Example:retrieve(var,1,"\t") returns the value before the first tab in the text variable var.

Function Syntax and usage

Page 164: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 9: Expressions and Conditions

164 Create!form Director

For the syntax rules governing the evaluation of nested functions, see Section 9.4.

Date functionsThe result of a date function depends on the current date order setting (Section 5.5.6.1).

rfind

rfind(string,find_text,start_char)Finds one text string within another text string by searching from the right to the left, starting from character position start_char, and returns the starting position. The first character in string is position 1. Position 0 specifies the last character in string. Returns 0 if find_text is not found in string.Example: rfind("Heath,Adele,Mrs",",",0) = 12

round

round(number,num_digits)Rounds a number to a specified number of decimal places. Examples:round(1234.567,2) = 1234.57round(1234.56,0) = 1235round(1234.56,-2) = 1200

rtrimrtrim(string)Trims trailing spaces from a text string.Example: rtrim(" right trim ") = " right trim"

sentencesentence(string)Converts a text string to sentence case.

substitute

substitute(string,old_text,new_text)Replaces all occurrences of existing text with new text in a text string.Example: substitute("Contact <N> for quote","<N>","Chris") = "Contact Chris for quote"

substringsubstring(string,start_char,length)Returns a portion of a text string. Example: substring("Telephone: 303-8783 2054",12,3) = "303"

trimtrim(string)Trims leading and trailing spaces from a text string.Example: trim(" trim ") = "trim"

upperupper(string)Converts a text string to upper case.

Function Syntax and usage

Page 165: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 165

9.3 Building Blocks

Any non-numeric parsing character is permitted in a string representing a date value,for example, the strings "19 4 03" and "19.04.2003" will return the same value whenused as arguments in a date function.

For information on using the addition and subtraction operators with date values, seeSection 9.4.

9.3.4 Variables

The types of variables that can be used in conditions as arguments of operators andfunctions are summarized below:

Function Syntax and usage

date

date(year,month,day)Returns a date value from arguments representing the year, month and day. Values of day and month outside the normal range are treated on the basis that month=0 is the last month of the previous year, and day=0 is the last day of the previous month.The following examples assume a date order setting of d-m-y:date("2003","4","19") = 19-4-2003date(2000,0,0) = 30-11-1999date(2004,-1,32) = 2-12-2003

day

day(date)Returns the day of the month (a number between 1 and 31) from a date value. Example: day("19/4/03") = 19 when date order is d-m-y

month

month(date)Returns the month of the year (a number between 1 and 12) from a date value. Example: month("19-4-2003") = 4 when date order is d-m-y

yearyear(date)Returns the year (a number between1970 and 2069) from a date value. Example: year("19 04 03") = 2003 when date order is d-m-y

Variable Type Usagedata variable input data (Section 5.5.3)

user variable user defined expressions relating to section data (Section 8.3)

global user variable user defined expressions relating to other sections or the whole project (Section 8.4)

system variable system supplied data (Section 8.5)

Page 166: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 9: Expressions and Conditions

166 Create!form Director

The variables that are available to you at any time, will depend on the type ofexpression you are building, and where you are building it from. User variables anddata variables are available only in the section they are defined in.

9.3.5 System Conditions

When working with text an JDE PDF input files, Create!form Director provides pre-defined conditions that you can use to:

• conditionally apply an input section• conditionally define derived variables

System conditions will only be displayed in the Condition Builder when you areperforming one of the above tasks. The following table describes the systemconditions available.

lookup variable data from an external database (Section 8.6)environment variable data that applies to all projects (Section 8.7)job ticket variable job file attributes (Section 8.8)

Pre-defined conditions Definition

Sys.FirstPageOfDocReturns TRUE when the current section is on the first page of the project.

Sys.ContPageOfDocReturns TRUE when the current section is not on the first page or the last page of the project.

Sys.LastPageOfDocReturns TRUE when the current section is on the last page of the project.

Sys.FirstPageOfSetReturns TRUE when the current section is on the first page of the set for the project.

Sys.ContPageOfSetReturns TRUE when the current section is not on the first page or the last page of the set for the project.

Sys.LastPageOfSetReturns TRUE when the current section is on the last page of the set for the project.

Variable Type Usage

Page 167: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 167

9.4 Syntax and Order of Precedence Rules

9.4 Syntax and Order of Precedence RulesExpressions are evaluated using a specific set of rules, or syntax, that depends on theoperators and functions you use in the expression. The Condition Builder andExpression Builder dialogs will assist you in building expressions with a validsyntax; however you must follow a few basic rules to ensure the expression willperform the way you expect:

• Mixed Data Types (Section 9.4.1)• Addition Operator (Section 9.4.2)• Subtraction Operator (Section 9.4.3)• Comparing Text Strings (Section 9.4.4)• Order of Precedence (Section 9.4.5)• Nested Functions (Section 9.4.6)• Parsing (Section 9.4.7)• Names of Variables (Section 9.4.8)

9.4.1 Mixed Data TypesAvoid mixing text, numeric and date values in the same expression as this can produceunexpected results. All variable data is stored as a string, but will be interpreted as anumber in an arithmetic operation. For example:

"-2"*"3" evaluates to the number -6

2*"3A4" evaluates to the number 68

2*"3-4" evaluates to the number 68

2*"3A4-" evaluates to the number -68

"two"*"three" evaluates to the number 0

9.4.2 Addition Operator

The addition operator (+) is a special case. The rules governing the addition ofnumeric, text and date arguments are:

• if both arguments of an addition are numeric, an addition is performed. Forexample: 1+1 evaluates to the number 2.

• if either argument of an addition is a string, the arguments are concatenated. Forexample: 1+"1" evaluates to the text string "11".

Page 168: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 9: Expressions and Conditions

168 Create!form Director

• if one argument is a date and the other is a number, a date addition is performed.For example: if Today is a date variable (m-d-y) with a value of 9-6-2004, theexpression Today+1 evaluates to the date value 9-7-2004, whereas the expression"9/6/2004"+1 evaluates to the string "9/6/20041".

9.4.3 Subtraction Operator

The subtraction operator (-) is a special case. The rules governing the subtraction ofnumeric, text and date arguments are:

• if both arguments of a subtraction are either numeric or text, a subtraction isperformed. For example: "a5"-2 evaluates to the number 3.

• if the first argument is a date and the second is a number, a date subtraction isperformed. For example: if Today is a date variable (m-d-y) with a value of 9-6-2004, the expression today-1 evaluates to the date value 9-5-2004, whereas theexpression "9/6/2004"-1 evaluates to the number 962003.

• if both arguments are dates, a date difference is performed. For example:Sys.Today-InvDate evaluates to the number of days difference between today’sdate and the date variable InvDate, whereas the expression "9/6/2004"-"9/6/2003" evaluates to the number 1.

9.4.4 Comparing Text Strings

Avoid using the comparison operators <=, >=, <, > to compare text strings as this canproduce unexpected results. The rules governing comparisons of numeric, text anddate arguments are:

• if either argument of a comparison is a number, a numeric comparison isperformed. For example: "10">2 returns TRUE.

• if both arguments are strings, a string comparison is performed based on theASCII collating sequence, and is case sensitive. For example: "10">”2” returnsFALSE.

• if both arguments of a comparison are dates, a date comparison is performed.

9.4.5 Order of Precedence

Expressions are evaluated in the following order of precedence:

• operations inside parentheses ( ) are evaluated first, followed by• - (negation)• *, /

Page 169: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 169

9.4 Syntax and Order of Precedence Rules

• +, -• ==, !=, <=, >=, <, >• NOT• AND, OR

Operators with the same order of precedence e.g. + and -, are evaluated from left toright. For example, the expression 3*2+6/-2 evaluates to 3, whereas 3*(2+6/-2)evaluates to -3.

9.4.6 Nested Functions

Functions can be used as arguments for other functions, and can be nested. Forexample, if the variable A has a value of "Andersch,Jorge", then the expression:

length(substring(A,find(A,",",1)+1,length(A)-find(A,",",1)))

will return the value 5 (the length of the substring "Jorge").

9.4.7 Parsing

Certain characters or combinations of characters, when included in text strings, canhave specific meanings in an expression:

For example,

"the literal \"\\\" is ignored" evaluates to the literal "\" is ignored

"C:\\Program Files\\Create!form" evaluates to C:\Program Files\Create!form

2*"1A2B3-" evaluates to -246

2*"1A2-3" evaluates to 246

Characters Description Usage

" text delimiter quotation marks are used to define the start and end of a text string

\" quotation mark quotation marks are treated literally when preceded by a backslash

\\ backslash the backslash character is treated literally when preceded by another backslash

\n new line inserts a line feed

- minus signwhen a minus sign is adjacent to a number, the number is interpreted as a negative in an arithmetic operation. A minus sign embedded inside a number is ignored.

Page 170: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 9: Expressions and Conditions

170 Create!form Director

9.4.8 Names of Variables

Avoid using function names (Section 9.3.3) as names of variables as this can produceunexpected results.

Page 171: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

10

Create!form Director 171

CustomizingYou can customize the look and feel of the Create!form Director interface.

The following topics are covered in this chapter:

About User Preferences

General Preferences

Design Window Preferences

Input Window Preferences

Page 172: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 10: Customizing

172 Create!form Director

10.1 About User PreferencesYou can customize the look, feel and behavior of Create!form Director to suit the wayyou work. User preference settings are specific to the local copy of Create!formDirector; changes made to user preferences are not saved with the project.

All user preferences are set from the Preferences dialog, which will be displayed byselecting Tools Preferences from the Main menu. The categories of settingsavailable are displayed in the tree view on the left of the dialog. Select the category inthe tree view to display the corresponding controls on the right.

Figure 10-1: Preferences dialog.

• General Preferences (Section 10.2)• Section Borders (Section 10.2.1)• Input Source Preferences (Section 10.2.2)• Design Window Preferences (Section 10.3)• Design Tree (Section 10.3.1)• CSV (Section 10.4.1)• JDE PDF (Section 10.4.2)• JDE PDF Sections (Section 10.4.2.1)• Text (Section 10.4.3)• Text Sections (Section 10.4.3.1)• XML (Section 10.4.4)

Categories are listed in the tree view.

Dialog changes as each category is selected in the tree view.

Page 173: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 173

10.2 General Preferences

10.2 General PreferencesSelect Tools Preferences from the Main menu to display the Preferences dialog andselect General in the tree view.

The following general preferences settings are available:

Default project directoryClick the ( ) button to change the project directory (Section 3.2.1).

Common project directoryClick the ( ) button to change the common project directory (Section 3.2.2).

Allow direct editing of expressions and conditionsSelect the checkbox to enable direct editing of expressions and conditions in dialogswithout opening the Expression Builder or the Condition Builder.

Make backup on saveSelect the checkbox to make a backup copy of the project and DataMap files when theproject is saved (Section 3.5).

To use a backup version of a project file and a DataMap file, you must manuallychange the name of the backup files to the correct filename extension. For moreinformation about names of project files, refer to Section 3.10.

Restore suppressed messagesSelect this option to restore messages that have previously been suppressed. Amessage is suppressed when the “Do not show this message again” option is selectedon a message dialog.

10.2.1 Section BordersSelect Tools Preferences from the Main menu to display the Preferences dialog andselect General Section Borders in the tree view. The following preferences settingsare available:

• the color of a section when it is selected• the color of the corresponding section in an inactive window• the thickness of the border

Page 174: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 10: Customizing

174 Create!form Director

10.2.2 Input Source Preferences

Select Tools Preferences from the Main menu to display the Preferences dialog andselect General Input Source in the tree view. The following preferences settings areavailable:

Display Font• Select the input file source view display font in the drop-down.• Select the font Size.• Select the Monospace only checkbox to restrict the fonts available in the font

drop-down.

ColorsSelect the colors for the text and the background.

Scroll barsDisplay and hide the horizontal and vertical scroll bars.

10.3 Design Window PreferencesSelect Tools Preferences from the Main menu to display the Preferences dialog andselect Design in the tree view. The following preferences settings are available:

Scale factorSets the default view magnification.

Background colorSelect the color for the window background.

Show rulersHorizontal and vertical rulers are available to assist in node layout and placement.

Show tooltipsSelect the checkbox to display tooltips when the cursor is moved over nodes.

Page 175: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 175

10.4 Input Window Preferences

10.3.1 Design TreeSelect Tools Preferences from the Main menu to display the Preferences dialog andselect Design Tree in the tree view. The following preferences settings are available:

Node TextSelect an option to annotate nodes with either a description, or the properties of thenode.

ColorsSelect the annotation text colors.

Node ImagesSelect a node type from the drop-down, and click the Browse button ( ) to displaythe Select Image dialog from which you can change the image that will be displayedat all nodes of that type. A selection of images are provided, but you can also add yourown icons. The controls on the Select Image dialog will allow you to add and deleteimage files.

To highlight invalid nodes, select the Mark invalid nodes checkbox.

ConnectorsSelect the line type, style and color of node connectors.

Selected node frame colorSelect the color of the frame that outlines the selected node.

10.4 Input Window Preferences

10.4.1 CSVSelect Tools Preferences from the Main menu to display the Preferences dialog andselect Input (CSV) in the tree view. The following preferences settings are available:

Input file sizeTo limit the size of an input data file to be used as a sample, select the Limit tocheckbox and enter the maximum number of lines you want to use. To most accuratelyrepresent the sample data, it is recommended that you don’t limit the number of linesunless the number of lines affects the processing speed.

Page 176: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 10: Customizing

176 Create!form Director

Whenever you open a project where the input file size exceeds the limit, you will beprompted to truncate the input file.

Header• Select the Show checkbox to display the CSV input file header in the Input

Window.• To change the background color, click the Background color field to display the

Color Picker dialog.

Detail• Select the Show row numbers checkbox to display the row number in the Input

Window.• To alternate the background color between consecutive sets, select different

colors for odd and even sets.

10.4.2 JDE PDF

Select Tools Preferences from the Main menu to display the Preferences dialog andselect Input (JDE PDF) in the tree view. The following preferences settings areavailable:

ViewTo set the default page view magnification, choose Fit to Width, Fit in Window orActual Size from the View drop-down list.

Input file sizeTo limit the size of an input data file to be used as a sample, select the Limit tocheckbox and enter the maximum number of lines you want to use. To most accuratelyrepresent the sample data, it is recommended that you don’t limit the number of linesunless the number of lines affects the processing speed.

Whenever you open a project where the input file size exceeds the limit, you will beprompted to truncate the input file.

Show rulersHorizontal and vertical rulers are available to measure column (character) and row(line) positions on the input page.

Page 177: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 177

10.4 Input Window Preferences

Enable tooltipsSelect the checkbox to display names as the cursor moves over data variables in theInput Window.

10.4.2.1JDE PDF SectionsSelect Tools Preferences from the Main menu to display the Preferences dialog andselect Input (JDE PDF) Sections in the tree view. The following preferencessettings are available:

Section borders• Select the Show checkbox to display section borders in the Input Window.• Select the section border line style from the Style drop-down.

Selected section• Select the Highlight background checkbox to display the selected section in the

background color shown. To change the background color, click the backgroundcolor field to display the Color Picker dialog.

• To change the variable background color, click the Variable background colorfield to display the Color Picker dialog.

• To change the selected variable frame color, click the Selected variable framecolor field to display the Color Picker dialog.

Unselected sections• Select the Highlight background checkbox to display unselected sections in the

background color shown. To change the background color, click the backgroundcolor field to display the Color Picker dialog.

10.4.3 Text

Select Tools Preferences from the Main menu to display the Preferences dialog andselect Input (Text) in the tree view. The following preferences settings are available:

ViewTo set the default page view magnification, choose Fit to Width, Fit in Window orActual Size from the View drop-down list.

Page 178: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter 10: Customizing

178 Create!form Director

Input file sizeTo limit the size of an input data file to be used as a sample, select the Limit tocheckbox and enter the maximum number of lines you want to use. To most accuratelyrepresent the sample data, it is recommended that you don’t limit the number of linesunless the number of lines affects the processing speed.

Whenever you open a project where the input file size exceeds the limit, you will beprompted to truncate the input file.

GridA grid can be displayed in the Input Window to assist in mapping sections and datavariables. The grid lines correspond to the column and row numbering displayed onthe rulers.

Use the Grid options to:

• Hide and show a grid. • Show grid as points.• Change the grid line style.

RulersHorizontal and vertical rulers are available to measure column (character) and row(line) positions on the input page. Use the Rulers options to:

• Hide or show ruler.• Change the cursor indicator color.

Display font• Select the Monospace only checkbox to restrict the fonts available in the font

drop-down.• Select the input file display font in the drop-down.

Enable tooltipsSelect the checkbox to display names as the cursor moves over data variables in theInput Window.

10.4.3.1Text SectionsSelect Tools Preferences from the Main menu to display the Preferences dialog andselect Input (Text) Sections in the tree view. The following preferences settings areavailable:

Page 179: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 179

10.4 Input Window Preferences

Section borders• Select the Show checkbox to display section borders in the Input Window.• Select the section border line style from the Style drop-down.

Selected section• Select the Highlight background checkbox to display the selected section in the

background color shown. To change the background color, click the backgroundcolor field to display the Color Picker dialog.

• To change the variable background color, click the Variable background colorfield to display the Color Picker dialog.

• To change the selected variable frame color, click the Selected variable framecolor field to display the Color Picker dialog.

Unselected sections• Select the Highlight background checkbox to display unselected sections in the

background color shown. To change the background color, click the backgroundcolor field to display the Color Picker dialog.

• To change the variable background color, click the Variable background colorfield to display the Color Picker dialog.

10.4.4 XML

Select Tools Preferences from the Main menu to display the Preferences dialog andselect Input (XML) in the tree view. The following preferences settings are available:

TooltipsYou can choose to display tooltips when the cursor hovers over an XML element, andoptionally, the tooltip will display values, variable and section names, and the type ofnode.

Initial document viewWhen the document is opened, choose if the whole tree is expanded, or only the firstlevel.

ColorsSelect a component of the tree to display the current color setting. To customizecolors, clear the Use system color checkbox and click the color field to display theColor Picker dialog.

Page 180: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April
Page 181: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Appendices

Page 182: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April
Page 183: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

A

Create!form Director 183

GlossaryThis appendix provides a list of commonly used Create!form terms.

Page 184: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Appendix A: Glossary

184 Create!form Director

A.1 GlossaryThe following table explains many of the terms specific to Create!form.

Term Definitionargument The component of a function or expression that defines a value.common project directory

The directory used to store shared project resources.

CommonProject directory

The default common project directory.

condition A user-defined logical test that results in either a true or falsevalue. Conditions enable the project to behave differentlyaccording to the content of the input file or the productionenvironment.

data section A section that is brought into the project from the input file.DataMap A DataMap records how the different parts of an input file are

identified and labelled. data variable A variable defined in the input file.derived variable A user-defined expression, defined in the input.e-forms server The system that hosts Create!form Server, which merges the

project with incoming spool files.enterprise server ERP system or other application that is the originator of the

input files.expression A user-defined statement that performs calculations and derives

values from the input data. form project See project.function A pre-defined formula that performs a calculation from user

defined arguments.global user variable

A user-defined variable, global to the project.

input file A sample file from the enterprise server, used to build theDataMap.

lookup variable A variable that derives its value from an external database.operator A component of an expression or condition that defines an

arithmetic, logical or text operation on adjacent arguments.project A project is a record of the way you want to redesign the input

file. Also referred to as a form project.project directory The directory where the project resources are stored.

Page 185: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 185

A.1 Glossary

repagination The process of expanding or condensing pages in the projectdepending on the space required.

set A user-defined construct that divides the input file into its basicdocument units, that the project is designing.

subform A subform is a user defined graphical object.system variable System variables are predefined and relate to the project. They

include such items as the number of pages in the set ordocument.

template Defines the parameters in a job ticket.user variable User variables are user-defined expressions that relate only to

the section they were created in.

Term Definition

Page 186: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April
Page 187: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

B

Create!form Director 187

Quick GuideA quick reference to menu commands and how to select commands, dialog optionsand perform other tasks from the keyboard.

The following topics are covered in this chapter:

Quick Guide to Menu Commands

Quick Guide to Keyboard Shortcuts

Quick Guide to Tutorials

Page 188: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter B: Quick Guide

188 Create!form Director

B.1 Quick Guide to Menu Commands

File Menu

Edit Menu

Command Usage See

New Start the New Project Wizard. 3.3

Open Open an existing project. 3.6

Close Close the active project.

Save Save the active project. 3.5

Save As Save the active document to a new name or as a packed project. 3.8

Print Print the active project. 3.7

Print Preview Preview the active project. 3.7

Properties Display information about the active document.

1 2 3 ... Open a recent file.

Exit Close all open documents and exit.

Command Usage See

Undo Undo last edit.

Redo Redo previously undone edit.

Cut Copy selected items to clipboard and delete.

Copy Copy selected items to clipboard.

Paste Paste contents of clipboard to project.

Paste As Sibling Before Paste as sibling node before current node. 6.3.5

Paste As Sibling After Paste as sibling node after current node. 6.3.5

Paste As Parent Paste as parent of current node. 6.3.5

Page 189: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 189

B.1 Quick Guide to Menu Commands

View Menu

Paste As Child Paste as child of current node. 6.3.5

Paste As Child if “Yes” Paste as “Yes” child of condition node. 6.3.5

Paste As Child if “No” Paste as “No” child of condition node. 6.3.5

Insert Sibling Before Insert sibling node before current node. 6.3.2

Insert Sibling After Insert sibling node after current node. 6.3.2

Insert Parent Insert parent before current node. 6.3.2

Insert Child Insert child of current node. 6.3.2

Insert Child if “Yes” Insert “Yes” child of condition node. 6.3.2

Insert Child if “No” Insert “No” child of condition node. 6.3.2

Delete Delete selected object or item.

Select All Select all objects in current section.

Command Usage See

Graphic Display objects graphically. 4.1.2

Listing Display objects in a list. 4.1.2

Input Window Hide and show Input Window. 4.1.2

Input Tree Hide and show Input Tree view. 4.1.3

Input File Source Hide and show Input File Source view. 4.1.4

Actual Size Display active window true size.

Fit in Window Fit page inside active window.

Fit to Width Fit page to width of active window.

Zoom Window Zoom into user defined window.

Zoom In Increase magnification.

Command Usage See

Page 190: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter B: Quick Guide

190 Create!form Director

Project Menu

Node Menu

Page Menu

Zoom Out Decrease magnification.

Toolbars Hide and show toolbars.

Command Usage See

Global User Variables Create and edit global user variables. 8.4

Select Input File Select a new input file. 5.1.2

Change DataMap Change DataMap options. 3.3.3

Define Set Define when sets are created. 5.2.2

Command Usage See

User Variables Create and modify user variables. 8.3

Lookup Variables Create and modify lookup variables. 8.6

Properties Display and edit properties of selected node.

Command Usage See

First Go to first page. 4.2

Previous Go to previous page. 4.2

Next Go to next page. 4.2

Last Go to last page. 4.2

Go To Go to specified page. 4.2.1

Command Usage See

Page 191: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 191

B.1 Quick Guide to Menu Commands

Input Menu (CSV)

Input Menu (Text)

Input Menu (XML)

Command Usage See

File Properties Define CSV file structure. 5.4.2

Derived Variables Create and modify derived variables in selected section. 5.8

Command Usage See

New Section After Insert a new section after the selected section. 5.5.10.2

Input Headers Manage input headers control list. 5.5.9.3

Input Footers Manage input footers control list. 5.5.11.2

Delete Section Delete the selected section. 5.5.7.4

File Properties Define input page width and length. 5.5.4

Derived Variables Create and modify derived variables in selected section. 5.8

Section Properties Display and edit properties of selected input section. 5.5.7.1

Show All Instances Show how selected section is populated. 5.5.2

Command Usage See

Tag Properties Change how sections are created and named. 5.6.4

Variable Properties Change the properties of data variables. 5.6.5

File Properties Define input data formats. 5.6.2

Derived Variables Create and modify derived variables in selected section. 5.8

Page 192: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter B: Quick Guide

192 Create!form Director

Input Menu (JDE PDF)

Tools Menu

Window Menu

Command Usage See

File Properties Define input data mapping. 5.7.1

Derived Variables Create and modify derived variables in selected section. 5.8

Command Usage See

Preferences Customize the display of windows and other user preferences. 10.1

Named Destinations Create and modify destination definitions. 7.2.8

Environment Variables Create and modify environment variables. 8.7

Merge Configurations Create and modify merge configurations. 7.2.6.1

Transfer Transfers project and resources to e-forms server for production printing. 3.9

Commands Usage See

Cascade Arrange windows so they overlap.

Tile Horizontally Arrange windows as non-overlapping horizontal tiles.

Tile Vertically Arrange windows as non-overlapping vertical tiles.

Split Split the active window into duplicate panes.

Split Horizontally Arrange Design Window and Input Window horizontally.

Split Vertically Arrange Design Window and Input Window vertically.

1 2 3 ... Make the selected window active.

Windows Manage workspace.

Page 193: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 193

B.2 Quick Guide to Keyboard Shortcuts

Help Menu

B.2 Quick Guide to Keyboard Shortcuts

B.2.1 Menu Commands

To select any command from a menu with the keyboard:1. Press the ALT key together with the letter underlined in the menu name that

contains the command you want.

2. In the menu that appears, press the underlined letter in the command name thatyou want.

To select a command directly with the keyboard:

Commands Usage See

Help Topics Display help. 1.4

Create!form on the Web Visit the Create!form web site.

About Display information about this version of Create!form Director.

To select this command PressFile New CTRL+NFile Open CTRL+OFile Save CTRL+SFile Save As F12File Print CTRL+PFile Preview CTRL+SHIFT+PEdit Undo CTRL+ZEdit Redo CTRL+YEdit Cut CTRL+X OR SHIFT+DELEdit Copy CTRL+C OR CTRL+INSERTEdit Paste CTRL+V OR SHIFT+INSERTEdit Delete DELEdit Select All CTRL+ANode Properties ALT+R

Page 194: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter B: Quick Guide

194 Create!form Director

B.2.2 Dialog Options

To select any option on an active dialog with the keyboard:

Task shortcuts when editing objects:

View Graphic CTRL+GView Listing CTRL+LView Actual Size F9View Fit in Window F10View Fit to Width F11View Zoom In CTRL+HOMEView Zoom Out CTRL+ENDPage Previous PG UPPage Next PG DOWNPage Go To CTRL+T

To do this on an active dialog PressSelect next option or option group TABSelect previous option or option group SHIFT+TABSwitch to next dialog tab CTRL+TABSwitch to previous dialog tab CTRL+SHIFT+TABSelect an option with an underlined letter ALT+LETTEROpen a selected drop-down list ALT+DOWNMove between options in an open drop-down list arrow keysSelect an item in a drop-down list with the corresponding first letter letter key

Perform the action assigned to the selected command button (dotted outline) spacebar

Perform the action assigned to the default command button (bold outline) ENTER

Cancel the command and close the active dialog ESC

To do this when an object is selected PressMove object to the left LEFTResize object by moving left border to the left SHIFT+LEFT

To select this command Press

Page 195: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 195

B.2 Quick Guide to Keyboard Shortcuts

Resize object by moving right border to the left CTRL+LEFTMove object to the right RIGHTResize object by moving right border to the right SHIFT+RIGHTResize object by moving left border to the right CTRL+RIGHTMove object up UPResize object by moving top border up SHIFT+UPResize object by moving bottom border up CTRL+UPMove object down DOWNResize object by moving bottom border down SHIFT+DOWNResize object by moving top border down CTRL+DOWN

To do this in the active window PressSelect next window pane F6Select previous window pane SHIFT+F6Display shortcut menu SHIFT+F10

To do this when an object is selected Press

Page 196: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Chapter B: Quick Guide

196 Create!form Director

B.3 Quick Guide to Tutorials

Topic SubjectUsing the Create!form sample projects Input DesignTo create the CSV sample project: Designing for CSV Input FilesInput file properties Designing for CSV Input FilesTo create the text sample project: Designing for Text Input FilesInput sections Designing for Text Input FilesSetting the input page size Designing for Text Input FilesDefining sets Designing for Text Input FilesCreate data variables Designing for Text Input FilesCreate data variables in a detail section Designing for Text Input FilesMake an input header section expandable Designing for Text Input FilesAdd detail sections Designing for Text Input FilesMake a detail section expandable Designing for Text Input FilesAdjust the input footer section size Designing for Text Input FilesAdd input footer sections Designing for Text Input FilesRules for creating multiple input footer sections Designing for Text Input FilesTo create the XML sample project: Designing for XML Input FilesDefining sections Designing for XML Input Files

Page 197: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 197

Index, 169-, 169", 169.cdp6, 36.cdp6bak, 36.cmp6, 36.dmp6, 36.dmp6bak, 36.dpp6, 35, 36.jmp6, 36.xmp6, 36

Symbols

^, 169

A

action node, 103Actual Size, 176, 177add your own icons, 175adding arguments, 167adding nodes, 106Adobe Reader, 24annotate nodes, 175append to file, 115archive see Create!archivearguments, 184

adding, 167mixed, 167

ASCII collating sequence, 168

B

backslash, 169backup

on save, 173bold and underline overstrike control characters, 66

boolean operators, 159

C

Can contain duplicates, 98child node, 104command line, 125commands

quick guide, 188common project directory, 29, 173, 184CommonProject directory, 29, 184components

Create!archive, 22Create!email, 21Create!fax, 21Create!form Bind, 22Create!form Designer, 20Create!form Director, 20Create!form Server, 17, 19, 21Create!form Transform, 20Create!micr, 22Create!pdf server, 22Create!print, 21Create!send, 19, 21installing, 17

concatenate, 167condition, 103, 118, 184Condition Builder, 158, 166

syntax, 158, 167Condition node, 103, 117conditions, 150

boolean, 159building, 158examples, 157functions, 161operators, 159syntax, 167system, 166using, 157using expressions as, 158variables, 165

connection string, 123copying nodes, 111

Page 198: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

198 Create!form Director

Index

Create!form Server, 35CSV, 122

columns, 56data variables, 56defining sections, 55defining sets, 54delimiter, 53detail section, 56flowchart, 32header, 53input file, 51input file structure, 52input header, 56paginated, 52properties, 52

cursor, 108, 110customizing, 172

D

data section, 184data variable, 150, 165, 184

expandable, 72data variables, 46

creating, 68CSV, 56deleting, 70editing, 69expandable, 70in detail section, 71JDE PDF, 99moving, 69properties, 69, 70Text, 68

database, 122, 153Database (DSN) field, 153DataMap, 29, 45, 57, 97, 184

options, 30date

addition, 168difference, 168order, 57, 68, 97subtraction, 168

decimal separator, 57, 68, 97

decision, 117decision node, 103default project directory, 173Delete File, 104Delete File node, 124deleting, 124derived variables, 47, 150, 184

creating, 100design

input, 61overview, 31top-down, 61

design concepts, 102Design Window, 38, 39designing projects, 102destination, 113, 115destination type, 114detail, 59detail section

additional, 82, 83creating, 82, 83expandable, 86rules, 87working with, 82

dictionaries, 24display preferences, 125, 172document name, 115DSN, 153DSN details, 122duplicates, 98

E

editing nodes, 110e-forms server, 17, 35, 184email see Create!emaile-mailing projects, 35Empty Package after Send, 116enterprise server, 19, 184

requirements, 17environment variable, 154, 166EnvironmentVars.data, 154

Page 199: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 199

Index

expandabledata variable, 70, 72detail section, 86input header section, 78

Expression Builder, 156using, 156

expressions, 117, 150, 184building, 156direct editing, 173functions, 161navigating and editing, 157operators, 159system variables, 152variables, 152, 165

external programrunning, 125

F

fax see Create!faxFit in Window, 176, 177Fit to Width, 176, 177flowchart, 31

CSV, 32input design, 62JDE PDF, 33Text, 32XML, 33

folder name, 115Followed By list, 74, 78font, 178form project, 121, 184form projects, 19format

input data, 57, 68, 97formats used by data variables, 65

function, 184aswords, 162at, 162changed, 161concat, 162concatlist, 162contains, 161date, 164, 165day, 165exists, 161external, 162find, 162in conditions, 161in expressions, 161isfile, 161isfolder, 161isnumeric, 161length, 162logical, 161lower, 162ltrim, 162mod, 162month, 165nested, 169num, 163pad, 163previous, 163previousat, 163proper, 163retrieve, 163rfind, 164round, 164rtrim, 164sentence, 164substitute, 164substring, 164text and numeric, 162trim, 164upper, 164year, 165

Page 200: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

200 Create!form Director

Index

G

General Preferences, 173Generate Section, 75Get File, 103Get File node, 123getting help, 17global user variable, 151, 165, 184

creating, 151glossary, 18, 184go to page, 41grid

hiding and showing, 178grid settings, 178

H

HeaderParams.cfg, 154help

online, 18user guide, 17

highlight background, 177, 179

I

ignore blank pages, 65image, 114initial value, 151input

data format, 57, 68, 97design

flowchart, 62design principles, 61page size, 62, 65sections, 46, 59set, 46

input file, 184CSV, 51date and decimal values, 53deleting, 124getting, 123JDE PDF, 97navigating, 41properties, 62, 65

JDE PDF, 98select new, 44set, 46size, 175, 176, 178Text, 57types, 30viewing source, 45XML, 91

input file header, 59input file header section, 65input file properties, 52Input File Source View, 39input footer, 59input footer section

additional, 88adjusting, 87rules, 90working with, 87

input footers control list, 88input header, 59input header section

additional, 80adjusting, 77creating, 80deleting, 81expandable, 78multiple, 81rules, 81working with, 77

input headers control list, 80input sections

generating, 75logic, 75multiple, 75properties, 73, 75

Input Tree, 39Input Window, 38, 39

Page 201: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 201

Index

inserting nodes, 108installation, 23

directory, 24requirements, 24road map, 17, 24

installing, 24interface, 38

J

JDE PDF, 97data variables, 99date format, 98defining sections, 99defining sets, 99duplicates, 98flowchart, 33input file properties, 98non-breakable input sections, 98

JDEHeaderParams.cfg, 154job ticket, 116job ticket variable, 154, 166

K

keyboard shortcutstasks, 194

L

limit number of lines, 175, 176, 178literal, 169lookup variable, 152, 166, 184Lookup Variables dialog, 153

M

Main menu, 188Mark invalid nodes, 175menu commands, 188Merge, 103

merge configuration, 121Merge node, 121merge parameters, 121minus sign, 169mixed data types, 167monospace, 174, 178moving

nodes, 110

N

named destination, 115navigating, 37

input file, 40nested functions, 169new line, 169New Project wizard, 29node relationships, 104

Page 202: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

202 Create!form Director

Index

nodesaction, 103adding, 106colors, 175Condition, 103, 117connectors, 175copying, 111creating, 107decision, 103Delete File, 104, 124deleting, 111destination, 103editing, 110frame color, 175Get File, 103, 123images, 175inserting, 108Merge, 103, 121moving, 110parent, sibling and child, 104properties of, 110, 112Run Program, 104, 125selecting, 108Send, 103, 113Send to Current Device, 103Send to Folder, 103Send to FTP, 103Send to HTTP, 103Send to Queue, 103Sort, 103sort, 119Split, 103, 118Sub Project, 103, 120Transform, 103, 122type, 103Update, 103, 122

NOT, 159

O

ODBC, 153

operator, 184, 160, 160-, 160- (negation), 160!=, 160*, 160+, 160/, 160==, 160>, 160>=, 160AND, 159NOT, 160OR, 159

operators, 159in conditions, 159

order of precedence, 168OS/400 spool files, 66output, 113Output Format, 116overview, 18

design, 31

P

package destination type, 114packing projects, 35page size

input, 62, 65parent node, 104parentheses, 168parsing character, 165partitions

sorting, 119paste, 111PDF, 17PostScript, 24

Page 203: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 203

Index

preferences, 172Design Tree, 175Design Window, 174general, 173grid settings, 178input sections

JDE PDF, 177Text, 178

input source, 174Input Window

CSV, 175JDE PDF, 176Text, 177XML, 179

section borders, 173window display, 125

Preferences dialog, 172prerequisites, 16previewing projects, 34previous

occurrence, 41page, 41set, 41

printing, 34production printing, 35program file, 125project directory, 24, 28, 173, 184project type, 31projects, 184

Create!form Designer, 19Create!form Director, 19Create!form Transform, 19creating, 29definition, 28managing files, 36opening, 34options, 29overview, 31packing, 35printing and previewing, 34saving, 33sending, 35simple, 31standard, 31transferring, 35

Q

quotation mark, 169

R

repagination, 185requirements, 16

design workstation, 17enterprise server, 17installation, 24prerequisites, 16

rulers, 174, 176, 178run external program, 125Run Program, 104Run Program node, 125

S

sample project, 44, 58save as

packed project, 35saving

backup, 173screen elements, 38section

borders preferences, 173, 175, 177selected, 179

section variable, 150

Page 204: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

204 Create!form Director

Index

sectionsborders preferences, 179CSV, 55detail, 46, 59input, 46, 59input footer, 46, 59input header, 46, 59, 77JDE PDF, 99populated, 61selected, 177selecting, 41show all instances, 61Text, 59unselected, 177, 179

selecting nodes, 108Send from Package, 115Send node, 103, 113Send to Current Device, 103Send to Folder, 103Send to FTP, 103Send to HTTP, 103Send to Queue, 103sequence and timing, 105set, 46sets, 185

CSV, 54defining, 67JDE PDF, 99Text, 67

sibling node, 104simple project, 31sort, 103

mode, 120node, 119options, 119order, 119

Sort node, 119sorting file partitions, 119special characters, 169Split, 103split by partition, 120Split node, 118splitting by condition, 118splitting by set, 118splitting input file, 118standard projects, 31

Starting, 25Status bar, 38, 40Sub Project, 103Sub Project node, 120subform, 185subtraction of numeric, text and date arguments, 168

syntaxboolean operators, 159conditions, 167functions, 161operators, 159

Sys.ContPageOfDoc, 166Sys.ContPageOfSet, 166Sys.DeviceName, 152Sys.DocName, 152Sys.DocPageNum, 152Sys.DocSetNum, 152Sys.FirstPageOfDoc, 166Sys.FirstPageOfSet, 166Sys.Hostname, 152Sys.LastPageOfDoc, 166Sys.LastPageOfSet, 166Sys.OSVersion, 152Sys.PDFNumCopies, 98, 152Sys.PreviousSection, 152Sys.ProductVersion, 152Sys.ProjectName, 152Sys.QueueName, 152Sys.RandomString, 152Sys.SplitPageNum, 152Sys.SpoolID, 152Sys.Time, 152Sys.Today, 152Sys.Username, 152system conditions, 166system variable, 152, 165, 185

T

table, 123template, 116, 185terminology, 18

Page 205: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April

Create!form Director 205

Index

Textdata variables, 68defining sections, 59defining sets, 67flowchart, 32input file, 57section, 59

textaddition, 167comparing, 168

text delimiter, 169time-out, 124, 125toolbars

Design, 38Main, 38Navigation, 38

tooltips, 174, 177, 178Transfer command, 35transferring projects, 35Transform, 103Transform node, 122Transform project, 122Tutorials folder, 44, 58

U

Update, 103update action, 123Update node, 122updating database records, 122upgrading, 24user guide

conventions, 18shortcuts, 18viewing, 17

user variable, 122, 124, 150, 165, 185creating, 150

V

variables, 150data, 150derived, 150environment, 154global user, 151in expressions and conditions, 165job ticket, 154lookup, 152naming, 170section, 150system, 152types used, 106user, 150

variables and expressions, 105viewing and selecting Sections, 41

W

W3C, 92Win32User folder, 154Windows locale, 120wizard for new projects, 29WorkDir directory, 24, 28workflow, 19

X

XMLfile structure, 92flowchart, 33input file, 91input file properties, 93

Page 206: Create!form Director 6.2 - Bottomline Technologiesarchive.bottomline.com/collateral/technical_documents/Create... · Manual Name: Create!form Director 6.2 User Guide, Edition 1 [April