SSGH5D_26.0.0 - Documentation Index

Table of Contents

• Decision Intelligence Client Managed Software
  • Release notes
    • What's new
    • Privacy and compliance
      • Guidelines for GDPR readiness
      • FIPS compliance
    • Known limitations
    • Deprecated and removed features
  • Overview
    • Modeling and authoring business decisions
    • Collaborating on decision services
    • Integrating generative AI in decisions
    • Infusing business decisions with machine learning
    • Deploying and executing decision services
  • Upgrading
    • Upgrading from 26.0.0 to 26.0.0-IF001 or later
      • Upgrading from 26.0.0 to 26.0.0-IF001 or later by running the script
      • Completing the upgrade from 26.0.0
    • Upgrading from 25.0.1 to 26.0.0
      • Upgrading from 25.0.1 to 26.0.0 by running the script
      • Completing the upgrade from 25.0.1
    • Upgrading from 25.0.0 to 26.0.0
      • Upgrading from 25.0.0 to 26.0.0 by running the script
      • Completing the upgrade from 25.0.0
    • Upgrading from 24.0.0 to 26.0.0
      • Upgrading from 24.0.0 to 26.0.0 by running the script
      • Completing the upgrade from 24.0.0
  • Installing
    • Planning
      • System requirements
      • Storage considerations
      • Logging considerations
    • Preparing
      • Collecting and sending metrics to IBM Software Central
        • Reporting usage metrics with IBM Usage Metering Service
        • Uploading usage metrics to IBM Software Central for an air-gapped deployment
        • Disabling the usage metering service
      • Getting an IBM entitlement API key
      • Installing License Service and the certificate manager
      • Preparing your cluster for an air-gapped (offline) deployment
        • Setting up a host to mirror images to a private registry
        • Downloading the CASE files
        • Mirroring images to a private registry
          • Option 1: Mirroring images to a private registry with a bastion server
          • Option 2: Mirroring images to a private registry with a portable compute or a storage device (file system)
        • Setting up a repeatable air-gap process
      • Configuring PostgreSQL storage
        • Configuring Identity Management and Platform UI
        • Custom JDBC drivers
      • Configuring a generative AI secret
      • Configuring Decision Designer
      • Configuring the decision runtime
        • Configuring the event emitter for an external Apache Kafka instance
    • Installing Decision Intelligence Client Managed Software
      • Installing the Decision Intelligence Client Managed Software operator
      • Checking and completing your custom resource
        • Configuring Decision Intelligence Client Managed Software
        • Configuring for using Business Automation Insights
      • Applying the custom resources for Decision Intelligence Client Managed Software
      • Custom resource statuses
    • Completing post-installation tasks
      • (Optional) Creating Kubernetes Ingresses
      • Accessing the home page
      • Determining Decision Designer server URL
      • Configuring an identity provider
      • Managing user permissions
      • Tuning the logging level
    • Uninstalling
  • Administering
    • Configuring credentials for a Maven repository manager
    • Configuring global machine learning providers
    • Connecting to a remote repository automatically
    • Setting up your build environment
      • Using Decision Designer as a Maven repository
      • Using an external Maven repository
    • Installing the Decision Intelligence Client Managed Software command-line tool
    • Configuring for disaster recovery
      • Backing up Decision Intelligence Client Managed Software
      • Restoring Decision Intelligence Client Managed Software
    • Viewing metering information
    • Tuning performance
    • Configuring Horizontal Pod Autoscaler
  • Learning resources
    • Getting started
      • Before you start
      • Task 1: Making a decision service
      • Task 2: Exposing and sharing your decision service
      • Task 3: Adding nodes
      • Task 4: Creating a data model
      • Task 5: Using the interaction policy
      • Task 6: Deploying and running a decision
    • Best practices tutorials
      • Best practices for modeling decisions
        • Task 1: Making an individual decision
        • Task 2: Making decisions for a population of cases
        • Task 3: Making decisions for families of cases
        • Task 4: Making intermediate decisions
        • Task 5: Creating composite types
        • Task 6: Applying a decision logic to many values
        • Task 7: Applying decision models to multi-valued variables
        • Task 8: Adding a final decision node
      • Best practices for defining the decision logic
        • Task 1: Making decisions with single rules
        • Task 2: Ensuring completeness
        • Task 3: Understanding undefined decisions
        • Task 4: Selecting or aggregating values from multiple rules
        • Task 5: Implementing sequential rule-based decision modeling
    • Predictive modeling tutorials
      • Using machine learning to make better decisions
        • Task 1: Defining and deploying a machine learning model in Watson Machine Learning
        • Task 2: Defining a machine learning provider in Decision Designer
        • Task 3: Defining and using a predictive model
        • Task 4: Deploying and executing the decision service
      • Quick guide: Integrating Watson Machine Learning with decision services
        • Task 1: Creating an empty deployment space in Watson Studio
        • Task 2: Defining a machine learning provider in Decision Designer
        • Task 3: Uploading a PMML file and connecting a predictive model
        • Task 4: Running a predictive model and a decision model
      • Quick guide: Using the embedded machine learning provider
        • Task 1: Defining a machine learning provider in Decision Designer
        • Task 2: Uploading a PMML file and connecting a predictive model
        • Task 3: Running a predictive model and a decision model
      • Using machine learning to reduce customer churn
        • Task 1: Setting up the sample
        • Task 2: Reviewing the sample details
      • Importing a PMML file to create a transparent predictive model
        • Task 1: Importing a sample decision service and exploring resources
        • Task 2: Creating and configuring a predictive model
        • Task 3: Integrating the predictive model into a decision model
    • Using generative AI within decisions
      • Task 1: Configuring a generative AI provider
      • Task 2: Importing and exploring a sample decision service
      • Task 3: Creating a generative AI model and integrating it into a decision model
    • Using a definition file to create a data model
      • Importing a data model definition file
    • Samples and tutorials in GitHub
  • Building decision services in Decision Designer
    • Building decision services
      • Defining data
        • Creating data models
          • Creating data types
            • Introduction to data types
            • Creating composite types
            • Creating enumeration types
              • Entering values manually
              • Extracting values from an external data source
                • Importing an Excel file
                • Mapping values to an enumeration type
                • Updating values
          • Creating business functions
            • Creating functions
            • Creating actions
          • Importing a data model definition file
            • Definition file annotations
            • Defining default values
          • Using data models in other decision artifacts
          • Default verbalization
            • Default verbalization in Brazilian Portuguese
            • Default verbalization in Chinese
            • Default verbalization in English
            • Default verbalization in French
            • Default verbalization in German
            • Default verbalization in Italian
            • Default verbalization in Japanese
            • Default verbalization in Spanish
        • Working with external libraries
          • Building an external library
            • Creating a POM file for an external library
            • Generating the external library files
            • Editing the generated files
              • Editing the vocabulary
                • Vocabulary
                  • Vocabulary elements
                  • Placeholders
                  • Default verbalization in English
                  • Vocabulary properties
                  • Vocabulary errors and warnings
                • Editing terms
                • Documenting terms
              • Adding annotations
                • Annotations
                  • Collections
                  • Pure functions
                  • Impure functions
                  • Constructors
                  • Value types
                • External annotation files
              • Adding custom BOM types and members
                • Defining custom members and their implementation
                • Understanding BOM-to-XOM mapping
            • Method restrictions
          • Importing an external library into Decision Designer
          • Using an external library in a decision service
          • Changing the version of an external library
          • Updating external libraries
      • Creating decision models
        • Designing a decision
        • Creating a decision diagram
          • Defining input
            • Creating an input data node
            • Defining a default value
          • Adding decisions
            • Creating a decision node
            • Adding the decision logic
              • Creating a business rule
              • Creating a decision table
              • Defining a default value
              • Choosing an interaction policy
          • Calling other models
      • Creating task models
        • Orchestrating rules
        • Creating task model artifacts
          • Creating a folder
          • Creating a business rule
          • Creating a decision table
          • Creating a variable set
          • Creating a ruleflow
            • Building a ruleflow
            • Defining the ruleflow structure
              • Adding task nodes
                • Adding a rule task node
                • Adding an action task node
                • Adding a function task node
                • Adding a subflow task node
              • Connecting nodes
            • Using a generative AI output in a ruleflow
            • Choosing an execution mode
            • Choosing a language
        • Creating functions
      • Creating generative AI models
        • Creating prompts
      • Creating predictive models
        • Managing local machine learning providers
        • Creating a predictive model
          • Configuring a predictive model
            • Invoking a machine learning model hosted remotely
            • Importing a transparent machine learning model
          • Mapping input data types
          • Editing the invocation rule
          • Mapping output data types
        • Updating a predictive model
        • Integrating a predictive model
      • Authoring the decision logic
        • Working with business rules
          • How business rules work
            • Rule variables
              • Types of rule variables
            • Rule conditions
              • Conditions that compare business terms and values
              • Conditions that test for existence
              • Conditions that test for set membership
              • Combinations of conditions
              • Combination negation
            • Rule actions
              • Rule actions for lists of business terms
              • Dependency of rule actions on rule variables
          • Using the rule editor
            • Creating rule parts with the completion menu
            • Using punctuation to avoid ambiguity
            • Setting completion menu options
            • Basic syntax checks
            • Using shortcuts
        • Working with decision tables
          • Columns
            • Using the column menu
            • Defining columns
            • Sorting and filtering columns
          • Rows
            • Using the row menu
            • Adding a partially completed row
            • Grouping and splitting rows
          • Cells
            • Using the cell menu
            • Specifying values
            • Changing the default operator for a cell
          • Preconditions
          • Using decision table locking facilities
          • Decision tables errors and warnings
          • Exporting and importing decision tables with Excel
        • Conducting completeness analysis
      • Reusing decision artifacts
        • Publishing decision artifacts
        • Managing dependencies
      • Creating decision operations
      • Creating versions
      • Comparing revisions of decision artifacts
      • Automatic refactoring
      • Finding references
    • Interacting with Decision Designer through an MCP server
      • Configuring IBM Bob to connect to the MCP server
      • Using the MCP server
    • Working collaboratively on decision services
      • Loading changes
      • Resolving conflicts
      • Sharing changes
      • Reverting changes
      • Restoring changes
    • Managing decisions
      • Managing access to decision automations
      • Connecting to a remote repository manually
      • Managing decision services
      • Managing branches
        • Creating branches
        • Merging branches
        • Protecting branches
      • Editing group IDs
  • Testing decision services
    • Running models with test data
    • Unit testing
      • Adding JSON scenarios
  • Deploying decision services
    • Building and deploying from Decision Designer
    • Building and deploying from a CI/CD stack
    • Deploying to decision runtime with REST API
    • Deployment spaces
    • Promoting deployed decision services to another decision runtime
  • Executing decision services
    • Decision services from the run service
    • Decision services from a CI/CD stack
    • Decision service metadata
    • Executing decision services with decision runtime
      • Metering and tracking usage for decision runtime
      • Prometheus metrics endpoint for decision service executions
      • User permissions and authentication modes
      • Selecting decision services for execution
        • Executing the last deployed version
        • Executing the last semantic version
        • Executing the last sorted version
        • Executing a specific version
      • Calling decision services
      • Execution trace for decision runtime
      • Runtime snapshots
      • Swagger UI for decision runtime API
      • Emitting decision execution events
    • Executing decision services with execution Java API
      • Monitoring executions with IBM License Metric Tool
      • Metering and tracking usage for execution Java API
      • Application packaging
      • Executing a decision operation
      • Input and output format
      • Machine learning services
      • Execution trace for execution Java API
    • Integrating decision services into AI applications
  • Reference
    • Configuration parameters
      • Decision Designer parameters
      • Decision runtime parameters
      • Shared parameters by Decision Designer and the decision runtime
    • Decision Intelligence Client Managed Software command-line tool reference
    • Annotations Java API reference
    • Error codes in predictive model output
    • Languages reference
      • Rule language
        • Rule structure
          • Understanding the structure of business rules
          • Condition part
            • Preconditions
              • for each (object) called (variable), in (list)
              • definitions
                • set (variable) to (definition)
                • from (object)
                • in (list)
                • (attribute) of (list)
                • where (test)
            • Conditions
              • all (type) in (list)
              • all of the following conditions are true
              • any of the following conditions is true
              • in (list)
              • (variable) is defined | undefined
              • it is not true that (a condition)
              • (attribute) of (list)
              • none of the following conditions are true
              • the number of (type)
              • there are (number) (type)
              • there are at least (number) (type)
              • there are at most (number) (type)
              • there are less than (number) (type)
              • there are more than (number) (type)
              • there is at least one (type)
              • there is at most one (type)
              • there is no (type)
              • there is one (type)
          • Action part
            • add (object) to (variable)
            • define (variable) as (value)
            • for each (object) in (list)
            • (attribute) of (list)
            • print (string)
            • remove (object) from (variable)
            • set (variable) to (value)
        • Data types and functions
          • Numbers
            • Mathematical operators and functions
            • Number comparison functions
          • Boolean
            • Logical operators
          • Dates and times
            • Time point functions
            • Time period functions
            • Calendar duration functions
          • Strings
            • String functions
            • String conversion functions
            • String patterns
            • String interpolation
            • String affiliation
          • Lists
            • List functions
            • Aggregation functions
            • Stream operators
            • Empty list constructor
          • Object functions
        • Function invocation
        • Punctuation in rules
      • Advanced Rule Language (ARL)
        • ARL syntax
          • Variables
            • Data types
          • Operators
          • Type conversion
          • Expressions
          • Statements
          • Keywords
        • ARL task model examples
      • Business Function Language
        • Expressions
        • Statements
          • Actions
          • String affiliation
          • declare
          • if/then/else
          • while
          • for each
          • result
    • Unit testing Java API reference
    • Decision runtime REST API reference
    • Execution Java API reference
    • Business Automation Insights reference
      • Technical and business event format
      • Raw event format
  • Troubleshooting
    • Decision returns null
    • A rule is not executed
    • An exception is thrown
    • An ads-runtime pod is evicted because the EmptyDir volume for archive-cache-dir exceeds the limit
    • Decision Designer fails to connect to services during startup
    • Decision Intelligence Client Managed Software instance creation fails
    • Webhook communication errors might occur when Decision Intelligence Client Managed Software is deployed to EKS
    • Runtime container does not start after the database migration or update failed
  • Glossary