Difference between revisions of "Arcadia X - Building a Role Based Portal"

From SmartWiki
Jump to: navigation, search
(Configuring User Menu Items)
(Configuring Main Menu Items)
Line 79: Line 79:
  
 
Complete all appropriate fields:
 
Complete all appropriate fields:
* Caption - This will be the text used for the navigation link
+
* '''Caption''' - This will be the text used for the navigation link
* Description - User to store a general description of the main menu item
+
* '''Description''' - User to store a general description of the main menu item
* Display Order - Determines the order in which this navigation link will be displayed
+
* '''Display Order''' - Determines the order in which this navigation link will be displayed
* Content Type: three options:
+
* '''Content Type''': three options:
** Single Page - Creates a page using the URL provides from within the system
+
** '''Single Page''' - Creates a page using the URL provides from within the system
** Sections - Allows a page to be segmented in sections / or a grid displaying different information
+
** '''Sections''' - Allows a page to be segmented in sections / or a grid displaying different information
** Sub Tabs - Allows the addition of new dropdown menus with custom links
+
** '''Sub Tabs''' - Allows the addition of new dropdown menus with custom links
  
  

Revision as of 13:49, 11 October 2017

Building a Role-Based Portal with Arcadia

1. Click on Roles and Security in the Configuration section and then click on "User Roles". The Roles window is displayed.

NOTE: Arcadia X portals can be created for new and existing user roles.

2. Create a new role or select an existing role that will have access to the Arcadia X portal. The Edit Roles window is displayed.

3. Click “Portal” tab, select “Arcadia X” from the Style drop-down box, select appropriate Icon Size, click Save. Additional Arcadia options are displayed.

4. Add a checkmark to “Activate”, select appropriate logo, press Save.


Click on the Preview button at the bottom of the page to review the newly created Arcadia X Portal with Logo, user’s name, and logout option included in the header.


Portal Draft mode

The Portal Draft mode provides the ability to configure a draft Arcadia portal without affecting the active portal.

The user can test the draft portal and, when its ready and approved, can activate this portal so that the draft version replaces the current active portal.


1. Access the Edit Roles window for the Role the Portal is to be created against.

2. Click on the Arcadia Portal Draft Mode button along the top of the screen.

ArcadiaDraftMode.png


3. A new Draft Portal tab will appear, with a Save and Refresh button.

ArcadiaDraftMode2.png


4. Clicking Save in this tab will expose additional Arcadia options, including User Menu and Main Menu sections. These can be configured as required following the steps in the sections below.

5. Clicking Refresh in this tab will pull in the sections from the current active portal and expose the additional Arcadia options.

6. There are also buttons at the bottom of the page which function as follows:

  • Save': save draft portal and any existing sections and menus configured against it. It will not yet be activated.
  • Refresh: delete existing sections and menus found within the current draft portal and replace with the sections from the Active portal.
  • Deploy: switch the draft portal with the active portal.
  • Delete: delete existing draft portal.
  • Preview: review the layout of the draft portal.

Configuring User Menu Items

The User Menu are those items that will appear along the top right corner of the web browser. These links can link to the user profile, control the language displayed, or link to a specified custom page. Header links can be displayed across the top of the browser or within a drop down list.

UserMenu.png


Under the User Menu section → Click Add button.

Select the “Link Type”:

  • Custom - Add links to pages using URL from within the system
  • Drop Down - Allows the addition of new dropdown menus with custom links
  • Language - Adds the language switching options
  • User Profile - Adds a link to the User Profile page
  • Company Profile - Adds a link to the Company Profile page
  • SmartFolder - Add links to files or folders found in SmartFolders.

Additional options include:

  • Caption - The text entered here will be displayed at the link text
  • Description - Used to store a general description for the user menu item
  • Display Order - Determines the order in which the link is displayed in the header
  • URL - The URL address of the page that will be returned by the custom. Only appears for Custom Link Type.
  • Language Options- Displays list of language switching options. Only appears for Language Link Type.
  • SmartFolder- lookup to allow selection of files or folders found in SmartFolders. Only appears for SmartFolders Link Type.
  • Open in - Option to open file / folder in Current Window, Modal Window or New Window. Only appears for SmartFolders Link Type.

Configuring Main Menu Items

The Main Menu items are the main navigation links on the Arcadia X portal.

MainMenu.png

Under the Main Menu section → Click the Add button.

Complete all appropriate fields:

  • Caption - This will be the text used for the navigation link
  • Description - User to store a general description of the main menu item
  • Display Order - Determines the order in which this navigation link will be displayed
  • Content Type: three options:
    • Single Page - Creates a page using the URL provides from within the system
    • Sections - Allows a page to be segmented in sections / or a grid displaying different information
    • Sub Tabs - Allows the addition of new dropdown menus with custom links


Configuring Single Page

If Content Type is set to Single Page then an additional setting is available:

  • URL - The address of the page that will be returned when link is selected.

