Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
overridefalse
Short DescriptionTools from the projectdoc Toolbox to import from and export to other information systems.
Doctypetopichide
NameConfluence as Information Hub
Short Name
Parent
Parent Property
propertyParent
property-nameName

Audience

Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesDocumentation Architect, Author
propertyAudience
empty-as-nonefalse


Level of Experience

Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesCompetent
propertyLevel of Experience


Expected Duration
Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags

Tag List
namesprojectdoc Toolbox, add-on, Confluence, Information System, Integration, Information Hub
propertyTags

hide
Iteration

Iteration
valuefilled

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namestip
propertyType


Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide
enable-heading-numberstruehide
Column
Panel
titleContents
Table of Contents
outlinetrue
indent10px
stylenone
Section
show-titlefalse
titleDescription

Stakeholders need to use the tools they get there work done most productively. Therefore there is no one tool to rule them all. On the other hand stakeholders need to exchange information via a common gateway - the information hub . A wiki or a collaboration platform like Confluence is such a hub.

Note Box
titleSingle Point of Access

In the context of ADOC we call this practice to introduce an information hub Single Point of Access.

This short tip shows how macros from the PDAC1 support teams to make information accessible from the hub.

  1. Transclude information from other information systems using the Information Systems Extension
  2. Export information to Confluence and import from it via the Web API Extension.
  3. Attach properties files to projectdoc documents.
Section
titleSummary

Section
titlePrerequisites

You need have installed the Information Systems Extension and the Web API Extension on top of the PDAC1 on your Confluence server.

It is also recommended to install the Core Doctypes Add-on.

Note Box

All extensions and doctype add-ons for the projectdoc Toolbox are free of charge. Confluence and the projectdoc Toolbox are software with commercial licenses.

All add-ons are available on the Atlassian Marketplace!

Section
titleInformation Systems

The Information Systems Extension connects to remote servers and transcludes information into Confluence pages. Content to transclude may be text or images. The extension provides also macros to make linking information quite easy.

The projectdoc Toolbox is also intended for software development teams in a moving development environment, where servers change from time to time. Therefore the extension allows to set the root URL for each server as a space property. In case the server got a new address, only this base URL needs to be changed.

The extension provides the following macros to link and transclude information from remote servers.

Display Table
doctypemacro
render-modedefinition
selectName, Short Description
where$<Extension>=[Information Systems Extension] AND Iteration NOT Deprecated
exclude-selffalse

Section
titleWeb API

The projectdoc Toolbox makes projectdoc documents available via a RESTAPI. Information may be easily read from a property or section. The API also allows to change the values of properties and sections.

Display Table
doctypeaddon-component
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
sort-bySort Key, Name
where$<Direct Ancestor Title>=[Web API Extension]

Here are some examples using cURL to access information from projectdoc documents.

Tour
render-as-definition-listtrue
replace-title-with-nametrue
Tip Box
titleBookmarklets!

The Bookmarklet Extension allows to create bookmarklets for your browser for tasks you need to execute more often.

Section
titleAttachments

Using the Document Properties Supplier Attachment Macro projectdoc documents may make properties specified in properties files available as document properties.

In cases where a remote system has no direct access to the Confluence server, properties may be exported in form of a file and attached to a projectdoc document.

Section
titleSubordinate Topics
Display Table
doctypetopic
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name
Section
required-permissionswrite-access
titleNotes

Section
titleReferences

Section
titleResources

Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto