PUBLIC Model Manager User Guide

Transcription

1 SAP Predictive Analytics PUBLIC

2 Content 1 Introduction Concepts Roles Rights Schedules Tasks My Model Manager....8 Overview My Notifications My Subscriptions My Preferences Notifications Language Preferences Items to Display for Paging My Roles and Rights Credentials Documentation Administration Panel License Info Users Projects External Executables Schedules Servers Sources Definitions Rights Roles Role Assignment Rights Management Default Subscriptions Supervision Panel Projects Models SAP SE or an SAP affiliate company. All rights reserved. Content

3 Tasks Variables Usage Server Usage Project Panel Overview Management Assignments Sources Metadata Repository Models Scheduled Tasks Apply-in Settings Retrain a Model Specific Learning Modes Apply a Model Defining a Project From A to Z Declare the Sources Add the Project Assign Roles To Define a Single Schedule To Define a Periodic Schedule To Schedule a Task To Delete a Project To Import a Model into a Project Content 2015 SAP SE or an SAP affiliate company. All rights reserved. 3

4 1 Introduction This document presents the Model Manager feature offered by Automated Analytics. The Concepts section provides definitions of essential concepts, the section guides you through the different panels of the interface and the Defining a Project From A to Z section lists the essential steps of a project within Model Manager SAP SE or an SAP affiliate company. All rights reserved. Introduction

5 2 Concepts This chapter describes: Roles Rights Schedules Tasks 2.1 Roles Model Manager offers the possibility to assign predefined roles to users. These roles belong to three different groups and are connected to predefined J2EE roles: J2EE roles : the three roles (ModelManagerAdmin, ModelManagerSupervisor, and ModelManagerUsers) can be assigned to users in the J2EE server configuration file. Note This cannot be modified in the Web User Interface. Group: the three groups (Administration, Supervision, Project ) are used to classify the user roles that can be assigned in the Web User Interface. These groups correspond to the J2EE roles used in the configuration file. Role: the user roles can be created, modified and assigned in the Web User Interface, see the chapter Roles. Each role belongs to one of the three groups (Administration, Supervision, Project). Note The roles corresponding to the Project group can only be assigned by the project manager or an administrator. Concepts 2015 SAP SE or an SAP affiliate company. All rights reserved. 5

6 The menu panels displayed according to the group and the role of the user: Supervision Projects Administration Projects Models Tasks Variables Usage Servers Usage Kxsvrmulti Overview Management Assignments Sources Models Tasks License Info Users Projects External Executables Schedules Servers Sources Definitions Rights Roles Roles Assignnment Rights Management Default Subscriptions 2.2 Rights As the different persons working with the application do not need access to all options, for each group - Administration, Supervision, Project - there are predefined roles. For instance, in the Administration group: the IT Administrator has access to the server and the sources but not to the projects management, whereas the Analyst Administrator does. Therefore, the competences of the different persons involved have to be taken into account when assigning roles SAP SE or an SAP affiliate company. All rights reserved. Concepts

7 2.3 Schedules Tasks can be executed according to an existing schedule. This feature can be used to have better control of resources like the server capacity. An administrator can create different schedules for tasks that are executed once or periodically and define the moment of execution to avoid overloading the servers. Users working on a project can use these schedules when defining a task without having to consider the workload for the server or the network. 2.4 Tasks Tasks are used in a project to perform actions once or periodically. The following tasks are available: Retrain a Model: retraining a model built with SAP Predictive Analytics. Apply a Model: applying a model built with SAP Predictive Analytics to a new data set. Detect Model Deviations: checking the evolution of a model by taking into account only the selected variables after the variable selection process. Detect Deviation of a Data Set: checking the evolution of a data set with the possibility of selecting variables and targets. External Executable: launching an independent executable file, for example a script, via the application interface. Concepts 2015 SAP SE or an SAP affiliate company. All rights reserved. 7

8 3 Model Manager is based on roles handled by J2EE Security Manager server. Some resources (panels/views) are restricted to users who are assigned the appropriate J2EE role. To access the web interface, a user must have been assigned at least one J2EE role. These roles are handled as groups (see Concepts). There are three groups: Administration Supervision Project Users can be assigned J2EE roles via the XML configuration file. It is also possible to handle J2EE roles with an Active Directory. For further information about groups and J2EE roles, see the document Model Manager Installation and Configuration Guide. The user must enter a valid name and password to connect to the application web interface. Both Internet Explorer 7.0 (and above) and Firefox 3.0 (and above) are supported browsers. The J2EE Server verifies if the identification is correct, retrieves the roles assigned to the user and displays only the accessible panels. 3.1 My Model Manager The block My Model Manager is displayed for users of every group. The personal settings can be edited on through this menu block, without consequences for other users. Clicking the menu root My Model Manager allows you to display an overview of the section Overview This panel appears when users connect to the application and provides an overview of the account. Click one of the following options to display the corresponding list of notifications: Icon Meaning Task(s) ended on success status Task(s) ended on warning status Task(s) ended on failure status Message(s) Below the list of notifications, users can view the list of projects they are working on SAP SE or an SAP affiliate company. All rights reserved.

9 This panel also displays warning messages in the following cases: When servers are not running. When sources are not available. When models are not available. When tasks cannot be performed. When some license elements are close to expire. To Display a Project Overview, click the name of a project in the Project List to display its Overview My Notifications The list of notifications provides information on the status of the tasks users have executed and displays the messages received according to the roles or the personal subscriptions (after a task is performed...). The project name is displayed for each notification in the right column. Users can filter notifications by date (fields From and To), Originator, Project Name and Status. The unread notifications appear in bold font, the read notifications appear in normal font. To read a notification, click on the event link in the Event column. To remove a notification, mark it as read or unread: 1. Identify the notification(s) by selecting the checkbox in the left column. 2. Click Remove, Mark as Read or Mark as Unread My Subscriptions Users have the possibility to subscribe to notifications to stay informed on events without having to systematically check each project they are involved in: for example, they can choose to be notified every time a model is imported in one project. Note These notifications are not to be confused with the default subscriptions made in the Administration panel, which are not specific to a project or a user, but to roles. For further information see Default Subscriptions [page 25]. It is also possible to subscribe to warnings when the predictive power or the prediction confidence of a model is lower than a given value. To enable this option, choose the action A Model Alert is Detected when adding a new subscription To Add a New Subscription 1. Click Add a New Subscription SAP SE or an SAP affiliate company. All rights reserved. 9

10 2. Enter a name for the new subscription. 3. Choose the action that must trigger the notification in the drop-down list You would like to be warned when. 4. Select one or several projects for which you want the subscription to be active. 5. Click Subscribe to save the settings Activating, Deactivating, and Removing Subscriptions To Remove a Subscription (or a Default Subscription): Click the Remove link next to the subscription (or the default subscription) you want to remove. To Deactivate a Subscription (or a Default Subscription): Click the Deactivate link next to the subscription (or the default subscription) you want to temporarily deactivate. To Activate a Subscription (or a Default Subscription): Click the Activate link next to the subscription (or the default subscription) you want to activate again My Preferences Set all your preferences under My Preferences, for example, address and enabling notifications, and click Save Notifications The address associated to a user account can be modified and used to receive a copy of the notifications. For users who do not regularly check the application for new notifications, it is interesting to activate this option. To Enable the Notifications: 1. Check the option Enable Notifications. 2. Enter your address in the field Address. The task execution notification s include the task reports as PDF attachments. Depending on the task types, one or more PDF attachments are sent. For example, for a data deviation task, two attached files are now sent, corresponding to 'overview' and 'executive report' contents. Note - If an error occurs, you may click the Report button in order to forward the error message by to the application administrator or the support for troubleshooting purposes SAP SE or an SAP affiliate company. All rights reserved.

