Nexacro Platform creates and manages "Projects," which are stored as files with the extension xprj. Projects are generally managed as ADL (Application Definition Language), Type Definition, Global Variables, and FDL (Form Definition Language), as discussed in this chapter.

New Project Wizard

New projects can be created by using the New Project Wizard.

Menu File [New – Project]

The wizard walks you through naming the project and its location, defining its type definition, and defining the screen.

Step 1: Location

The first step is to enter the Frame Template, the path to the project and the name of the project. The project name is mandatory.

The following special characters cannot be used for IDs of projects, forms and objects.

tab new-line return \ / : ‘ * ? “ < > | ! @ # $ % ^ & ( ) - + = ~ [ ] { } , `

The following characters cannot be used as well and will display error message.

Null character strings, .(Dot), character strings starting with numbers, two-byte characters

Step 2 Definition

The next step is to set up the project's TypeDefinition.

Step 3 Screen

Set up the screen information for running applications.

Application Definition Language (ADL)

ADL manages styles, themes, and main frames that are generally applied to projects when launching applications.

MainFrame

The MainFrame is an element composing Nexacro Platform application's basic screen. It has ChildFrame as a subordinate element and by default is created when a project is created.

Theme

You can change the style of project by selecting a user-developed Theme.

Theme Functions

Access the Themes menu and select the function you want to perform.

Manage an Existing Theme

To manage an existing theme, select the theme from the tree and the function you want to perform.

Working with Image and CSS Files

Manage image and CSS files using the following functions.

ScreenInfo

Access the Popup menu associated with the ADL item in the Project Explorer window to add new screen information.

To edit screen information, select ScreenInfo under the ADL item.

The ScreenInfo Editor provides the same editing functions as the previously mentioned Variable Editor.

Add Application Property

Selecting Add Application Property in the Properties window displays a dialog window for inputting application property information.

You can delete the added application property information by using the context menu.

Tray

You can add applications' icons to the system tray of Windows. Then, you can control applications through the tray-related features such as a pop-up menu opened from the tray.

Adding Icons

You can add a tray icon by accessing [Inset ADL Item > Tray] from the context menu of an ADL file. Then, you can see a new tray icon under the created "Trays" group. If you want to add another tray icon, select "Insert Tray" from the context menu of the Trays group or press "Add" button on the tray editor panel.

Adding Pop-up Menu Items

You can assign only one action for clicking an application icon on the system tray. However, you can set multiple features by using a pop-up menu.

Access items on the Properties window of a tray icon. Then, open the tray pop-up menu editor by clicking the button placed on the right-hand side of items. In the editor, you can create a pop-up menu and add items by setting an innerdataset.

The process of adding items is the same with the ones applied to a Menu component or PopupMenu component. The value of levelcolumn begins with 0. You can set a shortcut by applying "&" to a certain item of captioncolumn.

Executing Tray

Added icons will be displayed on the system tray of Windows when the relevant application runs on the runtime environment. You should add the below event script to allow users to open the registered pop-up menu by clicking the relevant icon on the system tray.

this.Tray0_onlbuttonup = function(obj:Tray, e:nexacro.MouseEventInfo)
{
	obj.items['item00'].trackPopup();
}

Managing TypeDefinition

In Nexacro Studio, you can register and update Components in TypeDefinition and use them as prefixes.

Access the TypeDefinition context menu for different functions you can use.

Editing TypeDefinition Items

Open the Edit TypeDefinition window to add, edit, or delete an item by selecting Edit from the context menu or by double-clicking the TypeDefinition item.

Objects

Modules

To use additionally developed components, you must register (add) related modules on the Modules tab.

Protocols

In Protocols, you can register/delete protocols as well as manage the device types to which each protocol is applied. Moreover, you can register information of modules and classes for each device type.

Services

Access the Services tab for managing service definitions, and the folder path or Internet URL.

Use the Add and Delete button to add new services or delete selected services.

The file types allowed in the Project Explorer differ according to service types.

Update Tab

The Update Definition manages the file distribution and version information. You can add and delete updates using Add and Delete buttons.

Service Refactoring

When changing the Prefix ID of a service being used in a TypeDefinition, the refactoring function is automatically performed.

This figure shows all of the Prefix ID before it is changed in the current project list. When you click the Rename button, the checked items are changed automatically.

Metadata

