Skip to content

Add checkbox option to start OIE service after install #505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
paul-hristea wants to merge 3 commits into
base: main
Choose a base branch
from
+109 −9
Open

Add checkbox option to start OIE service after install #505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d804a11
Add checkbox option to start OIE service after install
paul-hristea Oct 20, 2026
9273c98
Improve content on Finish screen
paul-hristea Oct 21, 2026
f3cedb7
Slightly improve wording
paul-hristea Oct 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 104 additions & 4 deletions tools/install4j/oie-installer-config.install4j
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,9 @@
<actions>
<action id="7" beanClass="com.install4j.runtime.beans.actions.misc.LoadResponseFileAction" rollbackBarrierExitCode="0" multiExec="true">
<serializedBean>
<property name="excludedVariables" type="array" elementType="string" length="1">
<property name="excludedVariables" type="array" elementType="string" length="2">
<element index="0">sys.installationDir</element>
<element index="1">startServiceNow</element>
</property>
</serializedBean>
<condition>context.getBooleanVariable("sys.streamlinedInstallation")</condition>
Expand Down Expand Up @@ -313,8 +314,9 @@ return true;
<actions>
<action id="11" beanClass="com.install4j.runtime.beans.actions.misc.LoadResponseFileAction" rollbackBarrierExitCode="0" multiExec="true">
<serializedBean>
<property name="excludedVariables" type="array" elementType="string" length="1">
<property name="excludedVariables" type="array" elementType="string" length="2">
<element index="0">sys.installationDir</element>
<element index="1">startServiceNow</element>
</property>
</serializedBean>
<condition>context.getVariable("sys.responseFile") == null</condition>
Expand Down Expand Up @@ -403,11 +405,109 @@ return true;
</formComponent>
</formComponents>
</screen>
<screen name="Start service" id="200" beanClass="com.install4j.runtime.beans.screens.FormScreen" rollbackBarrierExitCode="0">
<serializedBean>
<property name="title" type="string">Installation Successful</property>
<property name="subTitle" type="string">The service is installed and will run automatically on boot.</property>
</serializedBean>
<condition>!context.isConsole() &amp;&amp; !context.isUnattended()</condition>
<formComponents>
<formComponent id="201" beanClass="com.install4j.runtime.beans.formcomponents.MultilineLabelComponent" insetBottom="10">
<serializedBean>
<property name="labelText" type="string">The Open Integration Engine service has been installed and is configured to run automatically when the computer starts up.

Would you like to start the service now?</property>
</serializedBean>
</formComponent>
<formComponent id="202" beanClass="com.install4j.runtime.beans.formcomponents.CheckboxComponent">
<serializedBean>
<property name="checkboxText" type="string">Start the service now</property>
<property name="initiallySelected" type="boolean" value="false" />
<property name="variableName" type="string">startServiceNow</property>
</serializedBean>
</formComponent>
</formComponents>
</screen>
<screen name="Starting service" id="205" beanClass="com.install4j.runtime.beans.screens.CustomizableProgressScreen" rollbackBarrierExitCode="0">
<serializedBean>
<property name="title" type="string">Starting Service</property>
<property name="subTitle" type="string">Please wait...</property>
</serializedBean>
<condition>
context.getBooleanVariable("startServiceNow") // Skip screen altogether if startServiceNow is false
</condition>
<postActivation>
context.getWizardContext().setControlButtonVisible(ControlButtonType.NEXT, false);
context.getWizardContext().setControlButtonVisible(ControlButtonType.PREVIOUS, false);
context.goForward(1, true, true); // startServiceNow was true, start action automatically
</postActivation>
<actions>
<action id="206" beanClass="com.install4j.runtime.beans.actions.control.SetProgressAction" actionElevationType="none" rollbackBarrierExitCode="0">
<serializedBean>
<property name="progressChangeType" type="enum" class="com.install4j.runtime.beans.actions.control.ProgressChangeType" value="SET_INDETERMINATE" />
</serializedBean>
</action>
<action name="Start service and record result" id="203" beanClass="com.install4j.runtime.beans.actions.control.RunScriptAction" actionElevationType="elevated" rollbackBarrierExitCode="0" failureStrategy="continue">
<serializedBean>
<property name="script">
<object class="com.install4j.api.beans.ScriptProperty">
<property name="value" type="string">
com.install4j.runtime.beans.actions.services.StartServiceAction startAction =
new com.install4j.runtime.beans.actions.services.StartServiceAction();
startAction.setLauncherId("25");
startAction.init(context);
boolean succeeded = false;
try {
succeeded = startAction.execute(context);
} catch (Exception e) {
com.install4j.api.Util.log(e);
succeeded = false;
}
context.setVariable("serviceStartSucceeded", Boolean.valueOf(succeeded));
return true;
</property>
</object>
</property>
</serializedBean>
</action>
</actions>
<formComponents>
<formComponent id="207" beanClass="com.install4j.runtime.beans.formcomponents.ProgressComponent">
<serializedBean>
<property name="initialStatusMessage" type="string">Starting the Open Integration Engine service...</property>
</serializedBean>
</formComponent>
</formComponents>
</screen>
<screen id="20" beanClass="com.install4j.runtime.beans.screens.FinishedScreen" styleId="7" rollbackBarrierExitCode="0" finishScreen="true">
<formComponents>
<formComponent id="21" beanClass="com.install4j.runtime.beans.formcomponents.MultilineLabelComponent" insetBottom="10">
<formComponent name="Finish message - service not started" id="208" beanClass="com.install4j.runtime.beans.formcomponents.MultilineLabelComponent" insetBottom="10">
<serializedBean>
<property name="labelText" type="string">The Open Integration Engine service is installed and will start automatically when the computer boots.

