Workspace Widgets - Akumina Community

Workspace Widgets

Workspace Widgets

The following widgets are for use as part of the Akumina Workspaces environment only as they rely upon the O365 Groups infrastructure and the Akumina Workspaces implementation details. These widgets will appear in the widget panel which displays upon editing an Akumina Workspaces page.

For additional information on how each of these widgets are used in Akumina Workspaces, see the Akumina Workspaces – Quick Start Guide.

Available With:  Release 4.1 and Above

 

Workspace Conversation Widget

Purpose

To be a dynamic conversation board to view, reply, and start new conversations.

 

Features

  • Displays a list of all existing conversations in the current workspace
  • Conversations can be displayed with newest first or oldest first
  • Start New Conversation – click here to add a new conversation thread
  • Conversation topic list – on this page, only the conversation topics are listed in the left panel.  This allows from more topics to be viewed.  Clicking on a conversation topic displays the complete thread for that topic in the right panel.
  • Conversation thread – displays the thread for the selected topic
  • View Document link – if a conversation is associated with a document, this link is displayed which navigates the user to the preview page for the document
  • Reply and Delete – the reply button opens the reply field.  The Delete button on is displayed in the following conditions:
    • An Owner in the workspace can delete any conversation topic or reply in the workspace
    • A Member can delete any conversation thread that they create, which includes deleting any of the replies in that thread
    • A Member can only delete replies that they created as part of a thread created by another member

Details

    • Widget Name: WorkspaceConversationWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspaceConversationWidget 

Properties

thread order Drop-down menu to choose the order that conversations appear: Newest First, Oldest First
displaytemplateurl N/A OOTB, url that changes the widgets display

 

 

Workspace Details Widget

Purpose

To display an editable overview of the users Workspaces

 

Features

  • Displays the following information/links within the current Workspace
    • Workspace Image
    • Workspace Title and Description (with edit access to edit both)
    • Workspace Delete access
    • List of current workspace members (avatars)
    • Access to Manage Members page
    • Refresh link to update workspace display
    • Leave (Add) Workspace link to allow the current user to remove themselves from the current workspace, or Add themselves to the current workspace (public workspaces only)

Details

    • Widget Name: WorkspaceDetailsWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspaceDetailsWidget 
      • View Description: Default view for the Workspace Details Widget
    • View Name: WorkspaceDetailsWidget-AllMembers
      • View Description: View showing Workspaces for all members
    • View Name: WorkspaceDetailsWidget-Edit
      • View Description: View allowing editing

Properties

displaytemplateurl2 Url that changes the widgets display, should be: /Style Library/DigitalWorkplace/Content/Templates/Workspaces/WorkspaceEditPopup.html
uicallbackmethod N/A OOTB, the function that is called after the UI is rendered to the screen.
displaytemplateurl N/A OOTB, url that changes the widgets display

Workspace Documents View Widget

Purpose

To allow users to edit and view documents in real time.

 

Features

  • Displays a preview of the selected document along with any associated conversations
  • Allows for checkout/checkin and editing of the selected document
  • Contains the following links and functionality:
    • Action Menu – the action menu applies to the current document being displayed.  It allows the user to Check-in/Check-out, Share, Download, Promote and Delete the current document.
    • Preview Pane – displays a preview of the current document (if it is a type supported by Office Online) and allows for editing of the document using the “Edit Document” function
    • Associated Conversation – if there is a conversation already started for the document it is displayed here.  If there is no conversation, a “Start New Conversation” box will appear.
    • View Versions – provides access to the list of previous versions of the document for viewing.  Clicking on a previous version will display that version.

Details

    • Widget Name: WorkspaceDocumentsViewWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspaceDocumentsViewWidget 

Properties

uicallbackmethod N/A OOTB, the function that is called after the UI is rendered to the screen.
displaytemplateurl N/A OOTB, url that changes the widgets display

Workspace Documents Widget

Purpose

Displays a sortable list of all documents the user has access to.

 

