Customizing Webdocs With REST Events

This gives you an overview of how to use custom code to integrate with Webdocs. The scope of the custom code can be as large or small as your organization needs. Some common uses of custom code include:

  • Automating manual tasks.

  • Integrating with other programs or databases to import data to Webdocs or to receive data from Webdocs.

  • Automatically updating similar documents when one document is updated.

  • Validating search-key entry and rejecting any document whose validation fails.

  • Notifying non-Webdocs users, like managers, when important documents are changed.

  • Much more.

REST Events

There are ten places in Webdocs that can integrate with custom code. These places are called events. The supported events are:

  • Pre Checkin - Before a new document is added to Webdocs.
    • Can deny the checkin if custom rules are not met
    • Can populate keys from database lookups
  • Post Checkin - After a new document is added to Webdocs.
    • Cannot deny the checkin
  • Pre Update - Before a document's metadata is updated in Webdocs.
    • Can deny the update if custom rules are not met
    • can populate keys from database lookups
  • Post Update - After a document's metadata is updated in Webdocs.
    • Cannot deny the update
  • Route Step Advancing - Before a document in a route is advanced to the next step.
    • Can block the advancement if custom rules are not met
  • Route Step Advanced - After a document in a route is advanced to the next step.
    • Cannot block the advancement of the route
  • Route Completed - After a document reaches the end of a route.
  • Route Rejected - After a document is rejected on a route.
  • Pre Move - Before a document is moved to a new folder
    • Can block the move if custom rules are not met
  • Post Move - After a document is moved to a new folder
    • Cannot block the move

Depending upon what you need Webdocs to do, you might only need to utilize a single event. Write as little custom code as necessary to meet your needs.

Writing the Custom Code

To customize Webdocs at one or more of its events, someone has to write the custom code in the in their programming language of choice that can listen for a REST call. A sample application is provided with the Webdocs installation folder in C# to get you started.

If you need to customize Webdocs and you do not have a programmer at your organization or you require assistance with this feature please contact Fortra for