Nexacro N

Properties

Property	default	Data Type	Description
key	None	string	This is a required property. Set the key value of the service Must be a the only value in the same start.json
bjson	None	string	This is a required property. Specify the service's start.json path
commthreadcount	3	int	Specifies the number of communication threads used by Nexacro Engine If you want to use several communications at the same time, increase the number to get quicker responses. However, increasing the number does not significantly affect response speed if the network is slow. Max value: 10
commthreadwaittime	-1	int	Specifies the waiting time (in seconds) before the communication thread used by Nexacro Engine is terminated If the communication thread is terminated if it is not used When the default value is set to -1, shutdown is processed after the waiting time set in the Nexacro Engine.
globalvalue	None	string	Set variables to be added to globalvariable when Nexacro Engine is run
splashimage	None	string	Specify the path of the splash image to be displayed while the engine is loading with Nexacro If this isnot specified, the Nexacro default image is output, and the image is displayed in the center of the screen.
onlyone	false	boolean	Set whether to launch only one instance matching key and bjson value
version	None	string	Specify the version to run the Nexacro N in The value that can be entered is "21"
screenid	None	string	Set the Screen ID where the app is running
enginesetupkey	None	string	This is a required property. Specify the ProductKey value of a specific version of Nexacro to be used as an execution path. IF a Setup Module separately written in the website is used, set the Product Key that is given when creating a Setup in this property. If this is not set, the service may not run properly
setupresource		boolean	Setting whether to use the feature for downloading the SetupResource.zip file Supported from version 1.1.0.9
componentpath		string	Set the path to save the component
loadingimage		string	Set the image displayed on screen for data loading
splashmessage		string	Set whether to display messages when using splashimage No message is displayed if “none” or “(empty value)” is set.
multisession	false	boolean	Set whether to use TPLSvcAgent Supported from version 1.1.0.29

Unexpected results may occur if property values contain special characters.

If the key, bjson property value contains a semicolon (;) or the string ".Run", there can be security issues, so delete the string (applied from version 1.1.0.12)

If the value of the key, bjson property contains a comma (,), a tab character (\t), a newline (\n, \r), or a space between a dot () and the string "run", such as “Run.”, there may be security issues, so delete the string (applied from version 1.1.0.16)

If the key property value contains the string "..[*] :.\" that indicates a relative path, there may be security issues, so delete the string (applied from version 1.1.0.27)

Files with the following extensions cannot be specified for the splashimage property (applied from version 1.1.0.16).

bat, bin, cmd, com, cpl, exe, gadget, inf1, ins, inx, isu, job, jse, lnk, msc, msi, msp, mst, paf, pif, ps1, reg, rgs, scr, sct, shb, shs, u3p, vb, vbe, vbs, vbscript, js, ws, wsf, wsh, dll, hta

There are the following limitations when setting the componentPath property (effective in versions 1.1.0.23 and later)

Only permitted aliases can be used to set values.
Parent folders cannot be specified by including ".." in the path.

When setting the commthreadcount and commthreadwaittime properties, the launcher service must be version 1.1.0.36 or higher and the product (Nexacro Engine) version must be 21.0.0.1000 or higher.

Method

Method	Result	Parameter	Description
launch	None	None	Run Nexacro Engine as NRE.
launchasadmin	None	None	Run Nexacro Engine as NRE in administrator mode. Supported from version 1.1.0.43 (not supported when the multisession property value is true)
makeshortcut	None	strShortCutName strIconPath strIconTargetPath strPosition bAllUser	Creates a shortcut icon.
makeshortcut	None		- strShortCutName:Name of the shortcut icon - strIconPath: Server path where shortcut icon files can be downloaded - strIconTargetPath: Local path where the shortcut icon is downloaded (alias allowed) - strPosition: Position of the created shortcut Choose from "startmenu" / "startup" / "programs" / "desktop" An invalid value is treated as "desktop" - bAllUser :Whether to permit use to all users (the default value is false)
isexistshortcut	boolean	strShortcutName strPosition bAllUser	Checks whether there is a shortcut icon corresponding to the entered factor.
isexistshortcut	boolean	strShortcutName strPosition bAllUser	- strShortCutName:Name of the shortcut icon - strPosition: Position of the created shortcut Choose from "startmenu" / "startup" / "programs" / "desktop" An invalid value is treated as "desktop" - bAllUser :Whether to permit use to all users (the default value is false)
getengineversion	string	strEngineKeyName	Get the engine installed version corresponding to the engine key installed on the system.
getengineversion	string	strEngineKeyName	strEngineKeyName: Engine Setup Key
download	None		Download resources used to run the app.
deleteshortcut	boolean	strShortcutName strPosition bAllUser	Delete the shortcut icon.
deleteshortcut	boolean	strShortcutName strPosition bAllUser	- strShortCutName:Name of the shortcut icon - strPosition: Position of the created shortcut Choose from "startmenu" / "startup" / "programs" / "desktop" An invalid value is treated as "desktop" - bAllUser :Whether to permit use to all users (the default value is false)
addWebInfo	None	strCookie	Automatically adds the cookie information of the current browser to the cookie variable of globalvariable.
addWebInfo	None	strCookie	strCookie: browser’s cookie information
downloadresource		param	Specify the server path where the SetupResource.zip file is located. Supported from version 1.1.0.9

