Product & Suite Build Configuration Properties

InstallShield 11 Universal

The properties of Product and [Dynamic] Suite Build Configurations determine the name of the archive file, what type of archive should be built (for example, JAR file, directory, CDROM, etc.), the Build Categories that should be excluded, and the location to where the archive should be saved. You can also change the UUID of the software objects in your project just for this build configuration's output.

You can add as many build configurations as you need to the same project to suit different installation needs—you select which build configuration to use to build your project before you click Build.

Note

In order for the Universal Installer or Dynamic Suite installation payload to be spanned across multiple media, the build configuration's Archive Type Info property must be set to either "Custom Size Archive" or "CDROM Archive."

The following descriptions and instructions are for setting the Standard and Advanced properties of Product and Suite Build Configurations.

Standard Properties

Property Description
Output Directory Specify the location to which you want the built project saved. Either type the location in this field, or click the ellipsis ("...") and browse to the location. A path variable can also be used.

Note

All build output of goes into the <outputDirectory>/disk1 directory regardless of whether media spanning is required.

Archive Name Specify the name of the file or directory to create. Typically, ZIP-compatible archives are named with the .jar extension, while directory archives do not have an extension. A path variable can also be used for this property.
Archive Type Info Universal supports four types of archives. Click the ellipsis ("...") and select one of the following types that most appropriately fits the needs of this configuration:
  • Directory Archive—This type of archive creates a directory structure that can be used to run the installation. It does not compress the files. Directories are used most frequently for CD or file system-based installations because they enable direct access to the contents of the installation. However, they offer minor performance advantages over JAR archives.
  • Single JAR Archive—Also known as a "ZIP® Archive," this type of archive is the most common. A JAR file can be distributed as a single file because it compresses all of the files at build time except for those that are specified to be built outside of the archive. This archive type is the only archive type supported by Universal installation launchers. Also, if the product you will install with this project is a Java application, then this is the type of Archive Type Info you should select.

    Note

    If the following message is received, it is usually because the installation is a single JAR archive, but it is located in the / (root) directory when it runs:

    Insert Media #1
    If this message is received and your installation does not span multiple media, then the installation process must be killed using <Ctrl+C> or the kill command for that platform. The installation archive must then be moved to a directory other than root, and it must be reinstalled.

  • Custom Size Archive—This type of archive enables you to specify the amount of data that should be written to a each CD when media spanning is required for the installation, that is, when the size of the installation exceeds the storage space on one piece of media. It is also used when you will distribute the installation on DVD(s) so that you can set the media and block sizes for DVDs. When this type of archive is selected, the following additional properties become available to be set (see below for an additional property):
    • Media Size—The total size in bytes on the media. For example, a CD-ROM has 681984000 bytes of available space, which is the default value for this property.
    • Block Size—The byte size for each block of data on the media. A file stored to the media always takes up a size that is a multiple of this number. For example:
      • A CD-ROM has a Block Size of 2048 bytes (the default value for this property). A stored file of 1048 bytes (which is the Media Size of the file), would require one block (1 x 2048, which is 2048 bytes) because the byte size of the file is less than the number of bytes in one block.
      • A file that is larger in bytes than the byte size of one block would require a multiple of blocks. Therefore, a stored file of 2056 bytes would require two blocks (2 x 2048), which would be 4096 bytes.
  • CDROM Archive—This type of archive creates a CDROM installation, which can utilize media spanning when the size of the installation exceeds the storage space on one CD. The amount of data written to each CD cannot, however, be specified as it can be in Custom Size Archive (see below for an additional property).
Note

Custom Size Archive and CDROM Archive include an additional property called Assemblies Folder (for Dynamic Suite Installers in Premier only). To set this property, specify or browse to the folder where the built assemblies' directory structures are located so that they can be referenced by the suite and included at build time. For example, to include all of your assemblies in the building of this suite, set the Assemblies Folder property to $A(IS_HOME)/assemblygallery. To only include specific assemblies, copy their directory structures to a common directory, then specify that common directory here. You cannot add assembly directory structures to a Dynamic Suite Installer once it has been built with the Archive Type Info property set to either Custom Size Archive or CDROM Archive.

