Versions Compared

Key

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

Anchor
thisistop
thisistop

Table Of Contents

HTML
<style> .toc-macro ul {display: block; counter-reset: item} .toc-macro li {list-style-type:none} .toc-macro li:before {content: counters (item, ".")". "; counter-increment: item} </style>

Table of Contents
maxLevel2
outlinetrue
exclude(Table Of Contents).*
styledecimal

Objective and Scope


Objective of this Procedure

This document describes how to create and maintain Work Instructions Operating Procedure (OP) in Confluence, including approval process and best practices to be followed in order to ensure aligned maintenance approach between different domains and processes. 

Scope

Data Operations Team based in Riga is responsible to create and maintain Work Instructions Operating Procedures (OP) for procedures in their scope, including customer, vendor and material data maintenance in Baan and SAP systems for GBU's within Riga Data Operation teams scope as well as Work Instructions Operating Procedures (OP) for any other additional activities. 

Roles & responsibilities of each actor 

The approval process below is in place to ensure a 6 eye check for OP according to audit standards.

Editor (Data Operations Specialist L1/L2) - once a need for new work instructions OP or update of existing ones is identified Editor creates or updates the corresponding confluence page and submits it to Reviewer in a timely manner.  

Reviewer (Data Operations Team Lead/Manager) - reviews the OP to ensure that nothing is missing and everything is updated correctly.

