Importing and Exporting Packages

In FintechOS Platform, users with elevated privileges (admin users) can export metadata from an environment and import it into another environment, using digital solution packages (recommended).

In FintechOS Platform, you have the following options for importing and exporting packages:

• In FintechOS Studio, from the Development menu > Digital Solution Packages. For more information, see the FintechOS Studio, section Digital Solution Packages.
• From the command line by using the FtosSysPackageDeployer tool.

The FtosSysPackageDeployer tool is available in the release subdirectory, \Tools\FtosSysPackageDeployer. It allows you to do the following from the command prompt:

• list the customization sets found in a FTOS server.
• import / export in / from server a customization set from / in a local file.

For information on how to use the FtosSysPackageDeployer tool , see the built-in help by running the command prompt as admin and executing FtosSysPackageDeployer.exe without arguments. The tool is using the POST CUSTOMIZATION SET method of the FintechOS Platform API.

Use the FtosSysPackage Deployer for Digital Solution Packages

You can use the FtosSysPackage Deployer to import Digital Solution Packages that contain SQL objects, execute scripts before or after import, or map custom and custom-on-demand files to a portal profile:

1. Create a .config file with the following JSON :

   Copy

   {
     "digital-asset-custom-files-portal-mapping": [
       {
         "digital-asset-name": "DA",
         "portals": ["PP1", "PP2"],
         "map-to-all-portals-without-profile": true
       }
     ],
     "digital-solution-package": {
       "sql-scripts": {
         "before-import-folder": "FolderName",
         "after-import-folder": "AnotherFolderName"
       },
       "idp-themes": {
         "import-themes": true,
         "abort-import-on-exception": true
       }
     }
   }

   Descriptions:

   digital-asset-custom-files-portal-mapping : Array<Object>

   Object properties:

   • digital-asset-name: String - The name of the digital asset that contains the custom files.

   • portals: Array<String> - The portal profile to which the files should be deployed.

   • map-to-all-portals-without-profile: Boolean - Set to true if the custom files should also be deployed on portal instances that do not have a profile. Otherwise, set to false.

   digital-solution-package : Object

   sql-scripts : Object

   • before-import-folder: String - The name of the folder from the directory where the before scripts are located.

   • after-import-folder: String - The name of the folder from the directory where the after scripts are located.

   idp-themes : Object

   • import-themes: Boolean - Controls whether or not the import should also process the IDP Themes found in the package (if any). Set to true if the IDP themes related to Portal Profiles should be pushed to IDP. Otherwise set to false.

   • abort-import-on-exception: Boolean - Set to true if the import should roll back if an error occurs when the IDP themes are pushed to IDP. Otherwise set to false, and in case of an error the import continues and the error is logged.

    

2. Follow the guidelines below before adding the .config file:

   • the .config file must have the same name as the deploy package

   • the .config file must be in the same folder as the Digital Solution Package, but not inside the .zip file. This also applies to the SQL scripts folder.

3. Use FtosSysPackageDeployer to install the digital solution package as follows:
   • Locate the FtosSysPackageDeployer in the unzipped FintechOS installation kit at the following location: <unzipped_install_archive>\Tools\FtosSysPkgDeployer.
   • Create a new .bat file and edit and replace the parameters below with your own values.
   • Add the config file with the custom file mapping.
   • Right-click the .bat file and run it as administrator.

.bat Parameters Explanation

For asynchronous import run the following command: FtosSysPkgDeployer.exe-i –a -s <studio_url> -u <studio_user_name> -p <studio_user_password> -z <db_Server> -v <db_server_login_username> -k <db_server_login_password> -d <db_name> -r <syspack_file_path>

Field	Description
<studio_url>	The web URL of the FintechOS Studio installation, for example http://localhost/ftos_studio.
<studio_user_name>	The username of the FintechOS Studio user under which this import is executed. The user has to exist in FintechOS Studio prior to this operation
<studio_user_password>	The password for the FintechOS Studio user.
<db_server>	The name of the database server where the FintechOS installation database was created.
<DB_user>	The username of the SQL Server user with administration rights on the FintechOS installation database.
<db_server_login_username>	The login username of the SQL Server user with administration rights on the FintechOS installation database.
<db_server_login_password>	The password for the above mentioned SQL user.
<db_name>	The name of the database where the FintechOS Platform is deployed.
<syspack_file_path>	The physical path to the unzipped Digital Solution Package previously downloaded.

HINT  
For more information about the deployment tool, please run FtosSysPackageDeployer.exe without any arguments to see the built-in help.

Execute maintenance scripts

You can automatically execute maintenance scripts after package import by using the switch execute-after-import-maintenance-script with the aim alias. The switch takes true or false values.

When true or not specified, after importing a Digital Solution Package, the FtosSysPkgDeployer.exe executes maintenance scripts. When false, maintenance scripts are not executed. The switch's default value is true.

Examples:

FtosSysPkgDeployer.exe -i -s <value> -u <value> -p <value> --execute-after-import-maintenance-script false
FtosSysPkgDeployer.exe -i -s <value> -u <value> -p <value> --aim false