Advanced Properties

  • Click OK. The Software Object Key Overrides property is now set to "Use key overrides."
  • then the build directory would look something like this:
    default/disk1/product/data/src/setup.jar

    Notes

    Property Description
    Build Category Filter This property enables you to specify the build category(ies) to exclude when you build this project using this build configuration. Those software objects that are set with the build category(ies) specified will not be included in the build.
    Comments
    (Premier Only)
    This optional property enables you to specify comments about this action. These comments are stored in the project file and are for your use only. They are ignored at run time.
    Software Object Key Overrides This optional property enables you to specify new UUIDs for all of the software objects in your project (the root product, features, and components).

    Note

    This property does not apply to the referenced products in a Static Suite Installer.

    These UUIDs are stored only with this build configuration—the UUIDs that are set for each of these objects in the Installation Design view are not altered. This enables you, for example, to create and manage different tiers of your product in conjunction with the Build Category Filter property—the Express tier's software objects would have different UUIDs from the Professional tier's software objects, and so on.

    The default value of this property is "Use default keys," which means that the original UUIDs assigned to each software object in the Installation Design view will be used when this project is built with this build configuration.

    Procedures

    To use different UUIDs when building with this build configuration:

    1. Click the ellipsis ("..."), and the Software Object Keys dialog box opens.

      Tip

      To reset the UUID for all of the software objects in your project, click Generate All New UUIDs in the right side of the dialog box. Then click OK and skip the rest of these steps.

    2. In the left side of the dialog box, select the software object for which you want to set a new UUID.
      1. Select the Software Object UUID field, then right-click and select Generate UUID. Universal will generate a unique UUID for the selected object.

        --OR--

        1. In the right side of the dialog box, double-click the Software Object UUID field, and the field becomes editable.
        2. Double-click the field again, and the UUID becomes highlighted.
        3. Type the new, maximum 32-character, alphanumeric UUID with no spaces. The only non-alphanumeric character you can use is the underscore ("_").
        4. Press Enter to save the new UUID.
    3. Click OK. The Software Object Key Overrides property is now set to "Use key overrides."
    External Resource Location
    (Universal & RPM Installer Projects Only)
    Specify the relative directory to which all of the external resources should be written at build time. The specified directory will be created relative to the location of the built project. Leave this property blank if the external resources should be located in the same directory as the built project, or if you have no external resources to include in this configuration.

    For example, if you set up your project as follows:

    • The Output Directory of the build configuration is "default"
    • The External Resource Location build configuration property is "product/data"
    • You are installing a Files action with its
      • Stored As property set to "External Resources,"
      • Resource Location set to "src"
      • Resource ID set to "1"
    then the build directory would look something like this:
    default/disk1/product/data/src/setup.jar

    Notes

    • All build output goes into <specifiedOutputDirectory>/disk1 regardless of whether media spanning is required.
    • In custom beans, if the putExternalResource method is called in the build method of the bean, then that resource is stored in the same manner as the Files action example above. The location of the external resource will be relative to the Resource Location specified here in the Product Build Configuration.

    Include Assemblies
    (Universal Installer Projects/Premier Only)
    This property contains all of the assemblies that were selected to be referenced by this project in the Installation Design/Assemblies view. You also indicated in the assembly's Source property whether the assembly should be included in this build configuration. This property is for you to add any additional assemblies that are required by this product.

    Click the ellipsis ("...") and the List of Values dialog box opens. For each assembly reference you want to add to this build configuration, click Add and type the absolute path to the assembly.

    For example:

    • If a feature requires an assembly that is not referenced by this project, then you would add it here.
    • If this project is installing an add-on to a product that is already installed on the target machine, it requires that the product be present in order for this installation to succeed. You would add the path to that required product here. If the product is not found on the target machine, the installation fails, and an error message displays advising of the unresolved dependency.
    Generate Manifest Select whether you want the build output of this build configuration to include the creation of a manifest.xml file. This file contains detailed information about the assembly, and is presented in XML format. This file is for your administrative use only. The default value of this property is "False."

    See Also