SRS Documents > Document Setup > SRS Document Print Setup > SRS Document Template

SRS Document Template

You use this program to create and maintain SRS document templates for selected document types.

Toolbar and menu

Field Description
File  
Import Select this to copy a template from a network drive or an external drive or device onto the current machine.
Export Select this to copy the currently highlighted template from this machine onto a network drive or an external drive or device.
Edit  
Copy Select this to create a new template by copying the current template.

When you select this option, the following message is displayed: "Do you wish to copy the document 'xxx'?' (where xxx is the current Document description.

If you select Yes, then you are prompted to enter the description for the new document.

Once you have entered the description for the new document and selected OK, you are returned to the SRS Document Template screen.

Functions  
Reset customizable fields Select this to reset the following fields to what is set against the document type (Maintain SRS Document Types):
  • Print options - File name format

  • Email options - Default Email Subject line format

Note that both these fields are simultaneously reset.

New Select this to use the Add SRS Document Templates program to add a new template for the selected document type.
Delete Select this to delete the currently displayed document template.
Document description This indicates the document for which you are maintaining the template.
Design Select this to use Crystal Reports to change the design or layout of the template.

Document Template

Field Description
Document description This indicates the description of the document template you are currently maintaining. This can be changed.
Template file This indicates the name of the template document file.

This name is controlled by the system and cannot be changed.

Archive options
[Note]

You cannot configure archive information for any document type which has items listed in the SRS Document Pending Archive Viewer.

See also Coding considerations.

Archive document Select this to archive a copy of the documents generated for this document type and template combination.
[Note]
  • When emailing a printed document the email address is pre-populated if it is defined against either the customer or supplier.

    When emailing an archived document, no email address is pre-populated and you are prompted to enter the recipient's address.

  • When emailing from the Print Preview screen, all the invoices showed in the preview are included into one document, irrespective of your selections in the SO Batch Invoicing program.

Archive type

Indicate the format in which you want to archive printed, faxed and emailed documents.

If you want to use 128 bit encryption for the document, then you need to select either the PDF or Both option.

Field Description
{none} This indicates that the document is not archived. When you select the Archive document option, this cannot be left as {none}.
RPT Select this to archive the documents in Crystal Reports format (.rpt).
PDF Select this to archive the documents in Adobe Acrobat format (.pdf).
Both Select this to archive documents in both Crystal Reports format (.rpt) and Adobe Acrobat format (.pdf).
Print options  
Spool multiple documents as single job

Select this to send the documents you selected to print using one of the batch printing programs (e.g. AR Statement Print, PO Print, SO Batch Invoicing, Quotation Document Print, etc) to the printer as a single print job.

You typically select this option if the printer you are using is shared with other operators. If you select this option, then each of your document batches is printed as a complete batch, without other operators' documents being printed within your batch of documents.

See Restrictions and limits in Notes and warnings

File name format Optionally enter the attachment file name to create when emailing documents using this template.

You can specify any variables displayed in the Variables pane together with any text you require.

The variables and text you enter are used as a template for the actual file name when creating the document.

You need to manually enter the variables and the text. Note that the variables are case sensitive.

For example, for AR Statements you could have:

%CustomerAccntNumber%StatementDateCymd

If you enter a string here and another string against the document type (Maintain SRS Document Types), then the string entered here takes precedence.

You can revert this field back to what is defined against the document type (Maintain SRS Document Types) by selecting the Reset customizable fields option from the Functions menu. Note that this option also simultaneously reverts the Default Email subject line format field under the Email options to what is defined in Maintain SRS Document Types.

Email options

Documents can be grouped by a single email address using the Group by email address option. This results in fewer emails being sent out. For example, customer 0000001 and customer 0000002 have the same email address. If you select to email 4 invoices for these two customers and you selected the option Group by email address, then one email is sent to the email address with 4 invoice attachments. If you did not select this option, then 4 Emails are sent out with one invoice attachment each.

If you select the Send multiple documents as single attach option together with the Group by email address option, then all the documents are consolidated into one email attachment. Using the above example, one email is sent to the single email address with one attachment. All 4 invoices are included in the attachment and the attachment name is invoice_100808.pdf (where 100808 is the last invoice number of the 4 documents).

You can also define the maximum number of documents to attach to a single email. In the above example, if you define the maximum number of documents to attach as 2, then two Emails are sent, both with 2 invoice attachments.

Default Email Subject line format Optionally specify the format of the email subject by adding the variables you want to use.

You can specify any variables displayed in the Variables pane together with any text you require.

The variables and text you enter are used as a template for the actual subject line when creating the document.

You need to manually enter the variables and the text. Note that the variables are case sensitive.

For example, for AR statements, you could have:

Statement for %CustomerName % StatementDateCymd

