bt Confluence Overview
Article - Draft - Confluence Overview
Jim Mason
Article Draft for Review
What this article is useful for |
---|
The article tries to strike a balance between a very short article on some Confluence Cloud features and yet avoid something that's too long. This article is NOT a tutorial, the full documentation set or a detail task reference. In theory, this article is useful if
In future articles, we'll look at building your own plugin apps and other content integration options |
Table of Contents
https://www.atlassian.com/software/confluence
Key Points on Confluence |
---|
SWTR ranks Confluence as a "GOLD" rated wikiThe SWTR ( Sky Web Technology Rank ) of 8.5 is based on 4 summary factors scaled from 1 ( worse ) to 10 ( better )
Can a wiki add value to your organization or group?Wikis help solve information sharing problems for organizations and groupsWhat problems do wikis solve?Maybe. There are many ways to share different types of information across organizations and groups including applications, databases, documents, shared drives, files, media, chat services and more. Wikis provide organizations and groups a way to rapidly, securely collaborate different types of information that is easily created, edited and integrated with other resources. Many other solutions require more extensive training and expertise to implement ( Web and mobile applications, complex data analytics tool suites, databases etc ). Wikis provide a simple, easy way to
Confluence makes it easy to see if it adds value for your needsWikis differ in features, technologies and costs. Some are open-source and free to download and use. Some are commercial with a variety of licensing models. Confluence offers a low-end free to see how it adds value to your teams. Unlike some "try and buy" products that are free for 90 days or a year, the Confluence free tier is permanently free so you can learn to use it on your schedule. Most wikis offer a good variety of integration features for different information and content types right of out of the box. In addition, good wikis offer both an active 3rd party marketplace with plugin applications to extend the wiki and a simplified development model to add your own application plugins. Confluence scores well here too. The SWT Wiki Audit - Should your organization use wikis?
Symptoms you may need a wiki
Some "wins" for wikis like ConfluenceTeam Knowledge baseProblem - small staff with rapidly expanding technology needs One IT infrastructure team I managed during a recession had a slow RIF ( Reduction In Force ) while we rapidly grew our servers and added new OS stacks to our backlog in addition to all the normal software maintenance, support, compliance audits and new projects. A challenge? Solution - Knowledge base wiki Yes. I created an "extended" wiki that used added plugins. All of our team work tickets and support tickets were reviewed against the team knowledge base. Initially there were few solutions there but we added and tagged our solutions going forward. It also offered quick dashboards with integrated SQL queries on our operating environments. Impacts - With fewer staff expanded infrastructure technology capability 300% in 18 months 18 months later the team was smaller but our ability to cover a wide range of technologies productively had grown 300% - not a bad payoff ! Other teams also started using our knowledge base as well - a real win for the company. Sharing documents, content with local and remote users ( support for services, products, procedures )Problem - on-demand content sharing High volume data and document sharing applications are normally well engineered by organizations. Companies may not be setup to easily share some content securely across teams. Lower volume or on-demand sharing of content is a challenge. Service and support organizations are challenged to share documents, media with the clients and users. Users and clients often have problems finding the right set of documents to work with. Solution - wikis setup easy on-demand content sharing with authorized users It was easy to setup a wiki space, add users and permissions for content upload, sharing and access. Internally, we were able to share content to authorized users quickly using the wiki. When needed, we also created wiki spaces ( sites ) that allowed the public ( anonymous users ) to search and access documents, wiki pages and media. Where allowed, users can also blog on topics and create a productive community on knowledge sharing that helps both clients and companies. Impacts - where automated content sharing didn't exist, wikis provide another secure option Providing public access to selected content is a great solution for any business that services clients or provides support to clients. Some clients appreciated the ability to find the information they needed quickly and provide feedback directly to the organizations. If you're not sure how clients feel about your organization, you might consider adding a wiki blog. Atlassian did that for Confluence itself and got great feedback and improved client's engagement with the platform. Voluntary Data quality, sharing supports the Information Maturity Life CycleProblem - too many spread sheets create too many versions of the truth One company I worked at had solid "systems of record" and "trusted data stores" with many Web services and APIs, multiple databases to validate, ingest, integrate and distribute information centrally. Despite that, users created thousands of separate spread sheets. Every user had a different story to tell with different data at different ages. The problems getting useful answers were large. Rolling out an enterprise-wide data quality infrastructure initiatives isn't a quick project. It usually requires a culture change starting at the top as well. Solution - voluntary data sharing with round-trip data stores I offered a simple, self service data integration app in the wiki that authorized teams could access as a short-term alternative. Users could search the catalog of integrated data stores. If one didn't exist, they could submit a spread sheet that was validated and posted to a data store. When needed, users could edit the data directly or download the data again to a spread sheet and re-publish their data. Impacts - natural data quality and efficiency improved informally As users starting using this "round trip" process to search for data, download data if available and upload data if not available, the user teams gradually started reusing data, checking data quality and reducing data conflicts across teams. This "voluntary" data quality system paid off quickly. We improved data sharing, data services, data ownership and data qualtiy. Eventually, some of these data stores will "migrate" into formal "systems of record" with normal corporate data governance which is good. In the interim, voluntary data integration sources did improve data quality. QA Center of Excellence coordinates multiple projects, test cases, results across environmentsProblem - QA teams supporting multiple projects with dependencies Sharing the QA standards and processes across teams and projects in simple documents was challenging. Documents were not always found or kept current. QA teams didn't always find the right test cases and results for test plans. Some testing delays were due to coordination issues across teams. Solution - easy to setup project testing sites quickly QA standards by project type were defined in the QA master site. Separate spaces were setup for each project using the right templates from the master site to setup projects in minutes. All related artifacts ( source repositories, folders, QA plans, JIRA defect tracking, test cases, test results ) were easily linked by QA project. Defect resolution and test results analytics were easy to integrate with the wiki. Impacts - project integration sites link all test plans, cases, results QA project setup was faster. Templates made it easy to support different types of testing. Productivity of testers, developers, users improved on QA tasks. The JIRA integration with real time reports made Scrum meetings more productive. The visibility of QA results and challenges improved across all business teams. Compliance Management CenterProblem - Compliance programs have multiple projects and steps to coordinate productively While compliance reviews are often scheduled on a regular basis by internal and external audit teams, most audits require customized work plans for the objectives and tasks in scope. Quickly setting up plans and collaborating productively with the teams in scope can be challenging. Reusing related content from prior audits and the outcomes can also be important. Solution - simple to define the standards, processes and projects in one place Using the wiki, standard audit templates, work plans, case folders and sample documents can be copied into a new audit case. Auditor admins can set permissions on who contributes content, edit's pages, views content etc. The integrated Google Drive and Docs plugin makes it easy for the audit team to work together on the audit documents and plans. Google Sheets make it easy to show graphically summaries on the audit progress and audit issues by type. Impacts - costs, time can be reduced and coordination with departments simplified The wiki solution for audits allows all related teams to quickly identify what is expected and how to complete the audit tasks. Progress on the audit is visible to all authorized users. It's easier to keep audit work on track and quickly identify issues that need resolution. Overall, stress can be lower for the auditors and those audited. Does a wiki make sense for you?You have many choices for wikis that fit different use cases. If you have other use cases, let us know. If you need help defining the value for your use cases and looking at candidate wiki solutions or getting started let us know. – jim.mason@skywebteam.com |
Confluence Basic Concepts
Confluence offers Multiple Versions
Confluence is a collaboration software program created by Atlassian. Like many wikis, Confluence makes it very easy to create and publish custom web pages. Confluence is developed primarily in Java. Wikipedia has a long list of wiki software that includes both open-source and commercial offerings. Confluence has 2 licensed package offerings:
This overview is limited to the Cloud version. |
Warning – Any sample hyperlinks in this document that reference one of our sites ( skywebteam ) won't work since the site is not a public site. The urls are for reference only to show the format of the url to access a similar resource |
Sample Confluence Web Page Layout
For long pages, you can add a Table of Contents macro control at the top of the page to generate a table of contents automatically from headings in content ( similar to Word docs ). This sample page did not use a table of contents. The space header above includes ( from left to right ):
On the page itself is the page header which includes:
On the left, the hierarchical space page menu for this space shows on the left ( abbreviated here ) for easy navigation across the space. The user can easily collapse or expand the left space page menu as needed. |
Confluence Administration concepts
Confluence Sites and Spaces With a Confluence license, you get an assigned Web address. In my case, the web site is: skywebteam.atlassian.net. Spaces are a way to organize pages and content into logical categories that can be separately managed ( much like a simple, flat folder system ). Administrators can provide different access and permissions easily to a space. In addition, you can optionally set a space to public access allowing anonymous users access to the space. Spaces ( and their pages can be imported, exported and archived. I can email you a small space with a few pages that an administrator at your site can import. Confluence registered users As a Web CMS ( Content Management System ), Confluence makes it easy for registered users with the right permissions to add, edit and delete pages Confluence anonymous users The Confluence Cloud paid licenses offer optional access to anonymous users. If I want to create a general knowledge base to share with anyone, I can set my Confluence site or an individual space to allow anonymous user access. Admin Page showing Spaces and default permissions by roleSpaces are a convenient way to segregate content. The Space administration page below shows 3 categories of users:
In the page below, you can manage the specific permissions eacch role has on the space. In addition, adminstrators can create individual spaces and set individual permissions Confluence Support Pagehttps://support.atlassian.com/confluence-cloud/resources/ The Cloud version has a dedicated support page. It covers a wide variety of topics: Getting Started, Organizing Work, Collaborating on Content etc. |
Confluence Page Designer Options
Confluence Page FeaturesThis article would go on forever if I detail all the options a Page Designer or Page Editor has to create content in Confluence. Instead I'll only list the highlights and ask you to download the free version of Confluence to do more. This is a list of features available that can be added or used on Confluence pages
|
Confluence App Plugins
Confluence has many application plugins available that add new controls and features to Confluence pages.
Many are billable but there are some excellent free plugins that are very useful.
The Manage apps screen has "Find New Apps" link to search for more app plugins. It is available for an admin to searh and load app plugins.
Clicking the "Find New Apps" opens a page to search all the Confluence apps available
Some other Confluence Plugins that may add value
The site offers some plugins for email as well as calendars including Google Calendar and more.
Confluence Google Docs integration plugin
|
Google Slides in a Confluence page ( Note you can EDIT in Confluence as well )
Google Sheet can be directly edited in Confluence page
Confluence Calendar Plugins
There are multiple calendar plugins available in the Confluence marketplace. There are a few good candidates, one of which is lower cost than the others There also is an option conceptually to embed an iFrame control in Confluence that calls a standard Google Calendar Some calendars found in the Manage Apps Confluence Marketplacehttps://marketplace.atlassian.com/search?moreFilters=free&query=calendar The Google Calendar plugin is free but only works for the server version - not the cloud version The Google Calendar plugin for the server version is referenced here: https://marketplace.atlassian.com/vendors/1212722/servicerocket-labs Google Team Calendars ( from Atlassian )This plugin is from Atlassian While it is expensive ( about $30 per year per registered user ), there may be discounts for a non-profit organization. This plugin has some constraints as well for JiraTeam Calendars for Confluence provides one place for fast-moving teams working in Confluence to stay in sync – so they know who’s doing what and when. Teams can stay organized and communicate availability with a schedule of personal and team events linked to their personal calendars and Confluence pages. Sync Team Calendars for Confluence with Outlook, Google Calendar (Android) and Apple Calendar. Visit the Atlassian website to learn more. Plugin Dependency - To enable the Jira Software integration features for Team Calendars for Confluence you must install the Team Calendars for Confluence for Jira Integration Plugin in Jira. This plugin is bundled in Jira 4.4.x and or later. Google Calendar Page MacroThis app is billable starting about $.25 per month per registered user or less than $3 per year per registered user After installing the app on a page, it shows either a 7 day or a 30 day list of events If I select any event in the list, it opens a new window showing the standard Google Calendar with all the options I normally have. Here, I can add subscriptions to other calendars, import calendar events etc - everything we normally do in Google Calendar Overall not a bad solution and reasonably affordable compared to other Google Calendar plugins |
Confluence Global Templates
Templates are pre-defined pages that can be used as prototypes across the site. You can see I credited a custom template ( Article template ). Confluence also comes with a nice set of pre-built When you create a new page you have the option of using an existing template |
Confluence pages have a New editor and an Legacy Editor
Atlassian has been working on the new editor for a while to make it useful. The Legacy Editor used a plugin editor that is a widely used Web page editor for wikis. By default, all pages have the new editor. To create a page with the new editor, just click the icon and select a page template. To use the Legacy Editor, you need to import pages from ANOTHER space that still has the Legacy Editor. Confluence has been smart enough to allow users to choose the right editor for their needs. Generally, the editors are "almost" WYSIWYG ( What You See Is What You Get ) After editing a page, you "Publish" it to see the changes. Confluence offers some basic page layout controls ( eg 2 column layout etc ). In addition, you can use the tables as "layout controls" for more complex layouts even embedding tables as needed. Editing a Table in the New EditorWhen you create a page from a template, you are using the new editor. To add a row to a table, you have to hover carefully over the plus sign and click to open up the next row Editing a Table in the Legacy EditorWhen you copy a page that uses the Legacy Editor, the new page has the Legacy Editor. To add a row to a table, you just click the add row icon on the editor menu bar. Very fast to add or delete many rows. Page Edit History - a great feature !Here I've selected 2 versions of a page to compare and the view shows all the details of what was added, changed or deleted. A few features in the New EditorSome highlights:
Page CommentsYou can allow users ( registered or anonymous ) to comment on a page not. As a space administrator, you have the option to delete any selected comment on a page. You can also assign permissions to registered and anonymous users on their ability to add or delete comments in a space. |
Confluence Search Query, Advanced Search and CQL - Confluence Query Language
The space header search barThe search bar at the top of the space provides an easy way to enter a search string to show all pages that match to a degree in a hyperlinked results list. ( see the results list below ) Default Search ResultsBy default, you can enter a text string into the search bar for the space. Confluence will search the spaces you have access to and build a results list of hyperlinked documents You have an option to run an advanced search at the bottom. Advanced SearchUsing the advanced search button at the bottom of the search results list allows access to Advanced Search. The filter fields are listed on the right side of the page. Here, I entered a search for pages that have Grails label ( Tag ) on the page You can see how well I can use page labels for targeted searches CQL - Confluence Query LanguageIf you know SQL, you'll love the extra precision you can achieve using a CQL query. CQL Similar to the filters page in advanced search, a user can enter a query using CQL - Confluence Query Language. CQL has a set of pre-built attributes similar to the advanced query form. This allows you to create a detailed query script that can used later by a user or via the Confluence REST API. For details on the keywords and syntax in CQL, see these links https://confluence.atlassian.com/doc/confluence-search-fields-161188.html https://support.atlassian.com/confluence-cloud/docs/confluence-search-syntax/ |
Confluence Development Options
For content integration, developers can:
- build content for Confluence creating macros or using iFrames
- integrate content from Confluence using the REST API
Development is easier with Confluence Server where a developer can have access to server logs on runtime errors.
In Cloud version, there is a simple failure message but you don't have full access to the runtime logs to debug issues.
Confluence Blueprints
Confluence Blueprints are a special type of Template that supports creation of dynamic content when the page runs. Other wiki platforms offer similar dyanmic page loading development options. A JSPWiki knowledge base I created had Javascript code that could query any JDBC database with a standard SQL Select statement returning a scrollable data table. The plugin eliminated creating many custom report apps in typical BI tools |
Create a simple Blueprint
https://developer.atlassian.com/server/confluence/write-a-simple-confluence-space-blueprint/
Confluence iFrame Macro can insert another app in a page
Given Confluence Cloud as a runtime, there are issues that limit the use of other Web apps inside a Confluence iFrame. One issue is the need for iFrame properties on the app origin to be flexible given the app will not be served typically from the same origin. For more on using iFrames in Confluence Cloud see: https://developer.atlassian.com/cloud/confluence/cacheable-app-iframes/#prefetching-app-iframes |
Confluence Developer Site
https://developer.atlassian.com/
The developer guide is the starting place to learn how to develop a Confluence app. https://developer.atlassian.com/developer-guide/start-building-with-atlassian/ Who hosts the app? If you build an app for a cloud product, then you'll be responsible for hosting your app, whereas on a server or Data Center product the app will be hosted by the customer. At a glance Cloud apps:
The Cloud developer documentation includes API info https://developer.atlassian.com/cloud/ |
Confluence REST API
https://developer.atlassian.com/cloud/confluence/rest/
This is the reference for the Confluence Cloud REST API. This API is the primary way to get and modify data in Confluence Cloud, whether you are developing an app or any other integration. Use it to interact with Confluence entities, like pages and blog posts, spaces, users, groups, and more. NOTE: Personal data that is used to identify users, such as For more on Confluence development, see |