Global Software, Inc.'s Spreadsheet Writeback User Manual. Release V14 R1 M2

Transcription

1 Global Software, Inc.'s Spreadsheet Writeback User Manual Release V14 R1 M2 Worldwide Headquarters 3201 Beechleaf Court, Suite 170 Raleigh, NC USA EMEA/APAC Headquarters 100 Saint Paul's Churchyard London, EC4M 8BU UK +44 (0)

2 Spreadsheet Writeback All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. Microsoft, Excel, Windows, Outlook, Office, Access and SQL Server are all registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. IBM, DB2, iseries, and AS/400 are registered trademarks of International Business Machines Corporation. Trade names referenced are the service marks, trademarks, or registered trademarks of their respective manufacturers in the United States and/or other countries. Global Software, Inc. is not associated or affiliated in any manner with the respective owners of the foregoing trademarks, trade names or service marks unless expressly stated otherwise. The respective owners of the foregoing trademarks, trade names or service marks have not endorsed, certified or approved any of Global Software, Inc.'s products for use in connection with their respective products. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Printed: February 2014

3 Contents I Table of Contents Part I Spreadsheet Writeback Overview 1 Part II Spreadsheet Writeback Installation 2 1 Additional... Components 2 2 Registration Register... Add-In 4 4 Uninstall... Process 5 Part III Navigation 6 1 Spreadsheet... Writeback Menu 7 2 SWB Toolbar SWB Ribbon... 9 Part IV Set Database 10 Part V Build a Template 13 1 Example... Writeback Definition 16 Part VI Data Rows 17 Part VII Run Writeback 18 1 Run a... Single Writeback 19 2 Run Multiple... Writebacks 23 3 Deleting... Data 25 Part VIII Miscellaneous Items 26 1 View Log... Entries 26 2 Remove... Writeback Connection 28 3 Delete... Writeback Definition 30 Index Global Software, Inc.

4 1 Spreadsheet Writeback - Release V14 R1 M2 1 Spreadsheet Writeback Overview As an integral part of Global Software, Inc.'s suite of data analytical solutions, Spreadsheet Writeback is a powerful tool used to write data from an Excel spreadsheet to a database. Spreadsheet Writeback provides an interface to enable data on worksheets to be written back to a database table. Data may be written back to any table for which the user has write permissions. During the initial setup process, a database is identified to which to write the data. This database connection is assigned per worksheet, thus it is possible to assign a different database to each worksheet within a workbook. After the database connection is defined, the user selects the table to which to write the data and identifies the columns in the table to populate with data from the spreadsheet. A Writeback definition has a header row that defines the table name and table fields, plus two columns at the far right to hold the date and status of the last writeback. One or more Writeback definitions may reside on a worksheet. Once the Writeback definition is defined, data to be written to the database is entered on the spreadsheet. The number of Writeback rows is limited only by the number of rows in a spreadsheet. The text "SWB>" signifies that the row is to be written back. After the data is keyed on the spreadsheet, the Writeback may be run. When running Writebacks, the user may run an individual Writeback, all Writebacks for a selected worksheet, or all Writebacks for the entire workbook. In addition, the user may write all data rows or only selected data rows to the database.

5 Spreadsheet Writeback Installation 2 2 Spreadsheet Writeback Installation 2.1 Additional Components REQUIRED COMPONENTS Microsoft.Net Framework Microsoft.Net Framework 4.0 is a prerequisite for Spreadsheet Writeback. This component must be installed prior to running the Spreadsheet Writeback setup program. Microsoft Visual Studio Tools for Office Microsoft Visual Studio 2010 Tools for Office Runtime is a prerequisite for Spreadsheet Writeback. If it is not installed, then the Spreadsheet Writeback setup program will force the install. OPTIONAL COMPONENTS Global Software, Inc.'s Spreadsheet Server.Net To utilize connections established in Global's Spreadsheet Server.Net application or to access Spreadsheet Writeback functions from the Spreadsheet Server custom ribbon, Spreadsheet Server must be installed. OPTIONAL DATABASE COMPONENTS Based upon the database type to which Spreadsheet Writeback is connecting to, additional software components may be required prior to processing. Contact your IT department to determine what is required to be installed. iseries DB2 Database Both the ODBC and the OLE DB Provider components of the IBM iseries Access for Windows must be installed onto the PC which will use Spreadsheet Writeback. Run the setup program within IBM iseries Access for Windows to determine that the ODBC and OLE DB Provider components are installed. Microsoft SQL Server Database No further software needs to be loaded to provide connectivity to a SQL Server database, as the ODBC driver used is already loaded with Windows. Global Software, Inc.

