mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
66d8935624
* Demo shell pagination bug fix * tslint error fix * user preferences service fix * refactor * refactor * refactor * unit tests added * unit tests fix * [ADF-2676] added documentation for app config onChange stream * [ADF-2676] renamed onChange stream to onLoad stream * [ADF-2676] fixed test
125 lines
3.4 KiB
Markdown
125 lines
3.4 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
---
|
|
# App Config service
|
|
|
|
Supports app configuration settings, stored server side.
|
|
|
|
## Details
|
|
|
|
The `AppConfigService` service provides support for loading and accessing global application configuration settings that you store on the server side in the form of a JSON file.
|
|
|
|
You may need this service when deploying your ADF-based application to production servers.
|
|
|
|
There can be more than one server running web apps with different settings, like different addresses for Alfresco Content/Process services.
|
|
|
|
Or there is a need to change global settings for all the clients.
|
|
|
|
The service is already pre-configured to look for the "app.config.json" file in the application root address.
|
|
|
|
That allows deploying ADF-based web applications to multiple servers together with different settings files, for example having development, staging or production environments.
|
|
|
|
Example of the default settings file content:
|
|
|
|
**app.config.json**
|
|
|
|
```json
|
|
{
|
|
"ecmHost": "http://localhost:3000/ecm",
|
|
"bpmHost": "http://localhost:3000/bpm",
|
|
"application": {
|
|
"name": "Alfresco"
|
|
}
|
|
}
|
|
```
|
|
|
|
Please note that settings above are default ones coming with the server.
|
|
You can override the values in your custom `app.config.json` file if needed.
|
|
|
|
You can also change the path or name of the configuration file when importing the CoreModule in your main application.
|
|
|
|
```ts
|
|
...
|
|
@NgModule({
|
|
imports: [
|
|
...
|
|
CoreModule.forRoot({
|
|
appConfigFile: 'app.production.config.json'
|
|
})
|
|
],
|
|
...
|
|
}
|
|
export class AppModule { }
|
|
```
|
|
|
|
Below is a simple example of using the AppConfigService in practice.
|
|
|
|
**app.component.ts**
|
|
|
|
```ts
|
|
import { AppConfigService } from '@alfresco/adf-core';
|
|
|
|
@Component({...})
|
|
export class AppComponent {
|
|
|
|
constructor(appConfig: AppConfigService) {
|
|
|
|
// get nested properties by the path
|
|
console.log(appConfig.get('application.name'));
|
|
|
|
// use generics for type safety
|
|
let version: number = appConfig.get<number>('version');
|
|
console.log(version);
|
|
}
|
|
}
|
|
```
|
|
|
|
Your custom components can also benefit from the `AppConfigService`,
|
|
you can put an unlimited number of settings and optionally a nested JSON hierarchy.
|
|
|
|
### Variable substitution in configuration strings
|
|
|
|
The `AppConfigService` also supports a limited set of variable substitutions to greatly simplify certain scenarios.
|
|
|
|
```json
|
|
{
|
|
"ecmHost": "http://{hostname}:{port}/ecm",
|
|
"bpmHost": "http://{hostname}:{port}/bpm",
|
|
"application": {
|
|
"name": "Alfresco"
|
|
}
|
|
}
|
|
```
|
|
|
|
The supported variables are:
|
|
|
|
| Variable name | Runtime value |
|
|
| ------------- | ------------- |
|
|
| hostname | `location.hostname` |
|
|
| port | `location.port` |
|
|
|
|
## App Config onLoad Stream
|
|
When the app config is loaded correctly an onChange event is sent with the whole set app config properties. This comes in handy when a component wants to react to some property change or interact with the app config when it's correctly loaded.
|
|
|
|
```ts
|
|
|
|
appConfig.onLoad.subscribe((appConfig) => {
|
|
console.log(appConfig); //this is the representation of the app-config
|
|
});
|
|
```
|
|
|
|
We have added also the `select` method where the user can give the property name which wants to be notified the when the app config is loaded and get the value.
|
|
|
|
```json
|
|
appconfig : {
|
|
logLevel : 'trace'
|
|
}
|
|
```
|
|
|
|
```ts
|
|
|
|
appConfig.select('logLevel').subscribe((logLevelValue) => {
|
|
console.log(logLevelValue); //this will be 'trace';
|
|
});
|
|
``` |