› Execution plans › Create an execution plan

Create an execution plan

An execution plan is an Insight document that defines how data is loaded. You can run execution plans from the Data Loader application.

  1. In Studio, right-click Execution Plan and select New Execution Plan.

    The New Execution Plan window appears.

  2. In the Name field, enter a name for the execution plan and click OK.

    The execution plan editor opens.

    By default, the plan is not scheduled. To schedule the plan, complete the following steps.

  3. Click Schedule Options.

    The Scheduling Options window appears.

  4. In the Schedule section, select the frequency of the plan update schedule:

    • Manually

    • Daily

    • Incrementally

  5. If you select Every day, at specific times, click Add Add icon.

    The Execution time window appears.

  6. Click the calendar icon and slide the bars to set the hour and minute when you want the data to automatically update.

    The selected time appears in your Execution Plan.

    For more information about scheduling options, see the Help for Kofax Insight Data Loader.

  7. For a time interval update, select Every and select time interval settings, based on the preferred frequency for refreshing your data.
  8. Under Options section, define whether you want to stop the dataload in case an unexpected failure occurs. By default, the Stop execution if a step fails option is selected. It cancels the dataload with the Failed status assigned to it. If the check box is not selected, the dataload is executed anyway with the Success status.
  9. Select Keep old from date if no records loaded if you want to keep the last historic date in case no new data is loaded for records or metrics.
  10. Under the Options section, in the Start batch time from list, select one of the following options to set the historic date:
    • Select The last record time to save the time of the latest loaded record or metric as a historic date.
    • Select The previous batch finish time to save the time before dataload has been executed as a historic date.
  11. The data is loaded in accordance with the schedule. You can use a customized schedule to skip the data loading tasks during non-business hours and weekends, if required. For that, you can create a calendar and define the schedule that will be used to run the plan, and then select the required Calendar from the list under the Options section.

    For more information about creating calendars, see the Help for Kofax Insight Admin Console.

  12. Click OK.
  13. Select the Do not execute in parallel with option to set preferences for running the new plan separately from other plans scheduled at the same time. Use this option to ensure that the load on the server is distributed evenly while multiple plans are running, and to avoid performance issues. Do one of the following:
    • All Plans: Select this option to run the new plan separately from all other plans with the same schedule.
    • <Plan name>: Select the option next to each plan that should be run separately from the new plan.
  14. To assign your Execution Plan to a specific record or metric group, add running an external program as a step, or more, in the Plan window, click AddAdd icon to open a menu of options.
  15. If you select Run External Program, you can select the template document created in Admin Console that contains the path. The list of available external program templates is available under the Program drop-down list. Use the Arguments field to manually enter program arguments. Select Wait for exit external program to wait until the external program is complete and then proceed with the data load. If you clear this check box, the external program is launched but the data load continues without pausing.
  16. Select an option to assign your Execution Plan, such as a specific group.
  17. To define the execution plan availability in the Data Loader, assign the required execution plan type, using the Plan type property on the Property Panel. The following choices are available:

    • Internal: The plan is intended for internal use and is hidden on the list of plans in the Data Loader.

    • Load: A user can manually load the plan.

    • Schedule and load: A user can schedule and manually load the plan.

  18. To customize handling indexes during the data load, use the Rebuild Indexes Mode option on the Property Panel to select one of the following:

    • Don't rebuild indexes

    • Rebuild all indexes

    • Use record settings: In this case, index handling is managed by the individual setting for the record, described in Customize index handling.

    This option is available for each step.

  19. Select the Restore data load in case of system failure check box to enable the option. Set the time range to specify which data should be restored if an unexpected failure occurs.
    1. On the toolbar, select Tools > Project settings.
    2. Use the search help to find the Period to restore not running tasks. For example, if you type the word period, the system goes directly to the setting you need. This setting resumes the dataload for the execution plans that could not be executed within the specified range of time due to an unexpected failure.
    3. Set the required amount of time. When setting the value, consider using a date range that represents a manageable volume of data that will not have an adverse impact on performance when the plan is run.
  20. Click Save.