Integration with External Applications: General View

Transcription

1 Integration with External Applications: General View Ref GOAL Learn some of the functionalities of the Integration with AuraPortal Content 1. Integration Scheme 2. Which is the best option? 1.1. Data Importer Service 3. Other Integrations 1.2. Web Services (SOA) 1.3. AuraPortal Adapters Servers 1.4. System Task NOTIFIER 1.5. Web Services (SOA) 1.6. Script Execution

2 Integration with External Applications: General View Ref Referenced Documents 1. Manual-Delegated Administrator

3 1 Integration Scheme 0714/ 3

4 Integration Scheme AuraPortal 0714/ 4

5 Integration Scheme Example AuraPortal 1 Importer service 2 Web Service (SOA) 3 4 Balance in ERP Pending Invoices 6 7 Stock Values AuraPortal Web Services 5 Automatic Notifications 8 External Web Services 9 Messages via Web Services 10 TS Script execution 0714/ 5

6 1 1.1 Data Importer Service 0714/ 6

7 Data Importer Service 1 Importer Service AuraPortal includes a Windows Service called Importer Service to carry out data imports from external programs, allowing any data to be imported using ODBC, and lodging it wherever desired in AuraPortal, either in the main elements or in the Annexes. AuraPorta l MANUAL: To carry out manual imports when desired. PROGRAMMED: To carry out automatic imports on programmed days and times. Sigue INSTANT: To carry out automatic imports each x seconds, of XML files deposited with the data to be imported. 0714/ 7

8 1 1.2 Web Services (SOA) 0714/ 8

9 Web Services (SOA) 2 Web Services (SOA) The AuraPortal structure is designed using Services Orientated Architecture (SOA). An important part of the internal communications and nearly all of the transfers to the exterior are structured on Web Services. All the AuraPortal data is available using Web Services (SOA), both to enter as well as extract information. Sigue In this example, from the external program, the Web Service is invoked for a Start Message Event to trigger a Process with ERP data. 0714/ 9

10 1 1.3 AuraPortal Adapters Server 0714/ 10

11 AuraPortal Adapters Server With Adapters Server it is possible to connect to the external Databases to interact with AuraPortal. 3 Balance in ERP In this example, the Gateway DX.82 consults the ERP if the customer has a positive or negative balance in order to send the process in one direction or another. Sigue 4 Pending Invoices The user can, from his AuraPortal task, consult the invoices pending payment that are in the ERP. 6 Stock Check The system checks if there is stock available of the material sold. Sigue 0714/ 11

12 AuraPortal Adapters Server With AuraPortal Adapters Server it is possible to consult and modify data lodged in external Databases (ERP, CRM, ) from the AuraPortal Process tasks. There are multiple uses, for example: Show data from the external DB, in AuraPortal Process Tasks, so that the performer can consult or modify (depending on the set-up). The external DB data can be used by the Gateways of AuraPortal processes to make decisions, direct the Process flow in one direction or another depending on the value. 0714/ 12

13 1 1.4 System Task NOTIFIER 0714/ 13

14 System Task NOTIFIER 5 Automatic Notifications Sigue AuraPortal sends automatic notifications by . In this case, the customer receives one with details of his order status. Sigue 0714/ 14

15 1 1.5 Web Services (SOA) 0714/ 15

16 Web Services (SOA) 7 Web Services in AuraPortal With the System Task Deviator, AuraPortal Web Services are invoked to start other processes. In this case, to carry out the purchase of the necessary material. Sigue 8 External Web Services With the System Task Invoker, it is also possible to invoke external Web Services. In this case, to carry out the order to the supplier. 9 Messages via Web Services The System Task Deviator can also use Intermediate Message Events to upload data in functioning Processes. 0714/ 16

17 Web Services (SOA) The AuraPortal structure is designed using Service Oriented Architecture (SOA), in other words, Web Services. The Web Service is the most modern via and standard to interconnect applications using the Internet, both to upload as well as to extract information. For this, the WSDL (Web Services Description Language) has been used, and the construction of these Web Services is handled using SOAP (Simple Object Access Protocol) technology, the standard protocol from the auspicious W3C (World Wide Web Consorcium), which defines the communication between two objects using the XML standard. AuraPortal Many programs can connect to Web Services: standard applications (MS Access 2003, MS Excel 2003, ) as well as especially designed applications using any system, such as Java, Visual Basic, Delphi, Visual Studio.NET, etc. Two examples are the AuraPortal Warning Bell and the document Uploader. Internet 0714/ 17

18 Web Services (SOA) In AuraPortal there are three different types of Web Services: Generic Web Services: provided by default by SharePoint (the platform that is used to develop a large part of AuraPortal) and available for reading or writing the majority of the AuraPortal information. System Web Services: designed by AuraPortal to make specific proposals easier and included in the installation by default. The following can carry out the majority of actions that a user needs from the AuraPortal interface: AuraPortalProcesos: Process data. AuraPortalTareas: Open Tasks. AuraPortalDoc: Documents. AuraPortalFamilias: Families of Employees, Accounts, Projects, Items, Areas and Own Families. AuraPortalDiccionarioTerminos: Dictionary Terms. AccionBell: Warning Bell. AuraPortalSistema: Internal AuraPortal use. Personalized Web Services: both the Start Process Message Event and the Intermediate Message Event forms that are made to measure in the AuraPortal Process, can be published as Web Services to be invoked from other AuraPortal Processes from external programs. 0714/ 18

19 1 1.6 Scripts Execution 0714/ 19

20 Scripts Execution 10 TS Script Execution With a System Task that Executes Scripts, data can be transferred from the Process Panel using scripts. This system includes the possibility of executing any program code. 0714/ 20

