Deploying the custom code-based applications to development environments


BMC Helix Innovation Studio enables you to deploy the custom code-based applications. After you customize an application, you must create a deployment package, that contains all definitions, data, and code required by the application or library, and deploy the package to BMC Helix Innovation Studio. This capability enables you to move application customization and data across environments quickly and easily.

Before you begin

Make sure that you create a deployment package of the custom code-based application, so that you can deploy the custom application and data to development environments.

To create a deployment package

When you create a deployment package, the application definitions and data are exported from the BMC Helix Innovation Studio server to a deployment package.

To create a deployment package, perform the following tasks:

  1. On the command prompt, navigate to the application's parent project directory. 
    For example:

    \projects> cd suggestion-box
  2. Run the following command:

    mvn install -Pexport  

    For example:

    \projects\suggestion-box> mvn install -Pexport  

The deployment package that contains the project source code is created as a ZIP file at the target directory of the project. For example, \projects\suggestion-box\package\target\com.example.suggestion-box-1.0.0.SHAPSHOT.zip file. 
The application definitions and data are exported to the ZIP file, which contains a db folder and all individual object definition files. For example, \projects\<application name>\package\target\db folder.
All individual object definition files are available in the following folders:

  • association
  • configuration
  • named-list
  • process
  • record
  • rule
  • view

Important

When you export the definitions and data to a deployment package, if there is an existing db folder, the new db folder overwrites the data of the existing db folder.

To set a preferred Home page for an application

When users log in, an application opens the first menu item on the navigation bar by default. However, this behavior can be customized to navigate users to a preferred Home page after login by following these steps: 

  1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab.
  2. Select Application management > Application settings.
  3. Select the required Application ID from the list or click New to create new application settings.
  4. In the Edit application settings window, specify the following information:

    Field name

    Description

    Example

    Application ID

    Enter your Application ID

    image-2025-1-28_15-20-54.png

    Display Name

    Enter a name for your application; this name will appear on the Navigation bar.

    Home page path

    You can copy the home page path directly from the browser's address bar after navigating to the desired view.

    The home page path may include view input parameters and follow the format: view/<view definition name>?<view input parameters>.

    Example: view/com.example.demoapplication::My%20Home%20Page?param1=foo&param2=bar

    Show in application launcher

    Select the button to list your application in Application launcher application_launcher.png.


To deploy code-based applications

After you create deployment package for a custom code-based application or library, you can deploy the deployment package to BMC Helix Innovation Studio.

To deploy a package to the same environment, perform the following tasks:

  1. On the command prompt, navigate to the application's parent project directory. 
    For example:

    \projects> cd suggestion-box
  2. Run the following command:

    mvn clean install -Pdeploy

    For example:

    \projects\suggestion-box> mvn clean install -Pdeploy

The deployment package that contains all definitions, data, and code required by an application or a library, is deployed to BMC Helix Innovation Studio. After an application is deployed, only the application developer and an administrator can view the application.

Important

The administrator can use the containerrolepermission REST API to provide access to users as well as remove access from specific users for any licensed application. 

For information about the containerrolepermission REST API, see Platform REST API documentation.

To undeploy code-based applications

On the command prompt, navigate to the application parent directory and run the following command:

mvn com.bmc.arsys:rx-sdk-maven-plugin:undeploy -N

For example:

\projects\suggestion-box> mvn com.bmc.arsys:rx-sdk-maven-plugin:undeploy -N