REST

Labels
AJAX(112) App Studio(7) Apple(1) Application Builder(245) Application Factory(207) ASP.NET(95) ASP.NET 3.5(45) ASP.NET Code Generator(72) ASP.NET Membership(28) Azure(18) Barcode(2) Barcodes(3) BLOB(18) Business Rules(1) Business Rules/Logic(140) BYOD(13) Caching(2) Calendar(5) Charts(29) Cloud(14) Cloud On Time(2) Cloud On Time for Windows 7(2) Code Generator(54) Collaboration(11) command line(1) Conflict Detection(1) Content Management System(12) COT Tools for Excel(26) CRUD(1) Custom Actions(1) Data Aquarium Framework(122) Data Sheet(9) Data Sources(22) Database Lookups(50) Deployment(22) Designer(177) Device(1) DotNetNuke(12) EASE(20) Email(6) Features(101) Firebird(1) Form Builder(14) Globalization and Localization(6) How To(1) Hypermedia(2) Inline Editing(1) Installation(5) JavaScript(20) Kiosk(1) Low Code(3) Mac(1) Many-To-Many(4) Maps(6) Master/Detail(36) Microservices(4) Mobile(63) Mode Builder(3) Model Builder(3) MySQL(10) Native Apps(5) News(18) OAuth(9) OAuth Scopes(1) OAuth2(13) Offline(20) Offline Apps(4) Offline Sync(5) Oracle(11) PKCE(2) Postgre SQL(1) PostgreSQL(2) PWA(2) QR codes(2) Rapid Application Development(5) Reading Pane(2) Release Notes(183) Reports(48) REST(29) RESTful(29) RESTful Workshop(15) RFID tags(1) SaaS(7) Security(81) SharePoint(12) SPA(6) SQL Anywhere(3) SQL Server(26) SSO(1) Stored Procedure(4) Teamwork(15) Tips and Tricks(87) Tools for Excel(2) Touch UI(93) Transactions(5) Tutorials(183) Universal Windows Platform(3) User Interface(338) Video Tutorial(37) Web 2.0(100) Web App Generator(101) Web Application Generator(607) Web Form Builder(40) Web.Config(9) Workflow(28)
Archive
Blog
REST
Saturday, November 10, 2012PrintSubscribe
RESTful Client-Side Validation

Data integrity can be ensured on different tiers of a web application. Code On Time web apps take advantage of the business rules engine that allows creating JavaScript Business Rules (Client Tier), Code Business Rules (Application Tier), and SQL Business Rules (Data Tier).

About Business Rules

Business rules are abstracted from the presentation of data. Developers manipulate field values directly as if the field values are local variables. The client library and application framework pass collections of values to the business rules making unnecessary a complex task of inspecting user interface elements. A business rule can access “old” value, “new” value, and “current” value of any field. It is also known if a field is “read-only” or “modified”. Business rules are executed in response to actions that have “before”, “execute”, and “after” phase. Changes to the values of the fields may affect the data that ends up in the database. Calculated field values are presented to the user on the client device.

This approach to business rule implementation allows continues improvement to the user interface client library.  It guarantees that business rules will remain unchanged even for the future supported client devices.

Selecting an Application Tier

The major challenge is to select an application tier for a business rule implementation.

The client tier is most commonly used to correct user spelling or for basic data integrity enforcement. For example, formatting of a phone number most definitely lends itself to a client side business rule. Client business rules allow avoiding a server-side round trip.

If a business rule requires a database lookup then the data tier works best in most situation. A script written in SQL dialect of the application database engine can select data from a table, call a stored procedure, and perform complex data manipulations.

Some business rules may require access to operating system resources, file system, or web services. Application tier business rules are written in C# or Visual Basic. The full power of Microsoft.NET is at disposal of a developer. “Code” business rules supersede SQL business rules at a cost of using special classes when a database access is required.

Hybrid Business Rules

If a server-side data is required for a client-side JavaScript business rule, then the business rule is a hybrid. This type of rules is difficult to implement.

The server-code implemented on the application or data tier cannot have a “conversation” with a user. Conditional execution with a user confirmation can be performed on the client only. The client business rule must have a way to request information from the server before confronting a user with requests for additional information.

RESTFul Application Server

Code On Time web applications may include application server components that enable interaction with clients supporting Representational State Transfer protocol know as REST. When enable, the application server components can respond to HTTP requests for information or commands to execute an action.

The  responses to such HTTP request are encoded in XML or JSON. The latter is a great match to JavaScript Business Rules since a response is essentially a JavaScript object.

Example of a RESTful Business Rule

Consider entering of new products in the Northwind sample.

Entering a new product in 'createForm1' in a web app created with Code OnTime application generator

There is product with the name “Chai” with a different price. The existing product is supplied by another vendor.

A list of products in 'Northwind' web app sample created with Code On Time

There may be a business requirement to warn a user about a potential duplicate.

A business rule written in JavaScript may contact the app to verify if a matching product exists. The URL of a web request may look as follow:

http://demo.codeontime.com/northwind/appservices/Products?ProductName=Chai

or

http://demo.codeontime.com/northwind/appservices/Products?ProductName_Filter_Equals=Chai

Here is the response encoded in XML.

<?xml version="1.0" encoding="utf-8"?>
<Products totalRowCount="1" pageSize="100" pageIndex="0" rowCount="1">
  <items>
    <item ProductName="Chai" SupplierID="1" CategoryID="1" QuantityPerUnit="10 boxes x 20 bags" 
          UnitPrice="$18.00" UnitsInStock="39" UnitsOnOrder="0" ReorderLevel="10" 
          Discontinued="False" ProductID="1" 
          SupplierCompanyName="Exotic Liquids" CategoryCategoryName="Beverages" />
  </items>
</Products>

The business rule can display a warning to a user about a potential duplicate. If a user does not confirm creation of a duplicate product, then a new record is not created.

First, may sure to enable REST requests to the data controller products. Select the data controller in Project Explorer and change it as follows.

Property Value
Representational State Transfer (REST) Configuration

Uri: .
Users: *

This will ensure that only authenticated users can send requests to application server components.

Enter a new JavaScript business rule in Products data controller configured as follows:

Property Value
Type JavaScript
Command Name Insert
Phase Before

Enter this code in the Script property of the rule and click OK button.

var duplicateProduct = null;
$.ajax({
    url: '../appservices/Products?ProductName=' + [ProductName],
    cache: false,
    async: false,
    dataType: 'json',
    success: function (result) {
        if (result.Products.length > 0)
            duplicateProduct = result.Products[0];
    }
});
if (duplicateProduct)
    if (confirm('This product is a duplicate. Continue?') == false) {
        this.preventDefault();
        this.result.focus('ProductName',
            'Product with this name and price of {0} is supplied by "{1}".',
            duplicateProduct.UnitPrice, duplicateProduct.SupplierCompanyName);
    }

This is how the rule will be displayed in Project Explorer.

A 'hybrid' validation business rule in Project Explorer

Click Browse and navigate to Products page. Enter a new product with the name “Chai” and click OK to save the new record.

A standard browser confirmation will be displayed.

JavaScript business rule dispalys a confirmation if a duplicate product is detected

Click Cancel button to prevent creation of the product. The focus will be on Product Name field. The information about the duplicate product will be displayed next to the field.

JavaScript business rule cancels 'Insert' action and displayes duplicate product info next to 'ProductName' field if a user clicks 'Cancel' button in confirmation window.

The script makes a web request to the application server to locate a potential duplicate product. The request is executed synchronously making both user and web browser wait for its completion.

The scripts analyzes the response and displays a confirmation if there is a duplicate product. The supplier name and unit price of the existing product are displayed next to the product name field. A call to the method preventDefault will not allow the Insert action to proceed.

The screenshot displays a JSON response to a request for a product by name as presented in Visual Studio 2012.

JSON response to a request for a product in Debug mode as presented by Visual Studio 2012

Monday, October 8, 2012PrintSubscribe
Extending a Web App with jQuery CRUD

The Product Browser example explains how to create a user control that takes advantage of the application server built in a web app created with Code On Time.  The scope of this example is to demonstrate reading the app data with REST requests with a custom JavaScript. The example also uses jQuery library integrated in the generated web apps.

Most custom user interface extensions will need to update, insert, and delete data.  Create, Read, Update, and Delete operations are also known as CRUD.  A complete example of a standalone Product Catalog Manager is implementing a Cross-Domain CRUD.

If a custom user control is created in a web app, then there is no need for cross-domain AJAX requests. Standard JSON requests can be executed with explicitly defined HTTP methods POST, GET, PUT, and DELETE to indicate the purpose of an AJAX web request.

Enabling Access to Products, Suppliers, and Categories

