This documentation supports the 23.3 version of BMC Helix Innovation Suite (AR System and BMC Helix Innovation Studio).

To view an earlier version, select the version from the Product version menu.

Creating a Project using Maven and the Archetype

Bundle development involves the development of an application or a library. All the code for an application or a library is packaged and deployed as a deployment package. A bundle has a project structure in the development environment. 


  • Use the developer account to develop an application or library.
  • A developer account is set with an administrator role. The developer account does not require the domain identifier to log in. You can log in to BMC Helix Innovation Studio with just the user name without the domain.

The following video (5:41) provides details to create a Maven project using BMC Helix Innovation Studio SDK and Integrated Development Environment (IDE) and deploying the project to your system.

The video shows an older version of BMC Helix Innovation Studio. Although there might be minor changes in the UI, the overall functionality remains the same.

To create a new project

To create a new application project or library project, use the Maven archetype with the BMC Helix Innovation Studio SDK. For your projects, decide where you want your project code to reside. We recommend that you do not place the project code at the BMC Helix Innovation Studio SDK location. For example, create a new project in the root directory.

  1. At the command prompt, navigate to the directory to create a project.
    For example, C:\projects
  2. Run the following command to create a project for application development or library development:

    mvn archetype:generate -DarchetypeGroupId=com.bmc.arsys -DarchetypeArtifactId=rx-sdk-archetype-application -DarchetypeCatalog=local

    The following table defines the arguments:

    Archetype argumentDescription


    Maven uses BMC archetypes.


    This argument sets the POM file to create an application package and generates a working UI.


    This argument uses only the local catalog.

    For more information about the Maven archetype, see Maven archetype plugin Open link in the Maven documentation.
    The command starts the archetype plugin in interactive mode and prompts for the property values. 

  3. Enter the values for the following properties:

    PropertyDescriptionSample values for application developmentSample values for library development

    Project group ID. The ID usually follows the naming conventions of Java package names.

    Important: You must provide the Developer ID as the groupID value.

    Warning: The com.bmc namespace is reserved for Lines of Business and BMC-specific bundles. Make sure that you do not use this namespace as your groupId.


    Project ID that is used as a part of the file name. It usually has a short name as the project is already in the namespace by the groupId.


    The artifactId cannot be a combination of:

    '-' (hyphen) and numeric character. For example, work-order-lib-12 is not a valid artifactId.

    Uppercase and lowercase letters. For example, Work-Order-Lib is not a valid artifactId.

    For more information, see Naming conventions Open link in the Apache Maven documentation.


    Project version. You must provide the value in the following format:

    <major version>.<minor version>.<incremental version>-<qualifier>

    See Version number rules Open link in the Maven documentation and Releasing a version of your bundle.


    Default Java package for the project. The default value is groupId value.

    isApplicationFlag to decide if you want to create an application or a library.truefalse

    Friendly name of the bundle. This name is used by the archetype to display the name of the application on the login page and in the BMC Helix Innovation Studio.

    Suggestion BoxWork Order

    Flag to skip UI code generation.

    If the UI code generation is skipped, the Angular UI project is not generated, and you cannot create custom UI elements like Actions or View Components.

    This flag is useful if the application or library only contains custom java elements.


  4. Confirm the configuration of all the properties.

  5. If any third-party dependencies exist, add the third-party dependencies.
    See Using code from open-source v22.1.

To set up the development server environment properties in the project pom.xml file

After you create the application (or library) project, you must modify the user credentials in the project pom.xml file.  

  1. Open the parent pom.xml file located in project folder; for example, projects\work-order-lib\pom.xml.
  2. Modify the properties section that specifies the environment information provided with your Development Server instance.

    <!-- START: Bundle specific configuration. Verify and Change as per environment -->
       <!-- Server name with Jetty port. -->
    <!-- END: Bundle specific configuration.-->

    The following table lists the properties in the pom.xml file:

    Property nameDescription
    Application developer that you create while requesting a sandbox.
    Application developer password.

    Value of this property determines the application development mode.

    Valid values:

    0—Base Development Mode.

    1—(Default) Best Practice Customization Mode

    We recommend that you use Best Practice Customization Mode for developing your application.

    When you deploy the application for the first time, the overlayMode property determines how the application is deployed.

    If you develop the application in Base Development Mode (value 0), it is deployed in the Base Development Mode. Similarly, if you develop the application in the Best Practice Customization Mode (value 1), the application is deployed in the Best Practice Customization Mode.

    For more information, see the Customization layer.

    webUrl of your sandbox. 
    For example:<8008>
  3. Save the changes.

