IBM Analytical Decision Management

https://www.ibm.com/docs/en/sdm
Admin
IBM Analytical Decision Management is a software solution that helps organizations make data-driven...
Tokens:356,297
Snippets:3,237
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Optimization Configuration with CPLEX Algorithm

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=examples-analytical-decision-management-demand-optimization-template

Configures the optimization algorithm, objective value name, and the path to the optimization model file. This example specifies the CPLEX algorithm and points to 'DemandOptimization.mod'.

```xml
<Optimization algorithm="CPLEX" objectiveValueName="ObjectiveValue" path=
 "/Applications/DemandOptimization/Optimization/DemandOptimization.mod">

```

--------------------------------

### Prefix Notation Examples

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=equation-understanding-prefix-notation

This snippet shows simple examples of prefix notation elements that might be used within IBM Analytical Decision Management expressions. These are basic building blocks for defining operations and variables.

```text
"-"
"*"
ProbabilityToRespond
Revenue
Cost
```

--------------------------------

### Configure Optimization Algorithm and Model in XML

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=examples-analytical-decision-management-campaign-optimization-template

Specifies the optimization algorithm, objective value name, and the path to the optimization model file. This example uses CPLEX with a specific model file.

```xml
<Optimization algorithm="CPLEX" objectiveValueName="ObjectiveValue" path="/Applications/CampaignOptimization/Optimization/CampaignOptimization3.mod">
```

--------------------------------

### Example URL for IBM Analytical Decision Management Login Bypass

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=guide-url-syntax

An example of a complete URL that bypasses the IBM Analytical Decision Management login page by providing username, password, and provider information. This is useful for custom integrations.

```URL
http://yourserver:8080/DM/?username=admin&password=mypassword&provider=native
```

--------------------------------

### Define Application Step Inclusion

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=examples-analytical-decision-management-customer-interactions-template

Configures which steps of the predictive application are included by setting the 'stepIncluded' attribute to 'true'. This example shows Data, Global Selections, Define, Optimize, DeployScore, and Report steps.

```xml
<DataStep stepIncluded="true"/>
			<GlobalSelectionStep stepIncluded="true"/>
			<DefineStep stepIncluded="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type=
			"typeDecisionHierarchyDefineStep">
				<DimensionSetting name="Campaign">
					<PlanningSection enableInteractionPoints="true" enableStartEndDates="true"/>
					<SelectionSection enabled="true" enableModels="true"/>
					<AllocationRuleSection enabled="true"/>
					<AggregateRuleSection enabled="false"/>
					<PredictiveModelSection enabled="false"/>
				</DimensionSetting>
			</DefineStep>
			<OptimizeStep stepIncluded="true">
				<OptimizeMethod enableNumReturnsByIP="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
			xsi:type="PrioritizationOptimization"/>
			</OptimizeStep>
			<DeployScoreStep stepIncluded="true">
				<RealTimeScoring enableInteractiveQuestions="true"/>
				<ImmediateBatchScoring enableScoringOptions="true"/>				
			</DeployScoreStep>
			<ReportStep stepIncluded="true"/>
```

--------------------------------

### XSD: Hierarchical Data Model Example with Optional Fields

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=exsd-editing-input-parameter-type

Provides an example of a hierarchical data model (Customer) where individual elements like 'FirstName' and 'Sirname' are marked as optional using `minOccurs="0"`. This indicates they are not mandatory for the rule invocation.

```xml
<xsd:complexType name="Customer">
	<xsd:sequence>
		<xsd:element name="FirstName" type="xsd:string" minOccurs="0"/>
		<xsd:element name="Sirname" type="xsd:string" minOccurs="0"/>
	
```

--------------------------------

### Hierarchical Data Model Example in XSD Schema

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=exsd-editing-input-parameter-type-3

This example illustrates a hierarchical data model structure within an XSD schema for a 'Customer' type. It shows how elements like 'FirstName' and 'Sirname' can be marked as optional using 'minOccurs="0"'.

```xml
<xsd:complexType name="Customer">
	<xsd:sequence>
		<xsd:element name="FirstName" type="xsd:string" minOccurs="0"/>
		<xsd:element name="Sirname" type="xsd:string" minOccurs="0"/>

```

--------------------------------

### Configure Application Steps in XML

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=examples-analytical-decision-management-campaign-optimization-template

