Skip to main content

Workbook Automation

The Workbook Automation profile type is used to process writebacks for Budget Accelerator workbooks, or to perform workbook generation for Spreadsheet Analyst reports.

Note: Workbook Automation is only available if the user is licensed to both Spreadsheet Server and Budget Accelerator, or, to Spreadsheet Analyst.

Create and Maintain a Workbook Automation Job

  1. Use the following table to enter data in the Workbook Automation > Job tab:
  2. Field

    Description

    Job Name

    Specify the name of the job.

    Comments

    If desired, specify comments related to the job.

    Select the workbooks to process:

    This section indicates the workbooks and/or folder of workbooks to be included in the run. To:

    • Add workbooks to the job: specify the default values, click the Add Workbook(s) button, navigate, to, and select the desired workbook(s), then click the Open button.
    • Add a folder of workbooks to the job: specify the default values, click the Add Folder button, navigate, to, and select the desired folder, then click the Open button.
    • Edit a workbook or folder: select the item, and double-click, or, click the Edit button. The Edit dialog box appears. Modify the name or path (for example, assign a mask or wildcard), then click OK.
    • Remove a workbook or folder: select the item, and click the Remove button.
    • Control the order of worksheets or folders in the list: select the item in the window, then click the appropriate arrow button to move the item up or down in the list.

    Include (no label)

    If selected, the workbook(s) or folder(s) of workbooks are processed when the job is run.

    Workbook Name

    Displays the name of the workbook or folder assigned to the job.

    Start Macro

    If desired, specify the name of the macro to be run prior to refreshing and/or distributing the workbook(s)

    Refresh

    If selected, the workbook(s) or folder(s) of workbooks in the folder is refreshed, using the replacement data in the Range Name Replacement tab during the run process.

    Writeback

    If selected, budget and/or actual records from Budget Accelerator budget workbook(s) are uploaded to the budget database during the run process.

    End Macro

    If desired, specify the name of the macro to be run after refreshing and/or distributing the workbook(s).

    Sub Folders

    If selected, all workbooks in the sub-folders of the path specified are processed when the job is run.

    Include Default

    Specify the default Include value to be assigned when a workbook and/or folder is added to the job.

    Refresh Default

    Specify the default Refresh value to be assigned when a workbook and/or folder is added to the job.

    Writeback Default

    Specify the default Writeback value to be assigned when a workbook and/or folder is added to the job.

    Sub Folders Default

    Specify the default Sub Folder to be assigned when a workbook and/or folder is added to the job.

    Start Macro Default

    Specify the default Start Macro value to be assigned when a workbook and/or folder is added to the job.

    End Macro Default

    Specify the default End Macro value to be assigned when a workbook and/or folder is added to the job.

    Halt on Error

    If selected, and an error is encountered while running the profile, the system stops processing the job.

    Button

    Function

    Run

    Saves and closes the job, then processes all workbook(s) or folder(s) of workbooks in the folders which are selected to run.

  3. Use the following table to enter data in the Workbook Automation > Writeback Settings tab:
  4. Field

    Description

    Database

    If desired, click the drop-down list, and, select the named connection for the database to be used for retrieving budget version, fiscal year, and writeback selections available on the panel.

    Note: this option does not control the database used during the writeback process.

    Override Values:

     

    Budget Version

    If desired, click the drop-down list, and select the budget version to assign as the budget version during the writeback process.

    Fiscal Year

    If desired, click the drop-down list, and select the fiscal year to assign as the budget year during the writeback process.

    Writeback Selection:

    The following options are only available when a database is selected. If a database is not selected, All is assumed.

    All/All Non-Express/All Express/Selected

    When a database is selected, specify whether to process all writebacks in the budget database, only non-express writebacks, only express writebacks, or only selected writebacks. The option selected determines the writebacks listed in the grid.

    Writeback List

    Displays a list of writebacks and associates their budget model name, based on the database and Writeback option specified. If Writeback is set to Selected, the Include column appears, allowing the user to select which writebacks to process.

  5. Use the following table to enter data in the Workbook Automation > Range Name Replacement tab:
  6. Field

    Description

    Range Name Replacement:

    This section indicates the ranges of the selected workbooks to be replaced with designated values. To:

    • Display a list of range names in the workbooks assigned to the job: click the Refresh button.
    • Modify values: select the line and make the appropriate change(s).
    • Remove a range in the list: select the item, then click the Remove button.
    • Clear all ranges in the list: click the Clear button.

    Range Name

    Specify the name of the range to be replaced.

    Replacement Value

    Specify the value to be placed in the associated range.

    Button

    Function

    Run

    Saves and closes the job, then processes all workbook(s) or folder(s) of workbooks in the folders which are selected to run.

  7. Proceed to the next step: Schedule Job.

Was this article helpful?

We're sorry to hear that.

Powered by Zendesk