Three data controllers are required to implement the Product Catalog Manager. The data controllers Products, Categories, and Suppliers must explicitly allow REST requests. The application server will deny any web requests if data controllers are not configured accordingly.

Select Products, Suppliers, and Categories data controllers in Project Designer and enter the following in its Representational State Transfer (REST) Configuration property for each controller:

Property Value
Representation State Transfer (REST) Configuration

Uri: .
Users: *

Creating a User Control

Create a custom user control following instructions from the Product Browser example and replace the markup of a the user control with the example from the Source Code section below.

Browse to the page of a running web app that contains the user control. You will see the following:

A CRUD-enabled Product Catalog Manager implemented as a User Control in a web app created with Code On Time

Note that if you are accessing the page without singing in, then you will see a browser prompt for user name and password. The static link to the list of suppliers will force the application server to issue an identity challenge.

<script type="text/javascript" 
    src="../appservices/Suppliers?_sortExpression=CompanyName&_instance=SupplierData">
</script>

If you do not wish to have a static link to suppliers then dynamically populate SupplierID list following the pattern shown in the implementation of loadCategories method.

loadCategories: function () {
    $.ajax({
        url: this.basePath() + '/Categories?_sortExpression=CategoryName',
        dataType: 'json',
        cache: false,
        success: function (data) {
            $.each(data.Categories, function (index, category) {
                $('<option>').text(category.CategoryName)
                .attr('value', category.CategoryID).appendTo($('#CategoryID'));
            })
        }
    });
}

Try updating, inserting, and deleting data.

A new product is created by issuing an PUT request to the application server of a web app.

A new product has been created by issuing an PUT request to the application server of a web app created with Code On Time

An existing product is deleted by issuing a DELETE request to the application server of a web app.

An existing product is being deleted by issuing a DELETE request to the application server of a web app created with Code On Time

Source Code

The ajax requests are using a relative path to access the application server. Method ProductManager.basePath() return the path.

Notice the use of “json” in the “dataType” parameter of ajax requests. Also the nature of the CRUD operations is explicitly expressed by the “type” of the requests.

<%@ Control AutoEventWireup="true" %>
<!-- this tag is needed to enable jQuery IntelliSense only -->
<script src="../Scripts/_System.js" type="text/javascript"></script>
<!-- the user interface of the control -->
<script type="text/javascript" 
    src="../appservices/Suppliers?_sortExpression=CompanyName&_instance=SupplierData">
</script>
<script type="text/javascript">
var ProductManager = {
    // Returns the url of the application server of a demo web app.
    basePath: function () { return '../appservices'; },
    // Loads the list of categories requested from the app server via ajax request.
    loadCategories: function () {
        $.ajax({
            url: this.basePath() + '/Categories?_sortExpression=CategoryName',
            dataType: 'json',
            cache: false,
            success: function (data) {
                $.each(data.Categories, function (index, category) {
                    $('<option>').text(category.CategoryName)
                    .attr('value', category.CategoryID).appendTo($('#CategoryID'));
                })
            }
        });
    },
    // Populate suppliers from the list retrieved by the second <script> element.
    loadSuppliers: function () {
        $.each(MyCompany.SupplierData.Suppliers, function (index, supplier) {
            $('<option>').text(supplier.CompanyName)
                .attr('value', supplier.SupplierID).appendTo($('#SupplierID'));
        })
    },
    // Shows a list of products in <select> element
    showProductList: function () {
        var query = '?_sortExpression=ProductName&_q=' + encodeURIComponent($('#QuickFind').val());
        $.ajax({
            url: this.basePath() + '/Products' + query,
            cache: false,
            dataType: 'json',
            success: function (data) {
                var selectedValue = $('#ProductList').val();
                $('#ProductList option').remove();
                $.each(data.Products, function (index, product) {
                    $('<option>')
                        .text(product.ProductName + ' / ' + product.CategoryCategoryName)
                        .attr('value', product.ProductID).appendTo($('#ProductList'));
                });
                $('#ProductList').val(selectedValue);
                $('#ProductListPanel').show();
            }
        });
    },
    // Shows a form with product details,
    showProductDetails: function (productId) {
        if (productId == null) return;
        $('#ProductSearchPanel').hide();
        $('#DeleteButton').show();
        $.ajax({
            url: this.basePath() + '/Products/editForm1/' + productId,
            cache: false,
            dataType: 'json',
            success: function (product) {
                $('#ProductDetailsPanel').show();
                $('#ProductID').attr('value', product.ProductID);
                $('#ProductName').attr('value', product.ProductName).focus();
                $('#SupplierID').attr('value', product.SupplierID);
                $('#CategoryID').attr('value', product.CategoryID);
                $('#QuantityPerUnit').attr('value', product.QuantityPerUnit);
                $('#UnitPrice').attr('value', product.UnitPrice);
            }
        });
    },
    // Returns back to the search mode.
    backToSearch: function () {
        $('#ProductDetailsPanel').hide();
        $('#ProductSearchPanel').show();
        $('#ProductList').focus();
    },
    // Refreshes the search result.
    refreshSearch: function () {
        this.backToSearch();
        this.showProductList();
    },
    // Formats a URI of a product
    createProductUrl: function (requestType) {
        if (requestType == 'POST')
            return this.basePath() + '/Products/createForm1';
        return this.basePath() + '/Products/editForm1/' + encodeURIComponent($('#ProductID').val());
    },
    // Creates an object with the properties retrievd from the input fields 
    // of the "ProductDetails" form.
    collectFieldValues: function () {
        return {
            ProductID: $('#ProductID').val(),
            ProductName: $('#ProductName').val(),
            SupplierID: $('#SupplierID').val(),
            CategoryID: $('#CategoryID').val(),
            QuantityPerUnit: $('#QuantityPerUnit').val(),
            UnitPrice: $('#UnitPrice').val()
        };
    },
    // Deletes a products.
    deleteProduct: function () {
        if (!confirm('Delete?')) return;
        $.ajax({
            url: this.createProductUrl('DELETE'),
            dataType: 'json',
            type: 'DELETE',
            data: ProductManager.collectFieldValues(),
            success: function (result) {
                if (result.errors)
                    alert(result.errors[0].message);
                else
                    ProductManager.refreshSearch();
            }
        });
    },
    // Shows the product form with blank values.
    newProduct: function () {
        $('#ProductSearchPanel').hide();
        $('#DeleteButton').hide();
        $('#ProductDetailsPanel').show();
        $('#ProductID').attr('value', null);
        $('#ProductName').attr('value', 'New Product').focus().select();
        $('#SupplierID').attr('value', null);
        $('#CategoryID').attr('value', null);
        $('#QuantityPerUnit').attr('value', null);
        $('#UnitPrice').attr('value', null);
    },
    // Saves a product. If there is no value in the #ProductID hidden field then
    // a new product is created by "POST" request. Otherwise an existing product
    // is updated with "PUT" request.
    saveProduct: function () {
        if (!confirm('Save?')) return
        var requestType = $('#ProductID').val() != '' ? 'PUT' : 'POST';
        $.ajax({
            url: this.createProductUrl(requestType),
            dataType: 'json',
            type: requestType,
            data: ProductManager.collectFieldValues(),
            success: function (result) {
                if (result.errors)
                    alert(result.errors[0].message);
                else {
                    if (requestType == 'POST')
                        alert('ID of the new product is ' + result.ProductID);
                    ProductManager.refreshSearch();
                }
            }
        });
    },
};
$(document).ready(function () {
    // pre-populate the drop down lists of categories and suppliers
    ProductManager.loadCategories();
    ProductManager.loadSuppliers();
    // attach event handlers to buttons
    $('#ProductListPanel,#ProductDetailsPanel').hide();
    $('#FindButton').click(function (e) {
        e.preventDefault();
        ProductManager.showProductList();
    });
    $('#ShowDetailsButton').click(function (e) {
        e.preventDefault();
        ProductManager.showProductDetails($('#ProductList').val());
    });
    $('#BackToSearchButton').click(function (e) {
        e.preventDefault();
        ProductManager.backToSearch();
    });
    $('#NewButton').click(function (e) {
        e.preventDefault();
        ProductManager.newProduct();
    });
    $('#SaveButton').click(function (e) {
        e.preventDefault();
        ProductManager.saveProduct();
    });
    $('#DeleteButton').click(function (e) {
        e.preventDefault();
        ProductManager.deleteProduct();
    });
    $('#QuickFind').focus();
});
</script>
<style type="text/css">
    body, button, input, select
    {
        font-family: Tahoma;
        font-size: 8.5pt;
    }
   
    #QuickFind
    {
        width: 280px;
    }
    
    #ProductList
    {
        width: 350px;
        height: 208px;
        margin-bottom: 4px;
    }
    
    #FindButton
    {
        width: 60px;
    }
    
    #ProductListPanel
    {
        margin-top: 4px;
    }
    
    .Field
    {
        padding-bottom: 4px;
    }
    
    #ProductDetailsPanel
    {
        margin-top: 4px;
        padding: 8px;
        border: solid 1px silver;
        display: inline-block;
    }
    
    .Field label
    {
        display: block;
        color: green;
    }
    
    .Field input
    {
        width: 300px;
    }
