Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpiCore)  1.26.2
Server version since 1.26.0.0 (MLC-FW: 14V22)
Collaboration diagram for Server version since 1.26.0.0 (MLC-FW: 14V22):
Note
Since firmware version 14V22 (MLPI-Server-Version: 1.26.0.0) a centralized permission management has been implemented in target controls XM2, L75 and VPx. Some permissions have been summarized in order to improve their usability. Additional information regarding the usage of older manifest files (i.e. accounts.xml) with newer server versions can be found in Manifest since server version 1.26.0.0.
Users of other CML controls (i.e. L25, L45, L65) have to use the old permissions as defined in Server versions before 1.26.0.0
List of valid permissions for mlpiApiLib. These permissions shall be assigned to the groups (i.e. in the group manifest file groups.xml) rather than the users.
Permission-Ident Description
APILIB_DEBUG Debug connections - Allows to debug MLPI/MLPIS connections, e.g. benchmark and stability tests
APILIB_STATUS Get connection status - Allows to get the status of of MLPI/MLPIS conntections
APILIB_MANAGEMENT Manage connections - Allows to manage MLPI/MLPIS connections, e.g. enumerate connects or modify, close arbitrary connections
APILIB_DEPRECATED Use deprecated functions - Allows to use deprecated functions, it is recommended to not use functions that need this permission

The following table provides the minimum server version (Server versions of MLPI) and the user permission required to execute each of the methods supported by the mlpiApiLib library.

Note
Functions with permission "IMPLICIT" cannot be blocked. Everybody with the permission to use the MLPIS protocol is able to trigger this functions
List of available functions in mlpiApiLib and the permissions required for their use.
Function Server version Permission-Ident
mlpiApiConnect 1.0.0.0 "IMPLICIT"
mlpiApiDisconnect 1.0.0.0 "IMPLICIT"
mlpiApiSetDefaultTimeout 1.0.0.0 "IMPLICIT"
mlpiApiGetDefaultTimeout 1.0.0.0 "IMPLICIT"
mlpiApiIsConnected 1.0.0.0 "IMPLICIT"
mlpiApiTestConnection 1.0.0.0 "APILIB_DEBUG"
mlpiApiDelay 1.0.0.0 "APILIB_DEBUG"
mlpiApiGetClientCoreVersion 1.0.0.0 "IMPLICIT"
mlpiApiGetServerCoreVersion 1.0.0.0 "APILIB_STATUS"
mlpiApiSetNameOfConnection 1.1.0.0 "APILIB_STATUS"
mlpiApiSetLabelOfConnection 1.1.0.0 "APILIB_STATUS"
mlpiApiGetOwnConnectionDescription 1.1.0.0 "IMPLICIT"
mlpiApiGetAllConnectionDescription 1.1.0.0 "APILIB_STATUS"
mlpiApiCloseConnectionByUid 1.1.0.0 "APILIB_MANAGEMENT"
mlpiApiCloseConnectionsByUser 1.1.0.0 "APILIB_MANAGEMENT"
mlpiApiCloseConnectionsByUri 1.1.0.0 "APILIB_MANAGEMENT"
mlpiApiUserAccountControlReload 1.1.0.0 "APILIB_DEPRECATED"
mlpiApiUserAccountControlLoadAccounts 1.4.0.0 "APILIB_DEPRECATED"
mlpiApiUserAccountControlUnloadAccounts 1.4.0.0 "APILIB_DEPRECATED"
mlpiApiGetOwnPermissions 1.4.0.0 "IMPLICIT"
mlpiApiGetAccounts 1.4.0.0 "APILIB_DEPRECATED"
mlpiApiGetAccountPermissions 1.4.0.0 "APILIB_DEPRECATED"
mlpiApiNotifyAlive 1.4.0.0 "IMPLICIT"
mlpiApiGetLibrarySupport 1.8.0.0 "IMPLICIT"
List of the old permissions of mlpiApiLib and their corresponding new permission.
Old permission new Permission
MLPI_APILIB_PERMISSION_ALL IMPLICIT
MLPI_APILIB_PERMISSION_CONNECTION_INFO APILIB_DEBUG
MLPI_APILIB_PERMISSION_MLPI_INFO APILIB_STATUS
MLPI_APILIB_PERMISSION_CONNECTION_OWN_DESCRIPTION IMPLICIT
MLPI_APILIB_PERMISSION_CONNECTION_ALL_DESCRIPTION APILIB_STATUS
MLPI_APILIB_PERMISSION_CONNECTION_CLOSE APILIB_MANAGEMENT
MLPI_APILIB_PERMISSION_USER_ACCOUNT_CONTROL_RELOAD APILIB_DEPRECATED
MLPI_APILIB_PERMISSION_USER_ACCOUNT_CONTROL_LOAD APILIB_DEPRECATED
MLPI_APILIB_PERMISSION_USER_ACCOUNT_CONTROL_ACCESS APILIB_DEPRECATED
See also
Permission and user management