[Index]

Model: data/MenuLayout

Menu Layouts

Note

To work on an existing menu layout, we recommend that you clone the menu layout and work on the clone.

  1. Log in as hcsadmin, provider or reseller administrator.

  2. Choose the hierarchy for the menu layout.

  3. Choose Role Management > Menu Layouts.

  4. Click Add to open the Menu Layouts input form.

  5. Enter a Name and a Description for the menu layout.

  6. Add (by clicking + next to Menu Items), and optionally nest Menu Items for each required menu item:

    1. Choose an Icon name from the dropdown to be displayed on the GUI menu. To see the icons, refer to Business Admin Portal Interface Custom Icon Names Reference.

    2. Enter a Title.

    3. For a list view of a model, select from the Type drop-down list and choose List as the Display as value. For the selected model type, choose a default Field Display Policy and Configuration Template. If a User Role is associated with the menu layout, then users with this role see the model type according to these.

      If List is chosen as the Display As type, then the resulting list can also be filtered. See Configurable Filters in Menus and Landing Pages.

    4. Href is generally used for external links. It can however be used for links within the application to link directly to a form. For example, the Add Phone form would have the HREF value of api/relation/SubscriberPhone/add. In such cases, any associated Field Display Policies and Configuration Templates for the menu item can only be added by using a menu import in JSON format or on a bulk load sheet.

      Note that view/ type models should not be referenced as Href - only from the Type drop down. The view/ model types always open the "Add" form - without having to use the href with /add/.

      If Href is used, choose the Display as format of the item as follows:

      • Form - Show an input form. The Href value points to a model instance with the pkid, for example data/Countries/5331a739d0278d7893e26d2e, or ends with "/add/".

      • IFrame - A URL specified as the Href value opens as an IFrame for cross-launching.

      • External Link - A URL specified as the Href value opens as a new browser tab.

        Note: pop-up blocking should be disabled on user browsers for the external link to resolve.

      • Tree - If available, a tree view of resource to display. Href provides the tree path.

      • List - List view of a resource referenced by Type or Href. A tool (tool/[toolname]) can also be presented as a list, for example

        /api/tool/Transaction/?entity=data/Event&operation=execute

      • Wizard - Execute a wizard referenced by Href (wizard resource ends with "/0/"). For example:

        /api/wizard/AddressWizard/0/

    5. Arrange the desired order of the menu items by clicking the up or down arrow to move the menu items up or down respectively.

  7. Click Save on the button bar when complete to create the menu layout.

To modify an existing menu layout, click the relevant menu layout name from the Menu Layouts list view and edit the appropriate fields as described above. Click Save when complete.

Updates in the menu layout are available for the user only when logging in again.

When complete, assign the menu layout to the appropriate roles.

While default menu layouts are available for a user and an administrator user, a menu layout can be created from the GUI and can then be associated with a User Role. Users that have been assigned to this role will be able to use the created menu layout.

Model Details

Title Description Details
Name * The name that is given to the Menu Layout.
  • Field Name: name
  • Type: String
Description A description of the Menu Layout.
  • Field Name: description
  • Type: String
Menu Items The list of menu items and -sub items that belong to the Menu Layout.
  • Field Name: menu_items.[n]
  • Type: Array
Icon The icon to be used for this menu entry.
  • Field Name: menu_items.[n].icon
  • Type: String
  • Choices: ["3D Rotation", "Ac Unit", "Access Alarm", "Access Alarms", "Access Time", "Accessibility", "Accessible", "Account Balance", "Account Balance Wallet", "Account Box", "Account Circle", "Add", "Add A Photo", "Add Alarm", "Add Alert", "Add Box", "Add Circle", "Add Circle Outline", "Add Location", "Add Shopping Cart", "Add To Photos", "Add To Queue", "Adjust", "Airline Seat Flat", "Airline Seat Flat Angled", "Airline Seat Individual Suite", "Airline Seat Legroom Extra", "Airline Seat Legroom Normal", "Airline Seat Legroom Reduced", "Airline Seat Recline Extra", "Airline Seat Recline Normal", "Airplanemode Active", "Airplanemode Inactive", "Airplay", "Airport Shuttle", "Alarm", "Alarm Add", "Alarm Off", "Alarm On", "Album", "All Inclusive", "All Out", "Android", "Announcement", "Apps", "Archive", "Arrow Back", "Arrow Downward", "Arrow Drop Down", "Arrow Drop Down Circle", "Arrow Drop Up", "Arrow Forward", "Arrow Upward", "Art Track", "Aspect Ratio", "Assessment", "Assignment", "Assignment Ind", "Assignment Late", "Assignment Return", "Assignment Returned", "Assignment Turned In", "Assistant", "Assistant Photo", "Attach File", "Attach Money", "Attachment", "Audiotrack", "Autorenew", "Av Timer", "Backspace", "Backup", "Battery Alert", "Battery Charging Full", "Battery Full", "Battery Std", "Battery Unknown", "Beach Access", "Beenhere", "Block", "Bluetooth", "Bluetooth Audio", "Bluetooth Connected", "Bluetooth Disabled", "Bluetooth Searching", "Blur Circular", "Blur Linear", "Blur Off", "Blur On", "Book", "Bookmark", "Bookmark Border", "Border All", "Border Bottom", "Border Clear", "Border Color", "Border Horizontal", "Border Inner", "Border Left", "Border Outer", "Border Right", "Border Style", "Border Top", "Border Vertical", "Branding Watermark", "Brightness 1", "Brightness 2", "Brightness 3", "Brightness 4", "Brightness 5", "Brightness 6", "Brightness 7", "Brightness Auto", "Brightness High", "Brightness Low", "Brightness Medium", "Broken Image", "Brush", "Bubble Chart", "Bug Report", "Build", "Burst Mode", "Business", "Business Center", "Cached", "Cake", "Call", "Call End", "Call Made", "Call Merge", "Call Missed", "Call Missed Outgoing", "Call Received", "Call Split", "Call To Action", "Camera", "Camera Alt", "Camera Enhance", "Camera Front", "Camera Rear", "Camera Roll", "Cancel", "Card Giftcard", "Card Membership", "Card Travel", "Casino", "Cast", "Cast Connected", "Center Focus Strong", "Center Focus Weak", "Change History", "Chat", "Chat Bubble", "Chat Bubble Outline", "Check", "Check Box", "Check Box Outline Blank", "Check Circle", "Chevron Left", "Chevron Right", "Child Care", "Child Friendly", "Chrome Reader Mode", "Class", "Clear", "Clear All", "Close", "Closed Caption", "Cloud", "Cloud Circle", "Cloud Done", "Cloud Download", "Cloud Off", "Cloud Queue", "Cloud Upload", "Code", "Collections", "Collections Bookmark", "Color Lens", "Colorize", "Comment", "Compare", "Compare Arrows", "Computer", "Confirmation Number", "Contact Mail", "Contact Phone", "Contacts", "Content Copy", "Content Cut", "Content Paste", "Control Point", "Control Point Duplicate", "Copyright", "Create", "Create New Folder", "Credit Card", "Crop", "Crop 16 9", "Crop 3 2", "Crop 5 4", "Crop 7 5", "Crop Din", "Crop Free", "Crop Landscape", "Crop Original", "Crop Portrait", "Crop Rotate", "Crop Square", "Dashboard", "Data Usage", "Date Range", "Dehaze", "Delete", "Delete Forever", "Delete Sweep", "Description", "Desktop Mac", "Desktop Windows", "Details", "Developer Board", "Developer Mode", "Device Hub", "Devices", "Devices Other", "Dialer Sip", "Dialpad", "Directions", "Directions Bike", "Directions Boat", "Directions Bus", "Directions Car", "Directions Railway", "Directions Run", "Directions Subway", "Directions Transit", "Directions Walk", "Disc Full", "Dns", "Do Not Disturb", "Do Not Disturb Alt", "Do Not Disturb Off", "Do Not Disturb On", "Dock", "Domain", "Done", "Done All", "Donut Large", "Donut Small", "Drafts", "Drag Handle", "Drive Eta", "Dvr", "Edit", "Edit Location", "Eject", "Email", "Enhanced Encryption", "Equalizer", "Error", "Error Outline", "Euro Symbol", "Ev Station", "Event", "Event Available", "Event Busy", "Event Note", "Event Seat", "Exit To App", "Expand Less", "Expand More", "Explicit", "Explore", "Exposure", "Exposure Neg 1", "Exposure Neg 2", "Exposure Plus 1", "Exposure Plus 2", "Exposure Zero", "Extension", "Face", "Fast Forward", "Fast Rewind", "Favorite", "Favorite Border", "Featured Play List", "Featured Video", "Feedback", "Fiber Dvr", "Fiber Manual Record", "Fiber New", "Fiber Pin", "Fiber Smart Record", "File Download", "File Upload", "Filter", "Filter 1", "Filter 2", "Filter 3", "Filter 4", "Filter 5", "Filter 6", "Filter 7", "Filter 8", "Filter 9", "Filter 9 Plus", "Filter B And W", "Filter Center Focus", "Filter Drama", "Filter Frames", "Filter Hdr", "Filter List", "Filter None", "Filter Tilt Shift", "Filter Vintage", "Find In Page", "Find Replace", "Fingerprint", "First Page", "Fitness Center", "Flag", "Flare", "Flash Auto", "Flash Off", "Flash On", "Flight", "Flight Land", "Flight Takeoff", "Flip", "Flip To Back", "Flip To Front", "Folder", "Folder Open", "Folder Shared", "Folder Special", "Font Download", "Format Align Center", "Format Align Justify", "Format Align Left", "Format Align Right", "Format Bold", "Format Clear", "Format Color Fill", "Format Color Reset", "Format Color Text", "Format Indent Decrease", "Format Indent Increase", "Format Italic", "Format Line Spacing", "Format List Bulleted", "Format List Numbered", "Format Paint", "Format Quote", "Format Shapes", "Format Size", "Format Strikethrough", "Format Textdirection L To R", "Format Textdirection R To L", "Format Underlined", "Forum", "Forward", "Forward 10", "Forward 30", "Forward 5", "Free Breakfast", "Fullscreen", "Fullscreen Exit", "Functions", "G Translate", "Gamepad", "Games", "Gavel", "Gesture", "Get App", "Gif", "Golf Course", "Gps Fixed", "Gps Not Fixed", "Gps Off", "Grade", "Gradient", "Grain", "Graphic Eq", "Grid Off", "Grid On", "Group", "Group Add", "Group Work", "Hd", "Hdr Off", "Hdr On", "Hdr Strong", "Hdr Weak", "Headset", "Headset Mic", "Healing", "Hearing", "Help", "Help Outline", "High Quality", "Highlight", "Highlight Off", "History", "Home", "Hot Tub", "Hotel", "Hourglass Empty", "Hourglass Full", "Http", "Https", "Image", "Image Aspect Ratio", "Import Contacts", "Import Export", "Important Devices", "Inbox", "Indeterminate Check Box", "Info", "Info Outline", "Input", "Insert Chart", "Insert Comment", "Insert Drive File", "Insert Emoticon", "Insert Invitation", "Insert Link", "Insert Photo", "Invert Colors", "Invert Colors Off", "Iso", "Keyboard", "Keyboard Arrow Down", "Keyboard Arrow Left", "Keyboard Arrow Right", "Keyboard Arrow Up", "Keyboard Backspace", "Keyboard Capslock", "Keyboard Hide", "Keyboard Return", "Keyboard Tab", "Keyboard Voice", "Kitchen", "Label", "Label Outline", "Landscape", "Language", "Laptop", "Laptop Chromebook", "Laptop Mac", "Laptop Windows", "Last Page", "Launch", "Layers", "Layers Clear", "Leak Add", "Leak Remove", "Lens", "Library Add", "Library Books", "Library Music", "Lightbulb Outline", "Line Style", "Line Weight", "Linear Scale", "Link", "Linked Camera", "List", "Live Help", "Live Tv", "Local Activity", "Local Airport", "Local Atm", "Local Bar", "Local Cafe", "Local Car Wash", "Local Convenience Store", "Local Dining", "Local Drink", "Local Florist", "Local Gas Station", "Local Grocery Store", "Local Hospital", "Local Hotel", "Local Laundry Service", "Local Library", "Local Mall", "Local Movies", "Local Offer", "Local Parking", "Local Pharmacy", "Local Phone", "Local Pizza", "Local Play", "Local Post Office", "Local Printshop", "Local See", "Local Shipping", "Local Taxi", "Location City", "Location Disabled", "Location Off", "Location On", "Location Searching", "Lock", "Lock Open", "Lock Outline", "Looks", "Looks 3", "Looks 4", "Looks 5", "Looks 6", "Looks One", "Looks Two", "Loop", "Loupe", "Low Priority", "Loyalty", "Mail", "Mail Outline", "Map", "Markunread", "Markunread Mailbox", "Memory", "Menu", "Merge Type", "Message", "Mic", "Mic None", "Mic Off", "Mms", "Mode Comment", "Mode Edit", "Monetization On", "Money Off", "Monochrome Photos", "Mood", "Mood Bad", "More", "More Horiz", "More Vert", "Motorcycle", "Mouse", "Move To Inbox", "Movie", "Movie Creation", "Movie Filter", "Multiline Chart", "Music Note", "Music Video", "My Location", "Nature", "Nature People", "Navigate Before", "Navigate Next", "Navigation", "Near Me", "Network Cell", "Network Check", "Network Locked", "Network Wifi", "New Releases", "Next Week", "Nfc", "No Encryption", "No Sim", "Not Interested", "Note", "Note Add", "Notifications", "Notifications Active", "Notifications None", "Notifications Off", "Notifications Paused", "Offline Pin", "Ondemand Video", "Opacity", "Open In Browser", "Open In New", "Open With", "Pages", "Pageview", "Palette", "Pan Tool", "Panorama", "Panorama Fish Eye", "Panorama Horizontal", "Panorama Vertical", "Panorama Wide Angle", "Party Mode", "Pause", "Pause Circle Filled", "Pause Circle Outline", "Payment", "People", "People Outline", "Perm Camera Mic", "Perm Contact Calendar", "Perm Data Setting", "Perm Device Information", "Perm Identity", "Perm Media", "Perm Phone Msg", "Perm Scan Wifi", "Person", "Person Add", "Person Outline", "Person Pin", "Person Pin Circle", "Personal Video", "Pets", "Phone", "Phone Android", "Phone Bluetooth Speaker", "Phone Forwarded", "Phone In Talk", "Phone Iphone", "Phone Locked", "Phone Missed", "Phone Paused", "Phonelink", "Phonelink Erase", "Phonelink Lock", "Phonelink Off", "Phonelink Ring", "Phonelink Setup", "Photo", "Photo Album", "Photo Camera", "Photo Filter", "Photo Library", "Photo Size Select Actual", "Photo Size Select Large", "Photo Size Select Small", "Picture As Pdf", "Picture In Picture", "Picture In Picture Alt", "Pie Chart", "Pie Chart Outlined", "Pin Drop", "Place", "Play Arrow", "Play Circle Filled", "Play Circle Outline", "Play For Work", "Playlist Add", "Playlist Add Check", "Playlist Play", "Plus One", "Poll", "Polymer", "Pool", "Portable Wifi Off", "Portrait", "Power", "Power Input", "Power Settings New", "Pregnant Woman", "Present To All", "Print", "Priority High", "Public", "Publish", "Query Builder", "Question Answer", "Queue", "Queue Music", "Queue Play Next", "Radio", "Radio Button Checked", "Radio Button Unchecked", "Rate Review", "Receipt", "Recent Actors", "Record Voice Over", "Redeem", "Redo", "Refresh", "Remove", "Remove Circle", "Remove Circle Outline", "Remove From Queue", "Remove Red Eye", "Remove Shopping Cart", "Reorder", "Repeat", "Repeat One", "Replay", "Replay 10", "Replay 30", "Replay 5", "Reply", "Reply All", "Report", "Report Problem", "Restaurant", "Restaurant Menu", "Restore", "Restore Page", "Ring Volume", "Room", "Room Service", "Rotate 90 Degrees Ccw", "Rotate Left", "Rotate Right", "Rounded Corner", "Router", "Rowing", "Rss Feed", "Rv Hookup", "Satellite", "Save", "Scanner", "Schedule", "School", "Screen Lock Landscape", "Screen Lock Portrait", "Screen Lock Rotation", "Screen Rotation", "Screen Share", "Sd Card", "Sd Storage", "Search", "Security", "Select All", "Send", "Sentiment Dissatisfied", "Sentiment Neutral", "Sentiment Satisfied", "Sentiment Very Dissatisfied", "Sentiment Very Satisfied", "Settings", "Settings Applications", "Settings Backup Restore", "Settings Bluetooth", "Settings Brightness", "Settings Cell", "Settings Ethernet", "Settings Input Antenna", "Settings Input Component", "Settings Input Composite", "Settings Input Hdmi", "Settings Input Svideo", "Settings Overscan", "Settings Phone", "Settings Power", "Settings Remote", "Settings System Daydream", "Settings Voice", "Share", "Shop", "Shop Two", "Shopping Basket", "Shopping Cart", "Short Text", "Show Chart", "Shuffle", "Signal Cellular 4 Bar", "Signal Cellular Connected No Internet 4 Bar", "Signal Cellular No Sim", "Signal Cellular Null", "Signal Cellular Off", "Signal Wifi 4 Bar", "Signal Wifi 4 Bar Lock", "Signal Wifi Off", "Sim Card", "Sim Card Alert", "Skip Next", "Skip Previous", "Slideshow", "Slow Motion Video", "Smartphone", "Smoke Free", "Smoking Rooms", "Sms", "Sms Failed", "Snooze", "Sort", "Sort By Alpha", "Spa", "Space Bar", "Speaker", "Speaker Group", "Speaker Notes", "Speaker Notes Off", "Speaker Phone", "Spellcheck", "Star", "Star Border", "Star Half", "Stars", "Stay Current Landscape", "Stay Current Portrait", "Stay Primary Landscape", "Stay Primary Portrait", "Stop", "Stop Screen Share", "Storage", "Store", "Store Mall Directory", "Straighten", "Streetview", "Strikethrough S", "Style", "Subdirectory Arrow Left", "Subdirectory Arrow Right", "Subject", "Subscriptions", "Subtitles", "Subway", "Supervisor Account", "Surround Sound", "Swap Calls", "Swap Horiz", "Swap Vert", "Swap Vertical Circle", "Switch Camera", "Switch Video", "Sync", "Sync Disabled", "Sync Problem", "System Update", "System Update Alt", "Tab", "Tab Unselected", "Tablet", "Tablet Android", "Tablet Mac", "Tag Faces", "Tap And Play", "Terrain", "Text Fields", "Text Format", "Textsms", "Texture", "Theaters", "Thumb Down", "Thumb Up", "Thumbs Up Down", "Time To Leave", "Timelapse", "Timeline", "Timer", "Timer 10", "Timer 3", "Timer Off", "Title", "Toc", "Today", "Toll", "Tonality", "Touch App", "Toys", "Track Changes", "Traffic", "Train", "Tram", "Transfer Within A Station", "Transform", "Translate", "Trending Down", "Trending Flat", "Trending Up", "Tune", "Turned In", "Turned In Not", "Tv", "Unarchive", "Undo", "Unfold Less", "Unfold More", "Update", "Usb", "Verified User", "Vertical Align Bottom", "Vertical Align Center", "Vertical Align Top", "Vibration", "Video Call", "Video Label", "Video Library", "Videocam", "Videocam Off", "Videogame Asset", "View Agenda", "View Array", "View Carousel", "View Column", "View Comfy", "View Compact", "View Day", "View Headline", "View List", "View Module", "View Quilt", "View Stream", "View Week", "Vignette", "Visibility", "Visibility Off", "Voice Chat", "Voicemail", "Volume Down", "Volume Mute", "Volume Off", "Volume Up", "Vpn Key", "Vpn Lock", "Wallpaper", "Warning", "Watch", "Watch Later", "Wb Auto", "Wb Cloudy", "Wb Incandescent", "Wb Iridescent", "Wb Sunny", "Wc", "Web", "Web Asset", "Weekend", "Whatshot", "Widgets", "Wifi", "Wifi Lock", "Wifi Tethering", "Work", "Wrap Text", "Youtube Searched For", "Zoom In", "Zoom Out"]