The text and variables are space delimited.

When emailing a single document (as opposed to a batch of documents) from within SYSPRO, you are prompted to confirm the email details prior to sending the document.

Note that when the program that generates the final document passes default information for this field, then you need to delete the default information passed from that program and enter the required information manually.

For example, in Sales Orders, a default subject line is automatically generated by the Sales Order Print program. The SRS Document Printing program will not overwrite this subject information, so you need to change it manually if you want a different subject.

If you enter a string here and another string against the SRS document type, then the string entered here takes precedence.

You can revert this field back to what is defined against the document type (Maintain SRS Document Types) by selecting the Reset customizable fields option from the Functions menu. Note that this option also simultaneously reverts the File name format field under the Print options to what is defined in Maintain SRS Document Types.

For the AR Statement Print program, the email subject is used if defined. If not defined, the custom subject defined against the document is used.

Group by email address

Select this to group all documents for a single email address together. This results in fewer Emails being sent out, because the documents can be grouped together in one PDF document and sent as one email, depending on your selections at the Email options below.

If you select this option, then you can select to group all the documents for a single email address into one document. Alternatively, you can define the maximum number of documents to attach to a single email.

[Note]

This option must not be selected when you are batch printing statements using the AR Statement Print program.

Send multiple documents as single attach

Select this to group all documents for a common (single) email address into one PDF document.

If you select this option, then you must ensure that the limit imposed by your Internet Service Provider (ISP) on the size of Emails that you can send is not exceeded.

If you do not select this option, then all documents for a common (single) email address are sent as individual documents attached to each email. You can then specify the maximum number of documents to attach to each individual email.

This option is only enabled if you selected the option: Group by email address above.

Maximum number of attachments per email

Specify the maximum number of documents you want to attach to each individual email.

A minimum of one attachment and a maximum of 10 attachments can be selected.

[Note]

If you allow a large number of attachments per email, then the email could become too large to send (depending on the size of each document created and the limits set on your email server).

This applies if you selected the option: Group by email address and not the option: Send multiple documents as single attach above.

Email using This defaults to your company settings.
[Note]

Macro using VBScript is not supported for SRS document printing.

If you selected Macro using VBScript in your company setup, then Microsoft Outlook is used. If you are using Outlook 2010, then Outlook email client is used.

FieldDescription
Microsoft Outlook

Select to use Microsoft Outlook, Microsoft Outlook email client or simple MAPI mail when emailing the document using this template.

3rd Party applicationSelect this to use your custom email client software (i.e. you have written your own email client software).
3rd Party application path Indicate the full path name where your custom email client software is located.
Encryption level This applies when you select the Archive document option and set the Archive type to PDF or Both.
[Note]

Only the PDF version of the document can be encrypted.

FieldDescription
NoneSelect this if you do not want to encrypt the document.
128 BitSelect this to encrypt the PDF version of the document using 128 bit encryption.
[Note]

Encryption is only applied to documents created using this template from the time you select this option.

Documents already created are not affected.

Encryption master password Enter the master password used to secure the document. This field is mandatory if you selected to encrypt the document.

The password is not validated and can be a mixture of letters, numbers and symbols to a maximum of 50 characters.

The password is only required to change the permissions or security for the document or to change or copy the content of the document. It is not required to view, print or reprint the document.

This password is for your internal use only and should not be made known to your customers or other parties external to your organisation.

Fax options  
Group by contact information

Select this to fax all documents for a single contact name and number together in a single fax transmission.

If you select his option, then fewer faxes are sent.

Variables

This pane lists the variables you can use to format the Email subject line and the attachment File name for emailing documents using the selected document template.

Variables prefixed with a % are specific to each document type and are the same fields you selected as the available archive fields (see Archive.) Variables prefixed with a $ are system-wide variables and are available for all document templates.

[Note]

The variable names are case sensitive, so they must be entered exactly as displayed.

Printers

These options enable you to add printers for the selected document template and to indicate the number of copies to print when printing the document using this template.

[Note]
  • If you do not define any printers against the document template, then the {Current printer}is used by default.

    The {Current printer} defaults to one of the following:

    • the current SYSPRO printer
    • the default printer assigned to the program. If using server-side printing, ensure that a valid printer has been assigned by the administrator.
    • the default printer destination for the specific document (e.g. SO Batch Invoicing - Printer Preferences)

      If none of these are defined, then the Print dialog screen for your operating system is displayed, enabling you to indicate the printer to use.

  • The Print Preview screen is displayed for all SRS documents when printed from a program regardless of whether printing online or in batch mode when the option: Document Preview is enabled (Setup - Printing) and the program from which the print is generated does not explicitly instruct the SRS print program (SRSPRT) not to preview.

Refer to Printers for additional information.

