Operations Tab Page 

Definition

A view pane that lists the operations used to specify search queries used in services and service mapping.

Use

You use the Operations tab page to create and edit operations or methods used in application, entity, and external services. You can create information such as name, define input and output parameters, and permission definitions.

The tab page also provides an overview of mapped relations between entity and external services. The Operations window contains parameters that describe an operation.

For instruction on how to add, edit, or delete operations, see the following topic:

●     Modeling Entity Service Operations

Structure

The Operations view can be divided into the following sections where applicable:

●     Operations table

Lists operation properties such as name, description, and transaction type. See the individual service sections below for more information.

●     Attributes/Type Repository

Only available for application services. Contains a catalog of services with subdirectories for data structures, simple types, and faults.

●     Input, Output Parameters and Exceptions

Lists parameters used for mapping operations.

●     Properties/Tasks

Lists attribute properties.

The figure below shows how the window is divided.

 

The pre-defined CRUD operations (create, read, update, and delete) cannot be edited or deleted. Currently only the FindBy operation can be added and edited.

 

Application Services

You use the Operations tab page to create operations used in application services. Only operations with return parameters and arguments can be created in application services.

Operations View

The operations table lists operations that are used or have been added. The descriptors are listed in the table below.

Operation Attributes	Description
Name	Name of operation
Description	An additional description of the operation
Transaction Type	Describes the transaction, for example, if it is required or no longer supported.
Permission	Indicates if permissions have been enabled or disabled.
Operation type	Designates the CRUD operation type.

Attributes/Type Repository

In this section you can see the entity and core services that are used to map input and output parameters and faults (exceptions) to an operation. The type repository is indicated by the catalog storage area.

You can choose which services to use and map them to Input, Output Parameters and Exceptions. The table below summarizes mapping constraints to parameters and exceptions.

Service type	Input	Output	Fault	Allow multi-mapping to Input
Data structures	yes	yes	no	yes
Simple type	yes	yes	no	yes
Fault	no	no	yes	no

Only one output parameter can be mapped for each operation.

Data Structure

Data structure describes the type of service used for mapping. The Data Structures node list the entity or core services that are made available on the Dependencies tab page.

Data structures can be mapped to both input and output parameters. The type of service mapped is reflected in the Input, Output Parameters and Exceptions window.

Simple Types

Simple types are core dictionary data types that are delivered with CAF. You can choose a data type, for example string or double, to map simple types to input and output parameters. In the Parameters and Exceptions window, simple types are listed as arguments.

Faults

Faults are core exception types that are delivered with CAF Core. You can map fault operators, such as create or retrieve, to fault parameters. You can only map faults faults in the Parameters and Exceptions window.

Input/output Parameters and Exceptions

This window lists the mapped parameters and faults of an operation. You can remove these parameters at any time.

 

Entity Services

The Operations window displays the operations used in entity services. They are listed in a table with the following columns headings:

Name	Description
Operation Name	Name of operation
Visibility	Lists if the operation is visible to the client
Return Type	Describes the service being used in the operation
Description	An additional description of the operation

 

External Services

The Operations window lists parameters describing the operation. They are listed in a table with the following columns:

Name	Description
Name	Name of operation
Description	An additional description of the operation
Output	Lists the resulting data output type. There can only be one output type listed.
Input	It is the input data type used. Multiple selections are allowed.

This section displays the content of the external service imported. It lists the exception parameters and information for input and output value.