6 3 Spreadsheet Writeback - Release V14 R1 M2 2.2 Registration After the completion of a new install it is necessary to register the product for the user. The registration function is also used to release a license key, thus allowing the license to be assigned to a different user. 1. In Excel from the Spreadsheet Writeback menu, select About. The Spreadsheet Writeback panel appears. 2. Click the License Key ellipse ( ) button. The License Key - Spreadsheet Writeback panel appears. Nav Tip: If the user has not yet been registered, this panel may also be accessed by selecting any Spreadsheet Writeback function. 3. Use the table to enter data on the License Key - Spreadsheet Writeback panel. Field User Name License Key Use a Proxy Server Address, Port, User Name, Password Buttons Release License Description Specify the Windows user login name. Specify the license key to be assigned to the user. If selected, indicates to use the proxy server settings specified for connecting to the internet. When the option is selected, additional setting options become available for input. When the Use Proxy Server option is selected, specify the IP address, port number, user name and password to be used for connecting to the internet. Description Removes the license key currently assigned to the user, allowing the license key to be assigned to another user. 4. To register the user or update user data, click Submit.

7 Spreadsheet Writeback Installation Register Add-In If the Spreadsheet Writeback add-in was not registered during the installation process, then it is necessary to register the add-in prior to using Spreadsheet Writeback. The registration process initiates the Spreadsheet Writeback add-in for Excel. Note: If the add-in is not registered on the PC, then Spreadsheet Writeback will not appear in the list of available add-ins for Excel. To Register the Add-In 1. From the desktop, click Start>All Programs>Global Software Spreadsheet Writeback>Register Add-In. The Register Add-In panel appears. 2. Click OK to register the add-in. A panel appears indicating that the registration process is complete. 3. Click OK. To Unregister the Add-In 1. From the desktop, click Start>All Programs>Global Software Spreadsheet Writeback>Unregister Add-In. The Unregister Add-In panel appears. 2. Click OK to unregister the add-in. A panel appears indicating that the unregistration process is complete. 3. Click OK. Global Software, Inc.

8 5 Spreadsheet Writeback - Release V14 R1 M2 2.4 Uninstall Process Generally it is not necessary to uninstall Spreadsheet Writeback prior to installing new versions. An uninstall should only be performed in order to completely remove the product from the PC. To Unregister and Uninstall the Add-In 1. From the desktop, click Start>All Programs>Global Software Spreadsheet Writeback>Unregister Add-In. The Unregister Add-In panel appears. 2. Click OK to unregister the add-in. A panel appears indicating that the unregistration process is complete. 3. Click OK. 4. Ensure that Excel is not open. 5. From the desktop, click Start>Control Panel>Add or Remove Programs, -or- Programs and Features. 6. Select the Global Software Spreadsheet Writeback program and click Change/Remove or Uninstall..

9 Navigation 6 3 Navigation Spreadsheet Writeback uses the following navigation methods for processing functions within Excel. Each function is not always available from each method. Spreadsheet Writeback Menu (see Spreadsheet Writeback Menu) Spreadsheet Writeback Toolbar (see SWB Toolbar) Spreadsheet Server Ribbon (see SWB Ribbon) For Excel 2003: The Spreadsheet Writeback menu is accessible from the Excel menu bar. The Spreadsheet Writeback toolbar is accessible in the standard toolbar section. The Spreadsheet Server ribbon is NOT applicable. For Excel 2007 and Above: The Spreadsheet Writeback menu and Spreadsheet Writeback toolbar are accessible from the Add-Ins ribbon. The Spreadsheet Server ribbon is only available when Spreadsheet Server is installed and selected as an add-in to Excel. NAVIGATION TIPS: Throughout the manual navigation tips, noted by the convention "NAV TIP", will be listed indicating the various paths available to access a function. Global Software, Inc.

