Spotfire Automation Services

https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/
Admin
Spotfire Automation Services is an API platform for creating custom automation tasks and extensions...
Tokens:34,450
Snippets:261
Trust Score:9.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### TaskExecutionContext.Application Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Extension_TaskExecutionContext_Application.htm

Gets the Analysis Application.

```APIDOC
## TaskExecutionContext.Application Property

### Description
Gets the Analysis Application.

### Syntax
```csharp
public AnalysisApplication Application { get; }
```

### Property Value
Type: AnalysisApplication

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Initialize TaskExecutionStatus

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Framework_TaskExecutionStatus__ctor.htm

Use the default constructor to create a new instance of the TaskExecutionStatus class. No specific setup is required beyond having access to the Spotfire.Dxp.Automation.Framework namespace.

```csharp
public TaskExecutionStatus()
```

--------------------------------

### Job.Tasks Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_Job_Tasks.htm

Gets the list of tasks to execute in order.

```APIDOC
## Job.Tasks Property

### Description
Gets the list of tasks to execute in order.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public Collection<Task> Tasks { get; }
```

### Property Value
Type: Collection<Task>

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### TaskRegistry.Tasks Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_TaskRegistry_Tasks.htm

Gets all task instances in the registry.

```APIDOC
## TaskRegistry.Tasks Property

### Description
Gets all task instances in the registry.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public IList<Task> Tasks { get; }
```

### Property Value
Type: IList<Task>

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### BaseTasksControl.EditingContext Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_BaseTasksControl_EditingContext.htm

Gets the editing context to retrieve for example the Spotfire AnalysisApplication instance.

```APIDOC
## BaseTasksControl.EditingContext Property

### Description
Gets the editing context to retrieve for example the Spotfire AnalysisApplication instance.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public TaskEditingContext EditingContext { get; }
```

### Property Value
**Type:** TaskEditingContext

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### TaskEditingContext.Application Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_TaskEditingContext_Application.htm

Gets the Spotfire Analysis Application. This property is part of the Spotfire.Dxp.Automation.Framework namespace and is available in multiple versions of Spotfire.

```APIDOC
## TaskEditingContext.Application Property

### Description
Gets the Spotfire Analysis Application.

### Method
GET

### Endpoint
N/A (This is a property access, not a REST endpoint)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **Application** (AnalysisApplication) - The Spotfire Analysis Application object.

### Response Example
```json
{
  "Application": { ... AnalysisApplication object details ... }
}
```

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### TaskExecutionStatus.Ok Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_TaskExecutionStatus_Ok.htm

Gets or sets a value indicating whether the task executed successfully.

```APIDOC
## TaskExecutionStatus.Ok Property

### Description
Gets or sets a value indicating whether the task executed successfully.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public bool Ok { get; set; }
```

### Property Value
Type: Boolean

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### ErrorDialogBase.HelpKeyword Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Utilities_ErrorDialogBase_HelpKeyword.htm

This property is obsolete and should not be used. It was designed to get or set a help keyword for error dialogs.

```APIDOC
## ErrorDialogBase.HelpKeyword Property

### Description
Gets or sets the help keyword. This property is marked as obsolete and should not be used in new development.

### Namespace
Spotfire.Dxp.Automation.Utilities

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
[ObsoleteAttribute("Class obsolete, use message box or custom dialog instead.")]
public string HelpKeyword { get; set; }
```

### Property Value
Type: String
Description: The help keyword.

### Version Information
Obsolete (compiler warning) in versions 14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8.

### See Also
- ErrorDialogBase Class
- Spotfire.Dxp.Automation.Utilities Namespace
```

--------------------------------

### BaseTasksControl.AddEventsCore Method

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Framework_BaseTasksControl_AddEventsCore.htm

Allows overriding to add events after the context has been installed. This method is part of the Spotfire.Dxp.Automation.Framework namespace.

```APIDOC
## BaseTasksControl.AddEventsCore Method

