| contents |acumatica-builds.s3.amazonaws.com/builds/6.10/pdf/acumaticaerp... · | acumatica erp...

| Contents | 2

Contents

Copyright......................................................................................................5

Acumatica ERP and Acumatica Framework Installation Guide......................6

System Requirements for Acumatica ERP 6.1.............................................. 7

System Requirements for Acumatica Framework 6.1................................. 10

Typical Hardware Configurations for PCS and PCP Licenses....................... 12

Preparing for Installing Acumatica ERP..................................................... 19Configuring Web Server (IIS) Features............................................................................. 19Setting Up an HTTPS Service in Web Server (IIS)..............................................................19Enabling Semantic Search for Microsoft SQL Server........................................................... 19

Installing Acumatica ERP........................................................................... 21Installing Acumatica ERP Locally...................................................................................... 21

To Install the Acumatica ERP Tools..........................................................................21To Deploy an Acumatica ERP Instance.....................................................................22To Change the Password at the First Logon..............................................................25

Setting Up Acumatica Self-Service Portal.......................................................................... 26To Deploy a Self-Service Portal Instance..................................................................26To Specify the Company Available for Self-Service Portal Users...................................28

Installing Acumatica ERP in a Data Center........................................................................ 29Deploying the Acumatica ERP Service on Windows Azure........................................... 29Installing Acumatica ERP on Amazon Web Services................................................... 34

Installing Acumatica Framework................................................................40To Install Acumatica Framework Tools.............................................................................. 40To Deploy an Acumatica Framework Instance.................................................................... 41To Change the Password at the First Logon.......................................................................43To Install Acumatica Framework Templates....................................................................... 44

Licensing and Activating Acumatica ERP....................................................45To Activate the License for an Acumatica ERP Instance.......................................................45

Maintaining Acumatica ERP........................................................................47To Check the State of Application Instances and Databases.................................................47To Turn On Snapshot Isolation Mode for a Database...........................................................48To View the Details of an Acumatica ERP Instance............................................................. 49To Change the Database of an Instance........................................................................... 49To Perform Database Maintenance....................................................................................50To Configure the Session Time-Out.................................................................................. 52

| Contents | 3

To Configure the Report Time-Out....................................................................................53To Configure the Query Time-Out.................................................................................... 53To Select Roles That Will Have Administrative Privileges......................................................54To Shorten the Names of the Customization Folders...........................................................54To Turn On Reminders.................................................................................................... 55To Turn On the My Tasks and Events Button..................................................................... 55

Maintaining Acumatica Framework............................................................ 57

Managing Companies................................................................................. 58Multi-Company Instances................................................................................................ 58To Add a New Company................................................................................................. 59To Delete an Existing Company....................................................................................... 61

Updating Acumatica ERP............................................................................62Updating Acumatica ERP by Using the Web Interface..........................................................63Updating Acumatica ERP by Using the Configuration Wizard................................................ 64Updating Your Acumatica ERP Service on Windows Azure....................................................65To Schedule the System Lockout..................................................................................... 66To Update Acumatica ERP by Using the Web Interface........................................................ 66To Update the Acumatica ERP Tools................................................................................. 67To Update the Database and Site of an Acumatica ERP Instance.......................................... 67To Update the Database of an Acumatica ERP Instance.......................................................68To Update the Site of an Acumatica ERP Instance.............................................................. 68To Download the Acumatica ERP Service Configuration File..................................................69To Update Your Acumatica ERP Service on Windows Azure.................................................. 70To Update a Client Application that Uses Screen-Based Web Services....................................71To Unlock an Acumatica ERP Instance.............................................................................. 72

Troubleshooting Acumatica ERP.................................................................73Troubleshooting Performance........................................................................................... 73

Step 1: Check the Most Basic Causes..................................................................... 74Step 2: Investigate Application Server Time and Database Server Time in the Request Profiler78Step 3: Check the Configuration of the Application Server......................................... 78Step 4: Check the Configuration of the Database Server and Run Reports.................... 80Step 5: Collect More Information............................................................................82Step 6: Submit a Case to Acumatica Support...........................................................87

Using Logs.................................................................................................................... 88Using Profilers................................................................................................................91Using Built-In Debugging Tools........................................................................................ 92Using Third-Party Tools................................................................................................... 93To Optimize Memory Consumption During Startup..............................................................93

Uninstalling Acumatica ERP....................................................................... 95To Delete an Acumatica ERP Application Instance...............................................................95

Using the Command-Line Tool................................................................... 96

| Contents | 4

The Command-Line Tool..................................................................................................96Possible Parameters and Values....................................................................................... 97To Create a Configuration File........................................................................................105Examples of the Configuration String..............................................................................106

| Copyright | 5

Copyright

© 2017 Acumatica, Inc.ALL RIGHTS RESERVED.

No part of this document may be reproduced, copied, or transmitted without the express prior consentof Acumatica, Inc.

11235 SE 6th, Suite 140Bellevue, WA 98004

Restricted Rights

The product is provided with restricted rights. Use, duplication, or disclosure by the United StatesGovernment is subject to restrictions as set forth in the applicable License and Services Agreementand in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS252.227-7013 or subparagraphs (c)(1) and (c)(2) of the Commercial Computer Software-RestrictedRights at 48 CFR 52.227-19, as applicable.

Disclaimer

Acumatica, Inc. makes no representations or warranties with respect to the contents or use of thisdocument, and specifically disclaims any express or implied warranties of merchantability or fitness forany particular purpose. Further, Acumatica, Inc. reserves the right to revise this document and makechanges in its content at any time, without obligation to notify any person or entity of such revisions orchanges.

Trademarks

Acumatica is a registered trademark of Acumatica, Inc. HubSpot is a registered trademark of HubSpot,Inc. Microsoft Exchange and Microsoft Exchange Server are registered trademarks of MicrosoftCorporation. All other product names and services herein are trademarks or service marks of theirrespective companies.

Software Version: 6.1

Last updated: July 20, 2017

| Acumatica ERP and Acumatica Framework Installation Guide | 6

Acumatica ERP and Acumatica FrameworkInstallation Guide

This guide provides system requirements and detailed instructions for installing, maintaining, updating,and deleting Acumatica ERP and Acumatica Framework.

This guide covers the following topics:

• System Requirements for Acumatica ERP 6.1

• System Requirements for Acumatica Framework 6.1

• Preparing for Installing Acumatica ERP

• Installing Acumatica ERP

• Installing Acumatica Framework

• Licensing and Activating Acumatica ERP

• Maintaining Acumatica ERP

• Maintaining Acumatica Framework

• Uninstalling Acumatica ERP

• Using the Command-Line Tool

| System Requirements for Acumatica ERP 6.1 | 7

System Requirements for Acumatica ERP 6.1

Acumatica ERP contains the following parts: web interface, the server part and the database. For properwork of each of these parts the environment where you install and use Acumatica ERP, should meetparticular requirements that are described in this topic.

: Before you start the installation process, install at least all critical updates (or, preferably, all availableupdates) for the operating system and the required software. You should also make sure that all requiredthird-party components listed in this topic are properly installed and configured on your computer.

Workstations

Workstations that are used by employees of your organization to work with Acumatica ERP should meethardware and software requirements listed in the table below.

Hardware/Software Requirements

Display resolution Minimum 1024×768, Typical 1920x1080

Adobe Reader (to openAcumatica ERP PDFdocuments)

XI and higher

Microsoft Office (to viewdocuments exportedfrom Acumatica ERP)

• 2016

• 2013

• 2010

• 2007

• 2003 with the Microsoft Office 2007 compatibility pack

Web Browsers

Microsoft InternetExplorer

9, 10, and 11 with Compatibility View turned off.

: For Microsoft Internet Explorer 10 the hotfix for the ASP.NET browserdefinition files in the Microsoft .NET Framework 4.0 should be installed. Formore information, see http://support.microsoft.com/kb/2600088.

Microsoft Edge 38 and higher

Mozilla Firefox 47 and higher

Apple Safari 9 and higher

Google Chrome 52 and higher

Server Part

The environment where you install the server part of the Acumatica ERP should meet hardware andsoftware requirements listed in the table below.


Operating systems • Windows Server 2016 64-bit edition

• Windows Server 2012 64-bit edition

• Windows Server 2012 R2 64-bit edition

http://support.microsoft.com/kb/2600088





: You can install the server part of Acumatica ERP on non-server operatingsystems, such as Windows Vista 64-bit edition, Windows 7.0 64-bit edition,Windows 8.0 64-bit edition, Windows 8.1 64-bit edition, and Windows 1064-bit edition, but only for testing purposes. For production you must use aserver operating system.

Microsoft .NETFramework

4.6.1

Microsoft InternetInformation Services

7.0, 7.5, 8.0, 8.5, or 10 depending on the underlying operating system.

: You must set the “Enable 32-bit Applications” option to False in IISsettings.

: Acumatica ERP 6.1 supports only the Integrated mode of the applicationpool. The Classic mode is not supported. If you try to upgrade an earlierversion of Acumatica ERP with Classic mode of the application pool to 6.1,upgrade will not be performed, and a corresponding error message will bedisplayed.

Memory 4 GB RAM

Hard Disk Space 1 GB available hard disk space plus 200 MB for each additional instance ofAcumatica ERP

Database

You can find system requirements for the Acumatica ERP database in the following table.


Microsoft SQL Server • 2016

• 2014 64-bit edition


MySQL CommunityEdition Server

5.7 64-bit edition

Memory 4 GB RAM

Hard Disk Space For each database, 1 GB available hard disk space. Depending on thenumber of transactions, additional hard disk space may be required to storelarge numbers of transactions.

Code Authoring Environments

To create stand-alone applications with Acumatica ERP or develop customizations and add-on solutionson top of Acumatica ERP, you need one of the integrated development environments (IDEs) listed in thetable below.


IDE Requirements

Microsoft Visual Studiowith Microsoft WebDeveloper Tools

• 2015: Community, Professional, and Enterprise editions

| System Requirements for Acumatica Framework 6.1 | 10

System Requirements for Acumatica Framework6.1

Acumatica Framework is a Web 2.0 application development platform you use to develop businessapplications, such as enterprise resource planning (ERP) systems. Acumatica Framework includes serversoftware and a database. For proper work of each of these parts the environment where you install anduse Acumatica Framework, should meet particular requirements that are described in this topic.

: Before you start the installation process, install at least all critical updates (or, preferably, all availableupdates) for the operating system and the required software. You should also make sure that all requiredthird-party components listed in this topic are properly installed and configured on your computer.

Server Part

The environment where you install the server part of Acumatica Framework should meet hardware andsoftware requirements listed in the table below.







: You can install the server part of Acumatica ERP on non-server operatingsystems, such as Windows Vista 64-bit edition, Windows 7.0 64-bit edition,Windows 8.0 64-bit edition, Windows 8.1 64-bit edition, and Windows 1064-bit edition, but only for testing purposes. For production you must use aserver operating system.


4.6.1



: You must set the “Enable 32-bit Applications” option to False in IISsettings.

: Acumatica ERP 6.1 supports only the Integrated mode of the applicationpool. The Classic mode is not supported. If you try to upgrade an earlierversion of Acumatica ERP with Classic mode of the application pool to 6.1,upgrade will not be performed, and a corresponding error message will bedisplayed.

Memory 4 GB RAM

Hard Disk Space 1 GB available hard disk space plus 200 MB for each additional instance ofAcumatica ERP

Database

You can find system requirements for the Acumatica ERP database in the following table.

| System Requirements for Acumatica Framework 6.1 | 11






5.7 64-bit edition

Memory 4 GB RAM

Hard Disk Space For each database, 1 GB available hard disk space. Depending on thenumber of transactions, additional hard disk space may be required to storelarge numbers of transactions.

Code Authoring Environments

To create stand-alone applications with Acumatica Framework, you need one of the integrateddevelopment environments (IDEs) listed in the table below.

IDE Requirements

Microsoft Visual Studiowith Microsoft WebDeveloper Tools

• 2015: Community, Professional, and Enterprise editions

| Typical Hardware Configurations for PCS and PCP Licenses | 12

Typical Hardware Configurations for PCS andPCP Licenses

This topic contains typical configurations for Private Cloud Subscription (PCS) and Private CloudPerpetual (PCP) licenses that depend on the volume of documents that business will process by usingAcumatica ERP. You may use this topic as follows:

1. Find an appropriate volume of documents the business is going to process with Acumatica ERP inEstimation of Resource Level License and Hardware Needed.

2. Read about licensing limitations that correspond to the hardware configuration in LicenseParameters for Resource Levels.

3. Find the typical hardware configuration that corresponds to the License Resource Level in ServerConfigurations.

4. Read about the software requirements for the server part of the system in SoftwareRequirements for the Server Part and system requirements for workstations in SystemRequirements for Workstations.

Estimation of Resource Level License and Hardware Needed

Before determining the type of server configuration you should use you first need to make sure thatyou have selected the appropriate Acumatica ERP License Resource Level which is directly related to thetype of server environment you will use.

Instead of charging for every user that needs to use the system, Acumatica ERP uses a Resource Levelsize licensing system that is based on overall the Usage and Load levels you will have on the system.The more transaction volume (usage) and users you expect (load), the larger the resource level licenseyou will require.

When determining the expected usage level, you must use information for number of Transactions youexpect to process during a peak hour. The peak hour is the hour the most usage volume and load isexpected to occur in the business over the next 12 months.

For our guidance, a Transaction is getting a sale and purchase completed from start to finish throughthe system. For example, on Acumatica ERP Small Resource Level license with appropriate hardware,you can generally process up to 100 such transactions during a peak hour. That means you can create100 orders, ship them, invoice them, post them, accept payments, create and process similar amountof purchase orders, receipts, vendor invoices, payment, handle similar volume in CRM like cases,activities, opportunities, etc.

The following table will help you to find an appropriate hardware resource level that depends on theusage (number of transactions during peak time) and load (approximate number of users who initiatethe transactions).

License Resource Level Guidance

ResourceLevel

Maximum Number ofTransactions per Hour

Concurrent Users orNumber of Medium/

Heavy* Users

Total Number of Users

Small 100 25 100

Medium 200 50 200

Large 400 100 400

X-Large 800 200 800


ResourceLevel

Maximum Number ofTransactions per Hour

Concurrent Users orNumber of Medium/

Heavy* Users

Total Number of Users

2X-Large 1500 350 1500

*Medium Users are users that rely on the system every day and tend to use the system generally onceevery 10 minutes. Heavy Users tend to use the system 20+ times during their daily peak hours.

:

• The number of users can be less than shown in the table above if automated processing is set up onthe customer’s side (that is, transactions are initiated not by a user but by API methods).

• If import or export of data by using integration with external systems will be used (such as ODataexport, import and export by using Web API, scheduled import and export), we recommend thatyou select the resource level higher than the level that was defined by the number of transactions.(For example, if you have 200 transactions per hour and use integration with external systems, youshould select the Large resource level.)

License Parameters for Resource Levels

Currently, Acumatica ERP PCS and PCP license validation system places limits to the number of logicalCPU cores the Acumatica ERP application will use on the server.

You can find license limitations by CPU cores in the table below. The limitation of CPU core number inthe license should be equal to or more than the typical number of CPU cores in hardware requirements(see Server Configurations). Your operating system will still utilize the additional cores for OS relatedtasks.

License Limitations for Logical CPU Cores

License Parameter/Resource Level

Small Medium Large X-Large 2X-Large

Number of logical CPU cores 2 4 8 16 32

: Currently the actual throughput you can achieve can highly vary based on system hardware, usagepatterns, and many other factors. Acumatica ERP does expect to introduce a more precise and adaptivein-product Resource Level Manager which will monitor and maintain optimized performance for all usersof the system. The resource level manager will balance resource usage across all resource requests andeliminates excessive resource monopolization by individual sessions. Therefore please use the LicenseResource Level Guidance table shown earlier to determine resource level license you select. Once the newResource Level Manager is in place, improved hardware will only help response times so long as you arebelow the transaction volume and user load guidance levels. Once you pass the guidance level, user maybegin to see significant performance degradation.

Server Configurations

This section describes typical hardware specifications for servers used to host Acumatica ERP (whichincludes the application server and the database) for each type of resource levels defined in Estimationof Resource Level License and Hardware Needed.

You should install the application server and the database on separate virtual machines or physicalservers. In the following subsections, you can find typical specifications for each of these configurations.


Virtualization on VMWare or Hyper-V: Typical Specifications Based on Resource Levels

In this table, you can find typical specifications for the physical server where virtual machines (VM)for Acumatica ERP server part will be installed, and resources that should be allotted for these virtualmachines.

Small Medium LargeResource LevelLicense/ TypicalConfiguration Basic Advanced Basic Advanced Basic Advanced

Physical Server Specification

Number of physicalCPUs

1 1 1 2 2 2

Total number ofphysical CPU cores

6 6 6 12 12 12

Typical processor Xeon E52620

Xeon E52620

Xeon E52620

Xeon E52620

Xeon E52620

Xeon E52658

Hypervisor OFF OFF OFF OFF OFF OFF

RAM 32GB 64GB 64GB 128GB 128GB 256GB

Hard drive size* 250GB 500GB 500GB 500GB 750GB 1TB

Hard drive type SSD Sata3

90K+ IOPS

500MBps+ R/W

SSD Sata3

90K+ IOPS

500MBps+ R/W

SSD Sata3

90K+ IOPS

500MBps+ R/W

SSDPCIE3x4

300K+ IOPS

2000MBps+ R/W

SSDPCIE3x4

300K+ IOPS

2000MBps+ R/W

SSDPCIE3x4

300K+ IOPS

2000MBps+ R/W

RAID 1 1 1 10 10 10

Application Server VM

VM Allotted CPU Cores 2 2 4 4 8 8

VM RAM 16GB 24GB 24GB 32GB 32GB 96GB

Database Server VM

VM Allotted CPU Cores 2 2 4 4 8 8

VM RAM 8GB 32GB 32GB 64GB 64GB 128GB

* You need two hard drives: one for the Application Server VM and one for the Database Server VM.

: Contact your partner for hardware guidance on XL and higher resource level licenses.

When you install Acumatica ERP on virtual machines, you should consider the following:

• You should install the application server and the database on separate virtual machines.

• You should allocate these virtual machines for Acumatica ERP only (no other software should beinstalled there, including antivirus software).

• Virtual machines decrease hardware performance by approximately 15%. For maximumperformance, you could eliminate VMs and run directly on the node OS, however, you will losebenefits and flexibility of VMs. Most clients choose VMs for this reason.


• Make sure that Hypervisor is off in your BIOS as Acumatica ERP will only use the licensed numberof logical cores reported by the system and you want each logical core to be mapped 1:1 to yourphysical cores. Turning on Hypervisor can reduce your Acumatica ERP performance by factor of50% and each CPU core reported by your OS will use a fraction of your physical cores on theserver.

• You should not use dynamic memory for virtual machines. You need to allocate a required RAMcapacity for each virtual machine.

• Each virtual machine should use a separate physical hard drive. That is, you should not share onephysical hard drive between multiple virtual machines.

• If you use hard drives with low writing speed, then increasing RAM will not improve the databaseperformance. We recommend that you use hard drives with high writing speed for the databaseserver.

: You should not use the RAID 5 level for hard drives because of low writing speed.

Separate Physical Servers: Typical Specifications Based on Resource Levels

In this table, you can find typical specifications for the Acumatica ERP Application Server and theDatabase Server.


Application Server


1 1 1 1 2 2


6 6 6 6 12 12


Xeon E52620

Xeon E52620

Xeon E52620

Xeon E52620

Xeon E52620

Hypervisor OFF OFF OFF OFF OFF OFF


Hard drive size 250GB 500GB 500GB 500GB 500GB 500GB


90K+ IOPS

500MBps+ R/W

SSD Sata3

90K+ IOPS

500MBps+ R/W

SSD Sata3

90K+ IOPS

500MBps+ R/W

SSD Sata3

90K+ IOPS

500MBps+ R/W

SSD Sata3

90K+ IOPS

500MBps+ R/W

SSD Sata3

90K+ IOPS

500MBps+ R/W

RAID 1 1 1 10 10 10

Database Server


1 1 1 2 2 2


