Page History

Table of Contents

Code Block
.create("org.apache.streampipes.example.timestampextractor") .category( 01 ) .withLocales( 02 ) .withAssets( 03 )

01 category

With Category you can divide the processors into certain groups. In the pipeline editor, you can sort all installed processors by groups or names (default).

...

The visible result looks as follows

Image Modified

The DataProcessorType enum has the following structure and is part of the StreamPipes model SDK description.

...

The enum has the base structure of with

Code Block
NAME(String label, String description)

...

Code Block
EN("en"), # => string.en DE("de"); # => string.de

.withLocales(Locales.EN)

...


Image Added

An advantage of this additional facility is that the title and description do not need to be set in the creation method:

Code Block
.create("org.apache.streampipes.example.timestampextractor", "Timestamp Extractor", "Extracts a timestamp into its individual time fields.")

You can offload this to the appropriate Sting file. Use only the create(String id) method.

Code Block
.create("org.apache.streampipes.example.timestampextractor")

This internal ID must be used in the string file and with the extensions "title" and "description" you can now also enter the same text. For this reason, the ID must also be unique!
The result looks like this:

Code Block
org.apache.streampipes.example.timestampextractor.title=Timestamp Extractor org.apache.streampipes.example.timestampextractor.description=Extracts a timestamp into its individual time fields.

...

Image Added

In addition to this general information about the functionality, you can also write a user help for each required field. Without this additional information, it may be difficult for the user to understand all the options.

Image RemovedImage Added

For required data streams and properties, you can also add a title or description to these fields by using the string internalId. For this purpose, you can refer to the internalId as follows

Code Block


.requiredStream(  
    StreamRequirementsBuilder  
        .create()  
        .requiredPropertyWithUnaryMapping(EpRequirements.timestampReq(),  
            Labels.withId("timestampField"), PropertyScope.NONE)  
        .build())  
.requiredMultiValueSelection(Labels.withId("selectedOutputFields"),  
    ...  
)

...

Code Block
timestampField.title=Timestamp Field selectedOutputFields.title=Extract Fields

...

Image Added

Code Block
timestampField.title=Timestamp Field

...

 
timestampField.

...

descri
ption= Select a timestamp from the event stream.

...

selectedOutputFields.title=Extract Fields

...

selectedOutputFields.description= Choose what fields ot the timestamp you want to extract via multiselection.

...

We also recommend not to use too many characters in the description and to use XXX characters maximum!

Image RemovedImage Added

Make sure that you also include the Apache license header in the file before you commit it!
At the end, the file "string.en" has the following content:

Code Block

#  
# Licensed to the Apache Software Foundation (ASF) under one or more  
# contributor license agreements.  See the NOTICE file distributed with  
# this work for additional information regarding copyright ownership.  
# The ASF licenses this file to You under the Apache License, Version 2.0  
# (the "License"); you may not use this file except in compliance with  
# the License.  You may obtain a copy of the License at  
#  
#    http://www.apache.org/licenses/LICENSE-2.0  
#  
# Unless required by applicable law or agreed to in writing, software  
# distributed under the License is distributed on an "AS IS" BASIS,  
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
# See the License for the specific language governing permissions and  
# limitations under the License.  
#  
  
org.apache.streampipes.processors.transformation.jvm.processor.timestampextractor.title=Timestamp Extractor  
org.apache.streampipes.processors.transformation.jvm.processor.timestampextractor.description=Extracts a timestamp into its individual time fields.  
  
timestampField.title=Timestamp Field  
timestampField.description= Select a timestamp from the event stream.  
  
selectedOutputFields.title=Extract Fields  
selectedOutputFields.description= Choose what fields ot the timestamp you want to extract via multiselection.

...

`03 Assets`

Code Block
.withAssets(String assets)

The withAssets function allows to enrich the processor with additional (visual) information. There are two types of assets and the associated files must be placed in the resource folder like the locales string file.

Assets.DOCUMENTATION ⇾ documentation.md
Assets.ICON ⇾ icon.png

`Documentation`

Code Block
.withAssets(Assets.DOCUMENTATION)

...

Image Added

