Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

WORK IN PROGRESS (see also Pentaho internal DOC-1940)

Notes for the documentation template: Each section contains a description about it's purpose, if it is mandatory or optional and an example that begins or contains the words "Lorem ipsum".

Description

(Mandatory, general and high level overview about the step or job entry.)

The Lorem ipsum step (or job entry) is a placeholder text commonly used to demonstrate the graphic elements of a document or visual presentation. By replacing the distraction of meaningful content with filler text of scrambled Latin it allows viewers to focus on graphical elements such as font, typography, and layout.

May include screenshot here?

(Optional, special notes that need attention about the general, high level overview. Other notes that are specific to some options or sections should be in the section they belong to.) Lorem ipsum note.

Prerequisites

(Optional, in case prerequisites needs to be met and/or checked.) Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

Installation

(Optional, in case installation topics need to be performed.) Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

Configuration

(Optional, in case configuration topics need to be performed.) Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

Options

(Mandatory, describe the Options and Description for each property of the step or job entry. When multiple tabs are included, separate the Options within these tabs (see Lorem ipsum tab 1 & 2). TBD: 1) Omit not needed information: e.g. step name (should be describes not within each step/job entry but at the beginning) 2) Should we omit other obvious properties? 3) Should we omit the recurring information in field tables like: field name, type, length, precision etc. ?)

Option

Description

Lorem ipsum option1

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam.

Lorem ipsum option2

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam

(Optional, Notes are allowed in each section of the document.)

Lorem ipsum tab 1

Option

Description

Lorem ipsum option1

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam.

Lorem ipsum option2

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam

Lorem ipsum tab 2

Option

Description

Lorem ipsum option1

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam.

Lorem ipsum option2

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam

Context

(Mandatory, describe the context when this step or job entry is used. It is also possible to link to another page.)

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

Example

(Mandatory, describe at least one example or link to link to another page or reference at least one sample within the PDI distribution.)

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

Sample within the PDI distribution: data-integration/samples/transformations/Aggregate - basics.ktr
Lorem ipsum: http://en.wikipedia.org/wiki/Lorem_ipsum

Reference Information

(Optional, in case internal or external links are related to this documentation topic, list them in this section.)

Lorem ipsum: http://en.wikipedia.org/wiki/Lorem_ipsum

Technical Information

(Optional, in case technical documentation for developers is provided, like a link to the source code, special topics for developers or links to the source code or Javadoc.)

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

Lorem ipsum: http://en.wikipedia.org/wiki/Lorem_ipsum

  • No labels