Retrieve Templates from HotDocs Hub
HotDocs
Hub
is a suite of components
that provides Template management, User management, and Interview tools
for use with HotDocs Web Services. You can
retrieve template files from the Hub instead of using templates stored
in the Web
Services cache. This is accomplished using the RetrieveFromHub
parameter when making a request to the HotDocs Web
Services API.
In this Topic ShowHide
Configure
Web Services to use the HotDocs Hub
HotDocs
Web Services must be configured to connect
to the HotDocs Hub before the RetrieveFromHub parameter can be used. This is typically done
when installing
the Web Services API. If the parameter is not entered
when installing Web Services, you can manually configure the setting in
the Web Services web.config file.
To
manually configure Web Services to retrieve template files from HotDocs
Hub
- Navigate
to the Web Services installation directory; by default, this is C:\Program Files (x86)\HotDocs Server\HDSWebAPI\.
- Edit the Web.config
file in a text editor.
- Add the following line
to appSettings:
<add
key="TemplateHubUri" value="url"
/>
Where url is the
URL for the HotDocsTemplateHubApi
application installed in IIS, as part of your HotDocs Hub solution;
e.g. http://servername/HotDocsTemplateHubApi/.
Using RetrieveFromHub
The RetrieveFromHub parameter may only be used with the following
Web Services API methods: