System Data

Use the System Data functions to configure lookups, view or modify interactive views, assign a customized screen to a user, add or edit business rules, add tables, add columns to tables, or create custom menus. Information regarding the Search Catalog can be found here.

Use the Lookup Table function to configure the information shown when you use the Lookup command (F4) within Traverse without making changes directly to SQL Server tables. You can define column heading names, whether you want a field to appear as search criteria, the order in which items appear in the Look By field, the order in which fields appear in the results area of the Search screen, and so on.

To define what appears when you use the Lookup command, select Lookup Table from the System Data menu in Traverse Design Studio. The Lookup screen appears.

Modify Lookup

Note: Do not modify these fields unless you have knowledge of database design and administration. If you have any questions about data structures in Traverse, please contact your Traverse software provider for assistance.

To add or modify a lookup, follow these steps:

  1. Select an existing lookup you wish to modify.
  2. Copy the lookup record, then paste it, thus making a duplicate of the original record.
  3. Change the ID column for the new record you just pasted.
  4. Update the Replace ID field of the record you just pasted with the ID of the lookup record you want to replace.
  5. Modify the lookup data as needed in the new lookup record.

    6. Note: Changes are not recommended to any columns except the Data Source and Default Columns. Changes to other columns could cause the lookup to not function properly.

  6. Save the record by clicking the Save button on the toolbar.

You must use this method to modify or create a new lookup to prevent your changes from being overwritten by the maintenance server update.

The column definitions are:

Column Name Definition
ID The number assigned to the field within that Lookup ID.
Description The actual column heading name in the results section of the Search screen appears in the Description.
Data Source The SQL query that the system uses to retrieve the data for this lookup ID.
Key Column Defines the leading column in the lookup display, independent of user input or changes.
Default Names of the columns that you want displayed by default, independent of user input or changes.
Enumerated Provides an alternative description of the numeric values stored in a table. For example, Traverse stores the inventory item status as 1, 2, 3 or 4. You may want to view these values as Active, Discontinued, Superseded, and Obsolete.
Formats Use to format information that appears in the results section of the Search screen. For example, the social security format is &&&-&&&-&&&&.
Database Type

Describes the database from which that lookup's information is taken (e.g. Company, System, Payroll).
Volatile Data

Temporary, or transient data. Volatile data is put into the table, then removed.

Replace ID

The ID of the lookup to be replaced.

Use the Views Table function to view or modify the metadata used by Traverse interactive views. You also have the option of creating additional interactive views.

Modify Views

Note: Do not modify these fields unless you have knowledge of database design and administration. If you have any questions about data structures in Traverse, please contact your Traverse software provider for assistance.

To add or modify a view, follow these steps:

  1. Select an existing view you wish to modify.
  2. Copy the view record, then paste it, thus making a duplicate of the original record.
  3. Change the ID column for the new record you just pasted.
  4. Update the Replace ID field of the record you just pasted with the ID of the view record you want to replace.
  5. Modify the view data as needed in the new view record.

    6. Note: Changes are not recommended to any columns except the Data Source and Default Columns. Changes to other columns could cause the view to not function properly.

  6. Save the record by clicking the Save button on the toolbar.

You must use this method to modify or create a new view to prevent your changes from being overwritten by the maintenance server update.

The column definitions are:

Column Name Definition
ID The number assigned to the field within that View ID.
Description The actual column heading name in the results section of the Search screen appears in the Description.
Data Source The SQL query that the system uses to retrieve the data for this view ID.
Available A list of field available for the view.
Default Names of the columns that you want displayed by default, independent of user input or changes.
Enumerated Provides an alternative description of the numeric values stored in a table. For example, Traverse stores the inventory item status as 1, 2, 3 or 4. You may want to view these values as Active, Discontinued, Superseded, and Obsolete.
Formats Use to format information that appears in the results section of the Search screen. For example, the social security format is &&&-&&&-&&&&.
Replace ID

The ID of the view to be replaced.

Use the Business Rules function to view, edit, or add business rules to Traverse.

Use the Search Catalog function to edit existing search catalogs, or create new ones.

Modify Catalog

Note: Do not modify these fields unless you have knowledge of database design and administration. If you have any questions about data structures in Traverse, please contact your Traverse software provider for assistance.

  1. Select an existing catalog you wish to modify.
  2. Copy the catalog record, then paste it, thus making a duplicate of the original record.
  3. Change the ID column for the new record you just pasted.

    4. Note: If you cannot see the ID column, open the Column Chooser and add the ID column to the grid.

  4. Update the Replace ID field of the record you just pasted with the ID of the catalog record you want to replace.
  5. Modify the catalog data as needed in the new catalog record.
  6. Save your changes by clicking the Save button on the toolbar.

The column definitions are:

Column Name Definition
ID The number assigned to the catalog.
Description The description for the catalog that appears in the Catalogs tab of the Manage Catalog function.
Catalog Type The application for which the catalog is set up.
Data Source The SQL query that the system uses to retrieve the data for this search catalog.
Drill Through The application menu ID for the view that opens when you double-click on the search results.
Replace ID The ID of the catalog to be replaced.
Last Value Field  

Use the Sys Tables/Columns function if you want to add a new table or new column to a table.

Note: Do not modify these tables/columns unless you have knowledge of database design and administration. If you have any questions about data structures in Traverse, please contact your Traverse software provider for assistance.

To add a table

  1. Open the System Menu function in the System Data menu of Traverse Design Studio.
  2. Select a Location Type for the table you want to add:
    • CompanyDb -- each company has its own database
    • SysDb -- the system database is accessible across all companies
    • PayrollYearDb -- every year the payroll database is recreated for the new year.
  3. Select the New button on the toolbar to add a blank table record.

  4. The system will generate a Table ID.
  5. Enter the Application Id that will utilize the table
  6. The Location of the table cannot be changed.
  7. Enter a Table Name for the new table. Follow the naming protocol of the other tables.
  8. Enter a Description for the new table to help you identify its use.
  9. Use the Scale and DepOrder (depreciation order) fields as necessary.
  10. If you have validation criteria for the table, such as Status = 0, enter the Validate Criteria in parenthesis (i.e. (Status = 0) ). Records will have to meet this criteria before being added to the table.
  11. Add any Notes that will help identify the table, or offer information about the table, such as if the table is moved or will be used in the future.
  12. If the table is Obsolete, mark the check box.
  13. If the table will be used in the Future, mark the check box.
  14. Save your changes.

Add columns to a new table:

  1. Open the Sys Column screen by clicking on the ellipsis button in the Table Id column for the new table.

  2. Click the New button on the toolbar.
  3. Enter a Column Name.
  4. Enter a Description for the column.
  5. If the column is linked to an ID column or unique identifier in another table, select that column in the Key Column Id drop-down list.
  6. Enter a Key Group as necessary.
  7. If a record must meet certain criteria for the column before it is added to the table, enter the Criteria.
  8. Enter any Notes for the column.
  9. Mark check box(es) as applicable:
    • Primary Key
    • Allow Nulls
    • Skip Change Id
    • Skip Validation
    • Skip Deletion
    • Obsolete
    • Future
  10. Repeat steps 2 through 9 as needed.
  11. When you are finished adding columns, close Sys Columns screen.
  12. Save your changes.

Add columns to an existing table:

  1. Open the Sys Column screen by clicking on the ellipsis button in the Table Id column for the table to which you want to add a column.

  2. Click the New button on the toolbar.
  3. Enter a Column Name.
  4. Enter a Description for the column.
  5. If the column is linked to an ID column or unique identifier in another table, select that column in the Key Column Id drop-down list.

  6. Enter a Key Group as necessary.
  7. If a record must meet certain criteria for the column before it is added to the table, enter the Criteria.
  8. Enter any Notes for the column.
  9. Mark check box(es) as applicable:
    • Primary Key
    • Allow Nulls
    • Skip Change Id
    • Skip Validation
    • Skip Deletion
    • Obsolete
    • Future
  10. Repeat steps 2 through 9 as needed.
  11. When you are finished adding columns, close Sys Columns screen.
  12. Save your changes.

Deleting columns or tables

You can only delete tables or columns that are empty, or are not linked to any other tables. If the data in the table is also used in other tables, the system won't allow you to delete it.

To delete a column or table, select the column or table and click the Delete button on the toolbar. Click OK on the confirmation window.

Use the System Menu function to edit or add new items to the Traverse menu. This allows you to rename menu items, or add items to a menu.

Add a menu item

  1. Open the System Menu function in the System Data menu of Traverse Design Studio.
  2. A menu tree like the menu tree in the SM Setup and Maintenance Application Menus screen opens. To add a menu option, select the branch of the Application Menus tree in which you want to add the menu option.
  3. Select the New button on the toolbar to add a blank record.

  4. Enter a Description of the menu item. This is the description that will appear in the Traverse menu.
  5. The Type of entry should be 'Form'.
  6. Enter a Menu ID for the new record. The Menu ID must be a unique number.
  7. Enter the name of the assembly that is called by the menu option in the Assembly Name field.
  8. Enter the Plugin Name the menu option calls.
  9. Enter a sequence number in the Order column. The sequence number determines where the new menu option will appear on the menu.
  10. Select whether the new menu item is a 'Company', 'Payroll', or 'System' Menu Type.
  11. Enter any Parameters for the menu item.
  12. Save your changes.

In order for the new menu item to be visible on the Traverse menu, you must add permissions to the group(s) that will access it.

Note: Make sure you are logged into the same company as Design Studio.

  1. Open the SM Administration Groups function.
  2. Select the name of the group to which you want to give permission for the new menu option from the Group Name drop-down list.
  3. Select the Permissions button to open the menu tree and open the branch in which you added the new menu option.
  4. Mark the check box for the menu option you added, then click the Apply button.
  5. Click the OK button.
  6. Log out of Traverse and log back in as a member of a group with permission to the added menu option. The new menu option will appear on the menu.

