WorkflowScript class - Revision history

Nguyenduyan at 08:12, 3 April 2025

2025-04-03T08:12:57Z

← Older revision		Revision as of 08:12, 3 April 2025
Line 27:		Line 27:
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>CgScript</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>The script.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>CgScript</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>The script.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>DataCache</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the DataCache under which to run the script under. 0 means clear setting. Only for tabulation scripts.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>DataCache</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the DataCache under which to run the script under. 0 means clear setting. Only for tabulation scripts.</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>DynamicScriptName</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Script name to use for error messages in dynamic scripts.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>EnableProfiling</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Set to true to enable profiling.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>EnableProfiling</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Set to true to enable profiling.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ImpersonatedUser</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the user under which to run the script under. Must have Full access to the user to set as impersonation. 0 means clear impersonation.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ImpersonatedUser</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the user under which to run the script under. Must have Full access to the user to set as impersonation. 0 means clear impersonation.</nowiki>}}

Administrator at 06:33, 2 July 2020

2020-07-02T06:33:38Z

Nguyenduyan at 04:17, 31 May 2017

2017-05-31T04:17:03Z

← Older revision		Revision as of 04:17, 31 May 2017
Line 141:		Line 141:
	</source>		</source>

	<br/>'''Ex 2:''' <source lang="javascript">		<br />'''Ex 2:''' <source lang="javascript">
	ProfilingResult pr;		ProfilingResult pr;
	WorkflowScript wf = new WorkflowScript(11951195);		WorkflowScript wf = new WorkflowScript(11951195);
Line 162:		Line 162:
	DateTime dt = new DateTime("2017/05/31 03:10");		DateTime dt = new DateTime("2017/05/31 03:10");
	CatTaskSpecificTimeSchedule schedule = new CatTaskSpecificTimeSchedule(dt);		CatTaskSpecificTimeSchedule schedule = new CatTaskSpecificTimeSchedule(dt);
			//CatTaskInstantSchedule schedule = new CatTaskInstantSchedule();
	bool informMe = false;		bool informMe = false;
	array parameters={};		array parameters={};
	wS.Schedule(schedule, informMe, parameters);//Returns CatTask instance id: 104700 (CatTaskMetaDataId: 54183)		wS.Schedule(schedule, informMe, parameters);//Returns CatTask instance id: 104700 (CatTaskMetaDataId: 54183)
	</source>		</source>

Nguyenduyan at 02:36, 31 May 2017

2017-05-31T02:36:36Z

@@ Line 154: / Line 154: @@
 print(pr.TimeResult); // {"1": {"-1": 0.0034, "4": 0.0034}}
 print(pr.WhereExpTime); // 0
 </source>

Nguyenduyan at 09:07, 26 May 2017

2017-05-26T09:07:53Z

← Older revision		Revision as of 09:07, 26 May 2017
Line 1:		Line 1:
	{{CGscriptClass_Template		{{CGscriptClass_Template
	\|Name=WorkflowScript		\|Name=<nowiki>WorkflowScript</nowiki>
	\|Description=Class to manipulate workflows.		\|Description=<nowiki>Class to manipulate workflows.</nowiki>
	\|Constructors=		\|Constructors=
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=~~number~~\|Name=resourceId\|Description=Resource id of the script to load}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>resourceId</nowiki>\|Description=<nowiki>Resource id of the script to load</nowiki>}}
	\|Description=Load existing workflow}}		\|Description=<nowiki>Load existing workflow</nowiki>}}
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=script\|Description=The script to use.\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=isTabulation\|Description=Set if this is a tabulation script or not}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>script</nowiki>\|Description=<nowiki>The script to use.</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>isTabulation</nowiki>\|Description=<nowiki>Set if this is a tabulation script or not</nowiki>}}
	\|Description=Make new workflow}}		\|Description=<nowiki>Make new workflow</nowiki>}}
	\|Methods=		\|Methods=
	{{CGscriptMethods_Template\|ReturnType=~~AnyType~~\|Name=Call\|Parameters={{CGscriptParameters_Template\|Type=params AnyType\|Name=params AnyType\|Description=}}		{{CGscriptMethods_Template\|ReturnType=object\|Name=<nowiki>Call</nowiki>\|Parameters={{CGscriptParameters_Template\|Type=params AnyType\|Name=params AnyType\|Description=}}
	\|Description=Run the script with the given arguments}}		\|Description=<nowiki>Run the script with the given arguments</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=~~AnyType~~\|Name=Invoke\|Parameters=		{{CGscriptMethods_Template\|ReturnType=object\|Name=<nowiki>Invoke</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=array\|Name=arguments\|Description=The arguments to the script}}		{{CGscriptParameters_Template\|Type=array\|Name=<nowiki>arguments</nowiki>\|Description=<nowiki>The arguments to the script</nowiki>}}
	\|Description=Run the script with the given arguments}}		\|Description=<nowiki>Run the script with the given arguments</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=Save\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=name\|Description=Name of the resource. If empty it will not change the existing name. Required for new scripts.\|Comma=,}}{{CGscriptParameters_Template\|Type=~~number~~\|Name=parentResourceId\|Description=Parent of the resource. If 0 it will not change the existing. Required for new scripts.}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the resource. If empty it will not change the existing name. Required for new scripts.</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>parentResourceId</nowiki>\|Description=<nowiki>Parent of the resource. If 0 it will not change the existing. Required for new scripts.</nowiki>}}
	\|Description=Save the current workflowscript.}}		\|Description=<nowiki>Save the current workflowscript.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=Save\|Description=Save the current workflowscript using the existing name and parent.}}		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save the current workflowscript using the existing name and parent.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=ToString\|Description=The string representation of the object.}}		{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>Schedule</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=CatTaskSchedule\|Name=<nowiki>schedule</nowiki>\|Description=<nowiki>When to run</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>informMe</nowiki>\|Description=<nowiki>Send mail when finished task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=array\|Name=<nowiki>parameters</nowiki>\|Description=<nowiki>Send mail when finished task</nowiki>}}
			\|Description=<nowiki>Schedule workflow to run at a given schedule. Returns CatTask instance id</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}
	\|Properties=		\|Properties=
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=BatchMode\|HasGetter=1\|HasSetter=1\|Description=Get/Set the if the non-tabulation script should run in batch mode.}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>BatchMode</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the if the non-tabulation script should run in batch mode.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=CgScript\|HasGetter=1\|HasSetter=1\|Description=The script.}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>CgScript</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>The script.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=~~number~~\|Name=DataCache\|HasGetter=1\|HasSetter=1\|Description=Get/Set the DataCache under which to run the script under. 0 means clear setting. Only for tabulation scripts.}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>DataCache</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the DataCache under which to run the script under. 0 means clear setting. Only for tabulation scripts.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=EnableProfiling\|HasGetter=1\|HasSetter=1\|Description=Set to true to enable profiling.}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>EnableProfiling</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Set to true to enable profiling.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=~~number~~\|Name=ImpersonatedUser\|HasGetter=1\|HasSetter=1\|Description=Get/Set the user under which to run the script under. Must have Full access to the user to set as impersonation. 0 means clear impersonation.}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ImpersonatedUser</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the user under which to run the script under. Must have Full access to the user to set as impersonation. 0 means clear impersonation.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=ObjectTypeName\|HasGetter=1\|Description=The name of the type of object.}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=ProfilingResult\|Name=ProfilingResult\|HasGetter=1\|Description=Returns the result of the Profiling.}}		{{CGscriptProperties_Template\|ReturnType=ProfilingResult\|Name=<nowiki>ProfilingResult</nowiki>\|HasGetter=1\|Description=<nowiki>Returns the result of the Profiling.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=~~number~~\|Name=Questionnaire\|HasGetter=1\|HasSetter=1\|Description=Get/Set the Questionnaire under which to run the script under. 0 means clear setting. Only for non-tabulation scripts.}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Questionnaire</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Questionnaire under which to run the script under. 0 means clear setting. Only for non-tabulation scripts.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=TypeInformation\|HasGetter=1\|Description=Get information about this class.}}		{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=~~number~~\|Name=UniqueId\|HasGetter=1\|Description=The resource id of the workflow.}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UniqueId</nowiki>\|HasGetter=1\|Description=<nowiki>The resource id of the workflow.</nowiki>}}
	}}		}}


	=== '''Notes''' ===		=== '''Notes''' ===

Tungocman at 05:19, 26 March 2015

2015-03-26T05:19:09Z

← Older revision		Revision as of 05:19, 26 March 2015
Line 34:		Line 34:

	=== '''Notes''' ===		=== '''Notes''' ===
	To be able to run the dynamic scripts, means using the second constructor of this class. Users must have this special navigation access: '''Able to create scripts that can dynamically create scripts'''. This special navigation access just can be seen and set by user '''Administrator'''.		To be able to run the dynamic scripts, means using the second constructor of this class. Users must have this special navigation access in both module "Workflow Module" and "Tabulation Script Module": '''Able to create scripts that can dynamically create scripts'''. This special navigation access just can be seen and set by user '''Administrator'''.

