LogoLogo
IntegrationsInstallationAdministrationContact Support
XMPro Platform
XMPro Platform
  • What is XMPro?
  • Getting Started
    • Browser Requirements
    • End-To-End Use Case
  • Resources
    • What's New in 4.4
      • What's New in 4.3
      • What's New in 4.2
      • What's New in 4.1.13
      • What's New in 4.1
      • What's New in 4.0
    • Blueprints, Accelerators & Patterns
    • Integrations
    • Sizing Guideline
    • Platform Security
    • Icon Library
    • FAQs
      • Implementation FAQs
      • Configuration FAQs
      • Agent FAQs
      • General FAQs
      • External Content
        • Blogs
          • 2024
            • How to Build Multi-Agent Systems for Industry
            • Why Solving the Problem Doesn’t Solve the Problem: The Importance of Scalable Intelligent Operations
            • Content, Decision, and Hybrid: The Three Pillars of Multi-Agent Systems in Industry
            • Revolutionizing Manufacturing with AI and Generative AI: XMPro’s Intelligent Business Operations Sui
            • The Evolution of Skills: Lessons from Agriculture in the GenAI and MAGS Era
            • Part 1: From Railroads to AI: The Evolution of Game-Changing Utilities
            • Part2: The Future of Work: Harnessing Generative Agents in Manufacturing
            • Bridging Automation and Intelligence: XMPro’s Approach to Industrial Agent Management
            • XMPro APEX: Pioneering AgentOps for Industrial Multi Agent Generative Systems
            • Part 5 – Rules of Engagement: Establishing Governance for Multi-Agent Generative Systems
            • How to Achieve Scalable Predictive Maintenance for Industrial Operations
            • Understanding the Difference Between XMPro AI Assistant and AI Advisor
            • Part 3 – AI at the Core: LLMs and Data Pipelines for Industrial Multi-Agent Generative Systems
            • MAGS: The Killer App for Generative AI in Industrial Applications
            • The Importance of Pump Predictive Maintenance for Operational Efficiency
            • Progressing Through The Decision Intelligence Continuum With XMPro
            • The Value-First Approach to Industrial AI: Why MAGS Implementation Must Start with Business Outcomes
            • New Guide – The Ultimate Guide to Multi-Agent Generative Systems
            • The Ultimate Guide To Predictive Analytics
            • Part 4 – Pioneering Progress | Real-World Applications of Multi-Agent Generative Systems
            • Scaling Multi-Agent Systems with Data Pipelines: Solving Real-World Industrial Challenges
          • 2023
            • How to master Predictive Analytics using Composable Digital Twins
            • Accelerate Your AI Workflow: The 3 Key Business Advantages of XMPro Notebook
            • The Roadmap to Intelligent Digital Twins
            • What is edge computing, and how can digital twins utilize this technology?
            • THE TOP 5 USE CASES FOR COMPOSABLE DIGITAL TWINS IN RENEWABLES + HOW TO SUPERCHARGE RESULTS WITH AI
            • The Technology Behind Predictive Maintenance (PdM) : Hardware & Software
            • The Benefits of Using Digital Twins in Smart Manufacturing
            • XMPro I3C Intelligent Digital Twins Strategy Framework
            • The TOP 5 use cases for composable digital twins in mining – and how to use AI to supercharge result
            • The TOP 5 use cases for Composable Digital Twins in the Oil & Gas industry
            • Why Decision Intelligence with Digital Twins is “kinda like” DCS for Automation and Control
            • XMPro becomes an NVIDIA Cloud-Validated partner
            • From Reactive to Predictive : Introduction to Predictive Maintenance
            • Microsoft Azure Digital Twins : Everything You Need To Know
            • Unlocking Efficiency: The Right Time & Strategy to Launch Your Digital Twin for Enhanced Asset Manag
            • Revolutionize Your Supply Chain: How Digital Twins Can Boost Efficiency and Cut Costs
          • 2022
            • Create a Common Operating Picture of Your Operations with XMPro
            • 7 Trends for Industrial Digital Twins in 2022
            • How to Build a Digital Twin + 60 Use Cases By Industry
            • What are composable digital twins in the metaverse?
          • 2021
            • The Value of a Composable Digital Twin
          • 2020
            • Lean Digital Twin: Part 2
            • Digital Twin: Your Most Productive Remote Worker
            • From the Control Room to the Bedroom
            • Lean Digital Twin: Part 3
          • 2019
            • My Digital Twin: Digital Twin Applications for Real-time Operations (Like Me)
          • 2018
            • XMPro IoT Operational Capability Survey Results 2018
            • What is a Digital Business Platform and Why Should I Care?
            • [Robotic] Process Automation for IoT
            • 3 Patterns of Industrial IoT Use Cases
            • The CXO’s Guide to Digital Transformation – May The Five Forces Be With You
            • Is Security More Important Than Trustworthiness for Industrial IoT?
            • XMPro at bpmNEXT 2018: Watch The Presentation
          • 2017
            • The Top 5 Reasons to Invest in an IIoT Development Platform
            • IoT Business Solutions Start with Big Data & Create Business Outcomes
            • How AI Bots Bring Digital Twins to Life
          • 2016
            • How To Get Started With Industrial IoT
            • How To Overcome The Top 5 Challenges To Industrial IoT Adoption
            • What is an IoT Platform vs. an IoT Business Application Suite?
            • Industrial IoT: How To Get Started with Predictive Maintenance
            • 3 Ways The Internet of Things is Transforming Field Service
            • 7 Types of Industrial IoT Data Sources (And How To Use Them)
          • 2015
            • How Important Are Processes To The Internet Of Things?
            • Understanding the Value of Real Time KPI Management as Your Next Strategic Project
            • 6 Myths About Machine Learning
            • 10 Predictive Analytics Use Cases By Industry
            • What is a “Business Moment” in your business?
            • Does Operational Intelligence Make Business Intelligence Obsolete?
            • How To Reduce Operational Costs by 36% with Predictive Analytics
            • From Many, One – The Nature of Complex Event Processing
            • Herding Cats: What Enterprise Architects need to know about Business Process Management
          • 2014
            • Making Business Operations More Intelligent
          • 2013
            • Best Next Action Is The Next Big Thing For Intelligent Operations
            • The learns from two ‘Best in class’ organisations acquiring BPM technology
          • 2012
            • Why Intelligent Business Operations is Mobile, Social and Smart
            • Why Do You Want Intelligent Business Operations?
            • How big of a problem are ‘dark processes’?
            • Operational Risk: When You Stick Your Head In The Sand
            • The Difference Between Event-based And Workflow-based Processes
          • 2011
            • Is mobile BPM now essential to the business?
            • Stretch Socially Dynamic Processes To Fit Your Business
            • Social Listening – Get Control Of The Conversation
            • Operations Management – The Keys To KPIs
            • Benefits of BPM v 1.0
            • How to Prioritise Processes
          • 2010
            • The Business Drivers
            • Preserving Capability and Agility
            • Mobile BPM
        • Use Cases
          • Aging Pipe Predictive Maintenance in Water Utilities
          • Air Quality Monitoring For Agriculture
          • Alarm Management and Triage
          • Asset Condition Monitoring for Surface Processing Plants in the Mining Industry
          • Bogie Health Monitoring in the Rail Industry
          • Boiler Feed Water Pumps
          • CHPP Throughput Loss Monitoring
          • Casting Guidance
          • Conveyor Belt System Monitoring and Optimization in Automotive Manufacturing
          • Cooling Tower Fin Fan Monitoring
          • Cyclone/Slurry Pump Monitoring
          • Demand Planning to Reduce Stockholding in Stores
          • Demin Water Monitoring for Boiler Tube Corrosion
          • EV Battery Assembly Process Optimization for the Car Manufacturing Industry
          • Flood Prediction & Response in Water Utilities
          • Golden Batch For Culture Addition In The Dairy processing Industry.
          • Golden Batch Monitoring
          • Improve First Pass Yield (FPY)
          • Induced Draft (ID) Fan Monitoring
          • Long Conveyor Monitoring
          • Monitor Process Health to Reduce Cash-to-Cash Cycle
          • Monitor Storm Water Reservoirs For Flood Prevention
          • Monitor and Reduce Energy Consumption
          • Oil Well Maintenance Planning
          • Oil Well RTP Monitoring
          • Pipe Scaling Prediction for Roller Cooling
          • Precision Irrigation in Agriculture
          • Predict Heat Exchanger Fouling
          • Predictive Maintenance & Asset Health Monitoring For Haul Trucks In The Mining Industry
          • Predictive Maintenance For Mobile Assets Within The Mining Industry
          • Predictive Maintenance for Robotic Arms in the Automotive Industry
          • Predictive Maintenance for Wind Turbines
          • Pump Health Monitoring in Water Utilities
          • Pumping Station OEE
          • Real-time Balanced Business Scorecard (BBS)
          • Real-time Safety Monitoring
          • Short Term Inventory Planning
          • Strategic Performance & Safety Oversight for Global Mining Operations
          • Wheel and Track Wear Monitoring In The Rail Industry
          • Wind Turbine Performance Optimization
        • Youtube
          • 2024
            • Discover Gen AI Powered Operations With XMPro iBOS
            • Generative AI and Digital Twins in 2024 - XMPro Webinar
            • Go From Reactive To Predictive Operations In Water Utilities With XMPro iDTS
            • How to add Timestamps to Elements in XMPro App Designer
            • How to Build an AI Advisor for Industrial Operations Using XMPro
            • How XMPro Stream Hosts and Collections Enable Scalable, Real-Time Data Processing
            • Mind Blowing AI Agentic Operations For Industry With XMPro MAGS
            • The Ultimate Beginner's Guide To Predictive Analytics Podcast
            • XMPro's Flexible Deployment Options: Flexible Cloud & On-Premise Solutions For Industry
            • XMPro iBOS: The Only AI-Powered Suite for Scalable Intelligent Operations
          • 2023
            • 2023 XMPro Product Roadmap - Webinar
            • An Introduction To Intelligent Digital Twins - Webinar
            • Energy and Utilities Asset Optimisation through Digital Twin technology
            • Explore Model Governance using our MLflow Agent
            • Exploring XMPro Notebook and MLflow for Data Science and Model Governance
            • How Changing Properties For One Block Can Be Applied To All Blocks Within Same Style Group
            • How do I Use A Button To Update a Data Source In XMPro App Designer
            • How Does XMPro Compare To ESBs (Enterprise Service Buses)-
            • How to Configure and Integrity Check in Data Streams
            • How To Create A Widget Within XMPro App Designer
            • How to Create Intelligent Digital Twins Using XMPro AI
            • How to export grid data to Excel In XMPro App Designer
            • How to Revolutionize Your Supply Chain with Digital Twins
            • How To Rotate Text In App Designer
            • How To Update a Data Source Using A Button
            • How To Use & Clone XMPro Demos For Your Own Use
            • How To Use And Build 3rd Party Apps To Extend The Capabilities Of The XMPro App Designer.
            • How to use Avatars and why they are important
            • How to view stream host logs In XMPro Data Stream Designer
            • Logging Provider Support With XMPro
            • Mastering Health Check Endpoints: A Guide to Ensuring Service Uptime and Performance with XMPro
            • Mastering Root Cause Analysis with XMPro: Capture, Value, Impact
            • Microsoft Azure Digital Twins Everything You Need To Know
            • Model Based Predictive Maintenance (PdM) With XMPro
            • Monthly Webinar - Accelerate your digital twin use cases - XMPro Blueprints, Accelerators & Patterns
            • Optimizing Time Series Chart (TSC) Performance
            • Predictive Maintenance & Condition Monitoring - A Hot Seat Q&A Session
            • Predictive Maintenance with XMPro iDTS
            • Smart Facilities Management with Intelligent Digital Twins
            • The Benefits of using Digital Twins in Smart Manufacturing
            • The Four Industrial Revolutions Explained In Under 4 Minutes! #industry4 #smartmanufacturing
            • The Roadmap To Intelligent Digital Twins
            • The Technology Behind Predictive Maintenance (PdM) - The Hardware & Software that makes PdM Tick...
            • THE TOP USE CASES FOR COMPOSABLE DIGITAL TWINS IN RENEWABLES
            • Tips on how to use cache in agent configuration and get live updates
            • Webinar - XMPro 4.3 Release Showcase
            • What is a Digital Twin- Why Composable Digital Twins is the Future.
            • What Is Predictive Maintenance- (PdM)
            • What To Do When a Data Source Is Not Showing in Pass Page Parameter
            • XMPro - The World's Only AI - Powered Intelligent Digital Twin Suite
            • XMPro - The World's Only No Code Digital Twin Composition Platform
            • XMPro AI : How It Works
            • XMPro AI End To End Use Case
            • XMPro Auto Scale - Understanding Distributed Caching for Cloud-Native Applications
            • XMPro Promo Video - Dell Validated Design For Manufacturing Edge
          • 2022
            • Aggregate Transformation Agent Example - XMPRO Data Stream Designer
            • App Layout Best Practices for Desktop & Mobile - XMPro Lunch & Learn
            • Broadcast Transformation Agent Example - XMPRO Data Stream Designer
            • Calculated Field Transformation Agent Example - XMPRO Data Stream Designer
            • CRC16 Function Agent Example - XMPRO Data Stream Designer
            • Create a Common Operating Picture of Your Operations with XMPro
            • CSV Context Provider Agent Example - XMPro Data Stream Designer
            • CSV Simulator Agent Example - XMPRO Data Stream Designer
            • CSV Writer Agent Example - XMPRO Data Stream Designer
            • Data Conversion Transformation Agent Example - XMPro Data Stream Designer
            • Digital Twin Strategy To Execution Pyramid - XMPro Webinar
            • Event Printer Action Agent Example - XMPRO Data Stream Designer
            • File Listener Agent Example - XMPRO Data Stream Designer
            • Filter Transformation Agent Example - XMPRO Data Stream Designer
            • Group & Merge Transformation Agent Example - XMPRO Data Stream Designer
            • How To Bind Data To A Chart and Get It Working As Expected - XMPro Lunch & Learn
            • How To Send Data To My App (Including Caching Introduction) - XMPro Lunch & Learn
            • Join Transformation Agent Example - XMPRO Data Stream Designer
            • Min/Max Function Agent Example - XMPRO Data Stream Designer
            • PART 1- How To Manage Complex Operations in Real-time Using Composable Digital Twins
            • PART 3 - How To Manage Complex Operations in Real-time Using Composable Digital Twins
            • PART2 - How To Manage Complex Operations in Real-time Using Composable Digital Twins
            • Pass Through Agent Example - XMPRO Data Stream Designer
            • Pivot Table Transformation Agent Example - Count - XMPRO Data Stream Designer
            • Pivot Table Transformation Agent Example - Sum - XMPRO Data Stream Designer
            • Real-Time Is Real - How To Use Event Intelligence Tools to Manage Complex Operations in Real-time.
            • Row Count Agent Example - XMPRO Data Stream Designer
            • Sort Transformation Agent Example - XMPRO Data Stream Designer
            • Transpose Transformation Agent Example - Columns - XMPRO Data Stream Designer
            • Transpose Transformation Agent Example - Rows - XMPRO Data Stream Designer
            • Trim Name Transformation Agent Example - XMPRO Data Stream Designer
            • Twilio Action Agent Example - XMPRO Data Stream Designer
            • Union Transformation Agent Example - XMPRO Data Stream Designer
            • Variables & Expressions in App Designer - XMPro Lunch & Learn
            • Window Transformation Agent Example - XMPRO Data Stream Designer
            • XML File Reader Action Agent Example - XMPRO Data Stream Designer
          • 2021
            • The Value of a Composable Digital Twin - XMPro Webinar
          • 2020
            • 1. Understanding The Problem - UX Design - XMPRO
            • 1.1 Welcome - XMPRO UI Design Basics
            • 1.2 Introduction To UI Design - XMPRO UI Design Basics
            • 2. Creating User Stories - UX Design - XMPRO
            • 2.1 Responsive Design - XMPRO UI Design Basics
            • 2.2 Grids - XMPRO UI Design Basics
            • 2.3 Visual Hierarchy - XMPRO UI Design Basics
            • 2.4 Wireframes - XMPRO UI Design Basics
            • 3. Creating User Flow Diagrams - UX Design - XMPRO
            • 3.1 Color Palette - XMPRO UI Design Basics
            • 3.2 Typography - XMPRO UI Design Basics
            • 3.3 White Space - XMPRO UI Design Basics
            • 3.4 UI Elements - XMPRO UI Design Basics
            • 4. Plan Your App with Wireframes - UX Design - XMPRO
            • 4.1 Chart Types - XMPRO UI Design Basics
            • 4.2 Chart Styling - XMPRO UI Design Basics
            • 5. Designing for Dynamic Data - UX Design - XMPRO
            • Agents and Their Types - XMPRO Data Stream Designer
            • Data Wrangling: Row Transpose - XMPRO Data Stream Designer
            • Digital Twin: Your Most Productive Remote Worker - XMPRO Webinar
            • End-To-End Real-Time Condition Monitoring Demo - XMPRO Application Development Platform
            • Error Endpoints - XMPRO Data Stream Designer
            • Export and Import Recommendations - XMPRO App Designer
            • How To Add Buttons To Agents - XMPRO Data Stream Designer
            • How To Add EditLists to Agents - XMPRO Data Stream Designer
            • How To Change UI Language - XMPRO Subscription Manager
            • How To Configure a Stream Object - XMPRO Data Stream Designer
            • How To Configure The Aggregate Transformation - XMPRO Data Stream Designer
            • How To Configure The Anomaly Detection Agent - XMPRO Data Stream Designer
            • How To Configure The Azure SQL Action Agent - XMPRO Data Stream Designer
            • How To Configure The Azure SQL Context Provider - XMPRO Data Stream Designer
            • How To Configure The Azure SQL Listener - XMPRO Data Stream Designer
            • How To Configure The Calculated Field Transformation - XMPRO Data Stream Designer
            • How To Configure The CSV Context Provider - XMPRO Data Stream Designer
            • How To Configure The CSV Listener - XMPRO Data Stream Designer
            • How To Configure The Data Conversion Transformation - XMPRO Data Stream Designer
            • How To Configure The Edge Analysis Transformation - XMPRO Data Stream Designer
            • How To Configure The Email Action Agent - XMPRO Data Stream Designer
            • How To Configure The Email Listener - XMPRO Data Stream Designer
            • How To Configure The Event Printer Action Agent - XMPRO Data Stream Designer
            • How To Configure The Event Simulator Listener - XMPRO Data Stream Designer
            • How To Configure The FFT Function - XMPRO Data Stream Designer
            • How To Configure The File Listener - XMPRO Data Stream Designer
            • How To Configure The Filter Transformation - XMPRO Data Stream Designer
            • How To Configure The IBM Maximo Action Agent - XMPRO Data Stream Designer
            • How To Configure The IBM Maximo Context Provider - XMPRO Data Stream Designer
            • How To Configure The IBM Maximo Listener - XMPRO Data Stream Designer
            • How To Configure The Join Transformation - XMPRO Data Stream Designer
            • How To Configure The JSON File Reader Context Provider - XMPRO Data Stream Designer
            • How To Configure The MQTT Action Agent - XMPRO Data Stream Designer
            • How To Configure The MQTT Advanced Action Agent - XMPRO Data Stream Designer
            • How To Configure The MQTT Advanced Listener - XMPRO Data Stream Designer
            • How To Configure The MQTT Listener - XMPRO Data Stream Designer
            • How To Configure The Normalize Fields Function - XMPRO Data Stream Designer
            • How To Configure The OSIsoft PI Context Provider - XMPRO Data Stream Designer
            • How To Configure The OSIsoft PI Listener - XMPRO Data Stream Designer
            • How To Configure The Pass Through Transformation - XMPRO Data Stream Designer
            • How To Configure The PMML Agent - XMPRO Data Stream Designer
            • How To Configure The REST API Context Provider - XMPRO Data Stream Designer
            • How To Configure The RScript Agent - XMPRO Data Stream Designer
            • How To Configure The Run Recommendation Agent - XMPRO Data Stream Designer
            • How To Configure The Signal Filter - XMPRO Data Stream Designer
            • How To Configure The SQL Server Action Agent - XMPRO Data Stream Designer
            • How To Configure The SQL Server Context Provider - XMPRO Data Stream Designer
            • How To Configure The SQL Server Listener - XMPRO Data Stream Designer
            • How To Configure The SQL Server Writer Action Agent - XMPRO Data Stream Designer
            • How To Configure The Twilio Action Agent - XMPRO Data Stream Designer
            • How To Configure The Union Transformation - XMPRO Data Stream Designer
            • How To Configure The Unzip Function - XMPRO Data Stream Designer
            • How To Configure The Window Transformation - XMPRO Data Stream Designer
            • How To Create an App - XMPRO App Designer
            • How To Create and Manage Templates - XMPRO App Designer
            • How To Create and Publish a Use Case - XMPRO Data Stream Designer
            • How To Create and Use a Widget - XMPRO App Designer
            • How To Create App Data Connections - XMPRO App Designer
            • How To Create App Pages and Navigation - XMPRO App Designer
            • How To Create Recommendation Rules - XMPRO App Designer
            • How To Create Recurrent Data Streams - XMPRO Data Stream Designer
            • How To Do Integrity Checks - XMPRO Data Stream Designer
            • How To Edit Page Properties - XMPRO App Designer
            • How To Enable Audit Trails - XMPRO App Designer
            • How to Export, Import, and Clone a Data Stream - XMPRO Data Stream Designer
            • How To Export, Import and Clone an App - XMPRO App Designer
            • How to Export and Import an App - XMPRO App Designer
            • How To Find Help for an Agent - XMPRO Data Stream Designer
            • How To Install The XMPRO App Designer
            • How To Maintain and Capture Notes - XMPRO App Designer
            • How To Manage Agents - XMPRO Data Stream Designer
            • How To Manage and Use Server Variables - XMPRO Data Stream Designer
            • How To Manage Buffer Size - XMPRO Data Stream Designer
            • How to Manage Categories - XMPRO App Designer
            • How To Manage Categories - XMPRO Data Stream Designer
            • How To Pass Parameters Between Pages - XMPRO App Designer
            • How To Publish and Share an Application - XMPRO App Designer
            • How To Set Up and Use Charts in Live View - XMPRO Data Stream Designer
            • How To Set Up and Use Gauges in Live View - XMPRO Data Stream Designer
            • How To Share a Data Stream - XMPRO Data Stream Designer
            • How To Share a Use Case - XMPRO Data Stream Designer
            • How To Share an App For Design Collaboration - XMPRO App Designer
            • How To Troubleshoot a Use Case - XMPRO Data Stream Designer
            • How To Upgrade a Stream Object Version - XMPRO Data Stream Designer
            • How To Use App Files - XMPRO App Designer
            • How To Use Application Versions - XMPRO App Designer
            • How To Use Bar Gauge - XMPRO App Designer
            • How To Use Calendar - XMPRO App Designer
            • How To Use Chart Pan, Zoom and Aggregation - XMPRO App Designer
            • How To Use Chart Panes and Axes - XMPRO App Designer
            • How To Use Chart Print and Export- XMPRO App Designer
            • How To Use Charts - XMPRO App Designer Toolbox
            • How To Use Charts: Series - XMPRO App Designer
            • How To Use Collections - XMPRO Data Stream Designer
            • How To Use Content Card - XMPRO App Designer
            • How To Use D3 - XMPRO App Designer
            • How To Use Data Sources - XMPRO App Designer
            • How To Use Embedded Pages - XMPRO App Designer Toolbox
            • How To Use Fieldset and Field - XMPRO App Designer Toolbox
            • How To Use Flex Layout
            • How To Use Form Validation - XMPRO App Designer Toolbox
            • How To Use Input Mappings - XMPRO Data Stream Designer
            • How To Use Linear Gauges - XMPRO App Designer
            • How To Use Live View - XMPRO Data Stream Designer
            • How To Use Lookup - XMPRO App Designer
            • How To Use Maps - XMPRO App Designer
            • How To Use Page Layers - XMPRO App Designer
            • How To Use Pivot Grid - XMPRO App Designer
            • How To Use Polar Charts - XMPRO App Designer
            • How To Use Power BI - XMPRO App Designer
            • How To Use Radio Buttons - XMPRO App Designer Toolbox
            • How To Use Recommendations - XMPRO App Designer Toolbox
            • How To Use Select Box - XMPRO App Designer
            • How To Use Stacked Layouts - XMPRO App Designer Toolbox
            • How To Use Stream Host Local Variables - XMPRO Data Stream Designer
            • How To Use Tabs - XMPRO App Designer Toolbox
            • How To Use Tags - XMPRO App Designer Toolbox
            • How To Use Templated List - XMPRO App Designer
            • How To Use Templates - XMPRO App Designer
            • How To Use Text - XMPRO App Designer Toolbox
            • How To Use Text Area - XMPRO App Designer Toolbox
            • How To Use The Accordion - XMPRO App Designer Toolbox
            • How To Use The Block Styling Manager - XMPRO App Designer
            • How To Use The Box and Data Repeater Box - XMPRO App Designer Toolbox
            • How To Use The Button - XMPRO App Designer Toolbox
            • How To Use The Circular Gauge - XMPRO App Designer Toolbox
            • How To Use The Data Grid - XMPRO App Designer Toolbox
            • How To Use The HTML Editor - XMPRO App Designer Toolbox
            • How To Use The Hyperlink and Box Hyperlink - XMPro App Designer Toolbox
            • How To Use The Image - XMPRO App Designer Toolbox
            • How To Use The Indicator - XMPRO App Designer Toolbox
            • How To Use The Layout Grid - XMPRO App Designer Toolbox
            • How To Use The Number Selector - XMPRO App Designer Toolbox
            • How To Use The Pie Chart - XMPRO App Designer Toolbox
            • How To Use The Range Slider - XMPRO App Designer Toolbox
            • How To Use The Recommendation Chart - XMPRO App Designer Toolbox
            • How To Use The Scroll Box - XMPRO App Designer Toolbox
            • How To Use The Select Box - XMPRO App Designer Toolbox
            • How To Use The Sparkline - XMPRO App Designer Toolbox
            • How To Use The Textbox - XMPRO App Designer Toolbox
            • How To Use Tree Grid - XMPRO App Designer
            • How To Use Tree List - XMPRO App Designer
            • How To Use Unity - XMPRO App Designer Toolbox
            • How To Use Variables - XMPRO App Designer
            • How To Write and Maintain Notes and Business Case - XMPRO Data Stream Designer
            • Interactive 3D Models For Digital Twins - XMPRO Event Intelligence Platform
            • Manage Input Arrow Highlights - XMPRO Data Stream Designer
            • Manage Recommendation Access - XMPRO App Designer
            • Realize Value from End-To-End Condition Monitoring in 6 - 8 Weeks - XMPRO
            • Recommendation Versions - XMPRO App Designer
            • Solution Development Process For Event Intelligence Apps - XMPRO
            • Stream Hosts and How To Install Them - XMPRO Data Stream Designer
            • Use Case Versioning - XMPRO Data Stream Designer
            • XMPRO App Designer Overview - Event Intelligence Applications
            • XMPRO Data Stream Designer - Event Intelligence Applications
            • XMPRO Real-Time Event Intelligence Demo
            • XMPRO Recommendations - Event Intelligence Applications
          • 2019
            • Data Distribution Service: Using DDS in Your IoT Applications
            • My Digital Twin: Digital Twin Applications For Real-Time Operations (Like Me)
            • Setting up a Typical Industrial IoT Use Case with XMPro
            • XMPro Overview & Fin Fan Failure Demo
          • 2016
            • XMPro iBPMS Overview
          • 2013
            • XMPro Best Next Action - 3 Examples for XMPro blog
            • XMPro Case Management Example
            • XMPro Internet of Things Demo
          • 2012
            • Is Agile Business the New Normal
            • The Future of BPM Moving Towards Intelligent Business Operations
            • What industries does XMPro serve-
            • Who is XMPro for-
            • XMPro - The Social Listener - Why You Should Be Listening.wmv
            • XMPro Cool Vendor 2012
            • XMPro iBPMS For SharePoint
            • XMPro iBPMS v6 XMWeb for Intelligent Business Operations
            • XMPro News and Gartner BPM Sydney Summit Discount Offer.mp4
            • XMPro Version 6 - Introducing the Next Generation BPM for Intelligent Business Operations
    • Practice Notes
      • Unified Recommendation Alert Management
      • Performant Landing Pages in Real-Time Monitoring
  • Concepts
    • XMPro AI
      • XMPro Notebook
    • Data Stream
      • Stream Object Configuration
      • Verifying Stream Integrity
      • Running Data Streams
      • Timeline
    • Collection and Stream Host
    • Agent
      • Virtual vs Non-Virtual Agents
    • Application
      • Template
      • Page
      • Block
      • Canvas
      • Page Layers
      • Block Styling
      • Devices
      • Flex
      • Block Properties
      • Data Integration
      • Navigation and Parameters
      • Variables and Expressions
      • App Files
      • Metablocks
    • Recommendation
      • Rule
      • Execution Order
      • Auto Escalate
      • Form
      • Action Requests
      • Notification
      • Recommendation Alert
      • Deleted Items
      • Scoring
    • Connector
    • Landing Pages & Favorites
    • Version
    • Manage Access
    • Category
    • Variable
    • Insights
      • Data Delivery Insights
  • How-To Guides
    • Data Streams
      • Manage Data Streams
      • Manage Collections
      • Use Remote Receivers and Publishers
      • Manage Recurrent Data Streams
      • Use Business Case and Notes
      • Run an Integrity Check
      • Check Data Stream Logs
      • Use Live View
      • Use Stream Metrics
      • Troubleshoot a Data Stream
      • Upgrade a Stream Object Version
      • Setup Input Mappings
      • Use Error Endpoints
      • Use the Timeline
      • Context Menu
    • Application
      • Manage Apps
      • Manage Templates
      • Manage Pages
      • Import an App Page
      • Design Pages for Mobile
      • Navigate Between Pages
      • Pass Parameters Between Pages
      • Page Data
      • Manage Connections
      • Check Connector Logs
      • Manage Data Sources
      • Use Data Sources in the Page
      • Use Dynamic Properties
      • Use Expression Properties
      • Use Page Layers
      • Use Block Styling and Devices
      • Use Flex
      • Use Validation
      • Use Variables & Expressions
      • Create and Maintain Notes
      • Manage Widgets
      • Manage App Files
      • Manage Themes
    • Recommendations
      • Manage Categories
      • Manage Recommendations
      • Manage Rules
      • Manage Notifications
      • Manage Notification Templates
      • Subscribe to Notifications
      • Manage Forms
      • Manage Variables
      • Manage Alerts
      • Manage Alerts on Mobile
      • Manage Deleted Recommendation Items
    • Connectors
      • Manage Connectors
      • Building Connectors
      • Packaging Connectors
    • Stream Host
    • Agents
      • Manage Agents
      • Building Agents
      • Packaging Agents
      • Debugging an Agent
    • Manage Versions
    • Manage Access
    • Manage Categories
    • Manage Variables
    • Import, Export, and Clone
    • Publish
      • Admin Unpublish Override
    • Manage Site Settings
    • Manage Landing Pages & Favorites
  • Blocks
    • Common Properties
    • Layout
      • Accordion
      • Box & Data Repeater Box
      • Card & Content Card
      • Field & Fieldset
      • Layout Grid
      • Menu
      • Scroll Box
      • Stacked Layout Horizontal & Vertical
      • Tabs
      • Templated List
      • Toolbar
    • Basic
      • Calendar
      • Check Box
      • Color Selector
      • Data Grid
      • Date Selector
      • Dropdown Grid
      • Embedded Page
      • File Library
      • File Uploader
      • Html Editor
      • Image
      • Indicator
      • List
      • Lookup
      • Number Selector
      • Radio Buttons
      • Range Slider
      • Select Box
      • Switch
      • Tags
      • Text
      • Text Area
      • Textbox
      • Tree Grid
      • Tree List
    • Device Input
      • Location Capture
      • Visual Media Capture
    • AI
      • Azure Copilot
      • ChatGPT Copilot
    • Actions
      • Box Hyperlink
      • Button
      • Data Operations
      • Hyperlink
    • Recommendations
      • Alert Action
      • Alert Analytics
      • Alert Discussion
      • Alert Event Data
      • Alert Form
      • Alert List
      • Alert Timeline
      • Alert Triage
      • Alert Survey
      • Recommendation Chart
    • Visualizations
      • Autodesk Forge
      • Azure Digital Twin Hierarchy
      • Bar Gauge
      • Chart
      • Circular Gauge
      • D3 Visualization
      • Esri Map
      • Image Map
      • Linear Gauge
      • Live Feed
      • Map
      • Pie Chart
      • Pivot Grid
      • Polar Chart
      • Power BI
      • Sparkline
      • Time Series Analysis
      • Tree Map
      • Unity
      • Unity (Legacy)
    • Advanced
      • Metablock
    • Widgets
  • Administration
    • Administrative Accounts
    • Language
    • Companies
      • Register a Company
      • Manage a Company
      • Manage Company Subscriptions
      • Manage License
    • Subscriptions
      • Manage User Access
      • Setup Auto Approval/Default Subscriptions
      • Request and Apply a License
    • Users
      • Invite a User
      • Register an Account
      • Profile
      • Change Password
      • Reset Password
      • Delete a User
      • Change Business Role
  • Installation
    • Overview
    • 1. Preparation
    • 2. Install XMPro
      • Azure
      • AWS
      • On-Premise
    • 3. Complete Installation
      • Configure Auto Scale (Optional)
      • Configure Health Checks (Optional)
      • Configure Logging (Optional)
      • Configure SSO (Optional)
        • SSO - Azure AD
        • SSO - ADFS
      • Create Base Company
      • Install Stream Host
        • Windows x64
        • Azure Web Job
        • Ubuntu 20.04 x64
        • Docker
      • Install Agents & Connectors
  • Release Notes
    • v4.4.18
    • v4.4.17
    • v4.4.16
    • v4.4.15
    • v4.4.14
    • v4.4.13
    • v4.4.12
    • v4.4.11
    • v4.4.10
    • v4.4.9
    • v4.4.8
    • v4.4.7
    • v4.4.6
    • v4.4.5
    • v4.4.4
    • v4.4.3
    • v4.4.2
    • v4.4.1
    • v4.4.0
    • Archived
      • v4.3.12
      • v4.3.11
      • v4.3.10
      • v4.3.9
      • v4.3.8
      • v4.3.7
      • v4.3.6
      • v4.3.5
      • v4.3.4
      • v4.3.3
      • v4.3.2
      • v4.3.1
      • v4.3.0
        • v4.2.3
        • v4.2.2
        • v4.2.1
      • v4.2.0
      • v4.1.13
      • v4.1.0
      • v4.0.0
