Ws Prog Guide

Programmer’s Guide JDA® Common WebServices Release 8.0.0.0

JDA Software Group, Inc.

Legal notice Rights to the content of this document

Copyright © 2013 JDA Software Group, Inc. All rights reserved.

Printed in the United States of America.

Reproduction of this document or any portion of it, in any form, without the express written consent of JDA Software Group, Inc. ("JDA") is prohibited.

These materials are protected by the Copyright Act of 1976, as amended, as an unpublished work and the foregoing notice and legend shall not be deemed to constitute publication or an intent to publish thereunder. These materials are proprietary and confidential information of JDA and may be disclosed and used only as authorized in a signed, written agreement controlling such disclosure or use.

The fact that a particular name or logo does not appear on this notice does not constitute a waiver of any intellectual property rights that JDA has established in any of its products, feature or service names, or logos.

Modifications to the contents of this document

JDA reserves the right, at any time and without notice, to change these materials or any of the functions, features, and specifications of any of the software described herein. JDA shall have no warranty obligation with respect to these materials of the software described herein, except as provided in the JDA software license agreement with an authorized licensee.

Rights to the functionality of this document

Described functionality may not be available as part of a customer's maintenance agreement or the JDA Investment Protection Program. New features and products are subject to license fees. JDA warranty and support obligations apply only to the documentation as delivered by JDA, and are void if the documentation is modified or supplemented by anyone other than JDA. This document embodies JDA valuable trade secrets, is confidential to JDA, and must be kept in confidence and returned upon the expiration or termination of your JDA license agreement. You are not permitted to copy, extract, distribute, transfer, or share the contents of this document with anyone except authorized individuals within your organization.

Technical documentation

NOTICE: This design or technical documentation is supplied as a courtesy only and does not form part of the "Documentation" as defined in your JDA license agreement. This design or technical documentation is supplied in the English language only and is supplied "as is" and without warranties. JDA, at its discretion, may choose to offer this document in additional languages, but is under no obligation to do so. JDA undertakes no obligation to update this design or technical documentation.

Patents

