Setting up your IDE and installing BMC Helix Innovation Studio SDK

Before you start with developing applications, you must install the BMC Helix Innovation Studio SDK and the components required to develop applications. For an overview of the steps to develop an application, see Setting-up-the-environment-to-develop-a-code-based-application. 

The following video (4:20) demonstrates the list of components required to develop the application and how to setup the Integrated Development Environment (IDE).

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.pnghttps://youtu.be/5mzWv7y3_3s

The following table lists the different components and installers you need to set up the development environment:

Components and installers

Description

BMC Helix Innovation StudioSoftware Development Kit

Open Java Development Kit 

BMC Helix Innovation Studio server

BMC Helix Innovation Studioserver and database are installed on the BMC Helix Innovation Studio Developer Instance (sandbox systems). Click here to register and request a free BMC Helix Innovation Studio Developer Instance.

Build system 

Integrated Development Environment (IDE) (2024-06)

Required for BMC Helix Innovation Studio SDK

JavaScript runtime engine required for Grunt

Package manager for JavaScript

JavaScript task runner for running and debugging custom web applications

Recommendations

  • Use Google Chrome or Mozilla Firefox browser to access BMC Helix Innovation Studio.

  • If you are using Google Chrome, you can use Batarang - the AngularJS Extension. To download the tool, click Chrome webstore apps.

  • When working with REST APIs, you can use the Postman application.

To install OpenJDK 17.0.8.1+1

  1. Download OpenJDK 17.0.8.1+1.  
  2. Extract the archive in a folder on your computer; for example, C:\Tools\Java\ jdk-17.0.8.1+1\. 
  3. Create a JAVA_HOME environment variable pointing to C:\Tools\Java\ jdk-17.0.8.1+1.  
    To create the variable on Microsoft Windows:
    1. Select Start > Control Panel > System > Advanced System settings.
    2. In the System Properties, select Advanced > Environment Variables.
  4. In System Variables, perform the following steps:
    1. Add <JDKInstallation> folder to JAVA_HOME variable.  
      For example, a typical value for the PATH variable can be: 
      C:\WINDOWS\system32;C:\WINDOWS;C:\Tools\Java\jdk17.0.8.1+1\ 
    2. Add %JAVA_HOME%\bin to the PATH environment variable. 

Important

Remove all references to the Oracle JRE bin folder in the system environment variable PATH. For example, C:\Program Files\Java\jre\bin and C:\ProgramData\Oracle\Java\javapath

To install Maven 3.9.8

  1. Download and install Maven 3.9.8.
    For more information, see archive.apache.org and download one of the following files: 

    • (Windows) Download apache-maven-3.9.8-bin.zip.
    • (UNIX) Download apache-maven-3.9.8-bin.tar.gz.

    For more information, see Installing Apache Maven in the Maven documentation.

  2. Create a  MAVEN_OPTS environment variable and set it to -Xms512m -Xmx1024m.
    For more information, see Configuring Apache Maven in the Maven documentation.