Powered by GitBook
On this page
  • Architecture
  • Prerequisites
  • Install
  • Subscription Manager
  • Component Choice
  • Database
  • Web Application
  • SMTP
  • Certificates
  • Final Steps
  • Accessing the Website
  • Obtaining an Installation Profile
  • Optional: IIS User Permissions
  • Data Stream Designer
  • Component Choice
  • Database
  • Encryption Upgrade
  • Web Application
  • Installation Profile
  • Final Steps
  • App Designer
  • Component Choice
  • Database
  • Encryption Upgrade
  • Web Application
  • Integration Details
  • SMTP
  • Twilio (Optional)
  • Installation Profile
  • Final Steps
  • Next Step: Complete Installation
  • Upgrade XMPro
  • Uninstall Subscription Manager Installer
  • Uninstall Data Stream Designer Installer
  • Uninstall Application Designer Installer

Was this helpful?

Export as PDF
  1. Installation
  2. 2. Install XMPro

On-Premise

Last updated 11 days ago

Was this helpful?

This document will guide you through how to deploy the XMPro Platform in an on-premise environment.

Architecture

The following deployment diagram shows an example on-premise architecture and the necessary resources for the XMPro platform in Microsoft Windows.

Prerequisites

In order to proceed with the deployment, you are required to:

  1. Complete the steps in the 1. Preparation guide:

  2. Enable Active Scripting and Allow Scriptlets (so App Designer and Data Stream installers can authenticate with Subscription Manager)

    1. Open Internet Explorer.

    2. Open Tools.

    3. Open Internet Options.

    4. Switch to the Security tab.

    5. Click the "Custom level..." button.

    6. Find and enable Active Scriptlets under ActiveX controls and plug-ins.

    7. Find and enable Active Scripting under Scripting.

  3. For Windows Server, disable these Internet Explorer settings (so App Designer and Data Stream installers can authenticate with Subscription Manager)

    1. Open Server Manager.

    2. Click on Local Server from the left menu.

    3. Find the IE Enhanced Security Configuration on the right side and click on the "On" value.

    4. On the pop-up, select "Off" for Administrators and apply the changes.

  4. Install IIS Service on a fresh Virtual Machine (VM)

    1. Open Server Manager.

    2. Click on Manage from the top right menu.

    3. Select Add Roles and Features, and click Next until you see Server Roles highlighted on the left.

    4. With Server Roles highlighted on the left, tick the Web Server (IIS) role...

    5. With Features highlighted on the left, tick everything under the .NET Framework features.

    6. Click Next twice.

    7. With Role Services highlighted on the left, tick everything except CGI under the Application Development section.

    8. Click Next and Install.

    9. Go to the Start button and Administrative Tools to confirm IIS Manager was installed.

