Difference between revisions of "WebService Diagnosis"
(→Diagnosis) |
(→Diagnosis) |
||
| Line 28: | Line 28: | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| − | ! Test !! Type !! Description | + | ! width="200" | Test !! style="text-align:center" | Type !! Description |
|- | |- | ||
| − | | rowspan="3 | + | | 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. |
|- | |- | ||
| − | | 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. | + | | 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. |
|- | |- | ||
| − | | 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. | + | | 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. |
|- | |- | ||
| − | | 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 | + | | 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 || 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 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 || 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. | + | | 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. |
|} | |} | ||
| Line 49: | Line 49: | ||
! Test !! Type !! Description | ! Test !! Type !! Description | ||
|- | |- | ||
| − | | rowspan="3" width="200" | 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. | + | | 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. |
|- | |- | ||
| − | | 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. | + | | 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. |
|- | |- | ||
| − | | 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. | + | | 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. |
|- | |- | ||
| − | | 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 | + | | 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 || 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 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 || 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. | + | | 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. |
|} | |} | ||
| Line 69: | Line 69: | ||
! Test !! Type !! Description | ! Test !! Type !! Description | ||
|- | |- | ||
| − | | rowspan="3" width="200" | Try to find the service end point|| Error || see the section in the Session Management tests | + | | 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 |
|- | |- | ||
| − | | 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 |
|- | |- | ||
| − | | 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 || Error || Adding push data failed. The reason could be a miscofigured service access point for the push service. | + | | 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 || 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. | + | | 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 || Error || see description of the possible error(s) described for "Fetch push data". | + | | Reset push data || align="center"| [[File:IC_WebService_Diagnosis_Error.png|Error]]|| see description of the possible error(s) described for "Fetch push data". |
|} | |} | ||
Revision as of 10:43, 30 April 2015
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.
Contents
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 |
|---|---|---|
 |
Error | The result of the diagnosis shows an error preventing the service from running as expected |
 |
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) |
 |
Message | The diagnosis showed that the tested part runs without problems |
 |
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 | |
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. |
| |
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. | |
| |
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 | |
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 | |
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 | |
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 | |
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. |
| |
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. | |
| |
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 | |
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 | |
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 | |
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 | |
see the section in the Session Management tests |
| |
see the section in the Session Management tests | |
| |
see the section in the Session Management tests | |
| Add push data | |
Adding push data failed. The reason could be a miscofigured service access point for the push service. |
| Fetch push data | |
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 | |
see description of the possible error(s) described for "Fetch push data". |
