Create AppWave Supported or Custom App from Scratch

From AppWave
Jump to: navigation, search

Go Up to Mastering Apps


This section walks you through how to create an app from an executable file of an application. This is a custom application that does not have any mastering support. This means that you need to manually insert Product Name, Display Name, Version, Long Description, etc. Once your product is mastered and placed in your AppWave, you will not need to master it again.

This option is only available through the AppWave Studio. A user must be granted authoring permission by an Administrator. For more information see Managing Groups.

This option provides a way for you to create an app file from a given installer file. It actually extracts all the install files from the installer, and then puts these extracted files in a directory under the OutputLocation directory.

The steps to be completed are:

Start

Select Folders and Files to include.png
  1. In the AppWave Browser click Studio and the Build an App page appears with the Start step highlighted in red.
  2. Click the Create AppWave Supported or Custom App from Scratch link or click Icon custom.PNG.
  3. The Select Folders and Files to include' dialog opens. For the Initial folder name, enter an existing folder name or create a new one. This is the root folder where the executable will be added.
  4. In Select a file, browse to the Installer path and select the executable. The Installer path mustbe on the root drive. For example: C:\PDFViewer.exe .
  5. In Select a folder browse a folder which contains the rest of files, dll, binary etc.. that the application needs to work.
    Note: Select a folder is not a required field, you can introduce the necessary files later in the App step.
  6. Click OK and the Create from Scratch dialog appears. You can select the option to close this dialog on successful completion of the operation. The time it takes to complete the operation is also displayed.
    Note: Click Details to see the details of the operation while it is creating or after it completes. If you want to see it after the operation is complete deselect the Close on successful completion option and then click Details.
  7. Depending on the option you selected, the Create from Scratch dialog may or may not automatically close. If you selected the Close on Successful Completion the Launch & Brand page automatically appears depending on the information provided by the executable. If you did not select that option, click Finished to advance to the Launch & Brand page.

Launch & Brand

The Launch & Brand step is where you select the launch executable. The working folder is then populated. You can also set any parameters needed for your App. This is also where you enter critical information for your App. This information for the mastered app appears in the Apps tab of Browser.

Note: If a Tasks pane is open at the bottom of the page, this means there are fields that are missing required information. Click Fix next to the task and your cursor is placed in the appropriate task. Once the tasks are corrected the Tasks dialog closes. The fields with an exclamation mark Icon taskwarning.png are the required fields missing information.

Field Description
Launch Executable The executable (.exe) file that runs the application. Click the drop-down arrow in the Launch Executable and select the executable.
Working Folder The Working Folder is automatically populated from the information you entered in the Initial folder name field.
Parameters These are requirements used with the command, so the content of the parameter depends on the specific app being mastered. For example, if you were mastering RAD Studio, a command executable would be “bds.exe”. But if you wanted to create a Delphi app you would add “-pDelphi” as a parameter for that command.
Product Name This is a required field. Enter the product name along with the trademark sign. This is an internal name used for the product not displayed to customer.
Display Name This is the name that is displayed on the AppWave Public Store and on the AppWave Browser . It should include the trademark sign.
Product Version If no product version is specified in the installer then it will be filled in with the default value of “1.0”. Production version cannot contain build numbers. Format accepted is “a.b.c.d”. Valid version numbers would be: 1.0, 1.0.1, 1.0.1.1. Invalid version numbers would be: 1.0.1234, 1.0.1.12345.
Product Edition This is mandatory if it exists within the app. Sample editions would be: Professional, Home, Ultimate, etc.
Publisher To locate the vendor name easily, you can use the Copyright phrase usually displayed at the bottom of the official website. For example: “Copyright © 2011 Adobe Systems Incorporated. All rights reserved.” Which means the vendor needs to be “Adobe Systems Incorporated” The maximum length of this field is 256 characters.
Icon Icons must be created using this tool: http://docs.embarcadero.com/products/appwave/vendor/IconGenerator/uploadIcon.html . The input of the iconize tool is a 130 x 130 pixel graphic.

The icon must be placed in the following folder and be in the .png format. C:\xxx\Embarcadero\AppWaveStudio\Output\<app name>.png

EULA The EULA file must be in the .htm format using the Arial font, size 10. It should be located in the following folder: C:\xxx\Embarcadero\AppWaveStudio\Output\<app name>.html

