Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

ReportEventLevel

All events with equal or higher severity will be reported.

Query

This parameter defines the translation to perform. The alternatives are:

  • Quality name to quality ID. The component will find the material quality ID of a given material quality name.
  • Quality label to quality ID. The component will find the material quality ID of a given material quality label.
  • Article name to article ID. The component will find the article ID of a given article name.
  • Article to article ID. The component will find the article ID of a given article.

Refresh strategy

This parameter defines when to perform translations. The alternatives are:

  • Never. Translations will never occur.
  • OnChange. Translations will be performed when the input to the component changes.
  • OnTimeAdvance. Translations will be performed every time step. (Not recommended)
  • OnTrigger. Translations will be performed initiated by a trigger signal.

Refresh result set on failure

This parameter affects the behavior in error situations. When true, repeating translation attempts will be performed when a translation fails. When false, no retry attempts are performed.

Keep value on failure

This parameter affects the behavior in error situations and decides whether the value of the previous translation shall be available on the output port if the current translation fails.

Report errors

When this parameter is true translation errors will be reported.

Output type

This parameter decides whether it is expected single or multiple valid translations of one single input.