TaskExecutionContext ClassTIBCO Spotfire Automation Services 7.11 API Reference
Context class for Automation Services Task Executors, providing access to the AnalysisApplication, tag expansion and other runtime services.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Automation.ExtensionTaskExecutionContext

Namespace: Spotfire.Dxp.Automation.Extension
Assembly: Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll) Version: 30.0.11525.4184 (30.0.11525.4184)
Syntax

C#
public abstract class TaskExecutionContext

The TaskExecutionContext type exposes the following members.

Methods

  NameDescription
Public methodCreateLibraryLink
Creates an URL link to the library (e.g. http://server/spotfire/library?guid=ec878f68-af67-4d2e-a014-a5d879ad5d03).
Public methodCreateWebPlayerLibraryLink
Creates a link to a TIBCO Spotfire Web Player file for a given library file. This requires the link to the Web Client server to be set in TIBCO Spotfire Administration manager.
Public methodDeleteLibraryFile
Delete the file from the library.
Public methodExpandTags
Handles all the tags in a string and returns a string where the tags have been replaced with their values.
Public methodGetAnalyticsServerUri
Returns the uri of the Spotfire Server using the ConnectivityService service
Public methodGetPreference
Returns the string value for a given named preference.
Public methodLibraryPathToId
Finds the id of the Library analysis entry with the given path.
Public methodStatic memberValidateDeleteFileInPath
This function will validate if the job is allowed to delete a file at the given path.

The same validation as in ValidateLoadAndSavePath(String) is done.

Enabling this validation and exception paths are configured using the section:

Spotfire.Dxp.Automation.Framework/security/ in Spotfire.Dxp.Worker.Automation.config.

This function will also check that the given file exist, that it is created and modified the last N minutes.

Where N is configured in the above section in allowDeleteOfFilesModifiedLastMinutes.

When executing jobs locally in Job Builder, this function will always succeed.
Public methodStatic memberValidateLoadAndSavePath
This function will validate if the job is allowed to load a file from or save a file to the given path.

Enabling this validation and exception paths are configured using the section:

Spotfire.Dxp.Automation.Framework/security/ in Spotfire.Dxp.Worker.Automation.config.

When executing jobs locally in Job Builder, this function will always succeed.

Top
Properties

  NameDescription
Public propertyApplication
Gets the Analysis Application.
Public propertyId
Gets the unique id of the current job execution.
Top
Version Information

Supported in: 7.9, 7.8, 7.7, 7.6, 7.5, 7.11, 7.10, 7.0
See Also

Reference