workgroups guide 2edoc1 for workgroups is an extension of the doc1 environment. it allows a...

DOC1 Suite 4

Workgroups GuideIssue 2e

®

2

Copyright ©2003 Group 1 Software Europe Ltd. All rights reserved.

This publication and the software described in it is supplied under license and may only be used or copied in accordance with the terms of such license. The information in this publication is provided for information only, is subject to change without notice, and should not be construed as a commitment by Group 1 Software. To the fullest extent permitted by applicable laws Group 1 Software excludes all warranties, representations and undertakings (express or implied) in relation to this publication and assumes no liability or responsibility for any errors or inaccuracies that may appear in this publication and shall not be liable for loss or damage of any kind arising from its use.

Except as permitted by such license, reproduction of any part of this publication by mechanical, electronic, recording means or otherwise, including fax transmission, without the express permission of Group 1 Software is prohibited to the fullest extent permitted by applicable laws.

Nothing in this notice shall limit or exclude Group 1 Software's liability in respect of fraud or for death or personal injury arising from its negligence. Statutory rights of the user, if any, are unaffected.

*TALO Hyphenators and Spellers are used. Developed by TALO B.V., Bussum, NetherlandsCopyright © 1998 *TALO B.V., Bussum, NL*TALO is a registered trademark ®

Encryption algorithms licensed from Unisys Corp. under U.S. Patent No. 4,558,302 and foreign counterparts.

Security algorithms Copyright ©1991-1992 RSA Data Security Inc.

Base 14 fonts and derivationsCopyright 1981 - 1983, 1989, 1993 Heidelberger Druckmaschinen AG.All rights reserved.

Maxicode encoding, Datamatrix and PDF417 encoding, fonts and derivationsCopyright (c) 1999, 2000, 2003 DL Technology Ltd.All rights reserved

Linear barcode fonts Copyright © 1997 Terrapin Solutions Ltd. with NRB Systems Ltd.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

Otherwise all product names are trademarks or registered trademarks of their respective holders.

Printed in the UK.

Contents

PREFACE ..................................................................................................................9

Document Structure ..............................................................................................................9

Skills and Training ................................................................................................................9

Definitions .........................................................................................................................10

Updates to this manual .......................................................................................................10

CONCEPTS AND OVERVIEW .....................................................................................11

Repository and administration ............................................................................... 12

Users and access permissions ..............................................................................................12

Projects, Folders and Files .................................................................................... 13

About revisions ............................................................................................................14

Development Cycle ............................................................................................. 15

Standard DOC1 vs Workgroups ............................................................................. 17

Application Rules ...............................................................................................................17

Font Table ..........................................................................................................................17

Conversion Utilities ............................................................................................................17

Build ..................................................................................................................................17

Sub Documents ..................................................................................................................18

THE WORKGROUPS CLIENT .....................................................................................19

Connecting to the Repository ..............................................................................................19

Exiting Workgroups ...........................................................................................................20

About the Workspace .......................................................................................... 21

The Navigator ....................................................................................................................21

The Details View ................................................................................................................22

The INI Editor .............................................................................................................23

The Output window ............................................................................................................24

The Tool Bar ......................................................................................................................25

The Status Bar ....................................................................................................................25

Contents 3

ADMINISTRATOR FUNCTIONS ................................................................................... 27

Repository set-up ................................................................................................................28

About the Shared folder ................................................................................................28

Creating and configuring users ............................................................................................29

Working with roles .............................................................................................................30

Working with projects .........................................................................................................32

CREATING AND MANAGING PROJECTS ..................................................................... 33

Creating a new project .........................................................................................34

About the Working Folder ..................................................................................................35

Importing resources .............................................................................................36

Existing DOC1 applications ................................................................................................36

Making Workstation resources more granular ...............................................................37

Document Object Libraries .................................................................................................39

Printer/browser resources ...................................................................................................41

Project maintenance ............................................................................................43

Project Revisions ................................................................................................................43

Managing deletions .............................................................................................................43

WORKING WITH RESOURCES ................................................................................... 45

Creating new DOC1 resources ...............................................................................46

Working with document objects ..........................................................................................47

Sections .......................................................................................................................48

Locating and selecting resources .............................................................................50

Selection techniques ............................................................................................................51

Adding existing resources to a project ......................................................................52

About referenced resources ...........................................................................................52

Sharing ...............................................................................................................................52

Branching ....................................................................................................................53

Copying .............................................................................................................................53

Adding resources ................................................................................................................54

Viewing and editing resources ................................................................................56

4

Managing resources ............................................................................................ 58

Viewing properties ..............................................................................................................58

Renaming ...........................................................................................................................58

Deleting and restoring .........................................................................................................59

MANAGING REVISIONS .............................................................................................61

Revision synchronization ....................................................................................................63

IMPLEMENTING AN APPLICATION ..............................................................................65

Building ........................................................................................................... 66

Generating metrics ............................................................................................. 70

Original or Workstation resources? ......................................................................................71

Editing metrics files ............................................................................................................73

Deploying ........................................................................................................ 75

About INI objects ...............................................................................................................75

Application Settings objects ..........................................................................................76

Host objects .................................................................................................................76

Preference objects .........................................................................................................77

Output Datastream objects ...........................................................................................78

Creating and editing INI objects ..........................................................................................79

Configuring transport settings .............................................................................................82

Initiating deployment ..........................................................................................................83

ARCHIVING AND REPORTING ....................................................................................85

Creating Snapshots ............................................................................................. 86

Archiving the user log .......................................................................................... 89

Project change reports ......................................................................................... 90

REFERENCE ............................................................................................................93

Add Files ............................................................................................................................93

Application Settings (object and section) ..............................................................................94

Build ..................................................................................................................................95

Check In .............................................................................................................................96

Check Out ..........................................................................................................................96

5

Clean Working Folder ........................................................................................................97

Clear Output Window ........................................................................................................97

Copy (and Paste) ................................................................................................................97

Copy Project .......................................................................................................................98

Create Project .....................................................................................................................99

Create Revision ..................................................................................................................99

Delete ...............................................................................................................................100

Deploy .............................................................................................................................101

Edit File ...........................................................................................................................102

Edit Key ...........................................................................................................................102

Edit Label .........................................................................................................................103

Edit Sections .....................................................................................................................103

Exit ..................................................................................................................................104

Export Snapshot ...............................................................................................................104

File List ............................................................................................................................106

Generate Metrics ..............................................................................................................107

Get Latest .........................................................................................................................107

Host (object and section) ...................................................................................................108

Import Application ...........................................................................................................109

Import Library ..................................................................................................................111

Import Printer Resources ..................................................................................................111

Invert Selection .................................................................................................................114

Merge ...............................................................................................................................115

Navigator .........................................................................................................................115

New .................................................................................................................................116

Open Repository ...............................................................................................................116

Options ............................................................................................................................117

Output Datastream (object and section) .............................................................................119

Output window ................................................................................................................120

Paste (after Copy) .............................................................................................................120

Preferences (object and section) .........................................................................................121

Project Settings .................................................................................................................122

Properties (general) ...........................................................................................................125

Properties (for document objects) ......................................................................................125

Properties (for Host objects) ..............................................................................................126

Properties (for projects) .....................................................................................................127

Rebuild All .......................................................................................................................127

Refresh .............................................................................................................................128

6

Rename ............................................................................................................................ 128

Report Changes ................................................................................................................128

Role ................................................................................................................................. 129

Select ............................................................................................................................... 130

Select All .......................................................................................................................... 131

Set Working Folder .......................................................................................................... 131

Share ................................................................................................................................ 131

Show Revisions ................................................................................................................133

Split ................................................................................................................................. 134

Undo Check Out .............................................................................................................. 135

User ................................................................................................................................. 135

View File .......................................................................................................................... 136

APPENDICES .........................................................................................................137

Appendix A: Access rights ...................................................................................137

Appendix B: Output message types ........................................................................139

Appendix C: Using APPC on OS/390 ....................................................................140

INDEX ..................................................................................................................143

7

Preface

This User�s Guide provides information about using DOC1 for Workgroups which is an extension of the regular DOC1 development environment.

The Workgroups user should be familiar with all DOC1 concepts. You will need to refer to other documents in the set of DOC1 user guides for information about the Workstation and Host modules with which Workgroups interacts.

The DOC1 Administrator should also familiarize themselves with Microsoft�s Visual SourceSafe.

Document StructureThe �Concepts and Overview� provides useful background information about how Workgroups works and what you will need to use it properly.

�The Workgroups Client� describes the main Workgroups interface and how to configure it.

�Creating and managing projects� on page 33, �Working with resources� on page 45, �Implementing an application� on page 65 and �Archiving and reporting� on page 85 provide tutorial style information to the main features. These sections are intended to give a step-by-step guide to using system features and to identify the interaction between modules and features of the DOC1 Workstation.

�Reference� on page 93 provides detailed information about the options available and input required for various features.

Skills and TrainingWorkgroups runs on a Microsoft Windows environment. It takes full advantage of the operating system functions. If you do not have Windows experience, we recommend that you attend an appropriate introductory training course.

Workgroups is an extension of the basic DOC1 environment. The Workgroups user will need to understand the operation of the various DOC1 editors and the interaction of the development and production environments.

9

The DOC1 Administrator will need an understanding of repository software including the control of user ids, access permissions and so on. Other users do not need to understand the operation of the repository but a basic knowledge of revision control issues is assumed for all Workgroups users.

While every effort is made to provide sufficient information in this and the other User�s Guides, we also recommend that DOC1 users attend a training course covering the features of the DOC1 environment and the interaction of DOC1 products on the various supported platforms. Your DOC1 supplier will be happy to advise on course availability.

DefinitionsALE The Application Layout Editor which is the main design interface for DOC1

applications.

DFE The Data Format Editor which is used to apply data formatting for use in the application design, along with a sample data file.

DLM The Document Library Manager is used to hold multiple document objects where they can be created, designed and updated.

EMFE The Extract, Merge and Formatting Engine. This is the main production engine responsible for processing the DOC1 application and producing the actual output datastream.

DOC1 Administrator The person(s) responsible for controlling access rights to resources and features within the Workgroups environment.

Updates to this manualThis manual may be reissued in electronic format from time to time to include corrections that have been made since the original hard copy publication. Such changes are indicated by change bars in the margin next to the amended material.

10 Preface

Concepts and Overview

DOC1 for Workgroups is an extension of the DOC1 environment. It allows a work-flow approach to creating and maintaining DOC1 applications. Under Workgroups, a project consists of a set of resources required in order to generate an application. Many of these resources will be familiar to existing DOC1 users but Workgroups provides greater granularity and control.

In summary Workgroups provides the following additional functionality over the standard DOC1 environment:

� An integrated development environment � all DOC1 editors can be invoked from within Workgroups. Additionally, deployment processes such as generating the initialization file and resource metrics required by EMFE are centrally controlled and automated.

� Project orientated environment � project resources are held in a central repository and can be shared by a team of developers. Some DOC1 file types � notably document objects � are more granular in the Workgroups environment to improve availability.

� Revision Control � the repository provides an archive of old projects and objects allowing old revisions to be retrieved should the need arise.

� Controlled Access � the Administration functions allow detailed control of users and their access rights. This prevents unauthorized changes to DOC1 resources and can be used to implement an approvals process if required.

11

Repository and administrationThe Workgroups� Repository is a third party revision control system that is used to store and control files related to DOC1 projects. For the current version of Workgroups, Microsoft Visual SourceSafe is always used for this function.

The repository allows multiple users to develop DOC1 projects. It keeps track of and stores changes to all resources held within Workgroups� control, enabling users to review the history, return to an earlier version, develop resources concurrently, and share them across more than one project if desired.

Before using Workgroups you must install the Visual SourceSafe Administrator on the computer that will be acting as your server. You must also install/setup the Visual SourceSafe Client on all workstations intending to use Workgroups.

Once the repository software has been installed you can use the Workgroups client to create and control user ids, passwords and access permissions for people who will need to use Workgroups.

The Workgroups repository allows a single administrator account which always has a user id of �Admin�. This account along with an initial password is set-up automatically when Workgroups is installed. In keeping with other DOC1 products and concepts this user is known as the �DOC1 Administrator� throughout this manual.

Users and access permissionsThe DOC1 Administrator creates and configures new user accounts within the Workgroups environment as required.

Users are assigned one or more roles which confer a set of default rights when the user is added to projects. Workgroups provides a set of built-in roles that cater for standard functional groupings but the DOC1 Administrator can create new roles with customized rights as required. Roles have global effect for the users to which they are assigned but the rights made available can be overridden when the user is added to a specific project.

! REFER TO �ADMINISTRATOR FUNCTIONS� ON PAGE 27 IN THIS GUIDE FOR DETAILS OF CONFIGURING THE WORKGROUPS ENVIRONMENT.

12 Concepts and Overview

Projects, Folders and FilesDOC1 for Workgroups controls the resources required to build and execute a DOC1 application. The term �resource� encompasses everything from the DOC1 files that are created when designing an application on the Workstation to the fonts and images that will be used on the target output device.

Such resources are archived as files within either a project folder or a shared resource folder. These folders represent locations within the repository and the files they contain are not directly available for editing. When you log on to the repository you will see all the folders that have previously been created (if any). A project folder typically contains all of the resources required by a particular DOC1 application but you can share resources across folders as required.

In order to work with any files you must create a working folder for the project to which they belong within the Workgroups client. These folders represent disk locations available to the client computer and you will need to specify an appropriate path name when you create them. Working folders are created on a per user and per project basis � i.e. each Workgroups client will need to have a working folder specified for each project containing files to be edited. You will be prompted to create a working folder whenever you create a new project and when you request to edit files from a project that you have not worked with before.

As resources are amended they are stored as different revisions of the base file within the repository. Normally you will want to work with the latest revision but it is possible to use any previous revision as the basis of a new version.

Many resource files are exactly the same as you would use in the regular DOC1 environment. However, document objects and EMFE initialization settings are stored in a much more granular form than would otherwise be the case.

Document objects:although associated with a particular library each document object is stored as a separate file that can be copied and/or shared with other projects.

Initialization settings:are broken down into objects that contain the settings for a section or group of associated sections used in an INI file. There are object types for the application, the target output datastream, the target host and preferences.

Projects, Folders and Files 13

About revisions

When you create or import a new resource using Workgroups you are generating a new file within the repository. Every time a resource is checked back in to the repository following an edit a new revision of the file is automatically created. Whenever you Edit or Get a resource Workgroups gets the latest revision of the file from the repository for you to work with.

Workgroups also allows you to create revisions of entire projects. Project revisions are a snapshot of the resources being used by the project at the time the revision is created. They contain an index to the files being used plus the relevant revision information. Note that project revisions are created only on request.


Development CycleThe act of creating a project within Workgroups establishes a new project folder in which you will create the DOC1 resource files related to the project. A project can be used for one or many DOC1 applications depending on your requirements.

To prepare for any DOC1 project you will first need to import non-DOC1 resources if they are not already available � a sample data file and the resources required by the target output device (fonts and images). Note that fonts and images are always placed in the Shared folder which is available to all projects.

For completely new applications you will normally want to create DOC1 resources in the following sequence:

1. the data format

2. document objects (cataloged within one or more document object libraries)

3. a document layout for each document type to be produced by the application (optionally broken down into sub-documents if required)

4. a document journal for each index to be produced by the application.

When you create a new resource a skeleton of the appropriate file type is generated in the repository. Selecting Edit for a file checks the resource out of the repository and automatically invokes the appropriate DOC1 editor.

! REFER TO THE DESIGNERS GUIDE FOR COMPLETE INFORMATION ABOUT USING THE DOC1 EDITORS.

The DOC1 production engine � EMFE � requires an Initialization File (INI) that defines the environment for a particular application. Under Workgroups this environment can be defined within deploy objects, each of which contain a section of initialization information. Deploy objects can be shared across projects and reused as required. The deploy objects are maintained within the Workgroups client and are manipulated in the INI Editor window.

Once you finished working with a resource file or deploy object you must check it back into the repository before it can be used as part of the build and deployment process. Every time a file is checked in a new revision is created within the repository.

You can also choose to create project revisions to capture file status at key points in the development cycle.

Development Cycle 15

Preparing an application for use with the DOC1 production engine � EMFE � consists of three phases:

Build � some or all of the document layouts and document journals within the project folder plus the associated data format and document object libraries are compiled into the format expected by EMFE.

Generate metrics � EMFE references information about fonts and image resources indirectly via metrics files. These are generated for an application based on the printer resources in the project folder.

Deployment � a new EMFE Initialization File is optionally created based on the deploy objects indicated; 2) the complete set of resources required by the application or a subset are exported to the specified host location.


Standard DOC1 vs WorkgroupsFor the most part the DOC1 editors behave the same under Workgroups as they do in the standard DOC1 Workstation environment. However, existing DOC1 users may want to note the following differences.

Application RulesUnder Workgroups you are able to break down the Application Rules (.LAR file) created by the ALE into smaller objects. Rather than a single .LAR per application you can work with individual document layouts (containing one or more ALE document layout objects) and individual document journals (containing one or more ALE journal objects). At build time you can decide which of these objects you want to make up the application being made ready for EMFE.

IMPORTANT: you must ensure that all layouts and journals within a project are associated with the same data format file (LDF).

Font TableIn standard DOC1 the fonts used in the Workstation editors must be added to the font table before being used. A separate font table is created on each machine using DOC1 editors and is shared by all applications edited on that machine.

Under Workgroups a font table is still used but it is created and maintained automatically whenever an application is imported or when fonts are added to a project. A separate font table is maintained for each project in the repository and is automatically made available to any user checking out a DOC1 file requiring font information.

Conversion UtilitiesThe conversion options are disabled when the DOC1 editors are called from Workgroups. All printer resources are expected to be imported into the Workgroups environment before being used in the editors.

BuildThe process of compiling an application into the format expected by EMFE on the host system is always handled by Workgroups and not by the ALE as in standard DOC1. The Build option is disabled in the ALE when used with Workgroups.

Standard DOC1 vs Workgroups 17

You can choose which document layout and document journal objects stored within a project are to be included in the build.

Sub DocumentsWherever possible you should create sub documents as new files from within Workgroups. You are still able to create sub documents directly in the ALE but these will not be brought under the control of Workgroups unless you explicitly add them to the appropriate project after they have been created.


The Workgroups client

The Workgroups client provides a user-friendly interface to the repository plus additional tools designed to help with the creation and management of DOC1 Project resources.

You must have DOC1 Workstation and Visual SourceSafe 6.0 client installed on your workstation in order to run DOC1 for Workgroups.

Connecting to the RepositoryWhen you start Workgroups you will be asked to enter a user name, password and the location of the repository into the Logon to DOC1 for Workgroups dialog.

Your DOC1 Administrator will provide you with your user name and password.

The location of the Repository is dependent on where the Visual SourceSafe Database has been installed by the Workgroups Administrator. You can use the browse feature to locate the SRCSAFE.INI file and allocate a �friendly� name. All repository locations are remembered by Workgroups and displayed in a list within the Logon dialog.

You can only log on to one location at a time. If you use more than one repository location, you can use the Open Repository option at any time to close a current session and log onto another repository.

| To Logon to a Workgroups� Repository:

1. On the File menu, click Open Repository.

The Logon to DOC1 for Workgroups dialog is displayed.

Note that when you first start-up Workgroups, the Logon dialog is automatically displayed.

2. Enter your User Name and Password.

3. Locate the Repository using the drop down list or click the Folder icon to browse. The repository is identified by a SRCSAFE.INI file.

4. Click OK.

Workgroups connects to the repository and displays the available DOC1 projects in the Navigator. Connection times may vary. The output window will keep you informed of progress. The status bar will also inform you when connection is complete.

19

Exiting Workgroups| To Exit Workgroups on the File menu, click Exit. Alternatively, click the �x� icon on the main Workgroups� title bar.

20 The Workgroups client

About the Workspace

The Workgroups interface consists of the Navigator, the Output window, and the Details View which may itself contain the File List and/or INI Editor windows.

The NavigatorThe navigator shows the Workgroups� Repository as a series of related folders which contain DOC1 resources. Unless you are using the Admin view the highest level folders relate to projects or shared resources. The navigator has up to four views available. Most users will see the three views related to the development cycle of a DOC1 application:

Header dividers:Cursor changes during hover. Click and hold to resize columns.

Separator bar:Drag to left or right to resize the space shared between workspace elements.

Docking bars:Double click on a docking bar to free the window. Or click and hold to drag to a new location.

NavigatorThis allows you to locate resources held in the Repository. Use the tabs to switch between the Design, Build and Deploy views which display the files appropriate to these development phases.The Administrator will have an additional view that lists users and role definitions.

Output WindowThis will display all information and error messages. Use the tabs to switch to messages generated by the Repository or Build.

Details View:This will display the files or settings associated with selected items in the navigator. It can contain multiple windows with the most recent on 'top'. Click where shown to display more that one window at once.

About the Workspace 21

� The Design View � use when working with DOC1 Workstation resources in the repository.

� The Build View � use when creating resource metrics and to when building a set of Production Rules Files to be used by EMFE in the production environment.

� The Deploy View � use when working with Initialization and other Project settings required for deployment and when actually requesting a deployment.

A user logged in as the DOC1 Administrator will have an additional view:

� The Admin View � contains the User and Role definitions that control access to system features and resources.

| To re-size the Navigator click the separator bar and drag it to the new position. This changes the amount of space allocated to the various panes.

| To display resources within a folder select a lowest level folder and click in it. The Details View will display the resource list.

The Details ViewThe Details View is a multi-function area that displays the contents of folders and objects selected in the Navigator and other lists.

When most folders are selected the Details View will show a File List window that summarizes the resources contained in the selected folder. Selecting a document object library in the Navigator will display a slightly different format that corresponds to that used in the Document Library Manager module of the DOC1 Workstation. Double clicking on a file or object will perform the currently defined default action � View, Edit or a prompt to allow you to choose.

Different icon 'overlays' are used to indicate a resource status:

Checked Out

SharedNot in working folder

If the resource is currently checked out these indicate the user who checked the file out and the date checked out from the repository

Indicates the revision number (i.e. how many times the resource has been edited)

Built but not checked in

Copy in working folder


