Compiling and Deploying Models

The models that you create in Visual Composer are saved in Generic Modeling Language (GML) format, a proprietary format in which all Visual Composer models are saved. You can build models (a combination of compilation and deployment) on demand at any time (fast deployment), so that you can debug and review them during the modeling process.

Note Note

In addition, your Visual Composer environment may be configured to automatically run nightly builds that build models that are checked in to the Design Time Repository (DTR). For more information, see Configuring Visual Composer to Work with NWDI.

End of the note.

When you compile your model, the code is converted from GML format into Executable GUI Language (XGL) format. When you deploy your model, the compilation process is performed, and then the XGL format is converted into a supported runtime language, such as Web Dynpro. When you build a model, all components stored in the current model's development component are automatically built.

During deployment, the model is automatically deployed to the runtime environment required for the specific component type, according to the runtime specified in the Configure task panel for the specific component. You can view (read-only) the runtimes defined for each nested component type for a selected default runtime by clicking the View runtime configuration link in the Options pane. If the default runtime provider does not specify nested component runtime providers, all runtime providers are supported by default.

Note Note

Each component is deployed in a specific format and to a specific location according to the selected runtime. If you choose to change the runtime for a specific component, it may cause an error at runtime. This is because the runtime engine may not support the selected runtime or may not be able to locate the deployed component, since it is not deployed to the format or location that was expected according to the default runtime configuration. Changing the runtime for a component may also affect any models in which the component is reused, for these same reasons. We recommend that you carefully consider all these potential issues before changing a runtime environment; in general, the default runtime settings should be sufficient.

End of the note.

During compilation and deployment, warnings and errors may be discovered, enabling you to check the model's validity. After the model is deployed, you can check that the application behaves as expected at runtime. If you find problems with the runtime application, you can return to Visual Composer Storyboard and make modifications, then redeploy it and check it again, and so on, until you are satisfied with the result.

Prerequisites

You have opened the model that you want to build.

Procedure

Specify whether the component should be built as an application, in one of the following ways:
- In the Compiler group of the Options pane ( Tools Options ), select the Define composite views as applications check box to specify that all composite view components should be built as applications by default. Even if you select this option, you can still change the setting for a specific component, as described in the following sentence.
- In the Configure task panel for the specific component, select the Define as application check box.
A component defined as an application can be run by clicking the relevant link in the Applications group of the Results area in the Deploy task panel after deployment.
Click the Deploy button in the task-panel tool bar.
To build all components throughout the dependency chain, select the Include dependencies check box. This means that any components referenced from the current model, any components referenced from the referenced components, and so on, are all built, regardless of the development component in which they are located. Because of this, if a referenced model resides in another development component, all models in that development component are also deployed. Depending on the length of the dependency chain, the build process may take some time.
Click Compile to create the XGL code for the model and transfer it to the runtime provider to convert as needed, or click Deploy to perform the compilation process and then take the runtime format files and create an archive file that can be deployed to the AS Java.

Note

Make sure that you have saved the current model (and any dependent models, if relevant) before compiling or deploying the model. If you have not saved the models, a message is displayed asking whether you want Visual Composer to save them before continuing with the selected operation. You can select the Automatically save models before build check box in the Compiler group of the Options pane ( Tools Options ) to automatically save all open models before compilation or deployment operations.

End of the note.

Result

All components in the current development component are built to the selected runtime environment. The Deploy task panel displays the following items:

Development component nodes: A development component node is displayed for each development component that was deployed. Expand a development component node to see the runtime providers supported for the compiled applications.
The different runtime providers displayed depend on the runtime provider configuration for the component ( Tools Options View Runtime Configuration ). For Web Dynpro, deployed applications can be run in both Web Dynpro HTML and Web Dynpro Flex.

Within each runtime provider node, there are links to all the components defined as applications. You can click an application link to run the specific application in the selected runtime.

Links to deployed applications in the Deploy task panel are saved when switching between open models, when reopening closed models, and between sessions. This means that you can click a link to run a previously deployed application, without having to first redeploy it.

The filter icon at the bottom of the Deploy task panel enables you to filter the list of applications links by runtime, and choose to see only those applications that were deployed to specific runtime(s). By default, the filter is Off and all returned applications are displayed. To turn the filter On, clear the Disable Filter checkmark in the context menu and from the Filter by Runtime context menu, make sure that only the runtimes you want to view are selected.

Note

If you deployed a model and there are no application links displayed, it means that there were no models defined as applications in the current development component (see step 1 in the procedure).

End of the note.
Info/Warnings/Errors: Expand these groups to display informative messages, warnings, and errors that may have occurred during compilation and deployment. You can click a link in this group to highlight the problematic element on the Design board, where relevant.