Sie sind auf Seite 1von 106

4/11/2019

SAP Manufacturing Integration and


Intelligence
Generated on: 2019-04-11

SAP Manufacturing Integration and Intelligence | 15.2.0

PUBLIC

Warning

This document has been generated from the SAP Help Portal and is an incomplete version of the official SAP product
documentation. The information included in custom documentation may not re ect the arrangement of topics in the SAP Help
Portal, and may be missing important aspects and/or correlations to other topics. For this reason, it is not for productive use.

For more information, please visit the SAP Help Portal.

This is custom documentation. For more information, please visit the SAP Help Portal 1
4/11/2019

SAP Manufacturing Integration and


Intelligence
Use
SAP Manufacturing Integration and Intelligence (SAP MII) enables you to integrate your plant and enterprise systems and
display integrated data to your employees. You can use SAP MII to view, measure, and compare the performance of plants and
assets with different automation system infrastructures. SAP MII reduces the cost of synchronizing plant and enterprise
business processes by using the following:

Plant system connectors

Business logic services

Integration scenarios

Integration
SAP MII is powered by SAP NetWeaver.

The following software units are required for some SAP MII functions:

SAP Java Connector (SAP JCo)

SAP Java Resource Adapter (SAP JRA)

Features

To access the SAP MII administration menu, enter http://<server:port>/XMII/Menu.jsp in your browser.

From the SAP MII administration menu, you access SAP MII components to which you have permission. For more information
about system permissions, see Security Services.

The main components of the SAP MII administration menu include the following:

System Management

Security Services

Data Services

Content Development

Including the SAP MII Workbench

Message Services

Catalog Services

Alerts and KPI

System Resources

Energy Monitoring and Analysis

This is custom documentation. For more information, please visit the SAP Help Portal 2
4/11/2019

Note
To log off of the SAP MII system, close your browser window.

System Management
Use
You can use System Management in SAP Manufacturing Integration and Intelligence (SAP MII) to con gure system-wide
settings and monitor your system.

Features
System Management consists of the following:

System Properties

System Jobs

Transaction Manager

Log Viewer

Scheduler

Active Sessions

Custom Attributes

Custom Attribute Mapping

Con gurations

Projects

Localization

Content Usage

System Properties
Use
You use the System Properties screen to set system property values.

Features
SAP Manufacturing Integration and Intelligence (SAP MII) system properties are described in the following table:

Screen Name Property Name Description

Name Name Base system con guration

Description Description System con guration

This is custom documentation. For more information, please visit the SAP Help Portal 3
4/11/2019
Language Language Default system language

Logon accounts have a language setting


that overrides the system setting.

Monitoring Retention Duration MonitoringRetentionDuration Frequency in seconds in which the


message monitor runs

The monitor processes items received


from the message listeners.

Message Cleanup Interval RunInterval How often message cleanup rules run

If you enter 2, the rules run every two


hours.

Session Timeout SessionTimeOut Amount of time in minutes that the system


takes to automatically close inactive
sessions

Transaction Cache Duration TransactionCacheDuration How many hours a transaction is included


in the system cache

Binary Size Limit BinarySizeLimit Maximum number of kilobytes that can be


posted to a transaction

Retention Time for Usage Statistics ExpireUsageStatistics Number of days to keep content usage
statistics

All data older than the speci ed number of


days is deleted.

Transaction Persistence Lifetime TransactionPersistenceLifetime Amount of time in hours to keep data in the
transaction manager

Expression Cache Duration ExpressionCacheDuration Amount of time in hours each expression is


cached

To improve system performance, cache


parsed expressions.

Job History Cleanup JobHistoryCleanup Amount of time in hours to keep the history
of a job.

Plant Information Catalog Logs PICLogsCleanUp How often Plant Information Catalog Logs
Cleanup Interval [Min] cleanup Job runs. This will clear all the
logs crated for any action in plant
information maintenance

MDO Batch Processing MDOBatchProcessingFlag If this checkbox is selected, the


manufacturing data object (MDO) queries
the connection from the data source and to
see if it supports batch processing. If it is
supported, batch processing is used for
the replace and update tasks and on-
demand processing. If the checkbox is not
selected, batch processing is not used.

Default Transaction Persistence DefaultTransactionPersistence The following options determine when the
system writes transaction information to
the database:

Always

On Error

Never

This is custom documentation. For more information, please visit the SAP Help Portal 4
4/11/2019

Run Transaction Check RunTransactionExpirationCheck Enable the transaction expiration check on


startup

NetWeaver DataSource Caching NetWeaverDataSourceCaching Enables the caching of data source created
in Netweaver
c

Usage Statistics Monitoring UsageStatisticsMonitoring Enables the monitoring of transactions and


query usage when value is set to true

Transaction Caching TransactionCaching Enables the caching of transactions to


improve the system performance

Template Caching templatecaching Enables the caching of templates for faster


execution

FTP File Transfer Time Out {Min] FTPFileTransfereTimeOut Integer eld which de nes the loss of
connectivity timeout for FTP action blocks.
If connectivity is lost during le transfer,
the FTP action will fail after this value is
exceeded.

Max Row Count maxrowcount De nes the query limit of 1,20,000 rows

Encode SOAP Response encodesoapresponse Enable encoding for the SOAP response

Temporary File Cache Duration TemporaryFileCacheDuration Number of hours a temporary le is


included in system cache

Workbench Memory WorkbenchMemory Maximum heap size of client JVM where


SAP MII Workbench application is running

Force Scheduler Start ForceSchedulerStart Used to track the scheduler status. Select
this checkbox to force the scheduler to
start SAP MII.

Proxy User Name ProxyUserName User name for authentication

Proxy User Password ProxyUserPassword Password for authentication

The password value is encoded.

Resolve Machine Name ResolveMachineName Enhances the logging information

If you select the checkbox, the system


nds the source machine name through the
con gured machine's domain name
system for each request to the server. If
you deselect the checkbox, the system
records the IP address of the request
machine.

WSDLGen Security Enabled WSDLGenSecurityEnabled If the checkbox is selected, the system


requires you to log on before you can
access the WSDLGen servlet. If the
checkbox is not selected, any user can call
the servlet to generate WSDL for a
transaction; however, you must still have
permission to run the transaction.

Register in System Landscape RegisterInSystemLandscapeDirectory If selected, the SAP MII instance is


Directory registered in the system landscape
directory (SLD).

MDO Batch Processing MDODataSource SAP NetWeaver JDBC data source used for

This is custom documentation. For more information, please visit the SAP Help Portal 5
4/11/2019
MDO tables

Default File Path DefaultFilePath The path on the le system (along with the
subfolders) used to store les that need to
be accessed by the following workbench
actions for read/write operations:

File I/O

CreateDirectory

CreateZipArchive

DeleteFile

GetFileList

WriteFile

FTPInput

FTPOutput

ADS Printing

E-Mail

Send Mail

Read Mail

Logging

XML Tracer

Web

HTMLSaver

XMLSaver

TextSaver

ImageSaver

HTMLLoader

XMLLoader

TextLoader

ImageLoader

 Note
Access to the les under the
previous path (and the
subfolders) will be lost if the
path is changed.

If the path is empty, you can


access the le system,
provided the le system
provides read/write
permissions. The same holds
good for prior releases.

If the drive letter is not


determined by the path, then
the drive you are using to run

This is custom documentation. For more information, please visit the SAP Help Portal 6
4/11/2019
the application from
(Netweaver directory) is used.
For example, if you have MII
de ned for the default le path,
and your Netweaver installation
is on the D drive, it will be
D:\MII. You can also specify a
drive letter in the default le
patht.

Use Certi ed HTTPS Connection for SecureADSConnectionEnabled Allows to use certi ed HTTPS connection
ADS to connect to ADS server. For more
information, see SAP Manufacturing
Integration and Intelligence 15.0
Con guration Guide.

Allow Cross Origin Resource Sharing CrossOriginResourceSharing Allows scripts to request to a domain other
than the hosted domain. In other words, a
browser based application sends a
request to a server residing in a different
domain. A valid Cross Origin Resource
Sharing request contains a header called
domain which is automatically added by
the browser.

Cross Origin Resource Sharing is


supported in the following browsers:

Chrome 3+

Firefox 3.5+

Opera 12+

Safari 4+

Internet Explorer 8+

Allowed Hosts AllowedHosts Hosts that are allowed to make Cross


Origin Resource Sharing requests. * allows
all hosts to make these requests

Allow Credentials AllowCredentials Enables MII server to add Access-


Control-Allow-Credentials to the
response.

Expose Headers ExposeHeaders Comma separated list of headers that is


allowed by MII server.

Allow Methods AllowMethods Comma separated list of http methods


allowed for Cross Origin Resource Sharing.

Allow Headers AllowHeaders Allows headers containing response to


pre ight request having Access-Control-
Request-Headers

Maximum Age MaximumAge Time in seconds for which the pre ight
response can be cached.

Use Decimal Formatting UseDecimalFormatting When enabled, all the oating and real data
types in the query template will be
rounded off to the 12th decimal place.

Parse Floating Point Numbers as ParseFloatsAsDouble This will convert oating values to double

This is custom documentation. For more information, please visit the SAP Help Portal 7
4/11/2019
Decimals and parse the same. Default value is
disabled. This eld is ignored if Use
Decimal Formatting is not selected.

Role Caching RoleCaching Select this checkbox to cache the details


of UME roles.

Attribute Caching AttributeCaching Select this checkbox to cache the custom


attributes when SAP MII requests to UME
and database.

Transaction Shutdown Mode TransactionShutdownMode When you try to shut down MII application,
a lot of transactions may be in progress.
You can choose one of the following option:

Continue: Default behavior where


MII transactions will continue to run
regardless of shutdown.

Wait Forever: Shutdown will be


postponed until all the running
transactions are stopped.

Wait Until Max Wait Time, then


terminate: MII application will wait
until the maximum time is reached
or until all running transactions are
stopped. If the maximum time is
reached, then the system sends
termination requests to all the
running transactions.

Terminate, then Wait Until


Complete: MII will send terminate
requests to all running
transactions, and then wait until
the maximum time is reached
before continuing the shutdown
process. •

Terminate Immediately: MII sends


terminate requests to all running
transactions, and then
simultaneously continue with the
shutdown process.

Maximum Wait Time for Transactions MaxWaitTimeForTrx De ne wait time in seconds. MII
before Shutdown [Sec.] application will wait until the maximum
time is reached. If the maximum time is
reached, then the system sends
termination requests to all the running
transactions

Wait for Data Server Startup WaitForDataServerStartup When selected, MII will wait for all the data
servers to startup before running any
scheduled jobs or completing MII startup.
This will reduce the time required for MII to
start. This will ensure continous operation
in the event of a server node shutdown or
restart, if there are many data servers
con gured.

Force Content Blowout on Startup ForceContentBlowout If True, SAP MII publishes the web content
to SAP Netweaver le system. You must
This is custom documentation. For more information, please visit the SAP Help Portal 8
4/11/2019
call the Blowout mode of the Catalog
servlet to publish MII content manually. You
can call with no request parameters to
publish all content, or you can speci y
Folder=<folder> to publish just a particular
folder or project

Protocol Encoding ProtocolEncoding When Enabled, queries containing columns


with special characters such as ( and ) are
encoded.

 Note
This is valid from SAP MII 14.0 SP07
release

Generate Change List GenerateChangeList If true, the system creates a change list for
the logged in user when a tag or group is
created in the Plant Information
Maintenance screen. The generated
change list contains the user id name and
description

If false, when a tag or group is created in


the Plant Information Maintenance
screen, the system prompts a dialog box
to create a change list for the logged in
user. You must enter a name and
description for the change list.

 Note
Change list will not be created if there
are existing change lists associated
with the logged in user.

Use Transaction Threading TrxUseThreading Con gures the transaction engine to use
the new threading model

Basic Threading TrxBasicThreading Uses a simple cached thread pool, cannot


be con gured further

Trx Engine Core Threads TrxCoreThreads Sets the amount of core threads for the
transaction threading pool

Trx Engine Max Threads TrxMaxThreads Sets the amount of maximum allowed
threads for the transaction threading pool

Trx Engine Keepalive TrxKeepAliveInMin Sets the amount of time a thread is kept
alive while inactive before destroying the
thread

Trx Engine Direct Handoff Flag TrxDirectHandoff Determines if the threading pool uses a
blocking queue or performs a direct
handoff to the thread pool

Trx Engine Blocking Queue Size TrxBlockingQueueSize Determines the size of the blocking queue.
Not used if the direct handoff ag is
enabled

Action Threading Con gures the transaction engine to use


threading for action

This is custom documentation. For more information, please visit the SAP Help Portal 9
4/11/2019

Activities
To view and change system property values, on the SAP MII administration menu, choose System Management System
Properties .

System Jobs
Use
You use the System Jobs screen to view a list of default SAP Manufacturing Integration and Intelligence (SAP MII) system
maintenance tasks, which are run in the background at a system-de ned frequency.

Features
The job frequency is a hard-coded value and cannot be changed. Times are based on the time SAP MII was last started.

The following table lists the default system jobs:

Job Name Description

ActivationRequestCleaner Removes activation requests that are older than seven days Runs
daily

DataBufferJobScanner Processes items in the data buffer queue Runs every minute

CatalogOldDeleteLogs Delete the old tag catalog logs

CatalogScanInactiveTags Checks for inactive tags in the plant historian systems

IndexingCleaner Removes obsolete le references from the index Runs daily

JCOConnectionMonitor Cleans the JCo connections for which the timeout value was
reached

JobHistoryCleaner Removes expired entries from the job history table Runs every 30
minutes

MDO Data Source Watcher Monitors the use of Manufacturing Data Object (MDO) data sources
When the MDO data source is down, this job runs once a minute to
check the status of the data source. When the data source is active
again, this job is disabled. When the job is running, all MDO
actions, such as queries, inserts, deletes, and so on, are returned
as errors.

MDO Log Cleanup Removes MDO log entries that are older than seven days

MonitorDataCleaner Monitors data in the message.Cleanup le

SecurityObjectReferenceCleaner Removes obsolete references to users and roles Runs weekly

SessionLogger Logs session information Runs every 30 minutes

Shared Property Cleanup Removes expired properties Runs every minute

TempFileCleaner Cleans the Temp le table Runs every 60 minutes

TransactionCacheCleaner Removes in-memory transactions Runs every 5 minutes

TransactionImageCleaner Removes transaction images from the database Runs every 5


minutes

This is custom documentation. For more information, please visit the SAP Help Portal 10
4/11/2019
ValueMapCacheCleaner Removes value map rules that were not used in the last 24 hours
Runs daily

SQLConnectionTimeoutMonitor Removes the connections that were timed out. The Timeout setting
is con gured in the SQL Transaction Begin action block

AlertExpirationJob Checks for expired alerts

For detailed frequency and runtime information, see the System Jobs screen.

Activities
To view the list of system jobs, on the SAP MII administration menu, choose System Management System Jobs .

Transaction Manager
Use
You use the Transaction Manager screen to see a summary of pending and processed transactions.

Features
The Transaction Manager screen includes the following information for each transaction:

Status

One of the following states of the transaction:

Pending

The transaction instance is not running yet. Applies to asynchronous mode only.

Running

The transaction instance is running.

Successful

The transaction instance completed successfully.

Failed

The transaction instance completed with an error.

Terminated

The transaction instance was terminated by a user.

Break

The transaction paused at a user-de ned breakpoint.

Debugging

The transaction is running in debug mode.

Debug was successful

The transaction ran in debug mode and completed successfully.

This is custom documentation. For more information, please visit the SAP Help Portal 11
4/11/2019
Debug was terminated

The transaction ran in debug mode and was terminated by a user.

Debug Abandoned

The transaction ran in debug mode and hit a breakpoint but completed because the user waited too long to
continue the session.

Exception

The transaction is processing in the exception state.

ID

A numeric identi er, which is assigned by the system, for the transaction

Name

The name given to the transaction

Runtime Mode

Synchronous or Asynchronous

Start Time

The time the transaction started running.

End Time

The time the transaction stopped running.

Server

The server on which the transaction is running.

User

The name of the user who ran the transaction.

Managed Thread Name

Displays the managed thread name. Managed means the top level thread that is managed by one of the SAP NetWeaver
thread pools. This is typically a Managed Application Thread (for transactions executed via scheduler or asynchronously),
or an HTTP Worker thread (for transactions executed via the Runner, SOAPRunner, or Illuminator). If the transaction is
executed via another transaction, the parent transaction's thread shows here.

Transaction Thread Name

Displays the thread name the transaction is running on.

Action Thread Name

Displays a sub-thread name for some action types. Sub-threads from JCO, JRA, and HTTP Post action blocks are shown
here.

Activities
To use the Transaction Manager, on the SAP MII administration menu, choose System Management Transaction Manager.

See also:

Using the Transaction Manager


This is custom documentation. For more information, please visit the SAP Help Portal 12
4/11/2019

Using the Transaction Manager


To view a table of pending or processed transactions, do the following:

1. On the SAP MII administration menu, choose System Management Transaction Manager.

2. To search the table, use the top row of UI components to limit the initial search. You can limit the search by Status, a
Duration, or use a wildcard Name search. You can also limit the maximum row count of the returned data. The default
maximum row count is 4000. Use Search button to execute the search.

3. To lter the table, do the following:

a. Enter a value in the Name, Start Time, End Time, or User elds, or select a status from the dropdown.

b. Click Filter.

The table refreshes to show only those transactions that satisfy the lter.

c. To remove the lter settings, click Clear Filter.

The system removes the lter settings and refreshes the table.

4. To view the details of a transaction, click the icon next to the transaction's ID.

The Transaction Details screen appears.

5. To delete transactions from the table, do the following:

a. Select the checkbox next to the transactions you want to delete from the table.

b. Click Delete.

The system removes the transactions from the Transaction Manager screen, but the transaction records still exist in the
system.

6. To terminate a transaction, select a transaction with the RUNNING status, and click the Terminate button. SAP MII rst
signals the transaction to stop. If the transaction does not stop immediately, an additional interrupt is sent to the
transaction thread to stop the transaction from running.

7. To terminate all running transactions, use the Terminate All button. This will terminate all running transactions, you do
not need to select any transactions for this.

See also:

Transaction Manager

Log Viewer
Use
You can use the Log Viewer screen in SAP Manufacturing Integration and Intelligence (SAP MII) to display the SAP NetWeaver
Log Viewer. It shows the records from the last 24 hours.

For more information, see the SAP NetWeaver application help on the SAP Help Portal at http://help.sap.com.

Activities

This is custom documentation. For more information, please visit the SAP Help Portal 13
4/11/2019
To view the log data, on the SAP MII administration menu, choose System Management Log Viewer.

Scheduler
Use
You use the SAP Manufacturing Integration and Intelligence (SAP MII) Scheduler to do the following:

Set up scheduled jobs to collect data for various objects, for example, queries, production events.

View a summary of scheduled jobs

For more information, see Working with Scheduled Jobs.

Note
In a clustered environment, if the SAP NetWeaver node running a scheduler goes down, then another node would start
running the scheduler automatically.

Features
The Scheduler screen displays the following columns in the Scheduler Jobs table:

ID

An identi cation number, which the system assigns to the job

Name

The name for the job, which you enter upon creation

Next Run Time

The next day and time the job is scheduled to be run, based on the job's pattern

File

Path for the le associated with the job

Description

A description of the job

Job Type

The type of job, such as Transaction, MDO, Query, or PIC

Status

Stopped

Jobs that are not enabled have a status of Stopped.

Disabled

Pending

The scheduler processes all jobs with a status of Pending that have reached their next runtime.

Running

This is custom documentation. For more information, please visit the SAP Help Portal 14
4/11/2019
If a job is currently running, its status is Running, and it is not processed again until its previous run has
completed.

In the Details section, you can maintain the following data for each job:

Name

Description

Enabled

User Name

Password

Pattern

For more information, see Cron Pattern.

Depending on the job type, one of the following tab pages is active. Each tab includes additional data for the particular job type:

Transaction Scheduler

Transaction

Persist Transaction

The following options determine when the system writes to the database:

Always

On Error

Never

Log Level

You select one of the following debugging levels:

Unknown

None

Debug

Info

Warn

Error

Fatal

Parameters

Query Scheduler

Query

Parameters

MDO Scheduler

MDO

This is custom documentation. For more information, please visit the SAP Help Portal 15
4/11/2019
Mode

Input tab

Post Execution tab

KPI Scheduler

Virtual Tag Scheduler

For more information, see Create Scheduled Jobs for a Virtual Tag

PIC Scheduler

For more information, see Sync of PIC with Plant Maintenance Hierarchy

Production Event Scheduler

Activities
To create, edit, and view scheduled jobs, on the SAP MII administration menu, you can choose System Management Scheduler.

To view the history of a selected scheduled job, including status and duration, you can choose the History tab page.

To view the next 20 planned run times for a selected job, you can choose the Execution Schedule tab page.

Working with Scheduled Jobs


Use
You use this procedure to manage jobs on the Scheduler screen.

For more information about the Scheduler screen and its features, see Scheduler.

Procedure
To create a scheduled job, do the following:

1. On the SAP MII administration menu, choose System Management Scheduler .

2. Click Create.

3. Enter a name for the scheduled job.

4. Select the type of job you want to create and click OK.

The appropriate tab page (For example, Transaction Scheduler, Query Scheduler, or MDO Scheduler) becomes active.

5. Enter the required data and click Save.

If you want to start the scheduled job right away, be sure to select the Enabled checkbox; otherwise come back later and
edit the scheduled job to enable it.

To edit a scheduled job, do the following:

1. On the SAP MII administration menu, choose System Management Scheduler .

2. In the table, select the job you want to edit, and click Edit.

This is custom documentation. For more information, please visit the SAP Help Portal 16
4/11/2019
3. In the Details section, edit the data and click Save.

To delete a scheduled job, do the following:

1. On the SAP MII administration menu, choose System Management Scheduler .

2. In the table, select the job you want to delete, and click Delete.

3. On the con rmation dialog box, click Yes.

Cron Pattern
De nition
A date and time format that determines when to run a scheduled job.

Structure
The cron pattern consists of six elds separated by spaces. The format is [second] [minute] [hour] [day of month] [month]
[day of week].

You can choose a pattern using the Select Pattern screen. For more information, see Selecting a Pattern. Or, you can manually
enter the pattern in the Pattern eld.

The allowed values for the cron pattern elds are described in the following table:

Field Allowed Values

Second 0-59

Minute 0-59

Hour 0-23

Day of month 1-31

Month 0-11 (0 = January)

Day of week 1-7 (1 = Sunday)

To con gure each eld, you use one of the following options:

An asterisk to run every instance of the value of the eld

It is equivalent to the range [ rst-last]. For example, an asterisk in the Month eld runs the job every month.

A range

The speci ed range is inclusive. For example, to specify a runtime between the hours of 8:00 and 11:00, the range of the
Hour eld would be [8-11], which is equivalent to [8,9,10,11].

A set of numbers or ranges separated by commas

For example, if you enter [1,8-12,15] in the Day of month eld, the job runs on the rst, eighth, ninth, tenth, eleventh,
twelfth, and fteenth days of the month.

A step, used with ranges

This is custom documentation. For more information, please visit the SAP Help Portal 17
4/11/2019

Enter / after a range to specify which values to use in the range. For example, [0-23/2] can be used in the Hour eld to
specify that a job runs every other hour. This is equivalent to specifying [0,2,4,6,8,10,12,14,16,18,20,22] in the Hour eld.
Steps are permitted after an asterisk, so if you want to run the job every two hours, you use [*/2].

Example
Examples of cron patterns are described in the following table:

Pattern Description

****** Runs the job every second. None of the elds are restricted.

*/5 * * * * * Runs every ve seconds, starting at second zero (that is, seconds
0,5,10,15,20,25,30,35,40,45,50,55)

0***** Runs every minute, on the rst second of the minute

00**** Runs every hour, on the rst second of the minute and the rst
minute of the hour

0 0 */4 * * * Runs every four hours, starting with hour zero (that is, hours
0,4,8,12,16,20) on the rst second of the minute and the rst
minute of the hour

00 30 11 * * * Runs every day at 11:30:00 AM

00 30 11 * * 2-6 Runs every weekday (Monday through Friday) at 11:30:00 AM. It


does not run on Saturday or Sunday.

00 30 11 1 0,6 * Runs at 11:30:00 AM on the rst of January and rst of July

00 30 11 1 0 2 Runs at 11:30:00 AM on the rst of January if it is Monday. It is


uncommon to specify both a [Day of Month] and a [Day of Week],
but it is allowed. This job runs every few years since the rst of
January is not always a Monday.

Selecting a Pattern
Use
You can use the Select Pattern screen to create a cron pattern for your scheduled job. For more information about scheduled
jobs, see Scheduler.

Note
If you already entered a pattern in the Pattern eld and do not want to overwrite it, click Cancel on the Select Pattern
screen.

Procedure
When you are creating or editing a scheduled job, you can select a pattern by doing the following:

1. Click the ... button next to the Pattern eld.

The Select Pattern screen appears.

2. If you want to set the pattern in seconds, do the following:


This is custom documentation. For more information, please visit the SAP Help Portal 18
4/11/2019
a. Select the Seconds tab page.

b. Under the Run Job heading, select whether you want to run the job every hour or every hour within a range of
hours.

c. To set how often you want to run the job, select a value for the Every x Second eld.

d. Select the checkboxes next to the days you want to run the job.

e. Click OK.

3. If you want to set the pattern in minutes, do the following:

a. Select the Hourly tab page.

b. Under the Run Job heading, select whether you want to run the job every hour, every few hours, or every hour
within a range of hours.

c. To set how often you want to run the job, select the appropriate radio button in the Run Within the Hour section
and select the appropriate minute values.

d. Select the checkboxes next to the days you want to run the job.

e. Click OK.

4. If you want to set a daily pattern, do the following:

a. Select the Daily tab page.

b. In the Run Job At eld, enter the time of day (HH:mm:ss) you want to run the job.

c. To set how many days a week you want to run the job, select the appropriate radio button.

If you select On Selected Days, select the days of the week you want to run the job.

d. Click OK.

5. If you want to set a monthly pattern, do the following:

a. Select the Monthly tab page.

b. In the Run Job At eld, enter the time of day you want to run the job.

c. In the Run On section, select a speci c date in the month or choose a pattern from the dropdowns next to the
second radio button.

d. Select the checkboxes next to the months you want to run the job.

e. Click OK.

Sync of PIC with Plant Maintenance


Hierarchy
Context
Plant Information Catalog (PIC) can be synced with the changes made in the plant maintenance (PM) hierarchy in SAP ERP
using a scheduled job. The sync can be performed with an SAP ERP system of type Plant Maintenance.

Procedure

This is custom documentation. For more information, please visit the SAP Help Portal 19
4/11/2019
1. Con gure a scheduler of type PIC:

a. Create a new scheduler from System Properties Scheduler Create

b. Select the scheduler type as PIC.

c. Enter the scheduler details.

d. Choose the node from PIC for which you want to schedule sync with PM hierarchy.

The node should be:

A group node

The group node should be mapped to a node in SAP ERP

e. Select a mode as per your requirement.

PIC scheduler can run in two modes:

Mode Details

Update In this mode, SAP MII syncs the changes made in the
values of the PM hierarchy nodes mapped to the nodes in
PIC hierarchy.

Modify In this mode, SAP MII syncs both – updates made in values
of the PM hierarchy nodes and any structural changes
 Note made to the hierarchy. For example, node deletion or node
addition in a hierarchy.
Ensure that when syncing in the Modify mode, the PIC
nodes were added using Add with Children option. If the Maintenance Plant property is changed in SAP ERP,
then the corresponding Maintenance Plant node and its
children are marked for deletion in PIM.

2. After the scheduler run, you can see the nodes that are changed under Category Services Plant Information
Maintenance

Status of the nodes is displayed in the Operationcolumn:

Nodes with changes show Edit

Nodes that were added show New

Nodes that no longer exist in SAP ERP show Marked for Deletion

Other users see the status of the node as Locked by the user running the scheduled job.

3. On the History tab in the details view of the scheduler you can see the number of nodes that are new (New Nodes),
edited (Edited Nodes), or deleted (Marked for Delete Nodes) in every run.

In scenarios where changes are still in the approval work ow:

If the user who ran the scheduler earlier runs it again in modify mode, then the deleted nodes appear as Locked
Nodes.

If a different user runs the scheduler in modify mode, then all new, edited, and deleted nodes appear as Locked
Nodes.

4. You can update the PIC with the changes using the approval work ow.

Next Steps
Scheduler

This is custom documentation. For more information, please visit the SAP Help Portal 20
4/11/2019

Create Scheduled Jobs for a Virtual Tag


Context
To collect data for a virtual tag, you must create scheduled jobs.

There are two modes of scheduled jobs for virtual tags:

Mode Description

History The job runs only once and retrieves data within a speci ed period of time.

The execution time of the job must be the same or later than the current system time. However, the start
time and the end time can be in the past or in the future.

If the start time is later than the current system time and you don't specify an end time, the system sets
the end time to the current system time when you save the job.

If the end time is later than the execution time, the job still runs only once at the execution time.
Therefore, the data retrieved will be between the start time and the execution time instead of between the
start time and the end time.

Current The job runs at regular intervals but does not retrieve data that is older than the rst execution.

Procedure
1. From the SAP MII administration menu, choose System Management Scheduler .

The SAP MII: Scheduler screen appears.

2. Create a job:

a. Choose Create.

The Create Scheduler screen appears.

b. Enter a name for the new job and specify the scheduler type as Virtual Tag.

c. If you want to create a job in the History mode, select the Run Historical Data checkbox.

If you want to create a job in the Current mode, keep this checkbox unselected.

d. Choose OK.

3. De ne the job details:

a. Select a virtual tag.

b. If the mode is History, specify the execution time, start time, and end time.

If the mode is Current, de ne the pattern that determines the execution schedule.

c. If required, de ne other details such as the description.

d. To start the job, select the Enabled checkbox.

4. To save the job, choose Save.

Results
You can now proceed to create a PIC Analysis query so that you can view the energy consumption report for this virtual tag.

This is custom documentation. For more information, please visit the SAP Help Portal 21
4/11/2019

Next Steps
Scheduler

Virtual Tags

Create a Virtual Tag

PIC Analysis Query Details

Active Sessions
Use
You use the Active Sessions screen to view a list of users that are logged on to SAP Manufacturing Integration and Intelligence
(SAP MII).

Prerequisites
You are assigned to the administrator role. For more information, see User Management.

Features
The Action Sessions screen displays the following data for each user:

Logon name

Full logon name

E-mail address

Date and time of initial logon

Date and time when the system was last accessed

Date and time when the session expires

Activities
To view the list of users that are logged on to the system, on the SAP MII administration menu, choose System Management
Active Sessions .

Custom Attributes
Use
You use this function to create custom attributes for existing users and roles.

Integration
After you create a custom attribute, you must map the attribute to the appropriate user or role. For more information, see
Custom Attribute Mapping.

This is custom documentation. For more information, please visit the SAP Help Portal 22
4/11/2019

Features
The elds on the Custom Attributes screen are described in the following table:

Field Use

Name The name given to the attribute.

Description A description of the attribute.

Required If this indicator is selected, the custom attribute is automatically


mapped to all users and roles and the attribute's default value is
used. You can manually map the attribute to a user or role and
overwrite the default value.

Type The type of eld, such as text or date, that appears on the users or
roles screen.

Field Size If the custom attribute type is Text, the eld size value is the
maximum number of characters allowed in the text eld.

Validation If the custom attribute type is Text, you can choose to allow only
numeric or alphanumeric characters in the text eld.

Values If the custom attribute type is date, list, or radio button, you can
enter the date format or options for the list or radio buttons.

Use a vertical bar to delimit your list of options. For example, enter
A|B|C to label your radio buttons A, B, and C.

Default Value The value that defaults for the custom attribute. For more
information, see Required. The Validation setting applies to the
default value.

To see a list of users and roles mapped to the selected custom attribute, choose the Usage tab.

Activities
To create custom attributes, on the SAP MII administration menu, choose System Management Custom Attributes.

Custom Attribute Mapping


Prerequisites
You have created custom attributes.

Procedure
1. On the SAP MII administration menu, choose System Management Custom Attribute Mapping.

2. On the Users or Roles tab page, select the user or role to which you want to map a custom attribute.

3. If you are mapping a custom attribute to a role, select a priority for the role.

The system applies the attributes of the role with the lowest priority (0) last. If you are assigned to two roles with the
same attribute, the attribute value from the role with the lower priority is used.

4. Select the attribute and click Add.

The custom attribute is added to the table.


This is custom documentation. For more information, please visit the SAP Help Portal 23
4/11/2019
5. Enter a value.

If a default value appears, you overwrite it.

6. To delete a custom attribute from the table, click the attribute row to select it and click Delete.

7. Click Save.

Example
You create the custom attribute Color, select it as required, and enter a default value of Green.

You map the attribute to one of the following roles:

Role1

You select a priority of 1 and enter a value of Blue.

Role2

You select a priority of 10 and enter a value of Red.

A user who is not assigned to Role1 or Role2 logs on to the system. The Color attribute value for this user is Green.

A user assigned to Role2 logs on to the system. The Color attribute value for the role overrides the default value, so this
user's value is Red.

A user assigned to Role1 and Role2 logs on to the system. The Color attribute value for the roles overrides the default value,
and Role1 has a lower priority than Role2, so this user's value is Blue.

Con gurations
Use
You use the Con gurations screen to do the following:

Import and export SAP Manufacturing Integration and Intelligence (SAP MII) con guration les. The les exported are
XML les containing data about the various con gurations done for different functions in SAP MII.

Transport your con gurations from SAP MII system to another system using Enhanced Change and Transport System
(CTS+).

Prerequisites
You have been assigned appropriate permissions in the SAP User Management Engine in SAP ERP.

You have created a le called xmiibackup.zip, stored the exported con gurations in it, and saved it in the location of
your choice. This is a prerequisite to import con gurations from the le system.

Features
Export Tab

The xmiibackup.zip le may include the following les:

This is custom documentation. For more information, please visit the SAP Help Portal 24
4/11/2019

Note
If you use CTS+ transport, the le is an sda le. It can contain the same les as the mentioned zip.

Con guration Associated File

Global Globals.xml

System Properties SystemProperties.xml

Link Objects ContentMap.xml

Time Periods TimePeriods.xml

Time Period Schedules Schedules.xml

Navigation Each user and role navigation is written to its own .xml le in the
Profiles folder in the xmiibackup.zip archive.

Unit Conversions UnitConversions.xml

Custom Attributes CustomAttributes.xml

NWDI Properties NWDIProperties.xml

Message Listeners MessageServers.xml

Quality Portal Suppressed Points QPSuppressedPoints.xml

Simulator Editor Each simulator is written to its own .xml le in the


Simulator_Files folder in the xmiibackup.zip archive.

Localization Each language is written to its own .xml le in the


Localization folder in the xmiibackup.zip archive. For more
information, see the explanation below this table.

Credential Store CredentialStore.xml

Connection Store ConnectionStore.xml

Message Listener Rules MessageProcessRules.xml

Message Listener Cleanup Rules MessageCleanupRules.xml

Data Servers Servers.xml

Data Server Permissions ServerPermissions.xml

Client Properties ClientProperties.xml

Quality Portal Comments QPComments.xml

Scheduled Jobs Jobs.xml

Plant Information Catalog The folder Plant Catalog contains the following xml les:

Catalog.xml

Propertysets.xml

Categories.xml

Alert Cleanup Rules AlertCleanupRules.xml

KPI Monitor kpimonitor.xml

This is custom documentation. For more information, please visit the SAP Help Portal 25
4/11/2019

Con guration Associated File

Production Events ProductionEvent.xml

Shift Patterns ShiftPattern.xml

Tariffs Tariff.xml

Recommendation
You should store exported con gurations in a secure location since con gurations can contain sensitive information.

An exported le may also include a [language abbreviation].xml le. If user localization terms exist, a related locale
XML le appears in the xmiibackup.zip le. For example, en.xml appears for English and de.xml appears for German.

Import Tab

After exporting the con guration les, the les must be imported for different MII instances. In other words, you have to trigger
the import of these exported les from the CTS+. You can access the import system queue and release the request from the
CTS+. This action triggers the import and deployment of the transport request to the import system. The import function in the
SAP MII systems does not need any action from your side. The SAP CTS ABAP system performs the import action.

You can import con gurations from a le system too, for example from your desktop. The le are available as backup.zip les.

Export Con gurations

Using File System

1. On the SAP MII: Con gurations screen, choose the con gurations.

Note
There are dependencies between some con gurations. If the dependencies are not met in target systems, the import
of the con gurations fails.

The shift pattern con gurations require the existence of related time period schedules in target systems.

The tariff con gurations require the existence of related categories in target systems.

2. Enter any secure code in the Passphrase eld.

3. Choose Export.

The File Download dialog box appears.

4. Save xmiibackup.zip to the location of your choice.

Using CTS+

1. In the SAP MII: Con gurations screen, on the Export tab, select the con guration les.

2. Choose CTS+ in the Export Method eld.

3. Enter brief descriptive text in the Description eld..

4. Choose Export.

This is custom documentation. For more information, please visit the SAP Help Portal 26
4/11/2019
The selected con guration les are exported to CTS+.

Projects
Use
You use the Projects screen to import and export SAP Manufacturing Integration and Intelligence (SAP MII) projects and de ne
certain project settings. You can export a project using Enhanced Change and Transport System (CTS+) or le system from SAP
MII system to other systems. For more information, see Enhanced Change and Transport System (CTS+).

Note
Deployed projects cannot be exported.

Features
When you create or import a project, the system creates the ProjectInfo.xml le in the SAP MII Workbench on the Meta-Inf
tab under <Project>/META-INF. In the editor for this le, you can do the following:

View default project attributes

Change the project description

If you are assigned the XMII_ProjectManagement action, you can add, delete, or change custom attributes. For more
information about actions, see Actions for Permissions.

When you export a project to the le system, the exported zip le contains the les and project structure as con gured in the
SAP MII Workbench.

When you use CTS+ to transport projects from one system to another, the exported project le is an sda le. The sda le
contains the same structure as the zip le.

An ExportManifest.xml le is also included and contains the following data:

User who exported the project

Hidden project setting

Creation date of the project

User who created the project

Project description

Project name

System project setting

Date and time of the export

SAP MII version from which the project was exported

If you import a project that already exists, the system overwrites the current project structure and les.

You import hidden projects that do not appear on the Projects screen or in the SAP MII Workbench. System-de ned projects
may appear in the Projects screen and in the SAP MII Workbench, but you cannot delete them. You import a project with the

This is custom documentation. For more information, please visit the SAP Help Portal 27
4/11/2019
same name as a hidden or system-de ned project and overwrite its properties. If you do this, they are not considered to be
hidden or system-de ned projects.

You create an external project structure, include it in a zip le, and import it as a new project. You do not need an
ExportManifest.xml le to import a project.

By default, all projects are visible to all users. Using Security tab, you can add a role to a project and only the assigned roles can
access the project. You can assign, remove, or edit the roles to the created projects. These projects can be viewed in
Workbench, Services, and Self Service Composition Environment.