### Description
Override to add events after the context has been installed.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
protected virtual void AddEventsCore()
```

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### ShowDialog with FormStartPosition, Title, Message, Exception, and MessageBoxIcon

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/T_Spotfire_Dxp_Automation_Utilities_ErrorDialog.htm

Obsolete method to display an error dialog with specified form start position, title, message, exception, and message box icon. Help settings are read from the exception.

```csharp
ShowDialog(FormStartPosition startPosition, String title, String message, Exception ex, MessageBoxIcon icon)
```

--------------------------------

### ShowDialog with Title, Message, Exception, and FormStartPosition

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/T_Spotfire_Dxp_Automation_Utilities_ErrorDialog.htm

Obsolete method to display an error dialog with a specified title, message, exception, and form start position. Help settings are read from the exception.

```csharp
ShowDialog(String title, String message, Exception ex, FormStartPosition startPosition)
```

--------------------------------

### TaskEditingContext.ShowGUIDs Property (Obsolete)

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_TaskEditingContext_ShowGUIDs.htm

This property is obsolete and should not be used. It previously indicated whether the 'show GUIDs' setting was enabled in the job editor dialog. Use the ShowGuidFields property instead.

```APIDOC
## TaskEditingContext.ShowGUIDs Property

### Description
Gets or sets a value indicating whether the setting for "show GUIDs" in the job editor dialog. When true, task editor fields should show raw GUIDs for tables, columns etc and make then editable. When false, task editor fields should show nice display names readonly. When this value changes, the task editor is reloaded, so you can depend on this value not to change while your editor control is alive.

**Note:** This API is now obsolete. Use property ShowGuidFields instead.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
[ObsoleteAttribute("Use property ShowGuidFields instead.")]
public bool ShowGUIDs { get; set; }
```

### Property Value
Type: Boolean

### Version Information
Obsolete (compiler warning) in 14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8.
```

--------------------------------

### Get or Set ShowGuidFields Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_TaskEditingContext_ShowGuidFields.htm

Use this property to control whether task editor fields display raw GUIDs or display names. When true, GUIDs are shown and editable; when false, display names are shown as read-only. The task editor reloads when this value changes.

```csharp
public bool ShowGuidFields { get; set; }
```

--------------------------------

### Initialize UnknownTask - C#

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Framework_UnknownTask__ctor.htm

Initializes a new instance of the UnknownTask class. This constructor is part of the Spotfire.Dxp.Automation.Framework namespace.

```csharp
public UnknownTask()
```

--------------------------------

### Create Web Player Library Link

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Extension_TaskExecutionContext_CreateWebPlayerLibraryLink.htm

Use this method to generate a URL for a library file that can be opened in the Spotfire Web Player. Ensure the Web Client server URL is configured in Spotfire Administration.

```csharp
public abstract string CreateWebPlayerLibraryLink(
	AnalysisApplication application,
	string path,
	string name
)
```

--------------------------------

### TaskEditingContext.ShowGuidFields Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_TaskEditingContext_ShowGuidFields.htm

Gets or sets a value indicating whether the setting for "show GUIDs" in the job editor dialog. When true, task editor fields should show raw GUIDs for tables, columns etc and make then editable. When false, task editor fields should show nice display names readonly. When this value changes, the task editor is reloaded, so you can depend on this value not to change while your editor control is alive.

```APIDOC
## TaskEditingContext.ShowGuidFields Property

### Description
Gets or sets a value indicating whether the setting for "show GUIDs" in the job editor dialog. When true, task editor fields should show raw GUIDs for tables, columns etc and make then editable. When false, task editor fields should show nice display names readonly. When this value changes, the task editor is reloaded, so you can depend on this value not to change while your editor control is alive.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public bool ShowGuidFields { get; set; }
```

### Property Value
Type: Boolean

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Get or Set Original Namespace

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_UnknownTask_OriginalNamespace.htm

Use this property to get or set the namespace in the original XML. It must not be changed before reserializing.

