KB249132: How to Create a Custom Task That Will Login, Export a Document and Logout using MicroStrategy Web SDK 9.4.x

Developers may want to login and create a session, execute a document, and close the session all in one task call. This can be achieved by creating a custom Java-based task that will combine the following out of the box tasks:
login, exportDocument, logout
The custom Java-based task will extend the AbstratDataServiceTask and use the getMainTaskName().
Follow the steps below on how to accomplish this:
 

• Open the Web Customization Editor (WCE) and create a new plugin.
• Select the Application Settings tab and click Strategy Web Configuration to expand the hierarchical tree of customizable features.
• Right click on Tasks and select “New Task”.

• Create a Java task by selecting “Create a Task by writing a Java class only”.

• Click Next.
• Enter the source folder, package, name of the custom task, task ID, and task description.
• Click the Browse... button next to the Supperclass text field.
• Search for AbstractDataServiceTask and click OK.

• Click Next.
• Add getMainTaskName() to the methods to override.

• Click Finish.
• In the new java file created, in the getMainTaskName(), return the main task to be called after logging in and before logging out:

protected String getMainTaskName() {
        return "exportDocument";
    }

1. Make sure the new task is registered in the Task Factory Settings:

         Registering a Java-based Task

1. Save changes and restart the Web Server.

 
The example provided in this document is provided “as-is” to the user and assumes that the user:

• Can program, compile (e.g. javac, jikes, etc.), and execute Java programs
• Can configure environment variables (e.g. JAR files, property files, etc.)
• Have all the necessary tools to create Java applications (JDK, IDE, etc.)
• Has access to the Strategy SDK documentation.
• Has read the customization warning at the bottom of this document

PREREQUISITES:
 
For the sample to work, the Strategy Web JAR files must be accessible by the Java Runtime
Environment. The Strategy Web JAR files can be found under:

• Strategy Web Universal (JSP): {web_root}/WEB-INF/lib directory.
• Strategy Web (.NET): Program Files\Common Files\Strategy directory.

Note:
 
More elaborate programs will require additional library files and are out of the scope of this document.
 
ADDITIONAL INFORMATION:
 
The Strategy SDK allows you to customize the standard Strategy Web interface, and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy Web products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy Web architecture or the process of customizing Strategy Web, please refer to MicroStrategy Developer Hub.
 
To access the Strategy Developer Hub, you must have access to the Strategy Knowledge Base, you must have purchased the Strategy SDK, and you must be current on your Strategy maintenance agreement. If you are a US-based business and believe that you satisfy all three of these conditions but you do not have access to the Strategy Developer Hub, please contact Strategy Technical Support at support@microstrategy.com or at (703) 848-8700. If you are an international business, please contact Strategy Technical Support at the appropriate email address or phone number found at https://www.microstrategy.com/en/support/contact-support.
 
 
CUSTOMIZATION WARNING:
 
This customization is provided as a convenience to Strategy users and is only directly applicable to the version stated. While this code may apply to other releases directly, Strategy Technical Support makes no guarantees that the code provided will apply to any future or previous builds. In the event of a code change in future builds, Strategy Technical Support makes no guarantee that an updated version of this particular customization will be provided. In the event of a code change in future builds, Strategy may not be able to provide additional code on this matter even though this customization is provided at this time for this specific build. For enhancements to this customization or to incorporate similar functionality into other versions, contact your Account Executive to inquire about Strategy Consulting assistance.