custom:api_js_workflow [GeowebFramework]

Questa pagina è in sola lettura. Puoi visualizzare il sorgente, ma non puoi modificarlo. Contatta l'amministratore se pensi che ci sia un errore.
====== Workflow API javascript ====== 
  * [[:custom:api_js_workflow#activateProcessInstanceByld()|activateProcessInstanceByld()]]
  * [[:custom:api_js_workflow#cancelProcessInstance()|cancelProcessInstance()]]
  * [[:custom:api_js_workflow#cancelProcessInstances()|cancelProcessInstances()]]
  * [[:custom:api_js_workflow#cancelArchivedProcessInstance()|cancelArchivedProcessInstance()]]
  * [[:custom:api_js_workflow#cancelArchivedProcessInstances()|cancelArchivedProcessInstances()]]
  * [[:custom:api_js_workflow#claimTask()|claimTask()]]
  * [[:custom:api_js_workflow#completeTask()|completeTask()]]
  * [[:custom:api_js_workflow#openAllGwTaskDetailByProcessInstanceId()|openAllGwTaskDetailByProcessInstanceId()]]
  * [[:custom:api_js_workflow#openArchivedProcessProcedureDetail()|openArchivedProcessProcedureDetail()]]
  * [[:custom:api_js_workflow#openArchivedProcessProcedureDetailFloatingPane()|openArchivedProcessProcedureDetailFloatingPane()]]
  * [[:custom:api_js_workflow#openArchivedProcessProcedureDetailTab()|openArchivedProcessProcedureDetailTab()]]
  * [[:custom:api_js_workflow#openGwArchivedProcessList()|openGwArchivedProcessList()]]
  * [[:custom:api_js_workflow#openGwClassProcesses()|openGwClassProcesses()]]
  * [[:custom:api_js_workflow#openGwProcessStartTaskForm()|openGwProcessStartTaskForm()]]
  * [[:custom:api_js_workflow#openGwProcessStartTaskFormDialog()|openGwProcessStartTaskFormDialog()]]
  * [[:custom:api_js_workflow#openGwProcessStartTaskFormFloatingPane()|openGwProcessStartTaskFormFloatingPane()]]
  * [[:custom:api_js_workflow#openGwProcessStartTaskFormTab()|openGwProcessStartTaskFormTab()]]
  * [[:custom:api_js_workflow#openGwRunningProcessList()|openGwRunningProcessList()]]
  * [[:custom:api_js_workflow#openGwSuspendedProcessList()|openGwSuspendedProcessList()]]
  * [[:custom:api_js_workflow#openGwTaskDetail()|openGwTaskDetail()]]
  * [[:custom:api_js_workflow#openGwTaskDetailDialog()|openGwTaskDetailDialog()]]
  * [[:custom:api_js_workflow#openGwTaskDetailFloatingPane()|openGwTaskDetailFloatingPane()]]
  * [[:custom:api_js_workflow#openGwTaskDetailTab()|openGwTaskDetailTab()]]
  * [[:custom:api_js_workflow#openGwTaskList()|openGwTaskList()]]
  * [[:custom:api_js_workflow#retrieveAllGwTasksByProcessInstanceId()|retrieveAllGwTasksByProcessInstanceId()]]
  * [[:custom:api_js_workflow#setAssigneeToTask()|setAssigneeToTask()]]
  * [[:custom:api_js_workflow#setCategoryToTask()|setCategoryToTask()]]
  * [[:custom:api_js_workflow#startProcessInstance()|startProcessInstance()]]
  * [[:custom:api_js_workflow#startProcessInstanceByMessage()|startProcessInstanceByMessage()]]
  * [[:custom:api_js_workflow#synchronizeActivitiWithGwClass()|synchronizeActivitiWithGwClass()]]
  * [[:custom:api_js_workflow#suspendProcessInstanceById()|suspendProcessInstanceById()]]

==== activateProcessInstanceByld() ====

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

=== Parametri ===
  * **processInstanceId**, String, required. Identificativo del processo in Activiti (persistito sulla colonna **act_pid** della tabella della gwClass del gwProcess)
  * **options**, Object, optional, default null,
    * **silent**, Boolean, optional, default false. When true no event is published
    * **callback**, function, optional, default null
    * **errorCallback**, function, optional, default null

=== Esempi ===
<code javascript>
var processInstanceId = "123";
activateProcessInstanceById(processInstanceId);
</code>
<code javascript>
var processInstanceId = "123";
var options = {
	silent: false,
	callback: function(){
	},
	errorCallback: function(e){
	}
};
activateProcessInstanceById(processInstanceId, options);
</code>


==== cancelProcessInstance() ====

Cancella un'istanza di processo, dato il processInstanceId.

=== Parametri ===
  * **processInstanceId**, String, required. Identificativo del processo in Activiti (persistito sulla colonna **act_pid** della tabella della gwClass del gwProcess)
  * **options**, Object, optional, default null,
    * **silent**, Boolean, optional, default false. When true no event is published
    * **exclusionIds**, String[], optional, default null. List of ids that had to be not sensible to the publish of the event 
    * **callback**, function, optional, default null
    * **errorCallback**, function, optional, default null

=== Esempi ===
<code javascript>
var processInstanceId = data.itemDB.act_pid; 
cancelProcessInstance(processInstanceId); 
</code>
<code javascript>
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); 
</code>

==== cancelProcessInstances() ====

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

=== Parametri ===
  * **processInstanceIdList**, String[], required. Lista di identificativi del processo in Activiti (persistito sulla colonna **act_pid** della tabella della gwClass del gwProcess)
  * **options**, Object, optional, default null,
    * **silent**, Boolean, optional, default false. When true no event is published
    * **exclusionIds**, String[], optional, default null. List of ids that had to be not sensible to the publish of the event 
    * **callback**, function, optional, default null
    * **errorCallback**, function, optional, default null

=== Esempi ===
<code javascript>
var processInstanceIdList = ['123', '456', '789'];
cancelProcessInstances(processInstanceIdList); 
</code>
<code javascript>
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); 
</code>


==== claimTask() ====

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

=== Parametri ===
  * **taskId**, String, required. Identificativo del task in Activiti
  * **options**, Object, optional, default null,
    * **silent**, Boolean, optional, default false. When true no event is published
    * **exclusionIds**, String[], optional, default null. List of ids that had to be not sensible to the publish of the event 
    * **callback**, function, optional, default null
    * **errorCallback**, function, optional, default null

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

==== completeTask() ====

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

=== Parametri ===
  * **taskId**, String, required. Identificativo del task in Activiti
  * **taskVariables**, Object, optional. Mappa contenente come key le variabili di processo e come value i valori stessi
  * **options**, Object, optional, default null,
    * **localScope**, Boolean, optional, default false. Reversed on Activiti JAVA API
    * **handleNextStep**, Boolean, optional, default true. When true open gwTaskDetail too, after starting process
    * **openingDetailMode**, String, optional, allowed values: ['floatingPane', 'dialog', 'tab'], default 'floatingPane'. Evaluated only if handleNextStep==true
    * **silent**, Boolean, optional, default false. When true no event is published
    * **exclusionIds**, String[], optional, default null. List of ids that had to be not sensible to the publish of the event 
    * **callback**, function, optional, default null
    * **errorCallback**, function, optional, default null

=== Esempi ===
<code javascript>
var taskId = dijit.registry.getEnclosingWidget(dojo.byId(detailContainerId)).gwProcessInfo.taskId;
var taskVariables = {
	var1: 'value1',
        var2: 'value2'
        var3: 3
};
completeTask(taskId, taskVariables);
</code>
<code javascript>
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 );
</code>

==== 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 [[:custom:api_js_workflow#openGwTaskDetail()|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:
  * con la possibilità di completare il task (task assegnato all' utente corrente)
  * in sola lettura (task assegnato ad un altro utente)
  * con la possibilità di richiedere per se l'assegnazione del task (task non ancora assegnato)

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 ===
  * **processInstanceId**, String, required. Identificativo del processo in Activiti (persistito sulla colonna **act_pid** della tabella della gwClass del gwProcess)
  * **options**, Object, optional, default null,
    * **openingDetailMode**, String, optional, allowed values: ['floatingPane', 'dialog', 'tab'], default 'floatingPane'
    * **onlyActive**, Boolean, optional, default false. Has priority on onlySuspended. Reversed on Activiti JAVA API
    * **onlySuspended**, Boolean, optional, default false. It's evaluated only when onlyActive is missing or false. Reversed on Activiti JAVA API
    * **dimensions**, Object, optional. Done like this {w: 600, h: 500}

=== Esempi ===
<code javascript>
var processInstanceId = '123';
openAllGwTaskDetailByProcessInstanceId(processInstanceId);    
</code>
<code javascript>
var processInstanceId = '123';
var options = {
      openingDetailMode: 'floatingPane',
      onlyActive: true
};
openAllGwTaskDetailByProcessInstanceId(processInstanceId, options);    
</code>


==== 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 ===
  * **processDefinitionKey**, String, required. Identificativo della definizione di processo in Activiti
  * **processInstanceId**, String, required. Identificativo del processo in Activiti (persistito sulla colonna **act_pid** della tabella della gwClass del gwProcess)
  * **options**, Object, optional, default null,
    * **openingDetailMode**, String, optional, allowed values: ['floatingPane', 'dialog', 'tab'], default 'floatingPane'
    * **dimensions**, Object, optional. Done like this {w: 600, h: 500}

=== Esempi ===
<code javascript>
var processDefinitionKey = 'processDefinitionKey';
openArchivedProcessProcedureDetail(processDefinitionKey);  
</code>
<code javascript>
var processDefinitionKey = 'processDefinitionKey';
var options = {
        openingDetailMode: 'floatingPane'
};
openArchivedProcessProcedureDetail(processDefinitionKey, options);   
</code>


==== openArchivedProcessProcedureDetailDialog() ====

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

=== Esempi ===
<code javascript>
var processDefinitionKey = 'processDefinitionKey';
openArchivedProcessProcedureDetailDialog(processDefinitionKey);  
</code>


==== openArchivedProcessProcedureDetailFloatingPane() ====

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

=== Esempi ===
<code javascript>
var processDefinitionKey = 'processDefinitionKey';
openArchivedProcessProcedureDetailFloatingPane(processDefinitionKey);  
</code>


==== openArchivedProcessProcedureDetailTab() ====

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

=== Esempi ===
<code javascript>
var processDefinitionKey = 'processDefinitionKey';
openArchivedProcessProcedureDetailTab(processDefinitionKey);  
</code>


==== 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 ===
  * **gwProcessName**, String, required. Name del gwProcess in Geoweb
  * **title**, String, optional, default null
  * **parametersMap**, Object, optional
    * **openingDetailMode**, String, optional, allowed values: ['floatingPane', 'dialog', 'tab'], default 'floatingPane'
    * **filters**, Object[], optional. Lista di filtri
    * **staticFilters**, Object[], optional. Lista di filtri
  * **insertIndex**, Integer, optional, default null. Se omesso la scheda verrà aperta in ultima posizione

=== Esempi ===
<code javascript>
var gwProcessName = 'gw_process_name';
var title = 'title';
openGwArchivedProcessList(gwProcessName, title);
</code>
<code javascript>
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);
</code>

==== openGwClassProcesses() ====

Apre una scheda di tipo [[gwClassProcesses]] .

=== Parametri ===
  * **gwClassName**, String, required. Name della gwClass
  * **gwProcessName**, String, required. Name del gwProcess in Geoweb
  * **title**, String, optional, default null
  * **parametersMap**, Object, optional
  * **insertIndex**, Integer, optional, default null. Se omesso la scheda verrà aperta in ultima posizione

=== Esempi ===
<code javascript>
var gwClassName = 'gw_class_name';
var gwProcessName = 'gw_process_name';
var title = 'title';
openGwClassProcesses(gwClassName , gwProcessName, title);
</code>
<code javascript>
var gwProcessName = 'gw_process_name';
var title = 'title';
var parametersMap = {
};
var insertIndex = 0;
openGwClassProcesses(gwClassName , gwProcessName, title, parametersMap, insertIndex);
</code>

 
==== 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 ===
  * **processDefinitionKey**, String, required. Nome della definizione di processo in Activiti
  * **startFormKey**, String, optional, default null. If omitted is retrieved from processDefinitionKey
  * **options**, Object, optional, default null
    * **openingDetailMode**, String, optional, allowed values: ['floatingPane', 'dialog', 'tab'], default 'floatingPane'. Evaluated only if handleNextStep==true
    * **dimensions**: Object like this {w: 600, h: 500}. Evaluated only for floatingPane and dialog

=== Esempi ===

<code javascript>
var processDefinitionKey = 'processDefinitionKey';
openGwProcessStartTaskForm(processDefinitionKey);
</code>

<code javascript>
var processDefinitionKey = 'processDefinitionKey';
var startFormKey = 'startFormKey';
var options = {
         openingDetailMode: 'floatingPane'
};
openGwProcessStartTaskForm(processDefinitionKey, startFormKey, options);
</code>


==== openGwProcessStartTaskFormDialog() ====

Specializzazione del metodo [[:custom:api_js_workflow#openGwProcessStartTaskForm()|openGwProcessStartTaskForm()]], che apre la form in un contenitore di tipo Dialog.

=== Esempi ===

<code javascript>
var processDefinitionKey = 'processDefinitionKey';
openGwProcessStartTaskFormDialog(processDefinitionKey);
</code>

<code javascript>
var processDefinitionKey = 'processDefinitionKey';
var startFormKey = 'startFormKey';
var options = {
};
openGwProcessStartTaskFormDialog(processDefinitionKey, startFormKey, options);
</code>


==== openGwProcessStartTaskFormFloatingPane() ====

Specializzazione del metodo[[:custom:api_js_workflow#openGwProcessStartTaskForm()|openGwProcessStartTaskForm()]], che apre la form in un contenitore di tipo FloatinPane.

=== Esempi ===

<code javascript>
var processDefinitionKey = 'processDefinitionKey';
openGwProcessStartTaskFormFloatingPane(processDefinitionKey);
</code>

<code javascript>
var processDefinitionKey = 'processDefinitionKey';
var startFormKey = 'startFormKey';
var options = {
};
openGwProcessStartTaskFormFloatingPane(processDefinitionKey, startFormKey, options);
</code>


==== openGwProcessStartTaskFormTab() ====

Specializzazione del metodo [[:custom:api_js_workflow#openGwProcessStartTaskForm()|openGwProcessStartTaskForm()]], che apre la form in un contenitore di tipo Tab.

=== Esempi ===

<code javascript>
var processDefinitionKey = 'processDefinitionKey';
openGwProcessStartTaskFormTab(processDefinitionKey);
</code>

<code javascript>
var processDefinitionKey = 'processDefinitionKey';
var startFormKey = 'startFormKey';
var options = {
};
openGwProcessStartTaskFormTab(processDefinitionKey, startFormKey, options);
</code>


==== 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 ===
  * **gwProcessName**, String, required. Name del gwProcess in Geoweb
  * **title**, String, optional, default null
  * **parametersMap**, Object, optional
    * **filters**, Object[], optional. Lista di filtri
    * **staticFilters**, Object[], optional. Lista di filtri
  * **insertIndex**, Integer, optional, default null. Se omesso la scheda verrà aperta in ultima posizione

=== Esempi ===

<code javascript>
var gwProcessName = 'gw_process_name';
var title = 'title';
openGwTaskList(gwProcessName, title);
</code>

<code javascript>
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);
</code>


==== 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 ===

  * **gwProcessName**, String, required. Name del gwProcess in Geoweb
  * **title**, String, optional, default null
  * **parametersMap**, Object, optional
    * **openingDetailMode**, String, optional
    * **filters**, Object[], optional. Lista di filtri
    * **staticFilters**, Object[], optional. Lista di filtri
  * **insertIndex**, Integer, optional, default null. Se omesso la scheda verrà aperta in ultima posizione

=== Esempi ===

<code javascript>
var gwProcessName = 'gw_process_name';
var title = 'title';
openGwSuspendedProcessList(gwProcessName, title);
</code>

<code javascript>
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);
</code>


==== openGwTaskDetail() ====

Apre la form del task relativo al taskId.

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

  * con la possibilità di completare il task (task assegnato all' utente corrente)
  * in sola lettura (task assegnato ad un altro utente)
  * con la possibilità di richiedere per se l'assegnazione del task (task non ancora assegnato)

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 ===
  * **taskId**, String, required. Identificativo del task in Activiti
  * **options**, Object, optional
    * **openingDetailMode**, String, optional, allowed values: ['floatingPane', 'dialog', 'tab'], default 'floatingPane'. Evaluated only if handleNextStep==true
    * **dimensions**, Object, optional. Done like this {w: 600, h: 500}

=== Esempi ===

<code javascript>
var taskId = 'taskId';
openGwTaskDetail(taskId);
</code>

<code javascript>
var taskId = 'taskId';
var options = {
         openingDetailMode: 'floatingPane'
};
openGwTaskDetail(taskId, options);''
</code>


==== openGwTaskDetailDialog() ====

Specializzazione del metodo [[:custom:api_js_workflow#openGwTaskDetail()|openGwTaskDetail()]], che apre la form in un contenitore di tipo Dialog.

=== Esempi ===

<code javascript>
var taskId = 'taskId';
openGwTaskDetailDialog(taskId);
</code>


==== openGwTaskDetailFloatingPane() ====

Specializzazione del metodo [[:custom:api_js_workflow#openGwTaskDetail()|openGwTaskDetail()]], che apre la form in un contenitore di tipo FloatingPane.

=== Esempi ===

<code javascript>
var taskId = 'taskId';
openGwTaskDetailFloatingPane(taskId);
</code>


==== openGwTaskDetailTab() ====

Specializzazione del metodo [[:custom:api_js_workflow#openGwTaskDetail()|openGwTaskDetail()]], che apre la form in un contenitore di tipo Dialog.

=== Esempi ===

<code javascript>
var taskId = 'taskId';
openGwTaskDetailTab(taskId);
</code>


==== 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 [[:custom:api_js_workflow#openGwTaskDetail()|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 ===
  * **gwProcessName**, String, required. Name del gwProcess in Geoweb
  * **title**, String, optional
  * **parametersMap**, Object, optional, default null
    * **showOnlyUserTasks**, Boolean, optional, default false
    * **staticFilters**, Object[], optional
  * **insertIndex**, Integer, optional. Se omesso la scheda è aperta per ultima

=== Esempi ===

<code javascript>
var gwProcessName = 'gw_process_name';
var title = 'title';
openGwTaskList(gwProcessName, title);
</code>

<code javascript>
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);
</code>


==== retrieveAllGwTasksByProcessInstanceId() ====

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

=== Parametri ===
  * **processInstanceId**, String, required. Identificativo del processo in Activiti (persistito sulla colonna **act_pid** della tabella della gwClass del gwProcess)
  * **callback**, function, optional. Verrà eseguita con argomento la lista dei task
  * **errorCallback**, function, optional. Verrà eseguita con argomento il messaggio di errore
  * **options**, Object, optional, default null,
    * **onlyActive**, Boolean, optional, default false. Has priority on onlySuspended
    * **onlySuspended**, Boolean, optional, default false. It's evaluated only when onlyActive is missing or false

=== Esempi ===

Recupera i task, li cicla con forEach(), e li esegue
<code javascript>
var processInstanceId = '123';
var callback = function(tasks){
	if(tasks){
		tasks.forEach(function(task){
			var taskId = task.id;
			completeTask(taskId);
		});
	}
};
retrieveAllGwTasksByProcessInstanceId(processInstanceId, callback);
</code>

Recupera i task, li cicla con for(), e ne apre la scheda gwTaskDetail in un tab
<code javascript>
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);
</code>

Recupera i task, li cicla con forEach(), e li esegue passando un set di variabili
<code javascript>
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);
</code>


==== 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 ===
  * **taskId**, String, required. Indentificativo del task in Activiti
  * **assignee**, String, required. Nome dell'user a cui assegnare il task
  * **options**, Object, optional, default null
    * **silent**, Boolean, default false. If true no event publish is made
    * **exclusionIds**, String[]. List of id that had to be not sensible to event publish
    * **callback**, function, optional, default null
    * **errorCallback**, function, optional, default null

=== Esempi ===

<code javascript>
var taskId = detailContainer.gwProcessInfo.taskId;
var assignee = activeUser;
setAssigneeToTask(taskId, assignee);
</code>

<code javascript>
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);
</code>


==== 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 ===
  * **taskId**, String, required. Indentificativo del task in Activiti
  * **category**, String, required. Nome dell'user a cui assegnare il task
  * **options**, Object, optional, default null
    * **callback**, function, optional, default null
    * **errorCallback**, function, optional, default null

=== Esempi ===

<code javascript>
var taskId = detailContainer.gwProcessInfo.taskId;
var category = 'category';
setCategoryToTask(taskId, category);
</code>

<code javascript>
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);
</code>


==== startProcessInstance() ====

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

A differenza di [[:custom:api_js_workflow#openGwProcessStartTaskForm()|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 ===
  * **processDefinitionKey**, String, required. Nome della definizione di processo in Activiti
  * **processVariables**, Object, required. Mappa con key i nomi delle variabili di processo e per value i valori
  * **options**, Object, optional, default null
    * **handleNextStep**, Boolean, default true. When true open gwTaskDetail too, after starting process
    * **openingDetailMode**, String, optional, allowed values: ['floatingPane', 'dialog', 'tab'], default 'floatingPane'. Evaluated only if handleNextStep==true
    * **silent**, Boolean, default false. If true no event publish is made
    * **exclusionIds**, String[]. List of id that had to be not sensible to event publish
    * **callback**, function, optional, default null
    * **errorCallback**, function, optional, default null

=== Esempi ===

<code javascript>
var processDefinitionKey = 'processDefinitionKey';
var processVariables = {
         var1: 'value1',
         var2: 'value2'
         var3: 3
};
startProcessInstance(processDefinitionKey, processVariables);
</code>

<code javascript>
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);
</code>


==== startProcessInstanceByMessage() ====

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

=== Parametri ===
  * **message**, String, required. Nome del message di Activiti (definito nel .bpmn, che deve essere univoco)
  * **options**, Object, optional, default null
    * **handleNextStep**, Boolean, default true. When true open gwTaskDetail too, after starting process
    * **openingDetailMode**, String, optional, allowed values: ['floatingPane', 'dialog', 'tab'], default 'floatingPane'. Evaluated only if handleNextStep==true
    * **silent**, Boolean, default false. If true no event publish is made
    * **exclusionIds**, String[]. List of id that had to be not sensible to event publish
    * **callback**, function, optional, default null
    * **errorCallback**, function, optional, default null

=== Esempi ===

<code javascript>
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);
</code>


==== 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 ===
  * **processInstanceId**, String, required. Identificativo del processo in Activiti (persistito sulla colonna **act_pid** della tabella della gwClass del gwProcess)
  * **gwClassName**, String, required.
  * **valuesMap**, Object, optional, if omitted the whole gwClass record will be synchronized
  * **callback**, function, optional, default null, invoked with 'jsonServerResponse' as incoming parameter
  * **errorCallback**, function, optional, default null, invoked with 'jsonServerResponse' as incoming parameter

=== Esempi ===

<code javascript>
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);
</code>


==== 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 ===
  * **processInstanceId**, String, required. Identificativo del processo in Activiti (persistito sulla colonna **act_pid** della tabella della gwClass del gwProcess)
  * **options**, Object, required.
    * **silent**, Boolean, default false. If true no event is published
    * **callback**, function, optional, default null, invoked with 'jsonServerResponse' as incoming parameter
    * **errorCallback**, function, optional, default null, invoked with 'jsonServerResponse' as incoming parameter


=== Esempi ===

<code javascript>
var processInstanceId = '123';
suspendProcessInstanceById(processInstanceId);
</code>

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