eOrder - Installation and Configuration Guide Volume 3: Configuration Part 1 (File Upload Properties and E-Mail Settings)

Configuration

This section describes the configuration settings required for a baseline eOrder installation. See Customization to learn how to tailor the web forms to meet your specific needs.

Editing Configuration Files

Please make a backup copy of any configuration file prior to editing in case you need to revert to an earlier version of the file.

Please use a source code editor such as Notepad++ to edit the configuration files. A source code editor will provide automatic color coding of comments, tags, attributes and values. Automatic color coding makes the configuration files easier to read and edit, and provides visual clues when an item is formatted incorrectly.

Notepad++ is a free and open source application, and may be downloaded from http://notepad-plus-plus.org.

*Do not use a word processor (example: Microsoft Word) to edit any of the configuration files.

Several of the configuration files contain Extensible Markup Language (XML), and have an .xml or .xsl extension. Each property value in an XML file is contained within opening and closing tags. For example:

<property-name>property-value</property-name>

Be careful when modifying these files. If you inadvertently delete a closing tag or bracket or forward slash, eOrder will not function as desired. The XML file must be properly formatted. After editing, you may validate the syntax of the file using either of the following methods:

General Settings

The general configuration settings are stored in the upload.properties file located in the "conf" subfolder in the installation path. This is a text file which you may edit with a source code editor such as Notepad++.

Upload.Properties File

*Before making any changes to the upload.properties file, please make a copy of the original file in case you need to revert to the original settings.

An unmodified upload.properties file appears as follows:

rootPath=C:/PLP/Uploads
archive.enabled=true
email.enabled=true
pfs.enabled=false
track.enabled=false
track.host=localhost
order.number.format={00000}
order.number.last=0

rootPath

This is the "root" file system path to which uploaded files will be saved.
Use forward slash (/) or double backslash (\\) to separate entities in the rootPath. For example:
  • C:\\Folder\\Subfolder - OR -
  • C:/Folder/Subfolder
  • Mapped drives (net use) and virtual drives (subst) are not supported for rootPath. Use a Universal Naming Convention (UNC) path instead. For example:
  • \\\\SERVER\\Folder\\Subfolder - OR -
  • //SERVER/Folder/Subfolder
*You must specify a UNC path if you plan to enable PlotWorks Pro Integration, even if the uploaded files will be stored on a local drive.
*You must specify a UNC path for the filepath to function correctly as a clickable link within email clients.  Will open Windows Explorer to the exact folder path of the files uploaded.

archive.enabled

When archive.enabled is set to true, a date-based folder structure will be created under rootPath when the next order is placed.


The first folder level is named YYYY-MM where YYYY is the current year and MM is the current month (with a leading zero if needed).

The second folder level is named DD where DD is the current day of the month (with a leading zero if needed).

Finally, a unique subfolder folder will be created under the DD folder for each order received on that day, named according to the order.number.format property.

The archive.enabled property should, in almost all cases, be set to true in order to provide a permanent, date-based folder structure for uploaded files. The date structure enables anyone to easily find today's orders, and it simplifies file management (archive/deletion) for system administrators.

*If archive.enabled is set to false, a uniquely named folder will be created in rootPath for each order. The folder name is in the form of a Globally Unique IDentifier (GUID). For example: f31bae59-cf7f-40de-8bed-6bc02a5d0a92.

email.enabled

This property must be set to true in order to send e-mail notifications upon receipt of order.

pfs.enabled

This property must be set to true to enable PlotWorks Pro Integration. When enabled, a subfolder named "Job Tickets" will be created under rootPath when the next order is placed, along with a unique subfolder for each new order. A PlotWorks Flexibile Submission (PFS) file and a copy of the order form will be created in the unique subfolder. The location of the uploaded files (controlled by archive.enabled) is not affected.

track.enabled

If you are using OpCenter Track to log and track your orders, setting track.enabled to true will enable automatic creation of OpCenter Track job records upon order submission. If this property is set to true, track.host must be set appropriately.

track.host

To enable integration with OpCenter Track (track.enabled=true), you must set track.host to the fully qualified domain name or IP address of the server hosting OpCenter Track. For example: track.host=oct.example.com or track.host=192.168.1.200.

*Integration with OpCenter Track requires a minor update to the OpCenter Track server. Please contact Customer Support for assistance at support@opcenter.com

order.number.format

This property controls automatic order number formatting. Changes to this option only affect new orders. The company name for the contact who uploaded the order will auto-populate after this number as "_Company Name Here". Total length of the order number must not exceed 13 characters. 
For example:
  • AB-{0000} will create order numbers like AB-0123_Company Name
  • CD{000000} will create order numbers like CD000123_Company Name
  • EF-{0000}-GH will create order numbers like EF-0123-GH_Company Name
  • The text outside of the brackets may only contain a hyphen, a-z, A-Z, and 0-9. You may also use the following macros to include date components in the order number:
  • {MM} - month with leading zero
  • {DD} - day of month with leading zero
  • {YY} - year in 2 digit format
  • {YYYY} - year in 4 digit format
  • For example:
  • {YY}{MM}{DD}-{000} will create order numbers like 120916-123_Company Name
  • {YYYY}{MM}{DD}-{00000} will create order numbers like 20120916-0123_Company Name

