[ADF-4152] Restructured Content Services docs (#4429)

* [ADF-4152] Moved content services docs to subfolders * [ADF-4152] Manual URL fixes for cont services docs * [ADF-4152] Moved content services docs to subfolders * [ADF-4152] Manual URL fixes for cont services docs * [ADF-4152] Updated doc index pages for content services
2025-07-24 17:32:15 +00:00 · 2019-03-13 18:44:37 +00:00
parent bc5208b767
commit dfea5c2f04
72 changed files with 958 additions and 1055 deletions
--- a/docs/content-services/components/webscript.component.md
+++ b/docs/content-services/components/webscript.component.md
@@ -0,0 +1,185 @@
+---
+Title: Webscript component
+Added: v2.0.0
+Status: Active
+Last reviewed: 2018-11-14
+---
+
+# [Webscript component](../../../lib/content-services/webscript/webscript.component.ts "Defined in webscript.component.ts")
+
+Provides access to Webscript features.
+
+## Contents
+
+-   [Basic usage](#basic-usage)
+-   [Class members](#class-members)
+    -   [Properties](#properties)
+    -   [Events](#events)
+-   [Details](#details)
+    -   [Webscript View HTML example](#webscript-view-html-example)
+    -   [Webscript View DATATABLE example](#webscript-view-datatable-example)
+    -   [Webscript View JSON example](#webscript-view-json-example)
+
+## Basic usage
+
+```html
+<adf-webscript-get 
+    [scriptPath]="string"
+    [scriptArgs]="Object"
+    [contextRoot]="string"
+    [servicePath]="string"
+    [showData]="boolean"
+    [contentType]="JSON | HTML | DATATABLE | TEXT"
+    (success)= "logData($event)">
+ </adf-webscript-get>
+```
+
+Another example:
+
+**app.component.html**
+
+```html
+<adf-webscript-get 
+    [scriptPath]="scriptPath"
+    [scriptArgs]="scriptArgs"
+    [contextRoot]="contextRoot"
+    [servicePath]="servicePath" 
+    [contentType]="'HTML'">
+</adf-webscript-get>
+```
+
+**app.component.ts**
+
+```ts
+export class AppComponent {
+    scriptPath: string = 'sample/folder/Company%20Home';
+    contextRoot: string = 'alfresco';
+    servicePath: string = 'service';
+}
+```
+
+## Class members
+
+### Properties
+
+| Name | Type | Default value | Description |
+| ---- | ---- | ------------- | ----------- |
+| contentType | `string` | "TEXT" | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" |
+| contextRoot | `string` | "alfresco" | Path where the application is deployed |
+| scriptArgs | `any` |  | Arguments to pass to the webscript. |
+| scriptPath | `string` |  | (required) Path to the webscript (as defined by webscript). |
+| servicePath | `string` | "service" | Path that the webscript service is mapped to. |
+| showData | `boolean` | true | Toggles whether to show or hide the data. |
+
+### Events
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. |
+
+## Details
+
+### Webscript View HTML example
+
+This sample demonstrates how to implement a [Webscript component](webscript.component.md) that renders the HTML contents that come from a webscript
+This sample Web Scripts reside in your Alfresco Server. You can access the folder webscript here:
+
+`http://localhost:8080/alfresco/service/sample/folder/Company%20Home`
+
+```html
+<adf-webscript-get 
+    [scriptPath]="scriptPath"
+    [contextRoot]="'alfresco'"
+    [servicePath]="'service'";
+    [scriptPath]="'Sample/folder/Company%20Home'"
+    [contentType]="'HTML'">
+</adf-webscript-get>
+```
+
+![Custom columns](../../docassets/images/HTML.png)                         
+
+### Webscript View DATATABLE example
+
+This sample demonstrates how to implement a [Webscript component](webscript.component.md) that renders the JSON contents that come from a webscript
+
+`http://localhost:8080/alfresco/service/sample/folder/DATATABLE`
+
+```html
+<adf-webscript-get 
+    [scriptPath]="scriptPath"
+    [contextRoot]="'alfresco'"
+    [servicePath]="'service'";
+    [scriptPath]="'Sample/folder/DATATABLE'"
+    [contentType]="'DATATABLE'">
+</adf-webscript-get>
+```
+
+If you want to show the result from a webscript inside a 
+[datatable component](../../core/components/datatable.component.md)
+you have to return the data structure below (subdivided into data and
+schema) from the GET method of the webscript:
+
+```ts
+data: [],
+schema: []
+```
+
+Here is an example: 
+
+```ts
+data: [
+    {id: 1, name: 'Name 1'},
+    {id: 2, name: 'Name 2'}
+],
+schema: [{
+    type: 'text',
+    key: 'id',
+    title: 'Id',
+    sortable: true
+}, {
+    type: 'text',
+    key: 'name',
+    title: 'Name',
+    sortable: true
+}]
+```
+
+Alternatively, you can send just the array data and the component will create a schema for you: 
+
+```ts
+data: [
+    {id: 1, name: 'Name 1'},
+    {id: 2, name: 'Name 2'}
+]]
+```
+
+This will render the following table:
+
+![Custom columns](../../docassets/images/datatable.png)
+
+### Webscript View JSON example
+
+This sample demonstrates how to implement a [Webscript component](webscript.component.md) that renders the JSON contents that come from a webscript.
+This sample webscript resides in your Alfresco Server. You can access the folder webscript here:
+
+`http://localhost:8080/alfresco/service/sample/folder/JSON%EXAMPLE`
+
+```html
+<adf-webscript-get 
+    [scriptPath]="scriptPath"
+    [contextRoot]="'alfresco'"
+    [servicePath]="'service'";
+    [scriptPath]="'Sample/folder/JSON_EXAMPLE'"
+    [contentType]="'HTML'"
+    [showData]="false"
+    (success)="logDataExample($event)">
+</adf-webscript-get>
+```
+
+You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application
+
+```ts
+logDataExample(data) {
+    console.log('Your webscript data is here' + data);
+}
+```