Configuring Sub Tabs

If Content Type is set to Sub Tabs then an additional Sub-menu section is available.

ArcadiaSubTabs.png


Clicking Add will allow you to configure the sub-tab settings:

ArcadiaSubTabs2.png


  • Caption - This will be the text used for the sub-tab
  • Description - User to store a general description of the sub-tab item
  • Display Order - Determines the order in which this sub-tab will be displayed
  • Content Type: three options:
    • Single Page - Creates a sub-tab using the URL provides from within the system
    • Sections - Allows the sub-tab to be segmented in sections / or a grid displaying different information.

Configuring Sections

ArcadiaSections.png

If Content Type is set to Sections then additional settings are available:

  • Theme - determines the way a section appears (colors, fonts, and decorative elements).
    • Default - has decorative boxes with rounded corners and gradients to give it a more 3 dimensional and segregated appearance.
    • Whitepaper (Clean & flat) - has no boxes or gradients and the fonts are larger giving it a clean and flat minimalist appearance.
  • Background Colour - colour applied to the background of the interface

There is also an an additional Sections option.

Clicking Add Layout here will allow you to select from a predefined list of layout options. The selected Layout will be used when displaying the individual sections.

Clicking Add here will allow you to configure the general section settings:

  • Type: available options include:
    • Chart
    • Custom Link
    • List View
    • Media Files
    • Section Container
    • Section in Tabs
    • Shortcuts
    • Text Template - Creates a sub-tab using the URL provides from within the
  • Title - This will be the text used for the section
  • Instructions - Text that will appear at the top of the individual section
  • Description - User to store a general description of the section
  • Display Order - Determines the order in which this section will be displayed

The Type specific settings are discussed below.

Configuring Sections - Chart

If Section Type is set to Chart then the following additional options are displayed.

  • Chart List View - list view used to create chart
  • Enable View Options - provides option to View All Data or View Table Data
  • Chart Title - title of the chart
  • Chart Type - number of options available (e.g. Bar, Pie, 3D Donut, etc)
  • X-Axis: column from list view used for X-Axis
  • X-Axis Label: label displayed for X-Axis
  • Y-Axis: column from list view used for Y-Axis
  • Y-Axis label: label displayed for Y-Axis
  • Aggregate: Sum, Count, Average, None

Configuring Sections - Custom Link

If Section Type is set to Custom Link then the following additional options are displayed.

  • URL - The URL address of the page that will be returned by the navigation link.


Configuring Sections - List View

If Section Type is set to List View then the following additional options are displayed.

  • System List - select List View that will appear in the section
  • Show Search Panel - List View appears with Search Options available
  • Width - width of the screen that the section will occupy.
  • Height - height of the screen that the section will occupy.
  • Style Options - indicate if you want to appear with Shadow or Margin
  • Background Colour - colour applied to the background of the interface

Configuring Sections - Media Files

Media Files section will display a list of specified Media Files, with metadata exposed.

If Section Type is set to Media Files then the following additional options are displayed.

  • UTA - UTA where the Media File custom field is configured
  • Entity - entity where the Media File custom field is configured
  • Media Custom Files - Media File custom field to be displayed configured
  • Type Filter - filter records returned based on selected Type
  • Status Filter - filter records returned based on selected Status
  • Media File Type - filter records returned based on selected media types

Configuring Sections - Section Container

If Section Type is set to Section Contains then an additional Sub-Sections option appears.

Clicking Add here will allow you to configure the same as when configuring overall Section.

There are also additional Width and Height settings. These allow you to specify the percentage of the screen that the section will occupy.


Configuring Sections - Section In Tabs

If Section Type is set to Section In Tabs then an additional Sub-Sections option appears.

Clicking Add here will allow you to configure the general section settings the same as when configuring overall Section.

There are also additional Layout settings as follows:

  • Width - width of the screen that the section will occupy.
  • Height - height of the screen that the section will occupy.
  • Style Options - indicate if you want to appear with Shadow or Margin
  • Background Colour - colour applied to the background of the interface


Configuring Sections - Shortcuts

If Section Type is set to Shortcut then the following additional options are displayed.

  • Width - width of the screen that the section will occupy.
  • Height - height of the screen that the section will occupy.
  • Style Options - indicate if you want to appear with Shadow or Margin
  • Background Colour - colour applied to the background of the interface
  • Selected Shortcuts - Lookup to select individual shortcuts that will appear in the section. Leave blank if you wish all shortcuts to appear.


Configuring Sections - Text Template

If Section Type is set to Text Template then the following additional options are displayed.

  • Width - width of the screen that the section will occupy.
  • Height - height of the screen that the section will occupy.
  • Style Options - indicate if you want to appear with Shadow or Margin
  • Background Colour - colour applied to the background of the interface

Re-order Items

The User Menu, Main Menu and Section options can all be re-numbered and re-ordered by clicking on the row and dragging it to its new location.

The Display Order is immediately updated and the order will be stored on Save.