Install

Subscription Manager

  1. Start the installation process by running the Subscription Manager.exe file, received from your Global Administrator.

  1. Click the "I Agree" button and press "Next"

  1. Follow the instructions and when the installation is finished click "Close"

This "Setup" will install the installer you will use to install the database and website

  1. When this initial installation is complete, open the start menu

  2. Search for "XMPro Subscription Manager" and click on Run as Administrator

Component Choice

  1. When the installer launches, choose “Install” and click "Next"

  1. Select the components that you would like to install and click "Next"

If this is the first time you are installing Subscription Manager, it is highly recommended that you select both “Database” and “Web Application”

Database

Server

  1. Select the server instance to which you would like to connect

If you already know the server instance name, it can be entered manually. Otherwise, use the refresh button on the right to load all available servers. Selecting the “Local Servers” check box will limit the search to the local network.

Authentication Method

  1. Specify the authentication method that should be used: Windows or SQL

9.1. Windows Authentication: you may leave the options as is

Warning: Configure a service account that can be used for Windows authentication.

9.2. SQL authentication:

  • Click the "Change" button

  • Select the “Use SQL Authentication” option

  • Enter the username and password of the SQL Server instance you’re connecting to

Warning: The SQL user must have permission to create databases on the server.

Database

The Database section allows you to configure if you would like to use an existing database or create a new one. Leaving the options as default will result in a new database being created.

To change the pre-populated name of the new database or to select to use an existing database:

  1. Click the "Change" button

  2. Make the changes needed by selecting the correct option

  3. Specify the name of the new database or select an existing database from the drop-down

Web Application

DNS Name

  1. Verify if your DNS name is correct, if not, edit the value to contain the correct DNS name

This is your fully qualified domain name (FQDN). Please find some examples below explaining the DNS name.

  • https://localhost/xmprosubscriptionmanager

  • https://desktop-f64k32e/xmprosubscriptionmanager

  • https://demo.azurewebsites.com

Complete Address
DNS
Virtual Directory

https://localhost/xmprosubscriptionmanager

localhost

xmprosubscriptionmanager

https://desktop-f64k32e/xmprosubscriptionmanager

desktop-f64k32e

xmprosubscriptionmanager

https://demo.azurewebsites.com

demo.azurewebsites.com

Virtual Directory

  1. Select the parent site from the Web Site drop-down

By default, the Virtual Directory name will be "xmprosubscriptionmanager" which will be created within IIS for the Subscription Manager site. If you wish to change the name you can specify it in the "Virtual Directory Name" text box.

  1. Verify if the value in the content directory field is correct. If not, apply any changes needed

By default, the option to create a sub-directory within the content directory is checked and you can specify a name in the “Sub-Directory” text box.