Features

  • Displays a listing of all the documents in the current workspace
  • Contains the following links and functionality:
    • Document Item – lists the name, owner and last modified date for the document.  Clicking on the document title launches the preview page for the document.
    • Documents to show – sets the number of recent documents to display (5, 10, 15)
    • Add Document – opens the upload document modal
    • View All – navigates the user to the Document Listing page to view all the workspace documents
    • Refresh – this button is provided to refresh the document list when necessary to view an up-to-the-minute list of documents.  Useful if another member has just added a new document.
    • Action Menu – accessed by clicking on the ellipses.  Allows the user to take action on the document directly from this listing

Details

    • Widget Name: WorkspaceDocumentsWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspaceDocumentsWidget 

Properties

uicallbackmethod N/A OOTB, the function that is called after the UI is rendered to the screen.
displaytemplateurl N/A OOTB, url that changes the widgets display

Workspace Listing Featured Widget

Purpose

Displays a detailed overview of the 10 most recent public workspaces.

 

Features

  • Lists the last 10 PUBLIC workspaces created by date
  • Displays the image, title, tags, # of Tasks and # of Documents for each workspace
  • Clicking on listing navigates to the selected workspace
  • Cannot be used WITHIN a workspace

Details

    • Widget Name: WorkspaceListingFeaturedWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspaceListingFeaturedWidget 

Properties

uicallbackmethod N/A OOTB, the function that is called after the UI is rendered to the screen.
displaytemplateurl N/A OOTB, url that changes the widgets display

Workspace Listing Widget

Purpose

Displays a complete list of all public and private workspaces that the current user has access to.

 

 

Features

  • Lists the workspaces (Private and Public) that are available to the current user
  • Cannot be used WITHIN a workspace
  • My Workspaces – the workspaces that the current user belongs to
  • Public Workspaces – the complete list of public workspaces that are available
  • Search name or tag – typing three letters of more will filter the displayed list of workspaces to show only those with a title or tag that contains the search term.
  • Workspace Tile – shows the workspace name, image, and the number of current Tasks and Documents in the workspace.  Clicking on the workspace image or the right arrow will launch the workspace.
  • Create a New Workspace – clicking this button will launch the “Create Workspace” wizard in a modal window, which is also part of this widget.  Note that this button can be put under permission control so that only authorized users can create new workspaces.

Details

    • Widget Name: WorkspaceListingWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspaceListingWidget 

Properties

permissiongroups N/A OOTB, enter if you want only certain groups to have access to the widget
uicallbackmethod N/A OOTB, the function that is called after the UI is rendered to the screen.
userphotocallback N/A OOTB, the function that is called after fetching user photos
displaytemplateurl N/A OOTB, url that changes the widgets display

Workspace Manage Members Widget

Purpose

An interface to search and edit user permissions.

 

Features

  • Used to manage members and permissions levels for the current workspace
  • Contains the following links and functionality:
    • Add Member – Typing a first or last name in this box will display matching users that can be added to the workspace.  Users are added as a Member level by default.  Owners of the workspace can elevate their permissions if needed.
    • Member Search – clicking on the “Name” label will activate a search box which can be used to filter the member list to find a specific member.  Used when the member list for a workspace is long.
    • Member Entry – includes both the display name and the email address of the user
    • Remove – only visible to Owners, clicking this button will remove the user from the workspace
    • Permissions – only visible to Owners, used to set the permission level for workspace users.  See the “Workspace Permissions” section for more details.
    • Save – once changes are made, you must click the Save button to put them into affect.

Details

    • Widget Name: WorkspaceManageMembersWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspaceManageMembersWidget 
      • View Description: Default view for the Workspace Manage Members Widget
    • View Name: WorkspaceManageMembersWidget-AllMembers
      • View Description: Workspace Manage Members view that allows to look and manage all members.

Properties

uicallbackmethod N/A OOTB, the function that is called after the UI is rendered to the screen.
userphotocallback N/A OOTB, the function that is called after fetching user photos
displaytemplateurl N/A OOTB, url that changes the widgets display

Workspace Milestone Widget

Purpose

Displays dates that are considered important Milestones for users to view, add, and edit.

 

 

