Getting started with the Web Interface

The Web Interface allows you to use the same functionality in a simple web browser like the Generic Tool Adaptor or the Eclipse plugin has. Any kind of web browser can be used which supports the HTML 4.01.

With this extension your users do not have to install OTIF to use OTIF functions. If you install OTIF and setup the MS IIS web server on your server machine, your users may publish or fetch any kind of documents through a web browser.


How to use the package

How to create your own OTIF site

You need to be familiar with Active Server Page technology, a good start point can be the ASP pages in [OTIF_installation_directory]/www. This simple OTIF site implements all the functionality that you can find in Generic Tool Adaptor.

The pages are using interface provided by [OTIF_installation_directory]/bin/Generic_ToolAdaptor_ActiveX.ocx to generate HTML pages.

The interface methods are the follows:

STDMETHOD(initialize)(/*[in]*/ BSTR parameters, /*[out,retval]*/ BSTR *err);
STDMETHOD(remoteTypes)(/*[out,retval]*/ BSTR *ret);
STDMETHOD(remoteParadigms)(/*[out,retval]*/ BSTR *ret);
STDMETHOD(getActions)(/*[out,retval]*/ BSTR *ret);
STDMETHOD(getSubscribable)(/*[out,retval]*/ BSTR *ret);
STDMETHOD(getPublishable)(/*[out,retval]*/ BSTR *ret);
STDMETHOD(loginToolAdaptor)(/*[in]*/ BSTR type, /*[out,retval]*/ BSTR *err);
STDMETHOD(publishDocument)(/*[in]*/ BSTR name, /*[in]*/ BSTR version, /*[in]*/ long keepAlive, /*[in]*/ BSTR remarks,
/*[in]*/ BSTR filename, /*[in]*/ BSTR xslt_filename, /*[in]*/ BSTR attachments, /*[in]*/ long update_id, /*[out,retval]*/ BSTR *err);
STDMETHOD(subscribeParadigm)(/*[in]*/ BSTR par_name, /*[in]*/ BSTR par_version, /*[out,retval]*/ BSTR *err);
STDMETHOD(availableDocuments)(/*[out,retval]*/ BSTR *ret);
STDMETHOD(requestDocument)(/*[in]*/ BSTR extension, /*[in]*/ BSTR mga_par, /*[in]*/ BSTR directory, /*[in]*/ long doc_id,
/*[in]*/ BSTR xslt_filename, /*[out,retval]*/ BSTR *err);
STDMETHOD(availableGMEParadigms)(/*[out,retval]*/ BSTR *ret);
STDMETHOD(logout)(/*[out,retval]*/ BSTR *ret);
STDMETHOD(unsubscribeParadigm)(/*[in]*/ BSTR par_name, /*[in]*/ BSTR par_version, /*[out,retval]*/ BSTR *err);
STDMETHOD(getExistingDocuments)(/*[out,retval]*/ BSTR *ret);

You need to design your own ASP site and implement (with VBS or JScript) the control using the methods above to reach OTIF's core functionality.


Dependencies

This package depends on (and fully compatible with):


Contact and support

If you have any question, please contact: Andras Lang

Upgrades, accessories are posted to the project website


Credits