6 6 6 12 12 16


Xeon E52620

Xeon E52620

Xeon E52620

Xeon E52620

Xeon E52658



Hypervisor ON ON ON ON ON ON


Hard drive size 250GB 500GB 500GB 500GB 750GB 1TB


90K+ IOPS

500MBps+ R/W

SSD Sata3

90K+ IOPS

500MBps+ R/W

SSD Sata3

90K+ IOPS

500MBps+ R/W

SSDPCIE3x4

300K+ IOPS

2000MBps+ R/W

SSDPCIE3x4

300K+ IOPS

2000MBps+ R/W

SSDPCIE3x4

300K+ IOPS

2000MBps+ R/W

RAID 1 1 1 10 10 10

: Contact your partner for hardware guidance on XL and higher resource level licenses.

When you install Acumatica ERP on separate physical servers, you should consider the following:

• You should install the application server and the database on separate servers.

• You should allocate these servers for Acumatica ERP only (no other software should be installedthere, including antivirus software).

• Network latency between an application server and a database should be less than 1 millisecond(both servers should be in the same data center).

• If you use hard drives with low writing speed, then increasing RAM will not improve the databaseperformance. We recommend that you use hard drives with high writing speed for the databaseserver.

: You should not use the RAID 5 level for hard drives because of low writing speed.

Software Requirements for the Server Part

The environment where you install the server part (the Application Server and the Database Server) ofthe Acumatica ERP should meet software requirements listed in the table below.

Application Server

Software Requirements






Note: You can install the server part of Acumatica ERP on non-serveroperating systems, such as Windows Vista 64-bit edition, Windows 7.0 64-bit edition, Windows 8.0 64-bit edition, Windows 8.1 64-bit edition, and



Windows 1064-bit edition, but only for testing purposes. For production youmust use a server operating system.


4.6, 4.6.1



: You must set the Enable 32-bit Applications option to False in IISsettings.

: Acumatica ERP 6.1 supports only the Integrated mode of the applicationpool. The Classic mode is not supported. If you try to upgrade an earlierversion of Acumatica ERP with the Classic mode of the application pool to6.1, upgrade will not be performed, and a corresponding error message willbe displayed.

Database Server






5.7 64-bit edition

System Requirements for Workstations

Workstations that are used by employees of your organization to work with Acumatica ERP should meethardware and software requirements listed in the table below.

Hardware/ Software Requirements

Display resolution Minimum 1024×768, Typical 1920x1080

Adobe Reader (to openAcumatica ERP PDFdocuments)

XI and higher

Microsoft Office (to viewdocuments exportedfrom Acumatica ERP)

• 2016

• 2013

• 2010

• 2007

• 2003 with the Microsoft Office 2007 compatibility pack

Web Browsers

Microsoft InternetExplorer

9, 10, and 11 with Compatibility View turned off.

: For Microsoft Internet Explorer 10 the hotfix for the ASP.NET browserdefinition files in the Microsoft .NET Framework 4.0 should be installed. Formore information, see http://support.microsoft.com/kb/2600088.

http://support.microsoft.com/kb/2600088


Hardware/ Software Requirements

Microsoft Edge 38 and higher

Mozilla Firefox 47 and higher

Apple Safari 9 and higher

Google Chrome 52 and higher

| Preparing for Installing Acumatica ERP | 19

Preparing for Installing Acumatica ERP

Before you start installing Acumatica ERP, you may have to configure your system, including thefollowing:

• Configuring Web Server (IIS) Features

• Setting Up an HTTPS Service in Web Server (IIS)

• Enabling Semantic Search for Microsoft SQL Server

Configuring Web Server (IIS) FeaturesBefore you install the Acumatica ERP server software, make sure that the following Web Server (IIS)features are turned on:

• Web Management Tools > IIS Management Console

• World Wide Web Services > Application Development Features > .NET Extensibility

• World Wide Web Services > Application Development Features > ASP.NET

• World Wide Web Services > Application Development Features > ISAPI Extensions

• World Wide Web Services > Application Development Features > ISAPI Filters

• World Wide Web Services > Common HTTP Features > Default Document

• World Wide Web Services > Common HTTP Features > Static Content

• World Wide Web Services > Performance Features > Dynamic Content Compression

• World Wide Web Services > Performance Features > Static Content Compression

• World Wide Web Services > Security > Request Filtering

Attention: Make sure, that for each application pool you are planning to use with Acumatica ERP 6.1version or higher, the Enable 32-bit Applications parameter is set to False (the parameter is locatedunder the IIS Manager > Application Pools > Edit Application Pool > Advanced Settings menu).

Setting Up an HTTPS Service in Web Server (IIS)HTTPS is a secure communications channel that is used to exchange information between a clientcomputer and a server. You may need to set up an HTTPS service in Web Server (IIS)—for example, ifyour users export data to Microsoft Excel and want to update the data automatically, or you wont to usesingle sign-on (SSO).

To enable SSL in Web Server (IIS), you must first obtain a certificate that is used to encrypt anddecrypt the information that is transferred over the network. You receive a certificate file from thecertification authority, and then register the certificate with your Web Server (IIS). For instructions,refer to the documentation of your Web Server (IIS).

Enabling Semantic Search for Microsoft SQL ServerTo access the full-text search functionality, you have to install the Semantic Search for the MicrosoftSQL Server. For more information on searching in Acumatica ERP, see Managing Search in theAcumatica ERP User Guide.

To install Semantic Search, do the following:

| Preparing for Installing Acumatica ERP | 20

• Select Full-Text and Semantic Extractions for Search on the Features to Install pageduring Microsoft SQL Server setup.

For details, see the documentation to Microsoft SQL Server.

| Installing Acumatica ERP | 21

Installing Acumatica ERP

Acumatica ERP is a web-based application that users can access from any computer by using a webbrowser. The following topics (and the topics beneath them) describe the Acumatica ERP installation anddeployment options:

• Installing Acumatica ERP Locally

• Setting Up Acumatica Self-Service Portal

• Installing Acumatica ERP in a Data Center

Installing Acumatica ERP LocallyYou can install Acumatica ERP locally where you want it to be installed. Before you install AcumaticaERP, make sure that the server computer and software meet the system requirements specified inSystem Requirements for Acumatica ERP 6.1.

To install an Acumatica ERP instance locally, you perform the following steps:

1. Install the Acumatica ERP Tools on a server. For more information, see To Install the AcumaticaERP Tools.

2. Deploy an Acumatica ERP instance on the server by using the Acumatica ERP ConfigurationWizard. For more information, see To Deploy an Acumatica ERP Instance.

3. Start working with Acumatica ERP by changing the password of the default user. For details, seeTo Change the Password at the First Logon.

Acumatica ERP Tools

The Acumatica ERP Tools include the following:

• The Acumatica ERP Configuration Wizard: A required software component that gives you theability to deploy new application instances, delete application instances, and perform applicationand database maintenance.

• The Acumatica Report Designer: An optional software component that provides visual tools thatyou can use to design custom reports for Acumatica ERP. For more information, see ReportDesigner.

• The Debugger Tools: An optional set of software components that gives you a limited ability todebug the deployed Acumatica ERP instances. If you choose to install the Debugger Tools, in theinstallation directory, the installer adds the Sources folder and .pdb files to the bin folder. TheSources folder contains core files from Acumatica Framework which you can use when debuggingthe application.

To Install the Acumatica ERP ToolsTo install the Acumatica ERP Tools, run the Acumatica ERP installation package and follow theinstructions of the Acumatica ERP Installer wizard:

1. On the Welcome page, click Next.

2. On the License Agreement page, read the license agreement. To accept the license agreement,click I Agree.

3. Click Next.

4. On the Main Software Configuration page, specify the following options:


• Launch the Acumatica ERP Configuration Wizard: Select this check box to continuedeploying the Acumatica ERP application instance once you install the Acumatica ERP Tools.

• Install Report Designer: Select this check box to install the optional Acumatica ReportDesigner. For more information, see Report Designer.

• Install Debugger Tools: Select this check box if you want to install the optionalDebugger Tools component.

5. Click Next.

6. On the Select Installation Folder page, specify the location where you want to install AcumaticaERP Tools, and then click Next.

: Click Disk Cost to view the list of the drives where you can install Acumatica ERP, along with theavailable and required disk space on each drive.

7. On the Confirm Installation page, click Next.

8. If you did not select the Launch the Acumatica ERP Configuration Wizard check box in Step4, click Close when you're prompted.

: You can run the Acumatica ERP Configuration Wizard anytime by selecting Start > Acumatica >Acumatica ERP Configuration.

To Deploy an Acumatica ERP InstanceYou deploy an Acumatica ERP instance by using the Acumatica ERP Configuration Wizard.

To Deploy a New Acumatica ERP Application Instance

1. Run the Acumatica ERP Configuration Wizard. For example, select Start > Acumatica >Acumatica ERP Configuration.

2. On the Welcome page, click Deploy New Application Instance.

Alternatively, on the Welcome page of the Acumatica ERP Configuration Wizard, click PerformApplication Maintenance, and then click New on the Application Maintenance page.

3. On the Database Server Connection page, specify the database server that will be used by theAcumatica ERP instance:

a. In the Server Type box, choose the server type. The following options are available:Microsoft SQL Server or MySQL Server.

b. Select a server to connect to. Do one of the following:

• In the Server Name box, type the name or the address of the server machine.

: For a MySQL server, the port number defaults to 3306. You can specify the customport number after a comma.

• If you are using a Microsoft SQL server, select the server in the Available Serverslist.

If the server list does not include the server you are looking for, you should clickUpdate the List to rescan your network. The list of database servers may not havea particular server even after your network is rescanned (if, for instance, the serverblocks broadcasts). If the problem persists, contact your network administrator forassistance.

: If you use Microsoft SQL Server Express, the (local) option will not work even if thedatabase server is running on the same machine. To use the server, start the SQLBrowser service first, and then update the list of servers and select your server. Note


that Microsoft SQL Server Express should not be used in a production environmentdue to its limitations.

c. Select the authentication method to be used to connect to the database server. If youselect the SQL Server Authentication option, specify an account with sufficient rightsfor creating the databases or making changes to them. Keep the following points in mindas you select an authentication method:

• The selected authentication method must be supported by the database server.By default, Microsoft SQL Server 2005 is installed with Windows authenticationdisabled.

• Windows authentication works only for a local Microsoft SQL Server or when bothapplication and database servers are members of the same Windows domain.

• Windows authentication doesn't work for a MySQL Server.

4. Click Next.

5. On the Database Configuration page, select the appropriate option as follows:

• To create a new database, click Create a new database and then type the name in theNew database's name box.

• To connect to an existing database, do the following:

1. Click Connect to an existing database.

2. In the Available databases on server list, select a database name.

3. Depending on the schema of the database you have selected, select the relevantcheck box to update, repair, or set up the database, if required.

4. If you want to shrink data after the database maintenance, select the Shrink datacheck box.

6. Click Next.

7. On the Company Setup page, do the following:

a. Configure the new company (named Company) that the Acumatica ERP ConfigurationWizard created by default:

• To rename the company, double-click the company name in the Login CompanyName column, type a new company name, and press Enter.

• If you want to fill the database with demo data or template data, select Demo orTemplate in the Insert Data column.

b. Optional: Add more companies if you want to create a multi-company Acumatica ERPinstance. For more information about company setup, see Managing Companies.

c. Optional: For a multi-company Acumatica ERP instance, if you want to restrict the listof companies a user can see only to the companies the user has access to, select theSecure Company on Login Form check box. In this case, the Company box does notappear on the Welcome screen by default and all users first authenticate themselves byentering their login and password.

d. Optional: For a multi-company Acumatica ERP instance, if you want to configure datasharing between companies, select the Advanced Settings check box. For moreinformation, see Multi-Company Instances.

8. Click Next.


9. Optional: On the Table Configuration page (which is displayed only if you have selected theAdvanced Settings check box on the Company Setup page), configure data sharing betweencompanies, and then click Next.

: Table configuration is a dangerous operation that can result in database corruption. Any changesyou make are at your own risk. If you configure tables, be sure to first back up the database.

10. On the Database Connection page, specify the authentication method that this instance ofAcumatica ERP will use to connect to the database, which is one of the following options:

• Windows Authentication: The Acumatica ERP Configuration Wizard will use the defaultanonymous user account used by Internet Information Services (IIS).

: Windows authentication doesn't work for a MySQL Server.

• SQL Server Authentication: Select Create new login to create a new SQL login, orselect Use existing login and specify an existing login. The login must have at least thefollowing rights:

• For a Microsoft SQL server, read, write, execute, and ddl_admin

• For a MySQL server, create, alter, drop, select, delete, insert, update, createtemporary tables, and execute

11. Click Next.

12. On the Instance Configuration page, specify the following options:

a. Instance Name: Type a name for this Acumatica ERP instance.

b. Create Portal: Leave this check box cleared.

c. Local Path to the Instance: Enter the path on the local computer to this applicationinstance.

d. Select an account to access ASP.NET application: Select one of the followingaccounts to be used to access the ASP.NET application:

• Default (anonymous user): To use the user account that IIS uses by default.

• Specify: To use another user account. Specify the login and password of the useraccount.

13. Click Next.

14. On the Web Site Configuration page, do the following:

a. In the Web Site Settings section, configure the list of websites and create a virtualdirectory. To use the URL of the IIS default site (that is, http://www.domain.com), clearthe Create Virtual Directory check box.

b. In the Application Pool Settings section, specify the application pool. You may want touse a dedicated application pool to better isolate instances and fine-tune resources thatare allocated for the instance by IIS. To specify the dedicated application pool, select oneof the following options:

• To create a new application pool, click Create New Application Pool and type thename in the Application Pool Name box.

• To use an existing application pool, click Use Existing Application Pool and selectthe name of the application pool in the list of available application pools.

The list of application pools includes all the application pools you can use to installAcumatica ERP from the list of pools configured in Web Server (IIS), either classicor integrated.


: Acumatica ERP employs the application pools that use one of the supported .NETFramework versions. For the list of supported .NET Framework versions, see SystemRequirements for Acumatica ERP 6.1.

15. Click Next.

16. On the Confirm Configuration page, do the following:

a. Check the configuration settings you have specified.

b. Optional. To make any changes, click Back to return to the required wizard page, andthen make necessary changes.

c. If you want to save the configuration settings in an XML file on your computer, click SaveConfiguration.

d. Click Finish to deploy this Acumatica ERP instance.

To Change the Password at the First LogonEvery Acumatica ERP instance comes with an active default user account that you use to sign in to thesystem. You start working with Acumatica ERP by changing the password for the default user.

To Change the Password for the Default User

1. Launch the application instance you have deployed by doing one of the following:

• On the Welcome page of the Acumatica ERP Configuration Wizard, click PerformApplication Maintenance. On the Application Maintenance page, select the instance youhave deployed and click Launch.

• Use the link created automatically in the Acumatica ERP program group.

• Navigate to http://localhost/Instance_Name/ in the web browser, whereInstance_Name is the name that you specified in the Virtual Directory Name box on theWeb Site Configuration page during configuration. (If you used the default name for thevirtual directory during the deployment of the instance, you would use the following URL:http://localhost/AcumaticaERP/.)

: The http://localhost/Instance_Name/ URL works only on the local computerwhere you have installed Acumatica ERP Tools. To access the Acumatica ERP instanceremotely, use the fully qualified domain name (FQDN) of the server instead of localhost in theURL.

2. On the Login page, type the following default credentials:

• My User Name: admin

• My Password: setup

3. Click Sign In.

4. Type the new password in the New Password and Confirm Password boxes.

5. If your Acumatica ERP instance is configured so that you need to agree to the terms of theAcumatica User Agreement, do the following:

a. Click the Acumatica User Agreement link, and read the user agreement.

b. Select Check here to indicate that you have read and agree to the terms of theAcumatica User Agreement, if you agree to these terms. If you don't agree to theterms of the user agreement, you cannot start using the software.

6. Click Sign In.


Setting Up Acumatica Self-Service PortalAcumatica Self-Service Portal is designed to be the site where your customers can view all the relevantinformation about their interaction with your company as a vendor and perform common activitiesonline.

To give your customers limited access to your Acumatica ERP instance, you deploy a Self-Service Portalinstance connected to your Acumatica ERP instance. For details, see To Deploy a Self-Service PortalInstance.

If you deploy a multi-company Acumatica ERP instance, after you deploy the Self-Service Portalinstance, you must specify the company that the Self-Service Portal users can access. For details, seeTo Specify the Company Available for Self-Service Portal Users.

: If you want different companies to be available through Self-Service Portal, you must deploy a Self-Service Portal instance for each company.

To Deploy a Self-Service Portal InstanceAfter you install the Acumatica ERP instance, you use the Acumatica ERP Configuration Wizard to deploythe Self-Service Portal instance and connect it to the database used by the Acumatica ERP instance. Bydoing this, you can give your customers limited access to the Acumatica ERP instance.

:

To Deploy a Self-Service Portal Instance

1. Run the Acumatica ERP Configuration Wizard. Select Start > Acumatica > Acumatica ERPConfiguration.

2. On the Welcome page, click Deploy New Application Instance.

3. On the Database Server Connection page, specify the database server that is used by theAcumatica ERP instance:



• In the Server Name box, type the name or the address of the server machine.

: For a MySQL server, the port number defaults to 3306. You can specify the customport number after a comma.



: If you use Microsoft SQL Server Express, the (local) option will not work even if thedatabase server is running on the same machine. To use the server, start the SQLBrowser service first, and then update the list of servers and select your server. Notethat Microsoft SQL Server Express should not be used in a production environmentdue to its limitations.


c. Select the authentication method to be used to connect to the database server. If youselect the SQL Server Authentication option, specify an account with sufficient rightsfor creating the databases or making changes to them. Keep the following points in mindas you select an authentication method:




4. Click Next.

5. On the Database Configuration page, connect to the database that is used by the Acumatica ERPinstance:

a. Click Connect to an existing database.

b. In the Available databases on server list, select the database that is used by theAcumatica ERP instance.

c. If the schema of the database you have specified is outdated, select the Updatedatabase check box.

d. If you want to shrink data after the database maintenance, select the Shrink data checkbox.

6. Click Next.

7. On the Company Setup page, check the companies used by the Acumatica ERP instance andclick Next.

8. On the Database Connection page, specify the authentication method that the instance of Self-Service Portal will use to connect to the database, which is one of the following options:






9. Click Next.


a. Instance Name: Type a name for this Self-Service Portal instance.

b. Create Portal: Select this check box.




• Default (anonymous user): The user account that IIS uses by default.

• Specify: Another user account. Specify the login and password of the user account.

11. Click Next.


a. In the Web Site Settings section, configure the list of websites and create a virtualdirectory. To use the URL of the IIS default site (that is, http://www.domain.com), clearthe Create Virtual Directory check box.






:

13. Click Next.






If you use a multi-company configuration, now you must specify the company that the Self-ServicePortal instance will be connected to, as described in To Specify the Company Available for Self-ServicePortal Users.

To Specify the Company Available for Self-Service Portal UsersIf you use a multi-company Acumatica ERP configuration, after you deploy a Self-Service Portalinstance, you must specify the company that will be available for the Self-Service Portal users.

To Configure the Companies Available for Self-Service Portal Users

1. Open the web.config file for the Self-Service Portal instance. This file is usually located in%Program Files%\Acumatica ERP\<instance name>, where <instance name> is thename of the Self-Service Portal instance site.


2. In the file, find the providers section, which has the following settings:

<add name="PXSqlDatabaseProvider" ... companyID="" .../>

3. Change the following key value:

companyID="x"

where x is the ID of the company you want to make available to the Self-Service Portal users.

4. Save the web.config file; this automatically restarts the website.

Installing Acumatica ERP in a Data CenterYou can install Acumatica ERP in a data center in which the system and the associated databases arehosted by the hosting provider.

With most host providers, you follow the installation procedure described in Installing Acumatica ERPLocally. If you choose to deploy Acumatica ERP on Windows Azure as a service, you need to create theAcumatica ERP Service package and deploy it on Windows Azure, as described in a later section of thisdocument.

Installing Acumatica ERP in a Data Center

You can install Acumatica ERP on a hosting or cloud services provider because these providers providepersistent, durable storage in the cloud.

If you are provided with a web service where you can launch an operating system with Microsoft SQLServer available, follow the installation procedure described in Installing Acumatica ERP Locally.

Deploying the Acumatica ERP Service on Windows Azure

You can deploy Acumatica ERP as a cloud service in Windows Azure. In this case, you create anAcumatica ERP Service package and upload it to the cloud service. For details, see Deploying theAcumatica ERP Service on Windows Azure.

Installing Acumatica ERP on Amazon Web Services with Independent Database Server

You can install the Acumatica ERP Tools on an Amazon Elastic Compute Cloud (Amazon EC2) virtualmachine and use the Amazon Relational Database Service (Amazon RDS) to host the databases. Fordetail, see Installing Acumatica ERP on Amazon Web Services.

Deploying the Acumatica ERP Service on Windows AzureAcumatica ERP can be deployed on Windows Azure, which is a cloud services platform hosted throughMicrosoft data centers. The platform includes the Windows Azure operating system and a set ofdeveloper services.

Also, you can access the storage services that are provided through the Windows Azure ManagementPortal. To use them, you must have a storage account.

System Requirements

Deploying Acumatica ERP on Microsoft Azure imposes additional limitations to Acumatica ERP systemrequirement, described in System Requirements for Acumatica ERP 6.1.

The performance and capabilities of Microsoft Azure SQL databases depend on the service tier youselect for the database, with the performance levels expressed in database throughput units (DTUs). Tosuccessfully run Acumatica ERP on Azure, the database must have at least 50 DTUs. Taking into accountthe requirement for databases, you should select at least Standard S2 service tier. For more informationon service tiers, see Service Tiers on Microsoft Azure.

https://azure.microsoft.com/en-us/documentation/articles/sql-database-service-tiers/


Before You Begin

To deploying Acumatica ERP instance on Windows Azure, you will need the following:

• An Azure account. For more information, see Microsoft Azure.

• An SSL service certificate that has been signed by a Certificate Authority, a trusted third-partywho issues certificates.

If you do not already have one, you will need to obtain one from a company that sells SSLcertificates. If you have the certificate imported in the system, you can export the certificate intoa PFX file by using the Internet Information Services (IIS) Manager or OpenSSL command-linetools.

Deployment

To deploy the Acumatica ERP Service on the Windows Azure platform, you perform the following steps:

1. Download the service package file To Download the Configuration Package

2. Prepare for deployment on Windows Azure. For more information, see To Prepare forDeployment on Windows Azure.

3. Set up the database options and create an Acumatica ERP Service package on your localcomputer. For the detailed procedure, see To Create an Acumatica ERP Service Package.

4. Deploy the Acumatica ERP Service package on Windows Azure. For the detailed procedure, seeTo Deploy the Acumatica ERP Service on Windows Azure.

To Download the Configuration Package

Before you begin installing Acumatica ERP as a service on Windows Azure, you need to get the Azureservice package file that you can download on the Partner Portal. The package file should correspond tothe version of Windows Azure that you purchased as shown in the following table.

Azure Deployment Acumatica ERP Edition Configuration Package

Small Standard SmallService.cspkg

Medium Advanced MediumService.cspkg

Large Enterprise LargeService.cspkg

90 day free trial Unlicensed SmallService.cspkg

To Download the Configuration Package

• On the Downloads tab of the Partner Portal, click on the service package you plan to use.

The Azure service package file (.cspkg) is downloaded on your computer.

To Prepare for Deployment on Windows Azure

Before you deploy an Acumatica ERP instance on Windows Azure, you configure your Windows Azureaccount.

To prepare for deployment, perform the following steps:

1. Create a new cloud service on Windows Azure as follows:

a. In Management Portal, click New, Cloud Service, and then Quick Create.

b. In URL, enter your company name to use in the public URL for accessing your cloudservice in production deployments. The URL format for production deployments ishttp://myCompany.cloudapp.net, where myCompany is the company name.

c. In Region/Affinity Group, select Acumatica Group.

https://azure.microsoft.com/en-us/

http://partner.acumatica.com/


d. Click Create Cloud Service.

2. Add an SSL service certificate to the certificate store on Windows Azure.

Before you can use a Windows Azure service certificate, you must upload it to a cloud service.Export a new certificate into a PFX file by using the Internet Information Services (IIS) Manageror OpenSSL command-line tools, and then upload this file to Windows Azure by using theWindows Azure Management Portal or the Windows Azure Service Management API. Theuploaded certificate can then be used by a service or stored in the hosted services certificatestore. To add the certificate, do the following:

a. In Management Portal, click Cloud Services. Then click the name of the cloud serviceyou created in Step 1 to open the dashboard.

b. Open the Certificates page and click Add new certificate. The Add a Certificatedialog box opens.

c. In Certificate file, use Browse to select the certificate (PFX file) to use.

d. In Password, enter the private key for the certificate.

e. Click OK.

f. Copy and paste the thumbprint of the certificate into a file; you will need it during a laterstep, when you're configuring database settings.

3. Configure remote access to the role instance as follows:

a. In Management Portal, select Cloud Services. Then click the name of the cloud serviceyou created in Step 1 to open the dashboard.

b. Open the Configure page for the cloud service, and click Remote.

c. On the Configure Remote Desktop Settings page, make the following changes:

• Select the Enable remote desktop check box.

• Create an account to use in Remote Desktop connections to the role instances.

• In the Certificates dialog box, select the certificate you uploaded in the previousstep.

d. Click OK.

e. Connect to a role instance as follows:

a. Click Instances to open the Instances page.

b. Click the role instance that has Remote Desktop configured to select the instance.

c. Click Connect, and follow the instructions to open the desktop of the virtualmachine.

4. Create a SQL database on Windows Azure:

a. Click +NEW at the bottom of the page.

b. Click Data Services.

c. Click SQL Database.

d. Click Custom Create.

e. In Name box, enter a name for the new database.

f. In the Edition box, select the WEB edition.

g. Select the Subscription box, depending on your company contract.


h. In the Service Tiers and Performance Level boxes, choose the service tier you want touse.

: For running Acumatica ERP you should select at least the Standard S2 service tier.

i. In the Collation box, specify the collation for your database. TheSQL_Latin1_General_CP1_CI_AS collation is selected by default.

j. In the Server box, select New SQL Database Server.

k. Click the check mark to go to the next page.

l. In the Server Settings box, enter a SQL Server authentication login name andpassword.

m. Click the check mark at the bottom of the page when you are finished.

To Create an Acumatica ERP Service Package

You install the Acumatica ERP Tools on the local computer and use the Acumatica ERP ConfigurationWizard to set up database options and create an Acumatica ERP Service package as follows:

To Set Up Database Options and Create an Acumatica ERP Service Package

1. Install the Acumatica ERP Tools on the local computer, as described in To Install the AcumaticaERP Tools.

2. Open the Acumatica ERP Configuration Wizard.

3. On the Welcome page of the Acumatica ERP Configuration Wizard, click Generate AzureConfiguration File.

4. On the Database Server Connection page, enter the host name of the Microsoft Azure SQL serverand the administrator account credentials.

5. Click Next.

6. On the Database Configuration page, do one of the following:

• To create a new database, click Create a new database and then type the name in theNew database's name box.



2. In the Available databases on server list, select a database name.

3. Depending on the schema of the database you have selected, select the relevantcheck box to update, repair, or set up the database.



a. Do the following to configure the new company (named Company) that the AcumaticaERP Configuration Wizard created by default:

a. To rename the company, double-click the company name in the Login CompanyName column, type a new company name, and press Enter.

b. If you want to fill the database with demo data or template data, select Demo orTemplate in the Insert Data column.


b. Optional: If you want to create a multi-company Acumatica ERP instance, add morecompanies. For more information about company setup, see Managing Companies.


d. Optional: For a multi-company Acumatica ERP instance, if you want to configure datasharing between companies, select the Advanced Settings check box. For moreinformation, see Multi-Company Instances

8. Click Next.

9. Optional: On the Tables Configuration page, you can specify whether you want the databasetables to be shared by different companies, and then click Next.

: This page is displayed only if you have selected the Advanced Settings check box on theprevious page.


a. Instance Name: Type a name for this Self-Service Portal instance.

b. Create Portal: Select this check box.



• Default (anonymous user): To use the user account that IIS uses by default.

• Specify: To use another user account. Specify the login and password of the useraccount.


a. Instance Name: Enter a name for this application instance of Acumatica ERP.

b. Local Path to the Instance: Enter the local path to the configuration files folder.

c. Select an account to access ASP.NET application: Select one of the followingaccounts to be used to access the ASP.NET application:

• Default (anonymous user): The user account that IIS uses by default.

• Specify: Another user account. Specify the login and password of the user account.

d. SSL Certificate Thumbprint: Enter the thumbprint of the SSL service certificate thatyou saved to a text file in To Prepare for Deployment on Windows Azure.

12. Click Next.

13. On the Confirm Configuration page, verify the configuration settings, and then click Finish.




c. Click Finish.


The service package (.cspkg) file is generated and stored on your computer.

To Deploy the Acumatica ERP Service on Windows Azure

To deploy the Acumatica ERP Service on Windows Azure, use the Windows Azure Management Portal toupload the following files:

• The service package file (.cspkg) that you downloaded from the Partner Portal. For moreinformation, see Deploying the Acumatica ERP Service on Windows Azure.

• The service configuration file (.cscfg) you created in To Create an Acumatica ERP Service Package

To Deploy the Packaged Acumatica ERP Service on Windows Azure

1. In the Management Portal, click Cloud Services. Then click the name of the cloud service toopen the dashboard.

2. Click Quick Start to open the Quick Start page.

3. Click New Production Deployment or New Staging Deployment.

4. In Upload a Package, make the following changes:

a. In Deployment name, enter a name for the new deployment.

b. In Package, use Browse to select the service package file (.cspkg) to use.

c. In Configuration, use Browse to select the service configuration file (.cscfg) to use.

5. Click OK (check mark) to begin the cloud service deployment.

Uploading the service package file and the service configuration file may take several minutes. You cantrack the upload progress on the Azure Management Portal.

: For more information about deploying a cloud service, see How to Create and Deploy a Cloud Service onMicrosoft Azure portal.

When you create an application in Windows Azure, Windows Azure provides a friendly subdomain onthe cloudapp.net domain so your users can access your application by using a URL such as http://<myUrl>.cloudapp.net. However, you can also expose your application and data on your own domainname. For more information, see Configuring a custom domain name for a Windows Azure cloud serviceor storage account on Microsoft Azure portal.

Installing Acumatica ERP on Amazon Web ServicesYou can launch Acumatica ERP on Amazon Web Services (AWS). In this case, you use the AmazonElastic Compute Cloud (Amazon EC2) to host the web server and Amazon Relational Database Service(Amazon RDS) to host the databases. This section includes our recommendations for configuring theEC2 and RDS instances and the details about deploying Acumatica ERP on AWS.

Before You Begin

Before you start deploying Acumatica ERP on Amazon Web Services, make sure you have completed thefollowing tasks:

• Sign up for Amazon Web Services.

• Create a key pair.

• Create a security group that will specify your EC2 instance, which can access your RDS instance.

To Launch Acumatica ERP on Amazon Web Services

1. Launch an Amazon EC2 instance. For more information, see To Launch an Amazon EC2 Instance.

http://www.windowsazure.com/en-us/manage/services/cloud-services/how-to-create-and-deploy-a-cloud-service

http://www.windowsazure.com/en-us/develop/net/common-tasks/custom-dns/

http://www.windowsazure.com/en-us/develop/net/common-tasks/custom-dns/


2. Create a database instance by using Amazon RDS. For details, see To Create a DatabaseInstance on Amazon RDS.

3. Install Acumatica ERP Tools and deploy a new application instance. For more information, see ToDeploy Acumatica ERP on Amazon EC2.

To Launch an Amazon EC2 Instance

When you launch your Amazon EC2 instance, you secure it by specifying a key pair and security group.When you connect to your instance, you must specify the private key of the key pair that you specifiedwhen launching your instance.

To Launch an Amazon EC2 Instance

1. Sign in to the AWS Management Console and open the Amazon EC2 console.

2. In the top right corner of the Amazon EC2 console, select the region for your EC2 instance.

: You must select the same region for your EC2 and RDS instances and for the key pair you use tosign in to your instances.

3. From the console dashboard, click Launch Instance.

4. On the Select an Amazon Machine Image (AMI) page, select the Windows Server 2012 Base 64-bit AMI.

5. On the Select an Instance Type page, select the m1.medium hardware configuration for yourinstance.

6. On the Security Groups page, select the security group that you've prepared to launchAcumatica ERP.

7. On the Review Instance Launch page, review the settings for your instance, and then clickLaunch.

8. In the Select an existing key pair or create a new key pair dialog box, select Choose anexisting key pair, and then select the prepared key pair.

9. When you are ready, select the acknowledgment check box, and then click Launch Instances.

A confirmation page lets you know that your instance is launching.

10. Click View Instances to close the confirmation page and return to the console.

11. On the Instances page, view the status of your instance. It takes a short time for an instanceto launch. When you launch an instance, its initial state is pending. After the instance starts, itsstate changes to running, and it receives a public DNS name.

12. On the Instances screen, select the instance and click Connect.

13. In the Connect to Your Instance dialog box:

a. Select the prepared key.

b. Download the Remote Desktop file.

14. Run the Remote Desktop file you've downloaded in Step 12.2 to access the web server you havelaunched.

15. For the operating system of the virtual machine, turn on the Microsoft Internet InformationServices (IIS) and make sure the required IIS features are turned on, as described in SystemRequirements for Acumatica ERP 6.1.

To Create a Database Instance on Amazon RDS

After you set up the EC2 instance, you can create a database instance by using the RDS console.


To Create a Database Instance on Amazon RDS

1. Sign in to the AWS Management Console and open the Amazon RDS console.

2. In the top right corner of the Amazon RDS console, select the region in which you want to createthe database instance.

: You must select the same region for your EC2 and RDS instances and for the key pair you use tosign in to your instances.

3. In the navigation pane, click Instances.

4. Click Launch DB Instance to start the Launch DB Instance wizard.

The wizard opens on the Engine Selection page.

5. If you want to use MS SQL database, do the following:

a. In the Launch DB Instance Wizard window, click the Select button for the MS SQLServer Web Edition.

b. On the DB Instance Details page, specify your database instance information, includingthe following settings:

• DB Instance Class: db.m1.medium

• Allocated Storage: 20 GB

• DB Instance Identifier

• Master User Name

• Master Password

6. If you want to use MySQL database, do the following:

a. In the Launch DB Instance Wizard window, click the Select button for the MySQLCommunity Edition.

b. On the DB Instance Details page, specify your database instance information, includingthe following settings:

• DB Engine: as specified in System Requirements for Acumatica ERP 6.1

• DB Instance Class: db.m1.medium

• Allocated Storage: 20 GB

• Multi-AZ Deployment: No

• DB Instance Identifier

• Master User Name

• Master Password

7. Click Next Step.

8. On the Additional Configuration page, provide the additional information that RDS uses to launchthe SQL Server database instance, including the following setting:

• DB Security Groups: Select the prepared security group you used when launching theEC2 instance.

9. Click Next Step.

10. On the Management Options page, you can specify backup and maintenance options for yourdatabase instance.

11. Click Next Step.


12. On the Review page, review the options for your database instance. When you're certain of allthe settings, click Launch DB Instance.

13. On the final page of the wizard, click Close.

14. On the RDS console, the new database instance appears in the list of instances. The databaseinstance will have a status of creating until it is created and ready for use. When the statechanges to available, you can connect to the database instance. Depending on the databaseinstance class and store allocated, it could take several minutes for the new instance to beavailable.

15. On the RDS console, select the database and check the DNS name of the instance in theEndpoint box; you will need this name during Acumatica ERP installation.

To Deploy Acumatica ERP on Amazon EC2

After you launch the Amazon EC2 and RDS instances, you can install Acumatica ERP Tools and deployapplication instances.

To Deploy Acumatica ERP on the Amazon EC2 Instance

1. Use the Remote Desktop Connection to connect to the web server running on your Amazon EC2instance.

2. Copy the Acumatica ERP installation package to the web server.

3. Install the Acumatica ERP Tools, as described in To Install the Acumatica ERP Tools.

4. On the Welcome page of the Acumatica ERP Configuration Wizard, click Deploy NewApplication Instance.

5. On the Database Server Connection page, specify the database server that will be used by theAcumatica ERP instance:

a. In the Server Type box, choose the server type you used to deploy the database onAmazon RDS. The following options are available: Microsoft SQL Server or MySQL Server.

b. In the Server Name box, enter the DNS name of the Amazon RDS database instanceyou've launched. Also, you can specify a custom port number after a comma.

: If you cannot connect to the server, check the security groups you've selected for the EC2and RDS instances: You must select the same group for both services.

: For a MySQL server, the port number defaults to 3306.

c. Select the SQL Server Authentication method, and specify the login that you createdwhile you set up the Amazon RDS database instance (in Step 5 or 6 of the To Create aDatabase Instance on Amazon RDS procedure, depending on the database type):

• Login: Master User Name

• Password: Master Password

6. Click Next.

7. On the Database Configuration page, connect to the database that you've launched on AmazonRDS. Do the following:

a. Click Connect to an existing database.

b. In the Available databases on server list, enter the database name.

c. Depending on the schema of the database you have selected, select the relevant checkbox to update, repair, or set up the database, if required.


d. If you want to shrink data after the database maintenance, select the Shrink data checkbox.

8. Click Next.


a. Configure the new company, named Company, that the Acumatica ERP ConfigurationWizard created by default:

• To rename the company, double-click the company name in the Login CompanyName column, type a new company name, and press Enter.

• If you want to fill the database with demo data or template data, select Demo orTemplate in the Insert Data column.

b. Optional: Add more companies if you want to create a multi-company Acumatica ERPinstance. For more information about company setup, see Managing Companies.


d. Optional: For a multi-company Acumatica ERP instance, if you want to configure datasharing between companies, select the Advanced Settings check box. For moreinformation, see Multi-Company Instances.

10. Click Next.

11. Optional: On the Tables Configuration page (which is displayed only if you have selected theAdvanced Settings check box on the Company Setup page), configure data sharing betweencompanies, and then click Next.


12. On the Database Connection page, specify the authentication method that this instance ofAcumatica ERP will use to connect to the database. Do the following:

a. Select the SQL Server Authentication authentication method.

b. Select Use Existing Login option and specify the login you created while you set up theAmazon RDS database instance (in Step 5 or 6 of the To Create a Database Instance onAmazon RDS procedure, depending on the database type):

• Login: Master User Name

• Password: Master Password

13. Click Next.


• Instance Name: Type a name for this Acumatica ERP instance.

• Create Portal: Leave the check box cleared.

• Local Path to the Instance: Enter the path on the local computer to this applicationinstance.

• Select an account to access ASP.NET application: Specify whether you want theAnonymous user account to be used to access the ASP.NET application, or specify anotheruser account.


15. Click Next.


a. In the Web Site Settings section, configure the list of websites and create a virtualdirectory. To use the URL of the Internet Information Services (IIS) default site (that is,http://www.domain.com), clear the Create Virtual Directory check box.






17. Click Next.



b. Optional: To make any changes, click Back to return to the required wizard page, andthen make necessary changes.



| Installing Acumatica Framework | 40

Installing Acumatica Framework

Acumatica Framework is a Web 2.0 application development platform that you use to develop businessapplications, such as enterprise resource planning (ERP) systems.

Installing Acumatica Framework

To install Acumatica Framework, perform these steps:

1. Install the Acumatica Framework Tools on a server computer. For more information, see ToInstall Acumatica Framework Tools.

2. Deploy an Acumatica Framework instance on the server by using the Acumatica FrameworkConfiguration Wizard. For more information, see To Deploy an Acumatica Framework Instance.

3. Start working with Acumatica Framework by changing the password of the default user. Fordetails, see To Change the Password at the First Logon.

Installing Acumatica Framework Templates

For details on the installation of Acumatica Framework Templates, see To Install Acumatica FrameworkTemplates.

Using Acumatica Framework Tools

You use the Acumatica Framework Configuration Wizard to deploy the Acumatica Framework instances.

Acumatica Framework Tools include the Acumatica Framework Configuration Wizard and the AcumaticaReport Designer.

The Acumatica Framework Configuration Wizard gives you the ability to deploy new applicationinstances and perform application and database maintenance.

The Acumatica Report Designer provides visual tools that you can use to design custom reports forAcumatica ERP. For more information, see Report Designer.

To Install Acumatica Framework ToolsTo install Acumatica Framework, run the Acumatica Framework installation package and follow theinstructions of the Acumatica Framework Installer wizard:

1. On the Welcome page, click Next.

2. On the License Agreement page, read the license agreement. To accept the agreement, click IAgree, and then click Next.

3. On the Main Software Configuration page, specify the option that you want:

• Launch the Configuration Wizard (Recommended): Select this check box if you wantto continue deploying Acumatica Framework once you install it.

• Install Report Designer: Select this check box if you want to install the optionalAcumatica Report Designer component. For more information, see Report Designer.

4. Click Next.

5. On the Select Installation Folder page, specify the location where you want to install AcumaticaFramework Tools.


: Click Disk Cost to view the list of the drives where you can install Acumatica Framework, alongwith the available and required disk space on each drive.

6. Click Next.

7. On the Confirm Installation page, click Next.

8. If you did not select the Launch the Acumatica Framework Configuration Wizard checkbox in Step 3, click Close when you're prompted.

: You can run the Acumatica Framework Configuration Wizard anytime by selecting Start >Acumatica > Acumatica Framework Configuration.

To Deploy an Acumatica Framework InstanceDuring this step, you deploy an instance by using the Acumatica Framework Configuration Wizard.

To deploy a new Acumatica Framework instance, do the following:

1. Run the Acumatica Framework Configuration Wizard. For example, select Start > Acumatica >Acumatica Framework Configuration.

2. On the Welcome page of the wizard, do one of the following:

• Click Deploy New Instance of Acumatica Application Template to deploy a newapplication instance or an application instance with training templates.

• Click Deploy New Instance of Acumatica Training Application to deploy a trainingapplication instance of Acumatica Framework with all demo data.

3. On the Database Server Connection page, specify the database server that will be used by theAcumatica Framework instance:



• In the Server Name box, type the name or the address of the server machine.Also, you can specify the custom port number after a comma.

: For a MySQL server, the port number defaults to 3306.



: If you use Microsoft SQL Server Express, the (local) option will not work even if thedatabase server is running on the same machine. To use the server, start the SQLBrowser service first, and then update the list of servers and select your server. Notethat Microsoft SQL Server Express should not be used in a production environmentdue to its limitations.

c. Select the authentication method to be used to connect to the database server. If youselect the SQL Server Authentication option, specify an account with sufficient rights


for creating the databases or making changes to them. Keep the following points in mindas you select an authentication method:




4. Click Next.


• To create a new database, click Create a new database, and then type the name in theNew database's name box.



2. In the Available databases on server list, click a database name.

3. Depending on the schema of the database you have selected, select the relevantcheck box to update, repair, or set up the database. To shrink data after thedatabase maintenance, select the Shrink data check box.

6. Click Next.

7. On the Database Connection page, specify the authentication method that this applicationinstance of Acumatica Framework will use to connect to the database, which is one of thefollowing options:

• Windows Authentication: The Acumatica Framework Configuration Wizard will use thedefault anonymous user account used by Internet Information Services (IIS).





8. Click Next.


• Instance Name: Type a name for this Acumatica Framework instance.

• Local Path to the Instance: Enter the path on the local computer to this applicationinstance.

• Select an account to access ASP.NET application: Specify that you want theAnonymous user account to be used to access the ASP.NET application, or specify anotheruser account.

10. Click Next.



• Configure the list of websites and create a virtual directory. To use the URL of the IISdefault site (that is, http://www.domain.com), clear the Create Virtual Directory checkbox.

• Specify the application pool. You may want to use a dedicated application pool to betterisolate instances and fine-tune resources that are allocated for the instance by IIS. Tospecify the dedicated application pool, select one of the following options:

• To create a new application pool, click Create New Application Pool and type theapplication pool name.

• To use the existing application pool, click Use Existing Application Pool and selectthe name of the application pool.

The list of application pools includes all the application pools you can use to installAcumatica Framework from the list of pools configured in Web Server (IIS), eitherclassic or integrated.

: Acumatica Framework employs the application pools that use one of thesupported .NET Framework versions. For the list of supported .NET Frameworkversions, see System Requirements for Acumatica ERP 6.1.

12. Click Next.




c. To save the configuration settings in an XML file on your computer, click SaveConfiguration.

d. Click Finish to deploy this Acumatica Framework instance.

: You can deploy an Acumatica Framework instance by using the command line. For more information, seeUsing the Command-Line Tool.

To Change the Password at the First LogonEvery Acumatica Framework instance comes with an active default user account that you use to sign into the system. You start working with the Acumatica Framework instance by changing the password forthe default user.

To Change the Password for the Default User

1. Launch the application instance you have deployed by doing one of the following:

• On the Welcome page of the Acumatica Framework Configuration Wizard, click PerformApplication Maintenance. On the Application Maintenance page, select the instance youhave deployed and click Launch.

• Use the link created automatically in the Acumatica Framework program group.

• Navigate to http://localhost/Instance_Name/ in the web browser, whereInstance_Name is the name that you specified in the Virtual Directory Name box on theWeb Site Configuration page during configuration. (If you used the default name for thevirtual directory during the deployment of the instance, you would use the following URL:http://localhost/AcumaticaFramework/.)


: The http://localhost/Instance_Name/ URL works only on the local computerwhere you have installed Acumatica Framework Tools. To access the Acumatica Frameworkinstance remotely, use the fully qualified domain name (FQDN) of the server instead oflocalhost in the URL.

2. On the Login page, enter the following default credentials:

• My User Name: admin

• My Password: setup

3. Click Sign In.

4. Type the new password in the New Password and Confirm Password boxes.

5. If your Acumatica Framework instance is configured so that you need to agree to the terms ofthe Acumatica User Agreement, do the following:

a. Click the Acumatica User Agreement link, and read the user agreement.

b. Select Check here to indicate that you have read and agree to the terms of theAcumatica User Agreement, if you agree to these terms. If you don't agree to theterms of the user agreement, you cannot start using the software.

6. Click Sign In.

To Install Acumatica Framework TemplatesTo install Acumatica Framework Templates, which consist of Microsoft Visual Studio templates, do thefollowing:

1. Run the Acumatica Framework Configuration Wizard. For example, select Start > Acumatica >Acumatica Framework Configuration.

2. On the Welcome page of the wizard, click Deploy Acumatica Framework Tools.

3. On the Confirm Configuration page, if you want to save the configuration settings in an XML fileon your computer (which you can use later for an unattended installation from the commandline), click Save Configuration.

4. Click Finish.

| Licensing and Activating Acumatica ERP | 45

Licensing and Activating Acumatica ERP

By default, Acumatica ERP is installed in trial mode. You remove the trial mode restrictions when youobtain and activate the license for using Acumatica ERP.

Trial mode allows only 10 companies per instance and only two users to concurrently use the system,though all features are available. Each time a third user signs in to Acumatica ERP, one of the currentusers is forcibly signed out.

A license is applied to an Acumatica ERP instance defining the number of companies you can add to theinstance, the number of concurrent users, and the set of features you can activate for the instance. Youcan create additional trial companies. For details on applying a license, see To Activate the License foran Acumatica ERP Instance.

If you use Acumatica Self-Service Portal you have to obtain a license for the Self-Service Portalinstance, activate the license, and then activate the required Self-Service Portal features. For details,see Configuring Acumatica Self-Service Portal.

To Activate the License for an Acumatica ERP InstanceTo activate your Acumatica ERP instance, you obtain a product key and then register the key by usingthe Activate License (SM.20.15.10) form.

To Activate the Product License

: Before you proceed with activation, make sure that all Acumatica ERP users have saved their work andsigned out of the system. During licensing and activation, the Acumatica ERP instance is restarted, and anyunsaved work is lost.

1. Obtain a product key by creating a support case through the Partner Portal. Submit the followinginformation:

• Installation ID: The installation ID is available on the About dialog box of the AcumaticaERP application instance. To open this dialog box, on any Acumatica ERP form, selectHelp > About.

• Contract ID: You can find this ID on your Acumatica ERP sales invoice.

2. On the Configuration tab, click Common Settings. In the left pane, navigate to Licensing >Activate License.

3. Depending on the license type that you have obtained from your sales representative, do one ofthe following:

• If you have obtained a license key, click Enter License Key on the form toolbar, enter thelicense key in the Activate New License dialog box, and click OK.

The system contacts the licensing server and validates the license online. Each license canbe used to activate a predetermined number of instances. If you reach the limit for yourlicense, you generally won't be able to use this license. Alternatively, depending on yourlicense settings, the system may offer to deactivate the license from the oldest instance.

: To validate your license, the licensing server requires port 443 to be opened on thecomputer running the Acumatica ERP instance you use to enter the key. You may have toopen port 443 if the computer has a firewall enabled.

• If you have obtained a license file, click Upload License File on the form toolbar, and thenselect and upload the license file by using the Upload New License File dialog box.

| Licensing and Activating Acumatica ERP | 46

If you use a license file, the system validates the license without contacting the licensingserver.

4. In the Agree to Proceed dialog box, which opens, click the link to read the license agreement,and if you agree to the terms of the agreement, click Agree to proceed with activation and closethe dialog box.

5. In the table, review the features that this license supports, and make sure that the feature list iscorrect.

6. Click Apply License to activate your instance.

| Maintaining Acumatica ERP | 47

Maintaining Acumatica ERP

The topics in this section describe how to perform maintenance tasks that are associated with theAcumatica ERP instances and their databases:

• To Check the State of Application Instances and Databases

• To Turn On Snapshot Isolation Mode for a Database

• To View the Details of an Acumatica ERP Instance

• To Change the Database of an Instance

• To Perform Database Maintenance

• To Configure the Session Time-Out

• To Configure the Report Time-Out

• To Configure the Query Time-Out

• To Select Roles That Will Have Administrative Privileges

• To Shorten the Names of the Customization Folders

• To Turn On Reminders

• To Turn On the My Tasks and Events Button

You can also perform database and application maintenance tasks by using the command-line tool. Formore information, see Using the Command-Line Tool.

To Check the State of Application Instances and DatabasesYou can check the state of your application instances and databases and see which instances anddatabases you need to update.

To Check the State of Application Instances and Databases

1. Run the Acumatica ERP Configuration Wizard on the server where Acumatica ERP is installed. Forexample, select Start > Acumatica > Acumatica ERP Configuration.

2. On the Welcome page, click Perform Application Maintenance.

On the Application Maintenance page of the Acumatica ERP Configuration Wizard, the system flags eachinstance in the list of installed sites with one of the following icons:

• Green check mark: Indicates that the instance and the associated database are up to date (theversions of the application instance, the database, and the Acumatica ERP Configuration Wizardare the same).

• Yellow triangle with exclamation point: Indicates that the instance and the instance database areoutdated (the version of the application instance is same as the version of the database and isolder than that of the installed Acumatica ERP Configuration Wizard). You may need to update theapplication instance and the database.

: After you update the Acumatica ERP Tools, all your instances installed before the update aremarked in this way.


• Red circle with a white X: Indicates that the instance or the database (depending on which has anolder version) requires update; that is, the versions of the instance and the instance's databaseare different. You must update the one whose version is older.

Also, this marking may indicate that the instance and the database versions are newer than theversion of the installed Acumatica ERP Configuration Wizard. You won't be able to downgrade theinstance or the database.

For example, the following screenshot shows three instances. The z instance has been updated. Thedatabase of the v3 instance has been updated and the site needs to be updated. The v2 instance is aworking instance that may be updated if required.

Figure: Checking the state of the application instances and databases

To Turn On Snapshot Isolation Mode for a DatabaseIn order for an Acumatica ERP instance that uses a SQL Server database to work properly, snapshotisolation must be turned on for the instance database. In this topic, you can find information about howto use SQL Server Management Studio to check if snapshot isolation mode is turned on and how to turnon this mode for your database.

To Check If Snapshot Isolation Mode Is Turned On

• Run the following query in SQL Server Management Studio:

SELECT is_read_committed_snapshot_on FROM sys.databases WHERE name = '<database name>'

where <database name> is the name of the database whose settings you want to check.

If the is_read_committed_snapshot_on parameter is set to 1, snapshot isolation mode is turned on.If not, you have to turn on snapshot isolation mode.

To Turn On Snapshot Isolation Mode for a Database

1. In SQL Server Management Studio, right-click the database and click Properties to open theDatabase Properties dialog box.

2. Select the Options page.

3. In the Miscellaneous section, set Is Read Committed Snapshot On to True.

4. Click OK to save the settings and close the dialog box.


To View the Details of an Acumatica ERP InstanceYou can view such details of an Acumatica ERP instance as the local path to configuration files, thedatabase the application is connected to, the virtual directory name, the website name, and the currentversion of the site and database.

To View the Details of an Acumatica ERP Instance

1. On the server where the Acumatica ERP Tools are installed, run the Acumatica ERP ConfigurationWizard. For example, select Start > Acumatica > Acumatica ERP Configuration.

2. On the Welcome page of the wizard, click Perform Application Maintenance.

3. On the Application Maintenance page, click Instance Info.

To Change the Database of an InstanceYou can change the database of an Acumatica ERP instance—for example, if you want to switch to abackup database.

To Change the Database of an Instance

1. On the server where Acumatica ERP is installed, run the Acumatica ERP Configuration Wizard.For example, select Start > Acumatica > Acumatica ERP Configuration.


3. On the Application Maintenance page, do the following:

a. In the Installed Sites list, click the instance for which you want to specify anotherdatabase.

b. On the bottom area of the page, click Change Database.

4. On the Database Server Connection page, specify the Microsoft SQL Server that will be used bythe Acumatica ERP instance:

a. In the Available Servers list, select a server to connect to.

If the server list does not include the server you are looking for, you should clickUpdate the List to rescan your network. The list of database servers may not have aparticular server even after your network is rescanned (if, for instance, the server blocksbroadcasts). In this case, you can type the name or the address of the Microsoft SQLServer machine in the Server Name box. If the problem persists, contact your networkadministrator for assistance.

: If you use Microsoft SQL Server Express, the (local) option will not work even if thedatabase server is running on the same machine. To use the server, start the SQL Browserservice first, and then update the list of servers and select your server. Note that MicrosoftSQL Server Express should not be used in a production environment due to its limitations.

b. Select the authentication method to be used to connect to the database server. If youselect the SQL Server Authentication option, specify an account with sufficient rightsfor creating the databases or making changes to them.

:

• The selected authentication method must be supported by the database server. Note that bydefault, Microsoft SQL Server 2005 is installed with Windows authentication disabled.


• Windows authentication works only for a local Microsoft SQL Server or when both applicationand database servers are members of the same Windows domain.

5. Click Next.


• To create a new database, click Create a new database, and then type the name of thedatabase.



2. In the Available databases on server list, click a database name.

3. Depending on the schema of the database you have selected, select the relevantcheck box to update, repair, or set up the database.

4. To shrink data after the database maintenance, select the Shrink data check box.

7. Click Next.

8. On the Company Setup page, make any necessary changes to the list of companies. For moreinformation, see Managing Companies.

9. Click Next.

10. Optional: On the Tables Configuration page (which is displayed only if you have selected theAdvanced Settings check box on the Company Setup page), specify whether you want thedatabase tables to be shared by different companies, and then click Next.


11. On the Database Connection page, specify the authentication method that this applicationinstance of Acumatica ERP will use to connect to the database, which is one of the followingoptions:


• SQL Server Authentication: Select Create new login to create a new login with read,write, execute, and ddl_admin rights, or select Use existing login and specify an existinglogin with read, write, execute, and ddl_admin rights.

12. Click Next.





d. Click Finish to deploy the Acumatica ERP instance.

To Perform Database MaintenanceYou can create a new Acumatica ERP database, upgrade an existing database with a current versionof the database schema, repair the database schema, and set up companies. To perform these tasks,


you use the Perform Database Maintenance option on the Welcome page of the Acumatica ERPConfiguration Wizard.

To Perform Database Maintenance


2. On the Welcome page, click Perform Database Maintenance.

3. On the Database Server Connection page, specify the Microsoft SQL Server that will be used bythe Acumatica ERP instance:

a. In the Available Servers list, select a server to connect to.

If the server list does not include the server you are looking for, you should clickUpdate the List to rescan your network. The list of database servers may not have aparticular server even after your network is rescanned (if, for instance, the server blocksbroadcasts). In this case, you can type the name or the address of the Microsoft SQLServer machine in the Server Name box. If the problem persists, contact your networkadministrator for assistance.

: If you use Microsoft SQL Server Express, the (local) option will not work even if thedatabase server is running on the same machine. To use the server, start the SQL Browserservice first, and then update the list of servers and select your server. Note that MicrosoftSQL Server Express should not be used in a production environment due to its limitations.

b. Select the authentication method to be used to connect to the database server. If youselect the SQL Server Authentication option, specify an account with sufficient rightsfor creating the databases or making changes to them.

:

• The selected authentication method must be supported by the database server. Note that bydefault, Microsoft SQL Server 2005 is installed with Windows authentication disabled.

• Windows authentication works only for a local Microsoft SQL Server or when both applicationand database servers are members of the same Windows domain.

4. Click Next.

5. On the Database Configuration page, select the appropriate options as follows:

• To create a new database, click Create a new database and then type the name of thenew database.



2. In the Available databases on server list, select a database.

3. Depending on the schema of the database you have selected, select the relevantcheck box to update, repair, or set up the database, if required.


6. Click Next.

7. On the Company Setup page, configure companies. For more information, see ManagingCompanies.

8. Click Next.


9. Optional: On the Table Configuration page (which is displayed only if you have selected theAdvanced Settings check box on the Company Setup page), specify whether you want thedatabase tables to be shared by different companies, and then click Next.






d. Click Finish to perform database maintenance.

To Configure the Session Time-OutYou can configure the session time-out value for your Acumatica ERP website. To change the time-out value, you change the session time-out and cookie time-out values in the web.config file of theapplication instance website. Also, you must make sure that the Application Pool Idle Time-out value inthe Internet Information Services (IIS) Manager is greater than the session time-out and cookie time-out values for your website. This step is required, because IIS can recycle the application pool beforethe session has expired.

: Make sure that all users of your website are warned about the site restart so that they can save alldocuments.

To Configure the Session Time-Out

1. Open the web.config file for the instance. Usually it can be located in %Program Files%\Acumatica ERP\<instance name>, where <instance name> is the name of the applicationinstance website.

2. Change the session time-out to the appropriate value (in minutes), as shown below.

<sessionState timeout="90">

: By default, the session time-out is set to 60 minutes.

3. Change the cookie time-out to the appropriate value (in minutes), as shown in the followingcode line.

<formsAuth loginUrl="Frames/Login.aspx" timeout="90" />

: By default, the cookie time-out is set to 60 minutes.

4. Save the web.config file, which automatically restarts the website.

5. Select Start > Administrative Tools > Internet Information Services (IIS) Manager.

6. In the Connections pane, double-click the site name and then select Application Pools.

7. On the feature page, select the application pool that you use on your website.

8. In the Actions pane, click Advanced Settings.


9. In the Advanced Settings dialog box, in the Idle Time-out (minutes) box, set theApplication Pool Idle Time-out value (in minutes) so that this value is greater than the sessionand cookie time-out values that you set in Steps 2 and 3.

10. Click OK to save the settings.

To Configure the Report Time-OutWhen you have to run a report that takes a long time to complete (for example, a General Ledgerreport that covers multiple periods), the report can time out before it finishes. To avoid this error, youcan increase the report time-out value. By default, the report time-out is set to 300 seconds.


To Configure the Report Time-Out

1. Open the web.config file for the site instance. Usually it is located in %Program Files%\Acumatica ERP\<instance name>, where <instance name> is the name of the applicationinstance website.

2. In the file, find the following line, where ... represents the other parameters, which depend onyour website settings.

<add name="PXSqlDatabaseProvider" type="PX.Data.PXSqlDatabaseProvider, PX.Data" ... />

3. Add the reportQueryTimeout parameters to the line and specify the report timeout time (inseconds).

<add name="PXSqlDatabaseProvider" type="PX.Data.PXSqlDatabaseProvider, PX.Data" ... reportQueryTimeout="600" />


To Configure the Query Time-OutBy default, the query time-out is set to 30 seconds. If you need to, you can increase the query time-out.


To Configure the Query Time-Out


2. In the file, find the following line, where ... represents the other parameters, which depend onyour website settings.

<add name="PXSqlDatabaseProvider" type="PX.Data.PXSqlDatabaseProvider, PX.Data" ... />

3. Add the queryTimeout parameter to the line and specify the query timeout time (in seconds).

<add name="PXSqlDatabaseProvider" type="PX.Data.PXSqlDatabaseProvider,


PX.Data" ... queryTimeout="100" />


To Select Roles That Will Have Administrative PrivilegesIn Acumatica ERP, the Administrator role has administrative privileges. For your instance, you canchange the default settings and assign administrative privileges to one role or multiple roles wheneveryou need to.

Prerequisites

Configure the roles to which you want to give administrator privileges in your instance. For moreinformation on role configuration, see Managing User Access Rights.

To Select a Role or Multiple Roles That Will Have Administrative Privileges



2. In the file, find the Providers section in pxaccess, which has the following settings.

<providers> <remove name="PXDatabaseAccessProvider" /> <add name="PXDatabaseAccessProvider" type="PX.Data.PXDBFeatureAccessProvider, PX.Data" applicationName="/" administratorRole="Administrator" /> </providers>

The administratorRole="<role>" parameter defines which roles have the administratorprivileges.

3. List the roles you want to have the administrative privileges in the administratorRoleparameter, as shown below.

administratorRole="<Roles>"

Where Roles is the comma-separated (without spaces) list of roles to which you want to grantadministrative privileges.


To Shorten the Names of the Customization FoldersIn Acumatica ERP, the names of the Validation and Website customization folders start with the nameof the application instance website. For example, a path to the Website folder of the InstanceNameinstance may be as follows.

C:\Program Files (x86)\Acumatica ERP\Customization\InstanceName\InstanceNameValidation\InstanceNameWebsite

Because the Customization folder includes the folder with the instance name, you can configure thesystem to shorten the names of the Validation and Website folders by excluding the <instance_name>


prefix, that is, the name of the application instance website. The paths to the Validation and Websitefolders remain unique.

To Shorten the Names of the Customization Folders


1. Open the web.config file for the site instance. Usually it is located in %Program Files%\Acumatica ERP\<instance_name>, where <instance_name> is the name of theapplication instance website.

2. In the file, add the following sections.

<add key="CstSolutionName" value="SolutionDev"/><add key="CstWebsiteName" value="Dev"/>

3. Save the web.config file, which causes the website to automatically restart.

To Turn On RemindersIn Acumatica ERP, you can use reminders to draw users' attention to upcoming tasks and events. Bydefault, these reminders are turned off. For more information about reminders, see Managing YourTasks and Events.

: After you save changes to the web.config file, the website is automatically restarted. Make sure that allusers are warned about the restart so that they can save their documents in advance.

To Turn On Reminders


2. In the file, find the Reminder section, which has the following settings.

<add key="ReminderVisible" value="false" /> <add key="ReminderRequestPeriod" value="60" /> <add key="ReminderActiveMode" value="false" />

3. Change the following key values:

• ReminderVisible to true

• ReminderActiveMode to true


Post-requisites

After you turn on the reminders, you should configure access to the Reminder Dialog Box form for roleswhose users use reminders. For more information on roles configuration, see Access Rights for Roles.

To Turn On the My Tasks and Events ButtonIn Acumatica ERP, you can use My Tasks and Events menu in the top right corner of the screen todraw users' attention to their tasks and events and to quickly navigate to the task or event in question.By default, this menu is hidden. For more information, see Info Area in the Acumatica ERP InterfaceGuide.


: After you save changes to the web.config file, the website is automatically restarted. Make sure that allusers are warned about the restart so that they can save their documents in advance.

To Turn On Reminders


2. In the file, find the following section.

<add key="ActivityTotalsVisible" value="false" />

3. Change the ActivityTotalsVisible key value to true.


| Maintaining Acumatica Framework | 57

Maintaining Acumatica Framework

Maintenance of the Acumatica Framework application instance site and database is similar tomaintenance of the Acumatica ERP application instance. Follow the procedures described in MaintainingAcumatica ERP to perform maintenance tasks that are associated with application instances ofAcumatica Framework and their databases.

| Managing Companies | 58

Managing Companies

Acumatica ERP is an application with multi-tenancy architecture, in which a single instance of anapplication can serve multiple tenants. Each such tenant is a separate company. By running oneinstance of the application with one instance of a database, you can give multiple companies webaccess to the same database. You can manage companies locally or by using the web interface.

Managing Companies Locally

By using the Company Setup page of the Acumatica ERP Configuration Wizard, you can do thefollowing:

• Add a new company to the selected instance. For more information, see To Add a New Company.

• Delete an existing company. For details, see To Delete an Existing Company.

Managing Companies by Using the Web Interface

You can create new companies directly from the Acumatica ERP application without using the AcumaticaERP Configuration Wizard. For more information, see Management Overview.

Managing Multi-Company Instances

Multiple companies can use the same application instance with completely isolated data. The applicationlooks identical to all tenants, but each company has exclusive access to only its data. For moreinformation, see Multi-Company Instances.

Multi-Company InstancesMultiple companies or tenants can work on the same application instance with completely isolated data.The application looks identical to all tenants, but each company has exclusive access to only its data.

When you deploy the Acumatica ERP instance, you create at least one tenant company. You cancreate more companies with the help of the Acumatica ERP Configuration Wizard or directly from theAcumatica ERP application by using the Companies (SM.20.35.20) form.

The System Company

When you install Acumatica ERP, the System company (with Company ID = 1) is always createdautomatically. This company contains the predefined system data, such as preconfigured roles andnumbering sequences, as well as wiki-based documentation. The system data is used by all tenants ofthe same application instance.

By default, the System company is hidden. All other user-created companies inherit the initialconfiguration and system data (predefined data) from the System company. That is, all the dataavailable in System is visible to other companies in the same database.

An application update or upgrade replaces all the data available in the System company. The datacreated by users in user-created companies remains unchanged.

Parent and Child Companies

If you would like to replace the preconfigured data, such as roles and numbering sequences, similarlyfor multiple new companies, you can create a parent company that will serve as a system company foryour new companies.


To configure a custom parent company, create a new company and provide a name that clearlyindicates how this company will be used—for example, Parent1. This company inherits all the datafrom the System company. In the Parent company, override the preconfigured settings as needed andspecify other configuration settings to be used in all the new companies. Then, when you create a newcompany by using the Acumatica ERP Configuration Wizard, you specify Parent1 as the new company'sparent company; the new company will inherit all the data from the Parent company rather than fromthe System company.

You can create a virtually unlimited number of parent companies; a parent company can be a childof another parent company. Users won't be able to sign in to a parent company. You can create newcompanies based on the parent company only by using the Acumatica ERP Configuration Wizard.

You can create a virtually unlimited number of child companies, which cannot be parents to any othercompany. Users can sign in to a child company.

Data Sharing Between Companies

Acumatica ERP provides shared data access in a multi-tenant configuration. You can set up the datasharing mode for all companies on a per-table basis and the mode is applied to every companyimmediately.

: Table configuration is a dangerous operation that can result in database corruption. Any changes youmake are at your own risk. If you configure tables, be sure to first back up the database.

You can select one of the available data sharing modes: Split, Shared, or Separate.

Signing in to a Specific Company

In a multi-company Acumatica ERP instance, the Company box appears on Welcome screen by default.Thus, the users can select the company to sign in to from the list of all available companies.

If you want to restrict the list of companies a user can see only to the companies the user has accessto, select the Secure Company on Login Screen check box on the Company Setup page. In this case,the Company box does not appear on the Welcome screen by default and all users first authenticatethemselves by entering their login and password. Depending on the user, one of the following occurs:

• A user who has access to only one company will be automatically signed in to this company afterentering the login and password.

• A user who has access to multiple companies and has the same credentials in these companiesmust select a company in the Company box, which appears after the user has been authenticatedand contains the list of companies available for the user.

• A user who has access to multiple companies and has different credentials for different companiesis signed in to the company whose credentials the user entered on the Welcome screen.

• A user who has access to multiple companies and logs in to Acumatica ERP instance using singlesign-on with an external identity provider, is signed in to the first company with enabled singlesign-on.

To Add a New CompanyYou can add a virtually unlimited number of companies to an application instance.

To Add a New Company





a. In the Installed Sites list, select the appropriate Acumatica ERP instance.

b. Click Company Maintenance.

4. In the SQL Server Authentication dialog box, select the authentication method to be used toconnect to the database.

5. Click OK.

6. On the Company Setup page, click New to add a new company.

A new row is appended to the table with the New check box selected.

7. To rename the company, double-click the company name in the Login Company Name column,type a new company name, and press Enter.

: This name is used only when there are multiple companies; otherwise, the Logon screen will nothave an option to select a company.

8. If you want to fill the database with demo data or template data, select Demo or Template in theInsert Data column.

9. Optional: For each company, specify the following:

• Visible: Select this check box to have this company displayed on the logon screen.

• Parent Company ID: Select the ID of the company you want to use as the parent for thiscompany.

The following view-only parameters are also displayed for each company:

• ID: The numerical identifier of the company.

• New: A check box that, if selected, indicates that this company is newly created and hasnot been deployed yet. If the check box is cleared, the company has been deployed.

• Additional Info: The company name in the database.

If you want to delete a company that you just added (that is, one with the New check boxselected), do the following:

a. In the Installed companies list, select the row of the newly added company.

b. Click Delete.

10. Optional: Select the Advanced check box to configure the data sharing mode for the databasetables.

11. Optional: On the Tables Configuration page (which the system displays only if you have selectedthe Advanced Settings check box on the previous page), specify whether you want thedatabase tables to be shared by different companies, and then click Next.




b. If you want to save the configuration settings in an XML file on your computer, click SaveConfiguration.

c. Click Finish to deploy the new company.


To Delete an Existing CompanyIf you need to delete an existing company by using the Acumatica ERP Configuration Wizard, you openthe instance for company maintenance and delete the company in advanced mode.

: Because any company you see on the Company Setup page can be a live company, you may want tocreate backups before making any changes.

To Delete an Existing Company




a. In the Installed sites list, click the appropriate Acumatica ERP instance.

b. In the bottom area of the page, click Company Maintenance.

4. In the SQL Server Authentication dialog box, select the authentication method to be used toconnect to the database, and then click OK.

5. On the Company Setup page, select the company row in the Installed companies list.

6. Click Delete.

7. When you're prompted, click OK to delete the selected company.

8. On the Table Configuration page, check the data sharing modes for the database tables, andthen click Next.



b. If you want to save the configuration settings in an XML file on your computer, click SaveConfiguration.

c. Click Finish to delete the company.

| Updating Acumatica ERP | 62

Updating Acumatica ERP

Updates for Acumatica ERP provide functional enhancements and new functionality. You need to use aninstallation package to update your Acumatica ERP instances.

In this topic, you will read about the ways to update Acumatica ERP and the schedule for locking outthe system during the time of update.

Updating Acumatica ERP

You can update your instance of Acumatica ERP to a new product version or build in one of the followingways:

• By using the Acumatica ERP web interface

• By using the Acumatica ERP Configuration Wizard

The easiest way of updating Acumatica ERP is by using the web interface.

: If you have deployed your instance on Windows Azure, you won't be able to update this instance thoughthe web interface. You must instead use the procedures described in Updating Your Acumatica ERP Serviceon Windows Azure.

If a server with Acumatica ERP is connected to the Internet, the system can download installationpackages directly from the Acumatica ERP update server during installation. If the server is notconnected to the Internet, you can download the update package from another computer, upload thepackage to Acumatica ERP, and install it by using the web interface. For more information, see UpdatingAcumatica ERP by Using the Web Interface.

Alternatively, you can update Acumatica ERP by using the Configuration Wizard if you cannot update itby using the web interface (for example, for security reasons). For details, see Updating Acumatica ERPby Using the Configuration Wizard.

You can forbid the users of your Acumatica ERP instance to update the system by using the webinterface. This might be useful, for example, when you want to avoid an unwanted update of a largedatabase on Amazon Web Services. To prevent users from updating the system through the webinterface, you set the RestrictUpdates parameter value to True in the appSettings section of theweb.config file. With this setting, a message conveying this restriction appears on the Apply Updates(SM.20.35.10) form, all update actions on this form are blocked, and you can update Acumatica ERP byusing the Configuration Wizard only.

Scheduling the Lockout of the System

Before you start updating your system, we recommend that you schedule the system lockout by usingthe Apply Updates form, specifying when the system will be unavailable. A message alerting usersto the system lockout will be displayed on the Welcome screen. When the lockout is in effect, non-administrative users won't be able to enter the system; they will see a message indicating that the siteis under maintenance. After finishing the update, you must manually unlock the system on the ApplyUpdates form.

: When the lockout is in effect, only users that have the Administrator role can sign in to the system.

For details, see To Schedule the System Lockout and To Unlock an Acumatica ERP Instance.


Updating Acumatica ERP by Using the Web InterfaceYou can use the Acumatica ERP web interface to remotely update Acumatica ERP (which is installed onthe premises of your organization or on Amazon EC2) to a newer version or build.

: If you have deployed your instance on Windows Azure, you won't be able to update this instance thoughthe web interface. You must instead use the procedures described in Updating Your Acumatica ERP Serviceon Windows Azure.

In this topic, you will find an upgrade policy, a description of the update process when you use the webinterface and recommended update preferences.

Upgrade Policy

On the Apply Updates (SM.20.35.10) form, only minor updates for your current version of AcumaticaERP are available. You should upgrade your Acumatica ERP from previous versions of the systemto Version 6.1 manually on the server (upgrade by using the web interface is not supported dueto significant changes in customizations). For details, see Updating Acumatica ERP by Using theConfiguration Wizard.

Before You Proceed

We strongly recommend that before you update Acumatica ERP to a newer product version, you do thefollowing:

• Back up all configuration files and databases used by the application instances.

• If you have created any custom views with the SCHEMABINDING clause in the Acumatica ERPdatabase, remove them. (You can create these views anew after update.)

• If you have been replicating the Acumatica ERP database, turn off the replication. (Otherwise, thesystem cannot be updated.)

• If you developed a client application by using the screen-based SOAP API, follow the proceduredescribed in To Update a Client Application that Uses Screen-Based Web Services to prevent afailure of your application that can happen because of the UI changes in the system.

Overview of the Update Process

When you update Acumatica ERP by using the web interface, both the site and the database of theapplication are updated at the same time. To update Acumatica ERP by using the web interface, you willperform the following steps:

1. If necessary, notify users about the upcoming update and automatically lock out the system atthe time of update, as described in To Schedule the System Lockout.

2. If you want to upload a custom installation package (which was released especially for yourorganization) with an update from a local computer, on the Apply Updates (SM.20.35.10) form,click Upload Custom Package and select the custom package file.

3. Update the instance by using the Apply Updates form, as described in To Update Acumatica ERPby Using the Web Interface.

4. If you are upgrading your system from a version that did not include the search indexes, buildthe search indexes. For details, see To Build Search Indexes in the Acumatica ERP User Guide.

5. If you have locked out the system, unlock the system, as described in To Unlock an AcumaticaERP Instance.


Configuration of Update Preferences

If a server with Acumatica ERP is connected to the Internet, the system can download installationpackages directly from the Acumatica ERP update server during installation. To make the systemdownload installation packages from the update server and to display the most recent informationabout Acumatica ERP updates, you need to do the following on the Update Preferences (SM.20.35.05)form:

• Select the Use Update Server check box to download installation packages directly from theAcumatica ERP update server.

• Select the Check for Updates check box to automatically check for new updates. When a newproduct update (a major version or a build) has been approved and released by the AcumaticaQuality Assurance team, a notification appears in the About Acumatica dialog box. (To open thisdialog box, sign in to the system, and on the form toolbar, click About on the Help menu.)

Updating Acumatica ERP by Using the Configuration WizardIf you have the installation package file available on your computer, you can update Acumatica ERPlocally on the server where the previous version of the system is installed. You can also use thismethod of updating if for some reason you cannot use the Acumatica ERP web interface to update theapplication.

You perform the update procedure on the server where the current version of the Acumatica ERP Toolsis installed.

: To run the installation package, you must have the Administrator role on your local computer.

In this topic, you can find a brief description of the update process on a local server and on MicrosoftAzure.

Before You Proceed

We strongly recommend that before you update Acumatica ERP to a newer product version, you do thefollowing:

• Back up all configuration files and databases used by the application instances.

• If you have created any custom views with the SCHEMABINDING clause in the Acumatica ERPdatabase, remove them. (You can create these views anew after update.)

• If you have been replicating the Acumatica ERP database, turn off the replication. (Otherwise, thesystem cannot be updated.)

• If you developed a client application by using the screen-based SOAP API, follow the proceduredescribed in To Update a Client Application that Uses Screen-Based Web Services to prevent afailure of your application that can happen because of the UI changes in the system.

Overview of the Update Process on a Local Server

To update Acumatica ERP locally, perform the following steps:

1. If necessary, notify users about the upcoming update, and automatically lock out the system forthe time of update, as described in To Schedule the System Lockout.

2. Use the installation package file available on your computer to update the Acumatica ERP Tools.For details, see To Update the Acumatica ERP Tools.

3. Start updating the database and the site of your application instance. The system willautomatically perform the following actions:


a. For instances that contain published customization projects, validate the compatibility ofthe currently published customization code with the code of the new product version.

b. Update the database of the instance.

c. Update the site of the instance.

For details, see To Update the Database and Site of an Acumatica ERP Instance.

If you need to update the database without updating the site or to update the site withoutupdating the database, see Divided Update of the Database and the Site.

: We strongly recommend that you use the common procedure described in this step for a usualupdate of your Acumatica ERP instance.

4. If you are upgrading your system from a version that did not include the search indexes, buildthe search indexes. For details, see To Build Search Indexes in the Acumatica ERP User Guide.

5. If you locked out the system, unlock the system, as described in To Unlock an Acumatica ERPInstance.

Divided Update of the Database and the Site

If (for strong reasons) you need to update the Acumatica ERP database without updating the site, toupdate the site without updating the database, or to consequently update the database and the site,you can use the Update only Website and Update only Database commands, which you can findin the drop-down list to the right of the Upgrade button in the Application Maintenance page of theAcumatica ERP Configuration Wizard. For details, see To Update the Database of an Acumatica ERPInstance and To Update the Site of an Acumatica ERP Instance.

: When you update your Acumatica ERP instance by using the Update only Website or Update onlyDatabase commands, the system does not validate the customization compatibility. If you have publishedcustomization in your Acumatica ERP instance, the instance may stop working after update due toincompatible customization code.

Updating Your Acumatica ERP Service on Windows AzureIf you have deployed your Acumatica ERP Service on Windows Azure and want to update this servicewith a new installation package, you need to do this on the Windows Azure portal. In this topic, you willfind an overview of the update process on the Windows Azure portal.

: If you change the Windows Azure deployment size (for example, when you extend your subscription fromSmall to Medium), you also need to update your Acumatica ERP Service by using the steps described in thistopic.

The Update Process on Windows Azure

To update your Acumatica ERP Service that was deployed on Windows Azure, you need to perform thefollowing steps:

1. Download the service package file of the Acumatica ERP version to which you want to updateyour Acumatica ERP Service, as described in To Download the Configuration Package.

2. Download the configuration file of your Acumatica ERP Service, as described in To Download theAcumatica ERP Service Configuration File.

3. If necessary, notify users about the upcoming update, and automatically lock out the system forthe time of update, as described in To Schedule the System Lockout.

4. Update your Acumatica ERP Service on Windows Azure, as described in To Update YourAcumatica ERP Service on Windows Azure.


5. If you are updating your system from a version that did not include the search indexes, build thesearch indexes. For details, see To Build Search Indexes in the Acumatica ERP User Guide.

6. If you locked out the system, unlock the system, as described in To Unlock an Acumatica ERPInstance.

To Schedule the System LockoutTo notify users about the upcoming update and automatically lock out the system at the time, you canschedule a lockout by using the Apply Updates (SM.20.35.10) form. A message alerting users to thesystem lockout will be displayed on the Welcome screen.

: When the lockout is in effect, only users who have the Administrator role can sign in to the system.

To Schedule the System Lockout

1. If you are not already signed in to the system, sign in to Acumatica ERP.

2. Navigate to System > Management > Process > Apply Updates.

3. On the form toolbar, click Schedule Lockout.

4. In the Schedule Lockout dialog box, specify the date and time when the system will be lockedout and the reason for the lockout.

: If you want to update the system immediately, specify the current date and time.

5. Click OK to lock out the system at the specified time.

To Update Acumatica ERP by Using the Web InterfaceTo update an Acumatica ERP instance by using the web interface, you use the Apply Updates(SM.20.35.10) form. For more information, see Updating Acumatica ERP by Using the Web Interface.

To Update an Acumatica ERP Instance by Using the Web Interface



3. Install the new product version. On the Updates tab, do the following:

a. In the Major Version box, select the product version to which you want to update yourAcumatica ERP instance.

b. In the table of available updates, select the latest product build of the selected version,and then click Download Package in the table toolbar.

When the download is complete, the Ready to Install check box is automaticallyselected.

c. If you have published customization projects in your Acumatica ERP instance, in the tabletoolbar, click Validate Customization to start the process of validating the compatibilityof the currently published customization code with the code of the selected productversion. For details, see To Validate the Compatibility of the Published Customization witha New Version Before an Upgrade.

d. If the validation has succeeded, in the table toolbar, click Install Update.


A background process starts that copies Acumatica ERP software components to theserver computer and then updates the application instances and databases.

If you locked the instance before the update, you should unlock the instance, as described in To Unlockan Acumatica ERP Instance.

To Update the Acumatica ERP ToolsYou perform the update procedure on the server where the current version of the Acumatica ERPTools is installed. For an overview of the update procedure, see Updating Acumatica ERP by Using theConfiguration Wizard.

: To run the installation package, you must have the Administrator role on the local computer.

To Update the Acumatica ERP Tools

1. If necessary, back up the configuration files and databases maintained by the applicationinstances.

2. Run the latest version of the installation package, and follow the procedure for installingAcumatica ERP Tools. For more information, see To Install the Acumatica ERP Tools.

To Update the Database and Site of an Acumatica ERP InstanceAfter you have updated the Acumatica ERP Tools, you need to update the database and the site of yourAcumatica ERP instance. For an overview of the update procedure, see Updating Acumatica ERP byUsing the Configuration Wizard.

To Update the Database and Site of an Acumatica ERP Instance

1. Run the Acumatica ERP Configuration Wizard on the server where the Acumatica ERP Tools areinstalled.



a. In the Installed Sites list, click the Acumatica ERP instance whose version you want toupdate. You can see the current versions in the Site Version and DB Version boxes.

b. Click Upgrade.

4. When you're prompted, click Yes to continue the update.

5. In the SQL Server Authentication dialog box, do the following:

a. Select the authentication method to be used to connect to the database.

b. If you have selected the SQL Server Authentication option, specify an account that hassufficient rights to make changes to the database.

c. If you want to shrink data after the database maintenance, select the Shrink data checkbox.

d. Click OK to start the update.

For instances that contain published customization projects, the system first validates the compatibilityof the currently published customization code with the code of the selected product version. If thevalidation is successful, the system updates the database and the site. If the validation fails, the


Validation Failed window opens to display the list of the executed checks and the discovered errors,and the update process is interrupted. To resolve any issues that were discovered, see To Resolve anIssue Discovered During the Validation.

The time required for the update depends on the performance of your database server, the differencesbetween the old and current versions of the database schema, the hardware configuration of theserver, and the current system load. When the update of the instance is finished, the Acumatica ERPConfiguration Wizard updates the list of instances.

To Update the Database of an Acumatica ERP InstanceYou update the databases after you update the Acumatica ERP Tools.

: You must update the application instances as well.

To Update the Database of an Application Instance




a. In the Installed Sites list, click the Acumatica ERP instance whose database you want toupdate. You can see the current version in the DB Version box.

b. In the drop-down menu next to the Upgrade button, select Update only Database.

4. When you are prompted, click Yes to continue the update.

5. In the SQL Server Authentication dialog box, specify the authentication method to be used toconnect to the database.

If you select the SQL Server Authentication option, specify an account that has sufficientrights to make changes to the databases.

6. If you want to shrink data after the database maintenance, select the Shrink data check box.

7. Click OK.

The time required for the update depends upon your database server performance and the differencesbetween the old and current versions of the database schema.

After you have updated the database you should update the site, as described in To Update the Site ofan Acumatica ERP Instance.

To Update the Site of an Acumatica ERP InstanceYou update an application instance after you update the Acumatica ERP Tools.

: You must update the database of the application instance as well. For details, see To Update theDatabase of an Acumatica ERP Instance.

To Update the Site of an Acumatica ERP Instance

1. Run the Acumatica ERP Configuration Wizard on the server where the Acumatica ERP Tools areinstalled.




a. In the Installed Sites list, click the Acumatica ERP instance whose version you want toupdate. You can see the current version in the Site Version box.

b. In the drop-down menu next to the Upgrade button, select Upgrade only Site.

4. When you're prompted, click Yes to continue the update.

The update process takes a few minutes, depending on the hardware configuration and the currentsystem load. When the update of the instance is finished, the Acumatica ERP Configuration Wizardupdates the list of instances.

To Download the Acumatica ERP Service Configuration FileBefore you update your Acumatica ERP Service deployed on Windows Azure, you should download theconfiguration file (*.cscfg) that you will use for update, as described in this topic.

To Download the Acumatica ERP Service Configuration File

1. Sign in to the Windows Azure portal.

2. On the left pane, click Cloud Services (classic).

3. In the Cloud Services (classic) blade, click the name of the Acumatica ERP Service you wantto update.

4. In the left part of your Acumatica ERP Service blade, click Configuration.

5. On the Configuration blade toolbar, click Download to download the *.cscfg configuration file(see the following screenshot).

Figure: Windows Azure portal: Downloading a configuration file

https://portal.azure.com/


After you have downloaded the configuration file for your Acumatica ERP Service, you can start theupdate procedure. For details, see To Update Your Acumatica ERP Service on Windows Azure.

To Update Your Acumatica ERP Service on Windows AzureTo update your Acumatica ERP Service deployed on Windows Azure, you need to follow the proceduredescribed in this topic. For the overview of the update procedure, see Updating Your Acumatica ERPService on Windows Azure.

To Update Your Acumatica ERP Service on Windows Azure

1. Sign in to the Windows Azure portal.

2. On the left pane, click Cloud Services (classic).

3. In the Cloud Services (classic) blade, click the name of the Acumatica ERP Service you wantto update.

4. On the toolbar of your Acumatica ERP Service blade, click Update (see the followingscreenshot).

Figure: Windows Azure portal: Opening the Update you deployment blade

5. In the Update your deployment blade, do the following (see the screenshot below):

a. In the Package box, select the *.cspkg package file that you downloaded from thePartner Portal.

b. In the Configuration box, select the *.cscfg configuration file that you downloaded onthe Configuration blade.

c. Specify other settings to meet your needs.

d. Click OK to start updating the service.

https://portal.azure.com/


Figure: Windows Azure portal: Updating your Acumatica ERP Service

Uploading the service package file and the service configuration file and updating the service may takeseveral minutes.

To Update a Client Application that Uses Screen-Based WebServices

To prevent application failures and omit the regeneration of the WSDL description for each change ofthe user interface of the system, we recommend that you follow the procedure described in this topicbefore you update your Acumatica ERP instance.

To Update a Client Application that Uses Screen-Based Web Services

To prevent application failures with the update to a newer version of Acumatica ERP, perform thefollowing steps before you install the update:

1. Create a test copy of your production Acumatica ERP instance.

2. Make changes to your client application, as described in To Use the Screen-Based API Wrapper.

3. Test the client application with the test copy of your Acumatica ERP instance.

4. Update the test copy of your Acumatica ERP instance to a new version of Acumatica ERP.

5. Test the client application with the updated test copy of your Acumatica ERP instance.

6. Update the production instance of Acumatica ERP to the new version.


: You should distribute the client application along with the XML schema file that is generated by thescreen-based API wrapper. For details, see Screen-Based API Wrapper.

To Unlock an Acumatica ERP InstanceIf you have locked your instance before updating Acumatica ERP, you should use the Apply Updates(SM.20.35.10) form to unlock the instance after you finish updating it.

: When the lockout is in effect, only users that have the Administrator role can sign in to the system.

To Unlock an Acumatica ERP Instance



3. On the form toolbar, click Stop Lockout to unlock the system.

| Troubleshooting Acumatica ERP | 73

Troubleshooting Acumatica ERP

This chapter explains how you can use various tools and methods to troubleshoot Acumatica ERP, bothduring installation and later, during production use.

In This Chapter

• Troubleshooting Performance

• Using Logs

• Using Profilers

• Using Built-In Debugging Tools

• Using Third-Party Tools

• To Optimize Memory Consumption During Startup

Troubleshooting PerformanceIn this topic and the steps within it, you can find a detailed description of the steps you need to performto resolve performance issues on the client side and, if necessary, to gather information to provide it tothe Acumatica support team.

Performance issues fall into two broad categories:

• Overall performance is slow

The whole site is slow, and you cannot identify a particular process for which the slowdownoccurs.

• Some process works slowly

The site works slowly when a user is working with particular forms or executing specific actions.

The category your client’s performance issues fall into dictates the steps and substeps you shouldperform to find the reasons for the performance slowdown and resolve the issue. For each category, thefollowing table shows these steps and substeps; the + symbol indicates that you should perform thestep or substep. You can find detailed descriptions of the steps and substeps in the applicable topics.

Performance Troubleshooting

Overall performance is slow Some process works slowly

Step 1: Check the most basic causes

1. Check whether the site islicensed

+ Skip this substep

2. Check the speed from otherbrowsers

+ +

3. Check the speed from otherlocations

+ +

4. Check automation schedules + +

5. Explore the running processes + +


Overall performance is slow Some process works slowly

6. Check whether antivirussoftware is blocking somefunctionality of the site

+ Skip this substep

Step 2: Investigate applicationserver time and database servertime in the Request Profiler

+ Skip this step

Step 3: Check the configurationof the application server

+ Skip this step

Step 4: Check the configuration of the database server and run reports

1. Check the configuration of thedatabase server

+ +

2. Run performance reports + +

3. Check the SQL ActivityMonitor for locks

+ +

Step 5: Collect more information

1. Investigate requests in theRequest Profiler

+ +

2. Collect additional informationfrom the logs

+ +

3. Use external tools + +

Step 6: Submit a case toAcumatica support

+ +

Step 1: Check the Most Basic CausesTo exclude the reasons that lead to performance slowdown most frequently, you should perform thesubsteps described in the sections that follow.

1. Check Whether the Site Is Licensed

The slowdown may be caused by the site not being licensed. Sites in trial mode allow only twoconcurrent users and limit the usage of hardware resources.

If you have already registered the site, it could become unlicensed for the following reasons:

• A user may be using a URL of an unregistered site—for example, if the user is accessing the sitethrough a bookmark with that URL.

• Some hardware changes have been made to the application server—for example, more CPUs havebeen added, or the application pools have been changed.

Perform the following task to check whether the site is licensed.

To check whether the site is licensed:

1. Check if the site is licensed in one of the following ways:

• Make sure there is no message in the bottom of the browser window that says Yourproduct is in the trial mode. Only two concurrent users are allowed. Activate. See themessage in the following screenshot.


• On the Activate License (SM.20.15.10) form, check the value of the Status element. Anunregistered site has the Invalid status, as shown in the following screenshot.

Figure: Invalid license

2. Depending on the results of the previous instruction, do one of the following:

• If the site is not licensed, activate the license by following the instructions in Licensing andActivating Acumatica ERP.

• If the site is licensed, continue with the next substep.

2. Check the Speed from Other Browsers

Another possible reason for the slowdown is that some properties of the browser may be preventing thesite from running faster.

Perform the following task to see whether this is the reason for the slowdown.

To check the speed from other browsers:

1. Try to access the site from another browser.


• If the issue is reproduced in only one browser, check the version of the browser, and try toreproduce the issue in the latest version of the browser. You can also try to turn off plug-ins in the browser. Collect more information on the slowdown, and send it to the Acumaticasupport team, as described in Step 5: Collect More Information and Step 6: Submit a Caseto Acumatica Support.

• If the issue is reproduced in all browsers, continue with the next substep.

3. Check the Speed from Other Locations

Some network or internet service provider issues at the user’s end may be causing a performanceslowdown.

Perform the following task to see whether this is the reason for the slowdown.

To check the speed from other locations:

1. Try to reproduce the slowdown issue on some computers at a different location.


• If the issue is not reproduced on other computers, the problem is probably in the client’snetwork. Ask the client to check the network settings.


• If the issue is reproduced on multiple computers, continue with the next substep.

4. Check Automation Schedules

Slowdowns may be caused by errors on active schedules, unprocessed emails, or insufficient time for ascheduled processes to complete before others begin.

Perform the following tasks to check the automation schedules.

To look for errors on the active schedules:

1. On the Automation Schedules (SM.20.50.30) form, look for errors on the active schedules. (Foreach schedule, see the Status and the Last Execution Result columns.)


• If you found an error, either correct the error in the scheduled process or deactivate theschedule.

• If there are no errors in automation schedules, continue with the next task.

To check the frequency of schedules:

1. On the Automation Schedules form, make sure there are no schedules starting at the same timeor within short intervals.


• If you have found some overlap in the schedules, correct the execution times of anyneeded schedules. For example, we recommend that you leave at least 5 minutes betweenSend and Receive Email schedules, as shown in the following screenshot.

Figure: Send and Receive Email schedule

• If there is enough time for each process to finish before the start of the next scheduledprocess, continue with the next task.

To look for failed and old unprocessed emails:

1. On the All Emails (CO.40.90.70) form, look for failed and old unprocessed emails.



• If you have found failed or old unprocessed emails, delete them.

• If there are no failed or unprocessed emails, continue with the next substep.

5. Explore the Running Processes

The slowdown could be caused by some process that is hung and is running in an endless loop.

Perform the following tasks to check the running processes.

To Check the Running Processes in Acumatica ERP

On the Running Processes (SM.20.15.30) form, check the list of all ongoing processes for all users asfollows:

1. Look for processes that have been going on for a long time (typically you should look forprocesses running longer than 30 minutes) to see if the process is hung and running in anendless loop.

2. Depending on the results of the previous instruction, do the following:

• If some process is hung, select the process and click Abort on the form toolbar to endthe process, as shown in the following screenshot. If the situation repeats, collect moreinformation on the slowdown and send it to the Acumatica support team, as described inStep 5: Collect More Information and Step 6: Submit a Case to Acumatica Support.

Figure: Abort button

• If no process is hung, continue with the next task.

To check the running processes in the operating system:

1. In Task Manager, review the running processes as follows:

• Check the memory consumption of the w3wp.exe process.

: Acumatica ERP runs under the w3wp.exe process, with the username that is the name ofthe application pool.

• Check whether other processes are executed at the same time and review their memoryconsumption.

2. Depending on the results of the previous, do one of the following:

• If w3wp.exe is using almost all memory, create a process dump, as described in If yoursite is completely non-responsive or extremely slow in Step 5. Try to restart the process.


• If another process takes too much time, either investigate the reasons or end the process.

• If memory consumption of the w3wp.exe is normal and no other processes are taking toomuch time or using too much server memory, continue with the next substep.

6. Check Whether Antivirus Software Is Blocking Some Functionality of the Site

Some settings of antivirus software could be preventing the site from working normally.

Perform the following task to see whether antivirus software is the reason for the slowdown.

To check whether the antivirus software is blocking the site:

1. Check the antivirus logs, and try to turn off the antivirus software, if any.


• If the antivirus software is blocking the site, change the antivirus settings.

• If the antivirus software is not blocking the site, continue with Step 2: InvestigateApplication Server Time and Database Server Time in the Request Profiler .

Step 2: Investigate Application Server Time and Database Server Time inthe Request Profiler

Either the application server or the database server may be working slowly, causing performanceissues.

Perform the following task to check the reason for the slowdown by using the Request Profiler, anAcumatica ERP tool.

To detect which of the servers works slowly:

1. On the Request Profiler (SM.20.50.70) form, start the Request Profiler by clicking Start on theform toolbar.

2. Reproduce the slowdown in the system.

3. Back on the Request Profiler form, click Refresh Results on the form toolbar to upload to thisform all the new activities since the last refresh.

: You must click Refresh Results to get the new rows in the profiler table. Pressing F5 does notprovide the same result.

4. Review the values in the Server Time, ms and SQL Time, ms columns of the profiler table:

• SQL Time is the time taken by SQL Server, in milliseconds.

• Server Time is the time taken by the request, in milliseconds. To get the time taken bythe application server, use the formula Time taken by application server = Server Time –SQL Time.


• If the time taken by application server is too long for most of the requests, proceed withStep 3: Check the Configuration of the Application Server.

• If the time taken by SQL server is too big for most of the requests, proceed with Step 4:Check the Configuration of the Database Server and Run Reports.

Step 3: Check the Configuration of the Application ServerSeveral settings of the application server may be configured incorrectly, leading to the performanceslowdown.


If correction of the application server settings does not improve the performance, collect moreinformation on the slowdown and send it to the Acumatica support team, as described in Step 5: CollectMore Information and Step 6: Submit a Case to Acumatica Support.

Perform the following tasks to check the configuration of the application server.

To enable dynamic compression:

You should enable dynamic content compression, which is disabled by default. The HTTP compressionsetting on Internet Information Services (IIS) can provide faster transmission times between IIS andthe client browser.

Click Start > Control Panel > Programs > Turn Windows features on or off. In the WindowsFeatures dialog box, which opens, select the Dynamic Content Compression check box (InternetInformation Services > World Wide Web Services > Performance Features), which is shown inthe following screenshot.

Figure: Dynamic Content Compression option

To use a dedicated application pool:

All Acumatica ERP instances should use their own application pools, which are not shared with any otherapplications.

When you are creating a new instance in Acumatica ERP Configuration Wizard, you should always usethe Create New Application Pool setting, which is shown in the following screenshot.


Figure: Create New Application Pool setting

You can change the application pool of an already-configured application in Internet InformationServices (IIS) Manager as described in https://technet.microsoft.com/en-us/library/cc731755(v=ws.10).aspx.

To check the IIS configuration on a 64-bit server:

You should make sure the application pool does not enable 32-bit applications on a 64-bit applicationserver, which can slow down the performance of a 64-bit server.

In the Connections pane of Internet Information Services (IIS) Manager, click Application Pools.Right-click the needed application pool, and in the pop-up menu, click Advanced Settings. Make surethe Enable 32-Bit Applications setting in the General group is set to False.

Step 4: Check the Configuration of the Database Server and Run ReportsTo make sure that the database server works correctly, you should perform the substeps describedbelow.

1. Check the Configuration of the Database Server

Several settings of the SQL server may not be configured properly, leading to the performanceslowdown.

If correction of the database server settings does not improve the performance of the site, continuewith 2. Run Performance Reports.

Perform the following tasks to check the database server configuration.

To ensure that the database server is not restricted on memory usage:

In SQL Server Management Studio, right-click the database server instance and select Properties. Inthe Server Properties dialog box, click Memory. Set the value in the Maximum server memory(in MB) box to 75 to 80 percent of the total physical memory of the server, but leave at least 4 GBavailable for the operating system. For example, if your server has a total memory of 16 GB, you canset the maximum server memory to 12 GB (which is 75 percent but leaves 4 GB for the operatingsystem).

To schedule the weekly maintenance plan:

By using the Maintenance Wizard in SQL Server Management Studio, schedule the following tasks:

• Database Integrity Check: Checks the logical and physical integrity of the database

• Rebuild Index: Helps remove gaps in data pages and eases the data retrieval process

• Shrink Database: Removes space by moving pages from the end of the file to the front, andthen deallocates the excess space back to the file system

https://technet.microsoft.com/en-us/library/cc731755(v=ws.10).aspx

https://technet.microsoft.com/en-us/library/cc731755(v=ws.10).aspx


• Update Statistics: Internally updates statistical information about tables and indexes used bySQL Query Optimizer during data retrieval requests

You can find more information on creating maintenance plans in https://msdn.microsoft.com/en-us/library/ms189953.aspx.

See an example of the schedule of the recommended maintenance plans in the following screenshot.

Figure: Weekly maintenance plan

2. Run Performance Reports

Some SQL queries consume too many resources.

To find out the top resource-consuming SQL queries, you should perform either or both of the followingtasks. You should collect data on the resource-consuming SQL queries as quickly as possible after aperformance slowdown occurs, because information in such reports is updated frequently during theprocess of server work.

To find out the top resource-consuming SQL queries by using a standard report:

1. In the Object Explorer of Microsoft SQL Server Management Studio, right-click the serverinstance, and select Reports > Standard Reports > Performance - Top Queries byAverage CPU Time. SQL Server Management Studio opens the report.

2. Right-click the report, select Export, and select the format of the exported report.

3. Send this report, along with other information on the slowdown, to the Acumatica support team.(See the list of information that you should provide to support in Step 6: Submit a Case toAcumatica Support.)

To find out the top resource-consuming SQL queries manually:

1. Perform the following SQL query to get the performance report. By using this report, you getthe same information that is provided in the standard report but in a table format, which canbe more convenient. Moreover, as a result of this request, you get not only average CPU time(AvgCPU) but also the number of times the process was executed (execution_count).Therefore, you can find out not only which process is taking the longest but also which process isbeing executed the most.

SELECT top 100

https://msdn.microsoft.com/en-us/library/ms189953.aspx

https://msdn.microsoft.com/en-us/library/ms189953.aspx


total_worker_time AS TotalCPU, total_elapsed_time/execution_count AS AvgDuration , total_elapsed_time AS TotalDuration , (total_logical_reads+total_physical_reads)/execution_count AS AvgReads , (total_logical_reads+total_physical_reads) AS TotalReads, execution_count , SUBSTRING (st.TEXT, (qs.statement_start_offset/2)+1, ( (CASE qs.statement_end_offset WHEN -1 THEN datalength(st.TEXT) ELSE qs.statement_end_offset END - qs.statement_start_offset)/2)+ 1 )AS txt , convert(nvarchar(max),query_plan), CONVERT(int, depa.value)

FROM [master].[sys].[dm_exec_query_stats] AS qs WITH (NOLOCK)cross apply [master].[sys].[dm_exec_sql_text](qs.sql_handle) AS st cross apply [master].[sys].[dm_exec_query_plan] (qs.plan_handle) AS qp cross apply [master].[sys].[dm_exec_plan_attributes](qs.plan_handle) depa WHERE (depa.attribute = 'dbid')ORDER BY 1 DESC;

2. Send the results of the query, along with other information on the slowdown, to the Acumaticasupport team. (For the list of information that you should provide to support, see Step 6: Submita Case to Acumatica Support.)

3. Check the SQL Activity Monitor for Locks

1. In the Object Explorer of SQL Server Management Studio, right-click the instance name, andthen select Activity Monitor.

2. Review the Recent Expensive Queries section.

3. Send the data from the SQL Activity Monitor, along with other information on the slowdown, tothe Acumatica support team. (For the list of information that you should provide to support, seeStep 6: Submit a Case to Acumatica Support.)

Step 5: Collect More InformationIf you have not found the reason for the performance slowdown while performing the previous steps oryou need to collect more details about it, perform the following substeps.

1. Investigate Requests in the Request Profiler

Do the following to isolate queries leading to errors and performance lags:

1. On the Request Profiler (SM.20.50.70) form, specify the following settings, which are shown inthe screenshot below:

• Log SQL Requests: Selected

• SQL Time Threshold: 2000

• SQL Count Threshold: 1000

: You have specified two thresholds for the requests. Therefore, the profiler will record the URLrequests that meet either of these conditions (the logical OR is applied).


Figure: Request Profiler settings

2. If the Request Profiler has not been started yet, click Start on the form toolbar.

3. Reproduce the slowdown in the system.

4. On the Request Profiler form, click Refresh Results on the form toolbar to upload to the formall the new activities since the last refresh.

5. Review the list of requests as follows:

• Find requests that have a value other than LongRun in the Command Target column witha server time greater than 2000 milliseconds.

• Find requests that have more than 1000 milliseconds in the SQL Count column.

6. For each request that meets either or both of the criteria above, select the corresponding row inthe table, and click SQL on the table toolbar to see the queries being executed, as shown in thefollowing screenshot.

Figure: SQL button

7. In the SQL Profiler dialog box, which opens, review the TimeMs column, which shows thetime taken by each step, and find the row with the biggest value in this column, as shown in thefollowing screenshot.


Figure: SQL Profiler dialog box

8. Double-click on this row to see the actual SQL statement, an example of which is shown in thefollowing screenshot.

Figure: SQL statement

9. Copy and paste the statement into SQL Server Management Studio, run the query with theExecution Plan enabled, and see whether any suggestions are provided by the SQL Server.

The following screenshot demonstrates SQL Server suggesting that the problem is a missingindex.

Figure: SQL Server suggestion

10. Report the issue to the Acumatica support team, as described in Step 6: Submit a Case toAcumatica Support. You can save the Request Profiler log to an Excel file by clicking Export toExcel on the table toolbar on the Request Profiler form.


: You can perform the solution suggested by SQL Server as an interim fix after consultation withthe Acumatica support team. However, we recommend that such issues are always reported via asupport case for a permanent solution.

2. Collect Additional Information from the Logs

You should collect the information from the needed log files depending on the situation, which can beone of the following:

• The performance slowdown appeared after an update

• Your site is completely non-responsive or extremely slow

• You need to track a randomly reproducible error

If the performance slowdown appeared after an update

1. Get information on the update that was performed and the errors that occurred during update byusing the following resources:

• Update history and errors

On the Update History tab of the Apply Updates (SM.20.35.10) form, get the informationon the history of updates and the errors that occurred during update. You can get thesame information from the UpHistory and UpErrors database tables of the site database,which you can view in the SQL Server Management Studio.

• Maintlog.txt

This log file contains the update history for the instance and all the errors that were loggedduring the update. The log file can be used to review the cause when you are unable to login due to a failed update through the Acumatica ERP Configuration Wizard.

You can find the file in the folder <Acumatica ERP Installation Folder>\<Site Folder>\App_Data. By default, the folder is C:\Program Files (x86)\Acumatica ERP\<SiteFolder>\App_Data.

2. Provide this information to the Acumatica support team, along with other information on theperformance slowdown issue. (For the list of information that you should provide to support, seeStep 6: Submit a Case to Acumatica Support.)

If your site is completely non-responsive or extremely slow:

1. Create a dump file as follows:

a. In Task Manager on the application server, find the w3wp.exe process that is run underthe username that is the name of the application pool.

b. Right-click on the process, and select Create Dump File, as shown in the followingscreenshot.


Figure: Creation of a dump file

: A process dump is a snapshot of an application showing what processes were executing andwhich modules were loaded at the time it was taken. The dump must be created only when the siteis completely non-responsive or extremely slow. While you are creating a dump file, the processgoes into a suspended mode, which will disconnect users from the site and lose any unsaved work.

2. Provide the dump file to the Acumatica support team, along with other materials related to theperformance slowdown issue. (For the list of information that you should provide to support, seeStep 6: Submit a Case to Acumatica Support.)

If you need to track a randomly reproducible error

1. Enable the first-chance exception log as follows:

a. Ensure that there is enough hard drive space on the Acumatica ERP installation drive(which by default is drive C).

: The first-chance exception log grows quite quickly in size and should be enabled for onlyshort periods of time.

b. In the web.config file in the Acumatica ERP site folder, find theEnableFirstChanceExceptionsLogging key, and change its value to true, as shown in thefollowing screenshot.

Figure: Fragment of web.config

c. Reproduce the problem.

d. Find the first-chance exception log file in the site folder. By default, it is C:\ProgramFiles (x86)\Acumatica ERP\<Site Folder>\firstchanceexceptions.log.

: The first-chance exception log is a powerful mechanism to track all exceptions in the system, butespecially randomly reproducible errors. The difference between the first-chance exception log andthe exception log that you can obtain by using the Request Profiler in Acumatica ERP (if you selectLog Trace Messages, Log Exceptions, or both on the Request Profiler (SM.20.50.70) form) isthat the first-chance exception log tracks not only committed transactions but also transactions thatresulted in errors.


2. Provide the first-chance exception log file to the Acumatica support team, along with othermaterials related to the performance slowdown issue. (For the list of information that you shouldprovide to support, see Step 6: Submit a Case to Acumatica Support.)

3. Use External Tools

You can use different external tools to get more information about the reasons for the performanceslowdown.

For example, you can use the dotTrace performance profiler to create a process snapshot.

If you use external tools to investigate performance issues, include the information obtained from thesetools when you contact the Acumatica support team. (For the list of information that you should provideto support, see Step 6: Submit a Case to Acumatica Support.)

Step 6: Submit a Case to Acumatica SupportIf you have not found a solution for your issue, create a case for the Acumatica support team andprovide as much information in it as you can, which may include the following information:

• Basic points to reproduce the issue

• Version and build of Acumatica ERP

• Troubleshooting steps taken so far (provide screenshots where applicable):

• Have you checked whether the site is licensed?

• Have you checked the speed from other browsers?

• If the issue is reproduced in only one browser, specify the browser and its version.

• Have you checked the speed from other locations?

• Have you checked automation schedules?

• Have you checked the list of running processes in Acumatica ERP and in the operatingsystem?

• Have you checked whether antivirus software is blocking the site?

• Have you checked the configuration of the application server?

• Specify whether dynamic content compression is enabled in the system.

• Specify whether the application uses its own application pool.

• Specify the mode in which IIS is running.

• Specify the parameters of the application server (total physical memory, number ofCPU cores, operating system, and number of concurrent users in the system).

• Have you checked the configuration of the database server?

• Specify whether the application server and database server are on separate hosts.

• Specify the maximum server memory specified in SQL Server settings.

• Specify whether weekly maintenance plans are scheduled.

• Specify the parameters of the database server (total physical memory, number of CPUcores, and operating system).

• Provide the performance reports of SQL Server.

• Specify whether you have found any locks in the SQL Activity Monitor.

• Have you used the Acumatica ERP Request Profiler?

https://www.jetbrains.com/profiler/download/


• Provide the log of the Request Profiler exported to Excel.

• Specify whether you have found any long-running requests.

• Have you obtained any additional information?

• Include memory dump file.

• Include update history and errors.

• Include maintlog.txt.

• Include first-chance exception log.

• Include dotTrace snapshot.

• Access credentials

• Convenient times to reset the system without contacting the client (if any)

Using LogsAcumatica ERP stores logs in a number of files and database tables. This topic contains informationabout the following logs:

• Trace: You can use this standard Acumatica ERP log for browsing issues that occur in theapplication.

• First-chance exception log: This mechanism for catching and logging exceptions can be veryhelpful when you are facing a problem of an unknown origin.

• Configuration Wizard logs: These logs provide information related to issues occurring in theAcumatica ERP Configuration Wizard or Acumatica Framework Configuration Wizard.

• Maintenance logs: In these logs, you can find details about issues that occur when you perform anupgrade in the Acumatica ERP application.

• Acumatica ERP logs: These logs, which are stored in database tables, provide historical data forvarious operations.

• Windows logs: These logs provide details for issues related to ASP.NET (for example, frequentapplication restarts or unhandled exceptions).

• IIS logs: In these logs, IIS keeps records of all requests.

• SQL Server logs: These logs, kept by SQL Server, contain details for issues related to databaseaccessibility and server maintenance operations.

Trace

The Acumatica ERP trace log is the first place you should look when you face an issue in the application.You can view the trace log by clicking Help > Trace on the form title bar.

When you are working with reports or generic inquiries, the trace log contains relevant SQL statementsthat you can use for SQL debugging purposes.

By default, the trace log is stored only in the current user session. However, you can also store thetrace log in the file system. This possibility is useful when you are dealing with errors that causeInternet Information Services (IIS) to become unresponsive and result in a web server restart.

To make the trace log stored in a file as well as in the current user session, edit the pxtrace sectionof the web.config file (which is located in the folder that contains the application instance website)similarly to the code block shown below.

<pxtrace defaultProvider="PXSessionTraceProvider"> <providers> <remove name="PXSessionTraceProvider" />


<add name="PXSessionTraceProvider" type="PX.Data.PXSessionTraceProvider, PX.Data" url="../Frames/Trace.aspx" /> <remove name="PXFileTraceProvider" /> <add name="PXFileTraceProvider" type="PX.Data.PXFileTraceProvider, PX.Data" file = "C:\Out\AcumaticaTraceInfo.txt" /> </providers></pxtrace>

In this case, the log file will be stored in C:\Out\AcumaticaTraceInfo.txt. You should create thefolder for the log file manually.

: You will have to monitor the size of the log file manually and delete its contents from time to time toavoid excessive growth of the file.

If you prefer to store the trace log only in a file and not in the current user session, edit the pxtracesection of the web.config file similarly to the code block shown below.

<pxtrace defaultProvider="PXFileTraceProvider"> <providers> <remove name="PXFileTraceProvider" /> <add name="PXFileTraceProvider" type="PX.Data.PXFileTraceProvider, PX.Data" file = "C:\Out\AcumaticaTraceInfo.txt" /> </providers></pxtrace>

First-Chance Exception Log

Acumatica ERP has a mechanism for catching and logging all exceptions in the system. You can activateit by editing the appropriate line in the appSettings section of the web.config file (which is located inthe folder that contains the application instance website) to read as follows.

<add key="EnableFirstChanceExceptionsLogging" value="true" />

You can edit the file name for the log in the following line of the same section. (By default, the log willbe stored in <Site_Folder>\App_Data\firstchanceexceptions.log, where <Site_Folder> is the pathto the folder that contains the application instance website.)

<add key="FirstChanceExceptionsLogFileName" value="firstchanceexceptions.log" />

: The first-chance exception log contains records of all exceptions, including those that the systemhas already caught and handled without issues, so the log file will grow rapidly and may reach anunmanageable size in minutes. Because of this, we recommend that you activate this logging mechanismfor only short periods of time. In addition, you may want to erase the contents of the file once the error hasbeen replicated and you have determined the required call stack.

When you are facing a problem of an unknown origin, we recommend that you use this loggingmechanism before trying other solutions—that is, you enable the mechanism, replicate the error,disable the mechanism to stop the log file from growing too much, and view the resulting log.

Configuration Wizard Logs

If an error occurs when you are using the Acumatica ERP Configuration Wizard or Acumatica FrameworkConfiguration Wizard, you can find the details of the error in the corresponding wizard log:

• Acumatica ERP Configuration Wizard: <Application_Installation_Folder>\log.txt

• Acumatica Framework Configuration Wizard: <Framework_Installation_Folder>\log.txt

In particular, if you are performing an upgrade by using the Acumatica ERP Configuration Wizard, thelog contains all errors that have occurred during the upgrade, including all failed SQL statements.


: If a log file becomes too large, you can create a backup and delete the file.

Maintenance Logs

In the maintenance logs, you can find details for issues that occur when you perform an upgrade in theAcumatica ERP application. The maintenance logs are stored in the following locations:

• The UPErrors database table: This table contains all errors that occur during an update of thedatabase performed in the Acumatica ERP application. The table is displayed on the UpdateHistory tab of the Apply Updates (SM.20.35.10) form.

• The maintenance log file (<Site_Folder>\App_Data\maintlog.txt): This file contains all errorsthat occur during a site upgrade performed in the Acumatica ERP application. In addition, the filecontains all failed SQL statements. You can view this file in Acumatica ERP by clicking Show LogFile on the Update History tab of the Apply Updates form.

Acumatica ERP Logs

Other logs that may be useful are stored in the following database tables:

• LoginTrace: All login, logout, form opening, session expiration, and customization publishingevents

• UPSnapshotHistory: All snapshot restore operations

• UPHistory: All application updates

• AUScheduleHistory: All schedule execution events

• AuditHistory: All field changes (if auditing is enabled)

• EMailSyncLog: All exchange synchronization operations

• AUNotificationHistory: All notification operations

Windows Logs

You may need to check the Windows logs if any of the following is occurring:

• Your application restarts frequently.

• There are unhandled exceptions in the application.

• The system shows the Session has expired message too often.

ASP.NET Core records various exceptions and maintenance operations to these logs. The two Windowslogs you need to check are the Application and System logs. To do this, open Windows Event Viewerand, in the navigation pane, select:

• Windows Logs > Application for the Application log.

• Windows Logs > System for the System log.

We recommend that you search the logs for the following events:

• .NET Runtime events

• ASP.NET events

• IIS events

• Network events


IIS Logs

Records of all requests are stored in the IIS (Internet Information Services) log files. To find the logfiles for your site, open IIS Manager, navigate to the site, and double-click Logging. On the Loggingfeature page that opens, in the Directory box, you can find the path to the folder with the log files.

SQL Server Logs

In Microsoft SQL Server, storage of system logs is enabled by default. These logs contain informationabout database accessibility and server maintenance operations. To view the logs, open ObjectExplorer in Microsoft SQL Server Management Studio and navigate to <Your_Server> >Management > SQL Server Logs.

Using ProfilersTo monitor the state of your Acumatica ERP server at any given moment, you can use the followingprofilers and related tools, each of which is described in a section in this topic:

• Acumatica ERP request profiler: A tool for monitoring the performance of requests in AcumaticaERP

• Acumatica ERP SQL profiler: A tool for monitoring the performance of SQL queries

• Acumatica ERP running processes: A form for monitoring batch processing operations

• SQL Server profiler: A tool for tracing SQL queries

• Browser profilers: Tools for monitoring requests, catching JavaScript errors, and obtainingnetwork timing data

• Stack trace snapshot: A method for investigating website-related issues

Acumatica ERP Request Profiler

On the Request Profiler (SM.20.50.70) form, you can monitor the performance of Acumatica ERP andfind out which requests are taking too much time. By using the filters on the form, you can identify theperiods of slow performance and isolate its root cause. For details, see the Request Profiler topic.

: For a simple operation (such as opening a screen, adding a new record, or deleting a record), thestandard duration of the execution of the request on the server (server time) is about 500 milliseconds.

You can also monitor exceptions by using this form. To activate this functionality, select the LogTrace Messages check box (for documented exceptions) and the Log Exceptions check box (forundocumented exceptions). To view exceptions that occurred during the execution of a request, selectthe request in the table and click Trace on the table toolbar.

Acumatica ERP SQL Profiler

You can analyze SQL queries by using the built-in SQL profiler of Acumatica ERP. To activate the SQLprofiler, select the Log SQL Requests check box on the Request Profiler (SM.20.50.70) form. To viewthe SQL profiler log, click SQL on the table toolbar of the same form. For details, see the RequestProfiler form reference topic.

: We recommend that you activate the Log SQL Requests mode for only a limited period because it candegrade system performance.

Acumatica ERP Running Processes

On the Running Processes (SM.20.15.30) form, you can monitor all batch processing operations thatare currently being performed in the system, such as the release of multiple transactions at once,preparation of dunning letters, generation of a report, creation of a company snapshot, or use of an


import or export scenario. Your server may be slow because of a large number of such operationsrunning simultaneously.

SQL Server Profiler

Microsoft SQL Server Profiler is a tool for tracing SQL queries. To find problematic queries more easily,you can select only particular events to be traced and use various filters.

Sometimes it may be helpful to identify the actual SQL query by using the profiler and then execute thequery in Microsoft SQL Server Management Studio to investigate the problem.

Browser Profilers

Most modern browsers offer debugging tools, which you can use to monitor requests, catch JavaScripterrors, and obtain network timing data. Combined with the Acumatica ERP Request Profiler, these toolscan help you analyze the network latency.

Stack Trace Snapshot

If your site is unresponsive and you are unable to establish the reason, you can create a dump of thestack trace of the running process. To do this, right-click the IIS worker process (w3wp.exe) in WindowsTask Manager and select Create Dump File. You can then open the dump file in Visual Studio andanalyze all threads and their stack traces.

Using Built-In Debugging ToolsThe following built-in debugging tools, described in the sections of this topic, may help you get moreinformation from Acumatica ERP:

• Automation debugging: A mechanism for debugging automation steps and definitions

• ShowError URL parameter: A parameter for viewing the details of errors in Acumatica ERP withoutdirect access to the file system of the server

Automation Debugging

If you encounter a problem with automation steps or definitions that you have configured in AcumaticaERP, you can use automation debugging. You can activate it by adding the following line in theappSettings section of the web.config file (which is located in the folder that contains the applicationinstance website).

<add key="AutomationDebug" value="true" />

After you have activated automation debugging, you can view the information about the currentautomation step in the form title bar on any form in Acumatica ERP.

ShowError URL Parameter

If Acumatica ERP displays a generic error message (for example, We're sorry! An error has occurredwhile processing your request. A report has been generated for our technical staff to investigate theproblem. Please try to repeat your request later. Thank you for understanding.) and you do not havedirect access to the file system of the Acumatica ERP server (as in the case of public hosting), youcan use the special URL parameter ShowError=true. As a result, the system will display the specificmessage for the error that has occurred instead of the generic message.

The full URL with the parameter looks as follows: http://<website_address>/main.aspx?showerror=true, where <website_address> is replaced with the address of your site.


Using Third-Party ToolsThis topic describes the following third-party tools, which may be useful for troubleshooting:

• JetBrains dotTrace: A tool for analyzing the application performance

• .NET Memory Profiler: A tool for analyzing an application's memory usage

• WinDbg: A powerful tool for analyzing process dump files

JetBrains dotTrace

JetBrains dotTrace is a tool for analyzing the performance of your application. In particular, by using thistool, you can view the average running time for the methods in your application.

.NET Memory Profiler

.NET Memory Profiler is another tool for monitoring and analyzing issues on your server. By using thistool, you can take snapshots of the Acumatica ERP memory and isolate memory leaks.

WinDbg

WinDbg is a powerful tool that can open and analyze process dump files.

To use WinDbg, you first need to obtain two .dll files from the .NET Framework version installed on themachine where the dump file was created. You then load these files into WinDbg by using the .loadcommand, and use the .symfix system command to set the symbol storing path, as shown below.

.load c:\sos\sos.dll

.load c:\sos\mscordacwks.dll

.symfix

You can then analyze all objects in the memory by using the following commands:

• !dumpheap -stat (summary for objects of all types)

• !dumpheap -type System.Data.SqlClient.SqlConnection (objects of a specific type)

• !do 000007feeeca24a0 (object at a specific address)

By exploring the memory this way, you can obtain the value of each object instance in the currentprocess, which may help you find the reason why the application is not working correctly.

To Optimize Memory Consumption During StartupOn initialization of the domain, the system compiles every page from the site map and stores the pagesin the web server cache. This gives users the ability to quickly open any page without having to wait forit to compile when the page is opened for the first time. The downside of compiling every page duringstartup is the significant increase in memory consumption for a short period after the initialization.

To avoid this increase in memory consumption, you can disable the compilation of all pages duringstartup.

To Optimize Memory Consumption During Startup

1. Open the web.config file for the instance. Usually it can be located in %Program Files%\Acumatica ERP\<instance name>, where <instance name> is the name of the applicationinstance website.


2. Set the CompilePages setting to False in the appSettings section of the web.config file, asfollows.

<appSettings> ... <add key="CompilePages" value="False"/> ...</appSettings>

With the CompilePages flag set to False, a page will be compiled on the first request by a user.Hence, the page will be opened slowly the first time. However, after the first request, the pagewill be opened as quickly as it is when CompilePages is set to True.


| Uninstalling Acumatica ERP | 95

Uninstalling Acumatica ERP

To uninstall an Acumatica ERP application instance, you perform the following steps:

1. Delete application instances on the server by using the Acumatica ERP Configuration Wizard. Fordetails, see To Delete an Acumatica ERP Application Instance.

2. Uninstall the Acumatica ERP Tools on a server computer by using the standard Windowsprocedure. The relevant registry data is cleaned, and the program group item is removed.

The above procedure does not affect the following entities:

• Databases created by the application: If you need to delete a database, do so manually by usingSQL Server tools.

• Directories on the file system used by the application: If needed, manually delete the emptydirectories on the file system and the program group items.

To Delete an Acumatica ERP Application InstanceWhen you delete an instance by using the Application Maintenance page, you delete applicationscreated under the default site in Internet Information Services (IIS) when installing Acumatica ERP.

To Delete an Acumatica ERP Application Instance




a. In the Installed Sites list, click the Acumatica ERP instance that you want to delete.

b. Click Delete.

c. When you're prompted, click OK.

The Acumatica ERP instance files are deleted from the file system, and the virtual directory of theinstance is removed from IIS configuration. The database of the instance remains untouched when youdelete the instance; if you want to delete the database, you must do so manually.


• Mixed: Some parameters are passed to ac.exe through the configuration file, while otherparameters are passed from the command line. In this mode, command-line parameters have apriority over those specified in the configuration file.

Possible Parameters and ValuesThe following table lists all available command-line parameters and values and a brief description ofeach parameter.

Parameter Values Description

-file

or

-f

path toconfiguration file

Specifies the directory where the XML configuration file isstored. By default, the file is stored in C:\Program Files(x86)\Acumatica ERP\Data\.

Example: -file:"C:\Program Files (x86)\ProgramFolder\Data\"

-configmode

or

-cm

NewInstance

DBMaint

DBConection

CompanyConfig

ToolsInstall

NewCompanyPortal

DeleteSite

RenameSite

UpgradeSite

(Mandatory) Specifies the maintenance scenario for whichyou are using the command-line tool. The possible values andapplicable scenarios follow:

• NewInstance: Installs a new application instance. Youcan also use the following command-line parameters inthis scenario:

-company

-dbname

-dbnew

-dbnewuser

-dbpass

-dbsrvname

-dbsrvpass

-dbsrvuser

-dbsrvwinauth

-dbupdate

-dbuser

-dbwinauth

-iname

-ipath

-sactions

-spass

-split

-spool

-suser

-svirtdir

-swebsite



• DBMaint: Creates a new database or updates anexisting database with a current version of the databaseschema. You can also use the following command-lineparameters in this scenario:

-company

-dbname

-dbnew

-dbsrvname

-dbsrvpass

-dbsrvuser

-dbsrvwinauth

-dbupdate

-split

• DBConection: Modifies database connection settings.You can also use the following command-lineparameters in this scenario:

-company

-dbname

-dbnew

-dbnewuser

-dbpass

-dbsrvname

-dbsrvpass

-dbsrvuser

-dbsrvwinauth

-dbupdate

-dbuser

-dbwinauth

-split

• CompanyConfig: Adds new companies or deletesexisting ones. You can also use the following command-line parameters in this scenario:

-company

-dbname

-dbnew

-dbsrvname

-dbsrvpass

-dbsrvuser

-dbsrvwinauth

-dbupdate



-split

• ToolsInstall: Installs Acumatica ERP controls andtemplates for Microsoft Visual Studio; this optionis available in the Acumatica ERP ConfigurationWizard. You can also use the following command-lineparameters in this scenario:

-vscontrols

-vstemplates

• NewCompanyPortal: Installs a new company portal; thisoption is available in the Acumatica ERP ConfigurationWizard. You can also use the following command-lineparameters in this scenario:

-dbname

-dbnew

-dbnewuser

-dbpass

-dbsrvname

-dbsrvpass

-dbsrvuser

-dbsrvwinauth

-dbupdate

-dbuser

-dbwinauth

-iname

-ipath

-sactions

-spass

-spool

-suser

-svirtdir

-swebsite

-wscompany

-wsuser

-wswiki

• DeleteSite: Deletes an existing Acumatica ERP instance.You can also use the -iname parameter in this scenario.

• RenameSite: Renames an existing Acumatica ERPinstance. You can also use the following command-lineparameters in this scenario:

-iname



-ioldname

• UpgradeSite: Upgrades the files of an existingAcumatica ERP instance. You can also use the -inamecommand-line parameter in this scenario.

Example: -configmode:"NewInstance"

-dbsrvname

or

-s

server name Specifies the name of the SQL server that will be accessedby this application instance of Acumatica ERP. The defaultsetting is (local).

Example: -dbsrvname:"(local)"

-dbsrvwinauth

or

-sw

True

False

Specifies whether Windows or SQL Server authenticationwill be used by the configuration tools to access SQL Server.Select one of the following values:

• True: Uses Windows authentication. This is the defaultvalue.

• False: Uses SQL Server authentication.

Example: -dbsrvwinauth:"True"

-dbsrvuser

or

-u

user name Specifies the user name of the account used to access SQLServer. You must add this parameter if the SQL Serverauthentication method is used (and the dbsrvwinauthparameter value is set to False).

Example: -dbsrvuser:"SQLAdmin"

-dbsrvpass

or

-p

user password Specifies the user password for the account used toaccess SQL Server. You must specify this parameter ifthe SQL Server authentication method is used (and thedbsrvwinauth parameter value is set to False).

Example: -dbsrvpass:"<user_password>"

-dbname

or

-d

database name Required. Specifies the name of the database maintained bythis application instance of Acumatica ERP.

Example: -dbname:"HSBC_DB"

-dbnew

or

-n

True

False

Specifies whether you want to create a new database in SQLServer. The default setting is True.

Example: -dbnew:"False"

-dbupdate

or

-b

True

False

Specifies whether you want to update an earlier versionof the database with a newer one. You can also use thisparameter to repair an existing database of the currentversion. The default setting is True.

Example: -dbupdate:"False"

-dbmode

or

Regular

Template

Specifies the database creation mode. This parameter is validfor Acumatica Framework only. Select one of the followingpossible values:



-dm Demo • Regular: Creates a regular Acumatica Frameworkapplication.

• Template: Creates a template for an AcumaticaFramework training application.

• Demo: Creates an Acumatica Framework trainingapplication.

Example: -dbmode:"Demo"

-dbsize

or

-dz

1

5

10

20

30

40

50

Specifies the maximum size of the database on Azure SQLand therefore is used only for Acumatica ERP deployed onWindows Azure. The available values correspond to thestandard database size values in GB. The default setting is 1.

Example: -dbsize:"50"

-dbskip

or

-ds

True

False

Specifies whether the database setup steps are skipped. Ifthey are, the database will be set up by the Acumatica ERPinstance in run time. The default setting is False.

Example: -dbskip:"False"

-dbshrink

or

-dc

True

False

Specifies whether you want the utility to shrink the databaseonce it has been configured. This parameter is used onlyfor Acumatica ERP deployed on Windows Azure. The defaultsetting is False.

Example: -dbshrink:"True"

-iname

or

-i

instance name Required. Specifies the name of the Acumatica ERP instance.

Example: -iname:"HSBC Main ERP"

-ioldname

or

-io

old instance name Specifies the current name of an Acumatica ERP instancewhen you rename this instance.

Example: -ioldname:"HSBC_HQ"

-ipath

or

-h

instance directory Required. Specifies the directory where the applicationinstance files will be stored. The default setting is C:\Program Files\Acumatica ERP\.

Example: -ipath:"C:\Program Folder\"

-vmsize

or

-is

Small

Medium

Large

ExtraLarge

Specifies the relative size of the Windows Azure virtualmachine. This parameter is used only for Acumatica ERPdeployed on Windows Azure. The default setting is Small.

Example: -vmsize:"ExtraLarge"



-thumbprint

or

-it

X.509 thumbprint Specifies the thumbprint of the maintenance certificateuploaded to the hosted service on Windows Azure. For moreinformation on finding the thumbprint, see Deploying theAcumatica ERP Service on Windows Azure.

-project

or

-ip

Visual Studioproject name

Specifies the name of the Visual Studio project. Thisparameter is used in Acumatica Framework only.

Example: -project:"<project_name>"

-swebsite

or

-w

website name Specifies the name of the existing Internet InformationServices (IIS) website on the local computer.

-svirtdir

or

-v

virtual directory Specifies the name of the IIS virtual directory. If there is nosuch virtual directory in IIS, this directory will be created onthe local IIS.

Example: -svirtdir:"<virtual_directory_name>"

-spool

or

-po

application pool Specifies the name of the IIS application pool. If there is nosuch application pool in IIS, this pool will be created on thelocal IIS.

Example: -spool:"<application_pool_name>"

-sactions

or

-a

AnonymousUser

SelectedUser

Specifies the user account used to run the ASP.NETapplication. The possible values are the following:

• AnonymousUser: Uses the default IIS account to runthe ASP.NET application pool.

• SelectedUser: Uses a specific Windows user accountwith sufficient access rights to run the ASP.NETapplication. In this case, you must also specify the -suser and -spass parameters.

Example: -sactions:"SelectedUser"

-suser

or

-k

user name Specifies the user name of the account used to access anASP.NET application. This parameter must be added if youhave specified the SelectedUser value for the -sactionsparameter.

Example:-suser:"<user_name>"

-spass

or

-m

user password Specifies the user password of the account used to accessan ASP.NET application. This parameter must be added ifyou have specified the SelectedUser value for the -sactionsparameter.

Example: -spass:"<user_password>"

-dbwinauth

or

-dw

True

False

Specifies whether Windows or SQL Server authentication willbe used by this Acumatica ERP instance to access SQL Server.These are the possible values:



• True: Uses Windows authentication. (This is the defaultvalue.)

• False: Uses SQL Server authentication.

Example: -dbwinauth:"True"

-dbnewuser

or

-dn

True

False

Specifies whether a new SQL Server account must becreated. The default setting is True.

Example: -dbnewuser:"True"

-dbuser

or

-du

user name Specifies the name of the user account used by thisAcumatica ERP instance to access SQL Server. You must addthis parameter if the SQL Server authentication method isused (and the dbwinauth parameter value is set to False).

Example: -dbuser:"SQLAdmin"

-dbpass

or

-dp

user password Specifies the password of the user account used by thisAcumatica ERP instance to access SQL Server. You must addthis parameter if the SQL Server authentication method isused (and the dbwinauth parameter value is set to False).

Example: -dbpass:"SQLAdmin"

-wscompany

or

-wc

company ID Specifies the ID of the company that will be used for thecompany portal. This parameter is used only in the CompanyPortal configuration mode.

Example: -wscompany:"<company_ID>"

-wsuser

or

-wu

user name Specifies the user account that will be used for the companyportal. This parameter is used only in the Company Portalconfiguration mode.

Example: -wsuser:"<company_ID>"

-wswiki

or

-ww

portal Wiki Specifies the Wiki article that will be used for the companyportal. This parameter is used only in the Company Portalconfiguration mode.

Example: -wswiki:"<company_ID>"

-securemode

or

-cs

True

False

Specifies whether the company ID is displayed on the logonscreen. The default setting is False. Select one of thesepossible values:

• True: Hides the company ID.

• False: Displays the company ID.

Example: -securemode:"False"

-split

or

-sp

table split options Specifies split options for a table stored in an existingdatabase. If you want to configure more than one table, youneed to specify this parameter for each of the tables. Thisparameter contains two subparameters: Table (short form: t)and Option (short form: o).



For the Table subparameter, you specify the name of thedatabase table.

For the Option subparameter, you specify one of the threevalues that indicate the available split modes:

• Separate

• Split

• Shared

Example: -Split:"Table=AccountClass;Option=Shared; " -Split:"Table=AccessInfo;Option=Split; "-Split:"Table=APContact;Option=Separate;"

-company

or

-c

company options Specifies company options. If you want to configure optionsfor more one company, specify this parameter for eachof the companies. This parameter contains the followingsubparameters:

• CompanyID: Specifies the company ID. To modify thesettings of an existing company, specify its ID here.

• ParentID: Specifies the ID of the company's parentcompany.

• Visible: Allows users to sign in to the company if youspecify the True value.

• CompanyType: Inserts demo data into the company'sdatabase if you specify the True value.

• LoginName: Displays the company name on theAcumatica ERP logon screen.

• Delete: Deletes the company if you specify the Truevalue.

Example: -company:"CompanyID=KC; ParentID=1;Visible=True; CompanyType=True;LoginName=Company; Delete=True"

-vstemplates

or

-vst

True

False

Specifies whether Acumatica Framework Templates forMicrosoft Visual Studio must be installed. This parameteris used with Acumatica Framework only. To install thetemplates, add this parameter and specify the True value.

Example: -vstemplates:"True"

-vscontrols

or

-vsc

True

False

Specifies whether Acumatica Framework Controls forMicrosoft Visual Studio must be installed. This parameter isused with Acumatica Framework only. To install the controls,add this parameter and specify the True value.

Example: -vscontrols:"True"

-output

or

Normal

Quiet

Specifies the command-line execution mode. Select one ofthe following possible values:



-op Forced • Normal: The command line acts as a dialog. Whenyou run the ac.exe utility, you will answer questionsrelated to the parameters.

• Quiet: All warnings are ignored. Any error forces theac.exe utility to stop and exit.

• Forced: All warnings are ignored. If you do not specifyany mandatory parameters, they are automaticallyconfigured with default values. Minor errors areignored, while critical errors force the ac.exe utility tostop and exit.

Example: -output:"Forced"

-dbcollation

or

-dl

Microsoft SQLServer collationname

Specifies a collation that will be used for a database that iscreated during Acumatica ERP instance deployment instead ofthe default SQL_Latin1_General_CP1_CI_AS collation.

Example: -dbcollation:French_CI_AI

-dboptimize

or

-do

True

False

Specifies whether the Optimize Tables command shouldbe applied to MySQL database tables during deploymentof an Acumatica ERP instance. The default value of thisparameter is False because the process of table optimizationmay take a lot of time. To apply the Optimize Tablescommand, add this parameter and specify the True value.

Example: -dboptimize:"True"

: For all command-line parameters that have the False and True values, you can also use No instead ofFalse and Yes instead of True.

To Create a Configuration FileYou can create a configuration file for the unattended deployment and maintenance of applicationinstances. You can create this configuration file manually or create it automatically by running theAcumatica ERP Configuration Wizard.

To Create the Configuration File by Using the Acumatica ERP Configuration Wizard


2. Use the wizard to specify all the options that you want.

3. On the final page of the wizard, click Save Configuration to save the configuration file.


Figure: Saving configuration parameters to a file

The configuration data is saved in this file in XML format and as a command-line command using boththe short and full forms of the parameters.

Examples of the Configuration StringIn this topic, you can find examples of the configuration string.

The following command-line command creates an application instance.

ac.exe -configmode:"NewInstance" -dbsrvname:"GP" -dbname:"JPMorgan" -company:"CompanyID=1;CompanyType=;LoginName=;" -company:"CompanyID=2;CompanyType=;ParentID=1;Visible=Yes; LoginName=JPMorgan;" -iname:"JP Morgan" -ipath:"C:\Program Files\Program Folder\JP Morgan\\" -swebsite:"Default Web Site" -svirtdir:"JPMorgan" -spool:"JPMorgan" -sactions:"SelectedUser" -suser:"GP\Administrator"

The following command also creates an application instance and uses the short forms of the command-line parameters.

ac.exe -cm:"NewInstance" -s:"SM" -d:"InstanceDB" -c:"ci=1;" -c:"ci=2;cp=1;ct=Demo;cv=True;cn=Company;" -i:"Instance" -h:"C:\Program Files (x86)\Program Folder\Instance" -w:"Default Web Site" -v:"Instance" -po:"Classic .NET AppPool" -a:"AnonymousUser"

The following command-line command updates an existing database.

ac.exe -configmode:"DBMaint" -dbsrvname:"SM" -dbnew:"False" -dbname:"DotNet4" -dbupdate:"True"

The following command updates an existing application instance.

ac.exe -cm:"UpgradeSite" -i:"Instance"

| contents |acumatica-builds.s3.amazonaws.com/builds/6.10/pdf/acumaticaerp... · | acumatica erp...

Documents