Post-Installation Jobs

Overview

Post-installation jobs -- also called post-install jobs -- are process-oriented logicnets that the system runs after you install a published package. Examples of typical post-install jobs include modeled user management functions like creating user groups and setting roles, and setting initial data using database parts. You can also use post-installation jobs to perform data conversion.

Identifying Post-Installation Jobs

You must house post-installation jobs within a direct subfolder of the logicnets folder in the application. This folder is called postinstalljobs, and the system does not create this folder automatically. You add it using the New Folder tool in the Project Explorer toolbar. The system runs logicnets located here after you install the associated published package. 

 

Creating Post-Installation Jobs

A post-installation job is a logicnet containing only processing and pathway nodes. It should not contain form or form-part nodes, because post-installation jobs run without any user interaction.

1. Open the project in which you want to create your post-installation job.
2. Navigate to the logicnets folder in the tree view and create a subfolder called postinstalljobs.
3. In the this folder, create a logicnet for each job. Note: You can add multiple post-installation job logicnets to this folder, but each logicnet should be a separate, invokable job. The logicnet can reach out to logicnets outside of the postinstall subfolder, but the invoked logicnets themselves must be in the postinstalljobs subfolder.
4. Model the postinstalljob logicnet to perform the processing you want it to do. Remember to use only process nodes and system-facing node types.
5. When you have finished creating your logicnet publish the project. You can only install and trigger post-installation jobs from published projects.

Running Post-Installation Jobs

When you install a package using the Package Installer the system searches for any post-installation jobs contained in the package and runs them accordingly. When you upgrade a package installation the system searches for all post-installation jobs in all installed packages and runs them in the order in which the packages were installed. 

There are both simple and advanced ways to start the post-install process, as detailed here:  

Simple Start: All Users

Install your published package using the Package Installer, which provides an installation user interface and is available in all LogicNets installations. Once your package is installed, the system accesses the logicnets you created in the postinstalljobs folder and runs them.

Advanced Start: Developers and Other Technical Users

If you install your packages using the command line or have created an installer for your your packages, you can also use the following methods for starting post-installation jobs:

• run_postinstalljobs.bat: Run this from the cmd line. The system calls the post-installation jobs directly without first installing the packages. It runs all post-install jobs. 
• install_package.bat: Run this from the cmd line. The system first installs all packages and then calls the post-install jobs directly. The primary difference between using this command and the Package Installer is that this command installs/reinstalls all packages rather than selected ones.