This documentation supports the 19.05 version of BMC Helix Platform. 
To view an earlier version, select 19.02 from the Product version menu.

Creating a Project using Maven and the Archetype

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

Important

  • Application development or smart library development must be done by using the developer account.
  • A developer account is set with an administrator role. The developer account does not require the domain identifier to log in. You can login to BMC Helix Innovation Studio with just the user name without the developer.com domain.
  • Ensure that the Developer ID is set for the BMC Helix Platform server. The Developer ID is used to uniquely identify your organization. When the SaaS administrator creates the Bundle project, the archetype assigns the Developer ID.

The following video (5:41) provides details on how to create a maven project using BMC Helix Platform SDK and IDE and how to deploy the project to your system.

The video shows an older version of BMC Helix Platform. The previous product name was BMC Helix Innovation Suite. Although there might be minor changes in the UI, the overall functionality remains the same.

 https://youtu.be/_aXeUOGRlNY

To create a new project

To create a new application project or smart library project, use the Maven archetypes (simple archetype or lib archetype) with the BMC Helix Platform SDK. For your projects, decide where you want your project code to reside. It is recommended that not to place the project code at the BMC Helix Platform SDK location. For example, you can create a new directory projects in the root directory.

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

    • If you want to create a project for application development, run the following command:

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

      where,

      Archetype ArgumentDescription
      -DarchetypeGroupId=com.bmc.arsysMaven uses BMC archetypes
      -DarchetypeArtifactId=rx-sdk-archetype-simpleSelects the simple application archetype. This sets the POM file to create an application package and generates a working UI.
      -DarchetypeCatalog=localUses only the local catalog
    • If you want to create a project for library development, run the following command:

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

      where,

      Archetype ArgumentDescription
      -DarchetypeGroupId=com.bmc.arsysMaven uses BMC archetypes
      -DarchetypeArtifactId=rx-sdk-archetype-libSelects the library archetype. This sets the POM file to create a library package and does not generates a working UI.
      -DarchetypeCatalog=localUses only the local catalog

      For more information on Maven archetype, see  Maven archetype plugin in Maven documentation.

  3. The command (for library archetype or simple application archetype) starts the archetype plugin in interactive mode and prompts for the property values.

    Enter the values for the following properties:

    PropertyDescriptionSample values for application developmentSample values for library development
    groupId

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

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

    com.examplecom.example
    artifactId

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

    Notes:

    The artifactId cannot be a combination of:

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

    Upper case and lower case letters. For example, Work-Order-Lib is not a valid artifactId.

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

    suggestion-boxwork-order-lib
    version

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

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

    See Version number rules in Maven documentation and Guidelines for versioning and undeploying an application.

    1.0-SNAPSHOT1.0-SNAPSHOT
    package

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

    com.examplecom.example
    name

    Friendly name of the bundle. This 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

  4. Confirm the configuration of all the properties.

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

After you create the application (or smart library) project, you must modify the user credentials in the project pom.xml file. See Setting the development server environment properties in the project pom.xml file.  

To set up the development server environment properties 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 -->
     
       <developerUserName>developer</developerUserName>
       <developerPassword>mydeveloperpw</developerPassword>
     
       <!-- Server name with Jetty port. -->
       <webUrl>https://developer.innovate.bmc.com</webUrl>
     
    <!-- END: Bundle specific configuration.-->

    where, developerUserName is developer user that you create while requesting a sandbox. You do not need to use the domain name developer.com.

    Note

    You must provide the webUrl of your sandbox.

  3. If you plan to use the Grunt utility for active debugging of Javascript, you must add the correct api-host in the parent project bundle\bundle.conf.json file. By default, it is generated as localhost, you must update it to match your development server host. The host typically remains as localhost that is where the JavaScript source code resides.  For example:

    "options": {
                "livereload-port": 39005,
                "skip-tests": "true",
                "skip-validation": "true",
                "api-host": "developer101.innovate.bmc.com",
                "api-port": 443,
                "api-https": true,
                "host": "localhost",
                "port": 9005
    },
  4. 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. If your application or smart library intends to make use of workflows for approvals, assignments, or the Foundation library, add the dependencies in the bundle\pom.xml, so that these capabilities can be tailored after the application is deployed. You can use the following content for the rx-sdk.bundledependencies tag. The syntax is bundleid;version using commas to separate each bundle.

	<properties>
		<!-- Comma separated Bundle Dependencies with version.  -->
		<rx-sdk.bundleDependencies>standardlib;${rx-sdk.version},com.bmc.arsys.rx.approval;${rx-sdk.version},com.bmc.arsys.rx.assignment;${rx-sdk.version},com.bmc.arsys.rx.foundation;${rx-sdk.version}</rx-sdk.bundleDependencies>
	</properties>

