Indice

Workflow API javascript

activateProcessInstanceByld()

Attiva un'istanza di processo, dato il processInstanceId. In genere è usato dopo suspendProcessInstanceById()

Parametri

Esempi

var processInstanceId = "123";
activateProcessInstanceById(processInstanceId);
var processInstanceId = "123";
var options = {
	silent: false,
	callback: function(){
	},
	errorCallback: function(e){
	}
};
activateProcessInstanceById(processInstanceId, options);

cancelProcessInstance()

Cancella un'istanza di processo, dato il processInstanceId.

Parametri

Esempi

var processInstanceId = data.itemDB.act_pid; 
cancelProcessInstance(processInstanceId); 
var processInstanceId = data.itemDB.act_pid; 
var options = {
	silent: false,
	exclusionIds: ['unsensible_to_publish_widget_id'],
	callback: function(){
		closeGwContainer(detailContainerId);
	},
	errorCallback: function(e){
		showErrorDialog(e.toString());
	}
};
cancelProcessInstance(processInstanceId, options);

cancelProcessInstances()

Cancella piu' istanze di processo, data una lista processInstanceId.

Parametri

Esempi

var processInstanceIdList = ['123', '456', '789'];
cancelProcessInstances(processInstanceIdList); 
var processInstanceIdList = ['123', '456', '789'];
var options = {
	silent: false,
	exclusionIds: ['unsensible_to_publish_widget_id'],
	callback: function(){
		closeGwContainer(detailContainerId);
	},
	errorCallback: function(e){
		showErrorDialog(e.toString());
	}
};
cancelProcessInstances(processInstanceIdList);

claimTask()

Richiede l'assegnazione per l'utente corrente del task, dato il taskId.

Parametri

Esempi

var taskId = 123;
claimTask(taskId);
var taskId = 123;
var options = {
	silent: false,
	exclusionIds: ['unsensible_to_publish_widget_id'],
	callback: function(){
	},
	errorCallback: function(e){
		showErrorDialog(e.toString());
	}
};
claimTask(taskId);

completeTask()

Completa il task, data il taskId e il set di variabili.

Parametri

Esempi

var taskId = dijit.registry.getEnclosingWidget(dojo.byId(detailContainerId)).gwProcessInfo.taskId;
var taskVariables = {
	var1: 'value1',
        var2: 'value2'
        var3: 3
};
completeTask(taskId, taskVariables);
var taskId = dijit.registry.getEnclosingWidget(dojo.byId(detailContainerId)).gwProcessInfo.taskId;
var taskVariables = {
	var1: 'value1',
        var2: 'value2'
        var3: 3
};
var options = {
        handleNextStep: true,
        openingDetailMode: 'tab',
        silent: false,
        exclusionIds: [],
        callback: function(){
            //TODO 
        },
        errorCallback: function(e){
            showErrorDialog(e.toString());
        }  
};
completeTask(taskId, taskVariables, options );

openAllGwTaskDetailByProcessInstanceId()

Apre tutte le form del task attivi relativi a processInstanceId. Nel caso che nell'istanza di processo in corso sia attivo solo un task nel momento corrente, l'esecuzione di questo metodo non avrebbe effetti diversi che l'esecuzione di openGwTaskDetail(). Però può capitare che in dato momento per una data istanza di processo, siano contemporaneamente attivi più task, magari assegnati ad esecutori diversi.

A seconda dell'utente corrente e dalla configurazione nel bpmn, il gwTaskDetail verrà aperto:

Nel caso di gwProcess di tipo PROCEDURE, verrà aperta l'apposita interfaccia, con in primo piano la fase corrente, ma con la possibilità di vedere in sola visualizzazione le fasi precedenti e successive. Il parametro openingDetailMode dentro options influisce sul tipo di contenitore che verrà utilizzato per aprire la form. I possibili valori sono: 'floatingPane', 'dialog' e 'tab'.

Parametri

Esempi