Caution
Authorization to roles in Security tab is available from MII 15.0 SP02 release.

Activities
To import or export projects, on the SAP MII menu, choose System Management Projects . You click the icons at the end of the
row to export or delete listed projects.

If you want to track project statistics, select the Usage Monitoring checkbox. For more information, see Content Usage.

Enhanced Change and Transport System


(CTS+)
Use
Enhanced Change and Transport System (CTS+) is a tool to execute and monitor the transports from the SAP MII system to
different systems. CTS+ is an extension of the existing Change and Transport System (CTS). You use this tool to organize,
monitor and transport changes between SAP systems in your system landscape. You must create objects on the development
system and attach them to a transport request that is distributed across your landscape using CTS+.

You can export con gurations and projects from the SAP MII system to any CTS+ system:

Select the con guration les from System Management Con gurations screen.

Select the project les from System Management Projects screen.

For more information on Change and Transport System (CTS), see SAP help portal at http://help.sap.com Application
Lifecycle Management CTS Plug-In CTS Plug-In 1.0. Change and Transport System - Overview (BC-CTS) .

This document gives you basic information on setting up the CTS+ system on an SAP MII system and on choosing transport
strategy.

Integration
CTS ABAP system must be con gured and available at the customer landscape.

Prerequisites
You have registered CTS+ as an RFC destination in SAP NetWeaver server. For more information, see Registering Enhanced
Change and Transport System (CTS+).

This is custom documentation. For more information, please visit the SAP Help Portal 28
4/11/2019

Features
The CTS+ is used to manage the transports between development, test and productive systems. A representation must be
created for each system of the application landscape. Transport routes are used to connect these systems in CTS+.

The following gure shows how CTS+ works with Java export and import systems:

Enhanced Change and Transport System (CTS+)

The Java export system gets the transport request from the CTS+ and attaches the objects to be exported. It then releases the
transport request which is routed from the export system queue to the import system queue.

To import the transport request, you must release the request from the CTS+. This triggers the import and deployment of the
transport request to the import system. No action is required from the SAP MII system for import.

Note
You cannot change recording for ABAP objects using the CTS+ tool.

Activities
To export the con guration les, do the following:

1. In the SAP MII: Con gurations screen, on the Export tab, select the con guration les.

This is custom documentation. For more information, please visit the SAP Help Portal 29
4/11/2019
2. Choose CTS+ in the Export Method eld.

3. Enter brief descriptive text in the Description eld..

4. Choose Export.

The selected con guration les are exported to CTS+.

To export projects, do the following:

1. In the SAP MII: Projects screen, select the project les.

2. Choose Export. Choose CTS+ in the Export Method eld.

3. Enter brief descriptive text in the Description eld..

4. Choose OK.

The selected project les are exported to CTS+.

To import the les, see SAP help portal at http://help.sap.com Application Lifecycle Mgmt Change and Transport System
(Including CTS Plug-In) CTS Plug-In 1.0 Change and Transport System - Overview (BC-CTS) Transporting Non-ABAP Objects
in Change and Transport System.

Registering Enhanced Change and Transport


System (CTS+)
To register CTS+ as an RFC destination on the source system, do the following:

1. Login to the SAP NetWeaver administration screen using your administrator credentials.

2. Go to Con guration/Security/Destinations.

3. Choose Create in the Destinations List table.

The Destinations screen appears.

4. Enter the following:

Hosting System: Local Java System N73

Destination Name: sap.com/com.sap.tc.di.CTSserver

Destination Type: RFC

5. Choose Next.

The Connection screen appears.

6. Enter the following:

Target Host: Name of the CTS system

System Number:CTS system number

System ID: CTS system ID

7. Choose Next.

The Authentication screen appears.

This is custom documentation. For more information, please visit the SAP Help Portal 30
4/11/2019
8. Enter the following:

Authentication User:

Language:

Client:

User Name: CTS system user name

Password: CTS system password

9. In the Repository Connection, enter the details in Destination name, User Name and Password elds.

10. Choose Finish.

To test the RFC connection, select the created destination in the Destination List table and choose Ping Connection in the
Destination Details column. A success message appears.

To create an application in the CTS system, see SAP Help Portal at http://help.sap.com Application Lifecycle Mgmt CTS
PLUG-IN 1.0 Change and Transport System (Including CTS Plug-In) Change and Transport System - Overview (BC-
CTS) Performing Con guration Steps for Non-ABAP Transports Connecting Further Applications with the Change and
Transport System Con guring Source Systems for Further Applications.

Localization
Use
You use this function to provide language support for SAP Manufacturing Integration and Intelligence (SAP MII).

Features
SAP MII reads settings from the following locations, in the order listed, until a language is speci ed:

1. SAP User Management Engine (SAP UME) user locale

2. SAP UME Language attribute

3. Your browser language

4. The Language value on the System Properties screen (On the SAP MII administration menu, choose System
Management System Properties. )

5. Your Java Virtual Machine language

You can also create a localized time period. To do so, create a time period in Time Period screen, and create localized texts for
the same using Create button.

More Information
Web Page Localization

Project Localization

Content Usage
This is custom documentation. For more information, please visit the SAP Help Portal 31
4/11/2019

Use
You use the Content Usage screen to view the following statistics for transactions, templates, and manufacturing data objects
(MDO):

Number of runs

Average runtime

Minimum runtime

Maximum runtime

Integration
On the Projects screen, you select the Usage Monitoring checkbox to enable content monitoring for each project.

Features
The system updates the usage statistics at the end of each run. When a le, folder, or project is deleted, its usage statistics are
also deleted.

Activities
To view content statistics, on the SAP MII administration menu, choose System Management Content Usage.

Services
Use
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 con guration


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.

This is custom documentation. For more information, please visit the SAP Help Portal 32
4/11/2019

Service Name Action Name Function Provides

Chart Servlet XMII_ChartServlet Chart generation servlet

Con guration XMII_Con gurationService Import and export of server con guration
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

EncryptCon g XMII_EncryptCon g Access to encryption con guration

File System Browser XMII_FileSystemBrowser Ability to browse folders and les 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 Run indexer

XMII_Indexer For examples, see Examples: Indexing


Services.

JCoDataBufferService XMII_JCoDataBufferService Access to the server from the SAP MII


Workbench to ll XML properties with
sample data

Localization XMII_LocalizationService De ne 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

Pro leEditor XMII_Pro leEditorService Navigation and tab items for roles

Quality Portal Service XMII_QualityPortal Handling of SPCCharts

XMII_PermissionService

QueryCaching XMII_QueryCaching Run a query, cache the results, and access


cached data

This is custom documentation. For more information, please visit the SAP Help Portal 33
4/11/2019

Service Name Action Name Function Provides

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 con gure
SPC charts in the display template and not
the query.

Statistics XMII_ContentUsageService Returns usage statistics for les

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
le path.

Summary

Returns a one row summary for all


objects that were accessed in the
speci ed time frame

System Info XMII_SystemInformationService Access a reporting service with server list


and mode list functions

Transport XMII_Transport Exports con guration 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 You use this service to:

View alerts and its details

Change alert status

Delete alerts

Forward alerts

For examples, see Examples: Alert


Services.

Activities

This is custom documentation. For more information, please visit the SAP Help Portal 34
4/11/2019
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> de nes the operation of the service.

For example, the Admin service has a UserList mode that returns the list of all users con gured 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> de nes 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
It can be used only with those services that returns data in
standard MII format.

You can return a custom response by specifying the FinalTransform property. The nal transform can be an XSL le
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>

Data Server Services


Services for data servers and associated URL examples are listed in the following table. For more information, see Services.

Service Example URL

Import one or more data servers (If the speci ed data server http://<server>:<port>/XMII/Illuminator?
already exists, the service updates it; otherwise, the service adds service=Configuration
the dataserver.)
&mode=DataServers&type=Import&payload=<xml>

This is custom documentation. For more information, please visit the SAP Help Portal 35
4/11/2019

Service Example URL

Export the list of data servers http://<server>:<port>/XMII/Illuminator?


service=Configuration

&mode=DataServers&type=Export

Delete a data server http://<server>:<port>/XMII/Illuminator?


service=Configuration

&mode=DataServers&type=Delete&Name=<name>

Enable a data server http://<server>:<port>/XMII/Illuminator?


service=Configuration

&mode=DataServers&type=Enable&Name=<name>

Disable a data server http://<server>:<port>/XMII/Illuminator?


service=Configuration

&mode=DataServers&type=Disable&Name=<name>

Admin Services
The following admin services use different mode list. You need authorization to access admin services. Fore more information,
see Services. The following table lists the different modes and the parameters used in admin services:

Mode Description Parameters

ModeList Displays a list of modes

ContentList Legacy service for content map. If group is Group=<user name>


not speci ed, all the information is returned

DBINIT Force reload of system content Type=Con g or Project


con guration or prede ned projects

GetResource Retrieves localization information; used by Language=<lang>&Filename<bundlename>


applets

Inspector Retrieves the list of methods available; Name=<appletname>&Method=


used by JAVA script wizard <method>&QueryType=<type>

PermissionList List of user permissions Method=System or Server&Group=<name>

RoleAttributeList List of role attributes for the speci ed role Group=<rolename>

RoleList List of roles in the system or assigned to a Group=<username>


user

SessionList List of active session and the session None


properties on this instance

SystemList List of system properties and their values None

UserAttribList Displays attributes for the current user or Group=<username>


the user speci ed

UserDataReport Displays all information contained for the Username=<name>


speci ed user name

UserList List of users or list of users which are Group=<rolename>


members of a role

This is custom documentation. For more information, please visit the SAP Help Portal 36
4/11/2019

Mode Description Parameters

Who List of users currently logged into the None


instance

The following modes are directly related to your home page. The modes return the information in XML format to build the home
page.

Mode Description Parameter

CurrentPro le The current users navigation tree None

FullPro le Displays the full navigation tree for the Group=<username>


speci ed user

UserPro le Displays the navigation tree for the Group=<username>


speci ed user name without role
information

RolePro le Displays the role speci c navigation tree Group=<username>

Pro leEditor Update pro le for user or role Group=<user or role name>&Type=
[USER]&payload=<xml>

Indexing Services
Indexing services and associated URL examples are listed in the following table. For more information, see Services.

Service Example URL

List of modes http://<server>:<port>

/XMII/Illuminator?service=Indexing&Mode=modelist

Start the indexing service http://<server>:<port>

/XMII/Illuminator?service=Indexing&Mode=start

Status of the indexer and the list of the les indexed since the last http://<server>:<port>
start
/XMII/Illuminator?service=Indexing&Mode=status

Returns the list of usages of the speci ed item and index type http://<server>:<port>

/XMII/Illuminator?service=Indexing&Mode=

usage&type=<indexType>name=<item>

List of indexes that do not exist, such as referenced data servers http://<server>:<port>
that do not exist
/XMII/Illuminator?service=Indexing&Mode=

missing&type=<indexType>

The index types are listed in the following table:

Index Type Description

credential Credential aliases used in transactions

connection Connection aliases used in transactions

This is custom documentation. For more information, please visit the SAP Help Portal 37
4/11/2019

Index Type Description

dataserver Data servers used in query templates

file Transaction, template, and manufacturing data object uses

Scheduler Services
The following table lists scheduler services and associated URL examples. For more information, see Services.

Service Example URL

Start the scheduler main process http://<server>:<port>

/XMII/Illuminator?service=Scheduler&mode=Start

Stop the scheduler main process http://<server>:<port>

/XMII/Illuminator?service=Scheduler&mode=Stop

List all jobs in the scheduler http://<server>:<port>

/XMII/Illuminator?service=Scheduler&mode=List

Run a job by ID http://<server>:<port>

/XMII/Illuminator?service=Scheduler&mode=Run&ID=
<jobid>

Enable a job by ID http://<server>:<port>

/XMII/Illuminator?
service=Scheduler&mode=Enable&ID=<jobid>

Disable a job by ID http://<server>:<port>

/XMII/Illuminator?
service=Scheduler&mode=Disable&ID=<jobid>

Display the run history for a job by ID and limit the row count http://<server>:<port>

/XMII/Illuminator?
service=Scheduler&mode=History&ID=
<jobid>&RowCount=<#>

Delete a job by ID http://<server>:<port>

/XMII/Illuminator?
service=Scheduler&mode=Delete&ID=<jobid>

Import a job to add it or update it http://<server>:<port>

/XMII/Illuminator?
service=Scheduler&mode=Import&Payload=<xml>

Export a job by ID, which outputs an XML document that can also http://<server>:<port>
be used for import
/XMII/Illuminator?
service=Scheduler&mode=Export&ID=<jobid>

Statistics Services
This is custom documentation. For more information, please visit the SAP Help Portal 38
4/11/2019
Statistics services and associated URL examples are listed in the following table. For more information, see Services.

Service Example URL

List of modes http://<server>:<port>/XMII/Illuminator?service=

Statistics&Mode=modelist

Display all usage statistics for the speci ed object http://<server>:<port>/XMII/Illuminator?service=

Statistics&Mode=Runtime&Name=<filepath>

Display all usage statistics for the current day http://<server>:<port>/XMII/Illuminator?service=

Statistics&Mode=Runtime

Display all usage statistics for the speci ed time period http://<server>:<port>/XMII/Illuminator?service=

Statistics&Mode=Runtime&StartDate=<SD>&EndDate=
<ED>

http://<server>:<port>/XMII/Illuminator?service=

Statistics&Mode=Runtime&Path=<path>&Duration=<d>

&DurationUnit=<unit>

Display a summary per object for the current day http://<server>:<port>/XMII/Illuminator?service=

Statistics&Mode=Summary

Display a summary per object for the speci ed time period http://<server>:<port>/XMII/Illuminator?service=

Statistics&Mode=Summary&StartDate=<SD>&EndDate=
<ED>

http://<server>:<port>/XMII/Illuminator?service=

Statistics&Mode=Summary&Path=<path>&Duration=<d>

&DurationUnit=<unit>

Display a list of user names http://<server>:<port>/XMII/Illuminator?service=

Monitoring&Mode=Logins

Display all usage statistics for the counts per day http://<server>:<port>/XMII/Illuminator?service=

Monitoring&Mode=LoginsSummary

Display all usage statistics per day for a speci c user http://<server>:<port>/XMII/Illuminator?service=

Monitoring&Mode=LoginsSummary&Username=name

Display all usage statistics of Data Server http://<server>:<port>/XMII/Illuminator?service=

Monitoring&Mode=DataServers

Display a summary of queries per user http://<server>:<port>/XMII/Illuminator?service=

Monitoring&Mode=UserQuery

Display all usage statistics of le usage http://<server>:<port>/XMII/Illuminator?service=

Monitoring&Mode=FileUsage

Display all usage statics of le usage for speci c le http://<server>:<port>/XMII/Illuminator?service=

Monitoring&Mode=FileUsage&ID=field

This is custom documentation. For more information, please visit the SAP Help Portal 39
4/11/2019

Service Example URL

Display a summary of le usage for speci ed days http://<server>:<port>/XMII/Illuminator?service=

Monitoring&Mode=FileUsageSummary

Displays a summary of message listener server receive and http://<server>:<port>/XMII/Illuminator?service=


process information
Monitoring&Mode=Messages

Transaction Services
Transaction services and associated URL examples are listed in the following table. For more information, see Services.

Service Example URL

List of modes http://<server>:<port>/XMII/Illuminator?

Service=BLSManager&Mode=List

Returns the details of a transaction http://<server>:<port>/XMII/Illuminator?

Service=BLSManager&Mode=Details&ID=<transactionID>

Terminates a running transaction http://<server>:<port>/XMII/Illuminator?

Service=BLSManager&Mode=Terminate&ID=
<transactionID>

Delete a transaction http://<server>:<port>/XMII/Illuminator?

Service=BLSManager&Mode=Delete&ID=<transactionID>

View the transaction log http://<server>:<port>/XMII/Illuminator?

Service=BLSManager&Mode=ViewLog&ID=<transactionID>

View the transaction output http://<server>:<port>/XMII/Illuminator?

Service=BLSManager&Mode=ViewOutput&ID=
<transactionID>

View the transaction cache http://<server>:<port>/XMII/Illuminator?

Service=BLSManager&Mode=ViewCache&type=Transaction

Clear the transaction cache http://<server>:<port>/XMII/Illuminator?

Service=BLSManager&Mode=ClearCache&type=Transaction

View the expression cache http://<server>:<port>/XMII/Illuminator?

Service=BLSManager&Mode=ViewCache&type=Expression

Clear the expression cache http://<server>:<port>/XMII/Illuminator?

Service=BLSManager&Mode=ClearCache&type=Expression

You can display a report on the execution times of the individual actions for a given transaction. You can execute a transaction
using the Runner Servlet. For more details, see Transaction Calls Using URLs. Set the parameter LogStatisticsToDB to true as
in the URL http://<server>:<port>/XMII/Runner?Transaction=
<Project>/<Path>/<Name>&LogStatisticsToDB=true.

This is custom documentation. For more information, please visit the SAP Help Portal 40
4/11/2019
On executing this transaction, the system records the runtimes of each action and the links associated with each action. The
transaction will return Transaction ID associated with the recorded values. The URL, http://<server>:
<port>/XMII/Illuminator?service=BLSManager&Mode=Stats&ID=<TRXID>&content-type=text/csv will
retrieve the detailed performance information from the database and display the results in your CSV editor.

Transport Services
Transport services and associated URL examples are listed in the following table. For more information, see Services.

Service Example URL

List of modes http://<server>:<port>/XMII/Illuminator?service=

Transport&Mode=modelist

Export con guration information http://<server>:<port>/XMII/Illuminator?service=

Transport&Mode=ExportConfig&Algorithm=

<encrypt-algorithm>&Passphrase=<password>

Export a project http://<server>:<port>/XMII/Illuminator?service=

Transport&Mode=ExportProject&Name=<projectName>

Alert Services
These services are used to do the following:

View alerts and its details

Change alert status

Delete alerts

Forward alerts

For more information, see Services.

Services Example URLs

List of modes http://<server>:<port>/XMII/Illuminator?Service=Alert&mode=Modelist

Gets the alerts along with the http://<server>:<port>/XMII/Illuminator?Service=


status, container property
Alert&mode=GetAlerts&containerPropertyName=Loc&containerPropertyValue=
name, and container property
value [value1;value2]

For multiple name value pairs, use http://<server>:<port>/XMII/Illuminator?Service=

Alert&mode=GetAlerts&containerPropertyName=Name,Loc&containerPropertyValue=

[Name1;Name2],[value1;value2]

Gets the details of the alerts http://<server>:<port>/XMII/Illuminator?Service=

Alert&mode=GetDetails&Id=<Alert Id>

This is custom documentation. For more information, please visit the SAP Help Portal 41
4/11/2019

Services Example URLs

Sets the status of the alerts http://<server>:<port>/XMII/Illuminator?Service=

Alert&mode=SetStatus&Id=<Alert Ids separated by comma>&Status=

<New Status Name or Integer Value>

Deletes the alerts http://<server>:<port>/XMII/Illuminator?Service=

Alert&mode=Delete&Id=<Alert Ids separated by comma>

Forwards the alerts to http://<server>:<port>/XMII/Illuminator?Service=


different roles
Alert&mode=Forward&Id=<Alert Ids separated by comma>&Roles=

<Comma separated Role names>

Plant Information Maintenance Services


This service is for the Plant Information Maintenance screen.

For more information, see Services.

Services Description Example URL

ModeList Provides the modes available for the service <http:>//<server><port>/XMII/Illuminator?Service=

PlantInformationMaintenance&mode=Modelist

Export Export the objects from the Plant <http:>//<server><port>/XMII/Illuminator?Service=


