Quick list for setting up a new Aptify Application Server or adding new Service to existing server

Overall, you need to follow the steps detailed in Installing Application Servers. If you're looking to install Aptify just so you have an environment (Desktop, Web, or e-Business) to play around with, it might be easier to download the Community Virtual Machine rather than go through the install process. If interested in trying it out, please contact Aptify Support.

But for a quick checklist, if you're setting up a new Application Server, make sure to follow these steps/verify these items are done. This guide can also be used to setup additional Async services on an existing Application Server. If you're looking to install Aptify Web, e-Business 6, or other items, refer to links in the parent guide: Quick List for Setting up and Troubleshooting Aptify Infrastructure 

This process should work with both the stock Aptify Application Server as well as the Consulting-built Async Processor X.


Make sure your environment has the following items installed:

  1. .NET 3.5 framework
  2. .NET 4.5 framework 
  3. Aptify Desktop client. Make sure to connect the Desktop client to the DB server at least once before proceeding.

You must have the Aptify Object Repository Service running for this to work. That is installed alongside the Aptify Desktop client automatically. If you don't have it (e.g., you copied the Aptify 5.0 folder instead of running through the install) it can easily be added per the below instructions.

Creating the AptifyObjectRepositoryService

This is required only if it does not already exist on your system.

  1. Make sure your Desktop client can connect to the DB first.
  2. Then open Command Prompt as an Administrator.
  3. Copy the below test, right click in Command Prompt and click Paste.
    It should create your AptifyObjectRepositoryService for you. Once it's created, go to services.msc and start it.
If your Aptify 5.0 folder is somewhere different than the default C:\Program Files\Aptify 5.0 make sure to change that in the Command Prompt script before executing in the area underlined below.
So create AptifyObjectRepositoryService binPath= "C:\Program Files\Aptify 5.0\Services\Object Repository\AptifyObjectRepositoryService.exe" DisplayName= "Aptify Object Repository Service" start= auto

Aptify Setup

  1. You'll need to setup an Aptify user to run the App Server.
    If you do not have a user already setup for this, you can create a new user or update an existing user to have the proper permissions.
  2. This user needs to have the Administrators and Application Servers security groups applied. Otherwise, it can use an End User license. Tie this user to an Employee record on the final step of the wizard.
  3. Navigate to the Application Servers service under the Process Pipeline application. Create a new record.
  4. Under Name, you can enter whatever you'd like. Under Server Name, enter the Server Name and specific SQL instance if applicable.
    For example, in the below given screenshot, this targets the default instance of the APTIFYDEV server. If I needed to target an instance named SQL2019, I would put APTIFYDEV\SQL2019 as the ServerName.

    If using the Consulting-built Async Processor X, you will have two additional fields.
    1. Select Process Untargeted Runs if you wish this application server to pick up open jobs
    2. Enter your choice for ServiceName. It can be "AptifyAsyncProcessor" by default, or, if setting up backup async processes, something like "AptifyAsyncBackup1." Make a note of what you choose as it'll be used later. (Note, it must be unique per server, e,g, you cannot have two services named AptifyAsyncService on the same server, but you could have an AptifyAsyncService on two separate servers)
  5. On the Account Information tab, enter in the username and password (including domain) of the Aptify User who will be running this Async service. This should either previously have been setup or setup in Instructions 1→4 above.
  6. On the Account Information tab, enter the Account Name and Account Password (including domain) of the Aptify User who will be running this Async service. This should either previously have been setup or setup in Instructions 1→4 as given above.
  7. Make a note of the Application Server ID record that was created.

Config File Settings

This process will setup an Async Service target the typical C:\Program Files\Aptify 5.0 folder. Note, you can also have it target other folders which may be preferred to separate the Async Processor's bin folder from the Aptify 5.0 client folder. To do so, just copy the Aptify 5.0 folder to your preferred location and name the folder as you wish. All the config file changes should happen in that new folder.

This process assumes your Aptify 5.0 folder has the AptifyAsyncProcessor.exe.config file. If not, you'll need to download the attachment named "Async Files.zip" from this page, unzip, and place in your Aptify 5.0 folder. Note, there is both an Async Files STOCK.zip and an Async Files CONSULTING.zip, pick the correct one depending on which version of the Application Server you are using. (These should work for both Aptify 6.0 and Aptify 6.1)