Features

  • Allows for the creation and display of “milestone” dates for the current workspace
  • Contains the following links and functionality:
    • Add – opens the Add New Milestone modal.  A milestone has a title, description and date.
    • Milestone title – click on the title to edit the milestone
    • Milestone status – shows the days remaining or if a milestone is past due
    • Action Menu – click on the ellipses to display the Action menu.  The menu allows you to “Edit”, “Delete” or “Mark as Complete”

Details

    • Widget Name: WorkspaceManageMembersWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspaceManageMembersWidget 

Properties

uicallbackmethod N/A OOTB, the function that is called after the UI is rendered to the screen.
displaytemplateurl N/A OOTB, url that changes the widgets display

Workspace Page Widget

Purpose

A container for the Workspace Widgets for their display on the site.

Features

  • When added to a page, defines the zones and enables the additional of individual widgets to the page (essentially provides a container)
  • Enables the widget list functionality for choosing the Workspace Widgets to add to the page from the right hand widget selector tray

Details

    • Widget Name: WorkspacePageWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspaceLayout
      • View Description: Page container for the Workspace page. 
    • View Name: WorkspaceHomeTab
      • View Description: Page container for the Workspace Home tab.
    • View Name: WorkspaceConversationTab
      • View Description: Page container for the Workspace Conversation tab. 
    • View Name: WorkspaceDocumentTab
      • View Description: Page container for the Workspace Documents tab. 
    • View Name: WorkspaceTaskTab
      • View Description: Page container for the Workspace Tasks tab. 
    • View Name: WorkspacePhotoGalleryTab
      • View Description: Page container for the Workspace Photo Gallery Tab. 
    • View Name: WorkspaceDMSTab
      • View Description: Page container for the Workspace DMS tab. 

Properties

loadwidgetcallback N/A OOTB, the function that is called after the widget is loaded
savewidgetcallback N/A OOTB, the function that is called after widgets are saved
displaytemplateurl N/A OOTB, url that changes the widgets display

Workspace Photo Gallery Widget

Purpose

Displays the images that have been uploaded to the Workspace.

 

 

Features

  • Allows for the upload and display of images added to the current workspace
  • Includes and “Add Photo” modal popup

Details

    • Widget Name: WorkspacePhotoGalleryWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspacePhotoGalleryWidget

Properties

displaytemplateurl N/A OOTB, url that changes the widgets display

Workspace Plans Widget

Purpose

Used to add, view, and complete tasks. Dynamically pulls in users current tasks.

Features

  • Displays a summary listing of the tasks in the current workspace
  • Provides a modal popup for the adding/editing of tasks
  • Contains the following links and functionality:
    • My Tasks – displays the active tasks assigned to the current user.  To see the completed tasks as well, select the “Show Completed” checkbox.
    • All Tasks – displays all the active tasks in the workspace.  To see the completed tasks as well, select the “Show Completed” checkbox.
    • Add – clicking this button opens the WorkspacePlanTasksWidget to add a new task
    • Refresh – refreshes the task list to show any new tasks since the last page access
    • Sort by – allows the list of tasks to be sorted by Bucket, Due Date or Status
    • Task info – clicking on the task title launches the task modal.
    • Action Menu/Status indicator – the Action menu (ellipses) allows for marking a task as complete without having to access the task modal.  A task can also be deleted.  The status indicator changes color depending on whether the task is Not Started, In Progress or Overdue.  A task is Overdue beginning the day after it is due.

Details

    • Widget Name: WorkspacePlansWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspacePlansWidget

Properties

displaytemplateurl N/A OOTB, url that changes the widgets display

Workspace Recent Conversation Widget

Purpose

Displays the most recent conversations in a Workspace.

 

Features

  • Displays a summary list of the conversations for the current workspace
  • Supports creating a new conversation, or replying to an existing conversation
  • Contains the following links and functionality:
    • Start New Conversation – click to display the topic and comment field to start a new conversation thread
    • Expand Conversation – click the arrow to expand or collapse the thread for a specific topic
    • Add a reply – when a conversation topic is expanded, the reply box is displayed to add your reply
    • View All – clicking this link will navigate to the Conversations Page

Details

    • Widget Name: WorkspaceRecentConversationWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspaceRecentConversationWidget

Properties

