system.mes.createSignatureTemplate(name)

Sepasoft MES Module Suite

createSignatureTemplate(...)

Creates a new, unsaved MESSignatureTemplate with a given display name. The object is created with user ownership and forceUniqueUser enabled; configure expression, timeout, and other properties, then persist it with system.mes.signature.saveSignatureTemplate.

Syntax

Copy Code

Python

system.mes.signature.createSignatureTemplate(name)

Parameters

Parameter	Type	Required	Description
name	String	Required	Name for the new signature template. Must be unique among existing templates (comparison is case-insensitive) and must pass MES name validation.

Return Value

Type	Description
MESSignatureTemplate	A new, in-memory signature template. It is not written to the gateway until you call system.mes.signature.saveSignatureTemplate.

Scope / Availability

Registered on the system.mes.signature script module.
Gateway: Executes on the runtime gateway.
Designer / Client: Same API; calls are sent to the connected gateway via RPC.

Excluded / Edge Cases

Unsaved result: Nothing is persisted until system.mes.signature.saveSignatureTemplate succeeds.
Runtime only: If the operation does not run on the runtime server, an UnsupportedOperationException is raised.
Feature support: If authentication challenge / signature features are not supported on the connected Ignition version, an UnsupportedOperationException is raised.
Duplicate name: If another signature template already uses the same name (case-insensitive), a ResourceNamingException is raised with a message that the name already exists.
Invalid name: If the name contains invalid characters for MES object names, a ResourceNamingException is raised.

Example Usage

Minimal Example

Copy Code

Python

template = system.mes.signature.createSignatureTemplate("My New Approval")
saved = system.mes.signature.saveSignatureTemplate(template)

Complex Example

Copy Code

Python

if system.mes.signature.isSignatureNameExists("Line Clearance Sign-off"):
	raise Exception("Template name already in use.")

template = system.mes.signature.createSignatureTemplate("Line Clearance Sign-off")
template.setDescription("Second operator confirms line clearance before resume.")
template.setExpression("{role:Operator}")
template.setForce(True)
template.setTimeout(5)

saved = system.mes.signature.saveSignatureTemplate(template)

Related Functions

system.mes.signature.saveSignatureTemplate(signatureTemplate) — Validates and saves a signature template.
system.mes.signature.copySignatureTemplate(mesObjectLink) — Creates a new unsaved template by copying an existing one.
system.mes.signature.isSignatureNameExists(name) — Returns whether a name is already taken before creating a template.
system.mes.signature.getSignatureTemplate(name) — Loads an existing saved template by name.
system.mes.signature.removeSignatureTemplate(mesObjectLink) — Disables and removes a user-created template by link.

Sepasoft MES Module Suite