The service was not started during installation.</property>
</serializedBean>
<visibilityScript>!context.getBooleanVariable("startServiceNow")</visibilityScript>
</formComponent>
<formComponent name="Finish message - service start succeeded" id="209" beanClass="com.install4j.runtime.beans.formcomponents.MultilineLabelComponent" insetBottom="10">
<serializedBean>
<property name="labelText" type="string">The Open Integration Engine service has been initiated.

If the server does not come online, please check the logs in the installation directory for errors.</property>
</serializedBean>
<visibilityScript>context.getBooleanVariable("startServiceNow") &amp;&amp; context.getBooleanVariable("serviceStartSucceeded")</visibilityScript>
</formComponent>
<formComponent name="Finish message - service start failed" id="210" beanClass="com.install4j.runtime.beans.formcomponents.MultilineLabelComponent" insetBottom="10">
<serializedBean>
<property name="labelText" type="string">The Open Integration Engine was successfully installed, but the service could not be started.

Please check the service status in your operating system's service manager and review the server logs in the installation directory for errors.</property>
</serializedBean>
<visibilityScript>context.getBooleanVariable("startServiceNow") &amp;&amp; !context.getBooleanVariable("serviceStartSucceeded")</visibilityScript>
</formComponent>
<formComponent name="Documentation link" id="211" beanClass="com.install4j.runtime.beans.formcomponents.MultilineHtmlLabelComponent" insetTop="10">
<serializedBean>
<property name="labelText" type="string">${form:finishedMessage}</property>
<property name="labelHtml" type="string">Visit the &lt;a href="https://docs.openintegrationengine.org"&gt;official documentation website&lt;/a&gt; for more information.</property>
</serializedBean>
</formComponent>
</formComponents>
Expand Down
10 changes: 5 additions & 5 deletions tools/install4j/readme.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
<!DOCTYPE html>
<html>
<body style="font-family: Arial, sans-serif; line-height: 1.6; margin: 1em; background-color: white; color: black;">
<h1 style="color: black;">Open Integration Engine ${compiler:sys.version}</h1>
<body style="font-family: Arial, sans-serif; line-height: 1.6; margin: 1em; background-color: #46494B; color: #DDDDDD;">
<h1 style="color: #DDDDDD;">Open Integration Engine ${compiler:sys.version}</h1>
<p>
This installer sets up a fully functional version of the engine with minimal user input,
or upgrades an existing installation.
The installer requires administrator permissions to run and install services.
</p>
<h2>Notes</h2>
<ul>
<li>Native services are installed for all supported platforms and are configured to start automatically.</li>
<li><strong>macOS users:</strong> A reboot will automatically start the service.</li>
<li>Native services are installed for all supported platforms and are configured to start automatically on boot.</li>
<li>An option will be provided to start the service immediately after installation.</li>
<li>
A new installation uses the default configuration files in the conf directory;
the installer does not prompt for customization.
This includes ports (default: 8080 and 8443), log and app data paths, and password requirements.
</li>
<li>
An upgrade replaces the program files from the previous installation.
An upgrade replaces the program files after uninstalling the previous installation.
Files in the conf directory are kept and are not updated with new defaults.
Directories created at runtime, such as appdata, are also kept.
</li>
Expand Down
Loading