10 7 Spreadsheet Writeback - Release V14 R1 M2 3.1 Spreadsheet Writeback Menu After Spreadsheet Writeback is initiated as an add-in to Excel, the Spreadsheet Writeback menu is added to Excel. The menu is used to access/process various functions within the application. For Excel 2003: The Spreadsheet Writeback menu is accessible from the Excel menu bar. For Excel 2007 and Above: The Spreadsheet Writeback menu is accessible from the Add-Ins ribbon. Menu Item Database Set Spreadsheet Writeback Database About Build a Template Spreadsheet Writeback Description Displays the name of the database set for the current worksheet. Otherwise, the literal '(Not Set)' appears if a database has not been selected. Use the Set Spreadsheet Writeback Database function to select the appropriate database. Opens the Connection Builder panel, allowing the user to select the database that will receive the data from the worksheet. Refer to Set Database for more information. Opens the about panel displaying company and product information. Opens the Build a Template panel, allowing the user to create a Writeback definition. Refer to Build a Template for more information. Opens the Spreadsheet Writeback panel, allowing the user to write data from the spreadsheet to the database. See Run Writeback for more information.

11 Navigation SWB Toolbar After Spreadsheet Writeback is initiated as an add-in to Excel, a Spreadsheet Writeback (SWB) toolbar is added to Excel. The SWB toolbar may be used as a convenient alternative to various Spreadsheet Writeback menu functions. For Excel 2003: The SWB toolbar is accessible from the Excel menu bar. For Excel 2007 and Above: The SWB toolbar is accessible from the Add-Ins ribbon. Menu Item Database Build a Template Writeback Description Displays the name of the database set for the current worksheet. Otherwise, the literal '(Not Set)' appears if a database has not been selected. Click the down arrow and select the Set Spreadsheet Writeback Database function to select the appropriate database. Refer to Set Database for more information. Opens the Build a Template panel, allowing the user to create a Writeback definition. Refer to Build a Template for more information. Opens the Spreadsheet Writeback panel, allowing the user to write data from the spreadsheet to the database. See Run Writeback for more information. Global Software, Inc.

12 9 Spreadsheet Writeback - Release V14 R1 M2 3.3 SWB Ribbon When Global's Spreadsheet Server application is installed, a custom ribbon is automatically installed for Excel 2007 (and above) users. The custom ribbon may be used as a convenient alternative to various Spreadsheet Writeback menu functions. For Excel 2003: The custom ribbon is NOT applicable. For Excel 2007 and Above: The Spreadsheet Server ribbon is only available when Spreadsheet Server is installed and selected as an addin to Excel. Menu Item Browse Database Build a Template Writeback About Description Opens the Connection Builder panel, allowing the user to select the database that will receive the data from the worksheet. Refer to Set Database for more information. Opens the Build a Template panel, allowing the user to create a Writeback definition. Refer to Build a Template for more information. Opens the Spreadsheet Writeback panel, allowing the user to write data from the spreadsheet to the database. See Run Writeback for more information. Opens the About panel displaying company and product information.

13 Set Database 10 4 Set Database The Set Spreadsheet Writeback Database function allows the user to create connections and assign a specific database connection to a worksheet. As the database connection is assigned per worksheet, it is possible to assign a different database to each worksheet within a workbook. Database connections may be created to the following data sources: Application Configurator Connections (excluding Salesforce and SAP connection types) DSN Oracle SQL Server IBM DB2 -- iseries Access (ODBC or OLE/DB) 1. In Excel from the Spreadsheet Writeback menu, select Set Spreadsheet Writeback Database. The Connection Builder panel appears. Nav Tip: This panel may also be accessed by selecting the SWB toolbar or ribbon equivalent (see SWB Toolbar or SWB Ribbon). 2. Select the row designating the desired Connection Type. 3. Click Next -or- select the Connection Settings tab. The Connection Settings tab appears displaying the appropriate setting fields based upon the selected connection type. Global Software, Inc.

14 11 Spreadsheet Writeback - Release V14 R1 M2 4. Use the table to enter data on the Connection Settings tab. Field Application Configurator Connections: Database Connection Name Login: Name/Password Connection DSN: Database Driver Data Source Name (DSN) Connect using Windows Authentication ID Password Oracle: Server Name SID Port ID Password SQL Server: Server Name Connect using Windows Authentication ID Password Database Name iseries Access (ODBC / OLE/DB): System ID Password Default Library Description Note: This option only appears if Spreadsheet Server.Net V14 (or higher) is installed on the user's PC. Otherwise Executive Dash connections will be available if Executive Dash is installed. Click the down arrow and select the Configurator connection to be used. Displays the login name and password assigned to the connection in the Configurator. Note: When using a Configurator connection in Spreadsheet Writeback, the system utilizes the Prompt for Input option as defined in the Configurator. Displays the criteria defined for the connection in the Configurator. Click the down arrow and select a driver. Valid options are Access dbase, Access Driver, or Excel. Click the down arrow and select the data source (DSN). If selected, indicates to use the user's Windows login ID to validate security access to the designated server. Specify the user name to be used to connect to the database. Specify the password associated with the above user name. Specify the Oracle Local Server Name. Specify the service name indicating where the database is located. Specify the port number. Specify the user name to be used to connect to the database. Specify the password associated with the above user name. Click the down arrow and select the server name. If selected, indicates to use the user's Windows login ID to validate security access to the designated server. Specify the user name to be used to connect to the database. Specify the password associated with the above user name. Click the down arrow and select the database. Specify the server name or IP address. Specify the user name to be used to connect to the database library. Specify the password associated with the above user name. Specify the name of the database library.

15 Set Database To modify the Connection Save Options setting, select the appropriate radio button. Use the table to identify the options. Field Save (without password) Save Don't Save Description Saves the connection in the worksheet without saving the password. A login prompt panel appears when accessing the Build a Template or Writeback functions. This option is only available for connections that have a login ID. Saves the connection in the worksheet with all login information. Note: Caution should be used when utilizing this option, as anyone obtaining the workbook will be able to writeback to the database. Does not save the connection in the worksheet, but instead a prompt for connection appears when accessing the Build a Template or Writeback functions. 6. To test the connection, click Test Connection. If required the user is prompted to enter login information. The system returns a message confirming that the connection is successful. 7. To update the connection and assign the database to the worksheet, click OK. The selected database data displays on the Spreadsheet Writeback menu and toolbar. Global Software, Inc.

16 13 Spreadsheet Writeback - Release V14 R1 M2 5 Build a Template The Build a Template function is used to create a Writeback definition. A Writeback definition identifies where to write the data to and where to get the data to be written back. The Build a Template panel helps identify three major parts of a definition. The database table and fields that data will be written back to. The range on the worksheet where the data to be written back resides. How to handle the database connection. 1. In Excel from the Spreadsheet Writeback menu, select Build a Template. The Build a Template panel appears. Nav Tip: This panel may also be accessed by selecting the SWB toolbar or ribbon equivalent (see SWB Toolbar or SWB Ribbon). 2. Use the table to enter data on the Build a Template panel. Field Schema Name Table Name Description Click the down arrow and select the database schema or table space name. Note: For some connection types the Schema Name will remain blank. Click the down arrow and select the table to which the data will be written.

17 Build a Template 14 Field Table Fields: Included/Name Description Once the Schema Name and Table Name are defined, the associated fields are listed. Select the fields to which data will be written. Primary key fields are required and are automatically selected. If the table does not have a primary key then one should be added -or- once the template has been inserted into the spreadsheet then key fields may be defined by prefixing the field name with two asterisks. Example: **FiscalYear Required fields may also be predefined by prefixing a field with one asterisk. Example: *Account Note: During the writeback process the system validates that all required fields are nonblank. Nav Tip: Click the top left corner in the Table Fields section to select or deselect all fields. Worksheet Insert: Range Name Worksheet Starting Column Starting Row Ending Column (Optional) Ending Row (Optional) Worksheet Database Connection: Save (Without Password) Once the Schema Name and Table Name are defined, a systemgenerated range name defaults. The range name for the Writeback determines the valid rows and columns on the worksheet that may be written back. It is recommended to use the system-generated name; however if necessary, click the down arrow and select an existing range name. Note: The system generated range name syntax is GSIWB.ABC, where ABC is the selected table name. Click the down arrow and select the sheet for the Writeback definition. Specify the starting column for the Writeback definition range. Defaults to the active column at the time the Build a Template function is accessed. Specify the starting row for the Writeback definition range. Defaults to the active row at the time the Build a Template function is accessed. Specify the ending column for the Writeback definition range. A value must be entered when using the Exclude Column Names option. If this value is not defined then the system determines the range width. Specify the ending row for the Writeback definition range. If this value is not defined then the range defaults to three rows: a column header row, one data row, plus one empty row. If selected, the connection in the worksheet is saved without saving the password. A login prompt panel appears when accessing the Build a Template or Writeback functions. This option is only available for connections that have a login ID. Global Software, Inc.

