[ADF-1549] Added docs for Upload, Userinfo, Viewer and Webscript (#2359)

2025-07-24 17:32:15 +00:00 · 2017-09-20 18:12:02 +01:00
parent 5cf61e319f
commit a3020897ed
18 changed files with 726 additions and 16 deletions
--- a/docs/webscript.component.md
+++ b/docs/webscript.component.md
@@ -0,0 +1,175 @@
+# Alfresco Webscript Get component
+
+<!-- markdown-toc start - Don't edit this section.  npm run toc to generate it-->
+
+<!-- toc -->
+
+- [Basic usage](#basic-usage)
+  * [Properties](#properties)
+- [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)
+
+<!-- tocstop -->
+
+<!-- markdown-toc end -->
+
+## Basic usage
+
+```html
+<adf-webscript-get 
+    [scriptPath]="string"
+    [scriptArgs]="Object"
+    [contextRoot]="string"
+    [servicePath]="string"
+    [showData]="boolean"
+    [contentType]="JSON | HTML | DATATABLE | TEXT"
+    (onSuccess)= "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';
+}
+```
+
+### Properties
+
+| Attribute | Type | Default | Description |
+| --- | --- | --- | --- |
+| scriptPath | string | |  (**mandatory**) path to Web Script (as defined by Web Script) |
+| scriptArgs | Object | | arguments to pass to Web Script |
+| contextRoot | string | | path where application is deployed | 
+| scriptPath | string | alfresco |  path to Web Script (as defined by Web Script) | 
+| contentType | string | service | path where Web Script service is mapped default value | 
+| contentType | string | TEXT | how to handle the data received from the web script JSON , HTML , DATATABLE or TEXT |
+| onSuccess | event | |  You can get the plain data from the webscript through the **onSuccess** event parameter and use it as you need in your application |
+| showData | booleann | true | render the webscript data |
+
+**contentType** {string}  
+***data***      {string}  data containing the plain value you get from the webscipt as an output parameter
+
+## Details
+
+### Webscript View HTML example
+
+This sample demonstrates how to implement a Webscript component 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 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 ng2-alfresco-datatable you have to return from the GET of the webscript the datastructure below:
+subdivide in data and schema
+
+```ts
+data: [],
+schema: []
+```
+
+this 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
+}]
+```
+
+or 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'}
+]]
+```
+
+that will render the following table
+
+![Custom columns](../docassets/images/datatable.png)
+
+### Webscript View JSON example
+
+This sample demonstrates how to implement a Webscript component that renders the JSON 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/JSON%EXAMPLE```
+
+```html
+<adf-webscript-get 
+    [scriptPath]="scriptPath"
+    [contextRoot]="'alfresco'"
+    [servicePath]="'service'";
+    [scriptPath]="'Sample/folder/JSON_EXAMPLE'"
+    [contentType]="'HTML'"
+    [showData]="false"
+    (onSuccess)="logDataExample($event)">
+</adf-webscript-get>
+``` 
+
+You can get the plain data from the webscript through the **onSuccess** event parameter and use it as you need in your application
+
+```ts
+logDataExample(data) {
+    console.log('You webscript data are here' + data);
+}
+```