Approver (Data Operations Manager/ Approver (IS Supply Chain M&S Data Architect) -    approves the changes. Process and any changes should be approved by them before they are added in the OP. 


Creating a new page


To create new page in Confluence press "Create" on the upper left corner. 


It's advised to use Riga Data Operations WI Template which provides general layout of the Work Instructions Operating Procedure which includes:

  • Formatted Table of Contents
  • Back to top button


Once Template is open :

  • Change the parent page, if it's incorrect;
  •  Add labels to ensure that your page will appear correctly in the Data Operations space.  For more details see chapter Labels.
  • Page title - add name of the work instructionsOP.
  • Chapter name - add name of the chapters. Usually work instructions OP should start with "Objective and Scope". Can be completed later.
  • Body of the WI - add text of the work instructionsOP. Can  Can be completed later.

To save your progress press 

Info

Pressing Publish will only save your progress and will make your instructions page visible to other Editors only.






Publishing a page


To make added document as "published" for everyone you need to follow the steps below.

  • Press on the status showing "draft" and press "submit" for review:

Image Added

  • Add the reviewer's email. For Riga Operations you can see in this file*.
    *This file is currently kept up-to date only for Riga SC.

Image Added

  • Once the reviewer will review the document he / she will do the same and add the approver. It should automatically send an email to the appropriate person. After the approver has approved it, the status of the document is changed "published". At this moment updated document is visible for everyone.

Image Added


Labels 
Anchor
labels
labels


Labels (tags) drive the organization of the files under service center sections of the Data Operation space. For Operating Procedure to appear under Riga SC page, use "riga_sc" label.  Use appropriate labels from the table below to store them under correct domain. 

Labels that are currently used by Data Operations in Riga:

TagSection
riga_scRiga SC page
data_operations
customerCustomer
material

Material

vendorVendor
contractsContracts and PIR's
pirContracts and PIR's
intercompanyAgents/Intercompany
agentsAgents/Intercompany


Image Added


Best practices


Find below some best practices for maintaining the document. 

Info

Feel free to switch this document to "Edit" mode to see the how these tools are used in practice.

You can also use "View Source" to see detailed view of the document.


Headers

In order for Table Of Contents to work correctly please use Header 1Header 2 etc. for chapter headers.

After Header 1 use horizontal rule. 





Page Layout

Structure your page using Page Layout. 

  • Use do divide text into columns. For example, to one column for text, other for pictures. 
  • Add empty sections to create space between parts of the page.


Images

Warning

Never copy images directly from Google Drive documents!

When inserting an image from a link or Google document make sure the image is uploaded into Confluence and does not retain the link to the source; otherwise you risk of loosing an image when it is deleted from the source.

For Google documents it is also true if the access to the document, where the image comes from, is restricted.


Appendixes

Please follow the guidelines below when adding or referring to an Appendix:

  • Do not number the Appendixes. 
  • Always refer to the Appendix with it's full name, e.g. "Appendix - Macros used in Template", to ensure, that text is readable even if the link is broken.
  • Please use Anchor to link to the appendix. This will ensure, that link remains intact even if the name of the appendix is changed.


Useful Macros


Below you will find examples of some useful Macros available in confluence. You can find all macros by pressing and choosing "Other macros" at the bottom of the list. Please note that the list is not comprehensive.

Info

Feel free to switch this document to "Edit" mode to see the how these tools are used in practice.


Anchor

Use anchor to refer to a place in your page, e.g. a title.  Please find details on how to create and link to Anchors here


Boxes

Use Info, Note, Warning or Panel to highlight information.







Info

Info Box


Note

Note Box


Warning

Warning Box


Panel
borderColorBlack
bgColor#DFE1E5
titleColorWhite
titleBGColorBlack
borderStylesolid

Panel Box



Columns

Divide text into two or more columns in another object, e.g. in a warning tab. You will need to use two macros:

  • Section macros - Creates an object (box) in which Columns are stored
  • Column macros - Creates column in Section macros. You can add multiple columns and indicate their with, for example, in %. 

More details can be found here


Section
bordertrue


Column
width50%

Column 1


Column
width50%

Column 2




Tabs

Create interactive tabs. You will need to use two macros:

  • SP Tabs group macros - Creates an object (box) in which tabs are stored
  • SP Tab pane macros - Creates tab in the Tabs group. You can add multiple tabs.

When printing:

  • Tabs will print sequentially
  • Tab names do not print. Best practice is to repeat tab name in the section.


Warning

Search (CTRL+F) works only in the open tab. If needed you can add keywords box at the bottom of the Tabs Group, to indicate what keywords can be found in each tab.



Tabs Group | Vectors (Formerly: SP Tabs group)
dispositionhorizontal
colorgreen#36B37E


Tab Pane | Vectors (Formerly: SP Tab pane)
anchor80560710
nameTab 1

Tab 1

Text in tab 1


Tab Pane | Vectors (Formerly: SP Tab pane)
anchor80560711
nameTab 2

Tab 2

Text in tab 2


Tab Pane | Vectors (Formerly: SP Tab pane)
anchor80560712
nameTab 3

Tab 3

Text in tab 3




GDrive documents

To avoid duplicating information in multiple places you can insert different GDrive documents directly in Confluence page. 

Note

Make sure that the sharing settings of the GDrive document has view access enabled.


Embedded Google Drive File
docid1MgFwPaycavP22wBeY79KdBp58vf5YEtAgcgveri8XiE
height300px


Appendix - Macros used in Template
Anchor
TemplateLayout
TemplateLayout

html


Table of contents numbering

To achieve the table of contents numbering you will need:

  • HTML macro with code
  • Table of contents macro

Steps to follow:

  1. Insert HTML macro and add the following code into it:

    Code Block
    languagexml
    <style>
    .toc-macro ul {display: block; counter-reset: item}
    .toc-macro li {list-style-type: none}
    .toc-macro li:before { content: counters(item, ".") ". " ; counter-increment: item}
    </style>


  2. Insert Table of contents macro with following adjustments:

    • Output Type: list
    • List style: none
    • Exclude Headings: (Table of contents).* - will exclude headings listed.

Resulting TOC will look like this:

Image Added

"Back to top" button

To create a button that brings you to the top of the wiki page you will need following:

  • HTML macro with code
  • HTML wrap macro with an assigned ID
  • An image for the button
  • An anchor that leads to the top of the page

Steps to follow:

  1. Create an anchor at the top of the page and give it a name.  In this example the name is "thisitop"
    Image Added
  2. Insert an HTML Wrap macro and assign a CSS ID to it (ID = backToTopButton). Leave the rest unchanged
    Image Added
  3. Place an image for the button inside the HTML Wrap.
    Image Added
    Standard image can be found in Data Operations space, by using insert image Image Added.
    Image Added

  4. Create an advanced link Image Added for the image to the anchor you made earlier. 
    Image Added
  5. Insert an HTML macro and add the following code in it:

    Code Block
    languagexml
    <style>
    #backToTopButton {
    	position: fixed;
    	right: 20px;
    	bottom: 20px;
    	Z-index: 1;
    }


The final composition looks as follows:

Image Added

Info

It is best if you place the setup in a separate block at the bottom of the document. It will look better on the PDF output.




HTML
<style>
#backToTopButton
#ReqForTaxNr {
	overflow: auto !importantposition: fixed;
	right: 20px;
	bottom: 20px;
	Z-index: 1;
}
</style>


HTML Wrap
idbackToTopButton
classnoprint

Riga SC WI maintenanceImage Added