</style>
<div>
    <div id="ProductSearchPanel">
        <input id="QuickFind" type="text" />
        <button id="FindButton">
            Find</button>
        <div id="ProductListPanel">
            <select id="ProductList" size="5">
            </select>
            <div>
                <button id="ShowDetailsButton">
                    Show Details</button>
                <button id="NewButton">
                    New Product</button>
            </div>
        </div>
    </div>
    <div id="ProductDetailsPanel">
        <input id="ProductID" type="hidden" />
        <div class="Field">
            <label for="ProductName">
                Product Name:</label>
            <input id="ProductName" />
        </div>
        <div class="Field">
            <label for="SupplierID">
                Supplier Company Name:</label>
            <select id="SupplierID">
            </select>
        </div>
        <div class="Field">
            <label for="CategoryID">
                Category Name:</label>
            <select id="CategoryID">
            </select>
        </div>
        <div class="Field">
            <label for="QuantityPerUnit">
                Quantity Per Unit:</label>
            <input id="QuantityPerUnit" />
        </div>
        <div class="Field">
            <label for="UnitPrice">
                Unit Price:</label>
            <input id="UnitPrice" />
        </div>
        <div>
            <button id="BackToSearchButton">
                Back To Search</button>
            <button id="SaveButton">
                Save</button>
            <button id="DeleteButton">
                Delete</button>
        </div>
    </div>
</div>
Friday, October 5, 2012PrintSubscribe
Cross-Domain CRUD jQuery Client of a Web App

A built-in application server of a web app created with Code On Time supports standard create, read, update, and delete (CRUD) operations. A client application must specify a REST URI of an object in a web request. The method of an HTTP  request indicates, which CRUD operation is desired. 

HTTP Method Operation description
GET Read data from the web app.
POST Insert a new data object in the web app database if a URI specifies a data controller name.
Execute a data controller action if a URI also specifies an action group ID and action ID.
PUT Update a data object identified by a URI.
DELETE Delete a data object identified by a URI.

A cross-domain client of a web app makes requests to the application server by using only the “GET” HTTP method. Any other types of request will be blocked by web browsers.

Both jQuery library and application server support JSONP protocol. The application server of a web app will consider the “_type” parameter in a URI as a replacement for the HTTP method type. For example, the uniform resource identifier ~/appservices/Customers/BONAP?_type=DELETE will instruct the built-in application server of a web app to delete a customer with ID of BONAP.

Product Catalog Manager Cross-Domain Sample

Let’s build a simple HTML form enhanced with jQuery capable of managing a catalog of products. The catalog manager will take advantage of the application server built in the demo web app at http://demo.codeontime.com/northwind. Here is how the Product Catalog Manager page will look if opened in Design mode in Visual Studio 2012.

Product Catalog Manager in Design mode in Visual Studio 2012

The top portion of the form is occupied by select element that will display products. Button Find will initiate a search.

The bottom of the form is a panel with several properties of a product. The panel becomes visible when a user clicks on Show Details or New Product buttons. Users can return back to the search mode if they choose Back to Search or when the product is saved or deleted.

Read

This is how the page is rendered when a user opens Product Catalog Manager in a web browser. Only the search controls are visible. The panel with product properties is hidden.

The initial state of a cross-domain Product Catalog Manager

If a user enters a search criteria and clicks Find button then the matched products are displayed in the list box.

Product Catalog Manager makes a cross domain request to the application server built-in the web app created with Code OnTime

This is the implementation of the JavaScript method invoked when Find button is clicked.

showProductList: function () {
    var query = '?_sortExpression=ProductName&_q=' + encodeURIComponent($('#QuickFind').val());
    $.ajax({
        url: this.basePath() + '/Products' + query,
        cache: false,
        dataType: 'jsonp',
        success: function (data) {
            var selectedValue = $('#ProductList').val();
            $('#ProductList option').remove();
            $.each(data.Products, function (index, product) {
                $('<option>')
                    .text(product.ProductName + ' / ' + product.CategoryCategoryName)
                    .attr('value', product.ProductID).appendTo($('#ProductList'));
            });
            $('#ProductList').val(selectedValue);
            $('#ProductListPanel').show();
        }
    });
}

