Integrator Guide THE BEST RUN. PUBLIC SAP Information Steward Document Version: 4.2 Support Package 12 ( )

(1)

PUBLIC

SAP Information Steward

Document Version: 4.2 Support Package 12 (14.2.12.0) – 2019-05-23

Integrator Guide

(2)

Content

1 Overview. . . . 4

2 Web Services technologies. . . .5

2.1 XSD. . . 6

2.2 WSDL. . . 7

3 Using Information Steward as a web service provider. . . .8

3.1 Common Web Services WSDL file. . . .12

ping. . . 12

login. . . .13

logout. . . .16

3.2 Metapedia Web Services WSDL file. . . .17

search. . . .18

getTermDetailsByName. . . .20

getMultipleTermDetailsByName. . . 23

searchPolicyStatement. . . 24

searchPolicySet. . . .27

getPolicyStatementDetailsByName. . . .28

GetPolicySetDetailsByName. . . .30

getPolicyStatementComplianceScore. . . .32

getPolicySetComplianceScore. . . 34

getPolicyStatementsInPolicySet. . . .36

3.3 Configuring the Web Services security policy. . . .38

Enabling and disabling the default security policy. . . .39

Security checklist: Enabling and using SSL. . . .39

Using keytool to generate keystores . . . .40

Creating a custom security policy. . . 42

4 Web Services log. . . . 43

5 Sample files. . . .44

5.1 is-common.wsdl. . . .44

5.2 is-common.xsd. . . 46

5.3 Metapedia_WebServices.wsdl. . . 48

5.4 Metapedia_Services.xsd. . . 53

5.5 Security configuration files. . . .61

policy.properties. . . 61

default_server.keystore. . . 63

(3)

default_client.keystore. . . .63 https_policy.xml. . . 63 axis2.xml. . . 64

(4)

1 Overview

Use the information in the Integrator Guide and the programming language of your choice to develop an interface to the Metapedia component in SAP Information Steward.

The access mechanism is SOAP (Simple Object Access Protocol). With the provided WSDL (Web Service Description Language) and XSD (XML Schema Definition) interface files, it is possible for you to log in, manage sessions, search, and retrieve operations.

The Common Web Service features include login that supports several SAP BOE authentication methods by using authentication and session management. Authentication and session management enables authorized users to log in and out without compromising the security of SAP BI platform in general. Authentication and session management specifically protects unauthorized users from accessing Information Steward. For stateless operation and security, the software uses short-term sessionID tokens for each information request.

When you use the Metapedia Web Service, term and policy set search and retrieval information is available. The Metapedia Web Service session management features allow you to specify the following:

● Maximum number of terms, policy sets, or policy statements to retrieve

● Index value and pagination

Advanced search features allow you to use wildcard characters, such as “*” (for multiple characters) and “?”

(for single characters).



Note

Users who have permissions set within Metapedia are able to access the same information using the web service.

This SDK and documentation is intended for use by web service developers familiar with XSD, WSDL, and web services.

With this SDK, create widgets or plugins for Microsoft Office for Word, Outlook, PowerPoint, or Excel. The widgets and plugins provide quick and direct access to Metapedia business terms. Your users do not have to switch between the SAP BI platform to Metapedia to their favorite program to work with their terms and policy sets.



Note

You still have to perform maintenance for Metapedia terms, policy set, and policy statement databases using SAP Information Steward.

Related Information

Using Information Steward as a web service provider [page 8]

(5)

2 Web Services technologies

Information Steward Metapedia Web Services use WSDL and XSD to define the interface rules. IS Common and Metapedia web services each have a corresponding WSDL and XSD file.

Web service technology Description

SOAP Connection protocol (envelope for XML messages).

WSDL Language used to request a service and return replies (subset of XML).

XML Schema Definition (XSD) Format used for the WSDL file. It is the schema used to describe the input and output for a web service operation.

XML Schema formats are defined in the types element of the WSDL file.

The following table describes the basic SOAP components:

SOAP components

Attribute Description Sample Value

XML Declaration Inclides the version and

encoding declaration. <?xml version="1.0" encoding="UTF-8" ?>

soapenv:Enve lope

Encompasses the name

space (XMLNS) of the servers, the soap schema, and SAP Infor

mation Steward Web Services.

<soapenv:Envelope xmlns:soapenv="http://

schemas.xmlsoap.org/soap/envelope/"

xmlns:ns="http://

common.isws.sap.com/2012/01/01">

soapenv:Head er

Encompasses the API.

<soapenv:Header>

<ns:SessionHeader>

<ns:SessionId>AUeUnNX1addNgzkHhHOh70Y</

ns:SessionId>

<ns:SessionStatus type="">

<ns:Reason>?</ns:Reason>

</ns:SessionStatus>

</ns:SessionHeader>

</soapenv:Header>

soapenv:Body The SOAP body tag con

tains the search method(s).

<soapenv:Body>

<ns1:Search recordsPerResult="15"

startIndex="0" plainText="true">

<Query>metauth</Query>

</ns1:Search>

</soapenv:Body>

The Metapedia interface is fully compliant with Web Services Interoperability (WS-I) Basic Profile 1.0, and supports support the standard Java Web Services technologies using SOAP, WSDL and XML.

(6)

Related Information

is-common.wsdl [page 44]

Metapedia_WebServices.wsdl [page 48]

Metapedia_Services.xsd [page 53]

is-common.xsd [page 46]

2.1 XSD

XML Schema Definition (XSD) outlines the structure of the Metapedia documents provided. The SDK uses these XSD files:

XSD file Description

ISCommon Services Used to submit authentication information and retrieve a token.

The is-common.xsd file provides the complete specification of all available service options for logging in and out, and server ping. The top level summary of these functions include:

● LoginDetails (UserName, Password, Domain, AuthType, Locale, Additional

<sapClient, sapSystem>)

● ISWSException (ID, Message, Operation, CallStackTrace, CauseException, CauseID, CauseMessage, CauseDetail)

● ISSession (SessionId, SessionStatus)

● Status (Reason, Type <SUCCESS> or <FAILED> )

● LoginResponse (SessionHeader / ISSession)

● SessionHeader

● LoginInformation (LoginDetails, LoginToken, SerializedSession)

● logout (SessionId)

● ping (PingResponse=timestamp)

Metapedia Services Provides the interface to access Metapedia search functions and search results.

The Metapedia_Services.xsd file provides operations that retrieve term, policy set, and policy statement information.

Related Information

is-common.xsd [page 46]

Metapedia_Services.xsd [page 53]

Common Web Services WSDL file [page 12]

Metapedia Web Services WSDL file [page 17]

(7)

2.2 WSDL

Web Services Description Language (WSDL) uses XML to define the structure, or schema definition of the XML document that is used in web services communication between client and server.

The Metapedia SDK uses these WSDL definitions:

WSDL definition Description

Common Web Service Provides a WS-Policy-based security infrastructure. Services include login, logout and vali

dation services and logging.

You can access the is-common.wsdl file from the following URL: http://

<domain.url>:<port>/BOE/ISWebServices/Common?wsdl The Common Web Services include login, logout, and ping.

● login token or credentials (LoginToken returns the SessionId)

● logout (requires the SessionId)

● ping (no parameters are needed) Metapedia Web Services Provides search and retrieval functions.

You can access the Metapedia_Web Services.wsdl file from the following URL:

http://<domain.url>:<port>/BOE/ISWebServices/Metapedia?wsdl The Metapedia web services term, policy set, and policy statement details by name and by query.

● Term, policy set, and policy statement search (requires the SessionId and the exact spelling of the term, policy set, or policy statement). Additional parameters include:

○ SessionStatus

○ Formatting (@plainText - the response is formatted as RTF or plain text)

○ TermName, policySetName, or policyStatementName (requires that the name be exact)

● Search with wild card (requires the SessionId and a phrase with the * or ? wild card).

Additional parameters include:

○ SessionStatus

○ Formatting (@recordsPerResult, @startIndex, @plainText)

○ Query (the term, policy set, or policy statement name can include a wild card char

acter * or ?)

Related Information

Common Web Services WSDL file [page 12]

Metapedia Web Services WSDL file [page 17]

(8)

3 Using Information Steward as a web service provider

The following web service workflow diagram shows a typical query session. The black represents the IS Common services, while the white represents the Metapedia web services.

The following component dependency diagram illustrates how Information Steward web application appears with the Metapedia IS Common Services and the IS Session Management Module leverages existing

functionality of other components such as the Apache Rampart security module and the AXIS 2 web services engine.

The following message flow diagram illustrates the path that service requests follow. Secure SOAP messages are initiated by clients, the query is processed, and the requested data is securely returned.

The Axis 2 module handles the Session Management, serving to validate the session token, sampling the thread every minute, and timing out after 10 minutes.

(9)

The following UML sequence diagram illustrates the interactions between the various components, showing swim lanes for the Common Web Services and the IS Repository that contains the Metapedia data.

The client logs on, the Common WS delivers a success message and a logon token to be used for query sessions. Given the stateless operation of the web service, subsequent queries validate the token before allowing the query to proceed. When the query completes, the client can be formally logged out, or the session and token validity can be allowed to expire after 10 minutes.

(10)

The overall system design showing how the Common Web Services and the Metapedia Web Services fit into the BOE system is shown in the following diagram:

(11)

(12)

3.1 Common Web Services WSDL file

Provides operations for session management.

The ISCommonBinding interface is used for the following operations:

Operation Description

ping Checks to see if a webservice is available by returning a timestamp.

login Facilitates logging in to Information Steward and retrieval of a session token.

logout Ends the session.



Note

The path for ISCommon webservices is as follows:

http://<IS_WEBSERVER_DOMAIN>:<PORT>/BOE/ISWebServices/Common?wsdl

3.1.1 ping

Verifies that the Information Steward web server that contains the Metapedia SDK is running and responding.

The ping operation is an empty input message with a ping operation request.

Input

Parameter Description

ping The domain name of the server running the BI platform Information Steward. The port number is not required.

The server may be pinged with a URL:

http://<domain.name>:<port>/BOE/InfoStewardApp/<number>/

ICCExplorer/services/ISCommon/ping

Where <number> is a server-specific numerical value. For example, 1210021132.

(13)

Output

Method Description

