Export a Fabric app

The Quantum Fabric export is used to export the existing Quantum Fabric application to your SCM.

The export job keeps track of the application code that is exported in the previous build. If there are no changes from the previous build, the push part of the pipeline is omitted.

Configuration

You can build the Export job by using the Build with Parameters option. You can access the option by following either of these steps.

  • On the right-side of the job row, select the icon that represents Build with Parameters
  • Open the drop-down list for the buildFabricApp job, and then select Build with Parameters
  • Open the buildFabricApp job and click Build with Parameters on the left panel

NOTE: If you don’t see the option, you might not have ownership permissions to the project. You can verify whether your name is listed in the Folder Owners section of the project. The Primary owner of the project can add users as secondary owners to grant permissions to the builds.

To build the job, you need to configure the build parameters. For more information about the parameters, refer to the following sections.

Parameter Description

SCM_BRANCH

Specifies the branch, release tag, or the commit ID of the repository that contains the source code of the Fabric app.
Parameter Description

FABRIC_CREDENTIALS

Specifies the credentials that App Factory uses to import and publish the app to the Fabric cloud. The Fabric cloud must be specified in the FABRIC_APP_CONFIG. For more information, refer to Adding New Cloud Credentials.

FABRIC_APP_CONFIG

Specifies the configuration that App Factory uses to connect the Visualizer (client) app to corresponding Fabric (server) app.

The configuration includes the hosting type, cloud account, environment name, and the Fabric app name.

The build pipeline refers to this parameter for the Fabric Account details to Import and Publish the app. For more information, refer to Adding new Quantum Fabric App Config.
Parameter Description

VALIDATE_VERSION

Specifies whether App Factory must validate the app version from the Fabric console with the app version in the SCM. If the two versions do not match, the changes are not committed to the SCM.

FABRIC_APP_VERSION

Specifies the version of the Fabric app that you want to export.

The version must be in the format <major>.<minor>, for example: 1.0 or 999.99. The major version must be between 1 and 999, and the minor version must be between 1 and 99.

FABRIC_DIR

Specifies the directory in the repository that contains the source code of the Fabric app.

For example, if the path to the Fabric source code is path/to/FabricApp/Apps, the Fabric directory is path/to/FabricApp.

If the source code of your Fabric app is at the root of the SCM, leave this parameter blank.

IGNORE_JARS

Specifies whether the dependent JAR files must be ignored while committing the app to the SCM.

SERVICE_CONFIG_PATH

Specifies the path in source control to which the service configuration JSON file must be exported and placed. The path must be relative to the root of the repository.

This is useful if you have manually configured the back-end endpoints and other settings in the Fabric Console, and you want App Factory to push the configuration to source control. If the path is left blank, App Factory exports the Fabric app, but not the corresponding service configuration.

For information about service configurations, refer to Managing Service Profiles.

IMPORTANT: This parameter is only applicable for Fabric Console versions V9SP2 or later.

App Factory supports custom locations for the configuration file, but Temenos recommends naming the folder configuration. Temenos also recommends naming every JSON file after the environment it is meant for. For example: If your environment is called Test Env, your configuration file should be configuration/Test_Env.json.

AUTHOR_EMAIL

Specifies the email address that is used for the Git client configuration to push changes to the remote repository.

COMMIT_AUTHOR

Specifies the author name that is used for the commit. For example: user.name

The default author name is App Factory.
COMMIT_MESSAGE

Specifies the message that is used for the commit. For example: Code commit for Test_Env.json

Exporting

After you configure the build parameters, you can trigger the export by clicking BUILD. The export process contains the following stages:

  • Prepare the build node environment
  • Export Quantum Fabric application
  • Clone Quantum Fabric application from Git
  • Check if there were changes
  • Configure local Git account
  • Prettify exported JSON files and move them to SCM
  • Push changes to remote storing artifacts
  • Notify on export status by email

After a successful export, the designated user receives an email alert.

After an unsuccessful export, the designated user receives an email alert on export failure.