Sidebars

Sidebars

From LongJump Support Wiki

Sidebars
Jump to: navigation, search

Designer > Sidebars

A default Sidebar appears in every page in the platform and is positioned on the left side of the page. Optionally, an additional Sidebar can be added to the right side of the page. Sidebars are made up of selected widgets.

Contents

About Sidebars

Custom Sidebars can be assigned to individual Applications and displayed based on the Role of the user that is logged in.

Some examples of widget types in Sidebars:

  • Search - Enter a keyword and find matching records
  • Create New - Create a new record in an object or Log an Activity
  • Recent Items - A list of links to the most recently accessed records; Not all types of records are listed
  • Views, Reports or Widget Tools, including other platform elements

Working with Sidebars

File:Lock-tiny.gif

Users that have the Customize Objects permission can modify Sidebar settings 

Create and Modify Sidebars

  1. Click Designer > Sidebars
  2. Click the [New Sidebar] button or click the name of an existing Sidebar.
  3. Provide the following information:
    Name
    Name of the Sidebar
    Sidebar Width
    Horizontal width of the Sidebar; Default is 200px; Minimum is 190px.
  4. Click [Save]
  5. In the Sidebars page, choose from these options:
    Add Widget
    Click the [Add Widget] button to add a new widget to the Sidebar
    Type
    Select the type of widget; Learn more: Widget
    Position
    Defaults to Center Column
    Widget Title
    Enter the name of the widget
    Edit Properties
    Click the [Edit Properties] button to change the name of the Sidebar or the Sidebar Width
    Delete
    Click the [Delete] button to delete this Sidebar (this cannot be undone and will remove the Sidebar from all applications)
  6. To modify a Widget or its position:
    Edit
    Change the title and height of an existing widget with the Edit icon
    Minimize/Maximize
    Show or hide the widget with the Minimize/Maximize icon; When minimized, only the header bar is displayed
    Delete
    Delete the widget from the Sidebar with the Delete icon
    Move
    Hover the mouse cursor over the widget header bar and the cursor icon will change to indicate that the widget can be moved
    Click and drag the widget to a new location in the Sidebar (above or below its current location)

Sidebar Assignments

Sidebars are assigned to Applications individually. To make a new Sidebar Assignment, or change an existing Sidebar assignment in an application:

  1. Click Designer > Sidebars
  2. Click the [Sidebar Assignments] button
  3. Choose one of the following options:
    • Click the [New Sidebar Assignment] button, choose an Application from the list
    • Choose an existing application
  4. In the Application Information section, choose:
    Application
    Select the application where this Sidebar is displayed
  5. In the Global Assignment section, choose the sidebar that will be displayed for everyone who does not have a role-specific assignment:
    • Default Sidebar
    • One of the existing Sidebars in the list
  6. In the Role Specific Assignment section, optionally assign a Sidebar based on the role of the user viewing the page:
    • Users in the selected roles can see the Sidebar as assigned in this section
    • When a user with the specified role opens the application, the specified Sidebar is displayed
    • Choose either the Default Sidebar or one of existing Sidebars for:
    System Administrator
    Team Manager
    Team Member

Delete a Sidebar

To delete a Sidebar assignment, open the Sidebars page and click the Delete link located by the application name.

Create a Custom Sidebar Using Graphic Images

This example creates a new Sidebar for the Sample Order Processing System. It displays large, easy-to-locate graphic images for users to click on.

Upload the Images

Upload the images as documents:

  1. Workspace > All Items > Documents
  2. Click [New Document]
  3. Choose the files:
    • Open a New Order
      File:Sidebar_openneworder.png
    • View Open Orders (invoke the view that displays open Orders)
      File:Sidebar_viewopenorders.png
    • BrowseReports
      File:Sidebar_browsereports.png
  4. Click [Upload]

Generate Links to the Images

For each uploaded image, make the image Public to generate a link to it, and save the URL.

To make an uploaded file Public:

  1. Workspace > All Items > Documents
  2. Click [Edit]
  3. Click the checkbox to make it a Publicly Available Document
  4. Click [Save]
The image properties section for a public document contains the field, URL for Public Document, that contains a URL you can use to reference the document. That URL can then be put into an email, used as a bookmark, or put into a JSP/Html Page.
The generated link looks like this (with newlines added for readability):
https://{domain}/networking/RepositoryPublicDocDownload
   ?id={document_id}
   &cid={company_id}
   &encode={media_type}