Title The menu item title as it will show on the menu.
  • Field Name: menu_items.[n].title
  • Type: String
Type The selected model type from the Type drop-down list to associate with the Title.
  • Field Name: menu_items.[n].type
  • Type: String
  • Format: uri
Href If a direct reference to a model type is used for the menu item, the specified path.
  • Field Name: menu_items.[n].href
  • Type: String
Field Display Policy The selected Field Display Policy that is associated with the Menu Item.
  • Field Name: menu_items.[n].field_display_policy
  • Type: String
  • Target: data/FieldDisplayPolicy
  • Target attr: name
  • Format: uri
Configuration Template The selected Configuration Template that is associated with the Menu Item.
  • Field Name: menu_items.[n].configuration_template
  • Type: String
  • Target: data/ConfigurationTemplate
  • Target attr: name
  • Format: uri
Display As Select the display format of the model types of the menu item. The format can be a Form for a single instance, or a List for more than one instance. Default: list
  • Field Name: menu_items.[n].display
  • Type: String
  • Default: list
  • Choices: ["Form", "List", "Wizard", "Iframe", "External Link"]
Fixed Filters Filters that can't be removed by end user. Applicable to display as = 'list'
  • Field Name: filter_options.[n]
  • Type: Array
Filter By
  • Field Name: menu_items.[n].filter_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: menu_items.[n].filter_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: menu_items.[n].filter_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: menu_items.[n].filter_options.[n].ignore_case
  • Type: Boolean
