Operations Guide

10.2
- 10.5 HotFix 2
- 10.5 HotFix 1
- 10.5
- 10.2 HotFix 1
- 10.1 HotFix 1
- 10.1
- 10.0 HotFix 1
- 10.0

Back Next

NSA-Batch Service

This is a web based Service which provides the ability to add records to the NSA Transaction table. The service is implemented by the Synchronization Server, as part of the

ssasrsv

executable image.

Enabling the NSA-Batch Service

In order for the NSA-Batch Service to be available the Synchronization Server must be running. In addition, the NSA-Batch Service must be configured

The Synchronization Server is enabled by allocating the server’s host name (

SSA_XSHOST

) and port number (

SSA_XSPORT

) in the

env\mdmres.bat

(Windows) or

env/mdmres

(UNIX).The default port number of the Synchronization Server is

1671

Configuring

The configuration process consists of creating a simple text file named either

xsserv.ini

xsserv.xml

. The two different extensions represent two different formats that the configuration file can take; an INI file form and an XML form.

The file can be located in

$SSAINI

$HOME

$SSABIN

, which the server searches in that order.

The content of this file determines which searches and Rulebases are visible to the client. It is read at server initialization, so changes to the configuration become effective only after the XML Search Server is bounced.

The

xsserv.ini

form has the same format as the

htserv.ini

file used by the HTTP Search Server. Refer to the HTTP Search Client
section of the

OPERATIONS Guide

for instructions on how to use this format.

Since this is a Web Service, the XML format is recommended.

Generic Mode

The simplest possible file contains the following lines:

<?xml version="1.0" encoding="UTF-8"?>
<server xmlns="http://www.identitysystems.com/xmlschema/iss-version-8/xsserv">
<mode>generic</mode>
<rulebase>ids:rb</rulebase>
</server>

This simple

xsserv.xml

will make all searches in the

Rulebase ids:rb

available.

Unlike the HTTP Search Server, a Rulebase must be supplied to the XML Search server.

Rulebase names are sent from the client to the server in the clear using the HTTP protocol. To avoid passing database passwords, it is strongly recommended that

xsserv.xml

files should specify Dictionary Alias names.

Custom Mode

Custom mode is use to configure the Systems, Searches and Rulebases visible to the Web clients. A custom

xsserv.xml

file will look something like this:

<?xml version="1.0" encoding="UTF-8"?>
<server xmlns="http://www.identitysystems.com/xmlschema/iss-version-1/xsserv">
<mode>custom</mode>
<profile name="search profile">
<rule name="search rule">
<rulebase>ids:rb</rulebase>
<system>ssa001</system>
<search name="search name">
<sdf_search>name-search</sdf_search>
</search>
</rule>
</profile>
</server>

The example defines one profile but multiple profiles can be defined. Each may contain one or more rules. In this case, there is just one rule. Each rule must have a corresponding definition that nominates the Rulebase name, System name and any number of Searches (

name-search

in this example) that can be used by a client.

WSDL file

A WSDL file is created in the server work directory for each system defined in the

xsserv.xml

file when the server starts or is refreshed.

The WSDL can also be accessed through the server at:

http://<xshost>:<xsport>/?<system>sync.wsdl

For example, the sample system would be found at:

http://localhost:1670/?ssa001sync.wsdl

Re-generating the WSDL file

The WSDL file can be regenerated by issuing a flush command to the server. The server will re-read the

xsserv.xml

file and re-create the WSDL file.

On Unix this would be done by:

$SSABIN/ssashut -h$SSA_XSHOST -f

Or on Windows:

%SSABIN%\ssashut -h%SSA_XSHOST% -f

Using the NSA-Batch Service

The NSA-Batch Service accepts an XML file containing a set of IDT records to be synchronized.

Rename Saved Search

Table of Contents

Operations Guide

Operations Guide

NSA-Batch Service

NSA-Batch Service

Enabling the NSA-Batch Service

Configuring

Generic Mode

Custom Mode

WSDL file

Re-generating the WSDL file

Using the NSA-Batch Service