When a deploy object is selected in the navigator the Details View will display the Initialization File settings associated with the object. You will also be able to edit such settings within the view itself provided the object has first been checked out of the repository. See below for more details.

Other windows may also appear in the Details View and many can appear simultaneously. In summary:

� One File List window for the last selected resource folder or document object library.

� One INI Editor window containing the last selected deploy object.

� One Deployment settings window.

� One window for each time the Report Changes feature is executed (until closed)

� One window for Administration functions (DOC1 Administrator only)

You can tile, cascade or otherwise manipulate these windows within the space allocated to the Details View.

| To set the double-click default action use Tools/Options.

| To sort a file or object list click on a column header.

| To re-size columns drag the column header dividers back and forth to change the amount of space allocated to each column. You can also reorder the columns by dragging and dropping them.

| To refresh the view use the View/Refresh menu option or press F5 on the keyboard.

The INI Editor

The INI Editor is displayed when you are working with a Section of an INI objects in the Deploy View. INI objects contains the settings that will be used to build an EMFE Initialization File for an application. When a Section is checked out, you can add, delete, move and edit keywords and the associated values. Where appropriate, the editor will provide you with a list of keywords and values suitable for the section you are editing. If a keyword value is not specified a default value is applied. You can also type in custom (unlisted) keywords directly into any keyword field.

! REFER TO �IMPLEMENTING AN APPLICATION� ON PAGE 65� FOR DETAILS OF USING INI OBJECTS AND THE INI EDITOR WINDOW.


The Output windowThe Output window displays a list of messages generated by events occurring within the Repository.

All messages have a unique Workgroups message ID associated to them. Should you need to contact Customer Support with a problem, please quote the Workgroups message number. This will help Customer Support to identify and solve the problem.

The Output window has two message and output views:

� The Repository View � provides information about the interaction of Workgroups with the Repository.

� The Build View � displays the output information generated when using the Build options.

Workgroups flips to the correct output view as new messages or output are added.

| To sort the Output window either right-click within the window to display the sort by... options in the context-sensitive menu or click on a column�s header.

| To clear the Output window on the View menu, click Clear Output Window.

| To re-size columns drag the column header dividers back and forth to change the amount of space allocated to each column. You can also reorder the columns by dragging and dropping them.

! REFER TO �APPENDIX B: OUTPUT MESSAGE TYPES� ON PAGE 139� FOR A TABLE OF MESSAGE TYPES USED IN THE OUTPUT WINDOW.


The Tool BarThe Tool bar contains shortcuts to frequently used functions. It can be toggled on or off and is dockable like the main Workgroups windows.

Placing the cursor over an icon will display the hover help. A brief description about the function of the option is also displayed in the status bar.

! REFER TO MESSAGE 1 GUIDE "REFERENCE" SECTION FOR A TABLE OF ALL TOOL BAR S AND KEYBOARD SHORTCUTS.

The Status BarThe status bar is positioned along the bottom edge of the workspace. The status bar provides the following information:

Help � context-sensitive help regarding the currently selected menu item or tool bar icons.

Working Folder � the path of the current working folder for the currently selected project.

Connection Status � this reports the current connection status of Workgroups to the repository.

Progress Bar � gives visual feedback to the user during intensive tasks such as Logon or Build.


Administrator functions

The Workgroups� Repository is a third party revision control system that is used to store and control files related to DOC1 projects. For the current version of Workgroups, Microsoft Visual SourceSafe is always used for this function.

The Repository allows a single administrator account which always has a user id of �Admin�. This account along with an initial password is set-up automatically when Workgroups is installed. In keeping with other DOC1 products and concepts this user is known as the DOC1 Administrator throughout this manual.

The DOC1 Administrator is permitted to carry out all Workgroups functions and has sole responsibility for adding and configuring all other users who will participate in the Workgroups environment.

Users are assigned one or more roles which confer a set of default rights when the user is assigned to projects. Workgroups provides a set of built-in roles that cater for standard functional groupings but the DOC1 Administrator can create new roles with customized rights as required. Roles have global effect for the users to which they are assigned but the rights made available can be overridden when the user is added to a specific project.

h WHEN THE DOC1 ADMINISTRATOR IS LOGGED ON AN ADDITIONAL MENU �ADMINISTRATION� IS AVAILABLE ON THE WORKGROUPS CLIENT. THIS CAN BE USED TO PERFORM ALL FUNCTIONS RELATED TO USERS AND ROLES.

The available rights can provide very specific control � for instance, you can restrict access to individual objects types if required. The DOC1 Administrator can also assign the right to administer parts of the system to other users.

All objects other than users and roles are considered to be part of a project and you will need to create one or more projects before work on DOC1 applications can begin. Users must be assigned to each project they will need to work with.

27

Repository set-upBefore using Workgroups you must install the Visual SourceSafe Administrator on the computer that will be acting as your server. You must also install/setup the Visual SourceSafe Client on all workstations intending to use Workgroups.

! REFER TO YOUR VISUAL SOURCESAFE DOCUMENTATION FOR FURTHER INFORMATION ABOUT THE REVISION CONTROL SOFTWARE.

About the Shared folder

The DOC1 Administrator will normally want to set up a project within the repository which can be used to contain cross-project (shared) resources. This is automatically used by Workgroups as the target location for DOC1 fonts and any further imported printer resources.

During the installation of Workgroups, users are prompted to specify the name of the shared project (e.g. DFWShared � or as set up by the Administrator) and a working folder for it (e.g. C:\DFW\DFWShared). If necessary, this can be changed at a later date by using the Repository page in the Options dialog (see the �Options dialog� on page 118 at the end of this guide for more information).

| To set up the Repository for use with DOC1 for Workgroups:

1. Install the SourceSafe server software on the appropriate machine.

2. In the Visual SourceSafe Admin tool, use the Tools/Create Database option to create a repository database.

3. Open the repository just created and then use the Archive/Restore Projects option to restore the SourceSafe archive containing the shared resources project. This can be found on the DOC1 installation CD as:

Windows\Workgroups\DFWAdmin\DFWAdmin.SSA

Note that if you do not restore this file you will need to add the DOC1 fonts manually (using the import printer resources).

h IMPORTANT � SYSTEM CLOCKS NEED TO BE SYNCHRONIZED BETWEEN CLIENTS AND SERVER IN ORDER TO AVOID POSSIBLE CONFLICTS IN THE REVISION CONTROL MECHANISM.

28 Administrator functions

Creating and configuring usersAll Workgroups users must be registered with the system and assigned to one or more projects before they can start work. The DOC1 Administrator function alone can create new users.

When a user is created the Administrator assigns one or more roles. The rights conferred by the roles will be assigned by default to any new project which is added to the users profile but can be overridden. Typically the Administrator will also assign a new user the right to work with one or more projects while creating the new object.

| To create a new user:

1. Create a new user object.

In the Admin view, right click on Users in the navigator and select New from the pop-up menu.

2. Specify a user name.

A new user will have been added to the tree with a default label. Right click on it, select Rename and enter the required name (note that this is not necessarily the same as the name the user specifies at logon � see below).

3. Select the users role(s).

In the details view, select the required role(s). The built-in roles can be toggled on and off by using the check boxes.

For custom roles right click in the Roles area, select the Add option from the pop-up menu then choose the required role from the list that appears. If you need to create a new role for this user it can be assigned later.

4. Specify the logon details.

Enter the name and password that the user will log in to Workgroups with. These are not case-sensitive.

29

5. Specify projects for which the user is authorized.

Right click in the Projects area, select the Add option from the pop-up menu then choose the required project name from the list that appears. Repeat as required for other projects.

| To remove a custom role from a user, right click on the role in the details view and select Delete from the pop-up menu.

| To delete a user right click on the user object in the navigator and select Delete.

Working with rolesSix built-in roles are always available in Workgroups � Project Administrator, Operations Administrator, Production Administrator, Resource Administrator, Application Designer and Application Operator. These are intended to cater for standard functional groupings and many installations will be able to control

their DOC1 environment using just these roles.

New roles with customized authorities can be created as required and assigned to users instead of or as well as the built in roles.

h IF MULTIPLE ROLES ARE ASSIGNED TO A SINGLE USER THE HIGHEST LEVEL OF AUTHORITY AVAILABLE WITHIN THE SPECIFIED ROLES IS GIVEN TO THE USER.

Project

Admin.

Operations

Admin.

Production

Admin.

Resource

Admin.

Application

Designer

Application

Operator

Administer system features "

Assign the right to administer parts of the system to other users *

" " "

Create and manipulate projects " "

View and use file revisions " " "

Create and work with resources " "

Import resources " "

Configure build settings " "

Use build and deployment options " "

* Only the DOC1 Administrator can assign administration rights to other users.

Detailed information about the rights associated with these roles can be found in Appendix A.

Summary of Rights assigned using the built-in roles


| To create a custom role

1. Create the new object.

In the Admin view, Right click on Roles in the navigator and select Add from the pop-up menu.

2. Specify a name.

A new role will have been added to the tree with a default label. Right click on it, select Rename and enter the required name.

3. Specify rights.

Clicking on the new object displays the Rights tree in the details view. See below for details of configuring rights to your requirements.

Refer to�Appendix A: Access rights� on page 137 for details of the available rights.

| To copy an existing role select a role in the Admin navigator select Administration/Role/Copy from the menu bar.

Configuring rights

Rights are attributes of Workgroups Roles that permit users to work with specific objects or functions. Click on a role object to display the rights tree In the details view. This is grouped according to area of responsibility into which they fall.

Objects have multiple levels of access rights with each level permitting the action specified plus all other actions that are 'below' it in the hierarchy. The access levels are: Disabled; View; Edit; Createwith the hierachy being left-to-right.

Functions are are either enabled or disabled only.

| To configure a single right click on it and select the level from the list or right click and select from the menu.

| To configure rights as a group – i.e. wherever there is a folder – right click on the folder and select the new access level from the pop-up menu

If you create a completely new role all rights are disabled by default and you will need to set access levels for each right as required. More typically you will want to use an existing role as a template: copying a role object will create a new object with the same rights already specified and you can then refine it as required.

31

| To assign new roles to existing users

1. Select the user(s) to be updated in the Admin navigator.

2. From the Administration menu select User/Roles/Assign.

3. In the Select Role dialog select the roles to be assigned.

Working with projectsAll objects to be controlled by Workgroups must be included within a specific project. (The exception to this is imported printer resources which are located in the Shared folder.) Additionally users must be assigned to every project that they need to work with including the Shared folder.

Only users with project administration rights can create projects. The user who creates the project is automatically added to the user list for that project. All other users who need to work with the project will then need to be specifically assigned to it.

When users are assigned to a project their access rights are defined by default according to the roles to which they are assigned. You will need to alter these rights on a user-by-user basis if you want to override the defaults.

! REFER TO �IMPORTING RESOURCES� ON PAGE 36� IN THIS DOCUMENT FOR DETAILS OF HOW PROJECTS ARE CREATED AND MAINTAINED.

| To assign new projects to existing users:

1. Select the user(s) to be updated in the Admin navigator.

2. From the Administration menu select User/Projects/Assign.

3. In the Select Projects dialog select the roles to be assigned.

| To override user rights for a particular project:

1. Select the user to be updated in the Admin navigator.

2. Select the project for which override is required.

In the details view right click on the project to be manipulated. The Rights dialog will appear listing the rights conferred by the users role(s).

3. Configure rights as required.

Refer to the �Creating and configuring users� on page 29� feature in this section for details. Bear in mind that when you are configuring rights at the project level you may be dealing with cumulative rights conferred by multiple roles.


Creating and managing projects

A project is a group of related files, typically all the files required for one or more DOC1 applications. A DOC1 project may consist of existing resources from other projects or completely new resources or, most likely, a combination of both.

The Create Project option will create an empty project folder structure, where resources can then be added, using Add Files.

To create a project from an existing DOC1 application�s set of files, use the Import Application option.

33

Creating a new projectYou can create a completely new project, copy an existing project within the repository or use the Import Application option to create a project from DOC1 resources currently outside of Workgroups control. Whenever you create a project a complete folder structure is created within the project folder.

! SEE �IMPORTING RESOURCES� ON PAGE 36 IN THIS SECTION FOR DETAILS OF IMPORTING EXISTING DOC1 FILES.

To use import features you will need to be assigned the project admin. role or equivalent.

When you create a completely new project it will contain no files (except default fonts) and you will have to build up the contents using import and creation features.

When you copy a project all resources within the project including shared and referenced resources are copied into the new folder structure and can then be manipulated independently as required. By using the Keep Revision Histories option when you copy you are effectively creating a branch in the repository for the selected project. Within the new projects you will be able to view project revisions prior to the copy and Roll Back to them if required.

h ONLY USERS WITH PROJECT ADMINISTRATION RIGHTS CAN CREATE PROJECTS. THE USER WHO CREATES THE PROJECT IS AUTOMATICALLY ADDED TO THE USER LIST FOR THAT PROJECT. ALL OTHER USERS WHO NEED TO WORK WITH THE PROJECT WILL THEN NEED TO BE SPECIFICALLY ASSIGNED TO IT. REFER TO �ADMINISTRATOR FUNCTIONS� ON PAGE 27 FOR DETAILS.

| To create a new project:

1. On the File menu, click Create Project.

2. In the Create New Project dialog, enter a project name and, if you wish, a comment.

3. Click on the OK push button.

A new project is created. Empty folders for the project�s resources are also created.

| To copy a project:

1. On the Tools menu, click Copy Project.

2. In the Copy Project dialog, enter a name for the new project.

3. Enter a working folder location for the new project. If the path does not exist Workgroups will create it. Alternatively, use the Browse push button to help you locate an existing folder.

34 Creating and managing projects

4. Select the project you want to copy from the Base Project list.

5. Confirm copy and specify options.

If you want to work with the new project immediately ensure the Check Out Immediately option is checked.

Check Keep Revision Histories if you want to be able to work with earlier versions of the copied resources.

Click OK to create the new project.

About the Working FolderEvery user needs to allocate work space for each project they intend to work with. This is known as the working folder and is a file location where resources are stored while they are in use.

When you create or copy a project or start working with a project for the first time you will be prompted to specify the working folder for that project.

We recommend that the Working Folder for each project is unique (e.g. C:\DFW\Projects\<project name>) as this will avoid any overwriting problems when working with more than one project. You should also make sure that the location specified has enough space available to deal with the DOC1 resources you will be working with.

You can change the location used as a working folder at any time. You can also delete the resources held in a working folder using the Clean working folder option.

| To change a working folder:

1. Select a project in the Design View.

2. On the Project menu, click Set Working Folder.

3. In the Set Working Folder dialog, enter a working folder location. If the path does not exist Workgroups will create it.

Alternatively, use the Browse push button to help you locate an existing folder using the Browse for Folder dialog.

| To delete resources in a working folder:

1. Select a project in the Design View.

2. On the Project menu, click Clean Working Folder.

3. Specify how non-project files are to be handled.

If the working folder contains any files that are not registered with the current project you will be prompted with a list. Selecting Yes will also delete these files from the directory.

The directory itself is not deleted.

Creating a new project 35

Importing resourcesFor new Workgroups projects the first activity is nearly always importing resources to be brought under the control of the repository.

To use import features you will need to be assigned the project admin. or operator roles or equivalent.

Existing DOC1 applicationsThe Import Application option allows you to bring existing DOC1 applications under the control of Workgroups. This feature works by parsing a �base file� for references to other files required by the application. For Workstation resources the base file is an Application Rules (.LAR) file. For production resources the base files is an EMFE Initialization File (INI). All referenced files that can be located are copied and placed in the relevant Workgroups folder.

Base Files

Application Rules (LAR) May be imported without change or broken down into document layout and journal files. Usedto reference all other Workstation resources for the application.

EMFE Initialization File (INI) Imported as a text file. Used to reference all other production resources for the application.

Referenced files

Workstation files from Application Rules Production files from INI

Document Object Libraries (LFL, LOL) Font Metrics (FM)

Data Format (LDF) Image Metrics (IM)

Sample Data (SVD) Text Substitution (ETS)

Workstation (LarMeta) fonts (LCF, LMS, LFO) User Exit Control (DAT)

Workstation (LarMeta & Bitmap) images (LIM, BMP)

Workstation (LarMeta) overlays (LOM)

Sub Documents (if used) (LSD)

Global Symbolic Links (LGL)

Message Rules (Message1 Users only) (LME)

Files created by optional features

Document Objects (LDOs) Created by the Break Document Object Library.. option

Additional Application Rules (LAR) Created by the Break Application Rules... option

Journal Rules (LJR) Created by the Break Application Rules... option

Sub Documents (LSD) Created by the Convert Shadow Bundle Objects... option

Relevant file types when Importing a DOC1 Application


The import function will search for referenced files in the directory in which the specified LAR and/or INI file is located. Files that cannot be found will cause a warning to be issued and such files can be added separately as required. All progress messages are displayed in the Output window.

h IF YOU INTEND TO REGENERATE DOC1 METRICS FROM TARGET PRINTER RESOURCES (OTHER THAN BMPS) YOU WILL NEED TO IMPORT THESE INDEPENDENTLY. SEE �IMPORTING RESOURCES� ON PAGE 36 IN THIS SECTION.

When using Import Application you can either create a completely new project or import the resources into an existing project.

| To Import a DOC1 Application:

1. On the File menu, click Import Application.

2. Identify the target project.

In the Import DOC1 Application dialog, use the Name field either enter a new name to create a new project or select an existing project from the drop down list.

3. Specify the master files.

In the Import DOC1 Application dialog you must specify an Application Rules file which is used to identify all other Workstation resources used by the application.

You will also normally want to specify an EMFE INI file to identify the custom files from the Host environment to be brought under Workgroups� control.

4. Select the break down check boxes as required (see following topics).

5. Enter a working folder location for the new project. If the path does not exist Workgroups will create it. Alternatively, use the Browse push button to help you locate an existing folder.

6. Click on the Import push button.

A new Workgroups� Project will be created using the files that you have specified.

Making Workstation resources more granular

When importing an application three options allow you to increase its granularity as documented below.

Breaking Document Object Libraries

The Break Document Object Library... option will create individual document object files (LDOs) from the objects contained in the document object libraries referenced by the application.

Importing resources 37

If you choose this option new folders with the name of the imported libraries will be created within the document objects folder of the project. The new LDOs will be included in these folders but the old library files will not be referenced.

If you do NOT choose this option the document object library files will be included in the root of the document objects folder within the project. If required you can still decide to break a library at a later date using the Import Library option.

! THE MERGE AND SPLIT FUNCTIONS PROVIDE THE OPTION TO MANIPULATE DOCUMENT OBJECTS. YOU CAN CHOOSE TO COMBINE NEW OR EXISTING DOCUMENT OBJECTS INTO A LIBRARY OR CONVERSELY DIVIDE A LIBRARY INTO INDIVIDUAL DOCUMENT OBJECTS. FOR MORE INFORMATION, SEE �WORKING WITH DOCUMENT OBJECTS� ON PAGE 47.

Breaking Application Rules

The Break Application Rules... option will create separate files from each Document Layout and Journal object within the original Application Rules file.

If you choose this option an Application Rules file (LAR) will be created for each Document Layout object and placed in the Document Layout folder of the selected project. A Document Journal file (LJR) will be created for each Journal object and placed in the Document Journal folder. The original Application Rules file will not be referenced.

If you do NOT choose this option the original Application Rules file will be stored unchanged within the Document Layout folder.

Breaking Shadow Bundles

The Convert Shadow Bundle Objects... option will create Sub Document files from the contents of each Bundle object within the Application Rules that has been shadowed elsewhere in the application.

If you choose this option for each shadowed Bundle a Sub Document file (LSD) containing the objects previously contained within the Bundle will be created and placed in the Sub Document folder of the selected project. The Bundle objects will be removed from the Application Rules file(s) and be replaced by a reference to the appropriate Sub Documents. Bundle objects that are not shadowed are NOT converted to Sub Documents.

If you do NOT choose this option the Bundle objects and their shadows will remain in the Application Rules file(s). However, if you have selected the Break Application Rules file... option and the application contains Bundles that are shadowed between Document Layouts then a copy of the appropriate Bundle group will be placed within a Note object in the Document Layout that included the shadow.


Document Object LibrariesIf you have not de-constructed an existing document object library during the import of a DOC1 application you can choose to do this at any time by using the Import Library option. This converts Document Object Libraries (as used by the DOC1 Workstation) into individual document objects.

