Workflow call - Revision history

Administrator at 05:23, 27 May 2020

2020-05-27T05:23:17Z

← Older revision		Revision as of 05:23, 27 May 2020
Line 29:		Line 29:
	==Syntax==		==Syntax==

	Workflow_call(''workflowResourceId[, array parameters]'')		Workflow_call(workflowResourceId[, array parameters])

			Workflow_call(workflowResourceId[, array parameters] [, schedule])

	==Arguments==		==Arguments==
Line 36:		Line 38:

	''parameters'': will be passed into the CG Script of the called workflow or tabulation script		''parameters'': will be passed into the CG Script of the called workflow or tabulation script

			''schedule'': Use the given schedule to run workflow. It is CatTaskSchedule object see more at [[CatTaskInstantSchedule class\|CatTaskInstantSchedule]], [[CatTaskSpecificTimeSchedule class\|CatTaskSpecificTimeSchedule]], [[CatTaskNeverSchedule class\|CatTaskNeverSchedule]]

	==Return value==		==Return value==

	Object: This function returns a number, boolean, string, array, etc. depending on what the called workflow returns.		Object: This function returns a number, boolean, string, array, etc. depending on what the called workflow returns.

			When schedule workflow, will return CatTask instance id

	==Example==		==Example==
			<source lang="javascript">
			//Script of workflow with Resource Id = 12345
			array para = Workflow_getParameters();
			number a = para[0];//100
			number b = 1;
			number total = a+b;
			return total;
			</source>

	~~'''Main script~~:~~'''~~		<span style="color:#DF8621"> Call workflow with parameters </span>
	<source lang="javascript">		<source lang="javascript">
	array parameters={~~100~~};		//Main script
	number ~~wfId~~ = 12345;		number x = 100;
	~~array a~~ = Workflow_call(~~wfId~~,parameters);		array parameters = {x};
	~~print(a);~~		number workflowRId = 12345;
			number result = Workflow_call(workflowRId, parameters);//result = 101
	</source>		</source>
	~~'''Script of worflow with Resource Id~~ = ~~12345~~:~~'''~~
			<span style="color:#DF8621"> Schedule workflow, will return CatTask instance id </span>
	<source lang="javascript">		<source lang="javascript">
	~~array b~~ = ~~Workflow_getParameters~~();		number workflowRId = 12345;
	~~b[0]~~ = ~~b[0] +~~ 100;		number numberOfMinutesInFuture = 1;
	return b;		CatTaskSpecificTimeSchedule whenToSchedule = new CatTaskSpecificTimeSchedule(new DateTime(DateTime_addMinutes(new DateTime().AsArray, numberOfMinutesInFuture)));
			number curSchedule = Workflow_call(workflowRId,{100}, whenToSchedule);//return CatTask instance id
	</source>		</source>
	~~'''The main script will print:'''~~

	~~200~~

Administrator at 04:29, 27 May 2020

2020-05-27T04:29:38Z

← Older revision		Revision as of 04:29, 27 May 2020
Line 2:		Line 2:
	{{HelpFiles}}		{{HelpFiles}}

	~~===~~=Workflow_call~~===~~=		=Workflow_call=

	~~'''~~Description~~'''~~		==Description==

	This function will allow you to run a specific workflow or tabulation script, including feeding it with parameters in the process.		This function will allow you to run a specific workflow or tabulation script, including feeding it with parameters in the process.
Line 27:		Line 27:
	* It cannot run to a call depth of more than 10 (meaning that it cannot call a workflow that calls a workflow that calls a workflow ... to more than the 10th level)		* It cannot run to a call depth of more than 10 (meaning that it cannot call a workflow that calls a workflow that calls a workflow ... to more than the 10th level)

	~~'''~~Syntax~~'''~~		==Syntax==

	Workflow_call(''workflowResourceId[, array parameters]'')		Workflow_call(''workflowResourceId[, array parameters]'')

	~~'''~~Arguments~~'''~~		==Arguments==

	''workflowResourceId'': number - resource id of workflow		''workflowResourceId'': number - resource id of workflow
Line 37:		Line 37:
	''parameters'': will be passed into the CG Script of the called workflow or tabulation script		''parameters'': will be passed into the CG Script of the called workflow or tabulation script

	~~'''~~Return value~~'''~~		==Return value==

	Object: This function returns a number, boolean, string, array, etc. depending on what the called workflow returns.		Object: This function returns a number, boolean, string, array, etc. depending on what the called workflow returns.

	~~'''~~Example~~'''~~		==Example==

	'''Main script:'''		'''Main script:'''
			<source lang="javascript">
	''array parameters={100};''		array parameters={100};
			number wfId = 12345;
	''number wfId = 12345;''		array a = Workflow_call(wfId,parameters);
			print(a);
	''array a = Workflow_call(wfId,parameters);''		</source>

	''print(a);''

	'''Script of worflow with Resource Id = 12345:'''		'''Script of worflow with Resource Id = 12345:'''
			<source lang="javascript">
	''array b = Workflow_getParameters();''		array b = Workflow_getParameters();
			b[0] = b[0] + 100;
	''b[0] = b[0] + 100;''		return b;
			</source>
	''return b;''

	'''The main script will print:'''		'''The main script will print:'''

	200		200

	~~'''Availability'''~~

	~~Version 5.8.1~~
	~~__NOTOC__~~
	~~<!-- imported from file: 8067.htm-->~~

Cg_pham at 07:04, 14 December 2011

2011-12-14T07:04:38Z

← Older revision		Revision as of 07:04, 14 December 2011
Line 1:		Line 1:
	[[Category:Workflow]]		[[Category:Workflow]]
			{{HelpFiles}}

	====Workflow_call====		====Workflow_call====

Cg_pham at 10:43, 23 March 2011

2011-03-23T10:43:38Z

← Older revision		Revision as of 10:43, 23 March 2011
Line 1:		Line 1:
	[[Category:~~HelpBooks~~]]		[[Category:Workflow]]

Catglobe: jrfconvert import

2011-03-07T09:13:01Z

jrfconvert import

New page

[[Category:HelpBooks]]

====Workflow_call====

'''Description'''

This function will allow you to run a specific workflow or tabulation script, including feeding it with parameters in the process.

The function will throw an exception when:

* It is passed an invalid number of parameters
* It is passed invalid data types for any of its parameters
* It is passed empty parameters
* It is passed an invalid workflow resource id
* It is run by a user who does not have at least observer access to the workflow.

This function is useful in regards to:

* Returning values from a workflow that you need in another workflow
* Returning a chart from a tabulation script that you need in another workflow
* Returning the error stacktrace from another workflow

The following limitations apply to this function

* It cannot call a workflow which is set to run in batch mode
* It cannot run to a call depth of more than 10 (meaning that it cannot call a workflow that calls a workflow that calls a workflow ... to more than the 10th level)

'''Syntax'''

Workflow_call(''workflowResourceId[, array parameters]'')

'''Arguments'''

''workflowResourceId'': number - resource id of workflow

''parameters'': will be passed into the CG Script of the called workflow or tabulation script

'''Return value'''

Object: This function returns a number, boolean, string, array, etc. depending on what the called workflow returns.

'''Example'''

'''Main script:'''

''array parameters={100};''

''number wfId = 12345;''

''array a = Workflow_call(wfId,parameters);''

''print(a);''

'''Script of worflow with Resource Id = 12345:'''

''array b = Workflow_getParameters();''

''b[0] = b[0] + 100;''

''return b;''

'''The main script will print:'''

200

'''Availability'''

Version 5.8.1
__NOTOC__