Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Div
classtitle-box lead


Excerpt

Registry v3.2.0 introduces Dashboards, simple information portals. Information is provided by Dashboard Widgets, which are implemented as Dashboard Widget Plugins. Multiple Dashboards can be defined within a CO. Dashboards include header and footer text areas appropriate for providing arbitrary html content on the landing page of a CO.




Panel
bgColor#d9d9d9
titleColor#3e3e3f
titleBGColor#bed73b
borderStylenone
titleOn this Page

Table of Contents
maxLevel3
indent20px
stylenone



Using and Configuring Dashboards

Dashboard Visibility

Dashboards are configured with a visibility, controlling who may render the dashboard and its widgets. While widgets automatically inherit the Dashboard's overall visibility, it is not possible to have a single Dashboard with Widgets configured for different visibilities.Dashboards made visible to "Unauthenticated Users" are publicly viewable at a URL similar to /registry/co_dashboards/dashboard/3. The URL can be obtained (and the dashboard previewed) by clicking the "Render" button in the index of available dashboards.

Primary CO Dashboard

One Dashboard may be flagged as Primary for the CO, via Configuration > CO Settings > Primary Dashboard. When a Primary Dashboard is configured, it will render at the CO landing page (/registry/co_dashboards/dashboard/co:#). Note that any active CO Person (CO Member) can view this page. If a more restrictive visibility is configured for the Dashboard, the structure of the Dashboard will still render, though the Widgets will throw permissions errors rather than render. In general, if a Dashboard is set as the Primary Dashboard, it should be given CO Member visibility.

Dashboard Widgets

Existing Widgets

Registry Dashboards contain Dashboard Widgets

Content by Label
showLabelsfalse
showSpacefalse
sorttitle
titleDashboard Widget Plugins
excerptTypesimple
cqllabel = "plugin" and label = "dashboard"

Writing your own widget

Building your own plugin is a great was to get started with custom development for COmanage. Through plugins you can build powerful extensions to the existing Registry functionality. Building a Registry Plugin requires knowledge of PHP, CakePHP, and COmanage.

Start Here

The general documentation for building plugins can be found on the Writing Registry Plugins page. All plugins follow some standard conventions which are outlined on this page. In addition, some types have additional requirements as listed below.

Specific plugin details

Some additional conventions are required when writing a Dashboard Widget Plugin. See the documentation for more detail.


CSS Stylesheet
.home-banner {
                    background: #ffffff;
                    color: #d44415;
                    font-size: 20px;
                    padding: 20px;
                    }
                    .home-banner h1 {
                    color: #5e2b97;
					font-size:2.5em;
                    }
                    .title-box {
                    border: 0px solid #ff5b2d
                    padding: 10px;
				 	padding-bottom: 30px;
                    }
                    .title-box > h2 {
                    /*background: #5e2b97;*/
				 	border-top: 3px solid #c2d6d6;
                    bottom: 10px;
                    /*color: #c2d6d6;*/
                    /*margin-left: -10px;*/
                    /*margin-right: -10px;*/
                    padding: 1em 0 0;
                    position: relative;
                    }
                    .cfm-blog-image > img {
                    display: block;
                    margin-left: auto;
                    margin-right: auto;
                    }
					.lead > p {
					line-height: 2;
					font-size: 1.5em;
					}
					.about-box {
					border-top: 1px solid #c2d6d6;
					border-bottom: 2px solid #c2d6d6;
					padding: 10px;
					padding-top: 30px;
					padding-bottom: 30px;
					}
					.about-box > p {
					font-size: 0.9em;
					font-style: italic;
					}
					.about-box > h3 {
					font-size: 0.9em;
					}
}