A parameter is a configuration option. Parameter exist on different layers. Wizard and macro parameters are configuration options. Use
parameter types to organize them!

Categories: / Doctype / API
ID: app-parameter
Suite: App
Since: 1.0

Properties

The document type app-parameter provides the following properties:

Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

ID

Specify the unique parameter identifier.

Type

Declare the type of this parameter. This information is used for categorization and allows to collect all parameters on the referenced type page.

Suite

Specify the suite of tools the parameter belongs to. Typically inherited from the parent document.

App Tool

Specify the app the parameter belongs to. Typically inherited from the parent document.

Datatype

Define the datatype for the parameter.

Default Value

Specify a default for the parameter.

Value Range

List valid values or the range of valid values.

Content

Since

Specify since which version this feature is available.

Deprecated

Specify since which version this feature is marked as deprecated.

Removed

Specify since which version this feature has been removed.

Sections

Description

Describe the use of the parameter.

Subordinate Parameters

Provide information for subordinate parameters.

Notes

These are internal notes that are usually not exported and only visible to team members with write access.

But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.

The text of notes sections is also indexed.

References

For a document the references section contains pointers to resources that prove the statements of the document.

Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.

For further information please refer to References and Resources.

Resources

The resources section provides references to further information to the topic of the document.

This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.