Each newly created document object is given a unique file name based on the library�s file name (e.g. tryme#0000001.LDO). However, when browsed in the Document Object List, document objects are identified by their label.

The import function will also create a new document object library (.CAT) that acts as a reference to the new document object (.LDO) files.

h THE SPLIT FUNCTION ALSO PROVIDES YOU WITH THE OPTION TO CREATE INDIVIDUAL DOCUMENT OBJECTS (.LDO) WITH AN ASSOCIATED DOCUMENT OBJECT LIBRARY (.CAT). SEE �WORKING WITH DOCUMENT OBJECTS� ON PAGE 47 FOR MORE DETAILS.

| To Import a Document Object Library

1. Select the project where the files should be added.

2. Select the document object library file you wish to import.

Use File/Import Library and in the Import Library dialog find the document object library file you wish to import.

3. Click Open.

A document object library (catalog) file and the individual document object files are created within the selected project.

h YOU CAN ALSO CREATE NEW DOCUMENT OBJECTS (IN NEW OR EXISTING LIBRARY CATALOGS) BY USING THE NEW OPTION, AND ADD, RENAME OR DELETE SECTIONS USING THE EDIT SECTIONS OPTION. SEE �WORKING WITH RESOURCES� ON PAGE 45� FOR MORE DETAIL.

Global symbolic links can be inserted into a document object in a library. If the global symbolic link file (LGL) does not already exist, it must be created in the application file (LAR) from the project where it is to be used. Refer to the Designer�s Guide for information on global symbolic links.

| To use global symbolic links:

1. Add the global symbolic link file (LGL) to the project.

Use the Files/Add� option in the relevant project and select the required LGL file.

2. Check out the relevant document object library.

Select the library in the navigator and select Repository/Check out


3. Make the global symbolic link file available for use.

Use File/Properties� on the document object library.

Select the Details tab and, using the Available Symbol Link Definition Files drop down list, select the required global symbolic link file.

4. Check the document object library back in using Repository/Check in�

The global symbolic links can now be used in the document objects.


Printer/browser resourcesRefer to the Printer/Browser Resources section in the Designers Guide for an in depth discussion on resource handling in DOC1 as a background to this section.

Use the Import Printer Resources option to bring printer/browser resources (i.e. fonts, images or overlays) under control of the Workgroups repository and to convert them into LarMeta format as used by the DOC1 editors.

All files are added to the Shared folder so they can be used by any project. They are automatically shared with the chosen project.

! FOR MORE INFORMATION ABOUT HOW RESOURCES CAN BE MADE AVAILABLE TO MULTIPLE PROJECTS SEE �SHARING� ON PAGE 52 IN THIS CHAPTER.

Both the original printer resource files and the converted Workstation fonts are held in the Workgroups shared project folders.

The original printer/browser resources or the Workstation (LarMeta) resources can then be used for generating/regenerating the metrics files required by EMFE in the production environment. In a scenario where you are using Windows resources or resources which are available during the build process then resource metrics are generated automatically. This assumes that the output datastream generated by the application supports the

Resource IBM AFP

(& filename)

Xerox Other LarMeta

extension

Fonts Coded Font (Xx…):– Character Set (Cx..)Code Page (T1..)

FNT Windows (Postscript/PDF/HTML)

LCFLFOLMS

Images Page Segment (S1..) IMGLGO

BMP *JPGPCXTIFGIF

LIM

Overlays OGL Source FRM LOM

* Bitmap files are compatible with DOC1 editors and are therefore not required to be converted into LarMeta format.

File Types supported


Resource Pack feature. Refer to the release notes for information on output datastreams generated by DOC1. For more information about generating metrics refer to �Generating metrics� on page 70.

h NOTE THAT BY DEFAULT, WINDOWS COMPATIBLE IMAGES (I.E. POSTSCRIPT, PDF OR HTML COMPATIBLE IMAGES) ARE CONVERTED TO BITMAP. THOUGH THE WIZARD DOES PROVIDE AN OPTION TO CONVERT TO LARMETA FORMAT IF REQUIRED.

| To Import printer resources

1. Select a project where the resources are to be added.

2. On the File menu, click Import Printer Resources.

The Import Printer Resources wizard is displayed.

3. Select the resource type you wish to import, e.g. AFP fonts.

4. Identify the resource files to be converted.

The format of this page will depend on the type of resources you have specified.

h WHEN IMPORTING HTML, PDF OR POSTSCRIPT COMPATIBLE FONTS, IF THE CREATE WORKSTATION FONT FROM WINDOWS INSTALLED FONT OPTION IS NOT SET, THEN ONLY THE MAPPING BETWEEN A WORKSTATION FONT AND PRINTER FONT IS IMPORTED.IF THE OPTION IS SET, THE WORKSTATION FONT WILL BE CREATED AND IMPORTED ALONG WITH THE MAPPING.

5. Click Finish to start the conversion process.

The selected resources are imported into Workgroups and added to the shared resources project � the original printer resources are placed into the relevant Printer Resources folder (Xerox, AFP or Postscript/PDF/HTML), whilst the converted Workstation (LarMeta) resources are placed into the appropriate font, image or overlay folder. The Workstation resources are also shared with the selected project.

! REFER TO PRINTER/BROWSER RESOURCES IN THE DESIGNERS GUIDE FOR INFORMATION ON RESOURCE HANDLING WITHIN THE DOC1 ENVIRONMENT.


Project maintenanceTo use these features you will need to be assigned the project admin. role or equivalent.

Project RevisionsA project revision is a snapshot of project status at a given time. It contains information about the resources used by the project and their revision levels at the time the project revision was taken. If required you can roll back the revision levels for resources in an entire project to recreate an earlier status.

Project revisions are created on request and you can create one whenever required by your development strategy. Typically you will want to create a project revision at the start of a new development cycle and at various key stages in the project.

! COMPLETE INFORMATION ABOUT REVISION CONTROL FOR BOTH PROJECTS AND INDIVIDUAL RESOURCES CAN BE FOUND IN THE �MANAGING REVISIONS� ON PAGE 61� SECTION OF THIS DOCUMENT.

Managing deletionsDepending on their access rights users can delete resource files from projects when they are no longer needed. However, deleted files are actually retained in the repository and can be recovered until they are permanently purged.

When restoring the last revision of the resource is made available to the project.

| To purge or restore deletions

1. Select the project from which the file was deleted in the Navigator.

2. From the File menu, click Properties.

3. Select the resource to be recovered

Click on the Deleted Files tab and select the file from the list.

4. Select the files you want to work with.

Click on the files to be changed in the Deleted list. If you are purging you can use the Purge all option without selecting any files from the list.

5. Click a Purge or Restore option.

Project maintenance 43

Working with resources

Each project contains a set of folders where the project�s resources are kept. The actual resources are stored within the Repository and can only be accessed via Workgroups. When you add a resource to a project it is automatically filed in the folder relevant for its file type.

To work with resources you will need to be assigned the project admin. or designer roles or equivalent. Note that it is possible for the DOC1 Administrator to control access to individual resource types if required.

h IF YOU HAVE NOT WORKED WITH A PROJECT BEFORE YOU WILL BE PROMPTED TO SPECIFY A WORKING FOLDER THE FIRST TIME YOU CLICK ON IT IN THE NAVIGATOR. A WORKING FOLDER IS THE WORKSPACE ALLOCATED BY A USER FOR EACH PROJECT THEY INTEND TO WORK WITH. IT IS A FILE LOCATION WHERE RESOURCES ARE STORED WHILE THEY ARE IN USE. IT IS NOT SHARED WITH OTHER WORKGROUPS USERS.

Option Action

View A temporary read-only file is placed into the system temporary folder and opened in the relevant viewer. The file is removed from the temp folder once the editor is closed.

Get Latest (file) A read-only file is placed into the working folder. This is useful when the file is needed for a build but you do not need to edit it.

Get Latest (project) All files associated to a project are placed in the working folder ensuring that all the required resources are at hand.

Edit The file is checked out from the repository and a read-write copy is placed into the working folder. The relevant editor is then invoked.

Check Out (file) The file is checked out from the repository and a read-write file is placed into the working folder. You can check out more than one file at a time.

Check Out (project) All files associated within a project are checked out from the repository and placed into the working folder.

Options for accessing resources

45

Creating new DOC1 resourcesUse the File/New option whenever you need to create a new DOC1 Workstation resource:

Data Format data definition for EMFE input data; edited using DFE.

Document Layout application logic and page layout; edited using the ALE.

Document Journal logic for creating an EMFE run-time document index; edited using ALE.

Sub-document a partial Layout or Journal; edited using ALE.

Document Object document design element; edited using DOE.

! DEPLOY OBJECTS AS USED WHEN BUILDING EMFE INITIALIZATION FILES ARE MAINTAINED SOLELY WITHIN THE WORKGROUPS ENVIRONMENT. REFER TO THE SECTION �IMPLEMENTING AN APPLICATION� ON PAGE 65� FOR DETAILS OF CREATING SUCH OBJECTS.

For most resource types you need only give it a name and identify the project to which it will be assigned when initially creating it. A new �skeleton� resource is created, registered with the repository and automatically filed into the relevant folder within the specified project. The new resource remains checked out to the user who created it ready for loading into the relevant DOC1 editor.

Document objects have additional organizational requirements that are covered in the following topic.

| To create a new resource:

1. On the File menu, click New.

2. In the New dialog, select the file type and enter a label for the object.

3. Use the Add To Project list to specify the target project.

46 Working with resources

4. Click OK to create the new resource.

The new file is checked out ready for you to start work with. Open the relevant folder within the project and use the Workgroups edit features as required. See �Viewing and editing resources� on page 56 in this section for details.

Working with document objectsDocument objects must always be included within a library. When using a Workgroups environment this normally means that the document objects (.LDO files) are created and managed individually and the library (.CAT file) simply catalogs the objects that are to be grouped together. New libraries of type CAT can be created any time you create a document object. Requesting Edit for such independent document objects invokes the Document Object Editor (DOE) with the relevant object loaded.

However, if you imported an existing application into Workgroups and decided not to �break� the document object library then you will have a library (.LOL file) in which the objects are directly incorporated. In this scenario the individual document objects are not known to Workgroups and you will need to edit the complete library in order to create new document objects within it. Requesting Edit for unbroken libraries of this kind invokes the Document Library Manager (DLM) with the relevant library loaded.

! REFER TO �CREATING AND MANAGING PROJECTS� ON PAGE 33� FOR MORE INFORMATION ABOUT IMPORTING EXISTING DOCUMENT OBJECT LIBRARIES INTO THE WORKGROUPS ENVIRONMENT.

Once document objects have been incorporated into the Workgroups environment they can be manipulated by using the Merge and Split functions. Depending on the circumstances the document objects can be divided into individual LDOs or conversely combined into a single document object library. Whether you are executing a merge or split, all references to the document objects being affected will be updated.

The Merge option enables you to combine new or existing document objects into a single library. By using the Split option you can separate a document object library into individual document objects.

Applications may refer to document objects indirectly by reference to their key. For independent document objects you can define such keys directly within the Workgroups environment.

| To create a document object proceed as for other DOC1 file types. In the New dialog you will additionally need to specify the library to which the object is to be added.

| To create a new document object library type a new name in the library field when creating a new document object.

Creating new DOC1 resources 47

| To merge individual document objects:

1. Check the document objects� library (CAT) out of the repository.

Right click the CAT library folder in the Navigator and select Check Out from the pop-up menu.

2. Merge the .CAT library and its LDO document objects.

Select Edit/Merge or select Merge from the pop-up menu. The CAT and LDO files are merged into a LOL file with the same name as the CAT file.

| To split a document object library highlight the appropriate LOL in the Details View. Select Edit/Split or right click the LOL and select Split from the pop-up menu. The document objects (LDO) can now be selected from the Details View for individual editing.

| To add or change a document object key or label:

1. Check the document object out of the repository.

2. On the Edit menu select Edit Key or Edit Label.

3. Enter the label or key name in the Details View.

The Key or Label field will have become editable for the selected object. Type the required text and press return.

Sections

Document object libraries can have multiple sections which are typically used to cater for multilingual applications. Each section is effectively a variation of the base objects within the library and, if required, can have all or parts of the text translated or varied. New sections can be added to a .CAT library from within Workgroups and this is automatically added to all objects referenced by the library. Note that the document objects are always loaded into the DOE with all sections available for edit.


The act of creating a new section copies the contents of all objects as they appear in the first section of the library to their variants in the new section. You will therefore normally want to wait until you have created a full set of objects intended for the first section before creating new ones.

If you add a new object to a library that uses multiple sections you will need to create the required contents for each section as appropriate.

| To create a new section:

1. Check out the document object library to be updated.

See �Viewing and editing resources� on page 56 for details.

2. Edit sections.

Select the document object library in the Navigator and select Edit Section from the Edit menu.

The Sections dialog is displayed.

3. Add new section.

In the Sections dialog click the Insert button.

4. Name the new section.

In the New Section dialog enter the section name to be used and click OK.

The new section name will appear in the Document Object Sections list.

5. Click OK to close the Sections dialog.

6. Use the Edit option for each of the document objects to design the new section within the objects.

Creating new DOC1 resources 49

Locating and selecting resourcesThe following table provides information on all file types held within Workgroups and where to go in the Navigator to locate them.

File Type Extension Navigator View Folder Location

Workstation Resources

Application Rules LAR Design View Project > Document Layout

Sub Document LSD Design View Project > Sub Documents

Journal LJR Design View Project > Document Journals

Data Format LDF Design View Project > Document Data > Data Format

Sample Data SVD Design View Project > Document Data > Sample Data

Document Object Library LOL,LFL Design View Project > Document Object

CAT Design View Project > Document Object > [Library]

Document Object LDO Design View Project > Document Object > Library

Font† LCF, LFO, LMS Design View Project > Fonts

Image† BMP, LIM Design View Project > Images

Overlay† LOM Design View Project > Overlays

Printer Resources

Font ICF, IBB, ICP Design View Shared Resource > Printer Resources > AFP

FNT Design View Shared Resource > Printer Resources > Xerox

PFB, AFM Design View Shared Resource > Printer Resources > PDF/PScript

Image PSG Design View Shared Resource > Printer Resources > AFP

LGO Design View Shared Resource > Printer Resources > Xerox

BMP, JPG, PCX, TIF, GIF Design View Shared Resource > Printer Resources > PDF/PScript

Overlay OGL Design View Shared Resource > Printer Resources > AFP

FRM Design View Shared Resource > Printer Resources > Xerox

Host Resources

Intermediate Rules IAR, IDF, IOL Build View Project Rules Files > Intermediate Files

Engine Rules EAR, EDF, EOL Build View Project Rules Files > Engine Files

Metrics FM, IM Build View Project Rules Files > Metrics Files

Initialization Resources

Application Settings INI Deploy View Project Application Settings

File Types and Location


Selection techniquesSelect individual resources for a subsequent operation by clicking on them in a File list window of the Details View. You can use standard windows selection techniques within such a window to select multiple files; for instance, use Ctrl+Click to add a series of resources to the current selection.

You can also select resources as a group by clicking on the relevant folder (e.g. a project) and then proceeding with the required option (Check Out, Get Latest, Delete, etc.).

For both file and folder selection you can also use the various select options available under the Edit menu (Select, Select All, Invert Selection).

| To find a group of resources for selection (or deselection):

1. In the Select dialog, specify a group of files by using wildcards.

For example, *.* will select all resources, *.LAR will select all resources ending in .LAR, and T*R will select all resources starting with T and ending in R (e.g. tryme.lar).

2. Click on the Select or Deselect push button.

The files matching your specification will be selected or deselected in the file list.

3. Repeat as required.

You can continue to use the Select dialog to specify further files you wish to select or deselect. Previously selected resources will remain selected unless overridden.

Host Initialization*† INI Deploy View

Printer Initialization*† INI Deploy View

Preference Initialization*† INI Deploy View

Miscellaneous Resources

Message1 LME, ECM Design View Project > Others

DOC1 Color Palette PAL Design View Project > Others

Other TXT, etc. Design View Project > Others

* Standard DOC1 INI Files can also be viewed in the Design View > Project > INI Files folder.

† These files may also be viewed in the Design View > Shared Resources folders.

File Type Extension Navigator View Folder Location

File Types and Location

Locating and selecting resources 51

Adding existing resources to a projectExisting DOC1 files will normally already be resident in the repository either within a project or the Shared folder. For such files you can choose to either Share them into the new project or create a completely independent Copy.

For non-DOC1 files you can use the Add Files option to bring them under the control of a Workgroups project. You may want to do this with any external scripts used to control DOC1 processes or similar resources.

h EXISTING DOC1 RESOURCES ARE NORMALLY BROUGHT INTO THE WORKGROUPS ENVIRONMENT VIA THE IMPORT FEATURES. HOWEVER, YOU CAN STILL USE ADD FILES TO BRING INDIVIDUAL DOC1 RESOURCES UNDER CONTROL AS REQUIRED.

About referenced resources

Many DOC1 resources can contain references to other resources. For example, a document layout will usually contain references to document objects; the document objects will themselves reference font and image resources.

When you work with share or copy resources that contain such references you can optionally include the referenced files in the function. When this option is selected Workgroups will search the current project folder for the additional resources.

SharingSharing enables you to use a resource in more than one project. By sharing a resource, as opposed to copying it, only one copy is held within the Repository. Therefore if the shared resource is updated, it is also updated within all the projects it is shared with.

Resources initially reside either in a specific project folder or, in the case of independently imported printer/browser resources and some deploy objects, in the Shared folder. To use any existing resource with a project you must share it into the appropriate project � this includes resources from the Shared folder.

Shared resources are displayed in the appropriate folders within all the projects that reference them.

! REFER TO �IMPORTING RESOURCES� ON PAGE 36� FOR INFORMATION ON IMPORTING RESOURCES FROM YOUR PRINTER/BROWSER ENVIRONMENT.

To share a resource you must be assigned the project admin. role or equivalent for both the project you are sharing from and the project you are sharing to.


| To share a resource:

1. Select the resource(s) you want to share.

See �Locating and selecting resources� on page 50 earlier in this section for details.

2. On the Repository menu, click Share.

The Share Files dialog is displayed.

3. Select the project to share into and click OK.

Use the Share Files Into Project list box to select the project which is to share the selected files.

4. Confirm share and specify options.

If you check the Share Referenced Files option all other files associated with the selected resources will also be shared into the target project.

Click OK to perform the share.

h RESOURCES THAT ARE SHARED ARE DISPLAYED WITH A �HAND� ADDITION TO THEIR ICONS IN THE DETAILS VIEW

Branching

A shared resource may be branched to create a new (unshared) resource within the project. The new resource will contain all the revision history of the shared file up to the point of the break.

| To break a share: Select the resource(s) you want to branch. On the Repository menu, click Break Share. The share is broken. This is indicated in the resource's revision history.

CopyingBy copying resources you are creating completely new versions of the selected files that will be controlled independently of the originals. Files are copied to the system clipboard from their original folders and then pasted as required into new folders. When you paste a file into a new folder you can choose to also copy any other resources that may be referenced by the selected files. Pasted files will automatically be included in the relevant folder of the selected project.

Adding existing resources to a project 53

By using the Keep Revision Histories option when you paste files you are effectively creating a branch in the repository for the selected resources. You will be able to view revisions prior to the copy and Roll Back to them for both the new and existing copies of the resource.

! SEE �MANAGING REVISIONS� ON PAGE 61 LATER IN THIS SECTION FOR DETAILS OF HOW TO WORK WITH EARLIER VERSIONS OF FILES AND PROJECTS.

| To copy resources into a new folder:

1. Select the resource(s) you want to copy.

See �Locating and selecting resources� on page 50 for details.

2. On the Edit menu click Copy or press Ctrl+C.

3. Click on the folder into which the resources are to be copied.

4. On the Edit menu click Paste or press Ctrl+V.

5. Confirm copy and specify options.

In the File Copy dialog a list of the files that are about to be pasted is presented.

If you check the Copy Referenced Files option all other files associated with the resources on the clipboard will also be pasted into the new project.

Check Keep Revision Histories if you want to be able to work with earlier versions of the copied resources.

Click OK to perform the paste.

h IF REQUIRED YOU CAN COPY THE RESOURCES FOR AN ENTIRE PROJECT INTO A NEW PROJECT. USE TOOLS/COPY PROJECT FOR THIS PURPOSE.

Adding resourcesUse the Add Files option to bring any type of existing resource � either known DOC1 file types or otherwise � under the control of a project. Any number of files can be added at the same time; files added are automatically filed into the relevant folders within the selected project with all non-DOC1 files being placed in the Others folder.

If you wish to work with the new resources straight away, you have the option to check them out of the repository immediately after they have been added. You can also have Workgroups delete the originals from the local file system once they have been brought under Workgroups� control.

| To add files to an existing project:

1. Select the project that the files should be added to.

2. On the File menu, click Add Files.


3. Select files to be added

Use the Add files dialog to locate the required file(s). Click on the Open push button when you have finished.

4. Add history comment.

In the Adding dialog, enter a Comment that will be used for the initial revision in the repository.

5. Specify options.

Check Remove Local Copy and Check Out Immediately if required.

Click OK to complete the operation.

Adding existing resources to a project 55

Viewing and editing resourcesFor individual resources you can use the View or Edit options directly to work with a selected resource. This will place a copy of the file into the working folder and open it in the appropriate editor. If you used the Edit option you will be able to make changes and then use the Check In option to return the updated resource to the Repository once you have finished with it.

h IF A COPY OF A RESOURCE SELECTED FOR EDIT ALREADY EXISTS IN THE WORKING FOLDER (I.E. YOU HAVE ALREADY CHECKED OUT THE FILE) THAT COPY WILL BE OPENED.

Many DOC1 resources have interdependencies to other resources and before you can work with them all referenced resources must also be available in your working folder or the Shared folder. A document layout for example, normally requires at least a data format file and a range of document objects. When you work with such resources it may be easier to get local copies of all project resources or other file groups rather than work out the individual files required. You can use Get Latest on a folder to do this.

If you want to prevent others from amending resources while you are working use the Check Out option on files or folders. As well as placing the resource(s) in your working folder this also locks them out in the repository.

When resources are checked back into the repository you should add a comment about the changes you have made. The files are removed from the working folder unless the Leave Copy On Local Drive option is selected.

If you have locked out a resource from the repository, but no longer want to edit it, use the Undo Check Out option. This will release the lock that you currently hold on the file(s).

! FOR INFORMATION ABOUT EDITING INITIALIZATION FILES REFER TO �CREATING AND EDITING INI OBJECTS� ON PAGE 79 IN THIS GUIDE.

| To view or edit an individual resource:

1. In the Details view select the resource to be edited.

2. On the Edit menu, click View file or Edit file.

If the file type is unknown, the Windows default Open With dialog will prompt you for a program with which to open the file.

3. Make the required changes in the editor and then close it.

h WHEN EDITING APPLICATION RULES (LAR) IN THE ALE YOU SHOULD �EVALUATE ALL� PRIOR TO SAVING AND RETURNING THE FILE TO THE WORKGROUPS ENVIRONMENT.


| To prepare multiple files for viewing or editing:

1. Select the resource(s) you want to get.


2. On the Repository menu, click Check Out or Get Latest.

Check out makes all selected resources available for edit and locks them to prevent access by other users until they are checked back in.

Get latest makes a read only copy of the resources which can be viewed as required and is made available for reference by other resources.

3. Use the View or Edit options as required.

| To check in resources after editing:

1. Select the resource(s) you want to check in.


2. On the Repository menu, click Check In.

3. Enter an appropriate comment for the revision history.

In the Check In dialog box use the Description of Changes field to enter the comment. If you are returning more than one resource, note that the Check In dialog will appear for every file you have selected unless you check the Use the Same Comment For All Files option.

| To undo check out select the resource(s) and on the Repository menu, click Undo Check Out.

Double clicking on a specific resource has a default action of either view or edit. These shortcuts carry out all the required steps required to load a file into the editor ready for use. Use Options to define what action you want performed when you double click.

� View read only - select this option to get the latest copy of the resource and open in the appropriate viewer whenever you double-click on a resource. The appropriate rights are required.

� Edit - select this option to check out the resource and open in the appropriate editor whenever you double-click on a resource. The appropriate rights are required.

� Edit if allowed else View read only - select this option to check out the resource and open in the appropriate editor whenever you double-click on a resource. However, if this is not possible, due to restricted access rights or because it is already checked out, a read-only copy will be displayed instead.

Using double click as a shortcut to view or edit

Viewing and editing resources 57

Managing resources

Viewing propertiesYou can display a resources property to get detailed information about it. The properties notebook provides details of the current revision of the file, all projects that share it and any other resource files that reference it.

For document objects the properties notebook has an additional page that lets you view and, if necessary amend the label, key and description fields used to identify the object in the various DOC1 editors.

h PROPERTIES CAN ALSO BE DISPLAYED FOR PROJECT FOLDERS. SEE �CREATING AND MANAGING PROJECTS� ON PAGE 33 FOR DETAILS.

| To view the resource or project properties:

1. Select the resource(s) you want to work with.


2. On the File menu, click Properties.

3. Click on the relevant tab to display the required information.

RenamingDepending on your access rights you can rename resources and document object sections.

Many DOC1 resources can be specifically referenced by name within other files. Where this is the case the referencing files will also need to be updated with the new name if you want to change it. You will be presented with a list of the relevant links so you can decide to proceed or otherwise.

| To rename a non-referenced resource:

1. Select the file in the Details view.

2. On the Edit menu, click Rename.

3. The name becomes editable in the Details view.

Amend as required and press Enter.

| To rename a referenced resource proceed as 1 and 2 above. The Rename dialog will automatically appear if a referenced resource has been selected. This will either list the files that reference the resource or, if the resource is referenced within more than one project, the projects that are affected. In the


latter scenario you can select a project from the list and use the Details button to view the specific files that reference the resource. If you are happy that the resource can be renamed use the New Name field and press Rename to action.

| To rename a document object section:

1. Select the document object library.

Ensure that you have already checked out the document object library.

2. On the Edit menu, click Edit Section.


3. Select the section from the list and click on the Rename push button.

The New Section dialog is displayed.

4. Rename the section as desired and click OK.


Deleting and restoringDepending on your access rights you can delete projects, resources and document object sections.

Deleting a resource that is shared across projects will delete only the reference to that resource within the currently selected project.

Deleting a resource that is referenced within other files � e.g. a document object that is included in a document layout � will result in a warning dialog that lists the association(s). In such circumstances you can only proceed with the deletion if you specify a replacement file for the resource you are deleting.

Deleted objects are actually retained in the repository and can be recovered until they are permanently purged.

h IF YOU HAVE DELETED AN ENTIRE PROJECT NEITHER IT NOR THE NON-SHARED RESOURCES IT CONTAINED CAN BE RECOVERED FROM WITHIN WORKGROUPS. HOWEVER, IT MAY STILL BE RECOVERABLE IN THE REPOSITORY ITSELF. REFER TO YOUR DOCUMENTATION FOR YOUR CHOSEN REVISION CONTROL SYSTEM FOR DETAILS.

| To delete currently selected resource(s) or project:

1. Select the project or resource to be deleted in the Navigator.

2. On the Edit menu, click Delete.

3. Confirm delete.

If you have selected a file that is referenced within other files the Delete dialog is displayed. In order to continue deleting the file you must use the New file to reference list to choose a replacement file.

Managing resources 59

| To delete a document object section:

1. Select the document object library.

Ensure that you have already checked out the document object library.

2. On the Edit menu, click Edit Sections.


3. Select the section from the list and click on the Delete push button.


| To restore a previously deleted a file:

1. Select the project from which the file was deleted in the Navigator.

2. From the File menu, click Properties.

3. Select the resource to be recovered

Click on the Deleted Files tab and select the file from the list.

4. Click Restore.


Managing revisions

Workgroups uses the concept of revisions to control and access earlier versions of resources. Normally, you will be working with the latest revision of a resource file � View and Edit and other options automatically assume this to be the case.

Bear in mind the effect updating or rolling back a shared file

might have. A project revision will always reference the latest

version of all shared files

When you create or import a new resource using Workgroups you are generating a new file within the repository. Every time a resource is checked back in to the repository following an edit a new revision of the file is automatically created. Whenever you Edit or Get a resource Workgroups gets the latest revision of the file from the repository for you to work with.

Workgroups also allows you to create revisions of entire projects. Project revisons are a snapshot of the resources being used by the project at the time the revision is created. They contain an index to the files being used plus the relevant revision information. Note that project revisions are created only on request so

About revisions

File1(all)

File2(all)

File3(all)

File4(all)

File5(all)

File6(all)

File7(all)

File8(all)

File9(all)

File4(2)

File6(2)

File4(3)

Project'Bill'

revision 1

File1(1)File4(1)File5(1)File6(1)File8(1)

Project'Bill'

revision 2


File9(1)

File5(2)

File4(5)

File4(4)

Project'Bill'

revision 3

File1(1)File4(5)File5(2)File6(2)File8(1)File9(1)

Project Roll back torevision 2 creates

project revision 4 and new file revisions

File5(3)

File Roll back torevision 3 creates

revision 5

Project'Form'

revision 7

File2(5)File6(2)File7(3)

Project'Form'

revision 6

File2(5)File6(1)File7(3)

The highlighted file versions could not be rolled back with a project but are still

available as file revisions

Repository

File8(2)

File3(1)

Initialfiles

Create/Include

Edit Edit Edit Edit Edit CreateEdit Edit

it is perfectly possible for particular file revisions to not be included in any project revision.

You can use the Get feature to view an older revision of any file if you need to but bear in mind that this will be read-only. To actually work with older versions of resources you will need to Roll back either individual files or an entire project as required. Roll back copies the file(s) from the selected revision into a new ('latest') revision.

Files that are shared across projects can also be rolled back. Be aware that a project revision will always capture information about the latest revision of a file even if it has not been changed by the current project.

CreateEdit

Project'Bill'

revision 4


61

Using the Show Revisions option you can work with earlier version of individual files or entire projects as required.

File revisions are maintained automatically by Workgroups but project revisions are only created when you specifically request them. Consider creating project revisions during the various phases of developing an application and to bookmark implemented versions.

Use the Show Revisions option to display a list of all revisions of a resource. You can then get a copy of a specific revision of a resource or project using the Get push button. This places a read-only copy of the selected revision into the working folder for viewing or deploying.

To work with earlier revisions of resources you will need to restore them as the latest revision. The roll back feature is provided to do this and can be used on specific files or entire projects assuming you have created a project revision at the required point in time. Roll back takes a copy of the earlier file revision(s) and uses it to create a new Latest revision ready for editing or deployment.

To work with revisions other than when viewing you will need to be assigned the project admin. role or equivalent.

| To create a project revision:

1. Select the project folder in the Navigator.

2. From the Project menu click Create Revision.

3. In the Project Revision dialog give the revision a name.

You will probably want to use something that reflects the project status such as �Start of new project� or �System test phase�, etc.

62 Managing revisions

| To view the revision history:

1. Select the file or project folder in the appropriate view.

2. On the Repository menu, click Show Revisions.

3. The Revision History dialog is displayed.

| To view or deploy an earlier revision:

1. In the Revision History dialog (see above), select the file or project you require.

2. Click Get.

3. Use the View option to open the resource(s) in the appropriate editor(s) as required.

| To restore a previous revision:

1. In the Revision History dialog (see above), select the file or project you require.

2. Click Roll Back.

3. Specify synchronization options.

If you are rolling back a file that references other files or is shared across projects you will need to specify if these files should also be rolled back.

The Roll Back Options dialog appears in such cases and gives you the opportunity to specify the method to be used.

Refer to the following topic for more details.

4. In the Repository the appropriate revision(s) will be restored as Latest.

They will not, however, be loaded in your working folder. To work with restored files use the Get Latest or Check Out options as normal.

Revision synchronizationMany DOC1 files specifically reference other files as part of their design � for instance a document layout may include many document objects. It is likely that previous revisions of such files also used earlier versions of the referenced resources at the time they were current. Therefore, when you roll back a file you may need to decide if you want it to continue to use the most recent version of referenced resources or to roll back the referenced files to earlier revisions also.

Additionally, a file for which roll back has been requested may also be shared by more than one project. In such cases you will need to decide if the roll back is to be implemented for the currently selected project or for all projects that share it. If you decide to roll back for one project only the revision

63

control system creates a branch for the file and two separate files are effectively created. The file share is also lost at least as far as the current project is concerned.

Clearly there may be many complexities regarding revision synchronization where there are such file associations. Workgroups attempts to resolve some of the most typical requirements as a direct part of the roll back process. However, in complex cases you may need to carry out a file-by-file evaluation of requirements and roll back the resources individually to achieve your desired configuration. In particular, Workgroups will not attempt to roll back referenced files where the referenced files themselves are shared across projects.

Where synchronized roll back is possible you will be offered the following options:

Rollback this file only � only the selected file is rolled back. When it is edited or built it will use the latest revisions of the referenced file.

Rollback with default synchronization � all referenced resources will be rolled back to the revisions that were current when the selected file revision was checked in.

Rollback with custom synchronization � the Synchronize File dialog will appear and will allow the user to choose specific revisions of all referenced files.

64 Managing revisions

Implementing an application

In the Workgroups environment implementing a DOC1 application consists of three phases:

Build � some or all of the document layouts and document journals within the project folder plus the associated data format and document object libraries are compiled into the format expected by EMFE.

Generate metrics � the font and image metrics files for the application are generated based on the printer resources in the project folder. Where metrics have previously been generated this step is optional unless you have added new resources to the application. In a scenario where you are using Windows resources or resources which are available during the build process then resource metrics are generated automatically.

Deployment � a new EMFE Initialization File is optionally created based on the INI objects indicated; 2) the complete set of resources required by the application or a subset are exported to the specified host location.

