Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
docs:2500_config_apps:2000_add_edit_services [2022/08/25 00:00] – ↷ Page moved from 2500_config_apps:2000_add_edit_services to docs:2500_config_apps:2000_add_edit_services administratordocs:2500_config_apps:2000_add_edit_services [2025/06/12 03:58] (current) – Change to AwareIM aware_support3
Line 2: Line 2:
 ====== Adding/Editing Services ====== ====== Adding/Editing Services ======
  
-The following section describes how to work with the editor of services when adding a new service or editing the existing one. Services are described in the [[2000_concepts:0900_prod_feats:0300_comm_with_other_systems:0000_start|Communication with Other Systems]] section.+The following section describes how to work with the editor of services when adding a new service or editing the existing one. Services are described in the [[docs:2000_concepts:0900_prod_feats:0300_comm_with_other_systems|Communication with Other Systems]] section.
  
-The editor of services can be started as described in the [[2500_config_apps:0300_work_config_elements:0000_start|Working with Configuration Elements]] section. +The editor of services can be started as described in the [[docs:2500_config_apps:0300_work_config_elements|Working with Configuration Elements]] section. 
  
 You can define the following settings of the service in the working area of the editor: You can define the following settings of the service in the working area of the editor:
Line 14: Line 14:
 ===== SOAP/Web Services support ===== ===== SOAP/Web Services support =====
  
-Choose this option if you want Aware IM to expose the service as “web service” implementing the SOAP protocol. When the business space containing such service is published Aware IM will automatically create a WSDL file for the service. +Choose this option if you want AwareIM to expose the service as “web service” implementing the SOAP protocol. When the business space containing such service is published AwareIM will automatically create a WSDL file for the service. 
  
-<note warning>After a business space version has been published the system administrator has to login into the Operation Mode to cause the deployment of a new or changed service and the creation of the WSDL file.</note>+<callout type="danger" icon="true" title="warning"> After a business space version has been published the system administrator has to login into the Operation Mode to cause the deployment of a new or changed service and the creation of the WSDL file.</callout>
  
 ===== REST support ===== ===== REST support =====
Line 38: Line 38:
 ===== Description ===== ===== 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 [[2500_config_apps:3100_gen_doc|]]. +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 =====
 +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
 +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 ===== ===== REST settings =====
  
Line 64: Line 67:
 http://ServerName:port/AwareIM/someName1/someName2?parameters http://ServerName:port/AwareIM/someName1/someName2?parameters
  
-<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 Aware IM installation. The file must have a string that specifies the name of the business space containing REST-ful services, for example DOMAIN=CRM</note>+<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 ==== ==== Name mapping ====
  
Line 75: Line 78:
 ==== REST Handing of Undefined Values ==== ==== 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 //**Aware IM**// will encode such values. By default //**Aware IM**// 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.+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.
  
  • Last modified: 2022/09/13 18:06