Tungocman at 03:15, 26 March 2015

2015-03-26T03:15:55Z

← Older revision		Revision as of 03:15, 26 March 2015
Line 33:		Line 33:
	}}		}}

			=== '''Notes''' ===
			To be able to run the dynamic scripts, means using the second constructor of this class. Users must have this special navigation access: '''Able to create scripts that can dynamically create scripts'''. This special navigation access just can be seen and set by user '''Administrator'''.

CGHelpdesk at 09:26, 5 November 2013

2013-11-05T09:26:39Z

← Older revision		Revision as of 09:26, 5 November 2013
Line 37:		Line 37:
	=== '''Examples''' ===		=== '''Examples''' ===

	'''Ex 1:'''		'''Ex 1:''' <source lang="javascript">
	<source lang="javascript">
	/*		/*
	* MAKE A COPY OF A SPECIFIED WORKFLOW		* MAKE A COPY OF A SPECIFIED WORKFLOW
Line 136:		Line 135:
	</source>		</source>

			<br/>'''Ex 2:''' <source lang="javascript">
	'''Ex 2:'''
	<source lang="javascript">
	ProfilingResult pr;		ProfilingResult pr;
	WorkflowScript wf = new WorkflowScript(11951195);		WorkflowScript wf = new WorkflowScript(11951195);
Line 145:		Line 142:
	wf.Call();		wf.Call();

	print(pr.Script); // {print("hello world");}		print(pr.Script); // {print("hello world");}
	print(pr.CompileTime); // 0.0595		print(pr.CompileTime); // 0.0595
	print(pr.CountResult); // {"1": {"4": 1}}		print(pr.CountResult); // {"1": {"4": 1}}
	print(pr.~~DependecyGraphTime~~); // 0		print(pr.DependencyGraphTime); // 0
	print(pr.TimeResult); // {"1": {"-1": 0.0034, "4": 0.0034}}		print(pr.TimeResult); // {"1": {"-1": 0.0034, "4": 0.0034}}
	print(pr.WhereExpTime); // 0		print(pr.WhereExpTime); // 0
	</source>		</source>

CGHelpdesk at 11:03, 17 October 2013

2013-10-17T11:03:17Z

← Older revision		Revision as of 11:03, 17 October 2013
Line 32:		Line 32:
	{{CGscriptProperties_Template\|ReturnType=number\|Name=UniqueId\|HasGetter=1\|Description=The resource id of the workflow.}}		{{CGscriptProperties_Template\|ReturnType=number\|Name=UniqueId\|HasGetter=1\|Description=The resource id of the workflow.}}
	}}		}}



	=== '''Examples''' ===		=== '''Examples''' ===

	'''Ex 1:''' <source lang="javascript">		'''Ex 1:'''
			<source lang="javascript">
	/*		/*
	* MAKE A COPY OF A SPECIFIED WORKFLOW		* MAKE A COPY OF A SPECIFIED WORKFLOW
Line 132:		Line 134:
	return dest;		return dest;
	}		}
			</source>


			'''Ex 2:'''
			<source lang="javascript">
			ProfilingResult pr;
			WorkflowScript wf = new WorkflowScript(11951195);
			pr = wf.ProfilingResult;
			pr.EnableProfiling = true;
			wf.Call();

			print(pr.Script); // {print("hello world");}
			print(pr.CompileTime); // 0.0595
			print(pr.CountResult); // {"1": {"4": 1}}
			print(pr.DependecyGraphTime); // 0
			print(pr.TimeResult); // {"1": {"-1": 0.0034, "4": 0.0034}}
			print(pr.WhereExpTime); // 0
	</source>		</source>

CGHelpdesk at 11:01, 17 October 2013

2013-10-17T11:01:43Z

← Older revision		Revision as of 11:01, 17 October 2013
Line 33:		Line 33:
	}}		}}

	=== '''Examples''' = ===
			=== '''Examples''' ===

	'''Ex 1:''' <source lang="javascript">		'''Ex 1:''' <source lang="javascript">

← Older revision		Revision as of 08:12, 3 April 2025
Line 27:		Line 27:
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>CgScript</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>The script.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>CgScript</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>The script.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>DataCache</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the DataCache under which to run the script under. 0 means clear setting. Only for tabulation scripts.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>DataCache</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the DataCache under which to run the script under. 0 means clear setting. Only for tabulation scripts.</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>DynamicScriptName</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Script name to use for error messages in dynamic scripts.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>EnableProfiling</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Set to true to enable profiling.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>EnableProfiling</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Set to true to enable profiling.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ImpersonatedUser</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the user under which to run the script under. Must have Full access to the user to set as impersonation. 0 means clear impersonation.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ImpersonatedUser</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the user under which to run the script under. Must have Full access to the user to set as impersonation. 0 means clear impersonation.</nowiki>}}

← Older revision		Revision as of 09:07, 26 May 2017
Line 1:		Line 1:
	{{CGscriptClass_Template		{{CGscriptClass_Template
	\|Name=WorkflowScript		\|Name=<nowiki>WorkflowScript</nowiki>
	\|Description=Class to manipulate workflows.		\|Description=<nowiki>Class to manipulate workflows.</nowiki>
	\|Constructors=		\|Constructors=
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=~~number~~\|Name=resourceId\|Description=Resource id of the script to load}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>resourceId</nowiki>\|Description=<nowiki>Resource id of the script to load</nowiki>}}
	\|Description=Load existing workflow}}		\|Description=<nowiki>Load existing workflow</nowiki>}}
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=script\|Description=The script to use.\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=isTabulation\|Description=Set if this is a tabulation script or not}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>script</nowiki>\|Description=<nowiki>The script to use.</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>isTabulation</nowiki>\|Description=<nowiki>Set if this is a tabulation script or not</nowiki>}}
	\|Description=Make new workflow}}		\|Description=<nowiki>Make new workflow</nowiki>}}
	\|Methods=		\|Methods=
	{{CGscriptMethods_Template\|ReturnType=~~AnyType~~\|Name=Call\|Parameters={{CGscriptParameters_Template\|Type=params AnyType\|Name=params AnyType\|Description=}}		{{CGscriptMethods_Template\|ReturnType=object\|Name=<nowiki>Call</nowiki>\|Parameters={{CGscriptParameters_Template\|Type=params AnyType\|Name=params AnyType\|Description=}}
	\|Description=Run the script with the given arguments}}		\|Description=<nowiki>Run the script with the given arguments</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=~~AnyType~~\|Name=Invoke\|Parameters=		{{CGscriptMethods_Template\|ReturnType=object\|Name=<nowiki>Invoke</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=array\|Name=arguments\|Description=The arguments to the script}}		{{CGscriptParameters_Template\|Type=array\|Name=<nowiki>arguments</nowiki>\|Description=<nowiki>The arguments to the script</nowiki>}}
	\|Description=Run the script with the given arguments}}		\|Description=<nowiki>Run the script with the given arguments</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=Save\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=name\|Description=Name of the resource. If empty it will not change the existing name. Required for new scripts.\|Comma=,}}{{CGscriptParameters_Template\|Type=~~number~~\|Name=parentResourceId\|Description=Parent of the resource. If 0 it will not change the existing. Required for new scripts.}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the resource. If empty it will not change the existing name. Required for new scripts.</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>parentResourceId</nowiki>\|Description=<nowiki>Parent of the resource. If 0 it will not change the existing. Required for new scripts.</nowiki>}}
	\|Description=Save the current workflowscript.}}		\|Description=<nowiki>Save the current workflowscript.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=Save\|Description=Save the current workflowscript using the existing name and parent.}}		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save the current workflowscript using the existing name and parent.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=ToString\|Description=The string representation of the object.}}		{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>Schedule</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=CatTaskSchedule\|Name=<nowiki>schedule</nowiki>\|Description=<nowiki>When to run</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>informMe</nowiki>\|Description=<nowiki>Send mail when finished task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=array\|Name=<nowiki>parameters</nowiki>\|Description=<nowiki>Send mail when finished task</nowiki>}}
			\|Description=<nowiki>Schedule workflow to run at a given schedule. Returns CatTask instance id</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}
	\|Properties=		\|Properties=
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=BatchMode\|HasGetter=1\|HasSetter=1\|Description=Get/Set the if the non-tabulation script should run in batch mode.}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>BatchMode</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the if the non-tabulation script should run in batch mode.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=CgScript\|HasGetter=1\|HasSetter=1\|Description=The script.}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>CgScript</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>The script.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=~~number~~\|Name=DataCache\|HasGetter=1\|HasSetter=1\|Description=Get/Set the DataCache under which to run the script under. 0 means clear setting. Only for tabulation scripts.}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>DataCache</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the DataCache under which to run the script under. 0 means clear setting. Only for tabulation scripts.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=EnableProfiling\|HasGetter=1\|HasSetter=1\|Description=Set to true to enable profiling.}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>EnableProfiling</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Set to true to enable profiling.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=~~number~~\|Name=ImpersonatedUser\|HasGetter=1\|HasSetter=1\|Description=Get/Set the user under which to run the script under. Must have Full access to the user to set as impersonation. 0 means clear impersonation.}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ImpersonatedUser</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the user under which to run the script under. Must have Full access to the user to set as impersonation. 0 means clear impersonation.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=ObjectTypeName\|HasGetter=1\|Description=The name of the type of object.}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=ProfilingResult\|Name=ProfilingResult\|HasGetter=1\|Description=Returns the result of the Profiling.}}		{{CGscriptProperties_Template\|ReturnType=ProfilingResult\|Name=<nowiki>ProfilingResult</nowiki>\|HasGetter=1\|Description=<nowiki>Returns the result of the Profiling.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=~~number~~\|Name=Questionnaire\|HasGetter=1\|HasSetter=1\|Description=Get/Set the Questionnaire under which to run the script under. 0 means clear setting. Only for non-tabulation scripts.}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Questionnaire</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Questionnaire under which to run the script under. 0 means clear setting. Only for non-tabulation scripts.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=TypeInformation\|HasGetter=1\|Description=Get information about this class.}}		{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=~~number~~\|Name=UniqueId\|HasGetter=1\|Description=The resource id of the workflow.}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UniqueId</nowiki>\|HasGetter=1\|Description=<nowiki>The resource id of the workflow.</nowiki>}}
	}}		}}


	=== '''Notes''' ===		=== '''Notes''' ===

← Older revision		Revision as of 06:33, 2 July 2020
Line 2:		Line 2:
	\|Name=<nowiki>WorkflowScript</nowiki>		\|Name=<nowiki>WorkflowScript</nowiki>
	\|Description=<nowiki>Class to manipulate workflows.</nowiki>		\|Description=<nowiki>Class to manipulate workflows.</nowiki>
	\|Constructors=		\|InheritsFrom=object\|Constructors=
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>resourceId</nowiki>\|Description=<nowiki>Resource id of the script to load</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>resourceId</nowiki>\|Description=<nowiki>Resource id of the script to load</nowiki>}}
Line 22:		Line 22:
	{{CGscriptParameters_Template\|Type=CatTaskSchedule\|Name=<nowiki>schedule</nowiki>\|Description=<nowiki>When to run</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>informMe</nowiki>\|Description=<nowiki>Send mail when finished task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=array\|Name=<nowiki>parameters</nowiki>\|Description=<nowiki>Send mail when finished task</nowiki>}}		{{CGscriptParameters_Template\|Type=CatTaskSchedule\|Name=<nowiki>schedule</nowiki>\|Description=<nowiki>When to run</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>informMe</nowiki>\|Description=<nowiki>Send mail when finished task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=array\|Name=<nowiki>parameters</nowiki>\|Description=<nowiki>Send mail when finished task</nowiki>}}
	\|Description=<nowiki>Schedule workflow to run at a given schedule. Returns CatTask instance id</nowiki>}}		\|Description=<nowiki>Schedule workflow to run at a given schedule. Returns CatTask instance id</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}
	\|Properties=		\|Properties=
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>BatchMode</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the if the non-tabulation script should run in batch mode.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>BatchMode</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the if the non-tabulation script should run in batch mode.</nowiki>}}
Line 32:		Line 32:
	{{CGscriptProperties_Template\|ReturnType=ProfilingResult\|Name=<nowiki>ProfilingResult</nowiki>\|HasGetter=1\|Description=<nowiki>Returns the result of the Profiling.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=ProfilingResult\|Name=<nowiki>ProfilingResult</nowiki>\|HasGetter=1\|Description=<nowiki>Returns the result of the Profiling.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Questionnaire</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Questionnaire under which to run the script under. 0 means clear setting. Only for non-tabulation scripts.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Questionnaire</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Questionnaire under which to run the script under. 0 means clear setting. Only for non-tabulation scripts.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Inherited=object\|Description=<nowiki>Get information about this class.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UniqueId</nowiki>\|HasGetter=1\|Description=<nowiki>The resource id of the workflow.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UniqueId</nowiki>\|HasGetter=1\|Description=<nowiki>The resource id of the workflow.</nowiki>}}
	}}		}}


	=== '''Notes''' ===		=== '''Notes''' ===