Edit menu item

  • A menu tree like the menu tree in the SM Setup and Maintenance Application Menus screen opens.
    1. Open the System Menu function in the System Data menu of Traverse Design Studio.
    2. Select a menu item and edit as necessary.
    3. Save your changes.
    4. Log out of Traverse and log back in. The edited menu option will appear on the menu.

    Delete menu item

    1. Open the System Menu function in the System Data menu of Traverse Design Studio.
    2. A menu tree like the menu tree in the SM Setup and Maintenance Application Menus screen opens.
    3. Select a menu item and delete. Click OK in the confirmation window that appears.
    4. Save your changes.
    5. Log out of Traverse and log back in. The menu item will no longer appear.

    Use the Custom Menu function to configure company-specific menu options.

    Note: Changes made will not affect individual workstation Favorites.

    In Design Studio, selecting Custom Menu under System Data will by default display any custom menu settings configured for all companies regardless of the company you are logged into. If you want to make a change to a specific company, click the button in the upper right to take you to the Company settings for the company you are logged into. Changes made to the company specifically will supersede any changes made at the system level.

    Modify menu for all companies

    To change the AR Customers menu description from 'Customers' to 'Clients' for all companies:

    1. Open the Custom Menu function in the System Data menu of Traverse Design Studio.
    2. The initial screen that displays will show any custom menu settings for all companies. You can determine this by noting the label on the button in the upper right corner of the screen says 'Company'. This indicates that you are currently viewing the 'System' custom menu settings.
    3. Enter the Menu ID for the AR Customers menu.
    4. Enter a Description, or menu label, for the menu item.
    5. Enter the Plugin Name (from the System Menu screen) for the menu option.
    6. Enter the Assembly Name (from the System Menu screen) for the menu option.
    7. Click the Save button.

    Log into Traverse and navigate to the AR Setup and Maintenance menu, you will notice the 'Customers' function now reads 'Clients'. You can change companies to verify the change is reflected in all companies.

    Modify menu for a single company

    To change the AR Customers menu description from 'Customers' to 'Not for Profit Clients' for a selected company:

    1. Open the Custom Menu function in the System Data menu of Traverse Design Studio.
    2. Select the company for which you want to change the menu description from the File menu in the menu bar.

    3. Click the button in the upper right corner of the screen so it says 'System'. This indicates that you are currently viewing the 'Company' custom menu settings.
    4. Enter the Menu ID for the AR Customers menu.
    5. Enter a Description, or menu label, for the menu item.
    6. Enter the Plugin Name (from the System Menu screen) for the menu option.
    7. Enter the Assembly Name (from the System Menu screen) for the menu option.
    8. Click the Save button.

    Log into Traverse and into the company for which you set the custom menu to read 'Not for Profit Clients', and navigate to the AR Setup and Maintenance menu, you will notice the 'Customers' function now reads 'Not for Profit Clients'. You can change companies to verify the change is only reflected in the selected company.

    To return to the original menu label (Customers), select the custom menu setting and use the Delete button on the toolbar to clear the custom menu setting.

    Custom Layout

    Use the Custom Layout function to assign a screen with a customized layout to specific users. In order to assign a screen with this function, you first open the screen with the Screen Layout function and save the screen to the database.

    Note: If a customized layout is saved to database and not assigned to specific users with the Custom Layout function, the customized screen will be available to all users with access to that screen.

    Assign a custom layout to a user

    1. Open the Custom Layout function in the System Data menu of Traverse Design Studio.
    2. A list of screens that can be assigned opens, along with the users assigned those screens. If you want to add a screen that isn't listed, select a screen to edit from the Screen Layout function and save that customized screen to database.

    3. Highlight the screen you want to assign and click Assign To. The Assign Custom Layout dialog box opens.

    4. Enter the user IDs you want this custom screen to be assigned to in the User ID(s) field. Separate multiple user IDs with commas. When finished, click OK.
    5. The Custom Layout screen shows the users assigned to the screen layout. Those users see the customized screen when they use the assigned function.

    Copy custom layout settings from another company

    You can use the Copy From function on the Custom Layout screen to copy Custom Layout settings from another company.

    1. Click Copy From in the Custom Layout function. The Copy Custom Layout dialog box opens.

    2. Select the Company from which you want to copy the custom layout settings. The screen populates with the custom screen descriptions and the user IDs assigned to them.
    3. Check the boxes of the custom layout assignments that you want to import in the currently open company. Click Select All to check all of the assignments, and click Unselect All to clear all of the check boxes.
    4. Click OK to import the selected custom layout assignments into the currently open company. The newly imported information reflects in the Custom Layout screen, and you can use the screen to further add or delete custom field assignments.

    Back to top