timestamp Timestamp information from the server.



Example

Request XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:ns="http://common.isws.sap.com/2012/01/01">

<soapenv:Header/>

<soapenv:Body>

<ns:ping></ns:ping>

</soapenv:Body>

</soapenv:Envelope>



Example

Response XML

A successful response from the server displays a timestamp:

<c:PingResponse xmlns:c="http://common.isws.sap.com/2012/01/01">

<c:timestamp>1350189008009</c:timestamp>

</c:PingResponse>

3.1.2 login

Submits a logon token or username and password credentials to log in to the BI platform system.

The system returns a logon token, or SessionId, that is used when searching for terms, definitions, and policy sets and statements. Because the system is stateless, the login is not remembered and the token must be used for every search request.

The SessionID is a 23-character case-sensitive token (for example, AX88m9bEEBNAqUqztkzmGdU) that is supplied by BI platform security.

Three authentication methods are available:

● A BOE logon token obtained by other means such as by using the JAVA SDK or RESTful Web Services can be used to avoid having the user enter their name and password.

● A serialized session is used when a login to BOE has already occurred and/or the access is shared by more than one trusted user.

● A username- and password-authenticated login with and a choice of several authentication methods supported by the BI platform.

(14)

Input

The login operation uses one input parameter called LoginInformation. The following table describes the three methods that may be used to login to Information Steward. An appropriate login token is returned along with a response and status message:

Method Description Sample value

LoginDetails Parameters:

● Username

● Password

● Domain

● Authentication Method

● Locale (optional)

● Additional Information (optional)

LoginDetails sample values:

● user.john.doe

● pasw0rd.hard.to.guess

● test.domain.net

● secEnterprise

● <ns:Locale>en</ns:Locale>

● <ns:SAP sapClient="tenant1"

sapSystem="IBM"/>

LoginToken Client must already be a BOE registered user and must already be logged in to BOE enterprise.

This method avoids having to supply a user name and password to the client.

ASAB6t1Xe333oZ.UUH54am8

SerializedSession ● Client must already be a BOE regis

tered user and must already be logged in to BOE enterprise.

● As with LoginToken, this method avoids having to supply a user name and password to the client.

● The main advantage is to share BOE session with several users.

ASAB6t1Xe444oZ.UUH54am8

Supported authentication types for the username and password login are as follows:

Authentication types

Authentication type Value Notes

Enterprise secEnterprise BOE BI platform enterprise security

LDAP secLDAP Lightweight Directory Access protocol authentication

Windows AD secWinAD Microsoft Windows Active Directory logon

SAP secSAPR3 Requires additional parameters such as the SAP client

and SAP system.

JD Edwards EnterpriseOne secPSE1 n/a

Oracle EBC secOraApps n/a

PeopleSoft Enterprise secpsenterprise n/a

Siebel7 secSeibel7 n/a

(15)



Note

The BI platform passes requests to other layers of the system, including client applications. You can include request header attributes that are not recognized by the BI platform but are recognized by client

applications.

Output

Method Description

SessionId A token that is acquired at login and is required in order to log off. The 23-digit token that is obtained from ISCommonBinding login .

SessionStatus The SessionStatus response is either SUCCESS or FAILED.

If SessionStatus is FAILED, an error message appears.



Example

Request XML

The following XML code snippet is an example of a request form:

<?xml version="1.0" encoding="UTF-8" ?>

<soapenv:Header>

<ns:LoginInformation>

<ns:LoginDetails>

<ns:UserName>AuthorizedUser</ns:UserName>

<ns:Password>PasswordHere</ns:Password>

<ns:Domain>is_webserverdoman.name.here.com</ns:Domain>

<ns:AuthType>secEnterprise</ns:AuthType>

<ns:Locale>?</ns:Locale>

<ns:Additional>

<ns:SAP sapClient="?" sapSystem="?"/>

</ns:Additional>

</ns:LoginDetails>

<ns:LoginToken>?</ns:LoginToken>

<ns:SerializedSession>?</ns:SerializedSession>

</ns:LoginInformation>

</soapenv:Header>

<soapenv:Body>

<ns:login>?</ns:login>

</soapenv:Body>

</soapenv:Envelope>



Example

Response XML

(16)

The following XML code snippet is an example of a successful response from a request, where the SessionID value of AX88m9bEEBNAqUqztkzmGdU is retrieved:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

<c:LoginResponse xmlns:c="http://common.isws.sap.com/2012/01/01">

<c:SessionHeader>

<c:SessionId>AX88m9bEEBNAqUqztkzmGdU</c:SessionId>

<c:SessionStatus type="SUCCESS">

<c:Reason/>

</c:SessionStatus>

</c:SessionHeader>

</c:LoginResponse>

</soapenv:Body>

</soapenv:Envelope>

3.1.3 logout

Logs you out of the Information Steward web server when web service communication is complete.

You must use the SessionId logon token (a session CUID supplied from an EnterpriseSession) to notify Information Steward that you are leaving. This frees up a license seat for use by another person.

Input

Method Description

SessionId A token that is acquired at login and is required in order to log off. The 23-digit token that is obtained from ISCommonBinding login .

Output

Method Description

SessionStatus The SessionStatus response is either SUCCESS or FAILED.

If SessionStatus is FAILED, an error message appears.



Example

Request XML

<soapenv:Header/>

<soapenv:Body>

<ns:logout>

<ns:SessionId>?</ns:SessionId>

(17)

</ns:logout>

</soapenv:Body>

</soapenv:Envelope>



Example

Response XML

A successful logout response appears as follows:

<soapenv:Body>

<c:LogoutResponse type="SUCCESS" xmlns:c="http://common.isws.sap.com/

2012/01/01">

<c:Reason/>

</c:LogoutResponse>

</soapenv:Body>

</soapenv:Envelope>

3.2 Metapedia Web Services WSDL file

Provides functions to allow information retrieval.

The MetapediaServiceBinding interface is used for the following operations:

Operation Description

search Searches for matches using an approximate term name plus a wildcard

character such as * or ?.

getTermDetailsByName Searches for a term exactly as you enter it.

getMultipleTermDetailsByName Searches for multiple terms exactly as you enter them.

searchPolicyStatement Returns all the policy statements that match the provided search query.

The name can be a partial string with an asterisk (*) appended to the name string.

searchPolicySet Returns all the policy sets that match the provided search query. The name can be a partial string with an * appended to the name string.

getPolicyStatementDetailsByName Returns detailed information regarding the policy statement specified by the name in the request.

getPolicySetDetailsByName Returns detailed information about a specific policy set (exact name re

quired).

getPolicyStatementComplianceScore Returns the policy statement compliance score, based on the name of the policy statement.

getPolicySetComplianceScore Returns the policy set compliance score, based on the name of the pol

icy set.

getPolicyStatementsInPolicySet Returns all the policy statements found in a particular policy set, based on the name of the parent policy set.

(18)

Related Information

search [page 18]

getTermDetailsByName [page 20]

getMultipleTermDetailsByName [page 23]

searchPolicyStatement [page 24]

searchPolicySet [page 27]

getPolicyStatementDetailsByName [page 28]

GetPolicySetDetailsByName [page 30]

getPolicyStatementComplianceScore [page 32]

getPolicySetComplianceScore [page 34]

getPolicyStatementsInPolicySet [page 36]

3.2.1 search

Searches for matches using an approximate term name, plus a wildcard character such as * or ?.

Input

Method Description

SessionId 23-digit token that is obtained from ISCommonBinding login . recordsPerResult The maximum number of search results to return. 250 is the default value.

startIndex If there are multiple pages, the number of the page to display. The default is 0.

plainText Specifies how the description text should be returned. Use true for unformatted text and false for RTF (Rich Text Format) text.

Query Name of the term to search (the default is RelTerm). Asterisk (*) and question mark (?) symbols are used for wildcard and character substitution searches. For example,

*flower will return wildflower and sunflower and Bra?il will return Brazil and Brasil.

Output

Method Description

totalTerms Total number of terms found. If a term cannot be found, the return value is 0.

Name Name of the term. The terms are sorted in ascending order.

Description Description associated with the term.

(19)

Method Description

MetapediaTermURL URL to the term in Information Steward.

Author Name of the author.

LastModifiedDate Date the term was last modified.



Note

Any errors that result from the query, such as an expired session token, will display a faultcode and faultstring. For example:

<soapenv:Body>

<soapenv:Fault>

<faultcode>soapenv:Server</faultcode>

<faultstring>Session is expired or session ID is not correct.

(COM-101)</faultstring>

</soapenv:Fault>

</soapenv:Body>

</soapenv:Envelope>

COM is the error prefix code for Common Web Services.



Example

Request XML

xmlns:ns="http://common.isws.sap.com/2012/01/01" xmlns:ns1="http://

metapedia.isws.sap.com/2012/01/01">

<soapenv:Header>

<ns:SessionHeader>

<ns:SessionId>AUeUnNX1addNgzkHhHOh70Y</ns:SessionId>

<ns:SessionStatus type="">

</ns:SessionStatus>

</ns:SessionHeader>

</soapenv:Header>

<soapenv:Body>

<ns1:Search recordsPerResult="15" startIndex="0" plainText="true">

<Query>metauth</Query>

</ns1:Search>

</soapenv:Body>

</soapenv:Envelope>



Example

Response XML

<soapenv:Body>

<ns1:MetapediaTerms totalTerms="1" xmlns:ns1="http://

<Term>

<Name>metauth</Name>

<Description>metaauth</Description>

(20)

<MetapediaTermURL>http://uspalw201.dhcp.pal.sap.corp:8080/BOE/

InfoStewardApp/1209261045/ICCExplorer/

metapediaPage.do

?termName=metauth&name=metauth&rdir=y</

MetapediaTermURL>

<Author>MetaAuth</Author>

</Term>

</ns1:MetapediaTerms>

</soapenv:Body>

</soapenv:Envelope>

3.2.2 getTermDetailsByName

Searches for a term exactly as you enter it and returns detailed information about the specified term.

Input

Method Description

SessionId A 23-digit token that is obtained from ISCommonBinding login .

PlainText (optional) Specifies how the description text should be returned. Use true for unformatted text and false for RTF (Rich Text Format) text.

TermName Name of the term to search.

