inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-06-30 18:15:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-1880] processDefinitionId parameter in adf-start-process (#2848)

Browse Source 
* processDefinitionId parameter in adf-start-process

* fix test

* fix test
This commit is contained in:
Eugenio Romano 2018-01-19 11:04:03 +00:00 committed by GitHub
parent e883f5c83d
commit 807d7e0f78
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 142 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/start-process.component.md
View File

@ -18,6 +18,7 @@ Starts a process.
| --- | --- |
| appId | (required): Limit the list of processes which can be started to those contained in the specified app |
| name | (optional) name to assign to the current process |
| processDefinitionId| (optional) definition ID of the process to start |
| variables | Variables in input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md)|
| values | Parameter to pass form field values in the start form if is associated |
@ -29,6 +30,24 @@ Starts a process.
| cancel | Raised when the process canceled |
| error | Raised when the start process fail |
### Details
- If your app has only one processDefintion it will be automaticaly gather from the ***adf-start-process***.
- If your app has multiple processDefintion and you didn't define processDefinitionId parameter a drop down will allow you to select which use
- If your app has multiple processDefintion and you defined the processDefinitionId parameter the ***adf-start-process*** will be automatically instantiated with the selected process.
### Start a process with processDefinitionId
```html
<adf-start-process
[appId]="YOUR_APP_ID"
[processName]="PROCESS_NAME"
[processDefinitionId]="PROCESS_DEF_ID">
</adf-start-process>
```
If you have more then one process in yor app you can in this way preselect which is the process to start
### Custom data example

8
lib/process-services/mock/process/start-process.component.mock.ts
View File

@ -29,7 +29,13 @@ export let testProcessDefRepr = new ProcessDefinitionRepresentation({
hasStartForm: false
});
export let testProcessDefs = [new ProcessDefinitionRepresentation({
export let testProcessDefinitions = [new ProcessDefinitionRepresentation({
id: 'my:process1',
name: 'My Process 1',
hasStartForm: false
})];
export let testMultipleProcessDefs = [new ProcessDefinitionRepresentation({
id: 'my:process1',
name: 'My Process 1',
hasStartForm: false

19
lib/process-services/process-list/components/start-process.component.html
View File

@ -8,14 +8,17 @@
<mat-form-field class="adf-process-input-container">
<input matInput placeholder="{{'ADF_PROCESS_LIST.START_PROCESS.FORM.LABEL.NAME'|translate}}" [(ngModel)]="name" id="processName" required />
</mat-form-field>
<mat-form-field>
<mat-select [compareWith]="compareProcessDef" placeholder="{{'ADF_PROCESS_LIST.START_PROCESS.FORM.LABEL.TYPE'|translate}}" [(ngModel)]="currentProcessDef.id" (ngModelChange)="onProcessDefChange($event)" required>
<mat-option>{{'ADF_PROCESS_LIST.START_PROCESS.FORM.TYPE_PLACEHOLDER' | translate}}</mat-option>
<mat-option *ngFor="let processDef of processDefinitions" [value]="processDef.id">
{{ processDef.name }}
</mat-option>
</mat-select>
</mat-form-field>
<div *ngIf="hasMultipleProcessDefinitions()">
<mat-form-field>
<mat-select [compareWith]="compareProcessDef" placeholder="{{'ADF_PROCESS_LIST.START_PROCESS.FORM.LABEL.TYPE'|translate}}" [(ngModel)]="currentProcessDef.id" (ngModelChange)="onProcessDefChange($event)" required>
<mat-option>{{'ADF_PROCESS_LIST.START_PROCESS.FORM.TYPE_PLACEHOLDER' | translate}}</mat-option>
<mat-option *ngFor="let processDef of processDefinitions" [value]="processDef.id">
{{ processDef.name }}
</mat-option>
</mat-select>
</mat-form-field>
</div>
<adf-start-form *ngIf="hasStartForm()"
[data]="values"
[disableStartProcessButton]="!hasProcessName()"

94
lib/process-services/process-list/components/start-process.component.spec.ts
View File

@ -28,7 +28,14 @@ import { Observable } from 'rxjs/Observable';
import { ProcessInstanceVariable } from '../models/process-instance-variable.model';
import { ProcessService } from '../services/process.service';
import { newProcess, taskFormMock, testProcessDefRepr, testProcessDefs, testProcessDefWithForm } from '../../mock';
import {
newProcess,
taskFormMock,
testProcessDefRepr,
testMultipleProcessDefs,
testProcessDefWithForm,
testProcessDefinitions
} from '../../mock';
import { StartProcessInstanceComponent } from './start-process.component';
describe('StartProcessInstanceComponent', () => {
@ -71,7 +78,7 @@ describe('StartProcessInstanceComponent', () => {
processService = fixture.debugElement.injector.get(ProcessService);
formService = fixture.debugElement.injector.get(FormService);
getDefinitionsSpy = spyOn(processService, 'getProcessDefinitions').and.returnValue(Observable.of(testProcessDefs));
getDefinitionsSpy = spyOn(processService, 'getProcessDefinitions').and.returnValue(Observable.of(testMultipleProcessDefs));
startProcessSpy = spyOn(processService, 'startProcess').and.returnValue(Observable.of(newProcess));
getStartFormDefinitionSpy = spyOn(formService, 'getStartFormDefinition').and.returnValue(Observable.of(taskFormMock));
spyOn(activitiContentService, 'applyAlfrescoNode').and.returnValue(Observable.of({ id: 1234 }));
@ -96,7 +103,7 @@ describe('StartProcessInstanceComponent', () => {
component.ngOnChanges({ 'appId': change });
fixture.detectChanges();
expect(getDefinitionsSpy).toHaveBeenCalledWith(null);
expect(getDefinitionsSpy).not.toHaveBeenCalledWith(null);
});
it('should call service to fetch process definitions with appId when provided', () => {
@ -119,7 +126,7 @@ describe('StartProcessInstanceComponent', () => {
it('should display the option def details', () => {
let change = new SimpleChange(null, '123', true);
component.ngOnChanges({ 'appId': change });
component.processDefinitions = testProcessDefs;
component.processDefinitions = testMultipleProcessDefs;
fixture.detectChanges();
fixture.whenStable().then(() => {
let selectElement = fixture.nativeElement.querySelector('mat-select > .mat-select-trigger');
@ -158,24 +165,71 @@ describe('StartProcessInstanceComponent', () => {
});
}));
it('should auto-select process def from dropdown if there is just one process def', () => {
it('should hide the process dropdown if the app contain only one processDefinition', async(() => {
getDefinitionsSpy = getDefinitionsSpy.and.returnValue(Observable.of(testProcessDefRepr));
let change = new SimpleChange(null, '123', true);
component.appId = 123;
component.ngOnChanges({ 'appId': change });
fixture.detectChanges();
fixture.whenStable().then(() => {
let selectElement = fixture.nativeElement.querySelector('mat-select > .mat-select-trigger');
expect(selectElement).toBeNull();
});
}));
it('should hide the process dropdown if the processDefinition is already selected', async(() => {
getDefinitionsSpy = getDefinitionsSpy.and.returnValue(Observable.of(testMultipleProcessDefs));
let change = new SimpleChange(null, '123', true);
component.appId = 123;
component.processDefinitionId = 'my:process2';
component.ngOnChanges({ 'appId': change });
fixture.detectChanges();
fixture.whenStable().then(() => {
let selectElement = fixture.nativeElement.querySelector('mat-select > .mat-select-trigger');
expect(selectElement).toBeNull();
});
}));
it('should show the process dropdown if the processDefinition is not selected and the app contain multiple process', async(() => {
getDefinitionsSpy = getDefinitionsSpy.and.returnValue(Observable.of(testMultipleProcessDefs));
let change = new SimpleChange(null, '123', true);
component.appId = 123;
component.ngOnChanges({ 'appId': change });
component.processDefinitions[0] = testProcessDefRepr;
fixture.detectChanges();
fixture.whenStable().then(() => {
let selectElement = fixture.nativeElement.querySelector('mat-select > .mat-select-trigger');
expect(selectElement).not.toBeNull();
expect(selectElement).toBeDefined();
expect(selectElement.innerText).toBe('My Process 1');
});
});
}));
it('should select processDefinition based on processDefinitionId input', async(() => {
getDefinitionsSpy = getDefinitionsSpy.and.returnValue(Observable.of(testMultipleProcessDefs));
let change = new SimpleChange(null, '123', true);
component.appId = 123;
component.processDefinitionId = 'my:process2';
component.ngOnChanges({ 'appId': change });
fixture.detectChanges();
fixture.whenStable().then(() => {
expect(component.currentProcessDef.name).toBe(JSON.parse(JSON.stringify(testMultipleProcessDefs[1])).name);
});
}));
it('should select automatically the processDefinition if the app contain oly one', async(() => {
getDefinitionsSpy = getDefinitionsSpy.and.returnValue(Observable.of(testProcessDefinitions));
let change = new SimpleChange(null, '123', true);
component.appId = 123;
component.ngOnChanges({ 'appId': change });
fixture.detectChanges();
fixture.whenStable().then(() => {
expect(component.currentProcessDef.name).toBe(JSON.parse(JSON.stringify(testProcessDefinitions[0])).name);
});
}));
});
describe('input changes', () => {
let change = new SimpleChange(123, 456, true);
let nullChange = new SimpleChange(123, null, true);
beforeEach(async(() => {
component.appId = 123;
@ -191,17 +245,12 @@ describe('StartProcessInstanceComponent', () => {
expect(getDefinitionsSpy).toHaveBeenCalledWith(456);
});
it('should reload processes when appId input changed to null', () => {
component.ngOnChanges({ appId: nullChange });
expect(getDefinitionsSpy).toHaveBeenCalledWith(null);
});
it('should get current processDeff', () => {
component.ngOnChanges({ appId: change });
component.onProcessDefChange('my:Process');
fixture.detectChanges();
expect(getDefinitionsSpy).toHaveBeenCalled();
expect(component.processDefinitions).toBe(testProcessDefs);
expect(component.processDefinitions).toBe(testMultipleProcessDefs);
});
});
@ -355,14 +404,14 @@ describe('StartProcessInstanceComponent', () => {
expect(startBtn.disabled).toBe(true);
});
it('should enable start button when name and process filled out', () => {
it('should enable start button when name and process filled out', async(() => {
component.onProcessDefChange('my:process1');
fixture.detectChanges();
fixture.whenStable().then(() => {
startBtn = fixture.nativeElement.querySelector('#button-start');
expect(startBtn.disabled).toBe(false);
});
});
}));
it('should disable the start process button when process name is empty', () => {
component.name = '';
@ -411,11 +460,11 @@ describe('StartProcessInstanceComponent', () => {
describe('CS content connection', () => {
fit('alfrescoRepositoryName default configuration property', () => {
it('alfrescoRepositoryName default configuration property', () => {
expect(component.getAlfrescoRepositoryName()).toBe('alfresco-1Alfresco');
});
fit('alfrescoRepositoryName configuration property should be fetched', () => {
it('alfrescoRepositoryName configuration property should be fetched', () => {
appConfig.config = Object.assign(appConfig.config, {
'alfrescoRepositoryName': 'alfresco-123'
};
@ -423,7 +472,7 @@ describe('StartProcessInstanceComponent', () => {
expect(component.getAlfrescoRepositoryName()).toBe('alfresco-123Alfresco');
});
fit('if values in input is a node should be linked in the process service', () => {
it('if values in input is a node should be linked in the process service', async(() => {
component.values = {};
component.values['file'] = {
@ -436,8 +485,7 @@ describe('StartProcessInstanceComponent', () => {
fixture.whenStable().then(() => {
expect(component.values.file[0].id).toBe(1234);
});
});
}));
});
});
});

46
lib/process-services/process-list/components/start-process.component.ts
View File

@ -49,6 +49,9 @@ export class StartProcessInstanceComponent implements OnChanges {
@Input()
appId: number;
@Input()
processDefinitionId: string;
@Input()
variables: ProcessInstanceVariable[];
@ -89,22 +92,41 @@ export class StartProcessInstanceComponent implements OnChanges {
this.moveNodeFromCStoPS();
}
let appIdChange = changes['appId'];
let appId = appIdChange ? appIdChange.currentValue : null;
this.load(appId);
if (changes['appId'] && changes['appId'].currentValue) {
this.appId = changes['appId'].currentValue;
}
this.loadStartProcess();
}
public load(appId?: number) {
public loadStartProcess() {
this.resetSelectedProcessDefinition();
this.resetErrorMessage();
this.activitiProcess.getProcessDefinitions(appId).subscribe(
(res) => {
this.processDefinitions = res;
},
() => {
this.errorMessageId = 'ADF_PROCESS_LIST.START_PROCESS.ERROR.LOAD_PROCESS_DEFS';
}
);
if (this.appId) {
this.activitiProcess.getProcessDefinitions(this.appId).subscribe(
(processDefinitionRepresentations: ProcessDefinitionRepresentation[]) => {
this.processDefinitions = processDefinitionRepresentations;
if (this.processDefinitions.length === 1) {
this.currentProcessDef = JSON.parse(JSON.stringify(this.processDefinitions[0]));
} else {
if (this.processDefinitionId) {
this.processDefinitions = this.processDefinitions.filter((currentProcessDefinition) => {
return currentProcessDefinition.id === this.processDefinitionId;
});
this.currentProcessDef = JSON.parse(JSON.stringify(this.processDefinitions[0]));
}
}
},
() => {
this.errorMessageId = 'ADF_PROCESS_LIST.START_PROCESS.ERROR.LOAD_PROCESS_DEFS';
});
}
}
public hasMultipleProcessDefinitions(): boolean {
return this.processDefinitions.length > 1;
}
getAlfrescoRepositoryName(): string {