Quick Start

Signing in to ModelOps

1. From a supported web browser, enter your TIBCO ModelOps user name and password (as configured by your TIBCO ModelOps administrator) in the welcome screen.

   

2. Click Sign In. Once signed in, the ModelOps UI offers different navigational views to get you started.

Creating a Project

1. In the Project Explorer pane, next to the Projects section, click the plus sign (+) and select Create a New Project.
2. Enter project name as Audit.
3. Click Add artifacts and select the artifacts by navigating to the location they are stored.

   

4. After you import the file, click CREATE.

Creating Schemas for a Model

To bind schemas to a model, we need to create schemas first. An input schema defines the structure of the data expected by a model for scoring, and the output schema defines the structure of the data returned by a model after scoring.

1. In the Projects section, under Audit project, click the three vertical dots for audit.pmml model.
2. Next, click Create Schemas.

   

This creates input and output schemas needed to bind to the model. You can see these schemas in the Project Explorer pane, in the Projects section.

Binding Schemas to Model

Before creating a scoring flow, we first need to bind input and output schemas to the model.

1. In the Project Explorer pane, under Projects section, click the audit.pmml model.

2. Next, click Properties and select Model Properties. Now, select the input and output schemas from the drop-down list.

   

3. After done, click SAVE and PUBLISH.

Creating a Scoring Flow

1. In the Project Explorer pane, under Overview section, click Scoring Flows.
2. Click ADD A SCORING FLOW to create a new scoring flow. You can also click Add one to add a new scoring flow if there are none present.
3. Select the project name from the list.
4. Add flow name and description.

   

5. Click FINISH.

Authoring a Scoring Flow

1. In the Project Explorer pane, under Overview section, click Scoring Flows.
2. Select the scoring flow.
3. We are using Edit Wizard to author the scoring flow. Click the Content arrow and select Edit Wizard.

   

4. In the Select a Template section, click the Score model.

5. Configure the Input block.
   1. Click the contextual menu for Load Schema From and select Data Source > Audit.

   

   Selecting the data source automatically populates the input data source schema fields. 2. Click SAVE.

6. Configure the Score block.
   1. Under Model, select audit.pmml model from the drop down list.
   2. Under the Scoring Request Fields section, click the Add Input Schema of Selected Model option.
   3. Next, from Populate unset values with entries list, select “Input_Data” of step “Input”.

   

   1. Doing so populates all the scoring request fields.
   2. Click SAVE.
7. Configure the Output block.
   1. Click the drop down menu for Load Schema From > Model Schema > audit.pmml > audit-output.avsc.

   

   1. Next, from Populate unset values with entries list, select “SCORE” of step “Score”.

   

   1. Click SAVE.
8. Click PUBLISH on the main screen. Select the scoring flow to be published and add a relevant message. Click PUBLISH.

   

Creating a Scoring Pipeline

1. In the Project Explorer pane, under Overview section, click Pipelines.
2. Click ADD A SCORING PIPELINE to create a new scoring pipeline. You can also click Add one to add a new scoring pipeline if there are none present.
3. If ModelOps contains only one project, the project name will be selected automatically. Else, you can select the project name from the list.
4. Add pipeline name and description.

   

5. Click FINISH.

Authoring a Scoring Pipeline

1. In the Project Explorer pane, under Overview section, click Pipelines.
2. Select the scoring pipeline.
3. If you are using Data Source and Data Sink as input and output, select the Connect to deployed Data Channels for input and output.
   1. Select the scoring flow from the drop down list under Scoring Flows section.
   2. Add Data Source and Data Sink from the drop down list under the Data Channels section.
   3. A data source is used to supply data to a flow to process it. A data sink is a place where the data processed by the flow is sent.

   

4. If you want to use REST Request-Respone, select the Expose via REST Request-Response.

   1. Select the scoring flow from the drop down list under Scoring Flows section.
   2. Add channel endpoint path prefix, session timeout time, unique identifier, and external host name under their respective field.

   

5. Click SAVE on the main screen.

6. Next, click PUBLISH on the main screen. Select the scoring pipeline to be published and add a relevant message. Click PUBLISH.

Approving a Scoring Pipeline to Environment

1. In the Project Explorer pane, click Pipelines.
2. Select the pipeline that needs to be promoted by clicking the check box.
3. Click Approve present at the bottom of the pipeline list.

   

4. Turn on the toggle for Development environment and click CLOSE.

   

Deploying a Scoring Pipeline

1. In the Project Explorer pane, click Scoring Pipeline Deployments.
2. Select the DEPLOY A SCORING PIPELINE option.
3. Add name and description in the respective field.
4. Select scoring pipeline from the drop down list.
5. Select a scoring environment from the drop-down list.
6. Select when you need to schedule the job from the given options (Immediate, Future, or Periodic).
7. Select the duration for which you need to run the job. You can run the job forever or add the duration as per your needs.

   

8. Click DEPLOY. You can see the deployed pipeline in the list on the main screen.