Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You can configure workbook settings when you create a new workbook and you can edit them as needed, later. The system administrator can also edit the workbook settings.

Table of Contents

Configuring Workbook Settings

...

Info
titleINFO

The Workbook Settings page provides information about:

  • trigger
  • data retention
  • the Workbook description
  • saving results and time based partitions
  • error handling
  • notifications
  • advanced settings
  • running a Workbook after saving

Workbook settings can be configured when creating a new Workbook or be edited later on.

Table of Contents

Accessing Workbook Settings 

You can access the Workbook settings via:

  • the File Browser: Click "File" and select "Configure"The Workbook settings page opens.
    Image Added 
  • the Workbook: Click "File" and select "Configure"The Workbook settings page opens.
    Image Added 

Workbook Settings Overview

Image Added

Configuring Workbook Settings

Trigger options

The trigger settings specify how often the workbook data is calculated. It has the following options: 

Anchor
pullType
pullType

...

  • Run when any of the selected data sources are updated.
    • The entire workbook is recalculated any time selected data sources are updated.
  • Trigger the workbook to run when any of the selected data sources are updated only if only if the following conditions are true. 
    • Conditions can be created for each data source in the workbook that must be fulfilled before the workbook calculates.  
    • Triggering condition measurements are preformed after the data source set to run has completed. The triggering conditions are only measured when the the job (workbook data source) has a Complete or Complete with Warnings status.

For example, this workbook recalculates when the data source 1 or 2 update in Datameer unless Data_Source_1 has updated less than 2 days from today or Data_Source_2 has updated within the past 3 hours. The workbook doesn't run if Data_Source_3 updates.

...

  • Hourly through Monthly. Choose the interval suitable for your needs.
  • Custom Cron Pattern.The format is a series of numbers separated by spaces to indicate the following: minute hour DayOfMonth Month DayOfWeek. Learn more about about Scheduling with Custom Cron Patterns.

For example, 0 9-15 * * * indicates that the task should launch once every hour between 9am to 3pm everyday.

...

Saving results and time based partitions

Saving results specifies which workbook sheets are saved and visible. By saving only the sheets that you need you can improve performance and computation time. If you want to retain smart sampling on filtered sheets, make sure to save them. Smart sampling is sampling is disabled if a sheet isn’t saved because it can slow down other processes. 

The Time Based Partition column displays which sheets have a date type column. If not all partitions need to be saved, set specific date ranges to save.Image Removed

INFO: The indicator 'Consumed by' marks the sheets that are being used by a downstream Workbook or for an export job. This helps to detect sheets that are no longer needed to be kept. 

Image Added

Error handling

...

  • Ignore. Ignores error calculations leaving the cell blank and continues processing the workbook.
  • Skip. Skips the error and calculate rows with valid data. The invalid data is dropped. (You can view statistics on dropped data. See Importing Data to learn more.) 
  • Abort. Stops the calculation. This option stops processing the workbook. 

...

The advanced settings allow custom key/value properties and logging severity/customization options.

  • Default log severity. Specify the severity of logging messages to be recorded. 

Run workbook after after saving or updating the workbook

Select the checkbox to run the workbook directly after saving or updating the workbook configuration page.

...

To change workbook settings:

  1. Select the workbook from the the File Browser.
  2. Click the the Configure from the  from the Edit menu  menu or right-click and select select Configure.
     
  3. Make changes and click click Save.