11 3.1.6 Language Preferences The last option of this panel allows you to set the language preferences for the interface. Note Model Manager is currently available in English and in French. To Choose the Language Policy, in the list Select the language policy to be used, select: either Browser Language, which will use the language selected in your browser settings. or Determined by the user. In that case, a drop-down box is displayed allowing you to select the language Items to Display for Paging The option Maximum Items to display for paging enables the user to set the number of rows that he wants to be displayed in the tables containing information such as the Notification List or Tasks table. By default, it is set to 20 items per page. To set up the Maximum Items to display for paging 1. Enter a number other than Click the Save button My Roles and Rights My Roles and Rights summarizes all the roles and rights you have. Section You have been assigned the following administration and supervision roles You have been assigned the following project roles Authorized actions according to your administration roles Authorized actions according to your supervision roles Authorized actions according to your project roles Content Your user roles for the role types Supervision and Administration Projects you work on and the roles you have within these projects Available menu items according to your Administration roles Available menu items according to your Supervision roles Available menu items according to your Project roles Note The rights for the project manager are not listed, as this role can perform all actions concerning a project SAP SE or an SAP affiliate company. All rights reserved. 11

12 3.1.9 Credentials Creadentials shows your credentials to authenticate to Automated Analytics servers and data sources. Once an Automated Analytics server and/or a data source is defined by an administrator, each user involved in projects using this server and/or this data source must configure the related credentials to get the required accesses within this project : Authenticated servers credentials Database credentials Indeed, for security purposes, each user authenticates with its own credentials to the servers and/or data sources, this is called impersonation. For further informations about authentication and impersonation, refer to the Model Manager Installation and Configuration Guide To Edit the Credentials for an Authenticated Server or Database 1. Click Edit button. 2. Type in Login field. 3. Type in Password field. 4. Click Update button Documentation Documentation gives you access to the documentation about Model Manager. Model Manager Installation and Configuration Guide To access a guide, click the link of the guide you are interested in. 3.2 Administration Panel The Administration panels are only visible to users who are in the Administration group. The different menu items of this block allow managing users, servers, sources and other settings that can be used in projects. For security reasons, only authorized users can declare sources and define the rights corresponding to each role SAP SE or an SAP affiliate company. All rights reserved.

13 Clicking the menu root Administration allows you to display an overview of the section License Info Model Manager displays information about the license, allowing administrators to adjust the license acquisition policy (license extension...). The following information is displayed: Label Model Retrain Model Apply Model Deviation Data Deviation External Executable Information Expiry date of the license allowing retraining models. Expiry date of the license allowing applying models. Expiry date of the license allowing performing model deviation tasks. Expiry date of the license allowing performing data deviation tasks. Expiry date of the license allowing running external executables. Label Servers Limit Information The number of servers that can be declared in Model Manager SAP SE or an SAP affiliate company. All rights reserved. 13

14 Label Sources Limit Users Limit Executables Limit Information The number of sources that can be declared in Model Manager. The number of users that can be created in Model Manager. The number of external executables that can be declared in Model Manager Users Users can work on and share common resources. Each user has a unique identifier which is Name. The name must correspond to the one declared in the J2EE server configuration file or must correspond to an attribute of an entry of the Active Directory. Each user has one or several roles according to the role types to which he/she belongs: IT Administrator and Analyst Administrator (for the role type Administration) Analyst and Data Broker (for the role type Project) Business Owner (for the role type Supervision) For further information on the concept of role in Model Manager, see the section Roles (on page 4). A user is characterized by: A Name already defined in the J2EE server configuration file or in the Active Directory. An Address, to receive notifications. A Description, to add comments on the user. Note When editing a user account, it is not possible to modify his/her user name because this unique identifier is declared in the J2EE server configuration file or is an entry of the Active Directory. Some "exception" rights linked to roles are to be mentioned: To Create a New User Account 1. Click the button Add New User. 2. Enter a user Name. 3. Enter the Address of the user. 4. Give a short Description of the user and his role. 5. Click Next to create a new user. 6. Select the roles of the groups Administration or Supervision. Only the project manager or an administrator can assign project roles. 7. Click Add to validate the creation of the account SAP SE or an SAP affiliate company. All rights reserved.

15 3.2.3 Projects A project is the main concept in Model Manager. Projects contain models and tasks. To have an overview of a typical project life cycle, see Defining a Project From A to Z [page 59]. When connecting to the application, users can only see and access projects in which they have a specific role. Only a project manager or an administrator is allowed to assign roles to users. The rights attached to these roles are defined by an administrator. For more information, see Roles [page 5]. A project is characterized by the following elements: Parameter Name Project Manager Description name of the project name of the project manager. Note The project manager has the rights to assign roles in a project. Description Sources description of the project or additional comments the sources that this project can access Before creating a project, there must be at least one user created in Model Manager To Add a New Project 1. Click the button Add Project. 2. Enter a Name for the new project. 3. Choose a Project Manager. 4. Enter a Description for the project. 5. Enable the checkbox(es) corresponding to the source(s) that this project can access. 6. Click Save to create the project. Only the project manager and the description of a project can be modified afterwards. The name of a project cannot be edited once it has been created To Edit a Project 1. Click Edit link in the row of the project you want to edit. 2. Enter a Name for the new project. 3. Choose a Project Manager. 4. Enter a Description for the project SAP SE or an SAP affiliate company. All rights reserved. 15

16 5. Enable the checkbox(es) corresponding to the source(s) that this project can access. 6. Click Update To Remove a Project 1. Click the Remove link in the row of the project you want to edit. 2. Click Yes To Duplicate a Project 1. Click the Duplicate link in the row of the project you want to edit. 2. Edit the Name field. 3. Click Save External Executables An external executable is a script or an application that lets you automate specific actions, such as creating a data set from a specified source, saving a copy of files generated by Model Manager in another location, or setting ing campaigns. External executables can be launched in preparation for or in response to an event: for example, a call to an FTP application that will transfer data on a specific data source before a model apply. Defined external executables can be seen in the Administration Panel and scheduled as a project task once you declare the executable in the external executable configuration file. Related Information External executable's exit status and task execution reporting [page 17] To Declare a New External Executable [page 16] To Declare a New External Executable Before you can schedule an external executable task, you need to declare the executable in the external executable configuration file. 1. Define the path to the external executable configuration file in KMFConfig.cfg SAP SE or an SAP affiliate company. All rights reserved.

17 a. Open the KMFConfig.cfg file located in folder: <installation_dir>/tomcat/webapps/ Factory/config/. b. Enter the filepath as the value of ExternalExecFile. For example: ExternalExecFile = /config/external_executable.cfg c. Save the file. 2. Add a line for the new external executable in the file defined in step 1. Each line contains the following elements (in order): name, command, working directory, arguments, description, help. Separate the elements by a comma. Parameter Description Example Name Command Working Directory Name of the executable. The name should be unique. If not, the last line with the same name will be taken into account and a warning message will be displayed in the log. The executable file, including filepath that contains the instructions to be interpreted by the operating system. Directory from which the command will be started. FTP_Get C:\tmp\KMF\Scripts\ftp_in.bat C:\tmp\KMF\Scripts Arguments Arguments for the executable. -dl c:\tmp\kmf\data -dd public/data/ weekly/d01 -df mails.csv Description Description of the what the executable does. Command used to collect existing s on the FTP server. Help Additional information indicating how to launch the command or providing details about the argument list. -dd path to the remote folder -fd name of the remote file -dl path to the local folder -fl name of the local file External executable's exit status and task execution reporting When the application runs an external executable program, it sets the task's execution status to report whether the execution was successful or if it failed. Since the nature of the program that was run is unknown to the application, it has only limited means to communicate with the program and determine whether the execution was successful or not. The application expects the program it executes follows the convention stating that it will return 0 to indicate a successful execution and any other code to report a failure. So carefully check when you create a new External Executable in Model Manager that the program it runs follows this convention SAP SE or an SAP affiliate company. All rights reserved. 17

