Revenera

https://docs.revenera.com
Admin
Revenera provides comprehensive documentation for its software monetization, software supply chain,...
Tokens:457,999
Snippets:4,531
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### Code Insight Quick Start Guide

Source: https://docs.revenera.com/index_product=Revenera+SCA+-+Code+Insight&version=2025+R4

Quick start guides for different versions of Code Insight, designed to help users get up and running quickly. These guides provide essential information for initial setup and basic usage.

```text
Code Insight 2020 R4 Quick Start Guide
Code Insight 2020 R3 Quick Start Guide
Code Insight 2020 R2 Quick Start Guide
Code Insight 2020 R1 Quick Start Guide
Code Insight 2019 R4 Quick Start Guide
Code Insight 2019 R3 Quick Start Guide
Code Insight 2019 R2 Quick Start Guide
Code Insight 2019 R1 Quick Start Guide
Code Insight 2018 R4 Quick Start Guide
Code Insight 6.14.2 Quick Start Guide
Code Insight 6.14.1 Quick Start Guide
Code Insight 6.14.0 Quick Start Guide
Code Insight 6.13.3 Quick Start Guide
Code Insight 6.13.2 Quick Start Guide
Code Insight 6.13.1 Quick Start Guide
Code Insight 6.13.0 Quick Start Guide
Code Insight 6.12.3 Quick Start Guide
Code Insight 6.14.2 SP2 Quick Start Guide
Code Insight 6.14.2 SP1 Quick Start Guide
```

--------------------------------

### FlexNet Operations Installation and Implementation Guides

Source: https://docs.revenera.com/index_product=FlexNet+Operations+On+Premises&version=2025+R1

Guides for installing and implementing FlexNet Operations on premises. These documents provide step-by-step instructions for setting up the software.

```APIDOC
## FlexNet Operations Installation and Implementation Guide

### Description
Provides detailed instructions for the installation and implementation of FlexNet Operations on premises. Covers prerequisites, setup procedures, and initial configuration.

### Method
N/A (Documentation Reference)

### Endpoint
N/A (Documentation Reference)

### Parameters
N/A (Documentation Reference)

### Request Example
N/A (Documentation Reference)

### Response
N/A (Documentation Reference)
```

--------------------------------

### Code Insight Installation and Configuration Guide

Source: https://docs.revenera.com/index_product=Revenera+SCA+-+Code+Insight&version=2025+R4

Guides detailing the installation and configuration process for different versions of Code Insight. These documents are essential for setting up and customizing the Code Insight environment.

```text
Code Insight 2020 R3 Installation and Configuration Guide
Code Insight 2020 R2 Installation and Configuration Guide
Code Insight 2020 R1 Installation and Configuration Guide
Code Insight 2019 R4 Installation and Configuration Guide
Code Insight 2019 R3 Installation and Configuration Guide
Code Insight 2019 R2 Installation and Configuration Guide
Code Insight 2019 R1 Installation and Configuration Guide
Code Insight 2018 R4 Installation and Configuration Guide
Code Insight 6.14.2 Installation and System Administration Guide
Code Insight 6.14.1 Installation and System Administration Guide
Code Insight 6.14.0 Installation and System Administration Guide
Code Insight 6.13.3 Installation and System Administration Guide
Code Insight 6.13.2 Installation and System Administration Guide
Code Insight 6.13.1 Installation and System Administration Guide
Code Insight 6.13.0 Installation and System Administration Guide
Code Insight 6.12.3 Installation and System Administration Guide
Code Insight 6.14.2 SP2 Installation & Administration Guide
Code Insight 6.14.2 SP1 Installation & Administration Guide
```

--------------------------------

### Get Installer Install Bundles Java

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallerResources

Returns a vector of strings naming all install bundles (components) whose rules currently evaluate to true. Similar to `getInstallSets()`, providing a bundle name to `setChosenInstallBundles` will lead to its installation. This aids in programmatically selecting product components.

```java
java.util.Vector getInstallBundles()

```

--------------------------------

### Get Install Bundle Short Names - InstallerResources

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Retrieves a list of **short** names for installable components whose rules currently evaluate to true. This is an alternative to getInstallBundles() for simpler identifiers.

```Java
getInstallBundleShortNames() - Method in interface com.zerog.ia.api.pub.InstallerResources
    
    Returns a vector of Strings that describe the **short** names of all install bundles (components) whose rules currently evaluate to true.
```

--------------------------------

### Get Install Bundles - InstallerResources

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Retrieves a list of installable component names whose rules currently evaluate to true. This method is crucial for dynamic component selection during installation.

```Java
getInstallBundles() - Method in interface com.zerog.ia.api.pub.InstallerResources

    
    Returns a vector of Strings that describe the names of all install bundles (components) whose rules currently evaluate to true.
```

--------------------------------

### Get Installer Log Output as DataOutput

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallerAccess

This method returns an instance that implements java.io.DataOutput, allowing data to be written during the installation process. Information written to this instance will be accessible at uninstall-time.

```java
java.io.DataOutput getLogOutput()
```

--------------------------------

### Controlling Installer Navigation Buttons

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/GUIAccess

Methods for programmatically controlling the visibility and enabled state of the 'Next', 'Previous', and 'Exit' buttons in the installer. These methods are crucial for guiding the user through the installation flow.

```Java
void goNext();
void goPrevious();
void setExitButtonEnabled(boolean b);
void setExitButtonVisible(boolean visible);
void setNextButtonEnabled(boolean enabled);
void setNextButtonVisible(boolean visible);
void setPreviousButtonEnabled(boolean b);
void setPreviousButtonVisible(boolean visible);
```

