This guide assists in migrating from FlowX v4.1.x to v4.6.0.
locale
was added in order to improve formatting the dates, numbers and currencies.
When the SDK initialization happens through the FlowxSdkApi.getInstance().init(...)
method, the argument must be included inside the config: SdkConfig
parameter value:
Name | Description | Type | Requirement |
---|---|---|---|
projectId | The id of the project containing the process to be started | String | Mandatory |
onProcessEnded | Callback function where you can do additional processing when the started process ends | (() -> Unit)? | Optional. It defaults to null . |
Name | Description | Type | Requirement |
---|---|---|---|
onProcessEnded | Callback function where you can do additional processing when the continued process ends | (() -> Unit)? | Optional. It defaults to null . |
CustomViewComponent
is now ignored in the internals of the SDK and has been marked as @Deprecated
, in order to be completely removed in the next release.
changeLanguage
method has been updated and renamed to changeLocaleSettings
, in order to accommodate the newly added locale
config parameter:
locale
was added in order to improve formatting the dates, numbers and currencies.
The locale needs to be set on the FXConfig.sharedInstance.configure
method
Name | Description | Type | Requirement |
---|---|---|---|
projectId | The uuid string of the project containing the process to be started | String | Mandatory |
onProcessEnded | Callback function where you can do additional processing when the started process ends | (() -> Void)? | Optional. It defaults to nil . |
Name | Description | Type | Requirement |
---|---|---|---|
onProcessEnded | Callback function where you can do additional processing when the started process ends | (() -> Void)? | Optional. It defaults to nil . |
FXDataSource
protocol. Update conformance to protocol by adding the implementation of the new func.
changeLanguage
method has been updated and renamed to changeLocaleSettings
, in order to accommodate the newly added locale
config parameter:
Remove old packages and their explicit dependencies (required dependency packages for new sdks are bundled in the libraries so we don't need)
material-moment-adapter
unless its not used in custom components (usually together with material datepicker) and also the moment
package (unless used elsewhere in the project )angular.json
remove references to old stylesheets:Angular Flex
library (the new sdks don’t use it anymore and the package has been deprecated by the Angular team) unless it is not used in container app or custom componentsUpdate container app to Angular 18
ng --version
)NgRx
) please run migrations to v18 for each of them before proceeding. You can find details on the libraries documentation pages.
dist
folder, it now uses a browser
folder for the build output. In order to place the output of the build command directly in the dist/[APP_NAME]
folder, add the following change in angular.json
:
Update container app to Angular 19
ng --version
)NgRx
) please run migrations to v19 for each of them before proceeding. You can find details on the libraries documentation pages.
target
and module
settings in the tsconfig.json
file to the new version, although be advised that this might require additional changes in the codebase due to new compilation errors that might arise.
Install the new FlowX SDK packages
package.json
file to force the library to use the new Angular version.ng2-pdfjs-viewer
library has a dependency on Angular version 18 and will not work with the installed Angular version 19. To force the library to use the new Angular version, add the following override in the package.json
file:<flx-process-renderer>
component has two new parameters have been introduced: projectInfo
and locale
. These additions help support localization and project-specific configurations.
Name | Description | Type | Requirement |
---|---|---|---|
projectInfo | Object containing an projectId key, which identifies the project of the process to be started | {projectId: string} | Mandatory |
locale | Provides region-specific settings for localization. | string | Mandatory |
<flx-process-renderer>
component:
Category | Old Approach | New Approach |
---|---|---|
Process Renderer | FlxProcessModule.forRoot({...}) | FlxProcessModule.withConfig({...}) |
Category | Old Approach | New Approach |
---|---|---|
Import Paths | @flowx/ui-sdk | @flowx/angular-sdk (or, in some cases @flowx/core-sdk ) |
@flowx/ui-theme | @flowx/angular-theme | |
@flowx/ui-toolkit | @flowx/angular-ui-toolkit | |
Process Module | import {FlxProcessModule} from '@flowx/ui-sdk'; | import {FlxProcessModule} from @flowx/angular-sdk |
Localization Module | import {FlxLocalizationModule} from '@flowx/ui-sdk'; Include in module imports | import {FlxLocalizePipe} from '@flowx/angular-sdk'; Remove from module imports |
Task Management | import {FlxTaskManagementModule} from '@flowx/ui-sdk'; | import {FlxTasksManagementComponent} from '@flowx/angular-sdk'; |
Client Store Interface | import {ClientStoreInterface} from '@flowx/ui-sdk'; | import {ClientStoreInterface} from '@flowx/core-sdk'; |
FlxLocalizationModule
from any imports
arrays in modules, and import the FlxLocalizePipe
insteadwithExtraIconSet
method has been replaced with provideExtraIconSet
, which should now be used in the providers array.
HttpClient
to make API calls, so existing interceptors must be adapted to a new format, for Request Interceptos (eg. custom headers) and Response Interceptors (eg. error handling)
For an overview of implementation details, please refer to the respective sections of the renderer documentation for the new API changes.