Walk-Through Using the Scheduling Provider Examples
To properly set up an XWS, which allows the XCA to become an appointment store for Crestron Fusion, follow the steps below.
-
Choose a host server where the XWS is to be installed. While it is possible to use one of the servers where Crestron Fusion runs, this is not recommended since, depending on load (number of rooms and types of Crestron equipment), this might not be an optimal choice. Also, the routing of calls to the XWS via HTTP is most efficient when carried to the XWS on a separate, remote server or on the XCA server itself.
For the purposes of the sample solution, it is assumed that a .NET Web Service is to run under IIS. If this is not the preferred environment, go to step 5.
-
Edit the sample solution in Visual Studio 2010 or later. Find all references to the PhonyStore class in this project.
-
Code the replacement functions for the identified PhonyStore functions. Note that the ApiHelper project is included to provide a set of basic entity classes, which are used over the REST calls to and from Crestron Fusion, as well as utilities to convert, serialize, and encrypt strings sent between Crestron Fusion and the XWS.
-
Test the XWS using a simple HTTP test harness such as the Advanced Rest Client from the Google Chrome™ browser.
-
Deploy the XWS to the selected host server from step 1. Specify a virtual directory (for example, MyXWS), and establish access via a user ID and password. Ensure that the API Service is enabled for anonymous access.
-
Use the Crestron Fusion Configuration Web Client to access the Scheduling branch in the tree, and select the External Web Service tab.
-
Provide the base URL for the XWS in the External Web Service tab. For example, if the XWS is deployed on MyHost.xyz.com, under a virtual directory of MyXWS, the base URL is http://<MyHost.xyz.com>/<MyXWS>.
-
Provide default credentials for access to the XWS. If access to the XWS is not over a private Local Area Network (LAN), consider applying a security certificate and enter https://<MyHost.xyz.com>/<MyXWS>, as noted in the previous step.
-
Use the Crestron Fusion Setup Web Client to add a test room. Click External from the Scheduling tab drop-down menu. Enter the proper identifier for the calendar to be assigned to the room. The format of the identifier is entirely dependent on the XCA. Save the room. No further asset or symbol information is required until it has been verified that the XWS is working.
-
Use the appropriate client for the XCA to add an appointment to the calendar assigned to the room.
-
Use the Crestron Fusion Monitoring Web Client to view the room's schedule, and verify that the appointment appears at the correct date and time.
-
Add an appointment from the Crestron Fusion Web Client (if permitted). Then update and delete that appointment, again assuming that the XWS allows this.