Page Comparison

...

	Description
URI	http://host_name/uc/resources/sapconnection
HTTP Method	POST
Description	Creates an SAP Connection.
Example URI	http://localhost:8080/uc/resources/sapconnection
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Create an SAP Connection: Example Request, below.
Example Response	Status 200 /OK Successfully created the SAP Connection with sysId {sysId}. Status 400 /Bad Request Create SAP Connection failed. A duplicate value has been detected. Name must be unique.
SAP Connection Properties	See SAP Connection Properties 12779556, below.

Anchor
Create an SAP Connection Example Request
Create an SAP Connection Example Request
Create an SAP Connection: Example Request

XML Request

JSON Request

Expand

title	XML Request

<sapConnection retainSysIds="true">
    <description>description</description>
    <name>SAP Connection 1</name>
    <opswiseGroups />
    <sapAshost />
    <sapClient />
    <sapConnectionType>Load Balancing</sapConnectionType>
    <sapGroup>groupa</sapGroup>
    <sapGwhost>ABC</sapGwhost>
    <sapGwserv>test</sapGwserv>
    <sapMshost>server</sapMshost>
    <sapMysapsso2>>D:\ellen\qa\uc\testdir\new.data</sapMysapsso2>
    <sapR3name>777</sapR3name>
    <sapSaprouter>/H/192.168.30.17/S/3297/H/155.56.59.11</sapSaprouter>
    <sapSncLib>/qa/durability_export</sapSncLib>
    <sapSncMode>Off </sapSncMode>
    <sapSncMyname>my_test_name</sapSncMyname>
    <sapSncPartnername>partnername</sapSncPartnername>
    <sapSncQop>Integrity Protection</sapSncQop>
    <sapSncSso>No</sapSncSso>
    <sapSysnr />
    <sapUseSymbolicNames>Yes</sapUseSymbolicNames>
    <sapX509cert>D:\ellen\qa\uc\testdir\ecu.txt</sapX509cert>
    <sysId>1c6a3b42f2704ae8b3f2b62cc5f867c9</sysId>
</sapConnection>

Expand

title	JSON Request

{
    "description": null,
    "name": "SAP Connection 1",
    "opswiseGroups": [],
    "retainSysIds": true,
    "sapAshost": null,
    "sapClient": null,
    "sapConnectionType": "Load Balancing",
    "sapGroup": "groupa",
    "sapGwhost": "ABC",
    "sapGwserv": "test",
    "sapMshost": "server",
    "sapMysapsso2": "D:\\ellen\\qa\\uc\\testdir\\new.data",
    "sapR3name": "777",
    "sapSaprouter": "/H/192.168.30.17/S/3297/H/155.56.59.11",
    "sapSncLib": "/qa/durability_export",
    "sapSncMode": "Off",
    "sapSncMyname": "my_test_name",
    "sapSncPartnername": "partnername",
    "sapSncQop": "Integrity Protection",
    "sapSncSso": "No",
    "sapSysnr": null,
    "sapUseSymbolicNames": "Yes",
    "sapX509cert": "D:\\ellen\\qa\\uc\\testdir\\ecu.txt",
    "sysId": "1c6a3b42f2704ae8b3f2b62cc5f867c9"
}

...

	Description
URI	http://host_name/uc/resources/sapconnection
HTTP Method	DELETE
Description	Deletes an SAP Connection.
URI Parameters	See Delete an SAP Connection: URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/sapconnection?connectionname=Test4
Example Response	Status 200 /OK SAP Connection deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify `connectionname` and `connectionid` at the same time. Status 404 /Not Found An SAP Connection with {name/id} "test" does not exist.

...

	Description
URI	http://host_name/uc/resources/sapconnection/list
HTTP Method	GET
Description	Retrieves information on all SAP Connections.
Example URI	http://localhost:8080/uc/resources/sapconnection/list
Authentication	HTTP Basic
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Response	See List SAP Connections: Example Response, below.
SAP Connection Properties	See SAP Connection Properties 12779556.

Anchor
List SAP Connections Example Response
List SAP Connections Example Response
List SAP Connections: Example Response

XML Response

JSON Response

Expand

title	XML Response

