The init-crash-script Element"

From Documentation
m (correct highlight (via JWB))
Line 8: Line 8:
 
{{versionSince| 7.0.4}}
 
{{versionSince| 7.0.4}}
  
It specifies how to customize crash message when initiation by writing a javascript function which is assigned to <code>window.zkShowCrashMessage</code>.
+
If the client engine stops working before even the error handling is initialized (e.g. when ZK's core scripts fail to download - <code>zk.wpd</code>), you will see the message below:
 +
 
 +
[[File:error_handling_crash_screen.png| center]]
 +
 
 +
This element allows you to show a custom crash message when initiation by writing a javascript function which is assigned to <code>window.zkShowCrashMessage</code>.
  
 
For example,
 
For example,
Line 25: Line 29:
 
</client-config>
 
</client-config>
 
</source>
 
</source>
* Line 2, 6: The error code will be passed as parameter, and then user can take it for further manipulation.
+
* Line 3, 6: The error code will be passed as parameter, and you can take it for further use.
  
 
= Error Code =
 
= Error Code =

Revision as of 01:29, 16 May 2022


The init-crash-script Element


Syntax:

<init-crash-script>javascript function assigned to window.zkShowCrashMessage</init-crash-script>
[Default: see crashmsg.js]

Since 7.0.4

If the client engine stops working before even the error handling is initialized (e.g. when ZK's core scripts fail to download - zk.wpd), you will see the message below:

Error handling crash screen.png

This element allows you to show a custom crash message when initiation by writing a javascript function which is assigned to window.zkShowCrashMessage.

For example,

<client-config>
	<init-crash-script><![CDATA[
	    window.zkShowCrashMessage = function (code) {
	    	var h2 = '<h2 style="background: rgb(1,133,174); text-align: center; ' 
	    			+ 'color: white; width: 700px; margin: 0 auto;">';
		    var msg = 'Ooooops!! ErrorCode: ' + code;
		    h2 = h2 + msg + '</h2>';
		    document.body.style.background = 'rgb(1,133,174)';
		    document.body.innerHTML = h2;
	    }
	  ]]></init-crash-script>
</client-config>
  • Line 3, 6: The error code will be passed as parameter, and you can take it for further use.

Error Code

The error code has 5 values:

  1. zk before mounting error
  2. zk mounting error
  3. zk after mounting error
  4. user script error
  5. server no response error

Version History

Last Update : 2022/05/16


Version Date Content
7.0.4 November, 2014 ZK-2495: When ZK init page, the loading animation runs in a endless loop


Last Update : 2022/05/16

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.