var processInstanceId = '123';
openAllGwTaskDetailByProcessInstanceId(processInstanceId);    
var processInstanceId = '123';
var options = {
      openingDetailMode: 'floatingPane',
      onlyActive: true
};
openAllGwTaskDetailByProcessInstanceId(processInstanceId, options);

openArchivedProcessProcedureDetail()

Questo metodo è specifico per i gwProcess di tipo PROCEDURE. Apre in sola visualizzazione un'interfaccia riepilogativa con tutte le fasi del processo. E' richiamata in automatico al click sulle righe delle schede aperte dalla function openGwArchivedProcessList(). Il parametro openingDetailMode dentro options influisce sul tipo di contenitore che verrà utilizzato per aprire la form. I possibili valori sono: 'floatingPane', 'dialog' e 'tab'.

Parametri

Esempi

var processDefinitionKey = 'processDefinitionKey';
openArchivedProcessProcedureDetail(processDefinitionKey);  
var processDefinitionKey = 'processDefinitionKey';
var options = {
        openingDetailMode: 'floatingPane'
};
openArchivedProcessProcedureDetail(processDefinitionKey, options);

openArchivedProcessProcedureDetailDialog()

Specializzazione del metodo openArchivedProcessProcedureDetail(), che apre la form in un contenitore di tipo Dialog.

Esempi

var processDefinitionKey = 'processDefinitionKey';
openArchivedProcessProcedureDetailDialog(processDefinitionKey);

openArchivedProcessProcedureDetailFloatingPane()

Specializzazione del metodo openArchivedProcessProcedureDetail(), che apre la form in un contenitore di tipo FloatingPane.

Esempi

var processDefinitionKey = 'processDefinitionKey';
openArchivedProcessProcedureDetailFloatingPane(processDefinitionKey);

openArchivedProcessProcedureDetailTab()

Specializzazione del metodo openArchivedProcessProcedureDetail(), che apre la form in un contenitore di tipo Tab.

Esempi

var processDefinitionKey = 'processDefinitionKey';
openArchivedProcessProcedureDetailTab(processDefinitionKey);

openGwArchivedProcessList()

Apre una scheda di tipo gwArchivedProcessList. Essa contiene una lista di record contenenti i dati relativi ad istanze di processo terminate. Al click sulla singola riga verrà aperto un un gwClassDetail con il detailLayout di default per la gwClass. Nel Caso di GwProcess di tipo PROCEDURE, verrà aperta l'apposita scheda riepilogativa di tutte le fasi (in sola visualizzazione). Nel caso in cui la scheda sia già aperta, l'esecuzione della function non ne effettua il refresh, la sostituisce con una nuova nella stessa posizione.

Parametri

Esempi

var gwProcessName = 'gw_process_name';
var title = 'title';
openGwArchivedProcessList(gwProcessName, title);
var gwProcessName = 'gw_process_name';
var title = 'title';
var parametersMap = {
        openingDetailMode: 'tab',
        staticFilters: [{condition: 'AND', columnName: 'id_job', operator: '=', filterType: 'INTEGER', value: 100}]
};
var insertIndex = 0;
openGwArchivedProcessList(gwProcessName, title, parametersMap, insertIndex);

openGwClassProcesses()

Apre una scheda di tipo gwClassProcesses .

Parametri

Esempi

var gwClassName = 'gw_class_name';
var gwProcessName = 'gw_process_name';
var title = 'title';
openGwClassProcesses(gwClassName , gwProcessName, title);
var gwProcessName = 'gw_process_name';
var title = 'title';
var parametersMap = {
};
var insertIndex = 0;
openGwClassProcesses(gwClassName , gwProcessName, title, parametersMap, insertIndex);

openGwProcessStartTaskForm()

Apre una form che permette di raccogliere input utente, ed utilizzarli come variabili per avviare una nuova istanza di processo. Il processo avviato è definito dal parametro processDefinitionKey. Il parametro startFormKey è di fatti name del detailLayout che verrà usato per presentare la form, cosi come impostato nel .bpmn di processo secondo le convenzioni di implementazione. Se omesso verrà recuperato al netto di un piccolo rallentamento nell'esecuzione.