```csharp
public string OriginalNamespace { get; set; }
```

--------------------------------

### TaskExecutionStatus Constructor (Boolean, String)

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Framework_TaskExecutionStatus__ctor_2.htm

Initializes a new instance of the TaskExecutionStatus class. Creates an instance with status flag and error message.

```APIDOC
## TaskExecutionStatus Constructor (Boolean, String)

### Description
Initializes a new instance of the TaskExecutionStatus class. Creates an instance with status flag and error message.

### Syntax
```csharp
public TaskExecutionStatus(
	bool ok,
	string errorMessage
)
```

### Parameters
#### Path Parameters
This method does not have path parameters.

#### Query Parameters
This method does not have query parameters.

#### Request Body
This method does not have a request body.

### Parameters
- **ok** (System.Boolean) - Required - The execution result.
- **errorMessage** (System.String) - Required - The error message.

### Response
#### Success Response (200)
This method does not return a value directly. It initializes an object of type TaskExecutionStatus.

#### Response Example
```json
{
  "message": "TaskExecutionStatus object initialized successfully"
}
```

### Version Information
Supported in: 14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Initialize RegisterTasksAddIn

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Extension_RegisterTasksAddIn__ctor.htm

Initializes a new instance of the RegisterTasksAddIn class. This constructor is protected and intended for internal use within the Spotfire framework.

```csharp
protected RegisterTasksAddIn()
```

--------------------------------

### Get or Set Original Element Name

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_UnknownTask_OriginalElementName.htm

Use this property to get or set the element name in the original XML. It must not be changed before reserializing.

```csharp
public string OriginalElementName { get; set; }
```

--------------------------------

### Task.Description Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Extension_Task_Description.htm

Gets the task description as provided by the subclass constructor. The task description is not serialized. It is only used when presenting information about the available tasks, in which case the task is registered with the task registry.

```APIDOC
## Task.Description Property

### Description
Gets the task description as provided by the subclass constructor. The task description is not serialized. It is only used when presenting information about the available tasks, in which case the task is registered with the task registry.

### Namespace
Spotfire.Dxp.Automation.Extension

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public string Description { get; }
```

### Property Value
Type: String

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Spotfire.Dxp.Automation.Framework Namespace Overview

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/N_Spotfire_Dxp_Automation_Framework.htm

This namespace contains helper classes for registering and executing jobs within Spotfire Automation Services.

```APIDOC
## Spotfire.Dxp.Automation.Framework Namespace

This namespace contains helper classes for registering and executing jobs.

### Classes

*   **BaseTasksControl**: Base class for Tasks Controls.
*   **Job**: The Job class that holds a list of tasks.
*   **TaskBase**: Base class to use for all our built-in tasks.
*   **TaskEditingContext**: Context class for Task editor views, providing access to the AnalysisApplication, tags and some other state.
*   **TaskExecutionStatus**: Class holding the return status from an task execution.
*   **TaskRegistry**: The registry for Automation Services tasks.
*   **UnknownTask**: This class is used to represent an task which could not be found in the tasks registry. The serialize and deserialize methods in Job uses extra code to make sure that all data is kept (non-destructive).
```

--------------------------------

### CreateWebPlayerLibraryLink

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Extension_TaskExecutionContext_CreateWebPlayerLibraryLink.htm

Creates a link to a Spotfire Web Player file for a given library file. This requires the link to the Web Client server to be set in Spotfire Administration manager.

```APIDOC
## CreateWebPlayerLibraryLink

### Description
Creates a link to a Spotfire Web Player file for a given library file. This requires the link to the Web Client server to be set in Spotfire Administration manager.

### Method
POST (Assumed, as it creates a resource/link)

### Endpoint
/websites/tibco_pub_doc_remote_sfire_dev_area_doc_api_tib_sfire_autsvcs/TaskExecutionContext/CreateWebPlayerLibraryLink

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **application** (AnalysisApplication) - Required - The started AnalysisApplication.
- **path** (String) - Required - The absolute path to the library folder (or section) where the file is. Expected format: "section/[folder/../folder>/]".
- **name** (String) - Required - The name of the library file to open (no extension).

