xResponse User Guide Build 39

xPression 3
xResponse User Guide
© 2001-2008 by EMC Document Sciences Corporation. All rights reserved.
The copyright protection claimed includes all formats of copyrightable material and information governed by current or future statutory or judicial law. This includes,
without limitations, any material generated by the software programs that display icons or other screen interfaces. You may not copy or transmit any part of this
document in electronic or printed format without the express written permission of Document Sciences Corporation. xPression, CompuSet, and all other Document
Sciences Corporation products mentioned in this publication are trademarks of Document Sciences Corporation. For complete copyright information, please see the
file xPression Licensing Document.pdf located on your eBook Library CD.
Document Sciences Corporation, 5958 Priestly Drive, Carlsbad, CA 92008
www.docscience.com
Document Sciences Corporation
Table of Contents
Table of Contents
Introduction .................................................................................................... 6
Boxes and Revision Bars ................................................................................................................................... 6
Solution Support ................................................................................................................................................ 7
Getting Around in xResponse ...................................................................... 8
Logging on to xResponse .................................................................................................................................. 8
The xResponse Desktop ................................................................................................................................... 9
Language Localization Support ....................................................................................................................... 10
Microsoft Office Language Pack ......................................................................................................... 10
Now That I’m Logged on, What Can I Do? ...................................................................................................... 12
Logging Off ...................................................................................................................................................... 12
Using the Work in Progress Function .............................................................................................................. 13
Publishing Note History ....................................................................................................................... 15
Approving Documents ..................................................................................................................................... 16
How Do I Approve a Document? ........................................................................................................ 17
The Approval Preview Page ............................................................................................................... 18
How Do I Reject a Document? ............................................................................................................ 18
Previewing a PDF ............................................................................................................................................ 19
Activate Preview PDF ......................................................................................................................... 19
Configure Preview PDF ...................................................................................................................... 19
Use Preview PDF ................................................................................................................................ 20
Building a Letter With xResponse ............................................................. 21
Step 1: Prepare the Document ........................................................................................................................ 21
Where Do The Documents Come From? ........................................................................................... 22
Step 2: Verify That the Customer Data is Correct ............................................................................................ 23
Document Sciences Corporation
4
Table of Contents
Step 3: Preview Your Letter ............................................................................................................................. 24
What Are Optional Paragraphs? ......................................................................................................... 25
Step 4: Edit the Document ............................................................................................................................... 26
The Response Java Editor .................................................................................................................. 26
Using Track Changes ......................................................................................................................... 27
The Word Editor .................................................................................................................................. 27
Accepting and Rejecting Changes to a Document ............................................................................. 28
Step 5: Distribute the Letter ............................................................................................................................. 29
The xResponse Editors ............................................................................... 30
About the xResponse Editors .......................................................................................................................... 30
How Does the xResponse Java Editor Work? .................................................................................... 30
Loading the Plug-in ............................................................................................................................. 30
Spell Checking .................................................................................................................................... 31
Automatic Spell Checking ................................................................................................................... 31
Saving an Edited File .......................................................................................................................... 31
External Clipboards and the xResponse Editor .................................................................................. 32
Known Issues With the Java Editor .................................................................................................... 32
Implementing the Track Changes Utility ............................................................................................. 33
Accepting and Rejecting Changes ...................................................................................................... 33
Working with Protected Documents .................................................................................................... 33
How Does the xResponse Word Editor Work? ................................................................................................ 34
Setting xResponse Word Editor Version ............................................................................................. 34
ActiveX Controls and Plug-ins ............................................................................................................ 34
Toolbar Configuration ......................................................................................................................... 35
Known Issues With the Word Editor ................................................................................................... 35
Auto-Correction in the xResponse Editor ............................................................................................ 35
Adjusting the Word Editor and Preview Window Size ......................................................................... 35
Auto-Hyphenation in the xResponse Word Editor .............................................................................. 36
Different First Page Headers and Footers ....................................................................................................... 36
xResponse FastPath ................................................................................... 37
Parameter Query Strings ................................................................................................................................. 37
Category ............................................................................................................................................. 38
Custkeys1-Custkeys10 ....................................................................................................................... 38
Document ............................................................................................................................................ 39
Page .................................................................................................................................................... 39
Password ............................................................................................................................................ 41
UserName ........................................................................................................................................... 41
Document Sciences Corporation
5
Table of Contents
WIPID .................................................................................................................................................. 42
Operation ............................................................................................................................................ 42
XMLCustomerData and DataSourceName ...................................................................................................... 43
DataSourceName ............................................................................................................................... 43
XMLCustomerData ............................................................................................................................. 43
Example .............................................................................................................................................. 44
Using Unicode Characters with xResponse FastPath .................................................................................... 46
Automatic Distribution and Log Off .................................................................................................................. 46
Encrypting Passwords in Fastpath .................................................................................................................. 47
Customer Data Template ............................................................................ 48
Toolbar Configuration ................................................................................. 53
Toolbar Notes and Limitations ......................................................................................................................... 53
Toolbar Configuration File Listing .................................................................................................................... 53
Element Properties .......................................................................................................................................... 68
Document Sciences Corporation
Chapter 1
Introduction
1
Welcome to xResponse, a Web-based correspondence application that provides transactional services for
xPression documents through a Web browser.
Boxes and Revision Bars
The following colored boxes alert you to special information in the documentation.
Caution: The caution box warns you that a fatal error, unsatisfactory output, or loss of data
may occur if you do not follow the directions carefully.
Tip: A tip offers suggestions to simplify a task or describes a useful shortcut. They may also
describe an alternate way to use the techniques described in the text.
Note: A note offers information that emphasizes or supplements important points of the main
text.
Revision bars help you locate new or changed information. Look for these revision bars in the right margin of each
affected page.
Document Sciences Corporation
7
Chapter 1 - Introduction
Solution Support
For more information or to solve a problem, contact Document Sciences Solution Support:
Telephone: (760) 602-1500
Fax: (760) 602-1515
World Wide Web: http://support.docscience.com
E-mail: [email protected]
Document Sciences Corporation
Chapter 2
Getting Around in xResponse
2
xResponse is a Web-based correspondence application that provides transactional services for xPression
documents through a Web browser.
Logging on to xResponse
You can access xResponse from your Web browser by typing the URL for the xResponse default Web site. For
example: http://MYSERVER\xPressionResponse. Add the page to your Favorites list to make access quicker.
xPression validates your network user name and password to determine your access permissions, and retrieves
your user name from your corporate network security system (such as LDAP or NDS).
Figure 1. Supply
your network
username and
passoword and
click Login to
connect to the
defined xPression
server and return a
list of available
categories.
Document Sciences Corporation
9
Chapter 2 - Getting Around in xResponse
The xResponse Desktop
xPression validates your network user ID and password to determine your access permissions. The main
xResponse page appears, displaying your current session information in the left margin and a series of tabs that
enables you to perform specific tasks.
Figure 2. The
main xResponse
page.
This page contains the following elements.
Element Name
Description
Build a Letter tab
This tab is your entry point into xResponse. From here you will create documents and
submit them for distribution.
Work in Progress tab
Click here to check the status of your active documents. This tab shows the documents
not yet submitted for approval, and any documents requiring further action from you.
Approvals tab
Click here to check for documents awaiting your approval.
Prepare Document
workspace
In this section, select the category, document, and customer record from these lists.
Session Information
Displays your current session information.
Document Sciences Corporation
10
Chapter 2 - Getting Around in xResponse
Language Localization Support
xPression supports French Canadian and Chinese languages in the user interfaces. To use a French Canadian or
Chinese user interface, set the locale on your local machine to either French Canadian or Chinese. You can set
your locales from the Windows Control Panel in the Regional and Language Options application. To configure
your locale for a specific language, click the Regional Options tab.
Figure 3. Regional
updates.
Select your desired language from the list in the Standards and formats section. For Chinese language, choose
Chinese (PRC). For French, choose any variety of French.
On the Languages tab, click Details and ensure your language appears in the Installed Services box. Also on the
Languages tab, if you are using the Chinese language, ensure that you select the Install files for East Asian
languages option.
On the Advanced tab, ensure your language is selected in the Language for non-Unicode programs and that the
code pages for your language are selected.
Click OK.
Microsoft Office Language Pack
The editing process in xResponse is entirely local, so it is necessary to have Microsoft Office Language Pack
installed and configured on the local machine for the language of your choice to be used in the editor’s interface.
Refer to your Microsoft Office documentation for information on installing Microsoft Office Language Pack.
Document Sciences Corporation
11
Chapter 2 - Getting Around in xResponse
To Configure Microsoft Office Language Pack:
1. Click Start, point to Programs, Microsoft Office, Microsoft Office Tools, and then click Microsoft
Office Language Settings.
2. On the User Interface and Help tab select your language from the Display Office in list to set the interface
language and from the Display Help in list to set the Microsoft Office Help language.
3. Open the Enabled Languages tab.
4. Select your language from the Available Languages list and then click Add. The language is added to
the list of enabled languages.
5. Select your language from the list to set it as the default language for Microsoft Office applications.
Figure 4. Select
the language that
you want for the
editor interface
and help on the
User Interface and
Help tab. Enable
languages and set
the default
language on the
Enabled
Languages tab.
6. Click OK.
7. A message opens advising you of the effects of changing the default language. Click Continue and lose
customizations.
The changes will take place the next time you open any Microsoft Office application, including the xPression
editors. Note that thin client application interfaces will be in the language selected in Regional and Language
Options regardless of the settings that you have chosen in Microsoft Office Language Settings.
Document Sciences Corporation
12
Chapter 2 - Getting Around in xResponse
Now That I’m Logged on, What Can I Do?
Access rights determine what activities individual users can perform on work items with xResponse. The Access
Rights portion of the Category Management utility in xAdmin enables the system administrator to authorize access
on different levels to users of xPression applications.
xResponse incorporates the following levels of authority. You should also note that these levels are nonhierarchical, which is another way of saying that a user with Approve authority may not necessarily have Write
privileges. Each level is assigned separately.
Level
What Can You Do?
Read
Request, preview, and distribute documents.
Write_Data
Modify the customer data (in the primary table only) used to build a document,
request, preview, and distribute a document.
Write_Document
Modify the data source (in the primary table only) used to build a document, request,
preview, edit with the secured browser editing interface, and distribute a document.
Approve
Approve documents and content. This is the highest approval level.
If your HTTP session expires, you will lose your connection to xResponse and be unable to log on again. Contact
your system administrator and have him or her use the Concurrency Controls function in the License Management
section of xAdmin to stop your session. When the session is stopped, you'll be able to log on.
Logging Off
Be sure to log off xResponse before you close your Web browser window. If you close your browser before logging
off, xPression won’t release your user name. You won’t be able to log on again until your session times out, or you
use the Concurrency Controls utility in xAdmin to release your session.
Document Sciences Corporation
13
Chapter 2 - Getting Around in xResponse
Using the Work in Progress Function
The Work in Progress tab displays a list of the documents you’re working on that have not been submitted for
approval, or that require further action from you. By default, the documents are listed in alphabetical order, but you
can click a table header to reorder the list according to the values in that column.
Figure 5. The
Work in Progress
tab.
This page contains the following elements.
Element Name
Description
Open Button
Opens the selected document for viewing and editing. For more information, see Step 4:
Edit the Document.
Notations
Opens the notations attached to the selected document in a small window. You may add
to the notes from this window, cancel your changes, or delete the note.
Distribution
Opens the Distribution page. For more information, see Step 5: Distribute the Letter.
Reassign
Reassigns a document with an Active status to another approver if, for example, you’ll
be on vacation for several days. From the Work in Progress tab, you can reassign a
document to another user. You can only reassign documents to users authorized to view
the originating category.
Document Sciences Corporation
14
Chapter 2 - Getting Around in xResponse
Element Name
Description
Delete
Deletes the selected work items.
Work in progress list
This list displays all existing works in progress. Click the work item name to open it.
Click a column header to sort the letters by the column values.
Each work in progress item in the list has a Note, Distribute, Reassign, and Delete
button. These buttons are different than the buttons that appear on the Actions toolbar.
The work item buttons apply only to the individual work item and not to the other work
items in the list.
This list contains three additional columns:
Customer File Key - List the customer file key for the current document.
Action Date - Lists the date of the last action.
Reassigner - The name of the user who reassigned the document.
If you want to include a short note to the person who’s getting the letter, select his or her user name from the
Reassign document to list, then add your message in the Notes box.
Figure 6. Adding a
Note to a
Reassigned Letter.
Document Sciences Corporation
15
Chapter 2 - Getting Around in xResponse
When the reassigned letter appears in the recipient’s Work in Progress list, he or she can select the letter, then
click Note to view your message.
Figure 7. The note
as viewed by the
recipient.
When adding a new note, the Add button appears instead of the Update Note and Cancel buttons. If the workflow
state of this document doesn't change (submit/reject/reassign/approve/distribute) and the current document owner
is the creator of the notes, existing notes can be updated and deleted.
Publishing Note History
To publish your notes along with your document, select Output Notes in your xPublish Distribution Definition. This
option is available only when Individual print file for each customer is selected. The following points apply to the
Notes output file:
•
The notes file is distributed into the same Output Directory used for Print Files.
•
The notes file name is same as the output file.
•
The notes file is in XML format using this general format:
<?xml version="1.0" encoding="UTF-8"?>
<Annotation>
<Item user="tester" timestamp="20070523064025">Modify the document later</Item>
<Item user="tester" timestamp="20070523064052">Help to check this document</Item>
</Annotation>
Document Sciences Corporation
16
Chapter 2 - Getting Around in xResponse
Approving Documents
If you have Approve-level access rights, your Approvals tab will show a list of documents awaiting your approval.
The list displays in order by action date. Click a table header to reorder the list according to the values in that
column.
Figure 8. The
Approvals tab.
This page contains the following elements.
Element Name
Description
Open
Opens the selected document for viewing and editing.
Note
Opens the notations attached to the selected document in a small window. You may
add to the notes from this window, cancel your changes, or delete the note.
Approve
Starts the Approval process.
Reject
Sends the letter back to the person who submitted it to you for approval.
Delete
Deletes the selected work items.
Document Sciences Corporation
17
Chapter 2 - Getting Around in xResponse
Element Name
Description
Work in progress list
This list displays all existing documents awaiting approval. Click the document name to
open it. Click a column header to sort the letters by the column values.
Each document in the list has a Note, Approve, Reject, and Delete button. These
buttons are different than the buttons that appear on the Actions toolbar. The document
buttons apply only to the individual document and not to the other documents in the list.
How Do I Approve a Document?
Clicking the Approve button launches a notation window, and does one of the following three things:
•
If you aren’t the final approver, this action approves the document to the next approval level and sends the
document to the person defined as your approver.
•
If you are the final approver and the originator of the document requested that the document be distributed
by the approver, xPression automatically distributes the document after you approve it.
•
If neither of the first two conditions exists, this action reassigns the document back to the original owner
with a status of Ready to Distribute.
Figure 9. Approve
d document
notation window.
Document Sciences Corporation
18
Chapter 2 - Getting Around in xResponse
The Approval Preview Page
The approval preview page enables the approver to verify the document before approving it. You can launch the
xResponse Editor to make changes to the document by clicking Open.
Figure 10.
Approval preview
screen.
Changes made in the edit session will appear in the preview screen with track change markers. Click Accept All
Changes to re-display the document without the track change markers in the preview window.
Note: Documents that use xPression Publish as their publisher cannot display or publish
external content in PDF format. It may be possible to convert the PDF to an image, add it to the
xPression database, and handle it in this manner.
How Do I Reject a Document?
When you reject a document, xPression sends the document back to the user who submitted it. xResponse
displays a pop-up window when a document is rejected, enabling you to add a notation explaining why you’re
Document Sciences Corporation
19
Chapter 2 - Getting Around in xResponse
rejecting the document. The notation is available from the Work in Progress list of the user who submitted the
document.
Figure 11. Rejecte
d document
notation window.
Previewing a PDF
You can now preview PDFs from the xResponse preview pages for the Build a letter, Work in Progress, and
Approval tabs for both CompuSet and xPublish documents.
When this functionality is activated, a Preview PDF button will appear on the preview pages for the Build a letter,
Work in Progress, and Approval tabs. After clicking the button, the preview PDF will be displayed in a pop-up
window.
Activate Preview PDF
To activate this feature, set EnablePreviewPDF=true in your eCor.properties file.
Configure Preview PDF
You must configure this feature for both CompuSet and xPublish using the CompusetPreviewPDFOP and
PublishPreviewPDFOP properties in the eCor.properties file.
For each of these properties you need to supply the name of an existing output profile that meets certain criteria.
Document Sciences Corporation
20
Chapter 2 - Getting Around in xResponse
CompusetPreviewPDFOP
For this property, you need to supply the name of an existing CompuSet output profile. This profile must include
only one combination of output stream, format definition, and distribution definition. Additionally:
•
Recipient specified in the output profile must be consistent with the recipient specified in the document. If
the document does not include a recipient specified in the output profile, then no output will be produced.
•
The format definition must be “PDF”.
•
The distribution definition must use the “Return to calling application” mode.
For example:
CompusetPreviewPDFOP=return to caller
No PDF output stream will be generated if CompusetPreviewPDFOP is not set to a valid output profile and an error
message will be generated.
PublishPreviewPDFOP
For this property, you need to supply the name of an existing xPublish output profile. This profile must include only
one combination of output stream, output definition, and distribution definition. Additionally:
•
Recipient specified in the output profile must be consistent with the recipient specified in the document. If
the document does not include a recipient specified in the output profile, then no output will be produced.
•
The output definition must be PDF.
•
The distribution definition must use the “Return to calling application” mode.
For example:
PublishPreviewPDFOP=return to caller
No PDF output stream will be generated if PublishPreviewPDFOP is not set to a valid output profile and an error
message will be generated.
Use Preview PDF
After setting these properties, the Preview PDF button will appear on the preview pages for the Build a letter, Work
in Progress, and Approval tabs for both CompuSet and xPublish documents.
Click the Preview PDF button to display the preview PDF in a pop-up window.
Document Sciences Corporation
Chapter 3
Building a Letter With xResponse
3
The Build a Letter tab uses a wizard to guide you through the steps you need to create letters and distribute them
to your customers. Here’s what you’ll do:
•
Step 1: Prepare the Document
•
Step 2: Verify That the Customer Data is Correct
•
Step 3: Preview Your Letter
•
Step 4: Edit the Document
•
Step 5: Distribute the Letter
Step 1: Prepare the Document
To begin your letter, select the category, document, and customer record from the lists and click Continue. Since
the document list depends on the selected category, and the customer data source depends on the selected
Document Sciences Corporation
22
Chapter 3 - Building a Letter With xResponse
document, work from left to right on this page. To skip the verification and preview steps, click Distribute to send
the document. Otherwise, click Next to proceed.
Figure 12. First,
select a category,
then a document,
and finally a
customer. Then click
Next.
Where Do The Documents Come From?
Document designers at your company have used a design, testing, and proofing application called xDesign to
create the documents you work with in xResponse.
Using xDesign, they define business logic, or business rules, that include or exclude portions of content, based on
the information contained in your customer data. xDesign stores the content, images, and other document
information in a single xPression database.
When a document is approved, the document designer creates a document version to make the document
available to xPression production services like xPression Batch, xResponse, and xRevise. These applications use
the document version to assemble, customize, and distribute the document.
Document Sciences Corporation
23
Chapter 3 - Building a Letter With xResponse
Step 2: Verify That the Customer Data is Correct
The Customer Data page displays all the customer data retrieved from the primary table of the customer data
source. Verify that the customer data is correct. If you have Write_Data access to the selected category, you can
modify the data (in the primary table only) from this page. Changes are applied automatically. Changes apply to
the current session only, customer data is not changed in the customer data source.
Note: The data you change on this page must not contain XML reserved characters, such as
the ampersand (&), left and right brackets (<>), apostrophe (‘), and double quotation marks (“).
To preview the letter in the xResponse Editor, click Continue. Otherwise, click Distribute to skip the preview and
send the document to the customer.
Figure 13. Verify
customer data page.
If the standard Customer Data Page does not meet your needs, you can create a Customer Data Template.
Document Sciences Corporation
24
Chapter 3 - Building a Letter With xResponse
Step 3: Preview Your Letter
The document appears in the xResponse Editor. To edit the document (if you have Write_Document access
priveleges), click Edit. To distribute the document without changes, click Continue. Click Save to save the current
document to your work in progress list.
xDesign supports Word’s Protect Document feature. If a content item was protected using this feature you will not
be able to edit it in Response. It is possible to protect an entire content item, or only specific sections. If you need
to make changes to a protected content item, you must use Design to create a new approved version of the
content item with protection turned off.
Figure 14. A
preview of your
letter.
Document Sciences Corporation
25
Chapter 3 - Building a Letter With xResponse
If the document contains optional paragraphs, the paragraph names appear in the Insert pane. The document in
the preview pane displays the optional paragraph group names inserted into the document with track changes.
Click the hyperlinked name of an optional paragraph to preview the paragraph.
Figure 15. The
Optional inserts
page.
What Are Optional Paragraphs?
Optional paragraphs enable you to choose the text included in an assembled document. Optional paragraphs are
user-selectable paragraphs created by the document designer for use by xResponse users in a specific location in
a document.
Optional paragraphs are organized and displayed in groups. There are two types of optional paragraph groups:
Multiple select and Single select. Multiple select groups, signified by check boxes, enable you to select one or
more paragraphs from the same group. Single-select groups enable you to select only one paragraph from the
group.
Figure 16.
Optional paragraph
groups.
Single select content. You
can choose only one to
use in your letter.
Multiple select items. You
can use more than one in
your letter.
Document Sciences Corporation
26
Chapter 3 - Building a Letter With xResponse
Step 4: Edit the Document
You can edit documents in one of two editors: the standard Java editor, or the Microsoft Word editor. See The
xResponse Editors for information on how to select an editor, specific issues related to either editor, and .
The Response Java Editor
The xResponse Editor is a Java 1.4.2 Swing applet that runs on Microsoft Internet Explorer6.0 versions starting
with 6.0.26. The xResponse Java Editor enables you to edit the content of an instantiated document before you
send it to a customer. xResponse doesn’t currently support documents that use non-Latin based (Arabic, Semitic,
Cyrillic, and so on) characters.
Figure 17. The
xResponse Java
editor.
Bold, Italics, Underline
Style
Font
Size
Cut,
Copy,
Paste
Save
Spelling Check
Undo
The Java editor respects protected text that was established in xDesign. To bypass protected sections and go
directly to the next unprotected section, use the arrow keys.
If you have Write_Document-level access, you can use the xResponse Java Editor to perform basic editing tasks
such as:
•
Text formatting (such as bold, italics, underscoring, and font selection).
•
Spell checking.
•
Inserting and deleting text.
However, you can’t use the xResponse Java Editor to:
•
Save a document to your hard drive, or load a document from hard drive or diskette.
•
Cut, copy or paste images from the clipboard.
•
Insert or modify images, audio files, or embedded objects (such as spreadsheets).
•
Insert headers, footers, or footnotes.
•
Insert page or section breaks.
•
Print a document.
Document Sciences Corporation
27
Chapter 3 - Building a Letter With xResponse
Click Save Work to store your document, then click Distribute to submit the completed document for distribution.
Caution: If you click Distribute before Save Work, xResponse will not save your changes.
Using Track Changes
This feature enables you to quickly identify changes made to a document. The xResponse Editor marks inserted
and deleted text according to user specifications and labels them with the user name of the individual who made
the changes. The Track Changes feature is compatible with Microsoft Word. xResponse is automatically set up to
use the xResponse Editor.
You can specify the way Track Changes appear on the screen through xAdmin. Available options for inserted text
are underline, double underline, italics, bold, and none (default). Available options for deleted text are hidden,
strike through, and none (default). Each change is marked with the network user ID of the individual who made the
change and a date/time stamp. The change marks are visible to you in xResponse, but not to the intended
recipient. For more information, see Implementing the Track Changes Utility.
Figure 18. The Java
editor does not track
format changes.
Deletion
New Text
The Word Editor
The Response Word editor uses Microsoft Word as the interface. This editor is provided through an ActiveX
control, so when you load it Internet Explorer issues a warning that the control that the control can interact with
other elements of the page. Click Yes to load the control and proceed with editing.
Figure 19. The
xResponse Word
editor toolbar.
Document Sciences Corporation
28
Chapter 3 - Building a Letter With xResponse
Word provides access to its functions with a collection of toolbars. You can choose which toolbars are displayed by
right-clicking the toolbar area and choosing them from the list. Most toolbars are available in Response, except for
the Reviewing toolbar.
If you have Write_Document-level access, you can use any of Word’s functions as they are implemented in Word
except for Save and Save As functions. All documents are saved to the xPression database. Some Word toolbars
and controls are suppressed by default, but you can specify which toolbars, menus, and controls are available
using Toolbar Configuration.
Track Changes
Changes are indicated in the Word editor using the markup function that Word uses for Track Changes; changes
are highlighted by a font and color combination for the changed text and with details specified in balloons to the
side of the text. Track Changes settings in xAdmin do not affect change indicators in the Word editor.
Accepting and Rejecting Changes to a Document
After you use xResponse to make changes to a document, the document is sent to an approver for validation. The
approver can view the changes, accept all of the changes, make new changes, and accept or reject the document.
The approver can also preview the altered document before accepting the changes. This is generally true
regardless of your editor, although there are some differences in how changes are indicated in the document. For
more information, see Approving Documents.
Figure 20. Tracked
changes.
Deletion
New Text
Format Change
Document Sciences Corporation
29
Chapter 3 - Building a Letter With xResponse
Step 5: Distribute the Letter
Do you want the approver of this letter to distribute the document after he or she approves it? If you select Yes,
xPression distributes the document upon approval. If you select No, xPression returns the document to you for
distribution after it is approved.
Figure 21. These
are output profiles
“attached” to the
letter by the
document designer
in xDesign.
Select a distribution method from the list and click Continue. If you selected Yes to have your approver distribute
the document, proceed to Using the Work in Progress Function. If you selected No, xResponse returns you to the
Prepare Document screen and displays a message that the document was distributed successfully. If Return to
Calling Application is selected in the distribution definition, and there is only one document, the document will open
instead of the Prepare Document screen.
Document Sciences Corporation
Chapter 4
The xResponse Editors
4
xResponse provides two editor options: a Java applet and a Microsoft Word interface provided through an ActiveX
control. To use the Word editor, set the responseEditor property in eCor.properties on the xPression server to
“word.” Any other value will select the Java editor. Also, if using Word, set the wordEditorVersion to the appropriate
version of Microsoft Word; 2002 or 2003.
About the xResponse Editors
The xResponse Java Editor is an applet that runs on Microsoft Internet Explorer 6.0 versions starting with 6.0.26.
You must download a Java Runtime Environment plug-in from Sun Microsystems to run the editor. The xResponse
Editor enables the end user of Response or an xPression Framework correspondence application to edit the
content of an instantiated document before sending it. With Track Changes, you can track the changes to a
document while in a xResponse edit session. Documents that use non-Latin based characters aren’t supported.
You’ll find all the files discussed in this appendix in [drive:]\xPression Framework\xPression Editor Samples on the
eBooks CD.
The Word editor provides access to most Microsoft Word features, so it provides more options for editing your
documents than the Java editor. You must have Word installed on the client machine to use this editor.
How Does the xResponse Java Editor Work?
The xResponse Java Editor resides on an HTML page. For the purposes of this documentation, this page is called
the editor page. When you attempt to edit a document with the xResponse Editor, your browser loads the editor
page. The editor page checks the end-user’s browser for the Java 1.4.2 plug-in. The xResponse Editor requires
this plug-in to run.
Loading the Plug-in
If the editor page detects the plug-in, it begins to load the xResponse Editor. If the editor page fails to locate the
plug-in on your system, it downloads the plug-in from the directory defined on the editor page. You can locate the
plug-in on your company’s intranet or download it from Sun Microsystems (http://www.sun.com). Please see the
Document Sciences Corporation
31
Chapter 4 - The xResponse Editors
Sun documentation for instructions on how to make the plug-in available from your intranet site. The sample editor
pages included with your software are set up to access the Sun Web site.
After you install the plug-in, the editor page downloads the editor .jar file, and passes control to the applet. The
editor loads the necessary icon files and the document specified for editing from the server upon initialization. The
editor then displays the document for editing.
Spell Checking
The xResponse Editor uses a spell checking subsystem that comes from Wintertree Software. When the user
requests a spelling check, the applet loads the spell check configuration file for the language specified on the edit
page. The configuration file ties directly to the Wintertree spell checker, and is located in the editor’s .jar file. The
configuration file can be extracted for editing, but typically does not need to be altered. Consult the Wintertree
documentation if you need to alter the file.
The xResponse Editor supports the English and British spell checking libraries. You may obtain other spell
checking libraries from Wintertree, www.wintertree-software.com. For more information about using the spell
checker, see How Does the xResponse Word Editor Work?.
Automatic Spell Checking
Use this feature to enable an “automatic” spelling check to occur when you save a document in the xResponse
Editor.
To activate the spelling checker:
1. Locate the file ecor.properties in the [drive:]\xPression folder on your server and open it with Windows
Notepad or a similar text editor.
2. Find the responseAutoSpellCheck entry and add =required to enable automatic spell checking. For
example:
responseAutoSpellCheck=required
To disable the automatic spelling checker, remove =required and replace it with =novalue.
Note: Disabling automatic spell checking does not disable the spelling checker, just the
“forced” checking that occurs when you save a document.
Saving an Edited File
When you save a file from within the editor, the editor sends the file to the CGI application specified on the editor
page using an http post command. The application receives the file and saves it to the same directory it received
the original file from. The editor ships with a small CGI application called Upload.exe. You can use this file to
perform the save operation, or you can create your own.
Document Sciences Corporation
32
Chapter 4 - The xResponse Editors
Upload.exe saves the file under the name mod_filename.htm, where filename is the original name of the edited
file. The editor does not present a save dialog because the file is not saved to a local disk or user specified
directory. Upload.exe also creates a log file named Log.txt. This log file logs each save operation performed by
Upload.exe, and is used for debugging purposes only.
External Clipboards and the xResponse Editor
xPression enables you to cut, copy, and paste between external clipboards and the xResponse editor. To address
the security issues involved in this interface, you must add an entry to the java.policy file on each client computer.
To update the file:
1. Locate the java.policy file. On most computers, it is in C:\Program Files\Java\j2re1.4.1_03 \lib\security.
2. Open the file in WordPad.
3. Place the cursor before the bracket } at the bottom of the page and press Enter twice.
4. Move the cursor up one line and type permission java.awt.AWTPermission "accessClipboard";
5. Save the document and close WordPad.
Known Issues With the Java Editor
Please be aware of the following issues before starting work on your documents.
Java Editor Does Not Support Chinese Unicode Characters
You cannot edit Chinese Unicode characters with the Java Editor. Chinese Unicode characters are not supported.
However, the Java editor can display most Chinese characters correctly if you change your System Locale and
Current User Location settings to Chinese (PRC). These fonts can be displayed, but not edited.
Bullets From the Wingdings Font Display Incorrectly in the Java Editor
If your document uses bullet characters from the Wingdings font, those bullet characters will not display correctly
in the Java editor. The problem is isolated to the Java editor and will not affect the appearance of the bullets in your
output.
The bullets will continue to preview correctly in xResponse, xRevise, and xDesign. They will publish correctly from
xPression Batch, xResponse, xRevise, and xDesign.
Font Changes
The xResponse Java Editor does not show any changes made to the font size or style, but the changes do appear
in the final output.
Document Sciences Corporation
33
Chapter 4 - The xResponse Editors
External PDF Content Not Supported
External PDF content is not supported through xResponse. The PDF will be lost when publishing through
xResponse and the xPression system will not generate an error for the lost content.
Implementing the Track Changes Utility
This feature enables you to quickly identify changes made to a document. The xResponse Editor marks inserted
and deleted text according to user specifications and labels them with the username of the individual who made
the changes. The Track Changes feature is compatible with Microsoft Word.
You can specify the way Track Changes appear on the screen through xAdmin. Available options for inserted text
are underline, double underline, italics, bold, and none (default). Available options for deleted text are hidden,
strikethrough, and none (default). Each change is marked with the user ID of the individual who made the change
(the ID that appears here is passed in by the editor page as the value of the Userid parameter), and a date/time
stamp. The change marks are visible to you in xResponse, but not to the intended recipient. For more information
about configuring Track Changes, see the xAdmin Enterprise Edition User Guide.
Accepting and Rejecting Changes
After you use xResponse to make changes to a document, the document is sent to an approver for validation. The
approver can view the changes, accept all of the changes, make new changes, and accept or reject the document.
The approver can also preview the altered document before accepting the changes.
Working with Protected Documents
The document designer can make sections of the document protected. Sections identified as editable can be
changed as required without any special action. To edit other sections, you must turn protection off. You can turn
protection off either by clicking Stop Protection on the Protect Document pane, or by selecting Unprotect
Document from the Tools menu. Passwords do not apply in xDesign, and any password applied through the Word
interface are discarded. If you applied a password on the Templates tab of Document Properties in xDesign, then
xResponse users will be required to present the password to turn protection off and make changes to sections not
marked as editable
Document Sciences Corporation
34
Chapter 4 - The xResponse Editors
How Does the xResponse Word Editor Work?
The Word editor accesses Word using an ActiveX control. When you open a document with the Word editor,
Revise loads the control and displays the document with Word. When the control loads you will receive the
following message.
Figure 22. Active X
warning.
Click Yes to proceed. This message is part of Internet Explorer’s security system to prevent harmful programs
from being introduced to your computer and is always displayed when an ActiveX control of this type is loaded.
Most Word functions are available. Refer to The Word Editor for a complete list of Word functions that are not
supported.
Setting xResponse Word Editor Version
If you use the Microsoft Word editor in xResponse, you must set the version in eCor.properties.
To set Microsoft Word as your xResponse editor:
1. Open eCor.properties. Properties files are located in the xPressionHome directory.
2. Set the responseEditor property to word. If this property is set to any other value the Java editor will be
used.
3. Set the wordEditorVersion property to the appropriate value, either 2002 or 2003.
4. Save eCor.properties.
ActiveX Controls and Plug-ins
When you edit a work item, and you use the Word editor, xResponse opens the local installation of Microsoft Word
in a custom ActiveX plug-in. Before you can customize your work items, you must configure Internet Explorer to
accept the Document Sciences ActiveX plug-in.
To configure Internet Explorer:
1. Select Internet Options from the Tools menu.
2. Click the Security tab.
Document Sciences Corporation
35
Chapter 4 - The xResponse Editors
3. Select Local intranet, then click Custom Level.
4. Click Enable for all the controls in the ActiveX controls and plug-ins section.
Click OK to save these settings, then OK again to close the Internet Options window.
Toolbar Configuration
Changes that you make to the toolbar configuration through the Word interface are limited to the current session. If
you want to specify which toolbars and buttons are available as a configuration item that does not have to be
established each time xResponse opens, and you are using Word 2003, you can establish your preferences in the
toolbar.config file. Changes made to this file affect all xResponse users on the xPression server where the
configuration file is located.
Toolbar.config also provides the option of customizing the Word editor’s menus in xResponse. The settings in the
Menu section are ignored in xRevise.
Known Issues With the Word Editor
Please be aware of the following issues before starting work on your documents.
Word Table Positioning
The xResponse Word editor does not support positioning characteristics for tables. Documents with tables using
positioning characteristics will appear normal in preview, but not in the editor. Positioning characteristics can be
applied to a table if it is moved using the position handle that appears at the upper-left corner of the table when it is
selected. If this happens to your table, it is usually best to recreate the table.
Figure 23. Table
handles.
Auto-Correction in the xResponse Editor
When using the “Change All” feature for capitalization, if the replacement word appears in all caps, then it is
always replaced using all caps.
In all other instances, the word is replaced using the capitalization format of the input word.
Adjusting the Word Editor and Preview Window Size
You can adjust the size of the Word editor and Preview wndow by changing the appropriate lines in the xResponse
style.css file, located in ...\xPressionResponse.ear\Uniarch_eCor.war\css\. To adjust the size of the Word editor
window:
.items-table .obj-edit {width:100%; height:500px;}
Document Sciences Corporation
36
Chapter 4 - The xResponse Editors
To adjust the size of the Preview window:
.bodyfluid #ifr_preview {width:100%; height:500px;}
Auto-Hyphenation in the xResponse Word Editor
You can use auto-hyphenation in the xResponse Word editor. To do so, you must modify the corresponding
template. To enable auto-hyphenation:
1. Locate the template that you want to use in Windows Explorer. Right click and select Open to open it for
editing in Word. You must open the template in this way because otherwise it will open a new document
(DOC) based on the template.
2. From the Tools menu, point to Language and then click Hyphenation.
3. Select Automatically hyphenate document and Hyphenate words in CAPS.
4. Click OK as required to close all open dialog boxes and save the template file.
5. Log on xDesign and re-generate XML to update the version for the document that uses the template set
above.
Different First Page Headers and Footers
If you use the Different First Page option in your document, you must also select Different First Page in the Word
template. To set Different First Page in the Word template:
1. Locate the template in the file system. Right-click the xPressionWordTemplate.dot file and then select
Open. You must open the template from the file system as described. Do not open it from the Word
interface.
2. From the File menu, click Page Layout.
3. On the Layout tab, select Different First Page.
4. Click OK and save the template.
5. Open the document where you want to use Different First Page in xDesign. The HTML template is
updated automatically.
6. Update or create a document version.
Document Sciences Corporation
Chapter 5
xResponse FastPath
5
The xResponse FastPath module passes information from an external application, such as customer file values in
a database, to xResponse. xResponse is scalable and you can use it on multiple platforms.
Parameter Query Strings
FastPath translates external information into encoded statements, or query strings, before it passes the
information to xResponse. Different protocols handle query strings differently. For example, JavaScript uses
escape and unescape methods to encode and decode query strings, VBScript uses the Server.URLEncode
(string), and plain text query strings fill spaces with plus symbols (+).
FastPath requires query strings to work properly. xResponse does not require query strings to be in any particular
order.
You must provide a xResponse password when you first log on to FastPath. The system “remembers” passwords
through subsequent sessions until you exit xResponse, or until the xResponse session times out.
The following tables list FastPath query strings, their values, the effect each example string has on xResponse,
and examples of each. All FastPath parameters are case sensitive.
Note: (1) The examples shown here use the path names and folders associated with the
sample data installed with xPression. You’ll need to tailor these samples to fit your situation. (2)
The encoding used in the FastPath file must match the encoding used in the content in the
database.(3) Some Eastern European characters are not passed with FastPath. To avoid this
problem, ensure that the xResponse_Fastpath_XML.html which posts the relative data uses
UTF-8 encoding. The charset must be set to UTF-8 in the Head section using a tag similar to
this:
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Document Sciences Corporation
38
Chapter 5 - xResponse FastPath
Category
Name of the xPression Category you want to select.
Value
Notes
Example
Category Name
If the user can’t access the specified
data collection, FastPath generates a
log on error.
Category=Automatic+Payment+ Letter
Custkeys1-Custkeys10
The actual values of the key fields for the customer data source. You must map the passed keys in the same order
as the primary keys in the customer data source.
Value
Notes
Example
Key Value
FastPath can accept the Custkeys
string without first opening a category
or document. This enables an external
application to pass customer data to
xResponse, and enables you to use it
to select the letter to produce. This
number must equal the number of
keys for your document’s customer
data source.
For multiple keys in a get string:
<a href="xPressionResponse/
fastPath.jsp?Page=Custdata&Userid=master
&Password=master&Category=Response+Lette
rs&Document=Renewal+Letter&Custkeys1=16&
Custkeys2=Smith">Select Customer Key</a>
Document Sciences Corporation
For a single key:
<a href="xPressionResponse/
fastPath.jsp?Page=Custdata&Userid=master
&Password=master&Category=Response+Lette
rs&Document=Renewal+Letter&Custkeys1=16"
>Select Customer Key</a>
39
Chapter 5 - xResponse FastPath
Document
The name of the source document to open.
Value
Notes
Example
Document
Name
The document must exist in the
category you specify. You must specify
a category to specify a document.
Replace spaces with plus signs, as in
the example.
Document=Automatic+Payment+Letter
This element replaces the legacy
“BDT” element. Existing FastPath files
should work with the earlier version,
but in some cases it may be necessary
to update to the new element name.
Page
The name of the target page at which xResponse should start if called from FastPath. The Page query string is the
only required string.
Value
Notes
Example
Login
Transfers users to the log on page.
<a href="xPressionResponse/default.jsp?">Log
on to letter system</a>
Category
Transfers users to the Prepare
Document page. User ID, and
Password are required. Note that
Category, Document, and Cust all go
to the opening tab of the Build a Letter
function. This is to maintain backward
compatablity wth FastPath statements
created before the three tabs were
combined.
<a href="xPressionResponse/
fastPath.jsp?Page=Category&Userid=master&Pa
ssword=master
Document Sciences Corporation
40
Chapter 5 - xResponse FastPath
Value
Notes
Example
Document
Transfers users to the Prepare
Document page. User ID, Password,
and category query strings are
required. Note that Category,
Document, and Cust all go to the
opening tab of the Build a Letter
function. This is to maintain backward
compatablity wth FastPath statements
created before the three tabs were
combined.
<a href="xPressionResponse/
fastPath.jsp?Page=Document&Userid=master&P
assword=master&&Category=Response+Letters"
>Select letter</a>
Cust
Transfers users to the Prepare
Document page. Requires Userid,
Password, Category, and Document.
Note that Category, Document, and
Cust all go to the opening tab of the
Build a Letter function. This is to
maintain backward compatablity wth
FastPath statements created before
the three tabs were combined.
<a href="xPressionResponse/
fastPath.jsp?Page=Cust&
Userid=master&Password=master&Category
=Response+Letters&Document=
Renewal+ Letter">Select Customer Page</a>
Custdata
Transfers users to the Customer Data
page and displays the customer data.
Requires Userid, Password, Category,
Document, and Customerkeys.
<a href="xPressionResponse/
fastPath.jsp?
Page=Custdata&Userid=master&Password=m
aster&Category=
Response+
Letters&Document=Renewal+Letter&Custkeys1=
16&Custkeys2=Smith">Review Customer Data</
a>
Preview
Transfers users to the Preview page.
Requires Userid, Password, Category,
Document, and Customerkeys.
<a href="http://10.0.4.22:8001/
xPressionResponse/
fastPath.jsp?Page=Preview&Userid=master&
Password=master&Category=Response+Letters
&Document=Renewal+Letter&
Custkeys1=1">Preview Document</a>
wipPreview
Transfers users to the Preview page of
a specific document in the Work in
Progress list. Requires Userid,
Password, and WIPID.
<a href="http://10.0.4.22:8001/
xPressionResponse/
fastPath.jsp?Page=wipPreview&Userid=
master&
Password=master&WIPID=4301">Preview WIP
Document</a>
Document Sciences Corporation
41
Chapter 5 - xResponse FastPath
Value
Notes
Example
WIP
Transfers users to the the Work in
Progress list. Requires Userid,
Password, and WIPID.
<a href="http://10.0.4.22:8001/
xPressionResponse/
fastPath.jsp?Page=wip&Userid=master&Passwor
d=master
Approval
Transfers users to the Approval page.
Requires password query strings.
<a href="xPressionResponse/ fastPath.jsp?
Page=approval&Userid=master&Password=mast
er
Edit
Transfers user to the Edit page.
<a href="xPressionResponse/
fastPath.jsp?Page=edit>Edit Page</a>
Password
Provides FastPath with the user’s password. xResponse uses network login information.
Value
Notes
Example
The user’s
password
If the password is incorrect, FastPath
generates a log on error. You can
provide the password either encrypted
or unencrypted.
(unencrypted)Password=swordfish
(encrypted)Encryptedpassword=h4+NmoyMl
pCR
Use xResponse Framework,
FastpathHelper class, to find
encrypted items and replace them with
attributes. Encryption is accomplished
through
com.dsc.uniarch.util.EncryptionHelper.
UserName
Provides FastPath with the user’s name. xResponse uses network login information.
Value
Notes
Example
The user name
This value is case-sensitive. If the user
name is incorrect, FastPath generates
a log on error.
UserName=freud
Document Sciences Corporation
42
Chapter 5 - xResponse FastPath
WIPID
xPression creates the transaction ID number when a document is created in xResponse. This element is required
only when PAGE=WIP or PAGE=wipPreview. The value of WIPID for any document is stored in the xPression
database, and can be retrieved with a direct call to the CR or by parsing the document’s HTML.
Value
Notes
Example
Transaction
number of the
document
Specifies the transaction ID of the item
from the workspace that is being
requested. If the ID number is
incorrect, FastPath generates a blank
page and an error message.
WIPID=4301
Operation
Logs the user off, close the browser, or both.
Value
Notes
Example
logoff or return
Performs the indicated action:
Logoff - Logoff user and redirect the
page to index.jsp.
Return - Logoff the user and close the
browser.
operation:<input type='text' name='operation'
value='logoff'/><br/>
Document Sciences Corporation
43
Chapter 5 - xResponse FastPath
XMLCustomerData and DataSourceName
You must use the DataSourceName parameter in conjunction with XMLCustomerData or FastPath will cause an
error and fail to run. Both parameters are dependent on one another for data source overrides.
DataSourceName
FastPath uses this value to assemble the document. The XML data source is defined in xAdmin.
Value
Notes
Example
XML data
source name
If not set, FastPath gets the data
source name from the xPression
database. If your primary data source
is an RDB, this parameter enables you
to override your primary data source
with an XML data source. If you use
this parameter you must also use the
XMLCustomerData parameter. If you
don’t use both parameters, the
resulting assembly may include
replacement variables that aren’t
representative of the intended
customer.
<input type="hidden" name='DataSourceName'
value='AutomaticPaymentLetter.xml'/>
XMLCustomerData
The string that contains the customer data in XML format. The XML field values must not contain XML reserved
characters such as the ampersand (&), left and right brackets (<>), apostrophe (‘), and double quotation marks (“)
in the customer data.
Document Sciences Corporation
44
Chapter 5 - xResponse FastPath
You must pass the fields defined as your CustomerDelimiter fields with your table data if you want to use the
XMLCustomerData parameter to override a data source.
Value
Notes
Example
XML data
The string must match the schema as
defined in xAdmin. Your XML must
conform to the Data Reading Definition
of the data source you specify in
DataSourceName.
<input type="hidden" name="XMLCustomerData"
value=’<Your_Tag_Name_1>
For example, if you set the
CustomerDelimiter value in your Data
Reading Definition as shown here,
xPression reads the data passed by
XMLCustomerData.
<CustomerDelimiter XPath=”/
Your_Tag_name_1/
Your_Tag_Name_2”
node=”Your_Tag_Name_2”>
The “node” value in this example is
optional.
Example
This example demonstrates the proper way to use the XMLCustomerData and DataSourceName parameters.
These strings support most XML entities. Be sure to wrap your XML data in single quotation marks (‘). Double
quotation marks can only be entered into the XML if the entire value is surrounded by single quotation marks. This
makes the &quote; entity unnecessary. Single quotation marks in the XML data must use the entity &apos;. If you
use the &lt; entity, you must pre-escape the entity as shown here: &amp;lt;
In this example, replace the string Add your XML data here with your real XML data.
<form name="testfastpath" action='http://server:9080/xPressionResponse
/fastPath.jsp' method="post" encoding='plain/text'>
<input type="hidden" name="screenWidth" value="1024">
<input type="hidden" name="Userid" value="uniarch">
<input type="hidden" name="Password" value="uniarch">
<input type="hidden" name="Server" value="server">
<input type="hidden" name="Category" value="AutomaticPaymentLetter">
<input type="hidden" name="Document" value="AutomaticPaymentLetter">
<input type="hidden" name="Custkeys1" value="1">
<input type="hidden" name='DataSourceName' value='AutomaticPaymentLetter.xml'/>
Document Sciences Corporation
45
Chapter 5 - xResponse FastPath
<input type="hidden" name="XMLCustomerData" value=’<Your_Tag_Name_1>
<Your_Tag_Name_2>
Add your XML data here...
</Your_Tag_Name_2>
<Your_Tag_Name_1>
'>
Please select the destination:
<br>
<select name="gotopage" size="6">
<option value="1" selected>Login</option>
<option value="2" >Category</option>
<option value="3" >Document</option>
<option value="4" >Cust</option>
<option value="5" >Custdata</option>
<option value="6" >Preview</option>
</select>
<input type="button" value="Submit" onclick="toNextPage()">
</form>
<script language=JavaScript>
function toNextPage()
{
switch (document.testfastpath.gotopage.value)
{
case "1":
document.testfastpath.action="http://server:9080/xPressionResponse/
fastPath.jsp?Page=Login";
break;
case "2":
document.testfastpath.action="http://server:9080/xPressionResponse/
fastPath.jsp?Page=Category";
break;
case "3":
document.testfastpath.action="http://server:9080/xPressionResponse/
fastPath.jsp?Page=Document";
break;
case "4":
document.testfastpath.action="http://server:9080/xPressionResponse/
fastPath.jsp?Page=Cust";
break;
case "5":
document.testfastpath.action="http://server:9080/xPressionResponse/
fastPath.jsp?Page=Custdata";
break;
case "6":
document.testfastpath.action="http://server:9080/xPressionResponse/
Document Sciences Corporation
46
Chapter 5 - xResponse FastPath
fastPath.jsp?Page=Preview";
break;
}
document.testfastpath.submit();
}
</script>
Using Unicode Characters with xResponse FastPath
To use “special” characters and glyphs other than the characters available in the Basic Latin character in your
FastPath statements, you must use this format: &#xnnnn.
Substitute the nnnn in this example with the appropriate character code that you can find in the Code Charts at
www.unicode.com/charts. For example, to use the Euro currency symbol you would type &#20AC. However, if you
want to apply the character through FastPath you’ll need to pre-escape the entity: &amp;#20AC.
Automatic Distribution and Log Off
By adding a new parameter to your fastpath call when distributing a document, you can automatically perform the
following operations:
•
Distribute the document and log off of the application.
•
Distribute the document, log off of the application, and close the browser window.
You accomplish these tasks by adding the operation parameter to your fastpath call.
The operation parameter has two possible values. The values are:
•
logoff
•
return
In order to use the new parameter, your fastpath call must contain the following parameter:
operation (value is “logoff” or “return”)
The first four parameters causes the category, document, and enter customer data screen to be skipped. The user
is taken to the data validation page. The customer then continues through the preview and edit pages.
Document Sciences Corporation
47
Chapter 5 - xResponse FastPath
When the user clicks the distribute button xResponse will perform the actions defined in the operation parameter.
Operation Parameter Value
Performed Actions
“logoff”
The document is distributed and the user is logged-off of the application. The user’s
session is terminated.
“return”
The document is distributed and the user is logged-ff of the application. The browser
window is automatically closed.
Additionally, when the “return” parameter is used with any other Fastpath page and the user clicks Log Off from
that page, the application will return the user to the login page.
Encrypting Passwords in Fastpath
You can now provide encryption for passwords in FastPath queries by adding the “Encrypted” prefix to the
password parameter. For example:
fastpath.jsp?Encryptedpassword=<password>
To ensure that it will be decrypted correctly on the server, the encryption should be done through:
com.dsc.uniarch.util.EncryptionHelper.encryptAndEncode(String plaintextPassword)
The EncryptionHelper class is shipped in the xPressionClient.jar.
Document Sciences Corporation
Chapter 6
Customer Data Template
6
If the default presentation of the Customer Data page does not meet your needs, you can create a HTML
document to serve as a template for your own, custom layout. You can create a template for categories as well as
documents within a category. To create a custom data page you should have some knowledge of HTML and XML,
and JavaScript if you want to add a custom script.
Keep these points in mind when creating your template.
•
The document must be well-formed HTML. It must begin with a <html> tag and end with a </html> tag.
Sections must appear in order - <html><header></header><body><form>…</form></body></html> .
•
The Form section provides the displayed content on the page. The name of the Form section must be
"CustomerDataForm".
•
All fields that would be included in the default display must be referenced in your template. If you do not
want the field to be displayed, set the Type attribute in the Input tag to hidden. Do not delete field
references in the form.
•
You can add JavaScript methods to either the Header or Form section. For example, you can add data
checking scripts within the Form section and invoke them with the OnClick method of the Submit button.
<input name="Submit" onClick="javascript:dataChecking()">
•
You can use images in your template. Image files should be located on the server where other image files
are located, such as ..\xResponse.ear\Uniarch_eCor.war\img.
To create a custom data page:
1. Since the template must include all fields that would appear in the default screen, the easiest starting point
is to open the work item to the Customer Data screen, right-click, and then click View Source. Save the
source HTML document for later use.
2. Add elements to the CustomerDataTemplate.xml file to associate categories and documents with your
custom template. This file is located in \HtmlTemplates folder under the xPression home folder on the
Document Sciences Corporation
49
Chapter 6 - Customer Data Template
server. The Category tag establishes the relationship between the category and the template, and the
Template tag establishes the path to the template.
<CustomerDataTemplate>
<Category name="Claim Letter" template="demoTemplate">
</Category>
<Template name="demoTemplate"
path="C:\xPression\HtmlTemplates\demoTemplate.htm"/>
</CustomerDataTemplate>
You can associate different templates with documents within the same category using <Document>.
<Category name="Claim Letter" template="noticeTemplate">
<Document name="Claim LetterWI" template="demoTemplateWI"/>
</Category>
For each template referenced, provide a path to the template in its own <Template> tag.
xRevise uses the template identified in <Document> if one is available, if not it uses the template identified
in <Category>. If no custom template is identified, the default template is used.
3. Create your template. Use the file that you saved in step 1 to ensure that you have all of the fields and
their names.
Your template may resemble this:
<HTML xmlns="http://www.w3.org/1999/xhtml" lang="en" >
<HEAD>
</head>
<body>
<form name="customerDataForm" method="POST" action="preview.jsp">
<img src="../img/concordant.gif" width="206" height="85">
<table>
<tr>
<th align="left"><label for="">POLICY NUMBER:</label>
<tr> <td><input type="text" name="POLICY_NUMBER" style="width:160px">
</table>
<br>
<table>
<tr>
<th align="left"><label for="">TITLE:</label>
<th align="left"><label for="">MARITAL&nbsp;STATUS:</label>
<tr>
<td><select name="TITLE">
<option value="Mr.">Mr.</option>
<option value="Mrs.">Mrs.</option>
<option value="Ms.">Ms.</option>
Document Sciences Corporation
50
Chapter 6 - Customer Data Template
<option value="Miss">Miss</option>
</select>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<td><select name="MARITAL_STATUS">
<option value="Divorced">Divorced</option>
<option value="Married">Married</option>
<option value="Single">Single</option>
<option value="Widowed">Widowed</option>
</select>
</table>
<br>
<table>
<tr>
<th align="left"><label for="">LAST NAME:</label>
<th align="left"><label for="">FIRST NAME:</label>
<th align="left"><label for="">MIDDLE INITIAL:</label>
<tr>
<td><input type="text" name="LNAME">&nbsp;&nbsp;
<td><input type="text" name="FNAME">&nbsp;&nbsp;
<td><input type="text" name="MIDDLE_INITIAL" style="width:20px">
</table>
<br>
<table>
<tr>
<th align="left"><label for="">GENDER:</label>
<th align="left"><label for="">BIRTHDATE (YYYY-mm-dd):</label>
<tr>
<td><input type="text" name="GENDER"
style="width:20px">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&n
bsp;&nbsp;&nbsp;&nbsp;&nbsp;
<td><input type="text" name="DOB" style="width:100px">
</table>
<br><br>
<table>
<tr>
<th align="left"><label for="">ADDRESS:</label>
<tr>
<td><input type="text" name="RESIDENCE_ADDRESS1">
<tr>
<td><input type="text" name="RESIDENCE_ADDRESS2">
<tr>
<th align="left"><label for="">CITY:</label>
<th align="left"><label for="">STATE:</label>
<th align="left"><label for="">ZIP CODE:</label>
<tr>
Document Sciences Corporation
51
Chapter 6 - Customer Data Template
<td><input type="text" name="RESIDENCE_ADDRESS_CITY">&nbsp;&nbsp;
<td><input type="text" name="RESIDENCE_ADDRESS_STATE"
style="width:40px">&nbsp;&nbsp;
<td><input type="text" name="RESIDENCE_ADDRESS_ZIP" style="width:100px">
</table>
<br><br>
<table>
<tr>
<th align="left"><label for="">MAILING ADDR:</label>
<tr>
<td><input type="text" name="MAILING_ADDRESS1">
<tr>
<td><input type="text" name="MAILING_ADDRESS2">
<tr>
<th align="left"><label for="">CITY:</label>
<th align="left"><label for="">STATE:</label>
<th align="left"><label for="">ZIP CODE:</label>
<tr>
<td><input type="text" name="MAILING_ADDRESS_CITY">&nbsp;&nbsp;
<td><input type="text" name="MAILING_ADDRESS_STATE"
style="width:40px">&nbsp;&nbsp;
<td><input type="text" name="MAILING_ADDRESS_ZIP" style="width:100px">
</table>
<br><br>
<table>
<tr>
<th align="left"><label for="">PHONE:</label>
<th align="left"><label for="">FAX:</label>
<tr>
<td><input type="text" name="PHONE">&nbsp;&nbsp;
<td><input type="text" name="FAX">
</table>
<table>
<tr>
<th align="left"><label for="">EMAIL:</label>
<tr>
<td><input type="text" name="EMAIL" style="width:500px">
</table>
<br><br>
<table><tr><td><input type="hidden" name="TERMINATION_DATE"
value="2006-06-01">
<input type="hidden" name="COMPANY_DBA_ID"
Document Sciences Corporation
52
Chapter 6 - Customer Data Template
value="1">
<input type="hidden" name="EFFECTIVE_DATE"
value="2006-01-01">
<input type="hidden" name="ACCOUNT_ID_PRIMARY_KEY"
value="1">
<input type="hidden" name="JURISDICTION"
value="CA">
<input type="hidden" name="CUSTOMER_SEQUENCE_NUM"
value="1">
<input type="hidden" name="LANGUAGE"
value="English">
<input type="hidden" name="modified" value="0">
</table>
<div class="clearout">&nbsp;</div>
<br /><br />
<div class="clearout">&nbsp;</div>
</form>
</body>
</html>
4. Once you have saved the template and the modified CustomerDataTemplate.xml file, restart the server to
apply the customizations.
This sample template would produce the page shown in here.
Figure 24. Sample
template page.
Document Sciences Corporation
Appendix A
Toolbar Configuration
Toolbar.config for xResponse is an XML file located in the xResponse folder on the server. The following is an
example of a toolbar.config file. Control configurations must appear exactly as indicated in this example.
This appendix includes the following topics:
•
Toolbar Configuration File Listing
•
Element Properties
Toolbar Notes and Limitations
If Microsoft Word’s language is not English, the “Name” attribute of every tag in toolbar.config should be changed
to Word’s current language.
Menu bars are not exposed in the embedded editor, so menu configuration items are ignored.
Toolbar Configuration File Listing
The following is a complete listing of the toolbar.config file.
<ToolBarsConfiguration>
<ToolBars>
<ToolBar Name="Standard" Visible="true">
<HideControls></HideControls>
<DisableControls>
<Control Name="New" ShortCuts="(Control,N)"></Control>
<Control Name="Open..."
ShortCuts="(Control,O)|(Control,F12)|(Alt,Control,F12)"></Control>
Document Sciences Corporation
54
Appendix A - Toolbar Configuration
<Control Name="Save" ShortCuts="(Control,s)|(Shift,F12)|(Alt,Shift,F12)"></
Control>
</DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="New" ShortCuts="(Control,N)"></Control>
<Control Name="Open..."
ShortCuts="(Control,O)|(Control,F12)|(Alt,Control,F12)"></Control>
<Control Name="Save" ShortCuts="(Control,s)|(Shift,F12)|(Alt,Shift,F12)"></
Control>
<Control Name="Permission (Unrestricted Access)"></Control>
<Control Name="Mail Recipient"></Control>
<Control Name="Print" ShortCuts="(Control,P)|(Control,Shift,F12)"></Control>
<Control Name="Print Preview" ShortCuts="(Control,F12)|(Alt,Control,I)"></
Control>
<Control Name="Spelling and Grammar..." ShortCuts="(F7)></Control>
<Control Name="Research..."></Control>
<Control Name="Cut" ShortCuts="(Control,X)|(Shift,Delete)"></Control>
<Control Name="Copy" ShortCuts="(Control,C)|(Control,Insert)"></Control>
<Control Name="Paste" ShortCuts="(Control,V)|(Shift,Insert)"></Control>
<Control Name="Format Painter" ></Control>
<Control Name="Undo" ShortCuts="(Control,Z)|(Alt,Backspace)"></Control>
<Control Name="Redo" ShortCuts="(Control,Y)|(F4)|(Alt,Return)"></Control>
<Control Name="Insert Ink Annotations"></Control>
<Control Name="Hyperlink..." ShortCuts="(Control,K)"></Control>
<Control Name="Tables and Borders Toolbar"></Control>
<Control Name="Insert Table..."></Control>
<Control Name="Insert Excel Spreadsheet"></Control>
<Control Name="Columns..."></Control>
<Control Name="Drawing"></Control>
<Control Name="Document Map"></Control>
<Control Name="Show All" ShortCuts="(Control,*)"></Control>
<Control Name="Zoom:"></Control>
<Control Name="Microsoft Office Word Help" ShortCuts="(F1)"></Control>
<Control Name="Read"></Control>
-->
</ToolBar>
<ToolBar Name="Reviewing" Visible="true">
<HideControls></HideControls>
<DisableControls></DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Display for Review"></Control>
<Control Name="Show"></Control>
<Control Name="Previous"></Control>
<Control Name="Next"></Control>
<Control Name="Accept Change"></Control>
Document Sciences Corporation
55
Appendix A - Toolbar Configuration
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
Name="Reject Change/Delete Comment"></Control>
Name="Ink Annotations"></Control>
Name="Ink Comment"></Control>
Name="Comment"></Control>
Name="Highlight"></Control>
Name="Track Changes"></Control>
Name="Reply with Changes..."></Control>
Name="End Review..." ></Control>
Name="Reviewing Pane"></Control>
-->
</ToolBar>
<ToolBar Name="Formatting" Visible="true">
<HideControls></HideControls>
<DisableControls>
<Control Name="Distributed"></Control>
</DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Styles and Formatting..."></Control>
<Control Name="Style:"></Control>
<Control Name="Font:"></Control>
<Control Name="Font Size:"></Control>
<Control Name="Keyboard Language"></Control>
<Control Name="Bold" ShortCuts="(Control,B)|(Control,Shift,B)"></Control>
<Control Name="Italic" ShortCuts="(Control,I)|(Control,Shift,I)"></Control>
<Control Name="Underline" ShortCuts="(Control,U)|(Control,Shift,U)"></Control>
<Control Name="Align Left" ShortCuts="(Control,L)"></Control>
<Control Name="Center" ShortCuts="(Control,E)"></Control>
<Control Name="Align Right" ShortCuts="(Control,R)"></Control>
<Control Name="Justify" ShortCuts="(Control,J)"></Control>
<Control Name="Distributed" ></Control>
<Control Name="Line spacing" ShortCuts="(Control,1)|(Control,2)|(Control,5)"></
Control>
<Control Name="Left-to-Right" ></Control>
<Control Name="Right-to-Left"></Control>
<Control Name="Numbering"></Control>
<Control Name="Bullets"></Control>
<Control Name="Decrease Indent" ShortCuts="(Control,Shift,M)"></Control>
<Control Name="Increase Indent" ShortCuts="(Control,M)"></Control>
<Control Name="Borders"></Control>
<Control Name="Highlight"></Control>
<Control Name="Font Color"></Control>
-->
</ToolBar>
Document Sciences Corporation
56
Appendix A - Toolbar Configuration
<ToolBar Name="AutoText" Visible="false" DisableAllChild = "false">
<HideControls></HideControls>
<DisableControls></DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="AutoText..."></Control>
<Control Name="All Entries"></Control>
<Control Name="New..."></Control>
-->
</ToolBar>
<ToolBar Name="Control Toolbox" Visible="false">
<HideControls></HideControls>
<DisableControls></DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Exit Design Mode"></Control>
<Control Name="Properties"></Control>
<Control Name="View Code"></Control>
<Control Name="Check Box"></Control>
<Control Name="Text Box"></Control>
<Control Name="Command Button"></Control>
<Control Name="Option Button"></Control>
<Control Name="List Box"></Control>
<Control Name="Combo Box"></Control>
<Control Name="Toggle Button"></Control>
<Control Name="Spin Button"></Control>
<Control Name="Scroll Bar"></Control>
<Control Name="Label"></Control>
<Control Name="Image"></Control>
<Control Name="More Controls..."></Control>
-->
</ToolBar>
<ToolBar Name="Database" Visible="false">
<HideControls></HideControls>
<DisableControls></DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Data Form"></Control>
<Control Name="Manage Fields"></Control>
<Control Name="Add Record"></Control>
<Control Name="Delete Record"></Control>
<Control Name="Sort Ascending"></Control>
<Control Name="Sort Descending"></Control>
<Control Name="Database..."></Control>
<Control Name="Update Field"></Control>
<Control Name="Find in Field"></Control>
<Control Name="Main Document"></Control>
-->
</ToolBar>
Document Sciences Corporation
57
Appendix A - Toolbar Configuration
<ToolBar Name="Drawing" Visible="true">
<HideControls></HideControls>
<DisableControls></DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Draw"></Control>
<Control Name="Select Objects"></Control>
<Control Name="AutoShapes"></Control>
<Control Name="Line"></Control>
<Control Name="Arrow"></Control>
<Control Name="Rectangle"></Control>
<Control Name="Oval"></Control>
<Control Name="Text Box"></Control>
<Control Name="Vertical Text Box"></Control>
<Control Name="WordArt..."></Control>
<Control Name="Dia&gram..."></Control>
<Control Name="Clip Art..."></Control>
<Control Name="Picture..."></Control>
<Control Name="Ink Drawing and Writing"></Control>
<Control Name="Fill Color"></Control>
<Control Name="Line Color"></Control>
<Control Name="Font Color"></Control>
<Control Name="Line Style"></Control>
<Control Name="Dash Style"></Control>
<Control Name="Arrow Style"></Control>
<Control Name="Shadow Style"></Control>
<Control Name="3-D Style"></Control>
-->
</ToolBar>
<ToolBar Name="E-mail" Visible="false">
<HideControls/>
<DisableControls/>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Drawing and Writing Pen" />
<Control Name="Save" />
<Control Name="Print" />
<Control Name="Cut" ShortCuts="(Control,X)|(Shift,Delete)"></Control>
<Control Name="Copy" ShortCuts="(Control,C)|(Control,Insert)"></Control>
<Control Name="Paste" ShortCuts="(Control,V)|(Shift,Insert)"></Control>
<Control Name="Font:" />
<Control Name="Font Size:" />
<Control Name="Font Color" />
<Control Name="Bold" ShortCuts="(Control,B)|(Control,Shift,B)"></Control>
<Control Name="Italic" ShortCuts="(Control,I)|(Control,Shift,I)"></Control>
<Control Name="Underline" ShortCuts="(Control,U)|(Control,Shift,U)"></Control>
Document Sciences Corporation
58
Appendix A - Toolbar Configuration
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
Name="Align Left" ShortCuts="(Control,L)"></Control>
Name="Center" ShortCuts="(Control,E)"></Control>
Name="Align Right" ShortCuts="(Control,R)"></Control>
Name="Distributed" />
Name="Left-to-Right" />
Name="Right-to-Left" />
Name="Numbering" />
Name="Bullets" />
Name="Decrease Indent" ShortCuts="(Control,Shift,M)"></Control>
Name="Increase Indent" ShortCuts="(Control,M)"></Control>
Name="Translate" />
-->
</ToolBar>
<ToolBar Name="Extended Formatting" Visible="false">
<HideControls/>
<DisableControls/>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Highlight" />
<Control Name="Dot Accent" />
<Control Name="Double Strikethrough" />
<Control Name="Phonetic Guide..." />
<Control Name="Combine Characters..." />
<Control Name="Enclose Characters..." />
<Control Name="Single Spacing" />
<Control Name="1.5 Spacing" />
<Control Name="Double Spacing" />
<Control Name="Columns..." />
-->
</ToolBar>
<ToolBar Name="Forms" Visible="false">
<HideControls/>
<DisableControls/>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Edit Box" />
<Control Name="Check Box" />
<Control Name="Combo Box" />
<Control Name="Properties" />
<Control Name="Draw Table" />
<Control Name="Insert Table..." />
<Control Name="Frame" />
<Control Name="Show Field Shading" />
<Control Name="Reset Form Fields" />
<Control Name="Protect Form" />
-->
</ToolBar>
Document Sciences Corporation
59
Appendix A - Toolbar Configuration
<ToolBar Name="Frames" Visible="false">
<HideControls/>
<DisableControls/>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Table of Contents in Frame" />
<Control Name="New Frame Left" />
<Control Name="New Frame Right" />
<Control Name="New Frame Above" />
<Control Name="New Frame Below" />
<Control Name="Delete Frame" />
<Control Name="Frame Properties..." />
-->
</ToolBar>
<ToolBar Name="Mail Merge" Visible="false">
<HideControls/>
<DisableControls/>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Main document setup" />
<Control Name="Open Data Source" />
<Control Name="Mail Merge Recipients" />
<Control Name="Insert Address Block" />
<Control Name="Insert Greeting Line" />
<Control Name="Insert Merge Fields" ShortCuts="(Alt,Shift,F)"/>
<Control Name="Insert Word Field" />
<Control Name="Show Fields/Values" />
<Control Name="Highlight Merge Fields" />
<Control Name="Match Fields" />
<Control Name="Propagate Labels" />
<Control Name="First" />
<Control Name="Previous" />
<Control Name="Record:" />
<Control Name="Next" />
<Control Name="Last" />
<Control Name="Find Entry" />
<Control Name="Error Check Merge" />
<Control Name="Merge to Document" />
<Control Name="Merge to Printer" />
<Control Name="Merge to E-mail" />
<Control Name="Merge to Fax" />
-->
</ToolBar>
Document Sciences Corporation
60
Appendix A - Toolbar Configuration
<ToolBar Name="Outlining" Visible="false">
<HideControls/>
<DisableControls/>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Promote to Heading 1" />
<Control Name="Promote" />
<Control Name="Outline Level" />
<Control Name="Demote" />
<Control Name="Demote to Body Text" />
<Control Name="Move Up" />
<Control Name="Move Down" />
<Control Name="Expand" />
<Control Name="Collapse" />
<Control Name="Show Level" />
<Control Name="First Line Only View" />
<Control Name="Show Formatting" />
<Control Name="Update TOC" />
<Control Name="Go to TOC" />
<Control Name="Master Document View" />
<Control Name="Collapse Subdocuments" />
<Control Name="Create Subdocument" />
<Control Name="Delete Subdocument" />
<Control Name="Import Subdocument" />
<Control Name="Merge Subdocument" />
<Control Name="Split Subdocument" />
<Control Name="Protect Subdocument" />
-->
</ToolBar>
<ToolBar Name="Picture" Visible="false">
<HideControls/>
<DisableControls/>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Picture..." />
<Control Name="Color" />
<Control Name="More Contrast" />
<Control Name="Less Contrast" />
<Control Name="More Brightness" />
<Control Name="Less Brightness" />
<Control Name="Crop" />
<Control Name="Rotate Left 90" />
<Control Name="Line Style" />
<Control Name="Compress Pictures..." />
<Control Name="Text Wrapping" />
<Control Name="Format Object..." />
<Control Name="Set Transparent Color" />
<Control Name="Reset Picture" />
-->
Document Sciences Corporation
61
Appendix A - Toolbar Configuration
</ToolBar>
<ToolBar Name="Tables and Borders" Visible="false">
<HideControls/>
<DisableControls/>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Draw Table" />
<Control Name="Eraser" />
<Control Name="Border Style" />
<Control Name="Border Width" />
<Control Name="Border Color" />
<Control Name="Borders" />
<Control Name="Shading Color" />
<Control Name="Table Insert" />
<Control Name="Merge Cells" />
<Control Name="Split Cells..." />
<Control Name="Cell Alignment" />
<Control Name="Distribute Rows Evenly" />
<Control Name="Distribute Columns Evenly" />
<Control Name="Table AutoFormat..." />
<Control Name="Change Text Direction" />
<Control Name="Sort Ascending" />
<Control Name="Sort Descending" />
<Control Name="AutoSum" />
-->
</ToolBar>
<ToolBar Name="Visual Basic" Visible="false">
<HideControls/>
<DisableControls/>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Macros..." />
<Control Name="Record New Macro..." />
<Control Name="Security..." />
<Control Name="Visual Basic Editor" />
<Control Name="Control Toolbox" />
<Control Name="Exit Design Mode" />
<Control Name="Microsoft Script Editor" />
-->
</ToolBar>
<ToolBar Name="Web" Visible="false">
<HideControls/>
<DisableControls/>
</ToolBar>
Document Sciences Corporation
62
Appendix A - Toolbar Configuration
<ToolBar Name="Web Tools" Visible="false">
<HideControls/>
<DisableControls/>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Exit Design Mode" />
<Control Name="Properties" />
<Control Name="Microsoft Script Editor" />
<Control Name="Checkbox" />
<Control Name="Option Button" />
<Control Name="Drop-Down Box" />
<Control Name="List Box" />
<Control Name="Textbox" />
<Control Name="Text Area" />
<Control Name="Submit" />
<Control Name="Submit with Image" />
<Control Name="Reset" />
<Control Name="Hidden" />
<Control Name="Password" />
<Control Name="Movie" />
<Control Name="Sound" />
<Control Name="Scrolling Text" />
-->
</ToolBar>
<ToolBar Name="Word Count" Visible="false">
<HideControls/>
<DisableControls/>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Word Count Statistics" />
<Control Name="Recount" />
-->
</ToolBar>
<ToolBar Name="WordArt" Visible="false">
<HideControls/>
<DisableControls/>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="WordArt..." />
<Control Name="Edit Text..." />
<Control Name="WordArt Gallery" />
<Control Name="Format Object..." />
<Control Name="WordArt Shape" />
<Control Name="Text Wrapping" />
<Control Name="WordArt Same Letter Heights" />
<Control Name="WordArt Vertical Text" />
Document Sciences Corporation
63
Appendix A - Toolbar Configuration
<Control Name="WordArt Alignment" />
<Control Name="WordArt Character Spacing" />
-->
</ToolBar>
</ToolBars>
<Menus>
<Menu Name="File" Visible="true">
<HideControls></HideControls>
<DisableControls>
<Control Name="New..." ShortCuts="(Control,N)"/>
<Control Name="Open..."
ShortCuts="(Control,O)|(Control,F12)|(Alt,Control,F12)"/>
<Control Name="Close" ShortCuts="(Control,W)"/>
<Control Name="Save" ShortCuts="(Control,s)|(Shift,F12)|(Alt,Shift,F12)"/>
<Control Name="Save As..." ShortCuts="(F12)"/>
<Control Name="Save as Web Page..." />
</DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="New..." ShortCuts="(Control,N)"/>
<Control Name="Open..."
ShortCuts="(Control,O)|(Control,F12)|(Alt,Control,F12)"/>
<Control Name="Close" ShortCuts="(Control,W)"/>
<Control Name="Save" ShortCuts="(Control,s)|(Shift,F12)|(Alt,Shift,F12)"/>
<Control Name="Save As..." ShortCuts="(F12)/>
<Control Name="Save as Web Page..." />
<Control Name="File Search..." />
<Control Name="Permission" />
<Control Name="Permission..." />
<Control Name="Check Out" />
<Control Name="Check In..." />
<Control Name="Versions..." />
<Control Name="Version History" />
<Control Name="Web Page Preview" />
<Control Name="Page Setup..." />
<Control Name="Print Preview" ShortCuts="(Control,F12)|(Alt,Control,I)"/>
<Control Name="Print..." ShortCuts="(Control,P)|(Control,Shift,F12)"/>
<Control Name="Send To" />
<Control Name="Properties" />
<Control Name="Exit" />
-->
</Menu>
Document Sciences Corporation
64
Appendix A - Toolbar Configuration
<Menu Name="Edit" Visible="true">
<HideControls>
</HideControls>
<DisableControls>
<Control Name="Cut"></Control>
<Control Name="Find..."></Control>
</DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Undo" ShortCuts="(Control,Z)|(Alt,Backspace)"/>
<Control Name="Redo" ShortCuts="(Control,Y)|(F4)|(Alt,Return)"/>
<Control Name="Cut" ShortCuts="(Control,X)|(Shift,Delete)"/>
<Control Name="Copy" ShortCuts="(Control,C)|(Control,Insert)"/>
<Control Name="Office Clipboard..." />
<Control Name="Paste" ShortCuts="(Control,V)|(Shift,Insert)"/>
<Control Name="Paste Special..." />
<Control Name="Paste as Hyperlink" />
<Control Name="Clear" />
<Control Name="Select All" ShortCuts="(Control,A)"/>
<Control Name="Find..." ShortCuts="(Control,F)"/>
<Control Name="Replace..." ShortCuts="(Control,H)"/>
<Control Name="Go To..." ShortCuts="(Control,G)"/>
<Control Name="Update IME Dictionary..." />
<Control Name="Reconvert" />
<Control Name="Links..." />
<Control Name="Object" />
-->
</Menu>
<Menu Name="View" Visible="true">
<HideControls>
</HideControls>
<DisableControls>
</DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Normal" />
<Control Name="Web Layout" />
<Control Name="Print Layout" />
<Control Name="Reading Layout" />
<Control Name="Outline" />
<Control Name="Task Pane" ShortCuts="(Control,F1)"/>
<Control Name="Toolbars" />
<Control Name="Ruler" />
<Control Name="Show Paragraph Marks" />
<Control Name="Gridlines" />
<Control Name="Document Map" />
<Control Name="Thumbnails" />
<Control Name="Header and Footer" />
Document Sciences Corporation
65
Appendix A - Toolbar Configuration
<Control
<Control
<Control
<Control
<Control
Name="Footnotes" />
Name="Markup" />
Name="HTML Source" />
Name="Full Screen" />
Name="Zoom..." />
-->
</Menu>
<Menu Name="Insert" Visible="true">
<HideControls>
</HideControls>
<DisableControls>
</DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Break..." />
<Control Name="Page Numbers..." />
<Control Name="Date and Time..." />
<Control Name="AutoText" />
<Control Name="Field..." />
<Control Name="Symbol..." />
<Control Name="Comment" />
<Control Name="Ink Comment" />
<Control Name="Ink Annotations" />
<Control Name="Number..." />
<Control Name="Reference" />
<Control Name="Web Component..." />
<Control Name="Picture" />
<Control Name="Diagram..." />
<Control Name="Text Box" />
<Control Name="File..." />
<Control Name="Object..." />
<Control Name="Bookmark..." />
<Control Name="Hyperlink..." ShortCuts="(Control,K)"/>
-->
</Menu>
<Menu Name="Format" Visible="true">
<HideControls>
</HideControls>
<DisableControls>
</DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Font..." />
Document Sciences Corporation
66
Appendix A - Toolbar Configuration
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
<Control
Name="Paragraph..." />
Name="Bullets and Numbering..." />
Name="Borders and Shading..." />
Name="Columns..." />
Name="Tabs..." />
Name="Drop Cap..." />
Name="Text Direction..." />
Name="Change Case..." />
Name="Fit Text..." />
Name="Asian Layout" />
Name="Background" />
Name="Theme..." />
Name="Frames" />
Name="AutoFormat..." />
Name="Styles and Formatting..." />
Name="Reveal Formatting..." ShortCuts="(Shift,F1)"/>
Name="Object..." />
-->
</Menu>
<Menu Name="Tools" Visible="true">
<HideControls>
</HideControls>
<DisableControls>
</DisableControls>
<!--Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Spelling and Grammar..." ShortCuts="(F7)"/>
<Control Name="Research..." />
<Control Name="Language" />
<Control Name="Fix Broken Text..." />
<Control Name="Word Count..." />
<Control Name="AutoSummarize..." />
<Control Name="Look Up Reference..." />
<Control Name="Speech" />
<Control Name="Shared Workspace..." />
<Control Name="Track Changes" ShortCuts="(Control,Shift,E)"/>
<Control Name="Compare and Merge Documents..." />
<Control Name="Protect Document..." />
<Control Name="Online Collaboration" />
<Control Name="Letters and Mailings" />
<Control Name="Macro" />
<Control Name="Templates and Add-Ins..." />
<Control Name="AutoCorrect Options..." />
<Control Name="Customize..." />
Document Sciences Corporation
67
Appendix A - Toolbar Configuration
<Control Name="Show Signature..." />
<Control Name="Options..." />
-->
</Menu>
<Menu Name="Table" Visible="true">
<HideControls>
</HideControls>
<DisableControls>
</DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="Draw Table" />
<Control Name="Insert" />
<Control Name="Delete" />
<Control Name="Select" />
<Control Name="Merge Cells" />
<Control Name="Split Cells..." />
<Control Name="Split Table" />
<Control Name="Table AutoFormat..." />
<Control Name="AutoFit" />
<Control Name="Heading Rows Repeat" />
<Control Name="Insert Multidiagonal Cell..." />
<Control Name="Convert" />
<Control Name="Sort..." />
<Control Name="Formula..." />
<Control Name="Hide Gridlines" />
<Control Name="Table Properties..." />
-->
</Menu>
<Menu Name="Window" Visible="true">
<HideControls>
</HideControls>
<DisableControls>
</DisableControls>
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="New Window" />
<Control Name="Arrange All" />
<Control Name="Compare Side by Side with..." />
<Control Name="Split" />
-->
</Menu>
<Menu Name="Help" Visible="true">
<HideControls>
</HideControls>
<DisableControls>
</DisableControls>
Document Sciences Corporation
68
Appendix A - Toolbar Configuration
<!-- Control list (you can just copy it to HideControls or DisableControls):
<Control Name="xPression Word Help" />
<Control Name="Microsoft Office Word Help" ShortCuts="(F1)"/>
<Control Name="Show the Office Assistant" />
<Control Name="Microsoft Office Online" />
<Control Name="Contact Us" />
<Control Name="WordPerfect Help..." />
<Control Name="Check for Updates" />
<Control Name="Detect and Repair..." />
<Control Name="Activate Product..." />
<Control Name="Customer Feedback Options..." />
<Control Name="About Microsoft Office Word" />
-->
</Menu>
</Menus>
</ToolBarsConfiguration>
Element Properties
The following table lists all of the available elements and their properties.
Element
Properties
ToolBars
Contains all of the Toolbar elements, which establish the configuration for each
individual toolbar. This element has no properties.
Toolbar
Located between the opening and closing ToolBars tags, this tag establishes the
configuration for a specific toolbar. In addition to its properties, the HideControls and
DisableControls elements reside between its opening and closing tags.
•
Name is the name of the toolbar.
HideControls
•
Visible can be either true or false and determines whether the toolbar is visible
or not.
•
DisableAllChild disables all controls on the toolbar. When this property is true,
you do not neet to specify individual controls to be disabled.
Located between the opening and closing Toolbar tag, controls identified with this tag
are hidden on the toolbar identified in the Toolbar tag.
Name is the name of the control to be hidden.
Document Sciences Corporation
69
Appendix A - Toolbar Configuration
Element
Properties
Disable-Controls
Located between the opening and closing Toolbar tag, controls identified with this tag
are disabled on the toolbar identified in the Toolbar tag.
Name is the name of the control to be disabled. The control remains visible.
Control
Each Control element located within a HideControls or DisableControls section
identifies a control to be hidden or disabled.
ShortCuts disables any keyboard shortcuts associated with the control. This is
necessary if you want to eliminate the function entirely since the shortcut will still work
even if the control has been hidden or disabled. You must identify each shortcut
combination, separating keys with commas and different shortcut combinations with the
pipe symbol as in this example.
<Control Name="Save" ShortCuts="(control,s)|(shift,f12)|(alt,shift,f12)"></Control>
Menus
Contains all of the Menu elements, which establish the configuration for each individual
menu. This element has no properties. Since all menus are suppressed in xRevise, this
element only applies to xResponse.
Menu
Located between the opening and closing Menus tags, this tag establishes the
configuration for a specific menu. In addition to its properties, the HideControls and
DisableControls elements reside between its opening and closing tags. This element
only applies to xResponse.
•
Name is the name of the menu.
HideControls
•
Visible can be either true or false and determines whether the menu is visible
or not.
•
DisableAllChild disables all controls on the menu. When this property is true,
you do not neet to specify individual controls to be disabled.
Located between the opening and closing Menu tag, controls identified with this tag are
hidden on the menu identified in the Menu tag.
Name is the name of the control to be hidden.
DisableControls
Located between the opening and closing Menu tag, controls identified with this tag are
disabled on the menu identified in the Menu tag.
Name is the name of the control to be disabled. The control remains visible.
Document Sciences Corporation
70
Appendix A - Toolbar Configuration
Element
Properties
Control
Each Control element located within a HideControls or DisableControls section
identifies a control to be hidden or disabled.
ShortCuts disables any keyboard shortcuts associated with the control. This is
necessary if you want to eliminate the function entirely since the shortcut will still work
even if the control has been hidden or disabled. You must identify each shortcut
combination, separating keys with commas and different shortcut combinations with the
pipe symbol as in this example.
<Control Name="Save" ShortCuts="(control,s)|(shift,f12)|(alt,shift,f12)"></Control>
Document Sciences Corporation
© 2011 - 2013 EMC Corporation. All Rights Reserved.
EMC believes the information in this publication is accurate as of its publication date. The information is subject to change
without
notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NO
REPRESENTATIONS OR
WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND
SPECIFICALLY
DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.
EMC2, EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United State and other
countries.
All other trademarks used herein are the property of their respective owners.