where:
  • document_id - The unique identifier for the document.
  • company_id - The unique identifier for your instance of the platform
  • media_type - Identifies the file's Media Type. For example, image/png or text/plain.

Identify Target URLs for the Sidebar Links

In general, you identify the links you need by inspecting the HTML generated for a page in your browser.

  • Open a New Order (add a new record to the Orders object)
  • Inspect the Orders view. Find this link for the [New Order] button.
  • Copy it. It contains the ID of the Orders object.

javascript:top.showTabInIframe(
  '{Orders_object_id}-1', 'Orders',
  'Service?t=498&id=-1&a=add&object_id={Orders_object_id}');

  • View Open Orders (invoke the view that displays open Orders)
  • Inspect the list of objects in the sidebar. Find this link for the Orders entry.
  • Copy it. It contains the ID of the Orders object

javascript:top.showTab(
  '{view ID}', 'Orders_object_name',
  'Service?t=499&object_id={view ID}');

  • View Reports
  • Use this link:

javascript:top.showTabInIframe('259', 'Reports', 'Service?t=259&top_tab=reports');

Create the Sidebar

  1. Make a copy of the HTML snippet below, and modify it to substitute the values for your instance of the platform.
  2. Designer > Sidebars
  3. Click [New Sidebar]
    • 'Name: Order Processing
  4. Click Save]
    The sidebar is created, and the design window appears.
  5. Click [Add widget ]
    • Type: Widget Tools
      Additional options appear.
    • Widget Tool: Free Form
    • Text: Paste in the HTML snippet you modified.
    • Widget Title: Actions
  6. Click [Save]
    The widget appears in the design view. It can then be edited to adjust the height, if needed. (150 is about right).

After refreshing the page in the browser, the sidebar for the Order Processing app looks like this:

File:OrderProcessing_sidebar.png

HTML Snippet

This snippet of HTML creates a div that contains the images the user can click to do things. ( Newlines have been added for readability.)

To use it:

  • Find the ID of the Orders object in your instance of the platform and substitute it into the code for: {Orders_object_id} (four places, in all), or substitute the full image links obtained from inspecting the HTML, as directed earlier.
  • Substitute the URLs for the images, obtained when you made them public documents.
<div>
<table width="160"  border="0" cellspacing="0" cellpadding="0">

<tr><td> <!-- Open a New Order (Add an Orders Object record) -->
<a href="javascript:top.showTabInIframe(
   '{Orders_object_id}-1', 'Orders',
   'Service?t=498&id=-1&a=add&object_id={Orders_object_id}');"

>
   <img src='{link_to_new_order_image}'
     width="160" height="48" border="0"
  />
</a>
</td></tr>

<tr><td> <!-- View Open Orders -->
<a href="javascript:top.showTab(
   '{Orders_object_id}', 'Orders',
   'Service?t=499&object_id={Orders_object_id}');"

>
   <img src='{link_to_view_open_orders_image}'
     width="160" height="48" border="0"
  />
</a>
</td></tr>

<tr><td> <!-- Browse Reports -->
<a href="javascript:top.showTabInIframe(
   '259', 'Reports', 'Service?t=259&top_tab=reports');"

>
   <img src='{link_to_browse_reports_image}'
     width="160" height="48" border="0"
  />
</a>
</td></tr>
</table>
</div>

Optional: Add a Workspace Widget

To continue having access to the Workspace functionality you're used to, add a Workspace widget to the side bar, in minimized form:

  1. Click [Add widget ]
    • Type: Workspace.
    Widget Title: Workspace
  2. Click [Save]
    The Workspace widget appears in the design view, above the Actions widget.
  3. Click the down-arrow icon in the corner of the Workspace widget so it appears in minimized form (both in the design view and when displayed).
  4. Drag the Actions widget above it.

Assign the Sidebar to the Order Processing App

  1. Designer > Sidebars
  2. Click [Sidebar Assignments]
  3. Click [New Sidebar Assignment]
    Application: Order Processing
    Additional options appear.
    Global Assignment: Order Processing
    The new Order Processing sidebar is now assigned to every user of the Order Processing application, and will become visible to users the next time they log in.

File:thumbsup.gif

Tip: For faster testing, use the browser refresh button. You lose open tabs, but it's quicker than logging in again.

Personal tools