Application Pool

  1. If you wish to change this name or use an existing application pool, click the Change button

By default, a new application pool will be created when installing the site. The new application pool will have the same name as the name specified in the “Application Pool Name” field.

  1. Either select the “Create a new Application Pool” or “Use an existing Application Pool” option

If you choose “Create a new Application Pool”, give it an appropriate name. If you choose “Use an existing Application Pool”, select an existing application pool from the drop-down.

Security Account

  1. Select a security account that can be used

The default option is “Local System”, which is a built-in security account. You can either change it by selecting a different built-in security account from the drop-down or by specifying your own security account.

SMTP

SMTP can be disabled by unchecking the "Enable Email Notification" checkbox if you don't want to receive email notifications. If at a later stage email notifications are needed, the installer can be run again to add SMTP functionality.

Warning: You are required to set up an SMTP account. Failing to do so will make registering new users very cumbersome.

Check your connection to the email server using the "Test SMTP settings" button.

Certificates

Signing Certificate

  1. Start by browsing to a suitable .pfx certificate file. Specify the password for the certificate

  2. Use the dropdown to select "Subject Name"

It is recommended that you choose “LocalMachine” as the Location for the signing certificate.

Encryption Certificate

  1. Start by browsing to a suitable .pfx certificate file. Specify the password for the certificate

  2. Use the dropdown to select "Subject Name"

