Create a Client Operation
What is a Client Operation?
Before you can set up a client operation, you must have at least one host transaction available to reference. See Declare a Host Transaction.
NOTE: If you are creating a client operation using the Declare a Host Transaction wizard, then the host transaction has already been determined.
You can import legacy (Synapta) task definitions to associate with your client operations. See Import Legacy Host Interface Definitions.
When you create a client operation you must define the mapping between it and the host transaction and its data structure. You can modify the names and hierarchy of elements in your client schema until you are certain that the properties of your client operation match the data structure defined in the host transaction.
|To create a Client Operation
- In the Transaction Designer, from either the Actions menu or toolbar, select New Client Operation.
Alternatively, you can create a new client operation as part of the Declare a Host Transaction wizard workflow. If this is the case, a host transaction has already been determined and you can skip Step 3 in this procedure.
- Type a name and description for the client operation.
- From the drop down list, select the host transaction with which this client operation will be associated.
- By default, the client operation is populated with elements from each data item in the host program data structure. This provides an effective starting point for editing your client schema. You may override this behavior by selecting Create empty client schema.
|This option when...
||A blank client schema is created, consisting only of input and output areas, in which you must add elements and records, set their properties, and map them to data items.
- Basic elements and records are automatically created for every data item in the data structure.
- The hierarchical structure of the data structure is duplicated in the client schema.
- All default properties from the data structure are used to populate the corresponding properties in the client schema.
- Mappings between corresponding elements and data items are created automatically.
- Select Add input fields for security element attributes Username and Password to add these attributes to the client operation.
When you select this option, the client user is prompted for these values when the service is invoked. The values the user enters are passed to the host program as part of the service. If appropriate credentials are not provided, the service will fail to retrieve data from the host.
- At this point, if necessary, you can modify the names and hierarchy of the elements in your client schema until the structure is an accurate representation of the host program data structure.
See Map Client Schema to Host Program Data Structure for more information.
- Save the project.
The next step is to open Web Builder and build your interface objects for use in client applications.