WebService Providers

The WebService Providers page stores the information needed to implement the interfaces for all your Web service providers. Web service providers are currently used when using RQA or IRI. For example, for the RQA Interface, the Web service provider record links the Enclosure definition to the Web service.

To access the WebService Providers page:

In Administration, select System Setup > WebService Providers.

Adding a Webservice Provider

Click the New Provider button. The New Category Code dialog displays.
In the ID field, type the name of the code.
Click Ok. The Provider page will display the new provider name.
In the Description field, type a brief description of what the Webservice provider will do in the system.
In the WebService ID field, select the ID to save to the System Config Map table.
In the Text box, type (or copy and paste) the Arguments_doc text. This is the text for the XML document for the argument which is passed to the Web service call. This document contains the different argument values needed for the call. These values vary based on the implementation you are trying to create. Refer below to the Arguments Document for the RQA and IRI Interfaces.
Click the Save button.

CashStar Arguments Document

This is the text for the XML document for the argument which is passed to the CashStar Web service call. This document contains the different argument values needed for the call. These values vary based on the implementation you are trying to create. When setting up your CashStar Web service you should have a default arguments document, which uses the defaults set in the Configuration and by CashStar.

The following is an example of what you need to include in the XML document:

XML

<?xml version="1.0"?>
  <cashstarargumentslist>
    <cashstararguments from="Customer Care" faceplate_code="" challenge_description="" merchant_code=""/>
  </cashstarargumentslist>

Additional Web service providers can be defined with their own variation of this arguments document. You only insert values if you want to override the default values set in the Configuration and by CashStar. For example, insert a value for entering a specific faceplate_code, or if you have multiple brands, for creating a Web service provider for each brand with its own unique arguments document.

RQA Arguments Document

This is the text for the XML document for the argument which is passed to the RQA Web service call. This document contains the different argument values needed for the call. These values vary based on the implementation you are trying to create.

The arguments document can contain standard paragraph inserts to resolve the value for the attributes at run time.

When accessing RQA you may receive an error message due to a missing element in the RQA DATASET that is sent. The DATASET file located in the Emplifi Agent XML folder, RQASerializedDataSet.xml, can be updated to include any missing elements. For assistance in determining the cause of the error and updating this file if necessary, contact Emplifi Support via the Customer Center or directly at 614-508-6150.

The following is an example of what you need to include in the XML document:

XML

<rqaargumentslist>
  <rqaarguments
    BillToID="2634"
    RequestedBy="[case.b01_code]"
    NatureOfComplaint="1"
    ConsumerShipToMethodID="34"
    ConsumerPickup="1"
    ConsumerPack="0"
    StorePickup="0"
    StoreCheck="0"
    SealedSamples="0"
  ReplacementProduct="0"/>

IRI Arguments Document

This is the text for the XML document for the argument which is passed to the IRI Web service call. This document contains the different argument values needed for the call. These values vary based on the implementation you are trying to create. The following is an example of what you need to include in the XML document:

XML

<?xml version="1.0"?>
  <IRIArgumentList>
    <IRIArgument
      productfamilyid="[issue.c03_code]"
      producttype="upc"
      productid="[issue.c15_code.description1]"
      zip="[issue.c11_code]"/>
    <ResponseFormat Name="CaseText">
      <CaseText Type="Create" text_type_code="Email"/>
    </ResponseFormat>
  </IRIArgumentList>

The Response Format element of the Arguments doc is used to let the system know that a new Case Text is to be added (Type = “Create”) and what the text type code is going to be (in the example, it is “email”).

The following are the available IRI attributes that can be used in the Arguments document:

Parameter	Required	Description	Default
productfamilyid	Y	Brand Site ID provided by IRI (Can also be determined from Admin Site)	None
producttype	Y	To search for a single UPC use “upc” To search for a product group use “agg”	agg
productid	Y	Product UPC or Product Group Name	None
zip	Y	Numeric USA postal code	None
searchradius	N	The search radius in miles to search for stores from the center of the zip code supplied	10 Miles
stores	N	Search for Stores Defaults to yes-1	1
storespagenum	N	Number of results to display per page.	1
storesperpage	N	Number of stores to display per page.	10 (The max implemented in Emplifi Agent is 50)

The value for the attributes listed above can be hard-coded (for example, producttype = “upc”) or the system administrator can use the “standard paragraph” insert short-hand - [tablename.column.column_join plus folder level].

For example:

Productid = [issue.c15_code.description1] would get the value from the c15's code description1
Productid = [issue.c08_code.description2-2] would the value from the c08's code description2 folder level 2