viewalllink Link for the view all button. Should be: {workspaces.workspacesconversationspagetitle}
viewalltext Text for the view all button. Should be: {common.viewall} >
threadorder Drop-down to select the order that conversations appear in. Either: Newest First, Oldest First
uicallbackmethod N/A OOTB, function that is called after the UI is rendered to the screen.
displaytemplateurl N/A OOTB, url that changes the widgets display

 

 

Workspace Recent Documents Widget

Purpose

Displays the recent documents in a workspace that the user has access to.

 

 

Features

  • List the documents available in the current workspace
  • Provides a modal popup for the adding of new documents
  • Contains the following links and functionality:
    • Document Item – lists the name, owner and last modified date for the document. Clicking on the document title launches the preview page for the document.
    • Documents to show – sets the number of recent documents to display (5, 10, 15)
    • Add Document – opens the upload document modal
    • View All – navigates the user to the Document Listing page to view all the workspace documents
    • Refresh – this button is provided to refresh the document list when necessary to view an up-to-the-minute list of documents.  Useful if another member has just added a new document.
    • Action Menu – accessed by clicking on the ellipses.  Allows the user to take action on the document directly from this listing
    • Browse – opens explorer window to find the local document
    • Add as a new version to an existing file – checking this box will add the document as a new version to a file that already exists in the workspace with the exact same name. If this box is checked, you cannot start a new conversation in this dialog.
    • Start a new conversation for this file – as part of uploading a document, you have the option of starting a new conversation.  If this box is checked, then the Topic and Comments fields become active.

Details

    • Widget Name: WorkspaceRecentDocumentsWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspaceRecentDocumentsWidget

Properties

viewalllink Link for the view all button. Should be: {workspaces.workspacesdocumentspagetitle}
viewalltext Text for the view all button. Should be: {common.viewall} >
displaytemplateurl N/A OOTB, url that changes the widgets display

 

Workspace Tab Widget

Purpose

Displays the tabs for the different sections of Workspace.

 

Features

  • Provided the navigation element within the current workspace
  • Pages are automatically added to the navigation when they are enabled for the workspace (not currently managed content)

Details

    • Widget Name: WorkspaceTabWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspaceTabWidget

Properties

uicallbackmethod N/A OOTB, function that is called after the UI is rendered to the screen
displaytemplateurl N/A OOTB, url that changes the widgets display

 

Workspace Task List Widget

Purpose

Displays a detailed overview of all tasks for a Workspace in a card format.

 

 

Features

  • Displays all of the tasks for the current workspace
  • Allows for the sorting and filtering of the tasks in different views
  • Provides a modal popup for the adding/editing of tasks
  • Contains the following links and functionality:
    • Sort By – choose the view for the tasks (Bucket, People, Status, Due Date)
    • Add Bucket – a bucket is a means to organize your tasks into different topic areas.  Only one bucket is required, and you may add as many as needed.
    • Refresh – refreshes the task list to show any new tasks since the last page access
    • Action buttons – these include editing the bucket name, deleting the bucket (which will also delete any tasks still in the bucket) as well as the expand/collapse button.
    • Add Task – adding a task using this option will automatically assign the task to the bucket
    • Show/Hide Complete tasks – view or hide tasks in the bucket which have been completed

Details

    • Widget Name: WorkspaceTaskListWidget 
    • Available With:  Release 4.1 and Above
    • View Name: WorkspaceTaskByBucket
      • View Description: Displays Tasks ordered by their buckets (Sort by Buckets option)
    • View Name: WorkspaceTaskPageByAssignee
      • View Description: Displays Tasks ordered by their assignee (Sort by Assignee option)
    • View Name: WorkspaceTaskPageByStatus
      • View Description: Displays Tasks ordered by their status (Sort by Status option)
    • View Name: WorkspaceTaskList-AllMembers
      • View Description: Displays Tasks for all members
    • View Name: WorkspaceTaskList-AddTask
      • View Description: Displays the add task pop-up
    • View Name: WorkspaceTaskPageByDueDate
      • View Description: Displays Tasks ordered by their due date (Sort by Due Date option)

Properties

userphotocallback N/A OOTB, function that is called after pulling in user photos
displaytemplateurl N/A OOTB, url that changes the widgets display

Views: 225
//]]>