Note: If the application require prerequisites (like dotNet Framework, MSVC 2005/2008, J#, MDExplorer, Adobe Flash, etc) then the correspondent EULA file should be included as well.

Screen shot This is a screen shot of the main window of the application. It must be in .png format and located in the following folder: C:\xxx\Embarcadero\AppWaveStudio\Output\<screen name>.png

Note: When creating a screen shot, please take into consideration the fact that they will be scaled to 228 x 174 pixels and they must not be distorted; Also, the images used must not be under copyright.

Web Site Enter the URL for the applications web site.The maximum length is 512 characters.
Support Contacts List the email first. If that is not available, list the contact page (or form) from the website. Or you can list the phone number.

Note: If the contact page contains one entry per country then the link to the page is enough.

System Requirements If no particular requirements are needed then it must contain the phrase Windows XP and higher . If the application has pre-requisites then this field is mandatory. The maximum size of this field is 1024 characters.

In case the app requires pre-requisites, this info must be split into two sections:

  • Requirements for running the app: List all the pre-requisites that the app needs to run that Embarcadero does not offer runtime plugins for. An example would be Adobe AIR.
  • Requirements of the native application: List everything the native application needs even if a runtime plug is available. Examples would be: .NET 3.5 SP1 runtime, Adobe AIR runtime, Microsoft Visual C++ 2008 SPI runtime, and Windows installer 3.0.
Product Description Should not consist of more than two sentences, although there is a 5000 character limit. Include keywords a user might search on such as game, drawing, database, application development, image editor.

For example, the product description for Photographics is: “Photographics is an image editor that provides powerful tools for designers and developers. The information here cannot be copyrighted.”

Long Description The long description cannot contain part of the Product Description and vice versa. For commercial apps, if the description is taken from the vendor’s website, a copyright phrase must be added at the end of this description. For example: "Copyright © 2011 Adobe Systems Incorporated. All rights reserved." This maximum size of this field is 5,000 characters.
Release Date This is the date when the application was released, not the date when the app was mastered or published on AppWave Public Store .


Include Another Application

Include another app.png
  1. If you want to include another application in the App, such as for an application suite that consists of multiple products, click ADD NEW and complete the fields for the new launch entry. Click SAVE when finished.
  2. On this page you can add other apps that you want to include in the .tca file. For example, you may want the Browser user to download a database client in addition to TOAD. You would then click ADD NEW to add one or more applications. You will need only to broadcast one file but the Browser user will see both apps in the file as unique items in the App catalog.
  3. This page requires the same information: Launch Executable, Working Folder; Parameters; Product Name; Display name, Product Version; Product Edition; Publisher; Icon; EULA; Screen shot; Web Site; Support Contacts; System Requirements; Product Description; Long Product Description; and Release Date. All information designated by an exclamation mark Icon taskwarning.png are required fields.
    Note: that the product name and executable that you are adding to are already listed. Click Edit to make changes to this product information.
  4. Complete all the information. Click Save if you want to add another app.
  5. Click Next to advance to the App step.

For more information on this step, see Launch and Brand.

App

  1. When you have completed the Start and Launch & Brand steps, click App and the Configure your App page opens.
  2. This is where you can view what was created when you built a new App. You can edit, add, or delete the files, registry settings, and environment variables that were created during the mastering process. You can also choose required runtimes and select custom scripts to run when triggered.
  3. Click Files and the Files entries for you App page opens.
  4. The folder you created in the first step is shown. Once the managed file is broadcast it will also be shown.
  5. Click the Registry tab to advance to the Registry entries for your App. All registries and any changes to those registries are listed.
    Note: When modifying registry keys it is important to know the system variables. You need to know what variables can be used that will be replaced with the correct path when an app is loaded on a machine. For more information, see: AppWave Studio Appendix#Predefined Virtual Folders.
  6. Click the Environment Variables tab and the Environment variables for your app appears. You can add, edit or remove any Environment variables on this page.
  7. Click the Runtime tab to advance to the Runtimes required by your App page. A default list of runtime plug-ins are listed. You can select the ones required by your App.
  8. Click the Custom Scripts tab to advance to the Custom Scripts for your App page. Here you can you can attach scripts to key application triggers, such as activation, start, close, and deactivation that can accomplish whatever is necessary. These scripts are typically small executable files and batch files. Exe, bat, and cmd files are supported to perform acts such as:
    1. Establish a connection to a shared network location before the application starts.
    2. Run a file backup/archive process for user created documents after the application has exited.
    3. You can set different triggers and then define the actions for that trigger.

For more information on this step, see: Configure you App

Test

Click Test to master and test your app locally. This option allows you to master an app using the template .tca file that you just created.

A .tca file (also known as the Studio file) is a set of information that defines the resources, launch points, and registry settings required to run a product. It also contains information about the product such as the version, name, and editions. The .tca file needs to contain all the files that are associated with it. The .tca file has file system information that actually lists files for the program it needs to master. The files have to be physically present at the directory information that is saved in the .tca data.

  1. The Output Folder is automatically populated with the path, that is C:<xxx>\<user>\Embarcadero\AppWaveStudio\Output\ .
  2. The File Name is also automatically populated with the information from the Launch & Brand page.
  3. In the App field if an app file exists for the app (.stp), click Edit. Select the App file (.stp) to associate with the .tca file for this App.
    Note: This .stp file is typically located in the same output directory ( c:\<xxx>\<user>\Embarcadero\AppWaveStudio\Output\<app name.stp> ).
  4. Click the drop-down arrow in the Compression field and select the type you want to use. “Best Compression” is the recommended setting for Compression.
  5. If you want to select the type of encryption to use in the App, click Advanced.
  6. After your have verified your selections, click Master Icon master.png. If you haven’t saved your file, you will be asked to save your changes to the current working file.
  7. The Master dialog appears with a progress bar showing the mastering steps. Click Details to view the mastering details.
  8. Once the mastering is completed, an option to Record the launch of the application for faster start-up time appears in the Master dialog.
  9. Click Launch to open the app and the Recording dialog opens once again.
  10. Accept the End User License Agreement that appears and then once the application is open and the installation finishes, click Finished in the Recording dialog.
  11. The Master dialog reopens. Notice that a prefetch file has been created.
  12. Click Finished in the Master dialog and then click Next to advance to the Broadcast step.

For more information on this step, see Master and Test your Application.

Broadcast

  1. From the Test page, click Next to advance to the Broadcast page.
  2. Click Broadcast and once again save the changes to your file.
  3. Once the file is saved the Broadcast dialog appears.This dialog tracks the process of the broadcasting. Once you get the indication that the broadcast was successful, click Finished and the Broadcast dialog closes.
    Note: A popup also appears in the lower right corner of your screen indicating that new apps are available.
  4. Click Finished and your app is now mastered with the prefetch information included.
  5. Note: The files created have the file extensions of .aw, .app, and .stp and are placed in the C:\<xxx>\<user>\Embarcadero\AppWaveStudio\Output folder
  6. Once the file is saved, the Broadcast dialog appears.This dialog tracks the process of the broadcasting. Once you get the indication that the broadcast was successful, click Finished and the Broadcast dialog closes.
  7. Click Finished and your app is now mastered with the prefetch information included.
  8. Note: The files created have the file extensions of .aw, .app, and .stp and are placed in the C:\<xxx>/<user>\Embarcadero\AppWaveStudio\Output folder .
  9. A popup also appears in the lower right corner of your screen indicating that new Apps are available.

Messages:

  • If an .stp file already exists for the app you want to broadcast you get a message similar to the following message:

Warning duplicatestp.png

  • If you try to broadcast an app that has the same name, version, and edition of an existing App, you get the following message:

Warning unabletodeploy.png

Caution: During mastering, extra services related to the app you are mastering may be launched. At the end of the mastering process, Studio will attempt to shutdown any services it detects, but in some cases Studio cannot detect those services and you must shut them down manually before broadcasting the App.

For more information on this step, see: Broadcast your Application to AppWave

Using the App

  1. Once you have created the app using AppWave Studio, it is available on the AppWave Browser.
  2. Click Apps and select the AppWave folder.
  3. During the Broadcast process, if a folder doesn’t already exist, a folder with your user name (for example “embarcadero.comkathyb’s Folder”) is created in the AppWave folder.
  4. Tip: If your folder does not appear you may need to reconnect to the AppWave Browser by clicking Gear.png > Connect.
  5. After your app is broadcast, the newly mastered app is placed in a working folder, usually the <user_name> folder. You can see an indicator New App Indicator.png.
  6. Note: The app runs a little faster if it has first been downloaded to your local disk.
  7. Click Add to start the App.
  8. Note: For more information on the Apps portion of the App, please see Using AppWave Browser.

See Also