You should then have these files in your Aptify 5.0 bin folder:

  • AptifyAsyncProcessor.exe
  • AptifyAsyncProcessor.exe.config
  • AptifyCreateProcessFlowRun.exe
  • AptifyCreateProcessFlowRun.exe.config
  1. Open the AptifyAsyncProcessor.exe.config file. (Typically at C:\Program Files\Aptify 5.0\ but can be different if you setup a separate folder)
  2. Find the attribute named "Aptify.Framework.LoginServices.AptifyLogin.Server".
  3. Insert your database server in the value, replacing the "Insert Server Name Here" section.
    1. Make sure quotations remain surrounding this and other attributes so your database should be like "APTIFYDEV"
    2. If your database is setup on a different instance than default, make sure to specify the full servername/instance like section 7a under the Aptify setup section.
  4. Find the attribute named "Aptify.Framework.BusinessLogic.ProcessPipeline.AptifyAsyncProcessor.AptifyApplicationPath.
  5. Insert your Aptify 5.0 folder path here in the value, replacing the "Insert Aptify Client Application Path Here" section.
    1. Make sure quotations remain surrounding your DB, like "C:\Program Files\Aptify 5.0")
    2. If you are setting up your Application Server under a different folder, enter it here, e,g, "E:\Apps\AptifyAsync"
  6. Find the attribute named "Aptify.Framework.BusinessLogic.ProcessPipeline.AptifyAsyncProcessor.ApplicationServerID".
  7. Insert your Application Server ID in the value (created in the previous section) replacing the "Insert Application ID Here" section.
  8. Save and close the config file.

Aptify Consulting Async X-processor specific config settings

There are a few other attributes in the AptifyAsyncProcessor.exe.config file for the Consulting-built Async service.

  1. Find the attribute named "Aptify.Framework.BusinessLogic.ProcessPipeline.AptifyAsyncProcessor.ServiceName".
  2. Insert your service name in the value, replacing the "AptifyAsyncProcessor" value if not applicable.
  3. Find the attribute named "Aptify.Framework.BusinessLogic.ProcessPipeline.AptifyAsyncProcessor.ServiceDisplayName".
  4. You can enter whatever you'd like here as the display name of the Windows service, you will re-use this later. Insert your service name in the value, replacing the "Aptify Asynchronous Processor X 1" value if not applicable.
  5. Find the attribute named "Aptify.Framework.BusinessLogic.ProcessPipeline.AptifyAsyncProcessor.GetAttributeValuesFromAptify".
  6. This is set to 0 by default, meaning most values like ApplicationServerID, ProcessUntargettedRuns, etc will be taken from the config file rather than what's in Aptify. This should be left as is, or changed to 1 if you'd prefer to have Aptify manage these config settings.

Windows Service Creation

Once these items have been set up, there's a simple way to create your Aptify Async Windows service.

  1. Run Command Prompt as a Windows Administrator.
  2. Copy and paste this value to somewhere on your local machine, e,g, a new tab of a browser.
    1. sc create AptifyAsyncProcessor binPath= "C:\Program Files\Aptify 5.0\AptifyAsyncProcessor.exe" DisplayName= "Aptify 5.0 Asynchronous Processor" start= auto

    2. When run in Command Prompt, this will generate your Async service. First, verify the values are correct per below.
  3. The construct of this is sc create YourServiceName binPath= "LocationOfYourAptifyAsyncProcessor.exe file" DisplayName= "YourDisplayName" start=auto
  4. Make the following changes to that text, if applicable.
    1. For example, if I want to create an Async Service with a different service name for the Consulting Async Service, my text might be:
      1. sc create AptifyAsyncBackupProcessor binPath= "C:\Program Files\Aptify 5.0\AptifyAsyncProcessor.exe" DisplayName= "Aptify Backup Asynchronous Processor" start= auto
      2. You'd then need to make sure your config file and Aptify Application Server record have the ServiceName of AptifyAsyncBackupProcessor and in the config file, appropriate Display Name
    2. If I wanted to create an Async Service running off a different Aptify 5.0 folder, my text might be:
      1. sc create AptifyAsyncProcessor binPath= "E:\Apps\AptifyAsync\AptifyAsyncProcessor.exe" DisplayName= "Aptify 5.0 Asynchronous Processor" start= auto
  5. Once you have the right text, copy it.
  6. Right-click and paste it into the Administrator Command Prompt, it should quickly say Success. It will have created your Windows Service here:
  7. Now we need to set up the Async Processor to use the right user. Type Services.msc into the Windows Start Menu. Then double click the Aptify 5.0 Asynchronous Processor (or whatever yours is named).
  8. Under the Logon tab, change it from Local System account to This Account and specify the username/password for the Aptify user account that runs the app server. This should be the same values that are on the Application Server Account Information tab.
  9. On the Recovery Tab, you can specify optional actions if the service fails. At the minimum, it's recommended to setup Restart for the First and second failure.
  10. Click Apply and OK.
  11. Right-click the Async Service and click start. (By default, it'll start up with the server in the future) If it starts, great.
  12. If it's having trouble logging into the database or executing certain files, it may immediately stop after starting. Check the Event Viewer on the Application Server for more details as well as the Event Viewer on the database server.
    1. The most common issue is usually the Aptify 5.0 folder running the Async service is out of sync with the Object Repository. Try performing a full object repository sync on the folder and logging in to confirm the Desktop client is functional.
    2. If using the Consulting version, double check the Aptify ApplicationServer ServiceName, the config file service name, and the service name in services.msc to confirm all 3 matches.
    3. If you need to delete your Windows Service to try and setup a different one, in an Administrator Command Prompt you can enter sc delete YourServiceName.
Was this article helpful?
0 out of 0 found this helpful



Please sign in to leave a comment.