system.mes.getRootObject

Sepasoft MES Module Suite

getRootObject()

system.mes.signature.getRootObject() returns the MESSignatureRootTemplate instance that is the parent of all e-signature templates in MES. It is the direct-object counterpart to system.mes.signature.getRootLink(), which returns a lightweight MESObjectLink. If the root object does not yet exist in the gateway’s object store, the gateway creates it, persists it, and returns it.

Syntax

Copy Code
Python
system.mes.signature.getRootObject()

Parameters

This function takes no arguments.

Return Value

Type

Description

MESSignatureRootTemplate

The root signature template object. Its allowed child type is SignatureTemplate; all user and built-in signature templates are organized under this root in the MES object model.

Scope / Availability

Context

Notes

Gateway

Implemented on MESGatewayESignatureScript; delegates to ProductionRPCHandler.getRootSignatureTemplateObject().

Designer / client

Implemented on MESClientESignatureScript; calls the gateway via IProductionRPC.getRootSignatureTemplateObject() (Sepasoft Production Designer and clients where the module registers this API).

Requires the Sepasoft Production module with e-signature scripting on the gateway your session uses.

Excluded / Edge Cases

  • The call may create and save the root object on first use if it was missing; subsequent calls load the existing root.

  • There is no name or filter parameter; use getSignatureTemplate, getSignatureTemplateLinkList, getSignatureTemplateList, or related APIs to work with individual templates.

  • Prefer getRootLink() when you only need a link (for example, attaching parents or passing lightweight references); use getRootObject() when you want the full root MESSignatureRootTemplate without calling link.getMESObject().

Example Usage

Minimal Example

Copy Code
Python
root = system.mes.signature.getRootObject()

Complex example — obtain root and compare with link resolution

Copy Code
Python
root = system.mes.signature.getRootObject()
link = system.mes.signature.getRootLink()
rootFromLink = link.getMESObject()
# root and rootFromLink refer to the same logical root template object

Complex example — gateway script entry point for signature hierarchy

Copy Code
Python
rootTemplate = system.mes.signature.getRootObject()
# Use rootTemplate with other system.mes.signature.* APIs or MES object APIs
# as appropriate for your workflow (e.g. listing or saving templates).

Related Functions

  • system.mes.signature.getRootLink() — Returns MESObjectLink to the same root; use link.getMESObject() to resolve MESSignatureRootTemplate if you start from a link.

  • system.mes.signature.getSignatureTemplateLinkList(pageNo, pageSize, searchPattern) — Paged list of MESObjectLink entries for signature templates under the root.

  • system.mes.signature.getSignatureTemplateList(pageNo, pageSize, searchPattern) — Paged list of MESSignatureTemplate objects.

  • system.mes.signature.getSignatureTemplate(name) — Load a template by name.

  • system.mes.signature.createSignatureTemplate(name) / saveSignatureTemplate(signatureTemplate) — Create or persist templates (use saveSignatureTemplate where documented for template persistence).

Sepasoft MES Module Suite