Information Maintenance screen
PlantInformationMaintenance&mode=Export&Namespace=

<namespace of PIC object>

Import Import the objects into Plant Information <http:>//<server><port>/XMII/Illuminator?Service=


Maintenance screen
PlantInformationMaintenance&mode=Import&Namespace=

<namespace of PIC object>&ImportXML=

<Import XML containing PIC


structure>&ChangelistID=

<changelist_ID>

 Note
ChangeListID is an optional parameter. The service takes the
default change list ID, if you do not enter the change list ID
parameter.

Plant Information Catalog Services


This service is for the Plant Information Catalog screen.

For more information, see Services.

Service Description Example URL

This is custom documentation. For more information, please visit the SAP Help Portal 42
4/11/2019
ModeList Provides the modes available for <http:>//<server><port>/XMII/Illuminator?
this service Service=

PlantInformationCatalog&mode=Modelist

Export Export the objects from the Plant <http:>//<server><port>/XMII/Illuminator?


Information Catalog screen Service=

PlantInformationCatalog&mode=Export&Namespace=

<namespace of PIC object>

getTagsByPCoDataServer Returns the PCo tags for the <http:>//<server><port>/XMII/Illuminator?


selected data server. The Service=
selected node is the parameter
and the service returns the tags PCoNotificationService&Operation=
associated with that node. If the
getTagsByPCo&DataServerDataServer=
parameter is empty, then the rst
level of children for the data MIIPIAgent&selectedNode=[node]
server is returned.

searchTagsForDataServer Searches for tags on a PCo <http:>//<server><port>/XMII/Illuminator?


source agent that is associated to Service=
the data server. The parameter is
Mask which holds the search PCoNotificationService&Operation=
value. Mask can be a valid regular
searchTagsFor&DataServerDataServer=
expression.
MIIPIAgent&Mask=[searchValue]
 Note
Search is case-sensitive.

ObjectsWithGPS Returns the tags and groups http://<server>:


under the speci ed group <port>/XMII/IlluminatorOData/Catalog
speci ed in the Name parameter
with property set ?Mode=ObjectsWithGPS&Namespace=<GroupName>
SAP_GeoLocation. You must
de ne the properties, Longitude
and Latitude within the property
set with the correct data type.
This in turn returns the
coordinates in the format
<Longitude>;
<Latitude>;0identi ed with
key GPS in the response.

Message Services
Message services are listed in the following table. For more information, see Services.

Service Example URL

WSMessageListenerServer: Provides EO and EOIO support http://<server>:<port>/XMII/Illuminator?service=


with the additional parameters MessageId, SequenceName,
WSMessageListener&mode=WSMessageListenerServe
MessageNumber, and LastMessage.
&Name=<UniqueMessageName>&MessageId=
<UniqueMessageID>&Sequencename=

<SequenceName>&Messagenumber=
<MessageNumber>&Lastmessage=<boolean>

This is custom documentation. For more information, please visit the SAP Help Portal 43
4/11/2019

Service Example URL

Acknowledgement: Displays information about the received http://<server>:<port>/XMII/Illuminator?service=


message numbers and the status of a sequence.
WSMessageListener&mode=Acknowledgement&Sequencename=

<sequencename>

Close Sequence: Closes a sequence. http://<server>:<port>/XMII/Illuminator?service=

WSMessageListener&mode=CloseSequence&Sequencename=
<sequencename>

Delete Empty Sequences: Deletes empty sequences that are http://<server>:<port>/XMII/Illuminator?service=


in Closed status.
WSMessageListener&mode=DeleteEmptySequences

ModeList: Lists the supported modes. http://<server>:<port>/XMII/Illuminator?service=

WSMessageListener&mode=ModeList

Monitoring Services
Monitoring Services are listed in the following table. For more information, see Services.

Services Example URL

List of modes http://server:port/XMII/Illuminator?service=

Monitoring&Mode=modelist

Login information include user names http://server:port/XMII/Illuminator?service=

Monitoring&Mode=Logins

Login Summary of counts per day http://server:port/XMII/Illuminator?service=

Monitoring&Mode=LoginsSummary

Login Summary of counts per day for a speci c user http://server:port/XMII/Illuminator?service=

Monitoring&Mode=LoginsSummary&Username=<name>

DataServer usage http://server:port/XMII/Illuminator?service=

Monitoring&Mode=DataServers

Queries per user http://server:port/XMII/Illuminator?service=

Monitoring&Mode=UserQuery

File Usage http://server:port/XMII/Illuminator?service=

Monitoring&Mode=FileUsage

This is custom documentation. For more information, please visit the SAP Help Portal 44
4/11/2019

Services Example URL

File Usage for speci c le http://server:port/XMII/Illuminator?service=

Monitoring&Mode=FileUsage&ID=<fileid>

 Note
MII 14.0 supports lepath along with the extension in the URL. The URL
with lepath is http://server:port/XMII/Illuminator?
service=Monitoring&Mode=

FileUsage&filepath=<fullpath>

The monitoring service will prioritize le ID if both le ID and le path are


passed as URL parameters.

File Usage Summary across days http://server:port/XMII/Illuminator?service=

Monitoring&Mode=FileUsageSummary

Message Listener server receive and process http://server:port/XMII/Illuminator?service=


information
Monitoring&Mode=Messages

Data server connection information http://server:port/XMII/Illuminator?service=

SystemInfo&Mode=Status

MDO Services
Services for MDO and associated URL examples are listed in the following table. For more information, see Services.

Service Example URL

Get MDO Cache http://<server>:<port>/XMII/Illuminator?service=

MDO&mode=GetCache&ObjectName=<MDOName>

Restore MDO Cache in an http://<server>:<port>/XMII/Illuminator?service=


MDO
MDO&mode=RestoreCache&ObjectName=<MDOName>&Payload=<Payload>

Drop MDO Cache http://<server>:<port>/XMII/Illuminator?service=

MDO&mode=DropCache&ObjectName=<MDOName>

Get MDO Logs http://<server>:<port>/XMII/Illuminator?service=

MDO&mode=GetLogs&ObjectName=<MDOName>&TaskID=<MDOTask>=

&SortFields=<Fields to be sorted>&FileID=<FileIDOfMDOObject>

Clear MDO Logs http://<server>:<port>/XMII/Illuminator?service=

MDO&mode=ClearLogs&ObjectName=<MDOName>

Set Debug state for MDO http://<server>:<port>/XMII/Illuminator?service=

MDO&mode=SetDebugState&ObjectName=<MDOName>&DebugState=

<BooleanToEnableOrDisableDebug>

This is custom documentation. For more information, please visit the SAP Help Portal 45
4/11/2019

Service Example URL

Get Debug state for MDO http://<server>:<port>/XMII/Illuminator?service=

MDO&mode=GetDebugState&ObjectName=<MDOName>

Get Tasks for particular http://<server>:<port>/XMII/Illuminator?service=


MDO
MDO&mode=GetTasks&ObjectName=<MDOName>&ObjectName=<MDOName>

&TaskID=<MDOTask>=&SortFields=<Fields to be sorted>

&FileID=<FileIDOfMDOObject>

Check unique http://<server>:<port>/XMII/Illuminator?service=

MDO&mode=CheckUnique&ObjectName=<MDOName>&Payload=

<MDODefinitionPayload>

OData Illuminator Services


Use
Open Data Protocol (OData) is a web protocol for querying and updating data, applying and building on web technologies such
as HTTP, Atom Publishing Protocol (AtomPub) and JSON to provide access to information from a variety of applications, and
services. Since OData services are easily utilized on different platforms, you can use this service to build cross-platform web and
mobile applications.

Note
You cannot use this service to execute dynamic queries.

Features
OData is a new service available in MI 14.0 and higher versions to run query templates. The function of this service is to execute
the query templates in SAP MII. As per REST guidelines, the following requests are allowed to make calls to OData service:

GET: Execute those modes only to retrieve data

POST: Execute all modes

PUT: Executes those modes which insert some data

DELETE: Execute those modes which deletes some data

To setup SAML2.0 authentication scheme for the OData service, go to Authentication and Single Sign On under Con guration
in NetWeaver. Set the policy con guration for the web module, sap.com/xapps~xmii~ear*IlluminatorOData to
SAML2LoginModule. Please refer to Con guring AS Java as a Service Provider to setup the login con guration. The Identity
Federation should be enabled for the trusted provider and the NW UME user mapping should be done for the logon id. Please
refer to Identity Federation to con gure user mapping for SAML2.

Caution
You must enable the trusted provider and map NW UME user. For more details, see the help portal at http://help.sap.com
Technology SAP NetWeaver Platform 7.3 Application Help Function-Oriented View Security

This is custom documentation. For more information, please visit the SAP Help Portal 46
4/11/2019

Note
The URL http://<server>:<port>/XMII/IlluminatorOData/$metadata uses basic authentication
scheme. To get metadata for a speci c query template and to generate the response with row properties, use
http://<server>:<port>/XMII/IlluminatorOData/$metadata?QueryTemplate=
<FullpathtoQueryTemplate>.

This scenario is available from MII 15.0 SP02 release onwards.

To access the OData service using SAML2 authentication, use the URL http://<server>:
<port>/IlluminatorOData/$metadata. For example, You can execute query templates in MII using
http://<server>:<port><temperature>/IlluminatorOData/QueryTemplate?QueryTemplate=.

You can call an OData service using the URL, http://<server>:<port>/XMII/IlluminatorOData/QueryTemplate where
IlluminatorOData is the name of the service and Query Template is the namespace or entity set name. You can also use HTTP
action block available in MII Workbench to call an OData service. Different query templates support different http request types
in particular modes. The following table displays the modes and request types of query templates.

Query Template Mode Request Types

Tag Query All GET/POST

Aggregate Query All Modes GET/POST

MDO Query Update PUT

Delete DELETE

Insert POST

All the other modes GET/POST

KPI Query Delete DELETE

Insert POST

All the other modes GET/POST

All the modes GET/POST

Xcute Query All the modes GET/POST

Xcute Query All the modes GET/POST

ETC Query All the modes GET/POST

Alarm Query DBFixedQuery POST

PCo Query DBCommandQuery POST

TagStoreQuery POST

All the other modes GET/POST

Query POST

OLAP Query All the other modes GET/POST

SQL Query FixedQuery GET

FixedQueryWithOutput POST

All the other modes GET/POST

This is custom documentation. For more information, please visit the SAP Help Portal 47
4/11/2019

Query Template Mode Request Types

Command POST

You can execute query templates in MII using http://<server>:<port>/XMII/IlluminatorOData/QueryTemplate?


QueryTemplate=<templatename>.

To enter parameters, use http://<server>:<port>/XMII/IlluminatorOData/QueryTemplate?QueryTemplate=


<templatename>&Mode=<mode>&Server=<server>. You can pass parameters in the URL to override the existing
con gured query template parameters.

The default response type is Atom or XML. To receive the data in JSON format, use http://<server>:
<port>/XMII/IlluminatorOData/QueryTemplate?Mode=<mode>&$format=json. You have to enter the query
template name.

Note
To send requests to the OData service using HTTP POST, PUT or DELETE, you have to send an additional request parameter
whose values are fetched in the following way:

The client must send a HTTP GET to the server using the URL http://<server>:
<port>/XMII/IlluminatorOData/QueryTemplate?xsrfid=Fetch.

The server will return one of the header's key as xsr d and the value will be an encrypted token.

When the services using POST, PUT or DELETE are called, the client returns the token name xsr d and its value in a
request parameter as http://<server>:<port>/XMII/IlluminatorOData/QueryTemplate?
QueryTemplate=<templatename>&xsrfid=<responseHeaderValue>.

While calling the OData service, if the client is unable to send the above mentioned token and its value, the call is incomplete
and returns an HTTP response code 403 error. The xsr d token is optional and is not required to execute the query in HTTP
GET.

To extract only certain navigation properties from the OData service, see the following table:

Navigation URL Exa


Properties

Rowset <protocol>:<server>:<port>/XMII/IlluminatorOData/Rowset(ʻ<QueryTemplateName>’)/Rowset http


Entities

Message <protocol>:<server>:<port>/XMII/IlluminatorOData/Rowset(ʻ<QueryTemplateName>’)/Messages http


Entities

Column <protocol>:<server>: http


Entities <port>/XMII/IlluminatorOData/Rowset(ʻQueryTemplate=’<QueryTemplateName>’RowsetId='<rowsetId>')/Column
whe

Row <protocol>:<server>: http


Entities <port>/XMII/IlluminatorOData/Rowset('QueryTemplate=ʻ<QueryTemplateName>',RowsetId='<rowsetId>')/Row
whe

Note
You can also pass all the overriding parameters as follows:

This is custom documentation. For more information, please visit the SAP Help Portal 48
4/11/2019

http://myServer:10000/XMII/IlluminatorOData/Rowset(QueryTemplate='MyProject/MyFolder/MyQuery
Param.1=<value>Param.2<value>

More Information
For more information on OData, see http://help.sap.com SAP NetWeaver SAP NetWeaver Gateway SAP Library SAP
NetWeaver Gateway SAP NetWeaver Gateway Master Guide SAP NetWeaver Gateway and OData.

http://www.odata.org

Catalog OData Services

MDO OData Service

KPI OData Service

Catalog OData Services


Catalog Odata service, a new service in MII 15.0 is similar to query template service. You can access the service using
http://<server>:<port>/XMII/IlluminatorOData/Catalog.

Modes Description Sample URL

ObjectList Returns live Plant http://<server>:<port>/XMII/IlluminatorOData/Catalog?Mode=


Information Catalog
hierarchy ObjectList&Namespace=<namespace of the tag>&Group=<Name of the tag
group>

 Note
<Namespace> and <Group> are optional parameters

PropertiesList Returns the properties http://<server>:<port>/XMII/IlluminatorOData/Catalog?Mode=


for a tag.
PropertiesList&Namespace=<namespace of the tag>&DataType=<datatype>

 Note
<Namespace> is a mandatory parameter whereas <DataType> is an optional parameter.
The properties that match the speci ed data type are returned. String type properties are
returned if data type is not provided.

MDO OData Services


MDO OData service, a new service in MII 15.0 is similar to query template service and used to fetch the data for the MDO object.
You can access the service using http://<server>:<port>/XMII/IlluminatorOData/MDO.

An example of MDO OData service is http://<server>:<port>/XMII/IlluminatorOData/MDO?


Mode=GetData&$format=json&MDO=

”MDO Path”&Attributes=”comma separated names of attributes”. The mode supported for MDO OData service
mode is GetData where <MDO> and <Attributes> are mandatory parameters.

KPI OData Services


This is custom documentation. For more information, please visit the SAP Help Portal 49
4/11/2019
The KPI OData service, a new service in MII 15.0 is similar to query template service and is used to fetch data for the KPI objects.
You can access the service using http://<server>:<port>>/XMII/IlluminatorOData/KPI.

Modes Description Sample URL

GetData Returns aggregated live data for a given http://<server>:


KPI that was previously stored in SAP MII <port>/XMII/IlluminatorOData/KPI?
database. The aggregation is obtained Mode=GetData&KpiName=<fullpath to
based on the KPI con guration such as KPI>&Dim#1#=
SUM, AVG, and so on.
<filter value of dimension
1>&Dim#n#=<filter value of
dimension n>

&Granularity=<value for
granularity>&Duration=<value for
duration>

&StartDate=YYYY-MM-
DDThh:mm:ss.sTZD&EndDate=YYYY-MM-
DDThh:mm:ss.sTZD

&SelectedDim=<Value1>,<Value2>

GetMetaData Returns the de nition of a given KPI that http://<server>:


was created and con gured in SAP MII <port>/XMII/IlluminatorOData/KPI?
Workbench. Mode=

GetMetaData=&KpiName=<fullpath to
KPI>

GetTileData Provides all the data of a KPI that is http://<server>:


relevant to be visualized in a tile view. <port>/XMII/IlluminatorOData/KPI?
Also, the mode provides an orchestration Mode=
of the KPI de nition along with the
GetDimensionValues&KpiName=
aggregated KPI live value matching a
<fullpath to KPI>&Duration=<value
given duration.
for duration>&StartDate=
Additionally, the KPI status is provided
YYYY-MM-DDThh:mm:ss.sTZD&EndDate=
considering the con gured thresholds
along with the KPI trend. YYYY-MM-DDThh:mm:ss.sTZD&Dim#1#=

<filter value of dimension


1>&Dim#n#=<filter value of
dimension n>

Get Dimensions Returns the dimension names along with http://<server>:


the types of a given KPI that was created <port>/XMII/IlluminatorOData/KPI?
and con gured in SAP MII Workbench. Mode= GetDimensions&KpiName=
<fullpath to KPI>

GetDimension Values Returns the existing values for the given http://<server>:
dimension of a given KPI that was created <port>>/XMII/IlluminatorOData/KPI?
and con gured in SAP MII Workbench. Mode=

GetDimensionValues&KpiName=
<fullpath to KPI>&Dimension=
<selected dimension to get values
for>&Dim#1#=

<filter value of dimension


1>&Dim#n#=<filter value of
dimension n>

This is custom documentation. For more information, please visit the SAP Help Portal 50
4/11/2019

Modes Description Sample URL

Get Dependencies Returns all children KPI names and their http://<server>:
types for a given KPI. The con guration of <port>/XMII/IlluminatorOData/KPI?
the parent child relationship must be Mode=
performed using the SAP MII Workbench.
GetDependencies&KpiName=<fullpath
to KPI>

KPI GetData Request Parameter


The request parameters are shown in following table:

Parameter Description Supported Values Mandatory?

Mode Mode for this OData service GetData Yes

KpiName Provides the full path to a Default/MIIOBJ/KpiName1 Yes


speci c KPI without its internal
extension.

Duration The duration limits (or the time Yes


CurrentShift
period) for which the KPI values
are aggregated and extracted. CurrentMonth
The start and end time is
calculated automatically for CurrentYear
some speci c inbuilt time
PreviousShift
intervals such as CurrentShift,
PreviousMonth, and so on. PreviousMonth

The start and end date in the PreviousYear


Custom property must be in
any ISO8601 compliant format Custom
(YYYY-MM-
DDThh:mm:ss.sTZD).

StartDate De nes the start date of the Any ISO8601 compliant format No
duration to calculate the KPI
For example, 2013-07-
aggregated value.  Note
18T11:00:00Z
This eld is mandatory when
you set Duration to Custom.

EndDate De nes the end date of the Any ISO8601 compliant format. No
duration to calculate the KPI
For example, 2013-07-
aggregated value.  Note
18T11:00:00Z
This eld is mandatory when
you set Duration to Custom.

This is custom documentation. For more information, please visit the SAP Help Portal 51
4/11/2019

Parameter Description Supported Values Mandatory?

Dim_# Contains the dimension and a Only con gured custom No


value to lter the result set. The dimension names are allowed.
hash symbol must be replaced
by dimension name. For
example, Dim_Plant.

The parameter values can range


from 0 to multiple values.

If the parameter value


is 1, then only one lter
value for a single
dimension is provided.

If multiple lter values


for a single dimensions
are provided, only the
last occurrence is
considered.

SelectedDim Contains a comma separated Only con gured custom No


list specifying the dimensions dimension names are allowed.
to be selected. Following
conditions must be considered:

Leading and trailing


white spaces are
omitted for each entry.

Double occurrences are


omitted

Default dimensions
such as Timestampand
Value are not allowed

Granularity Groups the result data based No


HOUR
on a certain granularity level.
Some of the modes and the DAY
results are as follows:
MONTH
HOUR: Returns 24
values a day WEEK

NONE: Returns exactly YEAR


one aggregated value
RAW
for the given duration
NONE
RAW: Provides the plain
data stored in database
(value and timestamp)
omitting the con gured
aggregation

