XML content is rarely authored in a vacuum. The Resource Manager in XMetaL Author provides a convenient piece of screen real-estate to connect the author to the rest of the world. Sitting right beside the editor pane in XMetaL Author, it’s the perfect place to present information needed by the author, collect ancillary information about the content while it’s fresh in the author’s mind, or display widgets for the author to initiate additional processing on the content.
For example, you can use the Resource Manager to:
* display a to-do list of changes that need to be made to a document
* embed a powerful third-party image editor, e.g. to display and interact with a 3D image of a machine part
* let the author search for relevant reusable content
* let the author record metadata while they author a document
Join us for a quick introduction to embedding Internet Explorer in the XMetaL Resource Manager and how to communicate between Internet Explorer and XMetaL Author and your back-end systems.
A recording of this presentation is available at http://tinyurl.com/276qoul . Code samples used in the presentation are available at http://na.justsystems.com/files/resource_manager-demofiles.zip .
This presentation is part of the free "XMetaL in 37 Minutes" webinar series. For upcoming webinars, see http://na.justsystems.com/webinars.php .
Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...
Extending XMetaL Author Using the Resource Manager
1. in 37 minutes Episode 7 Extending XMetaL Author using the Resource Manager Murray Smith, Technical Services Manager Brought to you by XMetaL Technical Services
2. Announcements Latest Product Releases XMetaL Author Enterprise for Documentum Webtop XMetaL Reviewer 6.1 Next time: June 17, Getting to Yes: Overcoming Barriers to XML Adoption in the Enterprise. No 37 Minute webinar on the first Thursday of July (it’s a holiday in Canada).
3. System Overview Implementation Details Loading Internet Explorer in the Resource Manager. Communicating from the HTML page in IE to external systems. Communicating from the HTML page in IE to XMetaL Author. Communicating from XMetaL Author to your HTML page in IE. Advanced Topic: Making sure the HTML page in IE is fully loaded. Advanced Topic: Parameter passing between XMetaL Author and your HTML page in IE. Agenda
4. System Overview A key issue regarding script code is that script code in an HTML page in IE is running in IE’s script engine, while script code in an XMetaL macro file is running in XMetaL Author’s script engine.
6. Loading Internet Explorer in the Resource Manager – XMetaL Script Code 1) Load IE in Resource Manager and call the tab Demo_1. 2) Make this tab visible. 3) Get a reference to the IE control. 4) Tell the control to navigate to google.com. ResourceManager.AddTab(“Demo_1","Shell.Explorer"); ResourceManager.SelectTab(“Demo_1"); Var msie = ResourceManager.ControlInTab( “Demo_1" ); msie.Navigate( “http://www.google.com" ); ResourceManager is a global object that is accessible from script code running in XMetaL Author. XMetaL script code from ResManDemo1.mcr
9. Communication: HTML Page to External System – XMetaL Script code The code is the same as the previous demo, except this time we navigate to an html page on the file system. XMetaL script code in ResManDemo2.mcr
10. Communication: HTML Page to External System – IE Script Code Anything you can do from an HTML page in IE, you can do from an HTML page in IE in the Resource Manager. In this demo we use AJAX to call a server. IE script code in ResManDemo2.html
11. Communication: HTML Page to XMetaL Author The key issue is that script running in IE is running in IE’s script engine and script running in XMetaL Author is running in XMetaL Author’s script engine.
13. Communication: HTML Page to XMetaL Author – IE Script Code The key line is the first one. It shows how to get a reference to the XMetaL Application object from script code in IE. Once you have it you have access to the XMetaL Application API from within your HTML page. var xmApp = new ActiveXObject("XMetaL.Application"); var doc = xmApp.ActiveDocument; if( doc == null ){ alert( "Please open a document first." ); } else{ doc.Range.Text = time; } IE script code in ResManDemo3.html
14. Communication: XMetaL Author to the HTML Page Same issue as before. Script running in IE is running in IE’s script engine and script running in XMetaL Author is running in XMetaL Author’s script engine.
16. Communication: XMetaL Author to the HTML Page – IE Script Code The page loaded in the Resource Manager has a JavaScript function [writeMsg(msg)] that writes a message into the HTML page. We will invoke this function from script running in XMetaL Author. IE script code in ResManDemo4.html
17. Communication: XMetaL Author to the HTML Page – XMetaL Script Code Get a reference to the IE ActiveX control, Get a reference to the HTML Document object in IE, Use the execScript() method of the Script object to invoke the JavaScript function in the HTML page. var msie = ResourceManager.ControlInTab( "Demo_4" ); var doc = msie.document; doc.Script.execScript( "writeMsg( '" + msg + "' )", "JSCRIPT" ); XMetaL script code in ResManDemo4.mcr
18. Advanced Topic: Make Sure the HTML Page is Fully Loaded The issue is that if you have script code running in XMetaL Author that will make calls to your HTML page running in IE in the Resource Manager, you need to make sure the HTML page is fully loaded before you make any calls to it.
20. Advanced Topic: Make Sure the HTML Page is Fully Loaded – Overview The solution is to have IE tell the script code running in XMetaL Author when it has finished loading the HTML page.
21. Make Sure the HTML Page is Fully Loaded – Overview We have an additional ActiveX control that is loaded in the Resource Manager. (CritiqueUtils.WebBrowerContainer) Internet Explorer will be loaded inside the CritiqueUtils container which is loaded in the Resource Manager. The CritiqueUtils container will make a callback to your XMetaL JavaScript code once your page is fully loaded.
22. Make Sure the HTML Page is Fully Loaded – XMetaL Script Code Callback code that is executed when IE finishes loading the HTML page. Use CritiqueUtils.WebBrowerContainer instead of Shell.Explorer An instance of the callback handler is passed to the Navigate2() method. XMetaL script code in ResManDemo5.mcr
23. Advanced Topic: Parameter Passing Between XMetaL and Your HTML Page The key issue is that you generally can’t directly pass parameters between the two because they are 2 separate script engines.
25. Parameter Passing Between XMetaL and Your HTML Page – IE Script Code Use XMetaL’s CustomProperties API’s to pass parameters back and forth between IE script code and XMetaL script code. var xmApp = new ActiveXObject("XMetaL.Application"); xmApp.CustomProperties.Add( "msgFromHtmlPage", msg ); xmApp.Run( "displayMsgFromHtmlPage" ); IE script code in ResManDemo6.html
26. Summary Loading HTML pages running in Internet Explorer in the Resource Manager is a highly flexible way to extend XMetaL Author. We’ve seen that script code in IE is running in IE’s script engine and script code in XMetaL Author is running in XMetaL Author’s script engine. Therefore, we can’t directly invoke script methods or access script data. Instead we need to get references to the ActiveX controls and use the XMetaL API and IE API.
27. Additional Resources Information on the Internet Explorer ActiveX control. http://msdn.microsoft.com/en-us/library/aa752040(v=VS.85).aspx Information on the XMetaL API http://na.justsystems.com/webhelp/en/xmetaldeveloper/pg/6.0/pg.html