Jump to: navigation, search

Difference between revisions of "WebService Diagnosis"

m
 
(13 intermediate revisions by the same user not shown)
Line 3: Line 3:
  
 
== Start Diagnosis ==
 
== Start Diagnosis ==
−
 
+
The diagnosis page can be accessed by adding "/Diag" to {{UBIK}} web service path. For example, if the web service path is "https://myserver:777/UBIK/DEMO/UBIKContent.svc" the diagnosis can be run by entering "https://myserver:777/UBIK/DEMO/Diag" into the web browsers address bar.
−
To run the diagnosis, the installed {{UBIK}} web service path has to be extended by "/Diag". E.g. when the web service is accessible via "https://myserver:777/UBIK/DEMO/UBIKContent.svc" the diagnosis can be run by entering "https://myserver:777/UBIK/DEMO/Diag" into the web browsers address bar.
+
  
 
== Result Types ==
 
== Result Types ==
Line 17: Line 16:
 
| align="center" | [[File:IC_WebService_Diagnosis_Ok.png]] || Message|| The diagnosis showed that the tested part runs without problems
 
| align="center" | [[File:IC_WebService_Diagnosis_Ok.png]] || Message|| The diagnosis showed that the tested part runs without problems
 
|-
 
|-
−
| align="center" | [[File:IC_WebService_Diagnosis_undefined.png]] || Message|| The reault of the test is not defined
+
| align="center" | [[File:IC_WebService_Diagnosis_undefined.png]] || Message|| The result of the test is not defined
 
|}
 
|}
  
 
== Diagnosis ==
 
== Diagnosis ==
 +
In the header section at the top, links to the available and connected services (Content, Session Management, and Push service) are shown. These can also be tested by the user by clicking onto the links manually, but the connections will also be tested automatically once the test runs.
  
−
In the top section, the links to the connected services (Content, Session Management, and Push service) are shown. These can be also be tested by the user clicking the links manually, these connections will are also tested automatically while the test runs.
+
The following tests are executed to check the functionality of the web services. The details of each test run can be shown by clicking on the "Details..." link in the results list.
−
 
+
−
The following tests are executed check the functionality of the web service. The details of each test run can be shown by clicking on the "Details..." link in the results list.
+
  
 
==== Session Management ====
 
==== Session Management ====
  
−
* Try to find the service end point
+
{| class="wikitable sortable" width="80%"
−
** Error: The service cannot be reached: Possible reason is an error in the web.config, which cannot be parsed. An other reason can be a faulty configuration of the service in iis.
+
|-
−
** Warning: The service end point provides a non-secure connection ("http://"). A connection without transport security should only be used for testing or in internal networks in a trusted enviroment only. This is generally not recommended for a productive environment.
+
! width="200" | Test !! Type !! Description
−
** Warning: The service endpoint provides a secure connection ("https://") but has issues with the certificate provided: e.g. expired validity, non-trusted root authority etc. This means, a connection to the service will still be possible but it is not recommended to use in a productive environment.
+
|-
−
 
+
| rowspan="3" | Try to find the service end point|| align="center"| [[File:IC_WebService_Diagnosis_Error.png|Error]] || The service cannot be reached: Possible reason is an error in the web.config, which cannot be parsed. An other reason can be a faulty configuration of the service in IIS.
−
* Fetch a token
+
|-
−
** Error: The session management service is not configured to testing mode or does not have a valid test login configured in the {{UBIK}} database
+
| align="center"| [[File:IC_WebService_Diagnosis_Warning.png|Warning]]|| The service end point provides a non-secure connection ("http://"). A connection without transport security should only be used for testing or in internal networks in a trusted enviroment only. This is generally not recommended for a productive environment.
−
* Verify token
+
|-
−
** Error: The fetched token is not recognized as a valid token to be used with the content service. A possible reason is that the session management has a different database connection configured.
+
| align="center"| [[File:IC_WebService_Diagnosis_Warning.png|Warning]]|| The service endpoint provides a secure connection ("https://") but has issues with the certificate provided: e.g. expired validity, non-trusted root authority etc. This means, a connection to the service will still be possible but it is not recommended to use in a productive environment.
−
* Verify if token gets invalid
+
|-
−
** Warning: The fetched token is always valid. The reason can be that the setting "TokenRestrictive" is switched off which is not recommended for productive use.
+
| Fetch a token || align="center"| [[File:IC_WebService_Diagnosis_Error.png|Error]]|| The session management service is not configured to testing mode or does not have a valid test login configured in the {{UBIK}} database
 +
|-
 +
| Verify token || align="center"| [[File:IC_WebService_Diagnosis_Error.png|Error]]|| The fetched token is not recognized as a valid token to be used with the content service. A possible reason is that the session management has a different database connection configured.
 +
|-
 +
| Verify if token gets invalid || align="center"| [[File:IC_WebService_Diagnosis_Warning.png|Warning]]|| The fetched token is always valid. The reason can be that the setting "TokenRestrictive" is switched off which is not recommended for productive use.
 +
|}
  
 
==== {{UBIK}} Content Service ====
 