order.number.last

The initial value upon installation is zero. This property is incremented by one every time an order is placed.

E-mail Settings

The e-mail configuration settings are stored in the SendMail.xml file located in the "conf" subfolder in the installation path. This is a text file which you may edit with a source code editor such as Notepad++.

*Before making any changes to the SendMail.xml file, please make a copy of the original file in case you need to revert to the original settings.

An unmodified SendMail.xml file appears as follows:

************************************************************************************************************************************
<?xml version="1.0" encoding="utf-8" ?>
<configuration version="2.0">

   <!-- This section contains email server configuration settings. -->
   <!-- If company email is hosted with an ISP or internally, contact your system administrator.  -->
   <!-- If company email is hosted with Google.com, configure host smtp.gmail.com and port 587    -->
   <!-- If company email is hosted with Office 365, configure host smtp.office365.com and port 25 -->
   <connection id="default">
     <host>localhost</host>
     <port>25</port>
     <username></username>
    <password></password>
     <useSSL>false</useSSL>
     <debug>false</debug>
     <timeout>60</timeout>
     <enableTLS>true</enableTLS>
   </connection>

   
   <!-- This template is used to send order confirmation email to the customer. -->
   <template id="order-customer" connection-id="default">
      <from></from>
      <bcc></bcc> <!-- optional -->
      <subject>Thank you for placing an order: {id}</subject>
   </template>
   
   <!-- This template is used to send order confirmation email to the operator. -->
   <template id="order-operator" connection-id="default">
      <from></from>
      <to></to>
      <cc></cc> <!-- optional -->
      <subject>{company} has placed an eOrder: {id} Due: {duedate} {duetime}</subject>
   </template>
   
   <!-- This template is used to send pickup confirmation email to the customer. -->
   <template id="pickup-customer" connection-id="default">
      <from></from>
      <bcc></bcc> <!-- optional -->
 <subject>Thank you for placing a Pickup Order: {id}</subject>
   </template>
   
   <!-- This template is used to send pickup confirmation email to the operator. -->
   <template id="pickup-operator" connection-id="default">
      <from></from>
 <to></to>
      <cc></cc> <!-- optional -->
      <subject>Pickup Order: {id}</subject>
   </template>
   
   <!-- This template is used to send error notifications to the administrator. -->
   <template id="administrator" connection-id="default">
      <from></from>
      <to></to>
      <cc></cc> <!-- optional -->
      <subject>eOrder reported a problem</subject>
   </template>

</configuration>
************************************************************************************************************************************

connection id="default"

You can use the connection id section to create multiple connections for multiple store locations, forms, etc.  The default value is listed above.  If you choose to change this value, please copy the entire <connection></connection> section and duplicate in this file for your needs.

host

This property is required. This is the IP address or fully qualified domain name of your SMTP server (example: smtp.example.com).

port

This property is required. It is the port on which your STMP server listens for incoming connections, typically 25, 465 or 587.

username

This property should be blank if you are using an open relay (see Volume 2 of the configuration guide), otherwise it is required. This is the username that will be used to authenticate the connection with your STMP server.

The format of the username can be different depending on your SMTP server. With some SMTP servers you might have to specify john.doe@example.com, while other SMTP servers might require only john.doe.

Some SMTP servers are configured to block outbound mail if the "from" address is different than the account used to authenticate with the server. For example, if you were to authenticate as "john.doe@example.com," you may not be able to send a message where "orders@example.com" is the "from" address. To avoid this possibility, please make sure that the "from" address is associated with the account used for authentication.

password

This property should be blank if you are using an open relay (see Volume 2 of the configuration guidesee E-mail), otherwise it is required. This is the password associated with the username that will be used to authenticate the connection with your STMP server.  In this circumstance, useSSL should be set to false.

*At some point in the future, if you elect to change the password associated with this e-mail account, you will need to edit SendMail.xml to update the password.

useSSL

This property is required, and must be set to true or false. This property determines whether or not the Secure Sockets Layer (SSL) protocol should be used to establish an encrypted connection to the SMTP server. This is typically set to true when using port 465.

debug

This property is optional, and must be set to true or false. If set to true, additional information will be written to the log file when the software attempts to send an e-mail notification.

timeout

This property is required.  This value is set in seconds, and is the timeout value for the eOrder server to establish communication with the mailserver to send the email.  After 60 seconds (default value), the connection will timeout and the email will fail to send.

