Scripting-API

Verwende diese schreibgeschützten Helfer aus einer Funktion, die von einem DSL-Ausdruck script= aufgerufen wird. Sie stellen den aktiven Auswertungskontext bereit und sind keine allgemeine Runtime-API.

Grenze: Snapshot-Helfer liefern außerhalb der Auswertung einen leeren oder Standardwert. Memstore-Loader erfordern einen aktiven Kontext und melden andernfalls einen katalogisierten Task-Konfigurationsfehler. Zurückgegebene Container sind Kopien.

Für Werte aus verschachtelten Datensätzen beginne mit den Auswertungsscopes. Durchsuche alle sicheren Globals, Entities, Generatoren, Converter und eigenen Komponenten. Das vollständige Scripting-API-Projekt führt alle sieben Helfer an ihrer echten Auswertungsgrenze aus.

Anwendungsfall

Das vollständige Scripting-API-Projekt ruft jeden Helfer auf.

get_context_info

Zweck: Return a read-only snapshot of the current evaluation context.

Signatur: get_context_info()

Parameter

• None.

Rückgabe

Ein Snapshot-Mapping; nicht verfügbare Kontextwerte sind None.

get_current_product

Zweck: Return a copy of the current product being generated.

Signatur: get_current_product()

Parameter

• None.

Rückgabe

Ein dynamisches Datensatz-Mapping oder None, wenn kein Produkt aktiv ist.

get_property

Zweck: Return a read-only property value from the root context.

Signatur: get_property(name, default=null)

Parameter

• name: str; erforderlich.
• default: dynamischer Python-Wert; Standard null.

Rückgabe

Der dynamische Python-Wert aus dem aktiven Descriptor oder der angegebene Standardwert.

get_record_position

Zweck: Return the current record position (1-based) when available.

Signatur: get_record_position()

Parameter

• None.

Rückgabe

int | null.

get_variable

Zweck: Return a read-only variable value from the current evaluation context.

Signatur: get_variable(name, default=null)

Parameter

• name: str; erforderlich.
• default: dynamischer Python-Wert; Standard null.

Rückgabe

Der dynamische Python-Wert aus dem aktiven Descriptor oder der angegebene Standardwert.

load_memstore

Zweck: Load memstore data for the current task.

Signatur: load_memstore(product_name)

Parameter

• product_name: str; erforderlich.

Rückgabe

Eine Liste dynamischer Datensatz-Mappings; Feldnamen und Werte stammen aus dem gespeicherten Produkt.

load_memstore_page

Zweck: Load a paged window of memstore data for the current task.

Signatur: load_memstore_page(product_name, skip, limit)

Parameter

• product_name: str; erforderlich.
• skip: int; erforderlich.
• limit: int; erforderlich.

Rückgabe

Eine Liste dynamischer Datensatz-Mappings; Feldnamen und Werte stammen aus dem gespeicherten Produkt.