Configurable Filters Filters suggested to end users and my be cleared. Applicable to display as = 'list'
  • Field Name: configurable_options.[n]
  • Type: Array
Filter By
  • Field Name: menu_items.[n].configurable_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: menu_items.[n].configurable_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: menu_items.[n].configurable_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: menu_items.[n].configurable_options.[n].ignore_case
  • Type: Boolean
Menu Items The list of nested menu items that belong to the Menu Layout.
  • Field Name: menu_items.[n]
  • Type: Array
Title The nested menu item title as it will show on the menu.
  • Field Name: menu_items.[n].menu_items.[n].title
  • Type: String
Type The selected model type from the Type drop-down list to associate with the Title.
  • Field Name: menu_items.[n].menu_items.[n].type
  • Type: String
  • Format: uri
Href If a direct reference to a model type is used for the menu item, the specified path.
  • Field Name: menu_items.[n].menu_items.[n].href
  • Type: String
Field Display Policy The selected Field Display Policy that is associated with the Menu Item.
  • Field Name: menu_items.[n].menu_items.[n].field_display_policy
  • Type: String
  • Target: data/FieldDisplayPolicy
  • Target attr: name
  • Format: uri
Configuration Template The selected Configuration Template that is associated with the Menu Item.
  • Field Name: menu_items.[n].menu_items.[n].configuration_template
  • Type: String
  • Target: data/ConfigurationTemplate
  • Target attr: name
  • Format: uri