The documentation allows a more detailed description of the main purpose of the processor, some general background information and more details about all required fields. It should also explain a visual description of the output result. The documentation file is a simple Markdown file and can be written using a which with simple Markdown syntax.

In this use case, we can equip more information with the following documentation:

Code Block

<!--  
  ~ Licensed to the Apache Software Foundation (ASF) under one or more  
  ~ contributor license agreements.  See the NOTICE file distributed with  
  ~ this work for additional information regarding copyright ownership.  
  ~ The ASF licenses this file to You under the Apache License, Version 2.0  
  ~ (the "License"); you may not use this file except in compliance with  
  ~ the License.  You may obtain a copy of the License at  
  ~  
  ~    http://www.apache.org/licenses/LICENSE-2.0  
  ~  
  ~ Unless required by applicable law or agreed to in writing, software  
  ~ distributed under the License is distributed on an "AS IS" BASIS,  
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
  ~ See the License for the specific language governing permissions and  
  ~ limitations under the License.  
  ~  
  -->  
  
## Timestamp Extractor  
  
***  
  
## Description  
  
This processor extracts a timestamp into the individual time fields (e.g. day field, hour field, ....)  
  
***  
  
## Required inputs  
  
This processor requires an event that provides a timestamp value (a field that is marked to be of type ``http://schema  
.org/DateTime``.  
  
***  
  
## Configuration  
  
### Timestamp Field  
  
The field of the event containing the timestamp to parse.  
  
### Extract Fields  
  
Select the individual parts of the timestamp that should be extracted, e.g., Year, Minute and Day.  
  
## Output  
  
The output of this processor is a new event that contains the fields selected by the ``Extract Fields`` parameter.

...

The user can access the documentation in the pipeline editor at various points.

In the Data Processor Overview by clicking the question mark button.
In the Pipeline Processor Element in the Build Board by clicking the question mark button.
In the processor setup windows by activating the show documentation button.

Image Removed Image Removed

...

Image Added

`Icon`

Code Block
.withAssets(Assets.DOCUMENTATION, Assets.ICON)

Up to now, the processor is called TE (Time Extraction) due to the first two capital letters of the title. However, this can lead to a misunderstanding situation. Imagine there is another processor with the name "Threshold Extractor" and also without an provied a provided icon.Image Removed

As you can see, they have the same icon, but different titles. Everything still works, but the visual impression and identification could be improved to provide a better user experience!

Therefore, you can create a custom icon (named icon) in PNG format and paste it into the resources folder.

Image RemovedImage Added

The icon should meet the following conditions

...

You can also add the icon in the documentation by adding:

Code Block
... ## Timestamp Extractor

...

<p align="center">

...

<img src="icon.png" width="150px;" class="pe-image-documentation"/>  
</

...

p>
...

Image Added

...

`Template`

`documentation template`

Code Block

collapse	true

<!--  
  ~ Licensed to the Apache Software Foundation (ASF) under one or more  
  ~ contributor license agreements.  See the NOTICE file distributed with  
  ~ this work for additional information regarding copyright ownership.  
  ~ The ASF licenses this file to You under the Apache License, Version 2.0  
  ~ (the "License"); you may not use this file except in compliance with  
  ~ the License.  You may obtain a copy of the License at  
  ~  
  ~    http://www.apache.org/licenses/LICENSE-2.0  
  ~  
  ~ Unless required by applicable law or agreed to in writing, software  
  ~ distributed under the License is distributed on an "AS IS" BASIS,  
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
  ~ See the License for the specific language governing permissions and  
  ~ limitations under the License.  
  ~  
  -->  
  
## PROCESOR NAME  

<p align="center">  
    <img src="icon.png" width="150px;" class="pe-image-documentation"/>  
</p>
  
***  
  
## Description  

TEXT
  
***  
  
## Required inputs  

TEXT

***  
  
## Configuration  
  
### Timestamp Field  
  
TEXT
  
### Extract Fields  
  
TEXT
  
## Output 

TEXT with Example

...

`Icon PNG template`

This template can be used in gimp or other pixel-based programs!

...

Page tree

Versions Compared

Old Version 1

New Version Current

Key

01 category

`03 Assets`

`Documentation`

`Icon`

`Template`

`documentation template`

`Icon PNG template`