Starfish Scripting Class - Revision history

Jkuehlthau: /* File Class Methods */

2026-01-09T22:15:38Z

File Class Methods

← Older revision		Revision as of 22:15, 9 January 2026
Line 234:		Line 234:
	\|-		\|-
	\| MoveFile ( String, String )		\| MoveFile ( String, String )
	\| Moves a file on the server.		\| Moves a file on the server. (You can also use this to rename a file.)

	String – From filename path		String – From filename path

Jkuehlthau: /* File Class Methods */

2026-01-09T22:00:18Z

File Class Methods

← Older revision		Revision as of 22:00, 9 January 2026
Line 227:		Line 227:
	! style="font-weight: bold;" width="250" \| Method Name		! style="font-weight: bold;" width="250" \| Method Name
	! style="font-weight: bold;" \| Description		! style="font-weight: bold;" \| Description
			\|-
			\| FileExists ( String, String )
			\| Returns boolean indicating whether the file by the provided name exists. These file operations are performed within your instance's "Files" area. Returns: Boolean - true if the file exists, false if not.

			String - fileName - Filename to check for
	\|-		\|-
	\| MoveFile ( String, String )		\| MoveFile ( String, String )

Jkuehlthau: /* Class Properties */

2025-09-25T20:34:47Z

Class Properties

← Older revision		Revision as of 20:34, 25 September 2025
Line 35:		Line 35:
	\|-		\|-
	\| CurrentStageName		\| CurrentStageName
	\| Read-only. Returns the name of the current stage. Useful during “Repeat Each Stage” Exec Operations to determine path of execution/next steps.		\| Read-only. Returns the name of the current stage. Useful during “Repeat Each Stage” Exec Operations to determine path of execution/next steps. Use "Starfish.CurrentStageName" without the () in C#.
	\|-		\|-
	\| TotalRows		\| TotalRows

Jkuehlthau: /* System Generated Variables */

2025-09-24T20:30:28Z

System Generated Variables

← Older revision		Revision as of 20:30, 24 September 2025
Line 8:		Line 8:
	\|-		\|-
	\|[Row Hash Code]		\|[Row Hash Code]
	\|Found in the Origin Variable Class, the [Row Hash Code] is added to scripts as @@ORG:#RowHashCode@@.<br>Row Hash Code is a run-time generated MD5 hash of the entire row's data.<br>This is useful when you don't have a last modified date in your origin. You can store it and on the next run of the Job, compare the hash to see if the record changed instead of having to compare each individual field.<BR>'''*AS OF 12/28/22, ON-PREMISE, THIS ONLY WORKS IN VBSCRIPT. DO NOT USE WITH C#, JAVASCRIPT, OR PERL. UNSURE ABOUT DESIGNER.*'''		\|Found in the Origin Variable Class, the [Row Hash Code] is added to scripts as @@ORG:#RowHashCode@@.<br>Row Hash Code is a run-time generated MD5 hash of the entire row's data.<br>This is useful when you don't have a last modified date in your origin. You can store it and on the next run of the Job, compare the hash to see if the record changed instead of having to compare each individual field.<BR>'''*AS OF 12/28/22, ON-PREMISE, THIS ONLY WORKS IN VBSCRIPT. DO NOT USE WITH C#, JAVASCRIPT, OR PERL. UNSURE ABOUT DESIGNER.*'''<br>
			In Starfish Cartographer in the Cloud, use Starfish.GetRowHash();.
	\|-		\|-
	\|Job Argument		\|Job Argument

Jkuehlthau: /* Lookup and data retrieval Class Methods */

2024-04-24T21:33:30Z

Lookup and data retrieval Class Methods

← Older revision		Revision as of 21:33, 24 April 2024
Line 140:		Line 140:
	\|-		\|-
	\| SmartQueryDT ( String, [String], [String], String(Optional))		\| SmartQueryDT ( String, [String], [String], String(Optional))
	\| Same as above, except returns the results as a System.Data.DataTable object.		\| Same as above, except returns the results as a System.Data.DataTable object. In the DESTINATION/ORIGIN parameter, use the name or ID of a Connection to call a Connection that is not the Origin or Destination of your job.
	Intended for C# scripting only; to use it will be necessary to add the following to the .NET Global - External Assemblies: "System.dll,System.Xml.dll,System.Data.dll".		Intended for C# scripting only; to use it will be necessary to add the following to the .NET Global - External Assemblies: "System.dll,System.Xml.dll,System.Data.dll".
	\|}		\|}

Jkuehlthau: /* Lookup and data retrieval Class Methods */

2024-04-24T21:32:42Z

Lookup and data retrieval Class Methods

