Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{repository-workflow:comalatech.techdoc|categories=techdoc|chart=techdocoworkflow_850px.png} {repository-description:name=Technical Documentation Workflow} Simple tech docs review workflow * Pending pages are restricted from read only viewing and will expire if not approved within the specified period of time. * Pages approved within the set time are published and visible to all users. {repository-description} {workflow-body} {workflow
Wiki Markup
Info

Importing workflows

Find out how to Import Workflows

Technical Document Management workflow

requires v3.0.2+

com.comalatech.workflow.repository.categories.label: Technical Documentation

-Image Added

Simple tech docs review workflow

  • Pending pages are restricted from read only viewing and will expire if not approved within the specified period of time

  • pages approved within the set time are Published and visible to all users


Technical Documentation Workflow Markup

Code Block
{workflow:name=Technical Documentation Workflow}
	{description}
Simple tech docs review workflow, pending pages are restricted from read only viewing and will expire if not approved within the specified period of time, pages approved within the set time are published and visible to all users.
    {description}
    {workflowparameter:Document Editors|description=Only members of this users group can view pending documents|type=group}
        confluence-users
    {workflowparameter}
    {workflowparameter:Pending Expiration|description=If a page stays in 'For review' for this period of time, then the state will be changed to 'Expired'|type=duration}
        P10D
    {workflowparameter}
    {state:Pending|submit=For review|taskable=true}
    {state}
    {state:For review|approved=Published|rejected=Pending|expired=Expired|taskable=true|hideselection=true|duedate=@Pending Expiration@}
        {approval:Publish|assignable=true}
    {state}
    {state:Published|final=true|updated=For review}
    {state}
    {state:On hold|submit=For review|hidefrompath=true}
    {state}
    {state:Expired|hidefrompath=true}
    {state}
    {trigger:statechanged|state=Pending|initial=true}
        {add-restriction:type=View|group=@Document Editors@}
    {trigger}
    {trigger:statechanged|state=Published}
        {remove-restriction:type=View}
    {trigger}
    {trigger:statechanged|state=On hold}
        {add-restriction:type=View|group=@Document Editors@}
    {trigger}
    {trigger:taskassigned}
        {send-email:user=<at:var at:name="assignee" />|subject=<at:var at:name="task" /> has been assigned to you}
        Task <at:var at:name="task" /> on <at:var at:name="page" /> has been assigned to you by [~<at:var at:name="user" />].
        {quote}<at:var at:name="comment" />{quote}
        {pageactivity}
        {send-email}
    {trigger}
{workflow}

...

(warning) In later versions of Comala Document Management variables in the following syntax <at:var at:name="page" /> can simply be replaced by the name of the value reference enclosed in @ symbols for example @page@

Technical documentation process

...

Learn more

  • if a

    published

    Published page is updated, then it is sent for review again

    .

  • read-only users only have access to the

    published versions only.

    content version created on the last transition to the Published state

  • if pages for review are not reviewed within a set period of time, content transitions to the

    expired

    Expired state

    .

  • published pages can be put on hold to be hidden from the public, but will not be required to undergo content review and approval

    .

  • the users assigned as page editors and the expiration period are configurable as workflow parameter values

    .