X9Assist provides customization capabilities in various areas within the application. This are configuration changes that are supported within our standard products.
X9 and Tiff Rules
All validation rules (both x9 and for tiff images) are defined in XML configuration files. This allows you to modify the edits that are being applied to incoming x9 files. For example, you could decide to remove one of the standard edits that is in place, or you could change the list of allowable values for a given field. On the image side, configuration changes could be made to set minimum and maximum image sizes, EOFB presence, or required tiff tags. If you require editing capability that cannot be met by our current x9 rule set, then please contact us and we will make the changes required to meet your specific needs.
Missing Image Documents
X9Assist will utilize the missing image documents in several situations:
- Generate when dynamic images are not drawn
- Import when an image is not provided and dynamic images are not drawn
- Modify when an image is forced to a missing image document
X9Assist has separate missing image documents that are located in the x9assist\images folder. You can customize these images per your requirements.
These images must be stored in Tiff format and can be created using various paint tools. Our recommendation is GIMP2 which is open source and easy to use. There are obviously many other options and feel free to use your tool of choice.
Per X9 tough tiff standards, there are requirements to create a single strip Tiff image with very specific tiff tags. This is difficult (perhaps impossible) to do with available image paint tools. Given this issue, X9Assist use our internal tiff repair functionality to create a Tiff image that meets X9 tiff standards. This simplifies your process since you do not need to be concerned with Tiff standards when you create the tiff images to be used for missing front and missing back.
Credit Reconciliation Documents
X9Assist will utilize the credit reconciliation image documents when drawing the images for a type 61 credit reconciliation record. The front image must be designed to accept the overlay of a MICR line at the bottom. The MICR line will be added by X9Assist using information from the type 61 credit reconciliation record. These images must be stored in Tiff format and can be created using various paint tools. Our recommendation is GIMP2 which is open source and easy to use. There are obviously many other options and feel free to use your tool of choice.
As with the missing image documents, X9Assist will use your image and our repair routines to create the TIFF image that will be used internally. Because of that, you do not need to be concerned with X9 tiff standards when you create this image.
Check image creation within X9Assist can be extended with your own custom artwork.
Image formats are defined within categories. There are currently two defined categories (retail and business). These category definitions may be extended in the future based on user requirements.
The following steps must be followed when adding check artwork:
- Use a paint tool to create your check artwork. You can look at our existing formats in the x9assist/images folder to get an idea of how the current check image formats have been designed. A key part of your design is to ensure that MICR band (the bottom 9/16 of an inch) remains blank at the bottom of the image. When creating your check format, you need to consider the size (especially the length) based on your desire to support the Aux OnUs field which is required on business checks. Our check formats were designed using Photoshop which allows a very clear and sharp image to be created. You could do the same using other tools such as GIMP.
- Store your created image format(s) in the x9assist/images folder.
- Review the existing x9assist/xml/checkFormats.xml definition to get an understanding of how check formats are defined and the fields that must be specified. You must add your new check formats to this definition, which is used to provide the fonts, x/y coordinates, and lengths of each of the fields that can be displayed on your new image formats.
- You will now need to document the x/y coordinates and lengths of each of the fields for your new check format. The coordinates and lengths must be documented in inches. Most paint tools allow you to use the mouse and point at any pixel with the image and get the x/y coordinates. For example, GIMP will display these coordinates in either pixels, inches, or centimeters. This is a very detailed step but easily accomplished when you use a tool that provides the needed positional feedback.
- Determine what fonts you want to use for the various fields that will be drawn on top of your image format. You must also provide the initial font size to be used for the drawing process. If the drawn text will not fit within the available space, X9Assist will progressively reduce the font size until the text will fit. However, there is a performance hit when this is done so you will want to ensure that your font and size will allow all text to be drawn within the available space you are providing. This process is simplified if your image design allows sufficient space for all fields.
- Update the x9assist/xml/checkFormats.xml based on your formats and fields.
You can modify the severity that is assigned to all error messages that are created by X9Assist. This is done by modifying the error message severity as defined in the XML definition that is defined in your installation folder ProgramFiles/x9assist/rules/messages. You can also define multiple message files and define x9 configurations to be used for specific combinations of origination/destination RT. You define x9 configurations using the configuration editor and then assign them using the mapping editor.
Regarding error message severity, please reference the following two message examples.
tiff image segment does not end with EOFB
endorsement count on 25/31 does not agree with addendums present
In the above, you can see that error message 333 is assigned a “warn” severity and that error message 156 is assigned an “error” severity.
The error severity levels can be assigned:
If you specifically modify severities in the messages.xml definition, you should maintain a list of you changes so you can apply them to future release installations.
Please contact us at email@example.com Your inquiries are very important to us and we will reply promptly.