useTLS

This property is required, and must be set to true or false. Transport Layer Security (TLS) is the successor to SSL. eOrder will automatically establish a TLS connection if your STMP server supports the TLS protocol.  If your mailserver is hosted locally and you do not require TLS, you can set this value to false.

Email Templates

eOrder supports multiple email templates for different types of emails to be sent out.
  • order-customer - The email that is sent to the customer who is placing the order
  • order-operator - The email that is sent to the internal operator in your company when an order is placed
  • pickup-customer - The email that is sent to the customer who is placing the pickup request
  • pickup-operator - The email that is sent to the internal operator in your company when a pickup request is placed
  • administrator - If eOrder/ePickup encounters any errors, this email template is used to notify those specified
Each template is referenced with a <connection id="value"> and a <template id="value">.  Using the above connection id, in conjunction with the corresponding email template will send the correct email out.

from

This property is required. This e-mail address will appear in the FROM line of the message. When a customer replies to your message the reply will be sent to this address.

Some SMTP servers are configured to block outbound mail if the "from" address is different than the account used to authenticate with the server. For example, if you were to authenticate as "john.doe@example.com," you may not be able to send a message where "orders@example.com" is the "from" address. To avoid this possibility, please ensure that the "from" address is associated with the account used for authentication.

to

This property is required for the "Operator" and "Administrator" templates.  This is the email address of where these emails will need to go to.

bcc

This property is optional.  If provided, this e-mail address will be added to the BCC line of the message.  You may add multiple recipients to the bcc property by separating each recipient with a comma.

cc

This property is optional.  If provided, this e-mail address will be added to the CC line of the message. You may add multiple recipients to the cc property by separating each recipient with a comma.

subject

This property is required.  The subject line can be modified to your preference.  Email tokens can be added to the subject line to populate information on the subject line when the email is sent.  These tokens are as follows and require {}:
  • {company} - The company name listed on the Contact Tab will be populated here
  • {id} - The order ID number
  • {duedate} - The Due Date of the order MM/DD/YEAR
  • {duetime} - The Due Time of the order XX:XX

This is an example of a valid SendMail.XML file:
************************************************************************************************************************************
<?xml version="1.0" encoding="utf-8" ?>
<configuration version="2.0">

   <!-- This section contains email server configuration settings. -->
   <!-- If company email is hosted with an ISP or internally, contact your system administrator.  -->
   <!-- If company email is hosted with Google.com, configure host smtp.gmail.com and port 587    -->
   <!-- If company email is hosted with Office 365, configure host smtp.office365.com and port 25 -->
   <connection id="default">
<host>smtp.example.com</host>
<port>25</port>
<username>orders</username>
<password>MySecretPassw0rd</password>
<useSSL>false</useSSL>
<debug>false</debug>
<timeout>60</timeout>
<enableTLS>true</enableTLS>
   </connection>

   
   <!-- This template is used to send order confirmation email to the customer. -->
   <template id="order-customer" connection-id="default">
      <from>orders@example.com</from>
      <bcc></bcc> <!-- optional -->
      <subject>Thank you for placing an order: {id}</subject>
   </template>
   
   <!-- This template is used to send order confirmation email to the operator. -->
   <template id="order-operator" connection-id="default">
      <from>orders@example.com</from>
      <to>orders@example.com</to>
      <cc></cc> <!-- optional -->
      <subject>{company} has placed an eOrder: {id} Due: {duedate} {duetime}</subject>
   </template>
   
   <!-- This template is used to send pickup confirmation email to the customer. -->
   <template id="pickup-customer" connection-id="default">
      <from>orders@example.com</from>
      <bcc></bcc> <!-- optional -->
 <subject>Thank you for placing a Pickup Order: {id}</subject>
   </template>
   
   <!-- This template is used to send pickup confirmation email to the operator. -->
   <template id="pickup-operator" connection-id="default">
      <from>orders@example.com</from>
 <to>orders@example.com</to>
      <cc></cc> <!-- optional -->
      <subject>Pickup Order: {id}</subject>
   </template>
   
   <!-- This template is used to send error notifications to the administrator. -->
   <template id="administrator" connection-id="default">
      <from>orders@example.com</from>
      <to>administrator@example.com</to>
      <cc></cc> <!-- optional -->
      <subject>eOrder reported a problem</subject>
   </template>

</configuration>
************************************************************************************************************************************


If you have any further questions/comments, please contact OpCenter's technical support team at the below contact information.


 |  | 
2300 Clarendon Boulevard

Suite 250, Box 29
Arlington, VA 22201-3367 USA

Sales
+1.703.740.8909 x3
+1.800.444.7568 x3

Support
+1.703.740.8909 x2
+1.800.444.7568 x2

Main
+1.703.740.8909
+1.800.444.7568

+1.703.995.4398 (fax)

Feedback and Knowledge Base