Show TOC

Function documentationServices Locate this document in the navigation structure

 

You can use services to expose backend interfaces and execute tasks in SAP Manufacturing Integration and Intelligence (SAP MII) and the SAP MII Workbench.

Integration

To allow users to access certain services, see User Management.

Features

The SAP MII services are listed in the following table:

Service Name

Action Name

Function Provides

Admin

XMII_AdminService

Access to all system configuration functions. For more information, see Examples: Admin Services.

Audit

XMII_AuditService

Service for validating credentials and creating error entries

BLSManager

XMII_BLSManagerService

Access to the admin service, which provides transaction control. For examples, see Examples: Transaction Services.

Chart Servlet

XMII_ChartServlet

Chart generation servlet

Configuration

XMII_ConfigurationService

Import and export of server configuration data; used during migration

ContentList

XMII_ContentListService

View of content assigned to you

DataServers

XMII_DataServers

Manage data servers

For examples, see Examples: Data Server Services.

DynamicPageServlet

XMII_DynamicPageServlet

Access to the Dynamic Page servlet

DynamicQuery

XMII_DynamicQuery

Query execution without using a query template

EncryptConfig

XMII_EncryptConfig

Access to encryption configuration

File System Browser

XMII_FileSystemBrowser

Ability to browse folders and files in the database

Help Link

XMII_HelpLinkService

Resolving help links to a URL

IllumXSLTServlet

XMII_IllumXSLTServlet

XSL transformation engine through a URL request

ImageStorageServlet

XMII_ImageStorageServlet

Read and write permissions for GIF images on disk

Indexing

XMII_IndexingService

XMII_Indexer

Run indexer

For examples, see Examples: Indexing Services.

JCoDataBufferService

XMII_JCoDataBufferService

Access to the server from the SAP MII Workbench to fill XML properties with sample data

Localization

XMII_LocalizationService

Define string token replacements when localizing HTML content

Logout

XMII_LogoutService

Log off of current user

OutputStorageServlet

XMII_OutputStorageServlet

Used by the SAP MII Workbench when testing content

PDFService

XMII_PDFService

Used by the SAP MII Workbench to generate PDF output for a transaction

Personalization

XMII_PersonalizationService

Access to the home page URL

Ping Token

XMII_PingTokenService

Access to the SAP MII Workbench service that tests permissions

ProfileEditor

XMII_ProfileEditorService

Navigation and tab items for roles

Quality Portal Service

XMII_QualityPortal

XMII_PermissionService

Handling of SPCCharts

QueryCaching

XMII_QueryCaching

Run a query, cache the results, and access cached data

Scheduler

XMII_SchedulerService

Managing threads and running jobs at scheduled times

For examples, see Examples: Scheduler Services.

SPCChartServlet

XMII_SPCChartServlet

Generation of SPCCharts

SPCXMLServlet

XMII_SPCXMLServlet

Outputs the results of an SPC chart and query as an XML document. Required to retrieve SPC results since you configure SPC charts in the display template and not the query.

Statistics

XMII_ContentUsageService

Returns usage statistics for files

For examples, see Examples: Statistics Services.

The supported modes are the following:

  • Runtime

    You can specify an object name or start and end dates with an optional file path.

  • Summary

    Returns a one row summary for all objects that were accessed in the specified time frame

System Info

XMII_SystemInformationService

Access a reporting service with server list and mode list functions

Transport

XMII_Transport

Exports configuration and project information

For examples, see Examples: Transport Services.

WSDLGen

XMII_WSDLGen

WSDL for calling transactions using SOAPRunner

WSMessageListener

XMII_MessageListenerService

Write to the message table. For examples, see Examples: Message Services.

Alert

XMII_AlertService

You use this service to:

  • View alerts and its details

  • Change alert status

  • Delete alerts

  • Forward alerts

For examples, see Examples: Alert Services.

OData Service

XMII_ODataService

Enables you to access OData. For examples, see OData

Activities

You can call these services using the following URL:

http://<server>:<port>/XMII/Illuminator?service=<service name>&mode=<mode name>&content-type=<value>

  • service=<service name> is the name of the service, such as Admin.

  • mode=<mode name> defines the operation of the service.

    For example, the Admin service has a UserList mode that returns the list of all users configured for the server. You can return the list of modes for a service by running the service with ModeList as the mode.

  • content-Type=<value> defines how the data is returned.

    The following table lists the content types:

    Content Type Values

    Return Format

    raw/binary

    Legacy LISA format previously used by the applets

    text/xml

    Illuminator XML format

    text/html

    XML and transformed into an HTML document

    text/csv

    CSV output with a separator based on the user locale

    raw/xmii

    Binary protocol used by the applets and the SAP MII Workbench

    text/json

    Returns the response in JSON format

    Note Note

    It can be used only with those services that returns data in standard MII format.

    End of the note.

    You can return a custom response by specifying the FinalTransform property. The final transform can be an XSL file or a Java class.

Example

To run a scheduler job by ID, you enter the following URL:

http://<server>:<port>/XMII/Illuminator?service=Scheduler&mode=Run&ID=<jobid>