Output

Method Description

Name Technical name for the term. Terms are sorted in ascending order.

Description Text that describes this term.

RelatedTerms Other terms that have a related meaning to this term. Information about each re

lated term includes:

● Name (the business name)

● Metapedia term URL

Categories Name of each category to which the term belongs.

Synonyms Words that have the same meaning as the term.

(21)

Method Description

Keywords Words that you can use to search for the term.

CustomAttributes Information about each custom attribute includes:

● Value



Example

Request XML

<soapenv:Header>

<ns:SessionHeader>

<ns:SessionId>?</ns:SessionId>

<ns:SessionStatus type="?">

</ns:SessionStatus>

</ns:SessionHeader>

</soapenv:Header>

<soapenv:Body>

<ns1:GetTermDetailsByName plainText="false">

</ns1:GetTermDetailsByName>

</soapenv:Body>

</soapenv:Envelope>

The following example shows the form that has two items entered, a valid SessionId value, and a TermName:

<soapenv:Header>

<ns:SessionHeader>

<ns:SessionId>AZJKXqzyymBFvJZwcCem6HE</ns:SessionId>

</ns:SessionStatus>

</ns:SessionHeader>

</soapenv:Header>

<soapenv:Body>

<ns1:GetTermDetailsByName plainText="false">

<TermName>flower</TermName>

</ns1:GetTermDetailsByName>

</soapenv:Body>

</soapenv:Envelope>



Example

Response XML

<soapenv:Body>

(22)

<ns1:MetapediaTermDetail xmlns:ns1="http://metapedia.isws.sap.com/

2012/01/01">

<Name>flower</Name>

<Description><FONT FACE="Tahoma" SIZE="11"

COLOR="#000000" LETTERSPACING="0" KERNING="0">green<

/FONT></Description>

<MetapediaTermURL>http://10.162.206.101:8080/BOE/InfoStewardApp/

1210021132/ICCExplorer/metapediaPage.do?termName=flower &name=flower&rdir=y</MetapediaTermURL>

<Author>Administrator</Author>

<Name>plant</Name>

<Description>something that grows</Description>

</Category>

</Categories>

</Synonyms>

<Keyword>plant</Keyword>

</Keywords>

</ns1:MetapediaTermDetail>

</soapenv:Body>

</soapenv:Envelope>

Since the default value of plainText is false, the text is formatted.

Note that MetapediaTermDetail and MetapediaTermURL is URL-encoded. Characters such as "<" are encoded and appear as < . The ampersand symbols (&) appear as &.



Note

Note that formatting of the preceding code snippet for MetapediaTermURL has been shortened to fit the page better. Normally the string does not wrap in this fashion.

If the session has expired, the returned XML will appear as follows:

<soapenv:Body>

<soapenv:Fault>

<faultcode>soapenv:Server</faultcode>

<faultstring>Session is expired or session ID is not correct.

(COM-101)</faultstring>

</soapenv:Fault>

</soapenv:Body>

</soapenv:Envelope>

(23)

3.2.3 getMultipleTermDetailsByName

Returns detailed information about all the Metapedia terms specified by the same name.

Input

Method Description

TermName Name of the term to search.

Output

Method Description

Name Technical name for the term. Terms are sorted in ascending order.

Description Text that describes this term.

RelatedTerms Other terms that have a related meaning to this term. Information about each re

lated term includes:

● Metapedia term URL

Categories Name of each category to which the term belongs.

Synonyms Words that have the same meaning as the term.

Keywords Words that you can use to search for the term.

● Value



Example

Request XML

<soapenv:Header>

(24)

<ns:SessionHeader>

<ns:SessionId>AZuyU2HI315MrdELdcyauhU</ns:SessionId>

</ns:SessionHeader>

</soapenv:Header>

<soapenv:Body>

<ns1:GetMultipleTermDetailsByName plainText="false">

<Term>Macho</Term>

</ns1:GetMultipleTermDetailsByName>

</soapenv:Body>

</soapenv:Envelope>



Example

Response XML

<soapenv:Body>

<ns1:MetapediaTermDetailSequence xmlns:ns1="http://

<Term>

<Name>MACHO</Name>

COLOR="#000000" LETTERSPACING="0" KERNING="0">MACHO_description</

FONT></Description>

<MetapediaTermURL>http://localhost:8080/BOE/InfoStewardApp/

1606101653/ICCExplorer/metapediaPage.do?

termName=MACHO&name=MACHO&rdir=y</MetapediaTermURL>

</Term>

</ns1:MetapediaTermDetailSequence>

</soapenv:Body>

</soapenv:Envelope>

3.2.4 searchPolicyStatement

Returns all the policy statements that match the provided search query.

Input

Method Description

(25)

Method Description

Query Name of the policy statement to search. Asterisk (*) and question mark (?) symbols are used for wildcard and character substitution searches. For example, *flower will return wildflower and sunflower and Bra?il will return Brazil and Brasil.

Output

Method Description

Name Name of the policy statement.

ParentPolicySetName Specifies the name of the parent policy set.

Description Text that describes the policy statement.

MetapediaPolicyStatementURL URL for the policy statement in Information Steward.

LastModifiedDate Date the policy statement was last modified.

