You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 22 Next »

This server-side class provide methods and public functions that allow operating with workflows and theirs components, such as activities, transitions, and so on.

You can create an instance of the SimpleWorkflow class in the way described below:


SimpleWorkflow
<![CDATA[const simpleWorkflow = new SimpleWorkflow('159491114038814558'); // wf_workflow.sys_id

Parameter(s):

NameTypeMandatoryDefault Value
workflowIdStringNNULL

cancel(current)

This method allows cancelling all active contexts of the current record.


Parameter(s):

NameTypeMandatoryDefault Value
currentSimpleRecord objectYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

cancel
<![CDATA[const simpleWorkflow = new SimpleWorkflow('159491114038814558');
if (simpleWorkflow.hasActiveContexts(current)) {
   	simpleWorkflow.cancel(current);
}


If a workflow has subflows created for it, use the following script to cancel all contexts of the workflow and any active subflows related to it:

Example:
<![CDATA[const currentDocId = ss.getDocIdByIds(current.sys_db_table_id, current.sys_id);

const wfContext = new SimpleRecord('wf_context');
wfContext.addQuery('related_record_id', currentDocId);
wfContext.addQuery('active', true);
wfContext.orderBy('sys_id');
wfContext.selectAttributes(['workflow_version_id']);
wfContext.query();
const doesActiveWfExist = wfContext.getRowCount() > 0;

while (wfContext.next()) {
  const simpleWorkflow = new SimpleWorkflow(wfContext.workflow_version_id.getValue('workflow_id'));
  if (simpleWorkflow.hasActiveContexts(current)) {
    simpleWorkflow.cancel(current);
  }
}

if (doesActiveWfExist) {
  ss.addInfoMessage('All contexts have been canceled!');
  ss.setRedirect();
}


copy()

This method copies the workflow with creating a version in the Checked Out state and after that returns a copied workflow.


Return:

TypeDescription
SimpleRecord object or NULLThis method returns NULL if the new SimpleWorkflow object has been created without specifying the workflowId parameter; otherwise, it returns an object of the Workflow (wf_workflow) table (of a SimpleRecord type).


Example:

copy
<![CDATA[const workflow = new SimpleWorkflow('159491114038814558');
const copiedWorkflow = workflow.copy();
const simpleWorkflow = new SimpleWorkflow(copiedWorkflow.sys_id);

delete()

This method deletes the workflow and all its elements.


Return:

TypeDescription
BooleanThis method returns the boolean result (TRUE if the workflow was successfully deleted; otherwise, returns FALSE).


Example:

delete
<![CDATA[const simpleWorkflow = new SimpleWorkflow('159491114038814558');
const copiedWorkflow = simpleWorkflow.copy();
const simpleWorkflow = new SimpleWorkflow(copiedWorkflow.sys_id);
if (simpleWorkflow.delete()) {
	ss.info('Workflow deleted!');
}

hasActiveContexts(current)

This method checks the current record if there are any active workflow contexts present or not.


Parameter(s):

NameTypeMandatoryDefault Value
currentSimpleRecord objectYN


Return:

TypeDescription
BooleanThis method returns the boolean result (TRUE if the active workflow context presents; otherwise, returns FALSE).


Example:

hasActiveContext
<![CDATA[const simpleWorkflow = new SimpleWorkflow('159491114038814558');
if (simpleWorkflow.hasActiveContexts(current)) {
	simpleWorkflow.cancel(current);
}

revival(executingActivity, current)

This method restarts the workflow starting with the activity specified.


Parameter(s):

NameTypeMandatoryDefault Value
executingActivitySimpleRecord objectYN
currentSimpleRecord objectYN


Return:

TypeDescription
SimpleRecord objectThis method returns an object of the Workflow Context (wf_context) table (of a SimpleRecord type).


Example:

revival
<![CDATA[const current = new SimpleRecord('task');
current.get('164579976616724057');
const approval = new SimpleRecord('sys_approval');
approval.get('164625329711023536');
const activity = approval.wf_executing_activity_id;
const workflow = new SimpleWorkflow();
workflow.revival(activity, current);

start(current)

This method is intended to start the workflow. The method starts only the workflows where the Condition Type is set to Manual.


Parameter(s):

NameTypeMandatoryDefault Value
currentSimpleRecord objectYN


Return:

TypeDescription
SimpleRecord object or NULL

This method returns NULL in the cases listed below:

  • the new SimpleWorkflow object has been created without specifying the workflowId parameter;
  • there are no workflow versions created by the current user.

Otherwise, it returns an object of the Workflow Context (wf_context) table (of a SimpleRecord type). 


Example:

start
<![CDATA[const simpleWorkflow = new SimpleWorkflow('159491114038814558');
const context = simpleWorkflow.start(current);
if (context.state === 'finished') {
	ss.info('Workflow finished!');
}

startSubflow(executingActivity, current, workflowId)

This method allows starting sub-workflow by executing activity.


Parameter(s):

NameTypeMandatoryDefault Value
executingActivitySimpleRecord objectYN
currentSimpleRecord objectYN
workflowIdStringYN


Return:

TypeDescription
SimpleRecord object or NULLThis method returns NULL if there are no workflow versions created by the current user; otherwise, it returns an object of the Workflow Context (wf_context) table (of a SimpleRecord type). 


Example:

startSubflow


















                
        
    
        


                        
    





    

	

		
    
    
            
  • 
            No labels
        
    • 
            


    





        
		
            




            
        








                        
    


        
    





        


                
    
            



    

    




    
    

    
    
    


    

        



                    
        

            
© 2019-2023, SimpleOne



https://simpleone.ru