KPI GetData Response Parameter


The response parameter of the mode is listed in the following table:

This is custom documentation. For more information, please visit the SAP Help Portal 52
4/11/2019

Parameter Description Data Type Examples

VALUE Represents the value of the KPI Double "74.25076532959889


for the con gured aggregation
and the requested duration and
granularity.

DIM_# Returns the value of a String “Line1”


dimenstion, where the name of
the selected dimension is
de ned as part of the response
parameter name. The hash sign
is replaced by dimension name.

The value of this property can


range from 0 to n.

TIMESTAMP Returns the timestamp String ISO8601 "2013-07-18T11:00:00+0200"


matching the granularity values.

KPI GetMetaData Request Parameter


The request parameters for the GetMetaData mode are shown in following table:

Parameter Description Supported Values

Mode Returns the mode for this OData service. GetMetaData

KpiName Returns the full path to a speci c KPI Default/MIIOBJ/KpiName1


without its internal extension.

Note
Both the above mentioned parameters are mandatory.

KPI GetMetaData Response Parameter


The response parameter of the mode is listed in the following table:

Parameter Description Data Type Examples

Name Returns the full path to a String "KPIs/MIIOBJ/OEE"


speci c KPI without its internal
extension.

Type Speci es the KPI type String "Base"


(Base/Composite/Unde ned).

UoM Speci es the unit of String "%”


measurement of a KPI.

TargetValue Speci es the target value of a String "30"


KPI.

ThresholdType Speci es the KPI threshold type String "Bi-directional"


of a KPI (Positive, Negative, Bi-
directional).

This is custom documentation. For more information, please visit the SAP Help Portal 53
4/11/2019

Parameter Description Data Type Examples

FromRedLow De nes the minimum threshold String "-70.0"


of the lower red band.

 Note
This parameter is available
only for ʻNegative’ or ʻBi-
directional’ threshold type.

ToRedLow De nes the maximum threshold String "-50.0"


of the lower red band.

 Note
This parameter is available
only for ʻNegative’ or ʻBi-
directional’ threshold type.

FromYellowLow De nes the minimum threshold String "-50.0"


of the lower yellow band.

 Note
This parameter is available
only for ʻNegative’ or ʻBi-
directional’ threshold type.

ToYellowLow Maximum Threshold of the String "0.0"


lower yellow band.

 Note
This parameter is available
only for ʻNegative’ or ʻBi-
directional’ threshold type.

FromGreenLow De nes the minimum threshold String "0.0"


of the green band.

 Note
This parameter is available
for all the KPI types.

ToGreenLow De nes the minimum threshold String "50.0"


of the green band.

 Note
This parameter is available
for all the KPI types.

This is custom documentation. For more information, please visit the SAP Help Portal 54
4/11/2019

Parameter Description Data Type Examples

FromYellowHigh De nes the minimum threshold String 50.0"


of the upper yellow band.

 Note
This parameter is available
only for ʻNegative’ or ʻBi-
directional’ threshold type.

ToYellowHigh De nes the maximum threshold String "70.0"


of the upper yellow band.

 Note
This parameter is available
only for ʻNegative’ or ʻBi-
directional’ threshold type.

FromRedHigh De nes the minimum threshold String "70.0"


of the upper yellow band.

 Note
This parameter is available
only for ʻNegative’ or ʻBi-
directional’ threshold type.

ToRedHigh De nes the maximum threshold String "100.0"


of the upper yellow band.

 Note
This parameter is available
only for ʻNegative’ or ʻBi-
directional’ threshold type.

KPI GetTileData Request Parameter


The request parameters for the GetTileData mode are shown in following table:

Parameter Description Supported Values Mandatory?

Mode Returns the mode for this OData GetTileData Yes


service

KpiName Returns the full path to a KPI/MIIOBJ/KpiName1 Yes


speci c KPI without its internal
extension.

This is custom documentation. For more information, please visit the SAP Help Portal 55
4/11/2019

Parameter Description Supported Values Mandatory?

Duration The duration limits (or the time Yes


CurrentShift
period) for which the KPI values
are aggregated and extracted. CurrentMonth
The start and end time is
calculated automatically for CurrentYear
some speci c inbuilt time
PreviousShift
intervals such as CurrentShift,
PreviousMonth, and so on. PreviousMonth

The start and end date in the PreviousYear


Custom property must be in
any ISO8601 compliant format Custom
(YYYY-MM-
DDThh:mm:ss.sTZD)

StartDate De nes the start date of the Any ISO8601 compliant format No
duration to calculate the KPI
For example, 2013-07-
aggregated value.  Note
18T11:00:00Z
This eld is mandatory when
you set Duration to
Custom.

EndDate De nes the end date of the Any ISO8601 compliant format. No
duration to calculate the KPI
For example, 2013-07-
aggregated value.  Note
18T11:00:00Z
This eld is mandatory when
you set Duration to
Custom.

Dim_# Contains the dimension and a Only con gured custom No


value to lter the result set. The dimension names are allowed.
hash symbol must be replaced
by dimension name. For
example, Dim_Plant.

The parameter values can range


from 0 to multiple values.

If the parameter value is


1, then only one lter
value for a single
dimension is provided.

If multiple lter values


for a single dimensions
are provided, only the
last occurrence is
considered.

KPI GetTileData Response Parameter


The response parameter of the mode is listed in the following table:

Parameter Description Supported Values Mandatory

This is custom documentation. For more information, please visit the SAP Help Portal 56
4/11/2019

Parameter Description Supported Values Mandatory

DIM_# Contains a value for the speci c String "1000"


dimension. The dimension name
is returned as upper case

NAME Provides the full path of the KPI String "KPIs/MIIOBJ/BaseKPI"

VALUE De nes the current aggregated Double "66.79662453737092"


value of the KPI matching the
given duration

UOM Provides the unit of String "%"


measurement, as con gured

TREND Following trends are available: String "NEGATIVE"

Negative

Positive

Constant

Unde ned

STATUS Following statuses are available: String "YELLOW"

Green

Yellow

Red

Unde ned

DURATION Returns the given duration for String "CurrentYear"


convenient consumption

DURATION_STARTDATE Returns the start date matching String ISO8601 2013-01-01T00:00:00+0000"


the given duration value. For in-
built durations such as
PreviousYear, the returned
value is 1st January, previous
year

DURATION_ENDDATE Returns the end date matching String ISO8601 "2013-12-31T23:59:59+0000"


the given duration value. For in-
built durations such as
PreviousYear, the returned
value is 31st December,
previous year

KPI GetDimensions Request Parameter


The request parameters for the GetDimensions mode are shown in following table:

Parameter Description Supported Values

Mode Returns the mode for this OData service GetDimensions

KpiName Returns the full path to a speci c KPI Default/MIIOBJ/KpiName1


without its internal extension.

This is custom documentation. For more information, please visit the SAP Help Portal 57
4/11/2019

Note
Both the above mentioned parameters are mandatory.

KPI GetDimensions Response Parameter


The response parameter of the mode is listed in the following table:

Parameter Description Data Type Examples

DIMENSION_NAME Provides the names of the String “Plant”


dimensions de ned for a KPI

DIMENSION_TYPE Provides the data type of the String “Double”


dimension

KPI GetDimensionValues Request Parameter


The request parameters for the GetDimensionValues mode are shown in following table:

Parameter Description Supported Values Mandatory

Mode Returns the mode for this OData GetDimensionValues Yes


service

KpiName Returns the full path to a Default/MIIOBJ/KpiName1 Yes


speci c KPI without its internal
extension.

Dimension Contains the dimension name to A custom dimension name Yes


get the existing values for
?????.  Note
Default dimensions such as
Timestamp and Value are
prohibited.

Dim_# Contains the dimension and a Only con gured custom No


value to lter the result set. The dimension names are allowed.
hash symbol must be replaced
by dimension name. For
example, Dim_Plant.

The parameter values can range


from 0 to multiple values.

If the parameter value is


1, then only one lter
value for a single
dimension is provided.

If multiple lter values


for a single dimensions
are provided, only the
last occurrence is
considered.

This is custom documentation. For more information, please visit the SAP Help Portal 58
4/11/2019

KPI GetDimensionValues Response Parameter


The response parameter of the mode is listed in the following table:

Parameter Description Data Type Examples

DIM_# Each row contains a value for String "1000"


the speci c dimension. The
name of the selected dimension
is de ned as part of the
response parameter name,
where the hash sign is replaced
by the dimension name.

 Note
The dimension name
must be in upper
case

This property occurs


only once.

KPI GetDimensions Request Parameter


The request parameters for GetDimensions mode are shown in following table:

Parameter Description Supported Values

Mode Returns the mode for this OData service GetDimensions

KpiName Returns the full path to a speci c KPI Default/MIIOBJ/KpiName1


without its internal extension.

Note
Both the above mentioned parameters are mandatory.

KPI GetDependencies Request Parameter


The response parameter of the mode is listed in the following table:

Column Name Description Data Types Examples

NAME Returns the full path of the child String "KPIs/MIIOBJ/OEE"


KPI without internal le
extension

TYPE Returns the KPI type (0= Base String "Base"


and 1= Composite)

Security Services
Use
This is custom documentation. For more information, please visit the SAP Help Portal 59
4/11/2019
SAP Manufacturing Integration and Intelligence (SAP MII) Security Services allow you to grant access to system services and
data servers.

Features
Security Services consists of the following:

Data Access

Encryption Con guration

Credential Stores (See Using Credential Stores.)

User Management

Data Access
Use
You use the Data Access screen to assign roles to SAP Manufacturing Integration and Intelligence (SAP MII) servers. Assigned
roles have permission to access the server.

Prerequisites
You are assigned to the administrator role. For more information, see User Management.

Features
An SAP MII server may be one of the following data sources:

Relational database

Distributed Control System (DCS)

Supervisory Control and Data Acquisition (SCADA) system

Data historian

Enterprise Resource Planning (ERP) system

Activities
To assign or remove roles from a server, do the following:

1. On the SAP MII administration menu screen, choose Security Services Data Access.

2. Select a server from the dropdown list.

3. Select a role and use the arrow buttons to add it to or remove it from the Roles Assigned to Server list.

Note
To select multiple roles, press and hold CTRL and select the appropriate roles.

4. Click Save.

This is custom documentation. For more information, please visit the SAP Help Portal 60
4/11/2019

More Information
Connectors

Encryption Con guration


You use the Encryption Con guration screen to choose the encryption algorithm for encoding data servers, schedules, and
credentials when you save in SAP Manufacturing Integration and Intelligence (SAP MII).

The available encryption algorithms are determined by your SAP NetWeaver instance and may include the following:

TripleDES is the default setting, which provides the strongest data encryption.

This method is based on Data Encryption Standard (DES), where the data are encrypted three times.

DES provides the second-strongest data encryption.

Base64 provides the least data encryption.

When no other encryption method is available, the system uses Base64 encoding.

Caution
Changing the encryption algorithm may cause disruptions to the system.

Using Credential Stores


Context
You use the Credential Stores screen to add an alias for a user name and password. You can change or delete an alias.

You use the aliases in SAP Manufacturing Integration and Intelligence (SAP MII) Workbench actions instead of entering your
user name and password in the action con gurations.

Procedure
1. On the SAP MII administration menu screen, choose Security Services Credential Stores .

2. To create a new alias, do the following:

a. Click Create.

b. In the Name eld, enter an alias name.

c. In the User Name eld, enter the user name for the alias.

d. Enter and con rm the password for the user.

e. If you want to limit this credential's use to the assigned user, select the Private checkbox.

f. If you want to assign roles to the credential, select the Security tab and add the appropriate roles.

g. Click Save.

3. To see where an alias was used in the system, do the following:

a. Select an alias name from the list.

This is custom documentation. For more information, please visit the SAP Help Portal 61
4/11/2019
The associated name and user name appear in the detail elds on the Settings tab.

b. Choose the Usage tab.

4. To delete an alias, do the following:

a. Select an alias name from the list.

The associated name and user name appear in the elds.

Recommendation
We recommend that you check the usage of the alias before deleting it. Deletion may cause actions to fail.

b. Click Delete.

User Management
Use
You use the SAP User Management Engine in SAP ERP to assign SAP Manufacturing Integration and Intelligence (SAP MII)
roles to actions. These actions give users permission to certain services. Some actions allow permissions on system screens.
For more information about screen permissions, see Actions for Permissions.

Features
The default SAP MII roles and their permissions are the following:

SAP_XMII_User

Users assigned to this role have read access but no access to administration screens or the SAP MII Workbench.

SAP_XMII_Developer

Users assigned to this role have access to the SAP MII Workbench and some administration screens, such as Time
Periods, Connection Store Editor, and Credential Store Editor.

SAP_XMII_Administrator

Users assigned to this role have the same permissions as users assigned to the SAP_XMII_User and
SAP_XMII_Developer roles, plus administration access except for the following: NWDI con guration read and write,
encryption con guration, and import and export of con guration data.

SAP_XMII_Super_Administrator

Users assigned to this role have access to everything with no limitations.

SAP_XMII_Read_Only

Users assigned to this role have read permission for administration screens.

SAP_XMII_Approver

Users assigned to this role have access to approve lists under Catalog Services and can approve or reject a change list.

SAP_XMII_ProjectManagement

Users assigned to this role can handle multiple import of les and folders to the target location on SAP MII Workbench.

SAP_XMII_DynamicQuery

This is custom documentation. For more information, please visit the SAP Help Portal 62
4/11/2019
Users assigned to this role have permission to run dynamic queries (queries without a query template) and override all
query properties. By default, this permission is granted to users assigned to the SAP_XMII_Developer role but not the
SAP_XMII_User role. You assign this role to speci c or all users. For more information about this role, see Template
Security.

Note
Depending on your role in SAP MII, you may not see all SAP MII administration menu options and screens.

Activities
You can update role mappings by changing the actions assigned to the role. You also create new roles that have access to a
particular screen.

More Information
Services

Actions for Permissions


The following table lists actions, which you assign to your users in the SAP User Management Engine in SAP ERP, and their
associated permissions.

Action names may include the following suffixes:

_R permits read access

_RW permits read and write access

_RWD permits read, write, and delete access

_deploy forces an immediate deploy

_transport permits transport access

_all permits read, write, delete, and transport access

Other actions allow access to services. For a list of these actions, see User Management.

Screen/Utility Action Name Access

Administrator XMII_Administrator All content handlers

Access all system con guration functions

Con guration XMII_Transport Transport projects and con gurations

Connection Status XMII_ConnectionStatus Status of enabled data servers

Connection Store Editor XMII_ConnectionStore_R Access to Connections screen

XMII_ConnectionStore_RW

XMII_ConnectionStore_RWD

XMII_ConnectionStore_transport

XMII_ConnectionStore_all

This is custom documentation. For more information, please visit the SAP Help Portal 63
4/11/2019

Screen/Utility Action Name Access

Content Development XMII_Workbench_Content Export from SAP MII Workbench

Credential Store Editor XMII_CredentialStore_R Access to the Credential Stores screen

XMII_CredentialStore_RW

XMII_CredentialStore_RWD

XMII_CredentialStore_transport

XMII_CredentialStore_all

CustomActions XMII_CustomAction_R Access to Custom Actionsscreen

XMII_CustomAction_RWD

XMII_CustomAction_deploy

XMII_CustomAction_all

Custom Attributes and Custom XMII_CustomAttributes_R Access to Custom Attributes screen


Attribute Mapping
XMII_CustomAttributes_RW

XMII_CustomAttributes_RWD

XMII_CustomAttributes_transport

XMII_CustomAttributes_all

DataAccess Servers XMII_DataServer_R Access to the Data Access screen

XMII_DataServer_RW

XMII_DataServer_transport

XMII_DataServer_all

Data BufferJobs and Entries XMII_DataBuffer_R Access to the Data Bufferscreen

XMII_DataBuffer_RW

XMII_DataBuffer_RWD

Data Servers XMII_DatServer_R Access to the Data Servers screen

XMII_DatServer_RW

XMII_DatServer_RWD

XMII_DatServer_transport

XMII_DatServer_all

Developer XMII_Developer Content development

Dynamic GraphicsEditor XMII_Workbench_dyngraph_editor Read and write Dynamic Graphics

Dynamic Page Generator XMII_DynamicPageGenerator Access to Dynamic Page Generator

Export from Workbench XMII_Workbench_Export Export from SAP MII Workbench

Import to Workbench XMII_Workbench_Import Import to SAP MII Workbench

This is custom documentation. For more information, please visit the SAP Help Portal 64
4/11/2019

Screen/Utility Action Name Access

JDBC Drivers XMII_JDBCDriver_R Upload JDBC drivers to the system

XMII_JDBCDriver_RWD

XMII_JDBCDriver_deploy

XMII_JDBCDriver_all

KPI Value Maintenance XMII_KPIValueMaintenance_R Access to the KPI Value Maintenance


screen
XMII_KPIValueMaintenance_RW

XMII_KPIValueMaintenance_RWD

XMII_KPIValueMaintenance_all

Link Editor XMII_LinkEditor_R Assign a name and description to Web


and system content URL. Users can
XMII_LinkEditor_RW
access a URL by assigning roles to the
XMII_LinkEditor_RWD URL. Members of the assigned role can
subscribe to the URL.
XMII_LinkEditor_transport

XMII_LinkEditor_all

Localization XMII_Localization_R Localization editor

XMII_Localization_RW De ne string token replacements when


localizing HTML content
XMII_Localization_RWD

XMII_Localization_transport

XMII_Localization_all

Message Cleanup Rules XMII_MessageListenerCleanupRuleList_R Message Listener Cleanup Rule List

XMII_MessageListenerCleanupRuleList_RW

XMII_MessageListenerCleanupRuleList_RWD

Message Cleanup Rules Editor XMII_MessageListenerCleanupRules_R Access to the Message Cleanup


Rulesscreen
XMII_MessageListenerCleanupRules_RW

XMII_MessageListenerCleanupRules_RWD

XMII_MessageListenerCleanupRules_transport

XMII_MessageListenerCleanupRules_all

Message Listener Con g Editor XMII_MessageListenerCon g_R Access to the Message Listeners screen

XMII_MessageListenerCon g_RW

XMII_MessageListenerCon g_RWD

XMII_MessageListenerCon g_transport

XMII_MessageListenerCon g_all

This is custom documentation. For more information, please visit the SAP Help Portal 65
4/11/2019

Screen/Utility Action Name Access

Message Monitor and Failed Messages XMII_MessageListenerMonitor_R Access to the Message Monitor screen

XMII_MessageListenerMonitor_RW
 Note
XMII_MessageListenerMonitor_RWD
XMII_MessageListenerMonitor_All
XMII_MessageListenerMonitor_All permits read, write, delete, and
display access

NavigationEditor XMII_NavigationEditor_R Access the Navigation screen

XMII_NavigationEditor_RW

XMII_NavigationEditor_RWD

XMII_NavigationEditor_transport

XMII_NavigationEditor_all

NWDI Properties XMII_NWDIProperties_R NWDI Con guration screen

XMII_NWDIProperties_RW

XMII_NWDIProperties_transport

XMII_NWDIProperties_all

Object Page Generator XMII_ObjectPageGenerator Access to Object Page Generator

PDF Actions XMII_PDFAction_R Access to the PDF Actions in the SAP MII
Workbench
XMII_PDFAction_RWD

XMII_PDFAction_deploy

XMII_PDFAction_all

Processing RuleEditor XMII_MessageListenerRules_R Access to the Message Processing


Rulesscreen
XMII_MessageListenerRules_RW

XMII_MessageListenerRules_RWD

XMII_MessageListenerRules_transport

XMII_MessageListenerRules_all