This snippet shows the inclusion and configuration of various steps within the application, such as Data, Global Selections, Define, Optimize, and Deploy. It indicates which steps are active and their specific settings.

```XML
<DataStep stepIncluded="true"/>
<GlobalSelectionStep stepIncluded="true"/>
<DefineStep stepIncluded="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type= 
 "typeDecisionHierarchyDefineStep">
    <DimensionSetting name="Campaign">
        <PlanningSection enableInteractionPoints="true" enableStartEndDates="true"/>
        <SelectionSection enabled="true" enableModels="true"/>
        <AllocationRuleSection enabled="true"/>
        <AggregateRuleSection enabled="false"/>
        <PredictiveModelSection enabled="false"/>
    </DimensionSetting>
    <DimensionSetting name="Channel">
        <PlanningSection enableInteractionPoints="true" enableStartEndDates="true"/>
        <SelectionSection enabled="true" enableModels="true"/>
        <AllocationRuleSection enabled="false"/>
        <AggregateRuleSection enabled="false"/>
        <PredictiveModelSection enabled="false"/>
    </DimensionSetting>
</DefineStep>
<OptimizeStep stepIncluded="true">
    <OptimizeMethod enableNumReturnsByIP="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type= 
     "PrioritizationOptimization"/>
</OptimizeStep>
<DeployScoreStep stepIncluded="true">
```

--------------------------------

### HTML Structure for Launching POST Request

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=guide-url-syntax

This HTML code provides a basic structure for a web page, including a button that, when clicked, triggers a JavaScript function to send login information via POST. It demonstrates how to integrate the `post_to_url` JavaScript function to launch an IBM Analytical Decision Management project with specified credentials.

```html
<html>
<head>
<script type="text/javascript" language="javascript" src="base64.js"></script>
<script type="text/javascript">

function post_to_url(path, parameter, method, user, pass, provider) {
    method = method || "post"; // Set method to post by default, if not specified.

    // The rest of this code assumes you are not using a library.
    // It can be made less wordy if you use one.
    var form = document.createElement("form");
    form.setAttribute("method", method);
    form.setAttribute("action", path + parameter);
    
    if (user != null && pass != null)
    {
        var userName = Base64.encode(encodeURI(user));
        var password = Base64.encode(encodeURI(pass));
        
        var userField = document.createElement("input");
        userField.setAttribute("type", "hidden");
        userField.setAttribute("name", "username");
        userField.setAttribute("value", userName);
        
        form.appendChild(userField);
        
        var passField = document.createElement("input");
        passField.setAttribute("type", "hidden");
        passField.setAttribute("name", "pass");
        passField.setAttribute("value", password);
        
        form.appendChild(passField);
    }
    
    if (provider != null)
    {
        var providerField = document.createElement("input");
        providerField.setAttribute("type", "hidden");
        providerField.setAttribute("name", "provider");
        providerField.setAttribute("value", provider);
        
        form.appendChild(providerField);
    }
   
    document.body.appendChild(form);
    form.submit();

}
</script>
   

</head>
    <table>
        <tr>
            <td><button onclick="post_to_url('http://localhost:9084/DM/', '', 'post', 'admin', 'spss', 'Native');">
            Test</button> </td>
            <td>Post User Info</td>
            <td>gethost() + ''</td>
        </tr>
    </table>
</html>
```

--------------------------------

### Hierarchical Data Model Example with Optional Fields

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=exsd-editing-input-parameter-type-1

Provides an example of an XSD schema for a 'Customer' complex type using a hierarchical data model. It demonstrates how to define optional fields like 'FirstName' and 'Sirname' using 'minOccurs="0"'.

```xml
<xsd:complexType name="Customer">
	<xsd:sequence>
		<xsd:element name="FirstName" type="xsd:string" minOccurs="0"/>
		<xsd:element name="Sirname" type="xsd:string" minOccurs="0"/>
		

```

--------------------------------

### Configure CPLEX Algorithm for Demand Optimization

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=equation-example-analytical-decision-management-demand-optimization

This configuration defines the CPLEX algorithm for demand optimization and sets up objective functions. It specifies the path to the optimization model file and defines how 'ExpectedRevenue' and 'ExpectedRevenueWithPreferred' are calculated, including conditions for using preferred requests.

