¶ Documentation: Run Workbook Action Task in Planning
¶ Overview
The Run Workbook Action Task feature allows you to automate the execution of Excel workbook actions directly from the Planning web interface. This functionality enables scheduled or on-demand data loading and saving operations between your workbooks and the database, eliminating the need for manual intervention through the Excel add-in.
¶ Prerequisites
- Excel add-in must be configured with appropriate actions
- Workbook actions (Load or Save) must be properly set up
- User must have permissions to create and execute tasks
¶ Setting Up Run Workbook Action Task
¶ Step 1: Create Actions in Excel Add-in
Before setting up a Run Workbook Action Task, you must first create the necessary actions in your Excel workbook:
- Open your workbook in Excel with the Planning add-in installed
- Configure the Load and/or Save actions as needed
- Load actions pull data from the database into the workbook
- Save actions update database tables with data from the workbook
- For detailed instructions, refer to the Excel Add-in Action Documentation
¶ Step 2: Access the Task Creator
- Navigate to the "Build" menu in the Planning application
- Select the "Tasks" section
- Click on "Create New" to open the task creation form
¶ Step 3: Configure Task Settings
Fill in the required fields in the Create Task form:
- Name: Enter a descriptive name for your task
- Description: Provide details about what the task does
- Task Type: Select "Run Worksheet Action" from the dropdown
- Model: Choose the appropriate model from the dropdown
- Workbook Id: Select the calculation workbook containing your actions
- Action Type: Choose either "Load" or "Save"
- Load: Updates workbook with latest data from database
- Save: Updates database tables with data from workbook
Additional Options:
- Override: Check this box to forcefully update data, overriding any conflicts
- Mark output file as private: Check if the resulting file should be private
Click "Save" to create the task
¶ Running Workbook Action Tasks
¶ Manual Execution
To run a task immediately:
- Navigate to the Flow section
- Create Flow and Add your task in the flow
- Save Flow
- Click the "Execute" button
- Monitor the execution status in the monitor screen
¶ Summary
The Run Workbook Action Task feature in Planning provides powerful automation capabilities for data management between Excel workbooks and your database. By properly configuring these tasks, you can streamline operations, ensure data consistency, and reduce manual effort while maintaining control over your data processes. With proper setup and monitoring, these tasks become an essential part of an efficient planning and reporting system.