This is a feature designed to connect matadata to Nexacro Studio. The metadata will be used in the form of a dataset, or used to specify the value of the id or text property.

Metadata Registration

Metadata can be registered through the Services tab in the TypeDefinition editor.

You can register only one metadata service in a project. If you try to register more than one, an error will stop you by showing the below message.

To create a metadata service, you need further settings: specifying "Service List" and "DatasetLayout."

Service List

This item is used to designate a dataset file. The below script contains exemplary source codes of a file that can be specified as ServiceList. To employ a dataset as metadata, you must enter the fixed value "metadata" to the "DOMAIN" and "MODEL" columns.

<?xml version="1.0" encoding="utf-8"?>
<Root xmlns='http://www.nexacroplatform.com/platform/Dataset' ver='4000'>
<Parameters>
	<Parameter id="ErrorCode" type="int">0</Parameter>
	<Parameter id="ErrorMsg" type="string">success</Parameter>
</Parameters>
<Dataset id="termService">
	<ColumnInfo>
		<Column id="DOMAIN" type="string" size="255"/>
		<Column id="MODEL" type="string" size="255"/>
		<Column id="DESCRIPTION" type="string" size="255"/>
		<Column id="DATASOURCE" type="string" size="255"/>
	</ColumnInfo>
<Rows> 
	<Row>
		<Col id="DOMAIN">metadata</Col>
		<Col id="MODEL">metadata</Col>
		<Col id="DESCRIPTION">description</Col>
		<Col id="DATASOURCE">DB</Col>
	</Row> 
</Rows>
</Dataset>
</Root>

DatasetLayout

This item is used to designate information to include in the dataset. The below script contains exemplary source codes of a file that can be specified as DatasetLayout. The dataset layout includes the information on an output dataset and metadata dataset. You must enter the fixed value "metadata" to the "name" column of the output dataset. You also must specify the ID of the metadata dataset as "metadata."

<?xml version='1.0' encoding='utf-8'?>
<Root xmlns='http://www.nexacroplatform.com/platform/Dataset' ver='4000'>
<Parameters>
	<Parameter id='svcid' type='string'></Parameter>
	<Parameter id='ErrorCode' type='int'>0</Parameter>
</Parameters>
<Dataset id='output'>
	<ColumnInfo>
		<Column id='name' type='STRING' size='50'/>
		<Column id='type' type='STRING' size='50'/>
		<Column id='description' type='STRING' size='256'/>
	</ColumnInfo>
	<Rows>
		<Row>
			<Col id='name'>metadata</Col>
			<Col id='type'>dataset</Col>
			<Col id='description'>Color code</Col>
		</Row>
	</Rows>
</Dataset>
<Dataset id='metadata'>
	<ColumnInfo>
		<Column id='CODE' type='STRING' size='50'/>
		<Column id='NAME' type='STRING' size='50'/>
	</ColumnInfo>
	<Rows>
		<Row>
			<Col id='CODE'>0048BA</Col>
			<Col id='NAME'>Absolute Zero</Col>
		</Row>
		<Row>
			<Col id='CODE'>4C2F27</Col>
			<Col id='NAME'>Acajou</Col>
		</Row>
		<Row>
			<Col id='CODE'>B0BF1A</Col>
			<Col id='NAME'>Acid green</Col>
		</Row>
		<Row>
			<Col id='CODE'>C9FFE5</Col>
			<Col id='NAME'>Aero</Col>
		</Row>
	</Rows>
</Dataset>
</Root>

Option Setting

If you want to use metadata in specifying the value of the id or text property, you must configure a separate option. Access the menu [Tools > Options > Environment > Business Service] and select the checkbox in front of "Use user-defined metadata."

If you check the above option "Load business service layout information on Startup," Nexacro Studio loads the information on metadata whenever it opens a project. If it is unselected, you need to load metadata information manually by right-clicking the metadata in the Project Explorer and selecting the "Refresh" menu.

Metadata Used as a Property Value

If you check the "Use user-defined metadata" option, you can find a button to call metadata information in the id or text property box. Click the button and select an item to apply as the property value.

If there are too many data pieces in the metadata, you can filter them. Through the "Search Column" item in the TypeDefinition editor, you can specify which column to filter.

Metadata Used as a Dataset

To derive a dataset from metadata, select the metadata in the Project Explorer, and then drag and drop it onto the "Invisible Objects" pane.

Global Variables