18 Programs that do not follow this convention need to be wrapped in another program that will perform the exit code translation. On Windows systems a batch script (with the extension.bat) can be used to perform the mapping off set ok_code=<enter the code your program returns for successful executions here> set /a ko_code=%ok_code%+1 <enter the command to run your program here> set ret_code=%errorlevel% if %ret_code% equ %ok_code% exit /b 0 if %ret_code% equ 0 (echo The program returned with exit status 0 (success status would have been $ok_code^).) & exit /b 1 On Unix systems a shell script can be used to perform the mapping : #!/bin/sh ok_code=<enter the code your program returns for successful executions here> <enter the command to run your program here> if (test $? -eq 0) then echo "The program returned with exit status 0 (success status would have been $ok_code)."; exit 1; fi if (test $? -eq $ok_code) then exit 0; fi Schedules Schedules are date and time specifications used for the execution of recurrent tasks. These execution schemes can be used in projects to schedule tasks. This allows for example requesting the servers at different times. For further information on surveying the server activities, see the chapter Servers Usage. Three types of schedules are available: Single Schedule : tasks using this schedule will be executed once at the time set by the user in the schedule. Periodic Schedule : tasks using this schedule will be executed several times at regular intervals as defined in the schedule. Manual Trigger : this schedule is not planned and will need to be started manually by the user. It allows grouping tasks so that they can be executed all at once when the user needs it. The following information is provided for each schedule: Label Name Schedule Type Description The name that will be used to identify the schedule when creating a task. The type of schedule Single Schedule : only one execution is planned. Periodic Schedule : several executions are planned at specified intervals Manual Trigger : no automatic execution is planned. Its use needs an action from the user. Execution Count Recurrence The number of times the schedule will be executed The periodicity of the schedule (for periodic schedules) SAP SE or an SAP affiliate company. All rights reserved.

19 To Add a Manual Trigger 1. Click Add New Manual Trigger. 2. Enter a Name for the schedule. 3. Enter a Description for the schedule (optional). 4. Click Add to save the schedule To Add a Single Schedule 1. Click the button Add New Single Schedule 2. Enter a Name for the schedule. 3. Indicate the First Execution Date. 4. Indicate the First Execution Time. 5. Enter a Description for the schedule. 6. Click Add to save the schedule To Add a Periodic Schedule 1. Click the button Add New Periodic Schedule. 2. Enter a Name for the schedule. 3. Indicate the First Execution Date. 4. Indicate the First Execution Time. 5. Execute Every: Enter a value for the period and select a unit for the period (minutes, days, weeks...). 6. Choose the Periodic Schedule Type With a limited execution count: tasks associated to this schedule will be executed a given number of times and will then automatically stop. No End Date: tasks associated to this schedule will be executed until the user explicitly stops the tasks' executions. 7. Executions Count: if you have chosen the first option (limited execution...), enter the number of total executions. 8. Enter a Description for the schedule. 9. Click Add to save the schedule SAP SE or an SAP affiliate company. All rights reserved. 19

20 Displaying, Editing, Duplicating, and Deleting Schedules To... Display a Schedule Details Edit the Settings of a Schedule Duplicate a Schedule Delete a Schedule Do this... Click the name of the schedule. For manual triggers, this panel will also allow you to activate the trigger and execute the corresponding tasks. Click the Edit link of the schedule you want to modify and edit the schedule. Click the Duplicate link of the schedule you want to replicate. Click the Remove link of the schedule you want to delete Servers A server, used as a Data Mining Engine (DME) to process scheduled tasks, designates a server and can access declared sources. A server is characterized by the following elements: Parameter Name Host Port Sources Count Creation Date Status Description The logical server name. The hostname on which the physical CORBA Server is running. The port number used to set up the connection. The number of sources declared in the Model Manager and located on the server. The date the server was added in Model Manager. Specifies whether the server authentication is online and if it is an authenticated server. To Add a New Server Click the button Add Server. The form allowing you to declare a new server is displayed To Add a New Server Click the button Add Server. The form allowing you to declare a new server is displayed SAP SE or an SAP affiliate company. All rights reserved.

21 To Define a New Server 1. Enter the Name that will be used in Model Manager to identify the server. 2. Enter the address of the Host on which the server runs. 3. Enter the Port used to connect to the server. By default, the port is set to You can use the Description field to provide additional information about the server To Set the Authentication Parameters The Authentication section allows you to indicate whether you are connecting to an authenticated server and to provide the information needed for the connection. 1. If the server you are setting uses the authentication, check the option Authenticated. 2. Enter the Name Service. By default, the name service is KxAuthServer3 when setting an authenticated server and ModelManagerEntries3 when setting a server not using the authentication. 3. If you are declaring an authenticated server, enter the server authentication information in the fields Login and Password To Manage the CPU Resources The section CPU Resources allows you to directly control the maximum number of tasks run in parallel by Model Manager on a given Automated Analytics server and thus to moderate the CPU usage of Automated Analytics and Model Manager. This information can be provided by your IT administrator. 1. In the field Cores Ratio Usage, enter the maximum percentage of available CPU cores Model Manager can use. By default, it is set to 0.75, that is 75%. For example, if the server has 24 cores, Model Manager will only be able to use 18 cores. 2. In the field Cores Maximum Usage, enter the maximum number of CPU cores Model Manager can use. When set to 0, the number of cores is only limited by the Cores Ratio Usage. Note that whatever values are set in these fields, Model Manager will use at least 1 core To Create the New Server Click Add Sources Like servers, sources are logical objects. Sources represent the Store (directory or ODBC Data Source) and have access rights (read/write data and read/write models) SAP SE or an SAP affiliate company. All rights reserved. 21

22 The project manager, or another user with the corresponding rights, have to declare sources that can be used in a project in order to schedule tasks and to import models. Sources are accessed by servers when importing models or when scheduling tasks. There are two source types: shared/public sources that are accessed with the same credentials for everybody in Model Manager, once authenticated to Automated Analytics server. unshared/private sources that are accessed with user-specific credentials in Model Manager, once authenticated to Automated Analytics server. So a private source is only accessed by the authorized users in Model Manager, in a secured mode. For further information about credentials and authentication, please refer to Model Manager Installation and Configuration Guide. A source is characterized by the following elements: Parameter Server Name Store Type Folder Name User Name Password Shared Source Description Projects Description the server that can access the source the name of the source the format of the file or database for the source directory or database corresponding to the source being declared user name used to connect to the database password used to connect to the database binary status indicating whether the source is shared or unshared comments about the source projects that can access this source Definitions Administration Sources displays the sources declared for a specific server. A source is linked to a project or some projects: it is only visible in this or these project(s) To View the Sources Declared for a Server Select the server in the drop-down list Server Name SAP SE or an SAP affiliate company. All rights reserved.

23 To Declare a New Source 1. Select a server in the drop-down list Server Name. 2. Click the button Add Source. 3. Select a Store Type in the drop-down list. 4. Type in the Name for the new source. 5. Type in the Folder for the source or browse the directory by clicking Browse. 6. If the source is a database enter the User Name and the Password. 7. Enable the Shared Sourcecheckbox if the configured source is a shared source. 8. Enter a Description for the new source 9. Select the project(s) that can access this source by enabling the corresponding checkbox(es). 10. Click the button Test and Save. It is not possible to rename an existing source, but it can be duplicated with a different name. As all the projects that are not declared in step 9 do not include the configured source, this source is not visible and usable in these projects To Get Information About an Existing Source Click the link (source name) in the Name column To Test the Validity of a Source 1. Click the link (source name) in the Name column. 2. Click the button Test Source Validity. If the source is valid, the panel indicates 'Test successful'. If not, the system administrator should take a look at the configuration of the source in the application or check the configuration and status of the directories/files corresponding to the source on the server Rights Every source declared has specific rights associated to it. These rights determine the type of tasks authorized for a source. For example, if it is possible to read data and models but not to write, users cannot apply models on such sources SAP SE or an SAP affiliate company. All rights reserved. 23

24 To Edit the Rights of a Source 1. Click Edit Rights. 2. Check or uncheck the corresponding boxes to edit the rights of a source. 3. Click Save Roles When a user connects to Model Manager, the system retrieves all the role types and all the roles defined for this user. These roles are used to control the access to the application functionalities. Roles are structured in three different role types: Administration Role : a user is able to access Servers, Schedules, Sources and Roles menus in the Administration panel. Supervision Role : a user (an executive) is able to have a synthetic view of Projects, Models, Tasks, Key Performance Indicators and Server usage in the Supervision panel. Project Role : a user (an analyst) is able to create a Project, importing a Model, creating and scheduling Tasks in the Project panel. Note Project managers have also access to supervision menu items related to the project they manage. In this manner, each project manager within the Company can easily follow up the only activities related to its project Role Assignment To access Model Manager panels, users must have predefined roles assigned to them. This panel allows assigning roles for each role type: Administration, Supervision or Project To Assign a Role to a User 1. Select a group via the radio buttons. A table is displayed listing the users that have been assigned a role from this group SAP SE or an SAP affiliate company. All rights reserved.