It is recommended that you choose “LocalMachine” as the Location for the encryption certificate.

Warning: Both certificates must contain a private key.

Final Steps

  1. Continue through the wizard, confirm the installation and the components will be installed

Warning: Note the username and password on the last screen of the installer. This user has been created during installation as Subscription Manager itself needs at least one user in the system. Without it, you cannot add other users.

Change the password of the default user to a new, secure password after logging in for the first time.

Accessing the Website

Using Web Browser

  1. Access the website by putting the URL into your browser

The format of the URL will be as follows: “https://yourdnsname/virtualdirectoryname/”

Obtaining an Installation Profile

To install the Data Stream Designer and App Designer, you will need an Installation Profile.

  1. Navigate to the XMPro Subscription Manager site as above

  2. Go to the Subscription Manager page

  1. Click Products in the menu and click the Installation Profile button

  1. Enter a File Key and press OK to download the file

Warning: Remember the file key as it is needed when installing Data Stream Designer and App Designer.

Optional: IIS User Permissions

If you’ve chosen to use a custom service account during installation, you may have to perform an extra step. An error may be shown after logging into Subscription Manager, even after giving the IIS_USRS group permission on the signing certificate private keys. The error would be as follow: “We could not grant you access to the requested subscription. There was an unexpected error“. The logs would also contain the following error: “System.Security.Cryptography.CryptographicException: Keyset does not exist“.

