Auto Recover
If you set up whether to use Auto Recover function from Tools > Options menu, UX-Studio will save editing files in the temporary file every amount of time you set up.
If you open projects that were closed due to an unusual termination of UX-Studio, UX-Studio checks the temporary file and a message that asks you whether to recover file or not will pop up.
Auto Recover displays target recover list and recovers target file by using the temporary file that was saved while editing it.
Use User-defined Metadata
Developers can call pre-defined terminology data from the UX-Studio server by using the user-defined metadata feature. While bigger projects have the broader lexicon, developers can reduce the confusion caused by the use of terminology if they use this feature.
You can determine whether to use the user-defined metadata feature by accessing [Tools > Options > Environment > Business Service]. With this function, you can easily use the terminology data provided by the server through the text property of each component.
You should take the following three steps in order to use the feature.
Writing metadata files
Registering a service
Setting options
Writing Metadata Files
To use the feature of user-defined metadata, you must place a service dataset file and model dataset file in the application server. A service dataset file contains meta-information about service while a model dataset file includes actual terminology.
The below table describes the columns of a service dataset.
Column ID | Description | |
|---|---|---|
1 | domain | Names of domains that include models to call (metadata) |
2 | model | Name of the models to call (metadata) |
3 | description | Descriptions of the models |
4 | datasource | Names of data sources used by the models |
Write a service file as presented below by referring to the above table. Here, the example file is named “termServiceList.jsp." Be aware that the ‘domain’ and ‘model’ columns must be specified as metadata for the service file to work properly.
<?xml version="1.0" encoding="utf-8"?> <Root xmlns="http://www.tobesoft.com/platform/dataset" ver="5000"> <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>
Now that you have written a service dataset file, then you need to write a model dataset file which must contain information about an output dataset and metadata dataset. An output dataset include information about datasets supplied to UX-Studio while a metadata dataset consists of actual vocabulary.
The below table describes the columns of a model dataset.
Column ID | Description | |
|---|---|---|
1 | name | Data name |
2 | type | Data type |
3 | description | Description of the data |
The below XML code is an example of a model dataset file used in this section. The name of file is “termServiceModelData.jsp.”
<?xml version='1.0' encoding='utf-8'?> <Root xmlns='http://www.tobesoft.com/platform/Dataset' ver='5000'> <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'>metadata</Col> </Row> </Rows> </Dataset> <Dataset id='metadata'> <ColumnInfo> <Column id='Eng_NM' type='STRING' size='50'/> <Column id='NM' type='STRING' size='50'/> <Column id='DESC' type='STRING' size='256'/> </ColumnInfo> <Rows> <Row> <Col id='ENG_NM'>VCSG_AFST_DSB_TAM</Col> <Col id='NM'>VISA-CASH</Col> <Col id='DESC'>Total Amount provided to Franchises</Col> </Row> <Row> <Col id='ENG_NM'>VCSH_PCHCM_FE</Col> <Col id='nm'>VISA-CASH</Col> <Col id='DESC'>Acquirer Commission</Col> </Row> <Row> <Col id='ENG_NM'>VCSH_IS_CO_FE</Col> <Col id='NM'>VISA-CASH</Col> <Col id='desc'>Issuance Commission</Col> </Row> <Row> <Col id='ENG_NM'>VCSH_USE_TAM</Col> <Col id='NM'>VISA-CASH</Col> <Col id='DESC'>Total Commission Amount</Col> </Row> </Rows> </Dataset> </Root>
Finally, you need to place the service dataset file (termServiceList.jsp) and model dataset file (termServiceModelData.jsp) in the application server in order for UX-Studio to access them with the URL.
Using UX-Studio is a convenient way to write dataset files for user-defined metadata. Create a dataset component in the tool and write a file by using Dataset Contents Editor. Afterwards, copy and paste the result source.
Registering a Service
To fetch user-defined metadata from the application server, you must register a related service in UX-Studio.
Right-click TypeDefinition and select [Edit] to register a new service.
Once the Edit TypeDefinition window pops up, go to the Services tab and click the Add button. After the Add Service Group box appears, register a new service by referring to the below table.
Service ID | Service name |
|---|---|
Service Type | Service type (select ‘metadata’) |
Service URL | Service path (enter an URL including “http” and ending with “/”) |
Search Column | For faster search at text property bars, you can determine specific dataset columns that will be included in the search range. If you want to input multiple columns, you should enter their names by dividing them with semicolons (;). If you input nothing, the search will cover every column. |
After entering all the information and clicking the ‘OK’ button, you will find the new service registered. Now, you need to fill in ‘ServiceList’ and ‘DatasetLayout,’ as illustrated in the below picture, and press the ‘OK’ button.
ServiceList | Name of a service dataset file |
|---|---|
DatasetLayout | Name of a model dataset file |
If you have completed all the steps so far successfully, you will see the name of the registered service like the picture on the left below. Right-click the service and select ‘Refresh,’ and you will see the associated model as shown in the right-below picture. Right-click the model and select ‘Refresh.’
If the service was successfully registered while the ServiceList file and DatasetLayout file are located in the service URL, you will see that the service and associated model are loaded in the Project Explorer, as seen in the below picture.
Setting Options
Check the “Use user-defined metadata” option in [Tools > Options > Environment > Business Service] and you can see an ‘expand’ button added to the text properties of each component. You can use the pre-determined terminology data by pressing this button.
How to Use
If you have completed all the process described above, you are ready to use the user-defined metadata feature. First of all, you need to create a component in a form and select the text property in the Properties window, as seen in the below picture.
As shown in the below picture, click the newly-created ‘expand’ button to open the Metadata pop-up.
Choose an appropriate term and press the OK button. Check that your selected term has been successfully applied to the component, like the below picture.