Bentley Communities
Bentley Communities
  • Site
  • User
  • Site
  • Search
  • User
  • Welcome
  • Products
  • Support
  • About
  • More
  • Cancel
CUBE
  • Product Communities
  • Mobility Simulation
  • CUBE
  • Cancel
CUBE
CUBE Wiki How to create and use catalog keys?
    • Sign In
    • Wiki
    • -CUBE
      • +Announcements
      • +CUBE CONNECT Edition
      • -Cube 6
        • +Installation
        • +Licensing for CUBE 6.1.1
        • +Licensing for CUBE 6.4.x
        • -Base
          • How to fix ESRI Basemaps not loading anymore
          • +How to build a network from shape while there is NO A&B node information and get directions from the shape file?
          • How to export a Public Transport Line File (.lin) into a Shape File and DBF files
          • How to Load Raster Layer in Cube
          • Applying the power of GIS mapping capabilities inside CUBE
          • How to Add a New Centroid and Centroid Connector to a Network Which Already Has Existing Centroids/Centroid Connectors
          • How to Control the Model Applier's Accessibility to Applications and Catalog Keys?
          • How to fix 'Control ‘ScenAppPanel’ has no parent window'
          • Aligning underlying background images with CUBE Network (.net)
          • How to add ArcGIS online background maps to a highway network layer inside GIS window?
          • How to Add Branch Control?
          • How to Add Centroids and Centroid Connectors in CUBE Networks
          • How to compare networks and create difference network bandwidths?
          • How to Create a Network from Shapefile?
          • How to Create and Run Modification Log Files
          • How to create and use catalog keys?
          • How to create Bandwidth maps
          • How to Create Node / Point Charts
          • How to Delete Catalog Keys in Text Editor?
          • How to fix the issue with empty tools ribbon in Cube Base?
          • How to import a Line Shape File (.shp) into a CUBE Voyager PT Line File (.lin)
          • How to Import/Export Network Data
          • How to Include Python in Your Cube Application Manager Workflow?
          • How to perform link attributes calculation for a polygon-based selection of links in the NET Window
          • How to Upload Your Maps to Arcgis Online Within the Application Manager Process Using Python?
          • +How to use a polygon to extract subarea networks in CUBE GIS
          • How to Use True Shape Display?
        • +Voyager
        • +Avenue
        • +Analyst
        • +Analyst Drive
        • +Land
        • +Cargo
        • +Cluster
      • CUBE Access (formerly Sugar Access)
      • +Learning CUBE

     
     Questions about this article, topic, or product? Click here. 

    How to create and use catalog keys?

    Product(s): Cube
    Version(s): 6.1 to 6.5
    Area: Other

    Catalog keys define items that vary each time an application in a catalog is run. With catalog keys, users can develop one model to achieve many tasks with different parameter values, input files and run certain process only depends on the selection criteria.

    Solution

    In this sample catalog, we will demonstrate several examples on creating different types of catalog keys and the usage of those keys in script.

    A catalog key is defined by its type (integer, character, etc.) and control type (the input method). Keys used in the sample catalogs includes character keys, integer keys and Boolean key with control type using Edit, Combo List, Combo Edit, Radio Button, and Spin Control. The figure below gives a general overview of the keys included in the sample catalog:


    The application shows how to use those keys.


    In the first Pilot program, all the key values are printed out as a text file. The intention of this is for you to understand how we can refer to those keys and retrieve their values in other programs.

    Matrix program step #2 shows how to retrieve a key value and use it in the script.
    Note #1: Matrix 0 is a special case that the program will fail. Since the key used in that program (myVal_Edit) is defined as integer with extra specification in Properties > Advanced… forcing it as string! To run it, just double click the program and check the error message in the PRN file.

    Matrix step #3 is an example to use Boolean key.
    Note #2: Boolean=1 is checked and Boolean=0 is unchecked. In the script, you should use values 1 and 0 for condition check.

    Matrix step #4 is an example to include catalog key in the input file name. The way to do this is right-click an input file, and select Link to > Link to Catalog Key… then in the pop-out dialog, specify the file name with catalog key (i.e. Input\OD_{myYear}.MAT).


    Matrix step #5 give an example to use character key.
    Note #3: listAttribute is a character key with radio button. But in the Properties > Advanced… we specify its output value to be converted to the number of the item selected from the list.

    How to use and practice this catalog?

    1. Open the catalog in Cube.

    2. Double click the Base scenario, Cube will open the window for you to edit key values. You can put in values for any of the keys here. But certain keys have a range for the input value. If an invalid value is specified, you will have a pop-out window.


    3. Keys are listed in the key panel. To check the specification of a key, just right-click and select Properties. You can also add a key here by selecting Add.


    4. You are encouraged to create different kind of types and control with extra specifications in Range, list of allowed values and Advanced.


    catKey.zip

    • Share
    • History
    • More
    • Cancel
    • Angela Jose Created by Bentley Colleague Angela Jose
    • When: Tue, Feb 14 2023 2:27 AM
    • Vu Dang Last revision by Bentley Colleague Vu Dang
    • When: Wed, Feb 15 2023 12:22 PM
    • Revisions: 2
    • Comments: 0
    Recommended
    Related
    Communities
    • Home
    • Getting Started
    • Community Central
    • Products
    • Support
    • Secure File Upload
    • Feedback
    Support and Services
    • Home
    • Product Support
    • Downloads
    • Subscription Services Portal
    Training and Learning
    • Home
    • About Bentley Institute
    • My Learning History
    • Reference Books
    Social Media
    •    LinkedIn
    •    Facebook
    •    Twitter
    •    YouTube
    •    RSS Feed
    •    Email

    © 2023 Bentley Systems, Incorporated  |  Contact Us  |  Privacy |  Terms of Use  |  Cookies