FME Server .NET API

IFMETransformationRequest.SetTMDirective Method 

Sets the value assigned to a Transformation Manager (TM) Server directive. For example: - setTMDirective("priority", 5); - setTMDirective("description", "This is my description"); - setTMDirective("tag", "linux"); - setTMDirective("ttl", 120); Supported TM directive names: "priority" - The request priority. Priority values must be integers >= 0 with higher values meaning higher priority. Requests with higher priority are inserted into the request queue ahead of requests with lower priority. There is no logical restriction on the maximum value. If a request’s priority value is greater than 0 or is not specified, the FME Server sets it to 1. In general, the order of request jobs in the queue is defined according to the following rules: 1. Jobs of higher priority are placed in the queue ahead of jobs of lower priority. 2. Jobs of equal priority are placed in the queue in the order in which they were submitted to the FME Server. "description" - The request description. "tag" - This is the dynamic request assignment (DRA) tag for the request. "ttl" - This is the "time to live" in the job queue in seconds. This is useful in cases where jobs are time-sensitive and could become invalid or stale while waiting in the job queue.

It is the caller's responsibility to ensure that the correct object type is used for each TM directive. Valid object types differ according to the directive name.

TM directives affect the operation of the Transformation Manager itself. Unlike published parameters and FME directives, they do not directly control the data processing that occurs during the transformation.

[Visual Basic]
Sub SetTMDirective( _
   ByVal directiveName As String, _
   ByVal directiveValue As Object _
)
[C#]
void SetTMDirective(
   string directiveName,
   object directiveValue
);

Parameters

directiveName
the name of a TM directive that is recognized by the Transformation Manager.
directiveValue
a valid value for that directive

See Also

IFMETransformationRequest Interface | IFMETransformationRequest Members | Safe.FMEServer.API Namespace