<sapConnections>
    <sapConnection exportReleaseLevel="7.2.0.0" exportTable="ops_sap_connection" version="7">
    <description>description</description>
    <name>SAP Connection 1</name>
    <opswiseGroups />
    <sapAshost />
    <sapClient />
    <sapConnectionType>Load Balancing</sapConnectionType>
    <sapGroup>groupa</sapGroup>
    <sapGwhost>ABC</sapGwhost>
    <sapGwserv>test</sapGwserv>
    <sapMshost>server</sapMshost>
    <sapMysapsso2>>D:\ellen\qa\uc\testdir\new.data</sapMysapsso2>
    <sapR3name>777</sapR3name>
    <sapSaprouter>/H/192.168.30.17/S/3297/H/155.56.59.11</sapSaprouter>
    <sapSncLib>/qa/durability_export</sapSncLib>
    <sapSncMode>Off </sapSncMode>
    <sapSncMyname>my_est_name</sapSncMyname>
    <sapSncPartnername>partnername</sapSncPartnername>
    <sapSncQop>Integrity Protection</sapSncQop>
    <sapSncSso>No</sapSncSso>
    <sapSysnr />
    <sapUseSymbolicNames>Yes</sapUseSymbolicNames>
    <sapX509cert>D:\ellen\qa\uc\testdir\ecu.txt</sapX509cert>
    <sysId>1c6a3b42f2704ae8b3f2b62cc5f867c9</sysId>
    </sapConnection>
    <sapConnection exportReleaseLevel="7.2.0.0" exportTable="ops_sap_connection" version="2">
    <description>description</description>
    <name>SAP Connection 1</name>
    <opswiseGroups />
    <sapAshost />
    <sapClient />
    <sapConnectionType>Load Balancing</sapConnectionType>
    <sapGroup>groupa</sapGroup>
    <sapGwhost>ABC</sapGwhost>
    <sapGwserv>test</sapGwserv>
    <sapMshost>server</sapMshost>
    <sapMysapsso2>>D:\ellen\qa\uc\testdir\new.data</sapMysapsso2>
    <sapR3name>777</sapR3name>
    <sapSaprouter>/H/192.168.30.17/S/3297/H/155.56.59.11</sapSaprouter>
    <sapSncLib>/qa/durability_export</sapSncLib>
    <sapSncMode>Off</sapSncMode>
    <sapSncMyname>my_test_name</sapSncMyname>
    <sapSncPartnername>partnername</sapSncPartnername>
    <sapSncQop>Integrity Protection</sapSncQop>
    <sapSncSso>No</sapSncSso>
    <sapSysnr />
    <sapUseSymbolicNames>Yes</sapUseSymbolicNames>
    <sapX509cert>D:\ellen\qa\uc\testdir\ecu.txt</sapX509cert>
    <sysId>3d7a03053ad64de1b21b6849e6deafd9</sysId>
    </sapConnection>
<sapConnections>

Expand

title	JSON Response

[ {
    "description": null,
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_sap_connection",
    "name": "SAP Connection 1",
    "opswiseGroups": [],
    "retainSysIds": true,
    "sapAshost": null,
    "sapClient": null,
    "sapConnectionType": "Load Balancing",
    "sapGroup": "groupa",
    "sapGwhost": "ABC",
    "sapGwserv": "test",
    "sapMshost": "server",
    "sapMysapsso2": "D:\\ellen\\qa\\uc\\testdir\\new.data",
    "sapR3name": "777",
    "sapSaprouter": "/H/192.168.30.17/S/3297/H/155.56.59.11",
    "sapSncLib": "/qa/durability_export",
    "sapSncMode": "Off",
    "sapSncMyname": "my_test_name",
    "sapSncPartnername": "partnername",
    "sapSncQop": "Integrity Protection",
    "sapSncSso": "No",
    "sapSysnr": null,
    "sapUseSymbolicNames": "Yes",
    "sapX509cert": "D:\\ellen\\qa\\uc\\testdir\\ecu.txt",
    "sysId": "1c6a3b42f2704ae8b3f2b62cc5f867c9"
    "version": 7
    },
    {
    "description": null,
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_sap_connection",
    "name": "SAP Connection 1",
    "opswiseGroups": [],
    "retainSysIds": true,
    "sapAshost": null,
    "sapClient": null,
    "sapConnectionType": "Load Balancing",
    "sapGroup": "groupa",
    "sapGwhost": "ABC",
    "sapGwserv": "test",
    "sapMshost": "server",
    "sapMysapsso2": "D:\\ellen\\qa\\uc\\testdir\\new.data",
    "sapR3name": "777",
    "sapSaprouter": "/H/192.168.30.17/S/3297/H/155.56.59.11",
    "sapSncLib": "/qa/durability_export",
    "sapSncMode": "Off",
    "sapSncMyname": "my_test_name",
    "sapSncPartnername": "partnername",
    "sapSncQop": "Integrity Protection",
    "sapSncSso": "No",
    "sapSysnr": null,
    "sapUseSymbolicNames": "Yes",
    "sapX509cert": "D:\\ellen\\qa\\uc\\testdir\\ecu.txt",
    "sysId": "3d7a03053ad64de1b21b6849e6deafd9"
    "version": 2
    }
]

...

	Description
URI	http://host_name/uc/resources/sapconnection
HTTP Method	PUT
Description	Modifies the SAP Connection specified by the `sysId`.
Example URI	http://localhost:8080/uc/resources/sapconnection
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Modify an SAP Connection: Example Request, below.
SAP Connection Properties	See SAP Connection Properties 12779556.
Example Response	Status 200 /OK Successfully updated the SAP Connection with sysId <sysId> to version <version>.

...

XML Request

JSON Request

Expand

title	XML Request

<sapConnection>
    <description>description</description>
    <name>SAP Connection 1</name>
    <opswiseGroups />
    <sapAshost />
    <sapClient />
    <sapConnectionType>Load Balancing</sapConnectionType>
    <sapGroup>groupa</sapGroup>
    <sapGwhost>ABC</sapGwhost>
    <sapGwserv>test</sapGwserv>
    <sapMshost>server</sapMshost>
    <sapMysapsso2>>D:\ellen\qa\uc\testdir\new.data</sapMysapsso2>
    <sapR3name>777</sapR3name>
    <sapSaprouter>/H/192.168.30.17/S/3297/H/155.56.59.11</sapSaprouter>
    <sapSncLib>/qa/durability_export</sapSncLib>
    <sapSncMode>Off </sapSncMode>
    <sapSncMyname>my_test_name</sapSncMyname>
    <sapSncPartnername>partnername</sapSncPartnername>
    <sapSncQop>Integrity Protection</sapSncQop>
    <sapSncSso>No</sapSncSso>
    <sapSysnr />
    <sapUseSymbolicNames>Yes</sapUseSymbolicNames>
    <sapX509cert>D:\ellen\qa\uc\testdir\ecu.txt</sapX509cert>
    <sysId>1c6a3b42f2704ae8b3f2b62cc5f867c9</sysId>
</sapConnection>

Expand

title	JSON Request

{
    "description": null,
    "name": "SAP Connection 1",
    "opswiseGroups": [],
    "retainSysIds": true,
    "sapAshost": null,
    "sapClient": null,
    "sapConnectionType": "Load Balancing",
    "sapGroup": "groupa",
    "sapGwhost": "ABC",
    "sapGwserv": "test",
    "sapMshost": "server",
    "sapMysapsso2": "D:\\ellen\\qa\\uc\\testdir\\new.data",
    "sapR3name": "777",
    "sapSaprouter": "/H/192.168.30.17/S/3297/H/155.56.59.11",
    "sapSncLib": "/qa/durability_export",
    "sapSncMode": "Off",
    "sapSncMyname": "my_test_name",
    "sapSncPartnername": "partnername",
    "sapSncQop": "Integrity Protection",
    "sapSncSso": "No",
    "sapSysnr": null,
    "sapUseSymbolicNames": "Yes",
    "sapX509cert": "D:\\ellen\\qa\\uc\\testdir\\ecu.txt",
    "sysId": "1c6a3b42f2704ae8b3f2b62cc5f867c9"
}

...

URI	http://host_name/uc/resources/sapconnection
HTTP Method	GET
Description	Retrieves information on a specific SAP Connection.
URI Parameters	See Read an SAP Connection: URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/sapconnection?connectionname=Test4
Example Response	See Read an SAP Connection: Example Response, below.
SAP Connection Properties	See SAP Connection Properties 12779556.

Anchor
Read an SAP Connection URI Parameters
Read an SAP Connection URI Parameters
Read an SAP Connection: URI Parameters

...

XML Response

JSON Response

Expand

title	XML Response