EffectiveDate Date on which the policy statement goes into effect.

ExpiryDate Date on which the policy statement expires.

PathFromRootPolicySet Full path to the root policy set to which the policy statement belongs.



Example

Request XML

<soapenv:Header>

<ns:SessionHeader>

<ns:SessionId>Ab_t3tczR9JFnOd_TKgGdpM</ns:SessionId>

</ns:SessionHeader>

</soapenv:Header>

<soapenv:Body>

<ns1:SearchPolicyStatement recordsPerResult="250" startIndex="0"

plainText="false">

<Query>Centra*</Query>

</ns1:SearchPolicyStatement>

</soapenv:Body>

</soapenv:Envelope>



Example

Response XML

<soapenv:Body>

<ns1:MetapediaPolicyStatements totalPolicyStatements="5"

xmlns:ns1="http://metapedia.isws.sap.com/2012/01/01">

(26)

<Name>CentralAsia</Name>

<ParentPolicySetName>Global Procurement</ParentPolicySetName>

<Description><![CDATA[<FONT FACE="Tahoma"

SIZE="11" COLOR="#000000" LETTERSPACING="0" KERNING="0">An operational

purchase agreement with total amount assigned that exceeds 50,000 euros, must refer to a request for proposal (RFP). </

FONT><FONT FACE="Tahoma" SIZE="11" COLOR="#000000"

LETTERSPACING="0" KERNING="0">The RFP must be marked as closed, and it must have received responses from at least 3 distinct vendors. Evaluation metrics of each vendor response associated with the RFP must be available for

compliance and auditing purpose. </

LETTERSPACING="0" KERNING="0">The sourcing activities relevant to ‘Small Spend Countries’ are not subject to these requirements.]]></

Description>

<MetapediaPolicyStatementURL>http://localhost:8080/BOE/

InfoStewardApp/1606101653/ICCExplorer/metapediaPage.do?

policyStatementName=CentralAsia&name=CentralAsia&rdir=y</

MetapediaPolicyStatementURL>

<PathFromRootPolicySet>Global Procurement/CentralAsia</

PathFromRootPolicySet>

</PolicyStatement>

<Name>CentralAsia</Name>

SIZE="11" COLOR="#000000" LETTERSPACING="0" KERNING="0">An operational

purchase agreement with total amount assigned that exceeds 50,000 euros, must refer to a request for proposal (RFP). </

LETTERSPACING="0" KERNING="0">The RFP must be marked as closed, and it must have received responses from at least 3 distinct vendors. Evaluation metrics of each vendor response associated with the RFP must be available for

compliance and auditing purpose. </

LETTERSPACING="0" KERNING="0">The sourcing activities relevant to ‘Small Spend Countries’ are not subject to these requirements.]]></

Description>

policyStatementName=CentralAsia&name=CentralAsia&rdir=y</

<PathFromRootPolicySet>Global Procurement/Asia/CentralAsia</

</PolicyStatement>

</ns1:MetapediaPolicyStatements>

</soapenv:Body>

</soapenv:Envelope>

(27)

3.2.5 searchPolicySet

Returns all the policy sets that match the provided search query.

Input

Method Description

Query Name of the policy set to search. Asterisk (*) and question mark (?) symbols are used for wildcard and character substitution searches. For example, *flower will return wild

flower and sunflower and Bra?il will return Brazil and Brasil.

Output

Method Description

Name Name of the policy set.

Description Text that describes the policy set.

MetapediaPolicySetURL URL for the policy set in Information Steward.

LastModifiedDate Date the policy set was last modified.

EffectiveDate Date on which the policy set goes into effect.

ExpiryDate Date on which the policy set expires.

PathFromRootPolicySet Full path to the root policy set to which the policy set belongs.



Example

Request XML

<soapenv:Header>

<ns:SessionHeader>

</ns:SessionHeader>

</soapenv:Header>

(28)

<soapenv:Body>

<ns1:SearchPolicySet recordsPerResult="250" startIndex="0"

plainText="false">

</ns1:SearchPolicySet>

</soapenv:Body>

</soapenv:Envelope>



Example

Response XML

<soapenv:Body>

<ns1:MetapediaPolicySets totalPolicySets="1" xmlns:ns1="http://

<Name>Global Procurement</Name>

COLOR="#000000" LETTERSPACING="0" KERNING="0">The processes and rules the organization must follow when obtaining the products or services needed to run the business.</Description>

<MetapediaPolicySetURL>http://localhost:8080/BOE/InfoStewardApp/

1606101653/ICCExplorer/metapediaPage.do?policySetName=Global

Procurement&name=Global Procurement&rdir=y</MetapediaPolicySetURL>

<PathFromRootPolicySet>Global Procurement</PathFromRootPolicySet>

</PolicySet>

</ns1:MetapediaPolicySets>

</soapenv:Body>

</soapenv:Envelope>

3.2.6 getPolicyStatementDetailsByName

Returns detailed information regarding the policy statement specified by the name in the request.

Input

Method Description

SessionId A 23-digit token that is obtained from ISCommonBinding login . parentPolicySetName Specifies the name of the policy set to which the policy statement belongs.

policyStatementName Name of the policy statement for which you are searching.

(29)

Output

Method Description

Name Technical name for the policy statement.

ParentPolicySetName Specifies the name of the policy set to which the policy statement belongs.

ExpiryDate Date on which the statement expires.

RelatedTerms Terms that are related to the policy statement. Information about each related term includes the name (the business name) and the URL for the term.

AssociatedPolicyStatements Name of associated policy statements.

Keywords Words that you can use to search for the policy statement.

● Value



Example

Request XML

<soapenv:Header>

<ns:SessionHeader>

</ns:SessionStatus>

</ns:SessionHeader>

</soapenv:Header>

<soapenv:Body>

<ns1:GetPolicyStatementDetailsByName parentPolicySetName="Africa"

plainText="false">

<PolicyStatementName>Payment Run</PolicyStatementName>

</ns1:GetPolicyStatementDetailsByName>

</soapenv:Body>

</soapenv:Envelope>



Example

Response XML

(30)

<soapenv:Body>

<ns1:MetapediaPolicyStatementDetailSequence xmlns:ns1="http://

<Name>Payment Run</Name>

<ParentPolicySetName>Africa</ParentPolicySetName>

SIZE="11" COLOR="#000000" LETTERSPACING="0" KERNING="0">Payment is executed based on payment type and agreed payment timetable for that payment type according to company code. <FONT FACE="Tahoma"

SIZE="11" COLOR="#000000" LETTERSPACING="0" KERNING="0"><P

ALIGN="LEFT"><FONT FACE="Tahoma" SIZE="11" COLOR="#000000" LETTERSPACING="0"

KERNING="0">The payment is marked as pending when vendor is blocked. All pending payments are executed within 30 days from the day of vendor block removal.<FONT FACE="Tahoma" SIZE="11"

COLOR="#000000" LETTERSPACING="0" KERNING="0"><P

ALIGN="LEFT"><FONT FACE="Tahoma" SIZE="11" COLOR="#000000" LETTERSPACING="0"

KERNING="0">Each instance of vendor block and vendor block removal must have appropriate reasons and justifications documented for compliance and auditing purpose.]]></Description>

policyStatementName=Payment Run&name=Payment Run&rdir=y</

<PathFromRootPolicySet>Global Procurement/Africa/Payment Run</

</PolicyStatement>

</ns1:MetapediaPolicyStatementDetailSequence>

</soapenv:Body>

</soapenv:Envelope>

3.2.7 GetPolicySetDetailsByName

Returns detailed information about a specific policy set (exact name required).

Input

Method Description

PlainText (optional) Specifies whether the description text should be returned in the plain text (true) or in the rich text format (false).

policySetName Name of the policy set for which you are searching.

(31)

Output

Method Description

Name Name of the policy set.

ParentPolicySetName Specifies the name of the parent policy set (if applicable).

Description Text that describes the policy set.

MetapediaPolicySetURL URL for the policy set in Information Steward.

EffectiveDate Date on which the policy set goes into effect.

ExpiryDate Date on which the policy set expires.

PathFromRootPolicySet Full path to the root policy set to which the policy set belongs (if applicable).

Keywords Words that you can use to search for the policy set.

CustomAttributes Information about each custom attribute, including the name (the business name) and the value.



Example

Request XML

<soapenv:Header>

<ns:SessionHeader>

</ns:SessionHeader>

</soapenv:Header>

<soapenv:Body>

<ns1:GetPolicySetDetailsByName plainText="false">

</ns1:GetPolicySetDetailsByName>

</soapenv:Body>

</soapenv:Envelope>



Example

Response XML

<soapenv:Body>

<ns1:MetapediaPolicySetDetailSequence xmlns:ns1="http://

<ParentPolicySetName>Global Procurement</ParentPolicySetName>

COLOR="#000000" LETTERSPACING="0" KERNING="0">Policies that apply to all regions within the Asian continent.</Description>

policySetName=Asia&name=Asia&rdir=y</MetapediaPolicySetURL>

(32)

<PathFromRootPolicySet>Global Procurement/Asia</

</PolicySet>

<ParentPolicySetName>North America</ParentPolicySetName>

COLOR="#000000" LETTERSPACING="0" KERNING="0">Temporary Policy Set</

FONT></Description>

policySetName=Asia&name=Asia&rdir=y</MetapediaPolicySetURL>

<PathFromRootPolicySet>Global Procurement/North America/Asia</

</PolicySet>

</ns1:MetapediaPolicySetDetailSequence>

</soapenv:Body>

</soapenv:Envelope>

3.2.8 getPolicyStatementComplianceScore

Returns the policy statement compliance score, based on the name of the policy statement.

Input

Method Description

SessionId A 23-digit token that is obtained from ISCommonBinding login . parentPolicySetName (optional) Specifies the name of the parent policy set.

PlainText Specifies how the description text should be returned. Use true for unformatted text and false for RTF (Rich Text Format) text.

PolicyStatementName Name of the policy statement for which you want to see the compliance score.

(33)

Output

Method Description

PolicyStatementName Name of the policy statement.

ComplianceScore The overall compliance score for the policy statement.



Note

“Expired” appears if a policy statement is in the Expired state.

“No Score” appears if:

