Automation Service and Console

The Deacom Automation Service and Console (Deacom.WebServer.Console.exe) are used by the Deacom application to communicate with external devices, third party applications, and the Deacom Warehouse Management System. The following applications and equipment currently use the Deacom Automation Service and Console.

  • WMS Application (Scanners)
  • AutoFinisher
  • Currency Update
  • Triggers

The Automation Console application is used for workstations when the service is not available, such as when working in a test system that does not have a service running. Using the Console requires that the user knows the IP address of the workstation they are on. The difference between the service and the console is the console must be run manually anytime the server hosting the main Deacom application is restarted. This is unlike the service, which can be set to run automatically any time the server is restarted. We recommends using the Automation Service in all cases. The Automation Service and Console may not both be running at the same time on the same computer.

Networking requirements and setup

Before installing or un-installing the Automation Service, note the Deacom INI file settings for the following:

  • SVCADDR - Indicates the IP address of the server running the Deacom application and Deacom automation console which is used for the Warehouse Management System module and when using the Triggers feature in Deacom.
  • SVCPORT - Defines the port number for the Deacom automation console. This should never change and would be different for each instance of Deacom. (Example, Production 91 vs Test 92)

Note: If using the console, the SVCADDR is the IP address of the computer starting the console.

Installing and un-installing the Automation Service

Installing Automation Services

Multiple Deacom Automation Services can run on the same server at the same time if they are using different ports. The Automation Service uses whatever port is specified in the Deacom.ini file. So, that should be set to a different port before starting one of the services or setting up a new test environment.

  1. Ensure the deacom.ini "SVCPORT" value in the system you are installing the service for is not already in use by another DEACOM instance.
  2. Run Command Prompt as an Administrator.
  3. Use the sc tool to install the service.
    1. Type the following, including the quotes:  sc create "Deacom.Automation.Service.InstanceName" binpath= "C:\DEACOM\FolderName\deacom.automation.service.exe -allowmulti" start=auto depend= nlasvc/pla  
    2. Replace InstanceName with the Deacom folder name (e.g. Production, Test)
    3. Replace FolderName with the Deacom folder name (e.g. Production, Test) Example:  sc create "Deacom.Automation.Service.Test" binpath= "C:\DEACOM\Test\deacom.automation.service.exe -allowmulti" start=auto depend= nlasvc/pla
  4. The Command Prompt will respond with "[SC] CreateService SUCCESS"
  5. Locate the Service and set configurations
    1. Click "Start" menu and search for "Services"
    2. Run the Services program.
    3. Locate the Deacom Automation Service for the instance you just installed against, right click, and select "Properties".
    4. On the General tab, confirm "Startup Type" is set to "Automatic"
    5. Click "Apply" if any changes are made.
    6. On the Log On tab, confirm the DeacomERP user account is hosting the service.
    7. Click "Apply" if any changes are made.
    8. On the Recovery tab, confirm First, Second, and Subsequent Failures options are set to "Restart Service".
    9. Click "Apply" if any changes are made.
    10. Click "OK" to close properties form.
  6. Stop and restart the service.
    1. In the Services window, right click the Web Services and click "Stop".
    2. Right click the Web Services again and click "Start".
  7. Test your WMS clients by connecting a scanner to the host.

Notes:

  • The Automation Service must be stopped prior to performing an update, otherwise it may not update. Once the update is complete, the service may be restarted.
  • Deacom updates will automatically update the Automation Service.
  • When using the Automation Service, it is important to make sure that the service build version matches the version of the main application running. To check the build version of the service, right click on the Deacom.Automation.Service.exe icon in the Deacom application folder and select Properties. Navigate to the Details tab and note the File version listed. This version number should be the same as the main application version number (Deacom.Webserver.Service.exe). If the versions do not match, try re-running the last update.
  • When installed and configured correctly, the service will automatically start when the server is restarted. Therefore, it should not require manual starting or stopping except when running a DEACOM update.

Installing the Automation Service when the Production folder is not local to the server