25 2. Click Assign Role. 3. If you have selected the group Project Role, select the project for which you want to assign a role to the user. 4. Check the roles you wish to assign to the user. 5. Click Save Rights Management Default rights are attached to the predefined roles. In the example hereafter, the IT Administrator role has access to the servers and the sources, but not to the project tasks (projects management, roles assignment...), whereas the Analyst Administrator role has access to the project tasks. The default rights of each role can be edited by an administrator To Edit the Rights of a Role 1. Select the group using the radio buttons. 2. Click the Edit button. 3. Check or uncheck the corresponding boxes depending on whether you want a menu to be accessible to a role or not. 4. Click Save Default Subscriptions It is possible to define default subscriptions for a given role: for instance, all users who have an Analyst role can receive a notification when a given task is scheduled or when a model is imported in a project SAP SE or an SAP affiliate company. All rights reserved. 25

26 Note These default subscriptions are different from those that can be defined in the My Model Manager panel. Users will not receive the same notifications twice To Define a Default Subscription for a Role 1. Select the group using the radio buttons. 2. Click Add Subscription. 3. Enter a Name for the default subscription. 4. Select the Group in the drop-down menu. 5. Select the role in the drop-down menu Role Name. 6. In the drop-down menu You would like to be warned when, select the event that must trigger a notification. 7. Click Subscribe To Cancel a Subscription 1. Choose the role type (Group) using the radio buttons. 2. Click Remove next to the default subscription you want to delete. 3. Click Yes to confirm the deletion SAP SE or an SAP affiliate company. All rights reserved.

27 3.3 Supervision Panel Actions cannot be performed via the Supervision panels. It is only possible to view reports on projects, models, scheduled tasks, variables usage and servers usage. On each supervision panel, filtering options allow users to display selective information. Clicking the menu root Supervision allows you to display an overview of the section Projects Supervision role can now be linked to specific projects. That is why Project Managers now have access to the Supervision panel. Their Supervision access is restricted to the data regarding the projects they manage. The panel Projects displays the list of projects created. For each project, the following information is provided: Creation date Name of the project Methodology used for the project Phase of the project Name of the project Manager 2015 SAP SE or an SAP affiliate company. All rights reserved. 27

28 To Get Detailed Information about a Project Click the name of the project in the Name column. A summary of the project is displayed with its models and the related task executions Models The panel Models displays the list of all the models imported in the application, for all the projects. The list of versions can be viewed by clicking the name of the model. For each model, the following information is provided: Parameter Creation Date Name Project Name Model type Description date on which the model was imported name of the model project in which the model was imported Kxen.Classification (Classification/Regression), Kxen.RobustRegression (Classification/Regression) Kxen.Segmentation (Clustering) Version Count Originator number of existing versions of the model name of the user who imported the model To Get Detailed Information about a Model 1. Click the name of the model in the Name column. A summary of the model is displayed with a graph that shows KI/KR evolution and a table that shows detailed information, variable according to the model type. 2. Select the Model Name in the drop down list. 3. Select the View Type in the drop down list: either model version number, either model building date. Click Overview in the row of the model you want to get a report of SAP SE or an SAP affiliate company. All rights reserved.

29 or Click Executive Report in the row of the model you want to get an executive report of Tasks The panel Tasks displays all the tasks that have been scheduled. For each task, the following information is provided: Name of the task. Task Type: retrain, apply model, detect deviation, external executable. Executions : count of the executions carried out in regard of the total number of scheduled executions. : tasks ended on success status. : tasks ended on warning status. : tasks ended on failure status. Originator : name of the user who scheduled the task SAP SE or an SAP affiliate company. All rights reserved. 29

30 The details of the executions can be viewed by clicking the name of the task. For each execution, the following information is provided: Start Date End Date Status Model Version You can select the Task Name in the drop down list. You can for a given task filter its occurrences according to the running Status To Get Detailed Information about a Task 1. Click Overview in the row of the task you want to get a report of. 2. Or click Executive Report in the row of the task you want to get an executive report of SAP SE or an SAP affiliate company. All rights reserved.

31 3.3.4 Variables Usage The panel Variables Usage can display summarized or detailed reports that display information on the usage of the variables. In both cases, the list of variables can be filtered according to the following parameters: Project Name Model Name Model Type Variable Name Variable Role Storage type Value type Top n Report Type : choose between Summary and Details The summarized report provides the following information: Variable name Input Usage count Target Usage count Weight Usage count Skipped count Top 5 The detailed report provides the following information: Variable name Project name Model name Model Version Variable Contribution File/Table name Role of the variable Storage type Value type Value Type To Export the Variable Report as a CSV File Once the requested report displayed, click the Export To Csv button Server Usage The panel Servers Usage displays a chart that provides information on the use of the servers. When users select a specific date, the information is displayed for the week containing the date. The buttons Previous Week/Next Week allow navigating through the time periods SAP SE or an SAP affiliate company. All rights reserved. 31

32 Note Even when the selected date is not a Monday, the displayed chart covers a week from Monday to Sunday. Clicking the chart bars allows viewing the details of executions for a specific day, according to the status of the task (Success, Warning or Failure). A table is displayed under the bar chart: Clicking in this table on the status of the task in the Status column allows viewing the detailed logs related to the task execution: SAP SE or an SAP affiliate company. All rights reserved.

33 3.4 Project Panel The Project panels can only be accessed by members who have been assigned a project role (Project Manager, Analyst, Data Broker). When a user connects to the application, the system retrieves the corresponding groups and the roles that have been assigned to the user. Each role has specific rights. For example, only an Analyst will be able to import models in projects. Note The sub-menu Management is only accessible to the project manager and to the users who have been granted the appropriate rights. Clicking the menu root Project allows you to display an overview of the section and also to create new projects using the Add Project button. The Project section updates accordingly when adding, duplicating or removing projects Overview The Overview panel for a specific project allows having an executive view of the projects. The displayed reports are: Project Information : manager, users. Models : list of the latest model versions. Latest Task Executions : list of the latest executions of the tasks SAP SE or an SAP affiliate company. All rights reserved. 33

34 3.4.2 Management By default, this menu item is only visible for the project manager. Its sub-menus allow assigning roles to users for a specific project and declaring sources that will be used in the project when scheduling tasks or importing models Assignments This panel provides the possibility to assign project roles to users or to edit these role assignments To Assign Roles to a User 1. Click Assign Role. 2. Check a box next to the name of the user to assign the corresponding project role (Analyst and/or Data Broker). The table Authorized actions according to your project roles indicates the actions that can be performed in function of the roles. Only an administrator can modify the rights attached to a role SAP SE or an SAP affiliate company. All rights reserved.

35 3. Click Save. You are automatically redirected to the panel with the user names and their roles in the project Sources Sources are folders or databases that have been declared in the Administration panel. For additional information see the chapter Sources. The panel New Project > Sources displays all sources that have been declared for the related project. Note If the list of project sources is empty, no models can be imported and no tasks can be scheduled in your project To Select Sources for a Project 1. Click Select Source SAP SE or an SAP affiliate company. All rights reserved. 35

36 2. Select the sources to be used by checking the corresponding boxes in the left column. 3. Click Save to apply the modifications. The validity of a data source can be tested in order to verify if a folder was not deleted, a password changed, or other To Create a Source for a Project 1. Click Create Source. 2. Select the server in the drop-down list Server Name. 3. Click Add Source. 4. Select the data source type in the drop-down list Store Type (text files, database, SAS files...). 5. Type in a Name for the data source. 6. In the field Folder Name, browse to the data source folder or type in its path. 7. Enter a short Description if wanted. 8. Select the project(s) that can access this source. 9. Click Save to apply the modifications To Define or Modify a Metadata Repository for a Project 1. Click the button Edit metadata repository settings. 2. Check the box Enable Metadata Repository. 3. Select a source in the drop down list. 4. Click the button Save to apply the settings SAP SE or an SAP affiliate company. All rights reserved.