XMII_EnergyProductionEvent XMII_EnergyProductionEvent_all Maintenance of production event


templates and production events
XMII_EnergyProductionEvent_R

XMII_EnergyProductionEvent_RW

XMII_EnergyProductionEvent_RWD

XMII_EnergyProductionEvent_transport

XMII_EnergyShiftPattern XMII_EnergyShiftPattern_all Maintenance of shift patterns

XMII_EnergyShiftPattern_R

XMII_EnergyShiftPattern_RW

XMII_EnergyShiftPattern_RWD

XMII_EnergyShiftPattern_transport

This is custom documentation. For more information, please visit the SAP Help Portal 66
4/11/2019

Screen/Utility Action Name Access

XMII_EnergyTariff XMII_EnergyTariff_all Maintenance of tariffs

XMII_EnergyTariff_R

XMII_EnergyTariff_RW

XMII_EnergyTariff_RWD

XMII_EnergyTariff_transport

Projects XMII_ManageProjects_R Projects screen

XMII_ManageProjects_D

XMII_ManageProjects_transport

XMII_ManageProjects_all

Project Management XMII_ProjectInfo_RW Allows you to con gure and edit default
display templates

Read Only XMII_Read_Only Read only access to all screens

ScheduleEditor XMII_ScheduleEditor_R Scheduler screen

XMII_ScheduleEditor_RW

XMII_ScheduleEditor_RWD

XMII_ScheduleEditor_transport

XMII_ScheduleEditor_all

Scheduler XMII_Schedule_R View schedules

XMII_Schedule_control Start and stop the scheduler

SAP ServerEditor XMII_SAPServer_R SAP server editor

XMII_SAPServer_RW

XMII_SAPServer_RWD

XMII_SAPServer_transport

XMII_SAPServer_all

Service Registry XMII_ServiceRegistryService Returns the list of classi cations,


services, service endpoints, and physical
systems

Shared Memory XMII_SharedMemory_R Shared Memory screen

XMII_SharedMemory_RW

XMII_SharedMemory_RWD

XMII_SharedMemory_all

Simulator Editor XMII_Simulator_R Simulator Services screen

XMII_Simulator_RW

XMII_Simulator_RWD

XMII_Simulator_transport

XMII_Simulator_all

This is custom documentation. For more information, please visit the SAP Help Portal 67
4/11/2019

Screen/Utility Action Name Access

Super Admin XMII_Full_Access Access to everything

SystemJobs XMII_SystemJobs Read only to system jobs

SystemProperties XMII_SystemProperties_R Viewing System Properties screen

XMII_SystemProperties_RW Viewing and changing the screen

XMII_SystemProperties_transport All authorizations

XMII_SystemProperties_all

SystemSecurity Access XMII_SystemSecurity_R Data Access screen

XMII_SystemSecurity_RW

XMII_SystemSecurity_transport

XMII_SystemSecurity_all

TemplateEditor XMII_Workbench_query_editor Read and write templates

Time Period Editor XMII_TimePeriod_R Time Periods screen

XMII_TimePeriod_RW

XMII_TimePeriod_RWD

XMII_TimePeriod_transport

XMII_TimePeriod_all

Time Period Schedules Editor XMII_TimePeriodSchedule_R Time Period Schedules screen

XMII_TimePeriodSchedule_RW

XMII_TimePeriodSchedule_RWD

XMII_TimePeriodSchedule_transport

XMII_TimePeriodSchedule_all

Transactions XMII_Transaction_Read Transaction Manager screen

XMII_Transaction_Terminate

XMII_Transaction_Delete

XMII_Transaction_all

Workbench All XMII_Workbench_all All editors and System Info service

XacuteDevelopment XMII_Workbench_transaction_editor Read and write transactions

XacuteRuntime XMII_Workbench_transaction_test Run transactions

Access the SAP MII Workbench using a


URL

Self Service Composition XMII_SSCE_ALL Access to Self Service Composition


Environment Environment screen

XMII_SSCE_CHANGE To create, save, and modify dashboards

XMII_SSCE_READ To open an existing dashboard

MII Content XMII_SSCE_MIIContent_ALL Access to MII Content screen of Self


Service Composition Environment

This is custom documentation. For more information, please visit the SAP Help Portal 68
4/11/2019

Screen/Utility Action Name Access

Display Templates XMII_SSCE_MIICONTENT_DISPLAY_RWD Access to Display Templates screen of


MII Content.

Query Templates XMII_SSCE_MIICONTENT_QUERY_RWD Access to Query Templates folder of MII


Content.

MDO/KPI Objects XMII_SSCE_MIICONTENT_OBJECT_RWD Access to MDO/KPI Objects folder of MII


Content.

Resource Files XMII_SSCE_MIICONTENT_RESOURCE_RWD Access to Resource Files folder of MII


Content.

UI Elements XMII_SSCE_UIELEMENTS_ALL Access to UI Elements screen of Self


Service Composition Environment

Plant Information Catalog (PIC) XMII_SSCE_PIC_ALL Access to PIC screen of Self Service
Composition Environment

Plant Connectivity Integration XMII_RemotePCo_R Access to Plant Connectivity Integration


screen
XMII_RemotePCo_RW

XMII_RemotePCo_RWD

XMII_RemotePCo_Transport

XMII_RemotePCo_Publish

XMII_RemotePCo_PublishActivate

XMII_RemotePCo_PauseResume

XMII_RemotePCo_All

Data Services
You use the Data Services component in SAP Manufacturing Integration and Intelligence (SAP MII) to set up data source
connections and more.

See also:

Data Servers

Connection Status

Connections

Simulator Services

Shared Memory

Time Periods

Time Period Schedules

Data Buffer

To access the related screens on the SAP MII administration menu, choose Data Services.

This is custom documentation. For more information, please visit the SAP Help Portal 69
4/11/2019

Data Servers
Use
You use this function to maintain your data servers, which you use in query templates in the SAP Manufacturing Integration and
Intelligence (SAP MII) Workbench to browse data.

Integration
Before you con gure SQL connectors on the Data Servers screen, you must upload your JDBC drivers to SAP MII.

Features
The data server settings are as follows:

Parameter Type Description

Name String Unique name for the server

Connector String Class of the server determined by the data


source class

For more information, see Connectors.

Connector Type String Type of connection determined by the data


source class

The possible connector types are:

AGG (Aggregate)

ALARM

MDO

OLP (OLAP)

PCo

SQL

TAG

XCT

XML

KPIConnector

Enabled Boolean Indicator used to activate the server. You


can also click the Enable/Disable button.

AllowDynamicQuery Boolean Indicator used to support dynamic queries


for users with the Dynamic Query role.
When deselected, the data server does not
support dynamic queries.

Note

This is custom documentation. For more information, please visit the SAP Help Portal 70
4/11/2019
If a data server is enabled and you make changes to its parameters, the server is reloaded, and the updated settings are
effective immediately.

Using , you can re ne your search using a wildcard along with part of the name in any of the columns. The system will
automatically search, instead of you typing an entire name in the search box.

Activities
On the SAP MII administration menu, choose Data Services Data Servers to do the following:

Create servers

Copy servers

Note
After you copy a data server, you must reenter the password.

Edit server parameters

Enable or disable a server

Delete servers

See a summary of all the settings for a selected data server

View the connection status of your servers

See where your data servers are used

See also:

Virtual Servers

Data Buffer

Connectors
You use the following connectors to con gure your data servers.

AggregateConnector

AlarmSuite

DataSource

IDBC

IP21 and IP21OLEDB

InSQL

INSQLPCo Connector

MDOConnector

KPIConnector

OLAP
This is custom documentation. For more information, please visit the SAP Help Portal 71
4/11/2019
OLEDB (see Universal Data Connector)

OpenConnector

PCoConnector

Simulator

Universal Data Connector (UDC)

Catalog Connector

Virtual Servers

VirtualAlarm

VirtualIDBC

VirtualMDO

VirtualOLAP

VirtualPCo

VirtualTAG

VirtualXML

VirtualXacute

XMLConnector

XacuteConnector

You associate a connector with a connector type. For more information, see data servers.

Aggregate Connector
De nition
The aggregate connector joins multiple template queries into a single data set.

You can combine 32 query templates into a single aggregate data result set.

Use
You use the aggregate connector when you create an aggregate query.

The aggregate connector is an internal system connector and is enabled by default. You can assign permissions to the
connector. If you do not use aggregate queries, you can disable the connector.

Structure
The Aggregate Connector has the following modes:

ModeList

Returns the names of the supported modes

This is custom documentation. For more information, please visit the SAP Help Portal 72
4/11/2019
Query

Returns the result of the aggregate query

When you run an aggregate query, the Server parameter must be set to AggregateConnector. The SourceTemplate,
SourceName, and SourceTransform parameters combine the results.

AlarmSuite Connector
De nition
Enables a connection between SAP Manufacturing Integration and Intelligence (SAP MII) and Wonderware AlarmSuite.

Use
You use the AlarmSuite connector to insert parameter values into the FilterExpr and SortExpr parameters at runtime, using
[Param.1] to [Param.32]. You must use quotes to surround string literal values passed as parameters.

 Example
If you want to use an alarm group as input to the AlarmHistory query, you can con gure FilterExpr as the following:
FilterExpr: GroupName LIKE '[Param.1]'. The value from an applet or URL request is used as the value of [Param.1].

Structure
The AlarmSuite mode supports the recommended modes for an alarm connector. The structure of the AlarmSuite connector
depends on the following modes and parameters:

Data Query Modes

The associated data query modes are the following:

AlarmHistory

AlarmSummary

AlarmStatistics

You can use the following methods to calculate different statistics:

Time

The number of seconds a data point was in an alarm state.

TimePercent

The percentage of time during a time period in which a data point was in an alarm state.

 Example
If the time range is two hours and a data point was in an alarm state for 90 minutes, the percentage is 75%.

Frequency

The number of alarms during a time range.

This is custom documentation. For more information, please visit the SAP Help Portal 73
4/11/2019
FrequencyPercent

The percentage of alarms for each data point.

 Example
There are a total of 20 alarms, and Point A has 10 alarms, Point B has six alarms, and Point C has four alarms.
Therefore, the Point A percentage is 50%, Point B is 30%, and Point C is 20%.

The retrieval and calculations of the frequency methods use the RowCount parameter. You can use the FilterExpr
parameter to lter a subset of alarms.

Column Namespace Query Modes

The following column namespace query modes are supported:

AlarmHistoryColumnList

AlarmSummaryColumnList

These queries provide a list of columns that are returned from the AlarmHistory and AlarmSummary queries. You can use the
results to con gure the FilterExpr parameter to select data and the SortExpr parameter to order data. The SortExpr parameter
does not apply to the AlarmStatistics mode.

FilterExpr Parameter

The format of the FilterExpr parameter is like a WHERE clause of a SQL statement without the WHERE keyword.

 Example
To limit the history to tags in an alarm group, you can use the following
query:http://<servername>/Lighthammer/Illuminator?
Server=AlarmSuite&Mode=AlarmHistory&FilterExpr=GroupName%3D'Reactor'

SortExpr Parameter

The SortExpr parameter is a list of string values that correspond to columns for which data is sorted in the output. The format is
like the ORDER BY clause of a SQL statement without the ORDER BY keyword.

 Example
To order the AlarmSummary output based on the priority of the alarm and then by the time that the alarm came in (newest
rst), you can use the following query:http://<servername>/Lighthammer/Illuminator?
Server=AlarmSuite&Mode=AlarmSummary&SortExpr=Priority,LastEventDESC

Integration
You must con gure Microsoft SQL Server to listen on TCP/IP as the transfer protocol.

DataSource Connector
De nition

This is custom documentation. For more information, please visit the SAP Help Portal 74
4/11/2019
Allows SAP Manufacturing Integration and Intelligence to use any JDBC data source that is de ned in SAP NetWeaver.

Structure
The DataSource connector has the following properties on the Connection tab on the Data Serversscreen:

Date Pre x

Date Suffix

Retention Days

Internal Date Format

Max. Retry Count

Retry Interval

For more information about these properties, see MDO Connector.

Integration
You enter the data source connection as jdbc/[the SAP NetWeaver resource]. You must con gure the connection in
SAP NetWeaver.

For more information about JDBC data sources, see the SAP Help Portal at http://help.sap.com SAP NetWeaver SAP
NetWeaver 7.0 SAP NetWeaver 7.0 Library SAP NetWeaver Library Administrator's Guide SAP NetWeaver Security Guide
Security Aspects for System Management System Landscape Administration with SAP NetWeaver Administrator System
Management Con guration Work Center Application Resource Con guration Managing JDBC DataSources.

IDBC Connector
De nition
Enables a connection between SAP Manufacturing Integration and Intelligence (SAP MII) and a Java Database Connectivity
(JDBC) or Open Database Connectivity (ODBC) data source.

Structure
Many queries require date ranges. Many database vendors have their own syntax for performing date range comparisons in a
WHERE clause. The following parameters, which are de ned when you create a server, affect this behavior:

InternalDateFormat

DatePre x

DateSuffix

The IDBC connector supports the following modes. For more information, see Connector Modes.

TableList

ColumnList

FixedQuery

This is custom documentation. For more information, please visit the SAP Help Portal 75
4/11/2019
FixedQueryWithOutput

Query

Command

IP21 and IP21OLEDB Connectors


De nition
The IP21 Connectors connect SAP Manufacturing Integration and Intelligence (SAP MII) to AspenTech InfoPlus.21 (IP21) data
sources.

Use
You must install the IP21 ODBC driver and EasySoft JDBC/ODBC bridge before you con gure the IP21 connector. When you
con gure the server, make sure the connection URL and ODBC client con guration use the same data source name. You can
also use SQL Plus with the connector. You can use the IDBC connector to link to IP21, which allows you to issue any query that
can be constructed in SQL Plus.

The IP2OLEDB connector uses the OLE DB UDC connection instead of a JDBC connection. For more information, see Universal
Data Connector.

Structure
The IP21 and IP21OLEDB connectors support Current, HistoryEvent, History, and Statistics modes. You can also browse the IP21
namespace. The connectors can provide the following historical data retrieval:

History

Provides interpolated data retrieval.

HistoryEvent

Provides raw data values with time stamps from IP21.

If you there is no Method parameter value, the system uses the HistoryEvent parameter values to determine the
tables and columns for the query. If the Method parameter value is Compressed, the system uses the
CompressedHistoryEvent parameter values to determine the tables and columns for the query.

When you use the EasySoft JDBC/ODBC bridge, the format for the JDBCDriver parameter is easysoft.sql.jobDriver,
and the format for the URL parameter is jdbc:easysoft://SERVER:8831/DSN, where SERVER is the name of the machine
running the EasySoft NT service and DSN is the system data source name. If the bridge is running on the same machine as the
Web server, you can use localhost as the SERVER name.

Note
In the advanced settings of the ODBC administrator, deselect all indicators except the read-only indicator.

InSQL Connector
De nition
This is custom documentation. For more information, please visit the SAP Help Portal 76
4/11/2019
The connector that allows SAP Manufacturing Integration and Intelligence (SAP MII) to connect to the Wonderware
IndustrialSQL Server (InSQL) data source.

Use
When you con gure InSQL, con gure Microsoft SQL Server to listen on TCP/IP for better security con guration and data access
in distributed networks.

Structure
The following table describes the server parameters required to con gure InSQL to use the default TCP/IP protocol or OLEDB.

Parameter Data Type Description

URL String Driver-speci c string that de nes how to


access the database.

Default:
jdbc:inetdae:hammer9:1434?
database=Runtime&sql7=true

OLEDB:
jdbc:inetdae:hammer9:1433?
database=Runtime&sql7=true

User Name String Database-speci c user ID.

Default: wwUser

OLEDB: user account with permission to


query the Runtime database

Password String Database-speci c password.

Default: wwUser

OLEDB: password corresponding to the


User Name setting

UseOLEDB Boolean Determines what mode is used to query the


InSQL data.

Default: false (default for InSQL version 7.x


and earlier)

OLEDB: true (default for InSQL version 8.x


and later)

The following connector modes are supported:

GroupList

TagList

History

HistoryEvent

Statistics

Current

This is custom documentation. For more information, please visit the SAP Help Portal 77
4/11/2019
The connector provides current values for discrete and analog tags with all versions of InSQL. If the InSQL version is 7.1 or
newer, the connector also provides live values for string tags.

You do not need special modes to access the StringHistory, summary, and event tables of InSQL; you can use the IDBC
connector to access these. You do not need to license and con gure the IDBC connector; you can create a server in the IDBC
connector, which is identical to the server in the InSQL connector, and use the SAP MII Workbench to create your queries.

InSQLPCo Connector
De nition
The connector that allows SAP Manufacturing Integration and Intelligence (SAP MII) to connect to the Wonderware
IndustrialSQL Server (InSQL) data source.

Use
InSQLPCo connector is similar to InSQL connector except that InSQLPCo connectoer is of type PCo. It can be used in PCo and
Plant Information Catalog query as a source data server.

When you con gure InSQLPCo, con gure Microsoft SQL Server to listen on TCP/IP for better security con guration and data
access in distributed networks.

Structure
The following table describes the server parameters required to con gure InSQLPCo to use the default TCP/IP protocol or
OLEDB.

Parameter Data Type Description

URL String Driver-speci c string that de nes how to


access the database.

Default:
jdbc:inetdae:hammer9:1434?
database=Runtime&sql7=true

OLEDB:
jdbc:inetdae:hammer9:1433?
database=Runtime&sql7=true

User Name String Database-speci c user ID.

Default: wwUser

OLEDB: user account with permission to


query the Runtime database

Password String Database-speci c password.

Default: wwUser

OLEDB: password corresponding to the


User Name setting

This is custom documentation. For more information, please visit the SAP Help Portal 78
4/11/2019

Parameter Data Type Description

UseOLEDB Boolean Determines what mode is used to query the


InSQL data.

Default: false (default for InSQL version 7.x


and earlier)

OLEDB: true (default for InSQL version 8.x


and later)

You use the SAP MII Workbench to create your queries.

MDO Connector
De nition
A connector used to run queries against manufacturing data objects (MDO). For more information, see Connectors and
Manufacturing Data Object.

Use
You can have only one active MDO connector. If you want to use multiple MDO data sources where each data source has a
different DateTime value, do the following:

Set up the desired number of MDO JDBC data sources on the SAP NetWeaver server.

Specify the server on the System Properties screen in the MDO Data Source eld.

Enable the MDO connector with the appropriate DateTime pre x or suffix settings.

Disable the other MDO connectors.

Structure
The MDO connector has the following properties on the Connection tab on the Data Servers screen:

Property Use

Date Pre x De nes the pre x used when working with DateTime database
columns

Date Suffix De nes the suffix used when working with DateTime database
columns

Internal Date Format De nes the format used when working with DataTime database
columns

Max. Retry Count Used for data buffering.

Number of times the system retries the execution attempt before


stopping.

Retention Days Used for data buffering. For more information, see Data Buffer.

Number of days the execution attempt remains in the data buffer


before being removed

This is custom documentation. For more information, please visit the SAP Help Portal 79
4/11/2019
Retry Interval Used for data buffering.

Number of milliseconds the system waits before retrying the


execution attempt.

Integration
You must enter an associated MDO data source on the System Properties screen. To do so, on the SAP MII administration
menu, choose System Management System Properties.

You use the MDO connector when you create an MDO query. For more information, see MDO Query.

KPI Connector
De nition
A connector used to run queries against Key Performance Indicator (KPI).

Use
You can have only one active KPI connector. If you want to use multiple KPI data sources where each data source has different
dimensions and values, do the following:

Set up the desired number of KPI data sources on the SAP NetWeaver server.

Specify the server on the Data Provider screen in the KPI DataSource eld.

Enable the KPI connector with the appropriate.

Disable the other KPI connectors.

Structure
The property KPI Instance Name on the Connection tab of the Data Servers screen de nes the KPI connector instance that is
used.

Integration
You must enter an associated KPI data source on the System Properties screen. To do so, on the SAP MII administration screen,
choose System Management System Properties. You use the KPI connector when you create an KPI query. For more
information, see KPI Framework Query.

OLAP Connector
De nition
The On Line Analytical Processing (OLAP) Connector allows SAP Manufacturing Integration and Intelligence (SAP MII) to query
multidimensional data sources that support the XML for Analysis (XMLA) speci cation.

Use

This is custom documentation. For more information, please visit the SAP Help Portal 80
4/11/2019

To connect to a database using unique credentials and not a connection pool, add ServerUserName and
ServerUserPassword parameters to your applet code or to name-value pairs in the URL command line. You can access the
user name from the session through the {IllumLoginName} session variable in your applet code. You can also add script to
prompt the user for their user name and password.

To use the XMLA interface to Microsoft SQL Server, you must install the Microsoft XML for Analysis SDK on the database
server, in addition to the SQL Server Analysis Services components. This SDK install creates the web service interface within IIS.

For the SAP BW XMLA interface, you need to enable the XMLA Web service, which wraps the OLE DB for OLAP (ODBO) and
native interface, on the BW server. The Web service allows access to metadata (cubes, dimensions, measures) and data. You
can access BW cubes as well as operational data store (ODS) tables.

Structure
OLAP Connector modes are based on Multi-Dimensional Expressions (MDX) query construction. MDX is used to query OLAP
data sources through cubes, dimensions, and measures.

Cubes are subsets of data from the OLAP store, which are organized into multidimensional structures. Cubes allow better
response times to complex queries. Dimensions and measures are attributes of a cube. Dimensions provide category
descriptions into which measures are separated for analysis. Measures identify the numerical values for analysis, such as price,
cost, or quantity sold.

The following namespace modes are supported:

CubeList

The CubeList mode allows you to nd the list of cubes in a catalog. A catalog is similar to a database instance in a
relational database storage environment. The catalog is part of the SAP MII server con guration.

DimensionList

The DimensionList mode returns the dimensions for a given cube (Cube=<cubename>).

MeasureList

The MeasureList mode returns the measures for a given cube (Cube=<cubename>).

The Query mode executes an MDX through the XMLA service provided by the data store to retrieve data.

The following table describes some of the required server parameters for the OLAP Connector:

Parameter Description

Catalog Name of the server instance/cube/infoprovider to which you want


to connect.

ColumnNameAttribute String name used by the XMLA server implementation to retrieve


the returned column label.

DataSourceInfo Microsoft parameter for connecting to a data store.

DataTypeAttribute XMLA server ID used to return column data types with the response
document.

IP BW server address, IP address or server name of the machine that


is hosting the OLAP services.

Port Listening port for the XMLA services on the OLAP server or BW
server.

This is custom documentation. For more information, please visit the SAP Help Portal 81
4/11/2019
ResultInNamespace Indicator for returning SOAP responses from the XMLA server.

If the response element is referenced in a namespace, set the


indicator.

WebService Entry point to the XMLA services on the OLAP server.

Open Connector
De nition
The Open connector browses historical data in a relational database.

You can create tag queries in the SAP Manufacturing Integration and Intelligence (SAP MII) Workbench by browsing tag names
and descriptions and using time periods instead of writing SQL queries.

Use
The Open Connector can support the following connector modes:

ModeList

TagList

GroupList

Current

History

HistoryEvent

Statistics

Structure
The required server parameters are based on the mode of your server instance. The Open Connector is a special IDBC.

You can use tokens, or variables, in your query string. The system replaces the tokens with values at runtime based on the query
parameters. The tokens are listed below:

[TagName]

Replaced with tag names at runtime

[Mask]

Replaced with the speci ed mask at runtime. Allows you to use wildcard characters to perform LIKE clauses in the query
lter expressions.

[Group]

Replaced with the speci ed group at runtime. Represents a logical category that you can use to link individual tags.

PCo Connector
This is custom documentation. For more information, please visit the SAP Help Portal 82
4/11/2019

De nition
The Plant Connectivity (PCo) connector allows SAP Manufacturing Integration and Intelligence (SAP MII) to support the query
capabilities of PCo.

Use
When creating a PCo connection, you can do one of the following:

Manually enter the URL to the PCo management service

Retrieve the registered PCo instances from the System Landscape Directory (SLD)

To use this option, you must do the following:

Complete the initial setup of functional unit SLD using CTC templates

This is a standard procedure of the SAP NetWeaver SLD client con guration.

Register the PCo management service in the SLD

If the PCo management Web service interface requires authentication, you are prompted to enter your user name and
password.

Structure
The following table describes some of the required parameters for the PCo connector:

Parameter Description

Agent IP Machine name or IP address where the data server is installed

Agent Name Name of the PCo agent de ned in the PCo system

Agent Port Socket used for communication with the server

Date Pre x Pre x to the date string in date comparisons; corresponds to


delimiters that precede the date string when date values are
compared

Date Suffix Suffix to the date string in date comparisons; corresponds to


delimiters that follow the date string when date values are
compared

Internal Date Format Date format used to construct WHERE clause conditions; controls
the construction of the WHERE clause for date comparisons on
speci c databases and servers

Max. Retry Count Number of attempts to establish the connection

PCo Mgmt Service Password Password for the PCo management service user

PCo Mgmt Service URL URL of the PCo management service

PCo Mgmt Service User User name required to access the PCo management Web service
interface

Query Timeout (sec) Length of time that elapses before the connection request is
terminated

This is custom documentation. For more information, please visit the SAP Help Portal 83
4/11/2019

Parameter Description

Retention Days Number of days the query is cached in SAP MII so it can be run
later

Retry Interval (ms) Duration after which another connection attempt should be made

Server Package SAP MII Java class that is instantiated for the server

Not editable and not on the UI

Writable Indicator that determines whether you can update values on the
server

Status

A PCo connector can have the following statuses:

Running

Stopped

Error

You can either start or stop a PCo agent using relevant buttons.

Logs

You can view the logs for your PCo connector and lter them based on the following criteria:

Severity of the log messages

From and To dates and times

You can export logs in the following plain text format:

<Date> <Severity> <Log Message>

Integration
Query communication between SAP MII and PCo agents uses SAP MII binary protocol over TCP sockets. The Use SSL indicator
determines if secure socket is used. Secure socket and certi cate management is controlled by SAP NetWeaver. If an error
occurs while communicating with secure sockets, it is written to the server log le.

Communication between SAP MII and the PCo management service uses HTTP or HTTPS based on the PCo management
service con guration.

The PCo query template is used to query PCo agents.

More Information
For details on setting a PCo connection, see Query Process (with SAP MII).

Simulator Connector
De nition
This is custom documentation. For more information, please visit the SAP Help Portal 84
4/11/2019
The Simulator Connector connects to and queries a simulated tag database for the following:

Testing

Demonstration

Debugging

The Simulator Connector is con gured with an XML le that de nes groups, tags, and their values.

Integration
You edit the XML le using the Simulator Services screen.

See also:

Simulator Tag Operators and Functions

Simulator Tag Operators and Functions


Common arithmetic and Boolean operators can be used to create Simulator tag algorithms.

See also:

Simulator Connector

The following table lists supported operators in order of precedence from highest to lowest:

Operator Type Operator Use with Double Use with Complex Use with String Use with Vector
Variable Variable Variable Variable

Unary plus +x Yes Yes No No

Unary minus -x

Exponential power ^ Yes Yes No No

Division / Yes Yes No Yes

Multiplication * Yes Yes No Yes

Addition + Yes Yes Yes for addition No

Subtraction -

Not equal != Yes Yes Yes No

Equal =

Less than or equal <= Yes No No No


to
>=
Greater than or
equal to

Less than < Yes No No No

Greater than >

Boolean Not ! Yes No No No

This is custom documentation. For more information, please visit the SAP Help Portal 85
4/11/2019
Boolean Or || Yes No No No

Boolean And &&

The following table lists the functions that can be used to create Simulator tag algorithms:

Function Name Function Use with Double Use with Complex Use with String Use with Array
Variable Variable Variable Variable

Sine sin() Yes Yes No No

Cosine cos() Yes Yes No No

Tangent tan() Yes Yes No No

Arc sine asin() Yes Yes No No

Arc cosine acos() Yes Yes No No

Arc tangent atan() Yes Yes No No

Hyperbolic sine hsin() Yes Yes No No

Hyperbolic cosine hcos() Yes Yes No No

Hyperbolic tangent htan() Yes Yes No No

Inverse hyperbolic asinh() Yes Yes No No


sine

Inverse hyperbolic acosh() Yes Yes No No


cosine

Inverse hyperbolic atanh() Yes Yes No No


tangent

Natural logarithm ln() Yes Yes No No

Logarithm Base 10 log() Yes Yes No No

Angle angle() Yes No No No

Absolute abs() Yes Yes No No


Value/Magnitude

Random number rand() No No No No


(between 0 and 1)

Modulus mod() Yes No No No

Sum sum() Yes No No No

Real component re() No Yes No No

Imaginary im() No Yes No No


component

 Example
The following list shows examples of Simulator tag algorithms:

m^(-((s/40)^2)) * 80

s^3 / 1e4

This is custom documentation. For more information, please visit the SAP Help Portal 86
4/11/2019
h +h^2/1e3 - m^3/1e4

sin(s/20) * 50

(sin(m/10) > 0)*sin(m/10)*50

Universal Data Connector


De nition
The universal data connector (UDC) is a framework that allows access to SAP Manufacturing Integration and Intelligence (SAP
MII) services through proprietary server applications that you develop.

The OLEDB connector is a UDC that allows access to OLE DB data sources.

Use
The UDC communicates with remote universal data servers (UDS) using TCP/IP sockets. The UDS receives a request from the
UDC, including the appropriate parameters such as mode, tags, date intervals, and so on, and the UDS processes the input or
output to the underlying data source. The UDS returns status and data to the UDC, and the UDC passes it to the requesting
client.

Note
You can develop a universal data server (UDS) in any language. SAP provides UDS applications that use the UDC framework.
For more information, see the SAP Service Marketplace at service.sap.com.

The UDC allows data access from platforms that do not natively support communications with the underlying data source. For
example, it allows a Linux Web server to acquire data from an HMI package running on a Windows 98 PC.

The UDC allows remote data access when the data source does not. Therefore, if the data source API does not support IP
requests, you can run the UDS on the same computer as the data source and communicate to the SAP MII Web server through
TCP/IP.

The system sends mode requests to the UDS for processing. If the requested mode is not supported, the UDS returns an error.

Structure
The following table describes some UDC server parameters:

Parameter Data Type Use

IP String IP address or machine name where the


UDS, not necessarily the data source, is
running

Port Integer Port on which the UDS is listening.

We recommend that you use a different port


for each UDS instance; the UDS and UDC
instance settings must match.

QueryTimeout Integer Number of seconds the system waits for a


response from the UDS.

This is custom documentation. For more information, please visit the SAP Help Portal 87
4/11/2019
The QueryTimeout parameter should be
optimized for the UDS and network
connection between the UDC and UDS. The
default value is 10 seconds.

Name String Unique name for the server.

Writable Boolean Allows the UDS to write data to tags.

If you enable this function, you should


create another server instance with
separate access permissions.

Virtual Servers
Use
You use the SAP Manufacturing Integration and Intelligence (SAP MII) virtual server connectors to query data on another SAP
MII instance without con guring a direct connection to the data source. A virtual server allows SAP MII instances to pass data to
each other as if each was directly connected to the other server's data source. You use virtual servers when you are spanning
large distances across a network. They limit the load on the network since data is transferred using an efficient binary protocol.

Features
A virtual server provides the same capabilities as the underlying connector; however, the virtual server uses a data server on
another SAP MII instance as the data source. The capabilities are dependent on the underlying connector.

The following table describes properties of an SAP MII virtual server:

Property Description

Connector Virtual server connectors include the following:

VirtualAlarm

VirtualIDBC

VirtualOLAP

VirtualTAG

VirtualXML

VirtualXacute

VirtualPCoConnector

VirtualCatalogConnector

Connector Type The connector type is based on the virtual server type.

Connector types include the following:

SQL

Tag

Alarm

XML

XCT
This is custom documentation. For more information, please visit the SAP Help Portal 88
4/11/2019
OLP

Description Information only.

Enabled Indicator used to activate the server.

IP IP address of the remote server; the machine name in most


networks.

LegacyURL Indicator for using an 11.x server in the URL. If selected, the URL
includes /Lighthammer/ and not /XMII/.

Port Port number on which the remote SAP MII server is listening.

Protocol Http is the default setting.

If you are using a secure socket layer (SSL), you can enter https.

RemoteLoginName Name used to log on to the remote server and access data when a
query is executed against it.

The local user account is not used at the remote server. The name
must have proper permissions at the remote server or the queries
are not executed.

RemoteLoginPassword Password for the RemoteLoginName.

RemoteLoginServer Data source, or server name, in the remote SAP MII server
con guration.

RemoteServerName Virtual server at the local SAP MII server.

ServerPackage An internal system setting that cannot be edited.

TZOffset (time zone offset) Used to correct time differences (in minutes) between the local
SAP MII server and the remote server. See an example below.

The time zone offset only works with applets.

 Example
You are working on a server in Michigan (TimeZone = EST, GMT-5) and want to retrieve data from a server in California
(TimeZone = PST, GMT-8).

You want to know the California data from the Michigan rst shift time period. If you set the TZOffset to -180 (three hours
later), you use local time period = FirstShift in your query. The FirstShift time period is 8:00 AM to 4:00 PM EST (GMT-5). The
query runs in California from 5:00 AM to 1:00 PM and the resulting data are returned to the Michigan server.

If you want the data from the rst shift in California, set the TZOffsetvalue to zero.

XML Connector
De nition
The XML Connector allows you to connect to and query any XML-compliant data source and return data in SAP Manufacturing
Integration and Intelligence (SAP MII) format.

You send the data as XML using XSL transformation.

This is custom documentation. For more information, please visit the SAP Help Portal 89
4/11/2019

Use
The system includes a default XML connector. If you want to allow security access to speci c XML documents or queries, you
add other XML connector server instances and set server permissions for each instance.

You must transform the XML data from the data source to SAP MII XML format using an XSL Transformation (XSLT) le. For
SAP MII to process the data, the XSLT le, data source, and query must be referenced.

An XSL style sheet contains instructions for formatting a class of XML documents. The style sheet consists of the following:

A language for transforming XML documents

An XML vocabulary for specifying formatting semantics

If you want to use the XML Connector to retrieve data from one XML source and send it to another system, you must apply a
style sheet to the SAP MII-formatted data to make it available to the other system.

Structure
Each data query returns an XML Document Object Model (DOM). Since XML is case-sensitive, the XML output must use correct
element and node names.

The XML data le includes the following levels:

Rowsets

Rowset

Columns

Rows

Rowsets contains the following attributes:

Document creation date

Software version

Start Date (SD) and End Date (ED) settings used by the query

The Columns node contains metadata, and is followed by one or more Row elements. The metadata describes columns, which
can be mapped into SAP MII display objects or used in KPI calculations and agent activities. The Columns node requires the
following attributes:

Column name

Data source column name

Description

Data type

See SQL Data Types for Columns.

Minimum and maximum range

The Rows node contains data returned by the query object. Each data set is returned as a separate data element in a Row
node.

This is custom documentation. For more information, please visit the SAP Help Portal 90
4/11/2019

XML Connector Capabilities


The following capabilities apply to the XML Connector.

XMLQuery Mode
With this mode, the URL query and associated style sheet conversion is dynamically constructed by the connector using the
URL and Transform parameters. For example, the URL is http://livestockdata.com/StockPrices?Ticker=IBM and
the Transform is http://localhost/Styles/StocksToIlluminator.xsl or
C:\Inetpub\wwwroot\Styles\StocksToIlluminator.xsl.The URL contains the source le, and the Transform
contains the fully quali ed style sheet reference.

Date Placeholders
You use the StartDate(SD) and EndDate(ED) placeholders to insert the date and time values into the XML query string at
runtime. These dates are calculated by the system based on the query parameters. You use these placeholders in the
JoinExpr or FilterExpr parameters in Query mode and the Query or QueryParams parameters in FixedQuery or
Command mode. For example, http://weatherserver
?getHistoricalRainfall&PeriodBegin=[SD]&PeriodEnd=[ED].

The system recognizes queries with date placeholders as time-based queries and enables the time navigation bar on related
display applets.

Parameter Placeholders
You insert parameter values into an XML query at runtime using parameter placeholders [Param.1] to [Param.32].

For example, if you use an XML query to return open work orders for a department from the ERP system, you could use the
following URL:

http://erpsystem?method=output&requesttype=AB_OpenOrd&WorkCenter=[Param.1]&WorkStatus=Open.

SQL Data Types for Columns


The following table lists values for the SQLDataType attribute of the Columns node. For more information, see XML
Connector.

Data Type SQLDataType Value

Bit (Boolean) -7

Tiny Integer -6

Big Integer -5

Long Variable Binary -4

Variable Binary -3

Binary -2

Long Variable Character (String) -1

Null 0
This is custom documentation. For more information, please visit the SAP Help Portal 91
4/11/2019

Character (String) 1

Numeric 2

Decimal 3

Long Integer 4

Short Integer 5

Float 6

Real 7

Double 8

Variable Character 12

Date 91

Time 92

Date and time (TimeStamp) 93

Xacute Connector
De nition
The Xacute Connector enables you to retrieve and view output from a transaction.

Use
The Xacute Connector supports the following modes:

ModeList

Returns the names of the supported modes. For example,


http://<server>/XMII/Illuminator?Server=XacuteConnector&Mode=ModeList.

Query

Runs a transaction and returns speci ed output. For example,


http://<server>/XMII/Illuminator?Server=XacuteConnector&Mode=Query&Transaction=
<TransactionName>&OutputParameter=<outputParameter>&Folder=<folder>.

TransactionFolderList

Lists folders and their parents under the default transaction folder. For example,
http://<server>/XMII/Illuminator?Server=XacuteConnector&Mode=TransactionFolderList.

TransactionInputList

Lists inputs for a transaction. For example,


http://<server>/XMII/Illuminator?Server=XacuteConnector&Mode=TransactionInputList
&Transaction=<TransactionName>&Folder=<folder>.

TransactionList

This is custom documentation. For more information, please visit the SAP Help Portal 92
4/11/2019
Lists transactions for a speci ed folder. For example,
http://<server>/XMII/Illuminator?Server=XacuteConnector&Mode=TransactionList&Folder=
<FolderName>.

TransactionOutputList

Lists available outputs for a speci c transaction. For example,


http://<server>/XMII/Illuminator?Server=XacuteConnector&Mode=TransactionOutputList
&Transaction=<TransactionName>&Folder=<folder>.

Structure

If the AutoBind parameter is set to True and an Xacute query is called from a Web page, session variable values are
automatically mapped to the transaction that has transaction properties with the same names as the session variables.

Create a transaction input property of type String with name MYSAPSS02. When this transaction is executed using a Xacute
query, the string value is added with SAPSS02 ticket, which is then linked to actions. You can map the ticket to
SAPSS02Ticket property of SAP JCo Start Session or SAP JCo Interface actions.

Catalog Connector
Use
The Catalog connector allows SAP Manufacturing Integration and Intelligence (SAP MII) to query Plant Information Catalog. The
Catalog connector always points to the local Plant Information Catalog.

Integration
You use the Catalog connector when you create an catalog query. For more information, see Catalog Query.

