This documentation supports the 22.1 version of BMC Helix Innovation Studio.To view an earlier version, select the version from the Product version menu.

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

Before you begin, make sure that you create a project for an application (or smart library) development. To manage the data for the application (or smart library), you should deploy the deployment package to the BMC Helix Innovation Studio server.

To deploy a package

Navigate to the <artifactId> directory (parent folder) of your application project (or smart library project) and run the following command: 

 mvn clean install -Pdeploy

The following video (5:07) provides details on how to deploy the Maven project to BMC Helix Innovation Studio server.

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.


icon_play.png https://youtu.be/A7B6xXoElw0

For example:

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

After you deploy the package to BMC Helix Innovation Studio server, a deployment package is a zip file (for example, com.example.suggestion-box1.0SNAPSHOT.zip) is created. It is located in the target directory in the application package directory (for example, \projects\suggestion-box\package\target\com.example.suggestion-box1.0SNAPSHOT.zip). The zip file consists of the following folders and files:

  • db
    • record
      • <record-definition-name1>.def
      • <record-definition-name2>.def
      • <record-definition-name3>.def
      • <record-definition-name3>.options
      • <record-definition-name3>.data
      • <record-definition-name3>.delete
    • process
      • <process-definition-name1>.def
      • <process-definition-name2>.def
    • rule
      • <rule-definition-name>.def
    • association
    • view
      • <view-definition-name>.def
    • named-list
      • <named-list-definition-name1>.def
      • <named-list-definition-name2>.def
    • localized-string
      • <localized-strings.def>
    • configuration.data
    • role.data
  • code <jar file>
  • manifest file

The .jar file is used to store the code for your application and the .def files are used to store definitions for your application.

To validate the new version of your package

The valid version range for code-based bundles is [0-999). All the import package entries in the bundle MANIFEST.MF file should have either version range as [0-999) or no version attribute at all.

When you develop a new code-based bundle or create a new version of your bundle, make sure that the new version of your bundle is within the specified version range of [0-999).

To validate the version range and capture the version violations during the development, edit the /package/pom.xml file, and add the <validateVersionRange> property to the <deploy> tag.

<profile>
   <!-- mvn clean install -Pdeploy -->
   <id>deploy</id>
<build>
<plugins>
<plugin>
<groupId>com.bmc.arsys</groupId>
<artifactId>rx-sdk-maven-plugin</artifactId>
<version>${project.version}</version>
<executions>
<execution>
<id>server-deployment</id>
<phase>install</phase>
<goals>
<goal>deploy-package</goal>
</goals>
<configuration>
<username>${adminUserName}</username>
<password>${adminPassword}</password>
<url>${webURL}</url>
<validateVersionRange>true</validateVersionRange>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>

If the bundle deployment fails for an existing bundle, see Troubleshooting issues when developing code-based applications.

Tasks to perform after you deploy the package to BMC Helix Innovation Studio

After you deploy the package, perform the following tasks:

  • Access the application in BMC Helix Innovation Studio.

    Important

    You must login to BMC Helix Innovation Studio by using the credentials of 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.

  • In BMC Helix Innovation Studio, from the Workspace > deployed application page, you can launch the application by using the Visit Deployed Application link .

  • You can import the bundle project in Eclipse. By using Eclipse, you can modify and test the Java code.
    To import the application to Eclipse, you must import the POM file to Eclipse using the Import command (File > Import> General > Maven Projects) and set the root folder to the bundle directory of the project.

    1802_Import+Maven+Project.png

    Important

    You cannot rename the bundle after importing it to Eclipse.

Troubleshooting

As a developer, after you complete the initial deployment, if you deploy the package multiple times by using the command mvn clean install -Pdeploy, duplicate log configurations are created for the application, and the following error occurs:

DeploymentPackage [packageDeployStatus=Error, packageName=com.example.test-smart-app, packageVersion=1.0.00-SNAPSHOT, currentServersInSync=true, newlyAddedServers=[], jarToServerDeployStatusMap={onbmc-s=ReadyDeploy}, ErrorMessages=PARSE_DEF_IMPORT_STATUS: IMPORTING_SERVER:onbmc-s:10.133.77.92 IMPORT_APPLICATION_ERROR: ERROR (382): The value(s) for this entry violate a unique index that has been defined for this form; Error importing record 1: FormName: AppLocalConfig_ComponentBase WARNING (55): The following item was not imported

To resolve this issue, after you complete the initial deployment, export the application by using the following command:

mvn install -Pexport

Where to go from here

Using-components-from-another-application-or-library