37 To Test the Validity of a Source 1. Click the link (source name) in the Name column (in the panel Project > sources). 2. Click the button Test Source Validity. If the source is valid, the panel indicates 'Test successful' Metadata Repository The metadata repository allows you to store all metadata in a single repository. For example, you can define one metadata repository for each team thus allowing everyone in a team to have access to the same metadata. However, you may define a distinct metadata repository for each project, at the same level as the sources To Enable a Metadata Repository 1. Click the Edit button located to the right of the message Metadata Repository settings are not defined. 2. In the Server list, select the server where the metadata repository will be located. 3. In the Folder list, select the folder to be used as the metadata repository. The Server list and the Folder list display servers and sources previously declared in the Administration panel. 4. Click the Save link. 5. Check the box Enable Metadata Repository to activate the metadata repository you have defined To Define a Metadata Repository for a Specific Project Go to Project Management Sources Models This panel lists all the models that have been imported in the project. A model is defined by the following parameters: Parameter Name Description name of the model. This name can be different from the original name in Automated Analytics SAP SE or an SAP affiliate company. All rights reserved. 37

38 Source Version Count source on which the model is stored number of versions that exist for the model (starting from 1) Note - Do not confound with the version number. Originator Creation Date Model Type user who imported the model date the model was imported in a project indicates whether it is a Kxen.Regression or a Kxen.Classification model A new model version is added to the set and the Version Count increases when the model is retrained. A model version is defined by the following information: State information: an Active version is indicated by the icon IMAGE. Training Date : the date when the model was imported or retrained. The Version Number: the number of the version (starting from 0). A Records Count: the number of records in the data set used to train the model. The Variable Count : the number of variables used in the model. A set of model Performance Indicators to be displayed in the version reports concerning this model: L1, KI, KR... Note To import a model, the user must have a role allowing him to do so. Note When importing models, it is necessary to select a server and a source. If the source list is empty, either there is no source declared, either the rights of the source are not correctly set. To edit these settings, go to the Administration Panel Managing Models You can do the following: To... Import a Model Do this... Click the button Import Model to add another model to the list. Note You have to create a model with Modeler and then import it into Factory. Display all the Available Information on a Model Click the Name of the model SAP SE or an SAP affiliate company. All rights reserved.

39 To... Change the Settings Related to a Model Do this... Click Edit next to the model, to edit the optional settings: performance indicators to appear in the reports and active version of the model to be used. See the next table for more information about performance indicators. Select the Active Version to be Used 1. Choose a policy in the drop-down list and select the model activation policy. 2. Click Validate to save the changes. Remove a Model from the Project Display the Overview of a Model Version Click Remove next to the model you want to delete. For each model version, an Overview or an Executive Report can be displayed. 1. Click the Name of the model. 2. Click Overview next to the version you want to view. The overview is displayed in a new tab of the browser. A "KI/KR Evolution" graph displays the evolution of the KI/KR in function of the model training date or of the model version number. Several performance indicators are available for each model depending on the model type. This panel allows you to select the indicators you want to display in the model reports of Factory once the models have been imported. Indicators L1 LInf L2 Error Mean The Area Under the ROC Curve Classification Rate Definition mean of the absolute values of the differences between predictions and actual results, (City block distance or Manhattan distance) maximum absolute difference between predicted and actual values (upper bound) (Chebyshev distance) square root of the mean of the quadratic errors (Euclidian distance or root mean squared error - RMSE) mean of the difference between predictions and actual values The AUC statistic is a rank-based measure of model performance or predictive power calculated as the area under the Receiver Operating Characteristic curve. For a simple scoring model with a binary target, this represents the observed probability of a signal (responder) observation having a higher score than a non-signal (non-responder) observation. For individual variables, ordering based on score is replaced by ordering based on the response probability for the variable s categories (for example cluster ID or age range response rates). ratio between the number of correctly classified records and the total number of records 2015 SAP SE or an SAP affiliate company. All rights reserved. 39

40 GINI KXEN Information Indicator KXEN Robustness Indicator Error Standard Deviation The coefficient of determination (R2) The GINI statistic is a measure of predictive power based on the Lorenz curve. It is proportionate to the area between the random line and the Model curve. KI is the abbreviation for KXEN Information Indicator. The KI indicator is the quality indicator of the models generated using Automated Analytics. This indicator corresponds to the proportion of information contained in the target variable that the explanatory variables are able to explain. KR is the abbreviation for KXEN Robustness Indicator. The KR indicator is the robustness indicator of the models generated using Automated Analytics. It indicates the capacity of the model to achieve the same performance when it is applied to a new data set exhibiting the same characteristics as the training data set. dispersion of errors around the actual result in regression case (continuous target). The R2 is computed as the square correlation between the target and the model output ( prefixed by rr_ ). When you import several versions of a same model, this option allows you to indicate which version will be set as active, that is, which version will be used by the tasks defined in the application. You can choose one of the following activation policies: Latest : the most recent version of model will be active once the model has been imported in Model Manager. Best KI : the model version with the best KI will be used as the active version. User Determined : the user selects the version they want to activate. Note The option User Determined is not available when importing or editing multiple models. To activate a specific version for a model after importing multiple models, you need to edit the model in Model Manager thanks to the Edit link provided in the models list Managing Model Details You can rename the models you import or modify their description. You can do it manually for each model, or use rules to apply modifications to all models at once. The following parameters of the current import are summed up at the top of the page: the name of the project, the name of the data source the number of models to be imported SAP SE or an SAP affiliate company. All rights reserved.

41 To... Manually Rename a Model Manually Modify a Model Description Do this... In the models list, enter the new model name in the field Import Name corresponding to the model you want to rename. In the models list, enter the new model description in the field Import Description corresponding to the model for which you want to modify the description. Cancel All Modifications 1. In the Property List, select the item you want to reset to its original value for all the models: Name or Description. 2. In the Action List, select Reset. 3. Click Apply. Modify the Name or Description of All Models 1. In the Property List, select the item you want to reset to its original value for all the models: Name or Description. 2. In the Action List, select the type of modification you want to apply to the selected item: Add Prefix: add the provided string at the start of each name or description. Add Suffix: add the provided string at the end of each name or description. Remove String: remove the provided string from all names or descriptions. Replace String: replace the first string provided by the second one in all names or descriptions. Replace All: replace all names or descriptions by the provided string. Note All models will have the same name or description. Reset: cancel all modifications applied to the selected item. 3. Depending on the type of modification, enter the required information in the provided fields. 4. Click Apply. Validate this Step Click Next Scheduled Tasks Tasks can be scheduled SAP SE or an SAP affiliate company. All rights reserved. 41

42 Each task is associated to a schedule. This allows running tasks with predefined schedules. As for importing models, a user must have the right to schedule a specific task. If a user is not allowed to schedule a task, the schedule button is deactivated. For example a Data Broker is allowed to schedule data deviation and external executables while an Analyst is allowed to schedule retrains, applies and model deviations. Each scheduled task is based on a set of executions. Each execution is characterized by the following elements: Start Date End Date Status (Running, Success, Failure, Warning and Canceled) Report Messages Log Tasks are executed by an instance of a CORBA server. To schedule a task you have to select a logical server, except for an external executable (which is executed by the Operating System). For tasks that need models (Apply and Retrain), the server is selected by default in function of the model. It is only possible to choose sources (for Apply-in and Apply-out) that can be accessed by the selected server. If a task encompasses other tasks, the Tasks panel of the Project menu displays a task dependencies tree, so that the tasks that are linked to each other can be viewed in a glimpse. This tree can be useful when trying to remove a task, for example. When a project is deleted, the related scheduled tasks and executions are displayed by the server as being deleted To Shedule a New Task 1. Click Schedule New Task in the panel Project Task. 2. Select the Task Type in the drop down list. 3. Set the tasks settings, depending on the task type. 4. Click Next. 5. Define the associated schedule SAP SE or an SAP affiliate company. All rights reserved.

43 6. Check the upper box if you want to be notified when the test finishes. 7. Choose the execution mode with the proper radio button. 8. Type in the First Execution Date. 9. Type in the First Execution Time. The time displayed on the panel is the time of the server. 10. Click Next. 11. Type in the task Name. 12. Type in task Description. 13. Click Schedule. If a task contains sub-tasks, a tree displays the task dependencies in the Project menu, so that you can view in a glimpse the tasks that are linked to each other (when trying to remove a task for example) To Edit the Task Schedule 1. From the Project Name Tasks panel, click Edit for the selected task. 2. Click Change Scheduleto edit the panel. 3. Click Update SAP SE or an SAP affiliate company. All rights reserved. 43

