The three modules provided by nexacro platform are run by programs other than nexacro platform. The NexacroAX and NexacroLauncherAX modules are run by web browsers, and nexacro.exe is run on the OS command line.
NexacroAX
NexacroAX is an ActiveX module for running the nexacro platform Engine on web browsers.
This module is included in the following setup files:
nexacro14_SetupDeveloper_N.exe
nexacro14_SetupEngine_N.exe
nexacro14_SetupEngine_N.cab
NexacroAX is an object on web browsers, so it has elements (property, method, event). This section provides a brief description of these elements.
CLASS ID
The Classid for AcitveX is “812CB626-69B7-4FEB-B42F-E3BBFF53E23B”.
The following is the HTML code for activating this module.
<SCRIPT LANGUAGE="javascript"> document.write('<OBJECT ID="nexacroLauncher" ' + 'CLASSID="CLSID:812CB626-69B7-4FEB-B42F-E3BBFF53E23B"' + '"CODEBASE="./nexacro14_Launcher_N.cab#VERSION=2014,5,27,1" ' + 'onError="fn_onError()" >' + '</OBJECT>');
Property
The following table lists the NexacroAX property values, and identifies the required property values for driving the nexacro platform engine.
Property Name | Required | Description |
---|---|---|
Default Value | ||
key | O | Key value of the service must be designated It should be the only value in the same ADL |
No default value | ||
xadl | O | Designates the converted service ADL JavaScript file path |
No default value | ||
componentpath | X | Designates the PATH where the components will be saved on the user’s PC Generally this value is not designated |
Default value ="%USERAPP%\nexacro\14\Component\" Refer to “Appendix A. Alias route” for value of %USERAPP% | ||
autosize | X | Designates whether the size of nexacro platform will change accordingly to the size of the web browser When false, the plugin width and height of the web browser are applied |
Default value=true | ||
commthreadcount | X | Designates the number of communication thread nexacro platform Engine uses:
|
Default value =5 | ||
errorfile | X | File where nexacro platform Engine error information outputs are defined:
|
No default value | ||
handleflag | X | Decides whether the exit() event will occur after an nexacro platform application program is shut down If not designated, when becomes true and exit() occurs |
Default value =true | ||
Commthreadwaittime | X | Sets the time (seconds) to wait before shutdown when the thread the nexacro platform application program uses does nothing |
usewininet | X | Designates the method of communicating with the server Sets whether to communicate using WINNET communication library |
Default value = false | ||
autostart | X | Determines whether to automatically execute run() at the point NexacroAX control is created |
Default value =false |
Method
The following is a list of the methods NexacroAX can perform.
Method Name | Description |
---|---|
callscript | Performs nexacro platform Engine script in NexacroAX |
getvariablevalue | Gets the variable value of GlobalVariable of nexacro platform Engine in NexacroAX |
run | Method for NexacroAX to run nexacro platform Engine |
setvariablevalue | Sets the variable value of GlobalVariable of nexacro platform Engine in NexacroAX |
stop | Method for PlugIn to stop all managers in nexacro platform. |
quit | Method for Plugin to load ADL and start performance |
addWebInfo | Automatically adds the cookies information of the current browser to the cookies variable in GlobalVariable |
Event
These are the events that occur in NexacroAX.
Event Name | Description |
---|---|
addlog | Occurs when the trace() function is executed in nexacro platform Script The factor value of the trace() function is applied intactly to the factor value of the event in nexacro platform Script |
beforeexit | Occurs right before shutdown of nexacro platform Engine: • After the beforeexit event, the exit event occurs. When the handledflag value is set as false in the beforeexit event, the exit event is not triggered, and shutdown does not occur. • Happens when the exit function is called in nexacro platform and after the event of onbeforeexit of the application happens, beforeexit happens in NexacroAX. |
communication | Happens at the start and end of nexacro platform’s communication |
error | Triggered when an error occurs during NexacroAX loading, or running nexacro platform Engine |
exit | Triggered when nexacro platform Engine shuts down and is affected by an beforeexit() event |
load | Happens after the initial loading of nexacro platform Engine is complete Onload event happens in nexacro platform Script Happens in the following order: loadtypedefinition, loadingglobalvariables, load |
loadingglobalvariables | Happens after the objects of GlobalVariables are created. This is before the URL of dataset and form are loaded; so when the needed information is added or modified, it will load with the modified value. The Onloadingglobalvariables event of application will also occur in nexacro platform Script. |
loadtypedefinition | Occurs after the loading of components registered on the TypeDefinition is completed. It means the distribution of components is also complete. The Onloadtypedefinition event of an application also happens in the nexacro platform script. |
usernotify | Triggered on plugIn in the case of calling userNotify () function in the nexacro platform script. The userNotify () function's factor value is applied intactly as the factor value of the event. |
Launcher
Launcher is an ActiveX module used to run the nexacro platform Engine as an nexacro platform runner.
This module is included in the following setup files.
nexacro14_SetupDeveloper_N.exe
nexacro14_SetupEngine_N.exe
nexacro14_SetupEngine_N.cab
nexacro14_Launcher_N.cab
Launcher is an object on the web browser so it has elements (property, method, event).
A brief description of these elements follow.
CLASS ID
The Classid for AcitveX is “812CB626-69B7-4FEB-B42F-E3BBFF53E23B”.
The following is the HTML code for activating this module.
<SCRIPT LANGUAGE="javascript"> document.write('<OBJECT ID="nexacroLauncher" ' + 'CLASSID="CLSID:812CB626-69B7-4FEB-B42F-E3BBFF53E23B" ' + '"CODEBASE="./nexacro14_Launcher_N.cab#VERSION=2014,7,11,2" ' + 'onError="fn_onError()">' + '</OBJECT>');
Property
The following table lists the property values for Launcher. The values marked as required must be designated to drive the nexacro platform engine.
Property name | Required | Description |
---|---|---|
Default value | ||
Key | O | Sets the key value of the service Has to be the only value of the same ADL |
No default value | ||
Xadl | O | Designates the converted service ADL JavaScript file path |
No default value | ||
commthreadcount | X | Designates the number of communication threads the nexacro platform Engine uses. Best practice is set the value high if the user’s device has many CPUs Used only for the communication process:
|
Default value =5 | ||
componentpath | X | Designates the path of how components will be saved on the user’s PC Generally this value is not designated |
Default value ="%USERAPP%\nexacro\14\Component\"Refer to “Appendix A. Alias route” for value of %USERAPP%. | ||
errorfile | X | Defines file path of the nexacro platform engine error information outputs When not designated, the nexacro platform Engine basic error information is output Generally it is not designated |
No default value | ||
globalvalue | X | When nexacro platform Engine is run, this property sets the additional variable to globalvariable |
No default value | ||
loadingimage | X | Sets the images nexacro platform Engine displays while loading screen, data If the server path is entered in, downloads and saves under the designated ComponentPath |
No default value | ||
splashimage | X | Designates the path for the splash image that is displayed while nexacro platform Engine is loading
|
No default value | ||
onlyone | Decides whether or not the key and XADL values will be launched only once in the same instance | |
Default : false | ||
commthreadwaittime | Shuts down the thread used by the nexacro platform application program is doing nothing Sets the time (seconds) to wait before shutdown | |
enginesetupkey | Designates the ProductKey value of a specific version of nexacro platform that will be used as the execution route Note, if you are using a setup module exclusively made by the website, and you set the product that is given when making the setup in property, you will tbe to solve any problem of not being able to run Runtime in the launcher because of the fixed route. |
Method
The following table shows the methods Launcher can run.
Method Name | Description |
---|---|
launch | Runs nexacro platform Engine as an exclusive browser |
makeshortcut | Creates shortcut icon |
isexistshortcut | Checks if the shortcut icon that is relevant to the input factor exists |
getEngineVersion | Gets the engine setup version that is relevant to the engine key installed on the system |
download | Downloads the used resources when running an application |
deleteshortcut | Deletes shortcut icons |
addWebInfo | Adds the cookies information of the current browser to cookies variables in the globalvariable |
Event
The following table lists the events that occur in Launcher.
Event Name | Description |
---|---|
error | Triggered when an error occurs while running Launcher |
nexacro.exe
The nexacro platform Engine can be run directly on the MS Windows command line. It usually uses shortcut icons, and you can run the nexacro.exe file with a variety of options.
nexacro.exe –option1 option1_value –option2 option2_value … -optionN –optionN_value
Execution Option
Following is a description of options.
Execution Option | Value | Description |
---|---|---|
X (required) | Path name(string) | Designates the converted service ADL JavaScript file path |
K (required) | KEY name(string) | Sets the key value of service Needs to be the only value of services on URL |
C | Path name(string) | Designates the path component installed on the user device If not designated, it will be designated as "%USERAPP%\nexacro\14\Component\". \"Refer to “Appendix A. Alias route” for value of %USERAPP%. |
SP | Path name(string) | Designates the path of splash image
|
LF | Place value(int) | Designates the LEFT place of the first execution of application, and applies to the MainFrame of the first screen |
TP | Place value(int) | Designates the TOP place of the first execution of application, and applies to the MainFrame of the first screen |
WD | Size (int) | Designates the WIDTH of first execution of application, and applies to the MainFrame of the first screen |
HT | Size (int) | Designates the HEIGHT of first execution of application, and applies to the MainFrame of the first screen |
ERR | Path name (string) | Designates the path for errordefine.xml file which defines the error code value:
|
THR | Number(int) | Designates the number of threads of managers in the engine and others
|
TW | Time (int) | Designates the nexacro platform Runtime wait time for a communication thread |
LG | Path name(string) | Designates the path to set LoadingImage |
OO | Whether – is or not (bool) | Sets whether or not only one Runtime Engine will be launched when Runtime Engine is launched with the same key, XADl, item |
GF | File name (string) | The Temp file name used to pass the nexacro platform value when GlobalVariable is set on launcher:
|
V | Variable character string (string) | Sets the list of variables to add to global variables when launching the Runtime Engine.
Variable name:type=value Variable name:type=value
|
SIE | Whether – is or not (bool) | Decides whether or not to shut down after popping many message boxes when an error occurs while loading the ADL item |
CT | Time second(int) | Sets the Timeout, which checks if the initial network is connected:
|
SCR | Screen ID character string (string) | Designates the ScreenID to be used in LayoutManager |
nexacro.exe File Path
The nexacro.exe file is installed as nexacro14_SetupEngine_N.cab or nexacro14_SetupEngine_N.exe
For MS Windows, the setup path is:
%PROGRAMFILES%\nexacro\14\nexacro.exe