Data Stream Designer

  1. Start the installation process by running the Data Stream Designer.exe that you've received from your Global Administrator.

  1. Click the "I Agree" button and press "Next"​

  1. Follow the instructions and when the installation is finished click "Close"

  1. When this initial installation is complete, open the start menu

  2. Search for "Data Stream Designer" and click on Run as Administrator

Component Choice

  1. When the installer launches, choose “Install”

  1. Select the components that you would like to install

If this is the first time you are installing the Data Stream Designer, it is highly recommended that you select both “Database” and “Web Application”.

Database

Server

  1. Select the server instance you would like to connect to.

If you already know the server instance name, it can be entered manually. Otherwise, use the refresh button on the right to load all available servers. Selecting the “Local Servers” check box will limit the search to the local network.

Authentication Method

  1. Specify the authentication method that should be used: Windows or SQL

9.1. Windows Authentication: you may leave the options as is

Warning: Configure a service account that can be used for Windows authentication.

9.2. SQL Authentication:

  • To connect to the database using SQL Server authentication, click the "Change" button

  • Select the “Use SQL Authentication” option

  • Enter the username and password of the SQL Server instance you’re connecting to

Warning: The SQL user must have permission to create databases on the server.

Database

The Database section allows you to configure if you would like to use an existing database or create a new one. Leaving the options as default will result in a new database being created.

To change the pre-populated name of the new database or to select to use an existing database:

  1. Click the "Change" button and select the appropriate option

  2. Specify the name of the new database or select an existing database from the drop-down

Encryption Upgrade

If you are upgrading from 4.0 to 4.1 or greater, you will be shown the Encryption Upgrade Settings page. This will assist you in migrating existing Server Variables to the new method of encryption.

To upgrade existing Server Variables, the details of the Subscription Manager database are required, not the Data Stream Designer database (provided on the previous page).

Upgrade Server Variables?

  1. Tick to automatically upgrade the Server Variables. It is recommended, but not required. None of the other settings on this page are required if you choose not to upgrade.

Server

  1. Select the server instance you want to connect to

Authentication Method

  1. Specify the authentication method that should be used: Windows or SQL

Database

  1. Select the Subscription Manager database and click Next

Web Application

DNS Name

  1. Verify if your DNS name is correct. If not, edit the value to contain the correct DNS name

This is your fully qualified domain name (FQDN). Please find some examples below explaining the DNS name.

  • https://localhost/xmprosubscriptionmanager

  • https://desktop-f64k32e/xmprosubscriptionmanager

  • https://demo.azurewebsites.com

Complete Address
DNS
Virtual Directory

https://localhost/xmprosubscriptionmanager

localhost

xmprosubscriptionmanager

https://desktop-f64k32e/xmprosubscriptionmanager

desktop-f64k32e

xmprosubscriptionmanager

https://demo.azurewebsites.com

demo.azurewebsites.com

Virtual Directory

  1. Select the parent site from the Web Site drop-down

By default, the Virtual Directory name will be "DataStreams" which will be created within IIS for the Data Stream site. If you wish to change the name you can specify it in the "Virtual Directory Name" text box.

  1. Verify the value in the content directory field. If incorrect, apply any changes needed

By default, the option to create a sub-directory within the content directory is checked and you can specify a name in the “Sub-Directory” text box.

Application Pool

  1. If you wish to change the name or use an existing application pool, click the Change button

By default, a new application pool will be created when installing the site. The new application pool will have the same name as the name specified in the “Application Pool Name” field.

  1. Either select the “Create a new Application Pool” or “Use an existing Application Pool” option

If you choose “Create a new Application Pool”, give it an appropriate name. If you choose “Use an existing Application Pool”, select an existing application pool from the drop-down.

Security Account

  1. Select "Local System" as the security account.

The two options available to choose from are using a built-in security account or specifying your own security account.

Installation Profile

  1. Click the Browse button to upload an installation profile for Subscription Manager

  2. Select a file and click "Next"

  1. After you press "Next", authenticate yourself using Subscription Manager credentials

Final Steps

  1. Continue through the wizard, confirm the installation and the components will be installed

App Designer

  1. Start the installation process by running the App Designer.exe file that you've received from your Global Administrator.

  1. Click the "I Agree" button and press "Next"

  1. Follow the instructions and click "Close" when the installation is finished

This "Setup" will install the installer you will use to install the database and website

  1. When this initial installation is complete, open the start menu

  2. Search for "App Designer" and click on Run as Administrator

Component Choice

  1. When the installer launches, choose “Install” and click "Next"

  1. Select the components that you would like to install and click "Next"

If this is the first time you are installing Subscription Manager, it is highly recommended that you select both “Database” and “Web Application”.

Database

Server

  1. Select the server instance you would like to connect to

If you already know the server instance name, it can be entered manually. Otherwise, use the refresh button on the right to load all available servers. Selecting the “Local Servers” check box will limit the search to the local network.

Authentication Method

  1. Specify the authentication method that should be used: Windows or SQL

9.1. Windows Authentication: you may leave the options as is

Warning: Configure a service account that can be used for Windows authentication

9.2. SQL Authentication:

  • Click the "Change" button

  • Select the “Use SQL Authentication” option

  • Enter the username and password of the SQL Server instance you’re connecting to

Warning: The SQL user must have permission to create databases on the server.

Database

The Database section allows you to configure if you would like to use an existing database or create a new one. Leaving the options as default will result in a new database being created.

To change the pre-populated name of the new database or to select to use an existing database:

  1. Click the "Change" button and select the appropriate option

  2. Specify the name of the new database or select an existing database from the drop-down

Encryption Upgrade

If you are upgrading from 4.0 to 4.1 or greater, you will be shown the Encryption Upgrade Settings page. This will assist you in migrating existing Server Variables and Connector settings to the new method of encryption.

To upgrade existing Server Variables, the details of the Subscription Manager database is required, not the Data Stream Designer database (provided on the previous page).

App Designer Encryption Key

  1. Enter the App Designer Encryption Key

To find the App Designer Encryption Key, inspect the appsettings.json file in the web server files. It will be found under the JSON path "xmpro.appDesigner.encryptionKey".

If that path does not exist, it is stored in a cloud-service key vault. Search for the "xmpro.keyVault" JSON object for the details required to find the encryption key.

Upgrade Server Variables?

  1. Tick to automatically upgrade the Server Variables. It is recommended, but not required. None of the other settings on this page are required if you choose not to upgrade.

Server

  1. Select the server instance you want to connect to

Authentication Method

  1. Specify the authentication method that should be used: Windows or SQL