### Request Example
```json
{
  "application": "<AnalysisApplication_Object>",
  "path": "section/MyReports/Sales",
  "name": "QuarterlyReport"
}
```

### Response
#### Success Response (200)
- **Url** (String) - The generated URL to the Web Player library file.

#### Response Example
```json
{
  "Url": "http://your-web-player-server/SpotfireWeb/Analysis.aspx?file=section/MyReports/Sales/QuarterlyReport.sdn"
}
```

### Error Handling
- **ArgumentException** - If web client url not set in preferences.
```

--------------------------------

### TaskExecutionStatus Constructor

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Framework_TaskExecutionStatus__ctor.htm

Initializes a new instance of the TaskExecutionStatus class. This is the default constructor.

```APIDOC
## TaskExecutionStatus Constructor

### Description
Initializes a new instance of the TaskExecutionStatus class. Default constructor.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public TaskExecutionStatus()
```

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### UnknownTask.UnknownTaskAttributes Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_UnknownTask_UnknownTaskAttributes.htm

Gets or sets the attributes of the unregistered task.

```APIDOC
## UnknownTask.UnknownTaskAttributes Property

### Description
Gets or sets the attributes of the unregistered task.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public XmlAttribute[] UnknownTaskAttributes { get; set; }
```

### Property Value
Type: XmlAttribute[]

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### TaskBase Class Overview

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/T_Spotfire_Dxp_Automation_Framework_TaskBase.htm

Provides an overview of the TaskBase class, its namespace, assembly, and inheritance.

```APIDOC
## TaskBase Class

### Description
Base class to use for all built-in tasks in Spotfire Automation Services.

### Inheritance Hierarchy
* System.Object
* Spotfire.Dxp.Automation.Extension.Task
* Spotfire.Dxp.Automation.Framework.TaskBase

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Version
70.0.21819.5008

### Syntax
```csharp
public abstract class TaskBase : Task
```

### Constructors
#### TaskBase
Initializes a new instance of the TaskBase class. As opposed to the sample code version of this file: does not prefix all titles and descriptions.

### Version Information
Supported in: 14.8, 14.7, 14.6, 14.5
```

--------------------------------

### TaskExecutionStatus Constructor (Boolean)

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Framework_TaskExecutionStatus__ctor_1.htm

Initializes a new instance of the TaskExecutionStatus class. Creates an instance with status flag.

```APIDOC
## TaskExecutionStatus Constructor (Boolean)

### Description
Initializes a new instance of the TaskExecutionStatus class. Creates an instance with status flag.

### Syntax
```csharp
public TaskExecutionStatus(
	bool ok
)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

### Parameters
#### ok
- **ok** (System.Boolean) - Required - The execution result.
```

--------------------------------

### TaskExecutionContext.ExecutionLocation Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Extension_TaskExecutionContext_ExecutionLocation.htm

Gets the current jobs execution location.

```APIDOC
## TaskExecutionContext.ExecutionLocation Property

### Description
Gets the current jobs execution location.

### Namespace
Spotfire.Dxp.Automation.Extension

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public TaskExecutionContext.Location ExecutionLocation { get; }
```

### Property Value
Type: TaskExecutionContext.Location

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Initialize Task Constructor

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Extension_Task__ctor.htm

Initializes a new instance of the Task class. Pass the default title and display description to the base class constructor.

```csharp
protected Task(
	string title,
	string description
)
```

--------------------------------

### UnknownTask.UnknownTaskElements Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_UnknownTask_UnknownTaskElements.htm

Gets or sets the keeper elements of the unregistered task.

```APIDOC
## UnknownTask.UnknownTaskElements Property

### Description
Gets or sets the keeper elements of the unregistered task.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public XmlElement[] UnknownTaskElements { get; set; }
```