This product may be protected by one or more US patents. Please see the JDA Patents website (http://jda.com/JDAPatents).

This product may be protected by one or more of the following non-US patents:

Europe Patent No. 0861474 (E) Taiwan Patent No. 161120 Taiwan Patent No. I222584

Europe Patent No. 0861474 (UK) Taiwan Patent No. 161181 Taiwan Patent No. I222585

German Patent No. 10195871 Taiwan Patent No. 161494 Taiwan Patent No. I222586

German Patent No. 69507020.7 Taiwan Patent No. 163816 Taiwan Patent No. I225208








http://jda.com/JDAPatents�





German Patent No. DE10195968 Taiwan Patent No. 384430 Taiwan Patent No. I242952

Taiwan Patent No. 100569 Taiwan Patent No. 425517 Taiwan Patent No. I251760














Taiwan Patent No. 146038 Taiwan Patent No. 544599 Taiwan Patent No. M377652

Taiwan Patent No. 154327 Taiwan Patent No. 561424 Taiwan Patent No. NI-158220




Taiwan Patent No. 155708 Taiwan Patent No. I221578 Taiwan Patent No. NI-182787

Taiwan Patent No. 157467 Taiwan Patent No. I221978 Taiwan Patent No. NI-182974

Taiwan Patent No. 159609


Table of Contents Chapter 1. Documentation information ............................................................................ 1

Help information ........................................................................................................ 1 Installation/administration information.......................................................................... 1 Database information ................................................................................................. 1 Release Notes ........................................................................................................... 1 Get additional help from JDA ....................................................................................... 2

Chapter 2. Introduction to JDA Common WebServices .................................................... 4

Using Sample programs .............................................................................................. 4

Chapter 3. JDA Common WebServices interface .............................................................. 5

Calendar Services ...................................................................................................... 5 TVQ Services ............................................................................................................ 5 Understand input and output parameters ...................................................................... 5 Write a sample client program ..................................................................................... 6 Sample programs ...................................................................................................... 6

Sample Code: Obtaining all Calendar Names ......................................................... 6 Sample Code: Function to obtain TVQ values ........................................................ 9

Index ............................................................................................................................. 12

Documentation information

Common WebServices Programmer’s Guide 1 © 2013 JDA Software Group, Inc.- Confidential

Chapter 1. Documentation information Four different types of documentation are included with this application:

Help information Supply Chain Planning and Optimization (SCPO) applications contain online HTML help that guides you through the user interface. Each page has its own context-sensitive help topic that describes the purpose of each component of the page. In addition, user information is included to describe high-level processes and procedures, as well as provide step-by-step instructions for completing a task. You can access OnLine Expert for a particular page by clicking the Help link at the top of the page.

The SCPO suite of applications includes some components and utilities that are used by multiple applications as well as components that are specific to a single application. When using SCPO applications, you must be aware of your location in the system as it determines the Help text to which you have access. For example, if you are working in a Flexible Editor page, which is part of the basic SCPO architecture, and you click the Help link, you can access general Help information for common SCPO components. In this Help, you can find information about common features, such as Flexible Editor, calendar management, and import/export. This help also contains definitions for each database table. However, it does not provide information about specific JDA Demand or JDA Fulfillment features, such as forecasting, planning, distribution, or allocation.

To access information about application-specific features, you must access the Help for that application. To do so, open the appropriate page in the application. If you are unsure of the page to use, open any application-specific page, such as Plan Analysis for JDA Fulfillment or Demand Workbench for JDA Demand, and click the Help link on that page. The context-sensitive help topic for the page you are on is displayed in the right frame and the table of contents for the entire application help system is displayed in the left frame. You can then use the table of contents, search, or index to find the application-specific information.

Installation/administration information The Supply Chain Planning and Optimization Installation/Administration Guide provides information about the architecture of Supply Chain Planning and Optimization, step-by-step instructions to install and configure the server and applications, instructions to create or migrate your database, and information to customize and administer the applications after they are installed.

SCPO guides are available online in Portable Document Format (PDF) format. When you install SCPO, you can access the guides from the <install_dir>\config\doc\guides\en directory, the JDA program group on the Windows Start menu, or from the installed directory structure.

Database information The application Reference Guide contains detailed information about tables and columns in the SCPO schema. These documents are in PDF format and are located in the <install_dir>\config\doc\guides\en directory. In addition, the definitions for the tables used by each JDA application are included in the application OnLine Expert.

Release Notes The Supply Chain Planning and Optimization (SCPO) Release Notes contain information that pertains to all JDA applications included in SCPO. The Release Notes contain the following sections:

• Installing and upgrading: Provides version-specific installation notes for SCPO.

• What’s new: Provides a summary of the new features and enhancements included as part of SCPO.



• Resolved issues: Provides information on resolved issues in this SCPO release.

• Information alerts: Provides alert information/known issues of SCPO and, if necessary, ways to work around them.

In addition, individual product Release Notes are available for each JDA application for which you are licensed. These Release Notes contain application-specific hardware and software requirements, if applicable, and a list of known software issues for the application.

The General SCPO Release Notes is named release_notes_generalSCPO.pdf. File names for individual product Release Notes are in the format release_notes_<appname>.pdf, for example, release_notes_cspa.pdf. You can access Release Notes by opening the appropriate file in the doc\ directory. Readme files are also available from the JDA program group on the Windows Start menu and from the installed directory structure.

Get additional help from JDA In addition to the provided OnLine Expert, technical documentation, and functional documentation, many additional resources are available to help you understand and work with your JDA applications.

• JDA Support Services

JDA Support Services enhances your experience with JDA solutions throughout the lifetime of your relationship with JDA Software. Support Services provides many key values, including:

• Worldwide support provided locally for issue resolution, including functional and technical assistance

• Defined service levels and proactive escalation paths

• Special Interest Group (SIG) membership

• Access to new software releases

• Access to the JDAUser website (http://www.jdauser.com), which provides:

• Self-service user administration

• Online knowledge base

• Online case management and user communities

• Product documentation and release announcements

• JDA Education Services

To enhance the return on your JDA solution investment, JDA Education Services provides options to optimize your experience and knowledge. JDA Education Services offers high-quality training with e-learning and instructor-led training opportunities. JDA Education Services also offers the JDA Certification Program, which defines a curriculum that maximizes your knowledge and qualifications for a specific job. Certification programs employ a blend of learning methods that end with an industry-recognized exam. See the JDALearn website (http://www.jdalearn.com) for more information.

• JDA Consulting Services

JDA Consulting Services provides a broad range of services, including:

• Process definition and improvement

• Change management

• Program and project management

• Functional and technical consulting

• Performance engineering

• Solution delivery

http://www.jdauser.com/�

http://www.jdalearn.com/�



Every solution deployment begins with the JDA Enterprise Methodology, which encompasses both technology and implementation expertise. JDA Consulting Services works collaboratively with you to help your business realize the results you need, on time and on budget.

• JDA Cloud Services

JDA Cloud Services enables you to achieve faster deployment, rapid time to value, investment protection, and improved cost structure with JDA supply chain solutions. This allows you to focus on your core business while JDA manages the JDA applications. Areas of specialty include:

• Solution availability management

• Performance management

• Issue resolution

• Change management

• Security management

• Optimization and analytics management

For more information on any of the JDA Services, see the JDA Services website (http://www.jda.com/services/services/).

http://www.jda.com/services/services/�

Introduction to JDA Common WebServices


Chapter 2. Introduction to JDA Common WebServices JDA WebServices are XML-based self-contained and self-describing application components, which are used to communicate using open protocols.

JDA WebServices has two major advantages.

• Reusable application-components

Some application components are needed very often and can be re-used.

• Connect existing software

JDA WebServices can help you solve the interoperability problem by giving different applications a way to link their data. With JDA WebServices, you can exchange data between different applications and different platforms.

Using Sample programs To make it easier for you to work with JDA WebServices, the Programmer’s Guide includes sample programs:

• Sample Code: Obtaining all Calendar Names (page )10

• Sample Code: Function to obtain TVQ values (page )13

JDA Common WebServices interface


Chapter 3. JDA Common WebServices interface This section provides information about the common WebServices used in JDA.

JDA provides access to certain Time Series Data (TVQ) and Calendar APIs through WebServices. These APIs can be called from any WebServices client, including programs written in Java, .NET.

JDA Common WebServices interface standard normalizes ways in which operation requests and responses handle elements such as bounding boxes, exception processing, URL requests, URN expressions, and key value encoding.

The input and output parameters are described through standard WSDL and XSD files. See the sections below for a detailed description of the APIs and underlying data structures.

Calendar Services 1. Given a Calendar name, Start date, and Duration, the following code returns all the corresponding

Calendar Start dates.

DateListType getCalendarDates(CalendarNameDateAndDuration calDateOptions)

2. Given a Calendar type, the following code returns all the Calendar Names.

StringListType getCalendarNames(CalendarTypeEnumType calType)

3. Given a Calendar name and Start date, the following code returns whether the Calendar is open.

boolean getIsCalendarOpen(CalendarNameAndStartDate calDateOptions)

4. Given a Calendar name and StartDate, the following code returns the Start date of the next open period.

XMLGregorianCalendar getNextCalendarOpen(CalendarNameAndStartDate calDateOptions)

TVQ Services Time Varying Quantities (TVQ) are projections that are available in Fulfillment, Master Planning, and Supply.

1. The following code returns all the TVQ names.

StringListType getTVQNames()

2. The input structure is capable of accepting a calendar (start date, name, and duration), list of TVQ names and a list of SKUs. The following code returns the corresponding TVQ value projections (for the given list of SKUs and dates) in a structure named TVQValuesRetDataType (defined in the .xsd files).

TVQValuesRetDataType getTVQValues(SKUProjectionsInputType skuProjInput)

Understand input and output parameters Standard XSD and WSDL files are used to describe the JDA WebServices. Knowledge of the location of the service enables you to generate the necessary artifacts on the client side to be able to write the accessor programs.

WSDL for either service can be obtained through the following URLs (assuming, JDA SCPO server is running on port 7001)

http://yourHostName:7001/scpocommonws/CalendarServices or http://yourHostName:7001/scpocommonws/TVQServices

Both CalendarServices and TVQServices WSDLs can be clicked.



Click through http://yourHostName:7001/scpocommonws/CalendarServices?wsdl

or http://yourHostName:7001/scpocommonws/TVQServices?wsdl to review the various .xsd files for different data structures that are used in APIs.

Write a sample client program To compile and execute these sample programs, perform the following:

Note: Java is one of the languages that can communicate with a JDA WebServices offering. A client program can be written in .NET also.

1. Generate the classes required for the client program to communicate with the service. The following should be run when the JDA SCPO server is up:

C:\test>mkdir generated

C:\test>C:\bea\jrockit-jdk1.6.0_01\bin\wsimport -d http://yourHostName:7001/scpocommonws/CalendarServices?wsdl

The "wsimport" command is common in later version of JDKs. This downloads all the necessary ".class" files from the server to the c:\test\generated directory. You can verify all the necessary ".class" files under C:\test\generated\com\manu\scpoweb\webservices\common.

2. You are now ready to write your sample program. Consider that a simple test program (UTCalendarServicesTest .java) reads all the Calendar names.

3. Once this is compiled, you can run the test program as follows:

set CLASSPATH=.\generated;C:\release\v75tip\SCPO\weblogic\config\vendor\junit-4.5.jar

java -classpath %CLASSPATH% ut.com.manu.scpoweb.webservices.common.calendar.UTCalendarServicesTest

Sample programs After the sample test program UTCalendarServicesTest .java that reads all the Calendar names is compiled, you can run this as shown previously in step-3.

Sample Code: Obtaining all Calendar Names package ut.com.manu.scpoweb.webservices.common.calendar;

import com.manu.scpoweb.webservices.common.calendar.CalendarServices;

import com.manu.scpoweb.webservices.common.calendar.CalendarServicesFault;

import com.manu.scpoweb.webservices.common.calendar.CalendarServicesPortType;

import com.manu.scpoweb.webservices.common.calendar.param.CalendarTypeEnumType;

import com.manu.scpoweb.webservices.common.param.StringListType;

import junit.framework.Test;

import junit.framework.TestCase;

import junit.framework.TestSuite;

import javax.xml.ws.BindingProvider;

import java.util.List;

public class UTCalendarServicesTest extends TestCase



{

private CalendarServicesPortType port;

public static void main(String[] args)

{

junit.textui.TestRunner.run(suite());

}

public UTCalendarServicesTest(String iName)

{

super(iName);

}

public static Test suite()

{

TestSuite suite = new TestSuite("UTCalendarServicesTest");

suite.addTest(new TestSuite(UTCalendarServicesTest.class));

return suite;

}

public void setUp()

{

try

{

CalendarServices service = new CalendarServices();

port = service.getCalendarServicesPort();

((BindingProvider)port).getRequestContext().put(BindingProvider.USERNAME_PROPERTY, "SuperUser");

((BindingProvider)port).getRequestContext().put(BindingProvider.PASSWORD_PROPERTY, "password");

}

catch(Exception e)

{

System.out.println("Failure, exception thrown during test setup: " + e);

e.printStackTrace();

}

}

public void tearDown()



{

}

// This test case assumes the DB has a DAYS calendar in it.

public void testGetCalendarNames()

{

try

{

CalendarTypeEnumType calType = CalendarTypeEnumType.REPORTING;

StringListType calNames = port.getCalendarNames(calType);

List<String> calNamesList = calNames.getValues();

System.out.println("Number calendar names retrieved is: " + calNamesList.size());

assertTrue(calNamesList.size() > 1);

String daysCal = null;

for (String calName : calNamesList)

{

System.out.println(calName);

if (calName.equals("DAYS"))

{

daysCal = calName;

//break;

}

}

assertTrue(daysCal != null);

}

catch (CalendarServicesFault ex)

{

System.out.println("Failure, exception thrown");

System.out.println("Message: " + ex.getFaultInfo().getMessage());

System.out.println("Error code: " + ex.getFaultInfo().getErrorCode());

System.out.println("Translated message: " + ex.getFaultInfo().getTranslatedMessage());

assertTrue(false);

}

}



}

Sample Code: Function to obtain TVQ values public void testTVQValues()

{

try

{

CalendarNameAndStartDate calNameAndStartDate = new CalendarNameAndStartDate();

calNameAndStartDate.setCalName("DAYS");

GregorianCalendar cal = new GregorianCalendar();

cal.set(2006, 10, 1, 19, 0, 0); // Nov 2, 2006 at midnight GMT

// or we could say -Duser.timezone=GMT and pass in 2006, 10, 0, 0, 0)

cal.set(Calendar.MILLISECOND,0);

XMLGregorianCalendar xmlDate = WSCommonUtil.convertToJAXB(cal.getTime());

calNameAndStartDate.setCalStartDate(xmlDate);

CalendarNameDateAndDuration calDateOptions = new CalendarNameDateAndDuration();

calDateOptions.setNameAndStartDate(calNameAndStartDate);

calDateOptions.setDurInMinutes(60 * 24 * 90); // 90 Day

SKUProjectionsInputType skuProjInput = new SKUProjectionsInputType();

skuProjInput.setCalDateOptions(calDateOptions);

SKUListType skuListType = new SKUListType();

List<SKUType> skuList = skuListType.getValues();

SKUType sku = new SKUType();

sku.setItem("65185");

sku.setLoc("100");

skuList.add(sku);

sku = new SKUType();

sku.setItem("64054");

sku.setLoc("100");

skuList.add(sku);

skuProjInput.setSkuList(skuListType);

StringListType stringListType = new StringListType();

List<String> projNames = stringListType.getValues();

projNames.add("PROJOH");



//projNames.add("CONSTRPROJOH");

skuProjInput.setProjectionNamesList(stringListType);

TVQValuesRetDataType retData = port.getTVQValues(skuProjInput);

System.out.println("Number SKUs retrieved is: " + retData.getValuesList().getValues().size());

assertTrue(retData.getValuesList().getValues().size() == 2);

System.out.println("Number Dates retrieved is: " + retData.getDateList().getValues().size());

assertTrue(retData.getDateList().getValues().size() == 90);

SKUProjectionsType firstSKUProjection = retData.getValuesList().getValues().get(0);

SKUProjectionsType secondSKUProjection = retData.getValuesList().getValues().get(1);

System.out.println("First SKU: " + firstSKUProjection.getSku().getItem() + "@" + firstSKUProjection.getSku().getLoc());

assertTrue("65185@100".equals(firstSKUProjection.getSku().getItem() + "@" + firstSKUProjection.getSku().getLoc()));

System.out.println("Second SKU: " + secondSKUProjection.getSku().getItem() + "@" + secondSKUProjection.getSku().getLoc());

assertTrue("64054@100".equals(secondSKUProjection.getSku().getItem() + "@" + secondSKUProjection.getSku().getLoc()));

ProjectionDataListType firstProjDataListType = firstSKUProjection.getProjList();

System.out.println("Number projections retrieved for the first SKU is: " + firstProjDataListType.getValues().size());

assertTrue(firstProjDataListType.getValues().size() == 1);

ProjectionDataListType secondProjDataListType = secondSKUProjection.getProjList();

System.out.println("Number projections retrieved for the second SKU is: " + secondProjDataListType.getValues().size());

assertTrue(secondProjDataListType.getValues().size() == 1);

QtyProjectionDataType projOH = null;

for (BaseProjectionDataType o : firstProjDataListType.getValues())

{

if (o.getProjName().equalsIgnoreCase("ProjOH"))

{

projOH = (QtyProjectionDataType) o;

break;

}



}

assertTrue(projOH != null);

System.out.println("Num ProjOH intervals for the first SKU is: " + projOH.getValuesList().getValues().size());

assertTrue(projOH.getValuesList().getValues().size() == 90);

Double dblVal = projOH.getValuesList().getValues().get(0);

System.out.println("First ProjOH projection value for the first SKU is: " + dblVal);

//assertEquals(dblVal,360.76,.01);

DurProjectionDataType covDur = null;

for (BaseProjectionDataType o : firstProjDataListType.getValues())

{

if (o.getProjName().equalsIgnoreCase("CovDur"))

{

covDur = (DurProjectionDataType) o;

break;

}

}

}

catch (TVQServicesFault ex)

{

System.out.println("Failure, exception thrown");

System.out.println("Message: " + ex.getFaultInfo().getMessage());

System.out.println("Error code: " + ex.getFaultInfo().getErrorCode());

System.out.println("Translated message: " + ex.getFaultInfo().getTranslatedMessage());

assertTrue(false);

}

}



Index C Calendar Services 5

D Database information 1 Documentation information 1

G Get additional help from JDA 2

H Help information 1

I Installation/administration information 1 Introduction to JDA Common WebServices 4

J JDA Common WebServices interface 5

L Legal notice i

R Release Notes 1

S Sample Code

Function to obtain TVQ values 4, 9 Obtaining all Calendar Names 4, 6

Sample programs 6

T TVQ Services 5

U Understand input and output parameters 5 Using Sample programs 4

W Write a sample client program 6

Ws Prog Guide

Documents

Transcript of Ws Prog Guide