Differences

This shows you the differences between two versions of the page.

--- docs:2500_config_apps:2000_add_edit_services [2026/07/07 05:33] – aware_admin
+++ docs:2500_config_apps:2000_add_edit_services [2026/07/07 07:32] (current) – aware_admin
@@ Line 26: / Line 26: @@
 ===== Service Will be Protected by OAuth2.0 Protocol =====
-Tick this checkbox if you want to protect a service. If at least one service should be protected, you will need to deploy a special web application. This web application will manage scopes, clients, will issue access tokens and refresh tokens. To deploy this web application:
+Tick this checkbox if you want to protect a service. If at least one service should be protected, you will need to deploy a special web application. This web application will manage scopes, clients, will issue access tokens and refresh tokens. See the [[setting_up_oauth_protection|OAuth Protection section]].
-  - Go to the Edit menu of the Configuration Tool
-  - Select the entry with the name "SERVICE PROTECTION"
-Note that thew deployment of the dynamic feature should only be done once
-Your service documentation needs to convey to the callers of the service that before calling the service, they need to do the following:
-  - Obtain an access token by cand
-  - include the access token in the Authorization Bearer HTTP header, for example (<code>Authorization: Bearer <access token></code>).
-  - The name of the business space must be in the HTTP header called AW-DOMAIN, for example <code>AW-DOMAIN:CRM</code>
-  - The name of the service to call must be in the header called AW-SERVICE for a REST-ful service (for example, <code>AW-SERVICE: AddCustomer</code>) and AW-SERVICE-SOAP for a SOAP service - for example <code>AW-SERVICE-SOAP: AddCustomer</code>.
 ===== Service Reply =====
@@ Line 59: / Line 50: @@
   - for SOAP Service call: <code>http(s)://YourServer:YourPort/CXF/services/serviceCall/api</code>
-<callout type="warning" icon="true" title="warning">Note that for protected services the name of the business space and the name of the service to call are specified in the special HTTP header, as explained above </callout>
+<callout type="warning" icon="true" title="warning">Note that for protected services the name of the business space and the name of the service to call are specified in the special HTTP header see [[setting_up_oauth_protection|OAuth Protection]] </callout>
+==== Reply Format ====
+If a REST-ful service returns a reply, it can be either in the XML format (also Default) or in JSON format. The format can also vary depending on the URL used – the extension of the expected format can be specified in the URL itself. Choose the appropriate option here. A reply can also be just a string calculated by the process implementing the service. If that is the case, choose the "Calculated String" radio button.
+For SOAP services reply format is always XML.
+==== Handing of Undefined Values ====
+If values of the attributes of the returned object are undefined, you can choose how //**AwareIM**// will encode such values. By default //**AwareIM**// will skip undefined values (“Do not encode” option), but you can also encode an empty value or a particular string. You can also specify different encoding options depending on the name of the attribute.
+===== Editing service properties in the Property Window =====
 The following properties can be specified in the Element Properties window:
@@ Line 70: / Line 73: @@
   - The name must start with a character or underscore symbol; all other symbols must be characters (including underscore symbol) or digits. Space symbols are not allowed.
 ===== Description =====
 Specify any text that describes what the services does etc. Providing a description is not mandatory but is highly recommended. Any description if defined is included into the generated documentation for the business space version – see [[docs:2500_config_apps:3100_gen_doc]].
-===== Log =====
+===== Service Log Settings =====
-If you tick the Save button AwareIM will capture all communication in a log. It will record the name of the service called, time of the communication, URL parameters, HTTP method, HTTP body etc
+If you click on this property, the Service Log dialog will be displayed. If you tick "Save Communication In" checkbox the system will record the log of the communication. It will capture all communication in a log. It will record the name of the service called, time of the communication, URL parameters, HTTP method, HTTP body etc. It will also record HTTP headers of the request and response. The log will be captured in the instance of the object that you specify (you also need to define the attributes in this object that will store the log, as well as the attribute storing the name of the service and timestamp (the latter two attributes are required, so that you can sort by time and service.
-It will also record HTTP headers of the request and response. The log will be captured in the instance of the object that you specify (you also need to define the attributes in this object that will store the log, as well as the attribute storing the name of the service and timestamp (the latter two attributes are required, so that you can sort by time and service.
-===== REST settings =====
-If you ticked “Rest support” checkbox in the editor you will need to provide the following details:
+===== Handling of HTTP headers =====
+Values of HTTP headers of each service call can be stored in the object that is specified as the input of the process implementing the service. Enter the mapping between the name of the header and the attribute where the header value will be stored, in the dialog displayed when you edit this property.
-==== Default URL mapping ====
-Services exposed as REST will be called by other parties using a particular URL. If you choose the default option the default URL the other parties will have to use the default URL. It has the following format:
-http://ServerName:port/AwareIM/REST/BusinessSpace/ServiceName?parameters
-for example:
-[[http://myserver.com:8080/AwareIM/REST/CRM/Service1?param1=value1&param2=value2|]]
-==== URL must contain string ====
-If default URL cannot be used you can construct your own URL by choosing this option and providing your own custom string. For example, if you provide the following string:
-someName1/someName2
-the following URL can be used:
-http://ServerName:port/AwareIM/someName1/someName2?parameters
-<callout type="primary" icon="true" title="note"> If you choose this option you must also provide a file called rest.props and put it in the AwareIM/CP/eclipse directory of your AwareIM installation. The file must have a string that specifies the name of the business space containing REST-ful services, for example DOMAIN=CRM</callout>
 ==== Name mapping ====
 If your REST-ful service is implemented by a process that takes some object as input (should only be one object) then values of attributes of this object have to be provided as parameters in the URL (see example above). The name of the parameters must match the names of the attributes of the object. If this, however, is impossible for whatever reason, then you need to provide a mapping between the names of the parameters (“External Name”) and the name of the corresponding attribute. You should only do it for those parameters that have different names to the names of the attributes.
-==== Reply Format ====
-If a service returns a reply it can be either in the XML format (also Default) or in JSON format. The format can also vary depending on the URL used – the extension of the expected format can be specified in the URL itself. Choose the appropriate option here.
-==== REST Handing of Undefined Values ====
-This only applies to services exposed as REST-ful services. If values of the attributes of the returned object are undefined, you can choose how //**AwareIM**// will encode such values. By default //**AwareIM**// will skip undefined values (“Do not encode” option), but you can also encode an empty value or a particular string. You can also specify different encoding options depending on the name of the attribute.