Overview
The VenziaDatalinkApiService is an Angular service that provides methods to interact with Alfresco datalink web scripts. It handles loading datalink configurations from the repository.
Import
import { VenziaDatalinkApiService } from 'venzia-datalink';
Injectable
@Injectable({
providedIn: 'root'
})
Constructor
constructor(
private apiService: AlfrescoApiService,
private logService: LogService
)
Alfresco API service for making HTTP calls
ADF logging service for error handling
Methods
loadDataLink
Loads the list of configured datalinks from the Alfresco repository.
loadDataLink(): Observable<any>
Observable that emits the datalink configuration array
Returns
Returns an Observable containing an array of datalink configurations. Each configuration includes:
name: Datalink nameaspectPropertyName: Alfresco property where data is storedcolumns: Array of column definitionsconnectorRest: REST API configuration for external data
Example
import { Component, OnInit } from '@angular/core';
import { VenziaDatalinkApiService } from 'venzia-datalink';
@Component({
selector: 'app-my-component',
template: `
<div *ngFor="let datalink of datalinks">
{{ datalink.name }}
</div>
`
})
export class MyComponent implements OnInit {
datalinks: any[] = [];
constructor(private datalinkApi: VenziaDatalinkApiService) {}
ngOnInit() {
this.datalinkApi.loadDataLink().subscribe(
(data) => {
this.datalinks = data;
console.log('Loaded datalinks:', data);
},
(error) => {
console.error('Failed to load datalinks:', error);
}
);
}
}
Private Methods
handleError
Handles errors from web script calls.
private handleError(error: any): Observable<never>
Error object from the HTTP call
Observable that throws the error
executeWebScript
Executes an Alfresco web script with the specified parameters.
private executeWebScript(
httpMethod: string,
scriptPath: string,
scriptArgs?: any,
contextRoot?: string,
servicePath?: string,
postBody?: any
): Promise<any>
HTTP method: GET, POST, PUT, or DELETE
Path to the web script (e.g., ‘aqua/datalink/v1/list’)
Query parameters for the web script
Context root for the web script
Service path for the web script
Request body for POST/PUT requests
Implementation Details
import { Injectable } from '@angular/core';
import { LogService } from '@alfresco/adf-core';
import { from, Observable, throwError } from 'rxjs';
import { catchError } from 'rxjs/operators';
import { AlfrescoApiService } from '@alfresco/adf-content-services';
@Injectable({
providedIn: 'root'
})
export class VenziaDatalinkApiService {
constructor(
private apiService: AlfrescoApiService,
private logService: LogService
) {}
loadDataLink(): Observable<any> {
return from(
this.executeWebScript('GET', 'aqua/datalink/v1/list', null, null, 'service', null)
).pipe(
catchError((err) => this.handleError(err))
);
}
private handleError(error: any) {
this.logService.error(error);
return throwError(error || 'Server error');
}
private executeWebScript(
httpMethod: string,
scriptPath: string,
scriptArgs?: any,
contextRoot?: string,
servicePath?: string,
postBody?: any
): Promise<any> {
contextRoot = contextRoot || 'alfresco';
servicePath = servicePath || 'service';
postBody = postBody || null;
const allowedMethod: string[] = ['GET', 'POST', 'PUT', 'DELETE'];
if (!httpMethod || allowedMethod.indexOf(httpMethod) === -1) {
throw new Error('method allowed value GET, POST, PUT and DELETE');
}
if (!scriptPath) {
throw new Error('Missing param scriptPath in executeWebScript');
}
const contentTypes = ['application/json'];
const accepts = ['application/json', 'text/html'];
return this.apiService
.getInstance()
.contentClient.callApi(
scriptPath,
httpMethod,
{},
scriptArgs,
{},
{},
postBody,
contentTypes,
accepts,
null,
contextRoot + '/' + servicePath
);
}
}
Error Handling
The service includes error handling that:
- Logs errors using the ADF LogService
- Returns an Observable error for component handling
- Validates HTTP methods and required parameters
Dependencies
@angular/core: Angular framework@alfresco/adf-core: ADF core services (LogService)@alfresco/adf-content-services: Alfresco API servicerxjs: Reactive programming support
See Also
