AWE Maintain Schema

Generated from maintain.xsd. It includes query.xsd.

This Schema defines the way an AWE Maintain file must be structured

12 elements, 20 declared attributes (20 documented).

Elements

Elements: maintain, target, send-email, commit, retrieve-data, multiple, serve, queue, delete, insert, update, include-target

maintain

Root element of a maintain file. It contains the targets.

Type: maintainType

Contains: target (0..n)

Contained by: none (document root)

Attributes: none

target

Named group of operations that run in order in one transaction. The changes are committed at each commit element and at the end of the target; an error rolls back what was not committed.

Type: targetType

Contains: insert (0..n), update (0..n), delete (0..n), serve (0..n), queue (0..n), commit (0..n), multiple (0..n), send-email (0..n), include-target (0..n), retrieve-data (0..n)

Contained by: maintain

Attribute	Type	Required	Default	Description
name	string	yes		Unique identifier of the target. Screens launch the target by this name.
label	string	no		Localization key of the title of the response. When omitted a generic success title is used.
exclusive	true, false	no		Intended to prevent concurrent executions of the target. The engine reads it but does not use it yet.
public	true, false	no		Allows the target to be launched without an authenticated session. Default false.

send-email

Sends an email defined in the email file.

Type: emailType

Contains: no child elements

Contained by: target

Attribute	Type	Required	Default	Description
id	string	yes		Id of the email, defined in the email file, that is sent.
label	string	no		Localization key of the message returned when the operation finishes without a message of its own.

commit

Commits the changes made so far in the target.

Contains: no child elements

Contained by: target

Attributes: none

retrieve-data

Runs a query (SQL, service, enumerated or queue) and stores every returned column as a parameter named after its alias, for the following operations.

Type: retrieveDataType

Contains: table (0..n), computed (0..n), compound (0..n), field (0..n), constant (0..n), operation (0..n), case (0..n), over (0..n), join (0..n), union (0..n), variable (0..n), where (0..n), having (0..n), order-by (0..n), group-by (0..n), totalize (0..n)

Contained by: target

Attribute	Type	Required	Default	Description
distinct	true, false	no		Returns only distinct rows (SELECT DISTINCT). Default false.
enumerated	identifierType	no		Id of an enumerated group whose values fill the query instead of a database table. Only used by enumerated queries.
service	identifierType	no		Id of the service, defined in the services file, that returns the data instead of a database. Only used by service queries.
queue	identifierType	no		Id of the JMS queue, defined in the queues file, used to obtain the data. Only used by queue queries.
cacheable	true, false	no		Caches the result using the query id plus the resolved request parameters as key, so the same call is not executed again during the cache lifetime. Default false.
managed-pagination	true, false	no		Controls how a SQL query is paginated. When true or omitted, the database returns only the requested page (limit and offset plus a count query), unless the query has a totalize element or the page size is 0. When false, all rows are fetched and the page is cut in memory. Not applied to totalized queries.
post-process	true, false	no		Only for service queries. When true (default) AWE processes the returned data list (transforms, translations, computed fields). Set it to false to keep the service result untouched.
public	true, false	no		Allows the query to be launched without an authenticated session. Default false.

multiple

Inserts, updates or deletes the rows sent by a grid, according to the row type of each row.

Type: multipleType

Contains: table (0..n), field (0..n), variable (0..n)

Contained by: target

Attribute	Type	Required	Default	Description
audit	string	no		Name of the audit table that stores the audit rows of the operations.
label	string	no		Localization key of the message returned when the operation finishes without a message of its own.
grid	string	yes		Id of the grid that sends the rows. The row type of each row (insert, update or delete) is read from the request parameter named after the grid followed by -RowTyp.

serve

Calls a Java or web service.

Type: serveType

Contains: variable (0..n)

Contained by: target

Attribute	Type	Required	Default	Description
service	string	yes		Id of the service, defined in the services file, that is called.
label	string	no		Localization key of the message returned when the operation finishes without a message of its own.

queue

Sends a message to a JMS queue.

Type: queueType

Contains: variable (0..n)

Contained by: target

Attribute	Type	Required	Default	Description
name	string	yes		Id of the JMS queue, defined in the queues file, that receives the message.
label	string	no		Localization key of the message returned when the operation finishes without a message of its own.

delete

Deletes the rows that match its where clause.

Type: deleteType

Contains: table (0..n), field (0..n), constant (0..n), operation (0..n), variable (0..n), where (0..n)

Contained by: target

Attribute	Type	Required	Default	Description
multiple	true, audit	no		Runs the operation once per value of the list variables (true), or only audits once per value (audit). When omitted the operation runs once.
audit	string	no		Name of the audit table that stores the audit rows of the operation. The table must exist and have the audit user, date and action columns.
batch	true, false	no		Runs the statements in JDBC batches. Default false.
batch-size	integer	no		Number of statements per batch. When omitted, the value of the database configuration property is used.
label	string	no		Localization key of the message returned when the operation finishes without a message of its own.

insert

Inserts a row, or the rows of a query.

Type: insertType

Contains: table (0..n), field (0..n), constant (0..n), operation (0..n), variable (0..n)

Contained by: target

Attribute	Type	Required	Default	Description
multiple	true, audit	no		Runs the operation once per value of the list variables (true), or only audits once per value (audit). When omitted the operation runs once.
audit	string	no		Name of the audit table that stores the audit rows of the operation. The table must exist and have the audit user, date and action columns.
batch	true, false	no		Runs the statements in JDBC batches. Default false.
batch-size	integer	no		Number of statements per batch. When omitted, the value of the database configuration property is used.
label	string	no		Localization key of the message returned when the operation finishes without a message of its own.
query	string	no		Id of a query whose rows are inserted (INSERT INTO SELECT). The number of fields must match the columns of the query.

update

Updates the rows that match its where clause.

Type: updateType

Contains: table (0..n), field (0..n), constant (0..n), operation (0..n), variable (0..n), where (0..n)

Contained by: target

Attribute	Type	Required	Default	Description
multiple	true, audit	no		Runs the operation once per value of the list variables (true), or only audits once per value (audit). When omitted the operation runs once.
audit	string	no		Name of the audit table that stores the audit rows of the operation. The table must exist and have the audit user, date and action columns.
batch	true, false	no		Runs the statements in JDBC batches. Default false.
batch-size	integer	no		Number of statements per batch. When omitted, the value of the database configuration property is used.
label	string	no		Localization key of the message returned when the operation finishes without a message of its own.

include-target

Runs the operations of another target at this point.

Type: includeTargetType

Contains: variable (0..n)

Contained by: target

Attribute	Type	Required	Default	Description
name	string	yes		Name of the target whose operations are run at this point. The target must exist in a maintain file.

Simple types

multipleRestriction

true runs the operation once per value of the list variables; audit runs it once and audits once per value.

Base type: string

Allowed values: true, audit