### Property Value
Type: XmlElement[]

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### TaskExecutionContext.Id Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Extension_TaskExecutionContext_Id.htm

Gets the unique id of the current job execution.

```APIDOC
## TaskExecutionContext.Id Property

### Description
Gets the unique id of the current job execution.

### Namespace
Spotfire.Dxp.Automation.Extension

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public string Id { get; }
```

### Property Value
Type: String

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### ShowDetails Method Signature

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Utilities_ErrorDialogBase_ShowDetails.htm

This is the signature for the obsolete ShowDetails method. Use message boxes or custom dialogs instead.

```csharp
[ObsoleteAttribute("Class obsolete, use message box or custom dialog instead.")]
protected virtual void ShowDetails(
	bool show
)
```

--------------------------------

### ErrorDialogBase.Message Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Utilities_ErrorDialogBase_Message.htm

Gets or sets the message for the ErrorDialogBase. This property is obsolete and should not be used.

```APIDOC
## ErrorDialogBase.Message Property

### Description
Gets or sets the message. This property is obsolete and should be replaced with message box or custom dialog.

### Namespace
Spotfire.Dxp.Automation.Utilities

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
[ObsoleteAttribute("Class obsolete, use message box or custom dialog instead.")]
protected string Message { get; set; }
```

### Property Value
Type: String
The message.

### Version Information
Obsolete (compiler warning) in 14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8.

### See Also
* ErrorDialogBase Class
* Spotfire.Dxp.Automation.Utilities Namespace
```

--------------------------------

### RegisterTasksAddIn Constructor

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Extension_RegisterTasksAddIn__ctor.htm

Initializes a new instance of the RegisterTasksAddIn class. This constructor is part of the Spotfire.Dxp.Automation.Extension namespace and is available in multiple versions of Spotfire Automation Services.

```APIDOC
## RegisterTasksAddIn Constructor

### Description
Initializes a new instance of the RegisterTasksAddIn class.

### Method
protected

### Endpoint
N/A (Constructor)

### Parameters
None

### Request Example
N/A (Constructor)

### Response
N/A (Constructor)

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Task.ExecuteCore Method

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Extension_Task_ExecuteCore.htm

Implement this method to perform the task specific logic. This method is part of the Spotfire.Dxp.Automation.Extension namespace and is found in the Spotfire.Dxp.Automation.Framework.dll assembly.

```APIDOC
## Task.ExecuteCore Method

### Description
Implement this method to perform the task specific logic.

### Namespace
Spotfire.Dxp.Automation.Extension

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
protected abstract TaskExecutionStatus ExecuteCore(
	TaskExecutionContext context
)
```

### Parameters
#### context
- **context** (Spotfire.Dxp.Automation.Extension.TaskExecutionContext) - Required - The execution context.

### Return Value
- **TaskExecutionStatus** - The return status from executing the task.

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### ErrorDialogBase.DetailsException Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Utilities_ErrorDialogBase_DetailsException.htm

This property is now obsolete and should not be used. It was used to get or set the exception details.

```APIDOC
## ErrorDialogBase.DetailsException Property

### Description
Gets or sets the exception.

### Namespace
Spotfire.Dxp.Automation.Utilities

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
[ObsoleteAttribute("Class obsolete, use message box or custom dialog instead.")]
protected Exception DetailsException { get; set; }
```

### Property Value
Type: Exception
The exception.

### Version Information
Obsolete (compiler warning) in 14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8.

### See Also
* ErrorDialogBase Class
* Spotfire.Dxp.Automation.Utilities Namespace
```

--------------------------------

### Task Constructor

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Extension_Task__ctor.htm

Initializes a new instance of the Task class. Pass the default title and display description to the base class constructor.

```APIDOC
## Task Constructor

### Description
Initializes a new instance of the Task class. Pass the default title and display description to the base class constructor.

### Syntax
```csharp
protected Task(
	string title,
	string description
)
```

