MCPServer/TaskTypes - Revision history

Sallain at 21:57, 11 February 2020

2020-02-11T21:57:58Z

Sevein at 23:00, 7 March 2018

2018-03-07T23:00:57Z

Hbecker: Update links to MCPServer

2017-03-08T18:22:55Z

Update links to MCPServer

Hbecker: Hbecker moved page MCP/TaskTypes to MCPServer/TaskTypes: MCP too broad - this page will only cover the MCPServer, and MCPClient will be its own page

2017-03-08T18:16:45Z

Hbecker moved page MCP/TaskTypes to MCPServer/TaskTypes: MCP too broad - this page will only cover the MCPServer, and MCPClient will be its own page

Hbecker: /* General */ Remove now-dead link to old notes

2015-09-03T18:50:12Z

General: Remove now-dead link to old notes

Hbecker: Fix typo in previous

2015-02-25T23:18:24Z

Fix typo in previous

Hbecker: Mark Transcoding as removed.

2015-02-25T23:17:41Z

Mark Transcoding as removed.

Courtney at 21:48, 16 October 2013

2013-10-16T21:48:46Z

Hbecker: /* Unit Variable? */ Update description

2013-10-09T18:46:07Z

Unit Variable?: Update description

Hbecker: /* Magic Links - Deprecated */ Updating description

2013-10-08T19:31:32Z

Magic Links - Deprecated: Updating description

