THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
Introduction
| Anchor | ||||
|---|---|---|---|---|
|
Services are independent pieces of logic which when placed together process many different types of business requirements. Services can be of many different types: Workflow, Rules, Java, SOAP, BeanShellGroovy, etc. A service with the type Java is much like an event where it is a static method, however with the Services Framework we do not limit to web based applications. Services require input parameters to be in a Map and the results are returned in a Map as well. This is nice since a Map can be serialized and stored or passed via HTTP (SOAP).
...
The Service Dispatcher handles dispatching services to the appropriate Service Engine where it is then invoked. There is exactly one ServiceDispatcher for each Entity Delegator. If there are multiple delegators in an application there will also be multiple dispatchers. The ServiceDispatcher is accessed via a LocalDispatcher. There can be many LocalDispatchers associated with a ServiceDispatcher. Each LocalDispatcher is uniquely named and contains its own list of service definitions. When creating an instance of a LocalDispatcher, a DispatchContextis DispatchContext is also created and passed to the ServiceEngine.
...
Attribute | Required? | Description | Default Value |
|---|---|---|---|
name | Y | The unique name of the service. | |
engine | Y | The name of the engine (defined in serviceengine.xml). | |
location | N | The location or package of the service's class. | |
invoke | N | The method name of the service. | |
auth | N | Does this service require authorization? (true/false) | true |
debug | N | Enable verbose debugging when calling this service? | true |
default-entity-name | N | The default Entity to use for auto-attributes | |
export | N | Is this service allowed to be accessed via SOAP/HTTP/JMS? (true/false) | false |
max-retry | N | Sets the max number of times this service will retry when failed (persisted async only) | -1 (unlimited) |
require-new-transaction | N | Require a new transaction for this service | true |
semaphore | N | Defines how concurrent calls to this service should be handled: | none |
semaphore-wait-seconds | N | When semaphore="wait" how many seconds to wait before failing the service call | 300 |
sempahore-sleep | N | When semaphore="wait" how often (in milliseconds) to check if the waiting service call can be run | 500 |
transaction-timeout | N | Override the default transaction timeout, only works if we start the transaction | 0 (Use system default) |
use-transaction | N | Create a transaction for this service (if one is not already in place) | true |
validate | N | Do we validate the attributes found below for name and type matching? (true/false) | true |
...
| Code Block | ||
|---|---|---|
| ||
<service name="createInvoiceContactMech" engine="entity-auto" invoke="create" default-entity-name="InvoiceContactMech">
<description>Create a ContactMech for an invoice</description>
<permission-service service-name="acctgInvoicePermissionCheck" main-action="CREATE"/>
<auto-attributes include="pk" mode="IN" optional="false"/>
</service> |
...
The entity-auto engine can implement the following Create operations:
...
The testExample1 service will have the exact same required and optional attributes as thetestInterface the testInterface service. Any service which implements testInterfacewill testInterface will also inherit the parameters/attributes. If needed, additional attributes can be added to a specific service by including the attribute tag along with the implementstag. You may also override an attribute by re-defining it after the implements tag.
...
ECA (Event Condition Action) is much like a trigger. When a service is called, a lookup is performed to see if any ECAs are defined for this event. Events include before authentication, before IN parameter validation, before actual service invocation, before OUT parameter validation, before transaction commit, or before the service returns. Next each conditionin condition in the ECA definition is evaluated and if all come back as true, each actionis action is performed. An action is just a service which must be defined to work with the parameters already in the service's context. There are no limit to the number of conditions or actions each ECA may define.
| Code Block |
|---|
<service-eca>
<eca service="testScv" event="commit">
<condition field-name="message" operator="equals" value="12345"/>
<action service="testBsh" mode="sync"/>
</eca>
</service-eca>
|
A tip from Parimal Gain Tip: Note that you may use the set operation to rename a parameter for the triggered service or insert values for instance...
...
The eca element should also have 0 or more condition or condition-fieldelements field elements and 1 or more action elements.
...
The group definition is very simple, it contains a group elements along with 1 or more service elements. The group element contains a name attribute and a modeattribute mode attribute used to define how the group will function. The service element is much like the actionelement action element in an ECA, the difference being the default value for result-to-context.
...
JMS services are much like HTTP services, except the service request is sent to a JMS topic/queue. The engineshould engine should be set to jms, the location should be the name of the jms-service defined in the serviceengine.xml file (see Service Config document), and the invoke should be the name of the service on the remote system you are requesting to run. JMS services by nature are asynchronous.
...