Editing Document Templates

From SchemeServe Wiki

Contents 1 Introduction 2 Creating a new Document Template 3 Editing Existing Document Templates 4 Inserting a new image into one of your Document Templates 5 Inserting an existing (i.e. previously uploaded) image into one of your Document Templates: 6 Adding a header and footer for all documents on a particular Scheme: 7 Changing the header and footer for all documents on a particular Scheme: 8 Automatically generating documents on status changes

[edit] Introduction

The Document Template system is at the heart of the document system. With it, very complicated documentation can be automatically generated which would otherwise take a person a great amount of time to build manually with great risk of human error.

The document templates are found in the Admin section of the application, so you need to be an administrator to see them.

There are 2 levels of Document Template.

Templates applicable to All Schemes and Templates applicable to a single scheme.

[edit] Creating a new Document Template

To create a new Document Template, click New Document in the relevant Scheme or the All Schemes Section.

Read the on screen instructions and then provide a name for your new document template.

You'll then be presented with the Template Designer. In here you can create your document in exactly the way you would like it to appear. You can format text, you can add Dynamic Fields including Editable sections (Dynamic Fields control:essay, control:paragraph, control:sentence)

To remove a dynamic field once it's been placed, just delete it as if it was any normal text in your document.

Once you are happy with your template, press Save.

[edit] Editing Existing Document Templates

To edit an existing document template's definition, press the Configure button next to the template in question. You can then modify various Template parameters and effects on cases when the letters are produced. To modify the actual document template, press View Template and you'll be presented once more with the Template Designer. Save your changes once you've finished.

If you've decided to discard your changes, press the Back to List button and your changes will be ignored.

[edit] Inserting a new image into one of your Document Templates

1. Log-in to SchemeServe.
2. Go to Admin > Documents
3. Browse to the Document Template you wish to edit.
4. Click the 'Edit' button (looks like a little pen).
5. Position the cursor in the document where you'd like to insert the image.
6. Click the 'Insert/Edit Image' button (yellow background with two mountains and a sun).
7. Click the 'Upload' tab.
8. Click the 'Choose File' button to select an image from your hard drive.
9. Click 'Send it to the Server', then when it's done uploading click 'OK'.
10. Click 'OK' again to close the 'Image Properties' box.
11. Your image has been inserted into the selected Document Template.
12. Make sure you click 'Save' at the end to save your Document Template.

[edit] Inserting an existing (i.e. previously uploaded) image into one of your Document Templates:

1. Log-in to SchemeServe.
2. Go to Admin > Documents
3. Browse to the Document Template you wish to edit.
4. Click the 'Edit' button (looks like a little pen).
5. Click the 'Insert/Edit Image' button (yellow background with two mountains and a sun).
6. Click 'Browse Server', then click on the folder you'd like to browse.
7. Click the image you wish to use.
8. Click OK.
9. Your image has been inserted into the selected Document Template.
10. Make sure you click 'Save' at the end to save your Document Template.

[edit] Adding a header and footer for all documents on a particular Scheme:

1. Go to "Admin" > "Schemes".
2. Choose the correct Scheme and click the Images tab.

The header and footer get scaled by 50% to ensure high quality print versions.

Once you have an image that is twice as large as you want it on the documents all you need to do is upload it.

Just click "Browse", find the image on your PC and click "Open".

When you click "Save Changes" the image will be uploaded to SchemeServe and will display on any Document Templates that have the "Standard Header" or "Standard Footer" ticked.

[edit] Changing the header and footer for all documents on a particular Scheme:

1. Go to Admin > Schemes.
2. Choose the correct Scheme and click the Images tab.
3. Click the image next to "Document Header" or "Document Footer".
4. That'll open it full size and you can right click and "save image as" to download it to your PC.
5. Fire up your favourite image editor, make your changes and just click the "Browse" and "Save Changes".

The header image is positioned top left so to get your header appear top right (or center):

1. Make your image 1200px wide (white background).
2. Use a selection tool to move your logo to where you would like to appear on the page.
3. Click "Browse", find your updated image and "Save Changes".

The intricacies of using an image editor are outside the scope of this article.

You should be able to find many resources by typing the name or the editor you have into your favourite search engine.

[edit] Automatically generating documents on status changes

Often you'll want certain documents to be generated/presented to the user automatically at certain points in the Case lifecycle. This can be achieved using the "Auto Generation" section.

1. Select the type of Case this should apply to, "First Premium" are new Cases, "Adjustments" are adjusted existing Cases, "Renewals" are for Renewed Cases and "Any" will apply to all three.
2. Select the status you'd like to result in the document being generated

Now, this document will be regenerated when the case in question is of the Type you selected, (First Premium, Adjustment, Renewal) and it's status changes to the Status you selected.