### Parameters
#### Path Parameters
* **title** (string) - Required - Title used for diagnostic purposes
* **description** (string) - Required - User-displayed description

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### TaskExecutionStatus.ErrorMessage Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_TaskExecutionStatus_ErrorMessage.htm

Gets or sets the message containing information about the error for a task execution.

```APIDOC
## TaskExecutionStatus.ErrorMessage Property

### Description
Gets or sets the message containing information about the error.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public string ErrorMessage { get; set; }
```

### Property Value
Type: String

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### RegisterTasks Method Signature

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Extension_RegisterTasksAddIn_RegisterTasks.htm

Implement this method to register your tasks and their executors. It is called once the framework is up. The registrar helper is provided as a parameter.

```csharp
public abstract void RegisterTasks(
	TaskRegistrar registrar
)
```

--------------------------------

### Get Tooltip Control

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_BaseTasksControl_TooltipControl.htm

Accesses the tooltip control for a user control. This property is read-only.

```C#
protected ToolTip TooltipControl { get; }
```

--------------------------------

### UnknownTask Constructor

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Framework_UnknownTask__ctor.htm

Initializes a new instance of the UnknownTask class. This is a constructor for the UnknownTask class within the Spotfire.Dxp.Automation.Framework namespace.

```APIDOC
## UnknownTask Constructor

### Description
Initializes a new instance of the UnknownTask class.

### Syntax
```csharp
public UnknownTask()
```

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Show Dialog with OK/Cancel Options

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Utilities_ErrorDialog_ShowDialogOkCancel.htm

This method is obsolete and should not be used. It displays a dialog with a title, message, and OK/Cancel buttons. Exception details are used for help settings.

```csharp
[ObsoleteAttribute("Class obsolete, use message box or custom dialog instead.")]
public static DialogResult ShowDialogOkCancel(
	string title,
	string message,
	Exception ex
)
```

--------------------------------

### UnknownTask.OriginalNamespace Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_UnknownTask_OriginalNamespace.htm

Gets or sets the namespace in the original xml. This property must not be changed before reserializing.

```APIDOC
## UnknownTask.OriginalNamespace Property

### Description
Gets or sets the namespace in the original xml. This property must not be changed before reserializing.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Version
70.0.21819.5008

### Syntax
```csharp
public string OriginalNamespace { get; set; }
```

### Property Value
Type: String

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### GetAnalyticsServerUri Method Signature

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Extension_TaskExecutionContext_GetAnalyticsServerUri.htm

This method is obsolete and should not be used. Use ConnectivityService.ServerPublicUri instead. It returns the URI of the Spotfire Server or null if no server connection exists.

```csharp
[ObsoleteAttribute("Use ConnectivityService.ServerPublicUri instead.")]
public Uri GetAnalyticsServerUri()
```

--------------------------------

### UnknownTask.OriginalElementName Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_UnknownTask_OriginalElementName.htm

Gets or sets the element name in the original xml. Must not be changed before reserializing.

```APIDOC
## UnknownTask.OriginalElementName Property

### Description
Gets or sets the element name in the original xml. Must not be changed before reserializing.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public string OriginalElementName { get; set; }
```

### Property Value
Type: String

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### TaskExecutionStatus Constructor (Exception)

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Framework_TaskExecutionStatus__ctor_3.htm

Initializes a new instance of the TaskExecutionStatus class from an exception. This sets the status flag to false and includes exception information in the error message.

```APIDOC
## TaskExecutionStatus Constructor (Exception)

### Description
Initializes a new instance of the TaskExecutionStatus class. Creates an instance from an exception. Sets the status flag to false, includes exception information in the error message.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public TaskExecutionStatus(
	Exception exception
)
```

### Parameters
#### exception
- **exception** (System.Exception) - Required - The exception.

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Get or Set UnknownTaskAttributes

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_UnknownTask_UnknownTaskAttributes.htm

Retrieves or modifies the attributes associated with an unregistered task. This property is of type XmlAttribute[].

```csharp
public XmlAttribute[] UnknownTaskAttributes { get; set; }
```

--------------------------------

### TaskEditingContext.HasChanged Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_TaskEditingContext_HasChanged.htm

Gets a value indicating whether the current job has changed since it was loaded or created.

```APIDOC
## TaskEditingContext.HasChanged Property

### Description
Gets a value indicating whether the current job has changed since it was loaded or created.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public bool HasChanged { get; }
```

### Property Value
Type: Boolean

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Job Class Overview

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/T_Spotfire_Dxp_Automation_Framework_Job.htm

Provides an overview of the Job class, its inheritance, namespace, and assembly information.

```APIDOC
## Job Class

### Description
The Job class holds a list of tasks to execute in order.

### Namespace
Spotfire.Dxp.Automation.Framework

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Inheritance Hierarchy
* System.Object
* Spotfire.Dxp.Automation.Framework.Job
```

--------------------------------

### RegisterTasksAddIn Class Overview

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/T_Spotfire_Dxp_Automation_Extension_RegisterTasksAddIn.htm

Provides an overview of the RegisterTasksAddIn class, its purpose, and inheritance hierarchy.

```APIDOC
## RegisterTasksAddIn Class

### Description
Base AddIn class to subclass for your extension projects.

### Inheritance Hierarchy
* System.Object
* AddIn
* Spotfire.Dxp.Automation.Extension.RegisterTasksAddIn

### Namespace
Spotfire.Dxp.Automation.Extension

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Version Information
Supported in: 14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Get TaskEditingContext.HasChanged Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_TaskEditingContext_HasChanged.htm

Use this property to check if the current job has been modified. It returns a boolean value.

```csharp
public bool HasChanged { get; }
```

--------------------------------

### Get Editing Context

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_BaseTasksControl_EditingContext.htm

Access the editing context to retrieve the Spotfire AnalysisApplication instance. This property is read-only.

```csharp
public TaskEditingContext EditingContext { get; }
```

--------------------------------

### TaskExecutionContext.CreateLibraryLink

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Extension_TaskExecutionContext_CreateLibraryLink.htm

Creates a URL link to a library item in Spotfire. This method is part of the Spotfire.Dxp.Automation.Extension namespace.

```APIDOC
## TaskExecutionContext.CreateLibraryLink