Important

  • Do not change the default location of the Maven repository. By default, the Maven repository is located at C:\Users\Administrator\.m2.

  • Comment the maven-default-http-blocker to avoid the following error on http download:
    Could not transfer artifact com.bmc.arsys.mojo:is-build-helper-maven-plugin:pom:1.0 from/to maven-default-http-blocker (http://0.0.0.0/): Blocked mirror for repositories: [bmcmanaged-nexus-tps (http://<server>:<port>/nexus/content/repositories/BMCRemedyManagedRepo, default, releases+snapshots)

    <!--    

    <mirror>
          <id>maven-default-http-blocker</id>
          <mirrorOf>external:http:*</mirrorOf>
          <name>Pseudo repository to mirror external repositories initially using HTTP.</name>
          <url>http://0.0.0.0/</url>
          <blocked>true</blocked>
    </mirror>

    -->

  • Maven repository will now be available over HTTPS, so if your maven compilation fails due to the error, Return code is: 501 , ReasonPhrase:HTTPS Required, then add following entry in the <mirrors> section in Settings.xml file located in your <maven installation>/conf directory.

    <mirror>
    <id>central-over-https</id>
    <mirrorOf>central</mirrorOf>
    <name>Maven Central Repository</name>
    <url>https://repo.maven.apache.org/maven2</url>
    </mirror>

To install Eclipse 4.3 (2024-06)

  1. Download and unzip Eclipse IDE for Java developers, 64-bit version (2024-06). 

  2. Modify the eclipse.ini file to increase the memory used by Eclipse. 
    1. Update the line with -Xms to -Xms512m
    2. Update the line with -Xmx to -Xmx2048m
  3. Download and install the AspectJ plug-in for Eclipse. 
    2. In Eclipse, select Help > Install New Software > Add and select Archive (downloaded from above location).
    3. Select Required Tools > Next > Finish.
    4. In Eclipse, select Window > Preferences > Java > Installed JREs, and then select the open jdk 17.0.8.1+1.

To install GitHub

The following procedures list the different ways to install GitHub:

By using GitHub desktop

  1. Install the desktop version of GitHub.
    See GitHub.

  2. After you install GitHub, add the command line git.exe in the Windows Path environment variable.
    1. Get the git.exe path. GitHub desktop is installed in the following folder:
      C:\Users\<YourUserName>\AppData\Local\GitHubDesktop\app-<VersionNumber>\resources\app\git\cmd
      <YourUserName> is your Windows login name and <VersionNumber> is the GitHub version installed.
      For example, see the following image:
      Git_exe folder.gif
    2. Select Windows Explorer > This PC > Properties > Advanced System settings, and in the System Properties, select Advanced > Environment Variables.
    3. In System Variables, edit the variable Path to add the path to the git.exe utility, and save the changes.

  3. Verify that git.exe is available by opening a Windows command prompt and entering the following command:git --version

    The git.exe tool version is displayed as shown in the following image:
    Git tool version.gif

By using the Git command line program

  1. Access the GitHub Downloads URL and select Windows.

  2. Cancel the download for the default git installer and from the UI select the 64-bit Git for Windows Portable option.
  3. After you run the executable file, the Git command line program is installed at the C:\git\PortableGit folder.
  4. Add the git.exe path in the Windows Path environment variable by using the following steps:
    1. Get the git.exe path from the C:\git\PortableGit\bin\ folder.
      git path.png
    2. Select Windows Explorer > This PC > Properties > Advanced System settings and in System Properties, select Advanced > Environment Variables.
    3. In System Variables, edit the variable Path to add the path to the utility git.exe, and save the changes.

  5. Verify that git.exe is available by opening a Windows command prompt and entering the following command:
    git --version

    The git.exe tool version is displayed as shown in the following image:

git exe.png

To install Node.js

  1. Verify if the correct version of Node.js is installed by using the following command:

    node --version
  2. If you have installed a Node.js version earlier than 16.20.1, uninstall Node.js.

    •  If you have installed Node.js by using Node Version Manager (nvm), use the following command to uninstall it:

      nvm uninstall <version>

       

    • If you have installed Node.js directly, use your operating system OOTB functionality to uninstall it.
      For example the Add/Remove Programs on Windows.

  3. Install Node.js 16.20.1.

    You can install Node.js by using Node Version Manager version 1.1.11 or by using Node.js installer.

    Important

    BMC recommends that you use Node Version Manager. Node Version Manager simplifies the management of node versions when you have to frequently install, uninstall, or switch between different node versions. If you do not install Node Version Manager, make sure that you get the installer from the Previous Releases page on the nodejs.org website.

    • Install or update Node Version Manager to version 1.1.11

    • Install Node.js 16.20.1 installer.

      • (Windows) Use Windows Installer (.msi) or Windows Binary (.zip)
      • (Mac OS) Use macOS Installer (.pkg) or macOS Binary (.tar.gz)
      • (Linux) Use any the applicable binaries 

  4. Verify that the correct version of Node.js is running on your system by using the following command:

    node --version

To install Yarn

Install Yarn 1.22.19command line interface by using the following command:

npm install -g yarn@1.22.19

Operation System

Use the installation file with extension

Windows

.msi

Linux

.tar

MAC

.tar.gz

Other

See the Yarn installation information.

Important

If you have Windows operating system, you can install/uninstall Yarn by using the Add/Remove Programs.

To install Grunt 

You can install Grunt tool for easy debugging of custom web applications. Grunt is installed and managed via the Node.js package manager. No additional installer is required for installing Grunt.

Install Grunt 1.3.2 command line interface by using the following command:

npm install -g grunt-cli@1.3.2

Important

If the grunt command is not recognized as a command, the installer may have failed to add it to the path. Make sure the npm folder is in the path, usually located at \Users\YOURNAME\AppData\Roaming\npm.

To download and install BMC Helix Innovation Studio SDK

If you have created applications by using an BMC Helix Innovation Studio SDK version earlier than 25.1.02, you must upgrade your applications to version 25.1.02. 

  1. Download BMC Helix Innovation Studio SDK. 
  2. Extract the sdk folder to a desired location (for example, C:\sdk) and add a system environment variable RX_SDK_HOME pointing to the sdk folder location.

  3. Run the following command in the sdk lib folder:

    mvn clean install

    For example, if the sdk folder is located at C:\sdk, run the following commands:

    cd C:\sdk\com.bmc.arsys.rx.sdk-25.1.02\lib
    mvn clean install

To verify the development environment

You can have a quick check of installed software in the development environment by using commands. 

The following table describes the commands with output examples. The output may vary on your system depending on the installed components. 

Command

Output

Verification

java -version

openjdk version "17.0.8.1+1" 2020-04-14

OpenJDK Runtime Environment AdoptOpenJDK (build 17.0.8.1+1)
OpenJDK 64-Bit Server VM AdoptOpenJDK (build 17.0.8.1+1, mixed mode)

Verify that the JAVA_HOME and PATH parameters are set to the correct locations. If not set correctly, set the locations manually:

  • Set the JAVA_HOME parameters to "C:\BMCTools\Java"
  • In the PATH parameters, add "C:\BMCTools\Java\bin"

mvn -version

Apache Maven 3.9.8 (cecedd343002696d0abb50b32b541b8a6ba2883f)
Maven home: C:\Tools\apache-maven-3.6.3\bin\..
Java version: 17.0.8.1+1, vendor: AdoptOpenJDK, runtime: C:\Tools\Java\jdk17.0.8.1+1
Default locale: en_US, platform encoding: Cp1252
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"

Verify that the MAVEN_HOME, MAVEN_OPTS and PATH parameters are set to the correct location. If not set correctly, set the locations manually:

  • Set the MAVEN_HOME parameter to
    "C:\BMCTools\apache-maven-3.9.8"
  • Set the MAVEN_OPTS parameter to "-Xms512m -Xmx1024m"
  • In the PATH parameter, add
    "C:\BMCTools\apache-maven-3.9.8\bin"

node --version

v16.20.15.1.00

Verify that the PATH parameter is set to the correct location. If not set correctly, in the PATH parameter add "C:\BMCTools\nodeJS\" manually.

set RX_SDK_HOME

RX_SDK_HOME=<sdk location>\com.bmc.arsys.rx.sdk-25.1.02

Verify that the RX_SDK_HOME parameter is set to the correct location. If not set correctly, set the location manually to

<sdk location>\com.bmc.arsys.rx.sdk-25.1.02

yarn --version

1.22.19

Verify that the PATH parameter contains the location

C:\Users\Administrator\AppData\Local\Yarn\bin

grunt --version

 

v1.3.2

Verify that the PATH parameter is set to correct location. If not set correctly, set the location manually to

"C:\Users\Administrator\AppData\Roaming\npm"

Where to go from here

Creating-a-Project-using-Maven-and-the-Archetype

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*