All product information in wiki.bizagi.com is only valid for Bizagi BPM Suite 9.1.X.
For newer Bizagi BPM Suite versions (10.X and up) please visit the User Guide.
 

Bizagi SOA layer URL and considerations

From Business Process Management, BPM and Workflow Automation Wiki | BizAgi BPMS

Jump to: navigation, search

<keywords content="keywords">http URL, Bizagi web services, SOA layer, integration, portal, SOA, asmx, ?wsdl, wsdl, integration layer, </keywords>


Contents

Bizagi SOA layer URL and considerations

Overview

Every project in Bizagi has built-in SOAP web services to expose the processes' functionality for integration with external applications.

These web services from Bizagi SOA's layer are already published but its URL may slightly vary according to the Server used for the project's web application.


This article lists further detail about this and some considerations for web services interoperability among different platform technologies.


URL and considerations

Take into account the following information for Bizagi integration with external systems and applications.


Bizagi SOA layer's URL

Web services in Bizagi's SOA Layer are published under the following http URL.


For Bizagi Enterprise .Net and Bizagi Xpress

In Bizagi projects using Microsoft's IIS (in .Net solutions from Bizagi Enterprise .Net or Bizagi Xpress), the SOA layer's web services are located as:

http://[Server_name]/[Bizagi_project]/WebServices/[internal_component].asmx


Notice that:

  • [Server_name] is the name of your project's server.
  • [Bizagi_project] is the name of your Bizagi project.
  • [internal_component] is the name of Bizagi's internal component. There are 4 possible web services: EntityManagerSOA, WorkflowEngineSOA, QuerySOA and RenderSOA.


Example: 


http://localhost/CreditApplication/WebServices/EntityManagerSOA.asmx


For Bizagi Enterprise JEE

In Bizagi projects using Bizagi Enterprise JEE, the SOA layer's web services are located as:

http://[Server_name]:[port_number]/Bizagi-war/WebServices/[internal_component].asmx

Notice that:

  • [Server_name] is the name of your project's server.
  • [port_number] is the port number on which the JEE Application server starts up.
  • [internal_component] is the name of Bizagi's internal component. There are 4 possible web services: EntityManagerSOA, WorkflowEngineSOA, QuerySOA and RenderSOA.

Example: 

http://localhost:8080/Bizagi-war/WebServices/EntityManagerSOA?wsdl



Bizagi's web methods

The web methods available for Bizagi processes receive a String with XML format as input parameter. These methods are the same for all Bizagi editions.


This means that in Bizagi Enterprise JEE edition, Bizagi Enterprise .Net, and Bizagi Xpress, the SOA Layer's methods are those named with an .."AsString" termination (such as createCasesAsString, getEntitiesAsString, queryCasesAsString, performActivityAsString, saveEntityAsString, etc).


In addition to this, for Bizagi processes in .Net platforms (Bizagi Enterprise .Net and Bizagi Xpress), Bizagi SOA Layer's web methods are also available receiving an XML document as input parameter (such as createCases, getEntities, queryCases, performActivity, saveEntity, etc). This input parameter is of the type XMLDocument class (native in .Net).


Using CDATA

While using Bizagi's web methods (those which receive String-type input parameters or those which receive XMLDocument), it is recommended to use the CDATA element for any string contained in the XML.

This applies for all Bizagi editions, and ensures that any XML special characters (such as apostrophe, double quotes, ampersand, less-than and greater-than marks, etc) are correctly received by a web service, according to standard XML best practices.

The following example shows the CDATA element use in a getActivitiesAsString invocation: 

<![CDATA[<BizAgiWSParam><domain>domain</domain><userName>admon</userName><BizAgiWSParam>]]>


The following example shows the CDATA element use in a getEntities invocation: 

<BizAgiWSParam><EntityData><EntityName>Customer</EntityName><Filters><![CDATA[ Active=1 ]]></Filters> 
</EntityData><BizAgiWSParam>


Using Java-based clients to invoke Bizagi's web methods in a .Net environment

Whenever a Java client is used to consume Bizagi's web services, its referenced URL must be complemented with the ?wsdl termination.

For example if Bizagi processes are executed in a .Net platform (using Bizagi Enterprise .Net or Bizagi Xpress editions), then these processes' web services are published as: 

http://[Server_name]/[Bizagi_project]/webservices/WorkflowEngineSOA.asmx


When using a Java client to invoke these methods, it should explicitly reference: 

http://[Server_name]/[Bizagi_project]/webservices/WorkflowEngineSOA.asmx?wsdl



Using a root node

When sending XML information to Bizagi via web services (either when invoking web methods of Bizagi SOA, or when receiving updated response information from an invocation), the resulting XML and its transformation should always consider a root node.

This goes according to best practices as well, in which well-formed XML files always contain a root node.

In Bizagi, most often it is the <Entities> or <BizAgiWSResponse>, or the Application Entity.



Using Dates

When sending and including dates in an XML, it is required to use the XML standar format.

This format is: 


YYYY-MM-DDTHH:mm:ss



Related Articles

<comments />

Retrieved from "http://wiki.bizagi.com/en/index.php?title=Bizagi_SOA_layer_URL_and_considerations"