Display As Select the display format of the model types of the menu item. The format can be a Form for a single instance, or a List for more than one instance. Default: list
  • Field Name: menu_items.[n].menu_items.[n].display
  • Type: String
  • Default: list
  • Choices: ["Form", "List", "Wizard", "Iframe", "External Link"]
Fixed Filters Filters that can't be removed by end user. Applicable to display as = 'list'
  • Field Name: filter_options.[n]
  • Type: Array
Filter By
  • Field Name: menu_items.[n].menu_items.[n].filter_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: menu_items.[n].menu_items.[n].filter_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: menu_items.[n].menu_items.[n].filter_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: menu_items.[n].menu_items.[n].filter_options.[n].ignore_case
  • Type: Boolean
Configurable Filters Filters suggested to end users and my be cleared. Applicable to display as = 'list'
  • Field Name: configurable_options.[n]
  • Type: Array
Filter By
  • Field Name: menu_items.[n].menu_items.[n].configurable_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: menu_items.[n].menu_items.[n].configurable_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: menu_items.[n].menu_items.[n].configurable_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: menu_items.[n].menu_items.[n].configurable_options.[n].ignore_case
  • Type: Boolean
Menu Items The list of nested menu items that belong to the Menu Layout.
  • Field Name: menu_items.[n]
  • Type: Array