← Older revision		Revision as of 21:57, 11 February 2020
Line 1:		Line 1:
	[[Main Page]] > [[Development]] > [[:Category:Development documentation\|Development documentation]] > [[MCPServer]] > TaskTypes		[[Main Page]] > [[Development]] > [[:Category:Development documentation\|Development documentation]] > [[MCPServer]] > TaskTypes
		+
		+	<div style="padding: 10px 10px; border: 1px solid black; background-color: #F79086;">This page is no longer being maintained and may contain inaccurate information. Please see the [https://www.archivematica.org/docs/latest/ Archivematica documentation] for up-to-date information. </div> <p>

	<div class="status">		<div class="status">

← Older revision		Revision as of 23:00, 7 March 2018
Line 117:		Line 117:

	== Magic Links - Deprecated ==		== Magic Links - Deprecated ==
		+
		+	Removed in https://github.com/artefactual/archivematica/pull/948, will be part of Archivematica v1.8.0.

	=== Set Magic Link - Deprecated ===		=== Set Magic Link - Deprecated ===

@@ Line 1: / Line 1: @@
-[[Main Page]] > [[Development]] > [[:Category:Development documentation|Development documentation]] > [[MCP]] > TaskTypes
+[[Main Page]] > [[Development]] > [[:Category:Development documentation|Development documentation]] > [[MCPServer]] > TaskTypes
 <div class="status">
@@ Line 20: / Line 20: @@
 </div>
-For each '''MicroServiceChainLink''' in the [[MCP | MCP Server ]], the TaskType determines what code will be executed for that task.  There are 13 task types.
+For each '''MicroServiceChainLink''' in the [[MCPServer | MCP Server ]], the TaskType determines what code will be executed for that task.  There are 13 task types.
-Reading about the [[MCP | MCP Server]] is highly recommended to understand this page.
+Reading about the [[MCPServer | MCP Server]] is highly recommended to understand this page.
 == General ==
@@ Line 29: / Line 29: @@
 * '''Description in TaskTypes''': one instance
 * '''LinkTaskMananger''': linkTaskManagerDirectories
-* '''TaskTypePKReference''': Foreign key to [[ MCP#StandardTasksConfigs | StandardTasksConfigs]]
+* '''TaskTypePKReference''': Foreign key to [[ MCPServer#StandardTasksConfigs | StandardTasksConfigs]]
 Run the command listed in StandardTasksConfigs exactly once.  TODO filterSubDir?
@@ Line 36: / Line 36: @@
 * '''Description in TaskTypes''': for each file
 * '''LinkTaskMananger''': linkTaskManagerFiles
-* '''TaskTypePKReference''': Foreign key to [[ MCP#StandardTasksConfigs | StandardTasksConfigs]]
+* '''TaskTypePKReference''': Foreign key to [[ MCPServer#StandardTasksConfigs | StandardTasksConfigs]]
 Run the command once for each file associated with that Unit (SIP, DIP, Transfer).  Files can be filtered using filterFileEnd, filterFileStart (works on the basename of the file) or filterSubDir (selects only files in those directories)
@@ Line 45: / Line 45: @@
 * '''Description in TaskTypes''': get user choice to proceed with
 * '''LinkTaskMananger''': linkTaskManagerChoice
-* '''TaskTypePKReference''': Foreign key to [[ MCP#MicroServiceChainChoice | MicroServiceChainChoice]]
+* '''TaskTypePKReference''': Foreign key to [[ MCPServer#MicroServiceChainChoice | MicroServiceChainChoice]]
 * '''Use Case''': Run different MicroServiceChains based on user input
 Run a MicroServiceChain, depending on what the user chooses.  Each MicroServiceChainChoice knows where it should be displayed (choiceAvailableAtLink), and what chain to run if it is selected (chainAvailable).  The text to display comes from MicroServiceChains.description, as does the MicroServiceChainLink to run (MicroServiceChains.startingLink)
@@ Line 53: / Line 53: @@
 * '''Description in TaskTypes''': get replacement dic from user choice
 * '''LinkTaskMananger''': linkTaskManagerReplacementDicFromChoice
-* '''TaskTypePKReference''': Foreign key to [[ MCP#MicroServiceChoiceReplacementDic | MicroServiceChoiceReplacementDic]]
+* '''TaskTypePKReference''': Foreign key to [[ MCPServer#MicroServiceChoiceReplacementDic | MicroServiceChoiceReplacementDic]]
 * '''Use Case''': Run the same MicroServiceChainLinks in all cases, but with slightly different behavior based on user input, and you know all the options ahead of time.  Adds the user choice as a replacement variable.
 Adds a new replacement dict and value for the rest of the chain.  Future commands can use replacement %FOO% in their StandardTaskConfigs.arguments, and it will be replaced by the user's choice.  Each MicroServiceChoiceReplacementDic knows where it should be displayed (choiceAvailableAtLink), what text to display (description) and what replacement variables to add (replacementDic).
@@ Line 63: / Line 63: @@
 * '''Description in TaskTypes''': Get microservice generated list in stdOut
 * '''LinkTaskMananger''': linkTaskManagerGetMicroserviceGeneratedListInStdOut
-* '''TaskTypePKReference''': Foreign key to [[ MCP#StandardTasksConfigs | StandardTasksConfigs]]
+* '''TaskTypePKReference''': Foreign key to [[ MCPServer#StandardTasksConfigs | StandardTasksConfigs]]
 * '''Use Case''': Run the same MicroServiceChainLinks in all cases, but with slightly different behavior based on user input, and you need to get the options at run time.  Requires [[#Get User Choice - select from MicroService Generated List]]
 Takes the output (stdout) of the command run, evaluates it into a single python object, and adds it to the chain's passVar as a choicesDic.  The output is almost always a dict of {'choice to display':'value for replacement dict'}.
@@ Line 71: / Line 71: @@
 * '''Description in TaskTypes''': Get user choice from microservice generated list
 * '''LinkTaskMananger''': linkTaskManagerGetUserChoiceFromMicroserviceGeneratedList
-* '''TaskTypePKReference''': Foreign key to [[ MCP#StandardTasksConfigs | StandardTasksConfigs]]
+* '''TaskTypePKReference''': Foreign key to [[ MCPServer#StandardTasksConfigs | StandardTasksConfigs]]
 * '''Use Case''': Run the same MicroServiceChainLinks in all cases, but with slightly different behavior based on user input, and you need to get the options at run time.   Adds the user choice as a replacement variable.  Requires [[#Get User Choice - select from MicroService Generated List]]
 Looks for a choicesDic in the passVar, and displays the choices to the user.  Values to display are the choicesDic keys, and the choicesDic value is put in a replacement variable specified in StandardTasksConfig.execute.
@@ Line 83: / Line 83: @@
 * '''Description in TaskTypes''': linkTaskManagerSetUnitVariable
 * '''LinkTaskMananger''': linkTaskManagerSetUnitVariable
-* '''TaskTypePKReference''': Foreign key to [[ MCP#TasksConfigsSetUnitVariable | TasksConfigsSetUnitVariable]]
+* '''TaskTypePKReference''': Foreign key to [[ MCPServer#TasksConfigsSetUnitVariable | TasksConfigsSetUnitVariable]]
 For SIPs and Transfers only.  Inserts an entry into '''UnitVariables''' with a foreign key back to the SIP or Transfer, and values 'variable', 'variableValue' and 'microServiceChainLink' from '''TasksConfigsSetUnitVariable'''.  Unit variables can be accessed by any microservice and used as a permanent store associated with a unit.  The '''UnitVariables.microServiceChainLink''' is usually used by [[ #Get Unit Variable MicroServiceChainLink | get unit variable]] to determine which MicroServiceChainLink to run next.
@@ Line 90: / Line 90: @@
 * '''Description in TaskTypes''': linkTaskManagerUnitVariableLinkPull
 * '''LinkTaskMananger''': linkTaskManagerUnitVariableLinkPull
-* '''TaskTypePKReference''': Foreign key to [[ MCP#TasksConfigsUnitVariableLinkPull | TasksConfigsUnitVariableLinkPull]]
+* '''TaskTypePKReference''': Foreign key to [[ MCPServer#TasksConfigsUnitVariableLinkPull | TasksConfigsUnitVariableLinkPull]]
 For SIPs and Transfers only.  Looks in the '''UnitVariables''' table for variable with the correct name associated with the unit.  If one is found, go to the microServiceChainLink specified, otherwise go to the defaultMicroServiceChainLink.
@@ Line 99: / Line 99: @@
 * '''Description in TaskTypes''': Split creating Jobs for each file
 * '''LinkTaskMananger''': linkTaskManagerSplit
-* '''TaskTypePKReference''': Foreign key to [[ MCP#TasksConfigsStartLinkForEachFile | TasksConfigsStartLinkForEachFile]]
+* '''TaskTypePKReference''': Foreign key to [[ MCPServer#TasksConfigsStartLinkForEachFile | TasksConfigsStartLinkForEachFile]]
 Part of the pre-FPR way of handling transcoding. Removed - documentation kept for historical reasons.
@@ Line 106: / Line 106: @@
 * '''Description in TaskTypes''': Split Job into many links based on file ID
 * '''LinkTaskMananger''': linkTaskManagerSplitOnFileIdAndruleset
-* '''TaskTypePKReference''': Foreign key to [[ MCP#StandardTasksConfigs | StandardTasksConfigs]]
+* '''TaskTypePKReference''': Foreign key to [[ MCPServer#StandardTasksConfigs | StandardTasksConfigs]]
 Part of the pre-FPR way of handling transcoding. Removed - documentation kept for historical reasons.
@@ Line 113: / Line 113: @@
 * '''Description in TaskTypes''': Transcoder task type
 * '''LinkTaskMananger''': linkTaskManagerTranscoderCommand
-* '''TaskTypePKReference''': Foreign key to [[ MCP#CommandRelationships | CommandRelationships]]
+* '''TaskTypePKReference''': Foreign key to [[ MCPServer#CommandRelationships | CommandRelationships]]
 Part of the pre-FPR way of handling transcoding. Removed - documentation kept for historical reasons.
@@ Line 122: / Line 122: @@
 * '''Description in TaskTypes''': assign magic link
 * '''LinkTaskMananger''': linkTaskManagerAssignMagicLink
-* '''TaskTypePKReference''': Foreign key to [[ MCP#TasksConfigsAssignMagicLink | TasksConfigsAssignMagicLink]]
+* '''TaskTypePKReference''': Foreign key to [[ MCPServer#TasksConfigsAssignMagicLink | TasksConfigsAssignMagicLink]]
 For SIPs and Transfers only.  Sets the SIPs.magicLink or Transfers.magicLink to TasksConfigsAssignMagicLink.execute, and magicLinkExitMessage to the default value of "Completed successfully".  Next time Get Magic Link is called, it will go to that MicroServiceChainLink.

@@ Line 30: / Line 30: @@
 * '''LinkTaskMananger''': linkTaskManagerDirectories
 * '''TaskTypePKReference''': Foreign key to [[ MCP#StandardTasksConfigs | StandardTasksConfigs]]
-Run the command listed in StandardTasksConfigs exactly once.  TODO filterSubDir?  [[MCP/TaskTypes/one_instance | Old Notes]]
+Run the command listed in StandardTasksConfigs exactly once.  TODO filterSubDir?
 === Run for each file ===
@@ Line 37: / Line 37: @@
 * '''LinkTaskMananger''': linkTaskManagerFiles
 * '''TaskTypePKReference''': Foreign key to [[ MCP#StandardTasksConfigs | StandardTasksConfigs]]
-Run the command once for each file associated with that Unit (SIP, DIP, Transfer).  Files can be filtered using filterFileEnd, filterFileStart (works on the basename of the file) or filterSubDir (selects only files in those directories)  [[MCP/TaskTypes/for_each_file | Old Notes]]
+Run the command once for each file associated with that Unit (SIP, DIP, Transfer).  Files can be filtered using filterFileEnd, filterFileStart (works on the basename of the file) or filterSubDir (selects only files in those directories)
 == User Choice ==

@@ Line 109: / Line 109: @@
 Part of the pre-FPR way of handling transcoding. Removed - documentation kept for historical reasons.
-=== Transcode ===
+=== Transcode - Removed ===
 * '''UUID''': 5e70152a-9c5b-4c17-b823-c9298c546eeb
 * '''Description in TaskTypes''': Transcoder task type

@@ Line 57: / Line 57: @@
 Adds a new replacement dict and value for the rest of the chain.  Future commands can use replacement %FOO% in their StandardTaskConfigs.arguments, and it will be replaced by the user's choice.  Each MicroServiceChoiceReplacementDic knows where it should be displayed (choiceAvailableAtLink), what text to display (description) and what replacement variables to add (replacementDic).
-'''WARNING''': The replacement variables will disappear when a new MicroServiceChain is started, because the Unit is recreated.
+''NOTE'': The replacement variables no longer disappear when a new MicroServiceChain is started.
 === Generate User Choice in MicroService ===
@@ Line 75: / Line 75: @@
 Looks for a choicesDic in the passVar, and displays the choices to the user.  Values to display are the choicesDic keys, and the choicesDic value is put in a replacement variable specified in StandardTasksConfig.execute.
-'''WARNING''': The replacement variables will disappear when a new MicroServiceChain is started, because the Unit is recreated.
+''NOTE'': The replacement variables no longer disappear when a new MicroServiceChain is started, because the Unit is recreated.
 == Unit Variables ==
@@ Line 93: / Line 93: @@
 For SIPs and Transfers only.  Looks in the '''UnitVariables''' table for variable with the correct name associated with the unit.  If one is found, go to the microServiceChainLink specified, otherwise go to the defaultMicroServiceChainLink.
-== Transcoding ==
+== Transcoding - Removed==
-=== Split based on File? ===
+=== Split based on File - Removed ===
 * '''UUID''': 75cf8446-1cb0-474c-8245-75850d328e91
 * '''Description in TaskTypes''': Split creating Jobs for each file
 * '''LinkTaskMananger''': linkTaskManagerSplit
 * '''TaskTypePKReference''': Foreign key to [[ MCP#TasksConfigsStartLinkForEachFile | TasksConfigsStartLinkForEachFile]]
-In progress...
+Part of the pre-FPR way of handling transcoding. Removed - documentation kept for historical reasons.
-=== Split based on File and Ruleset? ===
+=== Split based on File and Ruleset - Removed ===
 * '''UUID''': 405b061b-361e-4e75-be27-834a1bc25f5c
 * '''Description in TaskTypes''': Split Job into many links based on file ID
 * '''LinkTaskMananger''': linkTaskManagerSplitOnFileIdAndruleset
 * '''TaskTypePKReference''': Foreign key to [[ MCP#StandardTasksConfigs | StandardTasksConfigs]]
-In progress...
+Part of the pre-FPR way of handling transcoding. Removed - documentation kept for historical reasons.
 === Transcode ===
@@ Line 114: / Line 114: @@
 * '''LinkTaskMananger''': linkTaskManagerTranscoderCommand
 * '''TaskTypePKReference''': Foreign key to [[ MCP#CommandRelationships | CommandRelationships]]
-In progress...
+Part of the pre-FPR way of handling transcoding. Removed - documentation kept for historical reasons.
 == Magic Links - Deprecated ==

@@ Line 40: / Line 40: @@
 == User Choice ==
-[[MCP/TaskTypes/processing_choices | Old Notes]]
 === Get User Choice - select chain ===
 * '''UUID''': 61fb3874-8ef6-49d3-8a2d-3cb66e86a30c
@@ Line 78: / Line 78: @@
 == Unit Variables ==
-[[MCP/TaskTypes/unit_variables | Old Notes]]
 === Set Unit Variable ===
 * '''UUID''': 6f0b612c-867f-4dfd-8e43-5b35b7f882d7
@@ Line 94: / Line 94: @@
 == Transcoding ==
-[[MCP/TaskTypes/Normalization | Old Notes]]
 === Split based on File? ===
 * '''UUID''': 75cf8446-1cb0-474c-8245-75850d328e91
@@ Line 117: / Line 117: @@
 == Magic Links - Deprecated ==
-Replaced by Unit Variables.  [[MCP/TaskTypes/magic_links | Old Notes]]
 === Set Magic Link - Deprecated ===
 * '''UUID''': 3590f73d-5eb0-44a0-91a6-5b2db6655889

@@ Line 123: / Line 123: @@
 * '''LinkTaskMananger''': linkTaskManagerAssignMagicLink
 * '''TaskTypePKReference''': Foreign key to [[ MCP#TasksConfigsAssignMagicLink | TasksConfigsAssignMagicLink]]
-In progress...
+For SIPs and Transfers only.  Sets the SIPs.magicLink or Transfers.magicLink to TasksConfigsAssignMagicLink.execute, and magicLinkExitMessage to the default value of "Completed successfully".  Next time Get Magic Link is called, it will go to that MicroServiceChainLink.
 === Get Magic Link - Deprecated ===
@@ Line 130: / Line 130: @@
 * '''LinkTaskMananger''': linkTaskManagerLoadMagicLink
 * '''TaskTypePKReference''': NULL
-In progress...
+For SIPs and Transfers only, looks at magicLink and magicLinkExitMessage in the SIPs or Transfers table, and goes to that link.
 [[Category:Development documentation]]