Projects created by the archetype

The Maven archetype creates the following projects:

ProjectLocation
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.

Smart bundle attributes

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

The following table describes 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 smart 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:

<properties>
    <rx-sdk.bundleId>${project.groupId}.${project.artifactId}</rx-sdk.bundleId>
    <rx-sdk.bundleName>${project.artifactId}</rx-sdk.bundleName>
    <rx-sdk.bundleFriendlyName>${project.name}</rx-sdk.bundleFriendlyName>
    <rx-sdk.bundleDescription>${project.description}</rx-sdk.bundleDescription>
    <rx-sdk.bundleDeveloperId>${project.groupId}</rx-sdk.bundleDeveloperId>
    <rx-sdk.bundleDeveloperName>${project.groupId}</rx-sdk.bundleDeveloperName>
    <rx-sdk.bundleIsApplication>true</rx-sdk.bundleIsApplication>
<properties>

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 smart bundle.

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

<plugin>
    <groupId>org.apache.felix</groupId>
    <artifactId>maven-bundle-plugin</artifactId>
    <version>${maven-bundle-plugin.version}</version>
    <extensions>true</extensions>
    <configuration>
        <instructions>
            <Bundle-Name>${rx-sdk.bundleName}</Bundle-Name>
            <Bundle-SymbolicName>${rx-sdk.bundleId}</Bundle-SymbolicName>
            <Bundle-Activator>com.mygroupid.bundle.MyApplication</Bundle-Activator>
            <Import-Package>*;resolution:=optional</Import-Package>
            <Embed-Dependency>*;scope=compile|runtime</Embed-Dependency>
            <Bundle-Description>${rx-sdk.bundleDescription}</Bundle-Description>
            <Bundle-Vendor>${rx-sdk.bundleDeveloperId}</Bundle-Vendor>
            <RxBundle-DeveloperName>${rx-sdk.bundleDeveloperName}</RxBundle-DeveloperName>
            <RxBundle-FriendlyName>${rx-sdk.bundleFriendlyName}</RxBundle-FriendlyName>
            <RxBundle-IsApplication>${rx-sdk.bundleIsApplication}</RxBundle-IsApplication>
        </instructions>
    </configuration>
</plugin>

The following table describes the smart bundle properties:

Smart bundle propertySample valueBundle descriptor methodpom.xml node in the maven-bundle-plugin sectionHow to define valueDefault valueRequiredDescription
IDcom.bmc.lunchordergetIid()<Bundle-SymbolicName>

Set property in the project\pom.xml file:

${rx-sdk.bundleId}

${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:

${rx-sdk.bundleName}

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

Set property in the project\pom.xml file:

${rx-sdk.bundleFriendlyName}
${project.name}YesFriendly bundle name.
DescriptionAn application which allows users to place lunch orders.getDescription()<Bundle-Description>

Set property in the project\pom.xml file:

${rx-sdk.bundleDescription}

${project.description}YesFriendly long description of bundle. Derived during project creation.
Version1.0.0.0getVersion()<Bundle-Version>

Set property in the project\pom.xml file:

${version}

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

Set property in the project\pom.xml file:

 ${rx-sdk.bundleDeveloperId}

${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:

 ${rx-sdk.bundleIsApplication}

<based on archetype used>  
Smart 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-SNAPSHOT  

Where to go from here

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

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

Comments