Title The nested menu item title as it will show on the menu.
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].title
  • Type: String
Type The selected model type from the Type drop-down list to associate with the Title.
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].type
  • Type: String
  • Format: uri
Href If a direct reference to a model type is used for the menu item, the specified path.
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].href
  • Type: String
Field Display Policy The selected Field Display Policy that is associated with the Menu Item.
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].field_display_policy
  • Type: String
  • Target: data/FieldDisplayPolicy
  • Target attr: name
  • Format: uri
Configuration Template The selected Configuration Template that is associated with the Menu Item.
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].configuration_template
  • Type: String
  • Target: data/ConfigurationTemplate
  • Target attr: name
  • Format: uri
Display As Select the display format of the model types of the menu item. The format can be a Form for a single instance, or a List for more than one instance. Default: list
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].display
  • Type: String
  • Default: list
  • Choices: ["Form", "List", "Wizard", "Iframe", "External Link"]
Fixed Filters Filters that can't be removed by end user. Applicable to display as = 'list'
  • Field Name: filter_options.[n]
  • Type: Array
Filter By
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].filter_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].filter_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].filter_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].filter_options.[n].ignore_case
  • Type: Boolean
Configurable Filters Filters suggested to end users and my be cleared. Applicable to display as = 'list'
  • Field Name: configurable_options.[n]
  • Type: Array
Filter By
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].configurable_options.[n].filter_by
  • Type: String
Filter Type
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].configurable_options.[n].filter_type
  • Type: String
  • Choices: ["Contains", "Does Not Contain", "Starts With", "Ends With", "Equals", "Not Equal"]
Filter String
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].configurable_options.[n].filter_string
  • Type: String
Ignore Case
  • Field Name: menu_items.[n].menu_items.[n].menu_items.[n].configurable_options.[n].ignore_case
  • Type: Boolean
API reference for data/MenuLayout