← Older revision		Revision as of 21:32, 24 April 2024
Line 122:		Line 122:
	String – Default Blank. Order By		String – Default Blank. Order By

	String – Default "DESTINATION". Use "ORIGIN" to query the Origin.		String – Default "DESTINATION". Use "ORIGIN" to query the Origin. Use the name or ID of a Connection to call a Connection that is not the Origin or Destination of your job.
	\|-		\|-
	\| SmartQuery ( String, [String], [String], String(Optional))		\| SmartQuery ( String, [String], [String], String(Optional))

Jkuehlthau: /* Queued Datasets */

2023-11-22T16:32:54Z

Queued Datasets

← Older revision		Revision as of 16:32, 22 November 2023
Line 540:		Line 540:
	</syntaxhighlight>		</syntaxhighlight>
	Once you have created your Queue, you can create a stage and set the Queue Behavior to Repeat and give it the name of the queue you created in your script. Starfish will then loop over the data in that Queue. When mapping fields in the Stage, you pull the data from the queue with a script:		Once you have created your Queue, you can create a stage and set the Queue Behavior to Repeat and give it the name of the queue you created in your script. Starfish will then loop over the data in that Queue. When mapping fields in the Stage, you pull the data from the queue with a script:
	<syntaxhighlight lang="~~Visual Basic.NET~~">		<syntaxhighlight lang="VBScript">
	Function ScriptedField		Function ScriptedField
	ScriptedField = Queued("FieldName")		ScriptedField = Queued("FieldName")
	End Function		End Function
	</syntaxhighlight>		</syntaxhighlight>

Jkuehlthau: /* Queued Datasets */

2023-11-22T16:32:34Z

Queued Datasets

← Older revision		Revision as of 16:32, 22 November 2023
Line 540:		Line 540:
	</syntaxhighlight>		</syntaxhighlight>
	Once you have created your Queue, you can create a stage and set the Queue Behavior to Repeat and give it the name of the queue you created in your script. Starfish will then loop over the data in that Queue. When mapping fields in the Stage, you pull the data from the queue with a script:		Once you have created your Queue, you can create a stage and set the Queue Behavior to Repeat and give it the name of the queue you created in your script. Starfish will then loop over the data in that Queue. When mapping fields in the Stage, you pull the data from the queue with a script:
	<~~syntaxhighlightlang~~="~~basic~~">		<syntaxhighlight lang="Visual Basic.NET">
	Function ScriptedField		Function ScriptedField
	ScriptedField = Queued("FieldName")		ScriptedField = Queued("FieldName")
	End Function		End Function
	</syntaxhighlight>		</syntaxhighlight>

Jkuehlthau: /* Queued Datasets */

2023-11-22T16:30:43Z

Queued Datasets

← Older revision		Revision as of 16:30, 22 November 2023
Line 532:		Line 532:
	=Queued Datasets=		=Queued Datasets=
	You can create datasets from a JSON Array or a C# Datatable object:		You can create datasets from a JSON Array or a C# Datatable object:
	<syntaxhighlight lang="~~csharp~~">		<syntaxhighlight lang="C#">
	void CSharpProcedure()		void CSharpProcedure()
	{		{

Jkuehlthau: /* Queued Datasets */

2023-11-22T16:30:19Z

Queued Datasets

← Older revision		Revision as of 16:30, 22 November 2023
Line 532:		Line 532:
	=Queued Datasets=		=Queued Datasets=
	You can create datasets from a JSON Array or a C# Datatable object:		You can create datasets from a JSON Array or a C# Datatable object:
	<~~source~~ lang="csharp">		<syntaxhighlight lang="csharp">
	void CSharpProcedure()		void CSharpProcedure()
	{		{
Line 538:		Line 538:
	Starfish.SetQueuedJSON(Starfish.OriginData["CONTACTS"].ToString(), "contacts")		Starfish.SetQueuedJSON(Starfish.OriginData["CONTACTS"].ToString(), "contacts")
	}		}
	</~~source~~>		</syntaxhighlight>
	Once you have created your Queue, you can create a stage and set the Queue Behavior to Repeat and give it the name of the queue you created in your script. Starfish will then loop over the data in that Queue. When mapping fields in the Stage, you pull the data from the queue with a script:		Once you have created your Queue, you can create a stage and set the Queue Behavior to Repeat and give it the name of the queue you created in your script. Starfish will then loop over the data in that Queue. When mapping fields in the Stage, you pull the data from the queue with a script:
	<~~source lang~~="basic">		<syntaxhighlightlang="basic">
	Function ScriptedField		Function ScriptedField
	ScriptedField = Queued("FieldName")		ScriptedField = Queued("FieldName")
	End Function		End Function
	</~~source~~>		</syntaxhighlight>