Class FMESession

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:

• directives (dict) - Specify one or more additional directives to the session. All objects in the dict must be strings. Applicable directives can be found in the FME Configuration section of the 'FME Fundamentals' documentation.

Raises:

• FMEException - An exception is raised if an error occurred

Overrides: object.__init__

Returns: a new object with type S, a subtype of T

Overrides: object.__new__

Passes the configuration information to the session. One use of this function is to define configuration lines for functions.

Parameters:

• configRow (list of string) - The configuration information.

Returns: None

Raises:

• FMEException - An exception is raised if an error occurred.

This method performs a modification of the unicode string from parsable FME encoded text back to a non-encoded form. For example, <semicolon>' will be replaced with ';'. If the decoding fails for a particular character sequence, the resulting output will retain that character sequence.

Parameters:

• parsableText (string or unicode) - FME encoded text as a string or unicode.

Returns: unicode

Non-encoded text as unicode.

This method performs a modification of the unicode string to parsable FME encoded text. For example, ';' will be replaced with the character sequence '<semicolon>'. If the encoding fails for a particular character sequence, the resulting output will retain that character sequence.

Parameters:

• inputText (unicode) - Non-encoded text.

Returns: unicode

FME encoded text.

Returns directory FME was installed into.

Returns: string

The home directory of FME.

Returns a list of all property values.

Returns: dict

The returned dict will contain a mapping of each property to its value for all properties found.

Raises:

• FMEException - An exception is raised if no properties were found.

Returns the last error message that FME encountered.

Returns: string

The last error message.

Returns the last error number that FME encountered.

Returns: int

The last error number.

This method is used to retrieve a variety of information on a FMESession or use a session to perform certain operations. The operation performed is determined by a combination of the propertyCategory specified and the propertyConfig information passed in.

Parameters:

• propertyCategory (string) - The property to retrieve or action to perform.
• properties (dict or list of strings) - Additional information to specify what to retrieve or action to perform.

Returns: list of strings

The properties requested. This value is empty in cases where actions are performed.

Raises:

• FMEException - An exception is raised if there was a problem in performing the specified getProperties operation.

Retrieves the schema features defined in the DEF lines that are prefixed with 'prefix' in the 'schemaFile'.

Parameters:

• macros (list of strings or dict) - Name-value pairs that define values for each macro used in the 'schemaFile'.
• prefix (string) - Prefix used to retrieve schema features.
• schemaFile (string) - The file name of the file containing the schema features.

Returns: list of FMEFeature

Raises:

• FMEException - An exception is raised if there was a problem retrieving the schema features.

Returns the values of the keyword for the session configuration. The list of strings returned will be empty if the keyword is invalid or does not exist in the current session.

Parameters:

• keyword (string) - The keyword for the session configuration.

Returns: list of strings

A list of strings containing the settings, or an empty list if the keyword is invalid or does not exist.

Raises:

• FMEException - An exception is raised if an error occurred.

Dumps the current session configuration to the logfile. No action will be performed if the keyword is unrecognized.

Parameters:

• keyword (string) - The keyword for the session configuration.

Returns: None

Adds a new keyword and value to the session configuration.

Parameters:

• keyword (string) - The new keyword to add to the configuration.
• value (string) - The value of the keyword to add to the configuration.

Returns: None

Raises:

• FMEException - An exception is raised if there was a problem in adding the new keyword and value.