Woohaa! Service URL
This article discusses how to set up the Woohaa! Client RESTful web service.
The Service URL is used to fully automate transactions in the Woohaa! network. Aside from setting up the client RESTful web service, you may also need to set up other required tools such as the WCF feature and application pools within IIS and configure the database connections using the Connected Business Application Configuration Tool. When all of these are set up, Woohaa should be able to communicate with your company seamlessly and automate all transactions at any given time.
Before you can set up the Woohaa! Client Web Service, you must have the following prerequisites:
Microsoft.Net 4 Framework must be installed.
IIS (Internet Information Services) must be up and running.
Woohaa! components must be installed.
Public IP is required to bind the service with.
Refer to Installing Connected Business. Make sure to select the entire feature for the Woohaa! Components when installing the Connected Business Application.
Step 1 - Add WCF Feature in IIS
The following platforms are supported in Connected Business:
- Windows 7
- Windows Vista
- Windows XP
- MS Small Business Server
- Windows Server 2008
- Windows Server 2003
Depending on the platform, you can add the WCF feature from the Features window of your current platform, Look for the Microsoft .Net Framework folder and enable the Windows Communication Foundation HTTP Activation and Non-HTTP Activation feature.
Step 2 – Configure Woohaa! Client Web Service
To configure the Woohaa! Client Web Service, open the Web.Config file in the Connected Business Application Configuration Tool. The web.config file is usually located in C:\Program Files (x86)\Interprise Solutions\Connected Business 13\CBN\Web. To know more about defining configurations, refer to Open Existing Configurations and Define New Configurations.
In the web.config file, set CBNAdmin for both the User Code and Password fields. Enter the database credentials and click the Test button to verify the database connection.
Make sure to use SQL Server Authentication for the Database Connection particularly for the Cache Database and don’t forget to update the connection when the user password is changed.
Step 3 – Configure the IIS to Host the Woohaa! Client Web Service
If the Woohaa! component is installed, the system automatically createa a Woohaa! website in IIS which is already hosted e.g. InterpriseCBN. You can modify the settings for the existing Woohaa! website or create a new website and configure it to point to the Woohaa! Client Web Service. In configuring the web service settings for a new website, you can refer to Configure Web Service.
In modifying the Application Pool for the Woohaa! Client Web Service, you can go the Application Pools page of IIS and select the application pool for Woohaa! . Open the advance settings (right click on the application pool and select Advance Settings),
and set the values for the following fields:
|.NET Framework Version||V4.0|
|Enable 32-bit Application||This option will only be available if you are using a 64-bit application. If available, set to True.|
|Managed Pipeline Mode||Integrated|
Make sure that the NetworkService user has a Read and Write access on the files and folders where the website files are located.
To assign an identity, click the ellipsis button and the Application Pool Identity window will be displayed. From the Built-In Account option, select your preferred identity from the dropdown list.
Step 4 – Test the Woohaa! Client Web Service
- Open the IIS Manager. Alternately, you may also key in inetmgr in the Search field on the Start menu.
- Right click on the web site you created for Woohaa! . and then go to Manage Web Site > Browse.
- A web browser will open and will try to open the Woohaa! client web service.
- Click on the link service help page or simply append “help” on the URL to view the Woohaa! Client Web Service endpoint. See sample screenshot below:
- You can check if your client service is working properly. To do this, access the “Test” method from the service (simple append “Test” on the URL). See screenshot below for reference:
It should return a 115, Web service is up and running message, else, your web service is not properly setup. You may need to check the configuration file again and / or make sure that your client service file is the same version as your database.
- Once you get a 115 response, you are now ready to use your service for Woohaa! ! Network.
Your service URL should not include the help or test methods in your profile or enrollment form. The format should only be http://domain.com/woohaa service and NOT http://domain.com/woohaaservice/help nor http://domain.com/woohaaservice/test.