Deploying custom DLL files using App Manager
Who is this article for?
IT personnel managing custom files.
IT administrator permissions are required.
Aura allows for inclusion of custom and additional DLL files which App Manager will deploy to the correct locations within the application when available in a precisely defined folder structure.
Understanding custom file categories
Custom DLL files fall into the following categories:
| Category | Description |
|---|---|
| Custom business rules | The most common category. These files are typically named Pentana.Tng.BusinessRules.[customer name].dll |
| Additional client files (unrelated to the application) | Files that will be delivered to a subfolder of the client, but which are not part of the application. Retain was delivered using this mechanism. |
| Additional application files (controls) | Custom versions of application files are delivered using this method, e.g. Pentana.Tng.UI.Smart.[customer name].dll |
| Custom Robot jobs | Additional Robot jobs, normally relating to notifications, typically called Pentana.Tng.ServerRobot.Jobs.[customer name].dll |
Configuring App Manager to deliver custom files
To configure App Manager to deliver custom files:
- Create a new folder called CustomerFiles on the app server. Normally this is included under the software folder containing the install set.
- In the CustomerFiles folder, create a new folder that matches the version of the application that's installed.
| Version | Path + new folder |
|---|---|
| v5.3.x | CustomerFiles\v5.3.0.0 |
| v5.4.x | CustomerFiles\v5.4.0.0 |
| v6.0.0.x | CustomerFiles\v6.0.0.0 |
| V6.0.1.x | CustomerFiles\v6.0.1.0 |
- In the new folder, create a subfolder that matches the category of custom DLL.
| Category | Subfolder |
|---|---|
| Custom business rules | BusinessRules |
| Additional client files (unrelated to the application) | Client |
| Additional application files (controls) | Controls |
| Custom Robot jobs | ServerRobot\Jobs |
Examples:
| Scenario | Path |
|---|---|
| A folder for a new custom business rule, for v6.0.1.8 | CustomerFiles\v6.0.1.0\BusinessRules |
| A folder for the Retain client, for v5.4 | CustomerFiles\v5.4.0.0\Client\RetainClientPRD |
- Copy the custom file to the new subfolder.
Deploying via App Manager
To deploy custom files via App Manager:
- In App Manager, set the Customer Files path in the Setup tab.
- Click Save.
- From now on, when you install or upgrade in the Config tab, the custom file will be included.
Upgrading with custom files
If App Manager tries to upgrade to a version where the custom file is missing, you will see an error like "a single plugin was not located at the specified path".
Important: Attempting an upgrade with a missing DLL will cause inconsistency in the database, and you will have no option but to restore the latest backup. This is why we always recommend taking and validating a backup before running an upgrade or customisation.
To successfully upgrade from one version to another, ensure that the correct versions are present in \CustomerFiles.
To prepare custom files for an upgrade:
- Copy the existing version folder and rename the copy to match the target version. For example, if upgrading from v5.3 to v5.4, copy the v5.3.0.0 folder and rename the copy to v5.4.0.0.
You will need a folder for each version that is upgraded to. For example, if upgrading directly from v5.3 to v6.0.1.8:
Managing version-specific DLLs
DLLs may be version-specific:
- If upgrading a custom DLL for v6.0.0.x then you will need a v6.0.0.x-specific DLL version
- If upgrading a custom DLL for v6.0.1.4 then you will need a v6.0.1.4-specific DLL version
- If upgrading a custom DLL for v6.0.1.11 then you will need a v6.0.1.11-specific DLL version
These can be obtained from Ideagen Support.