<sapConnection exportReleaseLevel="7.2.0.0" exportTable="ops_sap_connection" retainSysIds="true" version="1">
    <description>description</description>
    <name>SAP Connection 1</name>
    <opswiseGroups />
    <sapAshost />
    <sapClient />
    <sapConnectionType>Load Balancing</sapConnectionType>
    <sapGroup>groupa</sapGroup>
    <sapGwhost>ABC</sapGwhost>
    <sapGwserv>test</sapGwserv>
    <sapMshost>server</sapMshost>
    <sapMysapsso2>>D:\ellen\qa\uc\testdir\new.data</sapMysapsso2>
    <sapR3name>777</sapR3name>
    <sapSaprouter>/H/192.168.30.17/S/3297/H/155.56.59.11</sapSaprouter>
    <sapSncLib>/qa/durability_export</sapSncLib>
    <sapSncMode>Off </sapSncMode>
    <sapSncMyname>my_test_name</sapSncMyname>
    <sapSncPartnername>partnername</sapSncPartnername>
    <sapSncQop>Integrity Protection</sapSncQop>
    <sapSncSso>No</sapSncSso>
    <sapSysnr />
    <sapUseSymbolicNames>Yes</sapUseSymbolicNames>
    <sapX509cert>D:\ellen\qa\uc\testdir\ecu.txt</sapX509cert>
    <sysId>1c6a3b42f2704ae8b3f2b62cc5f867c9</sysId>
</sapConnection>

Expand

title	JSON Response

{
    "description": null,
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_sap_connection",
    "name": "SAP Connection 1",
    "opswiseGroups": [],
    "retainSysIds": true,
    "sapAshost": null,
    "sapClient": null,
    "sapConnectionType": "Load Balancing",
    "sapGroup": "groupa",
    "sapGwhost": "ABC",
    "sapGwserv": "test",
    "sapMshost": "server",
    "sapMysapsso2": "D:\\ellen\\qa\\uc\\testdir\\new.data",
    "sapR3name": "777",
    "sapSaprouter": "/H/192.168.30.17/S/3297/H/155.56.59.11",
    "sapSncLib": "/qa/durability_export",
    "sapSncMode": "Off",
    "sapSncMyname": "my_test_name",
    "sapSncPartnername": "partnername",
    "sapSncQop": "Integrity Protection",
    "sapSncSso": "No",
    "sapSysnr": null,
    "sapUseSymbolicNames": "Yes",
    "sapX509cert": "D:\\ellen\\qa\\uc\\testdir\\ecu.txt",
    "sysId": "1c6a3b42f2704ae8b3f2b62cc5f867c9"
    "version": 1
}

...

Property

UI Field Name

Description

Specifications

Required

Anchor

	description - SAP
	description - SAP

description

Description

Description of this record.

N

Anchor

	exportReleaseLevel - SAP
	exportReleaseLevel - SAP

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read only

N

Anchor

	exportTable - SAP
	exportTable - SAP

exportTable

n/a

Record table information.

read only

N

Anchor

	name - SAP
	name - SAP

name

Connection Name

Name used within the Controller to identify this SAP Connection.

Y

Anchor

	opswiseGroups - SAP
	opswiseGroups - SAP

opswiseGroups

Member of Business Services

Business Services that this record belongs to.

XML

<opswiseGroups>

<opswiseGroup>group1</opswiseGroup>

<opswiseGroup>group1</opswiseGroup>

<opswiseGroup>group2</opswiseGroup> </opswiseGroups> </pre>

<opswiseGroup>group2</opswiseGroup>
</opswiseGroups>

Panel

Html bobswift

JSON

<pre>

"opswiseGroups": ["group1","group2"]

</pre>

Panel

Html bobswift

N

Anchor

	retainSysIds - SAP
	retainSysIds - SAP

retainSysIds

n/a

Specification for whether or not the Create an SAP Connection web service will persist the sysId property.

If retainSysIds="true" and sysId is included in the request/response, sysId will be persisted to the database.
If retainSysIds="false" and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.

Note

title	Note

In XML web services, retainSysIds is specified as an attribute in the <sapConnection> element.

Valid values: true/false (default is true).

N

Anchor

	sapAshost - SAP
	sapAshost - SAP

sapAshost

Application Server

If connectionType = Specific Application Server; Host name of an SAP application server. If the path to the server goes through SAP routers, prefix the host name with the SAP router string.

Y

Anchor

	sapClient - SAP
	sapClient - SAP

sapClient

Client

If connectionType = Specific Application Server; SAP Client number.

Y

Anchor

	sapConnectionType - SAP
	sapConnectionType - SAP

sapConnectionType

Connection Type

Type of SAP Connection.

Valid Values:

As String = Specific Application Server, As Value = 1
As String = Load Balancing, As Value = 2

Y

Anchor

	sapGroup - SAP
	sapGroup - SAP

sapGroup

Group

If connectionType = Load Balancing; Host name of the message server.

N

Anchor

	sapGwhost - SAP
	sapGwhost - SAP

sapGwhost

Gateway

If connectionType = Specific Application Server; Host name of the SAP gateway.

