Spreadsheets

Spreadsheet objects are used to retrieve data from the database and store it in a spreadsheet file.

When a spreadsheet is run from the browser, depending on the browser and the operating system, the spreadsheet can open in the browser or can launch an outside helper application, such as Microsoft Excel, in which to display the spreadsheet.  For example, some versions of Microsoft Internet Explorer on Microsoft Windows may open the spreadsheet in the browser, however, it is likely that newer versions will open in Microsoft Excel (as this is a security patch from Microsoft).

See Also

Spreadsheet Templates

Adding Blocks to Spreadsheets

Modifying Blocks on Spreadsheets

Spreadsheet Fields

Spreadsheet Generation for Query Results

Property Definitions

Creating Spreadsheets

  1. In the Explorer Tree, expand and select the Group Information object in which you wish to create a spreadsheet.

  2. There are options in creating a spreadsheet at this point.

  1. The Creating an Entity screen will be displayed.

  2. Select the Spreadsheet entity type by left-clicking on the Spreadsheet radio button.

  3. Click on the Next button on the bottom right of the screen.

  4. In the Entity Name field, enter the desired name for the spreadsheet.

  5. In the Datasource pop-list, select the desired datasource or (use default).  

    Selecting (use default) will allow the spreadsheet to be used with any datasource, and data brought in will be determined by the user's datasource.

  6. In the Based On pop-list,select the template on which the new spreadsheet will be based.  Any mutable blocks assigned to the spreadsheet selected will be copied to the new spreadsheet.  

  7. In the Default Mode pop-list, select the view type that will be displayed by default for this spreadsheet.  Choices include Run Report and Parameter Form.

  8. Click on the Next button on the bottom right of the screen.

  9. The Adding New Block screen will be displayed.

  10. See the Adding Blocks to Spreadsheets section for the next steps.

Modifying Spreadsheet Templates

  1. In the Explorer Tree, expand the Group Information object and select the spreadsheet that you wish to modify.

  1. Display the spreadsheet properties.  These will either be displayed in Alphabetical or Logically, depending on the setting of the [Sort Alphabetically/Logically] button.  The following instructions are assuming that the properties are sorted logically.

  2. In the Name property, the name that you entered when creating the spreadsheet will be displayed.  It can be changed, if desired.

  3. In the Description property, enter a user-defined description for this spreadsheet .  The default is the type of object followed by the template name. (i.e. Spreadsheet:NEW)

  4. In the Datasource pop-list, the datasource that you selected when creating the spreadsheet will be displayed.  It can be changed, if desired.

    If set to (default), the default for the user's log in will be used when this spreadsheet is displayed.

  5. In the Allow Anonymous pop-list, select true if anonymous users should have access to this spreadsheet .  Select false if anonymous users should not have access to this spreadsheet.

  6. The Inherits From pop-list displays the template from which this spreadsheet was created, grayed out.  This value cannot be changed here.

  7. In the Default Mode pop-list, select the view type that will be displayed by default for this spreadsheet.  Choices include Run Report and Parameter Form.

  8. In the Parameter Screen Width property, enter the width in pixels for the parameter form created for this spreadsheet.

  9. In the Parameter Screen Height property, enter the height in pixels for the parameter form created for this spreadsheet.

  10. In the Required Roles property, select the roles that are required to run the entity.  When running this entity, the user must have at least one of the roles entered here, or the entity will not run, and the user will be returned to the log in screen.

    When you click on this field, a pop-up will be displayed with the available roles in the left side of the pop-up and the roles assigned to the entity on the right side.  

    To assign a role to the entity, select the desired role on the left side, and then click on the >> button to move it to the right side.  

    To unassign a role, select the desired role on the right side and then click on the << button to move it to the left side.  

    When all desired roles have been assigned, click on the Apply button.

    The Invalid Access Redirects To property will be displayed to allow you to define the entity that should be displayed for the user if the user does not have one of the required roles entered here.

  11. In the Required Globals property, list the global variables that are required to be set in order for the entity to run properly, separated by a line break.  If the entity is run, and some or all of these globals are missing, the entity will not be run.  The format is GLOBAL or, if desired, GLOBAL = VALUE.  

    For example, if the global variables ORG_UNIT_ID and EMPNO must be set for the page to run correctly, you would enter
    ORG_UNIT_ID
    EMPNO

    If the global variable ORG_UNIT_ID needed to have the value 100, but it didn't matter what the EMPNO value needed to be, you would enter
    ORG_UNIT_ID = 100
    EMPNO

  12. In the Accessed via property, enter the entity from which this spreadsheet is generated.  This is an optional property.  For example, if the spreadsheet has certain conditions that must be met on a screen entity before it can be run, the name of the spreadsheet entity should be entered here.  This prevents the spreadsheet from being improperly accessed.  

  13. In the Invalid Access Redirects To property, enter the entity to which the user will be redirected if this spreadsheet is improperly accessed.  This property is only displayed when the Accessed via property or Required Roles property is entered.  

    If a user accesses this spreadsheet from an entity other than the one entered in the Accessed via property, instead of opening the spreadsheet, the entity entered in this property will be opened.

    If a user that does not have one of the required roles accesses the entity, instead of opening the spreadsheet, the entity defined here is opened.

  14. In the Results Disposition property, only Return to Caller can be selected.

  15. The Created on property displays the date and time on which the spreadsheet was created and cannot be changed.

  16. The Modified on property displays the date and time on which the spreadsheet was last changed and cannot be modified.

  17. When all changes have been made, press the [Save] button in the Main Toolbar.

Xephr is a registered trademark of NDS Systems, LC.

Microsoft Internet Explorer, Microsoft Windows, and Microsoft Excel are registered trademarks of Microsoft Corporation.

Copyright © 2007 NDS Systems LC.