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.

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 (question mark) icon.

General Project Settings

Parameter Description

Custom Trust Store

Specifies the TrustStore that contains information about public certificates (cacerts). For more information, refer to Upload a Custom TrustStore File.

Custom Trust Store Password

Specifies the password for the TrustStore file that you provided. For more information, refer to Add a Custom TrustStore Password.

Recipients

Specifies the list of recipients that receive the email notifications for all jobs in the project.

You can specify multiple email addresses by separating them with a comma.

Checkout Time

Specifies the time taken (in minutes) for checkout based on the size of the project. The default value is 30 minutes.

Visualizer Project Settings

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

Parameter Description

SCM Vendor *

Specifies the Git vendor that hosts your repository. Select the option that matches your Git server.

App Factory supports GitHub, Bitbucket, AWS CodeCommit, and JFrog Artifactory.

If your Git vendor is not in the list, or if you're using a bare-bones Git server, select Other.

IMPORTANT:
  • JFrog Artifactory is available in version V9 ServicePack 7, or later.
  • JFrog Artifactory is supported only if your project source is packaged in a zip file.

Repository URL *

Specifies the Git repository URL based on the location of the Visualizer 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 is
git@git-vendor.com:username/reponame.git

Typically, a repository URL can be found by clicking a Code or Clone button.

IMPORTANT:

Only the .zip file extension is supported for JFrog Artifactory.

If you are using Azure DevOps as your Git vendor, the format of the Repository URL must adhere to the following syntax.

  • HTTPS URL syntax:
    https://dev.azure.com/organization-name/project-name/_git/repo-name
  • SSH URL syntax:
    git@ssh.dev.azure.com:v3/organization-name/project-name/repo-name

SCM Credentials *

Specifies the SCM credentials that App Factory uses to fetch the Visualizer project from the repository.

IMPORTANT:

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.

You must provide the Git credentials based on the Git clone URL format.

Project Path

Specifies the path from the root that contains the Visualizer project.

IMPORTANT: To include Micro Apps in the build job, make sure that you provide the path to the Base App.

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.
Link Microapps

Specifies the projects that must be linked as dependent Micro App projects.

The Link Micro Apps dialog box displays a list of all the projects available in the App Factory Cloud Instance. Select the checkbox for the apps that you want to link as dependent Micro App projects to the current app.

NOTE:
  • Refer the Project Manifest file of the source project (present in your file system) to accurately link the dependent Micro App Projects.
  • To ensure that the dependencies are correctly identified, Temenos recommends naming the App Factory project based on the actual dependency name of the Micro App (as specified in the Project Manifest file in the Visualizer Source project).

IMPORTANT:
The iOS settings are only available in V9 ServicePack 3 or later.

Parameter Description

Signing Method *

Specifies the method by which App Factory must sign the iOS app binary. Contains the following options:

  • API Key
    If you select API key, you need to add and select the required API Key credentials. For more information, refer to Adding an App Store Connect API Key.
  • Manual Certificates
    If you select Manual Certificates, you need to upload the signing certificates in the P12 format. For more information, refer to Adding a new signing certificate.

IMPORTANT:
The Android settings are only available in V9 ServicePack 3 or later.

For more information about these parameters, refer to Android keystore system and Sign your app.

NOTE: These parameters are applicable for building the app in the release mode or release-protected mode. If you want to build your app in the debug mode, you can skip these parameters.

Parameter Description

Keystore File

Specifies the keystore file that is used to sign the Android binary. The supported file formats are .keystore and .jks.

Keystore Password

Specifies the password for the file that is selected in the Keystore File parameter.

Key Password

Specifies the password to the key that is used to sign-in to the Android library.

Key Alias

Specifies the alias of the signing key in the keystore.
Parameter Description

Default Locale

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

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

NOTE: App Factory supports SonarQube only for the Visualizer 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 Visualizer 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.

Parameter Description

Enable SonarQube Analysis

Enables or disables the SonarQube analysis for your App Factory project.

Scanner Version

Specifies the version of the Sonar Scanner that you want to use for code analysis.

Server URL

Specifies 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 Token

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

Visualizer Project Key

Specifies the ID of the Visualizer 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.

Temenos recommends that you use the name of your Visualizer app as the project key.

Base Directory

Specifies the path to the Visualizer project.

If your Visualizer 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.

Sources

Specifies 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 Visualizer 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.

Exclusions

Specifies 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/**

Temenos recommends that you exclude auto-generated code and third-party libraries from the SonarQube analysis.

Additional Analysis Properties

Specifies 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 met

Specifies whether the build must fail if the SonarQube quality threshold is not met in the code analysis.

Debug mode

Specifies whether the SonarQube scanner must run in debug mode for the code analysis.
Parameter Description

Clean and Regenerate

Specifies whether App Factory must delete and regenerate the client-side object models. The models are used while invoking Object services, and are located in the /models folder of the project

This setting is enabled by default.
Parameter Description

Recipients

Specifies the list of recipients that receive the email notifications from the Visualizer build pipeline.

You can specify multiple email addresses by separating them with a comma.

 

Fabric Project Settings

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

Parameter Description

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 Fabric 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 is
git@git-vendor.com:username/reponame.git

Typically, a repository URL can be found by clicking a Code or Clone button.

IMPORTANT:

If you are using Azure DevOps as your Git vendor, the format of the Repository URL must adhere to the following syntax.

  • HTTPS URL syntax:
    https://dev.azure.com/organization-name/project-name/_git/repo-name
  • SSH URL syntax:
    git@ssh.dev.azure.com:v3/organization-name/project-name/repo-name

SCM Credentials *

Specifies the SCM credentials that App Factory uses to fetch the Fabric project from the repository.

IMPORTANT:

You must provide the Git credentials based on the Git clone URL format.

 

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 Path

Specifies the path from the root that contains the Fabric 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.
Parameter Description

Recipients

Specifies the list of recipients that receive the email notifications from the Fabric build pipeline.

You can specify multiple email addresses by separating them with a comma.

 

Microservice Project Settings

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

Parameter Description

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 Fabric 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 is
git@git-vendor.com:username/reponame.git

Typically, a repository URL can be found by clicking a Code or Clone button.

IMPORTANT:

If you are using Azure DevOps as your Git vendor, the format of the Repository URL must adhere to the following syntax.

  • HTTPS URL syntax:
    https://dev.azure.com/organization-name/project-name/_git/repo-name
  • SSH URL syntax:
    git@ssh.dev.azure.com:v3/organization-name/project-name/repo-name

SCM Credentials *

Specifies the SCM credentials that App Factory uses to fetch the Microservice config files from the repository.

IMPORTANT:

You must provide the Git credentials based on the Git clone URL format.

 

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 Path

Specifies the path from the root that contains the Microservice config files.

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.
Parameter Description

Recipients

Specifies the list of recipients that receive the email notifications from the Microservices build pipeline.

You can specify multiple email addresses by separating them with a comma.