18 15 Spreadsheet Writeback - Release V14 R1 M2 Field Save Don't Save Exclude Column Names Buttons Delete a Writeback Definition Description If selected, the connection in the worksheet is saved with all login information. Note: Caution should be used when utilizing this option, as anyone obtaining the workbook will be able to writeback to the database. If selected, the connection in the worksheet is not saved, but instead a prompt for connection appears when accessing the Build a Template or Writeback functions. When column headers have been predefined on the spreadsheet, select this option for the system to not assign column names when creating the Writeback definition range. When this option is selected, an Ending Column value must be assigned. Description Displays the Delete Writeback Definition panel allowing the user to remove a Writeback definition. Refer to Delete Writeback Definitions for processing instructions. 3. To load the selected Writeback definition to the worksheet, click Insert. The Writeback definition is loaded to the worksheet with columns for the table fields selected plus two columns at the far right to hold the date and status of the last writeback. Note: When inserting a Writeback definition, the range name for the Writeback is created if it does not exist -or- a prompt to overwrite the name appears if the range name does exist. In addition, a special range name is created that identifies the Writeback definition and the range name for the Writeback. The image below shows the special range names in the Excel Name Manager. The Writeback definition range name syntax is GSIWB.###.100, where ### represents an incremented number for each Writeback definition in the work sheet (i.e. GSIWB , GSIWB ), thus allowing for up to 999 Writeback definitions per work sheet. 4. Save the workbook.

19 Build a Template Example Writeback Definition After inserting the Writeback definition the table name and field names will be displayed on the worksheet in Excel. The Build a Template function also creates a range name that encompasses the Writeback definition columns and the data rows that are to be written back. The example below shows a Writeback definition that has been inserted onto a spreadsheet using the Build a Template function, and where data has been keyed and written back to the appropriate table. The Writeback definition on the spreadsheet includes: Schema Name and Table Name inserted and displayed in cell B2. The syntax is schema_name.table_name. Selected Writeback fields are the next sequence of cells (C2:J2). Date and Time of the data row's Writeback is entered at the time Writeback is executed (K2). Status of the data row's Writeback is entered at the time Writeback is executed (L2). All rows that are within the Writeback's range name and have the identifier "SWB>" in the first column of the range (B3:B5) will be available for writing back. The Writeback identifier can be excluded from rows within the Writeback's range name to allow for non Writeback rows such as summary rows, group headers and footers. Global Software, Inc.

20 17 Spreadsheet Writeback - Release V14 R1 M2 6 Data Rows Once the Writeback definition has been defined it is necessary to define the rows to be written back to the database and to enter the appropriate data. 1. After inserting the Writeback definition to the spreadsheet, a table similar to the following appears on the spreadsheet and a range name that encompasses the Writeback definition and data rows is created. (See Build a Template for instructions on creating and inserting the Writeback definition.) 2. On the SWB> rows on the spreadsheet, key the necessary data to be written to the database. Note: All rows that are within the Writeback definition range and have the identifier "SWB>" in the first column of the range, will be available for writing back. The Writeback identifier may be excluded from rows within the Writeback definition range to allow for non-writeback rows such as summary rows, group headers and footers. 3. If necessary, use one of the following methods to add additional data rows to the Writeback definition range: Copy/Insert Copy an existing SWB> row within the range and insert the copied row within the existing range. Expand the Writeback Definition Range For Excel From the Excel toolbar select Insert>Name>Define. Use the Define Name panel to select and expand the size of the Writeback definition range. For Excel 2007 and above-- From the Ribbon select Formula>Name Manager. Use the Name Manager panel to select and expand the size of the Writeback definition range. Note: Refer to Excel Help for additional instructions on expanding the size of a range. Note: The Writeback definition range name syntax is GSIWB.###.100, where ### represents an incremented number for each Writeback definition (i.e. GSIWB , GSIWB ). 4. Save the workbook.