44 To Remove One or More Existing Tasks 1. Check the box(es) in the left column corresponding to the tasks to be removed or the Select All box if you want to remove all the tasks of the project. 2. Click Remove. 3. Click Yes to confirm To Deactivate One or More Existing Tasks Deactivating a task prevents its further execution until it is (re)activated. 1. Check the box(es) in the left column corresponding to the tasks to be removed or the Select All box if you want to remove all the tasks of the project. 2. Click tdeactivate. The Deactivated Task icon displayed in the status column. INLINEIMAGE To (re)activate One or More Existing Tasks (Re)activating a task puts its execution status as active. 1. Check the box(es) in the left column corresponding to the tasks to be (re)activated or the Select All box if you want to (re)activate all the tasks for the project. 2. Click Activate. The Activated task icon is displayed in the status column. INLINEIMAGE To Run a Scheduled Task Immediately You can run a scheduled task immediately using the following steps: 1. Click the Task Name in the row corresponding to the task that you want to run. 2. Click Run Now. A new execution instance for this task is added in the table with the status 'Running'. 3. Set the tasks settings, depending on the task type. 4. Click Next Apply-in Settings Apply-in Settings Tasks that need an apply-in are: SAP SE or an SAP affiliate company. All rights reserved.

45 Retrain a Model Apply a Model Detect Deviation of a Data Set Apply-in settings depend on the selected model. If the model is built using Data Manager - Semantic Layer methodology (analytical data management), a Time-stamped population (TSP) and an analytical record (AR) must be selected. When the system cannot identify a TSP or an AR, it is not possible to access the schedule panel. This problem can have different causes: an error when selecting the source, a deactivated metadata repository or the a metadata repository that does not contain any TSP/AR definition. To change or activate the metadata repository for data manipulation, go to the panel Project Sources Edit Metadata Repository Settings. To detect the deviation of a data set, where no models are needed, you have to manually select the type of data set to be used. Prompts are automatically detected and the user interface displays them with their default values. The value for the reference date can either be handled through a specific prompt called KxRefDate or TimeStamp or it can be specified manually by the user. In standard data manipulation, an analytical record or a time-stamped population contains the prompt, the system automatically detects it and displays a message to indicate that the value of this prompt is set to the execution time Retrain a Model You can retrain an existing model through a model imported in a project (and it always uses the latest version). For each execution, a new version of the model is created and added to the set of versions To Retrain a Model 1. Select Retrain a Model in the list Task Type. 2. Choose the model to be retrained in the list Model Name. 3. Select the where the model is located in the list Source Name. 4. According to the type of the model, define the following: For a Classical Model Select the data set to use to retrain the model in the list Retrain Data Set. For an Model Manager - Semantic Layer Model 1. Select the Time-stamped Population in the list. 2. Select the Analytical Record in the list. 3. Indicate the values for the prompts (if there are any). 5. In the section Variable Selection, choose between the following options: Keep initially selected variables: the variables are the same as for the original model. Recompute auto-selection: the auto-selection is applied No auto-selection: all the variables are used to retrain the model SAP SE or an SAP affiliate company. All rights reserved. 45

46 Note The section Variable Selection is only displayed for models built with Automated Analytics Modeler - Regression/Classification. 6. In the list Variable Structure choose between the following options: Keep Initially Detected Variable Structures: choose this option, if the variable structures have been edited for the original model. Recompute Detected Variable Structures: the variable structures are automatically detected. 7. Check the option Include New Variables from the Data Set, if any variables have been added after the training of the original model. 8. Check the option Enable Specific Learning Mode to use the Rule Mode (on page 50) or the Risk Mode (on page 51). These specific learning modes are only available for models built with Automated Analytics Modeler - Regression/Classification. 9. Click Next and go to the procedure Defining a Schedule Specific Learning Modes There are two learning modes: Rule Mode, and Risk Mode Rule Mode Automated Analytics Modeler - Regression/Classification Rule mode allows advanced users to ask a Classification/Regression model to translate its internal equation obtained with no constraints into a specified range of scores associated with specific probabilities. When this mode is activated, the different encodings that are used internally for continuous and ordinal variables are merged in a single representation, allowing a simpler view of the model internal equations. This is particularly useful when the usage of predictive models is subject to legal restrictions: the model equations are now simple enough to be understood by legal departments, and can be exposed, not only in programming language, but also in simple words. The underlying technology is also used to display the 'score cards'. To use this mode, you need to choose a range of scores associated with probabilities. You cannot specify a range (such as 0, 1000) for the scores, but you can specify ranges associated with probabilities of detection, for example, you can specify that you would like the score 200 to be associated with a probability of detection (of the least frequent category) of 20% and the score 800 to be associated with a probability of detection of 80%. In this case, Automated Analytics Modeler - Regression/Classification will automatically re-scale the scores in order to align the probabilities of detection to the specified scores SAP SE or an SAP affiliate company. All rights reserved.

47 To Activate the Rule Mode 1. Check the option Enable Specific Learning Mode. 2. In the list Learn Mode, select the option Rule Mode. The probability and score fields are displayed. 3. Use the fields Low Probability and High Probability to set the probabilities range. 4. Indicate in the fields Score for Low Probability and Score for High Probability what score is expected in each case Risk Mode Automated Analytics Modeler - Regression/Classification Risk Mode allows advanced users to ask an Classification/Regression model to translate its internal equation obtained with no constraints into a specified range of scores associated with good/bad odds ratio. When this mode is activated, the different encodings that are used internally for continuous and ordinal variables are merged in a single representation, allowing a simpler view of the model internal equations. This is particularly useful when the usage of predictive models is subject to legal restrictions: the model equations are now simple enough to be understood by legal departments, and can be exposed, not only in programming language, as it was already the case before, but even in simple words. The underlying technology is also used to display so called 'score cards'. To use this mode, you need to choose: A Risk Score associated with a Good/Bad Odds ratio. The number of Points to double the odds. Where: Odds ratio: the ratio between 'good' and 'bad', i.e. (1-p)/p where p is the probability of risk. Points to double the odds (PDO): the number of risk points needed to double the odds ratio. For example, considering a Risk Score equal to 615, an odds ratio of 9 :1 and 15 points to double the odds. In this case, Automated Analytics Modeler - Regression/Classification will automatically re-scale the internal scores to scores in Risk Mode space and associates an odds ratio to each score in Risk Mode space To Activate the Risk Mode 1. Check the option Enable Specific Learning Mode. 2. In the list Learn Mode, select the option Risk Mode. 3. In the field Risk Score, enter the score you want to associate with a good/bad odds ratio. 4. In the field Good/Bad Odds Ratio, enter the ratio. 5. Indicate the increase of score points needed to double the odds in the field Points to double odds SAP SE or an SAP affiliate company. All rights reserved. 47

48 Apply a Model The Apply task is used to apply a model to a specific data set and to generate an output. This task can be used, when you have a data set that evolves To Apply a Model 1. Select Apply a Model in the list Task Type. 2. Choose the model to be applied in the list Model Name. Only models that have been imported into the project are available. 3. If the model was built on a simple data set: a. Select the server where to find the data in the list Source Name. b. Select a data set to apply the model on in the list Apply-in Data Set. If you need to enter long filenames or folders that contain numerous files or tables, you can click the Autocompletion button to display automatically a pop-up window containing the matching filenames for files or tables during keyboarding. 4. If the model was built on a Time-stamped Population and an Analytical Record: a. Select the server where to find the data in the list Source Name. b. Select a Time-stamped Population in the list. c. Select an Analytical Record in the list. d. Indicate the values for the prompts, if there are any. 5. In the section Results Generated by the Model in the list Data Source, select where to store the output. The extension of the output data set is automatically added according to the store type. 6. Type the name of the output data set to create a new one or choose an existing data set that will be updated with the output of the model apply SAP SE or an SAP affiliate company. All rights reserved.