To perform any of these actions you will need to be assigned the project admin. or operator roles or equivalent.

Deploy

Build

Application Rules(LAR)

DataFormat(LDF)

DocumentObject Libs

(LOLs / CATs)

Workstation Resource Files

EMFEDeployObjects

PrinterResources

EMFEINI File

Create INI

HostResource

Files

Otherselected

files

EMFE Files onHost systemTransport

Font and Image Metrics

Generate Metrics

65

BuildingThe Build option uses the resources in the current project to create a set of DOC1 Production Rules Files to be used by EMFE in the production environment. Before you build you will need to use Project Settings to customize the build environment for each application.

A single Workgroups project can maintain multiple DOC1 applications in that it can include many document layout and document journal files and you can choose those that are to make up the EMFE application rules file (.EAR) at build time. Using the Build Configurations page you can create different configurations which specify a subset of the available layouts and journals to be used when building. Also use this page to specify a base file name to be used for the complete set of Production Rules Files that are produced when a particular configuration is built.

h BY DEFAULT A NEW PROJECT HAS A SINGLE BUILD CONFIGURATION THAT INCLUDES ALL LAYOUTS AND JOURNALS AND HAS AN OUTPUT NAME THAT MATCHES THE PROJECT NAME. OLDER PROJECTS THAT HAVE NO CONFIGURATIONS WILL ALSO BE TREATED IN THIS DEFAULT MANNER. IF MULTIPLE CONFIGURATIONS HAVE BEEN CREATED THE ACTIVE CONFIGURATION AS DEFINED IN �PROJECT SETTINGS DIALOG� ON PAGE 123 WILL BE USED AT BUILD TIME.

The General page of the Project Settings dialog allows you to manage resources required to present the application output on the printer/browser, i.e. fonts, images and overlays. Refer to the Printer/Browser Resources section in the Designers Guide for further information

The Build page of the Project Settings dialog allows you to customize what EMFE options are to be used when the project is built. These include identifying the host type (ASCII or EBCDIC based), the enablement of parallel processing and other run-time options.

The Custom Build page allows you to specify external routines that can be executed before and/or after the build.

The build process takes the selected document layout and document journal file plus their associated data format file and document object libraries and compiles them into the format expected by EMFE. Note that where multiple application rules or document object libraries are included these are combined into single files as required by EMFE.

Once the build process has been completed, using the Build option again will only rebuild using those files that have been updated since the last build. This is intended to make the build process as quick as possible but, if for any reason you want to regenerate the Production Rules Files using all project files, use the Rebuild All option.

66 Implementing an application

| To set the build options for an application:

1. Select the project folder from which the application is to be built.

You can use the navigator in either Build or Design views for this.

2. On the Project menu, click Project Settings.

The Project Settings dialog is displayed.

3. Within the General tab, select the required resource file options.

Check the Reference resources directly from the Shared Resources project option if you want your project to reference resources from the shared resources project. It is recommended that this option is selected if your projects use common fonts, this will reduce the number of repeated font definition files.

Check the Allow use of Outline Fonts option if you want to use Windows fonts in the application design process.

Check the Use Resource Packs option if you want to use the resource pack feature when creating the desired output datastream. Note that the resource pack feature is available for supported output datastreams.

! REFER TO THE PRINTER/BROWSER RESOURCES SECTION IN THE DESIGNERS GUIDE FOR FURTHER DETAILS ON DOC1 RESOURCE HANDLING AND THE RELEASE NOTES FOR OUTPUT DATASTREAMS THAT SUPPORT THE RESOURCE PACK FEATURE.

4. Within the Build tab, select the required build options

Check the Convert for EBCDIC host option if Production Rules Files are intended for OS/390 or OS/400.

Check Parallel-enabled Rules if the application is intended to run in Parallel Mode on the host system. You will also normally want to check the Abort EMFE on... options when preparing for Parallel processing.

Make sure that Create EMFE Ready files is checked unless you want the build to produce Intermediate format Production Rules Files. Intermediate Production Rules Files are required if your installation is using a bespoke method to control document objects outside the normal library construct.

All other options are intended to assist you with trouble shooting. application problems. These may be useful when developing the application but note those that directly influence EMFE processing may have an adverse effect on performance. Be sure to disable them when creating Production Rules Files ready for production.

5. Specify any pre or post build commands.

If required, use the Custom Build page to specify any external routines to be called in association with the build process. These must be coded as command calls that are acceptable on the Windows command line

Building 67

6. Specify resources to be used when building.

If you do not want all layouts and journals in the project to be included in the build use the Build Configurations page to create a custom selection.

! SEE �PROJECT SETTINGS DIALOG� ON PAGE 123� FOR DETAILS OF ALL BUILD OPTIONS. REFER TO THE PRODUCTION GUIDE FOR COMPLETE INFORMATION ABOUT THE EMFE ENVIRONMENT.

| To create a Build Configuration:

1. Invoke Project Settings as above and select the Build Configurations page.

2. Click Add.

3. Give the configuration a name in the Build Configuration dialog.

Pressing OK creates the new configuration and makes it �active�.

4. Select the files to be used when building the configuration.

Use the lists in the Build Configurations page to select from the document layout and document journal files available in the project. Check the required files.

5. Specify an output file name.

The name specified will be used as the base name for all three Production Rules Files created by the build.

| To delete a Build Configuration make it Active in Project Settings and select Delete on the Build Configurations page.

| To build or rebuild a project:

1. From the Build View, select the project folder from which the application is to be built.

2. Verify build options

Use Project Settings to check that Build options are suitable and that the required Build Configuration is Active. See above.

3. On the Project menu, click either:

� Build � to build only the rules that need updating.

� Rebuild All � to rebuild all the rule files.

If you have selected the Use Resource Packs option from the Project Settings General tab and the output datastream supports the resource feature then the Build Rules dialog will be displayed. This details the output datastream to be generated together with resource pack details. You can update an existing, or create a new resource pack. You can also include additional resources, i.e. fonts, images and overlays, in the resource pack. Tick the option and press the Select button to specify the resources to be added.


Whilst the build is processing the build log file is displayed in the Build Output window. This reports whether the build was successful or if any errors were reported.

If successful, the Production Rules Files are added/updated in the Working Folder and displayed in the Navigator Build View folders.

h IMPORTANT NOTE: THE PRODUCTION RULES FILES ARE NOT ADDED TO THE REPOSITORY AUTOMATICALLY AS YOU WILL NORMALLY WANT TO TEST THEM BEFORE PLACING THEM UNDER REVISION CONTROL. YOU CAN USE THE USE LOCAL FILES OPTION AS PART OF THE DEPLOY PROCESS WHEN FILES ARE IN THE WORKING FOLDER. ONCE YOU ARE HAPPY WITH THE NEW RESOURCES YOU CAN USE THE CHECK IN OPTION TO BRING THE PRODUCTION RULES FILES UNDER REVISION CONTROL IF REQUIRED.

REFER TO �WORKING WITH RESOURCES� ON PAGE 45� FOR MORE INFORMATION ABOUT ADDING FILES TO THE REPOSITORY.

Building 69

Generating metricsEMFE uses font and image metrics files to supply information about external resources used by applications. In order to ensure no loss of performance the metrics files are generated in advance of the application being executed.

If you are using resources available to the Workstation during the build process and the output datastream generated supports the resource pack feature then metrics can be generated automatically. Refer to the "Printer/Browser Resources" section in the Designers Guide for an in depth discussion on resource handling within the DOC1 environment.

The primary function of resource metrics files is to provide dimension data relating to fonts and images used in an application. In some circumstances metrics files are also used to provide a mapping of resource names which can be useful, for instance, if you want to use the same application rules to produce different datastreams or if you need to specify special codes for PCL, PostScript or PDF datastreams.

Unless your project uses only the resources supplied with DOC1 distribution material you will need to generate metrics files before an EMFE application can be run. Once this is done however you should only need to regenerate metrics if new font or image resources are added to the project.

h IF YOU ARE WORKING WITH THE PRINTER RESOURCES PROVIDED WITH DOC1 DISTRIBUTION MATERIAL YOU MAY STILL WANT TO BRING THE RESOURCE FILES AND/OR THE ASSOCIATED METRICS FILES UNDER REVISION CONTROL. ADD THEM TO THE SHARED RESOURCE OR PROJECT FOLDER AS REQUIRED.

To generate the correct metrics Workgroups needs to know what output datastream you will be generating in the production environment and what resolution font and image resources are being used. The required resolution is expressed as a dots per inch (dpi) value. This information is provided as part of a output datastream INI object which is discussed in full later in this section.

Metrics are generated on a per project basis. When you request metric generation all font and image resources of the relevant type referenced by the selected project will be included in the process. Metrics generation produces one font metrics file and one image metrics file containing all the required tables.


Original or Workstation resources?You will need to decide whether font metrics are to be generated using the original printer/browser resources or the equivalent LarMeta files that are created when fonts and images are converted for use with the DOC1 Workstation.

The best method may vary according to your circumstances but generally the decision will depend on the output your application intends to generate.

AFPDSWorkstation resources normally produce accurate results but some minor differences in character spacing may occur particularly for right or fully justified text. Additionally you should not use Workstation resources if the target output device uses a resolution different from the AFP fonts originally imported. If in doubt use original resources. The resolution will vary depending on the target printer/browser.

Xerox MetacodeDue to fundamental differences between the way metrics information is stored within Xerox FNT resources and LarMeta fonts you should always use the original printer resources to generate font metrics. The resolution is usually 300 dpi.

Postscript and PDFAlways use original resources. Workgroups is able to use either Adobe font metrics files or PostScript font files for this purpose. Resolution must be 72 for PDF but will vary according to the target printer for PostScript output.

HTMLUse Workstation resources. Resolution must be 96.

PCLPCL output always uses converted resources originating from one of the other supported printer/browser environments and has no separate metrics requirements of its own.

LineDataIf you are using LineData to create a representation of output for another datastream ensure you use the same metrics as used with the original output. Otherwise use Workstation resources.

h USERS FAMILIAR WITH THE STANDARD DOC1 ENVIRONMENT MAY KNOW THAT MORE THAN ONE UTILITY IS PROVIDED WITH WHICH TO GENERATE METRICS IN SOME SCENARIOS. THE UTILITY USED DEPENDS ON THE TYPE OF RESOURCE AND THE INTENDED HOST PLATFORM. WORKGROUPS AUTOMATICALLY DECIDES WHICH UTILITY TO USE BASED ON PROJECT SETTINGS AND THE RESOURCE FILES WITHIN THE PROJECT FOLDER.

Generating metrics 71

| To generate metrics files for a project:

1. Create a output datastream INI object.

If it has not already been done create a output datastream INI object that indicates your target output datastream and the resolution of resources being used. See later in this section for details.

2. From the Build View, select the project folder from which the metrics are to be built.

3. On the Project menu, click Generate Metrics.

4. Define Metrics generation options.

In the Metric Generation dialog, select the appropriate output datastream object from the list.

Enter a file name. This is used as the base name for both Font and Image Metrics files.

5. Select whether you wish to use the original printer resources or the converted Workstation resources.

6. Click OK.

The metrics for the selected file(s) are generated and placed within the project folder.

| To protect metrics files from inadvertent change:

1. Select the project the metrics files relate to.

2. On the Project menu, click Project Settings.

The Project Settings dialog is displayed and allows you to specify project settings that customize the way Workgroups behaves when processing a project.

3. On the Metrics tab, select the Never generate metrics option.

4. Click Apply.

Users will not be able to regenerate the metrics files for the selected project.


Editing metrics filesOnce you have generated your resource metrics tables you may need to edit them to cater for certain special requirements. Mostly this is done to map resource names where the resources in the target printer environment have different names than those specified for the application or to indicate that a resource needs to be dealt with in a special way.

Metrics tables are text based and can be amended by any standard editor. Be sure not to use a word processor that may add control codes to the file.

You may need to edit metrics tables in the following circumstances:

� To specify alternative references �

If the names of resources used when designing the application are different to those actually present in the printer/browser environment you can use the appropriate entries in the metrics files to provide a link between the two names.

� To identify non-standard resources �

Occasionally you may need to change the resource type keyword created by default in metrics file entries. The three most typical scenarios and the associated keywords are:

� A font has been excluded from normal code point translations when creating the application.

� Metrics relate to a Xerox Logo resource (.LGO file) being used as an image. Although LGO files can be in either a font or image format the *LOGO keyword is only required when dealing with image metrics.

� Image metrics relate to an overlay. If Xerox overlays are used the final parameter in the relevant image metrics table will need to indicate a count of the fonts used by the overlay.

� To define positional characters �

The �space� and �period� characters are used as part of the DOC1 measure and tab leader features. For most fonts � including all Latin based resources � these characters are consistently located and DOC1 can use them without user intervention. However, for some non-Latin based fonts you may need to identify these characters explicitly in the relevant font metrics table.

| To edit a metrics file double-click on it in the Navigator. The system editor will be invoked with the file loaded.

h DO NOT CHANGE METRICS FILES USING A WORD PROCESSOR AS UNEXPECTED CONTROLS MAY BE INCLUDED IN THE FILE.

Generating metrics 73

The following is an example of the general structure of DOC1 metrics tables. Parameters that may need to be manipulated are in bold. Optional parameters - i.e. not generated by the metrics utilities - are in italics. Refer to the following sections for details of the various requirements.

Font metrics:

Image metrics:

*FONT or *IMAGE These are the usual keywords indicating the start of a font and image table respectively. Other keywords are used to indicate non-standard resource types such as *OVERLAY and *EPS.

*FONT01P=X0FONT01& *IMG1P=X0IMG01

These are examples of specifying alternative resource references. The first parameter is used as the printer/browser resource name - i.e. the name that will be included in the actual output datastream. The second parameter is the logical name of the resource - i.e. that used when designing the application. The logical name is used to identify the entry for the appropriate resource in the metrics table and must therefore be unique. If only one parameter is specified this will be used for both purposes.

64 66 These optional parameters identify ‘positional characters’. They represent the code points of the ‘space’ and ‘period’ characters respectively.

3 If Xerox overlays are used, the final parameter in the relevant metrics table will need to indicate a count of the fonts used by the overlay.

*EPS If Encapsulated PostScript files are used, this parameter determines the way in which EPS files are to be embedded in the printstream. There are two possible values for this keyword, INLINE and REFERENCE.

All other parameters should not be manually altered. The exception to this is where image metrics entries need to be coded by hand if the resource cannot be made available to DOC1 metrics utilities.

What to change in a metrics file

*FONT=FONT1P=X0FONT01 34 27 39 240 0 64 66

*IMAGE=IMG1P=X0IMG01 120 90 300*OVERLAY=OVER01 1000 750 3


DeployingDeployment of an application from Workgroups consists of two functions:

� Creation of the Initialization File (INI) to be used by EMFE (optional).

� Transport of the INI and the set of Production Rules Files generated by the Build process plus any other selected files to the Host environment.

h USERS FAMILIAR WITH THE STANDARD DOC1 ENVIRONMENT MAY KNOW THAT MORE THAN ONE UTILITY IS PROVIDED WITH WHICH TO GENERATE METRICS IN SOME SCENARIOS. THE UTILITY USED DEPENDS ON THE TYPE OF RESOURCE AND THE INTENDED HOST PLATFORM. WORKGROUPS AUTOMATICALLY DECIDES WHICH UTILITY TO USE BASED ON PROJECT SETTINGS AND THE RESOURCE FILES WITHIN THE PROJECT FOLDER.

Before you deploy you will normally want to create the INI objects that contain settings that are to be used when building the EMFE Initialization File for a particular application. You may also need to specify networking information for the systems to which files are to be transported.

Deployment settings are controlled from the Deploy view of the Navigator.

About INI objectsINI objects allow to specify the keywords and values to be included in the EMFE Initialization file (INI) that will be created for an application by the deploy process. There are four types of INI object � Output Datastream, Host, Preferences and Application Settings � representing the main types of section that can be specified in the INI file. You will need to add at least one Section to each INI object and specify the appropriate keywords and values within it.

h WHEN WORKING WITH INI OBJECTS BEAR IN MIND THAT MOST KEYWORDS HAVE DEFAULT VALUES THAT WILL BE ASSUMED BY EMFE IF THEY ARE NOT PRESENT IN THE INI FILE.

Host objects have dual purpose. As well as providing keywords and values for the INI file they also allow you to specify the system settings to be used when Workgroups transports the application files to the host system. Additionally the list of files that are to be deployed and the deployment locations are assumed from the keywords/value in the Files section included within the Host object assigned to the application. If required you can specify substitution variables rather than fixed names so that the locations are customized every time the object is specified for deployment. See �Host objects� on page 76 for details.

INI objects can either be created in the Shared Production Engine Settings folder and then shared into an application folder or you can create objects specifically for an application directly within its folder. Application folders automatically exist for each Build Configuration previously created for a project.

Deploying 75

! FOR DETAILED INFORMATION ABOUT INI KEYWORDS THAT ARE DEFINED WITHIN THESE OBJECTS REFER TO THE PRODUCTION GUIDE.

Application Settings objects

These objects define the keywords/values to be used in the sections of the INI file that relate to the special requirements of a particular application on the host system. The settings required will vary from project to project. Some applications will be able to use the default settings entirely and will not require an application object.

Application objects contain settings for:

� how much of the application data file is to be processed and what checkpointing options are to be used (InputData section)

� the level of exception messages that can be issued (Exception section)

� what validation of application data is to be performed (ExtendedInputValidation section)

� interaction with Message1 if this product is used with the application (Message1 section).

Host objects

These objects define the keywords/values to be used in the sections of the INI file that relate to the system on which EMFE will process the application � the �host�. Although you may be able to use the default settings for some projects you will typically need to create an object for each host machine on which you intend DOC1 applications to run.

h HAVING CREATED A HOST INI OBJECT YOU CAN THEN USE IT TO DEFINE DETAILS OF THE SYSTEM TO WHICH APPLICATIONS USING THE OBJECT WILL BE TRANSPORTED WHEN DEPLOY IS USED. THIS IS SPECIFIED AS PROPERTIES OF THE HOST OBJECT. REFER TO �CONFIGURING TRANSPORT SETTINGS� ON PAGE 82� IN THIS SECTION FOR DETAILS.

Host objects contain settings for:

� specifying your DOC1 license keycodes required by all applications (LicenceInfo section)

� the DOC1 files and optionally their locations to be used (Files section)

� identification of text translation tables (System section)

� system memory options (System section)

� Server Mode specific options (System and ServerCommands sections).


The entries in the Files section are also used to provide default settings for the actual deployment process. By default, all files listed will be deployed to the locations indicated. For instance of you have an entry such as Rules=\\MainServ\DOC1\prodres, the EMFE EAR file will, by default be transported to the DOC1\prodres directory on MainServ. You can choose not to deploy a particular file, to deploy additional files and change the default locations as required. See �Initiating deployment� on page 83 in this section for details.

Additionally, you can use substitution variables with Files values to customize the default deployment locations according to circumstance. You can use any of the following variables as part of a location string to build up a valid path, for instance Rules=\\MainServ\%P\%A.

Preference objects

Preferences allow you to customize the way EMFE and PCE present certain types of data and are particularly used when an application produces multi-lingual text. Preferences customizes:

� the format of standard text types such as the wording of dates and numeric separators.

� a range of user defined values that are used wherever your application uses the associated environment variables.

Variable Function

%F The file name as it is stored in the repository. This is the default value for all keywords when a Files section is created.

%I As above except the file extension is excluded. Useful when deploying to OS/390 or OS/400, for instance you could code

Rules=USER001.DOC1FILES(%1)

%P Project name.

%A Application name (the name of the active Build Configuration at deploy time).

%D System date at time of deployment – format is ddMMMyy (e.g. 03AUG98).

%R Revision number of file being deployed.

%B Current build number of Workgroups.

Substitution variables for use in Files section keywords

Deploying 77

Up to nine Preferences sections can be inserted into Preference objects exactly reflecting the structure in an INI file.

! THE USE OF PREFERENCES SECTIONS IS DICTATED BY THE LOGIC IN THE APPLICATION RULES BEING USED. REFER TO THE DESIGNERS GUIDE FOR DETAILS OF THIS FEATURE.

Output Datastream objects

These objects define the keywords/values to be used in the sections of the INI file that relate to the various types of output that can be produced by EMFE.

Output Datastream objects contain settings for:

� identification of the datastream to be produced by EMFE (PrintDevice section).

� customizing the datastream such as specifying AFP color settings, Metacode JDE/JDL names and password settings for PDF output and so on (choose the appropriate section: AFPDS, Metacode, PostScript, PDF, PCL, HTML, LineData).

! REFER TO THE PRODUCTION GUIDE FOR MORE INFORMATION ABOUT THE OUTPUT DATASTREAMS SUPPORTED BY DOC1 AND ANY SPECIAL CONFIGURATION REQUIREMENTS YOU MAY NEED TO BE AWARE OF.


Creating and editing INI objectsThe Deploy View automatically has a folder for each project known to the repository. Within these there will automatically be an Application Settings folder for each Build Configuration defined for the project. Refer to �Building� on page 66 for details of setting up Build Configurations. There will always be a Shared Production Engine Settings folder.

Each application folder can have one (only) of each type of INI object. You can choose to either share an existing object from the Shared folder or create one specifically for the application.

Within each INI object you will need to create at least one Section of the appropriate type. Sections contain the actual keywords and values that will be used in the INI file. These mainly (but not exclusively) follow the conventions of the actual INI file structure. When you are working with Sections an INI Editor window will appear in the Details View. Some keywords with default values are assumed automatically and displayed in the Editor when you create the relevant Section � you can change the values as required. For other keywords you will need to explicitly add them to the Section using the features of the INI Editor.

Deploying 79

| To create an INI object:

1. Select a folder within the Deploy View.

You can add a INI object to either to the appropriate sub-folder within the Shared folder or, for a non-shared object, to a specific application folder within a project folder.

To add objects to an application folder it must first be Checked Out of the repository. From the Repository menu, click Check Out.

Click on the required folder.

2. On the Insert menu, click the required object type.

Output Datastream, Host, or Preference objects can be inserted either into the appropriate Shared folder or any application folder. Application Settings can only be inserted into an application folder.

3. Give the object a name.

Overtype the default name that appears in the navigator and press enter.

| To create sections in an INI object:

1. In the navigator select the INI object where the section will be added.

2. If necessary, Check Out the object.

3. On the Insert menu, click the required section type.

You can only insert a section into the appropriate type of object: a Host section into a Host object, a Preference section into a Preference object and so on.

The relevant Section dialog is displayed.

4. Select the required Section types from the dialog list.

You can click on as may section types as required. One of each selected type will be added to the object when you click OK.

5. Check In the object.

6. Edit the new section(s)

Click on a section object to display the INI Editor in the Details View. Any keywords and values that are defaults for the section types will have been created within the section. You can then edit the values associated with these and add new keywords as required (see below).


| To add a keyword to a Section:

1. Right click anywhere in the INI Editor and select Add from the pop up menu

2. Select the keyword.

A new (blank) entry is made into the section. Use the drop down arrow in the Keyword column to display a list of keywords valid for the section type. Click on a name to select.

3. Enter a value.

Use the methods detailed in the feature below to specify the required values.

Move selected keyword up or down list

Add a new entry

Delete selected keyword

Boolean settings are represented as a check box. A checked option equates to a "YES" in the INI.

Having added a new entry, select the required keyword from the drop down list. Only keywords that are valid for the section you are working on will appear.

Select a value to be associated to the keyword from a drop down or scrolling list, or tick box. Where appropriate you can also browse for a file or enter a value via the keyboard.

Using the INI Editor

Deploying 81

Configuring transport settingsUsing the Deploy option transports the files required by EMFE to the locations specified for the Application in the Deploy View. All locations must either be available to your local file system or on the same remote system that can be accessed via FTP or APPC.

h NOTE THAT APPC IS ONLY AVAILABLE FOR USE ON OS/390. AN ADDITIONAL PROGRAM (AFTPD) IS ALSO REQUIRED. SEE �APPENDIX C: USING APPC ON OS/390� ON PAGE 140� FOR MORE DETAILS.

| To specify a host location:

1. Select a Host object

Deployment location details are specified as a property of a Host object as created in the Deploy view. If you have not already created an appropriate object do so now � see INI objects above.

2. On the File menu, click Properties.

Click on the Deployment tab of the Properties dialog.

3. Select one of the following options:

� Local � when deploy is selected the output will be transferred to a location available via the local file system. If required, you can specify a Directory which will be used to prefix the file locations specified within the application object.

� FTP � files will be deployed using FTP to the selected remote system. Select a known FTP site from the drop down list or enter a new one as either a textual (e.g. �ftp.company.co.uk�) or numerical code (e.g. �1.23.456.78�). You should also enter your user name and password as required to access the site specified.

� APPC � files will be deployed using APPC to the selected remote system. Enter a default LU Name and Log Mode as required by the target host. You should also enter your user name and password as required to access the location. Refer to�Appendix C: Using APPC on OS/390� on page 140 for details.


Initiating deploymentWhen deployment is requested an INI file is created according to the settings in the INI objects assigned to the application. This and all other selected files from the application folder are transported to the system specified in its assigned Host object. Only those files checked in the Details View will be deployed. The exact locations where the files will be delivered are indicated by the Target field for each file.

Normally the latest revisions of all files are deployed. If you want to deploy an earlier revision you will need to use the Show Revisions option for the appropriate project or file to first make the earlier versions available. You will then need to select the Local file option for the application object when deploying.

| To deploy an application:

1. Click on an application folder in Deploy View.

2. Check files and locations.

In the details view uncheck any files that you do not want to be deployed.

The Target locations specified for the files to be deployed default to the values within the Files section of the Host object assigned to the application. You can alter any of these as required before deploying.

If you are deploying files from your local system click the appropriate File Options button at the top of the page

3. On the Tools menu, click Deploy.

Information about the progress of deployment is reported in the Output Window

Deploying 83

Archiving and reporting

The revision control system underpinning the Workgroups environment provides archiving as an integral part of its function. However, Workgroups provides some features specific to the DOC1 environment that are documented in this section:

Snapshots provide the ability to generate an archive of a particular DOC1 project or other selected resource files. This allows an efficient method of backing-up or transferring files to other locations.

Archiving the user log allows you to copy the log that records user activity to a back-up location. As part of this process the log is cleared to prevent the file becoming too large.

This section also documents the project change reporting feature which allows you to identify what files were changed in a given period or between project revisions.

To perform these functions you will need to be assigned the project admin. or operator roles or equivalent.

85

Creating SnapshotsWhen you create a snapshot of a project or set of resources you are creating an archive that contains all the selected resources. This is useful if you need to transfer resources to a location not available to the Workgroups server, including Group 1 Customer Support.

Snapshots can be created at any point of development and you do not have to select a project beforehand. However, if you do so the Snapshot wizard will automatically detect the project and automatically set the wizard options based on the selected project.

Once a snapshot file has been created for a project you can keep it up to date by including files that have changed or been added since the last time the utility was run against the project.

Export Snapshot also allows you to use FTP to send a new or existing snapshot file to a server.

86 Archiving and reporting

| To create a new snapshot:

1. Select the project, folder or resources you want to copy.

2. On the Tools menu, click Export Snapshot.

The Export Snapshot wizard is displayed.

3. Select Create a new snapshot, only and click Next>.

4. Enter a snapshot name and use the browse push button to select a path where the snapshot will be created.

5. Select the files or file types that you want to include in the snapshot.

will select all files, and

will invert the selection.

Once highlighted click on a check box to select.

6. You can choose to only include files that have changed since a previous snapshot was created.

7. Click Finish to create the snapshot. Once complete the wizard is closed.

| To create a new snapshot and send it using FTP:

1. Select the project, folder or resource(s) you want to copy.



3. Select Create a new snapshot and send it to someone (using FTP).

Click Next>.

4. Follow instruction 4-6 above for creating a snapshot.

Click Next>.

5. Select an FTP site from the drop down list or enter new details.

If you select a site from the drop down list the User name, password and location on FTP site are displayed as previously set and should be checked and updated as necessary. However, these fields are left blank if you have selected �Group 1 Customer Support� as the settings can not be changed. All list entries originate from any FTP sites that you have previously configured in the Deployment Options or Snapshot.

A new FTP site address can be entered as either textual (e.g. �ftp.company.co.uk�) or numerical (e.g. �1.23.456.78�). You must then enter your user name and password (if one is required). You should also enter the directory path (if known) on the FTP site where the snapshot will be placed.

6. Click Finish to create and send the snapshot. Once complete the wizard is closed.

Creating Snapshots 87

| To send an existing snapshot using FTP:

1. Select a project, folder or resource.



3. Select Send a snapshot that you created before to someone (using FTP) and use the browse push button to locate the file.

Click Next>.

4. Follow instruction 5 above for specifying an FTP site.

5. Click Finish to send the snapshot. Once complete the wizard is closed.

When you have created a snapshot, you can manually extract the files from it and add them into a different Workgroups repository.

| To import a snapshot file:

1. Open a Windows Command prompt and browse to the <Workgroups>\dllexe directory.

2. Type:Gzixfr -x <snapshot_file> <output_directory>

wheresnapshot_file is the path and filename(.gz) of the snapshotoutput_directory a temporary directory for the unpacked files.

3. In Workgroups, use the Add Files option to add the unpacked files to a project, see �Adding resources� on page 54. Note that the snapshot file (.gz) and its package file (.pkg) should not be added.


Archiving the user logThe options on the Log Files page of the Options dialog allow you to specify archive options for the log file. The log file contains a log of events for the currently logged on user, such as messages displayed in the Repository Output and reports displayed in the Build Output. This file can become very large and should be archived on a regular basis.

The working log file is located under your Workgroups installation directory as �USERID.LOG�.

| To set Log File archive options:

1. On the Tools menu, click Options.

The Options dialog is displayed and allows you to specify system-wide options that customize the way Workgroups behaves.

2. Click on the Log Files tab.

3. Select an archive option (i.e. how often the log file archive is created) from the drop down list. Select either:

� Monthly � the log file is archived on a monthly basis.

� 1 Mb � the log file is archived whenever the size exceeds 1 Megabyte.

� 10 Mb � the log file is archived whenever the size exceeds 10 Megabytes.

� Never � the log file is never automatically archived. However you should archive the file manually to avoid the file size becoming too large. To do this simply rename the .LOG file using file manager.

4. A default archive filename is provided. If you wish to change this either enter a new path and filename or use the browse push button to locate one. The default filename is �USERID.000� incrementing as each archive file is created.

Archiving the user log 89

Project change reportsThe Report Changes feature allows you to review changes that have been made to files used by a particular project. Three types of report are available:

� all changes since a particular date/time

� changes since a particular project revision

� a comparison between two project revisions.

The reporting feature is customized by using a wizard that steps through the available options.

You can use the Revision History feature to display full revision details of any file displayed by the report.

| To produce a change report:

1. Select the project that you want to interrogate.

Select the project folder using the navigator in an appropriate view.

2. On the Project menu select Report Changes.

3. Select the required report type.

The Report wizard will be displayed allowing you to choose the report type.

4. Specify parameters.

Depending on the kind of report you have selected the wizard will display a further dialog in which you specify the parameters required.

5. Display the report.

Click Finish. The changes identified by the report are displayed in the Details view.


| To view the revision history:

1. Select the required file in the Details view.

2. On the Repository menu, click Show Revisions.

3. The Revision History dialog is displayed.

| To save or print the report use the options of the File menu. The report has a default name that will be used by the Save option; use Save As to specify a custom name.

| To close the report display simply click on another object in the navigator other than the project being interrogated.

Project change reports 91

Reference

Adding dialog

Option Description

Comment Enter a brief description to be attached to the revision of the file.

Check out immediately If you wish to edit the resource(s) select this check box to check out the file(s) immediately after adding them.

Remove local copy Mark this check box to remove the local copy of the file(s). We recommend that all local copies be removed unless stored in the working folder.

Use Same Comment for All Files This check box is only displayed when more than one file has been selected. If selected the same comment is applied for all the selected files.

Add Files

Click a project folder in Design view; File menu or right click or Ctrl+Add

This allows you to add existing resources (created outside of Workgroups) to a project. DOC1 resources and non-DOC1 resources alike can be added to a project.

Before the Adding dialog box is displayed, you will be asked to locate the file(s) using the Open dialog box.

To use this feature you will need to be assigned the project admin. or designer roles or equivalent.

93

For complete information about Sections, Keywords and associated values refer to �Appendix A� in the Production Guide.


Application INI dialog

Option Description

Application INI Section Select the section you want to add from the list of host INI sections.Exception � Use to define what level of exception messages should be produced by a DOC1 application.ExtendedInputValidation � Use to define how EMFE validates application data.Files � Use to specify the file names (including paths) that are required for an EMFE, PCE or DOC1DIME application.Hyphenation � Use to provide information for automatic hyphenation within an EMFE application.InputData � Use to specify the parameters required by EMFE that govern the amount of application data to be processed and also control the intervals at which checkpoints are reported (if any).LogicalPageMap � Use to define the position of logical pages within the physical page within an EMFE application.OverrideSymbols � Use to specify symbol values that cannot be overridden by the Symbols section.Symbols � Use to specify symbol values used to substitute parameters or

Application Settings (object and section)

Deploy view; Insert menu

Application Settings is one of four INI objects that appear in the Deploy View only. Application Settings define the keywords/values to be used in the sections of the INI file that relate to the special requirements of a particular application on the host system. The settings required will vary from project to project. Some applications will be able to use the default settings entirely and will not require an Application Settings object.

Unlike other INI objects, Application Settings can only be created within an application folder of Deploy View.

Within each Application Settings object you will need to create one or more Application Settings Sections which contains the actual keywords and values that will be used in the INI file. When you are working with Sections an INI Editor window will appear in the Details View. Some keywords with default values are assumed automatically and displayed in the Editor when you create the relevant Section � you can change the values as required. For other keywords you will need to explicitly add them to the Section using the features of the INI Editor.

94 Application Settings (object and section)

parts of parameters specified elsewhere.System � Use to specify settings that govern the way in which some EMFE or PCE internal functions operate and also allows you to specify system commands that can be executed before and after an EMFE application processes.All sections are added with default keywords/values and should be updated as appropriate.

Build Rules Dialog

Option Description

Name Name of the selected output datastream

Type The �<PrintDevice> - PrintStream� value for this Output Datastream object.

Resolution The �<PrintDevice> - Resolution� value for this Output Datastream object.

Update existing resource pack The drop-list displays ALL the list of existing resource packs in the project. The selected one will be checked out and updated.

Create new resource pack The �Name� field allows the user to specify the file name of the resource pack to be created.

