alfresco-ng2-components/docs/process-content.service.md

Process Content Service

Manipulate content related to a Process Instance or Task Instance in APS. Related content can be uploaded to APS via for example a file upload dialog.

At the moment you must provide the `ProcessContentService` class from your `NgModule` for it to work: ```ts @NgModule({ ... providers: [ProcessContentService] }) ``` And also import it in the way shown below.

Importing

import { RelatedContentRepresentation } from 'alfresco-js-api';
import { ProcessContentService } from 'ng2-activiti-form/src/services/process-content.service';

export class SomePageComponent implements OnInit {

  constructor(private contentService: ProcessContentService) {
  }

Methods

createProcessRelatedContent(processInstanceId: string, content: any, opts?: any): Observable

Associate an uploaded file with a Process Instance.

Let's say we have an upload button as follows:

  <div class="button-row">
    <button mat-button color="accent" mat-mini-fab (click)="fileInput.click()">
      <mat-icon>attachment</mat-icon>
    </button>
    <input hidden type="file" #fileInput (change)="onUploadFile($event)"/>
  </div>

We can then create related content as follows:

export class SomePageComponent implements OnInit {

  @ViewChild('fileInput') fileInput;

...

  onUploadFile() {
    const fileBrowser = this.fileInput.nativeElement;
    if (fileBrowser.files && fileBrowser.files[0]) {
      const file: File =  fileBrowser.files[0];
      const processInstanceId = '11337';
      const opts = {
        isRelatedContent: true
      };
      this.contentService.createProcessRelatedContent(processInstanceId, file, opts).subscribe(
        (relContent: RelatedContentRepresentation)  => {
          console.log('Related content: ', relContent);
       }, error => {
            console.log('Error: ', error);
       });
    }
  }

In the above sample code the file is uploaded via an HTML input element. The processInstanceId refers to a process instance ID for a running process in APS.
The returned relContent object looks like in this sample:

Related content:     
    contentAvailable: true
    created: Wed Nov 08 2017 10:50:30 GMT+0000 (GMT) {}
    createdBy: {id: 1, firstName: null, lastName: "Administrator", email: "admin@app.activiti.com"}
    id: 6007
    link: false
    mimeType: "application/pdf"
    name: "simple.pdf"
    previewStatus: "queued"
    relatedContent: true
    simpleType: "pdf"
    thumbnailStatus: "queued"

The related content id can be used by other methods in this service to get to the content and to delete it. It is referred to as the contentId.

If you look at attachments for the process instance it should now display the new file.

createTaskRelatedContent(taskId: string, file: any, opts?: any)

Associate an uploaded file with a Task Instance. This is in effect very similar to the createProcessRelatedContent call. Just use taskInstanceId instead of processInstanceId.

onUploadFile() {
    const fileBrowser = this.fileInput.nativeElement;
    if (fileBrowser.files && fileBrowser.files[0]) {
      const file: File =  fileBrowser.files[0];
      const taskInstanceId = '15303';
      const opts = {
        isRelatedContent: true
      };
      this.contentService.createTaskRelatedContent(taskInstanceId, file, opts).subscribe(
        (relContent: RelatedContentRepresentation)  => {
          console.log('Related content: ', relContent);
       }, error => {
            console.log('Error: ', error);
       });
    }
}

For more information see the docs for createProcessRelatedContent.

createTemporaryRawRelatedContent(file: any): Observable

Create temporary related content from an uploaded file. This means that the related content is not yet associated with a process instance or a task instance.

  onUploadFile() {
    const fileBrowser = this.fileInput.nativeElement;
    if (fileBrowser.files && fileBrowser.files[0]) {
      const file: File =  fileBrowser.files[0];
      this.contentService.createTemporaryRawRelatedContent(file).subscribe(
        (relContent: RelatedContentRepresentation)  => {
          console.log('Related content: ', relContent);
        }, error => {
             console.log('Error: ', error);
        });
    }
  }

For more information see the docs for createProcessRelatedContent.

deleteRelatedContent(contentId: number): Observable

Delete related content via the content identifier:

 const contentId = 6008;
 this.contentService.deleteRelatedContent(contentId).subscribe(
    res  => {
      console.log('Delete response: ', res);
    }, error => {
         console.log('Error: ', error);
    });

The response is going to be null if the delete was successful.

See getProcessRelatedContent and getTaskRelatedContent for how to get to the contentId.

getContentThumbnail(contentId: number): Observable

Get the thumbnail URL for related content (currently does not return this):

 const contentId = 6008;
 this.contentService.getContentThumbnail(contentId).subscribe(
   res  => {
     console.log('Response: ', res);
   }, error => {
     console.log('Error: ', error);
   });

The response looks like in this sample:

Blob {size: 3020946, type: "image/png"}

See getProcessRelatedContent and getTaskRelatedContent for how to get to the contentId.

getFileContent(contentId: number): Observable

Get the metadata for a related content item in the format of a RelatedContentRepresentation object:

const contentId = 6008;
this.contentService.getFileContent(contentId).subscribe(
   res  => {
     console.log('Response: ', res);
   }, error => {
     console.log('Error: ', error);
   });

The response looks like in this example:

contentAvailable: true
created: Wed Nov 08 2017 11:26:14 GMT+0000 (GMT) {}
createdBy: {id: 1, firstName: null, lastName: "Administrator", email: "admin@app.activiti.com"}
id: 6008
link: false
mimeType: "application/pdf"
name: "simple.pdf"
previewStatus: "created"
relatedContent: true
simpleType: "pdf"
thumbnailStatus: "created"

See getProcessRelatedContent and getTaskRelatedContent for how to get to the contentId.

getFileRawContentUrl(contentId: number): string

Get the URL for direct access to a related content file:

const contentId = 6008;
const url = this.contentService.getFileRawContentUrl(contentId);
console.log('URL: ', url);

The URL response looks something like this:

http://localhost:4200/bpm/activiti-app/api/enterprise/content/6008/raw

This URL can be used to directly access the content file, such as from a browser.

See getProcessRelatedContent and getTaskRelatedContent for how to get to the contentId.

getProcessRelatedContent(processId: string): Observable

Get related content items for passed in Process Instance ID, only metadata for related content is returned:

const processId = '11337';
this.contentService.getProcessRelatedContent(processId).subscribe(
   res  => {
    console.log('Response: ', res);
   }, error => {
    console.log('Error: ', error);
   });

The response looks like in the following sample:

size: 2
start:0
total:2
data:
    0:
        contentAvailable: true
        created: "2017-10-29T07:28:15.546+0000"
        createdBy: {id: 1, firstName: null, lastName: "Administrator", email: "admin@app.activiti.com"}
        id: 5006
        link: false
        mimeType: "application/msword"
        name: "More info for Invoice.doc"
        previewStatus: "created"
        relatedContent: true
        simpleType: "word"
        thumbnailStatus: "created"
    1:
        id: 6008, 
        name: "simple.pdf", 
        created: "2017-11-08T11:26:14.162+0000", 
        createdBy: {…}, 
        relatedContent: true, 
        …}

The id property corresponds to the contentId property used in many of the other methods of this service.

getTaskRelatedContent(taskId: string): Observable

Get related content items for passed in Task Instance ID, only metadata for related content is returned:

const taskId = '15303';
this.contentService.getTaskRelatedContent(taskId).subscribe(
   res  => {
     console.log('Response: ', res);
   }, error => {
     console.log('Error: ', error);
   });

The response format is the same as for the getProcessRelatedContent method, see its docs.