Install the App
- How do I install the COSMO Data Integration Framework in a SaaS environment?
- How do I install the COSMO Data Integration Framework in an on-premises environment?
- What are the dependencies of the COSMO Data Integration Framework app?
- How do I install the COSMO Data Integration Framework app in a docker container?
- How do I install the COSMO Data Integration Framework app in a server instance?
Tip
Summary: This article provides instructions for installing the COSMO Data Integration Framework in both SaaS and On-Premises environments. In SaaS environments, the app can be installed from AppSource or the Extension Marketplace. In On-Premises environments, the app can be installed using Docker or a Server Instance. Additionally, the app requires the installation of the COSMO Licensing, COSMO Template Catalog, and COSMO Data Integration Framework apps in the correct order.
This section covers the installation of the COSMO Data Integration Framework. Typically an installation is only performed once and is not executed by the user, but an administrator. The installation differs from SaaS and On-Premises (OnPrem) environment.
To install in SaaS environment
In SaaS environments, the app can be installed from the AppSource. There are two ways to install the app, from external and internal of Business Central. All dependencies are installed automatically. Uninstall and install the app again to upgrade to the most current version.
AppSource
Visit the AppSource and choose Free Trial. You will be forwarded to page where you must log in with your Business Central user credentials and must select an environment to install the app to. Follow the wizard instructions to complete the installation.
Extension Marketplace
In Business Central choose the icon, enter Extension Marketplace, and then choose the related link. In the marketplace search for COSMO Data Integration Framework and select Free Trial. Follow the wizard instructions to complete the installation.
To install in on-premises environment
Depending on the technology, different scripts are provided as basis to install the app and its requirements in on-premises environments. You can find the compiler packages of the apps in the COSMO CONSULT Solution Portal. Check the technical specifications of each version to find the minimum dependent version of Business Central and the Base Application. For customer installations without a Business Central developer license, you need to create and install a runtime package of the app (Microsoft Documentation).
Besides the Business Central Base Application, the app depends on additional library apps, that needs to be installed in the correct order, first.
- COSMO Licensing app
- COSMO Template Catalog app
- COSMO Data Integration Framework app
Docker
To install the apps to a docker container, the module BcContainerHelper must be installed, first. Change the file names, container name and credential type to your values.
$licensingAppFileName = Join-Path $PSScriptRoot "COSMO Licensing.app"
$templateAppFileName = Join-Path $PSScriptRoot "COSMO Template Catalog.app"
$difAppFileName = Join-Path $PSScriptRoot "COSMO Data Integration Framework.app"
$Global:containerName = "your-container-name"
$Global:credential = "your-credential"
function Install-CosmoAppToContainer {
Param (
[Parameter(Mandatory=$true)]
[string] $AppFileName
)
Publish-BcContainerApp `
-appFile $AppFileName `
-containerName $Global:containerName `
-credential $Global:credential `
-install `
-sync `
-skipVerification `
-scope "Global" `
-syncMode "Add"
}
try {
if (!(Get-Module -ListAvailable -Name "BcContainerHelper")) { throw "BcContainerHelper must be installed to run this script." }
Install-CosmoAppToContainer -AppFileName $licensingAppFileName
Install-CosmoAppToContainer -AppFileName $templateAppFileName
Install-CosmoAppToContainer -AppFileName $difAppFileName
} catch {
throw "Error on installation: $($_.Exception.Message)"
}
Server Instance
Change the file names and server instance to your values.
$licensingAppFileName = Join-Path $PSScriptRoot "COSMO Licensing.app"
$templateAppFileName = Join-Path $PSScriptRoot "COSMO Template Catalog.app"
$difAppFileName = Join-Path $PSScriptRoot "COSMO Data Integration Framework.app"
$Global:serverInstance = "your-server-instance"
function Install-CosmoAppToServerInstance {
Param (
[Parameter(Mandatory=$true)]
[string] $AppFileName,
[Parameter(Mandatory=$true)]
[string] $AppName
)
Publish-NAVApp `
-ServerInstance $Global:serverInstance `
-Path $AppFileName `
-SkipVerification `
-Scope Global
Sync-NAVApp `
-ServerInstance $Global:serverInstance `
-Name $AppName
Install-NAVApp `
-ServerInstance $Global:serverInstance `
-Name $AppName
}
try {
Install-CosmoAppToServerInstance -AppFileName $licensingAppFileName -AppName "COSMO Licensing"
Install-CosmoAppToServerInstance -AppFileName $templateAppFileName -AppName "COSMO Template Catalog"
Install-CosmoAppToServerInstance -AppFileName $difAppFileName -AppName "COSMO Data Integration Framework"
} catch {
throw "Error on installation: $($_.Exception.Message)"
}
See Also
Feedback
Submit feedback for this page .