Setting up your IDE and installing BMC Helix Innovation Studio SDK

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

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 11.0.7

1. Download OpenJDK 11.0.7. See OpenJDK11.0.7. 

2. Extract the archive in a folder on your computer. For example, C:\Tools\Java\ jdk-11.0.7\.
3. Create a JAVA_HOME environment variable pointing to C:\Tools\Java\ jdk-11.0.7. 
   To create the variable on Microsoft Windows:
   1. Navigate to Start > Control Panel > System > Advanced System settings.
   2. In the System Properties, navigate to Advanced > Environment Variables.
4. In System Variables, perform the following:
   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\jdk11.0.7\

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

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

   • (Windows) Download apache-maven-3.6.3-bin.zip.
   • (UNIX) Download apache-maven-3.6.3-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.

To install Eclipse 4.10 (2018-12)

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

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. 

   1. Download AJDT (AspectJ) 

   2. In Eclipse, navigate to Help > Install New Software > Add and select Archive (downloaded from above location).
   3. Select Required Tools > Next > Finish.

   4. To install AJDT M2E configurator in Eclipse, see https://archive.eclipse.org/technology/m2e/releases/1.5/1.5.0.20140606-0033/.

   5. In Eclipse, navigate to Window>Preferences > Java > Compiler, set the compiler compliance level to 11.
   6. In Eclipse, navigate to Window>Preferences > Java > Installed JREs, select the open jdk 11.

To install GitHub

The following procedures list the different ways to install GitHub:

• By using GitHub desktop
• By using the Git command line program
• Build issues due while installing dependencies
• Build issues due to Adapt changes
• Build fails with errors of cyclic dependencies in Angular

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:
      
   2. Navigate to Windows Explorer > This PC > Properties > Advanced System settings, and in the System Properties, navigate to 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:
   

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.
      
   2. Navigate to Windows Explorer > This PC > Properties > Advanced System settings and in System Properties, navigate to 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:

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 12.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 12.20.01.
   
   You can install Node.js by using Node Version Manager version 1.1.7 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 Node Version Manager version 1.1.7

     • (Windows) See nvm-windows. For more information about versions, see nvm-windows releases.

     • (Mac OS/Linux) See nwm-macOS

   • Install Node.js 12.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

1. Install Yarn 1.22.5.

   Operation System	Use the installation file with extension
   Windows	.msi
   Linux	.tar
   MAC	.tar.gz
   Other	See the Yarn installation information.

   Important

   To get the actual version of Yarn, see Yarn v1.22.5.

2. Verify that the version of Yarn running on your system by using the following command:

   yarn --version
   

   Important

   If you have Windows operating system, you can install/uninstall Yarn 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:

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 22.1.08, you must upgrade your applications to version 22.1.08. 

1. Download BMC Helix Platform 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-22.1.08\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. 

Troubleshooting

This section describes how to resolve issues that you might encounter when upgrading your applications or libraries from version 21.3.xx to 22.1.07 or earlier.

Build issues due while installing dependencies

The following errors are displayed when you upgrade your applications or libraries to version 22.1.06 or earlier:

• error sass@1.62.1: The engine "node" is incompatible with this module. Expected version ">=14.0.0". Got "12.20.1"
  error Found incompatible module.
  To resolve the issue, perform the following steps:
  1. Delete the node_modules folder and the yarn.lock file from the bundle/src/main/webapp/ location.

  2. Add the following dependency to the resolutions section located at bundle/src/main/webapp/package.json.

      "sass": "1.60.0"

     For example:

     dependencies
     
     "resolutions": {
       ...
       "sass": "1.60.0"
     },
• error ts-custom-error@3.3.1: The engine "node" is incompatible with this module. Expected version ">=14.0.0". Got "12.20.0"
  error Found incompatible module.To resolve the issue, perform the following steps:
  1. Delete the node_modules folder and the yarn.lock file from the bundle/src/main/webapp/ location.

  2. Add the following dependency to the resolutions section located at bundle/src/main/webapp/package.json.

      "ts-custom-error": "3.2.0"

     For example:

     dependencies
     
     "resolutions": {
       ...  
     "ts-custom-error": "3.2.0"
     },

• error tmp@0.2.3: The engine "node" is incompatible with this module. Expected version ">=14.14". Got "12.20.1"
  To resolve the issue, add 0.2.1 tmp library to the resolutions section.

  "resolutions": {
    ...
     "tmp": "0.2.1"
   },

Build issues due to Adapt changes

If you are using StackedChartType import from Adapt, for example import { StackedChartType } from '@bmc-ux/adapt-charts'; the build fails with the following error:

This issue occurs because the type name has changed from StackedChartType to AdaptStackedChartType.

Build fails with errors of cyclic dependencies in Angular

Make sure you refactor the code. For more information, see NG3003: Import cycles would need to be created to compile this component. 

Where to go from here

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