21 Scripts Execution From the AuraPortal Processes it is possible to execute any program code, so any integration is possible. This characteristic is based on the execution of SQL Stored Procedures, where it is also possible to execute Transac scripts and those designed using any standard program (.Net, Visual Basic 6, Delphi, Java, ). The scripts can be executed from AuraPortal in: System Task for Script Execution: When the Process current arrives at a System Task of this type, the configured Stored Procedure and script are executed and also a program, if this is indicated. Script Button: In the Message and Process Task Forms, the Personal Role Record, the Own Family Element Record and the Roles Grid in the AuraPortal Account can have action buttons added, in this case the Script Button, from where configured Stored Processes are executed. 0714/ 21

22 Scripts Execution 1 In Sales Sub-process, the Sales Department has sold to a new Customer, who is registered in AuraPortal but not yet in the ERP. 2 The System Task TS.129 invokes a Stored Procedure that executes a program that carries out the following: With the RefBase provided by the TS.129, the method PanelDatosVer (DataSee) of the Web Services AuraPortalProcesos is invoked to obtain all the sales data, for example the new Customer ID. 2 4 With the ID of the new Customer Account, the method GetFichaCuenta (GetRegisterAccount) of the Web Service AuraPortalFamilias is invoked to obtain all its data. 5 5 With all the AuraPortal data, a new Customer is registered in the ERP and the Sales Invoice is made If desired, data can be uploaded into the Process Panel using the Intermediate Event (EM.117) or other from other Web Services. 0714/ 22

23 Script Execution Button Script Execution Button This is the same function as the System Task Script Execution, but applied to a button, where the Stored Procedure will be executed by the user. Buttons location The Script Buttons can be executed from: Personal Task Forms Message Forms Personal Role Records Account Roles window Grid (Account Record) Own Family Element Record Invoice Data Is uploaded to Panel Reads Invoice Data User Fills in Invoice and executes Script Button The behavior of the buttons is always the same, but there are variations in the parameters, fixed or optional, that go to the Stored Procedure, depending on where the button is. In the Personal Roles Record, the optional parameters are the fields of the actual record. In the Forms, the optional parameters are the panel fields of the process. 0714/ 23

24 Script Execution Button A possible example for the use of a Script Button in the Account Roles Grid in an account record is the integration with a VOIP (Voice over IP) switchboard, where phone calls can be made from AuraPortal. In the following image, the integrated button Call can be seen in the Account Roles Grid. In practice, by selecting this button, a call is made using the switchboard. To make the call, it is only necessary to have the Phone parameter in the personal role record. 0714/ 24

25 Script Execution Button Example of a Script Button in a Personal Role Record Example of a Script Button in a Task Form Fixed Parameters Fixed Parameters Variable Parameters Variable Parameters 0714/ 25

26 2 Which is the best option? 0714/ 26

27 Which is the best option? Importer Service Adapter Server TS Script Execution Web Services Oriented to importing data in the general structure of AuraPortal Families, whether regularly or just once. The connection with the external DB is established using ODBC, and with AuraPortal there is internal communication with Web Services. It only requires knowledge of script language and the external Database structure. Oriented to handle external data from AuraPortal Processes, both in Gateways and in Personal Tasks. The connection with the external DB is established using ODBC, and with AuraPortal there is internal communication with Web Services. It only requires knowledge of script language and the external Database structure. It is only limited by the possibilities of the external application to be connected by scripts. Allows the execution of program code from the AuraPortal Processes. The coonection with AuraPortal is handled by using Web Services. The connection with the external application will depend on each case (Web Services, APIs, Active-X, directly to the Database, etc). Unlimited, any integration is possible. Always available for obtaining or uploading information to AuraPortal using programs created for this. To upload data: In processes, always using Web Services of Start (IM) and Intermediate (EM) Messages. To upload data to the rest of the Families, it must be done by using the System Web Services. To obtain data: With the System Web Services. Unlimited, any integration is possible. 0714/ 27

28 3 Other Integrations 0714/ 28

29 Other Integrations Besides the integrations with external application data, as already explained, other important forms of integration are: Reporting, Business Intelligence & DashBoard Integration with Web Applications Integration with external Document Handling 0714/ 29

30 Other Integrations Reporting, Business Intelligence & DashBoard Beside the tools included in AuraPortal for Business Intelligence and Dashboars for the analysis and control of Processes, it is also possible to use external tools that are compatible with MS SQL. Especially, SQL Reporting Services is integrated in AuraPortal, and by using it, all types of reports and queries (simple or complex), of one or several elements, and visual and practical graphic representations can be created: In AuraPortal Training School, courses on Data Location are given, in which the access keys to all the data, both SQL and SharePoint, are shown. Also, the AuraPortal Consultancy department provides SQL Views that are specifically prepared to make the implementation of the Reporting Services easier. 0714/ 30

31 Other Integrations Integration with Web Applications AuraPortal is 100% Web, so it is easy to integrate with other Web applications, either including all the functionalities in another Web, or vice versa, integrating the other application inside AuraPortal. Example of html interface design with the AuraPortal functions. 0714/ 31

32 Other Integrations Integration with external Document Handling AuraPortal has a special integration with the SharePoint Document Management, but it is also possible to make connections with other document management systems, as long as it is Web. In the set up of the Libraries Tree in the AuraPortal Structure, any URL can be added. This way, when the user navigates the AuraPortal Libraries Tree, it is possible to access all the Libraries, both inside AuraPortal and in external URLs. 0714/ 32

33 Contact Thank you! AuraPortal Training School Integration with External Applications: General View Ref PR0200/