Include additional resources� Allows fonts, images and overlays to be included in the resource pack. Press the Select button to specify the additional resources.

Build

Click a project folder in Build view; Project menu or right click or F7

Use the Build option to create a set of rule files for the current project to be used by EMFE on the host system. This option uses the resources in the project folder to convert the Application Rules, Document Object and Data Format files to the Production Rules Files format required by EMFE on the host system. Note that the individual Document Objects are combined into a Document Object Library as required by EMFE. Once the build process has been completed, using the Build option again will only build rules for files that have been updated. If for any reason you want to regenerate all rule files use the Rebuild All option.

Note that if you have selected the Use Resource Packs option from the Project Settings General tab and the output datastream supports the resource feature then the Build Rules dialog will be displayed during the build process. This details the output datastream to be generated together with resource pack details. You can update an existing, or create a new resource pack.

To use this feature you will need to be assigned the project admin. or operator roles or equivalent.

Build 95

Check In dialog

Option Description

From Use the From entry field to specify the location of the file, folder or project on your local hard drive that you are returning to the Repository. By default, the file is assumed to be held within the project�s current Working Folder.

Use this push button to display the Open dialog. This assists you in identifying the name and location of the file required

Description of changes When resources are checked back into the repository you should add a comment about the changes you have made.

Leave copy on local drive The files are removed from the working folder unless the Leave Copy On Local Drive option is selected.

Recurse Sub-folders If a project is being checked in, files may have been placed in sub-folders of the working folder. The Recurse Sub-folders option ensures all files from sub-folders are also checked in.

Use same comment for all files If more than one resource is being checked in, select this to apply the same comment to all files. If checked, no further Check In dialogs are displayed.

Check In

Click a resource folder in Design; click a file in Details view; Repository menu or right click

Use the Check In option to return checked out resources to the Workgroups Repository after they have been updated. This will create a new revision of the resource and update the revision history.

Check Out


This will check out the latest revision of a resource or set of resources ready for editing. The file(s) are copied into the project�s current Working Folder ready for editing. If no Working Folder has yet been set, the Set Working Folder dialog is displayed.

96 Check In

Clean Working Folder

Click a project folder in Design; Project menu

Use this option to delete the files in the working folder for the currently selected project.

A working folder is the work space allocated by a user for each project they intend to work with. It is a file location where resources are stored while they are in use. It is not shared with other Workgroups users.

If the working folder contains any files that are not registered with the current project you will be prompted with a list. Selecting Yes will also delete these files from the directory.

The directory itself is not deleted.

Clear Output Window

View menu

This will clear the contents of the output window and should be used, for example, when it is becoming too full. All Output views will be cleared. The messages are also stored in the user and system log file, so can still be viewed after using this option.

Copy (and Paste)

Click a resource folder or select file(s) in Details view; File menu or Ctrl+C & Ctrl+V

Use this option to create new versions of the selected resources within other folders. Copied files are controlled independently of the originals in the repository but may optionally share the same revision history prior to the copy being taken.

Files are copied to the system clipboard and then pasted as required into new folders. The act of pasting presents the File Copy dialog for verification and option setting.

Many DOC1 resources contain embedded references to other resources, e.g. a document layout will usually reference many document objects and the document objects will themselves contain references to fonts and images. Where this is the case you are optionally able to copy and paste such referenced files along with the selected resources.

Copy (and Paste) 97

File Copy dialog

Option Description

You are about to copy... This list presents the files that were selected when the last Copy took place. If you do not want these files to be pasted into the selected folder click Cancel.

Copy Referenced Files If this option is checked all other files associated with the resources on the clipboard will also be pasted into the new project.

Update existing files If checked the selected (and optionally referenced) resources that already exist within the project will be updated.If Keep Revision Histories is checked a new revision of the existing files will be created. If Keep Revision Histories is not checked the existing files along with their history will be completely overwritten by the copied resources.

Keep Revision Histories If this option is checked a branch is created in the repository for all selected (and optionally referenced) resources. The files share the same revision history prior to the copy but thereafter will have separate strands.

Copy Project dialog

Option Description

New Project Name Enter a name for the new project name in this field. The project name must be unique and cannot contain the following characters: < > : ; | * / \ ? ì $

Working Folder Enter the path name to be used as the working folder for the new project. Note that this only applies to the Workgroups client that is making the copy - other clients will need to specify a working folder when they first access the new project. If the folder does not exist it will be created.

Use this push button to display the Browse for Folder dialog. This assists you in identifying the name and location of the folder required.

Copy Project

Click a project folder in Design; Tools menu

Use this option to create a new project based on an existing project. All design, metric and initialization files are copied and can be altered, deleted and added to as required.

The project name and working folder must be specified and the base project selected before the Create push button is enabled.

To use this feature you will need to be assigned the project admin. role or equivalent.

98 Copy Project

Base Project Select the project from the drop down list that the new project will be based on.

Check Out Immediately Select this box if you want to work with the new project immediately.

Keep Revision Histories If this option is checked a branch is created in the repository for all resources included in the project being copied. The files in the new project will share the same revision history prior to the copy but thereafter will have separate strands.

Create New Project dialog

Option Description

New Project Name Enter the new project name into this field. The Create push button will not be available until some text has been entered into this field.

Project Revision dialog

Options Description

Revision Label Use this entry field to give the new revision a name by which it will be known in revision history displays. This must be no more than 30 characters.

Create Project

Design; File menu

Use this option to create a new project. The folder structure where the resources will later be placed is automatically generated.


Create Revision


A project revision is a snapshot of project status at a given time. It contains information about the resources used by the project and their revision levels at the time the project revision was taken. If required you can roll back the revision levels for resources in an entire project to recreate an earlier status.

Project revisions are created on request and you can create one whenever required by your development strategy.

Create Revision 99

Delete warning dialog

Option Description

Filename Enter the filename that will be used to replace the embedded references with. If you do not enter a filename you will not be able to proceed.

Referenced list This list contains all files that are currently referenced by the file(s) that will be deleted.

Delete

Click a resource folder in Design; click a file in Details view; Edit menu or Ctrl+Del

Use this option to delete the selected resource(s). If you have selected a file that is referenced within other files a warning dialog is displayed. You must specify a replacement file before you can proceed.


100 Delete

Normally the latest revisions of all files are deployed. If you want to deploy an earlier revision you will need to use the Show Revisions option for the appropriate project or file to first make the earlier versions available. You will then need to select the Local file option for the application object when deploying.


Deploy

Deploy view; Tools menu or tool bar

Use this option to prepare an application ready for processing by EMFE in the host environment. Deploy has two functions:

� builds an EMFE initialization file (INI) from the INI objects assigned to the selected application;

� transports selected files for the application to the system specified as a property of its assigned Host object. Typically these will be the set of DOC1 Production Rules Files previously created by a Build and the INI file created by Deploy itself

Files to be deployed are displayed in the Details view when an application folder is selected the Deploy View navigator. Only those files checked in the Details View will be deployed. The exact locations where the files will be delivered are indicated by the Target field for each file. The defaults for these locations are assumed from the Host INI object assigned to the application.

Deploy 101

If the resource file type you have selected is not recognized, the Open With dialog is displayed. If a copy of the resource already exists in the working folder (i.e. you have already checked it out) that file will be opened.

Once you have finished editing the resource, you should use the Check In option to return the updated resource to the Repository. You cannot edit a resource that is already checked out by another user.

Note that in order to prevent possible Build errors, when editing an application rules file (LAR) in the ALE you should Evaluate prior to saving and returning the file to the Workgroups environment.


This can only be used on Document object libraries that have been de-constructed into individual document object files. Ensure that you have already checked out the document object library and select the object in the Details view.

Upon selecting this option, the key field becomes editable in the Details view. Amend as required and press Enter. The new data is only saved to the repository once the object is checked in.


Edit File

Click a resource folder in Design; click a file in Details view; Edit menu or right click

Use the Edit option to update a selected resource. This will place a copy of the file into the working folder and open it in the appropriate editor.

Edit Key


A key name is required in order to use the document object as a keyed document object. Then DOC1 application rules can include the object implicitly by linking to the key name, rather than the object being explicitly included when the application is defined. Typically the required reference will be contained in application data so you will need to be aware of the required format of the key name before specifying or changing it.

102 Edit File

Ensure that you have already checked out the document object library. Upon selecting this option, the name field becomes editable in the Details view. Amend as required and press Enter. The new data is only saved to the repository once the object is checked in.


Sections dialog

Options Description

Document Object Sections Lists all the current sections for the selected document object library.

Insert Click to insert a new section to the document objects held in the selected document object library. The New Section dialog is displayed.

Delete Click to delete the selected section from the document objects held in the selected document object library.

Rename Click to rename the selected section in all document objects held in the selected document object library. The New Section dialog is displayed.

Edit Label


Depending on your access rights you can rename document objects. A Workgroups resource name can contain up to 255 characters, including spaces, but cannot contain any of the following characters: < > : ; | * / \ ? " $

Edit Sections

Click a (checked out) document object library in Design; Edit menu or right click

Use to insert, delete or rename sections within the document objects in the selected document object library.

This can only be used on Document object libraries that have been de-constructed into individual document object files. The library (.CAT) files are represented by sub-folders located in the Document Objects folder in the Design view of the Project Navigator. It is only available once you have checked out the document object library.


Edit Sections 103

Inserting a new section will add a new section to all document objects contained within the selected document object library. You should then use the Edit option on the individual document objects to design the new section.

Renaming a section will change the name of an existing document object section, applying the new name to all document objects held within the selected library.

New Section dialog

Options Description

Section Name If renaming a section, the existing section name is displayed. Enter the name to be applied to the section. Enables the OK push button.

OK Click this push button to insert/rename the section. The document objects and library file are updated and you are returned to the Sections dialog.

Exit

File menu

Use to close DOC1 for Workgroups.

The status of projects and files in the repository is unaffected by a user logging out.

Export Snapshot

Click a project folder in Design; Tools menu

Use to create a single compressed archive file containing a set of resources or all the resources held in a project.

Selecting a project or set of resources before selecting the Export Snapshot option will save you some time when working through the wizard options.

You can also choose to send the newly created snapshot file (or an existing one) to another location via FTP.


104 Exit

Export Snapshot wizard

Options Description

Export Snapshot Options Select from the following options:Create a new snapshot and send it to someone (using FTP) � allows you to create a snapshot and FTP the file.Create a new snapshot, only � allows you to create a snapshot file for archiving purposes.Send an existing snapshot to someone (using FTP) � allows you to select an existing snapshot and send the file using FTP. Enables Snapshot Archive File entry field.

Snapshot Archive File Enabled once you have selected to send an existing snapshot to someone. Enter the file path and name or use the Browse push button to locate it.

Use this push button to display the Open dialog. This assists you with identifying the name and location of the file required

Snapshot name Enter the name for the snapshot archive file. This is not displayed if you have selected to use an existing snapshot.

Snapshot location Enter the location where the snapshot archive file will be created. Note that even if the file will be transferred to someone, a copy will remain in the location specified. This is not displayed if you have selected to use an existing snapshot.

Current Selection Displays all the file types that are valid for inclusion in the snapshot. Make sure the required file types are selected by either manually selecting and checking the tick boxes or using the Select All and Invert Selection push buttons.Select All � this push button will select all the items in the current selection.Invert Selection � this push button will reverse the selection, i.e. selected files will no longer be selected, and vice versa.Once selected you must check the tick boxes. Checking one tick box when multiple objects are selected will tick the boxes for all the selected file types.If a project was selected before starting the Export Snapshot wizard, all the file types are automatically selected and checked.If a selection of resources was selected before starting the Export Snapshot wizard, these files are displayed and automatically selected and checked.This is not displayed if you have selected to use an existing snapshot.

Only include files that have changed This option will compare the latest files with those used in a previous snapshot archive and create a snapshot archive based on only the files that have changed. Check the tick box and select the snapshot archive from the list of all snapshots previously created that will be used in the comparison. This is not displayed if you have selected to use an existing snapshot.

FTP site Select an FTP site from the drop down list or enter a new FTP site address as either textual (e.g. �ftp.company.co.uk�) or numerical (e.g. �1.23.456.78�). Entering a new FTP site will enable entry into the User Name and Password fields. This is not displayed if you have selected to create a snapshot, only.

Export Snapshot 105

User Name Displays the current user name for the selected FTP site as defined in the Workgroups Options. When entering a new FTP site, you should enter your user name for the specified site. Note that no information will be displayed here when you have selected �Group 1 Customer Support�. This is not displayed if you have selected to create a snapshot, only.

Password Displays the current password for the selected FTP site as defined in the Workgroups Options. When entering a new FTP site, you should enter your password (if required) for the specified site. Note that no information will be displayed here when you have selected �Group 1 Customer Support�. This is not displayed if you have selected to create a snapshot, only.

Location on FTP site This is enabled if you select any site other than �Group 1 Customer Support�. Enter the directory path (if known) on the FTP site where the snapshot will be placed. This is not displayed if you have selected to create a snapshot, only.

File List

View menu

When a resource folder from the Navigator is being browsed the content is displayed within the File List window of the Details view. Use this toggle option to show or hide this window.

Different icon 'overlays' are used to indicate a resource status:

Checked Out

SharedNot in working folder

If the resource is currently checked out these indicate the user who checked the file out and the date checked out from the repository

Indicates the revision number (i.e. how many times the resource has been edited)

Built but not checked in

Copy in working folder

106 File List

Metric Generation dialog

Options Description

Create metrics for printstream Select a printstream that represents the print device appropriate to your resources. This list contains all output datastream objects created in the Navigator Deploy view.

Name of metrics file to create Enter a file name, excluding the file extension for the metrics file that will be created. The file name must be no longer than 8 characters.

Generate metrics from Select whether you want to generate metrics using either:Original printer resources � use the original printer resources to generate the metrics files.Workstation resources � use the converted LarMeta resource to generate the metrics files.

Generate Metrics

Select a project folder in Build; Project menu or right click

Use this option to generate the required metrics files using either the Workstation (LarMeta) or original printer versions of font and image files.


Get Latest


Use this option to get copies of the latest revision of the selected resource(s). This will place a read-only copy of the file(s) into the Working Folder. If you select a project or folder before selecting this option then all the resources for the project or within the folder are copied.


Get Latest 107


For more information about Sections, Keywords and associated values refer to �Appendix A� in the Production Guide.

Host INI Section dialog

Options Description

Host INI Section Select the section you want to add from the list of host INI sections. Files � this section contains the file names that are required for an application.LicenseInfo � this section specifies the keycode related information that is used to validate that your installation has a license to use DOC1 Host programs on the appropriate host systems.OverrideSymbols � this section specifies symbol values that cannot be overridden by the Symbols section.ParallelProcessing � this section specifies information that is required by EMFE when it is running in parallel mode.ServerCommands � this section allows you to specify system commands to be executed when processing applications via EMFE in Server Mode.Symbols � this section specifies symbol values used to substitute parameters or parts of parameters specified elsewhere.System � this section specifies settings that govern the way in which some EMFE or PCE internal functions operate and also allow you to specify system commands that can be executed before or after an EMFE application process.All sections are added with default keywords/values and should be updated as appropriate.

Host (object and section)

Click Shared/Hosts folder or an application folder in Deploy; Insert menu or right click

Host is one of four INI objects that appear in the Deploy View only. A host object defines the keywords/values to be used in the sections of the INI file that relate to the configuration of the system on which EMFE will process the application.

Host objects can either be created in the Shared Production Engine Settings folder and then shared into an application folder or you can create objects specifically for an application directly within its folder.

Within each host object you will need to create one or more Host Sections which contain the actual keywords and values that will be used in the INI file. When you are working with Sections an INI Editor window will appear in the Details View. Some keywords with default values are assumed automatically and displayed in the Editor when you create the relevant Section � you can change the values as required. For other keywords you will need to explicitly add them to the Section using the features of the INI Editor.

108 Host (object and section)

When importing an application three options allow you to increase its granularity � i.e. create a larger set of files each of which are stored and edited independently. Note that Workgroups will automatically merge all Workstation resources within the appropriate project folder at build time so the user need not be concerned about reintegration.


Import DOC1 Application dialog

Options Description

Project Name To create a new project enter a new name in this field � names must be unique and cannot contain the following characters: < > : ; | * / \ ? ì $.To add the application resources to an existing project select the relevant name using the drop down list.

Working Folder Enter the path of the working folder. If the folder does not exist it will be created.


Update existing files This option is available when importing into an existing project. If checked the base files plus any resources referenced by the base files that already exist within the project will be updated by the import, i.e. new revisions of the files will be created. If this option is not checked any existing resources will not be re-imported.

Application Rules File Enter the filename and path of the Application Rules (LAR) file.

Import Application

Design; File menu or Ctrl+I

Use this option to import existing DOC1 Applications not currently under the control of Workgroups. You can either create a completely new project or import the resources into an existing project. In both cases the imported files are copied and placed in the appropriate folder within the project structure.

This feature works by parsing a �base file� for references to other files required by the application. For Workstation resources the base file is an Application Rules (.LAR) file. For production resources the base files is an EMFE Initialization File (INI).

The import function will search for referenced files in the directory in which the specified LAR and/or INI file is located. Files that cannot be found will cause a warning to be issued and such files can be added separately as required. All progress messages are displayed in the Output window.

Import Application 109

Use this push button to display the Open dialog. This assists you in identifying the name and location of the file required.

Break Application Rules file... Checked: separate files will be created to contain the logic for each Document Layout and Journal object within the original Rules file. These will be placed in the Document Layout and Document Journal folders respectively. The original Application Rules file will not be referenced.Unchecked: the original Application Rules file will be stored unchanged within the Document Layout folder.

Convert Shadow Bundle Objects...) This option is only enabled only when the Break Application Rules file... option is selected.Checked: for each Bundle object that has been shadowed elsewhere in the application a Sub Document file (LSD) containing the objects previously contained within the Bundle will be created and placed in the Sub Document folder of the selected project. The Bundle objects will be removed from the Application Rules file(s) and be replaced by a reference to the appropriate Sub Documents. Bundle objects that are not shadowed are NOT converted to Sub Documents.Unchecked: the Bundle objects and their shadows will remain in the Application Rules file(s). However, if you have selected the Break Application Rules file... option and the application contains Bundles that are shadowed between Document Layouts, a copy of the appropriate Bundle group will be placed within a Note object in the Document Layout that included the shadow.

Break Document Object Library... Checked: new project folders with the name of the document object libraries referenced by the application will be created and will contain the document objects as individual files (LDOs). The original document object libraries will not be referenced.Unchecked: the document object library files will be included in the root of the document objects folder within the project.

Ensure Parallel Compatibility This option is only available if your keycode includes parallel EMFE support. It is enabled only when the Break Application Rules file... option is selected.Checked: ensures that the application rules files is only broken down into components that are compatible for use with Parallel EMFE. Where the rules file contains multiple layouts, these are broken down into separate sub-documents as opposed to individual rule files.Unchecked: the application rules file is broken down, where appropriate, into individual rule files but will not be compatible with Parallel EMFE.

Initialization File Enter the location of the Initialization (INI) file (optional).

Use this push button to display the Open dialog. This assists you in identifying the name and location of the file required.

110 Import Application

The Workstation and original printer resources are added to the Shared Resources folder so they can be shared by all users across any project. The Workstation resources are also shared with the chosen project.

Import Library

Click a project folder in Design; File menu

Use the Import Library option to convert a Document Object Library (as used by the DOC1 Workstation) into individual document object (.LDO) files and add them to the selected project. A new document object library (.CAT) file is also created.

A Document Object Library can also be converted into .LDO files with an associated .CAT file by using the Split function. See �Working with document objects� on page 47 for more details.

The Import Library dialog is a standard Windows Locate File dialog. Click on the Open push button to import.


Import Printer Resources

Design; File menu

Use this option to import printer resources (i.e. fonts, images or overlays) under Workgroups� control and convert them into LarMeta format as used by DOC1 Workstation. Both the original printer resource and the converted Workstation resource are added to the project.

Import Printer Resources 111

Import Printer Resources wizard

Options Description

Resource types Select the resource type you wish to import. Choose from the following options:AFP fonts � select to import IBM AFP font (ICF), character set (IBB), or code page (ICP) files.AFP images � select to import IBM AFP page segment (PSG) image files.AFP overlays � select to import IBM AFP OGL source overlay files.HTML/PDF/Postscript compatible fonts � select to import Windows (Postscript) compatible font (PFB, AFM) files.HTML/PDF/Postscript compatible images � select to import Window or OS/2 bitmap (BMP), GIF, JPG, PCX or TIF files.Xerox fonts � select to import Xerox font (FNT) files.Xerox images � select to import Xerox image (IMG) or logo (LGO) files.Xerox overlays � select to import Xerox form (FRM) overlay files.

Selected files to convert For resource types other than PostScript fonts you can import multiple files at once. This list shows the resources that will be imported when the choose Finish. Use Add to search for resource files that are to be included in the list of resources to be converted. Use Remove or Remove All buttons if you change your mind about previously selected resources

Convert the character set Enabled when importing AFP coded font files. Check this box if you also wish to import the associated character set. If checked you should ensure the file is available in the same location as the selected coded font.

Convert the code page Enabled when importing AFP coded font files. Check this box if you also wish to import the associated code page. If checked you should ensure the file is available in the same location as the selected coded font.

AFP Fonts

AFP font resource type Select whether you are importing Coded Font, Character Set or Code Page files.

AFP images

AFP image resolution Displayed when importing AFP image files. Use this spin box to select the resolution for the selected resource(s). A resolution of 240 dpi is selected by default. All selected resources must be the same resolution.

AFP Overlays

Use symbolic substitution file Displayed when importing AFP overlay file select the tick box and enter a path and file name for the symbolic substitution (SYM) file. Alternatively click on the Browse push button to locate the file.

112 Import Printer Resources

Use this push button to display the Select a Symbol File (Open) dialog. This assists you in identifying the name and location of the file required.

Used by overlay Check this box if the LGO is referenced by an overlay and you want the orientation to be automatically corrected to match that of the imported overlay.

Use an existing Workstation code page Displayed when importing a Xerox font resource type. Enabled once a file has been selected. Check the tick box to enable selection from the drop down list of existing workstation code pages. If left unchecked, a new code page is created for each section.

Page Size It is usual for Xerox overlay resources to have the page size for which the overlay was intended stored in the FRM. In this case, Read from imported file should be selected. However, if working with old FRM resources you may need to specify the page size. Select Specify and enter the Feed Edge in dots and Edge 2 in dots. If not specified and not included in the FRM, A4 size is assumed.

Import as LIM By default, Windows compatible fonts are converted into BMP. Check this box override this and convert to Larmeta image format.

Xerox Images

Xerox image resource type Select whether you are importing Xerox image (IMG file) or a Logo file (LGO file).

Xerox Fonts

Xerox font resource type Select whether you are importing a Xerox Font (FNT file) or Logo Font (LGO file).

Xerox Overlays

Remove rotation suffixes Xerox resource file names typically contain special suffixes indicating orientation etc. and the overlay to be imported may contain references to such resources. If required, you can choose to strip the suffixes from the references within the LarMeta overlay created by the conversion. Tick the relevant box to strip suffixes for fonts (FNT) images (IMG) and logos (LGO).

PostScript/PDF/HTML Images

Resolution of images in dots per inch Displayed when importing Postscript image files. Use this entry field to specify the resolution of the selected resource(s). If a resolution is not specified 72 dpi is assumed by default. If you import more than one resource ensure they are of the same resolution.

Import Printer Resources 113

Font Use the Select button to display the Font dialog and select a windows compatible font, style and size. The font name is then displayed in the Font entry field.

Code page DOC1 needs to know the code page on which the font to be converted is based. The default selection �DOC1 default� is a built-in code page that allows for most common Latin based international characters. If necessary select an alternative code page from the drop down list that matches the origin of your font.

File If you want Workgroups to generate font metrics for PostScript or PDF applications you will also need to import an actual PostScript resource in addition to the Windows font. Metrics can be based on a PostScript font resource � Type1 (PFB); Open Type (OTF) or Character Identifier (CID) � or an Adobe metrics file (AFM). Use the Select button to identify the PostScript resource to be associated with the LarMeta font being created.

Codepoint mapping/PScript CMAP file These optional parameters are used in two circumstances:For double-byte fonts (OTF, CID or the AFM relating to a CID) this indicates the filename of the CMap file associated with the font and which describes character code to CID mapping. CMap files of this sort are provided as part of the font files from your supplier.For other fonts that include character identifiers that do not conform to the ISO-Latin conventions, this is the path/filename of a DOC1 codepoint map file which can be used to specifically identify non-conforming characters. Note that this option should only be required in exceptional circumstances but particularly when the font is based on a non-Latin language and is used as part of measured text functions. The codepoint map file will need to be created with the help of Group 1 Customer Support.

Point Size Enter a point size for the selected font file.

Workstation name Enter a base name (maximum 8 characters) that will be used for the LarMeta font resources created by the conversion.

PostScript/PDF/HTML Fonts

Create Workstation font from... Use this option to generate a Windows installed font � or workstation font � font style and size.

Invert Selection

Click a resource folder in Design; Edit menu

Use this menu option to select all resources displayed within the file list or Document Object list not currently selected, and deselect those that are.

114 Invert Selection

Merge

Design; Edit or right click library folder in the Navigator

Use Merge to combine the individual Document Objects (LDO) their .CAT file into a Document Object Library (LOL). All projects referencing the document objects will be updated to reflect the change. This option is reversible by selecting the Split function. For more information, see �Split� on page 134.

Navigator

View menu

Use this toggle option to show or hide the Navigator display. The content of the Navigator varies depending on which view has been selected via the tabs at the bottom of the window.

Use the tabs to switch between the available Navigator views

Double click the docking bar to free the window and then drag it to a new location within the workspace.

The Admin view only appears to a user logged on with the Admin user id.

Navigator 115

New dialog

Options Description

File type Select the file type of the new file to be created.

File name Enter the new resource name.

Add to project Select a project to which the resource will be added.

Document Object Library Enabled when creating a new Document Object. Select a document object library to which the new document object will be added. If there are no libraries in the selected project, or you do not wish to add to an existing library, typing in a new name will create a new library. Alternatively select the �default� library.

New

Click a project folder in Design; File menu or Ctrl+N

This option allows you to create new DOC1 resources for a project. Once the file type is established the relevant DOC1 editor is opened allowing you to create the file. Upon saving, the file is automatically placed within the relevant folder in the selected project.

To use this feature you will need to be assigned the project admin. or designer roles or equivalent. Note that it is possible for the DOC1 Administrator to configure Workgroups so that access to individual file types is controlled.

Open Repository

File menu or Ctrl+O

Use this menu option to log on to a Workgroups Repository. If you are already logged on to a different repository, that session will be closed.

Your user name and password should be provided by your Workgroups Administrator.

116 New

Logon to DOC1 for Workgroups dialog

Options Description

User Name Enter your user name as specified by your Workgroups administrator.

Password Enter your password here. It will be displayed as encrypted text.

Repository Select the Workgroups Repository name from the drop down list or use the Browse push button to locate it.Use this push button to display the Open dialog. This assists you in locating the relevant SRCSAFE.INI file. The location of the Repository file is dependent on where the Visual SourceSafe Database has been installed by the Workgroups Administrator. You can also allocate a �friendly� name for the repository.

Options

Tools menu

Use this menu option to specify global settings that customize the way Workgroups behaves. The Options dialog consists of three pages:

� General � use this page to specify the double-click action.

� Log Files � use this page to specify the archive options.

� Repository � use this page to change the project to be used as the shared project and set its working folder.

Options 117

Options dialog

Options Description

General � Double-click ... Set the default action for double-clicking on a file from either:View read only - select this option to get the latest copy of the resource and open in the appropriate viewer whenever you double-click on a resource. The appropriate rights are required.Edit - select this option to check out the resource and open in the appropriate editor whenever you double-click on a resource. The appropriate rights are required.Edit if allowed else View read only - select this option to check out the resource and open in the appropriate editor whenever you double-click on a resource. However, if this is not possible, due to restricted access rights or because it is already checked out, a read-only copy will be displayed instead.

Log File � Archive options Select how often you want to archive the log file. Select one of the following options:Monthly � The log file is archived on a monthly basis.1 Mb � The log file is archived whenever the size exceeds 1 Megabyte.10 Mb � The log file is archived whenever the size exceeds 10 Megabytes.Never � The log file is never automatically archived. However you should archive the file manually to avoid the file becoming too large. To do this simply rename the .LOG file.

Log File � Archive filename Specifies the default archive filename. If you wish to change this either enter a new path and filename or use the browse push button to locate one. The default name is �USERID.000� the extension incrementing as each archive file is created.

Repository � Project Lists all current Workgroups projects. Select which project you wish to use as the shared project. DFWProject (as set up during install) is used by default.

Repository � Working folder Use to specify/change the path where shared resources are checked out to. If the specified folder does not exist it will be created.


118 Options





Output Datastream INI dialog

Options Description

Printstreams Select the section you want to add from the list of output datastream sections. AFPDS � Used to define printer settings when generating AFPDS for IBM IPDS or compatible printers.LineData � Used to define the layout when generating line data output.Metacode � Used to define printer settings when generating Xerox Metacode output.PCL � Used to define printer settings specific to the HP environment when generating PCL protocol.PDF � Used to define settings specific to PDF output.PostScript � Used to define settings specific to generating Postscript output.PrintDevice � Used to identify the target printer type, i.e. the Print Device. This section is a mandatory requirement for EMFE processing.

Output Datastream (object and section)

Click Shared/preferences folder or an application folder in Deploy; Insert menu or right click

Output Datastream is one of four INI objects that appear in the Deploy View only. An Output Datastream object defines the keywords/values to be used in the sections of the INI file that relate to the type and format of the main output file produced by EMFE.

Output Datastream objects can either be created in the Shared Production Engine Settings folder and then shared into an application folder or you can create objects specifically for an application directly within its folder.

Within each object you will need to create one or more Output Datastream Sections which contain the actual keywords and values that will be used in the INI file. When you are working with Sections an INI Editor window will appear in the Details View. Some keywords with default values are assumed automatically and displayed in the Editor when you create the relevant Section � you can change the values as required. For other keywords you will need to explicitly add them to the Section using the features of the INI Editor.

Output Datastream (object and section) 119

All sections are added with default keywords/values and should be updated as appropriate. However, when specifying PostScript we recommend that default options be used where possible.

Output window

View menu

Use this toggle option to show or hide the Output window. This displays a list of messages generated by events occurring within the Repository and consists of the Repository and Build views. Workgroups automatically switches to the correct output view as new messages or output are added.

Use the tabs or arrows to switch between the Repository or Build view

Double click the docking bar to free the window

Hover cursor over the header dividers to resize the columns

Use the menu options to clear or sort the contents of the window

Click on a column header to sort contents by that field

Paste (after Copy)

File menu or Ctrl+V

See Copy.

120 Output window



Preferences INI Section dialog

Options Description

Preferences INI Section Select the section you want to add from the list of sections. Preferences 0-9 � Use to include preference definitions that allow you to customize certain values that are applied dynamically by EMFE and PCE at run-time.Symbols � Use to specify symbol values that substitute parameters or parts of parameters specified elsewhere.OverrideSymbols � Use to specify symbol values that cannot be overridden by the Symbols section.All sections are added with default keywords/values and should be updated as appropriate.

Preferences (object and section)

Click Shared/Preferences folder or an application folder in Deploy; Insert menu or right click

Preferences is one of four INI objects that appear in the Deploy View only. A Preference object defines the keywords/values to be used in the sections of the INI file that customize the way EMFE and PCE present information such as dates and numbers.

Preference objects can either be created in the Shared Production Engine Settings folder and then shared into an application folder or you can create objects specifically for an application directly within its folder.

Within each object you will need to create one or more Preference Sections which contain the actual keywords and values that will be used in the INI file. When you are working with Sections an INI Editor window will appear in the Details View. Some keywords with default values are assumed automatically and displayed in the Editor when you create the relevant Section � you can change the values as required. For other keywords you will need to explicitly add them to the Section using the features of the INI Editor.

Preferences (object and section) 121

Use the General page to manage resources required to present the application output on the printer/browser, i.e. fonts, images and overlays. Refer to the Printer/Browser Resources section in the Designers Guide for further information

Use the Build page to customize what EMFE options are to be used when the project is built.

Use the Custom Build page to specify external routines to be executed before and/or after the build

Project Settings

Click a project folder in Build; Project menu or right click

Use the Project Settings option to specify build and metrics control options that are applied at the project level. You should not attempt to build or deploy until you are sure these options have been set to your requirements

122 Project Settings

Use the Build Configurations page to create configurations specifying which application rules files (.LARs) within the project are to be used when building. Also to specify a file name to be used with the Production Rules Files created by the build.

Use the Metrics page to specify when the metrics files are generated and from which resource type.

Project Settings dialog

Options Description

General � Reference shared resources Use this check box if you want to include resources directly from the shared resource project rather than using only resources within the project.

General - Allow the use of outline fonts Use this check box if Windows fonts are to be used in the application design.

General - Use Resource Packs Use this check box if the application uses resources stored in the resource pack. The resource pack feature is only available for supported output datastreams, refer to the release notes for further details. For detailed information on resource handling refer to "Printer/Browser Resources" in the Designers Guide.

Build � Check Non-compulsory records Use this check box to specify that the build process is to check for possible problems when generating the rules relating to non-compulsory records. It may be desirable to use this option if you use non-compulsory records with relative positioning features.

Build � Convert for EBCDIC Host Use this check box if the operating system on the intended host system for the Production Rules Files uses the EBCDIC system for translating text. If this box is not checked, a host system using ASCII is assumed.

Build � Output Trace Comments Use this check box if you want the Host version of the application rules file to contain comments generated by the build process. This may be useful to your DOC1 supplier when analyzing system problems.

Project Settings 123

Build � Generate Error Context Info Use this check box to specify that EMFE is to generate object specific codes when encountering errors. These can be used with the Find Error Item option to identify the object being processed when a failure occurred.N.B.. Use of this option affects EMFE performance.

Build � Generate Parallel-enabled Rules Use this check box to specify that the build is to check that the application is valid for use with EMFE in parallel mode. EMFE in normal mode can still be used if this option is checked. This option is only available if your Workstation keycode includes EMFE parallel mode support.

Build � Abort on Unknown Record Use this check box if EMFE is to abort whenever a record type not identified in the data format is encountered in application data. Note that this option performs checks independently of the EMFE ExtendedInputValidation/RecordOrder option (as specified in the Initialization file)Note: if you are going to run EMFE in parallel mode and want unknown records to be stored in a separate data file for subsequent correction and re-submission to EMFE, then this option must be checked.

Build � Abort on Document Error Use this check box if EMFE is to abort whenever a fatal error is generated. If this option is not turned on EMFE will continue to process the application starting with the next data document in application data. However, the user should be aware that many error messages may be generated if the problem was not document specific.Note: if you are going to run EMFE in parallel mode and want documents in error to be stored in a separate data file for subsequent correction and re-submission to EMFE, then this option must be checked.

Build � Create EMFE Ready Files Use this check box if the build is to generate Production Rules Files ready for use by EMFE on the host system.

Custom Build � Pre Build Step Any entry in this field will be assumed to be a call to an external routine to be called prior to executing the build process. This must be coded as a command call that is acceptable on the Windows command line

Custom Build � Post Build Step Any entry in this field will be assumed to be a call to an external routine to be called after executing the build process. This must be coded as a command call that is acceptable on the Windows command line

Build Config. � Active Configuration Use the drop down list to choose a previously defined build configuration to be used with subsequent Builds. A build configuration specifies the .LAR files within the project that will be included in the build.Add � use this button to create a new build configuration. This will invoke the Build Configuration dialog where you give the new configuration a name. Pressing OK creates the new configuration and makes it �active�. Then use Configuration Details to select the .LARs to be included with the configuration.Delete � use this button to delete the currently selected configuration.

Build Config. � Document Layouts Each file included in the list is a document layout file associated with the project. Every checked file will be included in the build when the currently selected configuration is active.

124 Project Settings

Build Config. � Document Journals As above but for document journals.

Build Config. � Output File Name The name specified will be used as the base name for all three Production Rules Files created by the build; i.e. a name of �bill1� will produce bill1.lar, bill1.ldf and bill1.lol. By default this is the same as the currently selected project name.

Metrics � Generate Use these radio buttons to select when metrics files are generated. Select either:On Demand � this allows you to use the Generate Metrics option.Never � this will disable the Generate Metrics option, ensuring that existing metrics files are protected.

Metrics � Line Spacing Allows you to override the value to be used as the inter-line sapcing when the font is used. Line space is expressed as a % of the pointsize for which metrics are to be generated. Note 120% is the default for Adobe fonts

Properties (general)

Click a file or object; File menu or right click

For all files and projects you can display the properties dialog which displays information about current status. For document objects, host INI objects and projects you can perform some editing and/or housekeeping actions using the Properties dialog. These are detailed in the following sections.

Properties (for document objects)

Click a document object in Details View; File menu or right click

For document objects the properties notebook has an additional page that lets you view and, if necessary amend the label, key and description fields used to identify the object in the various DOC1 editors. Refer to the �Designers Guide� for complete information about working with document objects.

See other Properties entries in this section for details of other object types.

Properties (for document objects) 125

Properties dialog

Options Description

Host Select a host from this drop down list. All Host Initialization objects created in the deploy view are listed here.

Local Select this radio button if the selected host is available via the local area network. The exact location will depend on the paths specified in the Files section of the initialization object, or if overridden by the user during deployment, the paths specified in the deploy wizard.

FTP Select this radio button if you need to use FTP to transfer the files during deployment to the specified host. Enables the Address, Username and Password options.

APPC Select this radio button if you need to use APPC to transfer the files during deployment to the specified host. Enables the LU Name, Log Mode, Username and Password options.

Username Displayed when either FTP or APPC is selected. Enter your username for the selected host system.

Password Displayed when either FTP or APPC is selected. Enter your password for the selected host system.

Address Displayed when FTP is selected. Enter a default FTP address as either textual (e.g. �ftp.company.co.uk�) or numerical (e.g. �1.23.456.78�).

LU Name Displayed when APPC is selected. Enter a default APPC Logical Unit Name.

Log Mode Displayed when APPC is selected. Enter a default APPC Log Mode.

Properties (for Host objects)

Click a Host object in Deploy; File menu or right click

For INI objects of type Host the properties notebook has a Deployment page (only) that allows you to specify information about the system to which the Deploy option will transport the files for a particular application.


126 Properties (for Host objects)

Properties dialog

Options Description

Restore Any file(s) selected in the list will be restored to the project as an active file.

Purge Any file(s) selected in the list will be permanently removed from the repository and will no longer be recoverable.

Purge All As above except all files are removed.

Properties (for projects)

Click a project folder in Design; File menu or right click

Use this option to view the status of a project and perform housekeeping on deleted files.


General page

This page provides non-editable information about project status.

Deleted Files page

This page displays files that have been deleted from the project and which have not yet been purged.

Rebuild All

Click a project folder in Build; Project menu or right click

This option should only be used secondary to an initial Build which is used to generate the files required for EMFE processing. Using Build a second time will only update the build files based upon any change in resources. The Rebuild option will regenerate all the build files.


Rebuild All 127

A Workgroups resource name can contain up to 255 characters, including spaces, but cannot contain any of the following characters: < > : ; | * / \ ? ì $.

You should also note that resources that are referenced by EMFE must conform to the 8.3 file naming format.


The report is presented as a file list in the Details View. Within this view you can use the Revision History feature to display full revision details of any file displayed by the report.

Refresh

View menu or F5

Use this option (or the F5 keyboard shortcut) to refresh the file and document object lists, the contents of which may change as other users make changes to projects.

Rename

Click a project folder in Design or a file in Details view; Edit menu or F2

Use this option to rename the selected resource or project.

When working with projects or resources that are not specifically referenced by other files you can simply amend the name in the Details view once this option has been selected. Pressing return confirms the new name.

If you have selected a resource that is referenced by other DOC1 files the Rename dialog will appear. This will either list the files that reference the resource or, if the resource is referenced within more than one project, the projects that are affected. In the latter scenario you can select a project from the list and use the Details button to view the specific files that reference the resource. If you are happy that the resource can be renamed use the New Name field and press Rename to action.

Report Changes


This feature allows you to review changes that have been made to files used by a particular project. Selecting this option produces a report wizard that allows you to select the required report type and the associated parameters

128 Refresh

While the report remains in the Details View you may use the Print, Save or Save As options from the file menu as required.

Report Changes wizard

Options Description

Report Selection Use this page to choose the method to be used to select files for display. Options areSince a date � the report will display all file changes made between the specified date and now. May also include time refinement if required.Since a project revision � the report will display all file changes made between the specified revisions and now.Compare revisions � the report will display all file changes made between the specified revisions.

Since a date � Date Use the drop down list to present a calendar from which you can select a date. File changes made earlier than this date will not be displayed.

Since a date � Time Use this field to specify a time within the specified Date. File changes made earlier than this time will not be displayed.

Since a project revision This page simply lists the revisions that have been made for the selected project. Click on the revision before which changes are not to be displayed.

Compare revisions Use this page to specify the project revisions to be compared for changes.

When the Create option is used a new role with a default label is added. Overwrite this as required. To specify the actual rights associated with the role click on the object in the navigator and specify the required access levels in the details view.

Role

Admin; Administration menu or right click on Roles folder

A role confers a set of default rights to users when they are assigned to projects. Workgroups provides built-in roles that are always available � Project Aministrator, Application Designer and Application Operator. These are intended to cater for standard functional groupings but the DOC1 Administrator can create new roles with customized rights as required. Roles have global effect for the users to which they are assigned but the rights made available can be overridden when the user is added to a specific project.

Role 129

When a role object is selected in the navigator further sub-menus become available � Delete and Copy. Use Copy to create another role (with default label) that has the same rights as the original. You can then refine them as required in the Details view.

Rights related to file access have several hierarchical permission levels that you can specify: Disabled; View; Edit; and Create. The type of access granted by these levels is self-explanatory and permissions are cumulative, e.g. if Edit is specified the user will also have authority to View.

Rights related to Workgroups functions can only be enabled or disabled.

To work with Roles you must be logged in as the DOC1 Administrator (user id �Admin�).

Select dialog

Options Description

Item Specify a group of files you wish to select by using wildcards. For example, *.* will select all resources, *.LAR will select all resources ending in .LAR, and T*R will select all resources starting with T and ending in R (e.g. tryme.lar).

Select Click this push button in order to select all the files displayed within the file/document object list that match the criteria.

Deselect Click this push button in order to deselect all the files displayed within the file/document object list that match the criteria.

Select

Click a resource folder in Design; Edit menu or Ctrl+L

Use this option to select multiple resources displayed in the File List window of the Details view. This is useful if you want to process multiple files but not an entire folder using a single operation.

130 Select

We recommend that the working folder for each project be unique as this will avoid any overwriting problems when working with more than one project.

Set Working Folder dialog

Options Description

Set working folder for project... Use to specify/change the path where shared resources are checked out to. If the specified folder does not exist it will be created.


Select All

Click a resource folder in Design; Edit menu or Ctrl+A

Use this option to select all resources displayed in the file/document object list. This is useful if you want to process multiple files using a single operation.

Set Working Folder

Click a project folder in Design; Project menu or Ctrl+D

Use this option to change the location used as the working folder for the currently selected project.

A working folder is the work space allocated by a user for each project they intend to work with. It is a file location where resources are stored while they are in use. It is not shared with other Workgroups users.

Share

Click a resource folder or select file(s) in Details view; Repository menu or right click

Use this option to share resources across more than one project. By sharing a resource, as opposed to copying it, only one copy is held within the Repository. Therefore if the resource is updated, it is also updated within all the projects it has been shared with.

To use this feature you will need to be assigned the project admin. role or equivalent for the project you are sharing from and the project you are sharing into.

Share 131

Many DOC1 resources contain embedded references to other resources, e.g. a document layout will usually reference many document objects and the document objects will themselves contain references to fonts and images. Where this is the case you are optionally able to share such referenced files along with the selected resources.

Share Files dialog

Options Description

Share Files Into Project Select a project from the drop down list of available projects that the selected resource will be shared with.

Share Referenced Files If this option is checked all other files associated with the selected resources will also be shared into the target project.