49 Note If you need to enter long filenames or folders that contain numerous files or tables, you can click the Autocompletion button to display automatically a pop-up window containing the matching filenames for files or tables during keyboarding. 7. Choose between the following options: Generate a Single Table: writes all output data in one table, even if the model is applied several times. This output contains an additional date column that represents the execution date. Generate Multiple Tables: every execution of the task creates a new table suffixed by the date and time if the execution: <output_data_set>_<reference_date> Note Reference date is formatted according to ISO format yyyy-mm-dd HH:mm:ss. 8. Select one of the Generation Options. If you select the option... Predicted value only The generated data will contain, for each row... Only the predicted value of observations (rr_targetvariablename) Probability the predicted value Individual Contributions the predicted value the probability (proba_rr_targetvariablename) the error bars (bar_rr_targetvariablename) the probability the error bar the individual contributions of the variables (contrib_variablename_rr_targetvariablename) To compute the gain chart: To compute the gain chart on the apply data set, that is to rank your data in order of descending scores and split it into exact quantiles (decile, vingtile, percentile): 1. Check the box Compute Gain Chart on Apply-in Data. 2. In the list, select the Number of Quantiles. 3. In the list Generate, select Predicted Value Only. To add additional variables: 1. In the Variables list, select the variables you want to add to the gain chart. Use the CTRL key to select multiple variables. 2. Click the > button to add the selected variables to the list Values for Gain Chart. The sum of each selected variable will be calculated for each segment of the population. Note The list of variables to be selected is: all variables of type 'continuous' for models imported after Automated Analytics version 6.1 all variable usage of type 'continuous' for models imported before Automated Analytics version SAP SE or an SAP affiliate company. All rights reserved. 49

50 When you select the option The generated data will contain for each row... Predicted Value Only the target value. Cluster Id Disjunctive Coding the target value. Cluster Id Disjunctive Coding (+copy data set) the target value. Cluster Id Target Mean the target value. the index of the cluster containing the current observation. the index of the cluster containing the current observation. the disjunctive coding (or "dummy" coding) of the clusters number: for each cluster, a boolean variable is created indicating whether the current observation belongs to that cluster (value is 1) or not (value is 0). the index of the cluster containing the current observation. the disjunctive coding (or "dummy" coding) of the cluster index: for each cluster, a boolean variable is created indicating whether the current observation belongs to that cluster (value is 1) or not (value is 0). all input variables contained in the application data set. the index of the cluster containing the current observation. the target mean of the cluster containing the current observation. 9. Click Next and go to the procedure Defining a Schedule Detect Model Deviations You can verify that the model can be run on a data set generating correct results. The Data to Test Deviations On has to be of the same structure as the model's training data set, that is containing the same variables, the same labels. Moreover, the variables included in the Data to Test Deviations On have to encompass similar attributes in order to get an efficient model. If the report shows a statistical distribution too different from the model's, the apply result is considered as bad. It is possible to generate alerts when the behaviour with respect to the target(s) has changed. The main differences between running a data deviation on the training data set (and testing the apply data sets) and this 'Detect Model Deviation' task are the following: by default, Task Detect Data Set Deviations will calculate the deviation of all the variables contained in the data set whereas Task Detect Model Deviations will calculate the deviation of the variables used by the model; by default, Task Detect Data Set Deviations will calculate the deviation probabilities in absolute terms whereas Task Detect Model Deviations will calculate the deviation according to the target SAP SE or an SAP affiliate company. All rights reserved.

51 To Detect Model Deviations in Simple Mode 1. Select Detect Model Deviations in the list Task Type. 2. Select the model in the list Model name. 3. Select the Source Name. 4. Select the reference data in the list Data Set to Test, using the Autocompletion button if required. 5. Click Next and go to the procedure Defining a Schedule To Detect Model Deviations in Data Manipulation Mode 1. Select Detect Model Deviations in the list Task Type. 2. Select the model in the list Model name. 3. Select the Source Name. 4. Select the reference population data in the list Time-stamped Population. 5. Select the reference date for model detection deviation (value of TimeStampPrompt) between these three values: date of task start date of planned task start 2015 SAP SE or an SAP affiliate company. All rights reserved. 51

52 user-defined date 6. Select the reference analytical data in the list Analytical Record. 7. Click Next and go to the procedure Defining a Schedule Detect Deviation of a Data Set This task is used to compare two data sets and to display a report indicating which variables have deviated. A Model Repository section allows managing the repository for the model used in this task type so you can reuse model repositories in the future To Detect Data Deviation in a Data Set 1. Select Standard Data Set in the list Data Set Type. 2. Select a Server. 3. In the section Reference Data, select a Source. 4. Select a Reference Data Set. 5. (Optional) Use the Skipped Variables button to ignore some of the data set variables. To do so a. Click the Skipped Variables button. b. Select one or more variables from the Variable column. c. Click the right arrow to move them to the Skipped Variables column. 6. (Optional) Use the Target Variables button to specify a target, following the same procedure as above for Skipped Variables. 7. In the section Data to be Tested for Deviations, select a Source. 8. Select a Test Data Set. If there is a TimeStampPrompt in the test data set, its value will be automatically set according to the date and time of the execution(s). 9. In the section Model Repository, choose a Source Name and a File or a Table. 10. Click Next and go to the procedure Defining a Schedule SAP SE or an SAP affiliate company. All rights reserved.

53 To Detect Data Deviation in an Analytical Record 1. Select Data Set Factory in the list Data Set Type. 2. Select a Server. 3. Select a Source. 4. Select an Analytical Record. 5. Select a Time-stamped Population for Reference Data. 6. Select a Time-stamped Population for Test Data. 7. Click Next and go to the procedure Defining a Schedule External Executable This panel allows you use a pattern to define the parameters of the external executables called by the duplicated tasks and to check that they will be correctly generated To Define the Pattern of the External Executables Parameters 1. For each external executable, enter the pattern of the arguments needed by this executable. To create the pattern, you can use the following variables: $(MODEL) : name of the model $(TASK) : name of the template task * : wildcard $(SOURCE) : data source where the template is located $(INPUT) : name of the input data set $(OUTPUT) : name of the output data set $(PROJECT) : project the template belongs to $d(your_date_pattern) : reference date. To use the reference date as an argument, it must use entered as $d(your_date_pattern), for example $d(yyyy-mm-dd HH:mm:ss). Note The date format follows Java's SimpleDateFormat specifications ( javase/6/docs/api/java/text/simpledateformat.html). 2. To display the details of the external executable and its help, click Show Details. 3. Click Check. The arguments generated from the pattern entered for each executable are listed at the bottom of the page. You can thus check that the patterns produce the expected parameters. 4. Click Next SAP SE or an SAP affiliate company. All rights reserved. 53

54 Defining a Schedule The previously configured task needs a schedule to be executed. This means defining how often and at which moment the task has to be executed. For more information on schedules see the section Essential Concepts (on page 6). To create a predefined schedule, go to the Administration panel (on page 20) To Set the Execution Schedule 1. If you want to receive a notification, check the box Notify me when the task finishes. The personal or role-specific subscriptions only send notifications, when a task is scheduled and when it finishes. 2. Choose between the following options: Execution Options Fields to Define Result Execute Once First Execution Date: click the calendar icon The task is performed once at the given date and time.. to select a date. First Execution Time : enter the launch time (format hh:mm:ss) SAP SE or an SAP affiliate company. All rights reserved.

55 Execution Options Fields to Define Result Execute n Times First Execution Date: click the calendar icon The task is performed periodically as often as indicated. to select a date. First Execution Time: enter the launch time (format hh:mm:ss). Execute every: saisissez une valeur et sélectionnez la périodicité dans la liste déroulante. Execution Count: saisissez la valeur souhaitée. Execute Once with User Defined Reference Dates First Execution Date: click the calendar icon The task is performed once, but with different reference dates. to select a date. First Execution Time: enter the launch time (format hh:mm:ss). Number of Reference Dates: enter a value. Execute on Predefined Schedule Schedule Name: select an item in the drop-down list. The task is performed as defined in the schedule. Execute after Another Task Task Name: select an item in the drop-down list. Status (of the task): indicate a status (success, failure...). Execute after an Event Task Name: select an item in the drop-down list. Event: select an item in the dropdown list. The task is performed after a previous one has been carried out. The task is performed after a given event (the detection of a deviation...). 3. Choose the First Execution Date and the First Execution Time. 4. If you selected the option Execute n Times, specify the execution frequency (in minutes, hours or other) using the Execution every field. 5. If you selected the option Execute n Times, specify the Execution Count To Base the Reference Date on the Execution Date Some tasks use a reference date to create time-stamped populations that will be used for the task execution. You can base this reference date on the task execution date by setting the option Time Lag Definition to Shift the Reference Date. In that case, the reference date used for the time-stamped populations will be the task execution date shifted by the period you will have defined in the procedure below: 1. Check the Enable Time Lag checkbox. 2. Type in the value for the time lag in the field Select a Period. 3. Choose a time unit in the drop-down list SAP SE or an SAP affiliate company. All rights reserved. 55