The method encodes the value of the text in the input box and adds it to the URL that ends up looking as follows.

http://demo.codeontime.com/northwind/appservices/Products/?_sortExpresson=ProductName&_q=40%20biscuit 

Click on the link to see an XML representation of the response. The actual response returned to the app contains a JSON-encoded data.

Create

If a product does not exist in the database than a user can click on New Product button to create a product.

Activating 'New Product' form in Product Catalog Manager

A panel with blank product properties will be displayed. The value of the hidden field ProductID is set to a null value.

newProduct: function () {
    $('#ProductSearchPanel').hide();
    $('#DeleteButton').hide();
    $('#ProductDetailsPanel').show();
    $('#ProductID').attr('value', null);
    $('#ProductName').attr('value', 'New Product').focus().select();
    $('#SupplierID').attr('value', null);
    $('#CategoryID').attr('value', null);
    $('#QuantityPerUnit').attr('value', null);
    $('#UnitPrice').attr('value', null);
}

If a user enters values and presses Save then an AJAX request will be sent to the web app with a URI configured to save a product.

Button 'Save' will make a cross-domain AJAX request to the application server of the web app created with Code On Time

The user will see a confirmation box displaying a new product ID if the operation was successful.

A confirmation with a product ID is displayed if a request to the application server of the web app has created a new product

The code behind the Save button is presented next.

saveProduct: function () {
    if (!confirm('Save?')) return
    var requestType = $('#ProductID').val() != '' ? 'PUT' : 'POST';
    $.ajax({
        url: this.createProductUrl(requestType),
        dataType: 'jsonp',
        type: requestType,
        data: ProductManager.collectFieldValues(),
        success: function (result) {
            if (result.errors)
                alert(result.errors[0].message);
            else {
                if (this.url.match('_type=POST'))
                    alert('ID of the new product is ' + result.ProductID);
                ProductManager.refreshSearch();
            }
        }
    });
}

If the product ID is blank then the parameter “_type” is equal to POST, which instructs the application server to create a new product.

Update

If a user selects a product in the list and clicks Show Details button then the product details are displayed.

Selecting a product for update in a cross-domain client of a web app created with Code On Time

The button will initiate a web request to obtain a product information.

showProductDetails: function (productId) {
    if (productId == null) return;
    $('#ProductSearchPanel').hide();
    $('#DeleteButton').show();
    $.ajax({
        url: this.basePath() + '/Products/editForm1/' + productId,
        cache: false,
        dataType: 'jsonp',
        success: function (product) {
            $('#ProductDetailsPanel').show();
            $('#ProductID').attr('value', product.ProductID);
            $('#ProductName').attr('value', product.ProductName).focus();
            $('#SupplierID').attr('value', product.SupplierID);
            $('#CategoryID').attr('value', product.CategoryID);
            $('#QuantityPerUnit').attr('value', product.QuantityPerUnit);
            $('#UnitPrice').attr('value', product.UnitPrice);
        }
    });
}

The following link shows the URL constructed by the Product Catalog Manager.

http://demo.codeontime.com/northwind/appservices/Products/editForm1/23

Click on the link to see an XML representation of the response.

The success method will initialize and display the product properties.

Saving product properties in a cross-domain client of a web app created with Code On Time

If a user changes properties and clicks Save then a confirmation is displayed.

A confirmation to save product information

Method ProductManager.saveProduct will execute with “_type” parameter set to PUT.

Delete

The “Delete” button is rendered next to “Save” on the product details panel.

User has to click Find and select a product to activate the panel.

Selecting a product to delete

If the product deletion is confirmed then an AJAX request will be executed.

A confirmation to delete a product

Product Catalog Manager will delete the selected product with the following code.

deleteProduct: function () {
    if (!confirm('Delete?')) return;
    $.ajax({
        url: this.createProductUrl('DELETE'),
        dataType: 'jsonp',
        type: 'DELETE',
        data: ProductManager.collectFieldValues(),
        success: function (result) {
            if (result.errors)
                alert(result.errors[0].message);
            else
                ProductManager.refreshSearch();
        }
    });
}

The code will execute a JSONP request with DELETE specified in the product URI as a value of parameter “_type”.

Source Code