Field Description
Add printer Add one or more printers for the template.

The printers defined here are used when you print or reprint the document, either online or in batch from the various document print programs. They do not apply to re-printing documents from within the SRS Document Archive Viewer programs.

You can add a specific printer, a Crystal printer and/or a SYSPRO printer. Refer to SYSPRO Printing for details on defining printers.

[Note]

If you add multiple printers, then the document is printed to each printer listed.

This enables you to generate the document on multiple printers without having to reprint it to each printer

Add SYSPRO current printer Print the documents to your current SYSPRO printer.

You can define this printer from the SYSPRO Desktop SYSPRO Ribbon bar->Setup.

Add Crystal template printer

Print the documents to the printer defined against the template.

To define the Crystal template printer, you need to select the Design option to display the Crystal Reports for SYSPRO screen. You then select File->Print Setup and define the Crystal template printer in the Printer Options.

Browse for printer

Display the Print dialog screen for your operating system.

The printers currently available are displayed, enabling you to indicate the printer you want to add.

Ensure that the relevant server-side printers have been defined by the administrator.

Do not print

Create and store the document on the server, without printing it.

You can then select to query, print and/or email the document from the client.

This option only applies to printed documents and does not impact documents being emailed or faxed.

[Note]

With client-side printing the generated document will not be stored after printing.

Delete Delete the printer currently highlighted in the listview from the list of printers to use for the template.
[Note]

If you delete all printers, then the {Current printer} is restored and used.

Name This indicates the name of the printer.
Prompt at runtime Select this to be able to print the number of copies indicated at the time of printing the document and to ignore the value entered in the Copies field.
[Note]

This option is only available for the {Current printer}.

This only applies if Print Preview is selected.

Copies

Indicate the number of copies of the document to print when using this template.

If you selected the Prompt at runtime option, then this setting is ignored and you indicate the number of copies you require from the Print dialog screen.

History

This pane displays details of maintenance performed on the document template.

Field Description
Action

This indicates the action performed on the document template.

These actions include:

  • Created - details of when the template was created.

  • Saved - details are recorded each time you change an option or change printer details.

  • Designed - details are recorded when you use the Design function to change the template.

Operator This indicates the name of the operator who created, modified or saved the document template.
Date This indicates the date on which the action took place.
Time This indicates the time at which the action took place.

Details

This pane displays the locations of the files defined for the document template.

The following information is included in this pane:

Field Description
File location This indicates the location of the document template, schema and sample XML files for the document.
Template path This indicates the full pathname and name of the document template file.
Schema path This indicates the full pathname and name of the schema file for the document template.
Sample XML path This indicates the full pathname and name of the sample xml file for the document template.

Notes and warnings

Restrictions and limits

  • Only one operator at a time may edit document templates or types, because the control files for SRS Document Printing are XML based. This is a system-wide lock.

  • Spooling large batches to print could cause memory allocation issues.

Coding considerations

  • The error message String Is Non-Numeric is displayed when designing a template, if you included comments in a formula, and the comment fields are not defined as numerictext.

  • The Page Setup option set against the template while in Design mode is ignored. The paper size for the printer is always used.

Program access

  • This program can be accessed:

    • by selecting the Change icon from the Templates pane of the SRS Document Print Setup program
    • from within each of the Stationery Format programs by selecting SRS Options and then Change for an existing SRS document format.

Changing a document template configuration

You would typically use this procedure when you need to change the options (archive, email, print or fax) defined against a document template configuration, or when you need to add or remove printers to the document template configuration.

  1. Open the SRS Document Print Setup program (SYSPRO ribbon bar > Setup > Stationery Formats > SRS Document Setup).

  2. Within the Document Types pane select the required document type, and then select the document template configuration you want to change from the Templates pane.

  3. Select (Change > Template) from the Edit menu.

  4. Change the document description and the template file name, if required.

  5. Change the required options and printers.

  6. Save your changes.

    The details in the Templates pane are refreshed and the changes saved to the ..\Base\ReportingCustomized\DocumentControl\documents.xml control file.

Copying a document template configuration

You would typically use this procedure when you want to use the same template, but have different archive, email, fax or printing options defined in the document template configuration.

  1. Open the SRS Document Print Setup program (SYSPRO ribbon bar > Setup > Stationery Formats > SRS Document Setup).

  2. Within the Document Types pane select the required document type, and then select the document template configuration you want to copy from the Templates pane.

  3. Select (Change > Template) from the Edit menu.

  4. Select Copy from the Edit menu.

    A (2) is added by default to the original document description.

  5. Change the document description, and any of the options and printers, if required.

  6. Save your changes.

    The copied template configuration is added to the Templates pane and the ..\Base\ReportingCustomized\DocumentControl\documents.xml control file.