Client Software
(→Built in C Sharp (C#)) |
|||
| (144 intermediate revisions by 7 users not shown) | |||
| Line 2: | Line 2: | ||
__TOC__ | __TOC__ | ||
| + | == Introduction == | ||
| + | |||
| + | This page documents the various client applications that Econz Wireless provides to it's customers for integration purposes. If you wish to bypass this and go directly to the source code examples for developing your own integrations with Econz Wireless products, please go to our [[Downloads]] page. | ||
| + | |||
| + | == The EService Integrator == | ||
| + | |||
| + | Developed in house, this application is designed to simplify the process of connecting external system to EService. The Integrator is designed to read incoming XML messages from Emails, Files, or Microsoft Message Queue Messages, convert them to EService Jobs, and send them into EService. The Integrator can then monitor these jobs and send XML Emails, Files, and Messages out detailing any status changes or updates to jobs in EService, allowing external systems to receive near real time job monitoring information. | ||
| + | |||
| + | The Integrator uses the SOAP interface to achieve this, but no knowledge of the SOAP interface is required to use the Integrator. | ||
| + | |||
== EService Test Clients == | == EService Test Clients == | ||
=== Built in C Sharp (C#) === | === Built in C Sharp (C#) === | ||
| − | The EService CSharp Test | + | The EService CSharp Test Client application is a complete test client in the sense that it is capable of running all of the EService SOAP methods as well as processing all of the data types returned by these SOAP methods respectively. It contains an internal data storage mechanism, i.e. Datasets to store the data in xml files within the application folder, that allows for progression and saving of job and task data and thus allowing users to effectively perform any function of the website via the application interface. It can also easily switch between different organisations. Please check back soon for instructions on how to request an organisation in our EService webserver. |
| − | It is made up of several panels, each of which is capable of running a group of related methods, e.g. methods for manipulating customer details, job details, etc. On the right hand side of each panels are two groups of buttons. The top group of light gray buttons contain buttons for calling methods to manipulate the local data storage, which is stored as xml files within the application folder. The lower group of dark gray buttons contain buttons for calling EService | + | It is made up of several panels, each of which is capable of running a group of related methods, e.g. methods for manipulating customer details, job details, etc. On the right hand side of each panels are two groups of buttons. The top group of light gray buttons contain buttons for calling methods to manipulate the local data storage, which is stored as xml files within the application folder. The lower group of dark gray buttons contain buttons for calling EService SOAP methods, i.e. those methods to interact with EService webserver. |
| − | The source code of this test client application should be able to help current and potential users of EService write their own modules to interact with EService webserver. For example, should a developer need to develop a module to export/import customer data to/from EService webserver, he or she could have a look at the source code for the "Create Customers" and "Manage Customers" panels. | + | The source code of this test client application should be able to help current and potential users of EService write their own modules to interact with EService webserver. It represents the coding required to link an external report or data management system with EService, and the source code is available to assist developers in creating their own linking modules to EService. |
| + | For example, should a developer need to develop a module to export/import customer data to/from EService webserver, he or she could have a look at the source code for the "Create Customers" and "Manage Customers" panels. | ||
The documentation for the client is here : [http://iweb.econz.co.nz/wiki/images/8/81/EService_CSharp_Full_Test_Client_Documentation_1.0.pdf C# Test Client Documentation]. | The documentation for the client is here : [http://iweb.econz.co.nz/wiki/images/8/81/EService_CSharp_Full_Test_Client_Documentation_1.0.pdf C# Test Client Documentation]. | ||
| − | |||
==== Visual Studio 2003 ==== | ==== Visual Studio 2003 ==== | ||
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/ | The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/ | ||
| − | |||
==== Visual Studio 2005 ==== | ==== Visual Studio 2005 ==== | ||
| − | The Test clients built under Visual Studio | + | The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/ |
=== Built in Visual Basic .Net === | === Built in Visual Basic .Net === | ||
| − | The Visual Basic Test | + | The Visual Basic Test Client is more limited in scope compared to its C Sharp alternative as it only focuses on a single method of the appropriate SOAP API. However, it contains highly detailed and comprehensive commenting in the source code. This Visual Basic client is designed to show existing and potential users of EService how to write Visual Basic .NET program to interact with EService webserver, i.e. how to invoke an EService SOAP method and process the returned value using a Visual Basic .NET program. This example should be sufficient as the procedures for invoking all of the other EService SOAP methods (as well as processing the returned values) are the same. |
The provided Visual Basic EService Test Client can only access the EService SOAP method to retrieve details of a job, given the primary key of the job. | The provided Visual Basic EService Test Client can only access the EService SOAP method to retrieve details of a job, given the primary key of the job. | ||
| Line 33: | Line 42: | ||
==== Visual Studio 2005 ==== | ==== Visual Studio 2005 ==== | ||
| − | The Test clients built under Visual Studio | + | The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/ |
| + | |||
| + | ==== Visual Studio 2008 ==== | ||
| + | The Test clients built under Visual Studio 2008 are designed to run against the Microsoft .NET Framework 3.5 SP1. The 3.5 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/ | ||
| + | |||
== Timecard Test Clients == | == Timecard Test Clients == | ||
=== Built in C Sharp (C#) === | === Built in C Sharp (C#) === | ||
| − | The Timecard CSharp Full Test Client exercises the full set of methods and data types in the Timecard Web Service. It uses Datasets to store the data in xml files within the application folder, allowing users to effectively perform any function of the website via the application interface. The | + | The Timecard CSharp Full Test Client exercises the full set of methods and data types in the Timecard Web Service. It uses Datasets to store the data in xml files within the application folder, allowing users to effectively perform any function of the website via the application interface. |
| + | |||
| + | It is made up of several panels, each of which is capable of running a group of related methods, e.g. methods for manipulating user events, teams, etc. On the right hand side of each panels are two groups of buttons. The top group of light gray buttons contain buttons for calling methods to manipulate the local data storage, which is stored as xml files within the application folder. The lower group of dark gray buttons contain buttons for calling Timecard SOAP methods, i.e. those methods to interact with Timecard webserver. | ||
| + | |||
| + | The source code of this test client application should be able to help current and potential users of Timecards write their own modules to interact with Timecard webserver. It represents the coding required to link an external report or data management system with Timecard, and the source code is available to assist developers in creating their own linking modules to Timecard. | ||
| + | For example, should a developer need to develop a module to manage teams in Timecard webserver, he or she could have a look at the source code for the "Team Management" panel. | ||
==== Visual Studio 2003 ==== | ==== Visual Studio 2003 ==== | ||
| + | The Timecard C# Full Test Client has been built to completely exercise all the functions and features of the Timecard SOAP API. It allows you to retrieve information about users events and hours of specified time intervals, and create new users and teams. Please check the [[Downloads]] page for more information about geting the source code and a test client installer. | ||
| + | |||
| + | The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/ | ||
==== Visual Studio 2005 ==== | ==== Visual Studio 2005 ==== | ||
| + | The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/ | ||
=== Built in Visual Basic .Net === | === Built in Visual Basic .Net === | ||
| − | The Visual Basic Test Clients | + | The Visual Basic Test Clients is more limited in scope compared to its C Sharp alternative as it focuses on a single method of the appropriate SOAP API. However, it contains highly detailed and comprehensive commenting in the source code. This Visual Basic client is designed to show existing and potential users of Timecard how to write Visual Basic .NET program to interact with Timecard webserver, i.e. how to invoke an Timecard SOAP method and process the returned value using a Visual Basic .NET program. This example should be sufficient as the procedures for invoking all of the other Timecard SOAP methods (as well as processing the returned values) are the same. |
| + | |||
| + | The provided Visual Basic Timecard Test Client can only access the EService SOAP method to retrieve event details of a user, within a given time period, given the primary key of the user, the start date and the end date of the period. | ||
==== Visual Studio 2003 ==== | ==== Visual Studio 2003 ==== | ||
| + | |||
| + | The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/ | ||
==== Visual Studio 2005 ==== | ==== Visual Studio 2005 ==== | ||
| + | The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/ | ||
Latest revision as of 03:21, 8 May 2017
| Main Page | Latest News | F.A.Q. | EService | Timecard | Web Services | Client Software | Downloads |
Contents |
[edit] Introduction
This page documents the various client applications that Econz Wireless provides to it's customers for integration purposes. If you wish to bypass this and go directly to the source code examples for developing your own integrations with Econz Wireless products, please go to our Downloads page.
[edit] The EService Integrator
Developed in house, this application is designed to simplify the process of connecting external system to EService. The Integrator is designed to read incoming XML messages from Emails, Files, or Microsoft Message Queue Messages, convert them to EService Jobs, and send them into EService. The Integrator can then monitor these jobs and send XML Emails, Files, and Messages out detailing any status changes or updates to jobs in EService, allowing external systems to receive near real time job monitoring information.
The Integrator uses the SOAP interface to achieve this, but no knowledge of the SOAP interface is required to use the Integrator.
[edit] EService Test Clients
[edit] Built in C Sharp (C#)
The EService CSharp Test Client application is a complete test client in the sense that it is capable of running all of the EService SOAP methods as well as processing all of the data types returned by these SOAP methods respectively. It contains an internal data storage mechanism, i.e. Datasets to store the data in xml files within the application folder, that allows for progression and saving of job and task data and thus allowing users to effectively perform any function of the website via the application interface. It can also easily switch between different organisations. Please check back soon for instructions on how to request an organisation in our EService webserver.
It is made up of several panels, each of which is capable of running a group of related methods, e.g. methods for manipulating customer details, job details, etc. On the right hand side of each panels are two groups of buttons. The top group of light gray buttons contain buttons for calling methods to manipulate the local data storage, which is stored as xml files within the application folder. The lower group of dark gray buttons contain buttons for calling EService SOAP methods, i.e. those methods to interact with EService webserver.
The source code of this test client application should be able to help current and potential users of EService write their own modules to interact with EService webserver. It represents the coding required to link an external report or data management system with EService, and the source code is available to assist developers in creating their own linking modules to EService. For example, should a developer need to develop a module to export/import customer data to/from EService webserver, he or she could have a look at the source code for the "Create Customers" and "Manage Customers" panels.
The documentation for the client is here : C# Test Client Documentation.
[edit] Visual Studio 2003
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/
[edit] Visual Studio 2005
The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/
[edit] Built in Visual Basic .Net
The Visual Basic Test Client is more limited in scope compared to its C Sharp alternative as it only focuses on a single method of the appropriate SOAP API. However, it contains highly detailed and comprehensive commenting in the source code. This Visual Basic client is designed to show existing and potential users of EService how to write Visual Basic .NET program to interact with EService webserver, i.e. how to invoke an EService SOAP method and process the returned value using a Visual Basic .NET program. This example should be sufficient as the procedures for invoking all of the other EService SOAP methods (as well as processing the returned values) are the same.
The provided Visual Basic EService Test Client can only access the EService SOAP method to retrieve details of a job, given the primary key of the job.
[edit] Visual Studio 2003
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/
[edit] Visual Studio 2005
The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/
[edit] Visual Studio 2008
The Test clients built under Visual Studio 2008 are designed to run against the Microsoft .NET Framework 3.5 SP1. The 3.5 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/
[edit] Timecard Test Clients
[edit] Built in C Sharp (C#)
The Timecard CSharp Full Test Client exercises the full set of methods and data types in the Timecard Web Service. It uses Datasets to store the data in xml files within the application folder, allowing users to effectively perform any function of the website via the application interface.
It is made up of several panels, each of which is capable of running a group of related methods, e.g. methods for manipulating user events, teams, etc. On the right hand side of each panels are two groups of buttons. The top group of light gray buttons contain buttons for calling methods to manipulate the local data storage, which is stored as xml files within the application folder. The lower group of dark gray buttons contain buttons for calling Timecard SOAP methods, i.e. those methods to interact with Timecard webserver.
The source code of this test client application should be able to help current and potential users of Timecards write their own modules to interact with Timecard webserver. It represents the coding required to link an external report or data management system with Timecard, and the source code is available to assist developers in creating their own linking modules to Timecard. For example, should a developer need to develop a module to manage teams in Timecard webserver, he or she could have a look at the source code for the "Team Management" panel.
[edit] Visual Studio 2003
The Timecard C# Full Test Client has been built to completely exercise all the functions and features of the Timecard SOAP API. It allows you to retrieve information about users events and hours of specified time intervals, and create new users and teams. Please check the Downloads page for more information about geting the source code and a test client installer.
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/
[edit] Visual Studio 2005
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/
[edit] Built in Visual Basic .Net
The Visual Basic Test Clients is more limited in scope compared to its C Sharp alternative as it focuses on a single method of the appropriate SOAP API. However, it contains highly detailed and comprehensive commenting in the source code. This Visual Basic client is designed to show existing and potential users of Timecard how to write Visual Basic .NET program to interact with Timecard webserver, i.e. how to invoke an Timecard SOAP method and process the returned value using a Visual Basic .NET program. This example should be sufficient as the procedures for invoking all of the other Timecard SOAP methods (as well as processing the returned values) are the same.
The provided Visual Basic Timecard Test Client can only access the EService SOAP method to retrieve event details of a user, within a given time period, given the primary key of the user, the start date and the end date of the period.
[edit] Visual Studio 2003
The Test clients built under Visual Studio 2003 are designed to run against the Microsoft .NET Framework 1.1. The 1.1 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/
[edit] Visual Studio 2005
The Test clients built under Visual Studio 2005 are designed to run against the Microsoft .NET Framework 2.0. The 2.0 Framework can be downloaded from Microsoft's website : http://msdn.microsoft.com/netframework/downloads/updates/