N

Anchor

	sapGwserv - SAP
	sapGwserv - SAP

sapGwserv

Gateway Service

If connectionType = Specific Application Server; Service name of the SAP gateway.

N

Anchor

	sapMshost - SAP
	sapMshost - SAP

sapMshost

Message Server

If connectionType = Load Balancing; Application servers group name.

Y

Anchor

	sapMysapsso2 - SAP
	sapMysapsso2 - SAP

sapMysapsso2

Single Sign-On Ticket

Path to a file that contains the actual value for the MYSAPSSO2 parameter.

N

Anchor

	sapR3name - SAP
	sapR3name - SAP

sapR3name

System ID

If connectionType = Load Balancing; System ID of the SAP system to which you want to connect.

Y

Anchor

	sapSaprouter - SAP
	sapSaprouter - SAP

sapSaprouter

SAProuter

SAProuter parameter.

N

Anchor

	sapSncLib - SAP
	sapSncLib - SAP

sapSncLib

SNC Library

SNC_LIB parameter; Path to the third-party security library for SNC.

N

Anchor

	sapSncMode - SAP
	sapSncMode - SAP

sapSncMode

SNC Mode

SNC_MODE parameter; Specification for whether or not SNC is activated.

Valid Values:

As String = Off, As Value = 0
As String = On, As Value = 1

N

Anchor

	sapSncMyname - SAP
	sapSncMyname - SAP

sapSncMyname

SNC My Name

SNC_MYNAME parameter; Token/identifier representing the external RFC program.

N

Anchor

	sapSncPartnername - SAP
	sapSncPartnername - SAP

sapSncPartnername

SNC Partner Name

SNC_PARTNERNAME parameter; Token/identifier representing the back-end system.

N

Anchor

	sapSncQop - SAP
	sapSncQop - SAP

sapSncQop

SNC Quality of Protection

SNC_QOP parameter.

Valid Values:

As String = Authentication Only, As Value = 1
As String = Integrity Protection, As Value = 2
As String = Privacy Protection, As Value = 3
As String = Default Protection, As Value = 8
As String = Maximum Protection, As Value = 9

N

Anchor

	sapSncSso - SAP
	sapSncSso - SAP

sapSncSso

SNC Single Sign-On

SNC_SSO parameter; Specification for whether or not to use single sign-on for SNC.

Valid Values:

As String = No, As Value = 0
As String = Yes, As Value = 1

N

Anchor

	sapSysnr - SAP
	sapSysnr - SAP

sapSysnr

System Number

If connectionType = Specific Application Server; SYSNR parameter.

Y

Anchor

	sapUseSymbolicNames - SAP
	sapUseSymbolicNames - SAP

sapUseSymbolicNames

Use Symbolic Names

If connectionType = Load Balancing; USE_SYMBOLIC_NAMES parameter; Specification for whether or not to use symbolic service names.

Valid Values:

As String = Off, As Value = 0
As String = On, As Value = 1

N

Anchor

	sapX509cert - SAP
	sapX509cert - SAP

sapX509cert

X.509 Certificate

Path to a file that contains the actual value for the X509CERT parameter.

Y

Anchor

	sysId - SAP
	sysId - SAP

sysId

UUID

System ID field in the database for this SAP Connection record.

Persisted only if retainSysIds is set to true.

N

...

Versions Compared

Old Version 3

New Version 4

Key

Anchor
Create an SAP Connection Example Request
Create an SAP Connection Example Request
Create an SAP Connection: Example Request

Anchor
List SAP Connections Example Response
List SAP Connections Example Response
List SAP Connections: Example Response

Anchor
Read an SAP Connection URI Parameters
Read an SAP Connection URI Parameters
Read an SAP Connection: URI Parameters

Page Comparison

Versions Compared

Old Version 3

New Version 4

Key

AnchorCreate an SAP Connection Example RequestCreate an SAP Connection Example RequestCreate an SAP Connection: Example Request

AnchorList SAP Connections Example ResponseList SAP Connections Example ResponseList SAP Connections: Example Response

AnchorRead an SAP Connection URI ParametersRead an SAP Connection URI ParametersRead an SAP Connection: URI Parameters

Anchor
Create an SAP Connection Example Request
Create an SAP Connection Example Request
Create an SAP Connection: Example Request

Anchor
List SAP Connections Example Response
List SAP Connections Example Response
List SAP Connections: Example Response

Anchor
Read an SAP Connection URI Parameters
Read an SAP Connection URI Parameters
Read an SAP Connection: URI Parameters