Update existing files If checked the selected (and optionally referenced) resources that already exist within the project will be updated with the files being shared.If Keep Revision Histories is checked a new revision of the existing files will be created. If Keep Revision Histories is not checked the existing files along with their history will be completely overwritten by the copied resources.

132 Share

If you choose to roll back a file you may need to specify how to handle other files that are referenced by the resource being rolled back. If the resource is shared across projects you will also need to specify if the roll back is to be implemented for the currently selected project or for all projects that share it. These options are handled by the Roll Back Options dialog which will appear automatically if such dependencies are detected.

While most users will be authorized to view history you will need to be assigned the project admin. role or equivalent to roll back or get files.

Revision History dialog (project and file versions)

Options Description

History All revisions of the resource or project are listed here. The following information is displayed:Project � the project status and version number, the date the status was set and the user who set it.Resource � the revision number, the date last edited, the user who changed it, the type of action applied and any comment that was added.

Show Revisions

Click a project folder in Design or a file in Details view; Repository menu or right click

Use the Show Revisions option to display a list of all revisions of a resource or project.

In the Revision History dialog you can work with earlier revisions if required:Get a copy of earlier file or project revisions for viewing or deployment;Roll Back files or projects to an earlier revision so that they are restored as the Latest revisions.

Show Revisions 133

Roll Back Choosing this option when a project or file is selected in the History will take a copy of the earlier file revision(s) and use them to create a new Latest revision in the Repository.

Get Choosing this option when a project or file is selected in the History places a read-only copy of the selected revision into the working folder for viewing or deploying.

Roll Back Options dialog

Options Description

Roll back Choose the synchronization option that meets your needs. Note that these options are not available if referenced resources are themselves shared across projects. Options are:Rollback this file only � only the selected file is rolled back. When it is edited or built it will use the latest revisions of referenced file.Rollback with default synchronization - all referenced resources will be rolled back to the revisions that were current when the selected file revision was checked in.Rollback with custom synchronization - the Synchronize File dialog will appear and will allow the user to choose specific revisions of all referenced files.

Roll back in all projects... If this option is not checked the revision control system creates a branch for the file. The current project will use a new version of the resource which will not (initially) be shared with other projects. Other projects that share the original resource will continue to use the last revision of it.

Synchronize File dialog

Options Description

This dialog appears when a file that has been selected for roll back references other files and the custom synchronization option has been specified. It will list the revisions of all referenced resources that have been created since the file revision being rolled back was checked in. You should check the required revision of each file. When the roll back is implemented the specified revisions will become the new latest revisions.

Split

Design; Edit or right click folder in the Navigator

Use this option to split a Document Object Library (.LOL) into individual Document Objects (.LDO) and an associated Document Object Library (.CAT). All projects referencing the document objects will be updated to reflect the change. This option is reversible by selecting the Merge option. For more information, see �Merge� on page 115.

134 Split

Users are assigned one or more roles which confer a set of default rights when the user is assigned to projects. For each user you will need to specify and maintain the lists of what role(s) users are assigned to and what projects they are permitted to work with. A user cannot work with a project unless assigned to it.

When the Create option is used a new user with a default label is added. In the navigator you should overwrite this with label that identifies the user. All other configuration options related to the user can be specified via the user display in the Details view.

When a user object is selected in the navigator further sub-menus become available � Delete, Roles and Projects. The Roles and Projects options provide quick ways of assigning or removing attributes from users.

To work with Users you must be logged in as the DOC1 Administrator (user id �Admin�).

Undo Check Out


If you have checked out a resource from the repository, but no longer want to update it, use this option to release the lock that check out performed.

User

Admin; Administration menu or right click on Users

These options allow the DOC1 Administrator to create and configure the user objects that determine who can participate in the Workgroups environment and what access rights they have.

User 135

View File


Use this option to view a resource. This will take the latest copy of the resource, saving it as read-only in the Working Folder, and open it in the appropriate viewer.

Alternatively, use this option to view resources already copied into the working folder (using the Get Latest option).

136 View File

Appendices

Appendix A: Access rightsThis section provides details of the rights that are used to control access to Workgroups resources and functions. Rights are specified in the role(s) assigned to users and which act as default authority whenever a user is added to a project. However these can be overridden on a project-by-project basis. Refer to �Working with projects� on page 32 for details.

Folder/File or Function Type1 Assign2 Built-in3 Permissions

Resource actions

Data format File RP PD Create, edit4 and view depending on access level1

Layout File RP PD Create, edit4 and view depending on access level1

Objects File RP PD Create, edit4 and view depending on access level1

Sub Documents File RP PD Create, edit4 and view depending on access level1

Fonts File RP PD Create, edit4 and view depending on access level1

Images File RP PD Create, edit4 and view depending on access level1

Overlays File RP PD Create, edit4 and view depending on access level1

Preferences... File RP PD Create, edit4 and view depending on access level1

output datastream... File RP PD Create, edit4 and view depending on access level1

Host... File RP PD Create, edit4 and view depending on access level1

Application... File RP PD Create, edit4 and view depending on access level1

Checkout/Checkin Func P PDO Use the repository to add or update files

Rename Func P P Rename any resource file (where possible)

Delete Func P P Delete any resource file

Copy Func P P Delete any resource file

Rollback Func P P Use roll-back feature on resources

View Revision History Func P PDO Use show revisions feature for resources

Share Func P P Use this feature

Operations

Deploy Func OPX PO Deploy applications

Access rights

137

Generate Metrics Func PX PO Create metrics files from project resources

Export Snapshots Func OP PO Use this feature

Build Func PX PO Initiate Build or Rebuild All

Import Applications Func OP PO Use this feature

Import Printer Resources Func OP PO Use this feature

Import Resources Func OP PO Use this feature

Configure FT Protocols Func OPX PO Define comms set-up for deployment

Projects

View Func P PDO Get latest version for viewing

Create Func P P Create new project

Rename Func P P Rename a project

Delete Func P P Delete a project

Copy Func P P Copy a project

Rollback Func P P Use rollback feature for entire projects

Change Status Func P PDO Use project and file status features

View Revision History Func P PDO Use show revisions feature for entire projects

Configure Build Settings Func PX PDO Use all project settings and build features

Administration

Project Admin. (P) Admin { DOC1 Admin}

Assign rights to Project features

Resource Admin. (R) Admin P P Assign rights to Resource features

Operation Admin. (O) Admin P P Assign rights to Operations features

Production Admin. (X) Admin P P Assign rights to Production features

NOTES:

1. Rights of type File have several hierarchical permission levels that you can specify: Disabled; View; Edit; and Create. The type of access granted by these levels is self-explanatory and permissions are cumulative, e.g. if Edit is specified the user will also have authority to View. Rights related to Functions and Admin can only be enabled or disabled.

2. The Assign column indicates what users can assign the particular type of right:P = Users with Project Admin right; R = Resource Admin; O = Operations Admin; X = Production Admin.

3. The Built-in column indicates the rights assigned to the built-in Workgroups Roles:P = Project Administrator; D = Application Designer; O = Application Operator.

4. Users will not be able to edit files not previously checked-out of the repository unless they also have the CheckIn/CheckOut right assigned.

Folder/File or Function Type1 Assign2 Built-in3 Permissions

Access rights

138 Appendices

Appendix B: Output message types

Type Icon Description

Information You do not need to take any action to resolve this message. The message has been produced to provide you with additional details about the current process.

Warning Workgroups has encountered a problem. If Workgroups can take corrective action you will be prompted by a dialog asking you if you wish to resolve the problem.

Action Workgroups encountered a problem and is unable to resolve it. The accompanying message will indicate where the problem lies. If you are unable to resolve the problem, contact Group 1 Customer Support quoting the Workgroups message number indicated in the additional information.

Output message types

Appendix B: Output message types 139

Appendix C: Using APPC on OS/390APPC transactions on the OS/390 host system are handled by an additional program (AFTPD) which must be made known to the operating system before it can be used. This must be configured as a logical unit (LU) on the OS/390 host. This work will normally need to be carried out by your system programmer.

STEP 1: define a suitable LU to VTAM. For example, in a member of SYS1.VTAMLST add the following:

STEP 2: make the LU known to APPC. For example, create or edit a SYS1 PARMLIB member with name APPCPMxx (last two characters may vary) and add the following:

A0600 VBUILD TYPE=APPL*MVSLU01 APPL ACBNAME=MVSLU01, ACBNAME FOR APPC C APPC=YES, C AUTOSES=0, C DDRAINL=NALLOW, C DLOGMOD=APPCHOST, C DMINWNL=5, C DMINWNR=5, C DRESPL=NALLOW, C DSESLIM=10, C LMDENT=19, C MODETAB=APPCTAB, C PARSESS=YES, C SECACPT=CONV, C SRBEXIT=YES, C VPACING=1

Note: to activate the LU in this example issue the following operator command:V NET,ACT,ID=A0600

LUADD ACBNAME(S43APP1) SCHED(ASCH) TPDATA(SYS1.APPCTP)

140 Appendices

STEP 3: add a scheduler class to ASCH. For example, create or edit a SYS1.PARMLIB member with name ASCHPMxx (matching the APPCPM member) and add the following:

STEP 4: execute the ATBSDFMU utility with the following input:

CLASSADD CLASSNAME(A) MSGLIMIT(1000) MIN(1) MAX(10) RESPGOAL(1)

Then issue the following operator command using the variable characters:SET ASCH=xx

TPADD TPNAME(DFWAFTP) ACTIVE(YES) TPSCHED_DELIMITER(##) CLASS(A) TPSCHED_TYPE(STANDARD) JCL_DELIMITER(++)//DFWAFTP JOB//FTP EXEC PGM=AFTPD//STEPLIB DD DSN=[location of DOC1 APPC program as provided],DISP=SHR//SYSPRINT DD SYSOUT=X++##

Appendix C: Using APPC on OS/390 141

142 Appendices

Index
Symbols
.CAT 39, 47

.EAR 66

.LAR 38

.LDO 37, 39

.LJR 38

.LSD 38

A

Abort on Document ErrorProject Settings dialog 124

Abort on Unknown RecordProject Settings dialog 124

Access rights 137Active Configuration 66

Project Settings dialog 124Add Files 52, 54, 93Add To Project 116Adding dialog 93Address

Options dialog 126Admin account 12, 27Admin View - Navigator 22Administrator see DOC1 AdministratorAFP font resource type

Import Printer Resources wizard 112AFP image resolution

Import Printer Resources wizard 112AFP resources 112

Import Printer Resources wizard 112AFPDS

Generating metrics 71Printstreams dialog 119

AFTPD 140ALE 10, 17, 46Allow use of Outline Fonts 67

Project Settings dialog 123APPC 82

Client 140Properties dialog 126

Application Designer role 129Application Layout Editor see ALEApplication Operator role 30, 129Application Rules 38

Importing 36Application Rules File

Import DOC1 Application dialog 109Application Settings 76, 94Archive filename 89, 118ASCII based host 66

B

Base Project 35Copy Project dialog 99

Branching 53Break

Application Rules file 110Document Object Library 110

Break Application Rules file 36, 38Import DOC1 Application dialog 110

Break Document Object Library... 36, 37Import DOC1 Application dialog 110

Break Share 53Browse for Folder 35Browser resources 41Build 66, 68, 95, 122

Project Settings 123Build Configurations 66, 123Build View 22, 24Built-in role 27, 137Bundle objects 38

C

Check In 56, 57, 96Check Non-compulsory records

Project Settings dialog 123Check Out 45, 56, 57, 96Check Out Immediately 35, 55

Adding dialog 93Copy Project dialog 99

Clean Working Folder 35, 97Clear Output Window 24, 97Client, Workgroups 19Code page

Import Printer Resources wizard 114Codepoint mapping

Import Printer Resources wizard 114Comment 55

Adding dialog 93Compare revisions

Report Changes wizard 129Conversion Utilities 17Convert for EBCDIC Host

Project Settings dialog 123Convert Shadow Bundle Objects... 36, 38

Import DOC1 Application 110Convert the character set

Import Printer Resources wizard 112Convert the code page

Import Printer Resources wizard 112Copy 97Copy Project 34, 98Copy Referenced Files

File copy dialog 98Copying resources 53Create Database 28Create EMFE Ready files 67

Project Settings dialog 124Create metrics for printstream

Metric Generation dialog 107Create new resource pack

Build Dialog 95, 96Create Project 33, 99Create Revision 99Create Snapshot 87Create Workstation font from

Import Printer Resources wizard 114Current Selection

Export Snapshot wizard 105Custom Build 66, 122Custom synchronization 64

143

D

Data Format 46Building 66

Data Format Editor see DFEDate

Report Changes wizard 129Default synchronization 64Delete

Sections dialog 103Warning dialog 100

Deleting 59Deletions

Restoring and purging 43Deploy

Deploy View - Navigator 22Wizard 101

Deploying 75Description of Changes 57, 96Deselect 51, 130Design View - Navigator 22Designer role 30Details

Rename dialog 128Details View 22DFE 46DLM 47DOC1 Administrator 27Document Journal 17, 38, 46

Building 66Project Settings dialog 125

Document Layout 17, 46Building 66Project Settings dialog 124

Document Library Manager see DLMDocument Object 37

Creating 47Properties 58, 125

Document Object Editor see DOEDocument Object Library 47

Break (Import dialog) 36Building 66Creating 47Import 39, 111Merge 48, 115Sections 48, 103

Deleting 59Renaming 59Restoring 59

Split 48, 134Document Object List 22Document Object Sections

Sections dialog 103DOE 46, 47Double clicking 23

E

EBCDIC based host 66Edit 45, 56, 57, 118

File 102Edit if allowed else View read only 57, 118Edit Key 102Edit Label 103Edit Section 49, 59, 103EMFE 10, 16, 22, 66

Initialization Keywords 75

Ensure Parallel CompatibilityImport DOC1 Application dialog 110

Evaluate 102Exception

Application INI Section dialog 94Exit 20, 104Export Snapshot 87, 104ExtendedInputValidation

Application INI Section dialog 94

F

FileImport Printer Resources wizard 114

File List 22, 106File Name

Delete warning dialog 100File Options 83Files 13, 19

Adding 54Application INI Section dialog 94Copying 53Deleting 59Host INI Section dialog 108Renaming 58

Folder 13Font

Import Printer Resources wizard 114Font Metrics 70Font Table 17FTP 82, 86

Deploy 82Export Snapshot wizard 105Properties dialog 126

G

GenerateProject Settings dialog 125

Generate Error Context InfoProject Settings dialog 124

Generate Metrics 107Generate Parallel-enabled Rules

Project Settings dialog 124Get 62

Revision History dialog 134Get Latest 45, 56, 107Global symbolic links 36

Using in document objects 39

H

HistoryRevision History dialog 133

Host 108Properties dialog 126

Host INI objectProperties 126

Host object 75, 76Properties 126

HTMLGenerating metrics 71Importing fonts 42

HyphenationApplication INI Section dialog 94

144 Index - D

I

Image 50Image Metrics 70Import 37Import Application 33, 36, 109Import as LIM

Import Printer Resources wizard 113Import Library 39, 111Import Printer Resources 41, 111Include additional resources

Build Dialog 95INI Editor 79, 81INI objects 75INI see Initialization FileInitialization File 75, 76

Import DOC1 Application dialog 110Importing 36

InputDataApplication INI Section dialog 94

InsertSections dialog 103

Installation 28Intermediate Rules 67Invert Selection 114Item

Select dialog 130

J

Journal 50JPG 50

K

Keep Revision HistoriesCopy project dialog 99Copying projects 34Copying resources 54File copy dialog 98

L

LarMeta 41Leave Copy On Local Drive 56

Check In dialog 96LGL 39LicenseInfo

Host INI Section dialog 108Line Spacing

Project Settings dialog 125LineData

Choosing metrics utilities 71Printstreams dialog 119

LocalDeploy 82Properties dialog 126

Local files 83, 101Location

Export Snapshot wizard 106FTP 87Logon to DOC1 for Workgroups dialog 117

Log ModeProperties dialog 126

LogicalPageMapApplication INI Section dialog 94

Logon to DOC1 for Workgroups 19, 117

LU NameProperties dialog 126

M

Mapping printer resource names 70Merge 48, 115Message1 Environment File 51Metacode

Generating metrics 71Printstreams dialog 119

Metrics 123Metrics Generation 72, 107Monthly

Log File Archive 89Options dialog 118

N

Name of metrics file to createMetric Generation dialog 107

Navigator 21, 115Never

Log File Archive 89Options dialog 118Project Settings dialog 125

New 46, 116Project Name 98

New NameRename dialog 128

New Section 49, 104

O

On DemandProject Settings dialog 125

Open Repository 19, 116Operations Administrator role 30Options 57, 89, 117Original Printer Resources 107Original resources 71OS/390 67, 140OS/400 67Output Datastream object 75, 78, 119Output Datastream section 119Output File Name

Project Settings dialog 125Output message types 139Output Trace Comments

Project Settings dialog 123Output window 24, 37, 120Overlay 50OverrideSymbols

Application INI Section dialog 94Host INI Section dialog 108Preferences INI Sections dialog 121

P

Page SizeImport Printer Resources wizard 113

Parallel-enabled Rules 67ParallelProcessing

Host INI Section dialog 108

Index - P 145

Password 19Export Snapshot wizard 106FTP 87Logon to DOC1 for Workgroups dialog 117Properties dialog 126

Paste 53, 97, 120PCL

Generating metrics 71PDF

Generating metrics 71Importing fonts 42

PDF/Postscript compatible resources 112Permissions 137Point Size

Import Printer Resources wizard 114Post Build Step

Project Settings dialog 124PostScript

Generating metrics 71Importing fonts 42

Postscript image resolutionImport Printer Resources wizard 113

Pre Build StepProject Settings dialog 124

PreferencesINI Sections 121

Preferences object 75, 77, 121Preferences0-9

Preferences INI Sections dialog 121PrintDevice

Printstreams dialog 119Printer resources 41

Mapping names in metrics files 70Production Administrator role 30Production Rules Files 22, 66

Deploying 75File names 66

Project 13, 27, 33Change reports 90Copying 34Create Revision 99Creating 34Properties 43, 127Working folder 35

Project Administrator role 30, 129Project change report 90Project Name

Import DOC1 Application dialog 109Project properties 127Project revision 43, 99Project Settings 122

Build options 66Projects

Allowing access 32Properties 58, 125, 126, 127Purge

Project properties 127Purge deletions 43

R

Rebuild All 66, 68, 127Recovering deleted resources 59, 60Recurse Sub-folders

Check In dialog 96Reference resources form shared resources

Project Settings dialog 123Reference resources from shard resources 67

Referenced listDelete warning dialog 100

Referenced resources 63Renaming 58Viewing 'used by' list 58

Refresh 23, 128Remove Local Copy 55

Adding dialog 93Remove rotation suffixes

Import Printer Resources wizard 113Rename 58, 128Report Changes 90, 128Report Selection

Report Changes wizard 129Repository 12, 24

Branching 98Installation 28

Repository View 24Resolution 70

Build Rules Dialog 95Resource Administrator role 30Resource types

Import Printer Resources wizard 112Resources 13, 45

Adding 54Copying 53Deleting 59Editing 56Importing 36Printer/browser 41Referenced 63Renaming 58Restoring 59Viewing 56

RestoreProject properties 127

Restore deletions 43Restore Projects 28Restore version 63Restoring 59Revision History 63, 90, 133Revision Label

Project Revision dialog 99Revisions 99

Project level 43Synchronizing 63Viewing latest properties 58

Rights 27, 31Overriding 32

Roles 27, 129Roll Back 62

Revision History dialog 134Roll Back in all projects

Roll Back Options dialog 134Roll Back Options dialog 134Rollback this file only

Roll Back Options dialog 134Rollback with custom synchronization

Roll Back Options dialog 134Rollback with default synchronization

Roll Back Options dialog 134

S

Sections 48, 75, 79, 103Name 49, 104

Select 51, 130Select All 51, 131

146 Index - R

Selected files to convertImport Printer Resources wizard 112

Send an existing snapshot to someone (using FTP)Export Snapshot wizard 105

Send Snapshot 88ServerCommands

Host INI Section dialog 108Set Working Folder 35, 131Settings 67, 72Settings objects 75Shadow Bundle Objects 38, 110Share 53, 131

Branching 53Break 53

Share Files dialog 132Share Files Into Project

Share Files dialog 132Share Referenced Files

Share Files dialog 132Shared folder 28, 32, 41, 52Shared resources 52

and synchronization 63Viewing project lists 58

Show Revisions 62, 83, 91, 101, 133Since a date

Report Changes wizard 129Since a project revision

Report Changes wizard 129Snapshot 86, 105Split 48, 134SRCSAFE.INI 19Status Bar 25Sub Documents 18, 38, 46, 50Substitution variables 77Symbols

Application INI Section dialog 94Host INI Section dialog 108Preferences INI Sections dialog 121

Synchronization 63Synchronize File dialog 134System

Application INI Section dialog 95Host INI Section dialog 108

T

Target 83, 101Time

Report Changes wizard 129Tool Bar 25Type

Build Rules Dialog 95

U

Undo Check Out 56, 135Update existing files

File Copy dialog 98Import DOC1 Application dialog 109Share Files dialog 132

Update existing resource packBuild Rules dialog 95

Use existing code pageImport Printer Resources wizard 113

Use Resource Packs 67Project Settings dialog 123

Use Same Comment For All Files 57, 96

Use symbolic substitution fileImport Printer Resources wizard 112

Used by overlayImport Printer Resources wizard 113

User Name 19Export Snapshot wizard 106FTP 87Logon to DOC1 for Workgroups dialog 117Properties dialog 126

USERID.LOG 89Users 12, 27, 135

Adding and configuring 29Registering 29Rights 31

V

View 45, 56, 136View read only 57, 118Visual SourceSafe 19, 27

W

Workgroups client 19Working Folder 35, 45

Copy Project dialog 98Import DOC1 Application dialog 109

Workstation font 114Workstation name

Import Printer Resources wizard 114Workstation resources 71, 107

X

Xerox font resource typeImport Printer Resources wizard 113

Xerox image resource typeImport Printer Resources wizard 113

Xerox resources 112

Y

You are about to copy...File copy dialog 98

Index - Y 147

148 Index - Y