--------------------------------

### InstallShield InstallScript Reference Guide

Source: https://docs.revenera.com/index_product=InstallShield

Contains comprehensive details on the InstallScript language used within InstallShield. This guide is vital for creating and customizing installation scripts.

```InstallScript
InstallScript Reference Guide
```

--------------------------------

### Example Implementation of CancelButtonHandler

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/CancelButtonHandler

This example demonstrates how to implement the CancelButtonHandler interface. The `installCancelled` method is overridden to set a flag that stops the ongoing `install` method's loop.

```APIDOC
## Example Implementation of CancelButtonHandler

### Description
This example shows a concrete implementation of the `CancelButtonHandler` interface. The `InstallCancelAction` class extends `CustomCodeAction` and implements `CancelButtonHandler`. The `installCancelled` method is overridden to interrupt the `install` method's execution.

### Method

- `installCancelled(InstallerProxy installer)`: Sets `allDone` to `false` to signal the `install` method to stop its execution loop.

### Request Body
N/A for this interface implementation example.

### Response
N/A for this interface implementation example.

### Code Example
```java
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;

import com.zerog.ia.api.pub.CancelButtonHandler;
import com.zerog.ia.api.pub.CustomCodeAction;
import com.zerog.ia.api.pub.InstallException;
import com.zerog.ia.api.pub.InstallerProxy;
import com.zerog.ia.api.pub.UninstallerProxy;

public class InstallCancelAction extends CustomCodeAction implements CancelButtonHandler {
    private boolean allDone = true;

