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 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. You also get a confirmation pop-up about the schemas being extracted. The pop-up asks if you wish to configure input and ouput schemas. Click Yes to configure the schemas.

Binding Schemas to Model

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

1. In the Projects section, under Audit project, click the audit model.

2. Next, click Model Properties and 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, click Scoring Flows.
2. Click Create 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 path and description.

   

5. Click Create.

Authoring a Scoring Flow

1. In the Project Explorer pane, click Scoring Flows.
2. Select the scoring flow.
3. Select Score scoring flow template by clicking the Load template flows option under Edit section.
4. Configure the Input block.
   1. Click Input block to open the Input processing step’s configuration form.
   2. Click the drop-down menu on the Load Schema From > Model Schema > and select the schema that matches with the model

      

   3. Doing this automatically populates the input data source schema fields.

   4. Click Save.
5. Configure the Score block.
   1. Click Score block to open the Score processing step’s configuration form.
   2. Under the Model section, select audit.pmml model from the drop-down list.
   3. Under the Scoring Field Values section, click the Add Input Schema of Selected Model option.
   4. Next, from Populate unset values with entries list, select “INPUT_DATA” of step “Input”.

      

   5. Doing so populates all the scoring request fields.

   6. Click Save.
6. Configure the Output block.
   1. Click Output block to open the Output processing step’s configuration form.
   2. Click the drop-down menu for the Load Schema from option
   3. Select Model Schema > audit.pmml > audit-output.avsc schema.

      

   4. Next, from Populate unset values with entries list, select the input from the Score step.

      

   5. Click Save.

7. 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, click Scoring Pipelines.
2. Click Create 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 Create.

Authoring a Scoring Pipeline

1. In the Project Explorer pane, click Scoring Pipelines.
2. Select the scoring pipeline.
3. Click Add one under the Scoring Flows section. Select the scoring flow from the drop down list.
4. 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. Add Data Source and Data Sink from the drop down list under the Data Channels section.
   2. 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.

   

5. If you want to use REST Request-Respone, select the Expose via Service (REST).

   1. Add endpoint path prefix, login session timeout time, unique identifier, and subdomains name under their respective field.

   

6. Click Save on the main screen.

7. 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 Scoring Pipelines.
2. Select the pipeline that needs to be promoted.
3. Click Approve present in the right panel.

   

4. Turn on the toggle for Development environment and close the pop-up window.

   

Deploying a Scoring Pipeline

1. In the Project Explorer pane, click Deployments.
2. Click Deploy new and select Scoring Pipeline from the drop-down list.
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.