App Administration
Fusion Project Portal Config Ids.
Name | ID | Env | Fusion Env | Description |
---|---|---|---|---|
Project Portal | 24843980-c0bb-42ce-f082-08db31e659d1 | prod | FPRD | Used for production |
Project Portal | 0177ef5f-c49e-4d2a-7907-08db31e4e851 | test | CI | Used for test |
Project Portal | 5b43c3fd-77e3-4072-0aa1-08db310ee26d | feature | CI | Project portal feature branch configuration |
Onboard a Fusion Application
To onboard a Fusion App, we need to know the following:
- App Key. This is the unique Fusion App Key. Can be obtained from the Fusion App API
- Is Legacy**. Simple Identifier of legacy fusion applications bit can be deprecated.
- App Group ID **. App Groups is deprecated but required to onboard a fusion application. The ID can be obtained by querying the App Groups endpoint.
- Context Types. This is the supported context types of the current application.
- Is Legacy - A new way of distinguishing legacy form new applications have been implemented from v3.0.0
- App Group ID - The reason for deprecation is to make the portal API simpler and more efficient. Starting from v3.0.0 the appCategory is part of the application manifest. This means that the appCategory defined in the application manifest is the one used in the portal. This reduces manual work since the category only needs to be defined once.
When you have found the these values, you can proceed with onboarding a Fusion App by doing the following:
POST: /api/onboarded-apps
Request Body:
{
"appKey": "string",
"isLegacy": true,
"appGroupId": "string",
"contextTypes": [
"string"
]
}
Remove an onboarded Fusion App
You can remove an onboarded Fusion App so that it's no longer available for consumption in the Project Portal. This will also remove all Work Surface Apps that might have been connected to the Fusion App earlier on.
DELETE: /api/onboarded-apps/{appKey}
Add Context Types to existing application
Remove Context Types to existing application
Enabling Apps in the Project Portal
- App Groups and Portals must have been created.
- At least one Fusion App must be onboarded.
- Optionally one Fusion Context must be onboarded (not applicable for global apps)
Onboarding Fusion Apps and Contexts does not automatically make apps available. To make an app visible, an Onboarded App and (optionally) an Onboarded Context must be connected to a Portal.
Let's make an Onboarded App available:
Adding a global Portal App
A global app means that ALL contexts have access to this app, even if the context is not onboarded.
To add a global app, we need to know the following:
- App Key. This is the unique Fusion App Key. Can be obtained from the Fusion App API
- Portal ID. The ID can be obtained by querying the Portals endpoint of from the table at the start of this document.
POST: /api/portals/{portalId}/apps
Request Body:
{
"appKey": "unique-fusion-app-key-of-onboarded-app"
}
Adding a context-specific Work Surface App
By adding a context-specific app, this app will ONLY be visible for a certain context.
To add a context-specific app, we need to know the following:
- Context Id of the context (a GUID). This can be obtained from the Fusion Context API
- App Key. This is the unique Fusion App Key. Can be obtained from the Fusion App API
- Portal ID. The ID can be obtained by querying the Portals endpoint of from the table at the start of this document.
POST: /api/portals/{portalId}/contexts/{contextId}/apps
Request Body:
{
"appKey": "unique-fusion-app-key-of-onboarded-app"
}
Removing Work Surface Apps
You can remove any app that you previously have added from a Work Surface - either it be globally or context-specific. This will essentially make the app unavailable. It will not remove the Onboarded App or the Onboarded Context.
To remove a Work Surface App, we need to know the following:
- (optional)- Context Id of the context (a GUID). This can be obtained from the Fusion Context API
- App Key. This is the unique Fusion App Key. Can be obtained from the Fusion App API
- Portal ID. The ID can be obtained by querying the Portals endpoint of from the table at the start of this document.
Remove a Global Work Surface App
DELETE: /api/portals/{portalId}/apps/{{appKey}}
Remove a context-specific Work Surface app
DELETE: /api/portals/{portalId}/contexts/{contextId}/apps/{appKey}