==== {{UBIK}} Content Service ====
  
−
* Try to find the service end point
+
{| class="wikitable sortable" width="80%"
−
** (see the same section in the session management tests above)
+
|-
−
* Check database connection
+
! width="200" | Test !! Type !! Description
−
** Error: Database cannot be reached. Possible reason can be a faulty database connection string or the used database server cannot be reached or is blocked by the network configuration.
+
|-
−
* Upload a file
+
| rowspan="3" width="200" | Try to find the service end point|| align="center"| [[File:IC_WebService_Diagnosis_Error.png|Error]]|| The service cannot be reached: Possible reason is an error in the web.config, which cannot be parsed. An other reason can be a faulty configuration of the service in IIS.
−
** Error: The configured target file system in the database settings is not set correctly to a folder allowing to write data. The reason can be that the user running the {{UBIK}} web service does not have read/write access to the configured target folder.
+
|-
−
* Download a file
+
| align="center"| [[File:IC_WebService_Diagnosis_Warning.png|Warning]]|| The service end point provides a non-secure connection ("http://"). A connection without transport security should only be used for testing or in internal networks in a trusted enviroment only. This is generally not recommended for a productive environment.
−
** Error: The uploaded file (uploaded in the previous test) cannot be downloaded. Possible reasons could be a timeout which is set too restrictive to download the data in time.
+
|-
−
* Write logs
+
| align="center"| [[File:IC_WebService_Diagnosis_Warning.png|Warning]]|| The service endpoint provides a secure connection ("https://") but has issues with the certificate provided: e.g. expired validity, non-trusted root authority etc. This means, a connection to the service will still be possible but it is not recommended to use in a productive environment.
−
** Error: The log cannot be written. Possible reason is that the configured log folders do not exist or the user running the web service has no read/write access to the logging folder.
+
|-
−
* Check rights structure
+
| Fetch a token || align="center"| [[File:IC_WebService_Diagnosis_Error.png|Error]]|| The session management service is not configured to testing mode or does not have a valid test login configured in the {{UBIK}} database
−
** Error: At least one of the configured target directories used to store data (e.g. uploaded photos) does not have the required read/write rights. See the details if there are issues with one of the configured folders.
+
|-
 +
| Verify token || align="center"| [[File:IC_WebService_Diagnosis_Error.png|Error]]|| The fetched token is not recognized as a valid token to be used with the content service. A possible reason is that the session management has a different database connection configured.
 +
|-
 +
| Verify if token gets invalid || align="center"| [[File:IC_WebService_Diagnosis_Warning.png|Warning]]|| The fetched token is always valid. The reason can be that the setting "TokenRestrictive" is switched off which is not recommended for productive use.
 +
|}
  
 
==== {{UBIK}} Push Service ====
 
==== {{UBIK}} Push Service ====
  
−
* Try to find the service end point
+
 
−
** (see the same section in the session management tests above)
+
{| class="wikitable sortable" width="80%"
−
* Add push data
+
|-
−
** Error: Adding push data failed. The reason could be a miscofigured service access point for the push service.
+
! width="200" | Test !! Type !! Description
−
* Fetch push data
+
|-
−
** Error: No push data received. If this error occurs even if adding the push data worked, the reason could be that the cached push data has been lost because the service had to be restarted or persisting the data in the background failed.
+
| rowspan="3" width="200" | Try to find the service end point|| align="center"| [[File:IC_WebService_Diagnosis_Error.png|Error]]|| see the section in the Session Management tests
−
* Reset push data
+
|-
−
** Error: see description of the possible error(s) described for "Fetch push data".
+
| align="center"| [[File:IC_WebService_Diagnosis_Warning.png|Warning]]|| see the section in the Session Management tests
 +
|-
 +
| align="center"| [[File:IC_WebService_Diagnosis_Warning.png|Warning]]|| see the section in the Session Management tests
 +
|-
 +
| Add push data || align="center"| [[File:IC_WebService_Diagnosis_Error.png|Error]]|| Adding push data failed. The reason could be a miscofigured service access point for the push service.
 +
|-
 +
| Fetch push data || align="center"| [[File:IC_WebService_Diagnosis_Error.png|Error]]|| No push data received. If this error occurs even if adding the push data worked, the reason could be that the cached push data has been lost because the service had to be restarted or persisting the data in the background failed.
 +
|-
 +
| Reset push data || align="center"| [[File:IC_WebService_Diagnosis_Error.png|Error]]|| see description of the possible error(s) described for "Fetch push data".
 +
|}
  
 
== See also ==
 