```xml
<Optimization algorithm="CPLEX" objectiveValueName="ObjectiveValue" path="/Applications/DemandOptimization/Optimization/
DemandOptimization.mod">
		<ObjectiveFunction Domain="double" Name="ExpectedRevenue" description="ExpectedRevenueDescription">
			<ExpressionFormat format="( ${UnitRevenue} * ${StockRequested} )"/>
			<ExternalUsage controlVariable="use_expected_revenue_function" variableType="int" enabledValue="1" disabledValue="0"/>
		</ObjectiveFunction>
		
		<ObjectiveFunction Domain="double" Name="ExpectedRevenueWithPreferred" description="ExpectedRevenueWithPreferredDescription">
			<ExpressionFormat format="( ${UnitRevenue} * ${StockRequested} * ${RequestPriority} )"/>
			<ExternalUsage controlVariable="use_prioritize_preferred_function" variableType="int" enabledValue="1" disabledValue="0"/>
		</ObjectiveFunction>
```
```

--------------------------------

### Example Equation in Prefix Notation

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=equation-defining-equations-using-expression-builder

This is an example of a mathematical equation defined using prefix notation, which is used in the Expression Builder. It represents a simple profit calculation based on quantity, price, unit cost, and promotion cost.

```text
profit = quantity * (price - unit cost - promotion cost)
```

--------------------------------

### Project Templating

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=guide-url-syntax

Launch IBM Analytical Decision Management and create a new project based on a specified application template using the 'template' parameter.

```APIDOC
## Create New Project from Template

### Description
Launches IBM Analytical Decision Management and initializes a new project based on a predefined application template. The user is responsible for saving the new project.

### Method
GET

### Endpoint
/DM/

### Parameters
#### Query Parameters
- **template** (string) - Required - The name of the application template to use for the new project. 
  Possible values include: `ModelerAdvantage`, `CampaignOptimization`, `ClaimsManagement`, `CustomerInteractionManagement`, `DemandOptimization`, `PredictiveMaintenance`, `RulesManagement`.

### Request Example
```
http://yourserver:8080/DM/?template=ModelerAdvantage
```

### Response
#### Success Response (200)
Launches IBM Analytical Decision Management with a new project created from the specified template.

#### Response Example
(No specific response body defined, typically loads the application with a new project context)
```

--------------------------------

### Application Step Configuration

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=examples-analytical-decision-management-demand-optimization-template

Configures the inclusion and details of various steps within an application, such as Data, Global Selections, Define, Optimize, Deploy, and Reports. It shows how to enable or disable specific features within these steps.

```xml
<DataStep stepIncluded="true"/>
			<GlobalSelectionStep stepIncluded="true"/>
			
			<DefineStep stepIncluded="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="typeDecisionHierarchyDefineStep">
				<DimensionSetting name="Inventory">
					<PlanningSection enableInteractionPoints="true" enableStartEndDates="true"/>
					<SelectionSection enabled="true" enableModels="true"/>
					<AllocationRuleSection enabled="false"/>
					<AggregateRuleSection enabled="false"/>
					<PredictiveModelSection enabled="false"/>
				</DimensionSetting>
			</DefineStep>
			<OptimizeStep stepIncluded="true">
				<OptimizeMethod enableNumReturnsByIP="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PrioritizationOptimization"/>
			</OptimizeStep>
			<DeployScoreStep stepIncluded="true">
				<RealTimeScoring enableInteractiveQuestions="false"/>
				<ImmediateBatchScoring enableScoringOptions="true"/>				
			</DeployScoreStep>
			<ReportStep stepIncluded="true"/>
```

--------------------------------

### Hierarchical Data Model Example with Optional Fields

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=definition-editing-input-parameter-type

Example of an XSD schema for a hierarchical data model ('Customer') where input fields like 'FirstName' and 'Sirname' are marked as optional using 'minOccurs="0"'. This allows null values but signifies they are not mandatory for the rule.

```xml
<xsd:complexType name="Customer">
	<xsd:sequence>
		<xsd:element name="FirstName" type="xsd:string" minOccurs="0"/>
		<xsd:element name="Sirname" type="xsd:string" minOccurs="0"/>
```

--------------------------------

### Example Rules for Repeat Predictions

Source: https://www.ibm.com/docs/en/sdm/18.0_topic=oms-association-rule-scoring-options-5

This snippet demonstrates how multiple rules can predict the same item, 'wine', in this case. The 'Allow repeat predictions' option in scoring controls whether all such rules are considered.

```plaintext
bread & cheese -> wine
cheese & fruit -> wine
```
Tokens:
Raw