NewHaven Software Wiki - User contributions [en]

Server Update

2021-05-03T16:24:48Z

Russ horton:

=Overview=

This article details the instructions for updating CMS to version 8, 9, and 10.

=Preparing for the Installation=

Before you begin installing or updating your Server please review the list below.

== Updating reports ==

If you are updating from CMS version 10.0.4 or older and you use custom CMS forms or crystal reports. We will need to update those reports. Please contact support@newhavensoftware.com directly so we can review this with you.

==Backing up CMS==

Below is information about backing up your CMS information before updating.

===Creating backups if doing a CMS 8 or later update===

Before updating CMS to a new version from v8 or 9, you will want to create a Database backup. To do this please review the instructions in the link below.
http://wiki.newhavensoftware.com/index.php/Creating_a_Database_Backup

==Download the CMS Installer==
Please visit http://updates.newhavensoftware.com/
For information on using the update page and downloading the installer please review the video : http://youtu.be/dBbd94k7b0A

==Time to Update the Server==
Newer versions of CMS can typically be updated in roughly 10 min to 1 hour, depending on the size of your database.

==Workstation Updates==
'''Note: If you are updating CMS 9 to CMS 10, you will be required to run a Workstation update on all of your Windows 10 CMS Workstations.

For information on this process please click the link below. http://wiki.newhavensoftware.com/index.php/Workstation_Install

==Release Notes==
Please take your time to review our release notes after an update. You can do so by clicking on the link below https://updates.newhavensoftware.com/release_notes.htm

=Server Update=
Note: Once you have verified that you meet the above prerequisites, follow the instructions below to Update your Server.

*'''BEFORE GOING ANY FURTHER PLEASE MAKE SURE EVERYONE IS LOGGED OUT OF CMS'''

To begin double click the CMS installer, then follow the screenshots shown below.

[[image:Serverupdate1.png]]

[[image:Serverupdate2.png]]

[[image:Serverupdate3.png]]

[[image:Serverupdate4.png]]

[[image:Serverupdate5.png]]

[[image:Serverupdate6.png]]

[[image:Serverupdate7.png]]

[[image:Serverupdate8.png]]

[[image:Serverupdate9.png]]

 

After following these instructions you should now be able to sign into CMS.

Sales Tax and CMS

2021-04-27T15:33:47Z

Russ horton:

=Introduction to Taxing and Nexus=
Traditionally how and where you collected sales tax was pretty straightforward. If you had a physical presence in a state, this established a sales tax [https://www.avalara.com/us/en/blog/2016/05/everything-you-wanted-to-know-about-nexus-but-were-afraid-to-ask-a-sales-tax-guide-for-small-businesses.html nexus], meaning your sales were taxable. For those states, you’d enter the corresponding rates into CMS, including the county and city rates where applicable. As e-commerce rose in prominence, however, the traditional rules for physical nexus became insufficient and started to change to suit new business models. Your nexus could now also be affected by some of the following:

*Where you are dropshipping from (including Fulfillment by Amazon - FBA)
*Affiliate relationships
*Number of days spent in a state for tradeshows/selling
*New economic nexus rules for sales into a state

=Economic Nexus=

With the 2018 [http://multichannelmerchant.com/ecommerce/wayfair-decision-bringing-clarity-uncertainty-equal-measure/ South Dakota vs Wayfair ruling], you can now also establish something called “economic nexus” merely by the amount of business you do with customers in that state. It’s important to note that this new economic nexus for tax responsibility is in addition to the aforementioned qualifications for nexus.

In an effort to protect small sellers from undue tax reporting burdens (think eBay) South Dakota established a threshold of 200 transactions or $100,000 in sales to customers in their state to establish this economic nexus. They’ve established Oct 1, 2018 as the effective date for this economic nexus rule.

Other states, waiting on the Wayfair decision, were poised to follow suit. Some have even set an aggressive start date of July 1, 2018 including VT, KY, and HI. So far it appears states will not be able to collect taxes retroactively for earlier dates. States with similar laws to South Dakota: AL, CT, GA, IA, IL, IN, LA, MA, ME, MS, ND, OH, PA, RI, SC, TN, WA, and WY with different effective dates and financial triggers. Avalara has an excellent resource explaining each of the state’s current position on economic nexus in [https://www.avalara.com/us/en/learn/sales-tax/South-Dakota-Wayfair.html this article].

=Determining Your Nexus=
When assessing transactional volume in a given state, you'll have to look to the state to understand not only the volume but also the dates they are concerned with. For example, VT considers economic nexus established if you met their thresholds in any previous 12 month period. HI and KY, however, are only looking at the current or previous calendar year.

Also, it’s worth pointing out that for some states all sales are being considered when establishing economic nexus. This includes non-taxable sales including tax-exempt products and customers, even if for resale.

To help with your determination of economic nexus, we have developed a new report called the State Tax Nexus Summary report that will show you sales dollars and the number of transactions per state for a selected range of dates. This report will soon be in CMS but, in the interim, is available via our [https://updates.newhavensoftware.com/ Support Downloads] site. Note that this is not an accounting report and should only be used for the determination of Nexus due to the methods it needs to use to determine shipping charges per recipient (data that is not explicitly stored in CMS).

Once you’ve determined that you must collect tax for a given you must then register with that state, which for most states is free but can cost up to $100. It may be helpful to use this report in conjunction with a [https://www.avalara.com/us/en/learn/nexus.html resource from Avalara which will help you understand each state's requirements].

It seems unlikely that we will see a simplification or unification of these taxes any time soon. We’ll need to contend with each state and their unique rules, rates, and compliance reporting.

=The Tax Challenge=
As you move from collecting tax for a state or two to having to collect tax for multiple states, the effort required to do this can become daunting. Trying to stay on top of changing tax rates and tax laws can be challenging enough. Even with that done, you'll then need to file your tax compliance reports to pay those taxes on a regular basis possibly monthly or quarterly.

Like PCI, this is not something small business was looking forward to. A lot of compliance effort without a lot of ROI but it is something we'll need to contend with. The last thing you want are tax audits and having to pay back taxes, especially for orders you never collected taxes on. For many of our clients, it is time to find a better tax solution.

=CMS Tax Compliance Module=

We’ve all known or feared that this day would come where we’d need to collect taxes for the majority of states. To address and simplify the increasingly complex nature of taxation and reporting we looked to partner and integrate with a third-party tax solution that specialized in servicing these needs. We originally partnered with a company called Exactor (recently purchased by Intuit to be their dedicated tax solution for their applications) and then subsequently with Avalara and their well-known [https://www.avalara.com/us/en/products/sales-and-use-tax/avatax.html AvaTax solution].

To work with these services we've developed the *Tax Compliance Module* for CMS. This module currently works with both Exactor (now defunct) and Avalara (Avatax) allowing you to get current accurate tax rates with a single click in Order Entry (and Returns) without having to set up and maintain any tax tables in CMS.

Perhaps more importantly, these companies also provide [https://www.avalara.com/us/en/products/sales-and-use-tax/returns.html tax filing services] for you. It may be hard to imagine the overhead for your business having to do the filings for each state yourself. Not only will you have peace of mind that the returns and payments are filed on time and are accurate, you’ll also reduce your exposure to audits. CMS has a "Commits" feature that allows you to submit all shipped invoices for a range of dates to Avalara to facilitate their sales tax filing on your behalf.

These services also provide tools to help you manage exemption certificates/documentation for your tax-exempt clients to ensure the exemption documents are stored and appropriately considered for transactions in applicable date ranges.

==Current limitations==
This beta module for CMS has a couple of known limitations that you should be aware of:

*Multiships - CMS is somewhat unique in its handling of multiple recipients (e.g. gift orders) orders as a single order. This gets complicated from a tax perspective when considering how to distribute shipping charges (some states charge tax on shipping). This is something we’re working on a solution for.
*We are currently not passing COD, Insurance, or Service charges to the tax service. These are not used much so they were left out of the initial module design in the interest of getting the module to market quickly. Let us know if these are a concern for you.

Sales Tax and CMS

2021-04-27T15:22:25Z

Russ horton: /* South Dakota vs Wayfair */

=Introduction to Taxing and Nexus=
Traditionally how and where you collected sales tax was pretty straightforward. If you had a physical presence in a state, this established a sales tax [https://www.avalara.com/us/en/blog/2016/05/everything-you-wanted-to-know-about-nexus-but-were-afraid-to-ask-a-sales-tax-guide-for-small-businesses.html nexus], meaning your sales were taxable. For those states, you’d enter the corresponding rates into CMS, including the county and city rates where applicable. As e-commerce rose in prominence, however, the traditional rules for physical nexus became insufficient and started to change to suit new business models. Your nexus could now also be affected by some of the following:

*Where you are dropshipping from (including Fulfillment by Amazon - FBA)
*Affiliate relationships
*Number of days spent in a state for tradeshows/selling
*New economic nexus rules for sales into a state

=Economic Nexus=

With the 2018 [http://multichannelmerchant.com/ecommerce/wayfair-decision-bringing-clarity-uncertainty-equal-measure/ South Dakota vs Wayfair ruling], you can now also establish something called “economic nexus” merely by the amount of business you do with customers in that state. It’s important to note that this new economic nexus for tax responsibility is in addition to the aforementioned qualifications for nexus.

In an effort to protect small sellers from undue tax reporting burdens (think eBay) South Dakota established a threshold of 200 transactions or $100,000 in sales to customers in their state to establish this economic nexus. They’ve established Oct 1, 2018 as the effective date for this economic nexus rule.

Other states, waiting on the Wayfair decision, were poised to follow suit. Some have even set an aggressive start date of July 1, 2018 including VT, KY, and HI. So far it appears states will not be able to collect taxes retroactively for earlier dates. States with similar laws to South Dakota: AL, CT, GA, IA, IL, IN, LA, MA, ME, MS, ND, OH, PA, RI, SC, TN, WA, and WY with different effective dates and financial triggers. Avalara has an excellent resource explaining each of the state’s current position on economic nexus in [https://www.avalara.com/us/en/learn/sales-tax/South-Dakota-Wayfair.html this article].

=Determining Your Nexus=
When assessing transactional volume in a given state, you'll have to look to the state to understand not only the volume but also the dates they are concerned with. For example, VT considers economic nexus established if you met their thresholds in any previous 12 month period. HI and KY, however, are only looking at the current or previous calendar year.

Also, it’s worth pointing out that for some states all sales are being considered when establishing economic nexus. This includes non-taxable sales including tax-exempt products and customers, even if for resale.

To help with your determination of economic nexus, we have developed a new report called the State Tax Nexus Summary report that will show you sales dollars and the number of transactions per state for a selected range of dates. This report will soon be in CMS but, in the interim, is available via our [https://updates.newhavensoftware.com/ Support Downloads] site. Note that this is not an accounting report and should only be used for the determination of Nexus due to the methods it needs to use to determine shipping charges per recipient (data that is not explicitly stored in CMS).

Once you’ve determined that you must collect tax for a given you must then register with that state, which for most states is free but can cost up to $100. It may be helpful to use this report in conjunction with a [https://www.avalara.com/us/en/learn/nexus.html resource from Avalara which will help you understand each state's requirements].

It seems unlikely that we will see a simplification or unification of these taxes any time soon. We’ll need to contend with each state and their unique rules, rates, and compliance reporting.

=CMS Tax Compliance Module=

We’ve all known or feared that this day would come where we’d need to collect taxes for the majority of states. To address and simplify the increasingly complex nature of taxation and reporting we looked to partner and integrate with a third party tax solution that specialized in servicing these needs. We originally partnered with a company called Exactor (recently purchased by Intuit to be their dedicated tax solution for their applications) and then subsequently with Avalara and their well known [https://www.avalara.com/us/en/products/sales-and-use-tax/avatax.html AvaTax solution].

To work with these services we've developed the *Tax Compliance Module* for CMS. This module currently works with both Exactor (now defunct) and Avalara (Avatax) allowing you to get current accurate tax rates with a single click in Order Entry (and Returns) without having to set up and maintain any tax tables in CMS.

Perhaps more importantly, these companies also provide [https://www.avalara.com/us/en/products/sales-and-use-tax/returns.html tax filing services] for you. It may be hard to imagine the overhead for your business having to do the filings for each state yourself. Not only will you have peace of mind that the returns and payments are filed on time and are accurate, you’ll also reduce your exposure to audits. CMS has a "Commits" feature that allows you to submit all shipped invoices for a range of dates to Avalara to facilitate their sales tax filing on your behalf.

These services also provide tools to help you manage exemption certificates/documentation for your tax-exempt clients to ensure the exemption documents are stored and appropriately considered for transactions in applicable date ranges.

==Current limitations==
This beta module for CMS has a couple of known limitations that you should be aware of:

*Multiships - CMS is somewhat unique in its handling of multiple recipients (e.g. gift orders) orders as a single order. This gets complicated from a tax perspective when considering how to distribute shipping charges (some states charge tax on shipping). This is something we’re working on a solution for.
*We are currently not passing COD, Insurance, or Service charges to the tax service. These are not used much so they were left out of the initial module design in the interest of getting the module to market quickly. Let us know if these are a concern for you.

Sales Tax and CMS

2021-04-27T15:20:38Z

Russ horton: /* Introduction to Taxing and Nexus */

=Introduction to Taxing and Nexus=
Traditionally how and where you collected sales tax was pretty straightforward. If you had a physical presence in a state, this established a sales tax [https://www.avalara.com/us/en/blog/2016/05/everything-you-wanted-to-know-about-nexus-but-were-afraid-to-ask-a-sales-tax-guide-for-small-businesses.html nexus], meaning your sales were taxable. For those states, you’d enter the corresponding rates into CMS, including the county and city rates where applicable. As e-commerce rose in prominence, however, the traditional rules for physical nexus became insufficient and started to change to suit new business models. Your nexus could now also be affected by some of the following:

*Where you are dropshipping from (including Fulfillment by Amazon - FBA)
*Affiliate relationships
*Number of days spent in a state for tradeshows/selling
*New economic nexus rules for sales into a state

=South Dakota vs Wayfair=

With the 2018 [http://multichannelmerchant.com/ecommerce/wayfair-decision-bringing-clarity-uncertainty-equal-measure/ South Dakota vs Wayfair ruling], you can now also establish something called “economic nexus” merely by the amount of business you do with customers in that state. It’s important to note that this new economic nexus for tax responsibility is in addition to the aforementioned qualifications for nexus.

In an effort to protect small sellers from undue tax reporting burdens (think eBay) South Dakota established a threshold of 200 transactions or $100,000 in sales to customers in their state to establish this economic nexus. They’ve established Oct 1, 2018 as the effective date for this economic nexus rule.

Other states, waiting on the Wayfair decision, were poised to follow suit. Some have even set an aggressive start date of July 1, 2018 including VT, KY, and HI. So far it appears states will not be able to collect taxes retroactively for earlier dates. States with similar laws to South Dakota: AL, CT, GA, IA, IL, IN, LA, MA, ME, MS, ND, OH, PA, RI, SC, TN, WA, and WY with different effective dates and financial triggers. Avalara has an excellent resource explaining each of the state’s current position on economic nexus in [https://www.avalara.com/us/en/learn/sales-tax/South-Dakota-Wayfair.html this article].

=Determining Your Nexus=
When assessing transactional volume in a given state, you'll have to look to the state to understand not only the volume but also the dates they are concerned with. For example, VT considers economic nexus established if you met their thresholds in any previous 12 month period. HI and KY, however, are only looking at the current or previous calendar year.

Also, it’s worth pointing out that for some states all sales are being considered when establishing economic nexus. This includes non-taxable sales including tax-exempt products and customers, even if for resale.

To help with your determination of economic nexus, we have developed a new report called the State Tax Nexus Summary report that will show you sales dollars and the number of transactions per state for a selected range of dates. This report will soon be in CMS but, in the interim, is available via our [https://updates.newhavensoftware.com/ Support Downloads] site. Note that this is not an accounting report and should only be used for the determination of Nexus due to the methods it needs to use to determine shipping charges per recipient (data that is not explicitly stored in CMS).

Once you’ve determined that you must collect tax for a given you must then register with that state, which for most states is free but can cost up to $100. It may be helpful to use this report in conjunction with a [https://www.avalara.com/us/en/learn/nexus.html resource from Avalara which will help you understand each state's requirements].

It seems unlikely that we will see a simplification or unification of these taxes any time soon. We’ll need to contend with each state and their unique rules, rates, and compliance reporting.

=CMS Tax Compliance Module=

We’ve all known or feared that this day would come where we’d need to collect taxes for the majority of states. To address and simplify the increasingly complex nature of taxation and reporting we looked to partner and integrate with a third party tax solution that specialized in servicing these needs. We originally partnered with a company called Exactor (recently purchased by Intuit to be their dedicated tax solution for their applications) and then subsequently with Avalara and their well known [https://www.avalara.com/us/en/products/sales-and-use-tax/avatax.html AvaTax solution].

To work with these services we've developed the *Tax Compliance Module* for CMS. This module currently works with both Exactor (now defunct) and Avalara (Avatax) allowing you to get current accurate tax rates with a single click in Order Entry (and Returns) without having to set up and maintain any tax tables in CMS.

Perhaps more importantly, these companies also provide [https://www.avalara.com/us/en/products/sales-and-use-tax/returns.html tax filing services] for you. It may be hard to imagine the overhead for your business having to do the filings for each state yourself. Not only will you have peace of mind that the returns and payments are filed on time and are accurate, you’ll also reduce your exposure to audits. CMS has a "Commits" feature that allows you to submit all shipped invoices for a range of dates to Avalara to facilitate their sales tax filing on your behalf.

These services also provide tools to help you manage exemption certificates/documentation for your tax-exempt clients to ensure the exemption documents are stored and appropriately considered for transactions in applicable date ranges.

==Current limitations==
This beta module for CMS has a couple of known limitations that you should be aware of:

*Multiships - CMS is somewhat unique in its handling of multiple recipients (e.g. gift orders) orders as a single order. This gets complicated from a tax perspective when considering how to distribute shipping charges (some states charge tax on shipping). This is something we’re working on a solution for.
*We are currently not passing COD, Insurance, or Service charges to the tax service. These are not used much so they were left out of the initial module design in the interest of getting the module to market quickly. Let us know if these are a concern for you.

Workstation Install

2021-03-31T16:14:21Z

Russ horton: /* Troubleshooting */

=Overview=

This article details the instructions for installing or updating a CMS 8, 9, or TEN Workstation.

=Prerequisite=

Before you begin installing or updating your workstation please check that you meet the requirements for all the steps below.

==Step 1: Workstation System Requirements ==

To verify that your system meets CMS system requirements please review : http://wiki.newhavensoftware.com/index.php/CMS_System_Requirements#CMS_workstations

==Step 2: Setup a mapped drive to the CMS server==
Ensure that you have a drive mapped to the \NewHaven Software share on the server and that it is using the same drive letter as other workstations on the network. Workstations should be joined to the network domain.

For Information on how to set up a mapped drive please review the video : http://youtu.be/D1IBcjWCmPs

==Step 3: Obtain the CMS Installer==

*Locate the last CMS update used, typically found in the \Updates subdirectory of the \NewHaven Software share (where you should now have a drive mapped to)

or

*visit http://updates.newhavensoftware.com/
For information on using the update page and downloading the installer please review the video : http://youtu.be/dBbd94k7b0A (Note: The video is focused on Windows XP, however, the setup steps are the same for Windows 7/10.

=Workstation Install/Update=
Note: The steps between updating or installing a CMS workstation are the same. Once you have verified that you meet the above prerequisites, follow the instructions below to Install/Update your workstation.

To begin double click the CMS installer, then follow the screenshots shown below.

[[image:Workstation1.png]]

[[image:Workstation2.png]]

===Workstation Install Option===

[[image:Workstation3.png]]

'''NOTE: There is no need to fill in the customer number and release code. Those are only needed for server installs.'''

[[image:Workstation4.png]]

[[image:Workstation5.png]]

[[image:Workstation6.png]]

[[image:Workstation7.png]]

[[image:Workstation8.png]]

[[image:Workstation9.png]]
 

After following these instructions you should now be able to sign into CMS.

=Troubleshooting=
If you receive an error installing or you are unable to browse to the shared drive when asked for the path to CMS.exe, there is a good chance that the installer is not able to reach the mapped drive, even if it appears you mapped it correctly. To resolve this you'll need to add a registry setting as described here:

# Click Start, type regedit in the Start Search box, and then press ENTER.
# Locate and then right-click the following registry subkey: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System
# Point to New, and then click DWORD Value.
# Type EnableLinkedConnections, and then press ENTER.
# Right-click EnableLinkedConnections, and then click Modify.
# In the Value data box, type 1, and then click OK.
# Exit Registry Editor, and then restart the computer.

Workstation Install

2021-03-31T16:13:55Z

Russ horton:

=Overview=

This article details the instructions for installing or updating a CMS 8, 9, or TEN Workstation.

=Prerequisite=

Before you begin installing or updating your workstation please check that you meet the requirements for all the steps below.

==Step 1: Workstation System Requirements ==

To verify that your system meets CMS system requirements please review : http://wiki.newhavensoftware.com/index.php/CMS_System_Requirements#CMS_workstations

==Step 2: Setup a mapped drive to the CMS server==
Ensure that you have a drive mapped to the \NewHaven Software share on the server and that it is using the same drive letter as other workstations on the network. Workstations should be joined to the network domain.

For Information on how to set up a mapped drive please review the video : http://youtu.be/D1IBcjWCmPs

==Step 3: Obtain the CMS Installer==

*Locate the last CMS update used, typically found in the \Updates subdirectory of the \NewHaven Software share (where you should now have a drive mapped to)

or

*visit http://updates.newhavensoftware.com/
For information on using the update page and downloading the installer please review the video : http://youtu.be/dBbd94k7b0A (Note: The video is focused on Windows XP, however, the setup steps are the same for Windows 7/10.

=Workstation Install/Update=
Note: The steps between updating or installing a CMS workstation are the same. Once you have verified that you meet the above prerequisites, follow the instructions below to Install/Update your workstation.

To begin double click the CMS installer, then follow the screenshots shown below.

[[image:Workstation1.png]]

[[image:Workstation2.png]]

===Workstation Install Option===

[[image:Workstation3.png]]

'''NOTE: There is no need to fill in the customer number and release code. Those are only needed for server installs.'''

[[image:Workstation4.png]]

[[image:Workstation5.png]]

[[image:Workstation6.png]]

[[image:Workstation7.png]]

[[image:Workstation8.png]]

[[image:Workstation9.png]]
 

After following these instructions you should now be able to sign into CMS.

=Troubleshooting=
If you receive an error installing or you are unable to browse to the shared drive when asked for the path to CMS.exe, there is a good chance that the installer is not able to reach the mapped drive, even if it appears you mapped it correctly. To resolve this you'll need to add a registry setting as described here:

1. Click Start, type regedit in the Start Search box, and then press ENTER.
2. Locate and then right-click the following registry subkey: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System
3. Point to New, and then click DWORD Value.
4. Type EnableLinkedConnections, and then press ENTER.
5. Right-click EnableLinkedConnections, and then click Modify.
6. In the Value data box, type 1, and then click OK.
7. Exit Registry Editor, and then restart the computer.

Barcode Scanners

2021-02-17T20:16:14Z

Russ horton: /* USB HID POS */

==Overview of scanning methods==

There are two primary modes of communication for a scanner to communicate: serial (USB) or keystrokes. If the scanner is configured/connected as a serial scanner, it transmits all of the scanned data to the software and lets the software determine what to do with the data. If the scanner is operating in a keyboard emulation (aka keyboard-wedge), the software is out of the loop for any interpretation of the scan and just processes the keystrokes as if you had typed them in.

Keyboard emulation is great in a lot of ways because there are no drivers for Windows or settings for the software. Very little to go wrong. Its strength is also its weakness though. While operating in keyboard mode, the software does not know when you are scanning and thus cannot do anything to help. This is the reason we've elected to use scanners in the serial mode for CMS's POS module and also the shipping manifest. With serial scans CMS can know when you are scanning and can do more for you.

The benefits of operating in serial mode currently include:

You can scan a barcode from anywhere on the Item screen. Say, for example, your cursor is in the qty or price field. CMS will recognize your scan as an 'Add new item' operation and will add the item you've scanned. (In keyboard mode you would have to make sure your cursor is always in the Product field, again, the same as if you were typing it in.)

Other such "smart" solutions are available to us in the shipping manifest as CMS can add a package when you scan, regardless of where you are on the manifest screen. It can also automatically bring in the weight from the scale as part of the scan. In keyboard wedge mode, you would have to be sure your cursor was in the Add A Single Package field.

With the way the serial-mode scans work in POS now, you merely scan the barcode and the cursor jumps to the qty field with a qty of 1. From there you can change the qty if it is other than 1 or, if 1 is correct, you can just move on to scanning the next product and not have to press Enter or click + to be ready for the next item. In other words, you can just scan products with no keyboard interaction unless the qty > 1. We saw this as a very efficient means of scanning while not making the qty field required since most items will be qty = 1.

If you prefer, you can reprogram the scanner to use keyboard emulation instead. As stated above though, it comes at the cost of operator having to make sure they are in the Product field when scanning. In the hectic POS/Retail environment, we did not think this was acceptable. Much the same holds true for shipping stations and the use of serial scanners there.

==Scanners==
As described above, scanners can work in a serial mode (serial emulation for USB) or keyboard emulation. Most any scanner can be programmed to work with either method. Changing between them is typically just a matter of scanning barcodes in the scanner's manual to program the options you want to use. Some scanners, however, will require specific cables for different communication types and, to facilitate these, most scanners' cables can be replaced.

Not sure what mode your scanner is in? Open Notepad and scan any barcode (coke can, candy bar, tracking number, etc.) and if the text shows up in Notepad, the scanner is in keyboard emulation mode. If you see nothing, chances are it is in serial emulation mode.

Presently CMS will work with serial scanners (again this includes USB scanners operating in serial emulation mode) in the following places:

*POS Module (all CMS versions)
*Manifest (all CMS versions)
*Products (CMS Ten+)
*Stock Manager (CMS Ten+)

===USB HID POS===
Support for this mode of scanning was added in CMS TEN and should be your first choice where possible. It is also the only mode supported in Windows 10 currently. Despite the name, scanners running in the HID POS mode are not limited to use in point of sale (POS.) They can be used wherever CMS supports scanner input. HID POS scanners are faster to setup and use with no driver software to install. They are about as close as you'll get to plug and play.

Not all scanners support this mode but many of the popular ones do and should only require a single programming code scan to put your scanner in this mode. Look for USB HID or HID POS in your scanners programming guide if you're using an unsupported scanner otherwise contact NewHaven Software for a programming instruction sheet for one of our supported scanners.

==='''SUPPORTED SCANNER MODELS:'''===
'''[[WINDOWS 10 USERS]]''' - Honeywell has been unable to get USB Serial Emulation to work on Win10. If you expect to need a barcode scanner on a Win10 machine, please choose a scanner model that supports USB HID POS mode (below):

**Honeywell 1300G (replaced the 3800G) - ''Supports only USB HID POS''
**Honeywell (Metrologic) Fusion MS3780 - ''Supports both USB serial and USB HID POS''
**Honeywell (HandHeld) 3800G - ''Supports both USB serial and USB HID POS'' (this model has been replaced by the 1300g above)
**Honeywell Voyager MS9520 (no trigger) - ''Supports only USB serial''
**Honeywell (Metrologic) Voyager MS9540 (has trigger) - Works only with the MX009 USB cable only and then only known to work with USB Serial, not USB HID POS)

'''SCANNERS THAT SHOULD ALSO WORK BUT HAVE NOT BEEN TESTED:'''
*'''CMS TEN''' added support for USB HID POS interface which works in lieu of USB serial emulation. Not all scanners support USB HID POS but, for those that do, its configuration should be easier and you may have more scanner models to choose from. The following '''Honeywell''' models support USB HID POS and should work with CMS (with no programming other than putting the scanner into HID POS mode), but these models have not been specifically tested by NewHaven Software:
**MS5145 Eclipse
**MS9590 VoyagerGS
**MS9591 VoyagerGS HD
**MS9521 VoyagerHD
**MS9524 VoyagerPDF
**MS9540 VoyagerCG
**MS9541 VoyagerHD
**MS9544 VoyagerPDF
**MS9535 VoyagerBT
**MS1633 FocusBT
**MS1690 Focus
**MS1691 FocusHD
**MS9590i VoyagerGS
**MS1890 Focus
**MS7120 Orbit
**MS7180 OrbitCG
**MS3580 QuantumT
While these scanners do have to be programmed to work in the USB HID POS mode (aka USB HID serial mode, '''not''' USB HID SurePOS or USB HID keyboard) there should be no driver installation necessary as there is with USB serial emulation. You'll just need to find the proper bar code to scan in the scanner's programming guide for USB HID. You can purchase a scanner and ship it to us if you'd like us to add it to our supported scanner list. We can then provide documentation on proper setup and help with troubleshooting any future issues.

===Serial Scanner Programming===

While NewHaven Software offers support and programming instructions for a select number of scanner models (available from [http://updates.newhavensoftware.com/ Support Downloads]), chances are most any scanner can be programmed to work with CMS. If you'd like NewHaven Software to certify your preferred scanner model, just have one shipped to us. In return we will provide step by step setup instructions and ongoing support for your use of that scanner model. If we get it to work, we keep the unit for future testing and support. If we cannot get it to work, we'll ship it back. Contact your account rep or technical support for more details.

If instead, you'd like to take a crack at it on your own, here are the elements we look for when programming a scanner:

#Get the manual - If you don't have it handy, download a copy from the manufacture's website. Most are available in a .pdf format.
#Get the Windows driver - Here again, download from the manufacture's website if you do not have a driver disk or know the location of the driver file
#Reset Product Defaults - scan the code that resets the scanner back to factory defaults
#USB Com Port Emulation - If the scanner is connected by USB (recommended), scan the code to enable USB Com Port Emulation. When programming a scanner to operate in serial mode, Windows will immediately recognize it, assign a COM port, and prompt you to install new hardware. Be prepared for this and have the driver handy, ideally in a sub-directory of NewHaven Software on the network for easy access to all workstations (each workstation using a serial scanner will need its own driver). Drivers for supported scanners are included on CMS CD's that we ship and are available on request along with the scanner's PDF manuals used for programming the scanners.
#Add a Carriage Return (CR) suffix - scan the code in the programming guide that appends a carriage return after every scan
#Remove the Line Feed (LF) suffix - Not all scanners default to include this but if yours does, you'll want to disable it
#Configure CMS to work with your scanner - In CMS the setup for serial scanners is in Workstation Specific under the Serial Dev tab. There you can click test to confirm it is working properly (you will see the contents of your scan in the box next to Test.) Refer to Device Manager in Windows if you are unsure of the com port assigned to the scanner. Default baud is typically 9600.

==Where scanners are used==
There are several places in CMS where scanning barcodes is supported and even encouraged. If you consider barcodes in keyboard emulation mode though, your imagination is your limit on what could be done to help automate anything you might do repeatedly in CMS that can be keyboard navigated.

*Order Entry/POS - In CMS's optional POS module we support serial/usb scans. In other words, CMS knows that a scan in Order Entry translates to the following steps
#Add new product
#product code added
#Advance cursor to the Qty field (defaults to 1)
There the operator can enter a quantity (if other than 1) or just scan the next item. Note that with the POS module, CMS will recognize either product codes or UPC codes. UPC codes can even be typed in. UPC codes for products can be entered in the Products section.

*Shipping - UPS Worldship and FedEx Ship Manager will work only with keyboard emulation and this works nicely with the barcoded package number CMS can print on your fulfillment forms. This also works well in CMS's Manifest screen for use with Endicia or general USPS manifesting. As of version 5.2 CMS can also support serial scanners in the manifest. Here again this means you do not have to be in the 'add new package' field and the weight can automatically be brought in from a connected scale.

*Products (v10) - Scan a product or UPC barcode while the Products window is open and CMS will jump to that product in the list.

*Stock Manager (v10) - Scan a product or UPC barcode in Stock Manager and CMS will jump to that product in the list.

==Printing Barcodes==
CMS can print barcoded package numbers on CMS forms and can also be done with Crystal as described in our [https://updates.newhavensoftware.com/v5release_notes.htm#crystalinv|5.0 Release Notes]

CMS does not yet print product barcodes. In the mean time, if you'd like to print barcodes we're recommending [http://www.seagullscientific.com/aspx/btw_table_of_contents.aspx Bartender]. The Professional version allows you to connect to CMS via ODBC and can print anything from our database. You may opt for Basic at the sacrifice of ODBC connectivity. Either way, this is great software that lets you design your own label formats and contents.

Product Costs

2021-01-20T15:53:53Z

Russ horton: /* PO Receiving */

"Costs" are discussed typically in three contexts:
*Cost of goods sold
*Value of inventory on hand
*Cost to be used when ordering from your vendor or receiving stock

This article will expand on each of these.

=Costs for Purchasing and Receiving=
==Purchasing==
When adding an item to a PO, CMS will use costs in the following order based on the presence of data:

#Vendor SKU Cost
#Expected Cost
#Last Lot Cost

Vendor Cost: This is the Cost field found in the Vendor SKU record (click + button from the Inventory sub-tab under Price/Inventory.

Expected Cost: CMS will use this field when no Vendor SKU is associated with a product. Its primary purpose is for Drop ship and non-inventory items that would never have lots. This is field is updated by the closing of received PO's but is otherwise set and maintained manually.

Last Lot Cost: This cost is associated with the cost of the last lot received. If no Vendor or Expected cost is found, CMS will use the cost from the last lot found when adding the item to a PO. This field is updated and created when a lot is received its value is set by either the expected cost (if no vendor cost exists), by Vendor Cost, or hand entered when the lot is created.

===PO Receiving===
The receiving of a PO will create a lot for each item received and CMS will set the unit cost in the lot equal to the cost the PO was received at (which may differ from the cost ordered at and can include "landing fees" like shipping and tax.) The costs for all associated lots will be updated as it is common for actual costs to be set some time after the PO was received (e.g. invoice for the order arrives by mail to your accounting office days after the shipment was received.) Also worth noting is that in the PO the item cost can be padded with landing fees so the lot unit cost includes associated shipping or other charges. NOTE: As of 9.0.5, if you edit a closed PO, that cost will now update its corresponding lots and itemsord records (this only used to happen at the time you closed.)

==Receiving (manually)==
Using Stock Manager to receive stock, including increasing stock with 'Adjust All Inventory', CMS will set the unit cost based on the most recently received lot. This is our most recent and best known landed cost.

It will not consider Vendor or Expected cost as those two are designed to be used in conjunction with Purchasing and they do not include the landed/padded costs as Lot costs do (see paragraph above.)

==Return Lots==
Return lots are those lots created when stock is received via a merchandise return (a return against an order where the checkbox for "Restock' was checked.) If the lot that this item was originally pulled from is still active (meaning is has some quantity available) the return will simply restock that lot. If the lot is now inactive though (no quantity available) a return lot will be created using the same criteria as the old lot (cost, vendor, etc.)

In the case where you are cancelling an unshipped order, stock will always be returned to the original lot even if inactive. A return lot would never be created in this scenario.

=Value of Inventory on Hand=
This is figure is useful at the end of year or accounting period where you would need to tell your accountant the value of all of the inventory you have on hand. This value is shown in the Lot Summary and Order Processing Summary reports and is calculated but looking at the available quantity in each lot and multiplying that by the unit cost for that lot. (each lot may have a different cost). CMS does not use average costs as some other systems do and thus is a strength of CMS.

=Cost of Goods Sold (COGS) in the database=
These are set in the Itemsord record at the time the item was sold. The field is t_cost which represents the total cost for the line item (qty ordered x unit cost).

==Stocked==
The t_cost is equal to the sum of the lot_item records which detail what stock was pulled from which lots and at what cost.

==Non-inv==
If this item was non_inventory, CMS will instead set the itemsord.t_cost using the Expected Cost field from the Product setup.

==Dropship==
For dropships CMS will initially set the itemsord.t_cost to the Expected Cost value. If a dropship PO is created, that PO will use the cost as described in the section below. When the dropship PO is confirmed (received) it will update the itemord.t_cost to whatever cost was entered during confirming/receiving. This last step is provided to allow for a true cost to be set based on what invoice/confirmation you receive from the drop shipper, should it differ from the cost you ordered at.

Note: if the items is both stocked AND dropshipped, something CMS allows but we do not support, the t_cost will = SUM(lot + expected cost). This is true both before and after the po confirm.

Product Costs

2021-01-20T15:51:50Z

Russ horton: /* PO Receiving */

"Costs" are discussed typically in three contexts:
*Cost of goods sold
*Value of inventory on hand
*Cost to be used when ordering from your vendor or receiving stock

This article will expand on each of these.

=Costs for Purchasing and Receiving=
==Purchasing==
When adding an item to a PO, CMS will use costs in the following order based on the presence of data:

#Vendor SKU Cost
#Expected Cost
#Last Lot Cost

Vendor Cost: This is the Cost field found in the Vendor SKU record (click + button from the Inventory sub-tab under Price/Inventory.

Expected Cost: CMS will use this field when no Vendor SKU is associated with a product. Its primary purpose is for Drop ship and non-inventory items that would never have lots. This is field is updated by the closing of received PO's but is otherwise set and maintained manually.

Last Lot Cost: This cost is associated with the cost of the last lot received. If no Vendor or Expected cost is found, CMS will use the cost from the last lot found when adding the item to a PO. This field is updated and created when a lot is received its value is set by either the expected cost (if no vendor cost exists), by Vendor Cost, or hand entered when the lot is created.

===PO Receiving===
The receiving of a PO will create a lot for each item received and CMS will set the unit cost in the lot equal to the cost the PO was received at (which may differ from the cost ordered at and can include "landing fees" like shipping and tax.) When the PO is closed, the costs for all associated lots will be updated as it is common for actual costs to be set some time after the PO was received (e.g. invoice for the order arrives by mail to your accounting office some time after the shipment was received.) Also worth noting is that in the PO the item cost can be padded with landing fees so the lot unit cost includes associated shipping or other charges. NOTE: As of 9.0.5, if you edit a closed PO, that cost will now update its corresponding lots and itemsord records (this only used to happen at the time you closed.)

==Receiving (manually)==
Using Stock Manager to receive stock, including increasing stock with 'Adjust All Inventory', CMS will set the unit cost based on the most recently received lot. This is our most recent and best known landed cost.

It will not consider Vendor or Expected cost as those two are designed to be used in conjunction with Purchasing and they do not include the landed/padded costs as Lot costs do (see paragraph above.)

==Return Lots==
Return lots are those lots created when stock is received via a merchandise return (a return against an order where the checkbox for "Restock' was checked.) If the lot that this item was originally pulled from is still active (meaning is has some quantity available) the return will simply restock that lot. If the lot is now inactive though (no quantity available) a return lot will be created using the same criteria as the old lot (cost, vendor, etc.)

In the case where you are cancelling an unshipped order, stock will always be returned to the original lot even if inactive. A return lot would never be created in this scenario.

=Value of Inventory on Hand=
This is figure is useful at the end of year or accounting period where you would need to tell your accountant the value of all of the inventory you have on hand. This value is shown in the Lot Summary and Order Processing Summary reports and is calculated but looking at the available quantity in each lot and multiplying that by the unit cost for that lot. (each lot may have a different cost). CMS does not use average costs as some other systems do and thus is a strength of CMS.

=Cost of Goods Sold (COGS) in the database=
These are set in the Itemsord record at the time the item was sold. The field is t_cost which represents the total cost for the line item (qty ordered x unit cost).

==Stocked==
The t_cost is equal to the sum of the lot_item records which detail what stock was pulled from which lots and at what cost.

==Non-inv==
If this item was non_inventory, CMS will instead set the itemsord.t_cost using the Expected Cost field from the Product setup.

==Dropship==
For dropships CMS will initially set the itemsord.t_cost to the Expected Cost value. If a dropship PO is created, that PO will use the cost as described in the section below. When the dropship PO is confirmed (received) it will update the itemord.t_cost to whatever cost was entered during confirming/receiving. This last step is provided to allow for a true cost to be set based on what invoice/confirmation you receive from the drop shipper, should it differ from the cost you ordered at.

Note: if the items is both stocked AND dropshipped, something CMS allows but we do not support, the t_cost will = SUM(lot + expected cost). This is true both before and after the po confirm.

ECommerce Integrations

2021-01-07T16:29:16Z

Russ horton: /* Integration with your Website - eCMS Module (Best) */

=Overview=
Users of CMS most always have an eCommerce site for order taking and may in fact have multiple stores or channels. This article discusses the various options available to you in progressing levels of sophistication and efficiency gains. Here we have listed several options available to improve the efficiency of managing your orders and related data with your site(s).

==Manual - For Starters (Good)==
For companies with low daily volumes of web orders, you may choose to just hand enter those orders into CMS. Chances are, however, that you have enough orders coming in via your website(s) to warrant some form of automation...

==File Importing (Better)==
Usually, the first step for a smaller business wanting to get away from hand-entering orders is to import orders into CMS. CMS has options available for:

*importing orders and catalog requests in an [http://wiki.newhavensoftware.com/index.php/CMS_XML_specification XML format] (included with CMS)
*order files from Amazon (optional beta module)

In these cases, the process is simply to download a file of your orders from your site and point CMS to that file to import those orders. Contact us for additional information on our XML specification.

==Integration with your Website - [http://wiki.newhavensoftware.com/index.php/ECMS_Module eCMS Module] (Best)==
Most of our clients using CMS have a significant volume of orders coming from their websites and will benefit from further automation and integration. With such integrations you'll bypass the file import method and can have CMS communicate directly with your site. These communications can include order and catalog request downloads, posting updated product information including pricing and stock availability, and uploading order status updates. We have developed a module for CMS called [http://wiki.newhavensoftware.com/index.php/ECMS_Module eCMS] to address the requirements of these more robust eCommerce integrations. No files to download or sites to log into, just click of a button or configure CMS to run these automatically on a schedule.

You can purchase our [http://wiki.newhavensoftware.com/index.php/ECMS_Module eCMS Module] and use one of our stock Plug-ins to connect to either [http://www.commercev3.com/ CommerceV3], [http://www.magentocommerce.com/ Magento], [https://www.volusion.com/ Volusion], or Amazon (beta).

==Order Importing with CMS==
Orders imported into CMS, from any source (eCMS or a file), flow into the Verify Orders section of CMS. This temporary holding section for imports is used to allow an operator to review the order for completeness and accuracy before committing stock, issue drop-ship purchase orders, and/or processing payment. For most orders this is a matter of just two clicks and thus can be very efficient (unless modifications to the order are needed.)

The Verify Imports section is multi-user so if you have a large volume of orders you can have any number of operators verifying them simultaneously. CMS will maintain locks on orders that are currently being reviewed to prevent the same order from being opened by more than one operator. Also see the Automated Imports Module below for additional information on how to streamline high volumes of order imports.

Orders can remain in the Verify Imports section until any problem is resolved. Alternately, the order may be saved as a proforma (quote) or placed on Hold using any one or more of predefined and user-defined hold reasons.

CMS employs [[http://wiki.newhavensoftware.com/index.php/Address_Matching_in_CMS sophisticated logic]] to both determine if the imported order is for a customer already in your list and if the recipient is the purchaser. This helps CMS match orders to existing customers when it should and know when the order should be processed as a gift order.

==Options for Further Efficiency Gains==
CMS also offers two additional modules to improve the efficiency of your import order processing:

*[[http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module]] - Setup validation checks to determine which orders should receive manual review. Those passing your checks are allowed to automatically convert to real orders and will enter your fulfillment processing.

*[[http://wiki.newhavensoftware.com/index.php/Address_Validation_Module Address Validation Module]] - This module is used to validate the deliverability of the addresses on your orders. This is done by CMS communicating with Endicia’s web service of all USPS addresses in the United States. You can validate either manually as you enter or review orders or this can also be automated for orders as they are imported.

Magento Integration

2021-01-05T17:35:32Z

Russ horton: /* Magento 2.x (Work in Progress) */

NewHaven Software has created an optional Magento Extension to expand the core capabilities of the Magento API and improve integration with CMS. For basic Magento deployments this extension is optional but it is required for products configured to use attributes (e.g. size and color) and Magento custom fields for data like ad code.

=Magento version requirements=
==Minimum==
*Enterprise 1.12.0.x
*Community 1.7.0.x
*Go 1.1.2.x (limited support)

==Maximum==
Latest tested version is 1.9.3.6

==Magento 2.x (unlikely to be supported in CMS)==
Magento 2.x is a significant departure for 1.x both for your site and the API that CMS communicates with. There is not a good transition path to get to 1.x to 2.x for either your site or our integration so research and plan accordingly before deciding to jump to 2.x. Be sure to find out what is involved to get your new site created and coordinate with us on our timeline for support for 2.x.

Magento 1.x is end of life (EoL) as of June 2020.

We are evaluating our integration options for 2.x but at this moment do not have a scheduled release date. Be advised, due to the complexity of the integration and how much has to be done from scratch, it is possible that 2.x support may not come.

In the meantime, we have explored alternatives for CMS users moving to Magento 2.x in advance of our support for it. There is a company called [https://www.xtento.com/magento-2-extensions.html Xtento] that produces inexpensive Magento extensions (for both 1.x and 2.x, Community and Enterprise) that looks promising. We've reviewed our XML requirements with them and they seem quite capable of delivering.

Perhaps most interesting about Xtento's suite of extensions is that they allow CMS to work with Magento in a non-synchronizing mode, for better or worse. In other words, instead of synchronizing invoices and packages with Magento which allows Magento to process the payments, it instead operates more like a standard integration where the order downloads into CMS '''with the credit card info''' so that CMS can handle payment processing. This is particularly beneficial for backorder and future ship (split order) processing and simplifying the integration. To accomplish this you'd need to use three of Xtento's extensions:

*[https://www.xtento.com/magento-extensions/magento-order-export-module.html Magento Order Export Module] - Allowing orders to be imported (not downloaded) - Downloads and imports can be done manually or in conjunction with our [http://wiki.newhavensoftware.com/index.php/ECMS_Module#Generic_File_Based File Based eCMS plug-in] (sold separately). To be clear, this extension pulls new Magento orders and posts a file to an FTP site in an XML format which they can modify to meet our spec (fees from Xtento apply for this translation.)
*[https://www.xtento.com/magento-extensions/saved-credit-cards-ccsave-for-magento2.html Magento Saved Credit Cards Module] - Enabling Magento to pass credit card data to CMS for processing
*[https://www.xtento.com/magento-extensions/magento-tracking-number-import-module.html Magento Tracking Number Import Module] - Import shipped item data with tracking numbers to update status in Magento - - CMS is not currently producing output suitable for use with this module but could be done outside of CMS (by you or us.)
*[https://www.xtento.com/magento-extensions/magento-stock-inventory-import-module.html Magento Stock Import Module] (optional) - For uploading updated stock levels - CMS is not currently producing output suitable for use with this module but could be done outside of CMS (by you or us.)

It is worth noting:

*Multiships - Magento does not support single orders with multiple recipients. This is a strength of CMS and common for B2C companies shipping gift orders. Magento instead treats each recipient as a separate order (meaning the buyer gets charged separately for each order instead of one payment for all orders.) In Magento 1.x our Magento extension stitches these separate orders together so this is another important difference to be aware of between 1.x and 2.x at the moment.
*Product Data Uploads - With their extension only supports inventory level uploads, not any other product data.
*CMS would not be communicating with a web service. These are all file-based operations so would involve either manual import/exporting of files or using our eCMS module to read/write files to an FTP site. This will require some level of file management for someone to archive processed files periodically (CMS will ignore duplicate files so file archiving doesn't have to be done multiple times a day, for example.)

=Current capabilities of the base Magento Plug-in=
==Order Downloads==
*Credit card payments are processed in Magento via Authorize.net CIM. CMS will provide Magento with shipped item data to facilitate related captures, include split and delayed shipments (back order or future ship.) These updates take place as part of the invoice creation process which takes place during order status updates.
**Credit card data is not available from Magento hosted solutions (Go and Enterprise) due to PCI concerns on their side. In a future version of CMS we will add support for downloading credit card data from their user-hosted solutions (Community and Professional.) This is currently scheduled to be included with our next submission of CMS for PA-DSS validation Q4 2013.
*Shipcode mapping from Magento codes to CMS codes
*Order level gift messages
*Supports Magento’s coupon codes (imported as ad code)
*Magento order-level custom field support (requires the NHS Extension, see the [https://docs.google.com/document/d/1shdEoLAXp8VlD75_HWhT-70lN4mQcFQOOp_ONTrr5vc/pub NHS Magento Setup Guide] for more info)

==Order Status Updates==
*Invoice creation (facilitates Magento’s payment processing)
*Support for back order invoicing
*Global support for billing delayed items now
*Status updates
*Shipment updates with tracking numbers

==Product Data Uploads==
*Support for Simple and Configurable products
*Creation of new products and updates to existing
**Product code/sku
**Descriptions
**Pricing
**Inventory
**Weight
**Status (enabled/disabled)
**Attributes (requires the NHS Extension)

CMS System Requirements

2020-12-04T18:06:08Z

Russ horton: /* Servers */

CMS system requirements are fairly meager considering the capabilities of today's machines. As such, most anything you buy or already own may be more than adequate. You do, however, want to make sure you're meeting the following system requirements.

=64-bit vs 32-bit=
This option affects both your hardware and software. Some Windows operating systems are available in either a 32-bit or 64-bit version. Either will work both with CMS and CMS's database server software - Sybase SQL Anywhere. The 64-bit version does not offer any benefits to CMS over its 32-bit counterpart for the workstations. Sybase, on the other hand, would stand to benefit from a 64-bit OS on the server, not the least of which is its support of additional RAM. If you're looking at running Windows Vista we'd recommend sticking with the 32-bit editions. If you're considering Windows 7, 8.1, or 2008 Server you may opt for either the 32 or 64-bit editions. Note that Windows Server 2008 R2 and Server 2012 are only available in 64-bit.

=Hardware=
==Servers==
This section applies to machines that are operating as pure servers or for stand-alone installations which are acting as both a server and workstation.

'''Minimum Requirements'''
For small volume companies with one or few workstations
* Pentium 4 - 1.8 GHz or faster CPU
* 8 Gigabyte RAM
* 500 GB Hard Drive with '''at least''' 2x your CMS database size always available in disk space

'''Database Server - Additional Recommendations'''
Server enhancements to consider as your server demands increase (higher volume, more workstation connections, larger/multiple databases)
#The best things you can do to improve the performance and capability of your CMS server is to maximize your RAM, purchase fast hard drives, and ensure adequate available disk space. The speed and number of processors/cores have less to do with CMS performance than does I/O (disk read/write speed) and being able to cache some or all of the database into RAM. This should be your first goal when purchasing a new server or optimizing an existing server.
#Solid State Drives (SSD) can be an attractive option/addition to your server. They are essentially RAM and are extremely fast.
#Isolate your CMS database onto its own drive so it is not sharing a drive with your operating system or other server files.
#Isolate CMS onto its own server so is not also being used for Exchange, file shares, etc. to achieve optimal performance (also recommended for PCI compliance)
#Disable Windows Themes (typically is disabled or not installed at all on server operating systems)
#Check your Power Options (Control Panel>Hardware>Power Options) and select High Performance (not necessary to do this and running in Balanced mode may be fine but consider this if experiencing performance issues)
#Fast network cards - Especially useful if you run a lot of reports from your workstations. In conjunction, evaluate the speed and age of switches (replace hubs) and network cabling.
#[http://en.wikipedia.org/wiki/RAID RAID] 6 or other drive arrays. Prioritize redundancy over striping if going with a different RAID configuration. Your server is at the heart of your company's operation and you need to make sure you can keep it going. Redundancy will help you sleep at night.
#Backups - While not a performance issue, this is an important consideration for a new server. You'll want to have an automated system in place to move the nightly CMS backup (must be turned on and configured in CMS) to other storage locations. Ideally, you'd have a rolling backup routine that allows you to store backups for each night without overwriting the previous backups and then move the last backup of the week off-site (DVD, tape, or online backup location). This way even if your place of business was in a natural disaster or your server was stolen, you would reasonably be able to recover. We had, unfortunately, a customer of ours go out of business because they were unable to recover when their server was lost in a fire. Please protect yourself from the same fate.

'''Configuration'''

When running directly on a Windows server (2003 and up), CMS will not be able to make web service calls until the following configuration change is made. This can impact some CMS integrations so the following setting should be made on your server. Go into Control Panel->System & Security->System->advanced System Settings->Performance->Settings and choose the Data Execution Prevention tab.

The default setting is Turn on DEP for all programs and services except those I select, and there is no reason to change it for CMS. However, you need to add CMS to the exception list, which will then allow CMS to communicate with web services.

*Themes - CMS 8.0 and later requires Windows Themes be enabled if you are running CMS on your server (including Terminal Services).

==CMS workstations==
Workstations are those machines that are running CMS from a server on your network. If you are running CMS on only one machine or that machine is your server, please see the Server requirements above.

'''Minimum Requirements'''
* Pentium III 500 MHz or faster
* 2 GB RAM
* 20GB Hard Drive with 2GB available
* 10Mbps Network Card(s) or faster

'''CMS Workstation Recommendations'''

Very little processing, disk space, or hardware is required to run CMS on a workstation. Most everything takes place on the server or in memory so your workstation requirements are reasonably small. Our only recommendation, beyond the above minimums, is to upgrade your RAM to 8+ Gig to support operations on large sets of data (e.g. mail list filtering, reporting, exporting).

==[http://en.wikipedia.org/wiki/Peripheral Peripherals]==
CMS will work with most any peripheral (e.g. printers) as long as the manufacture still supports it and offers drivers for your operating system. If the manufacture does not support your device and offer drivers for your operating system, NewHaven Software cannot assist you with it. It may work with CMS but, if not, you must upgrade your device to a currently supported model.

While this may seem like we're just washing our hands of supporting older hardware, there is really more to it. CMS, like most other Windows applications, relies on Windows to operate as an intermediary with its peripherals. CMS communicates to Windows and then Windows handles the communication with the peripheral. If Windows does not have a current driver, that communication may fail or operate in unexpected ways. In other words, any problems with the peripheral are outside of our software and control.

===[[POS Module]]===
The only place where CMS has more specific hardware requirements are the peripherals used with its POS Module. The Point of Sale Module only supports specific models of printers, cash drawers, credit card swipes and UPC bar code scanners.

*'''Printers''' - Most any Windows compatible printer should work but the following are the 80 column thermal printers we have tested and can support:
**Star TSP143II
**Samsung SRP-350

*'''[[Barcode Scanners]]''' - CMS requires either USB serial emulation mode or USB HID POS. Contact Support for a programming guide suitable for your model of scanner. If you are not purchasing these models through NewHaven Software, '''be sure that you are supplied with a proper cable to allow USB serial emulation if USB HID POS is not supported'''.

*'''Cash Drawer'''
**APG 320 MultiPro
**MMC 225151644204

*'''Credit card swipe/reader''' - Magtek model 21040102 (many look the same but are not, it must be this model)

*'''Pole Display''' - Logic Controls PD-3000 series

Other hardware may work with CMS but these are the only models we have tested and can support or offer configuration instructions for. The credit card reader, however, is unlikely to work unless you have the specific model we have recommended.

===Shipping Station===

===='''Barcode scanners'''====
CMS supports the USB HID POS, USB/serial, and keyboard wedge style scanner (albeit with reduced capability, not recommended). Read this article on [[Barcode Scanners]] for more information and a list of supported models.

We also provide a [http://updates.newhavensoftware.com/Manifest_Function_Key_Bar_Codes.pdf sheet of barcodes] suitable for use at the shipping station. Print this and tape it to your monitor for fast and easy hands-free shipping.

===='''Scales'''====
*CMS version 7 or earlier - CMS will work with most any scale that connects via a serial connection and can emulate a Mettler Toledo (models 8213 or PS60) or the UPS Fairbanks scale.
*CMS 8.0 or later - USB connections are supported for the Toledo models PS60 and PS90 (in addition to supporting serial connections for the scale models mentioned above.)
*[http://updates.newhavensoftware.com/v9release_notes.htm#link-1-9 CMS 9.0.5] or later - Any of the above plus the Adam brand scale - CPWplus models (e.g. CPWplus 35). These scales require a serial connection with '''null modem cable''' which is not included or can be used in conjunction with a USB-serial converter if your computer has no serial port (although a $15 serial card is cheaper and better.)
*CMS 10.0.14.270 adds support for the Mettler Toledo BC-30 and BC-60 models which replace the model PS60 in Mettler Toledo's lineup (both are available in CMS.)

If you are using a scale provided by UPS or FedEx, you may need to change a setting in the scale's menu to restore it to default settings (so it is no longer using a proprietary communication protocol).

Other scanners or scales may work with CMS but these are the ones we support and can assist you with configuration. Please contact us if you'd like us to evaluate other hardware (typically requires shipping a unit to us for testing.)

See our article on [[Shipping_Station_-_Best_Practices]] for more tips!

=Operating Systems=
The following are operating systems currently supported by Microsoft and NewHaven Software for use with CMS. NewHaven Software will only support use of CMS on operating systems currently supported by Microsoft. Noting also the PCI Compliance requires that your payment application (CMS) be used on an operating system that has current security updates.
==Servers==
*Windows Server 2008 - (Note: TLS 1.2 must be enabled, it is not by default. See https://technet.microsoft.com/en-us/library/dn786418.aspx#BKMK_SchannelTR_TLS12)
**Server 2008 R2 Editions supported - Standard, Small Business Server, Enterprise
Server 2008 is end of life January 2020
*Windows Server 2012 (CMS v9.0.9 or later)
**Server 2012 R2 Editions supported - Essentials, Standard
NOTE: Our experience has been that the server OS has never presented an issue for CMS or Sybase (our database server software.) Newer versions of Windows Server would be expected to work equally as well for editions corresponding to those listed above.

==Workstations or CMS Solo (i.e. single-user)==
*Windows 8.1 Pro (only) - Supported only in CMS 9.0.9 or later. An updated Sybase database driver is required to support Win 8.1 and workstation updates will be required.
*Windows 10 - CMS 10.0.5 or later (noting that some barcode scanners do not work with Windows 10 due to a manufacture's driver issue. Please see the above section on scanners for more information.

NOTE: Microsoft ended support for Windows XP Professional on April 8, 2014 and Vista on April 11, 2017, and Windows 7 on January 14th 2020.

=Remote Connections=
There are many options available to you when wanting to run CMS remotely. The core issue that must be observed is that CMS must be running on a machine that is connected locally to its database server. As long as that is true, you'll have no troubles running CMS remotely. You cannot, however, have CMS running locally on your workstation and connect to a remote server. The following are some remote access solutions and tips.

==Remote Access Software==
Software like TeamViewer, LogMeIn, and GoToMyPC are inexpensive remote access tools that allow you to connect to your PC via their website, thus from any other PC. Performance is a little slower than other solutions but is low cost, flexible and easy to use.

==[http://en.wikipedia.org/wiki/Remote_Desktop_Services Remote Desktop and Terminal Server]==
*Our preferred method is to use Windows' built-in remote access options. Remote Desktop (RDP) allows you to connect to your work machine with CMS on it and control it remotely. To do this you must first establish a [https://en.wikipedia.org/wiki/Virtual_private_network virtual private network (VPN) connection].
*[http://www.emazzanti.net/the-12-advantages-of-terminal-services/ Terminal Services] or Remote Desktop Services (RDS) is also an option that will allow you to VPN into your server and create/run a remote session right on the server and without the need for a dedicated workstation. This is also a popular option but does require purchasing Windows client access licenses (CALs). Note: Running CMS 8.0 or later on terminal services will require that you enable Windows themes (usually off or not installed with Windows Server OS's). Also note that when running CMS in terminal services, all users share the same 'Workstation Specific' settings (In CMS see Setup>General>Workstation Specific to review these settings and assess if this trade-off is acceptable.)
*We've written a separate article on configuration recommendations for RDP - http://wiki.newhavensoftware.com/index.php/CMS_over_Microsoft_Remote_Desktop

Printing can present some challenges under Terminal Services, not to CMS but in general. Here is an excellent resource to help address them - http://wiki.newhavensoftware.com/index.php/CMS_over_Microsoft_Remote_Desktop#Printing

===Warning===
At this time Endicia's Dazzle software is not supported by Endicia for use on a Terminal Services server. Please take into account your use of peripherals and integrations to make sure they are supported and will work as expected under Terminal Services.

==Cloud Computing==
===Licensing===
Only one database server can be running concurrently. Connections to that database server must come from the same domain. As stated above, CMS must be run on network local to the database server (i.e. you can remote into a vm, machine, or terminal server hosting CMS). You cannot run CMS locally and connect to a remote server.

===Peripherals and Integrations===
While cloud deployment does not present any inherent challenges to CMS, there can be complications with getting a remote instance of CMS to properly interact with local hardware. While printers are commonly used and not typically a problem, communication with serial or USB devices (e.g. bar code scanners, scales, card swipes, pole displays) can be more challenging. Testing of existing/needed peripherals must be done before launching into production to ensure all users can continue to operate efficiently. We recommend you read our separate article on running CMS via RDP, including peripheral sharing, for some guidance that may be helpful - http://wiki.newhavensoftware.com/index.php/CMS_over_Microsoft_Remote_Desktop

If you are using any other integrations with CMS, specifically if they are not done with web services, you'll also want to test those to ensure expected operation is possible.

===PCI Compliance===
There are PCI implications when moving your CMS database (which stores credit card data) to the cloud. It will add risk and corresponding cost/effort to mitigate that risk in order to remain PCI compliant. Here is a document from the PCI Council for guidance - https://www.pcisecuritystandards.org/pdfs/PCI_DSS_v2_Cloud_Guidelines.pdf

From the security experts, Coalfire Systems who validated CMS for PA-DSS, comes this [https://www.coalfire.com/Resources/White-Papers/Cloud-Security-Intelligence-Report Cloud Deployment Intelligence report] which provided valuable insight to consider before launching in the cloud.

=Network Requirments=
During the Setup of CMS on your network, you need to also ensure that your network security software is set to allow the following through it:
*TCP/IP 2638
*HTTP 80
*HTTPS 443
*CMS.exe
=Virtual Machines=
NewHaven Software will support CMS running on a virtual machine as long as the operating system (OS) running in the virtual machine is also supported. However, if NHS is unable to reproduce an issue, the customer may be asked to reproduce the problem running natively on the supported OS, outside the virtual environment. NHS does not explicitly test or certify products running in a virtual environment.

In other words, NHS can support CMS running in virtual environments but not the environments themselves. We strongly recommend that if you decide to pursue running virtual machines that you have someone with related expertise to assist with the setup and administration of these, much the same as you would network administration.

==Recommendations==
CMS can run on a virtual machine/server as long as it is provided enough resources (e.g. disk space, memory, processor). We in fact run CMS here at NewHaven Software on a virtual server and have had great success with it. We have been using VMware ESXi v4.0 and have also had successful tests with Xen Server 5.6 Feature Pack 1 although have yet to run CMS in production on Xen Server. We do have several CMS clients running live on virtual servers presently as well.

As a rule, CMS and the database server will run with no particular technical issues although performance may not be as good as running on a dedicated non-virtual server. Reinforcing what has been said above, lots of RAM and fast drives (disk I/O) are the biggest factors that impact CMS performance. Our recommendations for running CMS on a virtual server is simply to ensure that sufficient resources are allocated.

If you think virtualization is in your future, please contact us for assistance in setting up a test environment. Before deploying into production we of course strongly recommend testing. You'll want to validate that performance is acceptable and that all connectivity, including from peripherals (if applicable), and all integrations are working and performing at acceptable levels.

=3rd Party Software=
Many 3rd party software solutions can be used in conjunction with CMS but it is important to note that we do not support these software solutions. Examples of 3rd party software include Crystal Software, Microsoft Access, Mapforce, etc. The NHS technical staff is not responsible for answering any questions about features/functionality or bugs within these software programs. Please view your Software License and Support Agreement for details.

We are, however, happy to provide assistance as a professional service. For more details, please contact your account manager.

=FAQ's=
==Can I use Windows 10?==
We support running CMS on Windows 10 workstations under CMS versions 10.0.5 and later.

NOTE: If you're using older peripherals (scales/printers) the manufacture may never release a Win10 compatible driver. Something to consider before replacing a machine or updating its operating system. Either research to make sure compatible drivers are available or be prepared to replace the peripherals with newer models that are compatible.

SCANNERS: We've learned that Honeywell is not yet able to get serial emulation working with the USB bar code scanners. If you are using a scanner on a machine you intend to upgrade to Win10 you will need to obtain a scanner that can work in USB HID POS mode. Read the [http://wiki.newhavensoftware.com/index.php/CMS_System_Requirements#POS_Module POS section of our System Requirements] page for more details.

==Do I need a new machine to run CMS?==
Probably not. The operating system is far more important than your hardware. If your operating system is no longer supported by Microsoft, you may be able to update it or reinstall a supported operating system on your current machine. Please consult Microsoft for their minimum requirements for the operating system your selecting. Generally if it meets Microsoft's requirements for their operating system, it will be good enough for CMS as well. From there, you need to decide if good enough is in fact really good enough and that will be clear in the performance of Windows, CMS or other applications. Often times poor performance is a factor of limited memory and, since memory is typically quite cheap, you should consider maximizing RAM before replacing a machine (and on any new machine).

==My operating system is currently supported, do I need a new machine?==
Hardware is rarely an issue with CMS and you could be running old machines and still experience reasonable performance. If you're satisfied with the speed of CMS, you're able to run a supported operating system without errors, and you have adequate disk space, you may choose to continue to run on your existing machine(s).

If you were to do only one thing, it should be to max the amount of RAM your machine will take. RAM is cheap, too cheap to not have plenty of it.

Secondarily, a CMS server needs a lot of disk space not just for its database but also requires additional free gigabytes of space for temp files that the database server creates and destroys through normal usage to optimize performance. You should never have less than 2x your database size in free drive space on your server (and this only considers CMS's needs, not Windows or other processes). Here too, drive space is too cheap for this to be a limiting factor.

There may be other compelling reasons to upgrade your machines, be it for speed, other applications or compatibility with other new technologies. New machines that are capable of running 64-bit operating systems, for example, are capable of handling more than 4 Gigabytes of RAM. While this would rarely be a CMS consideration for a workstation, if you have a database (.db file) that is larger than 2 Gig, you should seriously consider a server with more than 4G of RAM.

As a rule, the performance you need from CMS is merely a factor of hardware. As your company grows, CMS can scale perfectly well with you but may require improved hardware to keep up with the increased server load. Evaluating CPU/memory usage and free disk space during the heat of the day will give you an indication of how well your server is handling the load and if more resources are needed.

==Why can't I continue to use an older operating system?==
Even if has worked fine with CMS for years, if Microsoft no longer supports it, you really don't want to be using it. Once Microsoft stops offering security patches, as they have for Windows XP and 2003 Server, you become vulnerable to new threats (viruses, hacks, etc.) and you may find that new versions of CMS will no longer work. Such was the case with Windows 2000 as it did not contain the encryption components needed for newer versions of CMS to run properly and satisfy PCI requirements. [http://wiki.newhavensoftware.com/index.php/Windows_2000_and_CMS This link] provides more information on this subject.

PCI requirements also dictate that your systems must be kept up to date with current security patches. In other words, you cannot be PCI compliant while running CMS on machines with unsupported operating systems.

==Can I run CMS on my Mac?==

CMS does not run natively on a Mac but there are solutions for running Windows applications on a Mac.

*Microsoft’s free [http://www.techrepublic.com/article/pro-tip-remote-desktop-on-mac-what-you-need-to-know/ remote desktop solution] can run on non-Intel Macs running OS 10.5.8 or later. This is desktop sharing (connecting to a remote PC/server).

*[http://www.parallels.com/landingpage/pd/windows-on-mac/ Parallels] is one of several solutions worth exploring if you prefer not to remote into a Windows machine. They have a 14 day free trial.

In either case, there is no USB/HID support, meaning printers are the only supported peripherals (no scale, scanner, card reader, or pole display).

==What about my network?==
Our recommendations here are pretty generic. If you're still on the old 10mbps cards you should consider upgrading. 1Gbps is pretty standard these days. CMS doesn't need a lot of bandwidth but could benefit from 100mbps over 10mbps...depending on what other network traffic you might expect. If you have hubs or old switches, that would be a good place to look at upgrading.

==Will CMS work with wireless?==
Yes, although CMS must maintain a constant connection with its database and even momentary interruptions in that connection can be enough to cause errors. As such, we do not recommend running CMS over a wireless network connection. You can, however, use Remote Desktop via wireless to connect to a machine that is on your physical network and, in that scenario, you would not be subject to disconnect issues.

==Can I run CMS remotely?==
Yes, but it must be done using RDP (remote desktop), terminal services or remote access software like Logmein. CMS must be running on the same network/domain as its database server. You'll need to remote into Windows first and then run CMS from that machine. You cannot have CMS installed locally and connect to a remote network/server. See the section on [http://wiki.newhavensoftware.com/index.php/CMS_System_Requirements#Remote_Connections remote connections] above.

==Can NewHaven Software assist with purchasing or configuring my hardware/network?==
We can make recommendations, like we have in this article, but the actual purchase, configuration and maintenance of your hardware and network must be performed by someone at your location. This would either be done by someone on staff that is capable or a local contractor that can provide these services and expertise to you. We're happy to consult with your staff or contractors on any CMS related configurations.

Workstation Install

2020-11-24T20:11:16Z

Russ horton: /* Workstation Install/Update */

Workstation Install

2020-11-24T20:10:37Z

Russ horton: /* Workstation Install/Update */

=Overview=

This article details the instructions for installing or updating a CMS 8, 9, or TEN Workstation.

=Prerequisite=

Before you begin installing or updating your workstation please check that you meet the requirements for all the steps below.

==Step 1: Workstation System Requirements ==

To verify that your system meets CMS system requirements please review : http://wiki.newhavensoftware.com/index.php/CMS_System_Requirements#CMS_workstations

==Step 2: Setup a mapped drive to the CMS server==
Ensure that you have a drive mapped to the \NewHaven Software share on the server and that it is using the same drive letter as other workstations on the network. Workstations should be joined to the network domain.

For Information on how to set up a mapped drive please review the video : http://youtu.be/D1IBcjWCmPs

==Step 3: Obtain the CMS Installer==

*Locate the last CMS update used, typically found in the \Updates subdirectory of the \NewHaven Software share (where you should now have a drive mapped to)

or

*visit http://updates.newhavensoftware.com/
For information on using the update page and downloading the installer please review the video : http://youtu.be/dBbd94k7b0A (Note: The video is focused on Windows XP, however, the setup steps are the same for Windows 7/10.

=Workstation Install/Update=
Note: The steps between updating or installing a CMS workstation are the same. Once you have verified that you meet the above prerequisites, follow the instructions below to Install/Update your workstation.

To begin double click the CMS installer, then follow the screenshots shown below.

[[image:Workstation1.png]]

[[image:Workstation2.png]]

[[image:Workstation3.png]]

'''NOTE: There is no need to fill in the customer number and release code. Those are only needed for server installs.'''

[[image:Workstation4.png]]

[[image:Workstation5.png]]

[[image:Workstation6.png]]

[[image:Workstation7.png]]

[[image:Workstation8.png]]

[[image:Workstation9.png]]
 

After following these instructions you should now be able to sign into CMS.

Workstation Install

2020-11-24T20:09:59Z

Russ horton: /* Workstation Install/Update */

=Overview=

This article details the instructions for installing or updating a CMS 8, 9, or TEN Workstation.

=Prerequisite=

Before you begin installing or updating your workstation please check that you meet the requirements for all the steps below.

==Step 1: Workstation System Requirements ==

To verify that your system meets CMS system requirements please review : http://wiki.newhavensoftware.com/index.php/CMS_System_Requirements#CMS_workstations

==Step 2: Setup a mapped drive to the CMS server==
Ensure that you have a drive mapped to the \NewHaven Software share on the server and that it is using the same drive letter as other workstations on the network. Workstations should be joined to the network domain.

For Information on how to set up a mapped drive please review the video : http://youtu.be/D1IBcjWCmPs

==Step 3: Obtain the CMS Installer==

*Locate the last CMS update used, typically found in the \Updates subdirectory of the \NewHaven Software share (where you should now have a drive mapped to)

or

*visit http://updates.newhavensoftware.com/
For information on using the update page and downloading the installer please review the video : http://youtu.be/dBbd94k7b0A (Note: The video is focused on Windows XP, however, the setup steps are the same for Windows 7/10.

=Workstation Install/Update=
Note: The steps between updating or installing a CMS workstation are the same. Once you have verified that you meet the above prerequisites, follow the instructions below to Install/Update your workstation.

To begin double click the CMS installer, then follow the screenshots shown below.

[[image:Workstation1.png]]

[[image:Workstation2.png]]

==Workstation Install Option==

[[image:Workstation3.png]]

'''NOTE: There is no need to fill in the customer number and release code. Those are only needed for server installs.'''

[[image:Workstation4.png]]

[[image:Workstation5.png]]

[[image:Workstation6.png]]

[[image:Workstation7.png]]

[[image:Workstation8.png]]

[[image:Workstation9.png]]
 

After following these instructions you should now be able to sign into CMS.

CMS XML specification

2020-11-23T14:25:37Z

Russ horton: /* Transforms */

=Overview=
CMS uses XML as its primary means of order importing and also is used for assorted other data imports and exports. A full specification is defined in our document CMSXML.xsd. This document is available on request from NewHaven Software with a signed non-disclosure agreement.

For more information on order file importing and eCommerce integration capabilities please see our [http://wiki.newhavensoftware.com/index.php/ECommerce_Integrations related article].

==The [http://www.w3schools.com/xml/xml_whatis.asp XML]==
XML is our file format of choice. It is extremely flexible, robust, and widely used. If you are unable to obtain your orders in our described XML format, NewHaven Software can be contracted to write a transform for you that will convert your current file format (ASCII, other XML, etc.) into our XML for importing into CMS. This can be done with a few clicks or, with our [http://wiki.newhavensoftware.com/index.php/ECommerce_Integrations eCMS module], fully automated.

The balance of this guide provides additional information about the preparation and use of XML with CMS.

==Transforms==
It is unlikely CMS will support other specifications/formats in the future. Instead, whenever we need to import from a source that cannot provide XML in our format, we would instead put that data through a transform process to convert it from their native format into CMS's expected XML format.

Transforms like this are currently done with our eCommerce integrations: CommerveV3, Magento, and Volusion, for example. When importing a file from one of those sources, the [http://wiki.newhavensoftware.com/index.php/ECMS_Module#Generic_File_Based CMS plug-in] for that store calls a .dll to transform the file on the fly into our spec and then the file is imported. This process is transparent to the user. Something similar is possible using a .xslt transform in conjunction with our generic plug-in.

Another solution is to use a tool called [http://www.altova.com/mapforce.html MapForce] that can be purchased (not from us) and used by our clients if they wish to write/execute their own transforms. This includes converting not only from other XML formats but also from ASCII, spreadsheets, etc.

Your first choice, however, should be to work with the company providing your data and establish if they can do the transform on their side.

=XML Standards=
There are two distinct phases of ensuring that the XML you produce will work with the merchant's system.

#Ensure your XML is valid (covered by this section) - Your XML must be valid, both per XML standards and meeting the requirement of our XSD specification
#Address the merchant's specific data requirements

==Data Validation==
The CMSXML.xsd file we supply outlines the specific needs of our system including structure of the XML, required elements and the sequence they appear in, definitions of the types of data allowed in an element (length, numeric, etc.).

Data validation should be employed on your site to ensure customers are entering data suitable for that field (e.g. numbers in a phone field.)

==Handling Special Characters==
There are also generic XML standards not explicitly expressed in the XSD that should be followed. A common issue is the use of special characters as data that are reserved for XML encoding. Your system should be able to find and properly escape (encode) these characters to ensure your XML file can be properly parsed. This wiki is a good resource for the list of characters:

https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references#Predefined_entities_in_XML

Example:

Salt & Pepper should instead be passed as Salt <code>&amp;</code> Pepper.

==Validating Your XML==
Before submitting your XML for testing, please validate it against our CMSXML.xsd (provided on request with NDA). If you do not have your own tool for doing so, there are [http://www.xmlvalidation.com/index.php free online tools] available that allow you to load your file and our XSD to show you where there are problems with the structure of the file.

=Merchant Data Requirements=
The information listed here addresses common questions and mistakes made when preparing XML for importing orders and/or catalog requests into CMS.

===Tech Tips===
*Orders imported are treated as new orders. You cannot use XML to import order history.
*Imported catalog requests will not update a customer's address if a customer number is being passed to match it to an existing customer.
*Matching
**CMS will attempt to match imported orders and catalog requests to existing customers based on [http://wiki.brodieware/wiki/index.php/How_CMS_matches_Customers_During_an_Import this logic] when a customer number is not passed.
**New customer records will be created if no match can be established.
*All orders must be manually verified before saved as new orders or use the optional [http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module] to validate as many as can pass your chosen validation checks.
*Inventory for imported orders is allocated at the time of validating.
*CMS order numbers are assigned to imported orders at the time of saving the validated order, not when imported. CMS will retain the order number generated by your site (or source of the order) in a field called Reference Order ID which can be searched on, printed, exported with orders, or even passed through some shipping integrations to appear on shipping labels.
*Catalog requests do not require nor can they be manually verified. They are automatically processed.
*Catalog requests and orders both require unique identification numbers (ID and Reforderid respectively)

==Intro==
Every effort should be made to ensure the product codes, taxing, and shipping & handling charges are setup to match what is in CMS (or that CMS is setup to match the site's config). CMS will expect your XML to contain all financial elements of the order including product pricing, discounts, shipping and handling, insurance, and payment. While we also encourage you to include tax in your XML, this is the only charge the CMS will override during import. In other words, your XML will dictate all of the financials of the order and CMS will not override or recalculate any of your financials with the exception of tax. Tax will be calculated as orders are imported. As such, you should plan on including all pertinent financials in your XML and configure your system to calculate tax in the same way as your client as configured CMS to calculate tax.

==Products==
The most important and potentially challenging aspect of website integration is ensuring the products are identified the same way in both systems. If both are setup at the same time and have the same capabilities this may not be so difficult but often they are disparate systems that were set up independent of each other and potentially with different product options.

In most situations the goal is to facilitate not only order downloads from the site into CMS but also product data uploads from CMS to the site which would include new products, price changes, current stock availability, etc. In other words, it's critical that both CMS and the site can identify products in the same way.

Products are uniquely identified by CMS's product code in most integrations. Where applicable there may also be a size/color type attribute. In more advanced integrations like we have with Magento, it is also possible to use an underlying SKU_ID to match up products that do not share the same product code or structure (e.g. your site does not support size/color attributes but you use them in CMS.)

Determining your strategy for matching products between the two systems should be your first order of business. If any changes are required, and you have a lot of products, this can be a time consuming task that you don't want to put off and risk launch delays or unexpected results.

==Shipping Methods==
For the shipping methods we recommend you use the 'hotkeys' the user has setup for each shipping method in CMS and pass it in the XML as such:

<DefaultShipMethod IndexBy="Code">FG</DefaultShipMethod>

where FG is the hotkey they've setup in CMS to represent FedEx Ground, for example.

The above corresponds to the order's default shipping method and will be used for all packages on the order.

You can additionally pass a shipping method at the recipient/package level if a recipient on the order must ship via an method other than the order default. We recommend only setting this when they differ since CMS treats this explicit setting of a recipient method as an override that cannot be automatically updated by any changes the user makes to the order's default shipping method (an edit that would otherwise cascade to alter the shipping methods on all recipients not explicitly set.)

==Addresses==
At minimum an address should be passed in the <Customer> node (this is the primary address) and the <Recipient> node (this is the shipping address). The billing address is optional and will default to the address passed in the Customer node if a billing address is not passed. In CMS, AddressLine3 is the primary address line. Any additional address lines should go onto AddressLine2 and only use AddressLine2 if 3 and 2 are already used.

==Notes==
<Notes> should be used for notes to the buyer. <GiftMessage> should be used for notes to a gift recipient (when the recipient is not the buyer.)

==Countries==
If you do not pass a country CMS will assume the country is the same as that defined in CMS Setup for the company's address. If you are passing the country you should use <CountryID> and use [https://en.wikipedia.org/wiki/ISO_3166-1 ISO3166-1 codes]. CMS will recognize [https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 alpha-2], [https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 alpha-3], or the [https://en.wikipedia.org/wiki/ISO_3166-1_numeric numeric codes] (3 digit).

CountryName can be used but requires an EXACT match with the [https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes ISO3166] or [https://www.ups.com/worldshiphelp/WS18/ENU/AppHelp/Codes/Country_Territory_and_Currency_Codes.htm UPS list of country names] (names, not the 2 digit code) which has a much lower chance of matching correctly, particularly if you allow free form entry of country name instead of choosing from a list.

==Payment Methods==
Payment methods they must be passed in the XML using the following names: (note - XML is case sensitive)

*American Express
*Check
*JCB
*MasterCard
*Diner's Club
*Money Order
*Discover
*Visa
*PayPal
*GoogleCheckout

Any user-defined payment methods created in CMS that are to be used on the website must also have their names match identically, including letter case.

==Encryption==
CMS does not currently support a method of field or file level encryption with XML. You may consider using PGP as a solution for encryption and then decrypt just before importing into CMS.

When using our [http://wiki.newhavensoftware.com/index.php/ECMS_Module eCMS Module] to connect to your web site's web service or an FTP location, CMS can enforce the use of secure connections (TLS) for orders that contain credit card data. This method ensures that a file with unencrypted card data never resides on your machine/network. The order data goes straight into the database (never saved as a file) and is encrypted before it is written to the table.

CMS is a PA-DSS validated application (2010 - present, v7 - 10.x) and you can rest assured that the credit card data will be managed in a PCI compliant manner once imported into CMS.

==Credit Card Processing==
Our XML supports importing unapproved, approved or even captured credit cards. We strongly discourage capturing credit cards outside of CMS, however. On import, CMS can adjust the payment amount to match the new amount of the order if the order total needs to be adjusted down due to items on backorder, for example. It can also account for small variations in tax amounts (as can happen if your site cannot calc tax the same way CMS can.)

If you'll be authorizing on your site and capturing in CMS (recommended) you'll need to use the same payment gateway and merchant account on both sides. You'll also need to pass additional data fields like a transaction_id to ensure CMS is able to capture the payment. Contact us for more details specific to your processor (Authorize.net, MPS/Vantiv, TransFirst).

Also, make sure your expiration dates are in the proper format of YYYY-MM. Improper formatting of the expiration date is probably the most common error we see.

==Testing==
===Data Provider===
#We can provide a sample xml file with orders that reflect a number of common product and order scenarios. You should discuss specific needs with the client to see which scenarios you should prepare for (e.g. multiple recipient orders, catalog requests, future shipping orders, credit card payments, etc.)
#As stated above, please ensure your XML validates against the provided XSD. CMS is tolerant of nodes and elements in the wrong sequence, which would normally raise errors when validating, but best to get those right just the same.

===Client===
We can assist you with setting up a test database to facilitate testing of imports before they are used in production. When testing, you should both be testing for:
*the success of the import (no errors)
*ensure all required data is being received in the right places

[[Category:Published]]

Updating the CMS License Code

2020-11-20T16:17:21Z

Russ horton: /* Preparing to update your CMS license */

=Overview=
This article details the manual instructions for updating your CMS license code. This process used to be required when you had been provided a new license code to update your support, you have added or changed models in CMS, or you are adding workstation licenses to CMS.

=Method 1 - Updating your license code if your workstation/seat count has not changed=
This license code updating now happens automatically after you've installed the CMS Licensing Service, which is an option any time you install a CMS update. Once installed, CMS will automatically update it's license code every two weeks.

You can also tell CMS to immediately retrieve the latest code by logging in as PCI Administrator, clicking on PCI Administration and then Licensing.

[[image:PCIlicense.png]]

=Method 2 - Updating your license code if your workstation/seat count has changed=
This article remains to describe the manual means updating your license code in cases where the CMS Licensing Service did not function, you are unable to log into CMS as PCI Administrator, or you need to change the number of seats.

==Preparing to update your CMS license==

# Please make sure everyone is signed out of CMS.
*TIP: If you can delete the CMSNET.dat file, everyone is out of CMS (and CMS will recreate this file automatically next time someone logs in.) If you are unable to delete CMSNET.dat and you're sure that everyone is out and/or you are unable to get the remaining users to exit CMS, you can force them out on the server by going to Computer Management in Windows, select Shared Folders and then Open Files. Select all files open that are in the \NewHaven Software directory and then right-click and choose Close Open File(s). This will disconnect everyone from the CMS files and allow a successful update installation or license update.
# Make sure you are on your CMS Server and not a workstation.

== Updating your CMS license via Manage CMS ==
Note: These instructions assume you are on CMS version 7 or later. Also you will need to be on your CMS Server.

[[image:license1.png]]

[[image:license2.png]]

[[image:license3.png]]

[[image:license4.png]]

[[image:license5.png]]

[[image:license6.png]]
Typically your customer number and last known code will be pre-populated for you here. If you've obtained a new code from NewHaven Software, you can paste it in here.
[[image:license7.png]]
We recommend selecting this option to install the CMS Licensing Service to allow CMS to automatically update (bi-weekly) it's code with new purchases, license extensions, etc. 
See the top of this article for info on how to tell CMS to immediately update your code.

[[image:license8.png]]

[[image:license9.png]]
 

After following these instructions your license will be updated and you can sign back into CMS.

Updating the CMS License Code

2020-11-20T16:17:11Z

Russ horton: /* Preparing to update your CMS license */

=Overview=
This article details the manual instructions for updating your CMS license code. This process used to be required when you had been provided a new license code to update your support, you have added or changed models in CMS, or you are adding workstation licenses to CMS.

=Method 1 - Updating your license code if your workstation/seat count has not changed=
This license code updating now happens automatically after you've installed the CMS Licensing Service, which is an option any time you install a CMS update. Once installed, CMS will automatically update it's license code every two weeks.

You can also tell CMS to immediately retrieve the latest code by logging in as PCI Administrator, clicking on PCI Administration and then Licensing.

[[image:PCIlicense.png]]

=Method 2 - Updating your license code if your workstation/seat count has changed=
This article remains to describe the manual means updating your license code in cases where the CMS Licensing Service did not function, you are unable to log into CMS as PCI Administrator, or you need to change the number of seats.

==Preparing to update your CMS license==

# Please make sure everyone is signed out of CMS.
**TIP: If you can delete the CMSNET.dat file, everyone is out of CMS (and CMS will recreate this file automatically next time someone logs in.) If you are unable to delete CMSNET.dat and you're sure that everyone is out and/or you are unable to get the remaining users to exit CMS, you can force them out on the server by going to Computer Management in Windows, select Shared Folders and then Open Files. Select all files open that are in the \NewHaven Software directory and then right-click and choose Close Open File(s). This will disconnect everyone from the CMS files and allow a successful update installation or license update.
# Make sure you are on your CMS Server and not a workstation.

== Updating your CMS license via Manage CMS ==
Note: These instructions assume you are on CMS version 7 or later. Also you will need to be on your CMS Server.

[[image:license1.png]]

[[image:license2.png]]

[[image:license3.png]]

[[image:license4.png]]

[[image:license5.png]]

[[image:license6.png]]
Typically your customer number and last known code will be pre-populated for you here. If you've obtained a new code from NewHaven Software, you can paste it in here.
[[image:license7.png]]
We recommend selecting this option to install the CMS Licensing Service to allow CMS to automatically update (bi-weekly) it's code with new purchases, license extensions, etc. 
See the top of this article for info on how to tell CMS to immediately update your code.

[[image:license8.png]]

[[image:license9.png]]
 

After following these instructions your license will be updated and you can sign back into CMS.

Updating the CMS License Code

2020-11-20T16:11:01Z

Russ horton:

=Overview=
This article details the manual instructions for updating your CMS license code. This process used to be required when you had been provided a new license code to update your support, you have added or changed models in CMS, or you are adding workstation licenses to CMS.

=Method 1 - Updating your license code if your workstation/seat count has not changed=
This license code updating now happens automatically after you've installed the CMS Licensing Service, which is an option any time you install a CMS update. Once installed, CMS will automatically update it's license code every two weeks.

You can also tell CMS to immediately retrieve the latest code by logging in as PCI Administrator, clicking on PCI Administration and then Licensing.

[[image:PCIlicense.png]]

=Method 2 - Updating your license code if your workstation/seat count has changed=
This article remains to describe the manual means updating your license code in cases where the CMS Licensing Service did not function, you are unable to log into CMS as PCI Administrator, or you need to change the number of seats.

==Preparing to update your CMS license==

# Please make sure everyone is signed out of CMS. TIP: If you can delete the CMSNET.dat file, everyone is out of CMS (and CMS will recreate this file automatically next time someone logs in.)
# Make sure you are on your CMS Server and not a workstation.

== Updating your CMS license via Manage CMS ==
Note: These instructions assume you are on CMS version 7 or later. Also you will need to be on your CMS Server.

[[image:license1.png]]

[[image:license2.png]]

[[image:license3.png]]

[[image:license4.png]]

[[image:license5.png]]

[[image:license6.png]]
Typically your customer number and last known code will be pre-populated for you here. If you've obtained a new code from NewHaven Software, you can paste it in here.
[[image:license7.png]]
We recommend selecting this option to install the CMS Licensing Service to allow CMS to automatically update (bi-weekly) it's code with new purchases, license extensions, etc. 
See the top of this article for info on how to tell CMS to immediately update your code.

[[image:license8.png]]

[[image:license9.png]]
 

After following these instructions your license will be updated and you can sign back into CMS.

Updating the CMS License Code

2020-11-20T16:09:04Z

Russ horton:

=Overview=
This license code updating now happens automatically after you've installed the CMS Licensing Service, which is an option any time you install a CMS update. Once installed, CMS will automatically update it's license code every two weeks. You can also tell CMS to immediately retrieve the latest code by logging in as PCI Administrator, clicking on PCI Administration and then Licensing.

[[image:PCIlicense.png]]

=Method 1 - Updating your license code if your workstation/seat count has not changed=
This article details the manual instructions for updating your CMS license code. This process used to be required when you had been provided a new license code to update your support, you have added or changed models in CMS, or you are adding workstation licenses to CMS.

=Method 2 - Updating your license code if your workstation/seat count has changed=
This article remains to describe the manual means updating your license code in cases where the CMS Licensing Service did not function, you are unable to log into CMS as PCI Administrator, or you need to change the number of seats.

==Preparing to update your CMS license==

# Please make sure everyone is signed out of CMS. TIP: If you can delete the CMSNET.dat file, everyone is out of CMS (and CMS will recreate this file automatically next time someone logs in.)
# Make sure you are on your CMS Server and not a workstation.

== Updating your CMS license via Manage CMS ==
Note: These instructions assume you are on CMS version 7 or later. Also you will need to be on your CMS Server.

[[image:license1.png]]

[[image:license2.png]]

[[image:license3.png]]

[[image:license4.png]]

[[image:license5.png]]

[[image:license6.png]]
Typically your customer number and last known code will be pre-populated for you here. If you've obtained a new code from NewHaven Software, you can paste it in here.
[[image:license7.png]]
We recommend selecting this option to install the CMS Licensing Service to allow CMS to automatically update (bi-weekly) it's code with new purchases, license extensions, etc. 
See the top of this article for info on how to tell CMS to immediately update your code.

[[image:license8.png]]

[[image:license9.png]]
 

After following these instructions your license will be updated and you can sign back into CMS.

Updating the CMS License Code

2020-11-20T16:07:46Z

Russ horton:

=Overview=
==Method 1 - Updating your license code if your workstation/seat count has not changed==
This article details the manual instructions for updating your CMS license code. This process used to be required when you had been provided a new license code to update your support, you have added or changed models in CMS, or you are adding workstation licenses to CMS.

This license code updating now happens automatically after you've installed the CMS Licensing Service, which is an option any time you install a CMS update. Once installed, CMS will automatically update it's license code every two weeks. You can also tell CMS to immediately retrieve the latest code by logging in as PCI Administrator, clicking on PCI Administration and then Licensing.

[[image:PCIlicense.png]]

==Method 2 - Updating your license code if your workstation/seat count has changed==
This article remains to describe the manual means updating your license code in cases where the CMS Licensing Service did not function, you are unable to log into CMS as PCI Administrator, or you need to change the number of seats.

=Preparing to update your CMS license=

# Please make sure everyone is signed out of CMS. TIP: If you can delete the CMSNET.dat file, everyone is out of CMS (and CMS will recreate this file automatically next time someone logs in.)
# Make sure you are on your CMS Server and not a workstation.

= Updating your CMS license via Manage CMS =
Note: These instructions assume you are on CMS version 7 or later. Also you will need to be on your CMS Server.

[[image:license1.png]]

[[image:license2.png]]

[[image:license3.png]]

[[image:license4.png]]

[[image:license5.png]]

[[image:license6.png]]
Typically your customer number and last known code will be pre-populated for you here. If you've obtained a new code from NewHaven Software, you can paste it in here.
[[image:license7.png]]
We recommend selecting this option to install the CMS Licensing Service to allow CMS to automatically update (bi-weekly) it's code with new purchases, license extensions, etc. 
See the top of this article for info on how to tell CMS to immediately update your code.

[[image:license8.png]]

[[image:license9.png]]
 

After following these instructions your license will be updated and you can sign back into CMS.

Moving CMS to a New Server

2020-11-09T18:07:01Z

Russ horton: /* Step 9 - Restart the Sybase service on the new computer (Skip this step if running CMS Solo) */

=Overview=
This article details the instructions for moving your CMS installation from an old server to a new server including moving your data.

This process is a large undertaking that will require CMS to be down during the move. As a result please inform NewHaven Support of the day you plan to do the server migration. This is so we may either set up a appointment with you to guide you through the process, or at least ensure we have staff available to you in case you find you require assistance.

The following instructions have 4 major themes to them:

# Preparing to move CMS to the new System.
# Installing CMS on the new System.
# Moving the old Database to the new System.
# Updating the old Database to the new version of CMS

The above list is to help outline what exactly the following instructions are attempting to accomplish and to give you an overview of the process you are about to undertake.

=Moving CMS on to a new server=
== Step 1 - Prerequisites==
CRITICAL! ALL USERS MUST EXIT CMS PRIOR TO INSTALLING CMS SERVER ON ANOTHER COMPUTER!

CRITICAL! YOU MUST BE LOGGED IN AS THE COMPUTER ADMINISTRATOR OR A USER THAT IS A MEMBER OF THE ADMINISTRATORS GROUP!

==Step 2 - Make a backup image of CMS Database files==
We need to create a backup of your current live database to transfer to the new server.
To create a backup of your database please review the link below:

http://wiki.newhavensoftware.com/index.php/Creating_a_Database_Backup

== Step 3 - Stop and Disable the Sybase service on your old system (Skip this step if running CMS Solo) ==
Next we will need to disable the Sybase service on your old system. This step is done to ensure there is no conflict with the database services when we do the install on the new system.

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#How_to_Stop_the_Sybase_service_if_running_CMS_8.0_or_later

== Step 4 - Disable sharing on the NewHaven Software folder ==
This is to ensure we do not accidentally connect workstations to the old server after the migration is complete.

For information on how to do this please visit http://wiki.newhavensoftware.com/index.php/Folder_sharing_in_Windows

== Step 5 - Install CMS Server on the new computer. ==

To do so please follow the information in the link below.
http://wiki.newhavensoftware.com/index.php/Server_Update

== Step 6 - Stopping the Sybase service on the new computer (Skip this step if running CMS Solo) ==
We need to stop the Sybase service now to transfer in the copy of the database from the old server.

To do so please follow the links below:

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#CMS_8.0_or_later

== Step 7 - Copying over your Database and log file to the new system ==
#Create a new folder in the NewHaven Software\Data folder. Name it CLEAN.
#There should be two files in the NewHaven Software\Data\ ( Your Database Name) folder; one with a .db extension and one with a .log extension. Move both of these files into the NewHaven Software\Data\Clean folder you just created.
#Copy the .db and .log file from the old CMS Server computer into the NewHaven Software\Data\ (Your Database Name) folder on your new CMS Server computer.

== Step 8 - Copying over the CMSDBO.ini file and Custom Reports ==
We now need to copy over the CMSDBO.ini file to ensure CMS is able to start, as well as any custom reports.

# Check the NewHaven Software folder on the old server, see if there is a file present called CMSDBO.ini, if it is not there skip the next step.
# If this file is present please copy and move it into the NewHaven Software folder on your new system.
# Also if you have any custom reports please make sure to move them to the new server as well.

== Step 9 - Restart the Sybase service on the new computer (Skip this step if running CMS Solo) ==
You will now need to start the Sybase service on the new computer. To do so please follow the links below:

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#How_to_Start_the_Sybase_service_if_running_CMS_8.0_or_later

== Step 10 - Log into CMS ==
Log into CMS and confirm it is working. If you get a database mismatch error message, you will need to rerun the setup and reboot the computer in order to sync up the CMS application and database. To do so please follow the instructions in http://wiki.newhavensoftware.com/index.php/Server_Update

== Step 11 - Check your backup ==

Check your CMS backup settings in to ensure the path that it is using to backup its files is still valid on this server. To access this please follow the information in the link below:

http://wiki.newhavensoftware.com/index.php/Creating_a_Database_Backup

== Step 12 - Sharing the NewHaven Software folder ==
Once you confirm CMS is working on the new installation, you can share out the NewHaven Software folder so your workstations are able to connect to it. For information on how to do this please visit http://wiki.newhavensoftware.com/index.php/Folder_sharing_in_Windows

== Step 13 - Connecting Workstations to CMS (Skip this step if running CMS Solo) ==
If the server is on the same network as your old server. All you need to do is remap the NewHaven Software shared drive on the workstations to the new server. For information on how to do that please review the video below:
http://youtu.be/dBbd94k7b0A

If these workstations are on a NEW network along with the server, or you are also installing new workstations, please follow the link below:
http://wiki.newhavensoftware.com/index.php/Workstation_Install

NOTE: Workstations must be on the same subnet as the server for CMS to be able to detect and connect to its database server. If this is not reasonable to do, please contact us for additional configuration options.

== Step 14 - Removing CMS from the old system ==
Uninstall CMS Server from the old computer to ensure the potentially conflicting Sybase service is removed and that everyone is running CMS from the same directory on the new CMS Server computer.

== Step 15 - Updating CMS to the latest version ==

At this point if you need to update CMS to the latest version, please follow the information in the link below:
http://wiki.newhavensoftware.com/index.php/Server_Update

NCOA

2020-10-02T15:12:33Z

Russ horton: /* Imports */

=Overview=
NCOA is the common acronym used for [http://www.peachtreedata.com/ncoa/ National Change of Address]. This service is provided by companies licensed by the United States Postal Service (USPS) to provide address hygiene services. While NCOA is most commonly used, and is a requirement, for any bulk mail discounts, it a good service for everyone to use to ensure your mail list is clean and up to date. NewHaven Software has partnered with Peachtree Data, a USPS licensee, to provide NCOA services. You'll find Peachtree Data to be fast, friendly, and reasonably priced. This article will elaborate on the benefits and details of NCOA processing.

=Benefits=
NCOA processing with CMS and Peachtree Data will provide the following benefits:

*For anyone who has moved, NCOA will provide their current address (as filed with USPS)
*For all addresses submitted, even those that have not moved, [http://www.melissadata.com/enews/articles/1005/8.htm CASS] processing will be performed to update the address to USPS standards including appending the +4 to your zips
*Rural Routes will be converted to standard addresses ([http://www.usps.com/ncsc/addressservices/addressqualityservices/lacsystem.htm LACS])
*Missing Suite numbers will be appended to business addresses
*Addresses validated as deliverable
*Meets USPS requirements for list updates if performed within 95 days of any discounted bulk mailing

When you import the NCOA response file, you will have a chance to review reports indicating all of the matches and address updates Peachtree Data was able to provide. These results can be reviewed before applying the changes to your mail list. After you have reviewed and continue with the import, CMS will not only update your customer records with the new addresses but will also flag customers with flags to indicate:

*NCOA - Your customer has moved and their address has been updated
*Undeliverable - USPS cannot provide a deliverable address for this person
*No Zip+4 - USPS could not find a +4 for this address
*May Have Moved - Someone moved from this address but they cannot be sure if that person matched the name you passed (previously known as NIXIE)

The above flags can be found under the Flags & Financials tab in the Customers section of CMS. These flags are useful both for visual referencing as well as mail list filtering. For example, it is a common practice to reach out to your "May Have Moved" customers to verify their addresses. In a few seconds you can create a filter based on this flag, run the filter in Quick Count, and double click on each name to contact them and update their record as appropriate. You might also want to exclude customers with the Undeliverable flag from any mailing. See our article on [[Compound Mail List Filters]] for more information on creating include and exclude criteria in your mail filters.

=Solution=
'''Please note that CMS will only work with Peachtree Data and your export to Peachtree Data must be generated from the Address Correction section of CMS.''' While there are other companies that provide NCOA services, CMS relies on Peachtree Data's specific file format and response codes to ensure proper data updates. NewHaven Software cannot support files processed from other NCOA service providers.

To obtain NCOA service please contact Clint Farmer at Peachtree Data and identify yourself as a NewHaven Software customer. '''Make sure to request the following format: Peachtree Original Layout for CMS'''.

Clint Farmer Peachtree Data, Inc. 2905 Premiere Pkwy Ste 200 Duluth, GA 30097-5240 cfarmer@peachtreedata.com (800) 477-3224 x4670 www.peachtreedata.com

=Additional Help=
You can find step by step instructions for NCOA processing in [http://help.newhavensoftware.com CMS Help] and typing in NCOA under the Index tab. Please contact NewHaven Technical Support if you require further assistance.

=Troubleshooting=
==Imports==
#Are your running CMS version 9.0.5.136 - 9.0.5.140? If so, you must update to a more current version before attempting any Peachtree import due to known problems in that span of CMS builds.
#Was the file sent to Peachtree generated from the Address Correction section of CMS? If not, a file must be resubmitted to Peachtree that was created from this section of CMS.
#Find the file called Layout Report.pdf that Peachtree includes in their response files. Scroll to the end of the document and the last field is either called Info or Notes. '''This field MUST be 22 bytes!''' If it is anything else, it needs to be pushed back to Peachtree for the proper output. (more info below)
#Look at the file from Peachtree that was included with the response file called Layout Report.pdf. The end of this PDF will tell you the length of each record.
##For CMS Versions 10.0.14.277 and below - Every record should be 587 bytes per the report. They also add two bytes (CRLF) onto each record which is not documented in the layout report so the total record length is 589. As such '''the entire file size should be a multiple of 589'''. If not, it is the wrong format and should be pushed back to Peachtree for the proper format (ask for Clint). For reference or coordination with Peachtree, this is what a properly formatted output should look like in their Layout Report - http://screencast.com/t/kuXqhoa8
##For CMS Versions 10.0.14.278 or later - Every record should be 588 bytes per the report. They also add two bytes (CRLF) onto each record which is not documented in the layout report so the total record length is 590. As such '''the entire file size should be a multiple of 590'''. If not, it is the wrong format and should be pushed back to Peachtree for the proper format (ask for Clint).
#Verify that the file sent is fixed length and not CSV

==Exports==
The export file from CMS is the Peachtree 180 format, so named because it is 180 characters per record. Like the above, a proper file should be an even multiple of 180. If not, it is a CMS bug.

It is imperative that the original file sent to Peachtree be generated from CMS's Address Correction section to ensure that each record is the right length. Also make sure the processing was done by PeachTree so we know the records are properly coded in a way that will allow CMS to match the response records properly to their customer records.

NCOA

2020-10-02T15:10:25Z

Russ horton: /* Imports */

=Overview=
NCOA is the common acronym used for [http://www.peachtreedata.com/ncoa/ National Change of Address]. This service is provided by companies licensed by the United States Postal Service (USPS) to provide address hygiene services. While NCOA is most commonly used, and is a requirement, for any bulk mail discounts, it a good service for everyone to use to ensure your mail list is clean and up to date. NewHaven Software has partnered with Peachtree Data, a USPS licensee, to provide NCOA services. You'll find Peachtree Data to be fast, friendly, and reasonably priced. This article will elaborate on the benefits and details of NCOA processing.

=Benefits=
NCOA processing with CMS and Peachtree Data will provide the following benefits:

*For anyone who has moved, NCOA will provide their current address (as filed with USPS)
*For all addresses submitted, even those that have not moved, [http://www.melissadata.com/enews/articles/1005/8.htm CASS] processing will be performed to update the address to USPS standards including appending the +4 to your zips
*Rural Routes will be converted to standard addresses ([http://www.usps.com/ncsc/addressservices/addressqualityservices/lacsystem.htm LACS])
*Missing Suite numbers will be appended to business addresses
*Addresses validated as deliverable
*Meets USPS requirements for list updates if performed within 95 days of any discounted bulk mailing

When you import the NCOA response file, you will have a chance to review reports indicating all of the matches and address updates Peachtree Data was able to provide. These results can be reviewed before applying the changes to your mail list. After you have reviewed and continue with the import, CMS will not only update your customer records with the new addresses but will also flag customers with flags to indicate:

*NCOA - Your customer has moved and their address has been updated
*Undeliverable - USPS cannot provide a deliverable address for this person
*No Zip+4 - USPS could not find a +4 for this address
*May Have Moved - Someone moved from this address but they cannot be sure if that person matched the name you passed (previously known as NIXIE)

The above flags can be found under the Flags & Financials tab in the Customers section of CMS. These flags are useful both for visual referencing as well as mail list filtering. For example, it is a common practice to reach out to your "May Have Moved" customers to verify their addresses. In a few seconds you can create a filter based on this flag, run the filter in Quick Count, and double click on each name to contact them and update their record as appropriate. You might also want to exclude customers with the Undeliverable flag from any mailing. See our article on [[Compound Mail List Filters]] for more information on creating include and exclude criteria in your mail filters.

=Solution=
'''Please note that CMS will only work with Peachtree Data and your export to Peachtree Data must be generated from the Address Correction section of CMS.''' While there are other companies that provide NCOA services, CMS relies on Peachtree Data's specific file format and response codes to ensure proper data updates. NewHaven Software cannot support files processed from other NCOA service providers.

To obtain NCOA service please contact Clint Farmer at Peachtree Data and identify yourself as a NewHaven Software customer. '''Make sure to request the following format: Peachtree Original Layout for CMS'''.

Clint Farmer Peachtree Data, Inc. 2905 Premiere Pkwy Ste 200 Duluth, GA 30097-5240 cfarmer@peachtreedata.com (800) 477-3224 x4670 www.peachtreedata.com

=Additional Help=
You can find step by step instructions for NCOA processing in [http://help.newhavensoftware.com CMS Help] and typing in NCOA under the Index tab. Please contact NewHaven Technical Support if you require further assistance.

=Troubleshooting=
==Imports==
#Are your running CMS version 9.0.5.136 - 9.0.5.140? If so, you must update to a more current version before attempting any Peachtree import due to known problems in that span of CMS builds.
#Was the file sent to Peachtree generated from the Address Correction section of CMS? If not, a file must be resubmitted to Peachtree that was created from this section of CMS.
#Find the file called Layout Report.pdf that Peachtree includes in their response files. Scroll to the end of the document and the last field is either called Info or Notes. '''This field MUST be 22 bytes!''' If it is anything else, it needs to be pushed back to Peachtree for the proper output. (more info below)
#Look at the file from Peachtree that was included with the response file called Layout Report.pdf. The end of this PDF will tell you the length of each record.
For CMS Versions 10.0.14.279 and below - Every record should be 587 bytes per the report. They also add two bytes (CRLF) onto each record which is not documented in the layout report so the total record length is 589. As such '''the entire file size should be a multiple of 589'''. If not, it is the wrong format and should be pushed back to Peachtree for the proper format (ask for Clint). For reference or coordination with Peachtree, this is what a properly formatted output should look like in their Layout Report - http://screencast.com/t/kuXqhoa8
#Verify that the file sent is fixed length, and not CSV

==Exports==
The export file from CMS is the Peachtree 180 format, so named because it is 180 characters per record. Like the above, a proper file should be an even multiple of 180. If not, it is a CMS bug.

It is imperative that the original file sent to Peachtree be generated from CMS's Address Correction section to ensure that each record is the right length. Also make sure the processing was done by PeachTree so we know the records are properly coded in a way that will allow CMS to match the response records properly to their customer records.

Custom SQL Filters

2020-09-08T16:00:05Z

Russ horton: /* Mail List Filters */

In addition to the standard invoice and mail list filter criteria provided in CMS, you also have the option to write your own SQL. This is useful for when you'd want to create a filter that is beyond the standard options available through the CMS interface.

It is important to note that when you select the 'Write Own SQL' checkbox, it supersedes all other criteria and becomes the only enabled option on the filter screen. You cannot combine it with other filter criteria. You can, however, customize a mail filter created in CMS.

In the Mail List Filter section you have the option of creating a filter using the checkboxes to get as close as you can to your desired filter. Once saved you would then click on View SQL to see the resulting SQL CMS has created based on the options selected. You cannot edit that SQL there but you can copy it and create a new filter with 'Write Own SQL' and paste/edit it there.

This can be very handy and is rather easy to do as, often times, the only modification desired is a change in Boolean values. For example, if you create a filter based on two customer description codes (CDC's) the default Boolean is 'OR'. In other words, customers will qualify for this filter if they have one code OR the other. If you only wanted customers who had both codes, you would create a custom filter, paste in the SQL from the original filter and change the OR to an AND.

Syntax is very important in these filters so if you are writing one from scratch, please pay attention to these examples for guidance on what your Selects should look like (namely the use of DISTINCT and which tables are being referenced):

=Mail List Filters=
==Requirements==
Every mail list filter must include (start with) at least the following:
<source lang="tsql">
SELECT DISTINCT C.*
FROM CUST C
WHERE ...
</source>

==Mail list filter examples==
NOTE: When writing your own SQL keep in mind if you are going to be using these statements in [[Compound Mail List Filters]], you will need to return C.ID, not C.* This makes these individual filters suitable for use only as components for Compound filters. They can no longer be used on their own. Our recommendation is to label them as compound filter components. Like COMP_Products_By_Date and COMP_Not_Select_Products. Doing this you will know not to use them by themselves. To use the filters by themselves and to combine different filters together, you have to use joins and not compound filters.

===Products Purchased===
Target customers based on products fulfilled within a date range (3 examples) and thus excludes unfulfilled back orders and future ships. Date range is based off of the fulfill date. These filters also exclude fully returned/canceled items.

*In a Date Range
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C, ITEMSORD I
WHERE (I.PROD_CODE = '1'
AND I.FULFILL_DT between '2017-01-31' and '2017-03-31'
AND ((I.CUR_RETURN + I.CUR_CANCEL) < I.CUR_SENT))
AND (I.CUST_NUM = C.ID)
</source>

*Greater than a specified date
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C, ITEMSORD I
WHERE (I.PROD_CODE = '1'
AND I.FULFILL_DT > '2017-01-31'
AND ((I.CUR_RETURN + I.CUR_CANCEL) < I.CUR_SENT))
AND (I.CUST_NUM = C.ID)
</source>

*Ordered in the last 30 days
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C, ITEMSORD I
WHERE (I.PROD_CODE = '1'
AND I.FULFILL_DT > (TODAY(*) - 30)
AND ((I.CUR_RETURN + I.CUR_CANCEL) < I.CUR_SENT))
AND (I.CUST_NUM = C.ID)
</source>

*Sold by a specific salesperson, only shipped and not returned (no date range)
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C INNER JOIN orderhdr o ON c.id = o.cust_num
INNER JOIN itemsord i ON o.order_id = i.order_id
WHERE o.proforma <> 1
AND o.tempsave <> 1
AND i.status > 5
AND i.order_qty > (i.cur_return + cur_cancel)
AND (i.prod_code = 'PRODUCT CODE'
AND o.SALES_ID = 'Salesperson Username')
</source>

*Customers that bought from a specified list of products in a selected date range. Exclude if they bought any from another list of products or if the customer is set to Do Not Mail Catalog.
(this query has to look at your entire order history and will take a long time to run)
<source lang='tsql'>
SELECT DISTINCT C.* FROM CUST C
LEFT JOIN CUSTFLAGS CF ON CF.ID = C.ID AND CF.FLAG_ID = 1
JOIN ITEMSORD I ON I.CUST_NUM = C.ID
WHERE I.FULFILL_DT BETWEEN '2012-02-01' AND '2013-03-07'
AND (I.CUR_RETURN + I.CUR_CANCEL) < I.CUR_SENT
AND I.PROD_CODE IN ('PRODCODE-A','PRODCODE-B')
-- FLAG_ID <> 1 by matching on null with the left join
AND CF.FLAG_ID IS NULL
AND C.ID NOT IN
(SELECT IO.CUST_NUM FROM ITEMSORD IO WHERE IO.PROD_CODE IN (
-- Comma delimited list of product codes to match for exclusion from the customer list
'PRODCODE-X','PRODCODE-Y','PRODCODE-Z')
GROUP BY IO.CUST_NUM
-- End customer exclusion list
);
</source>

*Customers that bought a specific product that was shipped since a specific date that hasn't been returned and that customer has a viable email address.
<source lang='tsql'>
SELECT DISTINCT C.*
FROM CUST C
Join Itemsord t on t.cust_num = c.ID
Join Invoice i on i.order_id = t.order_id and i.invoice_id = t.invoice_id
WHERE (t.PROD_CODE = 'XXXXXX'
and i.SHIPPED_DT between '2017-07-31' and '2017-08-31'
AND ((t.SENT_QTY > t.RET_QTY - t.CANCEL_QTY)))
AND datalength(LTRIM(RTRIM([EMAIL]))) - datalength(REPLACE(LTRIM(RTRIM([EMAIL])),'@','')) = 1 AND (CHARINDEX('.@',[EMAIL]) = 0 AND CHARINDEX('..',[EMAIL]) = 0)
</source>

===[[CMS Customer Filter for customers with a specific item on Back Order]]===
Click the title link to redirect to an article specifically on this topic.

===[[Targeting Catalog Requestors]]===
Click the title link to redirect to an article specifically on this topic.

===Customers with Unshipped Orders in a Date Range===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
LEFT OUTER JOIN ORDERHDR O ON (C.ID = O.CUST_NUM)
WHERE
((O.order_dt BETWEEN '2012-05-18' AND '2013-09-18')
AND (isnull(o.shipped_dt,'1899-12-30') = '1899-12-30'))
AND (C.EMAIL <> '')
</source>

===By First Order Date===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE
(C.FIRST_DATE BETWEEN '2013/08/15' AND '2013/08/15')
</source>

===Phone number Area code===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE
(C.ID IN (SELECT CUST_NUM FROM PHONES
where phone_num like
'(297%'
or phone_num like
'297'
or phone_num like
'1297'
or phone_num like
'1-297'
))
</source>

===Customers having more than one Customer Description Code===
In CMS it is easy to find customers who have any one code, or one of several, but you'll need custom SQL like the following to find customers who must have more than one of a list of codes to qualify.
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE C.ID IN (
SELECT CUST_NUM FROM CUSTDESC
WHERE CUSDESKE in ('0525','0600')
GROUP BY CUST_NUM
HAVING COUNT(CUST_NUM) >= 2 -- 2 = the number of values to find
)
</source>

*Change the cusdeske values to correspond to the desired customer description codes (CDC) per the CUSDESCO table
*Change the integer in the last line to indicate the number of CDC matches required

===Customers with a Company Name===

<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE C.COMPANY <> ''
</source>

===Last Modified===
The Last Modified field was added in CMS 8.0 but does not yet have a corresponding mail filter option. Here are a couple of examples of how you can build this into your filters:
*Last Modified in a range of dates:
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE (C.LAST_UPDAT BETWEEN '2011/05/02' AND '2012/05/02')
</source>
Change the dates as needed.

*Last Modified in the last 180 days:
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE (C.LAST_UPDAT > (TODAY(*) - 180))
</source>
Change 180 to whatever number of days back is desired.

===All Recipients for a Customer (e.g. Amazon)===
If you are processing orders with Amazon or similar partner, you'll only get shipping addresses and not billing information from them since Amazon handles all of the payments. As such these orders will import into CMS with Amazon as the customer and always attach themselves to your Amazon customer record. If you have the option enabled in CMS Order Entry Options, new customer records will also be created for each ship-to. It may be helpful to be able to identify those ship-to customer records. This might be to tag them with a customer description code, exclude from an upcoming mailing, etc. This SQL can be used as a mail list filter to find those recipient customer records that have ordered through Amazon (or whoever your orders are coming from.)

<source lang="tSQL">
SELECT DISTINCT C.*
From CUST c
where C.ID in
(Select a.cust_num
From Address a
Join recipient r on r.address_id = a.address_id
Join recipient_order ro on ro.recipient_id = r.recipient_id
Join orderhdr o on o.order_id = ro.order_idWhere o.cust_num = '0000518128')
</source>

Change the customer number in the last line to match your billing account for Amazon. Zero pad to ten total characters as shown in the above example.

===Orders Placed from Selected Order Sources===
<source lang="tSQL">
SELECT DISTINCT c.*
FROM CUST c
Join ORDERHDR o on o.cust_num = c.ID
Join ORDERSRC s on s.ordersrc_id = o.order_src
Where (o.ORDER_DT BETWEEN '2016-01-31' AND '2017-10-31'
AND o.CANCELLED = 0
and (s.name = 'Phoned In'
or s.name = 'Mailed In'))
</source>

====Amazon Recipients====
Similar to the above, this is targetting a specific order source but, since you are really drop-shipping for Amazon, Amazon is your customer...so all of the orders fall under the Amazon customer record in your mail list. If you have CMS configured to save recipients as new customers though, CMS will have customer records for each customer that ordered via Amazon. The following query will target those recipients:

<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
Where c.ship_id > 0
and c.ship_id in
(select address_id from Recipient r
JOIN Recipient_order ro on r.recipient_id = ro.recipient_id
JOIN ORDERHDR o on o.order_id = ro.order_id
where o.order_src = 15)
</source>
Noting that you'll need to change the last line (15) to match whatever the order source ID is for the order source you're targeting (see the ORDERSRC table for this.)

===Customers with orders having a specific Referral Code===

<source lang="tSQL">
SELECT DISTINCT c.*
FROM CUST c
Join ORDERHDR o ON o.cust_num = c.ID
WHERE (o.ORDER_DT BETWEEN '2016-01-31' AND '2017-06-30')
AND o.referral_code = 'XXXX'
</source>

===Invoice created in a date range with a captured credit card but invoice is unshipped===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C, INVOICE I
JOIN Payledger p on p.order_id = i.order_id
and p.invoice_id = i.invoice_id
JOIN chargeinfo r on p.payid = r.payid
WHERE I.ORDER_DT between '2012-08-31' and '2013-02-28'
AND I.SHIPPED_FL = '0'
AND r.edc = 1
AND (I.CUST_NUM = C.ID)
</source>

===Customers with a declined credit card in last 30 days===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
JOIN paylist l on l.ID = C.ID
JOIN paytypes t on t.pay_type = l.pay_type
Where l.badpayment = '1'
AND l.DELETED = '0'
AND t.credit_car = '1'
AND l.createdate > (TODAY(*)-30)
</source>

===Filter based on one of the customer user defined fields where the value is greater than X===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE (REGEXP_SUBSTR(C.USERCODE1,'\d+\.*\d*') > 12.4)
</source>
*This method allows you to perform a greater or less than query on a user field which is not explicitly defined as numeric. That said, this filter will fail if you have any non-numeric values in the corresponding user-defined field in any of the customer records.
*It is important to understand that any time you are running a "greater than" or "less than" operator against a numeric value you must not use quotes. Otherwise SQL will interpret that as a string comparison. And string comparing numeric values will not be accurate.

===U.S. and Canadian customers with first contact date, catalog request, or order in date range===
The first half of the SQL is to include based on any of the contact dates AND that they are in U.S. or Canada. The second half (starting with AND NOT) is the exclude portion of the statement, in this case based on specific customer description code, customer flag, or or order's adcodes.
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE C.COUNTRY < 2
AND (
(C.FIRST_CONTACT BETWEEN '2012-01-01' AND '2015-09-30')
OR EXISTS (SELECT 1 FROM CUSTHIST WHERE CUSTHIST.CUST_NUM = C.ID AND ENTRYDATE > '2012-01-01')
OR EXISTS (SELECT 1 FROM TODO WHERE TODO.TYPE = '05' AND TODO.VOID = 0 AND TODO.DATE_CREAT > '2012-01-01' AND TODO.RELATES_TO = C.ID)
OR (C.LAST_INVOI BETWEEN '2008/01/01' AND '2015/10/12')
) AND NOT EXISTS ( SELECT 1 FROM CUST C2
LEFT OUTER JOIN CUSTDESC ON C2.ID = CUSTDESC.CUST_NUM
LEFT OUTER JOIN ORDERHDR ON C2.ID = ORDERHDR.CUST_NUM
LEFT OUTER JOIN CUSTFLAGS CF ON CF.ID = C2.ID
WHERE (
CUSTDESC.CUSDESKE = '0004'
OR ORDERHDR.ADCODE = 'p-etch'
OR ORDERHDR.ADCODE = 'wwwg'
OR CF.FLAG_ID = 1
) AND C2.ID = C.ID
)
</source>

===Customers with a specific term that have no spending in period===
Here we're looking for customers that you have on terms but have not spent anything in a given time period. Adjust date ranges, spending amounts, and the term_id in the SQL to suit.
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
LEFT OUTER JOIN ORDERHDR ON (C.ID = ORDERHDR.CUST_NUM)
WHERE c.term_id = '002'
and not fbCustSpendingInPeriod(c.id,'2018/09/08','2020/09/08',1,99999999) =1
</source>

=Invoice filters=
==Invoice Filter requirements==
Every invoice filter must include (start with) at least the following:
<source lang="tsql">
SELECT DISTINCT I.* FROM INVOICE I
JOIN ORDERHDR O ON (I.ORDER_ID=O.ORDER_ID)
LEFT OUTER JOIN PACKAGE P ON (I.ORDER_ID=P.ORDER_ID) AND (I.INVOICE_ID=P.INVOICE_ID)
LEFT OUTER JOIN ADDRESS ON (I.SHIP_ID = ADDRESS.ADDRESS_ID)
WHERE...
</source>

==Examples==
===Target invoices whose item total is greater than $X===
<source lang="tsql">
SELECT DISTINCT I.* FROM Invoice I, Orderhdr O
WHERE I.ITEM_TOT > 300
and I.order_id = O.order_id
</source>
Modify the 300 in this example to represent the desired item total threshold. This item total take into account line and order level discounts but does not include S&H, taxes, or other order level charges.

===Target a single customer and any of their invoices with a balance===
<source lang="tsql">
SELECT DISTINCT I.* FROM INVOICE I
JOIN ORDERHDR O ON (I.ORDER_ID=O.ORDER_ID)
LEFT OUTER JOIN PACKAGE P ON (I.ORDER_ID=P.ORDER_ID) AND (I.INVOICE_ID=P.INVOICE_ID)
LEFT OUTER JOIN ADDRESS ON (I.SHIP_ID = ADDRESS.ADDRESS_ID)
WHERE O.CUST_NUM = '0000075194'
AND I.BALANCE > 0
</source>

===Target invoices shipping to Canada===
<source lang="tsql">
Select Distinct I.* from Invoice I, Address A, Orderhdr O
where I.SHIP_ID = A.ADDRESS_ID
and A.COUNTRY = '001'
and I.order_id = O.order_id
</source>

===Target invoices with packages shipping via specific methods===
This is useful with Best Shipping since the order/invoice no longer has a shipping method or if you're trying to filter on the actual shipping choice used instead of the underlying service level (which is how the shipping method filters work normally)
<source lang="tSQL">
SELECT DISTINCT I.* FROM Invoice I, Package P, Orderhdr O
WHERE I.order_id = P.order_id and I.invoice_id = P.invoice_id
and I.order_id = O.order_id
and P.shipmethid in
(SELECT shipmethid FROM SHIPMETH
WHERE SEL_LETTER in ('C','UC'))
</source>

===Targets fulfilled invoices with a specific adcode===
Specifically that does not use a selected term and the order does not contain an item ending with M:
<source lang="tSQL">
SELECT DISTINCT I.* FROM INVOICE I, ORDERHDR O
WHERE I.order_id = O.order_id
AND O.adcode = ' HOMESHOW'
AND O.term_id <> '002'
AND I.fulfill_dt > '2010-01-01'
AND I.order_id|I.invoice_id NOT IN
(SELECT order_id|invoice_id
FROM itemsord
WHERE fulfill_dt > '2010-01-01'
AND prod_code LIKE '%M')
</source>

===Single Line Orders===
The technique used here to identify which invoice are single product is unusual and noteworthy. There is a join against a sub-select because a sub-select on its own is only useful when looking for a single field and in this case we need both order_id and invoice_id. The last line is optional and should only be used when targeting specific products.
<source lang="tSQL">
SELECT DISTINCT I.* FROM Invoice I
JOIN ORDERHDR O ON O.order_id = I.order_id
JOIN ITEMSORD T ON T.order_id = I.order_id AND T.invoice_id = I.invoice_id
JOIN (SELECT order_id, invoice_id FROM itemsord
GROUP BY ORDER_ID, Invoice_id
HAVING count(line_id) = 1) j ON j.order_id = I.order_id AND j.invoice_id = I.invoice_id
WHERE I.TRANS_TYPE <> 'R' --Excluding returns
AND T.PROD_CODE IN ('SUB1','SUB2','SUB3')
</source>

====Single Qty Item====
Similar to above, which is for single line orders but for any quantity ordered, the following looks for single quantity ordered as well. As above, the last line is optional and should only be used when targeting specific products.

<source lang="tSQL">
SELECT DISTINCT I.* FROM Invoice I
JOIN ORDERHDR O ON O.order_id = I.order_id
JOIN ITEMSORD T ON T.order_id = I.order_id
AND T.invoice_id = I.invoice_id
AND t.sent_qty =1
AND (t.ret_qty + t.cancel_qty) = 0
JOIN (SELECT order_id, invoice_id FROM itemsord
GROUP BY ORDER_ID, Invoice_id
HAVING COUNT(line_id) = 1) j ON j.order_id = I.order_id AND j.invoice_id = I.invoice_id
WHERE T.PROD_CODE IN ('SUB1','SUB2','SUB3')
</source>

===Invoices by State and Carrier===
We wrote this for invoice filtering by state. This shows the use of a sub-select that is not part of a join:
<source lang="tSQL">
SELECT DISTINCT I.* FROM Invoice I
JOIN Orderhdr O ON O.order_id = I.order_id
JOIN Address A ON A.ADDRESS_ID = I.SHIP_ID
WHERE A.STATE IN
('ME','NH','VT','MA','CT','RI','NJ','DE','MD','DC','NY','PA','VA','NC','SC','GA','TN','KY','WV','OH','AL')
AND O.SHIP_VIA IN (SELECT ship_code FROM SHIPPERS WHERE SHIPPER = 'UPS')
</source>

===Invoices using a specific shipping method AND have at least one item in a bin location range===
<source lang="tSQL">
SELECT DISTINCT I.* FROM INVOICE I
JOIN ORDERHDR O ON O.ORDER_ID = I.ORDER_ID
JOIN (
SELECT IO.INVOICE_ID, IO.ORDER_ID FROM SKUWARE S
JOIN ITEMSORD IO ON IO.SKU_ID = S.SKU_ID
WHERE REGEXP_SUBSTR(S.BINLOC,'\d+\.\d') BETWEEN 3.0 AND 3.9
GROUP BY IO.ORDER_ID, IO.INVOICE_ID, IO.WAREHOUSE
) BIN ON BIN.INVOICE_ID = I.INVOICE_ID AND BIN.ORDER_ID = I.ORDER_ID
WHERE I.SHIPMETH_USED = 'First Class Mail'
</source>

===Invoices using a specific shipping method AND have only items in a bin location range===
This assumes bin locations are numeric:

<source lang="tSQL">
SELECT DISTINCT I.* FROM INVOICE I
JOIN ORDERHDR O ON O.ORDER_ID = I.ORDER_ID
JOIN (SELECT IO.INVOICE_ID,
IO.ORDER_ID, IO.WAREHOUSE,
REGEXP_SUBSTR(S.BINLOC,'\d+\.*\d*') AS BINLOC_NUM,
COUNT(IO.ITEMID) AS ITEMS
FROM SKUWARE S JOIN ITEMSORD IO ON IO.SKU_ID = S.SKU_ID
GROUP BY IO.ORDER_ID, IO.INVOICE_ID, IO.WAREHOUSE, S.BINLOC
HAVING BINLOC_NUM BETWEEN 3.0 AND 3.9
) IC ON IC.ORDER_ID = I.ORDER_ID AND IC.INVOICE_ID = I.INVOICE_ID
WHERE IC.ITEMS = (
SELECT COUNT(*) FROM ITEMSORD IO
WHERE IO.ORDER_ID = I.ORDER_ID
AND IO.INVOICE_ID = I.INVOICE_ID
)
AND I.SHIPMETH_USED = 'First Class Mail'
</source>

=Related Articles=
*[[Compound Mail List Filters]]

Custom SQL Filters

2020-09-08T15:58:47Z

Russ horton: /* Mail list filter examples */

In addition to the standard invoice and mail list filter criteria provided in CMS, you also have the option to write your own SQL. This is useful for when you'd want to create a filter that is beyond the standard options available through the CMS interface.

It is important to note that when you select the 'Write Own SQL' checkbox, it supersedes all other criteria and becomes the only enabled option on the filter screen. You cannot combine it with other filter criteria. You can, however, customize a mail filter created in CMS.

In the Mail List Filter section you have the option of creating a filter using the checkboxes to get as close as you can to your desired filter. Once saved you would then click on View SQL to see the resulting SQL CMS has created based on the options selected. You cannot edit that SQL there but you can copy it and create a new filter with 'Write Own SQL' and paste/edit it there.

This can be very handy and is rather easy to do as, often times, the only modification desired is a change in Boolean values. For example, if you create a filter based on two customer description codes (CDC's) the default Boolean is 'OR'. In other words, customers will qualify for this filter if they have one code OR the other. If you only wanted customers who had both codes, you would create a custom filter, paste in the SQL from the original filter and change the OR to an AND.

Syntax is very important in these filters so if you are writing one from scratch, please pay attention to these examples for guidance on what your Selects should look like (namely the use of DISTINCT and which tables are being referenced):

=Mail List Filters=
==Requirements==
Every mail list filter must include (start with) at least the following:
<source lang="tsql">
SELECT DISTINCT C.*
FROM CUST C
WHERE ...
</source>

==Mail list filter examples==
NOTE: When writing your own SQL keep in mind if you are going to be using these statements in [[Compound Mail List Filters]], you will need to return C.ID, not C.* This makes these individual filters suitable for use only as components for Compound filters. They can no longer be used on their own. Our recommendation is to label them as compound filter components. Like COMP_Products_By_Date and COMP_Not_Select_Products. Doing this you will know not to use them by themselves. To use the filters by themselves and to combine different filters together, you have to use joins and not compound filters.

===Products Purchased===
Target customers based on products fulfilled within a date range (3 examples) and thus excludes unfulfilled back orders and future ships. Date range is based off of the fulfill date. These filters also exclude fully returned/canceled items.

*In a Date Range
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C, ITEMSORD I
WHERE (I.PROD_CODE = '1'
AND I.FULFILL_DT between '2017-01-31' and '2017-03-31'
AND ((I.CUR_RETURN + I.CUR_CANCEL) < I.CUR_SENT))
AND (I.CUST_NUM = C.ID)
</source>

*Greater than a specified date
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C, ITEMSORD I
WHERE (I.PROD_CODE = '1'
AND I.FULFILL_DT > '2017-01-31'
AND ((I.CUR_RETURN + I.CUR_CANCEL) < I.CUR_SENT))
AND (I.CUST_NUM = C.ID)
</source>

*Ordered in the last 30 days
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C, ITEMSORD I
WHERE (I.PROD_CODE = '1'
AND I.FULFILL_DT > (TODAY(*) - 30)
AND ((I.CUR_RETURN + I.CUR_CANCEL) < I.CUR_SENT))
AND (I.CUST_NUM = C.ID)
</source>

*Sold by a specific salesperson, only shipped and not returned (no date range)
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C INNER JOIN orderhdr o ON c.id = o.cust_num
INNER JOIN itemsord i ON o.order_id = i.order_id
WHERE o.proforma <> 1
AND o.tempsave <> 1
AND i.status > 5
AND i.order_qty > (i.cur_return + cur_cancel)
AND (i.prod_code = 'PRODUCT CODE'
AND o.SALES_ID = 'Salesperson Username')
</source>

*Customers that bought from a specified list of products in a selected date range. Exclude if they bought any from another list of products or if the customer is set to Do Not Mail Catalog.
(this query has to look at your entire order history and will take a long time to run)
<source lang='tsql'>
SELECT DISTINCT C.* FROM CUST C
LEFT JOIN CUSTFLAGS CF ON CF.ID = C.ID AND CF.FLAG_ID = 1
JOIN ITEMSORD I ON I.CUST_NUM = C.ID
WHERE I.FULFILL_DT BETWEEN '2012-02-01' AND '2013-03-07'
AND (I.CUR_RETURN + I.CUR_CANCEL) < I.CUR_SENT
AND I.PROD_CODE IN ('PRODCODE-A','PRODCODE-B')
-- FLAG_ID <> 1 by matching on null with the left join
AND CF.FLAG_ID IS NULL
AND C.ID NOT IN
(SELECT IO.CUST_NUM FROM ITEMSORD IO WHERE IO.PROD_CODE IN (
-- Comma delimited list of product codes to match for exclusion from the customer list
'PRODCODE-X','PRODCODE-Y','PRODCODE-Z')
GROUP BY IO.CUST_NUM
-- End customer exclusion list
);
</source>

*Customers that bought a specific product that was shipped since a specific date that hasn't been returned and that customer has a viable email address.
<source lang='tsql'>
SELECT DISTINCT C.*
FROM CUST C
Join Itemsord t on t.cust_num = c.ID
Join Invoice i on i.order_id = t.order_id and i.invoice_id = t.invoice_id
WHERE (t.PROD_CODE = 'XXXXXX'
and i.SHIPPED_DT between '2017-07-31' and '2017-08-31'
AND ((t.SENT_QTY > t.RET_QTY - t.CANCEL_QTY)))
AND datalength(LTRIM(RTRIM([EMAIL]))) - datalength(REPLACE(LTRIM(RTRIM([EMAIL])),'@','')) = 1 AND (CHARINDEX('.@',[EMAIL]) = 0 AND CHARINDEX('..',[EMAIL]) = 0)
</source>

===[[CMS Customer Filter for customers with a specific item on Back Order]]===
Click the title link to redirect to an article specifically on this topic.

===[[Targeting Catalog Requestors]]===
Click the title link to redirect to an article specifically on this topic.

===Customers with Unshipped Orders in a Date Range===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
LEFT OUTER JOIN ORDERHDR O ON (C.ID = O.CUST_NUM)
WHERE
((O.order_dt BETWEEN '2012-05-18' AND '2013-09-18')
AND (isnull(o.shipped_dt,'1899-12-30') = '1899-12-30'))
AND (C.EMAIL <> '')
</source>

===By First Order Date===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE
(C.FIRST_DATE BETWEEN '2013/08/15' AND '2013/08/15')
</source>

===Phone number Area code===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE
(C.ID IN (SELECT CUST_NUM FROM PHONES
where phone_num like
'(297%'
or phone_num like
'297'
or phone_num like
'1297'
or phone_num like
'1-297'
))
</source>

===Customers having more than one Customer Description Code===
In CMS it is easy to find customers who have any one code, or one of several, but you'll need custom SQL like the following to find customers who must have more than one of a list of codes to qualify.
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE C.ID IN (
SELECT CUST_NUM FROM CUSTDESC
WHERE CUSDESKE in ('0525','0600')
GROUP BY CUST_NUM
HAVING COUNT(CUST_NUM) >= 2 -- 2 = the number of values to find
)
</source>

*Change the cusdeske values to correspond to the desired customer description codes (CDC) per the CUSDESCO table
*Change the integer in the last line to indicate the number of CDC matches required

===Customers with a Company Name===

<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE C.COMPANY <> ''
</source>

===Last Modified===
The Last Modified field was added in CMS 8.0 but does not yet have a corresponding mail filter option. Here are a couple of examples of how you can build this into your filters:
*Last Modified in a range of dates:
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE (C.LAST_UPDAT BETWEEN '2011/05/02' AND '2012/05/02')
</source>
Change the dates as needed.

*Last Modified in the last 180 days:
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE (C.LAST_UPDAT > (TODAY(*) - 180))
</source>
Change 180 to whatever number of days back is desired.

===All Recipients for a Customer (e.g. Amazon)===
If you are processing orders with Amazon or similar partner, you'll only get shipping addresses and not billing information from them since Amazon handles all of the payments. As such these orders will import into CMS with Amazon as the customer and always attach themselves to your Amazon customer record. If you have the option enabled in CMS Order Entry Options, new customer records will also be created for each ship-to. It may be helpful to be able to identify those ship-to customer records. This might be to tag them with a customer description code, exclude from an upcoming mailing, etc. This SQL can be used as a mail list filter to find those recipient customer records that have ordered through Amazon (or whoever your orders are coming from.)

<source lang="tSQL">
SELECT DISTINCT C.*
From CUST c
where C.ID in
(Select a.cust_num
From Address a
Join recipient r on r.address_id = a.address_id
Join recipient_order ro on ro.recipient_id = r.recipient_id
Join orderhdr o on o.order_id = ro.order_idWhere o.cust_num = '0000518128')
</source>

Change the customer number in the last line to match your billing account for Amazon. Zero pad to ten total characters as shown in the above example.

===Orders Placed from Selected Order Sources===
<source lang="tSQL">
SELECT DISTINCT c.*
FROM CUST c
Join ORDERHDR o on o.cust_num = c.ID
Join ORDERSRC s on s.ordersrc_id = o.order_src
Where (o.ORDER_DT BETWEEN '2016-01-31' AND '2017-10-31'
AND o.CANCELLED = 0
and (s.name = 'Phoned In'
or s.name = 'Mailed In'))
</source>

====Amazon Recipients====
Similar to the above, this is targetting a specific order source but, since you are really drop-shipping for Amazon, Amazon is your customer...so all of the orders fall under the Amazon customer record in your mail list. If you have CMS configured to save recipients as new customers though, CMS will have customer records for each customer that ordered via Amazon. The following query will target those recipients:

<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
Where c.ship_id > 0
and c.ship_id in
(select address_id from Recipient r
JOIN Recipient_order ro on r.recipient_id = ro.recipient_id
JOIN ORDERHDR o on o.order_id = ro.order_id
where o.order_src = 15)
</source>
Noting that you'll need to change the last line (15) to match whatever the order source ID is for the order source you're targeting (see the ORDERSRC table for this.)

===Customers with orders having a specific Referral Code===

<source lang="tSQL">
SELECT DISTINCT c.*
FROM CUST c
Join ORDERHDR o ON o.cust_num = c.ID
WHERE (o.ORDER_DT BETWEEN '2016-01-31' AND '2017-06-30')
AND o.referral_code = 'XXXX'
</source>

===Invoice created in a date range with a captured credit card but invoice is unshipped===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C, INVOICE I
JOIN Payledger p on p.order_id = i.order_id
and p.invoice_id = i.invoice_id
JOIN chargeinfo r on p.payid = r.payid
WHERE I.ORDER_DT between '2012-08-31' and '2013-02-28'
AND I.SHIPPED_FL = '0'
AND r.edc = 1
AND (I.CUST_NUM = C.ID)
</source>

===Customers with a declined credit card in last 30 days===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
JOIN paylist l on l.ID = C.ID
JOIN paytypes t on t.pay_type = l.pay_type
Where l.badpayment = '1'
AND l.DELETED = '0'
AND t.credit_car = '1'
AND l.createdate > (TODAY(*)-30)
</source>

===Filter based on one of the customer user defined fields where the value is greater than X===
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE (REGEXP_SUBSTR(C.USERCODE1,'\d+\.*\d*') > 12.4)
</source>
*This method allows you to perform a greater or less than query on a user field which is not explicitly defined as numeric. That said, this filter will fail if you have any non-numeric values in the corresponding user-defined field in any of the customer records.
*It is important to understand that any time you are running a "greater than" or "less than" operator against a numeric value you must not use quotes. Otherwise SQL will interpret that as a string comparison. And string comparing numeric values will not be accurate.

===U.S. and Canadian customers with first contact date, catalog request, or order in date range===
The first half of the SQL is to include based on any of the contact dates AND that they are in U.S. or Canada. The second half (starting with AND NOT) is the exclude portion of the statement, in this case based on specific customer description code, customer flag, or or order's adcodes.
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
WHERE C.COUNTRY < 2
AND (
(C.FIRST_CONTACT BETWEEN '2012-01-01' AND '2015-09-30')
OR EXISTS (SELECT 1 FROM CUSTHIST WHERE CUSTHIST.CUST_NUM = C.ID AND ENTRYDATE > '2012-01-01')
OR EXISTS (SELECT 1 FROM TODO WHERE TODO.TYPE = '05' AND TODO.VOID = 0 AND TODO.DATE_CREAT > '2012-01-01' AND TODO.RELATES_TO = C.ID)
OR (C.LAST_INVOI BETWEEN '2008/01/01' AND '2015/10/12')
) AND NOT EXISTS ( SELECT 1 FROM CUST C2
LEFT OUTER JOIN CUSTDESC ON C2.ID = CUSTDESC.CUST_NUM
LEFT OUTER JOIN ORDERHDR ON C2.ID = ORDERHDR.CUST_NUM
LEFT OUTER JOIN CUSTFLAGS CF ON CF.ID = C2.ID
WHERE (
CUSTDESC.CUSDESKE = '0004'
OR ORDERHDR.ADCODE = 'p-etch'
OR ORDERHDR.ADCODE = 'wwwg'
OR CF.FLAG_ID = 1
) AND C2.ID = C.ID
)
</source>

===Customers with a specific term that have no spending in period==
Here we're looking for customers that you have on terms but have not spent anything in a given time period. Adjust date ranges, spending amounts, and the term_id in the SQL to suit.
<source lang="tSQL">
SELECT DISTINCT C.*
FROM CUST C
LEFT OUTER JOIN ORDERHDR ON (C.ID = ORDERHDR.CUST_NUM)
WHERE c.term_id = '002'
and not fbCustSpendingInPeriod(c.id,'2018/09/08','2020/09/08',1,99999999) =1
</source>

=Invoice filters=
==Invoice Filter requirements==
Every invoice filter must include (start with) at least the following:
<source lang="tsql">
SELECT DISTINCT I.* FROM INVOICE I
JOIN ORDERHDR O ON (I.ORDER_ID=O.ORDER_ID)
LEFT OUTER JOIN PACKAGE P ON (I.ORDER_ID=P.ORDER_ID) AND (I.INVOICE_ID=P.INVOICE_ID)
LEFT OUTER JOIN ADDRESS ON (I.SHIP_ID = ADDRESS.ADDRESS_ID)
WHERE...
</source>

==Examples==
===Target invoices whose item total is greater than $X===
<source lang="tsql">
SELECT DISTINCT I.* FROM Invoice I, Orderhdr O
WHERE I.ITEM_TOT > 300
and I.order_id = O.order_id
</source>
Modify the 300 in this example to represent the desired item total threshold. This item total take into account line and order level discounts but does not include S&H, taxes, or other order level charges.

===Target a single customer and any of their invoices with a balance===
<source lang="tsql">
SELECT DISTINCT I.* FROM INVOICE I
JOIN ORDERHDR O ON (I.ORDER_ID=O.ORDER_ID)
LEFT OUTER JOIN PACKAGE P ON (I.ORDER_ID=P.ORDER_ID) AND (I.INVOICE_ID=P.INVOICE_ID)
LEFT OUTER JOIN ADDRESS ON (I.SHIP_ID = ADDRESS.ADDRESS_ID)
WHERE O.CUST_NUM = '0000075194'
AND I.BALANCE > 0
</source>

===Target invoices shipping to Canada===
<source lang="tsql">
Select Distinct I.* from Invoice I, Address A, Orderhdr O
where I.SHIP_ID = A.ADDRESS_ID
and A.COUNTRY = '001'
and I.order_id = O.order_id
</source>

===Target invoices with packages shipping via specific methods===
This is useful with Best Shipping since the order/invoice no longer has a shipping method or if you're trying to filter on the actual shipping choice used instead of the underlying service level (which is how the shipping method filters work normally)
<source lang="tSQL">
SELECT DISTINCT I.* FROM Invoice I, Package P, Orderhdr O
WHERE I.order_id = P.order_id and I.invoice_id = P.invoice_id
and I.order_id = O.order_id
and P.shipmethid in
(SELECT shipmethid FROM SHIPMETH
WHERE SEL_LETTER in ('C','UC'))
</source>

===Targets fulfilled invoices with a specific adcode===
Specifically that does not use a selected term and the order does not contain an item ending with M:
<source lang="tSQL">
SELECT DISTINCT I.* FROM INVOICE I, ORDERHDR O
WHERE I.order_id = O.order_id
AND O.adcode = ' HOMESHOW'
AND O.term_id <> '002'
AND I.fulfill_dt > '2010-01-01'
AND I.order_id|I.invoice_id NOT IN
(SELECT order_id|invoice_id
FROM itemsord
WHERE fulfill_dt > '2010-01-01'
AND prod_code LIKE '%M')
</source>

===Single Line Orders===
The technique used here to identify which invoice are single product is unusual and noteworthy. There is a join against a sub-select because a sub-select on its own is only useful when looking for a single field and in this case we need both order_id and invoice_id. The last line is optional and should only be used when targeting specific products.
<source lang="tSQL">
SELECT DISTINCT I.* FROM Invoice I
JOIN ORDERHDR O ON O.order_id = I.order_id
JOIN ITEMSORD T ON T.order_id = I.order_id AND T.invoice_id = I.invoice_id
JOIN (SELECT order_id, invoice_id FROM itemsord
GROUP BY ORDER_ID, Invoice_id
HAVING count(line_id) = 1) j ON j.order_id = I.order_id AND j.invoice_id = I.invoice_id
WHERE I.TRANS_TYPE <> 'R' --Excluding returns
AND T.PROD_CODE IN ('SUB1','SUB2','SUB3')
</source>

====Single Qty Item====
Similar to above, which is for single line orders but for any quantity ordered, the following looks for single quantity ordered as well. As above, the last line is optional and should only be used when targeting specific products.

<source lang="tSQL">
SELECT DISTINCT I.* FROM Invoice I
JOIN ORDERHDR O ON O.order_id = I.order_id
JOIN ITEMSORD T ON T.order_id = I.order_id
AND T.invoice_id = I.invoice_id
AND t.sent_qty =1
AND (t.ret_qty + t.cancel_qty) = 0
JOIN (SELECT order_id, invoice_id FROM itemsord
GROUP BY ORDER_ID, Invoice_id
HAVING COUNT(line_id) = 1) j ON j.order_id = I.order_id AND j.invoice_id = I.invoice_id
WHERE T.PROD_CODE IN ('SUB1','SUB2','SUB3')
</source>

===Invoices by State and Carrier===
We wrote this for invoice filtering by state. This shows the use of a sub-select that is not part of a join:
<source lang="tSQL">
SELECT DISTINCT I.* FROM Invoice I
JOIN Orderhdr O ON O.order_id = I.order_id
JOIN Address A ON A.ADDRESS_ID = I.SHIP_ID
WHERE A.STATE IN
('ME','NH','VT','MA','CT','RI','NJ','DE','MD','DC','NY','PA','VA','NC','SC','GA','TN','KY','WV','OH','AL')
AND O.SHIP_VIA IN (SELECT ship_code FROM SHIPPERS WHERE SHIPPER = 'UPS')
</source>

===Invoices using a specific shipping method AND have at least one item in a bin location range===
<source lang="tSQL">
SELECT DISTINCT I.* FROM INVOICE I
JOIN ORDERHDR O ON O.ORDER_ID = I.ORDER_ID
JOIN (
SELECT IO.INVOICE_ID, IO.ORDER_ID FROM SKUWARE S
JOIN ITEMSORD IO ON IO.SKU_ID = S.SKU_ID
WHERE REGEXP_SUBSTR(S.BINLOC,'\d+\.\d') BETWEEN 3.0 AND 3.9
GROUP BY IO.ORDER_ID, IO.INVOICE_ID, IO.WAREHOUSE
) BIN ON BIN.INVOICE_ID = I.INVOICE_ID AND BIN.ORDER_ID = I.ORDER_ID
WHERE I.SHIPMETH_USED = 'First Class Mail'
</source>

===Invoices using a specific shipping method AND have only items in a bin location range===
This assumes bin locations are numeric:

<source lang="tSQL">
SELECT DISTINCT I.* FROM INVOICE I
JOIN ORDERHDR O ON O.ORDER_ID = I.ORDER_ID
JOIN (SELECT IO.INVOICE_ID,
IO.ORDER_ID, IO.WAREHOUSE,
REGEXP_SUBSTR(S.BINLOC,'\d+\.*\d*') AS BINLOC_NUM,
COUNT(IO.ITEMID) AS ITEMS
FROM SKUWARE S JOIN ITEMSORD IO ON IO.SKU_ID = S.SKU_ID
GROUP BY IO.ORDER_ID, IO.INVOICE_ID, IO.WAREHOUSE, S.BINLOC
HAVING BINLOC_NUM BETWEEN 3.0 AND 3.9
) IC ON IC.ORDER_ID = I.ORDER_ID AND IC.INVOICE_ID = I.INVOICE_ID
WHERE IC.ITEMS = (
SELECT COUNT(*) FROM ITEMSORD IO
WHERE IO.ORDER_ID = I.ORDER_ID
AND IO.INVOICE_ID = I.INVOICE_ID
)
AND I.SHIPMETH_USED = 'First Class Mail'
</source>

=Related Articles=
*[[Compound Mail List Filters]]

Creating a Database Backup

2020-08-07T16:37:37Z

Russ horton:

=Overview=
This article covers how to create a Database backup in CMS 8.0 or later.

==Setting up CMS to create a daily backup==

To have CMS automatically create a backup of your database to a specified folder, please follow the instructions below.

#Log into your PCI Administration account
#Select the PCI Administration drop-down menu
#Select Administration
#Select Daily Backup
#Select 'Perform the daily backup at the time and in the folder specified below'
#Under Time to Backup, set the time you wish the backup to be created.
#Check mark 'Truncate the log' (see below)
#Under 'Folder in which to create backup image' select Browse
#Highlight the folder you wish to create the backup in (Please note: The Sybase service, which by default runs as LocalSystem, cannot access network drives, only local.)
#Select Ok
#Select Save these settings now.

CMS will now create a backup to that specified folder, every day, at the time you have specified.

===Important Info on Backup Routines===
Your database is a single file and contains all of your data. This file is locked by the Sybase database server, however, and cannot be copied, moved, deleted, or backed up. Using the above backup schedule allows Sybase to create a copy of its live database without having to shut down the database server. This also allows for 24/7 operation without having to stop to facilitate a backup.

The backup of your database is almost all you need in order to recover from a catastrophe like a failed drive, stolen server, or office fire (we've seen all of these.) Make sure you're backing up nightly and taking/uploading copies offsite regularly. The rest of your CMS install can be reinstalled in minutes, drop your backup in, and your back in business. No need to backup or protect the rest of the files in the NewHaven Software server share. If, however, you are storing your own files under our directory, please consider if they should be backed up.

As of CMS TEN, there is one exception to the above. You'll also want a backup copy of your CMSdbo.ini file. This file does not change daily but it can change every 90 days or when a CMS update is installed. This file contains an encrypted portion of a partial password that CMS uses to access the database. Without this file, CMS cannot run and it is unique to you and your database. Be sure to also have a copy of this in your offsite backups and as part of any backup restoration procedure. If you do not have this file and need to restore a backup, the database file will have to be sent to NewHaven Software where the password can be reset. This process is time-consuming and is not part of standard support.

====Truncating the Log====
For normal operation, we recommend that you run with the Truncate option enabled. Truncation keeps the size of your log file down to only include database changes since your last backup. This will save space on your server and potentially improving performance. Typically you'd only run with truncation disabled if you're working with NewHaven Software Support to troubleshoot a problem that cannot be replicated and need to build up a log file over time.

Truncation occurs during the scheduled backup event but does not occur when creating an immediate backup (see below.)

====Training Database====
If you are running a Training database, chances are you do not need a backup of this and the daily backup should be disabled. If you decide that you want to backup the Training database as well, please do so to a different directory and backup time than your production database to avoid conflicts (the training database uses the same log file name.)

==How to have CMS create an immediate backup of your database==

#Log into your PCI Administration account
#Select the PCI Administration drop-down menu
#Select Administration
#Select Daily Backup
#Under 'Folder in which to create backup image' select Browse
#Highlight the folder you wish to create the backup in (Please note: CMS can NOT Create a backup to a networked drive, only local drives)
#Select Ok
#Select 'Immediately create a Backup Image in the specified folder'

CMS will create a backup to the folder you have specified.

Creating a Database Backup

2020-08-07T16:20:18Z

Russ horton:

=Overview=
This article covers how to create a Database backup in CMS 8.0 or later.

==Setting up CMS to create a daily backup==

To have CMS automatically create a backup of your database to a specified folder, please follow the instructions below.

#Log into your PCI Administration account
#Select the PCI Administration drop-down menu
#Select Administration
#Select Daily Backup
#Select 'Perform the daily backup at the time and in the folder specified below'
#Under Time to Backup, set the time you wish the backup to be created.
#Check mark 'Truncate the log' (see below)
#Under 'Folder in which to create backup image' select Browse
#Highlight the folder you wish to create the backup in (Please note: The Sybase service, which by default runs as LocalSystem, cannot access network drives, only local.)
#Select Ok
#Select Save these settings now.

CMS will now create a backup to that specified folder, every day, at the time you have specified.

===Important Info on Backup Routines===
Your database is a single file and contains all of your data. This file is locked by the Sybase database server, however, and cannot be copied, moved, deleted, or backed up. Using the above backup schedule allows Sybase to create a copy of its live database without having to shut down the database server. This also allows for 24/7 operation without having to stop to facilitate a backup.

The backup of your database is almost all you need in order to recover from a catastrophe like a failed drive, stolen server, or office fire (we've seen all of these.) Make sure you're backing up nightly and taking/uploading copies offsite regularly. The rest of your CMS install can be reinstalled in minutes, drop your backup in, and your back in business. No need to backup or protect the rest of the files in the NewHaven Software server share. If, however, you are storing your own files under our directory, please consider if they should be backed up.

As of CMS TEN, there is one exception to the above. You'll also want a backup copy of your CMSdbo.ini file. This file does not change daily but it can change every 90 days or when a CMS update is installed. This file contains an encrypted portion of a partial password that CMS uses to access the database. Without this file, CMS cannot run and it is unique to you and your database. Be sure to also have a copy of this in your offsite backups and as part of any backup restoration procedure. If you do not have this file and need to restore a backup, the database file will have to be sent to NewHaven Software where the password can be reset. This process is time-consuming and is not part of standard support.

====Truncating the Log====
For normal operation, we recommend that you run with the Truncate option enabled. Truncation keeps the size of your log file down to only include database changes since your last backup. This will save space on your server and potentially improving performance. Typically you'd only run with truncation disabled if you're working with NewHaven Software Support to troubleshoot a problem that cannot be replicated and need to build up a log file over time.

Truncation occurs during the scheduled backup event but does not occur when creating an immediate backup (see below.)

==How to have CMS create an immediate backup of your database==

#Log into your PCI Administration account
#Select the PCI Administration drop-down menu
#Select Administration
#Select Daily Backup
#Under 'Folder in which to create backup image' select Browse
#Highlight the folder you wish to create the backup in (Please note: CMS can NOT Create a backup to a networked drive, only local drives)
#Select Ok
#Select 'Immediately create a Backup Image in the specified folder'

CMS will create a backup to the folder you have specified.

Creating an ODBC connection

2020-08-06T17:31:27Z

Russ horton:

=Overview=
CMS connects to its database via an [http://en.wikipedia.org/wiki/ODBC ODBC] connection. CMS creates the necessary ODBC definitions in Windows on the fly when you launch CMS. It uses information from the file CMSdb.ini in your NewHaven Software directory (plus a number of other default settings) to do this.

ODBC is also the connection method that would be used by any other application you may wish to connect to your database. Examples might include UPS Worldship, FedEx Ship Manager, Microsoft Access, Crystal Reports, Bartender (bar code printing), or one of many other applications that need access to your CMS data.

This article details the instructions for hand-creating an ODBC connection to your CMS Database.

== Prepare to create your ODBC connection ==

#These instructions only pertain to creating an ODBC connection for Sybase 12. These connections only work with CMS version 8.x and above.
#You will need the Sybase 12 ODBC driver installed on your system. If you do not have this driver you can install it by running a CMS Workstation install. To do this review the instructions in the link below:

http://wiki.newhavensoftware.com/index.php/Workstation_Install

==Open the correct ODBC Manager==

Before creating an ODBC connection you will need to make sure you open the 32 bit ODBC manager (It does not matter if you are on a 64 bit system you will still need to use the 32 bit manager). You can access this from the Start Menu > Programs > NewHaven Software > Data Sources (ODBC). For more detailed information on this please see the link below:

http://wiki.newhavensoftware.com/index.php/64-bit_vs._32-bit_ODBC_Drivers

=Creating the ODBC connection=

[[image:ODBC1.png]]

[[image:ODBC2.png]]

[[image:ODBC3.png]]

[[image:ODBC4.png]]

[[image:ODBC5.png]]

[[image:ODBC6.png]]
===Optional step if you find Crystal is throwing errors when running but CMS is fine:===
[[image:ODBC7.png]]

[[image:ODBC8.png]]

[[image:ODBC9.png]]

 

After following these instructions you now haven an active ODBC connection to your CMS database.

Moving CMS to a New Server

2020-07-07T16:38:58Z

Russ horton: /* Step 13 - Connecting Workstations to CMS */

=Overview=
This article details the instructions for moving your CMS installation from an old server to a new server including moving your data.

This process is a large undertaking that will require CMS to be down during the move. As a result please inform NewHaven Support of the day you plan to do the server migration. This is so we may either set up a appointment with you to guide you through the process, or at least ensure we have staff available to you in case you find you require assistance.

The following instructions have 4 major themes to them:

# Preparing to move CMS to the new System.
# Installing CMS on the new System.
# Moving the old Database to the new System.
# Updating the old Database to the new version of CMS

The above list is to help outline what exactly the following instructions are attempting to accomplish and to give you an overview of the process you are about to undertake.

=Moving CMS on to a new server=
== Step 1 - Prerequisites==
CRITICAL! ALL USERS MUST EXIT CMS PRIOR TO INSTALLING CMS SERVER ON ANOTHER COMPUTER!

CRITICAL! YOU MUST BE LOGGED IN AS THE COMPUTER ADMINISTRATOR OR A USER THAT IS A MEMBER OF THE ADMINISTRATORS GROUP!

==Step 2 - Make a backup image of CMS Database files==
We need to create a backup of your current live database to transfer to the new server.
To create a backup of your database please review the link below:

http://wiki.newhavensoftware.com/index.php/Creating_a_Database_Backup

== Step 3 - Stop and Disable the Sybase service on your old system (Skip this step if running CMS Solo) ==
Next we will need to disable the Sybase service on your old system. This step is done to ensure there is no conflict with the database services when we do the install on the new system.

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#How_to_Stop_the_Sybase_service_if_running_CMS_8.0_or_later

== Step 4 - Disable sharing on the NewHaven Software folder ==
This is to ensure we do not accidentally connect workstations to the old server after the migration is complete.

For information on how to do this please visit http://wiki.newhavensoftware.com/index.php/Folder_sharing_in_Windows

== Step 5 - Install CMS Server on the new computer. ==

To do so please follow the information in the link below.
http://wiki.newhavensoftware.com/index.php/Server_Update

== Step 6 - Stopping the Sybase service on the new computer (Skip this step if running CMS Solo) ==
We need to stop the Sybase service now to transfer in the copy of the database from the old server.

To do so please follow the links below:

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#CMS_8.0_or_later

== Step 7 - Copying over your Database and log file to the new system ==
#Create a new folder in the NewHaven Software\Data folder. Name it CLEAN.
#There should be two files in the NewHaven Software\Data\ ( Your Database Name) folder; one with a .db extension and one with a .log extension. Move both of these files into the NewHaven Software\Data\Clean folder you just created.
#Copy the .db and .log file from the old CMS Server computer into the NewHaven Software\Data\ (Your Database Name) folder on your new CMS Server computer.

== Step 8 - Copying over the CMSDBO.ini file and Custom Reports ==
We now need to copy over the CMSDBO.ini file to ensure CMS is able to start, as well as any custom reports.

# Check the NewHaven Software folder on the old server, see if there is a file present called CMSDBO.ini, if it is not there skip the next step.
# If this file is present please copy and move it into the NewHaven Software folder on your new system.
# Also if you have any custom reports please make sure to move them to the new server as well.

== Step 9 - Restart the Sybase service on the new computer (Skip this step if running CMS Solo) ==
You will now need to stop the Sybase service on the new computer. To do so please follow the links below:

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#How_to_Start_the_Sybase_service_if_running_CMS_8.0_or_later

== Step 10 - Log into CMS ==
Log into CMS and confirm it is working. If you get a database mismatch error message, you will need to rerun the setup and reboot the computer in order to sync up the CMS application and database. To do so please follow the instructions in http://wiki.newhavensoftware.com/index.php/Server_Update

== Step 11 - Check your backup ==

Check your CMS backup settings in to ensure the path that it is using to backup its files is still valid on this server. To access this please follow the information in the link below:

http://wiki.newhavensoftware.com/index.php/Creating_a_Database_Backup

== Step 12 - Sharing the NewHaven Software folder ==
Once you confirm CMS is working on the new installation, you can share out the NewHaven Software folder so your workstations are able to connect to it. For information on how to do this please visit http://wiki.newhavensoftware.com/index.php/Folder_sharing_in_Windows

== Step 13 - Connecting Workstations to CMS (Skip this step if running CMS Solo) ==
If the server is on the same network as your old server. All you need to do is remap the NewHaven Software shared drive on the workstations to the new server. For information on how to do that please review the video below:
http://youtu.be/dBbd94k7b0A

If these workstations are on a NEW network along with the server, or you are also installing new workstations, please follow the link below:
http://wiki.newhavensoftware.com/index.php/Workstation_Install

NOTE: Workstations must be on the same subnet as the server for CMS to be able to detect and connect to its database server. If this is not reasonable to do, please contact us for additional configuration options.

== Step 14 - Removing CMS from the old system ==
Uninstall CMS Server from the old computer to ensure the potentially conflicting Sybase service is removed and that everyone is running CMS from the same directory on the new CMS Server computer.

== Step 15 - Updating CMS to the latest version ==

At this point if you need to update CMS to the latest version, please follow the information in the link below:
http://wiki.newhavensoftware.com/index.php/Server_Update

Moving CMS to a New Server

2020-07-07T16:38:46Z

Russ horton: /* Step 9 - Restart the Sybase service on the new computer */

=Overview=
This article details the instructions for moving your CMS installation from an old server to a new server including moving your data.

This process is a large undertaking that will require CMS to be down during the move. As a result please inform NewHaven Support of the day you plan to do the server migration. This is so we may either set up a appointment with you to guide you through the process, or at least ensure we have staff available to you in case you find you require assistance.

The following instructions have 4 major themes to them:

# Preparing to move CMS to the new System.
# Installing CMS on the new System.
# Moving the old Database to the new System.
# Updating the old Database to the new version of CMS

The above list is to help outline what exactly the following instructions are attempting to accomplish and to give you an overview of the process you are about to undertake.

=Moving CMS on to a new server=
== Step 1 - Prerequisites==
CRITICAL! ALL USERS MUST EXIT CMS PRIOR TO INSTALLING CMS SERVER ON ANOTHER COMPUTER!

CRITICAL! YOU MUST BE LOGGED IN AS THE COMPUTER ADMINISTRATOR OR A USER THAT IS A MEMBER OF THE ADMINISTRATORS GROUP!

==Step 2 - Make a backup image of CMS Database files==
We need to create a backup of your current live database to transfer to the new server.
To create a backup of your database please review the link below:

http://wiki.newhavensoftware.com/index.php/Creating_a_Database_Backup

== Step 3 - Stop and Disable the Sybase service on your old system (Skip this step if running CMS Solo) ==
Next we will need to disable the Sybase service on your old system. This step is done to ensure there is no conflict with the database services when we do the install on the new system.

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#How_to_Stop_the_Sybase_service_if_running_CMS_8.0_or_later

== Step 4 - Disable sharing on the NewHaven Software folder ==
This is to ensure we do not accidentally connect workstations to the old server after the migration is complete.

For information on how to do this please visit http://wiki.newhavensoftware.com/index.php/Folder_sharing_in_Windows

== Step 5 - Install CMS Server on the new computer. ==

To do so please follow the information in the link below.
http://wiki.newhavensoftware.com/index.php/Server_Update

== Step 6 - Stopping the Sybase service on the new computer (Skip this step if running CMS Solo) ==
We need to stop the Sybase service now to transfer in the copy of the database from the old server.

To do so please follow the links below:

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#CMS_8.0_or_later

== Step 7 - Copying over your Database and log file to the new system ==
#Create a new folder in the NewHaven Software\Data folder. Name it CLEAN.
#There should be two files in the NewHaven Software\Data\ ( Your Database Name) folder; one with a .db extension and one with a .log extension. Move both of these files into the NewHaven Software\Data\Clean folder you just created.
#Copy the .db and .log file from the old CMS Server computer into the NewHaven Software\Data\ (Your Database Name) folder on your new CMS Server computer.

== Step 8 - Copying over the CMSDBO.ini file and Custom Reports ==
We now need to copy over the CMSDBO.ini file to ensure CMS is able to start, as well as any custom reports.

# Check the NewHaven Software folder on the old server, see if there is a file present called CMSDBO.ini, if it is not there skip the next step.
# If this file is present please copy and move it into the NewHaven Software folder on your new system.
# Also if you have any custom reports please make sure to move them to the new server as well.

== Step 9 - Restart the Sybase service on the new computer (Skip this step if running CMS Solo) ==
You will now need to stop the Sybase service on the new computer. To do so please follow the links below:

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#How_to_Start_the_Sybase_service_if_running_CMS_8.0_or_later

== Step 10 - Log into CMS ==
Log into CMS and confirm it is working. If you get a database mismatch error message, you will need to rerun the setup and reboot the computer in order to sync up the CMS application and database. To do so please follow the instructions in http://wiki.newhavensoftware.com/index.php/Server_Update

== Step 11 - Check your backup ==

Check your CMS backup settings in to ensure the path that it is using to backup its files is still valid on this server. To access this please follow the information in the link below:

http://wiki.newhavensoftware.com/index.php/Creating_a_Database_Backup

== Step 12 - Sharing the NewHaven Software folder ==
Once you confirm CMS is working on the new installation, you can share out the NewHaven Software folder so your workstations are able to connect to it. For information on how to do this please visit http://wiki.newhavensoftware.com/index.php/Folder_sharing_in_Windows

== Step 13 - Connecting Workstations to CMS ==
If the server is on the same network as your old server. All you need to do is remap the NewHaven Software shared drive on the workstations to the new server. For information on how to do that please review the video below:
http://youtu.be/dBbd94k7b0A

If these workstations are on a NEW network along with the server, or you are also installing new workstations, please follow the link below:
http://wiki.newhavensoftware.com/index.php/Workstation_Install

NOTE: Workstations must be on the same subnet as the server for CMS to be able to detect and connect to its database server. If this is not reasonable to do, please contact us for additional configuration options.

== Step 14 - Removing CMS from the old system ==
Uninstall CMS Server from the old computer to ensure the potentially conflicting Sybase service is removed and that everyone is running CMS from the same directory on the new CMS Server computer.

== Step 15 - Updating CMS to the latest version ==

At this point if you need to update CMS to the latest version, please follow the information in the link below:
http://wiki.newhavensoftware.com/index.php/Server_Update

Moving CMS to a New Server

2020-07-07T16:38:30Z

Russ horton: /* Step 6 - Stopping the Sybase service on the new computer */

=Overview=
This article details the instructions for moving your CMS installation from an old server to a new server including moving your data.

This process is a large undertaking that will require CMS to be down during the move. As a result please inform NewHaven Support of the day you plan to do the server migration. This is so we may either set up a appointment with you to guide you through the process, or at least ensure we have staff available to you in case you find you require assistance.

The following instructions have 4 major themes to them:

# Preparing to move CMS to the new System.
# Installing CMS on the new System.
# Moving the old Database to the new System.
# Updating the old Database to the new version of CMS

The above list is to help outline what exactly the following instructions are attempting to accomplish and to give you an overview of the process you are about to undertake.

=Moving CMS on to a new server=
== Step 1 - Prerequisites==
CRITICAL! ALL USERS MUST EXIT CMS PRIOR TO INSTALLING CMS SERVER ON ANOTHER COMPUTER!

CRITICAL! YOU MUST BE LOGGED IN AS THE COMPUTER ADMINISTRATOR OR A USER THAT IS A MEMBER OF THE ADMINISTRATORS GROUP!

==Step 2 - Make a backup image of CMS Database files==
We need to create a backup of your current live database to transfer to the new server.
To create a backup of your database please review the link below:

http://wiki.newhavensoftware.com/index.php/Creating_a_Database_Backup

== Step 3 - Stop and Disable the Sybase service on your old system (Skip this step if running CMS Solo) ==
Next we will need to disable the Sybase service on your old system. This step is done to ensure there is no conflict with the database services when we do the install on the new system.

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#How_to_Stop_the_Sybase_service_if_running_CMS_8.0_or_later

== Step 4 - Disable sharing on the NewHaven Software folder ==
This is to ensure we do not accidentally connect workstations to the old server after the migration is complete.

For information on how to do this please visit http://wiki.newhavensoftware.com/index.php/Folder_sharing_in_Windows

== Step 5 - Install CMS Server on the new computer. ==

To do so please follow the information in the link below.
http://wiki.newhavensoftware.com/index.php/Server_Update

== Step 6 - Stopping the Sybase service on the new computer (Skip this step if running CMS Solo) ==
We need to stop the Sybase service now to transfer in the copy of the database from the old server.

To do so please follow the links below:

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#CMS_8.0_or_later

== Step 7 - Copying over your Database and log file to the new system ==
#Create a new folder in the NewHaven Software\Data folder. Name it CLEAN.
#There should be two files in the NewHaven Software\Data\ ( Your Database Name) folder; one with a .db extension and one with a .log extension. Move both of these files into the NewHaven Software\Data\Clean folder you just created.
#Copy the .db and .log file from the old CMS Server computer into the NewHaven Software\Data\ (Your Database Name) folder on your new CMS Server computer.

== Step 8 - Copying over the CMSDBO.ini file and Custom Reports ==
We now need to copy over the CMSDBO.ini file to ensure CMS is able to start, as well as any custom reports.

# Check the NewHaven Software folder on the old server, see if there is a file present called CMSDBO.ini, if it is not there skip the next step.
# If this file is present please copy and move it into the NewHaven Software folder on your new system.
# Also if you have any custom reports please make sure to move them to the new server as well.

== Step 9 - Restart the Sybase service on the new computer ==
You will now need to stop the Sybase service on the new computer. To do so please follow the links below:

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#How_to_Start_the_Sybase_service_if_running_CMS_8.0_or_later

== Step 10 - Log into CMS ==
Log into CMS and confirm it is working. If you get a database mismatch error message, you will need to rerun the setup and reboot the computer in order to sync up the CMS application and database. To do so please follow the instructions in http://wiki.newhavensoftware.com/index.php/Server_Update

== Step 11 - Check your backup ==

Check your CMS backup settings in to ensure the path that it is using to backup its files is still valid on this server. To access this please follow the information in the link below:

http://wiki.newhavensoftware.com/index.php/Creating_a_Database_Backup

== Step 12 - Sharing the NewHaven Software folder ==
Once you confirm CMS is working on the new installation, you can share out the NewHaven Software folder so your workstations are able to connect to it. For information on how to do this please visit http://wiki.newhavensoftware.com/index.php/Folder_sharing_in_Windows

== Step 13 - Connecting Workstations to CMS ==
If the server is on the same network as your old server. All you need to do is remap the NewHaven Software shared drive on the workstations to the new server. For information on how to do that please review the video below:
http://youtu.be/dBbd94k7b0A

If these workstations are on a NEW network along with the server, or you are also installing new workstations, please follow the link below:
http://wiki.newhavensoftware.com/index.php/Workstation_Install

NOTE: Workstations must be on the same subnet as the server for CMS to be able to detect and connect to its database server. If this is not reasonable to do, please contact us for additional configuration options.

== Step 14 - Removing CMS from the old system ==
Uninstall CMS Server from the old computer to ensure the potentially conflicting Sybase service is removed and that everyone is running CMS from the same directory on the new CMS Server computer.

== Step 15 - Updating CMS to the latest version ==

At this point if you need to update CMS to the latest version, please follow the information in the link below:
http://wiki.newhavensoftware.com/index.php/Server_Update

Moving CMS to a New Server

2020-07-07T16:38:00Z

Russ horton: /* Step 3 - Stop and Disable the Sybase service on your old system */

=Overview=
This article details the instructions for moving your CMS installation from an old server to a new server including moving your data.

This process is a large undertaking that will require CMS to be down during the move. As a result please inform NewHaven Support of the day you plan to do the server migration. This is so we may either set up a appointment with you to guide you through the process, or at least ensure we have staff available to you in case you find you require assistance.

The following instructions have 4 major themes to them:

# Preparing to move CMS to the new System.
# Installing CMS on the new System.
# Moving the old Database to the new System.
# Updating the old Database to the new version of CMS

The above list is to help outline what exactly the following instructions are attempting to accomplish and to give you an overview of the process you are about to undertake.

=Moving CMS on to a new server=
== Step 1 - Prerequisites==
CRITICAL! ALL USERS MUST EXIT CMS PRIOR TO INSTALLING CMS SERVER ON ANOTHER COMPUTER!

CRITICAL! YOU MUST BE LOGGED IN AS THE COMPUTER ADMINISTRATOR OR A USER THAT IS A MEMBER OF THE ADMINISTRATORS GROUP!

==Step 2 - Make a backup image of CMS Database files==
We need to create a backup of your current live database to transfer to the new server.
To create a backup of your database please review the link below:

http://wiki.newhavensoftware.com/index.php/Creating_a_Database_Backup

== Step 3 - Stop and Disable the Sybase service on your old system (Skip this step if running CMS Solo) ==
Next we will need to disable the Sybase service on your old system. This step is done to ensure there is no conflict with the database services when we do the install on the new system.

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#How_to_Stop_the_Sybase_service_if_running_CMS_8.0_or_later

== Step 4 - Disable sharing on the NewHaven Software folder ==
This is to ensure we do not accidentally connect workstations to the old server after the migration is complete.

For information on how to do this please visit http://wiki.newhavensoftware.com/index.php/Folder_sharing_in_Windows

== Step 5 - Install CMS Server on the new computer. ==

To do so please follow the information in the link below.
http://wiki.newhavensoftware.com/index.php/Server_Update

== Step 6 - Stopping the Sybase service on the new computer ==
We need to stop the Sybase service now to transfer in the copy of the database from the old server.

To do so please follow the links below:

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#CMS_8.0_or_later

== Step 7 - Copying over your Database and log file to the new system ==
#Create a new folder in the NewHaven Software\Data folder. Name it CLEAN.
#There should be two files in the NewHaven Software\Data\ ( Your Database Name) folder; one with a .db extension and one with a .log extension. Move both of these files into the NewHaven Software\Data\Clean folder you just created.
#Copy the .db and .log file from the old CMS Server computer into the NewHaven Software\Data\ (Your Database Name) folder on your new CMS Server computer.

== Step 8 - Copying over the CMSDBO.ini file and Custom Reports ==
We now need to copy over the CMSDBO.ini file to ensure CMS is able to start, as well as any custom reports.

# Check the NewHaven Software folder on the old server, see if there is a file present called CMSDBO.ini, if it is not there skip the next step.
# If this file is present please copy and move it into the NewHaven Software folder on your new system.
# Also if you have any custom reports please make sure to move them to the new server as well.

== Step 9 - Restart the Sybase service on the new computer ==
You will now need to stop the Sybase service on the new computer. To do so please follow the links below:

http://wiki.newhavensoftware.com/index.php/How_to_stop_and_start_the_Sybase_service#How_to_Start_the_Sybase_service_if_running_CMS_8.0_or_later

== Step 10 - Log into CMS ==
Log into CMS and confirm it is working. If you get a database mismatch error message, you will need to rerun the setup and reboot the computer in order to sync up the CMS application and database. To do so please follow the instructions in http://wiki.newhavensoftware.com/index.php/Server_Update

== Step 11 - Check your backup ==

Check your CMS backup settings in to ensure the path that it is using to backup its files is still valid on this server. To access this please follow the information in the link below:

http://wiki.newhavensoftware.com/index.php/Creating_a_Database_Backup

== Step 12 - Sharing the NewHaven Software folder ==
Once you confirm CMS is working on the new installation, you can share out the NewHaven Software folder so your workstations are able to connect to it. For information on how to do this please visit http://wiki.newhavensoftware.com/index.php/Folder_sharing_in_Windows

== Step 13 - Connecting Workstations to CMS ==
If the server is on the same network as your old server. All you need to do is remap the NewHaven Software shared drive on the workstations to the new server. For information on how to do that please review the video below:
http://youtu.be/dBbd94k7b0A

If these workstations are on a NEW network along with the server, or you are also installing new workstations, please follow the link below:
http://wiki.newhavensoftware.com/index.php/Workstation_Install

NOTE: Workstations must be on the same subnet as the server for CMS to be able to detect and connect to its database server. If this is not reasonable to do, please contact us for additional configuration options.

== Step 14 - Removing CMS from the old system ==
Uninstall CMS Server from the old computer to ensure the potentially conflicting Sybase service is removed and that everyone is running CMS from the same directory on the new CMS Server computer.

== Step 15 - Updating CMS to the latest version ==

At this point if you need to update CMS to the latest version, please follow the information in the link below:
http://wiki.newhavensoftware.com/index.php/Server_Update

EMV Cards

2020-06-26T15:29:02Z

Russ horton: /* I want it already, what's the ETA? */

Some background information on EMV cards, clarification on the industry's roll-out plans, requirements, and frequently asked questions.

=[http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/what-is-emv/ What is EMV?]=
The above title is a link to an informative article from one of our payment processing partners, Mercury Payment Systems (MPS) and is worth the read. EMV cards are also referred to as "chip card" (because they have a chip embedded in the card) or "smart cards". Another type of chip card is [http://www.transfirst.com/secure-processing/NFC NFC] which is Near Field Communications chip. The new retail devices that support EMV will have you insert the card, chip first into a slot on the front, instead of swiping the mag stripe. For NFC cards/readers you'd merely wave the chip over the reader. New smartphone enabled payment applications like Apple Pay use this NFC technology as well.

=Why chips?=
The chip is used in lieu of the magnetic stripe to communicate the card number, expiration date, and card holder's name (but not the CVC) to the device you insert it into. The use of EMV is prevalent worldwide (we're late to the game in the U.S.A.) and helps to reduce fraudulent "card-present" transactions since the chips are not easily duplicated. The magnetic (mag) stripes, by comparison, are easily swiped by fake readers and then duplicated.

When a card is swiped, the terminal performs an initial communication to the processor to see if the card was issued with an EMV chip or not. If so you'll be prompted to insert the card into the terminal instead. This addresses the scenario where a thief has picked up your card data by NFC and created a fake mag stripe version of the card.

[http://info.mercurypay.com/rs/772-ISK-107/images/Nov_10_Messenger_Article2_EMVtransaction.pdf Article explaining the details of an EMV transaction]

MPS has outlined the Benefits of EMV to include:
*Reduced risk of accepting counterfeit cards
*Reduced risk of card skimming at the POS terminal
*Accepting foreign cards which are already EMV enabled
*Modernized POS with support for EMV and contactless payment technologies (NFC)

That said, it offers no additional security for card use online or by phone (CNP - card not present transactions). It's worth noting that these cards still have a mag stripe on them to be used with traditional/current card swipe solutions since it is expected that it will take retailers a few years to implement chip card readers.

Statement from Square on the topic (Sept 2015):

''Here’s some data we’ve seen: about 17 percent of the cards swiped on Square Stand or Reader now contain a chip, up from roughly 3.5 percent in January 2014. For now, the majority of the cards are still being processed as magnetic-stripe transactions (all chip cards also have a magnetic stripe on the back). But as sellers upgrade to EMV technology, more and more of these transactions will be processed via the chip on the card instead of the magnetic stripe. A big milestone here is the liability shift, which, as we mentioned, happens in October. At the current pace of chip card issuance, we expect roughly 35-40 percent of cards to be chip-enabled by the time the liability shift hits (though this may change if issuers speed up or slow down their pace). - See more at: http://paymentsjournal.com/Content/Featured_Stories/26769/#sthash.XSpykLlN.dpuf''

=Should I care?=
If you do all of your business by phone and/or online (card not present), no need to worry about the change. It is something you'll want to consider if you accept physical cards (card present). At this stage accepting EMV cards does not impact your processing rates and we've not heard plans to do so.

As a consumer you'll start receiving new chip cards from your credit card providers and be instructed on how to use them as merchants begin adopting the hardware needed to process them.

=Do I have to accept EMV in my store?=
[http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/do-i-need-emv/ "U.S. merchants are not required to implement EMV by October 2015"]

Supporting EMV is not a requirement, see the link above or the following article from Visa:

*http://usa.visa.com/merchants/grow-your-business/payment-technologies/credit-card-chip/liability-shift.jsp

Be aware that if you accept an EMV card by using its mag stripe instead, and the charge turns out to be fraudulent, you will be responsible for the fraudulent transaction costs.

=What is my exposure to PCI fines?=
This is not about PCI, breaches or the crippling fines that go with them. If a fraudulent transaction occurs with an EMV card, the merchant is responsible for the cost of that fraudulent transaction. See this [http://www.discovernetwork.com/chip-card/images/Merchant%20Store%20Owner_Fraud%20Liability%20Shift%20Overview.pdf pdf/graphic from Discover] which, on page 2, does a nice job of illustrating which scenarios impact the merchant. It is not a data breach that would incur PCI fines. Here is an article from the PCI Council that explains their stance:

*https://www.pcisecuritystandards.org/news_events/quick_resources/increasing_security_with_emv_chip_and_pci.php

It does help to reduce fraudulent card-present transactions. While not a requirement, you may find it is worth the expense/effort to implement an EMV card reader.

There is an additional scenario where if the card was swiped in your store and then a duplicate card was created by someone obtaining the mag stripe data from your system, you would then also be liable for any transactions made with the duplicated card. CMS does not, however, store the mag stripe data (per our adherence to PA-DSS 3.1 regulations) so this should not be a concern for CMS users unless your mag stripe reader itself was replaced/spoofed.

=Is EMV required?=
The first phase of the EMV roll-out is October 1, 2015 but even then it is not required. These articles confirm it is a liability shift, not a requirement:

*http://merchant.mercurypay.com/secure-my-business/getting-ready-emv/do-i-need-emv/
*http://usa.visa.com/merchants/grow-your-business/payment-technologies/credit-card-chip/liability-shift.jsp
*http://www.mercurypay.com/article/emv-chip-card-technology

Our primary payment partner MPS recently announced their EMV solution in April 2015 and we are a now researching how we can support it. The only solution for EMV is to integrate with one of their certified input devices. We can't say yet when we will be able to support EMV but it's possible/likely that it will not be by October.

Adoption of EMV appears to be slow thus far as reported in a recent article found in the Payments Journal where it said:

“The poll finds that roughly one in 10 Americans have received the new chip-enabled credit cards. Of those who have received the cards, only one-third say they've actually used the cards as intended in new specialized credit card readers.” - See more at: http://www.paymentsjournal.com/Content/Featured_Stories/26874/#sthash.Ld8IaeAz.dpuf

=When is the Right Time to Implement EMV?=
Typically clients of NewHaven Software are not at high risk for fraud from counterfeit cards, which is what EMV is targeting. Here is a statement from Mercury on the topic:

''Criminals who commit counterfeit card fraud typically focus on the purchase of “fenceable” goods (merchandise that can be purchased fraudulently and then turned easily for a healthy profit on the black market), or merchandise that can easily be converted to cash, such as gift cards...(e.g.high-end boutiques, grocers, and drug stores.)''

If you were to assess the number of card present fraudulent charges you've received in the past and then further reduce that by the fraction of future charges that will be made with cards that are EMV (noting this liability doesn't apply to non-EMV cards), in most cases the resulting risk/liability for not accepting EMV cards in October should be low.

Good article reviewing some reasons why now may not be the time for your company to implement EMV - http://blog.solupay.com/top-7-reasons-not-to-adopt-emv

=I want it already, what's the ETA?=
To clarify, these EMV readers are not just another input device to feed the card data to CMS for processing like the mag stripe readers have been. This is a new paradigm where the card reader device MUST handle the processing. As such each device must be individually certified (which is rigorous) and thus we expect to only offer support for a small number of devices. CMS will also have to be modified to support feeding transaction data to the device, have the device process the transaction, and CMS be updated with the results of that processing. This is not a trivial project and must be executed carefully to ensure a trouble-free and PCI compliant implementation.

=Will it work with my merchant account?=
Our first implementation of EMV will be with our payment partner MPS. If your merchant account is not with MPS, please contact us so we can arrange to have a quote prepared for you.

Again, this has no effect on card not present (CNP) transaction, only card-present.

=Any more good news?=
Indeed. The devices we're examining appear to also be conducive to working with other payment solutions like PIN Debit, Apple Pay and other NFC payment solutions which we'll also examine as an enhancement to CMS's [[POS Module]].

Address Validation Module

2020-06-10T19:43:57Z

Russ horton: /* Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service */

=Introduction=
The Address Validation Module (AVM) links CMS to Endicia Label Server (ELS) allowing users to validate individual addresses against the latest USPS data in real-time. This validation not only ensures proper formatting of an address ([http://www.usps.com/ncsc/addressservices/certprograms/cass.htm CASS]) but also validates that the address is indeed deliverable! This will help you catch typos, missing apartment numbers, etc. whether they result from your operator or the customer. This option is available in CMS where there is an editable address. Watch our [http://www.youtube.com/watch?v=TWJsUcejEbc YouTube video on AVM] to see it in action!

This is rather different than AVS (Address Verification Service) which is used when you process credit cards. AVS is only used to verify that the billing address of the order is the same as the billing address of the cardholder. It does nothing to validate that the address is properly formatted or deliverable. If you use AVM to validate your address before processing the credit card, your AVS processing stands a better chance of getting a match.

To use AVM, you'll just click the new Validate button which is located by the address you want to validate. The validation response will indicate if your address could be validated and if so, it will also be standardized.

If the address could not be validated, that means the address was not close enough to a deliverable address to be corrected and the customer should be contacted to confirm their address information.

=What does the validation do?=

The service performs address validation and standardization. In other words, it will validate that the address is deliverable (according to USPS,) a real address...not just one properly formatted. It will also standardize the address (like CASS) to append Zip +4, convert Street to St and so on. Here is a basic example from the Contact Manager (Customers) section in CMS:

'''Submit (before):'''

[[image:6custbefore.jpg]]

'''Return (after):'''

[[image:6custafter.jpg]]

Note the changes made to the address in this example:

*Standardized the address
**converted Crossing to Xing
**moved the suite onto the same lines as the address (which should be done when there is room)
*Fixed the incorrect zip code
*Added the zip+4
*Set the county
*Set the commercial checkbox (RDI)
*Validate button turns from red to green
*Date of validation is displayed

It can also correct spelling errors anywhere in the address.

'''Other important points:'''

*If any edits are made to the validated address, it immediately reverts to showing as non-validated.
*If the billing and/or shipping address is the same as the mailing, they too will immediately be set as validated to match. This is even true if the billing=shipping and both are different than the mailing. In that situation, validating the shipping in this case would automatically set the billing as validated as well.
*An added benefit to the validation process is it will return the the Residential Delivery Indicator. CMS will use this RDI to flag the address as ''commercial'' when appropriate. FedEx and UPS both assess a residential surcharge to their shipments and this flag will let CMS know when a shipment can go commercial, saving you the ~$2 residential surcharge. This flag will pass through to the UPS and FedEx through our various shipping integrations automatically.

=Where does it work?=
The address validation option is available in the following screens:
*Order Entry, wherever an address is found
**Customer
**Items (the Address Editor used for adding multi-ship recipients)
**Shipping - Shipping Address>Modify (same Address Editor screen used for editing a shipping/recipient address)
**Money - Billing Address>Modify (same Address Editor screen)
**View Invoice - While you cannot validate from the View Invoice screen, we do color code the shipping and billing addresses shown here using red font to indicate a non-validated address and green to indicate a validated address. This color coding is also done on the Shipping and Money addresses. You can click on the billing address to bring up the editor and validate from there but this is not yet supported for the shipping addresses.

[[image:6oeview.jpg]]

*Contact Manager (Customers)
**Address - Mailing, Billing and Shipping

*Order Importing - As orders are imported (eCMS or any XML order source) you can tell CMS to attempt to validate all of the addresses in each order.

*Manifest - Clicking on the Shipping address displayed will bring up the Address Editor where the address can be validated.

*[[Purchasing (PO) Module]] - PO Billing and Shipping addresses (not Vendor addresses yet)

*Warehouses - In Setup you can validate the addresses associated with each of your warehouses.

=Performance=
Near instant responses, certainly sub-second. This performance was even maintained over the busy holiday seasons.

A few comments on why we think you should continue to expect this level of performance:

*There is very little data being passed back and forth. This will minimize the communication time and the possibility of performance degradation you would experience even from a poor internet connection.

*The CMS portion of the communication is near-instant so we are not adding any noticeable overhead to the processing time.

*We are subscribed to Endicia's highest service level.

*When we asked Endicia about performance expectations, they stated that on a busy day they would expect users to see validation times around a quarter of a second.

Your results may vary of course and are subject to workstation resources (RAM and CPU) and available internet bandwidth but our experience has shown near-immediate results. It is impressive.

=Automation=
While the Validate button is great for orders your operators are touching (either hand entering or verifying imported orders,) what can you do when importing orders automatically (using the [http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module]) where an operator may not be reviewing the order?

To address this (pun intended) you'll now find an address validation option available in Setup>Fulfillment>Fulfillment Options>Import Sources. For each import order-source you defined, you can choose if you want CMS to automatically validate addresses as they are imported. We have also made changes to our XML to support external address validation so you can import an order with a validated address. You'll be able to see when it was validated and CMS will know to skip trying to validate addresses that are importing 'pre-validated'.

[[image:6osavm.jpg]]

There is also a validation check for the Automated Imports module which will let you prevent an imported order from saving as a completed order if any of its addresses failed validation. In those cases it will be available for manual review in the Verify Orders section...the same as any other validation exception (e.g. unrecognized product code, order not fully paid, back order, international, etc.)

[[image:6viavm.jpg]]

=Limitations=
*A workstation must have Internet access to use the Address Validation Module. CMS is communicating directly from the workstation to the web service for Endicia Label Server.

*The AVM does not perform NCOA type move changes. In other words, it is not checking to see if that person lives at that address, only that the address is deliverable and standardized. It will however match on company name if one is present. NCOA processing, where you can match the recipient name to their address, is only available by submitting data to Peachtree.

*The AVM only validates individual addresses. It is not used for batch address processing. We will be exploring batch processing options as a possible future enhancement to this module.

*AVM will only validate US addresses. The validate button will become disabled when the address is non-US.

*AVM will only validate addresses that USPS can deliver to.

*Results are returned in UPPER CASE. This only affects the address however and the name/company fields will remain untouched and in the case you had entered them. This means that any merge letters you may use will still use the case of the names as you entered them.

=Future considerations=
*Batch processing
*Address validate imported catalog requests
*Allow for the user to choose from a possible list of candidates when an exact match is not found
*Option to require validation before save
*Option to validate all addresses on an order at once (mailing, shipping and billing)
*Option to validate the ship-to address from View Invoice screen (now available for the billing address)
*Return mixed case results
*Validate imported recipient lists or all ship-to's for multi-ship orders

=Video=
View our YouTube video to see the AVM module in action! http://www.youtube.com/watch?v=TWJsUcejEbc

[[Category:Published]]

Alternate search keywords - Address validation software, address verification module, address verification software, address correction.

=Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service=

With rather short notice, Endicia has elected to shut down their Dial-a-Zip (DaZ) service and only make address validation available through their Endicia Label Server (ELS) web service.

A CMS update is now available for CMS TEN users on our [https://updates.newhavensoftware.com/ Support Downloads site]. With version 10.0.14.273 we have temporarily transitioned CMS's address validation calls to the Endicia Label Server (ELS) sandbox account until we can secure a production account either for CMS or for individual customers.
Please contact us for an appointment if you need assistance with installing this update. We expect to have access to a production ELS account around June 18th at which point we will test and release a new version of CMS using this new account. You may choose to wait to update until then.

If you find yourself on June 11th without a solution (either a CMS update and/or a working ELS account), there are some things to consider:

*What is the impact of not having addresses validated in CMS, albeit for a short time, while you wait for a solution or new ELS account (it appears one will be required) and is there anything you can do to mitigate those risks?
**Can you still get address validation on your website to mitigate the number of orders you are shipping without validation?
**If using UPS Worldship or FedEx Ship Manager with keyed imports, can you validate addresses in their software before generating the label?

*Disable address validation in CMS for your import order sources - With this option enabled, CMS will be automatically performing address validation for imported orders and, if that service is failing, it will stop your imports. Turn this option off [https://www.screencast.com/t/aat0jBFVHo as seen here] so your order imports can continue to flow in without error.
**If you are using the [[Automated Imports Module]] you'll also want to remove the validation check for processing orders that fail Address Validation, also highlighted in the screenshot linked above.

*While the above will allow your imports to come in without error, the Validate button will still be enabled throughout CMS where any address is displayed. Your operators will receive an error if they click on the Validate button. There is no option in CMS to disable this button but if you find that this is to confusing for your operators, we can issue you a new release code to disable the Address Validation option. We can reissue a new release code enabling it when desired.

Address Validation Module

2020-06-10T19:43:37Z

Russ horton: /* Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service */

=Introduction=
The Address Validation Module (AVM) links CMS to Endicia Label Server (ELS) allowing users to validate individual addresses against the latest USPS data in real-time. This validation not only ensures proper formatting of an address ([http://www.usps.com/ncsc/addressservices/certprograms/cass.htm CASS]) but also validates that the address is indeed deliverable! This will help you catch typos, missing apartment numbers, etc. whether they result from your operator or the customer. This option is available in CMS where there is an editable address. Watch our [http://www.youtube.com/watch?v=TWJsUcejEbc YouTube video on AVM] to see it in action!

This is rather different than AVS (Address Verification Service) which is used when you process credit cards. AVS is only used to verify that the billing address of the order is the same as the billing address of the cardholder. It does nothing to validate that the address is properly formatted or deliverable. If you use AVM to validate your address before processing the credit card, your AVS processing stands a better chance of getting a match.

To use AVM, you'll just click the new Validate button which is located by the address you want to validate. The validation response will indicate if your address could be validated and if so, it will also be standardized.

If the address could not be validated, that means the address was not close enough to a deliverable address to be corrected and the customer should be contacted to confirm their address information.

=What does the validation do?=

The service performs address validation and standardization. In other words, it will validate that the address is deliverable (according to USPS,) a real address...not just one properly formatted. It will also standardize the address (like CASS) to append Zip +4, convert Street to St and so on. Here is a basic example from the Contact Manager (Customers) section in CMS:

'''Submit (before):'''

[[image:6custbefore.jpg]]

'''Return (after):'''

[[image:6custafter.jpg]]

Note the changes made to the address in this example:

*Standardized the address
**converted Crossing to Xing
**moved the suite onto the same lines as the address (which should be done when there is room)
*Fixed the incorrect zip code
*Added the zip+4
*Set the county
*Set the commercial checkbox (RDI)
*Validate button turns from red to green
*Date of validation is displayed

It can also correct spelling errors anywhere in the address.

'''Other important points:'''

*If any edits are made to the validated address, it immediately reverts to showing as non-validated.
*If the billing and/or shipping address is the same as the mailing, they too will immediately be set as validated to match. This is even true if the billing=shipping and both are different than the mailing. In that situation, validating the shipping in this case would automatically set the billing as validated as well.
*An added benefit to the validation process is it will return the the Residential Delivery Indicator. CMS will use this RDI to flag the address as ''commercial'' when appropriate. FedEx and UPS both assess a residential surcharge to their shipments and this flag will let CMS know when a shipment can go commercial, saving you the ~$2 residential surcharge. This flag will pass through to the UPS and FedEx through our various shipping integrations automatically.

=Where does it work?=
The address validation option is available in the following screens:
*Order Entry, wherever an address is found
**Customer
**Items (the Address Editor used for adding multi-ship recipients)
**Shipping - Shipping Address>Modify (same Address Editor screen used for editing a shipping/recipient address)
**Money - Billing Address>Modify (same Address Editor screen)
**View Invoice - While you cannot validate from the View Invoice screen, we do color code the shipping and billing addresses shown here using red font to indicate a non-validated address and green to indicate a validated address. This color coding is also done on the Shipping and Money addresses. You can click on the billing address to bring up the editor and validate from there but this is not yet supported for the shipping addresses.

[[image:6oeview.jpg]]

*Contact Manager (Customers)
**Address - Mailing, Billing and Shipping

*Order Importing - As orders are imported (eCMS or any XML order source) you can tell CMS to attempt to validate all of the addresses in each order.

*Manifest - Clicking on the Shipping address displayed will bring up the Address Editor where the address can be validated.

*[[Purchasing (PO) Module]] - PO Billing and Shipping addresses (not Vendor addresses yet)

*Warehouses - In Setup you can validate the addresses associated with each of your warehouses.

=Performance=
Near instant responses, certainly sub-second. This performance was even maintained over the busy holiday seasons.

A few comments on why we think you should continue to expect this level of performance:

*There is very little data being passed back and forth. This will minimize the communication time and the possibility of performance degradation you would experience even from a poor internet connection.

*The CMS portion of the communication is near-instant so we are not adding any noticeable overhead to the processing time.

*We are subscribed to Endicia's highest service level.

*When we asked Endicia about performance expectations, they stated that on a busy day they would expect users to see validation times around a quarter of a second.

Your results may vary of course and are subject to workstation resources (RAM and CPU) and available internet bandwidth but our experience has shown near-immediate results. It is impressive.

=Automation=
While the Validate button is great for orders your operators are touching (either hand entering or verifying imported orders,) what can you do when importing orders automatically (using the [http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module]) where an operator may not be reviewing the order?

To address this (pun intended) you'll now find an address validation option available in Setup>Fulfillment>Fulfillment Options>Import Sources. For each import order-source you defined, you can choose if you want CMS to automatically validate addresses as they are imported. We have also made changes to our XML to support external address validation so you can import an order with a validated address. You'll be able to see when it was validated and CMS will know to skip trying to validate addresses that are importing 'pre-validated'.

[[image:6osavm.jpg]]

There is also a validation check for the Automated Imports module which will let you prevent an imported order from saving as a completed order if any of its addresses failed validation. In those cases it will be available for manual review in the Verify Orders section...the same as any other validation exception (e.g. unrecognized product code, order not fully paid, back order, international, etc.)

[[image:6viavm.jpg]]

=Limitations=
*A workstation must have Internet access to use the Address Validation Module. CMS is communicating directly from the workstation to the web service for Endicia Label Server.

*The AVM does not perform NCOA type move changes. In other words, it is not checking to see if that person lives at that address, only that the address is deliverable and standardized. It will however match on company name if one is present. NCOA processing, where you can match the recipient name to their address, is only available by submitting data to Peachtree.

*The AVM only validates individual addresses. It is not used for batch address processing. We will be exploring batch processing options as a possible future enhancement to this module.

*AVM will only validate US addresses. The validate button will become disabled when the address is non-US.

*AVM will only validate addresses that USPS can deliver to.

*Results are returned in UPPER CASE. This only affects the address however and the name/company fields will remain untouched and in the case you had entered them. This means that any merge letters you may use will still use the case of the names as you entered them.

=Future considerations=
*Batch processing
*Address validate imported catalog requests
*Allow for the user to choose from a possible list of candidates when an exact match is not found
*Option to require validation before save
*Option to validate all addresses on an order at once (mailing, shipping and billing)
*Option to validate the ship-to address from View Invoice screen (now available for the billing address)
*Return mixed case results
*Validate imported recipient lists or all ship-to's for multi-ship orders

=Video=
View our YouTube video to see the AVM module in action! http://www.youtube.com/watch?v=TWJsUcejEbc

[[Category:Published]]

Alternate search keywords - Address validation software, address verification module, address verification software, address correction.

=Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service=

With rather short notice, Endicia has elected to shut down their Dial-a-Zip (DaZ) service and only make address validation available through their Endicia Label Server (ELS) web service.

A CMS update is now available for CMS TEN users on our [https://updates.newhavensoftware.com/ Support Downloads site]. With version 10.0.14.273 we have temporarily transitioned CMS's address validation calls to the Endicia Label Server (ELS) sandbox account until we can secure a production account either for CMS or for individual customers. Please contact us for an appointment if you need assistance with installing this update. We expect to have access to a production ELS account around June 18th at which point we will test and release a new version of CMS using this new account. You may choose to wait to update until then.

If you find yourself on June 11th without a solution (either a CMS update and/or a working ELS account), there are some things to consider:

*What is the impact of not having addresses validated in CMS, albeit for a short time, while you wait for a solution or new ELS account (it appears one will be required) and is there anything you can do to mitigate those risks?
**Can you still get address validation on your website to mitigate the number of orders you are shipping without validation?
**If using UPS Worldship or FedEx Ship Manager with keyed imports, can you validate addresses in their software before generating the label?

*Disable address validation in CMS for your import order sources - With this option enabled, CMS will be automatically performing address validation for imported orders and, if that service is failing, it will stop your imports. Turn this option off [https://www.screencast.com/t/aat0jBFVHo as seen here] so your order imports can continue to flow in without error.
**If you are using the [[Automated Imports Module]] you'll also want to remove the validation check for processing orders that fail Address Validation, also highlighted in the screenshot linked above.

*While the above will allow your imports to come in without error, the Validate button will still be enabled throughout CMS where any address is displayed. Your operators will receive an error if they click on the Validate button. There is no option in CMS to disable this button but if you find that this is to confusing for your operators, we can issue you a new release code to disable the Address Validation option. We can reissue a new release code enabling it when desired.

Address Validation Module

2020-06-10T19:40:20Z

Russ horton: /* Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service */

=Introduction=
The Address Validation Module (AVM) links CMS to Endicia Label Server (ELS) allowing users to validate individual addresses against the latest USPS data in real-time. This validation not only ensures proper formatting of an address ([http://www.usps.com/ncsc/addressservices/certprograms/cass.htm CASS]) but also validates that the address is indeed deliverable! This will help you catch typos, missing apartment numbers, etc. whether they result from your operator or the customer. This option is available in CMS where there is an editable address. Watch our [http://www.youtube.com/watch?v=TWJsUcejEbc YouTube video on AVM] to see it in action!

This is rather different than AVS (Address Verification Service) which is used when you process credit cards. AVS is only used to verify that the billing address of the order is the same as the billing address of the cardholder. It does nothing to validate that the address is properly formatted or deliverable. If you use AVM to validate your address before processing the credit card, your AVS processing stands a better chance of getting a match.

To use AVM, you'll just click the new Validate button which is located by the address you want to validate. The validation response will indicate if your address could be validated and if so, it will also be standardized.

If the address could not be validated, that means the address was not close enough to a deliverable address to be corrected and the customer should be contacted to confirm their address information.

=What does the validation do?=

The service performs address validation and standardization. In other words, it will validate that the address is deliverable (according to USPS,) a real address...not just one properly formatted. It will also standardize the address (like CASS) to append Zip +4, convert Street to St and so on. Here is a basic example from the Contact Manager (Customers) section in CMS:

'''Submit (before):'''

[[image:6custbefore.jpg]]

'''Return (after):'''

[[image:6custafter.jpg]]

Note the changes made to the address in this example:

*Standardized the address
**converted Crossing to Xing
**moved the suite onto the same lines as the address (which should be done when there is room)
*Fixed the incorrect zip code
*Added the zip+4
*Set the county
*Set the commercial checkbox (RDI)
*Validate button turns from red to green
*Date of validation is displayed

It can also correct spelling errors anywhere in the address.

'''Other important points:'''

*If any edits are made to the validated address, it immediately reverts to showing as non-validated.
*If the billing and/or shipping address is the same as the mailing, they too will immediately be set as validated to match. This is even true if the billing=shipping and both are different than the mailing. In that situation, validating the shipping in this case would automatically set the billing as validated as well.
*An added benefit to the validation process is it will return the the Residential Delivery Indicator. CMS will use this RDI to flag the address as ''commercial'' when appropriate. FedEx and UPS both assess a residential surcharge to their shipments and this flag will let CMS know when a shipment can go commercial, saving you the ~$2 residential surcharge. This flag will pass through to the UPS and FedEx through our various shipping integrations automatically.

=Where does it work?=
The address validation option is available in the following screens:
*Order Entry, wherever an address is found
**Customer
**Items (the Address Editor used for adding multi-ship recipients)
**Shipping - Shipping Address>Modify (same Address Editor screen used for editing a shipping/recipient address)
**Money - Billing Address>Modify (same Address Editor screen)
**View Invoice - While you cannot validate from the View Invoice screen, we do color code the shipping and billing addresses shown here using red font to indicate a non-validated address and green to indicate a validated address. This color coding is also done on the Shipping and Money addresses. You can click on the billing address to bring up the editor and validate from there but this is not yet supported for the shipping addresses.

[[image:6oeview.jpg]]

*Contact Manager (Customers)
**Address - Mailing, Billing and Shipping

*Order Importing - As orders are imported (eCMS or any XML order source) you can tell CMS to attempt to validate all of the addresses in each order.

*Manifest - Clicking on the Shipping address displayed will bring up the Address Editor where the address can be validated.

*[[Purchasing (PO) Module]] - PO Billing and Shipping addresses (not Vendor addresses yet)

*Warehouses - In Setup you can validate the addresses associated with each of your warehouses.

=Performance=
Near instant responses, certainly sub-second. This performance was even maintained over the busy holiday seasons.

A few comments on why we think you should continue to expect this level of performance:

*There is very little data being passed back and forth. This will minimize the communication time and the possibility of performance degradation you would experience even from a poor internet connection.

*The CMS portion of the communication is near-instant so we are not adding any noticeable overhead to the processing time.

*We are subscribed to Endicia's highest service level.

*When we asked Endicia about performance expectations, they stated that on a busy day they would expect users to see validation times around a quarter of a second.

Your results may vary of course and are subject to workstation resources (RAM and CPU) and available internet bandwidth but our experience has shown near-immediate results. It is impressive.

=Automation=
While the Validate button is great for orders your operators are touching (either hand entering or verifying imported orders,) what can you do when importing orders automatically (using the [http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module]) where an operator may not be reviewing the order?

To address this (pun intended) you'll now find an address validation option available in Setup>Fulfillment>Fulfillment Options>Import Sources. For each import order-source you defined, you can choose if you want CMS to automatically validate addresses as they are imported. We have also made changes to our XML to support external address validation so you can import an order with a validated address. You'll be able to see when it was validated and CMS will know to skip trying to validate addresses that are importing 'pre-validated'.

[[image:6osavm.jpg]]

There is also a validation check for the Automated Imports module which will let you prevent an imported order from saving as a completed order if any of its addresses failed validation. In those cases it will be available for manual review in the Verify Orders section...the same as any other validation exception (e.g. unrecognized product code, order not fully paid, back order, international, etc.)

[[image:6viavm.jpg]]

=Limitations=
*A workstation must have Internet access to use the Address Validation Module. CMS is communicating directly from the workstation to the web service for Endicia Label Server.

*The AVM does not perform NCOA type move changes. In other words, it is not checking to see if that person lives at that address, only that the address is deliverable and standardized. It will however match on company name if one is present. NCOA processing, where you can match the recipient name to their address, is only available by submitting data to Peachtree.

*The AVM only validates individual addresses. It is not used for batch address processing. We will be exploring batch processing options as a possible future enhancement to this module.

*AVM will only validate US addresses. The validate button will become disabled when the address is non-US.

*AVM will only validate addresses that USPS can deliver to.

*Results are returned in UPPER CASE. This only affects the address however and the name/company fields will remain untouched and in the case you had entered them. This means that any merge letters you may use will still use the case of the names as you entered them.

=Future considerations=
*Batch processing
*Address validate imported catalog requests
*Allow for the user to choose from a possible list of candidates when an exact match is not found
*Option to require validation before save
*Option to validate all addresses on an order at once (mailing, shipping and billing)
*Option to validate the ship-to address from View Invoice screen (now available for the billing address)
*Return mixed case results
*Validate imported recipient lists or all ship-to's for multi-ship orders

=Video=
View our YouTube video to see the AVM module in action! http://www.youtube.com/watch?v=TWJsUcejEbc

[[Category:Published]]

Alternate search keywords - Address validation software, address verification module, address verification software, address correction.

=Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service=

With rather short notice, Endicia has elected to shut down their Dial-a-Zip (DaZ) service and only make address validation available through their Endicia Label Server (ELS) web service.

A CMS update is now available for CMS TEN users on our [https://updates.newhavensoftware.com/ Support Downloads site]. With version 10.0.14.273 we have temporarily transitioned CMS's address validation calls to the Endicia Label Server (ELS) sandbox account until we can secure a production account either for CMS or for individual customers.

If you find yourself on June 11th without a solution (either a CMS update and/or a working ELS account), there are some things to consider:

*What is the impact of not having addresses validated in CMS, albeit for a short time, while you wait for a solution or new ELS account (it appears one will be required) and is there anything you can do to mitigate those risks?
**Can you still get address validation on your website to mitigate the number of orders you are shipping without validation?
**If using UPS Worldship or FedEx Ship Manager with keyed imports, can you validate addresses in their software before generating the label?

*Disable address validation in CMS for your import order sources - With this option enabled, CMS will be automatically performing address validation for imported orders and, if that service is failing, it will stop your imports. Turn this option off [https://www.screencast.com/t/aat0jBFVHo as seen here] so your order imports can continue to flow in without error.
**If you are using the [[Automated Imports Module]] you'll also want to remove the validation check for processing orders that fail Address Validation, also highlighted in the screenshot linked above.

*While the above will allow your imports to come in without error, the Validate button will still be enabled throughout CMS where any address is displayed. Your operators will receive an error if they click on the Validate button. There is no option in CMS to disable this button but if you find that this is to confusing for your operators, we can issue you a new release code to disable the Address Validation option. We can reissue a new release code enabling it when desired.

Address Validation Module

2020-06-10T19:40:09Z

Russ horton: /* Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service */

=Introduction=
The Address Validation Module (AVM) links CMS to Endicia Label Server (ELS) allowing users to validate individual addresses against the latest USPS data in real-time. This validation not only ensures proper formatting of an address ([http://www.usps.com/ncsc/addressservices/certprograms/cass.htm CASS]) but also validates that the address is indeed deliverable! This will help you catch typos, missing apartment numbers, etc. whether they result from your operator or the customer. This option is available in CMS where there is an editable address. Watch our [http://www.youtube.com/watch?v=TWJsUcejEbc YouTube video on AVM] to see it in action!

This is rather different than AVS (Address Verification Service) which is used when you process credit cards. AVS is only used to verify that the billing address of the order is the same as the billing address of the cardholder. It does nothing to validate that the address is properly formatted or deliverable. If you use AVM to validate your address before processing the credit card, your AVS processing stands a better chance of getting a match.

To use AVM, you'll just click the new Validate button which is located by the address you want to validate. The validation response will indicate if your address could be validated and if so, it will also be standardized.

If the address could not be validated, that means the address was not close enough to a deliverable address to be corrected and the customer should be contacted to confirm their address information.

=What does the validation do?=

The service performs address validation and standardization. In other words, it will validate that the address is deliverable (according to USPS,) a real address...not just one properly formatted. It will also standardize the address (like CASS) to append Zip +4, convert Street to St and so on. Here is a basic example from the Contact Manager (Customers) section in CMS:

'''Submit (before):'''

[[image:6custbefore.jpg]]

'''Return (after):'''

[[image:6custafter.jpg]]

Note the changes made to the address in this example:

*Standardized the address
**converted Crossing to Xing
**moved the suite onto the same lines as the address (which should be done when there is room)
*Fixed the incorrect zip code
*Added the zip+4
*Set the county
*Set the commercial checkbox (RDI)
*Validate button turns from red to green
*Date of validation is displayed

It can also correct spelling errors anywhere in the address.

'''Other important points:'''

*If any edits are made to the validated address, it immediately reverts to showing as non-validated.
*If the billing and/or shipping address is the same as the mailing, they too will immediately be set as validated to match. This is even true if the billing=shipping and both are different than the mailing. In that situation, validating the shipping in this case would automatically set the billing as validated as well.
*An added benefit to the validation process is it will return the the Residential Delivery Indicator. CMS will use this RDI to flag the address as ''commercial'' when appropriate. FedEx and UPS both assess a residential surcharge to their shipments and this flag will let CMS know when a shipment can go commercial, saving you the ~$2 residential surcharge. This flag will pass through to the UPS and FedEx through our various shipping integrations automatically.

=Where does it work?=
The address validation option is available in the following screens:
*Order Entry, wherever an address is found
**Customer
**Items (the Address Editor used for adding multi-ship recipients)
**Shipping - Shipping Address>Modify (same Address Editor screen used for editing a shipping/recipient address)
**Money - Billing Address>Modify (same Address Editor screen)
**View Invoice - While you cannot validate from the View Invoice screen, we do color code the shipping and billing addresses shown here using red font to indicate a non-validated address and green to indicate a validated address. This color coding is also done on the Shipping and Money addresses. You can click on the billing address to bring up the editor and validate from there but this is not yet supported for the shipping addresses.

[[image:6oeview.jpg]]

*Contact Manager (Customers)
**Address - Mailing, Billing and Shipping

*Order Importing - As orders are imported (eCMS or any XML order source) you can tell CMS to attempt to validate all of the addresses in each order.

*Manifest - Clicking on the Shipping address displayed will bring up the Address Editor where the address can be validated.

*[[Purchasing (PO) Module]] - PO Billing and Shipping addresses (not Vendor addresses yet)

*Warehouses - In Setup you can validate the addresses associated with each of your warehouses.

=Performance=
Near instant responses, certainly sub-second. This performance was even maintained over the busy holiday seasons.

A few comments on why we think you should continue to expect this level of performance:

*There is very little data being passed back and forth. This will minimize the communication time and the possibility of performance degradation you would experience even from a poor internet connection.

*The CMS portion of the communication is near-instant so we are not adding any noticeable overhead to the processing time.

*We are subscribed to Endicia's highest service level.

*When we asked Endicia about performance expectations, they stated that on a busy day they would expect users to see validation times around a quarter of a second.

Your results may vary of course and are subject to workstation resources (RAM and CPU) and available internet bandwidth but our experience has shown near-immediate results. It is impressive.

=Automation=
While the Validate button is great for orders your operators are touching (either hand entering or verifying imported orders,) what can you do when importing orders automatically (using the [http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module]) where an operator may not be reviewing the order?

To address this (pun intended) you'll now find an address validation option available in Setup>Fulfillment>Fulfillment Options>Import Sources. For each import order-source you defined, you can choose if you want CMS to automatically validate addresses as they are imported. We have also made changes to our XML to support external address validation so you can import an order with a validated address. You'll be able to see when it was validated and CMS will know to skip trying to validate addresses that are importing 'pre-validated'.

[[image:6osavm.jpg]]

There is also a validation check for the Automated Imports module which will let you prevent an imported order from saving as a completed order if any of its addresses failed validation. In those cases it will be available for manual review in the Verify Orders section...the same as any other validation exception (e.g. unrecognized product code, order not fully paid, back order, international, etc.)

[[image:6viavm.jpg]]

=Limitations=
*A workstation must have Internet access to use the Address Validation Module. CMS is communicating directly from the workstation to the web service for Endicia Label Server.

*The AVM does not perform NCOA type move changes. In other words, it is not checking to see if that person lives at that address, only that the address is deliverable and standardized. It will however match on company name if one is present. NCOA processing, where you can match the recipient name to their address, is only available by submitting data to Peachtree.

*The AVM only validates individual addresses. It is not used for batch address processing. We will be exploring batch processing options as a possible future enhancement to this module.

*AVM will only validate US addresses. The validate button will become disabled when the address is non-US.

*AVM will only validate addresses that USPS can deliver to.

*Results are returned in UPPER CASE. This only affects the address however and the name/company fields will remain untouched and in the case you had entered them. This means that any merge letters you may use will still use the case of the names as you entered them.

=Future considerations=
*Batch processing
*Address validate imported catalog requests
*Allow for the user to choose from a possible list of candidates when an exact match is not found
*Option to require validation before save
*Option to validate all addresses on an order at once (mailing, shipping and billing)
*Option to validate the ship-to address from View Invoice screen (now available for the billing address)
*Return mixed case results
*Validate imported recipient lists or all ship-to's for multi-ship orders

=Video=
View our YouTube video to see the AVM module in action! http://www.youtube.com/watch?v=TWJsUcejEbc

[[Category:Published]]

Alternate search keywords - Address validation software, address verification module, address verification software, address correction.

=Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service=

With rather short notice, Endicia has elected to shut down their Dial-a-Zip (DaZ) service and only make address validation available through their Endicia Label Server (ELS) web service.

A CMS update is now available for CMS TEN users on our [https://updates.newhavensoftware.com/ Support Downloads site]. With version 10.0.14.273 we have temporarily transitioned CMS's address validation calls to the Endicia Label Server (ELS) sandbox account until we can secure a production account either for CMS or for individual customers.

If you find yourself on June 11th without a solution (either a CMS update and/or a working ELS account), there are some things to consider:

*What is the impact of not having addresses validated in CMS, albeit for a short time, while you wait for a solution or new ELS account (it appears one will be required) and is there anything you can do to mitigate those risks?
**Can you still get address validation on your website to mitigate the number of orders you are shipping without validation?
**If using UPS Worldship or FedEx Ship Manager with keyed imports, can you validate addresses in their software before generating the label?

*Disable address validation in CMS for your import order sources - With this option enabled, CMS will be automatically performing address validation for imported orders and, if that service is failing, it will stop your imports. Turn this option off [https://www.screencast.com/t/aat0jBFVHo as seen here] so your order imports can continue to flow in without error.
**If you are using the [[Automated Imports Module]] you'll also want to remove the validation check for processing orders that fail Address Validation, also highlighted in the screenshot linked above.

*While the above will allow your imports to come in without error, the Validate button will still be enabled throughout CMS where any address is displayed. Your operators will receive an error if they click on the Validate button. There is no option in CMS to disable this button but if you find that this is to confusing for your operators, we can issue you a new release code to disable the Address Validation option. We can reissue a new release code enabling it when desired.

Address Validation Module

2020-06-08T18:54:15Z

Russ horton: /* Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service */

=Introduction=
The Address Validation Module (AVM) links CMS to Endicia Label Server (ELS) allowing users to validate individual addresses against the latest USPS data in real-time. This validation not only ensures proper formatting of an address ([http://www.usps.com/ncsc/addressservices/certprograms/cass.htm CASS]) but also validates that the address is indeed deliverable! This will help you catch typos, missing apartment numbers, etc. whether they result from your operator or the customer. This option is available in CMS where there is an editable address. Watch our [http://www.youtube.com/watch?v=TWJsUcejEbc YouTube video on AVM] to see it in action!

This is rather different than AVS (Address Verification Service) which is used when you process credit cards. AVS is only used to verify that the billing address of the order is the same as the billing address of the cardholder. It does nothing to validate that the address is properly formatted or deliverable. If you use AVM to validate your address before processing the credit card, your AVS processing stands a better chance of getting a match.

To use AVM, you'll just click the new Validate button which is located by the address you want to validate. The validation response will indicate if your address could be validated and if so, it will also be standardized.

If the address could not be validated, that means the address was not close enough to a deliverable address to be corrected and the customer should be contacted to confirm their address information.

=What does the validation do?=

The service performs address validation and standardization. In other words, it will validate that the address is deliverable (according to USPS,) a real address...not just one properly formatted. It will also standardize the address (like CASS) to append Zip +4, convert Street to St and so on. Here is a basic example from the Contact Manager (Customers) section in CMS:

'''Submit (before):'''

[[image:6custbefore.jpg]]

'''Return (after):'''

[[image:6custafter.jpg]]

Note the changes made to the address in this example:

*Standardized the address
**converted Crossing to Xing
**moved the suite onto the same lines as the address (which should be done when there is room)
*Fixed the incorrect zip code
*Added the zip+4
*Set the county
*Set the commercial checkbox (RDI)
*Validate button turns from red to green
*Date of validation is displayed

It can also correct spelling errors anywhere in the address.

'''Other important points:'''

*If any edits are made to the validated address, it immediately reverts to showing as non-validated.
*If the billing and/or shipping address is the same as the mailing, they too will immediately be set as validated to match. This is even true if the billing=shipping and both are different than the mailing. In that situation, validating the shipping in this case would automatically set the billing as validated as well.
*An added benefit to the validation process is it will return the the Residential Delivery Indicator. CMS will use this RDI to flag the address as ''commercial'' when appropriate. FedEx and UPS both assess a residential surcharge to their shipments and this flag will let CMS know when a shipment can go commercial, saving you the ~$2 residential surcharge. This flag will pass through to the UPS and FedEx through our various shipping integrations automatically.

=Where does it work?=
The address validation option is available in the following screens:
*Order Entry, wherever an address is found
**Customer
**Items (the Address Editor used for adding multi-ship recipients)
**Shipping - Shipping Address>Modify (same Address Editor screen used for editing a shipping/recipient address)
**Money - Billing Address>Modify (same Address Editor screen)
**View Invoice - While you cannot validate from the View Invoice screen, we do color code the shipping and billing addresses shown here using red font to indicate a non-validated address and green to indicate a validated address. This color coding is also done on the Shipping and Money addresses. You can click on the billing address to bring up the editor and validate from there but this is not yet supported for the shipping addresses.

[[image:6oeview.jpg]]

*Contact Manager (Customers)
**Address - Mailing, Billing and Shipping

*Order Importing - As orders are imported (eCMS or any XML order source) you can tell CMS to attempt to validate all of the addresses in each order.

*Manifest - Clicking on the Shipping address displayed will bring up the Address Editor where the address can be validated.

*[[Purchasing (PO) Module]] - PO Billing and Shipping addresses (not Vendor addresses yet)

*Warehouses - In Setup you can validate the addresses associated with each of your warehouses.

=Performance=
Near instant responses, certainly sub-second. This performance was even maintained over the busy holiday seasons.

A few comments on why we think you should continue to expect this level of performance:

*There is very little data being passed back and forth. This will minimize the communication time and the possibility of performance degradation you would experience even from a poor internet connection.

*The CMS portion of the communication is near-instant so we are not adding any noticeable overhead to the processing time.

*We are subscribed to Endicia's highest service level.

*When we asked Endicia about performance expectations, they stated that on a busy day they would expect users to see validation times around a quarter of a second.

Your results may vary of course and are subject to workstation resources (RAM and CPU) and available internet bandwidth but our experience has shown near-immediate results. It is impressive.

=Automation=
While the Validate button is great for orders your operators are touching (either hand entering or verifying imported orders,) what can you do when importing orders automatically (using the [http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module]) where an operator may not be reviewing the order?

To address this (pun intended) you'll now find an address validation option available in Setup>Fulfillment>Fulfillment Options>Import Sources. For each import order-source you defined, you can choose if you want CMS to automatically validate addresses as they are imported. We have also made changes to our XML to support external address validation so you can import an order with a validated address. You'll be able to see when it was validated and CMS will know to skip trying to validate addresses that are importing 'pre-validated'.

[[image:6osavm.jpg]]

There is also a validation check for the Automated Imports module which will let you prevent an imported order from saving as a completed order if any of its addresses failed validation. In those cases it will be available for manual review in the Verify Orders section...the same as any other validation exception (e.g. unrecognized product code, order not fully paid, back order, international, etc.)

[[image:6viavm.jpg]]

=Limitations=
*A workstation must have Internet access to use the Address Validation Module. CMS is communicating directly from the workstation to the web service for Endicia Label Server.

*The AVM does not perform NCOA type move changes. In other words, it is not checking to see if that person lives at that address, only that the address is deliverable and standardized. It will however match on company name if one is present. NCOA processing, where you can match the recipient name to their address, is only available by submitting data to Peachtree.

*The AVM only validates individual addresses. It is not used for batch address processing. We will be exploring batch processing options as a possible future enhancement to this module.

*AVM will only validate US addresses. The validate button will become disabled when the address is non-US.

*AVM will only validate addresses that USPS can deliver to.

*Results are returned in UPPER CASE. This only affects the address however and the name/company fields will remain untouched and in the case you had entered them. This means that any merge letters you may use will still use the case of the names as you entered them.

=Future considerations=
*Batch processing
*Address validate imported catalog requests
*Allow for the user to choose from a possible list of candidates when an exact match is not found
*Option to require validation before save
*Option to validate all addresses on an order at once (mailing, shipping and billing)
*Option to validate the ship-to address from View Invoice screen (now available for the billing address)
*Return mixed case results
*Validate imported recipient lists or all ship-to's for multi-ship orders

=Video=
View our YouTube video to see the AVM module in action! http://www.youtube.com/watch?v=TWJsUcejEbc

[[Category:Published]]

Alternate search keywords - Address validation software, address verification module, address verification software, address correction.

=Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service=

With rather short notice, Endicia has elected to shut down their Dial-a-Zip (DaZ) service and only make address validation available through their Endicia Label Server (ELS) web service. If you find yourself on June 11th without a solution (either a CMS update and/or a working ELS account), there are some things to consider:

*What is the impact of not having addresses validated in CMS, albeit for a short time, while you wait for a solution or new ELS account (it appears one will be required) and is there anything you can do to mitigate those risks?
**Can you still get address validation on your website to mitigate the number of orders you are shipping without validation?
**If using UPS Worldship or FedEx Ship Manager with keyed imports, can you validate addresses in their software before generating the label?

*Disable address validation in CMS for your import order sources - With this option enabled, CMS will be automatically performing address validation for imported orders and, if that service is failing, it will stop your imports. Turn this option off [https://www.screencast.com/t/aat0jBFVHo as seen here] so your order imports can continue to flow in without error.
**If you are using the [[Automated Imports Module]] you'll also want to remove the validation check for processing orders that fail Address Validation, also highlighted in the screenshot linked above.

*While the above will allow your imports to come in without error, the Validate button will still be enabled throughout CMS where any address is displayed. Your operators will receive an error if they click on the Validate button. There is no option in CMS to disable this button but if you find that this is to confusing for your operators, we can issue you a new release code to disable the Address Validation option. We can reissue a new release code enabling it when desired.

Address Validation Module

2020-06-08T18:53:36Z

Russ horton: /* Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service */

=Introduction=
The Address Validation Module (AVM) links CMS to Endicia Label Server (ELS) allowing users to validate individual addresses against the latest USPS data in real-time. This validation not only ensures proper formatting of an address ([http://www.usps.com/ncsc/addressservices/certprograms/cass.htm CASS]) but also validates that the address is indeed deliverable! This will help you catch typos, missing apartment numbers, etc. whether they result from your operator or the customer. This option is available in CMS where there is an editable address. Watch our [http://www.youtube.com/watch?v=TWJsUcejEbc YouTube video on AVM] to see it in action!

This is rather different than AVS (Address Verification Service) which is used when you process credit cards. AVS is only used to verify that the billing address of the order is the same as the billing address of the cardholder. It does nothing to validate that the address is properly formatted or deliverable. If you use AVM to validate your address before processing the credit card, your AVS processing stands a better chance of getting a match.

To use AVM, you'll just click the new Validate button which is located by the address you want to validate. The validation response will indicate if your address could be validated and if so, it will also be standardized.

If the address could not be validated, that means the address was not close enough to a deliverable address to be corrected and the customer should be contacted to confirm their address information.

=What does the validation do?=

The service performs address validation and standardization. In other words, it will validate that the address is deliverable (according to USPS,) a real address...not just one properly formatted. It will also standardize the address (like CASS) to append Zip +4, convert Street to St and so on. Here is a basic example from the Contact Manager (Customers) section in CMS:

'''Submit (before):'''

[[image:6custbefore.jpg]]

'''Return (after):'''

[[image:6custafter.jpg]]

Note the changes made to the address in this example:

*Standardized the address
**converted Crossing to Xing
**moved the suite onto the same lines as the address (which should be done when there is room)
*Fixed the incorrect zip code
*Added the zip+4
*Set the county
*Set the commercial checkbox (RDI)
*Validate button turns from red to green
*Date of validation is displayed

It can also correct spelling errors anywhere in the address.

'''Other important points:'''

*If any edits are made to the validated address, it immediately reverts to showing as non-validated.
*If the billing and/or shipping address is the same as the mailing, they too will immediately be set as validated to match. This is even true if the billing=shipping and both are different than the mailing. In that situation, validating the shipping in this case would automatically set the billing as validated as well.
*An added benefit to the validation process is it will return the the Residential Delivery Indicator. CMS will use this RDI to flag the address as ''commercial'' when appropriate. FedEx and UPS both assess a residential surcharge to their shipments and this flag will let CMS know when a shipment can go commercial, saving you the ~$2 residential surcharge. This flag will pass through to the UPS and FedEx through our various shipping integrations automatically.

=Where does it work?=
The address validation option is available in the following screens:
*Order Entry, wherever an address is found
**Customer
**Items (the Address Editor used for adding multi-ship recipients)
**Shipping - Shipping Address>Modify (same Address Editor screen used for editing a shipping/recipient address)
**Money - Billing Address>Modify (same Address Editor screen)
**View Invoice - While you cannot validate from the View Invoice screen, we do color code the shipping and billing addresses shown here using red font to indicate a non-validated address and green to indicate a validated address. This color coding is also done on the Shipping and Money addresses. You can click on the billing address to bring up the editor and validate from there but this is not yet supported for the shipping addresses.

[[image:6oeview.jpg]]

*Contact Manager (Customers)
**Address - Mailing, Billing and Shipping

*Order Importing - As orders are imported (eCMS or any XML order source) you can tell CMS to attempt to validate all of the addresses in each order.

*Manifest - Clicking on the Shipping address displayed will bring up the Address Editor where the address can be validated.

*[[Purchasing (PO) Module]] - PO Billing and Shipping addresses (not Vendor addresses yet)

*Warehouses - In Setup you can validate the addresses associated with each of your warehouses.

=Performance=
Near instant responses, certainly sub-second. This performance was even maintained over the busy holiday seasons.

A few comments on why we think you should continue to expect this level of performance:

*There is very little data being passed back and forth. This will minimize the communication time and the possibility of performance degradation you would experience even from a poor internet connection.

*The CMS portion of the communication is near-instant so we are not adding any noticeable overhead to the processing time.

*We are subscribed to Endicia's highest service level.

*When we asked Endicia about performance expectations, they stated that on a busy day they would expect users to see validation times around a quarter of a second.

Your results may vary of course and are subject to workstation resources (RAM and CPU) and available internet bandwidth but our experience has shown near-immediate results. It is impressive.

=Automation=
While the Validate button is great for orders your operators are touching (either hand entering or verifying imported orders,) what can you do when importing orders automatically (using the [http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module]) where an operator may not be reviewing the order?

To address this (pun intended) you'll now find an address validation option available in Setup>Fulfillment>Fulfillment Options>Import Sources. For each import order-source you defined, you can choose if you want CMS to automatically validate addresses as they are imported. We have also made changes to our XML to support external address validation so you can import an order with a validated address. You'll be able to see when it was validated and CMS will know to skip trying to validate addresses that are importing 'pre-validated'.

[[image:6osavm.jpg]]

There is also a validation check for the Automated Imports module which will let you prevent an imported order from saving as a completed order if any of its addresses failed validation. In those cases it will be available for manual review in the Verify Orders section...the same as any other validation exception (e.g. unrecognized product code, order not fully paid, back order, international, etc.)

[[image:6viavm.jpg]]

=Limitations=
*A workstation must have Internet access to use the Address Validation Module. CMS is communicating directly from the workstation to the web service for Endicia Label Server.

*The AVM does not perform NCOA type move changes. In other words, it is not checking to see if that person lives at that address, only that the address is deliverable and standardized. It will however match on company name if one is present. NCOA processing, where you can match the recipient name to their address, is only available by submitting data to Peachtree.

*The AVM only validates individual addresses. It is not used for batch address processing. We will be exploring batch processing options as a possible future enhancement to this module.

*AVM will only validate US addresses. The validate button will become disabled when the address is non-US.

*AVM will only validate addresses that USPS can deliver to.

*Results are returned in UPPER CASE. This only affects the address however and the name/company fields will remain untouched and in the case you had entered them. This means that any merge letters you may use will still use the case of the names as you entered them.

=Future considerations=
*Batch processing
*Address validate imported catalog requests
*Allow for the user to choose from a possible list of candidates when an exact match is not found
*Option to require validation before save
*Option to validate all addresses on an order at once (mailing, shipping and billing)
*Option to validate the ship-to address from View Invoice screen (now available for the billing address)
*Return mixed case results
*Validate imported recipient lists or all ship-to's for multi-ship orders

=Video=
View our YouTube video to see the AVM module in action! http://www.youtube.com/watch?v=TWJsUcejEbc

[[Category:Published]]

Alternate search keywords - Address validation software, address verification module, address verification software, address correction.

=Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service=

With rather short notice, Endicia has elected to shut down their Dial-a-Zip (DaZ) service and only make address validation available through their Endicia Label Server (ELS) web service. If you find yourself on June 11th without a solution (either a CMS update and/or a working ELS account), there are some things to consider:

*What is the impact of not having addresses validated in CMS, albeit for a short time, while you wait for a solution or new ELS account (it appears one will be required) and is there anything you can do to mitigate those risks?
**Can you still get address validation on your website to mitigate the number of orders you are shipping without validation?
**If using UPS Worldship or FedEx Ship Manager with keyed imports, can you validate addresses in their software before generating the label?

*Disable address validation in CMS for your import order sources - With this option enabled, CMS will be automatically performing address validation for imported orders and, if that service is failing, it will stop your imports. Turn this option off [https://www.screencast.com/t/aat0jBFVHo as seen here] so your order imports can continue to flow in without error.
**If you are using the [[Automated Imports Module]] you'll also want to remove the validation check for processing orders that fail Address Validation, also highlighted in the screenshot linked above.

*While the above will allow your imports to come in without error, the Validate button will still be enabled throughout CMS where any address is displayed. Your operators will receive an error if they click on the Validate button. There is no option in CMS to disable this button but if you find that this is to confusing for your operators, we can issue you a new release code to disable the Address Validation option. We can reissue a new release cod enabling it when desired.

Address Validation Module

2020-06-08T18:52:41Z

Russ horton: /* Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service */

=Introduction=
The Address Validation Module (AVM) links CMS to Endicia Label Server (ELS) allowing users to validate individual addresses against the latest USPS data in real-time. This validation not only ensures proper formatting of an address ([http://www.usps.com/ncsc/addressservices/certprograms/cass.htm CASS]) but also validates that the address is indeed deliverable! This will help you catch typos, missing apartment numbers, etc. whether they result from your operator or the customer. This option is available in CMS where there is an editable address. Watch our [http://www.youtube.com/watch?v=TWJsUcejEbc YouTube video on AVM] to see it in action!

This is rather different than AVS (Address Verification Service) which is used when you process credit cards. AVS is only used to verify that the billing address of the order is the same as the billing address of the cardholder. It does nothing to validate that the address is properly formatted or deliverable. If you use AVM to validate your address before processing the credit card, your AVS processing stands a better chance of getting a match.

To use AVM, you'll just click the new Validate button which is located by the address you want to validate. The validation response will indicate if your address could be validated and if so, it will also be standardized.

If the address could not be validated, that means the address was not close enough to a deliverable address to be corrected and the customer should be contacted to confirm their address information.

=What does the validation do?=

The service performs address validation and standardization. In other words, it will validate that the address is deliverable (according to USPS,) a real address...not just one properly formatted. It will also standardize the address (like CASS) to append Zip +4, convert Street to St and so on. Here is a basic example from the Contact Manager (Customers) section in CMS:

'''Submit (before):'''

[[image:6custbefore.jpg]]

'''Return (after):'''

[[image:6custafter.jpg]]

Note the changes made to the address in this example:

*Standardized the address
**converted Crossing to Xing
**moved the suite onto the same lines as the address (which should be done when there is room)
*Fixed the incorrect zip code
*Added the zip+4
*Set the county
*Set the commercial checkbox (RDI)
*Validate button turns from red to green
*Date of validation is displayed

It can also correct spelling errors anywhere in the address.

'''Other important points:'''

*If any edits are made to the validated address, it immediately reverts to showing as non-validated.
*If the billing and/or shipping address is the same as the mailing, they too will immediately be set as validated to match. This is even true if the billing=shipping and both are different than the mailing. In that situation, validating the shipping in this case would automatically set the billing as validated as well.
*An added benefit to the validation process is it will return the the Residential Delivery Indicator. CMS will use this RDI to flag the address as ''commercial'' when appropriate. FedEx and UPS both assess a residential surcharge to their shipments and this flag will let CMS know when a shipment can go commercial, saving you the ~$2 residential surcharge. This flag will pass through to the UPS and FedEx through our various shipping integrations automatically.

=Where does it work?=
The address validation option is available in the following screens:
*Order Entry, wherever an address is found
**Customer
**Items (the Address Editor used for adding multi-ship recipients)
**Shipping - Shipping Address>Modify (same Address Editor screen used for editing a shipping/recipient address)
**Money - Billing Address>Modify (same Address Editor screen)
**View Invoice - While you cannot validate from the View Invoice screen, we do color code the shipping and billing addresses shown here using red font to indicate a non-validated address and green to indicate a validated address. This color coding is also done on the Shipping and Money addresses. You can click on the billing address to bring up the editor and validate from there but this is not yet supported for the shipping addresses.

[[image:6oeview.jpg]]

*Contact Manager (Customers)
**Address - Mailing, Billing and Shipping

*Order Importing - As orders are imported (eCMS or any XML order source) you can tell CMS to attempt to validate all of the addresses in each order.

*Manifest - Clicking on the Shipping address displayed will bring up the Address Editor where the address can be validated.

*[[Purchasing (PO) Module]] - PO Billing and Shipping addresses (not Vendor addresses yet)

*Warehouses - In Setup you can validate the addresses associated with each of your warehouses.

=Performance=
Near instant responses, certainly sub-second. This performance was even maintained over the busy holiday seasons.

A few comments on why we think you should continue to expect this level of performance:

*There is very little data being passed back and forth. This will minimize the communication time and the possibility of performance degradation you would experience even from a poor internet connection.

*The CMS portion of the communication is near-instant so we are not adding any noticeable overhead to the processing time.

*We are subscribed to Endicia's highest service level.

*When we asked Endicia about performance expectations, they stated that on a busy day they would expect users to see validation times around a quarter of a second.

Your results may vary of course and are subject to workstation resources (RAM and CPU) and available internet bandwidth but our experience has shown near-immediate results. It is impressive.

=Automation=
While the Validate button is great for orders your operators are touching (either hand entering or verifying imported orders,) what can you do when importing orders automatically (using the [http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module]) where an operator may not be reviewing the order?

To address this (pun intended) you'll now find an address validation option available in Setup>Fulfillment>Fulfillment Options>Import Sources. For each import order-source you defined, you can choose if you want CMS to automatically validate addresses as they are imported. We have also made changes to our XML to support external address validation so you can import an order with a validated address. You'll be able to see when it was validated and CMS will know to skip trying to validate addresses that are importing 'pre-validated'.

[[image:6osavm.jpg]]

There is also a validation check for the Automated Imports module which will let you prevent an imported order from saving as a completed order if any of its addresses failed validation. In those cases it will be available for manual review in the Verify Orders section...the same as any other validation exception (e.g. unrecognized product code, order not fully paid, back order, international, etc.)

[[image:6viavm.jpg]]

=Limitations=
*A workstation must have Internet access to use the Address Validation Module. CMS is communicating directly from the workstation to the web service for Endicia Label Server.

*The AVM does not perform NCOA type move changes. In other words, it is not checking to see if that person lives at that address, only that the address is deliverable and standardized. It will however match on company name if one is present. NCOA processing, where you can match the recipient name to their address, is only available by submitting data to Peachtree.

*The AVM only validates individual addresses. It is not used for batch address processing. We will be exploring batch processing options as a possible future enhancement to this module.

*AVM will only validate US addresses. The validate button will become disabled when the address is non-US.

*AVM will only validate addresses that USPS can deliver to.

*Results are returned in UPPER CASE. This only affects the address however and the name/company fields will remain untouched and in the case you had entered them. This means that any merge letters you may use will still use the case of the names as you entered them.

=Future considerations=
*Batch processing
*Address validate imported catalog requests
*Allow for the user to choose from a possible list of candidates when an exact match is not found
*Option to require validation before save
*Option to validate all addresses on an order at once (mailing, shipping and billing)
*Option to validate the ship-to address from View Invoice screen (now available for the billing address)
*Return mixed case results
*Validate imported recipient lists or all ship-to's for multi-ship orders

=Video=
View our YouTube video to see the AVM module in action! http://www.youtube.com/watch?v=TWJsUcejEbc

[[Category:Published]]

Alternate search keywords - Address validation software, address verification module, address verification software, address correction.

=Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service=

With rather short notice, Endicia has elected to shut down their Dial-a-Zip (DaZ) service and only make address validation available through their Endicia Label Server (ELS) web service. If you find yourself on June 11th without a solution (either a CMS update and/or a working ELS account), there are some things to consider:

*What is the impact of not having addresses validated in CMS, albeit for a short time, while you wait for a solution or new ELS account (it appears one will be required) and is there anything you can do to mitigate those risks?
**Can you still get address validation on your website to mitigate the number of orders you are shipping without validation?
**If using UPS Worldship or FedEx Ship Manager with keyed imports, can you validate addresses in their software before generating the label?

*Disable address validation in CMS for your import order sources - With this option enabled, CMS will be automatically performing address validation for imported orders and, if that service is failing, it will stop your imports. Turn this option off [https://www.screencast.com/t/aat0jBFVHo as seen here] so your order imports can continue to flow in without error.

**If you are using the [[Automated Imports Module]] you'll also want to remove the validation check for processing orders that fail Address Validation, also highlighted in the screenshot linked above.

*While the above will allow your imports to come in without error, the Validate button will still be enabled throughout CMS where any address is displayed. Your operators will receive an error if they click on the Validate button. There is no option in CMS to disable this button but if you find that this is to confusing for your operators, we can issue you a new release code to disable the Address Validation option. We can reissue a new release cod enabling it when desired.

Address Validation Module

2020-06-08T18:48:50Z

Russ horton: /* Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service */

=Introduction=
The Address Validation Module (AVM) links CMS to Endicia Label Server (ELS) allowing users to validate individual addresses against the latest USPS data in real-time. This validation not only ensures proper formatting of an address ([http://www.usps.com/ncsc/addressservices/certprograms/cass.htm CASS]) but also validates that the address is indeed deliverable! This will help you catch typos, missing apartment numbers, etc. whether they result from your operator or the customer. This option is available in CMS where there is an editable address. Watch our [http://www.youtube.com/watch?v=TWJsUcejEbc YouTube video on AVM] to see it in action!

This is rather different than AVS (Address Verification Service) which is used when you process credit cards. AVS is only used to verify that the billing address of the order is the same as the billing address of the cardholder. It does nothing to validate that the address is properly formatted or deliverable. If you use AVM to validate your address before processing the credit card, your AVS processing stands a better chance of getting a match.

To use AVM, you'll just click the new Validate button which is located by the address you want to validate. The validation response will indicate if your address could be validated and if so, it will also be standardized.

If the address could not be validated, that means the address was not close enough to a deliverable address to be corrected and the customer should be contacted to confirm their address information.

=What does the validation do?=

The service performs address validation and standardization. In other words, it will validate that the address is deliverable (according to USPS,) a real address...not just one properly formatted. It will also standardize the address (like CASS) to append Zip +4, convert Street to St and so on. Here is a basic example from the Contact Manager (Customers) section in CMS:

'''Submit (before):'''

[[image:6custbefore.jpg]]

'''Return (after):'''

[[image:6custafter.jpg]]

Note the changes made to the address in this example:

*Standardized the address
**converted Crossing to Xing
**moved the suite onto the same lines as the address (which should be done when there is room)
*Fixed the incorrect zip code
*Added the zip+4
*Set the county
*Set the commercial checkbox (RDI)
*Validate button turns from red to green
*Date of validation is displayed

It can also correct spelling errors anywhere in the address.

'''Other important points:'''

*If any edits are made to the validated address, it immediately reverts to showing as non-validated.
*If the billing and/or shipping address is the same as the mailing, they too will immediately be set as validated to match. This is even true if the billing=shipping and both are different than the mailing. In that situation, validating the shipping in this case would automatically set the billing as validated as well.
*An added benefit to the validation process is it will return the the Residential Delivery Indicator. CMS will use this RDI to flag the address as ''commercial'' when appropriate. FedEx and UPS both assess a residential surcharge to their shipments and this flag will let CMS know when a shipment can go commercial, saving you the ~$2 residential surcharge. This flag will pass through to the UPS and FedEx through our various shipping integrations automatically.

=Where does it work?=
The address validation option is available in the following screens:
*Order Entry, wherever an address is found
**Customer
**Items (the Address Editor used for adding multi-ship recipients)
**Shipping - Shipping Address>Modify (same Address Editor screen used for editing a shipping/recipient address)
**Money - Billing Address>Modify (same Address Editor screen)
**View Invoice - While you cannot validate from the View Invoice screen, we do color code the shipping and billing addresses shown here using red font to indicate a non-validated address and green to indicate a validated address. This color coding is also done on the Shipping and Money addresses. You can click on the billing address to bring up the editor and validate from there but this is not yet supported for the shipping addresses.

[[image:6oeview.jpg]]

*Contact Manager (Customers)
**Address - Mailing, Billing and Shipping

*Order Importing - As orders are imported (eCMS or any XML order source) you can tell CMS to attempt to validate all of the addresses in each order.

*Manifest - Clicking on the Shipping address displayed will bring up the Address Editor where the address can be validated.

*[[Purchasing (PO) Module]] - PO Billing and Shipping addresses (not Vendor addresses yet)

*Warehouses - In Setup you can validate the addresses associated with each of your warehouses.

=Performance=
Near instant responses, certainly sub-second. This performance was even maintained over the busy holiday seasons.

A few comments on why we think you should continue to expect this level of performance:

*There is very little data being passed back and forth. This will minimize the communication time and the possibility of performance degradation you would experience even from a poor internet connection.

*The CMS portion of the communication is near-instant so we are not adding any noticeable overhead to the processing time.

*We are subscribed to Endicia's highest service level.

*When we asked Endicia about performance expectations, they stated that on a busy day they would expect users to see validation times around a quarter of a second.

Your results may vary of course and are subject to workstation resources (RAM and CPU) and available internet bandwidth but our experience has shown near-immediate results. It is impressive.

=Automation=
While the Validate button is great for orders your operators are touching (either hand entering or verifying imported orders,) what can you do when importing orders automatically (using the [http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module]) where an operator may not be reviewing the order?

To address this (pun intended) you'll now find an address validation option available in Setup>Fulfillment>Fulfillment Options>Import Sources. For each import order-source you defined, you can choose if you want CMS to automatically validate addresses as they are imported. We have also made changes to our XML to support external address validation so you can import an order with a validated address. You'll be able to see when it was validated and CMS will know to skip trying to validate addresses that are importing 'pre-validated'.

[[image:6osavm.jpg]]

There is also a validation check for the Automated Imports module which will let you prevent an imported order from saving as a completed order if any of its addresses failed validation. In those cases it will be available for manual review in the Verify Orders section...the same as any other validation exception (e.g. unrecognized product code, order not fully paid, back order, international, etc.)

[[image:6viavm.jpg]]

=Limitations=
*A workstation must have Internet access to use the Address Validation Module. CMS is communicating directly from the workstation to the web service for Endicia Label Server.

*The AVM does not perform NCOA type move changes. In other words, it is not checking to see if that person lives at that address, only that the address is deliverable and standardized. It will however match on company name if one is present. NCOA processing, where you can match the recipient name to their address, is only available by submitting data to Peachtree.

*The AVM only validates individual addresses. It is not used for batch address processing. We will be exploring batch processing options as a possible future enhancement to this module.

*AVM will only validate US addresses. The validate button will become disabled when the address is non-US.

*AVM will only validate addresses that USPS can deliver to.

*Results are returned in UPPER CASE. This only affects the address however and the name/company fields will remain untouched and in the case you had entered them. This means that any merge letters you may use will still use the case of the names as you entered them.

=Future considerations=
*Batch processing
*Address validate imported catalog requests
*Allow for the user to choose from a possible list of candidates when an exact match is not found
*Option to require validation before save
*Option to validate all addresses on an order at once (mailing, shipping and billing)
*Option to validate the ship-to address from View Invoice screen (now available for the billing address)
*Return mixed case results
*Validate imported recipient lists or all ship-to's for multi-ship orders

=Video=
View our YouTube video to see the AVM module in action! http://www.youtube.com/watch?v=TWJsUcejEbc

[[Category:Published]]

Alternate search keywords - Address validation software, address verification module, address verification software, address correction.

=Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service=

With rather short notice, Endicia has elected to shut down their Dial-a-Zip (DaZ) service and only make address validation available through their Endicia Label Server (ELS) web service. If you find yourself on June 11th without a solution (either a CMS update and/or a working ELS account), there are some things to consider:

*Consider the impact of not having addresses validated in CMS, albeit for a short time while you wait for a solution or new ELS account. Can you still get address validation on your website to mitigate the number of orders you are shipping without validation?

*Disable address validation in CMS for your import order sources - With this option enabled, CMS will be automatically performing address validation for imported orders and, if that service is failing, it will stop your imports. Turn this option off [https://www.screencast.com/t/aat0jBFVHo as seen here] so your order imports can continue to flow in without error.

**If you are using the [[Automated Imports Module]] you'll also want to remove the validation check for processing orders that fail Address Validation, also highlighted in the screenshot linked above.

*While the above will allow your imports to come in without error, the Validate button will still be enabled throughout CMS where any address is displayed. Your operators will receive an error if they click on the Validate button. There is no option in CMS to disable this button but if you find that this is to confusing for your operators, we can issue you a new release code to disable the Address Validation option. We can reissue a new release cod enabling it when desired.

Address Validation Module

2020-06-08T18:00:24Z

Russ horton: /* Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service */

=Introduction=
The Address Validation Module (AVM) links CMS to Endicia Label Server (ELS) allowing users to validate individual addresses against the latest USPS data in real-time. This validation not only ensures proper formatting of an address ([http://www.usps.com/ncsc/addressservices/certprograms/cass.htm CASS]) but also validates that the address is indeed deliverable! This will help you catch typos, missing apartment numbers, etc. whether they result from your operator or the customer. This option is available in CMS where there is an editable address. Watch our [http://www.youtube.com/watch?v=TWJsUcejEbc YouTube video on AVM] to see it in action!

This is rather different than AVS (Address Verification Service) which is used when you process credit cards. AVS is only used to verify that the billing address of the order is the same as the billing address of the cardholder. It does nothing to validate that the address is properly formatted or deliverable. If you use AVM to validate your address before processing the credit card, your AVS processing stands a better chance of getting a match.

To use AVM, you'll just click the new Validate button which is located by the address you want to validate. The validation response will indicate if your address could be validated and if so, it will also be standardized.

If the address could not be validated, that means the address was not close enough to a deliverable address to be corrected and the customer should be contacted to confirm their address information.

=What does the validation do?=

The service performs address validation and standardization. In other words, it will validate that the address is deliverable (according to USPS,) a real address...not just one properly formatted. It will also standardize the address (like CASS) to append Zip +4, convert Street to St and so on. Here is a basic example from the Contact Manager (Customers) section in CMS:

'''Submit (before):'''

[[image:6custbefore.jpg]]

'''Return (after):'''

[[image:6custafter.jpg]]

Note the changes made to the address in this example:

*Standardized the address
**converted Crossing to Xing
**moved the suite onto the same lines as the address (which should be done when there is room)
*Fixed the incorrect zip code
*Added the zip+4
*Set the county
*Set the commercial checkbox (RDI)
*Validate button turns from red to green
*Date of validation is displayed

It can also correct spelling errors anywhere in the address.

'''Other important points:'''

*If any edits are made to the validated address, it immediately reverts to showing as non-validated.
*If the billing and/or shipping address is the same as the mailing, they too will immediately be set as validated to match. This is even true if the billing=shipping and both are different than the mailing. In that situation, validating the shipping in this case would automatically set the billing as validated as well.
*An added benefit to the validation process is it will return the the Residential Delivery Indicator. CMS will use this RDI to flag the address as ''commercial'' when appropriate. FedEx and UPS both assess a residential surcharge to their shipments and this flag will let CMS know when a shipment can go commercial, saving you the ~$2 residential surcharge. This flag will pass through to the UPS and FedEx through our various shipping integrations automatically.

=Where does it work?=
The address validation option is available in the following screens:
*Order Entry, wherever an address is found
**Customer
**Items (the Address Editor used for adding multi-ship recipients)
**Shipping - Shipping Address>Modify (same Address Editor screen used for editing a shipping/recipient address)
**Money - Billing Address>Modify (same Address Editor screen)
**View Invoice - While you cannot validate from the View Invoice screen, we do color code the shipping and billing addresses shown here using red font to indicate a non-validated address and green to indicate a validated address. This color coding is also done on the Shipping and Money addresses. You can click on the billing address to bring up the editor and validate from there but this is not yet supported for the shipping addresses.

[[image:6oeview.jpg]]

*Contact Manager (Customers)
**Address - Mailing, Billing and Shipping

*Order Importing - As orders are imported (eCMS or any XML order source) you can tell CMS to attempt to validate all of the addresses in each order.

*Manifest - Clicking on the Shipping address displayed will bring up the Address Editor where the address can be validated.

*[[Purchasing (PO) Module]] - PO Billing and Shipping addresses (not Vendor addresses yet)

*Warehouses - In Setup you can validate the addresses associated with each of your warehouses.

=Performance=
Near instant responses, certainly sub-second. This performance was even maintained over the busy holiday seasons.

A few comments on why we think you should continue to expect this level of performance:

*There is very little data being passed back and forth. This will minimize the communication time and the possibility of performance degradation you would experience even from a poor internet connection.

*The CMS portion of the communication is near-instant so we are not adding any noticeable overhead to the processing time.

*We are subscribed to Endicia's highest service level.

*When we asked Endicia about performance expectations, they stated that on a busy day they would expect users to see validation times around a quarter of a second.

Your results may vary of course and are subject to workstation resources (RAM and CPU) and available internet bandwidth but our experience has shown near-immediate results. It is impressive.

=Automation=
While the Validate button is great for orders your operators are touching (either hand entering or verifying imported orders,) what can you do when importing orders automatically (using the [http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module]) where an operator may not be reviewing the order?

To address this (pun intended) you'll now find an address validation option available in Setup>Fulfillment>Fulfillment Options>Import Sources. For each import order-source you defined, you can choose if you want CMS to automatically validate addresses as they are imported. We have also made changes to our XML to support external address validation so you can import an order with a validated address. You'll be able to see when it was validated and CMS will know to skip trying to validate addresses that are importing 'pre-validated'.

[[image:6osavm.jpg]]

There is also a validation check for the Automated Imports module which will let you prevent an imported order from saving as a completed order if any of its addresses failed validation. In those cases it will be available for manual review in the Verify Orders section...the same as any other validation exception (e.g. unrecognized product code, order not fully paid, back order, international, etc.)

[[image:6viavm.jpg]]

=Limitations=
*A workstation must have Internet access to use the Address Validation Module. CMS is communicating directly from the workstation to the web service for Endicia Label Server.

*The AVM does not perform NCOA type move changes. In other words, it is not checking to see if that person lives at that address, only that the address is deliverable and standardized. It will however match on company name if one is present. NCOA processing, where you can match the recipient name to their address, is only available by submitting data to Peachtree.

*The AVM only validates individual addresses. It is not used for batch address processing. We will be exploring batch processing options as a possible future enhancement to this module.

*AVM will only validate US addresses. The validate button will become disabled when the address is non-US.

*AVM will only validate addresses that USPS can deliver to.

*Results are returned in UPPER CASE. This only affects the address however and the name/company fields will remain untouched and in the case you had entered them. This means that any merge letters you may use will still use the case of the names as you entered them.

=Future considerations=
*Batch processing
*Address validate imported catalog requests
*Allow for the user to choose from a possible list of candidates when an exact match is not found
*Option to require validation before save
*Option to validate all addresses on an order at once (mailing, shipping and billing)
*Option to validate the ship-to address from View Invoice screen (now available for the billing address)
*Return mixed case results
*Validate imported recipient lists or all ship-to's for multi-ship orders

=Video=
View our YouTube video to see the AVM module in action! http://www.youtube.com/watch?v=TWJsUcejEbc

[[Category:Published]]

Alternate search keywords - Address validation software, address verification module, address verification software, address correction.

=Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service=

With rather short notice, Endicia has elected to shut down their Dial-a-Zip (DaZ) service and only make address validation available through their Endicia Label Server (ELS) web service. If you find yourself on June 11th without a solution (either a CMS update and/or a working ELS account), there are some things to consider:

*Disable address validation for your import order sources -

**If you are using the [[Automated Imports Module]] you'll also want to remove the validation check for failed

Address Validation Module

2020-06-08T17:59:39Z

Russ horton:

=Introduction=
The Address Validation Module (AVM) links CMS to Endicia Label Server (ELS) allowing users to validate individual addresses against the latest USPS data in real-time. This validation not only ensures proper formatting of an address ([http://www.usps.com/ncsc/addressservices/certprograms/cass.htm CASS]) but also validates that the address is indeed deliverable! This will help you catch typos, missing apartment numbers, etc. whether they result from your operator or the customer. This option is available in CMS where there is an editable address. Watch our [http://www.youtube.com/watch?v=TWJsUcejEbc YouTube video on AVM] to see it in action!

This is rather different than AVS (Address Verification Service) which is used when you process credit cards. AVS is only used to verify that the billing address of the order is the same as the billing address of the cardholder. It does nothing to validate that the address is properly formatted or deliverable. If you use AVM to validate your address before processing the credit card, your AVS processing stands a better chance of getting a match.

To use AVM, you'll just click the new Validate button which is located by the address you want to validate. The validation response will indicate if your address could be validated and if so, it will also be standardized.

If the address could not be validated, that means the address was not close enough to a deliverable address to be corrected and the customer should be contacted to confirm their address information.

=What does the validation do?=

The service performs address validation and standardization. In other words, it will validate that the address is deliverable (according to USPS,) a real address...not just one properly formatted. It will also standardize the address (like CASS) to append Zip +4, convert Street to St and so on. Here is a basic example from the Contact Manager (Customers) section in CMS:

'''Submit (before):'''

[[image:6custbefore.jpg]]

'''Return (after):'''

[[image:6custafter.jpg]]

Note the changes made to the address in this example:

*Standardized the address
**converted Crossing to Xing
**moved the suite onto the same lines as the address (which should be done when there is room)
*Fixed the incorrect zip code
*Added the zip+4
*Set the county
*Set the commercial checkbox (RDI)
*Validate button turns from red to green
*Date of validation is displayed

It can also correct spelling errors anywhere in the address.

'''Other important points:'''

*If any edits are made to the validated address, it immediately reverts to showing as non-validated.
*If the billing and/or shipping address is the same as the mailing, they too will immediately be set as validated to match. This is even true if the billing=shipping and both are different than the mailing. In that situation, validating the shipping in this case would automatically set the billing as validated as well.
*An added benefit to the validation process is it will return the the Residential Delivery Indicator. CMS will use this RDI to flag the address as ''commercial'' when appropriate. FedEx and UPS both assess a residential surcharge to their shipments and this flag will let CMS know when a shipment can go commercial, saving you the ~$2 residential surcharge. This flag will pass through to the UPS and FedEx through our various shipping integrations automatically.

=Where does it work?=
The address validation option is available in the following screens:
*Order Entry, wherever an address is found
**Customer
**Items (the Address Editor used for adding multi-ship recipients)
**Shipping - Shipping Address>Modify (same Address Editor screen used for editing a shipping/recipient address)
**Money - Billing Address>Modify (same Address Editor screen)
**View Invoice - While you cannot validate from the View Invoice screen, we do color code the shipping and billing addresses shown here using red font to indicate a non-validated address and green to indicate a validated address. This color coding is also done on the Shipping and Money addresses. You can click on the billing address to bring up the editor and validate from there but this is not yet supported for the shipping addresses.

[[image:6oeview.jpg]]

*Contact Manager (Customers)
**Address - Mailing, Billing and Shipping

*Order Importing - As orders are imported (eCMS or any XML order source) you can tell CMS to attempt to validate all of the addresses in each order.

*Manifest - Clicking on the Shipping address displayed will bring up the Address Editor where the address can be validated.

*[[Purchasing (PO) Module]] - PO Billing and Shipping addresses (not Vendor addresses yet)

*Warehouses - In Setup you can validate the addresses associated with each of your warehouses.

=Performance=
Near instant responses, certainly sub-second. This performance was even maintained over the busy holiday seasons.

A few comments on why we think you should continue to expect this level of performance:

*There is very little data being passed back and forth. This will minimize the communication time and the possibility of performance degradation you would experience even from a poor internet connection.

*The CMS portion of the communication is near-instant so we are not adding any noticeable overhead to the processing time.

*We are subscribed to Endicia's highest service level.

*When we asked Endicia about performance expectations, they stated that on a busy day they would expect users to see validation times around a quarter of a second.

Your results may vary of course and are subject to workstation resources (RAM and CPU) and available internet bandwidth but our experience has shown near-immediate results. It is impressive.

=Automation=
While the Validate button is great for orders your operators are touching (either hand entering or verifying imported orders,) what can you do when importing orders automatically (using the [http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module]) where an operator may not be reviewing the order?

To address this (pun intended) you'll now find an address validation option available in Setup>Fulfillment>Fulfillment Options>Import Sources. For each import order-source you defined, you can choose if you want CMS to automatically validate addresses as they are imported. We have also made changes to our XML to support external address validation so you can import an order with a validated address. You'll be able to see when it was validated and CMS will know to skip trying to validate addresses that are importing 'pre-validated'.

[[image:6osavm.jpg]]

There is also a validation check for the Automated Imports module which will let you prevent an imported order from saving as a completed order if any of its addresses failed validation. In those cases it will be available for manual review in the Verify Orders section...the same as any other validation exception (e.g. unrecognized product code, order not fully paid, back order, international, etc.)

[[image:6viavm.jpg]]

=Limitations=
*A workstation must have Internet access to use the Address Validation Module. CMS is communicating directly from the workstation to the web service for Endicia Label Server.

*The AVM does not perform NCOA type move changes. In other words, it is not checking to see if that person lives at that address, only that the address is deliverable and standardized. It will however match on company name if one is present. NCOA processing, where you can match the recipient name to their address, is only available by submitting data to Peachtree.

*The AVM only validates individual addresses. It is not used for batch address processing. We will be exploring batch processing options as a possible future enhancement to this module.

*AVM will only validate US addresses. The validate button will become disabled when the address is non-US.

*AVM will only validate addresses that USPS can deliver to.

*Results are returned in UPPER CASE. This only affects the address however and the name/company fields will remain untouched and in the case you had entered them. This means that any merge letters you may use will still use the case of the names as you entered them.

=Future considerations=
*Batch processing
*Address validate imported catalog requests
*Allow for the user to choose from a possible list of candidates when an exact match is not found
*Option to require validation before save
*Option to validate all addresses on an order at once (mailing, shipping and billing)
*Option to validate the ship-to address from View Invoice screen (now available for the billing address)
*Return mixed case results
*Validate imported recipient lists or all ship-to's for multi-ship orders

=Video=
View our YouTube video to see the AVM module in action! http://www.youtube.com/watch?v=TWJsUcejEbc

[[Category:Published]]

Alternate search keywords - Address validation software, address verification module, address verification software, address correction.

=Managing the June 11, 2020 shutdown of Endicia's Dial-a-Zip service=

With rather short notice, Endicia has elected to shut down their Dial-a-Zip service and only make address validation available through their Endicia Label Server (ELS) web service. If you find yourself on June 11th without a solution (either a CMS update and/or a working ELS account), there are some things to consider:

*Disable address validation for your import order sources -

**If you are using the [[Automated Imports Module]] you'll also want to remove the validation check for failed

Address Validation Module

2020-05-29T20:13:47Z

Russ horton: /* Limitations */

Address Validation Module

2020-05-29T20:13:13Z

Russ horton: /* Performance */

=Introduction=
The Address Validation Module (AVM) links CMS to Endicia Label Server (ELS) allowing users to validate individual addresses against the latest USPS data in real-time. This validation not only ensures proper formatting of an address ([http://www.usps.com/ncsc/addressservices/certprograms/cass.htm CASS]) but also validates that the address is indeed deliverable! This will help you catch typos, missing apartment numbers, etc. whether they result from your operator or the customer. This option is available in CMS where there is an editable address. Watch our [http://www.youtube.com/watch?v=TWJsUcejEbc YouTube video on AVM] to see it in action!

This is rather different than AVS (Address Verification Service) which is used when you process credit cards. AVS is only used to verify that the billing address of the order is the same as the billing address of the cardholder. It does nothing to validate that the address is properly formatted or deliverable. If you use AVM to validate your address before processing the credit card, your AVS processing stands a better chance of getting a match.

To use AVM, you'll just click the new Validate button which is located by the address you want to validate. The validation response will indicate if your address could be validated and if so, it will also be standardized.

If the address could not be validated, that means the address was not close enough to a deliverable address to be corrected and the customer should be contacted to confirm their address information.

=What does the validation do?=

The service performs address validation and standardization. In other words, it will validate that the address is deliverable (according to USPS,) a real address...not just one properly formatted. It will also standardize the address (like CASS) to append Zip +4, convert Street to St and so on. Here is a basic example from the Contact Manager (Customers) section in CMS:

'''Submit (before):'''

[[image:6custbefore.jpg]]

'''Return (after):'''

[[image:6custafter.jpg]]

Note the changes made to the address in this example:

*Standardized the address
**converted Crossing to Xing
**moved the suite onto the same lines as the address (which should be done when there is room)
*Fixed the incorrect zip code
*Added the zip+4
*Set the county
*Set the commercial checkbox (RDI)
*Validate button turns from red to green
*Date of validation is displayed

It can also correct spelling errors anywhere in the address.

'''Other important points:'''

*If any edits are made to the validated address, it immediately reverts to showing as non-validated.
*If the billing and/or shipping address is the same as the mailing, they too will immediately be set as validated to match. This is even true if the billing=shipping and both are different than the mailing. In that situation, validating the shipping in this case would automatically set the billing as validated as well.
*An added benefit to the validation process is it will return the the Residential Delivery Indicator. CMS will use this RDI to flag the address as ''commercial'' when appropriate. FedEx and UPS both assess a residential surcharge to their shipments and this flag will let CMS know when a shipment can go commercial, saving you the ~$2 residential surcharge. This flag will pass through to the UPS and FedEx through our various shipping integrations automatically.

=Where does it work?=
The address validation option is available in the following screens:
*Order Entry, wherever an address is found
**Customer
**Items (the Address Editor used for adding multi-ship recipients)
**Shipping - Shipping Address>Modify (same Address Editor screen used for editing a shipping/recipient address)
**Money - Billing Address>Modify (same Address Editor screen)
**View Invoice - While you cannot validate from the View Invoice screen, we do color code the shipping and billing addresses shown here using red font to indicate a non-validated address and green to indicate a validated address. This color coding is also done on the Shipping and Money addresses. You can click on the billing address to bring up the editor and validate from there but this is not yet supported for the shipping addresses.

[[image:6oeview.jpg]]

*Contact Manager (Customers)
**Address - Mailing, Billing and Shipping

*Order Importing - As orders are imported (eCMS or any XML order source) you can tell CMS to attempt to validate all of the addresses in each order.

*Manifest - Clicking on the Shipping address displayed will bring up the Address Editor where the address can be validated.

*[[Purchasing (PO) Module]] - PO Billing and Shipping addresses (not Vendor addresses yet)

*Warehouses - In Setup you can validate the addresses associated with each of your warehouses.

=Performance=
Near instant responses, certainly sub-second. This performance was even maintained over the busy holiday seasons.

A few comments on why we think you should continue to expect this level of performance:

*There is very little data being passed back and forth. This will minimize the communication time and the possibility of performance degradation you would experience even from a poor internet connection.

*The CMS portion of the communication is near-instant so we are not adding any noticeable overhead to the processing time.

*We are subscribed to Endicia's highest service level.

*When we asked Endicia about performance expectations, they stated that on a busy day they would expect users to see validation times around a quarter of a second.

Your results may vary of course and are subject to workstation resources (RAM and CPU) and available internet bandwidth but our experience has shown near-immediate results. It is impressive.

=Automation=
While the Validate button is great for orders your operators are touching (either hand entering or verifying imported orders,) what can you do when importing orders automatically (using the [http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module]) where an operator may not be reviewing the order?

To address this (pun intended) you'll now find an address validation option available in Setup>Fulfillment>Fulfillment Options>Import Sources. For each import order-source you defined, you can choose if you want CMS to automatically validate addresses as they are imported. We have also made changes to our XML to support external address validation so you can import an order with a validated address. You'll be able to see when it was validated and CMS will know to skip trying to validate addresses that are importing 'pre-validated'.

[[image:6osavm.jpg]]

There is also a validation check for the Automated Imports module which will let you prevent an imported order from saving as a completed order if any of its addresses failed validation. In those cases it will be available for manual review in the Verify Orders section...the same as any other validation exception (e.g. unrecognized product code, order not fully paid, back order, international, etc.)

[[image:6viavm.jpg]]

=Limitations=
*A workstation must have Internet access to use the Address Validation Module. CMS is communicating directly from the workstation to the Dial-a-Zip web server.

*The AVM does not perform NCOA type move changes. In other words, it is not checking to see if that person lives at that address, only that the address is deliverable and standardized. It will however match on company name if one is present. NCOA processing, where you can match the recipient name to their address, is only available by submitting data to Peachtree.

*The AVM only validates individual addresses. It is not used for batch address processing. We will be exploring batch processing options as a possible future enhancement to this module.

*AVM will only validate US addresses. The validate button will become disabled when the address is non-US.

*AVM will only validate addresses that USPS can deliver to.

*Results are returned in UPPER CASE. This only affects the address however and the name/company fields will remain untouched and in the case you had entered them. This means that any merge letters you may use will still use the case of the names as you entered them.

=Future considerations=
*Batch processing
*Address validate imported catalog requests
*Allow for the user to choose from a possible list of candidates when an exact match is not found
*Option to require validation before save
*Option to validate all addresses on an order at once (mailing, shipping and billing)
*Option to validate the ship-to address from View Invoice screen (now available for the billing address)
*Return mixed case results
*Validate imported recipient lists or all ship-to's for multi-ship orders

=Video=
View our YouTube video to see the AVM module in action! http://www.youtube.com/watch?v=TWJsUcejEbc

[[Category:Published]]

Alternate search keywords - Address validation software, address verification module, address verification software, address correction.

Address Validation Module

2020-05-29T20:12:19Z

Russ horton: /* Introduction */

=Introduction=
The Address Validation Module (AVM) links CMS to Endicia Label Server (ELS) allowing users to validate individual addresses against the latest USPS data in real-time. This validation not only ensures proper formatting of an address ([http://www.usps.com/ncsc/addressservices/certprograms/cass.htm CASS]) but also validates that the address is indeed deliverable! This will help you catch typos, missing apartment numbers, etc. whether they result from your operator or the customer. This option is available in CMS where there is an editable address. Watch our [http://www.youtube.com/watch?v=TWJsUcejEbc YouTube video on AVM] to see it in action!

This is rather different than AVS (Address Verification Service) which is used when you process credit cards. AVS is only used to verify that the billing address of the order is the same as the billing address of the cardholder. It does nothing to validate that the address is properly formatted or deliverable. If you use AVM to validate your address before processing the credit card, your AVS processing stands a better chance of getting a match.

To use AVM, you'll just click the new Validate button which is located by the address you want to validate. The validation response will indicate if your address could be validated and if so, it will also be standardized.

If the address could not be validated, that means the address was not close enough to a deliverable address to be corrected and the customer should be contacted to confirm their address information.

=What does the validation do?=

The service performs address validation and standardization. In other words, it will validate that the address is deliverable (according to USPS,) a real address...not just one properly formatted. It will also standardize the address (like CASS) to append Zip +4, convert Street to St and so on. Here is a basic example from the Contact Manager (Customers) section in CMS:

'''Submit (before):'''

[[image:6custbefore.jpg]]

'''Return (after):'''

[[image:6custafter.jpg]]

Note the changes made to the address in this example:

*Standardized the address
**converted Crossing to Xing
**moved the suite onto the same lines as the address (which should be done when there is room)
*Fixed the incorrect zip code
*Added the zip+4
*Set the county
*Set the commercial checkbox (RDI)
*Validate button turns from red to green
*Date of validation is displayed

It can also correct spelling errors anywhere in the address.

'''Other important points:'''

*If any edits are made to the validated address, it immediately reverts to showing as non-validated.
*If the billing and/or shipping address is the same as the mailing, they too will immediately be set as validated to match. This is even true if the billing=shipping and both are different than the mailing. In that situation, validating the shipping in this case would automatically set the billing as validated as well.
*An added benefit to the validation process is it will return the the Residential Delivery Indicator. CMS will use this RDI to flag the address as ''commercial'' when appropriate. FedEx and UPS both assess a residential surcharge to their shipments and this flag will let CMS know when a shipment can go commercial, saving you the ~$2 residential surcharge. This flag will pass through to the UPS and FedEx through our various shipping integrations automatically.

=Where does it work?=
The address validation option is available in the following screens:
*Order Entry, wherever an address is found
**Customer
**Items (the Address Editor used for adding multi-ship recipients)
**Shipping - Shipping Address>Modify (same Address Editor screen used for editing a shipping/recipient address)
**Money - Billing Address>Modify (same Address Editor screen)
**View Invoice - While you cannot validate from the View Invoice screen, we do color code the shipping and billing addresses shown here using red font to indicate a non-validated address and green to indicate a validated address. This color coding is also done on the Shipping and Money addresses. You can click on the billing address to bring up the editor and validate from there but this is not yet supported for the shipping addresses.

[[image:6oeview.jpg]]

*Contact Manager (Customers)
**Address - Mailing, Billing and Shipping

*Order Importing - As orders are imported (eCMS or any XML order source) you can tell CMS to attempt to validate all of the addresses in each order.

*Manifest - Clicking on the Shipping address displayed will bring up the Address Editor where the address can be validated.

*[[Purchasing (PO) Module]] - PO Billing and Shipping addresses (not Vendor addresses yet)

*Warehouses - In Setup you can validate the addresses associated with each of your warehouses.

=Performance=
Near instant responses, certainly sub-second. This performance was even maintained over the busy holiday seasons.

A few comments on why we think you should continue to expect this level of performance:

*There is very little data being passed back and forth. This will minimize the communication time and the possibility of performance degradation you would experience even from a poor internet connection.

*The CMS portion of the communication is near instant so we are not adding any noticeable overhead to the processing time.

*We are subscribed at Endicia's highest service level.

*Working through a custom third-party shipping solution which also uses Dial-a-Zip showed that address validation added ~1 second to label processing.

*When we asked Endicia about performance expectations, they stated that on a busy day they would expect users to see validation times around a quarter of a second.

Your results may vary of course and are subject to workstation resources (RAM and CPU) and available internet bandwidth but our experience has shown near immediate results. It is impressive.

=Automation=
While the Validate button is great for orders your operators are touching (either hand entering or verifying imported orders,) what can you do when importing orders automatically (using the [http://wiki.newhavensoftware.com/index.php/Automated_Imports_Module Automated Imports Module]) where an operator may not be reviewing the order?

To address this (pun intended) you'll now find an address validation option available in Setup>Fulfillment>Fulfillment Options>Import Sources. For each import order-source you defined, you can choose if you want CMS to automatically validate addresses as they are imported. We have also made changes to our XML to support external address validation so you can import an order with a validated address. You'll be able to see when it was validated and CMS will know to skip trying to validate addresses that are importing 'pre-validated'.

[[image:6osavm.jpg]]

There is also a validation check for the Automated Imports module which will let you prevent an imported order from saving as a completed order if any of its addresses failed validation. In those cases it will be available for manual review in the Verify Orders section...the same as any other validation exception (e.g. unrecognized product code, order not fully paid, back order, international, etc.)

[[image:6viavm.jpg]]

=Limitations=
*A workstation must have Internet access to use the Address Validation Module. CMS is communicating directly from the workstation to the Dial-a-Zip web server.

*The AVM does not perform NCOA type move changes. In other words, it is not checking to see if that person lives at that address, only that the address is deliverable and standardized. It will however match on company name if one is present. NCOA processing, where you can match the recipient name to their address, is only available by submitting data to Peachtree.

*The AVM only validates individual addresses. It is not used for batch address processing. We will be exploring batch processing options as a possible future enhancement to this module.

*AVM will only validate US addresses. The validate button will become disabled when the address is non-US.

*AVM will only validate addresses that USPS can deliver to.

*Results are returned in UPPER CASE. This only affects the address however and the name/company fields will remain untouched and in the case you had entered them. This means that any merge letters you may use will still use the case of the names as you entered them.

=Future considerations=
*Batch processing
*Address validate imported catalog requests
*Allow for the user to choose from a possible list of candidates when an exact match is not found
*Option to require validation before save
*Option to validate all addresses on an order at once (mailing, shipping and billing)
*Option to validate the ship-to address from View Invoice screen (now available for the billing address)
*Return mixed case results
*Validate imported recipient lists or all ship-to's for multi-ship orders

=Video=
View our YouTube video to see the AVM module in action! http://www.youtube.com/watch?v=TWJsUcejEbc

[[Category:Published]]

Alternate search keywords - Address validation software, address verification module, address verification software, address correction.

CMS TEN Upgrade Plan

2020-05-05T19:58:31Z

Russ horton: /* Required */

=Prep=
==Required==
*Whats New in CMS TEN - Review the CMS TEN Release Notes:
**[http://updates.newhavensoftware.com/whatsnew1001.htm v10.0.1]
**[https://updates.newhavensoftware.com/whatsnew1005.htm v10.0.5]
**[https://updates.newhavensoftware.com/whatsnew10014.htm v10.0.14 (current)]
*Encryption - The Encryption option in PCI Administration must be enabled before installing CMS TEN. Please log into CMS as PC Administrator and verify yours is turned on before proceeding. To do this, log into CMS as PCI Administrator and go PCI Administration>PCI. Your button for encryption should read 'Re-Encrypt' AND say "no further action is necessary" as seen in this [http://screencast.com/t/0qiBvCUQ7u screenshot]. If so, you're set and there's nothing more you need to do (no need to re-encrypt). If instead the button says "Encrypt" or you have a message that says "http://screencast.com/t/B8Q07gVur Your credit card holder data needs to be updated..." this means you'll need to run the Encrypt/Re-Encrypt. We recommend you run encryption overnight while everyone is out of the CMS. If you install the update and encryption has not been run, the install will warn you of this encryption issue and abort.
*If you worked with us on testing the UPS Worldship keyed imports performance solution in CMS 9.x, please contact NHS Support to have that removed before you update to CMS TEN (the latest version of this solution will be installed with CMS TEN but this is not designed to update the beta implementation of this feature from v9).
*Custom Reports and Forms - Please consider installing a test version of CMS TEN to confirm they will work with CMS TEN. If there are any issues, please contact NewHaven Software Support to contract any necessary fixes.
*Custom Integrations - NewHaven will keep all standard integrations current including those with UPS, FedEx, Endicia, Peachtree, and payment gateways. If you have developed any integrations of your own, please consider installing a test version of CMS TEN to confirm they will continue to work. Please contact NewHaven Support if you'd like assistance with setting up or updating your test environment. A list of the database and XML changes can be found in the [http://updates.newhavensoftware.com/v10release_notes.htm#db Release Notes].
*Database Connections - If you have any database connections to CMS that are using the dbo database user credentials, they must be switched to the cmsuser credentials or your connections will fail. We recommend updating these before installing CMS TEN to ensure no connection errors.
**The default password for cmsuser is case sensitive and is CMSUser. As part of your PA-DSS Implementation this password should have been changed long ago, but, if you are still using it, be sure that you have the case correct. The most common use of an ODBC connection to your database is for keyed imports from UPS Worldship, it's ODBC connections named CMSPackages and CMSPackagesExport.

=Install=
'''NOTE: You must be running CMS 8.0 or later before upgrading to CMS TEN'''
*Test Installs - Go [http://wiki.newhavensoftware.com/index.php/Test_Install HERE] for information on installing a test environment. 
*All Installs
#Get everyone out of CMS (TIP: delete the file CMSNET.dat from the \NewHaven Software directory to confirm all users are logged out. If you are unable to delete the file, it means there are still users logged into CMS. They will need to log out or you can disconnect the open files on the server at the risk of their losing their work.)
#Update your server - This process may take up to twice as long as a typical server update. Upgrades from versions earlier than 8.x are not supported and, in such cases, an intermediate update to 8.0 will be necessary. NOTE - Your version 9 release code can be used to upgrade to CMS TEN, no new code required.
##Verify you can log into CMS without error
#Update workstations - Only necessary for Windows 8.x or 10 workstations

=After Install=
==Required==
Reiterating the above, if you have any workstations running Windows 8.x or Windows 10, you'll need to run a CMS workstation update on each to ensure the database drivers have been updated. This workstation update is run using the same installer software that was used to update your server.

There are otherwise no further post-update steps required.

==Recommended (optional)==
Changes or settings worth examining shortly after updating (if you've not already done so in a test environment):
#Last Card Used - If CMS is configured to recall the last credit card used, in such situations a new dialog message comes up asking if you want to use the card ending in XXXX (displaying last four digits.) If yes, the card will come over masked (cannot be unmasked) or, if you say no, you can proceed with entering a new payment. Previous versions would have just recalled the payment without telling you the last four and, if it was not the one you wanted, you would have had to delete the payment. Keep in mind card data is only retained per your PCI Data Retention Policy so no prompt to use the last card will be presented once the card data has been removed from the database.
#Manifest Changes - A few changes here worth reviewing before turning your shipping dept. loose on it for the first time.
##We've changed the way shipping methods are selected in the Manifest and added features to allow the setting of carrier pickup dates.
##Also, if you have multiple shipping stations using the Manifest, the default is now that each station will only show its own packages instead of a master list of all manifested packages.
##See a full list of Manifest changes in our [https://updates.newhavensoftware.com/v1001release_notes.htm#link-1-21 Release Notes]
#CMS TEN supports 'Active' flags now which are on by default. Removing this flag will prevent inactive choices from being offered in Order Entry or other places where new transactions are created. Inactive choices are still viable though for orders that were created using those now inactive choices. The goal is not to remove these choices from your system entirely but instead to limit new transactions to using only current options.
##Shipping Methods
##Adcodes
##Order Source
##Price Catagories

=Known Issues=
*CMS is attempting order status uploads for all eCMS order sources. If you've never uploaded order status before, you may experience an error since the resulting upload would be too large (potentially years worth of data.) There is an easy/quick fix to this which our Tech Support staff can assist you with if you run into it. Issues Dev-201 and 221

CMS TEN Upgrade Plan

2020-05-05T19:57:44Z

Russ horton: /* Install */

=Prep=
==Required==
*Whats New in CMS TEN - Review the CMS TEN Release Notes:
**[http://updates.newhavensoftware.com/whatsnew1001.htm v10.0.1]
**[https://updates.newhavensoftware.com/whatsnew1005.htm v10.0.5]
**[https://updates.newhavensoftware.com/whatsnew10014.htm v10.0.14 (current)]
*Encryption - The Encryption option in PCI Administration must be enabled before installing CMS TEN. Please log into CMS as PC Administrator and verify yours is turned on before proceeding. To do this, log into CMS as PCI Administrator and go PCI Administration>PCI. Your button for encryption should read 'Re-Encrypt' AND say "no further action is necessary" as seen in this [http://screencast.com/t/0qiBvCUQ7u screenshot]. If so, you're set and there's nothing more you need to do (no need to re-encrypt). If instead the button says "Encrypt" or you have a message that says "http://screencast.com/t/B8Q07gVur Your credit card holder data needs to be updated..." this means you'll need to run the Encrypt/Re-Encrypt. We recommend you run encryption overnight while everyone is out of the CMS. If you install the update and encryption has not been run, the install will warn you of this encryption issue and abort.
*If you worked with us on testing the UPS Worldship keyed imports performance solution in CMS 9.x, please contact NHS Support to have that removed before you update to CMS TEN (the latest version of this solution will be installed with CMS TEN but this is not designed to update the beta implementation of this feature from v9).
*Custom Reports and Forms - Please consider installing a test version of CMS TEN to confirm they will work with CMS TEN. If there are any issues, please contact NewHaven Software Support to contract any necessary fixes.
*Custom Integrations - NewHaven will keep all standard integrations current including those with UPS, FedEx, Endicia, Peachtree, and payment gateways. If you have developed any integrations of your own, please consider installing a test version of CMS TEN to confirm they will continue to work. Please contact NewHaven Support if you'd like assistance with setting up or updating your test environment. A list of the database and XML changes can be found in the [http://updates.newhavensoftware.com/v10release_notes.htm#db Release Notes].
*Database Connections - If you have any database connections to CMS that are using the dbo database user credentials, they must be switched to the cmsuser credentials or your connections will fail. We recommend updating these before installing CMS TEN to ensure no connection errors.
**The default password for cmsuser is case sensitive and is CMSUser. As part of your PA-DSS Implementation this password should have been changed long ago, but, if you are still using it, be sure that you have the case correct. The most common use of an ODBC connection to your database is for keyed imports from UPS Worldship, it's ODBC connections named CMSPackages and CMSPackagesExport.

=Install=
'''NOTE: You must be running CMS 8.0 or later before upgrading to CMS TEN'''
*Test Installs - Go [http://wiki.newhavensoftware.com/index.php/Test_Install HERE] for information on installing a test environment. 
*All Installs
#Get everyone out of CMS (TIP: delete the file CMSNET.dat from the \NewHaven Software directory to confirm all users are logged out. If you are unable to delete the file, it means there are still users logged into CMS. They will need to log out or you can disconnect the open files on the server at the risk of their losing their work.)
#Update your server - This process may take up to twice as long as a typical server update. Upgrades from versions earlier than 8.x are not supported and, in such cases, an intermediate update to 8.0 will be necessary. NOTE - Your version 9 release code can be used to upgrade to CMS TEN, no new code required.
##Verify you can log into CMS without error
#Update workstations - Only necessary for Windows 8.x or 10 workstations

=After Install=
==Required==
Reiterating the above, if you have any workstations running Windows 8.x, you'll need to run a CMS workstation update on each to ensure the database drivers have been updated. No need to update workstations running operating systems other than Windows 8.x. This workstation update is run using the same installer software that was used to update your server.

Otherwise there are no post-update steps required.

==Recommended (optional)==
Changes or settings worth examining shortly after updating (if you've not already done so in a test environment):
#Last Card Used - If CMS is configured to recall the last credit card used, in such situations a new dialog message comes up asking if you want to use the card ending in XXXX (displaying last four digits.) If yes, the card will come over masked (cannot be unmasked) or, if you say no, you can proceed with entering a new payment. Previous versions would have just recalled the payment without telling you the last four and, if it was not the one you wanted, you would have had to delete the payment. Keep in mind card data is only retained per your PCI Data Retention Policy so no prompt to use the last card will be presented once the card data has been removed from the database.
#Manifest Changes - A few changes here worth reviewing before turning your shipping dept. loose on it for the first time.
##We've changed the way shipping methods are selected in the Manifest and added features to allow the setting of carrier pickup dates.
##Also, if you have multiple shipping stations using the Manifest, the default is now that each station will only show its own packages instead of a master list of all manifested packages.
##See a full list of Manifest changes in our [https://updates.newhavensoftware.com/v1001release_notes.htm#link-1-21 Release Notes]
#CMS TEN supports 'Active' flags now which are on by default. Removing this flag will prevent inactive choices from being offered in Order Entry or other places where new transactions are created. Inactive choices are still viable though for orders that were created using those now inactive choices. The goal is not to remove these choices from your system entirely but instead to limit new transactions to using only current options.
##Shipping Methods
##Adcodes
##Order Source
##Price Catagories

=Known Issues=
*CMS is attempting order status uploads for all eCMS order sources. If you've never uploaded order status before, you may experience an error since the resulting upload would be too large (potentially years worth of data.) There is an easy/quick fix to this which our Tech Support staff can assist you with if you run into it. Issues Dev-201 and 221

CMS TEN Upgrade Plan

2020-05-05T19:52:55Z

Russ horton: /* Required */

=Prep=
==Required==
*Whats New in CMS TEN - Review the CMS TEN Release Notes:
**[http://updates.newhavensoftware.com/whatsnew1001.htm v10.0.1]
**[https://updates.newhavensoftware.com/whatsnew1005.htm v10.0.5]
**[https://updates.newhavensoftware.com/whatsnew10014.htm v10.0.14 (current)]
*Encryption - The Encryption option in PCI Administration must be enabled before installing CMS TEN. Please log into CMS as PC Administrator and verify yours is turned on before proceeding. To do this, log into CMS as PCI Administrator and go PCI Administration>PCI. Your button for encryption should read 'Re-Encrypt' AND say "no further action is necessary" as seen in this [http://screencast.com/t/0qiBvCUQ7u screenshot]. If so, you're set and there's nothing more you need to do (no need to re-encrypt). If instead the button says "Encrypt" or you have a message that says "http://screencast.com/t/B8Q07gVur Your credit card holder data needs to be updated..." this means you'll need to run the Encrypt/Re-Encrypt. We recommend you run encryption overnight while everyone is out of the CMS. If you install the update and encryption has not been run, the install will warn you of this encryption issue and abort.
*If you worked with us on testing the UPS Worldship keyed imports performance solution in CMS 9.x, please contact NHS Support to have that removed before you update to CMS TEN (the latest version of this solution will be installed with CMS TEN but this is not designed to update the beta implementation of this feature from v9).
*Custom Reports and Forms - Please consider installing a test version of CMS TEN to confirm they will work with CMS TEN. If there are any issues, please contact NewHaven Software Support to contract any necessary fixes.
*Custom Integrations - NewHaven will keep all standard integrations current including those with UPS, FedEx, Endicia, Peachtree, and payment gateways. If you have developed any integrations of your own, please consider installing a test version of CMS TEN to confirm they will continue to work. Please contact NewHaven Support if you'd like assistance with setting up or updating your test environment. A list of the database and XML changes can be found in the [http://updates.newhavensoftware.com/v10release_notes.htm#db Release Notes].
*Database Connections - If you have any database connections to CMS that are using the dbo database user credentials, they must be switched to the cmsuser credentials or your connections will fail. We recommend updating these before installing CMS TEN to ensure no connection errors.
**The default password for cmsuser is case sensitive and is CMSUser. As part of your PA-DSS Implementation this password should have been changed long ago, but, if you are still using it, be sure that you have the case correct. The most common use of an ODBC connection to your database is for keyed imports from UPS Worldship, it's ODBC connections named CMSPackages and CMSPackagesExport.

=Install=
'''NOTE: You must be running CMS 8.0 or later before upgrading to CMS TEN'''
*Test Installs - Go [http://wiki.newhavensoftware.com/index.php/Test_Install HERE] for information on installing a test environment. 
*All Installs
#Get everyone out of CMS (TIP: delete the file CMSNET.dat from the \NewHaven Software directory to confirm all users are logged out. If you are unable to delete the file, it means there are still users logged into CMS. They will need to log out or you can disconnect the open files on the server at the risk of their losing their work.)
#Update your server - This process may take up to twice as long as a typical server update. Upgrades from versions earlier than 8.x are not supported and, in such cases, an intermediate update to 8.0 will be necessary. NOTE - Your version 9 release code can be used to upgrade to CMS TEN, no new code required.
##Verify you can log into CMS without error
#Update workstations - Only necessary for Windows 8.x workstations

=After Install=
==Required==
Reiterating the above, if you have any workstations running Windows 8.x, you'll need to run a CMS workstation update on each to ensure the database drivers have been updated. No need to update workstations running operating systems other than Windows 8.x. This workstation update is run using the same installer software that was used to update your server.

Otherwise there are no post-update steps required.

==Recommended (optional)==
Changes or settings worth examining shortly after updating (if you've not already done so in a test environment):
#Last Card Used - If CMS is configured to recall the last credit card used, in such situations a new dialog message comes up asking if you want to use the card ending in XXXX (displaying last four digits.) If yes, the card will come over masked (cannot be unmasked) or, if you say no, you can proceed with entering a new payment. Previous versions would have just recalled the payment without telling you the last four and, if it was not the one you wanted, you would have had to delete the payment. Keep in mind card data is only retained per your PCI Data Retention Policy so no prompt to use the last card will be presented once the card data has been removed from the database.
#Manifest Changes - A few changes here worth reviewing before turning your shipping dept. loose on it for the first time.
##We've changed the way shipping methods are selected in the Manifest and added features to allow the setting of carrier pickup dates.
##Also, if you have multiple shipping stations using the Manifest, the default is now that each station will only show its own packages instead of a master list of all manifested packages.
##See a full list of Manifest changes in our [https://updates.newhavensoftware.com/v1001release_notes.htm#link-1-21 Release Notes]
#CMS TEN supports 'Active' flags now which are on by default. Removing this flag will prevent inactive choices from being offered in Order Entry or other places where new transactions are created. Inactive choices are still viable though for orders that were created using those now inactive choices. The goal is not to remove these choices from your system entirely but instead to limit new transactions to using only current options.
##Shipping Methods
##Adcodes
##Order Source
##Price Catagories

=Known Issues=
*CMS is attempting order status uploads for all eCMS order sources. If you've never uploaded order status before, you may experience an error since the resulting upload would be too large (potentially years worth of data.) There is an easy/quick fix to this which our Tech Support staff can assist you with if you run into it. Issues Dev-201 and 221