Connector Modes
The following modes are supported by various SAP Manufacturing Integration and Intelligence (SAP MII) connectors:

ColumnList

Returns a list of the columns in the selected table. To select the table, use the Group parameter. The Mask parameter
can be used to lter the list of columns returned from the query.

Current

Provides current values for discrete and analog tags.

FixedQuery

Requires the entire SQL statement to be passed through the Query and QueryParams parameters.

GroupList

Finds tag groups de ned in the connector. The tag groups include the system-de ned groups, such as All Analog Tags, All
Discrete Tags, and so on, and user-de ned public and private groups. The user ID and password used to connect to the
database controls which private groups are displayed in the results of the query. This mode can be used with the Mask
parameter, which enables you to return only those groups that match the mask pattern.

This is custom documentation. For more information, please visit the SAP Help Portal 93
4/11/2019
History

Provides interpolated historical values for analog and discrete tags. You can specify the number of rows or retrieval
resolution for interpolation. If you enter a Resolution parameter value, the connector retrieves evenly-spaced values
until the RowCount parameter value is reached. If you do not provide a Resolution parameter value, the connector
returns an evenly-spaced number of values based on the RowCount parameter value.

For example, if the time interval is one hour, Resolution is 15, and RowCount is 240, the connector returns a value
every 15 seconds until it reaches 240 values.

HistoryEvent

Provides historical values for analog and discrete tags as they are stored by the connector. This mode does not provide
interpolated values.

Statistics

Ensures statistical measurement precision, especially for the time-weighted average, using the storage time and values
from the historical database. When the connector is retrieving data for statistical calculations, it uses the same process
as the HistoryEvent mode.

TableList

Returns the list of tables de ned in the database. The Group parameter can be used to lter the TableList query to
select only system tables, user tables, or views. The Mask parameter can also be used to lter the list of tables returned
from the query.

TagList

This mode allows you to nd tags de ned in the connector. You can use this mode with the Group and Mask parameters.
If you include a Group parameter value, tags for that group are displayed. You can use the Mask parameter to return
only those tags that match the mask pattern.

Server Parameters
You con gure the following parameters for servers that use the SAP Manufacturing Integration and Intelligence (SAP MII)
database access system. Some parameters only apply to certain data server types.

Note
Before you con gure SQL connectors on the Data Servers screen, you must upload your JDBC Drivers. To nd JDBCDriver
and ServerURL parameter values, see your database provider's information. For a list of drivers registered with Sun
Microsystems, see developers.sun.com.

Parameter Description

Autobind SAP MII Workbench connector parameter that passes parameters


with the same names as the input parameters for the transaction to
SAP MII and includes their values.

If you do not select this checkbox, you must assign input


parameters to the standard parameter names using the Xacute
Query template.

DatePrefix Pre x to the start date and end date parameters in query
templates used to format the date to match the database
con guration.

This is custom documentation. For more information, please visit the SAP Help Portal 94
4/11/2019
If you are connecting to a Microsoft SQL server database, the
typical pre x is a single quote. If you are connecting to an Oracle
database, an example of a pre x is GetDate('.

DateSuffix Suffix to the start date and end date parameters in query
templates used to format the date to match the database
con guration.

If you are connecting to a Microsoft SQL server database, the


typical suffix is a single quote. If you are connecting to an Oracle
database, an example of a suffix is
','MM/DD/YYYY HH24:MI:SS').

Description Text eld for additional information about the data server.

InitCommand Command used by the database connector that is run when a


connection pool is created.

You can use it to set the database locale in Oracle.

InternalDateFormat Date format used to construct WHERE clause conditions. Controls


the construction of the WHERE clause for date comparisons for
speci c databases and servers.

IP Machine name or internet protocol (IP) address from where


requests are made.

For a universal data connector (UDC), the IP is where the universal


data server (UDS) is installed.

For an SAP MII connector, the IP is the machine name where the SAP
MII is running. For anything running on the local machine, enter
localhost.

JDBCDriver Java Database Connectivity (JDBC) driver classpath used to


connect to the server.

See JDBC Drivers.

Password Password to connect to the database.

The password eld shows six asterisks even if your password has
more or less characters or is blank.

Passwords are not passed between browser clients and the


database. The Servers.xml le is not accessible through the
Web server.

PoolMax Maximum number of connections the pool allocates.

If a request is received and all connections are in use and


allocated, the query waits for an available connection or the
speci ed timeout period.

PoolSize Number of connections to be established with the database when


the connection pool is initialized.

Port Socket used for communication with the server.

For the UDC, the port is a direct socket communication and is the
port that is con gured in the agent de nition.

For the SAP MII connector, it is the HTTP port on which SAP MII is
listening (NetWeaver HTTP port).

Protocol Protocol for URL requests for the server. It is used by SAP MII and
proxy connectors and is de ned as HTTP or HTTPS.

This is custom documentation. For more information, please visit the SAP Help Portal 95
4/11/2019
QueryTimeout Length of time that elapses before a UDC and OLEDB connector
request is terminated.

For example, if the QueryTimeout value is ve seconds and it


takes 10 seconds to retrieve the requested data, the query request
is terminated.

ServerPackage SAP MII Java class that is instantiated for the server.

Do not change this parameter.

ServerURL Driver-speci c string that de nes how to access the database.

For example, with the Microsoft SQL Server 2000 JDBC driver, the
ServerURL is: jdbc:inetdae://
hammer9:1433?database=MyDatabase&sql7=true. The
SQL server on machine hammer9 is connected to the
MyDatabase database using TCP/IP port 1433.

For additional URL parameters, see the documentation from the


vendor of the JDBC driver you are using.

SimulatorInstanceName List of tags and their values used by the simulator to store
con guration information.

TimeOut Length of time (in minutes) that elapses before an unused


connection expires and its resources are released back to the
server. The connection pool maintains a minimum number of
connections and, if necessary, creates a new connection.

UseCount Number of times a connection can be used before it is terminated


and its resources are released back to the server.

This parameter is only required for ODBC data sources that have
resource leaks when they execute many statements.

User Name Database-speci c user ID.

ValidationQuery Query used to determine if a database connection is valid.

For example, when using Microsoft SQL Server, you can use
SELECT GETDATE() or SELECT * FROM Orders WHERE
OrderId=-1.

The query does not have to return rows, but it must succeed.

WaitTime Amount of time SAP MII waits for a connection before it fails.

Writable Indicator used by the UDC and OLEDB connectors to determine


whether you can update values in the server.

See also:

Virtual Servers

Connection Status
Use
You use the Connection Status screen to display the status of your enabled database servers.

This is custom documentation. For more information, please visit the SAP Help Portal 96
4/11/2019

A table lists your database servers. If a row is red and the No. of Available Connections column displays 0, the connection to
your data source is not available. If the connection is successful, the No. of Available Connections column displays 1 or higher.

Features
If a server has no available connections, a con guration, network, or communications problem is preventing SAP Manufacturing
Integration and Intelligence (SAP MII) from connecting to the server.

Note
The Connection Status screen only shows information for Java Database Connectivity (JDBC) servers in which a connection
pool is built. Most tag-based servers, such as Universal Data Servers (UDS), do not respond to a status check.

Activities
To display the connection status, do one of the following:

On the SAP MII administration menu, choose Data Services Connection Status .

On the SAP MII administration menu, choose Data Services Data Servers , and choose the Status tab page.

If you cannot establish a connection, do the following:

Con rm your settings for User, Password, and ServerURL on the Data Servers screen.

Verify that the Web server has the necessary security privileges to communicate with the data server.

Connections
Use
You use the Connections screen to create connections and assign aliases to the connection properties. You can use the aliases
in actions in the SAP Manufacturing Integration and Intelligence (SAP MII) Workbench instead of entering the connection details
in the action con gurations.

Integration
You de ne user name and password aliases on the Credential Stores screen and assign users to connections. For more
information, see Using Credential Stores.

Features
You choose among the following connection types, which are used by related actions:

BC (SAP Business Connector)

WAS (SAP NetWeaver Application Server)

JCO (SAP Java Connector)

FTP (File Transfer Protocol)

MAIL (E-mail)

This is custom documentation. For more information, please visit the SAP Help Portal 97
4/11/2019
JMS (Java Message Service)

EJB (Enterprise JavaBeans)

CR (Crystal Reports)

HANA SDA

To maintain a HANA SDA connection in SAP MII system, you must provide a valid MII user name, password, and port
number at which the HANA SDA adapter listens for requests from the HANA studio. In HANA system, you must create a
remote data source in HANA studio using the same credentials as provided while creating the HANA SDA connection.
This user must be a valid MII user who is assigned XMII_Developer role.

Additionally, you must provide the adapter instance (IP address of the MII instance and the port at which the adapter is
con gured to run and listen for requests as maintained for the connection). On connecting to HANA studio, all projects in
SAP MII system having PCo/Xacute query templates are displayed. You can select and add a query template as a virtual
table. The added virtual columns cannot be con gured. The Value column contains the tag values. You can query the
generated table using SQL as shown below:

Select * from "HANA_USER"."VIRTUALTABLE" where "TagName" = 'PCoTag' and "IntervalCount"


= 2

Note
Only PCo and Xacute queries are supported.

When you add PCo query template, the selected secondary and metadata properties are added as columns in
virtual table. This feature of adding metadata properties as columns is supported from 15.1 SP01 release.

TagName is a mandatory lter clause when you query the virtual table.

The datatype of the Value column can be con gured based on the Digital Settings property in the PCo Query
Template. The default datatype is Double and is Varchar when the property is selected.

Caution
For HANA SP10 and higher release, the support to create virtual tables on remote calculation views is disabled. You
can get the old behavior working by executing the below query:

ALTER SYSTEMALTER CONFIGURATION ('indexserver.ini', 'SYSTEM') SET


('smart_data_access', 'enable_hana_odbc_sql_table') = 'true'WITH RECONFIGURE;

Simulator Services
Use
You use the Simulator Services screen to edit, add, and delete tags and groups for your simulator instances.

Prerequisites
You have already made a copy of the default Simulator data server instance or you created a new Simulator data server
instance to which you can make changes.

Features

This is custom documentation. For more information, please visit the SAP Help Portal 98
4/11/2019
A tag de nition consists of the following:

Type

Analog

Returns oat values such as 189.83.

Discrete

Returns 1 or 0.

String

X65 Returns values such as C23 and X65.

Minimum Value and Maximum Value

These values are used for server side scaling.

Writable

Allows you to write a new value to a tag name. For example, you can change a tag value to simulate a product
changeover on a line. If tag Line1Product has a default value of X65, you can write a new value of ABC123 to it.

Note
If you change the Writable indicator from selected to not selected for a tag, the Value entry must be an expression.

Value

You can use the following values with operators and functions in an algorithm:

The current hour

The current minute

The current second

The current row of the result set

The total number of rows in the result set

For more information, see Simulator Tag Operators and Functions.

Activities
To edit your Simulator data server instance, on the SAP MII administration menu choose Data Services Simulator Services .

You must de ne at least one tag and assign it to a group.

This is custom documentation. For more information, please visit the SAP Help Portal 99
4/11/2019

Shared Memory
Use
You use the Shared Memory screen to view shared properties that are de ned in the SAP Manufacturing Integration and
Intelligence (SAP MII) Workbench. On this screen, you change or delete the current value of a shared property.

The existing default values of shared properties that are migrated with a project are not overwritten. To change the default
value of a shared property, you must change it in the SAP MII Workbench.

Integration
You de ne shared properties for your project in the SharedProperties.mem le on the Meta-Inf tab page of the SAP MII
Workbench. You de ne the default value for the property here.

Features
Following are few features of Shared Memory:

Active versus Design

When the SharedProperties.mem le is con gured, the property is set to be used. However, the value is not re ected
in the active memory until the property is used.

Remove a property from active memory

You can assign a null to the property through a link editor or delete the property using the Shared Memory admin UI. The
following functions will clear the property from the de ned links:

All types (as of 12.1 SP5 b35) - null

Numeric types: nullnumber

String : nullstring

Datetime: nulldate

Map/list: You can assign emptymap, emptylist to these properties to clear them out, but they can only be cleared
through the admin UI.

Admin UI

Allows you to see the active memory value for the shared properties. You can lter the properties by different projects.
You can change/remove the active values by the following UI:

xMII 12.1 – Data Services Shared Memory

MII 2.2 – MII Workbench Administration screen Tools

Inline versus Persistent

Inline properties are stored in a hash map in server memory. Inline properties do not persist and are not
recoverable after system restart.

The hash map is not cluster safe by design. The map is used for quick storage and retrieval of values.

Persistent properties are stored in the XMII_DB_MEMORY table of the MII data source. It is cluster-safe and
persists after system restart, but is slower as each storage or retrieval of values requires a call to the table.

This is custom documentation. For more information, please visit the SAP Help Portal 100
4/11/2019
Timeout

Timeout is a con gurable parameter for each shared property. The default value is -1 for a property to sustain. If
the timeout is de ned, then the property will expire that many seconds after its last access. Once a property is
stored or retrieved, the counter for the property expiration is reset.

A system thread, Shared Property Cleanup is available that runs once a minute to check the active memory
properties for expiration. If expired, this thread will perform the cleanup.

Protected/Namespace

Specifying a namespace helps to lock down properties for a speci c folder within a project. A namespace can be
con gured as Project.Folder, and then only transactions from within that folder and subfolders will be able to access
those variables.

Caching

The caching indicator for shared properties indicate the default value of the property.

If the indicator is True/On, then the property has no default value. In other words, the property does not exist in
active memory and if accessed, a null is returned.

If the indicator is False/Off, then the default value de ned in the design time UI is returned and is set in the active
memory.

Activities
To view or change the value of shared properties in the system, on the SAP MII administration menu, choose Data
Services Shared Memory.

Time Periods
De nition
A set amount of time that you use to perform tasks such as viewing reports and retrieving data.

Use
You de ne time intervals for production shifts and reporting periods.

You reference time periods in the following places:

Web pages

Applets

Queries

Hyperlinks

To add, edit, or delete time periods, on the SAP MII administration menu choose Data Services Time Periods. . You can also
create localized time periods. To do so, you create a time period with relevant details and create localized texts for the same in
Localization screen.

Structure

This is custom documentation. For more information, please visit the SAP Help Portal 101
4/11/2019
You cannot edit or delete the following time periods, which are de ned by the system:

CurrentMonth

CurrentShift

CurrentYear

PreviousMonth

PreviousShift

PreviousYear

The CurrentShift and PreviousShift time periods are used with schedules.

Time Period Schedules


De nition
A logical grouping of time periods.

Use
You use a time period schedule to return data from a particular shift.

To access the Time Period Schedules screen, on the SAP MII administration menu, choose Data Services Time Period
Schedules.

Structure
Each schedule must have a unique name. You must add one or more time periods to the time period schedule in chronological
order. The system determines which schedule to use based on the current time and the time period.

Example
Plant A runs three shifts a day:

First shift, from today at 8:00 AM to today at 4:00 PM

Second shift, from today at 4:00 PM to today at 12:00 PM

Third shift, from today at 12:00 AM to 8:00 AM

To return data for a shift, you de ne the Schedule and TimePeriod parameters in the query. In the TimePeriod parameter, you
enter CurrentShift to return the current shift's start and end times or you enter PreviousShift to return the start and end times
from the shift that ended before the current shift.

At 9:00 AM, you use the query Schedule=SampleShiftSchedule&TimePeriod=CurrentShift to retrieve the rst shift time period
because that is the schedule that is currently operating. If you query
Schedule=SampleShiftSchedule&TimePeriod=PreviousShift at 9:00 AM, the system returns the time period for the third shift.

Data Buffer
This is custom documentation. For more information, please visit the SAP Help Portal 102
4/11/2019

Use
You use data buffering to handle errors that occur when you send SAP Manufacturing Integration and Intelligence (SAP MII)
query or action requests to external systems. When errors have been corrected, you resend the data.

You enable data buffering for the following data servers:

InSQL Connector

IP21 Connector

Open Connector

OLEDB

AlarmSuite Connector

Universal Data Connector (UDC)

OLAP Connector

IDBC Connector

Xacute Connector

KPI Connector

PCo Connector

Catalog Connector

MDO Connector

See Connectors.

Prerequisites
You have set the following properties for your data servers:

Name Property Description

Retention Time in Days DaysRetention The number of days the system keeps the
data buffer entry

Max. Retry Count MaxRetryCount The maximum number of times you can
resubmit requests

Retry Interval RetryInterval The number of milliseconds the system


waits before resubmitting the query or
action request. The scheduler adds one
minute to this time.

Processing Type ProcessingMode


Synchronous Processing

The RFC is executed immediately,


and the transaction waits for a
response from SAP ECC. If an error
occurs, the system does not
execute the RFC again.

Asynchronous Processing on
Error

This is custom documentation. For more information, please visit the SAP Help Portal 103
4/11/2019
The RFC is executed immediately. If
the RFC cannot be executed
because of network or connectivity
issues, the action is added to the
data buffer for future execution.

Asynchronous Processing

The RFC is not executed


immediately, but it is added to the
data buffer to be executed later.
The transaction continues without
waiting for a response from SAP
ECC.

If you are using the following actions, you have set the above properties on the action's con guration screen:

HTTP Post

HTTP XI

SAP JCo Execute Queue

SAP JCo Function

SAP JCo Interface

SAP JRA Function Call

Web Service

Web Service XI

On the General screen of your query in the SAP MII Workbench, you have selected the Allow Buffering checkbox.

Features
You view a summary of data buffering jobs or you view, reset, and delete data buffering entries. For more information, see Data
Buffer Jobs and Entries.

Activities
The following steps describe the data buffering process:

1. You send a query or action request to an external system.

2. If the request fails because of a communications error, the system writes a data buffer entry to the SAP MII database.

3. The system checks the database for failed entries and sends a request to a Java Message Service (JMS) queue to
resubmit the query or action.

Note
If the query or action was already resubmitted from the buffer, it has a buffer entry ID. Once the retry limit is reached,
the entry is no longer considered for submission.

4. A data buffer processor listens to the JMS and resubmits the requests.

This is custom documentation. For more information, please visit the SAP Help Portal 104
4/11/2019

Data Buffer Jobs and Entries


Use
You use the Data Buffer screen to view a list of queries and actions that enable data buffering and failed to connect to their
data servers.

You also view queries and SAP Java Connector (JCo) action communications that failed and are waiting to be resubmitted.

You perform the following actions on data buffer entries:

View details

Reset

You set the number of retries to zero and resubmit an entry the maximum number of times.

View history

Note
If you reset an entry, the system saves historical data from the initial submissions.

Delete

For more information, see Data Buffering.

Features
You lter the entries by server and status.

Possible statuses are the following:

Completed with errors

The entry was submitted successfully, but it failed for a reason other than a communications error.

Error

The entry failed due to a communications error.

Expired

The status indicates that the number of days as stated by the DaysRetention setting on the Data Servers screen, has
passed. Only the status is changed as per the setting. The entry still remains in data buffer.

Failed

The maximum number of retry attempts, which is determined by the MaxRetryCount setting on the Data Servers
screen, has been reached and all retries failed.

Initial

The entry is new to the queue and has not been resubmitted.

Resubmitted

The entry has been resubmitted for execution.

This is custom documentation. For more information, please visit the SAP Help Portal 105
4/11/2019
Waiting

The entry is waiting to be resubmitted for execution.

Comments are read from the query and SAP JCo action con gurations in the SAP MII Workbench.

Activities
To view, reset, or delete a data buffer entry, on the SAP MII administration menu , choose Data Services Data Buffer and click
the appropriate icon next to the entry.

Note
If you keep the Data Bufferscreen open for some time, refresh the page to see the current status of the entries.

This is custom documentation. For more information, please visit the SAP Help Portal 106