Annotations on ScipioERP

Service annotations

Tue, 08 Sep 2026 00:00:00 +0000

Source: framework/service/src/com/ilscipio/scipio/service/def/.

@Service#

Defines one service. Place it on a nested public interface inside a container class; the interface itself carries no members.

Attribute	Type	Default	Meaning
`name`	String	`""`	Service name. Defaults to the method or class name in camelCase.
`description`	String	`""`	Service description.
`deprecated`	String	`""`	Deprecation note.
`deprecatedSince`	String	`""`	Version the service was deprecated in.
`deprecatedBy`	String	`""`	Replacement service name.
`implemented`	Implements[]	`{}`	Interfaces this service implements.
`entityAttributes`	EntityAttributes[]	`{}`	Attributes generated from an entity’s fields.
`attributes`	Attribute[]	`{}`	Explicit attribute list.
`overrideAttributes`	OverrideAttribute[]	`{}`	Overrides for attributes an implemented interface already declares.
`auth`	String	`"false"`	Whether a user login is required for the call to succeed.
`permissionService`	PermissionService[]	`{}`	Permission services to check.
`permission`	Permission[]	`{}`	Permissions to check.
`permissions`	Permissions[]	`{}`	Grouped permission checks with a join type.
`export`	String	`"false"`	Whether to export the service as a web service.
`validate`	String	`"true"`	Whether to validate attributes on invocation.
`defaultEntityName`	String	`""`	Entity that `entityAttributes` reads by default.
`useTransaction`	String	`"true"`	Whether to wrap the call in a database transaction.
`requireNewTransaction`	String	`"false"`	Whether to force a new transaction.
`hideResultInLog`	String	`"false"`	Whether to hide the result in the log.
`transactionTimeout`	String	`"0"`	Transaction timeout in seconds. `0` uses the transaction factory default.
`maxRetry`	String	`"-1"`	Max retries when run as a job. `-1` means no limit.
`debug`	String	`""`	Debug flag. Empty means the engine default, `"false"`.
`semaphore`	String	`"none"`	`"none"`, `"fail"` or `"wait"`.
`semaphoreWaitSeconds`	String	`"300"`	Wait time for a `"wait"` semaphore.
`semaphoreSleep`	String	`"500"`	Sleep interval while waiting.
`log`	String	`""`	Logging verbosity: `"normal"`, `"debug"` or `"quiet"`. Empty means `"normal"`.
`logEca`	String	`""`	Logging verbosity when invoked from an ECA. Empty means `"normal"`.
`priority`	String	`""`	Default job priority for async or scheduled runs.
`startDelay`	String	`""`	Fixed start delay in milliseconds.
`engine`	String	`""`	Service engine, for example `"java"`, `"simple"`, `"groovy"`.
`location`	String	`""`	Class or script location the engine invokes.
`invoke`	String	`""`	Method or entry-point name the engine invokes.
`invokes`	GroupInvoke[]	`{}`	For a `"group"` engine, the ordered list of services to run.
`accessorLocation`	String	`""`	Location of the accessor the engine uses.
`accessorInvoke`	String	`""`	Accessor method the engine invokes.
`namespace`	String	`""`	Namespace, for a service exported as a web service.
`namespacePrefix`	String	`""`	Namespace prefix, for a service exported as a web service.
`jobPoolPersist`	String	`""`	Job pool a persisted async run is queued on.
`logTraceExcludeDispatcherRegex`	String	`""`	Dispatcher names excluded from trace logging, as a regular expression.
`metrics`	Metric[]	`{}`	Metrics collected for this service.
`properties`	Property[]	`{}`	Free-form properties, read with `@Property`.

@Attribute#

One explicit service parameter, inside @Service(attributes = {...}).

Entity annotations

Tue, 08 Sep 2026 00:00:00 +0000

Source: framework/entity/src/com/ilscipio/scipio/entity/def/.

@Entity#

Defines one entity.