To set up dependencies that are needed for your bundle

The dependencies on the other bundles are declared in the bundle\pom.xml file. Use the following content for the rx-sdk.bundledependencies tag:

The syntax is bundleid;version. Use commas to separate each bundle.

		<!-- Comma separated Bundle Dependencies with version.  -->

Projects created by the archetype

The Maven archetype creates the following projects:

Parent project<artifactId>/
Bundle project<artifactId>/bundle/
Package project<artifactId>/package/

The application bundle project and the deployment package project have their own build system pre-generated in the form of a Maven POM file. You can import these projects in Eclipse to customize and debug the application or library.


Some Maven repositories may not be available over HTTP, so if your Maven compilation fails due to the error, Return code is: 501, ReasonPhrase:HTTPS Required, then add the following entry in the <mirror> section in Settings.xml file located in your <maven installation>/conf directory.

<name>Maven Central Repository</name>

Bundle attributes

Bundle (application or library) attributes and properties are defined in the project pom.xml file and bundle pom.xml file respectively.

The following table lists the project pom.xml file and bundle pom.xml file:

pom.xml fileDescriptionSample code
Project pom.xml file

The project pom.xml file consists of the bundle attributes. The attribute values are defined in the maven-bundle-plugin configuration. You can edit this file to modify the attribute values.

The following code snippet illustrates a sample maven-bundle-plugin configuration in the project pom.xml file:


Bundle pom.xml fileBy default, the bundle pom.xml file consists of the properties that are used to define bundle-specific values. You can edit this file to customize your bundle.

The following code snippet illustrates a sample properties configuration in the bundle pom.xml file:


The following table lists the bundle properties:

Bundle propertySample valueBundle descriptor methodpom.xml node in the maven-bundle-plugin sectionHow to define valueDefault valueRequiredDescription

Set property in the project\pom.xml file:


${project.groupId}.${project.artifactId}YesGlobally unique identifier for the bundle (i.e., Bundle Id)
Short NamelunchordergetName()<Bundle-Name>

Set property in the project\pom.xml file:


${project.artifactId}YesBundle short name. Not a friendly name.
Friendly NameLunch OrdergetFriendlyName()<RxBundle-FriendlyName>

Set property in the project\pom.xml file:

${}YesFriendly bundle name.
DescriptionAn application that allows users to place lunch orders.getDescription()<Bundle-Description>

Set property in the project\pom.xml file:


${project.description}YesFriendly long description of bundle. Derived during project creation.

Set property in the project\pom.xml file:


${version}YesVersion of the bundle
Developer IDcom.bmcdeveloperId()<Bundle-Vendor>

Set property in the project\pom.xml file:


${project.groupId}YesId of bundle author. Not a friendly name.
Developer NameBMC SoftwaregetDeveloperName()<RxBundle-DeveloperName>

Directly add <RxBundle-DeveloperName> node to the maven-bundle-plugin configuration

${project.groupId}NoFriendly name of developer. Not in archetype or manifest by default.
Is Application?truegetIsApplication()<RxBundle-IsApplication>

Set property in the project\pom.xml file:


<based on archetype used> Yes

If you set this property value to true BMC Helix Innovation Studio creates an application. If you set this property value to false BMC Helix Innovation Studio creates a library..

Bundle Dependenciescom.bmc.arsys.rx.standardlib;1.0,com.bmc.arsys.rx.approval;2.0getBependentBundles()<RxBundle-Dependencies>Directly add <RxBundle-Dependencies> node to the maven-bundle-plugin configurationstandardlib;9.5.00-SNAPSHOTNoList of bundles that must be present before you deploy your code-based application.

Where to go from here

Deploying your application for the first time to start working in BMC Helix Innovation Studio

Was this page helpful? Yes No Submitting... Thank you