    public void install(InstallerProxy proxy) throws InstallException {
        while (allDone) {
            System.out.println("Customcode execution in progress...");
            try {
                Thread.sleep(2000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }
    }

    public void installCancelled(InstallerProxy installer) throws InstallException {
        System.out.println("*********** In the CANCEL BUTTON handler **************");
        System.out.println("Execution of custom code interrupted. Stopping the custom code");
        allDone = false;
    }

    public void uninstall(UninstallerProxy uninstallerproxy) throws InstallException {
        // Implementation for uninstall if needed
    }

    public String getInstallStatusMessage() {
        return null;
    }

    public String getUninstallStatusMessage() {
        return null;
    }

    // TODO: Add other required methods
}
```
```

--------------------------------

### Get Install Bundle Short Names Java

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallerResources

Retrieves a vector of strings containing the short names of all install bundles (components) that satisfy their associated rules. This method provides a concise way to reference installable components.

```java
java.util.Vector getInstallBundleShortNames()

```

--------------------------------

### Usage Intelligence C++ SDK Developer Guide

Source: https://docs.revenera.com/index_product=Revenera+SCA+-+Code+Insight&version=2025+R4

Guides for developing with the Usage Intelligence C++ SDK on Windows, macOS, and Linux. These guides cover the specifics of integrating Usage Intelligence features into C++ applications for different operating systems. They may include API references and usage examples.

```text
Usage Intelligence 5.6.1 C++ for Windows SDK Developer Guide
Usage Intelligence 5.6.0 C++ for macOS SDK Developer Guide
Usage Intelligence 5.6.0 C++ for Linux SDK Developer Guide
Usage Intelligence 5.5.2 C++ for Windows SDK Developer Guide
Usage Intelligence 5.5.2 C++ for macOS SDK Developer Guide
Usage Intelligence 5.5.2 C++ for Linux SDK Developer Guide
```

--------------------------------

### InstallShield InstallScript Debugger User Guide

Source: https://docs.revenera.com/index_product=InstallShield

Explains how to use the InstallScript Debugger provided by InstallShield. This tool is essential for troubleshooting and testing installation scripts.

```text
InstallShield InstallScript Debugger User Guide
```

--------------------------------

### Get Installer Log Output as String

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallerAccess

This method retrieves the previously written installer log data as a String. It's a convenient way to access serialized data when a String representation is sufficient.

```java
java.lang.String getLogOutputAsString()
```

--------------------------------

### Get Software Object by UUID and Install Location

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallShieldUniversalRegistry

Searches the InstallShield Universal registry for a software object matching the provided UUID and installation location.

```APIDOC
## GET /websites/revenera/getSoftwareObject

### Description
Searches the InstallShield Universal registry for a software object matching the provided UUID and installation location.

### Method
GET

### Endpoint
/websites/revenera/getSoftwareObject

### Parameters
#### Query Parameters
- **uuid** (string) - Required - The UUID of the InstallShield Universal installed software.
- **installLocation** (string) - Required - The location where the software object is installed to.

### Response
#### Success Response (200)
- **softwareObject** (InstallShieldUniversalSoftwareObject) - A software object that matched your query, or null if nothing is found.
```

--------------------------------

### Get Log Input - UninstallerAccess and UninstallerProxy

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Provides access to installation log data during uninstallation. This allows for reading information logged at install-time.

```Java
getLogInput() - Method in interface com.zerog.ia.api.pub.UninstallerAccess
    
    Information written to the the log at install-time can be read back using the DataInput returned by this method.
```

```Java
getLogInput() - Method in class com.zerog.ia.api.pub.UninstallerProxy
    
    This method returns an instance that implements java.io.DataInput.
```

--------------------------------

### Get Software Object by UUID, Install Location, Version, and Compare Type

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallShieldUniversalRegistry

Searches the InstallShield Universal registry for a software object matching the provided criteria.

```APIDOC
## GET /websites/revenera/getSoftwareObject

### Description
Searches the InstallShield Universal registry for a software object matching the provided criteria including UUID, install location, version, and comparison type.

### Method
GET

### Endpoint
/websites/revenera/getSoftwareObject

### Parameters
#### Query Parameters
- **uuid** (string) - Required - The UUID of the InstallShield Universal installed software.
- **installLocation** (string) - Required - The location where the software object is installed to.
- **version** (string) - Required - The version of the InstallShield Universal installed software.
- **compareType** (string) - Required - Options are LOWER_THAN, LOWER_THAN_OR_EQUAL_TO, EQUAL_TO, HIGHER_THAN_OR_EQUAL_TO, HIGHER_THAN.

### Response
#### Success Response (200)
- **softwareObject** (InstallShieldUniversalSoftwareObject) - A software object that matched your query, or null if nothing is found.
```

--------------------------------

### Simulate Clicking 'Next' Button in Installation Navigator

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/GUIAccess

This method programmatically simulates the end-user clicking the 'Next' button of the installation navigator. It is useful for automated testing or scripting installation processes. No specific dependencies are mentioned, and it takes no arguments.

```Java
void clickNextButton()
```

--------------------------------

### Usage Intelligence Java SDK Developer Guide

Source: https://docs.revenera.com/index_product=Revenera+SCA+-+Code+Insight&version=2025+R4

This guide focuses on using the Usage Intelligence Java SDK. It provides instructions and examples for developers to integrate Usage Intelligence functionalities into their Java applications, covering aspects like API calls and data reporting.

```text
Usage Intelligence 5.6.1 Java SDK Developer Guide
Usage Intelligence 5.5.2 Java SDK Developer Guide
```

--------------------------------

### Java Code Example for Querying Software Objects

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallShieldUniversal10AndOlderRegistry

Demonstrates how to obtain an InstallShieldUniversal10AndOlderRegistry instance and retrieve software objects. This is typically done through InstallerProxy, CustomCodePanelProxy, or CustomCodeConsoleProxy. The example shows calling getSoftwareObjects with a product code and version.

```java
InstallShieldUniversal10AndOlderRegistry isuReg = (InstallShieldUniversal10AndOlderRegistry)proxy.getService(InstallShieldUniversal10AndOlderRegistry);
InstallShieldUniversalSoftwareObject[] objs = isuReg.getSoftwareObjects("00000000000000000000000000000002", "1.0.0");
```

--------------------------------

### Simulate Clicking 'Previous' Button in Installation Navigator

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/GUIAccess

This method programmatically simulates the end-user clicking the 'Previous' button of the installation navigator. It enables automated control over the installation flow by mimicking user navigation. It requires no arguments and has no explicit dependencies.

```Java
void goPrevious()
```

--------------------------------

### Get Install Status - InstallShieldUniversalSoftwareObject

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Retrieves the installation status of an InstallShield Universal Software Object. This is useful for checking the state of installed components.

```Java
getInstallStatus() - Method in interface com.zerog.ia.api.pub.InstallShieldUniversalSoftwareObject
    
    This method returns the install status of the InstallShield Universal Software Object.
```

--------------------------------

### setup Method Implementation

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/CustomCodeConsoleAction

Instance method called before the ConsoleAction is displayed. It's used for pre-action initialization and must return quickly. Returning false prevents the action from being displayed. Overrides the setup method from the parent InstallConsole class.

```java
public boolean setup()
```

--------------------------------

### Get Install Location - InstallShieldUniversalSoftwareObject

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Returns the installation location for an InstallShield Universal Software Object. This is essential for managing installed software details.

```Java
getInstallLocation() - Method in interface com.zerog.ia.api.pub.InstallShieldUniversalSoftwareObject
    
    This method return the Install Location InstallShield Universal Software Object.
```

--------------------------------

### Go Previous

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/GUIAccess

Simulates the end-user clicking the 'Previous' button within the installation navigator.

```APIDOC
## POST /websites/revenera/navigator/goPrevious

### Description
This method programatically simulates the end-user clicking the "Previous" button of the installation navigator.

### Method
POST

### Endpoint
/websites/revenera/navigator/goPrevious

### Parameters

### Request Body
(No request body required)

### Request Example
(No request body)

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### Get Install Status Message - CustomCodeAction

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Retrieves the status message that will be displayed during the installation of a CustomCodeAction. This is useful for providing user feedback during the installation process.

```Java
getInstallStatusMessage() - Method in class com.zerog.ia.api.pub.CustomCodeAction
    
    If this action is included in the "Install" task of the advanced designer, the string that this method returns will be displayed in the "Installing..." status label that appears above the installer's progress bar while the action is being executed.
```

--------------------------------

### Setup UI Method in CustomCodePanel

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/CustomCodePanel

An abstract method called before the `CustomCodePanel` is displayed. It's used for initializing Panel Components or other necessary objects for the install panel. The `customCodePanelProxy` parameter provides access to required resources.

```java
public abstract boolean setupUI(CustomCodePanelProxy customCodePanelProxy)
```

--------------------------------

### Installer Access Methods

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Methods for retrieving log output from the installer.

```APIDOC
## GET /websites/revenera/installer/log

### Description
Retrieves the installer log output as a `DataOutput` instance or a `String`.

### Method
GET

### Endpoint
/websites/revenera/installer/log

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **logOutput** (`DataOutput` or `String`) - The installer log output.

#### Response Example
```json
{
  "logOutput": "Log data..."
}
```
```

--------------------------------

### Get Install Directory - InstallerResources

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Provides the installation directory path on the target system. This is a convenience method for easily accessing the configured installation location.

```Java
getInstallDirectory() - Method in interface com.zerog.ia.api.pub.InstallerResources
    
    A convenience method to get the install directory for the installer on the target system.
```

--------------------------------

### Solution Install Services Methods

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Methods for accessing solution installation services.

```APIDOC
## GET /websites/revenera/solution/install/packages

### Description
Retrieves the list of packages available for solution installation.

### Method
GET

### Endpoint
/websites/revenera/solution/install/packages

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **packages** (`Array<Object>`) - A list of available packages.

#### Response Example
```json
{
  "packages": [
    { "name": "PackageA", "version": "1.0" },
    { "name": "PackageB", "version": "2.1" }
  ]
}
```
```

--------------------------------

### setupUI

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/CustomCodePanel

Abstract method called before the CustomCodePanel is displayed, used for initializing panel components and other necessary objects.

```APIDOC
## setupUI(CustomCodePanelProxy customCodePanelProxy)

### Description
This method gets called prior to the `CustomCodePanel` being displayed. This is useful for initializing Panel Components or other objects that may be needed by the install panel.

### Method
`public abstract boolean setupUI(CustomCodePanelProxy customCodePanelProxy)`

### Endpoint
N/A (Abstract Method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
* **boolean** - Indicates whether the UI setup was successful.

#### Response Example
```json
{
  "success": true
}
```

### Parameters
* **customCodePanelProxy** (CustomCodePanelProxy) - An instance of `CustomCodePanelProxy` providing access to resources and variables needed for UI initialization.
```

--------------------------------

### Installer Resources and UI Controls

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Methods for managing installer resources, UI elements like labels, text fields, text panes, and file choosers.

```APIDOC
## Installer Resources and UI Controls

### Methods

- **setShortcutDirectory(String)**: A convenience method to set the shortcut directory for the installer on the target system. (Interface: `com.zerog.ia.api.pub.InstallerResources`)
- **setText(String)**: Changes the text of the label. (Class: `com.zerog.ia.api.pub.controls.IALabel`)
- **setText(String)**: Changes the text of the text field. (Class: `com.zerog.ia.api.pub.controls.IATextField`)
- **setText(String)**: Sets the text of this Component. (Class: `com.zerog.ia.api.pub.controls.IATextPane`)
- **setStyledDocument(StyledDocument)**: Associates the editor with a text document. (Class: `com.zerog.ia.api.pub.controls.IATextPane`)
- **setToolTips(boolean)**: Set ToolTipText (Class: `com.zerog.ia.api.pub.controls.IAFileChooser`)
- **setToolTipText(String)**: Set ToolTipText (Class: `com.zerog.ia.api.pub.controls.IAButton`)
- **setToolTipText(String)**: Set ToolTipText (Class: `com.zerog.ia.api.pub.controls.IAChoiceGroup`)
- **setToolTipText(String)**: Set ToolTipText (Class: `com.zerog.ia.api.pub.controls.IALabel`)
- **setToolTipText(String)**: Set ToolTipText (Class: `com.zerog.ia.api.pub.controls.IATextField`)
- **setToolTipText(String)**: Sets tool tip for the component. (Class: `com.zerog.ia.api.pub.controls.IATextPane`)
```

--------------------------------

### Get Start Type from NTServiceConfig (Java)

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/installshield/wizard/platform/win32/win32service/NTServiceConfig

Retrieves the start type assigned to this Windows service configuration. The method returns an integer representing the start type. It is part of the NTServiceConfig class.

```java
public int getStartType()
```

--------------------------------

### Get Installer Service

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/IAProxy

Provides access to InstallAnywhere installer services. The Object returned by this method must be cast to the requested service.

```APIDOC
## Get Installer Service

### Description
Provides access to InstallAnywhere installer services. The Object returned by this method must be cast to the requested service. The returned Object, if the service is available, is guaranteed to implement `requestedServiceClass`.

### Method
GET (Assumed, as it's retrieving a service)

### Endpoint
/websites/revenera/service

### Parameters
#### Query Parameters
- **requestedServiceClass** (java.lang.Class) - Required - A class representing the interface of the service requested.

### Response
#### Success Response (200)
- **serviceInstance** (java.lang.Object) - An instance of the requested service, castable to the `requestedServiceClass`.

### Response Example
```json
{
  "serviceName": "com.installanywhere.service.SomeService"
}
```
```

--------------------------------

### Installer Logging

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallerProxy

Provides methods to access logging output during installation, both as a DataOutput stream and as a String.

```APIDOC
## getLogOutput

### Description
Returns an instance that implements java.io.DataOutput. Information written to this instance will be available at uninstall to the same custom code action via the java.io.DataInput object returned by the `getLogInput()` method. ExecuteCustomCode's run as part of the Pre/Post Install sequences should not write to getLogOutput().

### Method
GET

### Endpoint
N/A (Method call within installer context)

### Parameters
None

### Request Example
```java
DataOutput logOutput = installerAccess.getLogOutput();
logOutput.writeUTF("Installation log message");
```

### Response
#### Success Response (200)
- **java.io.DataOutput** - An object to write log information to.
```

```APIDOC
## getLogOutputAsString

### Description
Returns the `DataOutput` log as a `String`.

### Method
GET

### Endpoint
N/A (Method call within installer context)

### Parameters
None

### Request Example
```java
String logContent = installerAccess.getLogOutputAsString();
System.out.println(logContent);
```

### Response
#### Success Response (200)
- **java.lang.String** - The content of the log output as a String.
```

--------------------------------

### Get Install Sets - InstallerResources

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Retrieves a list of install set (feature) names whose rules currently evaluate to true. This method is used for managing and displaying available installation features.

```Java
getInstallSets() - Method in interface com.zerog.ia.api.pub.InstallerResources
    
    Returns a vector of Strings that describe the names of all install sets (features) whose rules currently evaluate to true.
```

--------------------------------

### File Utility Methods

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Provides documentation for static methods within com.installshield.util.FileUtils and com.installshield.boot.CoreFileUtils for file and byte array comparisons, and file copying operations.

```APIDOC
## compareBytes

### Description
Compares two byte arrays.

### Method
`static`

### Endpoint
`com.installshield.util.FileUtils.compareBytes(byte[], byte[])`

### Parameters
* **byte[]** - The first byte array.
* **byte[]** - The second byte array.

### Response
* **boolean** - True if the byte arrays are identical, false otherwise.

## compareFileNames

### Description
Returns the result of comparing two file names, either case sensitively or case insensitively, depending on the target file system.

### Method
`static`

### Endpoint
`com.installshield.util.FileUtils.compareFileNames(String, String)`

### Parameters
* **String** - The first file name.
* **String** - The second file name.

### Response
* **int** - A negative integer, zero, or a positive integer as the first file name is less than, equal to, or greater than the second file name.

## comparePaths

### Description
Verifies whether two paths are the same taking multiple path separators and folder relocators within the path (i.e., \. and \..) into account.

### Method
`static`

### Endpoint
`com.installshield.boot.CoreFileUtils.comparePaths(String, String)`

### Parameters
* **String** - The first path.
* **String** - The second path.

### Response
* **boolean** - True if the paths are considered the same, false otherwise.

## comparePaths

### Description
Verifies whether or not two paths are the same, taking into account multiple path separators and folder relocators within the path (such as /. and /..).

### Method
`method`

### Endpoint
`com.installshield.wizard.service.file.FileService.comparePaths(String, String)`

### Parameters
* **String** - The first path.
* **String** - The second path.

### Response
* **boolean** - True if the paths are considered the same, false otherwise.

## copy

### Description
Copies the contents of the input stream to the output stream.

### Method
`static`

### Endpoint
`com.installshield.boot.CoreFileUtils.copy(int, InputStream, OutputStream)`

### Parameters
* **int** - An integer flag (specific meaning depends on implementation).
* **InputStream** - The input stream to copy from.
* **OutputStream** - The output stream to copy to.

### Response
* **void**

## copy

### Description
Copies the contents of the input stream to the output stream.

### Method
`static`

### Endpoint
`com.installshield.boot.CoreFileUtils.copy(int, InputStream, OutputStream, int)`

### Parameters
* **int** - An integer flag (specific meaning depends on implementation).
* **InputStream** - The input stream to copy from.
* **OutputStream** - The output stream to copy to.
* **int** - An integer representing the buffer size.

### Response
* **void**

## copy

### Description
Copies the contents of the input stream to the output stream.

### Method
`static`

### Endpoint
`com.installshield.boot.CoreFileUtils.copy(int, InputStream, OutputStream, long)`

### Parameters
* **int** - An integer flag (specific meaning depends on implementation).
* **InputStream** - The input stream to copy from.
* **OutputStream** - The output stream to copy to.
* **long** - A long integer representing the number of bytes to copy.

### Response
* **void**

## copy

### Description
Copies the contents of the input stream to the output stream.

### Method
`static`

### Endpoint
`com.installshield.boot.CoreFileUtils.copy(InputStream, OutputStream)`

### Parameters
* **InputStream** - The input stream to copy from.
* **OutputStream** - The output stream to copy to.

### Response
* **void**
```

--------------------------------

### Get Default Install Set Java

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallerResources

Returns the name of the current default install set (feature). This is the feature that will be installed by default unless otherwise specified. This method helps in identifying the pre-selected feature for installation.

```java
java.lang.String getDefaultInstallSet()

```

--------------------------------

### File and System Service Methods

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Methods for managing symbolic links, system startup commands, and temporary files.

```APIDOC
## File and System Service Methods

### Description
Methods for managing symbolic links, system startup commands, and temporary files.

### Methods

#### removeSymbolicLink
- **Description**: Removes a symbolic link on Unix-based platforms.
- **Interface**: `com.installshield.wizard.service.file.FileService`
- **Parameters**:
  - `String` - The path to the symbolic link to remove.

#### removeSystemStartupCommand
- **Description**: Removes a command from the list of commands that run when the system reboots.
- **Interface**: `com.installshield.wizard.service.system.SystemUtilService`
- **Parameters**:
  - `String` - The command to remove.

#### removeTempFileOwner
- **Description**: Allows a file "owner" to unregister itself.
- **Class**: `com.installshield.util.FileUtils` (Static Method)
- **Parameters**:
  - `TempFileOwner` - The owner to unregister.

#### removeTerminalSeparator
- **Description**: Removes all separators from the end of a path, if present.
- **Class**: `com.installshield.util.FileUtils` (Static Method)
- **Parameters**:
  - `String` - The path to process.

#### resetCurrentTempDir
- **Description**: Resets the current temporary directory.
- **Class**: `com.installshield.boot.CoreFileUtils` (Static Method)
```

--------------------------------

### Product Constructor

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/registry/Product

Initializes a new Product object with comprehensive details including name, unique ID, version, vendor, copyright, URLs, modification date, and features. All parameters are required for instantiation.

```java
public Product(java.lang.String name,
               java.lang.String uniqueID,
               java.lang.String location,
               java.lang.String version,
               Vendor vendor,
               java.lang.String copyright,
               java.lang.String infoURL,
               java.lang.String supportURL,
               java.util.Calendar lastModified,
               Feature[] features)
```

--------------------------------

### Getting Installer Services (Java)

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/CustomCodePanelProxy

Provides access to various InstallAnywhere installer services based on the requested service class.

```java
public Object getService(Class requestedServiceClass)
```

--------------------------------

### Java: Managing System Startup Commands

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/installshield/wizard/service/system/SystemUtilService

Provides methods to manage commands that execute when the system reboots. This includes adding new commands, removing existing ones, and retrieving the list of all scheduled startup commands. These operations are crucial for automated system setup and maintenance.

```java
void addSystemStartupCommand(java.lang.String command);
void removeSystemStartupCommand(java.lang.String command);
java.util.Enumeration systemStartupCommands();
```

--------------------------------

### Get Install Status Message

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/CustomCodeAction

Retrieves the current status message related to the installation process. This method can be used to report or check the status of ongoing installation operations.

```java
public abstract java.lang.String getInstallStatusMessage();
```

--------------------------------

### Get Installation Directory

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallerResources

A convenience method to retrieve the installation directory path on the target system. This is equivalent to substituting the '$USER_INSTALL_DIR$' variable.

```java
java.lang.String getInstallDirectory()
```

--------------------------------

### InstallerResources API

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Methods for configuring installer resources, including setting the Java Virtual Machine path and list.

```APIDOC
## setJavaVM(String) / InstallerResources

### Description
Instructs the installer to use the system virtual machine described by the provided absolute path as the VM for the LaunchAnywhere executables.

### Method
`setJavaVM`

### Endpoint
N/A (Method within an interface)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **String** (absolute path) - The absolute path to the system virtual machine.

### Request Example
```java
installerResources.setJavaVM("/path/to/java/vm");
```

### Response
#### Success Response (200)
N/A (Method does not return a value)

#### Response Example
None
```

```APIDOC
## setJavaVMList(Vector) / InstallerResources

### Description
Allows the list of VM paths to be set externally to the installer's normal mechanism for gathering and saving paths to system VMs.

### Method
`setJavaVMList`

### Endpoint
N/A (Method within an interface)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **Vector** (list of VM paths) - A vector containing the absolute paths to the system virtual machines.

### Request Example
```java
Vector<String> vmPaths = new Vector<>();
vmPaths.add("/path/to/vm1");
vmPaths.add("/path/to/vm2");
installerResources.setJavaVMList(vmPaths);
```

### Response
#### Success Response (200)
N/A (Method does not return a value)

#### Response Example
None
```

--------------------------------

### Progress API

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Methods for updating installation progress.

```APIDOC
## setPercentComplete(int) / Progress

### Description
Sets the percentage of completion for the installation process.

### Method
`setPercentComplete`

### Endpoint
N/A (Method within an interface)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **int** (percentage) - The current percentage of completion (0-100).

### Request Example
```java
progress.setPercentComplete(50);
```

### Response
#### Success Response (200)
N/A (Method does not return a value)

#### Response Example
None
```

--------------------------------

### Get Installer Font Color - GUIAccess

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Retrieves the standard font color used by the InstallShield installer. This allows for programmatic control over the UI's text color.

```Java
getInstallerFontColor() - Method in interface com.zerog.ia.api.pub.GUIAccess
    
    Gets the Standard Font color of the installer.
```

--------------------------------

### GUI Interaction API

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Methods to programmatically control the installation GUI, such as navigating to the next or previous step.

```APIDOC
## POST /gui/next

### Description
Programmatically simulates the end-user clicking the "Next" button of the installation navigator.

### Method
POST

### Endpoint
/gui/next

### Parameters
(No parameters)

### Request Example
(No request body for POST request)

### Response
#### Success Response (200)
(No specific response body defined, indicates successful action)

## POST /gui/previous

### Description
Programmatically simulates the end-user clicking the "Previous" button of the installation navigator.

### Method
POST

### Endpoint
/gui/previous

### Parameters
(No parameters)

### Request Example
(No request body for POST request)

### Response
#### Success Response (200)
(No specific response body defined, indicates successful action)
```

--------------------------------

### Get Software Object Location - SoftwareObject and SoftwareObjectSearchCriteria

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Retrieves the installation location of a SoftwareObject or the configured location for searching for a SoftwareObject. This is fundamental for managing software installations and queries.

```Java
getLocation() - Method in class com.zerog.ia.api.pub.registry.SoftwareObject
    
    The location where the SoftwareObject is installed in.
```

```Java
getLocation() - Method in class com.zerog.ia.api.pub.registry.SoftwareObjectSearchCriteria
    
    Gets the configured location where the SoftwareObject should be installed in.
```

--------------------------------

### Get Installer Font - GUIAccess

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Retrieves the default font used by the InstallShield installer's user interface. This allows for customization or querying of UI text styles.

```Java
getInstallerFont() - Method in interface com.zerog.ia.api.pub.GUIAccess
    
    Gets the Standard Font of the installer.
```

--------------------------------

### SoftwareObject - Get Location Method (Java)

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/registry/SoftwareObject

Retrieves the installation path of the SoftwareObject. This method returns a string representing the directory where the software is installed.

```java
public java.lang.String getLocation()
```

--------------------------------

### GUI Access API

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Methods for controlling navigation buttons within the installer GUI.

```APIDOC
## setNextButtonEnabled(boolean) / GUIAccess

### Description
Disables or enables the button responsible for advancing to the next installation action or step.

### Method
`setNextButtonEnabled`

### Endpoint
N/A (Method within an interface)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **boolean** (enabled) - `true` to enable the next button, `false` to disable it.

### Request Example
```java
guiAccess.setNextButtonEnabled(true);
```

### Response
#### Success Response (200)
N/A (Method does not return a value)

#### Response Example
None
```

```APIDOC
## setNextButtonVisible(boolean) / GUIAccess

### Description
Shows or hides the button responsible for advancing to the next installation action or step.

### Method
`setNextButtonVisible`

### Endpoint
N/A (Method within an interface)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **boolean** (visible) - `true` to show the next button, `false` to hide it.

### Request Example
```java
guiAccess.setNextButtonVisible(false);
```

### Response
#### Success Response (200)
N/A (Method does not return a value)

#### Response Example
None
```

```APIDOC
## setPreviousButtonEnabled(boolean) / GUIAccess

### Description
Disables or enables the button responsible for returning to the previous installation action or step.

### Method
`setPreviousButtonEnabled`

### Endpoint
N/A (Method within an interface)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **boolean** (enabled) - `true` to enable the previous button, `false` to disable it.

### Request Example
```java
guiAccess.setPreviousButtonEnabled(true);
```

### Response
#### Success Response (200)
N/A (Method does not return a value)

#### Response Example
None
```

```APIDOC
## setPreviousButtonVisible(boolean) / GUIAccess

### Description
Shows or hides the button responsible for returning to the previous installation action or step.

### Method
`setPreviousButtonVisible`

### Endpoint
N/A (Method within an interface)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **boolean** (visible) - `true` to show the previous button, `false` to hide it.

### Request Example
```java
guiAccess.setPreviousButtonVisible(false);
```

### Response
#### Success Response (200)
N/A (Method does not return a value)

#### Response Example
None
```

--------------------------------

### Custom Code Panel Setup and Display Methods

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/CustomCodePanel

This section covers the core methods for setting up the UI, controlling panel display, and handling user navigation within a custom code panel.

```APIDOC
## setupUI(CustomCodePanelProxy customCodePanelProxy)

### Description
This method is called each time a Custom Code Panel is revisited or when the installer verifies if an install phase contains viewable panels. It should return quickly to ensure the panel displays promptly. Lengthy operations should be performed in a separate thread. If this method returns false, the installation manager will not call any other methods in `CustomCodePanel`.

### Method
* `setupUI` (from `com.zerog.ia.api.priv.InstallPanelInterface` and `com.zerog.ia.api.priv.InstallPanel`)

### Parameters
* **customCodePanelProxy** (`CustomCodePanelProxy`) - Provides access to designer-specified resources, system and user-defined variables, and international resources.

### Returns
* `true` if the Panel should be displayed, `false` otherwise. Defaults to `false`.

### See Also
* `CustomCodePanelProxy`
* `panelIsDisplayed()`

## panelIsDisplayed()

### Description
This method is called immediately after the Panel has been displayed. It's useful for performing additional processing without waiting for the `okToContinue()` method. This method will not be called if `setupUI()` returns `false`.

### Method
* `panelIsDisplayed` (overrides `com.zerog.ia.api.priv.InstallPanel.panelIsDisplayed`, specified by `com.zerog.ia.api.priv.InstallPanelInterface`)

### Returns
* `void`

### See Also
* `setupUI(CustomCodePanelProxy)`
* `okToContinue()`
* `okToGoPrevious()`

## okToContinue()

### Description
This method is called before the installer proceeds to the next step, typically when the user clicks the "Next" button. It is not called if `setupUI()` returns `false`. Subclasses can override this to perform runtime checks.

### Method
* `okToContinue` (overrides `com.zerog.ia.api.priv.InstallPanel.okToContinue`, specified by `com.zerog.ia.api.priv.InstallPanelInterface`)

### Returns
* `true` if it is okay to continue, `false` otherwise. Defaults to `true`.

### See Also
* `okToGoPrevious()`
* `GUIAccess.setNextButtonEnabled(boolean)`

## okToGoPrevious()

### Description
This method is called before the installer returns to a previous step, typically when the user clicks the "Previous" button. It is not called if `setupUI()` returns `false`. Subclasses can override this to perform runtime checks.

### Method
* `okToGoPrevious` (overrides `com.zerog.ia.api.priv.InstallPanel.okToGoPrevious`, specified by `com.zerog.ia.api.priv.InstallPanelInterface`)

### Returns
* `true` if it is okay to return to a previous step, `false` otherwise. Defaults to `true`.

### See Also
* `okToContinue()`
* `GUIAccess.setPreviousButtonEnabled(boolean)`

## getTitle()

### Description
This method returns the String to be displayed as the title of the installation step containing this Panel. By default, it returns an empty String. Classes extending `CustomCodeConsoleAction` can override this to provide a title.

### Method
* `getTitle` (specified by `com.zerog.ia.api.priv.InstallPanelInterface`)

### Returns
* `java.lang.String` - The title to be displayed.

```

--------------------------------

### Get Installer Install Sets Java

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallerResources

Retrieves a vector of strings representing the names of all install sets (features) whose rules currently evaluate to true. Passing a name from this vector to `setChosenInstallSet` will cause that feature to be installed. This method is essential for understanding available features before selection.

```java
java.util.Vector getInstallSets()

```

--------------------------------

### Click Next Button

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/GUIAccess

Simulates the end-user clicking the 'Next' button within the installation navigator.

```APIDOC
## POST /websites/revenera/navigator/clickNext

### Description
This method programatically simulates the end-user clicking the "Next" button of the installation navigator.

### Method
POST

### Endpoint
/websites/revenera/navigator/clickNext

### Parameters

### Request Body
(No request body required)

### Request Example
(No request body)

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### Configure NTServiceConfig: Set Start Type

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/installshield/wizard/platform/win32/win32service/NTServiceConfig

Sets how the service is started. Options include automatic start, boot start, demand start, or disabled.

```java
void setStartType(int startType)
```

--------------------------------

### InstallAnywhere InstallerResources Interface Definition (Java)

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallerResources

Defines the InstallerResources interface for InstallAnywhere, providing methods to manage installer resources, install sets, bundles, and JRE configurations. It includes methods for getting and setting various installer properties.

```Java
public interface InstallerResources
```

--------------------------------

### FileService Interface Methods

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/index-all

Methods for managing files and directories within the InstallShield wizard environment.

```APIDOC
## deleteDirectory

### Description
Deletes a directory. This method is useful for developers creating custom beans.

### Method
`void deleteDirectory(String directoryPath)`

### Endpoint
N/A (Interface method)

### Parameters
*   **directoryPath** (String) - The path to the directory to delete.

### Request Example
N/A

### Response
N/A

---

## deleteDirectory

### Description
Deletes a directory with options for handling deferred deletion and cleanup. Useful for developers creating custom beans.

### Method
`void deleteDirectory(String directoryPath, boolean defer, boolean cleanup)`

### Endpoint
N/A (Interface method)

### Parameters
*   **directoryPath** (String) - The path to the directory to delete.
*   **defer** (boolean) - If true, the deletion will be deferred.
*   **cleanup** (boolean) - If true, cleanup operations will be performed.

### Request Example
N/A

### Response
N/A

---

## deleteFile

### Description
Deletes a file. This method is useful for developers creating custom beans.

### Method
`void deleteFile(String filePath)`

### Endpoint
N/A (Interface method)

### Parameters
*   **filePath** (String) - The path to the file to delete.

### Request Example
N/A

### Response
N/A

### Constants
*   **DEFERRED** (int) - The constant used with `deleteFile` when delete is deferred.
```

--------------------------------

### Code Insight Product Documentation

Source: https://docs.revenera.com/index_product=FlexNet+Operations+On+Premises&version=2025+R1

Documentation for Code Insight, specifically release notes, installation and configuration guides, user guides, and plugins guides for version 2025 R4. This assists users in setting up and utilizing Code Insight.

```text
Code Insight 2025 R4 Release Notes
Code Insight 2025 R4 Installation and Configuration Guide
Code Insight 2025 R4 User Guide
Code Insight 2025 R4 Plugins Guide
```

--------------------------------

### Get Install Location of InstallShield Software Object

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallShieldUniversalSoftwareObject

Retrieves the installation directory for the InstallShield Universal Software Object. This method is crucial for locating the software's files on the system. It returns a String representing the absolute path to the installation.

```java
java.lang.String getInstallLocation()
```

--------------------------------

### Prototyping SetDllDirectoryW for DLL Search Path Control (InstallScript)

Source: https://docs.revenera.com/installshield25helplib/rn/ReleaseNotes

Demonstrates how to prototype the SetDllDirectoryW Windows API function in InstallScript to include SUPPORTDIR in the DLL load search path. This is a workaround for security changes that remove the current directory from the search path.

```InstallScript
prototype kernel32.SetDllDirectoryW(wstring);
// ...
SetDllDirectoryW(SUPPORTDIR);
```

--------------------------------

### Set Description for Installation Action

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/CustomError

Provides a mechanism to describe the action that is reporting status in the installation log. This description will be visible in the log even if no errors occur.

```java
void setLogDescription(java.lang.String description)
```

--------------------------------

### Reverting to Previous Version: Starting Application

Source: https://docs.revenera.com/fnci6133/rn/ReleaseNotes_6.13.3

This snippet demonstrates how to start the previous version of the FlexNet Code Insight application, specifically the Tomcat server. It includes commands to start the server and tail the catalina.out log file for monitoring. This is for multi-server installs after completing previous steps on all servers.

```shell
cd $OLD_DIR/tomcat/bin
./startup.sh && tail - f ../logs/catalina.out
```

--------------------------------

### Enabling SUPPORTDIR in DLL Search Path (InstallScript)

Source: https://docs.revenera.com/installshield25helplib/rn/ReleaseNotes

Shows how to use the DLL_DIRECTORY_SUPPORTDIR constant with the Enable function in InstallScript. This explicitly opts-in to using SUPPORTDIR as part of the DLL directory search path.

```InstallScript
// Assuming 'Enable' is a function that accepts this constant
Enable(DLL_DIRECTORY_SUPPORTDIR);
```

--------------------------------

### Get Bundled JRE Status Java

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallerResources

Returns an integer indicating the installer's status regarding the bundled Java Runtime Environment (JRE). The return value corresponds to predefined constants, such as `CAN_NOT_INSTALL_JRE`, signifying whether the installer can or cannot install a bundled JRE.

```java
int getBundledJREStatus()

```

--------------------------------

### Get InstallShield Object Install Status

Source: https://docs.revenera.com/InstallAnywhere%20API/javadoc/com/zerog/ia/api/pub/InstallShieldUniversalSoftwareObject

Retrieves the current installation status of the InstallShield Universal Software Object. This method returns an integer code representing the status.

```Java
int getInstallStatus()
```
Tokens:
Raw