Guides you through the process of creating and configuring the
JSONPROV
enterprise server region, and installing and verifying resources.
Start the Server Explorer
The
Server Explorer view is visible by default when using the
Team Developer perspective, and appears as a tab on the same level as the
Application Explorer view. However, if it is not visible:
- In Eclipse, click
, and then click
Open.
Attention: You might encounter an
ESCWA Sign On dialog box as you perform the steps required to create, configure, start, or stop an
enterprise server region from the
Server Explorer. If you do, ensure that the
Server requires credentials,
Use specific server credentials, or
Server is secured
, and the
Store credentials boxes are
unchecked, and then click
OK.
If asked to provide a password, enter your UNIX logon password.
Create an
enterprise server region
Here you use
Enterprise Server to create an
enterprise server region on which to run the Web service.
- On the
Server Explorer, right-click
Local [localhost:10086]; then select
New > Enterprise Server.
- In the
Name field, type
JSONPROV. This is the name for the new
enterprise server region.
- Click the
Browse button that corresponds to the
Template field, and navigate to the
CICSWebServicesTemplate.xml file located in the
ReverseJSON project folder.
- Double-click
CICSWebServicesTemplate.xml. This populates the
Template field.
- On the list next to
Associate with projects, check
ReverseJSON.
- Click
Finish.
The
Server Explorer should now show the
JSONPROV
enterprise server region listed under
Local [localhost:10086].
Note: If
JSONPROV is not showing, expand
Local [localhost:10086].
Configure
JSONPROV resources
All
enterprise server regions require access to certain resources, depending on the types of applications they run. Resources that are defined on a region's
startup list are loaded during the startup routine, making them available for as long as the region is running.
JSON CICS Web services use the underlying resources provided by the standard
Enterprise Server CICS Web interface (CWI) and CICS Web Services (CWS) support. However, the resource definition file supplied with the project
does not include these resources; therefore, you need to add them manually. The CWI resources reside in a predefined resource
group named DFHWEB. The CWS resources are in the predefined DFHPIPE group.
In addition, you need to create and define a resource group,
JSONPROV, to contain the resources required by the
REVERSEJ program.
- Start the
JSONPROV
enterprise server region
-
- In the
Server Explorer, right-click
JSONPROV; then select
Start.
- Start
Enterprise Server Common Web Administration (ESCWA)
-
- Access the CICS resource settings for the server
-
- After
JSONPROV has started, select it from the default
Directory Servers list in ESCWA.
- At the top of the right pane, click
CICS > Resources.
- Create the
JSONPROV resource group
-
- On the
Resources page, click the
Groups node.
- Click
New in the
Groups pane.
- In the
Name field, type
JSONPROV.
- In the
Description field, type
CICS Web Services Provider Resources; then click
Save. This invokes the
JSONPROV page where you can create and define resources for the group.
- Define
JSONPROV resources
- The
REVERSEJ program requires a resource for TCP/IP service, and a resource to support a pipeline.
- On the
JSONPROV page, click
New and then click
TCPIPSv from the drop-down list.
- Complete these fields:
Name
|
JSNTCPIP
|
Description
|
My TCP/IP Service
|
Port
|
5482
|
- Click
Save.
- Click
Back to return to the
JSONPROV page.
- On the
JSONPROV page, click
New and then click
Pipeline from the list.
Important: If the
Pipeline button is not present, check to be sure that you have properly installed the CCSID tables specified in the
Tutorials: CICS Web Services topic.
- Complete these fields:
Name
|
JSONPIPE
|
|
Description
|
My CICS JSON Provider Pipeline
|
|
Response Wait Time
|
Check
System Default
|
This is the number of seconds that an application waits for a response from the service. The default value is 10 seconds
for HTTP and 60 seconds for MQ.
|
Config file
|
$IDE_XML_LOC/JSONConfig.xml
|
The IDE_XML_LOC environment variable in
JSONPROV points to the
xml project folder.1
|
Web Directory
|
$IDE_LOADLIB/
|
The IDE_LOADLIB environment variable points to the
loadlib project folder, which contains the WSBIND file.2
|
1 To see a list of environment variables defined for
JSONPROV, from the list of Directory Servers, click the
(Edit) button that corresponds to the
JSONPROV region. Click the downward arrow next to
Monitor at the top of the page, then click
Environment Variables.
2The IDE_LOADLIB environment variable is set automatically when you start the
enterprise server region from the
Server Explorer in
Eclipse.
|
- Click
Save.
- Click
Back to return to the
JSONPROV page.
- Open the DEMOSTRT startup list
-
- Expand
Startup Lists to see the list of CICS startup lists.
The
JSONPROV region uses the default startup list, named DEMOSTRT.
- Click
DEMOSTRT.
This opens the
DEMOSTRT page in the right pane.
- Add resource groups to the startup list
- CICS Web Services are built on top of the CICS Web Interface (CWI) support, so you need to ensure that all CWS and CWI resources
are available. These reside in the DFHPIPE and DFHWEB resource groups respectively, which are already defined, but not included
in the startup list. In addition, you need to add the new
JSONPROV resource group.
- On the
DEMOSTRT page under
Groups, click
Add.
- On the
Available Groups list, check the
DFHPIPE,
DFHWEB, and
JSONPROV groups.
- Click
Select.
This adds the all groups to the end of the list.
- Cllick
Apply.
Install resources
You can install new and changed resources by stopping and starting the region.
- From the
Server Explorer in
Eclipse, right-click
JSONPROV; then select
Restart. This stops and then starts the
JSONPROV
enterprise server region, automatically installing and loading the newly added resources on the startup list.
Verify Resources
After
JSONPROV is started, you can verify that the resources you have defined are installed and active.
- From the ESCWA UI, click the
JSONPROV server in default list.
- From the
CICS drop-down list in the right pane, select
Resources.
- Set the first field to the right of
RESOURCES to
Active.
- On the resulting list of active resources, click
WebSvc. You should see the
REVERSEJ Web service listed and marked as
INSERVICE.
- On the list, click
Pipeline > JSONPIPE. You should see that the JSONPIPE pipeline is enabled.
- On the list, click
URIMap > £map-ref, where
map-ref is an alphanumeric string generated by
Enterprise Server. You should see the path specified as
/cics/services/json/reverse.
Enterprise Server generates URIMAPs to provide CICS with the information it needs to process requests. The name of each generated URIMAP begins
with a pounds sterling symbol (£).
To run your provider CICS Web service, you send a JSON request to an endpoint URL that routes the request to your
enterprise server region. The endpoint URL contains a URI value. The incoming request reads the installed URIMAPs to identify the map whose
Path value matches the
URI value of the endpoint URL. When the correct URIMAP is identified, CICS uses the data defined in the URIMAP, such as the name
of the
Web Service and its associated
Pipeline, to process the request.
- Close ESCWA.