56 4. Select the option After or Before the execution date (by default the value is set to After). The execution time is that of the server, which is indicated on the right above the table Defining Task Name and Description The last step of scheduling a task consists in giving a pertinent name to the task a as well as a description. The following information is just displayed as a summary and cannot be modified unless you use the Previous button: Server First Execution Date First Execution Time To Name the Tasks 1. In the field Task Naming Pattern, enter the naming convention to use to generate the name of the new tasks. Each name must be unique, so the naming convention must contain the name of the template task $(TASK) and at least one of the following variables: either the name of the model $(MODEL), or the wildcard * 2. Replace the prefix_ value suggested in the field by one that will allow you to manage all these tasks at once, for example to manually execute them or to modify their schedule. 3. Click Check. If unique names cannot be generating using the provided naming convention, a warning message is displayed. The names of the new tasks are listed below the navigation buttons. 4. Click Next To Finish Scheduling a Task 1. Enter a Name for the task SAP SE or an SAP affiliate company. All rights reserved.

57 2. Enter a Description. 3. Click the button Schedule to validate all the task settings Select the Input Data Sets For each task you need to define the data sets to be used with the models selected at the previous step. Before clicking Check, you need to fill all the fields displayed in the upper section. Note Even if the external executables used by the tasks do not need an input data set, you need to enter the name of an existing file or database table. To... Define a Single Data Set to be Used with All the Models Define a Different Data Set for each Model Do this... In the field corresponding to the name of the task, enter the exact name of the data set to use. To assign a different data set to each of the selected model, the name of the data set and that of the model need to contain an identical string that will allow matching them. In the example given in the previous step, the selected models were named classification_census_01, classification_census_02 and classification_census_05, so the corresponding data sets should be named customers_01, customers_02 and customers_05. If the data set corresponding to a model does not exist, the task will not be executed for this model. Match the Data Sets by Names 1. In the field corresponding to the name of the task, enter the naming convention of the data sets. Use the * character to replace the string that will be used to match the data set names and the model names. In the previous example, you would enter customers_*. 2. In the drop-down list displayed on the right of the field, select Match by Wildcard Value. Match the Data Sets by Position The option Match by Position allows you to assign the data sets to the models alphabetically. 1. To use all the data sets from a data source, enter *, possibly with the file extension. To use only some of the data sets, for example identified by a prefix, enter the string common to all the names and use the * character for the changing part of the name. 2. In the drop-down list displayed on the right of the field, select Match by Position SAP SE or an SAP affiliate company. All rights reserved. 57

58 Select the Output Data Sets You can use the variables listed below to define the names of the data sets generated by the tasks: $(TASK) : represents the name of the task that will generate the data set $(MODEL) : represents the name of the model used by the task * : represents the string common to the names of the model and the corresponding data set The following table presents examples of naming conventions for a task named Census Apply and two models named classification_census_01 and classification_census_02. Naming Convention $(TASK)_*_out Examples of Data Set Names Census Apply_01_out Census Apply_02_out $(TASK)_out Census Apply_01_out The same output data set is used for all models used by the task. If it is a file, it will be overwritten. In case of a database table, the behavior will be the one defined in the original task. $(MODEL)_*_out classification_census_01_01_out classification_census_02_02_out $(MODEL)_out classification_census_01_out classification_census_02_out $(TASK)_$(MODEL)_out Census Apply_classification_census_01_out Census Apply_classification_census_02_out SAP SE or an SAP affiliate company. All rights reserved.

59 4 Defining a Project From A to Z This chapter details the different steps for a classical project. They are guidelines for a better understanding of Model Manager. Note The following steps can be suitable for most of the projects, but they are not meant to be systematically followed. 4.1 Declare the Sources 1. In the menu Project, in the sub-menu Management, click the item Sources. 2. In the panel Sources, click the button Select Source. 3. Select one or several sources for your project in the list of the available sources. To declare a new source, see the section To Declare a New Source. 4. Click Save. 4.2 Add the Project 1. In the menu Administration, click the sub-menu Projects. Defining a Project From A to Z 2015 SAP SE or an SAP affiliate company. All rights reserved. 59

60 2. In the panel Administration Projects, click Add Project. 3. Enter a Name for the new project. 4. Select a Project Manager in the drop-down list. 5. Enter a Description for the project. 6. Click Save. 4.3 Assign Roles 1. In the menu Project, in the sub-menu Management, click the item Assignments. 2. In the panel Roles Assignment, click the button Assign Role. 3. Assign roles to users by checking or unchecking the corresponding boxes. The table Authorized actions according to your project roles allows viewing the actions that can be performed according to the roles that a user has. To edit the rights of a role, see the section To Change the Rights. 4. Click Save. Note Only the project manager or an administrator can assign project roles to users SAP SE or an SAP affiliate company. All rights reserved. Defining a Project From A to Z

61 4.4 To Define a Single Schedule 1. In the menu Administration, click the sub-menu Schedules. 2. In the panel Administration Schedules, click the button Add Single Schedule. 3. Enter a Name for the schedule. 4. Indicate the First Execution Date. 5. Indicate the First Execution Time. 6. Enter a Description for the schedule. 7. Click Add. Defining a Project From A to Z 2015 SAP SE or an SAP affiliate company. All rights reserved. 61

62 4.5 To Define a Periodic Schedule 1. In the menu Administration, click the sub-menu Schedules. 2. Click the button Add Periodic Schedule. 3. Enter a Name for the schedule. 4. Indicate the First Execution Date. 5. Indicate the First Execution Time. 6. In the field AdministrationExecute Every, enter the periodicity. 7. Select a unit for the period (minutes, hours, days...). 8. For the Periodic Schedule Type, choose between the options: 9. If you selected the option With a limited execution count, enter the number of counts in the Executions Count field. With a limited execution count: the schedule will be valid for a limited number of times. No End Date: the schedule will be executed periodically until the task is deleted. 10. Enter a Description for the schedule. 11. Click Add SAP SE or an SAP affiliate company. All rights reserved. Defining a Project From A to Z

63 4.6 To Schedule a Task 1. In the menu Project, click the sub-menu Tasks. 2. In the panel Tasks, click the button Schedule New Task. 3. Select a Task Type. 4. Fill in the necessary fields. For further information on how to deal with the different task types, see the section Project Panel > Tasks. Defining a Project From A to Z 2015 SAP SE or an SAP affiliate company. All rights reserved. 63

64 You can launch an automatic apply task of a given model when no deviation has been detected on this model. 5. Click Next. 6. Choose one of the execution options. 7. To create a predefined schedule, see the section Schedules. 8. Click Next. 9. Enter a Name and a Description for the task. 10. Click Schedule. 4.7 To Delete a Project 1. In the menu Administration, click the sub-menu Projects. 2. In the panel Administration > Projects, click Remove to delete a project SAP SE or an SAP affiliate company. All rights reserved. Defining a Project From A to Z

65 4.8 To Import a Model into a Project 1. In the menu Project, click the sub-menu Models. 2. In the panel Models, click the button Import Model. 3. Select a Source Name in the list. 4. Click Select next to a model to import it. Note The yellow warning sign appears next to the models that are not supported by the application, hence they cannot be imported. 5. Edit the Name of the model if necessary. 6. Enter a Description for the model. 7. Click the Import button. 8. Select the Visible Model Performance Indicators in Reports. Note According to the type of model you are importing (whether supervised or non supervised clustering, or classification, or other), the options displayed on the screen will vary. For non supervised clustering models, the Visible Model Performance Indicators in Reports section does not show at all. 9. To specify the Active Version to be Used, select one of the following model activation policies: Defining a Project From A to Z 2015 SAP SE or an SAP affiliate company. All rights reserved. 65