Nel caso di gwProcess di tipo PROCEDURE, verrà aperta l'apposita interfaccia, con in primo piano la fase preliminare, ma con la possibilità di vedere in sola visualizzazione tutte le fasi successive. Il parametro openingDetailMode dentro options influisce sul tipo di contenitore che verrà utilizzato per aprire la form. I possibili valori sono: 'floatingPane', 'dialog' e 'tab'.

Parametri

Esempi

var processDefinitionKey = 'processDefinitionKey';
openGwProcessStartTaskForm(processDefinitionKey);
var processDefinitionKey = 'processDefinitionKey';
var startFormKey = 'startFormKey';
var options = {
         openingDetailMode: 'floatingPane'
};
openGwProcessStartTaskForm(processDefinitionKey, startFormKey, options);

openGwProcessStartTaskFormDialog()

Specializzazione del metodo openGwProcessStartTaskForm(), che apre la form in un contenitore di tipo Dialog.

Esempi

var processDefinitionKey = 'processDefinitionKey';
openGwProcessStartTaskFormDialog(processDefinitionKey);
var processDefinitionKey = 'processDefinitionKey';
var startFormKey = 'startFormKey';
var options = {
};
openGwProcessStartTaskFormDialog(processDefinitionKey, startFormKey, options);

openGwProcessStartTaskFormFloatingPane()

Specializzazione del metodoopenGwProcessStartTaskForm(), che apre la form in un contenitore di tipo FloatinPane.

Esempi

var processDefinitionKey = 'processDefinitionKey';
openGwProcessStartTaskFormFloatingPane(processDefinitionKey);
var processDefinitionKey = 'processDefinitionKey';
var startFormKey = 'startFormKey';
var options = {
};
openGwProcessStartTaskFormFloatingPane(processDefinitionKey, startFormKey, options);

openGwProcessStartTaskFormTab()

Specializzazione del metodo openGwProcessStartTaskForm(), che apre la form in un contenitore di tipo Tab.

Esempi

var processDefinitionKey = 'processDefinitionKey';
openGwProcessStartTaskFormTab(processDefinitionKey);
var processDefinitionKey = 'processDefinitionKey';
var startFormKey = 'startFormKey';
var options = {
};
openGwProcessStartTaskFormTab(processDefinitionKey, startFormKey, options);

openGwRunningProcessList()

Apre una scheda di tipo gwRunninProcessList . Nel caso in cui la scheda sia già aperta, non ne effettua il refresh, la sostituisce con una nuova nella stessa posizione.

Parametri

Esempi

var gwProcessName = 'gw_process_name';
var title = 'title';
openGwTaskList(gwProcessName, title);
var gwProcessName = 'gw_process_name';
var title = 'title';
var parametersMap = {
         staticFilters: [{condition: 'AND', columnName: 'id_job', operator: '=', filterType: 'INTEGER', value: 100}]
};
openGwTaskList(gwProcessName, title, parametersMap);

openGwSuspendedProcessList()

Apre una scheda di tipo gwSuspendedProcessList . Nel caso in cui la scheda sia già aperta, non ne effettua il refresh, la sostituisce con una nuova nella stessa posizione.

Parametri

Esempi

var gwProcessName = 'gw_process_name';
var title = 'title';
openGwSuspendedProcessList(gwProcessName, title);
var gwProcessName = 'gw_process_name';
var title = 'title';
var parametersMap = {
	openingDetailMode: 'tab',
	staticFilters = [{condition: 'AND', columnName: 'id_job', operator: '=', filterType: 'INTEGER', value: 100}]
};
openGwSuspendedProcessList(gwProcessName, title, parametersMap);

openGwTaskDetail()

Apre la form del task relativo al taskId.

A seconda dell'utente corrente e dalla configurazione nel .bpmn, il gwTaskDetail verrà aperto:

Nel caso di gwProcess di tipo PROCEDURE, verrà aperta l'apposita interfaccia, con in primo piano la fase corrente, ma con la possibilità di vedere in sola visualizzazione le fasi precedenti e successive. Il parametro openingDetailMode dentro options influisce sul tipo di contenitore che verrà utilizzato per aprire la form. I possibili valori sono: 'floatingPane', 'dialog' e 'tab'.

Parametri

Esempi

var taskId = 'taskId';
openGwTaskDetail(taskId);
var taskId = 'taskId';
var options = {
         openingDetailMode: 'floatingPane'
};
openGwTaskDetail(taskId, options);''

openGwTaskDetailDialog()

Specializzazione del metodo openGwTaskDetail(), che apre la form in un contenitore di tipo Dialog.

Esempi

var taskId = 'taskId';
openGwTaskDetailDialog(taskId);

openGwTaskDetailFloatingPane()

Specializzazione del metodo openGwTaskDetail(), che apre la form in un contenitore di tipo FloatingPane.

Esempi

var taskId = 'taskId';
openGwTaskDetailFloatingPane(taskId);

openGwTaskDetailTab()

Specializzazione del metodo openGwTaskDetail(), che apre la form in un contenitore di tipo Dialog.

Esempi

var taskId = 'taskId';
openGwTaskDetailTab(taskId);

openGwTaskList()

Apre una scheda contenente la lista dei task relativi al gwProcessName (=processDefinitionKey). Al click sulle righe della lista verranno aperte form come all'esecuzione di openGwTaskDetail(). Si possono eventualmente visualizzare solo i task assegnati all'utente corrente (showOnlyUserTasks posto a true). Si possono imporre particolari set di filtri statici. Il parametro openingDetailMode dentro options influisce sul tipo di contenitore che verrà utilizzato per aprire le form. I possibili valori sono: 'floatingPane', 'dialog' e 'tab'.

Parametri

Esempi

var gwProcessName = 'gw_process_name';
var title = 'title';
openGwTaskList(gwProcessName, title);
var gwProcessName = 'gw_process_name';
var title = 'title';
var parametersMap = {
         openingDetailMode: 'tab',
         showOnlyUserTasks: false,
         staticFilters: [{condition: 'AND', columnName: 'id_job', operator: '=', filterType: 'INTEGER', value: 100}]
};
openGwTaskList(gwProcessName, title, parametersMap);

retrieveAllGwTasksByProcessInstanceId()

Recupera la lista dei task relativi al processInstanceId, e li passa come argomento della callback.

Parametri

Esempi

Recupera i task, li cicla con forEach(), e li esegue 

var processInstanceId = '123';
var callback = function(tasks){
	if(tasks){
		tasks.forEach(function(task){
			var taskId = task.id;
			completeTask(taskId);
		});
	}
};
retrieveAllGwTasksByProcessInstanceId(processInstanceId, callback);

Recupera i task, li cicla con for(), e ne apre la scheda gwTaskDetail in un tab 

var processInstanceId = '123';
var callback = function(tasks){
	if(tasks){
		for(var i=0; i<tasks.length; i++){
			var taskId = tasks[i].id;
			openGwTaskDetailTab(taskId);
		}
	}
};
retrieveAllGwTasksByProcessInstanceId(processInstanceId, callback);

Recupera i task, li cicla con forEach(), e li esegue passando un set di variabili 

var processInstanceId = '123';
var callback = function(tasks){
	if(tasks){
		tasks.forEach(function(task){
			var taskId = task.id;
			var taskVariables = {
				myFlag: true,
				myFlag2: false
			};
			completeTask(taskId, taskVariables);
		});
	}
};
var errorCallback = function(errorMessage){
	showErrorDialog(errorMessage);
};
var options = {
	onlyActive: true
};
retrieveAllGwTasksByProcessInstanceId(processInstanceId, callback, errorCallback, options);

setAssigneeToTask()

Assegna il task riferito da taskId ad uno specifico utente (assignee). Può essere usato anche per riassegnare un altro utente un task già assegnato.

Parametri

Esempi