● the policy statement doesn't have any rules associated with it.

● none of the rules associated with a policy statement have bindings.

If some of the rules have bindings, a score will appear, but the rules that have no bindings are left out of the score calculation.

● none of the rules associated with a statement have been run.

If some of the rules have been run, a score will appear, but the rules that have not been run are left out of the score calculation.

For more information about compliance scores, see the User Guide.

PathFromRootPolicySet Full path to the root policy set.



Example

Request XML

<soapenv:Header>

<ns:SessionHeader>

</ns:SessionHeader>

</soapenv:Header>

<soapenv:Body>

<ns1:GetPolicyStatementComplianceScore parentPolicySetName=""

plainText="false">

<PolicyStatementName>CentralAsia</PolicyStatementName>

</ns1:GetPolicyStatementComplianceScore>

</soapenv:Body>

</soapenv:Envelope>



Example

Response XML

<soapenv:Body>

<ns1:MetapediaPolicyStatementComplianceScoreSequence xmlns:ns1="http://

(34)

<ParentPolicySetName>South America</ParentPolicySetName>

<PathFromRootPolicySet>Global Procurement/CentralAsia</

</PolicyStatementComplianceScoreObject>

<PathFromRootPolicySet>Global Procurement/Africa/CentralAsia</

<ComplianceScore>No Score</ComplianceScore>

<PathFromRootPolicySet>Global Procurement/Asia/CentralAsia</

<ComplianceScore>Expired</ComplianceScore>

<PathFromRootPolicySet>Global Procurement/North America/

CentralAsia</PathFromRootPolicySet>

<ComplianceScore>No Score</ComplianceScore>

<PathFromRootPolicySet>Global Procurement/South America/

CentralAsia</PathFromRootPolicySet>

</ns1:MetapediaPolicyStatementComplianceScoreSequence>

</soapenv:Body>

</soapenv:Envelope>

3.2.9 getPolicySetComplianceScore

Returns the policy set compliance score, based on the name of the policy set.

Input

Method Description

SessionId A 23-digit token that is obtained from ISCommonBinding login . parentPolicySetName Specifies the name of the parent policy set (if applicable).

policySetName Name of the policy set for which you want to see the compliance score.

(35)

Output

Method Description

PolicySetName Name of the policy set.

ComplianceScore The overall compliance score for the policy set.



Note

“Expired” appears if a policy set is in the Expired state.

For more information about compliance scores, see the User Guide.

PathFromRootPolicySet Full path to the root policy set.



Example

Request XML

<soapenv:Header>

<ns:SessionHeader>

</ns:SessionHeader>

</soapenv:Header>

<soapenv:Body>

<ns1:GetPolicySetComplianceScore parentPolicySetName=""

plainText="false">

<PolicySetName>Global Procurement</PolicySetName>

</ns1:GetPolicySetComplianceScore>

</soapenv:Body>

</soapenv:Envelope>



Example

Response XML

<soapenv:Body>

<ns1:MetapediaPolicySetComplianceScoreSequence xmlns:ns1="http://

<PolicySetName>Global Procurement</PolicySetName>

<PathFromRootPolicySet>Global Procurement</PathFromRootPolicySet>

</PolicySetComplianceScoreObject>

</ns1:MetapediaPolicySetComplianceScoreSequence>

</soapenv:Body>

</soapenv:Envelope>

(36)

3.2.10 getPolicyStatementsInPolicySet

Returns all the policy statements found in a particular policy set, based on the name of the parent policy set.

Input

Method Description

policySetName Specifies the name of the policy set to which the policy statements belong.

Output

Method Description

Name Technical name for the policy statement.

ExpiryDate Date on which the statement expires.

RelatedTerms Terms that are related to the policy statement. Information about each related term includes the name (the business name) and the URL for the term.

AssociatedPolicyStatements Name of associated policy statements.

Keywords Words that you can use to search for the policy statement.

CustomAttributes Information about each custom attribute includes the name (the business name) and the value.



Example

Request XML

(37)

<soapenv:Header>

<ns:SessionHeader>

</ns:SessionHeader>

</soapenv:Header>

<soapenv:Body>

<ns1:GetPolicyStatementsInPolicySet plainText="true">

</ns1:GetPolicyStatementsInPolicySet>

</soapenv:Body>

</soapenv:Envelope>



Example

Response XML

<soapenv:Body>

<ns1:MetapediaPolicyStatementDetailSequence xmlns:ns1="http://

<Name>Payment Run</Name>

<Description>Payment is executed based on payment type and agreed payment timetable for that payment type according to company code.</

Description>

policyStatementName=Payment Run&name=Payment Run&rdir=y</

<PathFromRootPolicySet>Global Procurement/Africa/Payment Run</

</PolicyStatement>

<Name>Invoice Processing</Name>

<Description>Invoices are documented and time-stamped when received. Accounts Payable (AP) team must process an invoice within 15 days from the date of submission.</Description>

policyStatementName=Invoice Processing&name=Invoice Processing&rdir=y</MetapediaPolicyStatementURL>

<PathFromRootPolicySet>Global Procurement/Africa/Invoice Processing</PathFromRootPolicySet>

</PolicyStatement>

<Name>Payment Proposal</Name>