Web Documentation

 

Web Services API

 Print

LogicalDOC can be used as middleware and can be integrated with other systems by the use of the built-in Web Service. The Web Service module is part of the LogicalDOC core distribution and is compliant with W3C specifications SOAP and MTOM. Using SOAP over HTTP allows for easier communication through proxies and firewalls than previous remote execution technology. MTOM is a method of efficiently sending binary data to and from web services; it allows more efficient sending of binary data in a SOAP request or response.

LogicalDOC also supports a the more informal standard called RESTful.

The LogicalDOC Web Services are divided in a number of specialized services, each one dedicated to a specific topic.

Web Services Bindings and Samples

The easiest way to interface with LogicalDOC's API's is by using one of our Bindings and Samples we provide in the product's wiki page. In that page we provide source code projects in all major programming languages​​: Java, .Net, PHP, Python. They can be a good examples to quickly learn "hands on" how to interface with the LogicalDOC's API

Web Services Documentation

• SOAP Documentation
• 8.6.1
• 8.6
• 8.5.2
• 8.5.1
• 8.5
• 8.4.2
• 8.4.1
• 8.4
• 8.3.4
• 8.3.3
• 8.3.2
• 8.3.1
• 8.3
• 8.2.2
• 8.2.1
• 8.2
• 8.1.1
• 8.1
• 8.0
• 7.7.5
• 7.7.4
• 7.7.3
• RESTful Documentation
• 8.6.0
• 8.4.2
• 8.3.4
• 8.1
• 7.7.6
• 7.6.4

• The LogicalDOC platform is developed using the Java programming language. As such, we provide full documentation of the Java classes you could use from inside a sophisticated Automation script or a custom plug-in.

  We divided the documentation into the Community and Enterprise parts, the first covers the functions of the open-source package, while the second covers the capabilities of the commercial editions.

  Java Documentation

  • 8.6.1
  • 8.6
  • 8.5.2
  • 8.5.1
  • 8.5
  • 8.4.2
  • 8.4.1
  • 8.4

• 
  

• Automation

   Print

  The Automation is a pervasive aspect of the LogicalDOC platform and represents the way you have to program things using a simple scripting language. Sometimes you wish LogicalDOC to execute your own logic when something special happens during a workflow or in reaction to specific events occurrend inside the repository: with the Automation you can inject your own algorithm to take the proper actions automatically. Many objects support Automation and allow you to define custom Automation's scripts(folders, workflows, emails, etc.)

  Please look at the Automation Syntax Guide to familiarize with the syntax. You may also look at the Automation Snippets.

  In your automation scripts you can reference the following variables(some of them are only available in certain scopes):

  
  

  GENERALLY AVAILABLE
  Variable	Java Class	Description
  nl		represents the new line
  product		name of the product
  locale		current locale
  CURRENT_DATE		current date
  tenantId		identifier of the current tenant
  dictionary		map with all the variables(variable_name > value)
  keys		set of all the keys in the dictionary
  parameters		map with all the routine's invocation parameters names(parameter_name > value)
  parametersnames		set of all the routine's invocation parameters
  log	LogTool	gives access to the system's log
  I18N	I18NTool	handles the translations
  DateTool	DateTool	manipulation and formatting of dates
  NumberTool	NumberTool	formats a number using the given format
  DocTool	DocTool	handles documents and related resources
  FolderTool	FolderTool	handles folders and related resources
  ClassTool	ClassTool	creates new instances of the given class
  SystemTool	SystemTool	functions for interacting with the Operative System
  MailTool	MailTool	functions to send e-mails
  BarcodeTool	BarcodeTool	class to extract barcode contents from documents
  StampTool	StampTool	applies stamps into documents
  SignTool	SignTool	digitally signs a document with the user's digital certificate
  AutomationTool	AutomationTool	executes an automation routine in the same execution thread or a new one
  ContextTool	ContextTool	methods to access the Application context
  SplitTool	SplitTool	allows the splitting of a PDF in segments using different policies
  SecurityTool	SecurityTool	handles some security related operations
  WorkflowTool	WorkflowTool	methods to handle workflows and interact with them
  WebsocketTool	WebsocketTool	utility functions to interact with the user interface
  UserTool	UserTool	utility methods to handle some user related operations
  SearchTool	SearchTool	utility methods to do searches
  AVAILABLE WHEN REACTING TO EVENTS
  event	History	the current event
  document	Document	the document associated to the current event(if any)
  folder	Folder	the folder associated to the current event(if any)
  AVAILABLE INSIDE WORKFLOW
  candidates	User	list of the current task's candidate users
  documents	Document	list of the attached documents
  task		the current task
  taskName		name of the current task
  initiator	User	the user that started the workflow
  workflow		name of the workflow
  processId		identifier of the current process
  definitionId		identifier of the process definition
  actions		list of possible actions(transitions) declared for the current task
  assignee		user assigned to the current task
  AVAILABLE IN CustomID / Auto naming / Auto folding
  document	Document	the document being currently saved
  AVAILABLE IN WELCOME MESSAGE
  user	User	the currently logged in user
  session	Session	the current session
  AVAILABLE IN DASHLETS
  user	User	the currently logged in user
  session	Session	the current session
  dashlet	Dashlet	the dashlet object
  AVAILABLE IN THE EXECUTION OF A SCRIPT OR A CUSTOM ACTION
  user	User	the currently logged in user
  session	Session	the current session
  document	Document	the selected document
  documents	Document	the selected documents
  folder	Folder	the selected folder
  AVAILABLE DURING EMAIL IMPORT
  email	EMail	the email being imported
  AVAILABLE IN ZONAL OCR
  document	Document	the document being processed
  sample		the text extracted from the zone
  value		the value object(String, Date, Decimal ...) converted from the sample
  zone	Zone	the zone being processed, use zone.value if you want to change the value that will be saved in the document
  AVAILABLE DURING EXTERNAL AUTHENTICATION
  ldapUser	LDAPUser	the user being authenticated
  AVAILABLE IN THE NOTIFICATION OF NEW DEVICE
  user	User	the currently logged in user
  device	Device	the device used to login
  client	Client	the remote client connected to the platform
  event	History	the login event