The GlobalVariables object contains items used in overall projects but not included in ADL or the Form. Using any of the editors, you can add or edit these global variable items. An item can be a dataset, variable, or image.

Datasets

A dataset is a memory location in a table form used to process data. When a dataset is bound with components for presentation, automatic synchronization to relevant the component function is provided also.

You can add, delete or change the construction of dataset items in the Dataset Edit Window.

Variables

Variables are used widely in a project. Manage the variables from the Variables context menu.

You can add, delete, or change the construction of the variable items in the Variable Edit Window.

Images

You can add or delete images used in the Project.

Add a new image by selecting Insert Image from the context menu.

Manage individual images by expanding the Images group.

When an image item is selected in the Project Explorer, Image Preview is summoned automatically.

Form Creation Wizard

A new form can be created using the New Form Wizard, which is launched using Menu File [New – Form]

Step 1 Location

Enter the path and name of the form to be created. Entering the form name is mandatory, and must be unique among forms in the path.

Step 2 Dimension

Set up the width and height of form in pixels. Menu Tool [Options] displays the default values.

Step 3 Position

Set up the units for measuring the position when generating a component in a form. The default is the value specified in options.

After setting up the units, click the checkbox beside 'Save position in options' on the bottom left corner to save the designated units in options.

Step 4 Layout

Set up the form layouts, indicating which screens are supported by which layout.

Automatically compose a layout according to the screen designated when a project is generated. If a form is generated by clicking 'Finish' in the previous step, a default layout is composed without any additional information.

Click 'Template' button to open the Screen Template window.

You can compose a layout with items selected in Screen Template. In the process, the name and width of the layout are automatically determined according to the name and screenwidth properties of the relevant screen.

FDL (Form Definition Language)

FDL Drag and Drop

Forms may be moved in service group units in a project, in a group, and between groups by using drag-and-drop or <Ctrl> + drag-and-drop.

FDL Items

Form items contain subordinate items including: Layout, Objects, Script, and Bind elements.

The context menu displayed for a form in Nexacro Studio varies based upon whether the form is open for editing. When form is open for editing, menu items such as BindItem and Layout List are enabled. When not being edited, other menus such as Edit, Insert Style, and Rename are enabbled.

Using a Template

Make a Project Template

The Project Template function saves the current project as a template. In Project Explorer, right-click on Project and select Project Template to display the Make Project Template window.

Screen Template

You can use ready-made templates. You can register pieces of screen infomation you frequently use as user templates in Screen Template.

The information in Basic Template is default values, so users cannot edit them. The information is managed in the "nexacro_os_device.xml" file located within the directory of setup files.

Creating Other Files

Style files (CSS), XML files, script files, and theme files may be created using menu option File > New > File.

Create an XML File

Create a JavaScript File

Auto Recover

When you set up the Auto Recover function from the Tools > Options menu, Nexacro Studio will periodically save backups of files being edited.

With Auto Recover configured, when you open a project that was closed abnormally, Nexacro Studio will check the temporary file and prompt you to recover the file from the most recent backup.

Auto Recover displays the target recovery list and recovers the work in process using the saved backup file.

New Protocol Wizard

You can add a new protocol in TypeDefinition through New Protocol Wizard. There are two ways to start the wizard.

• In the Project Explorer, right-click TypeDefinition and access [Insert Typedefinition Item > Protocol]

• In the Project Explorer, right-click Protocols under TypeDefinition and select Insert Protocol.

You can choose either way to launch New Protocol Wizard.

Step 1. Protocol

In this step, you can register/delete protocols as well as select the device types to which each protocol is applied. Moreover, you can register information of modules and classes for each device type.

The following examples show how each device type constructs protocol information.

$r_title(start.json)
"version" : "15.0.0.1",														
	"runtime" :
	{
		"target" :
		{
			"os" : "windows"
		},
		"framework" :
		[
			[framework js path]
		],
		"component" :
		[
			[component js path]
		],
		"form" :
		[
		],
		"xadl" :
		{
		},
		"protocol" :
		{
			"adaptors" :
			[
				{
					"protocolname" : "[Protocol ID]",
					"modulename" : "[modulename].dll",
					"targetpath" : "[Target Path]"
				},
				{
				}
			]
		}
		"resource" :
		{
		},

$r_title(adl.xadl.js)

// load components
var registerclass = [
	{"id":"Div", "classname":"nexacro.Div", "type":"JavaScript"},
	{"id":"Button", "classname":"nexacro.Button", "type":"JavaScript"},
	{"id":"PopupDiv", "classname":"nexacro.PopupDiv", "type":"JavaScript"},
	{"id":"Combo", "classname":"nexacro.Combo", "type":"JavaScript"},
	{"id":"CheckBox", "classname":"nexacro.CheckBox", "type":"JavaScript"},
	{"id":"ListBox", "classname":"nexacro.ListBox", "type":"JavaScript"},
	{"id":"Edit", "classname":"nexacro.Edit", "type":"JavaScript"},
	{"id":"MaskEdit", "classname":"nexacro.MaskEdit", "type":"JavaScript"},
	{"id":"TextArea", "classname":"nexacro.TextArea", "type":"JavaScript"},
	{"id":"Menu", "classname":"nexacro.Menu", "type":"JavaScript"},
	{"id":"Tab", "classname":"nexacro.Tab", "type":"JavaScript"},
	{"id":"ImageViewer", "classname":"nexacro.ImageViewer", "type":"JavaScript"},
	{"id":"Radio", "classname":"nexacro.Radio", "type":"JavaScript"},
	{"id":"Calendar", "classname":"nexacro.Calendar", "type":"JavaScript"},
	{"id":"Static", "classname":"nexacro.Static", "type":"JavaScript"},
	{"id":"Grid", "classname":"nexacro.Grid", "type":"JavaScript"},
	{"id":"Spin", "classname":"nexacro.Spin", "type":"JavaScript"},
	{"id":"PopupMenu", "classname":"nexacro.PopupMenu", "type":"JavaScript"},
	{"id":"GroupBox", "classname":"nexacro.GroupBox", "type":"JavaScript"},
	{"id":"ProgressBar", "classname":"nexacro.ProgressBar", "type":"JavaScript"},
	{"id":"Plugin", "classname":"nexacro.Plugin", "type":"JavaScript"},
	{"id":"Dataset", "classname":"nexacro.NormalDataset", "type":"JavaScript"},
	{"id":"Protocol00", "classname":"test_HTML5", "type":"Protocol"},
	{"id":"Protocol01", "classname":"Protocol01", "type":"Protocol"}
];

$r_title(start_android.json)

"version" : "15.0.0.1",
	"runtime" :
	{
		"target" :
		{
			"os" : "android"
		},
		"framework" :
		[
			[framework js path]
		],
		"component" :
		[
			[component js path]
		],
		"form" :
		[
		],
		"xadl" :
		{
		},
		"protocol" :
		{
			"adaptors" :
			[
				{
					"protocolname" : "[Protocol ID]",
					"classname" : "[Android_ClassName]",
				},
				{
				}
			]
		}
		"resource" :
		{
		},

$r_title(start_ios.json)

"version" : "15.0.0.1",
	"runtime" :
	{
		"target" :
		{
			"os" : "ios"
		},
		"framework" :
		[
			[framework js path]
		],
		"component" :
		[
			[component js path]

		],
		"form" :
		[
		],
		"xadl" :
		{
		},
		"protocol" :
		{
			"adaptors" :
			[
				{
					"protocolname" : "[Protocol ID]",
					"classname" : "[iOS_ClassName]",
				},
				{
				}
			]
		}
		"resource" :
		{
		},

Step 2. Service

In this step, a service will be created automatically for the registered protocol.

Step 3. Resource

This step automatically adds a resource to start.json, which was generated as a result of applying the protocol to the Runtime device type.

Step 4. Finish

After clicking the Finish button shown in the Step 3, you will see a new protocol, service, and resource (update) added to TypeDefinition.

• The below picture show you how the protocol information entered in the Step 1 has been applied to Protocols in TypeDefinition.

• The below picture show you how the service information entered in the Step 2 has been applied to Services in TypeDefinition.

• The below picture show you how the resource (update) information entered in the Step 3 has been applied to Update in TypeDefinition.

The below code is a sample of TypeDefinition updated after completing New Protocol Wizard. The portions in red color represent the protocol, service and resource added through the wizard.

$r_title(default_typedef.xml)
<?xml version="1.0" encoding="utf-8"?>
<TypeDefinition version="1.2">
  <Modules>
    <Module url="CompBase.json"/>
    <Module url="ComComp.json"/>
    <Module url="Grid.json"/>
    <Module url="DeviceAPI.json"/>
  </Modules>
  <Components>
    <Component type="JavaScript" id="Div" classname="nexacro.Div"/>
    <Component type="JavaScript" id="Button" classname="nexacro.Button"/>
    <Component type="JavaScript" id="PopupDiv" classname="nexacro.PopupDiv"/>
    <Component type="JavaScript" id="Combo" classname="nexacro.Combo"/>
    <Component type="JavaScript" id="CheckBox" classname="nexacro.CheckBox"/>
    <Component type="JavaScript" id="ListBox" classname="nexacro.ListBox"/>
    <Component type="JavaScript" id="Edit" classname="nexacro.Edit"/>
    <Component type="JavaScript" id="MaskEdit" classname="nexacro.MaskEdit"/>
    <Component type="JavaScript" id="TextArea" classname="nexacro.TextArea"/>
    <Component type="JavaScript" id="Menu" classname="nexacro.Menu"/>
    <Component type="JavaScript" id="Tab" classname="nexacro.Tab"/>
    <Component type="JavaScript" id="ImageViewer" classname="nexacro.ImageViewer"/>
    <Component type="JavaScript" id="Radio" classname="nexacro.Radio"/>
    <Component type="JavaScript" id="Calendar" classname="nexacro.Calendar"/>
    <Component type="JavaScript" id="Static" classname="nexacro.Static"/>
    <Component type="JavaScript" id="Grid" classname="nexacro.Grid"/>
    <Component type="JavaScript" id="Spin" classname="nexacro.Spin"/>
    <Component type="JavaScript" id="PopupMenu" classname="nexacro.PopupMenu"/>
    <Component type="JavaScript" id="GroupBox" classname="nexacro.GroupBox"/>
    <Component type="JavaScript" id="ProgressBar" classname="nexacro.ProgressBar"/>
    <Component type="JavaScript" id="Plugin" classname="nexacro.Plugin"/>
    <Component type="JavaScript" id="Dataset" classname="nexacro.NormalDataset"/>
  </Components>
  <Services>
    <Service prefixid="Base" type="form" url="./Base/" version="0" communicationversion="0"/>
    <Service prefixid="Service00" type="JSP" url="Protocol00://" version="0" communicationversion="0"/>
    <Service prefixid="Service01" type="JSP" url="Protocol01://" version="0" communicationversion="0"/>
    <Service prefixid="Service02" type="JSP" url="Protocol02://" version="0" communicationversion="0"/>
  </Services>
  <Update>
    <Item systemtype="Windows" url="">
      <Os type="default" url="" engineurl="" enginesetupkey="" engineversion="">
        <Device type="default" url="" engineurl="" enginesetupkey="" engineversion="" desc="">
          <Resource type="Object" file="aa" failpass="false"/>
          <Resource type="File" file="test.dll" targetpath="" version="" failpass="false" desc=""/>
          <Resource type="File" file="protocolAdp.dll" targetpath="C:\Base" version="" failpass="false" desc=""/>
        </Device>
      </Os>
    </Item>
    <Item systemtype="Android" url="">
      <Os type="default" url="" engineurl="" enginesetupkey="" engineversion="">
        <Device type="default" url="" engineurl="" enginesetupkey="" engineversion="" desc="">
          <Resource type="File" file="default.zip" targetpath="C:\Users\user\Documents\nexacro\outputs" failpass="false"/>
        </Device>
      </Os>
    </Item>
    <Item systemtype="iOS" url="">
      <Os type="default" url="" engineurl="" enginesetupkey="" engineversion="">
        <Device type="default" url="" engineurl="" enginesetupkey="" engineversion="" desc="">
          <Resource type="File" file="Archive00.xzip" failpass="false"/>
        </Device>
      </Os>
    </Item>
  </Update>
  <Protocols>
    <Protocol id="Protocol00" classname="test_HTML5" targetpath="C:\apache-tomcat-6.0.36\webapps" devicetype="Runtime,HTML5,Android,iOS" modulename="test_runtime" android_classname="test_android" ios_classname="test_ios"/>
    <Protocol id="Protocol01" classname="Protocol01" devicetype="HTML5,iOS" file=""/>
    <Protocol id="Protocol02" devicetype="Runtime,HTML5,Android,iOS" modulename="protocolAdp" targetpath="C:\Base" classname="nexacro.Protocol02" android_classname="test_android" ios_classname="test_ios"/>
  </Protocols>
</TypeDefinition>