var taskId = detailContainer.gwProcessInfo.taskId;
var assignee = activeUser;
setAssigneeToTask(taskId, assignee);
var detailContainer = dijit.registry.getEnclosingWidget(dojo.byId(detailContainerId));
var taskId = detailContainer.gwProcessInfo.taskId;
var assignee = activeUser;
var options = {
         callback: function(){
                  detailContainer.gwRefresh();
         },
         errorCallback: function(e){
                  showErrorDialog(e.toString());
         }
};
setAssigneeToTask(taskId, assignee, options);

setCategoryToTask()

Modifica il parametro category di Activiti al Task riferito da taskId

Questa funzione è usata dal framework per alcuni sui funzionamenti interni ed in genere non dovrebbe servire all'utente configuratore.

Parametri

Esempi

var taskId = detailContainer.gwProcessInfo.taskId;
var category = 'category';
setCategoryToTask(taskId, category);
var detailContainer = dijit.registry.getEnclosingWidget(dojo.byId(detailContainerId));
var taskId = detailContainer.gwProcessInfo.taskId;
var category = 'category';
var options = {
         callback: function(){
                  detailContainer.gwRefresh();
         },
         errorCallback: function(e){
                  showErrorDialog(e.toString());
         }
};
setCategoryToTask(taskId, category, options);

startProcessInstance()

Avvia una nuova istanza di processo, data la processDefinitionKey e il set di variabili iniziali.

A differenza di openGwProcessStartTaskForm(), dove il set di variabili iniziali viene inserito a mano nella start task form dall'utente, qui vengono passate programmaticamente. Si può opzionalmente scegliere se aprire il task successivo nel flusso di processo, una volta avviato.

Parametri

Esempi

var processDefinitionKey = 'processDefinitionKey';
var processVariables = {
         var1: 'value1',
         var2: 'value2'
         var3: 3
};
startProcessInstance(processDefinitionKey, processVariables);
var processDefinitionKey = 'processDefinitionKey';
var processVariables = {
         var1: 'value1',
         var2: 'value2'
         var3: 3
};
var options = {
         handleNextStep: true,
         openingDetailMode: 'floatingPane',
         silent: false,
         callback: function(){
                  //TODO 
         },
         errorCallback: function(e){
                  showErrorDialog(e.toString());
         }
}
startProcessInstance(processDefinitionKey, processVariables, options);

startProcessInstanceByMessage()

Avvia una nuova istanza di processo, data il messaggio univoco e il set di variabili iniziali.

Parametri

Esempi

var message = 'start_process_message';
var processVariables = {
         var1: 'value1',
         var2: 'value2'
         var3: 3
};
var options = {
         handleNextStep: true,
         openingDetailMode: 'floatingPane',
         silent: false,
         callback: function(){
            //TODO 
         },
         errorCallback: function(e){
                  showErrorDialog(e.toString());
         }
}
startProcessInstanceByMessage(message, processVariables, options);

synchronizeActivitiWithGwClass()

Sincronizza i valori delle variabili di processo presenti in Activiti, con il corrispettivo record nella tabella di Geoweb (edit table per il gwClassName). Il match è eseguito trovando il record nella tabella della classe dove act_pid == processInstancId.Se valuesMao è emessa

Parametri

Esempi

var processInstanceId = '123';
var gwClassName= 'class_name';
var valuesMap = {
         value1: 'value1',
         value2: 2
};
var callback = function(){
         //TODO
};
var errorCallback =  function(e){
         showErrorDialog(e.toString());
}
synchronizeActivitiWithGwClass(processInstanceId, gwClassName, valuesMap, callback, errorCallback);

suspendProcessInstanceById()

Sospende un'istanza di processo, dato il processInstanceId. Sospendere un'istanza di processo è differente dal cancellarla. Quando è sospesa un'istanza di processo non può proseguire, i suoi task non possono essere completati, e tutti gli eventuali timer automatici di Activiti sono disattivati.

Parametri

Esempi

var processInstanceId = '123';
suspendProcessInstanceById(processInstanceId);
var processInstanceId = '123';
var options = {
         silent: false,
         callback: function(){
         },
         errorCallback: function(e){
         }
};
suspendProcessInstanceById(processInstanceId, options);