The mkzcommon.config file contains configuration values that relate both to the website/webservice modules and to the printroomservice.
<!-- LDAP DIRECTORY SETTINGS *** -->
<add key="DirectoryServer" value="server"/>
<add key="DirectoryRoot" value="dc=office,dc=mydomain,dc=com"/>
<add key="DirectoryUserObjectSearch" value="sAMAccountType=805306368"/>
<add key="DirectoryUserObjectSearch" value="objectClass=user"/>
<add key="DirectoryUserNameAttribute" value="sAMAccountName"/>
<add key="DirectoryGroupMembershipAttribute" value="memberOf"/>
<add key="DirectoryAuthenticationType" value="Secure"/>
<add key="DirectoryAllowedUsersGroup" value="MinkzUsers"/>
<add key="DirectoryAdministratorsGroup" value="MinkzAdmins"/>
<add key="DirectoryPrintOperatorsGroup" value="MinkzPrintOps"/>
<add key="DirectorySystemAdministratorsGroup" value="MinkzSuperAdmins"/>
<add key="DirectoryCacheUsers" value="False"/>
<add key="DirectoryAccessUser" value=" "/>
<add key="DirectoryAccessPassword" value=" "/>
<add key="DirectoryOrganisationGroups" value=" "/>
<add key="DirectoryOrganisationGroupsPrefix" value=" "/>
<add key="DirectoryUserAttributes" value=" "/>
<add key="DirectoryAllowGroupManagement" value="false"/>
For all the entries in this section, see the separate tech note TN - Active Directory. These entries are only if LDAP integration is enabled. Otherwise they can be ignored.
<!-- GENERAL SETTINGS ******* -->
<add key="FieldSeparator" value="-"/>
Specifies a single character to separate the fields that define the final concatenated output file name.
<add key="AllowGuests" value="false"/>
A boolean value that determines if users may connect as guests to the website to compose a letter, and then only
log in if they decide to post it.
<add key="PrinterStatusTimeout" value="1500"/>
Specifies number of seconds to wait for printer response when an output is configured to write directly to an actual printer.
<add key="PrintQueuesUpdateSeconds" value="5"/>
Specifies number of seconds between each auto-refresh of the Print Queues page.
<add key="Minimum lines of address" value="3"/>
Specifies minimum number of address lines that must be present before a letter will be accepted for further processing.
This is the first check performed on a letter when it is submitted.
A letter is blocked if it fails the test. An optional value of reject can be used to move failing letters
to the Rejected queue instead of blocking them. E.g.
<add key="Minimum lines of address" value="3"/> - block letters with fewer than 3 lines
<add key="Minimum lines of address" value="3,reject"/> - accept letters and move to Rejected queue
<add key="Ignore Address Check" value=""/>
Specifies a semicolon-separated list of key words that, if found in the address text, will cause all address checking to be ignored.
Use with care! Normally intended for letters heading for Docman or Keyman processing
<add key="SuspendWeekendOutputRelease" value="0"/>
Specifies a single number value to determine whether auto-scheduled outputs will be released at weekends
0 = release every day
1 = do not release on Saturdays
2 = do not release on Sundays
3 = do not release on Saturdays or Sundays
<add key="PAF Location" value=""/>
Specifies a fully-qualified filename defining the Australia PAF location. Only applicable to the Civica Australia system.
<add key="VAT rate" value="20" />
Specifies a single VAT rate applied. Only used to display estimated prices in the print client.
<add key="CustomExtractionStrategySpaceWidthDivisor" value="2.0" />
Specifies a width of a gap in PDF text required to insert a space character into the scanned text.
This is a floating-point number between 1.50 and 4.00.
<add key="DatabaseArchivePeriod" value="365" />
Specifies the number of days a letter record is kept in the database. N.B. this is not the same as
the Archive Period defined for each organisation in the website – which defines the number of
days that the letter PDF file will be kept.
This section selects the OMR format
<!-- OMR SETTINGS **************************** -->
<add key="MailpieceMarker" value="START_MAILPIECE;10,6"/>
Specifies the string value and the X,Y, location that is stamped on the first page of each mailpiece
for the Xerox_Mailpiece OMR set. This is currently deprecated, but may be revived
<add key="OmrPosition" value="X,Y,size"/>
Specifies the location where the OMR mark will be stamped. The X and Y values are mandatory.
The size value is optional, and its default varies with the particular OMR set
<add key="OmrSeqMarks" value=""/>
<add key="OmrBaseMarks" value=""/>
<add key="OmrSpyMarks" value=""/>
For the three entries above, see the separate tech note TN - OMR Base Marks.
This section defines the status and error emails sent back to Funasset
<!-- ERROR MONITORING SETTINGS ************* -->
A Summary Report is an email that is generated each time an output is released.
<add key="SummaryReportEmailTo:NN" value=""/>
<add key="SummaryReportEmailTo" value=""/>
Specifies a semicolon-separated list of recipients. The NN refers to the ID of a specific output.
Each output first looks for a key where NN specifies its own ID before looking for the generic one.
This can be used to specify a different list of recipients for certain outputs. E.g.
Output 27 will look first for an entry with a key of SummaryReportEmailTo:27.
If it is found, then the report is sent to the recipients in the value.
If the entry not found, or the value is empty, then the output will look for the generic
SummaryReportEmailTo entry instead.
<add key="SummaryReportEmailSubject" value=""/>
Specifies the subject line for the email. It is recommended that the subject should contain
the server name and the phrase 'Release Output'.
A Health Check Report is an email that is generated once per day.
<add key="HealthCheckReportEmailTo" value=""/>
<add key="HealthCheckReportEmailSubject" value=""/>
For the two entries above, see the separate tech note TN - Daily Health Check.
An Exception Report is an email that is generated if the error rate exceeds the configured value.
<add key="ExceptionLimit" value="20 in 60"/>
Specifies a number of errors that may occur in a number of minutes. If this rate is exceeded
then the exception report is generated.
<add key="ExceptionReportEmailTo" value=""/>
Specifies a semicolon-separated list of recipients.
This section defines the default error settings - rarely used
<!-- EMAIL OUTPUT SETTINGS ********************************** -->
<add key="Email Subject" value=""/>
<add key="Email Body" value=""/>
<add key="Email attachment name" value=""/>
These three values specify defaults for emails generated by Outputs configured as 'Email'.
Under normal circumstances these values would be collected during letter processing by the
appropriate tags in the XML Email Attachment. These defaults would only be used in the case
that the XML processing failed to collect the appropriate data.
lt;add key="Draw Address Box" value="false" />
Specifies a boolean value that will cause a box to be drawn around the address area throughout letter
processing including on the final printed file. Normally the box is only drawn on template and envelope previews.
<add key="BarcodeFontSize" value="6" />
Specifies the size of the barcode for Civica Australia outputs to BlueStar.
<add key="SuburbStatePostode" value="true" />
Specifies a Boolean value that causes the last three lines of the address to be printed all on the same line.
Only applicable to Civica Australia.
This section identifies theis server to a Master Server
<!-- RELAY SETTINGS *********************************** -->
<add key="Server ID" value="ID"/>
Specifies the server ID as a two-digit string. This is an important value: it forms part
of the mailmark barcode and is used to identify the originating server when returned letters are scanned.
Master servers are given IDs from "90" downwards in multiples of 10. Slave servers are given IDs from "00" upwards
in multiples of 1. Servers that do not use mailmark are all given the ID of "95". E.g.
Xerox-Master="90" TAone-Master="80" J41-Master="70"
Homerton="03" Imperial="04" Maidstone="06"
HMS="95"
<add key="OtherMasterServers" value="ID=name;ID=name;" />
Specifies the server IDs of any other master servers that may be involved in the same enterprise.
This is required so that returned letters can be scanned into any of the master servers and will be
updated on the correct one. E.g.
<add key="OtherMasterServers" value="80=TAone-Master;70=J41-Master;" />
N.B. For each server named in this entry there must be a corresponding entry in the <SqlConnections> section.
This section connects the XML attachment type keyword to the actual DLL
<!—- XML ATTACHMENT SETTINGS ************************************* -->
<add key="DefaultPreProcessXMLFile:nn" value="full path name to file.xml"/>
<add key="DefaultPostProcessXMLFile:nn" value="full path name to file.xml"/>
These optional settings specify default XML files that are executed for all templates for organisation 'nn'
before and/or after any other template-specific XML files
This section configures the output print files
<!-- GMCS SETTINGS ************************************** -->
<add key="GmcsPaperStock" value=""/>
<add key="GmcsEnvelopeStock" value="/>
Specifies the default Xerox stock codes for paper and envelope respectively. These values are only
used if the stock values requested in the GMCS file do not have entries in the HybridMail2StockCode
database table. In most cases they can be ignored.
<add key="GmcsJobMode" value=""/>
This should be left blank until Xerox tells us what it's used for.
<add key="GmcsAccountID" value="Funasset"/>
This should be left as 'Funasset' on the Xerox systems.
<add key="GmcsSubAccountID" value=""/>
This is a string that gets returned to us in the GMCS response report files so that we can identify
which server the report files should be processed.
<add key="GmcsJobName" value=""/>
This should be left blank for production on the Xerox systems.
<add key="MaxInsertFeeders" value="5"/>
Specifies the maximum number of inserts that can be simultaneously handled in a single GMCS file.
If more inserts are required they will be added as PDF pages directly within the body of the
concatenated PDF file. This value reflects the actual machinery at Xerox i.e. don't just increase it ad lib.
<add key="GmcsMaxItemsPerReport" value="2000"/>
Specifies the maximum number of mailpieces (could be more letters if some combine) to be wrapped in a single GMCS report.
<!—- COMMS SERVER SETTINGS ************************************* -->
<add key="CommsHost" value="URL"/>
Sets the URL used by the Comms Server on this machine
<add key="CommsTimeout" value="n"/>
Sets the timeout used by the Comms Server on this machine
<add key="CommsHost:NN" value="URL"/>
Sets the URL used to contact the Comms Server of other master servers on this network.
This works in conjunction with the OtherMasterServers value, where NN represents the
server ID of another master server
This section configures Mailmark
<!-- MAILMARK SETTINGS **************************************** -->
<add key="Mailmark SCID" value="8001260"/>
<add key="Mailmark RTS" value="TA1 1JJ"/>
<add key="Mailmark Participant ID" value="10100743"/>
<add key="Mailmark web service username" value="XeroxCorporationUK_test_WS"/>
<add key="Mailmark web service password" value="CeO(C6/|a5"/>
<add key="Mailmark Handover Delay" value="1"/>
<add key="Mailmark TestMode" value="1"/>
Sets the Mailmark processing module in a test mode that accurately emulates the behaviour of the
mailmark webservice but does not actually submit batches or manifests to Mailmark.
For all the entries above, see the separate tech note TN - Mailmark.