Before trying to install this type of setup, become familiar with the basic installation instructions above to gain a general understanding of the process prior to executing the steps below. 

  1. Locate the folder that houses the .NET services.
    1. Open the File Explorer.
    2. Navigate to C:\Windows\Microsoft.NET\Framework64\v4.xxxxxx, where "v4.xxxxxx" is the .NET version number.
    3. Click in the file path to highlight it, then copy it.
  2. Open a command prompt as administrator on the server.
    • Click "Start" on the computer, type "CMD", right click the Command Prompt result, and select Run as administrator.
  3. Use the mklink comand to create a linked drive.
    1. Type the following: cd\ and Hit Enter on the keyboard to execute the command.
      • “cd\” takes the user to the root of the server’s C drive.
    2. Type mklink /D \WMS \\Server\ShareName\Production and hit Enter on the keyboard to execute the command.
      • "/D" creates a symbolic link from the root directory to the specified file path.  
      • "\WMS" is a folder that will be created on the root of the C drive, pointing to the directory that is being linked.
      • "Server" and "ShareName" are replaced with the proper names based on server and application configuration. ShareName is usually Deacom.
  4. Use the cd tool to change the directory.
    1. Type the following: cd <file path> (the file path, pasted from step 1.3)
    2. Example: cd C:\Windows\Microsoft.NET\Framework64\v4.0.30319
    3. Hit Enter on the keyboard to execute the command.
    4. If successful, the command prompt will display the same file path with ">" appended.
  5. Continue using Step 3 in section 2.1 above.

Un-installing the Automation Service

The process for uninstalling the DEACOM Web Service is as follows:

  1. Locate and stop the service.
    1. Click "Start" on the computer, and open the Control Panel.
    2. Select Administrative Tools, then Services.
    3. Locate the Automation Service, right click, and select "Stop".
    4. Right click and select Properties, Control C to copy the Service Name and click OK.
  2. Open a command prompt as administrator.
    • Click "Start" on the computer, type "CMD", right click the Command Prompt result, and select Run as administrator.
  3. Use the sc tool to delete the service.
    1. Type the following: sc delete "Control V to paste in the servicename copied above"  (Example sc delete "automationservice.test" 
  4. Confirm the service is deleted.
    • In the Services window, refresh the list, and verify the service is no longer listed.

Running the Automation Console

There is no installation required to run the Automation Console. The only possible necessary setup is to ensure the Automation Service is not running. Once confirmed, use the below steps to run the console:

  1. Determine the IP address of the workstation.
    1. Click "Start" on the computer, type "CMD", and open the Command Prompt.
    2. Type ipconfig then hit Enter on the keyboard to execute the command.
    3. Locate the IPv4 address, which is the IP address of the local computer.
  2. Modify the SVCADDR of the INI file to match the local computer's IP address.
    1. Open the File Explorer.
    2. Navigate to the Deacom application folder.
    3. Locate the Deacom.ini file and double click to open.
    4. On the SVCADDR line, replace the current IP address listed with that of the local computer from step 1.3
    5. Save the change then close the ini file.
  3. Locate and run the Automation Console executable.
    1. In the File Explorer, navigate to the file path of the Deacom application.
    2. Locate the Deacom.Automation.Console.exe file and double click it to open.
    3. The Deacom Automation Console window will open and multiple lines including ones listing the version that is being operated, the port on which the server is listening, and that the console is "Waiting for input from client".
    4. Minimize the Deacom Automation Console window or leave it open in the background to begin working.
    5. Once finished using the console, the Deacom Automation Console window may be closed.

FAQ and Diagnostic Tips

What does it mean if I receive one of the following errors in the Automation Service service log?

  • Can't find the user - This error occurs when attempting to log in with a bad user name, or more often, when a user does not have, or is passing in, an invalid user token (because they were logged out).
  • Trying to access a closed connection - This error occurs when a WMS scanner goes to sleep and drops its network connection.
  • Trying to access the SQL Server connection - This error occurs when the SQL server connection was reset and the connection the application had is no longer valid.

What if the service won't start?

Check the account used when installing the services. If security was changed, you must use the new account.

When would I need to un-install and re-install?

Cases where services crash, stop, and/or cease to function for various reasons. These could possibly include Windows updates or web version updates.

How do I delete a mklink drive?

From an administrator command prompt type: rmdir wms  (if created using the example above)

What should I check if the service does not run?

Make sure the automation services matches the version of Deacom.  If the versions do not match, rerun the update.   Make sure the services are shut down before upgrading.  To find the automation service version, go to the Deacom.Automation.Service.exe program in the appropriate folder, right click, click on properties, and click on details.  Do the same for the Deacom.WebServer.Console.exe program.

What is the minimum security that I need for the Automation Services Service User Account?

The minimum security requirements for the Automation Services is to have Local Admin rights. However, if you utilize network printers, you’d need domain Admin rights in order to print from those. In most cases, users make use of network printing and thus need to have both local and domain admin rights on the service account user tied to the Automation Services.