The complete source code of Product Catalog Manager is presented next.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>Cross-Domain Catalog Manager</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.1/jquery.min.js" type="text/javascript"></script>
    <script type="text/javascript"
        src="http://demo.codeontime.com/northwind/appservices/Suppliers?_sortExpression=CompanyName&_instance=SupplierData">
    </script>
    <script type="text/javascript">
        var ProductManager = {
            // Returns the url of the application server of a demo web app.
            basePath: function () { return 'http://demo.codeontime.com/northwind/appservices'; },
            // Loads the list of categories requested from the app server via ajax request.
            loadCategories: function () {
                $.ajax({
                    url: this.basePath() + '/Categories?_sortExpression=CategoryName',
                    dataType: 'jsonp',
                    cache: false,
                    success: function (data) {
                        $.each(data.Categories, function (index, category) {
                            $('<option>').text(category.CategoryName)
                            .attr('value', category.CategoryID).appendTo($('#CategoryID'));
                        })
                    }
                });
            },
            // Populate suppliers from the list retrieved by the second <script> element.
            loadSuppliers: function () {
                $.each(MyCompany.SupplierData.Suppliers, function (index, supplier) {
                    $('<option>').text(supplier.CompanyName)
                        .attr('value', supplier.SupplierID).appendTo($('#SupplierID'));
                })
            },
            // Shows a list of products in <select> element
            showProductList: function () {
                var query = '?_sortExpression=ProductName&_q=' + encodeURIComponent($('#QuickFind').val());
                $.ajax({
                    url: this.basePath() + '/Products' + query,
                    cache: false,
                    dataType: 'jsonp',
                    success: function (data) {
                        var selectedValue = $('#ProductList').val();
                        $('#ProductList option').remove();
                        $.each(data.Products, function (index, product) {
                            $('<option>')
                                .text(product.ProductName + ' / ' + product.CategoryCategoryName)
                                .attr('value', product.ProductID).appendTo($('#ProductList'));
                        });
                        $('#ProductList').val(selectedValue);
                        $('#ProductListPanel').show();
                    }
                });
            },
            // Shows a form with product details,
            showProductDetails: function (productId) {
                if (productId == null) return;
                $('#ProductSearchPanel').hide();
                $('#DeleteButton').show();
                $.ajax({
                    url: this.basePath() + '/Products/editForm1/' + productId,
                    cache: false,
                    dataType: 'jsonp',
                    success: function (product) {
                        $('#ProductDetailsPanel').show();
                        $('#ProductID').attr('value', product.ProductID);
                        $('#ProductName').attr('value', product.ProductName).focus();
                        $('#SupplierID').attr('value', product.SupplierID);
                        $('#CategoryID').attr('value', product.CategoryID);
                        $('#QuantityPerUnit').attr('value', product.QuantityPerUnit);
                        $('#UnitPrice').attr('value', product.UnitPrice);
                    }
                });
            },
            // Returns back to the search mode.
            backToSearch: function () {
                $('#ProductDetailsPanel').hide();
                $('#ProductSearchPanel').show();
                $('#ProductList').focus();
            },
            // Refreshes the search result.
            refreshSearch: function () {
                this.backToSearch();
                this.showProductList();
            },
            // Formats a "jsonp" URL to POST (insert), PUT (update), or DELETE (delete) a product.
            // The request type is encoded in "_type" argument since JSONP supports only HTTP GET.
            createProductUrl: function (requestType) {
                if (requestType == 'POST')
                    return this.basePath() + '/Products/createForm1?_type=' + requestType;
                return this.basePath() + '/Products/editForm1/' + encodeURIComponent($('#ProductID').val()) +
                    '?_type=' + requestType;
            },
            // Creates an object with the properties retrieved from the input fields 
            // of the "ProductDetails" form.
            collectFieldValues: function () {
                return {
                    ProductID: $('#ProductID').val(),
                    ProductName: $('#ProductName').val(),
                    SupplierID: $('#SupplierID').val(),
                    CategoryID: $('#CategoryID').val(),
                    QuantityPerUnit: $('#QuantityPerUnit').val(),
                    UnitPrice: $('#UnitPrice').val()
                };
            },
            // Deletes a products.
            deleteProduct: function () {
                if (!confirm('Delete?')) return;
                $.ajax({
                    url: this.createProductUrl('DELETE'),
                    dataType: 'jsonp',
                    type: 'DELETE',
                    data: ProductManager.collectFieldValues(),
                    success: function (result) {
                        if (result.errors)
                            alert(result.errors[0].message);
                        else
                            ProductManager.refreshSearch();
                    }
                });
            },
            // Shows the product form with blank values.
            newProduct: function () {
                $('#ProductSearchPanel').hide();
                $('#DeleteButton').hide();
                $('#ProductDetailsPanel').show();
                $('#ProductID').attr('value', null);
                $('#ProductName').attr('value', 'New Product').focus().select();
                $('#SupplierID').attr('value', null);
                $('#CategoryID').attr('value', null);
                $('#QuantityPerUnit').attr('value', null);
                $('#UnitPrice').attr('value', null);
            },
            // Saves a product. If there is no value in the #ProductID hidden field then
            // a new product is created by "POST" request. Otherwise an existing product
            // is updated with "PUT" request.
            saveProduct: function () {
                if (!confirm('Save?')) return
                var requestType = $('#ProductID').val() != '' ? 'PUT' : 'POST';
                $.ajax({
                    url: this.createProductUrl(requestType),
                    dataType: 'jsonp',
                    type: requestType,
                    data: ProductManager.collectFieldValues(),
                    success: function (result) {
                        if (result.errors)
                            alert(result.errors[0].message);
                        else {
                            if (this.url.match('_type=POST'))
                                alert('ID of the new product is ' + result.ProductID);
                            ProductManager.refreshSearch();
                        }
                    }
                });
            },
        };
        $(document).ready(function () {
            // pre-populate the drop down lists of categories and suppliers
            ProductManager.loadCategories();
            ProductManager.loadSuppliers();
            // attach event handlers to buttons
            $('#ProductListPanel,#ProductDetailsPanel').hide();
            $('#FindButton').click(function (e) {
                e.preventDefault();
                ProductManager.showProductList();
            });
            $('#ShowDetailsButton').click(function (e) {
                e.preventDefault();
                ProductManager.showProductDetails($('#ProductList').val());
            });
            $('#BackToSearchButton').click(function (e) {
                e.preventDefault();
                ProductManager.backToSearch();
            });
            $('#NewButton').click(function (e) {
                e.preventDefault();
                ProductManager.newProduct();
            });
            $('#SaveButton').click(function (e) {
                e.preventDefault();
                ProductManager.saveProduct();
            });
            $('#DeleteButton').click(function (e) {
                e.preventDefault();
                ProductManager.deleteProduct();
            });
            $('#QuickFind').focus();
        });
    </script>
    <style type="text/css">
        body, button, input, select
        {
            font-family: Tahoma;
            font-size: 8.5pt;
        }

        #QuickFind
        {
            width: 280px;
        }

        #ProductList
        {
            width: 350px;
            height: 208px;
            margin-bottom: 4px;
        }

        #FindButton
        {
            width: 60px;
        }

        #ProductListPanel
        {
            margin-top: 4px;
        }

        .Field
        {
            padding-bottom: 4px;
        }

        #ProductDetailsPanel
        {
            margin-top: 4px;
            padding: 8px;
            border: solid 1px silver;
            display: inline-block;
        }

        .Field label
        {
            display: block;
            color: green;
        }

        .Field input
        {
            width: 300px;
        }
    </style>