21 Run Writeback 18 7 Run Writeback Once the Writeback definition has been defined and data has been entered on the spreadsheet, use the Spreadsheet Writeback function to select the Writeback definitions and associated data rows to be run. Running a Writeback writes the data that was defined by the Writeback definition to the database. When running Writebacks, the user may run an individual Writeback, all Writebacks for a selected worksheet, or all Writebacks for the entire workbook. The available functions and required steps vary slightly based upon whether running an individual Writeback or multiple Writebacks at one time. In addition to inserting a new record or updating an existing record, Spreadsheet Writeback provides the ability to delete data from a database. This may only be done when processing a single writeback and only on a row by row basis. Refer to Deleting Data for instructions. Global Software, Inc.

22 19 Spreadsheet Writeback - Release V14 R1 M2 7.1 Run a Single Writeback 1. In Excel from the Spreadsheet Writeback menu, select Spreadsheet Writeback. The Spreadsheet Writeback panel appears. Nav Tip: This panel may also be accessed by selecting the SWB toolbar or ribbon equivalent (see SWB Toolbar or SWB Ribbon). 2. Use the table to enter data on the Spreadsheet Writeback panel in order to indicate how to writeback data. Field General Options: Include All Rows / Include Only Insert Rows / Include Only Update Rows Preview Rows Writeback Selection: Select Worksheet Select Writeback Description Specify when writing back data whether to writeback all rows, only insert rows, or only update rows in the Writeback definition. If selected, all rows in the grid are displayed and required to be validated prior to writing back. Click the down arrow and select the individual worksheet containing the Writeback definition to be run. Defaults to the active worksheet at the time the Spreadsheet Writeback function is accessed. Click the down arrow and select the individual Writeback definition to be run. Defaults to all writebacks for the active worksheet.

23 Run Writeback 20 When Preview Rows is NOT Selected: 3. Click Run Writeback to writeback data. The system indicates in the grid whether or not all rows processed normally. In addition, the Date and Status values for each row processed are updated on the spreadsheet. Global Software, Inc.

24 21 Spreadsheet Writeback - Release V14 R1 M2 When Preview Rows is Selected: 4. Use the table to select rows for validating, or to access other functions. Field Rows: Description Once an individual worksheet and Writeback definition are defined, the associated rows are listed. Select the rows to be processed. Defaults to select all rows. Nav Tip: Click the top left corner in the Table Fields section to select or deselect all fields. Stop on First Error Button Highlight Writeback Data (Toggle) Validate Rows Run Writeback View Log When the Preview Rows option is selected, select this option to indicate for the system to stop the Writeback process when the first error is encountered. Description Toggles to highlight or remove the highlight, on the spreadsheet the rows currently selected for writeback. Validates selected rows. Writes data back to the database. Displays the Log Viewer panel, where the user may see information and error log entries, copy selected log entries, or clear the log file. Refer to View Log Entries for more information. 5. After selections are complete, click Validate Rows to validate all selected rows -or- click the Question Mark icon ( ) to validate a single row. The system determines if the row is an insert (new record) or an update (modification of an existing record), and indicates whether each row validated normally or not. Green check -- row validated normally. Red exclamation point -- an error occurred in validation. Click the icon or View Log to determine the problem.

25 Run Writeback 22 Note: After validation, primary k ey fields are wrapped with two asterisk s (**) and required, non-primary k ey fields are wrapped with one asterisk (*). Note: After a row has been validated and flagged as Update, it is possible to compare the existing value with the new value. Hover the mouse over a cell in the Writeback panel to display the current value in the database. 6. After selections are complete, click Run Writeback to process all selected rows -or- click on the Question Mark icon ( ) to process a single row. The system indicates in the grid whether or not the rows processed normally. In addition, the Date and Status values for each row processed are updated on the spreadsheet. Green check -- row inserted or updated successfully. Red exclamation point -- an error occurred. Click the icon or View Log to determine the problem. 7. After all writebacks are run, click Close. Global Software, Inc.

