Differences

This shows you the differences between two versions of the page.

--- docs:2500_config_apps:4300_runtime_exec [2022/08/25 00:00] – removed - external edit (Unknown date) 127.0.0.1
+++ docs:2500_config_apps:4300_runtime_exec [2025/06/12 03:59] (current) – Change to AwareIM aware_support3
@@ Line 1: / Line 1: @@
+[<10>]
+====== Building Runtime Executable ======
+<callout type="primary" icon="true" title="note"> This feature is only available in the AwareIM Developer Edition.</callout>
+If you want to sell applications configured with //**AwareIM**// you can use the "Build Executable" feature to prepare the system for your end users with your own product name and copyright.
+To do this select the business space version containing the final configuration of your application and select the "Build Executable" menu item from the "Version" menu. //**AwareIM**// will display the "Build Executable" dialog. Enter the following information in the dialog:
+===== Name of the application =====
+Specify the name of your application to be displayed by the Installation program and the "About" menu item. This value is mandatory.
+===== Version number =====
+Specify the version number of your application to be displayed by the Installation program and the "About" menu item. This value is mandatory.
+===== Company name/Copyright =====
+Specify your company name and copyright to be displayed by the "About" menu item. This value is optional.
+===== Target platform =====
+Specify the target operating system platform where your application will be used. If your application is to be used for multiple platforms, run "Build Executable" feature for each target platform independently. This value is mandatory.
+===== Target database =====
+Specify the database that your application will use. This value is mandatory.
+===== Do not allow end users to change business space version configuration =====
+Tick this box if you do not want users to change the configuration of your application using the Configuration Tool. In this case also specify the protection password to make sure that only you can access the configuration.
+===== Output directory =====
+Specify the directory where the executable will be built. This value is mandatory.
+===== License file location =====
+Specify the location of your license file. This must be an ASCII text file. This value is mandatory.
+===== Readme file location =====
+Specify the location of the "README" file of your application. This must be an ASCII text file. This value is mandatory.
+===== Documents directory =====
+If you include electronic documentation with your application specify the directory where your documentation files are stored. This value is optional.
+===== Web resources =====
+If your application requires any resources (such as images and styles), which are used in the custom HTML pages of your application, move these resources into a separate directory and specify the name of this directory. Make sure that your HTML pages refer to these resources using this directory as the parent directory. This value is optional.
+===== Other resources =====
+If your application requires any other resources (such as images used in the ''[[a_f:a:import_document|IMPORT DOCUMENT]]'' action), move these resources into a separate directory and specify the name of this directory. Make sure that these resources are referred to using '../OtherResources', for example
+<code aim>IMPORT DOCUMENT Statement.StatementDocument FROM '../OtherResources/myfile.doc'</code>
+This value is optional.
+===== Custom JAR’s location =====
+If your application requires any custom JAR files (for example if you write your own Java extensions – see [[docs:2000_concepts:0900_prod_feats:0800_extending_awareim|Extending AwareIM]] and [[docs:3500|Programmers Reference Guide]]), move these JAR files into a separate directory and specify the name of this directory. This value is optional.
+===== JDK location =====
+If you are building an application for the Linux platform and your current operating system is not Linux, you need to download the Linux JDK1.4 or later((  The license of Sun Microsystems does not allow distributing the complete JDK. However, //**AwareIM**// only requires Java Runtime environment (JRE) and the file tools.jar (you can take it from the JDK and put into the lib directory of the JRE – this file can be freely distributed together with the JRE). )) and specify the directory where it is stored.
+Once you provide the required values and press OK //**AwareIM**// will build the executable (for Windows platform) or zip file (for Linux and Mac OS X platforms) in the output directory that you specified. You can distribute this executable or zip file to your end users.
+<callout type="primary" icon="true" title="note"> When you install the runtime application you will not be able to run the Configuration Tool. If you want users to be able ton run the Configuraton Tool install the standalone Configuration Tool on the runtime machine or copy the AwareIM/ConfigTool directory from your development machine to the runtime machine.</callout>
+<callout type="primary" icon="true" title="note"> If you are distributing an application for Mac OS X platform you can take the resulting zip file to the Mac platform, unpack it and create an application bundle and/or distributable package out of it (see Mac OS X manuals for details). You can then distribute the application bundle or package to your customers. If you decide to distribute the application as an original zip file, you will need to provide startup instructions in a readme file. Customers will need to unpack the zip file, start the Mac OS X Terminal application, change to the ''BIN'' directory and run the startAwareIM.sh script.</callout>