Unexpected results may occur if method parameter values contain special characters.

If the parameter value delivered as the string when the makeshortcut method is executed contains a semicolon (;) or the string ".Run", there can be security issues, so delete the string (applied from version 1.1.0.15).

If the parameter value delivered as the string when the makeshortcut, deleteshortcut, isexistshortcut method is executed contains a comma (,), a tab character (\t), a newline (\n, \r), or a space between a dot () and the string "run", such as “Run.”, there may be security issues, so delete the string (applied from version 1.1.0.16)

Event

Event	parameter	Occurs
error	nError strMsg	Event set when an error occurs while launcher service is running
- nError: Error code - strMsg: Error message

parameter

Occurs

error

nError

strMsg

Event set when an error occurs while launcher service is running

- nError: Error code

- strMsg: Error message

Error Code	Error Message	Description
102	Not exist key. Please input key.	If key value is not set
103	Not exist bootstrap.Please input bootstrap.	If bjson value is not set
104	Fail to download.	If the image file cannot be downloaded
105	Fail to load config file.	If the nexacro.xml file cannot be read
106	Fail to write config file.	If the nexacro.xml file cannot be recorded

Reference

Distribute installation files with digital signatures preserved

The SetupResource.zip file must be downloaded to the user's PC first before running the SetupRuntime.exe installation file.

Distributing installation files with digital signatures preserved is supported in the launcher service version 1.1.0.9 or higher.

setupresource property settings

Set the setupresource property value to true in the setproperty function for running the launcher service as follows.

objNexacro.action = 'setproperty';
if (action_sub == 'basic') {
	objNexacro.value = {
		"key": strKey,
		"bjson": strBjson,
		"splashimage": strSplashImage,
		"componentpath": strComponentPath,
		"loadingimage": strLoadingImage,
		"globalvalue": strGlobalValue,
		"onlyone": bOnlyone,
		"splashmessage": 'none',
		"setupresource": 'true',
		"enginesetupkey": strEnginesetupKey
	};
}

downloadresource method settings

Set the server path where the start.json and SetupResource.zip files are located as argument values. When the downloadresource method is executed, the SetupResource.zip file is downloaded from the set path to the "%USERAPP%SetupResource" path.

else if (action == 'downloadresource') {
	objNexacro.value = {
		"downloadresource": {
			"param": ["http://127.0.0.1:8080/test/"]
		}
	};

After the downloadresource method is executed, the script that downloads the SetupRuntime.exe file will operate.

Nexacro Platform 17

Precautions when using version 17.1 or higher

There is an error in LauncherService version below 1.1.0.17, where the globalvalue property value cannot be processed. Check the LauncherService version on the distribution page and update to version 1.1.0.17 or higher.

// Check launcher service version
function checkUpdateLauncher() {
	if (xhrObject.readyState == 4 || xhrObject.reqType == 2) {
		if (xhrObject.status == 200 || xhrObject.reqType == 2 && launcher_response(xhrObject.responseText)) {
 
			//1. getlauncherversion Launcher service version information
			var resultJson = JSON.parse(xhrObject.responseText);
			strLocLuncherVer = resultJson.value["getlauncherversion"].productversion;
 
			//2. If the value is higher than the installed version, call TPL_LauncherDownload()
			if (strLauncherVersion > strLocLuncherVer) {
				TPL_LauncherDownload("update");
			} else {
				//Run nexacro..
			}
		}
	}
}
 
// Call download_TPLSvc() after setting the message on the distribution page
function TPL_LauncherDownload(str) {
	var msg = "Not installed.";
	if (str == "update") { msg = "Update complete."; }
	var contents = "TPLSvc " + msg + " Please download TPLSvc and proceed with the installation.";
 
	var divCon = document.getElementById("errorDiv")
	divCon.innerHTML = "<H3>" + contents + "</H3>";
	document.location = download_TPLSvc("newlanucher");
}
 
var strLauncherFileName = "TPLSvc_Setup.exe";
 
// Download launcher service 
function download_TPLSvc(type) {
	if (type == "newlanucher") {
		// Download TPLSvc_Setup.exe in the server path
		var downURL = strServerPath + strDownloadPath + "/" + strLauncherFileName;
		return downURL;
	}
}