26 23 Spreadsheet Writeback - Release V14 R1 M2 7.2 Run Multiple Writebacks 1. In Excel from the Spreadsheet Writeback menu, select Spreadsheet Writeback. The Spreadsheet Writeback panel appears. Nav Tip: This panel may also be accessed by selecting the SWB toolbar or ribbon equivalent (see SWB Toolbar or SWB Ribbon). 2. Use the table to enter data on the Spreadsheet Writeback panel, or to access other functions. Field General Options: Include All Rows / Include Only Insert Rows / Include Only Update Rows Preview Rows Writeback Selection: Select Worksheet Select Writeback Stop on First Error Description Specify when writing back data whether to writeback all rows, only insert rows, or only update rows in the Writeback definition. If selected, all rows are validated during writeback processing. Click the down arrow and select the individual worksheet containing the Writeback definitions to be run -or- select to run Writeback definitions for all worksheets in the workbook. Defaults to the active worksheet at the time the Spreadsheet Writeback function is accessed. Note: When the value All Worksheets is selected, the user is allowed to override the connection previously set for each worksheet. Click the down arrow and select to run all Writeback definitions for the selected worksheet/workbook. Defaults to all writebacks for the active worksheet/workbook. When the Preview Rows option is selected, select this option to indicate for the system to stop the Writeback process when the first error is encountered.

27 Run Writeback 24 Button Highlight Writeback Data (Toggle) Validate Rows Run Writeback View Log Description Not applicable. Not applicable. Writes data back to the database. Displays the Log Viewer panel, where the user may see information and error log entries, copy selected log entries, or clear the log file. Refer to View Log Entries for more information. 3. After valid selections are made, click Run Writeback. If a single worksheet was selected, the system starts the writeback process. If multiple worksheets were selected, the Run Writeback panel appears allowing the user to override the database previously assigned. Click No to use the database originally set for each worksheet. Click Yes to select a database to be applied to all Writebacks being run. The system starts the writeback process. 4. During the Writeback process, the Spreadsheet Writeback panel displays a list of rows being processed and indicates whether each row processed normally or not. In addition, after processing is complete the Date and Status values for each row processed are updated on the spreadsheet. Green check -- row inserted or updated successfully. Red exclamation point -- an error occurred. Click the icon or View Log to determine the problem. 5. After all writebacks are run, click Close. Global Software, Inc.

28 25 Spreadsheet Writeback - Release V14 R1 M2 7.3 Deleting Data In addition to inserting a new record or updating an existing record, Spreadsheet Writeback provides the ability to delete data from a database. This may only be done when processing a single writeback and only on a row by row basis for Update data type rows. 1. Complete steps 1-2 and 4-5 for running a single Writeback (see Run a Single Writeback). These steps include the following: Accessing the function Selecting an individual worksheet and writeback, and selecting desired rows for processing Validating rows 2. With the Spreadsheet Writeback panel open and the Validate Rows function complete, right click in the Insert/Update field on the data row targeted for deletion. The Database Delete Record dialog box appears. 3. Click Yes to delete the selected data or click No to cancel the delete process. 4. Click the Question Mark icon ( ) to process a single row. After running the writeback on the row the Insert/Update is changed to Insert for the deleted record 5. After all writebacks are run, click Close.

29 Miscellaneous Items 26 8 Miscellaneous Items 8.1 View Log Entries During the writeback process, the system records various logging information. Log entries may be viewed and copied if desired. 1. In Excel from the Spreadsheet Writeback menu, select Spreadsheet Writeback. The Spreadsheet Writeback panel appears. Nav Tip: This panel may also be accessed by selecting the SWB toolbar or ribbon equivalent (see SWB Toolbar or SWB Ribbon). 2. From the Spreadsheet Writeback panel, click View Log. The Log Viewer panel appears displaying the level, date, time, action, description, Writeback definition name, worksheet, and workbook for each log entry. In addition, in the bottom right hand corner the panel displays a count of the number of entries listed. Note: To select a different size font, click on the drop down arrow in the bottom right hand corner. 3. To copy selected records to the clipboard, on the Log Viewer panel first select the desired record(s) and then either click Copy Selected Errors -or- right click on the list and select Copy Selected Errors on the popup panel: To copy a single record -- select the desired record. To copy select multiple records -- press and hold the Ctrl key as records are selected in the list. To copy multiple records in a range -- select the first record in the range, press and hold the Shift key, and select the last record in the range. Global Software, Inc.

