IFMETransformationRequest Members
Public Instance Properties
Public Instance Methods
| GetFMEDirective |
Gets the value assigned to a FME Server directive.
|
| GetFMEDirectives |
Gets all directives that have been set for this transformation.
|
| GetNMDirective |
Gets the value assigned to a Notification Manager directive.
|
| GetNMDirectives |
Gets all Notification Manager directives that have been set.
|
| GetPublishedParameter |
Gets the value assigned to a parameter.
|
| GetPublishedParameters |
Gets all parameters that have been set for this transformation.
|
| GetTMDirective |
Gets the value assigned to a Transformation Manager directive. Since object types
vary according to the directive name, it is the caller's responsibility
to cast the object returned by this method to the appropriate type.
|
| GetTMDirectives |
Gets all Transformation Manager directives that have been set.
|
| SetFMEDirective |
Sets the value assigned to a FME Server directive. A full list of
directives understood by the FME Server is available elsewhere in the
FME Server documentation.
|
| SetFMEDirectives | |
| SetNMDirective |
Sets the value assigned to a Notification Manager directive.
Reserved NM directive names:
"jobsuccess_topic" - The name of the topic to be notified when a job succeeds.
"jobfailure_topic" - The name of the topic to be notified when a job fails.
Examples:
The following example will send a single notification when a job succeeds or fails.
A notification will be sent to the JOB_SUCCESS topic if the transformation
succeeds and a notification will be sent to the JOB_FAILURE topic if the transformation fails.
In addition the notification body will contain both "info" and "test" directives.
- SetNMDirective("jobsuccess_topic", "JOB_SUCCESS");
- SetNMDirective("jobfailure_topic", "JOB_FAILURE");
- SetNMDirective("info", "Misc notification info ...");
- SetNMDirective("test", "Misc test info ...");
The following example will send multiple notifications when a job succeeds or fails.
A notification will be sent to the JOB_SUCCESS, JOB_SUCCESS_SINK and SUCCESS_BATCH topics
if the transformation succeeds and a notification will be sent to the JOB_FAILURE and
FAILURE_HANDLER topics if the transformation fails. In addition the notification body
will contain both "info" and "test" directives.
- SetNMDirective("jobsuccess_topic{0}", "JOB_SUCCESS");
- SetNMDirective("jobsuccess_topic{1}", "JOB_SUCCESS_SINK");
- SetNMDirective("jobsuccess_topic{2}", "SUCCESS_BATCH");
- SetNMDirective("jobfailure_topic{0}", "JOB_FAILURE");
- SetNMDirective("jobfailure_topic{1}", "FAILURE_HANDLER");
- SetNMDirective("info", "Misc notification info ...");
- SetNMDirective("test", "Misc test info ...");
|
| SetNMDirectives | |
| SetPublishedParameter |
Sets the value assigned to a parameter. The interpretation of these
parameters depends on whether a workspace (.fmw) or mapping file (.fme)
is used. In a workspace, parameters correspond to published
parameters; in a mapping file, parameters correspond to macro
definitions.
|
| SetPublishedParameters | |
| SetTMDirective |
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.
|
| SetTMDirectives | |
| ToString |
Creates and returns a string representing this transformation request.
This string is used by the FME Server when communicating the request to
the FME Server. It cannot be modified directly; instead, its contents
can be changed using the other methods of this class.
|
See Also
IFMETransformationRequest Interface | Safe.FMEServer.API Namespace