General Interface is an open source project hosted by the Dojo Foundation

Project Settings for 3.1.x to 3.4 Migration

When you create a new project in General Interface Builder, a default application configuration file is automatically created as part of the project in the project directory: workspace/JSXAPPS/project_dir_/config.xml. The application configuration file contains application configuration data, such as project settings, application deployment, and file locations.

You can modify the project settings in the Project Settings dialog (Project > Project Settings) or in the application configuration file. Any changes you make in the Project Settings dialog are saved to the configuration file. Some changes can only be made in the configuration file.

Paths

Application resources can now be specified using relative paths, which allows for easier portability of code from one project to another and simplifies the relocation of applications in the JSXAPPS folder hierarchy.

When you open a 3.1.x project in General Interface Builder 3.3, paths in the config.xml file are updated automatically to relative paths after the upgrade prompt.

However, you must modify the path for the initial component. You can do this on the Deployment panel of the Project Settings dialog (Project > Project Settings) in the IDE or in the application configuration file (workspace/JSXAPPS/PROJECT_DIR_/config.xml). Simply remove JSXAPPS/PROJECT_DIR_/ from the path as shown in the Revised config.xml for 3.3 below.

config.xml for 3.1.x

<record jsxid="objectseturl"
  type="string">JSXAPPS/PROJECT_DIR/components/appCanvas.xml
</record>

Revised config.xml for 3.3

<record jsxid="objectseturl"
  type="string">components/appCanvas.xml
</record>

Auto Load Options

New file auto load options have been introduced in General Interface 3.2. In prior General Interface releases, auto loading could be set to true or false. In General Interface 3.2 and above, there are four auto load options: Manually as needed, At init, At full init, and At light init. Available options vary by file type. For more information about auto load options, see the General Interface Developer Guide.

Before using the new options, you need to modify the onLoad jsxid for some files in the application configuration file as follows:

  1. Open the application configuration file, which is located in workspace/JSXAPPS/PROJECT_DIR_/config.xml.
  2. Find jsxid="includes" and notice that there are multiple records of type map. Each type map record has a record with jsxid= " onLoad ".
  3. Modify each child record of type map with a jsxid of onLoad as follows:
    1. Change the jsxid onLoad value to load.
    2. Change the type from boolean to number.
    3. Change the record value to the new desired value, such as 0, 1, 2, or 3. For values, see the next table.
      For example, to set logic.js to load automatically when the application initializes, change the record from this:
      <record jsxid="onLoad" type="boolean">true</record>

      To this:

      <record jsxid="load" type="number">1</record>
Auto Load Option 3.2 or 3.3 Prior to 3.2
Manually as needed 0 false
At init 1 true
At full init 2 Not available
At light init 3 Not available

The Auto Load option is disabled for GUI component files, such as appCanvas.xml. You can specify a GUI component file to automatically load when the application initializes in the Initial Component field on the Deployment panel of the Project Settings dialog.

  1. Save the configuration file and reload the project.

Once you've modified the application configuration file, you can also set auto load options in General Interface Builder. Right-click a file in the Project Files palette and choose Edit Profile. Select an option from the Auto Load drop-down list in the Edit Profile dialog and click Save.

Internet Explorer Parameters

To take advantage of MSXML 4 or later, if installed, remove the following Internet Explorer parameters from the application configuration file.

  1. Open the application configuration file: workspace/JSXAPPS/PROJECT_DIR_/config.xml.
  2. Remove the following Internet Explorer-specific parameters:
    <record jsxid="xmlregkey"
        type="string">Msxml2.FreeThreadedDOMDocument.3.0</record>
      <record jsxid="xslregkey"
        type="string">Msxml2.XSLTemplate.3.0</record>
      <record jsxid="httpregkey" type="string">Msxml2.XMLHTTP</record>

However, you can pass these parameters at runtime using the General Interface runtime parameters. See the General Interface Developer Guide.

Custom Add-ins

If you've created a custom add-in for General Interface 3.1.x, you need to edit the project config.xml file of the add-in as follows:

  1. Open the project config.xml file of the add-in located at workspace/JSXAPPS/PROJECT_DIR_/config.xml.
  2. Add this new record to the configuration file:
    <record jsxid="jsxversion" type="string">3.3</record>
  3. Save the file.

You might also want to update your add-ins to use the new General Interface features, such as class loading and relative paths. See Class Loading in Migration for 3.1.x to 3.4 Migration and Relative Paths for 3.1.x to 3.4 Migration.

Contents

Searching General Interface Docs

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.