</head>
<body>
    <div>
        <div id="ProductSearchPanel">
            <input id="QuickFind" type="text" />
            <button id="FindButton">
                Find</button>
            <div id="ProductListPanel">
                <select id="ProductList" size="5">
                </select>
                <div>
                    <button id="ShowDetailsButton">
                        Show Details</button>
                    <button id="NewButton">
                        New Product</button>
                </div>
            </div>
        </div>
        <div id="ProductDetailsPanel">
            <input id="ProductID" type="hidden" />
            <div class="Field">
                <label for="ProductName">
                    Product Name:</label>
                <input id="ProductName" />
            </div>
            <div class="Field">
                <label for="SupplierID">
                    Supplier Company Name:</label>
                <select id="SupplierID">
                </select>
            </div>
            <div class="Field">
                <label for="CategoryID">
                    Category Name:</label>
                <select id="CategoryID">
                </select>
            </div>
            <div class="Field">
                <label for="QuantityPerUnit">
                    Quantity Per Unit:</label>
                <input id="QuantityPerUnit" />
            </div>
            <div class="Field">
                <label for="UnitPrice">
                    Unit Price:</label>
                <input id="UnitPrice" />
            </div>
            <div>
                <button id="BackToSearchButton">
                    Back To Search</button>
                <button id="SaveButton">
                    Save</button>
                <button id="DeleteButton">
                    Delete</button>
            </div>
        </div>
    </div>
</body>
</html>