Registering a Java-based Task

You use the Web Customization Editor to register or re-register a Java-based task. You can register a previously unregistered Java-based task class with any unused Task ID, register a currently registered Java-based task class with a different Task ID, or re-register an existing task by associating its Task ID with a different Java-based task class. In each case, the task class can be an out-of-the-box MicroStrategy task class or a custom task class.

• Registering a Java-based task

  When you register a task class, you select a Java-based task class and provide it with a new Task ID. If you select a task class that was previously registered, the result is that you now have two tasks that perform the same functions but have different Task IDs.

• Re-registering an existing MicroStrategy Java-based task

  When you re-register an existing MicroStrategy task, you select the Task ID for a Java-based task that was previously registered and re-link that Task ID to a different task class. The result is that you now have a task that may perform different functions from those previously performed by the task with the same Task ID.

The Task ID is also referred to as the task name or the task alias.

Registering a Java-based task

You register a Java-based task class using the Registering a New Task Wizard. To do this, you launch the Web Customization Editor and follow the steps below.

1. Select the Application Settings tab and click MicroStrategy Web Configuration to expand the hierarchical tree of customizable features.  

2. Right-click Tasks and select Open in Editor from the context menu.  

3. On the Task Factory Settings tab in the right-hand pane, click the Add button under Tasks. The Registering a New Task Wizard opens.  

4. On the Registering a New Task Wizard, do the following.  

   1. For the Fully Qualified Task Class, enter or browse to the full-qualified name of the Java-based task class that you want to register.  

   2. For the Alias, enter the Task ID with which you want the task to be registered.

      The Alias field is automatically populated based on the name of the Java class for the selected task. If this name has already been used as a Task ID, the Finish button is disabled and you must provide a different Task ID.

   3. Click the Finish button.

5. Under Tasks on the Task Factory Settings tab in the right-hand pane, the task that you registered now appears at the bottom of the list of tasks. The Task ID appears in the Namecolumn, and the fully-qualified name of the task class appears in theClass Namecolumn.

Re-registering an existing MicroStrategy Java-based task

You re-register a Java-based task with MicroStrategy using either the Modify Task Class Wizard or the Edit Task Wizard. To do this, you launch the Web Customization Editor and follow the steps below.

•  To re-register a Java-based task class using the Edit Task Wizard, you do the following:

  1. Select the Application Settings tab and click MicroStrategy Web Configuration to expand the hierarchical tree of customizable features. 

  2. Right-click Tasks and select Open in Editor from the context menu. 

  3. Under Tasks on the Task Factory Settings tab in the right-hand pane, select the Task ID of the task that you want to re-register and click the Edit button. 

  4. The Edit Task Wizard opens. 

     1. For the Fully Qualified Task Class, enter or browse to the full-qualified name of the new Java-based task class that you want to register for the selected Task ID. 

     2. The Task ID of the task that you are re-registering is displayed in the Alias field, but it is grayed out and cannot be changed. 

     3. Click the Finish button. 

  5. Under Tasks on the Task Factory Settings tab in the right-hand pane, the fully-qualified name of the new task class that you selected now appears in the Class Name column for the task that you are re-registering. The Task ID in the Namecolumn remains the same.

• To re-register a Java-based task class using the Modify Task Wizard, you do the following:

  1. Select the Application Settings tab and click MicroStrategy Web Configuration to expand the hierarchical tree of customizable features. 

  2. Under Tasks, select the Java-based task (identified by its Task ID) that you want to re-register. 

  3. Right-click the selected task (that is, Task ID) and select Modify Class from the context menu. 

  4. The Modify Task Class Wizard opens. 

     1. For the Fully Qualified Task Class, enter or browse to the full-qualified name of the Java-based task class that you want to register (that is, associate with the Task ID of the task you selected). 

     2. Click the Finish button. 

  5. Under Tasks on the Task Factory Settings tab in the right-hand pane, the fully-qualified name of the new task class that you selected now appears in the Class Name column for the task that you are re-registering. The Task ID in the Name column remains the same. 

Refer to Task Class for information about the interfaces, abstract classes, and methods used to write the Java class for the task. Refer to Code Sample for a Java-based Task for an annotated code sample that illustrates a simple Java-based task that performs folder browsing.