### Description
Creates an URL link to the library (e.g. http://server/spotfire/library?guid=ec878f68-af67-4d2e-a014-a5d879ad5d03).

### Method
This is a method within the TaskExecutionContext class.

### Endpoint
N/A (This is a method call, not a REST endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
// Example usage (assuming 'application' is an AnalysisApplication instance)
string libraryLink = taskExecutionContext.CreateLibraryLink(application, "/MyFolder", "MyAnalysis");
```

### Response
#### Success Response (String)
- **Return Value** (String) - An URL link to the library.

#### Response Example
```
"http://server/spotfire/library?guid=ec878f68-af67-4d2e-a014-a5d879ad5d03"
```

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Task Class Overview

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/T_Spotfire_Dxp_Automation_Extension_Task.htm

Provides an overview of the Task class, including its inheritance hierarchy, namespace, assembly information, and supported versions.

```APIDOC
## Task Class

### Description
Base task class for Spotfire Automation Services.

### Inheritance Hierarchy
* System.Object
* Spotfire.Dxp.Automation.Extension.Task
* Spotfire.Dxp.Automation.Framework.TaskBase
* Spotfire.Dxp.Automation.Framework.UnknownTask

### Namespace
Spotfire.Dxp.Automation.Extension

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Version Information
Supported in: 14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### ErrorDialogBase.GetExceptionString Method

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Utilities_ErrorDialogBase_GetExceptionString.htm

This method is used to get the exception string. It is marked as obsolete and should not be used in new development.

```APIDOC
## ErrorDialogBase.GetExceptionString Method

### Description
Gets the exception string. This method is obsolete and should be replaced with message box or custom dialog usage.

### Method
Protected virtual string GetExceptionString(Exception ex)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **string**: The exception string.

#### Response Example
None

### Obsolete Information
This method is obsolete starting from Spotfire version 14.8 and earlier versions including 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, and 11.8.
```

--------------------------------

### TaskRegistry Methods

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/T_Spotfire_Dxp_Automation_Framework_TaskRegistry.htm

Lists the methods available for the TaskRegistry class.

```APIDOC
## TaskRegistry Methods

### Register
**Description:** Register an task type by supplying an instance of the task.

**Parameters:**
* **taskInstance** (object) - An instance of the task to register.
```

--------------------------------

### Task.Title Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Extension_Task_Title.htm

Gets or sets the title of the task. This property is used in the job builder dialog and for logging purposes.

```APIDOC
## Task.Title Property

### Description
Gets or sets the title of the task. Used in job builder dialog and for logging.

### Namespace
Spotfire.Dxp.Automation.Extension

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Syntax
```csharp
public string Title { get; set; }
```

### Property Value
Type: String

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Initialize TaskBase Constructor

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Framework_TaskBase__ctor.htm

Initializes a new instance of the TaskBase class. Use this constructor when creating custom tasks. The 'deprecated' parameter defaults to false.

```csharp
protected TaskBase(
	string title,
	string description,
	bool deprecated = false
)
```

--------------------------------

### Get Analysis Application C#

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Extension_TaskExecutionContext_Application.htm

Retrieves the Analysis Application associated with the current task context. This property is read-only.

```csharp
public AnalysisApplication Application { get; }
```

--------------------------------

### ErrorDialogBase.OnLoad Method

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Utilities_ErrorDialogBase_OnLoad.htm

The OnLoad event is called when the ErrorDialogBase is loaded. This method is part of the Spotfire.Dxp.Automation.Utilities namespace and resides in the Spotfire.Dxp.Automation.Framework.dll assembly.

```APIDOC
## ErrorDialogBase.OnLoad Method

### Description
This method is called when the ErrorDialogBase is loaded. It is an override of the base class's OnLoad method.

### Method
protected override

### Endpoint
N/A (This is a class method, not a REST endpoint)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A (This is a method, not an API call with a response)

#### Response Example
N/A

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Task.GetProgressTitle Method

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Extension_Task_GetProgressTitle.htm

Gets the title text to show in progress dialogs when executing this task. By default, this returns the Title.

```APIDOC
## Task.GetProgressTitle Method

### Description
Gets the title text to show in progress dialogs when executing this task. By default, this returns the Title.

### Method
GET (or equivalent for retrieving a property)

### Endpoint
Not applicable for this method as it's likely called within a task execution context.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
This method is typically called internally by the Automation Services framework.

### Response
#### Success Response (200)
- **string** - The progress title for the task.

#### Response Example
```json
"Task Progress Title"
```

### Remarks
Note, this might not be called on application thread.

### Namespace
Spotfire.Dxp.Automation.Extension

### Assembly
Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll)

### Supported Versions
14.8, 14.7, 14.6, 14.5, 14.4
```

--------------------------------

### Get or Set UnknownTaskElements

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/P_Spotfire_Dxp_Automation_Framework_UnknownTask_UnknownTaskElements.htm

Use this property to access the keeper elements of an unregistered task. Supported in multiple versions of Spotfire.

```csharp
public XmlElement[] UnknownTaskElements { get; set; }
```

--------------------------------

### Initialize TaskExecutionStatus with Exception

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire_autsvcs/html/M_Spotfire_Dxp_Automation_Framework_TaskExecutionStatus__ctor_3.htm

Use this constructor to create a TaskExecutionStatus object when an exception occurs. It automatically sets the status to false and populates the error message with exception details.

```csharp
public TaskExecutionStatus(
	Exception exception
)
```
Tokens:
Raw