30 27 Spreadsheet Writeback - Release V14 R1 M2 4. To filter log entries for a specific workbook, click the workbook down arrow and select the desired workbook. The system displays only entries for the selected workbook. 5. To filter for a specific date range of entries in the error log file, select the Filter on Date check box and specify the desired date range. The system displays only entries for the selected date range. 6. To filter for a specific level of entries in the error log file, select the desired level(s) in the Filter list. The system displays only entries for the selected level(s). 7. To search for a specific value in the error log file Action column, key the desired value in the Find What field and click Find Next. The system will highlight the first log entry containing the value. Click Find Next again, to find the next occurrence of the selected value. 8. To clear the error log file, click Clear Log. 9. To display the full details of a log entry, double click the selected entry in the list. The Error Properties panel appears. Use the arrow buttons on the Error Proprieties panel to scroll up or down through the log entries in the list. To copy detail data for a single log entry to the clipboard, click Copy. Click Close to return to the Log Viewer panel. 10. To exit the Log Viewer panel, click Close.

31 Miscellaneous Items Remove Writeback Connection Writeback database connections are maintained at the worksheet level of a spreadsheet. The database connection may be removed via Spreadsheet Writeback or via Excel. Method 1 - Delete a Writeback Database Connection via Spreadsheet Writeback 1. In Excel from the Spreadsheet Writeback menu, select Build a Template. The Build a Template panel appears. Nav Tip: This panel may also be accessed by selecting the SWB toolbar or ribbon equivalent (see SWB Toolbar or SWB Ribbon). 2. Select the Don't Save radio button for the Worksheet Database Connection option, and click Insert. The panel closes and the connection is removed from the worksheet. 3. Save the workbook. Method 2 - Delete a Writeback Database Connection via Excel 1. Access the Define Name or Name Manager panel. For Excel From the Excel toolbar select Insert>Name>Define. The Define Name panel appears. For Excel 2007 and above -- From the Ribbon select Formula>Name Manager. The Name Manager panel appears. Global Software, Inc.

32 29 Spreadsheet Writeback - Release V14 R1 M2 Note: The connection range name syntax is GSIWB.000.###, where ### represents an incremented number for each Writeback definition (i.e. GSIWB , GSIWB ). 2. From the list of names, select the connection range name(s) to be deleted and click Delete. The connection is removed.

33 Miscellaneous Items Delete Writeback Definition If necessary Writeback definitions may be deleted from a worksheet. The definition may be removed via Spreadsheet Writeback or via Excel. Method 1 - Delete a Writeback Definition via Spreadsheet Writeback 1. In Excel from the Spreadsheet Writeback menu, select Build a Template. The Build a Template panel appears. Nav Tip: This panel may also be accessed by selecting the SWB toolbar or ribbon equivalent (see SWB Toolbar or SWB Ribbon). 2. From the Build a Template panel, click Delete a Writeback Definition. The Delete Writeback Definition panel appears. 3. For each Writeback definition targeted for deletion, select the check box in the Delete column and click OK. A message appears indicating that the deletion is complete. Note: An option is also available for deleting the Writeback definition range name if desired. Method 2 - Delete a Writeback Definition via Excel 1. Access the Define Name or Name Manager panel. For Excel From the Excel toolbar select Insert>Name>Define. The Define Name panel appears. For Excel 2007 and above -- From the Ribbon select Formula>Name Manager. The Name Manager panel appears. Global Software, Inc.

34 31 Spreadsheet Writeback - Release V14 R1 M2 Note: The Writeback definition range name syntax is GSIWB.###.100, where ### represents an incremented number for each Writeback definition (i.e. GSIWB , GSIWB ). 2. From the list of names, select the Writeback definition(s) to be deleted and click Delete. The Writeback definition is removed.

35 Index 32 Index - A - add-in register 4 unregister 4, 5 - B - build a template 13 - C - components 2 connection 10 - D - data rows 17 database connection 10 definition 13 example 16 delete data 25 database connection 28 Writeback definition 30 - E - error log 26 - L - license key 3 Log Viewer 26 - M - menu 7 - N - navigation 6 Writeback menu 7 Writeback ribbon 9 Writeback toolbar 8 - O - optional components 2 overview 1 - R - range names database connection 28 Writeback definition 30 register add-in 4 registration 3 required components 2 ribbon 9 run 18 delete data 25 multiple Writebacks 23 single Writeback 19 - S - set database 10 - T - toolbar 8 - U - uninstall 5 unregister add-in 4, 5 unregister user 3 - V - view log Global Software, Inc.

36 33 Spreadsheet Writeback - Release V14 R1 M2 - W - Writeback data rows 17 definition 13 definition example 16 delete data 25 run 18, 19, 23 set database 10 Writeback menu 7 Writeback ribbon 9 Writeback toolbar Global Software, Inc.