Database

  1. Select the Subscription Manager database and click Next

Web Application

DNS Name

  1. Verify if your DNS name is correct, if not, edit the value to contain the correct DNS name

This is your fully qualified domain name (FQDN). Please find some examples below explaining the DNS name.

  • https://localhost/xmprosubscriptionmanager

  • https://desktop-f64k32e/xmprosubscriptionmanager

  • https://demo.azurewebsites.com

https://localhost/xmprosubscriptionmanager

localhost

xmprosubscriptionmanager

https://desktop-f64k32e/xmprosubscriptionmanager

desktop-f64k32e

xmprosubscriptionmanager

https://demo.azurewebsites.com

demo.azurewebsites.com

Virtual Directory

  1. Select the parent site from the Web Site drop-down

By default, the Virtual Directory name will be "AppDesigner" which will be created within IIS for the Data Stream site. If you wish to change the name you can specify it in the "Virtual Directory Name" text box.

  1. Verify if the value in the content directory field is correct. If not, apply any changes needed

By default, the option to create a sub-directory within the content directory is checked and you can specify a name in the “Sub-Directory” text box.

Application Pool

  1. If you wish to change this name or use an existing application pool, click the Change button

By default, a new application pool will be created when installing the site. The new application pool will have the same name as the name specified in the “Application Pool Name” field.

  1. Either select the “Create a new Application Pool” or “Use an existing Application Pool” option

If you choose “Create a new Application Pool”, give it an appropriate name. If you choose “Use an existing Application Pool”, select an existing application pool from the drop-down.

Security Account

  1. Select "Local System" as the security account

You can either change it by selecting a different built-in security account from the drop-down or by specifying your own security account.

Integration Details

  1. Type in the URL of Data Stream designer in the text box

SMTP

SMTP can be disabled by unchecking the "Enable Email Notification" checkbox if you don't want to receive email notifications. If at a later stage email notifications are needed, the installer can be run again to add SMTP functionality.

Warning: You are required to set up an SMTP account. Failing to do so will make registering new users very cumbersome.

It is highly recommended to check your connection to the email server using the "Test SMTP settings" button.

Twilio (Optional)

Installation Profile

  1. Click the Browse button to upload an installation profile for Subscription Manager

  2. Select a file and click "Next"

The Installation Profile generated for Data Stream Installer can be used in this step.

  1. After you press "Next", authenticate yourself using Subscription Manager credentials

Final Steps

  1. Continue through the wizard, confirm the installation and the components will be installed

Next Step: Complete Installation

The installation of the XMPro Platform is now complete, but there are some environment setup steps before you can use the platform. Please click the below link for further instructions:

Upgrade XMPro

It is necessary to first uninstall the installers on the host server before proceeding with the upgrade installers. Once you have removed the installers, the procedure for the upgrade is the same as the original install.

This section aims to provide step-by-step instructions on how to safely uninstall only the XMPro installers and not the on-premises deployed XMPro solution.

The process of uninstalling the XMPro installer must be repeated for each application individually. The steps are the same for each application installer and the sequence is not significant.

Uninstall Subscription Manager Installer

  1. Log on to the instance where the XMPro installers are installed.

  2. From the start menu select XMPro Subscription Manager and right-click it.

  3. Click Uninstall.

  4. Select XMPro Subscription Manager from the list of programs displayed.

  5. Click Uninstall.

  6. When prompted to confirm uninstall click Yes.

  7. Click Next.

  1. When prompted to select the install to modify click Cancel. We do not want to remove the installed XMPro site, only the installer.

  1. Click on Yes to cancel the setup.

Uninstall Data Stream Designer Installer

  1. Log on to the instance where the XMPro installers are installed.

  2. From the start menu select XMPro Data Stream Designer and right-click it.

  3. Click Uninstall.

  4. Select XMPro Data Stream Designer from the list of programs displayed.

  5. Click Uninstall.

  6. When prompted to confirm uninstall click Yes.

  7. Click Next.

  1. When prompted to select the install to modify click Cancel. We do not want to remove the installed XMPro site, only the installer.

  1. Click on Yes to cancel the setup.

Uninstall Application Designer Installer

  1. Log on to the instance where the XMPro installers are installed.

  2. From the start menu select XMPro Application Designer and right-click it.

  3. Click Uninstall.

  4. Select XMPro Application Designer from the list of programs displayed.

  5. Click Uninstall.

  6. When prompted to confirm uninstall click Yes.

  7. Click Next.

  1. When prompted to select the install to modify click Cancel. We do not want to remove the installed XMPro site, only the installer.

  1. Click on Yes to cancel the setup.

Meet the

Install the

Follow the

Expand Web Server and Common HTTP Features, untick WebDAV Publishing, and click Next.

Please contact your XMPro account manager or to request the installers.

Warning: If you selected Windows authentication to connect to the database, you must choose “Specify your own Security Account” and provide the correct credentials. The service account must have batch logon rights enabled. More Information on how to set up a custom application pool in IIS as well as steps on how to enable batch logon rights can be found n this .

Enter the SMTP details referenced in the guide. By default, the "Enable Email Notification" is checked.

During the installation process, you will be asked to upload two certificates: a signing certificate and an encryption certificate. You may use the same certificate for both options. The instructions on how to create a certificate can be found in the guide.

To solve this issue, use this as a guideline to grant access for the Application Pool Identity (in some cases a domain account) on the signing certificate private keys.

Warning: If you selected Windows authentication to connect to the database, you must choose “Specify your own Security Account” and provide the correct credentials. The service account must have batch logon rights enabled. More Information on how to set up a custom application pool in IIS as well as steps on how to enable batch logon rights can be found n this .

This file ensures the Data Stream Designer contains the correct details for the Subscription Manager instance you would like to use. The file can be obtained through the .

Warning: If you are unable to sign in at this step, please follow this to disable Internet Explorer Enhanced Security Configuration.

Documentation for the and key vaults have been linked for convenience.

Warning: If you selected Windows authentication to connect to the database, you must choose “Specify your own Security Account” and provide the correct credentials. The service account must have batch logon rights enabled. More Information on how to set up a custom application pool in IIS as well as steps on how to enable batch logon rights can be found n this .

Enter the SMTP settings referenced in the guide. By default, the "Enable Email Notification" is checked.

Enter the Twilio details referenced in the guide. If you don't want SMS notifications you can select "None" from the "Select Provider" dropdown.

This file ensures the App Designer contains the correct details for the Subscription Manager instance you would like to use. The file used can be obtained through the .

Warning: If you are unable to sign in at this step, please follow this to disable Internet Explorer Enhanced Security Configuration.

You have now successfully uninstalled the XMPro installers. You can proceed to the instructions at the top of this page to perform an upgrade with the new installers: .

certificate and communication steps
XMPro support
i
link
1. Preparation
article
i
link
link
i
link
link
https://github.com/XMPro/public-docs/blob/main/docs/installation/3.-complete-installation
steps outlined previously in this tutorial
Amazon
Azure
steps outlined previously in this tutorial
Install On-Premise
Install
Upgrade
hardware requirements
software requirements
1. Preparation
1. Preparation
1. Preparation
Fig 1: Example XMPro architecture in Windows On-Premise