Search
Link Search Menu Expand Document
Kony Quantum is now HCL Volt MX. See Revised Terminology. Current Quantum users, see the important note about API naming.
Release:

Project Settings

Every project in App Factory contains a Project Settings page, which contains configurations such as Source Control parameters, Quality (SonarQube) related settings, and Notification related parameters.

To access the Project Settings page, open your App Factory project, and then select Project Settings from the left panel. The Project Settings link is available at every folder level of your project. The settings are only applicable for the selected project. You need to configure the project settings before you run a build. You can edit the settings at any time by opening the Project Settings page.

For more information about the project settings, refer to the following sections:

Note:

  • Parameters that are marked with an asterisk (*) are mandatory.

  • To view additional information about a setting, click the help icon (question mark) for the setting.

Iris Project Settings

Source Control

Note: Make sure that you configure the mandatory parameters (marked with an asterisk) before you run the buildIrisApp job.

ParameterDescription
SCM Vendor *Specifies the Git vendor that hosts your repository. Select the option that matches your Git server. App Factory supports GitHub, Bitbucket, and AWS CodeCommit. If your Git vendor is not in the list, or if you're using a bare-bones Git server, select Other.
Repository URL *Specifies the Git repository URL based on the location of the Iris project. The URL can be an HTTPS URL or an SSH URL. The format for an HTTPS URL is https://git-vendor.com/username/reponame.git The format for SSH URL isgit@git-vendor.com:username/reponame.git Typically, a repository URL can be found by clicking a Code or Clone button.
SCM Credentials *Specifies the SCM credentials that App Factory uses to fetch the Iris project from the repository.
Important: You must provide the Git credentials based on the Git clone URL format. If the Git clone URL has an https protocol type, you need to add the Username and Password for the Git account. For more information, refer to Adding New Source Code Repository Credentials. If the Git clone URL has the ssh protocol type, you need to add the SSH keys credentials. For more information, refer to Add SSH Key Credentials.
Note: If your repository is protected with 2FA (two-factor authentication) in GitHub, you need to add the GitHub credentials to your project. For more information, refer to GitHub 2FA.
Project PathSpecifies the path from the root that contains the Iris project. If your project is at the root of the repository, leave the field blank. Otherwise, type the path relative to the root of the repository, for example, path/to/FooApp. The depth of the sub-folder is not limited, but Windows has a limitation of 256 characters for the relative path.
Internationalization
ParameterDescription
Default LocaleSpecifies the ISO 693-1 language code for the default locale of the app. For example: en The specified language is used when the client app is launched.
Quality
SonarQube

SonarQube is an open-source platform that provides features to maintain code quality and security.

Note: App Factory supports SonarQube only for the Iris code of your project.

As an admin, you can also restrict users from modifying the settings. You can exclude auto-generated files from the code analysis, and also choose to abort the build process if the quality threshold is not achieved.

Important: App Factory does not support analysis of Java code for Iris projects. Make sure that you use the Sources and Exclusions parameters to exclude Java code. Otherwise, the analysis fails.

For more information about the SonarQube settings, refer to the following table.

ParameterDescription
Enable SonarQube AnalysisEnables or disables the SonarQube analysis for your App Factory project.
Scanner VersionSpecifies the version of the Sonar Scanner that you want to use for code analysis.
Server URLSpecifies the URL of the SonarQube server that you want to use for code analysis. Make sure that the Server URL is accessible from the App Factory Cloud Environment.
Login TokenSpecifies the Sonar token (authentication token) that is used to sign-in to the SonarQube server. For information on how to add Sonar token credentials, refer to Adding New Credentials → Sonar Token.
Iris Project KeySpecifies the ID of the Iris project. The ID is passed as the projectKey parameter to the SonarQube server. Make sure that you use the same project key for every run of code analysis. Otherwise, the results for the same app will be shown separately for every project key. HCL recommends that you use the name of your Iris app as the project key.
Base DirectorySpecifies the path to the Iris project. If your Iris project is at the root of your repository, leave this field blank. Otherwise, specify the path to the sub-directory that contains the project, for example, path/to/FooApp.
SourcesSpecifies the directories that contain the source files that must be analyzed. You can use this field to specify additional modules that are not part of the standard Iris project structure. You can specify multiple directories by separated them with commas. For example: controllers, modules, userwidgets Absolute paths and paths that are outside the source code are ignored during the SonarQube run.
ExclusionsSpecifies the files that must be excluded from the code analysis. You need to use glob patterns or shell patterns to specify the files. You can specify multiple exclusions by separating them with commas. For example: **/*.java, **/*.json, jssrc/**, actions/**, models/**, **/*ControllerActions.js, node_modules/** HCL recommends that you exclude auto-generated code and third-party libraries from the SonarQube analysis.
Additional Analysis PropertiesSpecifies a list of additional parameters (-D parameters) that are sent to the SonarQube server. You can specify multiple parameters by separating them with a blank space. For example: -Dsonar.organization=exploring -Dsonar.c.file.suffixes=- -Dsonar.cpp.file.suffixes=-
Abort if quality gateway is not metSpecifies whether the build must fail if the SonarQube quality threshold is not met in the code analysis.
Debug modeSpecifies whether the SonarQube scanner must run in debug mode for the code analysis.
Notifications
ParameterDescription
RecipientsSpecifies the list of recipients that receive the email notifications from the Iris build pipeline. You can specify multiple email addresses by separating them with a comma.

Foundry Project Settings

Source Control

Note: Make sure that you configure the mandatory parameters (marked with an asterisk) before you run the buildFoundryApp job.

ParameterDescription
SCM Vendor *Specifies the Git vendor that hosts your repository. Select one of the options that match your git server. App Factory supports GitHub, Bitbucket, and AWS CodeCommit. If your Git vendor is not in the list, or if you're using a bare-bones Git server, select Other.
Repository URL *Specifies the Git repository URL based on the location of the Foundry project. The URL can be an HTTPS URL or an SSH URL. The format for an HTTPS URL is https://git-vendor.com/username/reponame.git The format for SSH URL isgit@git-vendor.com:username/reponame.git Typically, a repository URL can be found by clicking a Code or Clone button.
SCM Credentials *Specifies the SCM credentials that App Factory uses to fetch the Foundry project from the repository.
Important: You must provide the Git credentials based on the Git clone URL format. If the Git clone URL has an https protocol type, you need to add the Username and Password for the Git account. For more information, refer to Adding New Source Code Repository Credentials. If the Git clone URL has the ssh protocol type, you need to add the SSH keys credentials. For more information, refer to Add SSH Key Credentials.
Note: If your repository is protected with 2FA (two-factor authentication) in GitHub, you need to add the GitHub credentials to your project. For more information, refer to GitHub 2FA.
Project PathSpecifies the path from the root that contains the Foundry project. If your project is at the root of the repository, leave the field blank. Otherwise, type the path relative to the root of the repository, for example, path/to/FooApp. The depth of the sub-folder is not limited, but Windows has a limitation of 256 characters for the relative path.
Notifications
ParameterDescription
RecipientsSpecifies the list of recipients that receive the email notifications from the Foundry build pipeline. You can specify multiple email addresses by separating them with a comma.