Attribute	Type	Default	Meaning
`name`	String	required	Entity name.
`packageName`	String	required	Entity package, for grouping in `entitymodel.xml` output.
`tableName`	String	`""`	Table name. Defaults to the entity name in upper case with underscores.
`description`	String	`""`	Entity description.
`title`	String	`""`	Human-readable title.
`author`	String	`""`	Author note.
`copyright`	String	`""`	Copyright note.
`version`	String	`""`	Version note.
`defaultResourceName`	String	`""`	Default UI-label resource for field titles.
`dependentOn`	String	`""`	Entity this one depends on for load order.
`sequenceBankSize`	int	`0`	Sequence bank size for id generation.
`enableLock`	boolean	`false`	Whether to enable optimistic locking.
`noAutoStamp`	boolean	`false`	Whether to skip automatic `createdStamp`/`lastUpdatedStamp` fields.
`neverCache`	boolean	`false`	Whether to disable entity caching.
`neverCheck`	boolean	`false`	Whether to skip schema checks.
`autoClearCache`	boolean	`true`	Whether to clear cache automatically on change.
`redefinition`	boolean	`false`	Whether this redefines an existing entity, to suppress duplicate warnings.
`fields`	Field[]	`{}`	Field list.
`primaryKeys`	PrimaryKey[]	`{}`	Primary key field list.
`relations`	Relation[]	`{}`	Relations to other entities.
`indexes`	Index[]	`{}`	Index list.

@Field#

One field, inside @Entity(fields = {...}).

Controller annotations

Tue, 08 Sep 2026 00:00:00 +0000

Source: framework/webapp/src/com/ilscipio/scipio/ce/webapp/control/def/.

@Controller#

Marks the class that groups a webapp’s requests, views and events. It carries no request data of its own.

Attribute	Type	Default	Meaning
`controller`	String	required	Controller location, as a `controller://` URL or a webapp name. `"default"` names the default webapp’s controller.

@Request#

Defines one request mapping. On a class it applies to every event method inside; on a method it uses that method as the event with default event options, unless the method also carries an @Event.

Widget annotations

Tue, 08 Sep 2026 00:00:00 +0000

Source: framework/widget/src/com/ilscipio/scipio/widget/def/, in five packages, one class per XML element of the widget schemas (151 files in screen, 62 in form, 21 in menu, 20 in tree, 7 in condition; each count includes a few enums, readers and [X]List repeatable-container classes alongside the annotations). This page lists the packages and their top-level annotations. It does not document every one; the class names below match the XML element names closely enough to read directly.

MCP annotations

Tue, 08 Sep 2026 00:00:00 +0000

Source: framework/mcp/src/com/ilscipio/scipio/mcp/def/. These annotations define the MCP servers and tools an AI agent calls; see Agents for the access model.

@McpServer#

Defines one MCP server profile, usually one per application component.

Attribute	Type	Default	Meaning
`name`	String	required	Server name.
`title`	String	`""`	Human-readable title.
`description`	String	`""`	Server description, shown to the agent.
`component`	String	`""`	Component directory name the server belongs to.
`webapps`	String[]	`{}`	Webapps the server is exposed on.
`featuredServices`	String[]	`{}`	Services ranked first in tool search.
`serviceAllow`	String[]	`{}`	Services explicitly allowed through the gateway.
`serviceDeny`	String[]	`{}`	Services denied on this server.
`entities`	String[]	`{}`	Entities the server may read through entity tools.
`allowAnonymous`	boolean	`false`	Whether the server accepts calls without a token.
`requiredPermission`	String	`""`	Permission required to use the server.
`hub`	boolean	`false`	Whether this is the cross-application hub server.
`topics`	McpTopic[]	`{}`	Topics this server declares; a topic is one tool with an `action` argument.
`serviceTools`	McpServiceTool[]	`{}`	Services wrapped directly as tools.
`providers`	Class<? extends McpToolProvider>[]	`{}`	Tool providers that build tools at run time.

@McpServiceTool#

Wraps one existing service as a tool, inside @McpServer(serviceTools = {...}) or @McpServerExtension(serviceTools = {...}).