== See also ==
Line 70: Line 86:
 
* [[HowTo:Install Microsoft IIS]]
 
* [[HowTo:Install Microsoft IIS]]
  
−
[[Category:Installing]]
+
{{Category/Version|2.4.3}}
−
[[Category:Web Service]]
+
 
 +
[[Category:2.4.3|WebService Diagnosis]]
 +
[[Category:Installing|WebService Diagnosis]]
 +
[[Category:Web service|WebService Diagnosis]]

Latest revision as of 09:23, 15 February 2016

WebService Diagnosis
WebService Diagnosis

The web service can be tested using the diagnosis function, which can run a diagnosis on the configured UBIK® web service to show possible problems and errors. Once the results are generated, they are presented via the web browser page.

Start Diagnosis

The diagnosis page can be accessed by adding "/Diag" to UBIK® web service path. For example, if the web service path is "https://myserver:777/UBIK/DEMO/UBIKContent.svc" the diagnosis can be run by entering "https://myserver:777/UBIK/DEMO/Diag" into the web browsers address bar.

Result Types

Icon Type Content
IC WebService Diagnosis Error.png Error The result of the diagnosis shows an error preventing the service from running as expected
IC WebService Diagnosis Warning.png Warning The result of the diagnosis showed that there is an issue the user has to be aware of (e.g. configuring an insecure service end point)
IC WebService Diagnosis Ok.png Message The diagnosis showed that the tested part runs without problems
IC WebService Diagnosis undefined.png Message The result of the test is not defined

Diagnosis

In the header section at the top, links to the available and connected services (Content, Session Management, and Push service) are shown. These can also be tested by the user by clicking onto the links manually, but the connections will also be tested automatically once the test runs.

The following tests are executed to check the functionality of the web services. The details of each test run can be shown by clicking on the "Details..." link in the results list.

Session Management

Test Type Description
Try to find the service end point Error The service cannot be reached: Possible reason is an error in the web.config, which cannot be parsed. An other reason can be a faulty configuration of the service in IIS.
Warning The service end point provides a non-secure connection ("http://"). A connection without transport security should only be used for testing or in internal networks in a trusted enviroment only. This is generally not recommended for a productive environment.
Warning The service endpoint provides a secure connection ("https://") but has issues with the certificate provided: e.g. expired validity, non-trusted root authority etc. This means, a connection to the service will still be possible but it is not recommended to use in a productive environment.
Fetch a token Error The session management service is not configured to testing mode or does not have a valid test login configured in the UBIK® database
Verify token Error The fetched token is not recognized as a valid token to be used with the content service. A possible reason is that the session management has a different database connection configured.
Verify if token gets invalid Warning The fetched token is always valid. The reason can be that the setting "TokenRestrictive" is switched off which is not recommended for productive use.

UBIK® Content Service

Test Type Description
Try to find the service end point Error The service cannot be reached: Possible reason is an error in the web.config, which cannot be parsed. An other reason can be a faulty configuration of the service in IIS.
Warning The service end point provides a non-secure connection ("http://"). A connection without transport security should only be used for testing or in internal networks in a trusted enviroment only. This is generally not recommended for a productive environment.
Warning The service endpoint provides a secure connection ("https://") but has issues with the certificate provided: e.g. expired validity, non-trusted root authority etc. This means, a connection to the service will still be possible but it is not recommended to use in a productive environment.
Fetch a token Error The session management service is not configured to testing mode or does not have a valid test login configured in the UBIK® database
Verify token Error The fetched token is not recognized as a valid token to be used with the content service. A possible reason is that the session management has a different database connection configured.
Verify if token gets invalid Warning The fetched token is always valid. The reason can be that the setting "TokenRestrictive" is switched off which is not recommended for productive use.

UBIK® Push Service

Test Type Description
Try to find the service end point Error see the section in the Session Management tests
Warning see the section in the Session Management tests
Warning see the section in the Session Management tests
Add push data Error Adding push data failed. The reason could be a miscofigured service access point for the push service.
Fetch push data Error No push data received. If this error occurs even if adding the push data worked, the reason could be that the cached push data has been lost because the service had to be restarted or persisting the data in the background failed.
Reset push data Error see description of the possible error(s) described for "Fetch push data".

See also

Retrieved from "https://wiki.augmensys.com/index.php?title=WebService_Diagnosis&oldid=18858"