M3coretech 13.4.0 M3coreipg Windows En-Us

Download as pdf or txt
Download as pdf or txt
You are on page 1of 91

M3 Core Installation Planning

Guide - Windows

Release 13.4.0
Copyright © 2023 Infor

Important Notices
The material contained in this publication (including any supplementary information) constitutes and contains
confidential and proprietary information of Infor.
By gaining access to the attached, you acknowledge and agree that the material (including any modification,
translation or adaptation of the material) and all copyright, trade secrets and all other right, title and interest
therein, are the sole property of Infor and that you shall not gain right, title or interest in the material (including
any modification, translation or adaptation of the material) by virtue of your review thereof other than the
non-exclusive right to use the material solely in connection with and the furtherance of your license and use
of software made available to your company from Infor pursuant to a separate agreement, the terms of which
separate agreement shall govern your use of this material and all supplemental related materials ("Purpose").
In addition, by accessing the enclosed material, you acknowledge and agree that you are required to maintain
such material in strict confidence and that your use of such material is limited to the Purpose described above.
Although Infor has taken due care to ensure that the material included in this publication is accurate and
complete, Infor cannot warrant that the information contained in this publication is complete, does not
contain typographical or other errors, or will meet your specific requirements. As such, Infor does not assume
and hereby disclaims all liability, consequential or otherwise, for any loss or damage to any person or entity
which is caused by or relates to errors or omissions in this publication (including any supplementary
information), whether such errors or omissions result from negligence, accident or any other cause.
Without limitation, U.S. export control laws and other applicable export and import laws govern your use of
this material and you will neither export or re-export, directly or indirectly, this material nor any related
materials or supplemental information in violation of such laws, or use such materials for any purpose
prohibited by such laws.

Trademark Acknowledgements
The word and design marks set forth herein are trademarks and/or registered trademarks of Infor and/or
related affiliates and subsidiaries. All rights reserved. All other company, product, trade or service names
referenced may be registered trademarks or trademarks of their respective owners.
Publication Information
Release: Infor M3 Core Technology 13.4.0
Publication Date: November 27, 2023
Document code: m3coretech_13.4.0_m3coreipg_windows_en-us
Contents

Contents

About this guide..........................................................................................................................7


Contacting Infor.................................................................................................................................................7
Chapter 1: Introduction and overview...........................................................................................8
What is M3 Core?................................................................................................................................................8
M3 Core installation worksheet.........................................................................................................................9
Prerequisites.......................................................................................................................................................9
Installation Scenarios......................................................................................................................................10
Overview.......................................................................................................................................................10
Recommendations.......................................................................................................................................10
Chapter 2: Sizing........................................................................................................................13
Sizing overview.................................................................................................................................................13
Chapter 3: System requirements.................................................................................................15
Network............................................................................................................................................................15
Important Network Topology Considerations............................................................................................15
LifeCycle Manager Network Requirements.................................................................................................16
Installation Topology Considerations.........................................................................................................17
M3 Business Engine network and infrastructure requirements.................................................................19
Embedded 3rd party product..........................................................................................................................20
Chapter 4: Security considerations..............................................................................................21
SAML authentication overview........................................................................................................................21
SAML Entities................................................................................................................................................21
Installation....................................................................................................................................................22
Runtime........................................................................................................................................................22
Users in M3........................................................................................................................................................22
The Person claim..........................................................................................................................................23
User authentication management..................................................................................................................24

M3 Core Installation Planning Guide - Windows | 3


Contents

Grid authentication considerations............................................................................................................24


LifeCycle Manager LDAP considerations.....................................................................................................25
Role management............................................................................................................................................27
IFS Security Roles.........................................................................................................................................27
Chapter 5: Prepare installation on the servers..............................................................................28
Install M3 Home Server....................................................................................................................................28
Software requirements................................................................................................................................28
Install Windows and SQL Server..................................................................................................................32
Install JVM.....................................................................................................................................................32
Setting up the LDAP......................................................................................................................................33
Preparing the LCM Backup server...............................................................................................................33
Set up file share............................................................................................................................................33
Install OpenText StreamServe/Exstream....................................................................................................33
Install M3 Project Admin Client/Server...........................................................................................................33
Introduction..................................................................................................................................................33
Software requirements................................................................................................................................34
Install JVM.....................................................................................................................................................34
Installing and verifying Eclipse....................................................................................................................35
Pre-installation steps for M3 Adaptation Kit...............................................................................................35
Set JAVA_HOME for Infor Enterprise Collaborator tools............................................................................36
Install M3 Application and M3 Database Servers............................................................................................37
Software requirements Windows................................................................................................................37
M3 Application and M3 Database Server Setup..........................................................................................41
Install Platform Windows Server / SQL Server 2014...................................................................................41
Install Platform Windows Server / SQL Server 2016...................................................................................43
Install Platform Windows Server / SQL Server 2017...................................................................................46
Install Platform Windows Server / SQL Server 2019...................................................................................48
Install Platform Windows Server / SQL Server 2022...................................................................................50
Post SQL Server Installation........................................................................................................................53
Install JVM.....................................................................................................................................................53
Chapter 6: Handover to installation.............................................................................................55
Handover document........................................................................................................................................55
Chapter 7: M3 SW Components Overview.....................................................................................56
LifeCycle Manager............................................................................................................................................56

M3 Core Installation Planning Guide - Windows | 4


Contents

M3 Foundation.................................................................................................................................................56
Infor ION Grid....................................................................................................................................................57
Infor ION Grid Application Concepts...............................................................................................................58
Grid Database Connectivity (GDBC)................................................................................................................59
Event Hub and Event Analytics Introduction..................................................................................................59
Event Hub Background................................................................................................................................59
What is Event Hub?.......................................................................................................................................60
Highlights of Event Hub...............................................................................................................................60
What Is Event Analytics?...............................................................................................................................61
How to set up Event Hub and Event Analytics............................................................................................61
Events............................................................................................................................................................61
Publisher.......................................................................................................................................................62
Subscriber.....................................................................................................................................................62
Subscription.................................................................................................................................................62
Persistence...................................................................................................................................................63
Event Hub Schematic Overview...................................................................................................................63
Event Analytics Technical Overview............................................................................................................64
High Availability for Event Hub........................................................................................................................64
High Availability for Event Hub Overview...................................................................................................64
High Availability and Clients........................................................................................................................65
M3 Web Services...............................................................................................................................................65
M3 UI Adapter...................................................................................................................................................66
M3 H5................................................................................................................................................................66
M3 Ad Hoc Reporting........................................................................................................................................66
M3 Financial Business Messages.....................................................................................................................66
M3 Business Engine User Documentation......................................................................................................67
Infor Enterprise Collaborator (IEC) overview..................................................................................................67
EC Server.......................................................................................................................................................67
Partner Administration tool.........................................................................................................................67
Business Document Mapper tool.................................................................................................................67
Flat File Definition tool.................................................................................................................................68
EC Application components........................................................................................................................68
BOD Processor..................................................................................................................................................69
M3 Workflow Executor.....................................................................................................................................69
M3 Adaptation Kit overview.............................................................................................................................69

M3 Core Installation Planning Guide - Windows | 5


Contents

M3 Metadata Publisher overview....................................................................................................................70


OpenText StreamServe/Exstream...................................................................................................................70
Chapter 8: Infor Enterprise Collaborator configuration, consideration, and dependencies...............71
Hardware requirements...................................................................................................................................71
Initial settings...................................................................................................................................................72
DocArchiver.Level.........................................................................................................................................72
Throughput factors to consider.......................................................................................................................72
Threads.........................................................................................................................................................72
Heap size.......................................................................................................................................................73
Queues..........................................................................................................................................................74
APIPool..........................................................................................................................................................74
DB pool..........................................................................................................................................................75
Folder structure............................................................................................................................................75
Node deployment............................................................................................................................................76
Verifying behavior............................................................................................................................................77
Check queues...............................................................................................................................................77
Check thread pool........................................................................................................................................77
Check message log.......................................................................................................................................78
Example configurations...................................................................................................................................78
Small configuration......................................................................................................................................78
Medium configuration..................................................................................................................................79
Large configuration......................................................................................................................................80
Appendix A: LifeCycle Manager installation worksheets................................................................82
LDAP installation values..................................................................................................................................82
Appendix B: LifeCycle Manager LDAP settings..............................................................................85
LDAP properties................................................................................................................................................85
Multiple LDAP domain controllers..................................................................................................................87
Appendix C: M3 Foundation resilience on multiple hosts...............................................................88
Configuring M3 Foundation for resilience on multiple hosts.........................................................................88
Creating an Additional M3Coordinator Binding.........................................................................................88
Creating an Additional Default Router Node..............................................................................................89
Creating an Additional M3 Router Node......................................................................................................90
Creating Additional M3 Connection Dispatchers........................................................................................90
Configuring the Remote Class File Loader to Run on Either Host..............................................................90

M3 Core Installation Planning Guide - Windows | 6


About this guide

About this guide

This guide provides information for the planning and preparation of M3 Core and its components.

Prerequisite knowledge
To fully understand the information presented in this guide, you should first have:
• Experience installing and administering operating systems.
• Experience installing and administering databases.
• Experience working with user authentication management.
• Experience installing and administering networks.
• Experience installing and configuring applications

Contacting Infor
If you have questions about Infor products, go to Infor Concierge at https://
mingle-portal.us2.prd3.inforcloudsuite.com/v2/CONCIERGE_PRD and create a support incident.
For the latest documentation, go to Documentation Central at docs.infor.com. We recommend that you check
this website periodically for updated documentation. If you have comments about Infor documentation,
contact documentation@infor.com.

M3 Core Installation Planning Guide - Windows | 7


Introduction and overview

Chapter 1: Introduction and overview

What is M3 Core?
For companies in the business to Make, Move and Maintain products, Infor M3 provides the tools they require
to manage their operations. With the full system, they can monitor transactions throughout their organization,
including manufacturing operations, supply chain activities, customer and supplier relationships, warehouse
and distribution processes and, financial management. Infor M3 consolidates these into one coherent view
of operations.
Although the complete M3 Solution is made up of several different Software Components, where some are
unique for a certain industry or micro vertical, there are several of components that will be common for all
M3 installations no matter for what industry. These components are gathered under the Product Family
named M3 Core.
This guide covers the necessary steps to plan and prepare for the installation of these components, M3 Core.

M3 Core
M3 Business Engine
M3 Financial Business Messages
M3 Core Infrastructure and Technology
LifeCycle Manager
ION Grid
Session Providers
M3 Core Technology
Grid Database Connectivity (GDBC)
Event Hub
Event Analytics
M3 UI Adapter
H5 Enterprise
M3 Foundation
Web Services Runtime
Infor Enterprise Collaborator (IEC)

M3 Core Installation Planning Guide - Windows | 8


Introduction and overview

BOD Processor
Workflow Executor
M3 Adaptation Kit
M3 Metadata Publisher

The Planning guide is the first in a set of three guides:


M3 Core Installation Guides
1 Planning in the guide "M3 Core Installation Planning Guide"
2 Software installation in the guide "M3 Core Installation Guide"
3 Post-installation, upgrade, and administration in the guide "M3 Core Administration Guide"
These guides cover all necessary aspects and steps to establish the installation of the components above and
can be found on docs.infor.com.
The first guide lay the foundation for the installation of the additional software components since they are
all connected to the M3 Core parts in one way or another. It is of utmost importance that the first steps are
finished carefully with attention to details because a small deviation here might cause ripple effects later on.

M3 Core installation worksheet


The M3 Core set of guides describes the planning, installation, and post-installation steps to install M3 Core.
Delivered with these guides is an Excel worksheet that serves as a handover document between the different
steps and as an exit document for the complete installation exercise.
The worksheet contains a brief introduction. There are also examples in addition to the work sheet. You can
get this worksheet from the Infor Download Center.
The M3 Core guides contain only the M3 Core parts of the complete M3 installation. We also recommend to
get the information for the rest of the servers that make up the full install so it is available in the same format.

Prerequisites
M3 Core require certain hardware and software components to run correctly. Ensure to verify the requirements
for the platform to be used.
• If you already have an existing M3 environment installed, ensure to back it up.
• The system must have TCP/IP configured, and be reachable from the network.

M3 Core Installation Planning Guide - Windows | 9


Introduction and overview

Installation Scenarios

Overview
The M3 Core is available on different platforms:
• IBM i with DB2/400 database
• IBM p (AIX) with ORACLE database
• Microsoft Windows Server with SQL Server database

Recommendations
Take note that before we can specify detailed hardware and software set-up for a specific customer installation,
a detailed sizing exercise must be carried out. This may enable us to consolidate installations onto shared
servers, but for this we must understand the transaction volumes intended for each application.
For specific information about versions to use, refer to the software requirements for each server in chapter
Prepare installation on the servers on page 28.
See more details in the M3 SW Components Overview chapter.
The M3 Home Server
• Windows as operating system and SQL Server as database

M3 Core Installation Planning Guide - Windows | 10


Introduction and overview

• Java
• LifeCycle Manager — Server: the central installation and management tool
• LifeCycle Manager — Service
• LifeCycle Manager — Backup
• Infor ION Grid — Host
• Session Providers
• GDBC
• Web Services Runtime
• M3 MetaData Publisher
• Infor Enterprise Collaborator — Server and Database
• M3 UI Adapter — Database
• Financial Business Messages
• M3 BE User Documentation: M3 BE application documentation
• OpenText StreamServe/Exstream: Third party application used for output in multiple formats.
• hardcopy
• PDF format
• fax
• mail
• XML output

The M3 Project Admin Client/Server


• Windows as operating system
• Java
• M3 Adaptation Kit: the development and debug environment
• LifeCycle Manager — Client
• Infor Enterprise Collaborator — Tools
• Eclipse: Third party development environment required for M3 Adaptation Kit.

The M3 Application Server


• Windows, AIX, or IBM i as operating system
The IBM i is a single-tier application server containing a tightly integrated database layer. Therefore, we
recommend that the Database Server and Application Server are consolidated on this platform.
• Java
• LifeCycle Manager — Service
• Infor ION Grid — Host
• M3 Business Engine — Application
• M3 Foundation: the M3 Business Engine runtime environment

M3 Core Installation Planning Guide - Windows | 11


Introduction and overview

• M3 UI Adapter — Application
• Event Hub
• Event Analytics

The M3 Database Server


• Windows, AIX, or IBM i as operating system
If the M3 Database Server is installed on Windows, the SQL Server database must be used.
If the M3 Database Server is installed on AIX, the Oracle database must be used.
If the M3 Database Server is installed on IBM i, the IBM DB2/UDB for IBM i database must be used.
The IBM i is a single-tier application server containing a tightly integrated database layer. Therefore, we
recommend that the Database Server and Application Server are consolidated on this platform.
• Java
• LifeCycle Manager — Service
• M3 Business Engine — Database
• Infor ION Grid — Database and Host
• GDBC

M3 Core Installation Planning Guide - Windows | 12


Sizing

Chapter 2: Sizing

Use the configuration values as input to the M3 Core installation worksheet to capture all the servers and
their suggested sizing information in the worksheet.

Sizing overview
Infor provides:
• Minimum (high level) recommendations for a specific case
• Topology examples in the form of Budgetaries
• Scalability information in the form of Data sheets
• Advice and experience , primary through ICS SEs and Solution Design

Local Hardware partners provide:


• Typically has the dialogue with the end customer
• Detailed configuration and pricing
• Additional services, such as HA, DR, SAN, Terminal servers etc.

For the sizing of the central piece of M3, M3 Business Engine information is provided on two levels:
As Budgetary:
• Based on number of licenses applying assumptions
• Tool available to all Infor employees
• General assumptions
• User activity
• 80% of authorized users logged on
• 80% of logged on users active
• 10% of active users - highly active
• 65% of active users – medium activity
• 25% of active users – low activity
• 300 working days per year

M3 Core Installation Planning Guide - Windows | 13


Sizing

• 12 hours of production per day


• Transaction number estimation, where a transaction is a theoretical metric consisting of a mix of
real life transactions
• Highly active users produce 20 transactions per hour.
• Medium active: 4 transactions/h
• Low: 1 transaction/h
• Peak load estimation
• Peak duration: 60 minutes
• Peak load: 30% of daily load within peak duration

As Detailed information:
• Used for either verifying a budgetary sizing or to be used in large and/or complex customer cases
• Based on questionnaire document, manual analysis and backend tool. Manual reply in mail format

M3 Core Installation Planning Guide - Windows | 14


System requirements

Chapter 3: System requirements

Network
The Infor user interfaces require for standard usage an average of 10kbit per concurrent user. It is recommend
to set maximum network latency between 100 and 300ms.
10kbit is an average. Some users require more bandwidth than others and there is more network traffic such
as email, internet access, printing, and others.
To provide some margin, we adopt these guidelines that is in accordance with the activity levels mentioned
in the M3 Sizing Questionnaire:
• Highly active users: 20kbit/concurrent user
• Medium active users: 15kbit/concurrent user
• Low active users: 10kbit/concurrent user

For good performance we highly recommend at least a 100 Mbps LAN network.
To ensure a smooth execution in the server, put more focus on the latency. Basic recommendation is to keep
all the servers within the same subnet, or the same router. Also, lookup from network services, that is DNS,
will have an effect if it is too slow.

Important Network Topology Considerations


The Infor ION Grid is a highly distributed application server where application nodes can run on many different
hosts. Every node is able and will initiate communication to all Host Routers within the same grid to register
itself on startup, communicate during runtime, and de-register itself on shutdown.
Due to this design, low network latency and high bandwidth are essential for correct grid operation, and so
these guidelines must be adhered to avoid problems:
• All hosts should be connected with a fast network (Gigabit or faster is recommended).
• The network has to be reliable. Dropped network connections result in unpredictable behavior of
applications installed in the grid.
• All hosts included within a grid must be located on the same network segment and ideally connected to
the same switch. The grid was not designed to work across network segments. Any topology which bridges
network segments will not be supported and will likely result in poor application performance.

M3 Core Installation Planning Guide - Windows | 15


System requirements

For example, the configurations are unlikely to meet the requirements stated above and are therefore
not supported: Mixing hosts which are located in different data-centers or on different sites Mixing hosts
in the DMZ and on the intranet
• All hosts must communicate freely with each other without hindrance from firewall configurations.
• If a firewall is in place, rules must be defined to ensure that TCP/IP traffic can flow freely between all
hosts in the Grid for all fixed ports. We recommend that a firewall be used to ring-fence the hosts rather
than between hosts to minimize the chance of misconfiguration and resulting issues.
• Anti-virus software can interfere with communication between processes. If such software is installed
and running on the servers then care must be taken to ensure that exceptions are created for the Java
executable used to run the Grid.
• In the case of the Windows platform, care must be taken to ensure the firewall service (Windows service
named "Windows Firewall") is started. This service should not be disabled or stopped as this causes
inconsistent behavior where traffic is randomly filtered.

LifeCycle Manager Network Requirements


If you plan to install LifeCycle Manager Server using server's (M3 Home Server) hostname instead of IP address,
ensure that name resolution is working on your network. The server hosting LifeCycle Manager Server service
must be accessible from the LifeCycle Manager Client (M3 Project Admin Client/Server) using LifeCycle Manager
Server hostname or FQDN.
Note: Avoid using the underscore (_) character in hostnames. Refer to

http://www.ibm.com/support/knowledgecenter/SSAW57_8.5.5/com.ibm.websphere.nd.doc/ae/rins_host
name.html

All active network cards installed on a server and connected to the LifeCycle Manager Server or LifeCycle
Manager Services must be configured to use:
• A Fully Qualified Domain Name (FQDN)
• A static IP address
Special consideration has to be taken if the server is configured with multiple network cards or addresses.
LifeCycle Manager database (on the M3 Home Server) binds by default to the network card listed as
primary. If a LifeCycle Manager Client connects to the LifeCycle Manager Server using the secondary
network adapter, the LifeCycle Manager Server service cannot bind to the LifeCycle Manager database.
You should connect to the LifeCycle Manager Server using the primary network card.
-or-
• A reserved IP address if the network card is configured to use Dynamic Host Configuration Protocol
(DHCP).
Note: Do not forget to configure reverse DNS lookup for all enabled network cards installed in your server.
Network cards that are not attached to the network must be disabled.

M3 Core Installation Planning Guide - Windows | 16


System requirements

Installation Topology Considerations


An Infor ION Grid installation can contain one or more hosts. The LifeCycle Manager Server should connect
to the grid agent on each host that is part of the grid. The Administrative Router, which is the connection
point for the Grid Management Pages, must be accessible from both the LifeCycle Manager Server and from
all locations where the LifeCycle Manager Client is used.
The different topology examples below show the network and communication from different perspectives.

Network Topology - Client Perspective

1 If the client uses normal grid communication, it connects to one of the routers. Only one router is required,
but there may be several.
2 If a client uses Java Web Start as a way to install, access to this port is required.
3 Clients that use one or more connection dispatchers require access to those ports.
4 Connection dispatchers belong to applications deployed in the grid. Most applications have no connection
dispatchers but they may have several. Therefore, the number of exposed connection dispatchers may
be none or several.

M3 Core Installation Planning Guide - Windows | 17


System requirements

Network Topology - LCM perspective

The LifeCycle Manager client will access the management and configuration pages directly through the Admin
Router, simultaneously all other communication is made through the LifeCycle Manager server.

Network Topology - Registry Client

This is a special case of connecting a client to the registry instead of a router.


A client connecting to the registry will be connected to all nodes and routers directly. The nodes have
dynamically assigned port numbers.
Note that clients connecting the normal way (to a router) will not get connected to all nodes in this fashion.

M3 Core Installation Planning Guide - Windows | 18


System requirements

Network Topology - Grid Internal Communication

The registry, routers and all nodes are connected to each other through the dynamically assigned ports.
The registry, routers and all nodes may serve the Grid Management Pages.
The Management Pages communicate with each grid agent.
The Administrative Router hosts the Configuration Manager that communicates with each grid agent.

M3 Business Engine network and infrastructure requirements


Network
• Limit the network protocols supported (TCP/IP). Do not enable other network protocols unless they are
required.
• Do not expose a server that is running the M3 BE database to the public internet.
• Configure M3 BE instances of SQL Server to use specific port assignments for TCP/IP. Consider to use
non-default numbers for the TCP/IP ports.
• Use dedicated network interfaces to separate network traffic between M3 BE application server and the
M3 BE database server. Ensure that you use the fastest possible connection between M3 BE application
server and database server.

Antivirus Considerations
• Misconfigured antivirus program can cause expensive problems in production, for example, blocking
access to critical I/O access and heavy I/O and CPU load, and provide a sense of false security.

M3 Core Installation Planning Guide - Windows | 19


System requirements

• If antivirus software is installed, remember that virus protection software requires some system resources
to run. You must perform testing before and after you install your antivirus software to determine if there
is an effect on the performance of the computer running SQL Server.

CPU
In addition to the high performing storage requirements, M3 BE database workloads also require correct
processing power. The common reason for CPU bottlenecks is insufficient hardware resources.

RAM
One of the most important factors that influence SQL Server performance is memory and SQL Server requires
a lot of memory. If SQL Server will run short on memory, query response time, CPU usage and disk I/O can
increase significantly as Windows begins paging more and more RAM to the hard drive. A good way to keep
database server performance is to ensure that the database is using as much RAM as possible to avoid to rely
as heavily upon disk which is exponentially slower than RAM. The total amount of memory required is directly
related to the size of the M3 BE database that is hosted on the server.

Embedded 3rd party product


Software component Version Vendor Notes
Microsoft JDBC driver 12.4 Microsoft Use these applicable jars:
for SQL Server mssql-jdbc-12.4.0.jre11.jar
mssql-jdbc-12.4.0.jre8.jar

M3 Core Installation Planning Guide - Windows | 20


Security considerations

Chapter 4: Security considerations

This chapter provides M3-specific security considerations. For detailed information about security-related
concepts and procedures for the Infor ION Grid see Infor ION Grid Security Administration Guide.

SAML authentication overview


M3 Core uses SAML session provider for authentication of users. SAML – Security Assertion Markup Language
– is a protocol for communicating user authentication and attribute information.

SAML Entities

The SAML protocol defines many roles. In the Grid, these are the roles we refer to:
• Service Provider (SP) – This is the role of the SAML Session Provider/Grid. Grid applications provide
services that require authentication, and the SAML Session Provider initiates the authentication using
the SAML protocol. In AD FS, the Service Provider is called a Relying Party Trust (RPT).
• Identity Provider (IdP) – This is the role of the entity that is responsible for handling authentication against
the user repository. In on-premise environments, AD FS (Active Directory Federation Services, a Microsoft
product) has the role of the Identity Provider.

M3 Core Installation Planning Guide - Windows | 21


Security considerations

• Claims Provider – This is the role of IFS (Infor Federation Services), which is part of Infor Operating Service
(Infor OS). After a successful authentication, the IdP retrieves additional attributes for the user from IFS,
in particular Security Roles, which are maintained in IFS. In the SAML standard, the attributes are called
claims. Claims may also come from other stores, for example attributes from the AD. All the claims for a
user are included in the authentication response, returned from the IdP to the SAML Session Provider
when the user has been authenticated.

Installation
For communication between the different systems (SAML Session Provider/IFS/IdP) to work according to the
SAML protocol, they should be aware of and trust each other’s certificates. This set-up is partially automated
during the initial configuration of the SAML Session Provider.
When the SAML Session Provider is started for the first time, it calls IFS to publish an SP configuration in IFS.
The configuration must be finished manually from the Infor OS Manager to publish the configuration to AD
FS. This is described in the configuration procedure for the SAML Session Provider.

Runtime
At runtime, the SAML Session Provider interacts with AD FS and IFS in several ways:
• SAML authentication. Browser clients are redirected to AD FS for authentication. After a successful
authentication, the response is returned to the SAML Session Provider from AD FS, including any additional
claims that have been supplied by IFS. For this authentication to work, the Grid access must pass through
a SAML-enabled router.
• WS-Trust authentication. Clients that cannot be redirected can pass credentials through basic
authentication headers. In this case, the SAML Session Provider actively communicates with AD FS using
the WS-Trust protocol. Claims are included in the response, in the same way as for SAML authentication.
For this authentication to work, the Grid access must pass through a router that provides the basic
authentication mechanism. WS-Trust authentication is not available in cloud scenarios - only passive
clients are supported.
• IFS API calls. IFS provides several APIs for retrieving Security Roles and other user information. When the
Grid role mapping UI is accessed, IFS is accessed directly to retrieve the available Security Roles. Grid
applications may also call these APIs through proxy methods in the SAML Session Provider.

Users in M3
M3 has the special requirement that user names must be at most 10 characters long. Special consideration
must be taken when configuring authentication parameters, so that the user names meet this requirement.
For M3, the IFS Person ID property is used to configure user names.

M3 Core Installation Planning Guide - Windows | 22


Security considerations

The Person claim


When SAML is used for authentication, the response from the IdP contains several claims (user properties).
In an M3 environment, the SAML Session Provider is configured to use the Person claim as the user name for
grid users.
The diagram shows an M3 environment with a Grid, AD FS, AD, and IFS. The environment has been configured
according to the recommendations for authentication. Specifically, the SAML Session Provider has been
configured to use the Person claim as the user name, IFS has been configured with values for the IFS Person
ID property for all users, and AD FS has been configured to emit the Person claim at log on.

1 The user accesses a protected grid resource in the H5 application.


2 The grid passes the call internally to the SAML Session Provider. The SAML Session Provider redirects the
browser to AD FS.
3 AD FS prompts the user for authentication and the user provides her credentials. The user logs on as
jane.doe@example.com.
4 AD FS authenticates the user against the Active Directory.
5 After a successful authentication, AD FS retrieves claims for the user from IFS. The Person claim is among
these. Jane Doe’s Person claim has the value 12345.
6 AD FS constructs an assertion – a message about the authentication and the user and provides this to
the browser.
7 The browser posts the assertion to the SAML Session Provider.

M3 Core Installation Planning Guide - Windows | 23


Security considerations

8 The assertion is validated by the SAML Session Provider. A grid session and a grid user are created, with
the user name based on the Person claim. In this case, the name will be 12345.
9 The user has sufficient privileges to access the protected resource, and is redirected to the first access
point.
10 During use, the H5 application accesses M3 BE on behalf of the user. The grid user name is 12345. This
name conforms to the 10 character limitation. The User 12345 has also been configured in M3 BE
'User.Open' (MNS150). Therefore, the user can access M3 BE.

User authentication management

Grid authentication considerations


The Grid uses a pluggable architecture to authenticate users. All authentication is handled by a special Grid
application called a session provider. SAML Session Provider is the only session provider that enables single
sign on with Security Roles from Infor Federation Services, which is a prerequisite for running M3 in Infor
Ming.le® with SSO.
• For new installations, install SAML Session Provider 1.14.
• Existing installations running either Windows Session Provider or LDAP Session provider must replace
the existing session provider with SAML Session Provider to enable SSO with Infor Ming.le.

SAML Session Provider


The SAML Session Provider authenticates users using SAML to communicate with the IdP. User credentials
are stored in AD but extended attributes (for example Security Roles) are also stored in Infor Federation
Services (IFS) and emitted as claims during log on.
The session provider supports these authentication methods:
• SAML2
• basic authentication (restricted to single IdP scenarios)

The SAML Session Provider implements the SAML protocol to authenticate users to the IdP (for browser clients
that can be automatically redirected). The basic authentication method uses WS-Trust (for active, non-browser
based clients).
For more detailed information about the Session Providers refer to Infor ION Grid Security Administration
Guide.
Your system must meet these requirements:
• AD FS is used as the Identity Provider (IdP). Federated set-ups with multiple AD FS servers are only
supported for browser-based clients.
• Infor OS is installed.

M3 Core Installation Planning Guide - Windows | 24


Security considerations

• ION Grid version 11.1.13.0.90 or later is installed.


• You have a domain account with the Infor Ming.le Security Roles IFSApplicationAdmin and AttributeSer
viceCaller. The password for this account should not expire, since it will be used for web service calls
to IFS during runtime.
• In AD FS, the Endpoint "/adfs/services/trust/13/usernamemixed" for WS-Trust 1.3 is both Enabled and
Proxy Enabled.
• The IFS security mode is set to "SAMLToken" or "SAMLToken Allowing Windows for Web Services".
• If the AD FS and IFS do not use the same ports, the SAML session provider must be set up using the Custom
AD FS profile.

LifeCycle Manager LDAP considerations


LifeCycle Manager (LCM) authenticates against user data stored in a Lightweight Directory Access Protocol
(LDAP) server. Only users who belong to the users or administrators group in the LDAP server will have access
to use the LCM Client tool. When you install LCM, you supply information that enables it to communicate with
an LDAP that contains the necessary groups and users.
Note: Active Directory is a critical part of infrastructure. The installation of LCM Server on a domain controller
is not allowed.
The LifeCycle Manager installation provides two LDAP options. Review these topics carefully to determine
which option best meets your requirements.
• Manual Configuration with an existing LDAP
• Installing a Pre-configured AD LDS instance

Manual Configuration with an existing LDAP


If you have an existing LDAP that already contains your users, Infor recommends that you choose the manual
LDAP configuration option. This option configures LifeCycle Manager to authenticate to your LDAP. Through
this method, your existing users and the LifeCycle Manager users will be the same and you can avoid dual
user maintenance.
If you already have an LDAP server installed to manage your user resources, Infor recommends that you do
these tasks:
• Add the necessary group or user structure to the LDAP.
• Install LifeCycle Manager using the option to manually configure settings for a central LDAP server.

M3 Core Installation Planning Guide - Windows | 25


Security considerations

Installing a Pre-configured AD LDS instance


If you do not have an existing LDAP server, the LifeCycle Manager installation program will deliver an Active
Directory Lightweight Directory Service (AD LDS) instance that is already configured for LifeCycle Manager
users. In this case, you do not have to provide any configuration data during the installation.
For more information on AD LDS, see http://technet.microsoft.com/library/hh831593 for a Windows 2012-based
installation.

Users and roles


When a user logs on using the LifeCycle Manager Client, the user ID and password are sent over an encrypted
SSL connection to the LifeCycle Manager Server. The server authenticates the user against an LDAP server
and checks if the user is a member of the LifeCycle Manager user group. If no such group has been defined,
all users that can be found in LDAP using the defined user search filter are allowed to log on. The Client only
displays the tasks that the user is allowed to perform. Therefore, for a viewer user, only a few or no tasks at
all will be displayed when the user is positioned on a node in the tree.
There are three levels of users in an LifeCycle Manager environment:
• LifeCycle Manager Administrators
Members of this group are allowed to perform all tasks throughout the server environment.
• Product Installation Administrators
Members of this group are allowed to administer and perform tasks on a specific product installation,
and on all product installations that are children to it.
Note: An administrator group can be defined for each product installation.
To set the administrator group for a product installation, you must be an administrator for the parent of
that product installation (or be a LifeCycle Manager administrator). This exception also applies to the
Adding a Path and Removing a Path tasks.
• Viewers
All users that can log on to LifeCycle Manager can view information about managed servers and installed
applications. The users, however, are not allowed to perform any task, unless the task is explicitly defined
as a "viewer task".

Example
On an M3 Business Engine (BE) installation, the administrator group BEAdmins is defined. On the PROD
environment under the M3 BE installation, the administrator group ProdAdmins is defined.
Alice is a member of the BEAdmins group. Therefore, she is allowed to administer both the BE installation
and all environments under it. She can also create new BE environments and set administrator groups for
them.
Bob is a member of the ProdAdmins group. He is allowed to administer the PROD environment, but not the
BE installation, nor any other environments under it. Bob is not allowed to change the administrator group
for the PROD environment.

M3 Core Installation Planning Guide - Windows | 26


Security considerations

Role management

IFS Security Roles


You can manage most role assignments through Ming.le, as many applications have Security Roles defined
in Infor Ming.le. These Security Roles become available when adding M3 applications in Infor Ming.le. Security
Roles in Infor Ming.le can be used for access control to Grid applications, given that there exist Grid role
mappings between the Security Roles and the corresponding Grid roles. Grid applications that do not have
Security Roles defined in Infor Ming.le must have their access managed directly in the Grid role mappings.
You can assign certain Security Roles to all users. Examples of such roles are M3UI-User and MingleEnterprise.
Consider which Security Roles to assign in this manner. See "Assigning a Security Role to all new or existing
users in Infor Ming.le 12" in M3 Core Administration Guide.
The GRID-Administrator role has no use in on-premise scenarios. To manage the grid itself, we recommend
using certificates rather than by authenticating with SAML, for example by accessing the Grid Management
Pages through the LCM.

M3 Core Installation Planning Guide - Windows | 27


Prepare installation on the servers

Chapter 5: Prepare installation on the servers

Use the suggested worksheet to capture all design decisions and the more detailed information that is a result
of the steps here. Take note of the user ID and password assignments, these are important in the latter part
of the steps.
Here is an ordered list on how to install the servers. In this planning step, we will prepare the installation of
software on the servers by installing the operating system, databases, and other tools required on the servers.
1 Install M3 Home Server
2 Install M3 Project Admin Client/Server
3 Install M3 Application and M3 Database Servers

Install M3 Home Server

Software requirements
Software requirements Windows 2012 R2
For information about how to install required software, see the corresponding installation guides.

Component Supported version(s)


Operating System Windows Server 2012 R2 Standard Edition
Any edition is possible from an M3 perspective. The choice should be
made on what other features you are looking for.
Note: The only supported configurations are:
• Server with full GUI Interface (Server Graphical Management Tools
& Infrastructure)
• Server with minimal GUI Interface (Server Graphical Shell)
English is the preferred language for installing Windows. Infor’s ability
to support non-English installations is limited.

M3 Core Installation Planning Guide - Windows | 28


Prepare installation on the servers

Component Supported version(s)


Database Microsoft SQL Server 2014 Enterprise Edition SP2 or higher 64-bit
Microsoft SQL Server 2014 Standard Edition SP2 or higher 64-bit
Note: Developer and Express editions are supported for test and
demonstration purpose.
Java Application server Oracle Java SE Development Kit 8.0 Update 191 or higher 32-bit and
64-bit
For more information about Oracle Java, see: http://www.oracle.com/
technetwork/java/index.html.
Amazon Corretto JDK 8 32-bit and 64-bit
For more information about Amazon Corretto, see: https://aws.ama
zon.com/corretto/.
OpenText StreamServe 5.6.2
Exstream 16.x
Used for output management of M3 Business Engine printouts
Infor Federation Services 12+
Note: IFS is included in Infor OS and this requirement is for the SAML
Session Provider.
IBM WebSphere MQ 8.5 (MQ Series Note: These are optional third party components for Infor Enterprise
Channel compatibility) Collaborator (IEC).
Windows version 5.6 for scripting If these channel types are required, refer to the third party installation
host guide.

Software requirements Windows 2016


For information about how to install required software, see the corresponding installation guides.

Component Supported version(s)


Operating System Windows Server 2016 Standard Edition
Datacenter and Essentials editions could be possible from an M3 per-
spective. The choice should be made on what other features you are
looking for.
Note: The only supported configuration is Server with a Desktop Expe-
rience.
English is the preferred language for installing Windows. Infor’s ability
to support non-English installations is limited.

M3 Core Installation Planning Guide - Windows | 29


Prepare installation on the servers

Component Supported version(s)


Database Microsoft SQL Server 2016 Enterprise Edition SP1 or higher 64-bit
Microsoft SQL Server 2016 Standard Edition SP1 or higher 64-bit
Microsoft SQL Server 2017 Enterprise Edition latest CU 64-bit
Microsoft SQL Server 2017 Standard Edition latest CU 64-bit
Note: Developer and Express editions are supported for test and
demonstration purposes.
Java Application server Oracle Java SE Development Kit 8.0 Update 191 or higher 32-bit and
64-bit
For more information about Oracle Java, see: http://www.oracle.com/
technetwork/java/index.html.
Amazon Corretto JDK 8 32-bit and 64-bit
For more information about Amazon Corretto, see: https://aws.ama
zon.com/corretto/.
OpenText StreamServe 5.6.2
Exstream 16.x
Used for output management of M3 Business Engine printouts
Infor Federation Services 12+
Note: IFS is included in Infor OS and this requirement is for the SAML
Session Provider.
IBM WebSphere MQ 8.5 (MQ Series Note: These are optional third party components for Infor Enterprise
Channel compatibility) Collaborator (IEC).
Windows version 5.6 for scripting If these channel types are required, refer to the third party installation
host guide.

Software requirements Windows 2019


For information about how to install required software, see the corresponding installation guides.

Component Supported version(s)


Operating System Windows Server 2019 Standard Edition
Datacenter and Essentials editions could be possible from an M3 per-
spective. The choice should be made on what other features you are
looking for.
Note: The only supported configuration is Server with a Desktop Expe-
rience.
English is the preferred language for installing Windows. Infor’s ability
to support non-English installations is limited.

M3 Core Installation Planning Guide - Windows | 30


Prepare installation on the servers

Component Supported version(s)


Database Microsoft SQL Server 2017 Enterprise Edition latest CU 64-bit
Microsoft SQL Server 2017 Standard Edition latest CU 64-bit
Microsoft SQL Server 2019 Enterprise Edition latest CU 64-bit
Microsoft SQL Server 2019 Standard Edition latest CU 64-bit
Note: Developer and Express editions are supported for test and
demonstration purposes.
Java Application server Oracle Java SE Development Kit 8.0 Update 191 or higher 32-bit and
64-bit
For more information about Oracle Java, see: http://www.oracle.com/
technetwork/java/index.html
Amazon Corretto JDK 8 32-bit and 64-bit
For more information about Amazon Corretto, see: https://aws.ama
zon.com/corretto/.
OpenText StreamServe 5.6.2
Exstream 16.x
Used for output management of M3 Business Engine printouts
Infor Federation Services 12+
Note: IFS is included in Infor OS and this requirement is for the SAML
Session Provider.
IBM WebSphere MQ 8.5 (MQ Series Note: These are optional third party components for Infor Enterprise
Channel compatibility) Collaborator (IEC).
Windows version 5.6 for scripting If these channel types are required, refer to the third party installation
host guide.

Software requirements Windows 2022


For information about how to install required software, see the corresponding installation guides.

Component Supported version(s)


Operating System Windows Server 2022 Standard Edition
Datacenter and Essentials editions could be possible from an M3 per-
spective. The choice should be made on what other features you are
looking for.
Note: The only supported configuration is Server with a Desktop Expe-
rience.
English is the preferred language for installing Windows. Infor’s ability
to support non-English installations is limited.

M3 Core Installation Planning Guide - Windows | 31


Prepare installation on the servers

Component Supported version(s)


Database Microsoft SQL Server 2019 Enterprise Edition latest CU 64-bit
Microsoft SQL Server 2019 Standard Edition latest CU 64-bit
Microsoft SQL Server 2022 Enterprise Edition latest CU 64-bit
Microsoft SQL Server 2022 Standard Edition latest CU 64-bit
Note: Developer and Express editions are supported for test and
demonstration purposes.
Java Application server Oracle Java SE Development Kit 8.0 Update 332 or higher 32-bit and
64-bit
For more information about Oracle Java, see: http://www.oracle.com/
technetwork/java/index.html
Amazon Corretto JDK 8 32-bit and 64-bit
For more information about Amazon Corretto, see: https://aws.ama
zon.com/corretto/.
OpenText StreamServe 5.6.2
Exstream 16.x
Used for output management of M3 Business Engine printouts
Infor Federation Services 12+
Note: IFS is included in Infor OS and this requirement is for the SAML
Session Provider.
IBM WebSphere MQ 8.5 (MQ Series Note: These are optional third party components for Infor Enterprise
Channel compatibility) Collaborator (IEC).
Windows version 5.6 for scripting If these channel types are required, refer to the third party installation
host guide.

Install Windows and SQL Server


Follow the instructions in Install M3 Application and M3 Database Servers on page 37.

Install JVM
Follow the instructions in Install M3 Application and M3 Database Servers on page 37.

M3 Core Installation Planning Guide - Windows | 32


Prepare installation on the servers

Setting up the LDAP


Use this procedure if you plan to install LifeCycle Manager using the manual LDAP configuration option. If
you plan to use the pre-configured AD LDS option, skip this section.
Verify required LDAP installation values
Fill in the worksheet in LDAP installation values. Contact the LDAP administrator if you are unsure about these
settings. For more information about the LDAP settings in the lcm.properties file, see LDAP properties.

Preparing the LCM Backup server


The LifeCycle Manager Server files can only be backed up to a Windows server. On that server, you must create
a shared folder to hold the backup files. It should be possible to map a network drive towards this folder from
the server where LCM Server is installed. Infor recommends to use the M3 Home Server or the M3 Database
Server (if applicable) as LCM Backup server, if those servers are backed up.

Set up file share


Create a file share to facilitate access to downloaded components for M3 Core.
1 Create a folder in the file structure on the M3 Home server.
2 Set this up with appropriate access.
3 Use this for downloaded components that are required to be accessed by installers.

Install OpenText StreamServe/Exstream


Install OpenText StreamServe/Exstream according to the instructions in the OpenText StreamServe/Exstream
installation guide.

Install M3 Project Admin Client/Server

Introduction
The M3 Project Admin Client/Server should be read as a generic name for the computer/server where M3
client products will be installed. These products can be installed on a common server or one by one on a
client computer.

M3 Core Installation Planning Guide - Windows | 33


Prepare installation on the servers

Software requirements
Software requirements Windows

Component Supported version(s)


Operating System Microsoft Windows 10 32-bit or 64-bit
Microsoft Windows 11 64-bit
Microsoft Windows Server 2012 R2 Standard Edition 64-bit
Microsoft Windows Server 2016 Standard Edition 64-bit
Microsoft Windows Server 2019 Standard Edition 64-bit
Microsoft Windows Server 2022 Standard Edition 64-bit
Java Application server Oracle Java SE Development Kit 8.0 Update 332 or higher 32-bit
or 64-bit
For more information about Oracle Java, see: http://www.ora
cle.com/technetwork/java/index.html.
Amazon Corretto JDK 8 32-bit or 64-bit
For more information about Amazon Corretto, see: https://
aws.amazon.com/corretto/.
Web Browser Chrome, latest version
Microsoft Edge, latest version
Eclipse 4.5
For M3 Adaptation Kit
Download the package from http://www.eclipse.org/downloads
Subclipse Latest valid version
For M3 Adaptation Kit
This is used for version control integration. For more informa-
tion, see Version Control and M3 Adaptation Kit User Guide.
IBM WebSphere MQ 8.5 (MQ Series Note: These are optional third party components for Infor En-
Channel compatibility) terprise Collaborator (IEC).
Windows version 5.6 for scripting host If these channel types are required, refer to the third party in-
stallation guide.

Install JVM
Follow the instructions in Install M3 Application and M3 Database Servers on page 37.

M3 Core Installation Planning Guide - Windows | 34


Prepare installation on the servers

Installing and verifying Eclipse

Install Eclipse
1 Download Eclipse. The product is available for download from this site: http://www.eclipse.org.
2 Select the correct Eclipse package on the Download Eclipse tab. Each package is provided with a brief
description about its specific functions or capabilities.
3 Extract the files to your local hard drive. The extracted zip file creates a folder named Eclipse.
Note: You can have multiple Eclipse installations as long as they are located in different folders. You
cannot upgrade to Eclipse from an earlier version using the Update Manager. However, since both versions
can exist in parallel, you are not required to uninstall the previous versions.

Verify installed Eclipse version


1 Start Eclipse.
2 Select Help > About Eclipse SDK. The version is displayed in the About Eclipse SDK window.
3 Verify that your Eclipse version is supported in this version of M3 Adaptation Kit. For more information,
see Software requirements.

Pre-installation steps for M3 Adaptation Kit

Install XML Editor for Complex Field Helps


1 Start Eclipse.
2 Select Help > Install New Software.
3 From the "Work with" drop down menu, select "Galileo - http://download.eclipse.org/releases/galileo"
Update Site.
4 Expand the Web, XML, and Java EE Development node.
5 Select Eclipse XML Editors and Tools and click Next.
6 Verify the checked items and click Finish. A progress window is displayed.
7 When the installation is finished, you are prompted to restart Eclipse to apply the changes. Click Yes. The
workbench is restarted and the MAK files are installed.

Install the Subclipse Plug-in for Eclipse


1 Go to the GitHub subclipse wiki page.

M3 Core Installation Planning Guide - Windows | 35


Prepare installation on the servers

2 Copy the Eclipse update site URL for the version of Subclipse.
3 Start Eclipse.
4 Select Help > Install New Software.
5 On the Available Software window, click Add.
6 On the Add Repository window, specify this information:
Name
Specify a name for the update site.

Location
Specify or paste the Eclipse update site URL obtained from step 2.

7 Click OK.
8 On the list of available software, select the parent node for Subclipse. Click Next.
9 Review the installation details and click Next.
10 Review and accept the terms of license agreement, and then click Finish.
11 Restart Eclipse to apply the changes.

Set JAVA_HOME for Infor Enterprise Collaborator tools


The Partner Administration and Flat File Definition tools require that the JAVA_HOME environment variable
is set.
1 Access the Environment Variables window.
2 In the System Variable section, click New.
The New System Variable window is displayed.
3 Specify this information:
Variable name
Specify JAVA_HOME.

Variable value
Specify the root path of the current Java installation.
For example, C:\jdk1.7.0

Note: Do not include spaces when specifying the variable value. Use short name path in Windows, to
address spaces for the variable value.

4 Click OK to finish.
5 Verify that you are using the required Java version number. Open a command prompt and run this
command:
%JAVA_HOME%\bin\java.exe -version

M3 Core Installation Planning Guide - Windows | 36


Prepare installation on the servers

Install M3 Application and M3 Database Servers


Use this section to know more about the requirements and instructions for installing M3 application and M3
database servers.

Software requirements Windows


Software requirements Windows 2012 R2
For information about how to install required software, see the corresponding installation guides.

Component Supported version(s)


Operating System Windows Server 2012 R2 Standard Edition
Any edition is possible from an M3 perspective. The choice should be
made on what other features you are looking for.
Note: The only supported configurations are:
• Server with full GUI Interface (Server Graphical Management Tools
& Infrastructure)
• Server with minimal GUI Interface (Server Graphical Shell)
English is the preferred language for installing Windows. Infor’s ability
to support non-English installations is limited.
Database Microsoft SQL Server 2014 Enterprise Edition SP2 or higher 64-bit
Microsoft SQL Server 2014 Standard Edition SP2 or higher 64-bit
Note: Developer and Express editions are supported for test and
demonstration purposes.
Java Application server Oracle Java SE Development Kit 8.0 Update 191 or higher 32-bit and
64-bit
For more information about Oracle Java, see: http://www.oracle.com/
technetwork/java/index.html.
Amazon Corretto JDK 8 32-bit and 64-bit
For more information about Amazon Corretto, see: https://aws.ama
zon.com/corretto/.
OpenText StreamServe 5.6.2
Exstream 16.x
Used for output management of M3 Business Engine printouts.
Infor Federation Services 12+
Note: IFS is included in Infor OS and this requirement is for the SAML
Session Provider.

M3 Core Installation Planning Guide - Windows | 37


Prepare installation on the servers

Component Supported version(s)


IBM WebSphere MQ 8.5 (MQ Series Note: These are optional third party components for Infor Enterprise
Channel compatibility) Collaborator (IEC).
Windows version 5.6 for scripting If these channel types are required, refer to the third party installation
host guide.

Software requirements Windows 2016


For information about how to install required software, see the corresponding installation guides.

Component Supported version(s)


Operating System Windows Server 2016 Standard Edition
Datacenter and Essentials editions could be possible from an M3 per-
spective. The choice should be made on what other features you are
looking for.
Note: The only supported configuration is Server with a Desktop Expe-
rience.
English is the preferred language for installing Windows. Infor’s ability
to support non-English installations is limited.
Database Microsoft SQL Server 2016 Enterprise Edition SP1 or higher 64-bit
Microsoft SQL Server 2016 Standard Edition SP1 or higher 64-bit
Microsoft SQL Server 2017 Enterprise Edition latest CU 64-bit
Microsoft SQL Server 2017 Standard Edition latest CU 64-bit
Note: Developer and Express editions are supported for test and
demonstration purposes.
Java Application server Oracle Java SE Development Kit 8.0 Update 191 or higher 32-bit and
64-bit
For more information about Oracle Java, see: http://www.oracle.com/
technetwork/java/index.html.
Amazon Corretto JDK 8 32-bit and 64-bit
For more information about Amazon Corretto, see: https://aws.ama
zon.com/corretto/.
OpenText StreamServe 5.6.2
Exstream 16.x
Used for output management of M3 Business Engine printouts.
Infor Federation Services 12+
Note: IFS is included in Infor OS and this requirement is for the SAML
Session Provider.

M3 Core Installation Planning Guide - Windows | 38


Prepare installation on the servers

Component Supported version(s)


IBM WebSphere MQ 8.5 (MQ Series Note: These are optional third party components for Infor Enterprise
Channel compatibility) Collaborator (IEC).
Windows version 5.6 for scripting If these channel types are required, refer to the third party installation
host guide.

Software requirements Windows 2019


For information about how to install required software, see the corresponding installation guides.

Component Supported version(s)


Operating System Windows Server 2019 Standard Edition
Datacenter and Essentials editions could be possible from an M3 per-
spective. The choice should be made on what other features you are
looking for.
Note: The only supported configuration is Server with a Desktop Expe-
rience.
English is the preferred language for installing Windows. Infor’s ability
to support non-English installations is limited.
Database Microsoft SQL Server 2017 Enterprise Edition latest CU 64-bit
Microsoft SQL Server 2017 Standard Edition latest CU 64-bit
Microsoft SQL Server 2019 Enterprise Edition latest CU 64-bit
Microsoft SQL Server 2019 Standard Edition latest CU 64-bit
Note: Developer and Express editions are supported for test and
demonstration purposes.
Java Application server Oracle Java SE Development Kit 8.0 Update 191 or higher 32-bit and
64-bit
For more information about Oracle Java, see: http://www.oracle.com/
technetwork/java/index.html.
Amazon Corretto JDK 8 32-bit and 64-bit
For more information about Amazon Corretto, see: https://aws.ama
zon.com/corretto/.
OpenText StreamServe 5.6.2
Exstream 16.x
Used for output management of M3 Business Engine printouts.
Infor Federation Services 12+
Note: IFS is included in Infor OS and this requirement is for the SAML
Session Provider.

M3 Core Installation Planning Guide - Windows | 39


Prepare installation on the servers

Component Supported version(s)


IBM WebSphere MQ 8.5 (MQ Series Note: These are optional third party components for Infor Enterprise
Channel compatibility) Collaborator (IEC).
Windows version 5.6 for scripting If these channel types are required, refer to the third party installation
host guide.

Software requirements Windows 2022


For information about how to install required software, see the corresponding installation guides.

Component Supported version(s)


Operating System Windows Server 2022 Standard Edition
Datacenter and Essentials editions could be possible from an M3 per-
spective. The choice should be made on what other features you are
looking for.
Note: The only supported configuration is Server with a Desktop Expe-
rience.
English is the preferred language for installing Windows. Infor’s ability
to support non-English installations is limited.
Database Microsoft SQL Server 2019 Enterprise Edition latest CU 64-bit
Microsoft SQL Server 2019 Standard Edition latest CU 64-bit
Microsoft SQL Server 2022 Enterprise Edition latest CU 64-bit
Microsoft SQL Server 2022 Standard Edition latest CU 64-bit
Note: Developer and Express editions are supported for test and
demonstration purposes.
Java Application server Oracle Java SE Development Kit 8.0 Update 332 or higher 32-bit and
64-bit
For more information about Oracle Java, see: http://www.oracle.com/
technetwork/java/index.html.
Amazon Corretto JDK 8 32-bit and 64-bit
For more information about Amazon Corretto, see: https://aws.ama
zon.com/corretto/.
OpenText StreamServe 5.6.2
Exstream 16.x
Used for output management of M3 Business Engine printouts.
Infor Federation Services 12+
Note: IFS is included in Infor OS and this requirement is for the SAML
Session Provider.

M3 Core Installation Planning Guide - Windows | 40


Prepare installation on the servers

Component Supported version(s)


IBM WebSphere MQ 8.5 (MQ Series Note: These are optional third party components for Infor Enterprise
Channel compatibility) Collaborator (IEC).
Windows version 5.6 for scripting If these channel types are required, refer to the third party installation
host guide.

M3 Application and M3 Database Server Setup


For performance reasons, Infor strongly recommend to separate the M3 Database server from the M3
Application server. This document is written to take this into consideration. Each section below specifies the
server to be used.

Install Platform Windows Server / SQL Server 2014

Install Windows Server


To install Windows Server, see the Windows Server documentation.
Ensure to perform Windows Update to install the latest updates.

Install Microsoft SQL Server 2014


Note: We recommend to perform Windows Update to enhance the SQL Server security and performance
before running the installation.
Preparations
• Ensure that you have your Microsoft SQL Server 2014 installation media, installation key, and operating
system installation media.
• Log on using an account that has Administrative rights.
• Disable any Antivirus software that is running as it can sometimes affect the installation.
• Shut down any services or applications that depend on SQL Server, Data Source Names (DSN), or Open
Database Connectivity (ODBC).
• Close any unnecessary applications that access the registry.
• Close the Event Viewer.

M3 BE SQL Server Instance Requirements


• Mixed mode authentication.

M3 Core Installation Planning Guide - Windows | 41


Prepare installation on the servers

• SQL Server collation Latin1_General_BIN2 for the system database.


• SQL Server collation Latin1_General_BIN2 for the M3 Business Engine database.
• A static port for each instance.
1 Mount the Microsoft SQL Server 2014 installation media on the server.
2 Run setup.exe and select Installation/New SQL Server stand-alone installation or add features to an
existing installation.
3 Check for warnings or errors in Setup Support Rules, and click OK.
4 Optionally, accept installation of Product Updates (if any) and click Next.
5 Check for warnings or errors in Setup Support Rules, and click Next.
6 Optionally, select Perform a new installation of SQL Server in Installation Type, and click Next.
7 Enter the Product Key and click Next.
8 Accept the licensing terms in the License Terms window, and click Next.
9 Select SQL Server Feature Installation in Setup Role and click Next.
10 Select these options in the window Feature Selection, and accept or change shared feature directory:
• Database Engine Services
• Client Tools Connectivity
• Management Tools - Basic
• Management Tools - Complete
Note: SQL Management Tools can only be installed on a Windows Server 2014 with full GUI interface
configuration.
Click Next.
11 In the Installation Rules window, check for errors and warnings and click Next.
12 In the Instance Configuration window, leave the Default instance check box selected,or name the new
Named instance. Accept or change the Instance root directory, and click Next.
13 In the Server Configuration window, select a specific, dedicated Windows user account (local or domain)
for all SQL Server services and specify passwords. In the Collation tab, choose Latin_General
(Latin_General_BIN2) binary sort for Database Engine, and click Next.
14 In the Database Engine Configuration window, select Mixed mode (SQL Server authentication and
Windows authentication).
Specify the sa login password.
Note
Always use a strong password for the sa account and change the password periodically.
Add a (current) User as SQL Server administrator.
Accept or change data directories in the Data Directories tab.
Do not enable FILESTREAM for Transact-SQL access in the FILESTREAM tab.
Click Next.
15 In the Error Reporting window, click Next.
16 In the Installation Configuration Rules window, check for errors and warnings and click Next.
17 In the Ready to Install window, check the summary and click Install.

M3 Core Installation Planning Guide - Windows | 42


Prepare installation on the servers

18 In the Complete window, click Close.

Install SQL Server 2014 Service Pack


Download and install the recommended SQL Server service pack level (if any). For information about Infor
recommended service packs, refer to Software requirements Windows on page 37.

Modify SQL Server Settings 2014


Caution: Unless you are sure that you know what you are doing, we recommend that you do not modify
other settings than those noted in this document.
Note: For information about post-installation steps and additional modifications on the Database Server,
see M3 Business Engine and Microsoft SQL Server - Best Practices for SQL server 2014 in KB 2212202.
1 Open the SQL Server Configuration Manager and connect to the installed SQL Server instance.
2 Select the SQL Server Services. Ensure that these services are Running and the Start Mode is turned to
Automatic for:
• SQL Server (your instance)
• SQL Server Agent (your instance)

3 Select SQL Server Network Configuration > Protocols for (your instance). Ensure that the TCP/IP is Enabled.
4 Verify that the instance of SQL Server is configured to use a static port. If firewall is enabled on your server,
you must create firewall exceptions to enable access to this port.
5 Restart the database server and check that it is working correctly.

Install Platform Windows Server / SQL Server 2016

Install Windows Server


To install Windows Server, see the Windows Server documentation.
Ensure to perform Windows Update to install the latest updates.

Install Microsoft SQL Server 2016


Note: We recommend to perform Windows Update to enhance the SQL Server security and performance
before running the installation.
Preparations

M3 Core Installation Planning Guide - Windows | 43


Prepare installation on the servers

• Ensure that you have your Microsoft SQL Server 2016 SP1 installation media, installation key, and operating
system installation media.
• Log on using an account that has Administrative rights.
• Disable any Antivirus software that is running as it can sometimes affect the installation.
• Shut down any services or applications that depend on SQL Server, Data Source Names (DSN), or Open
Database Connectivity (ODBC).
• Close any unnecessary applications that access the registry.
• Close the Event Viewer.

M3 BE SQL Server Instance Requirements


• Mixed mode authentication.
• SQL Server collation Latin1_General_BIN2 for the system database.
• SQL Server collation Latin1_General_BIN2 for the M3 Business Engine database.
• A static port for each instance.
1 Mount the Microsoft SQL Server 2016 installation media on the server.
2 Run setup.exe and select Installation/New SQL Server stand-alone installation or add features to an
existing installation.
3 Optionally, accept installation of Product Updates (if any) and click Next.
4 Check for warnings or errors in Install Rules, and click Next.
5 Optionally, select Perform a new installation of SQL Server in Installation Type, and click Next.
6 Enter the Product Key and click Next.
7 Accept the licensing terms in the License Terms window, and click Next.
8 Select this option in the Feature Selection window, and accept or change instance root directory and
Shared feature directory:
• Database Engine Services
Note: SQL Server Management Tools is no longer installed from the main feature tree and must be
downloaded separately.
Click Next.
9 In the Feature Rules window, check for errors and warnings and click Next.
10 In the Instance Configuration window, leave the Default instance check box selected, or name the new
Named instance. Click Next.
11 In the Server Configuration window, accept the Virtual account or select a specific, dedicated Windows
user account (local or domain) for all SQL Server services and specify passwords. Select the check box
"Grant Perform Volume Maintenance Task privilege".
See M3 Business Engine and Microsoft SQL Server - Best Practices for SQL Server 2016 in KB 2212202.
12 In the Collation tab, choose Latin_General (Latin_General_BIN2) binary sort for Database Engine, and
click Next.
13 In the Database Engine Configuration window, select Mixed mode (SQL Server authentication and
Windows authentication).
Specify the sa login password.
Note

M3 Core Installation Planning Guide - Windows | 44


Prepare installation on the servers

Always use a strong password for the sa account and change the password periodically.
Add a (current) User as SQL Server administrator.
Accept or change data directories in the Data Directories tab.
In the TempDB tab, accept default values or configure the tempdb by following the recommendations
in the M3 Business Engine and Microsoft SQL Server - Best Practices for SQL Server 2016 in KB 2212202.
Do not enable FILESTREAM for Transact-SQL access in the FILESTREAM tab.
Click Next.
14 In the Feature Configuration Rules window, check for errors and warnings and click Next.
15 In the Ready to Install window, check the summary and click Install.
16 In the Complete window, click Close.

Install SQL Server 2016 Service Pack


Download and install the recommended SQL Server service pack level (if any). For information about Infor
recommended service packs, refer to Software requirements Windows on page 37.

Modify SQL Server Settings 2016


Caution: Unless you are sure that you know what you are doing, we recommend that you do not modify
other settings than those noted in this document.
Note: For information about post-installation steps and additional modifications on the Database Server,
see M3 Business Engine and Microsoft SQL Server - Best Practices for SQL Server 2016 in KB 2212202.
1 Open the SQL Server Configuration Manager and connect to the installed SQL Server instance.
2 Select the SQL Server Services. Ensure that these services are Running and the Start Mode is turned to
Automatic for:
• SQL Server (your instance)
• SQL Server Agent (your instance)

3 Select SQL Server Network Configuration > Protocols for (your instance). Ensure that the TCP/IP is Enabled.
4 Verify that the instance of SQL Server is configured to use a static port. If firewall is enabled on your server,
you must create firewall exceptions to enable access to this port.
5 Restart the database server and check that it is working correctly.

M3 Core Installation Planning Guide - Windows | 45


Prepare installation on the servers

Install Platform Windows Server / SQL Server 2017

Install Windows Server


To install Windows Server, see the Windows Server documentation.
Ensure to perform Windows Update to install the latest updates.

Install Microsoft SQL Server 2017


Note: We recommend to perform Windows Update to enhance the SQL Server security and performance
before running the installation.
Preparations
• Ensure that you have your Microsoft SQL Server 2017 installation media, installation key, and operating
system installation media.
• Log on using an account that has Administrative rights.
• Disable any Antivirus software that is running as it can sometimes affect the installation.
• Shut down any services or applications that depend on SQL Server, Data Source Names (DSN), or Open
Database Connectivity (ODBC).
• Close any unnecessary applications that access the registry.
• Close the Event Viewer.

M3 BE SQL Server Instance Requirements


• Mixed mode authentication.
• SQL Server collation Latin1_General_BIN2 for the system database.
• SQL Server collation Latin1_General_BIN2 for the M3 Business Engine database.
• A static port for each instance.
1 Mount the Microsoft SQL Server 2017 installation media on the server.
2 Run setup.exe and select Installation/New SQL Server stand-alone installation or add features to an
existing installation.
3 Optionally, accept installation of Product Updates (if any) and click Next.
4 Optionally, check for warnings or errors in Install Rules, and click Next.
5 Select Perform a new installation of SQL Server in Installation Type, and click Next.
6 Enter the Product Key and click Next.
7 Accept the licensing terms in the License Terms window, and click Next.
8 Select this option in the window Feature Selection, and accept or change instance root directory and
Shared feature directory:
• Database Engine Services

M3 Core Installation Planning Guide - Windows | 46


Prepare installation on the servers

Note: SQL Server Management Tools is no longer installed from the main feature tree and must be
downloaded separately.
Click Next.
9 In the Feature Rules window, optionally check for errors and warnings and click Next.
10 In the Instance Configuration window, leave the Default instance check box selected, or name the new
Named instance. Click Next.
11 In the Server Configuration window, accept the Virtual account or select a specific, dedicated Windows
user account (local or domain) for all SQL Server services and enter passwords. Mark the check box "Grant
Perform Volume Maintenance Task privilege".
See information in M3 Business Engine and Microsoft SQL Server - Best Practices for SQL Server 2017 in
KB 2212202.
12 In the Collation tab, choose Latin_General (Latin_General_BIN2) binary sort for Database Engine, and
click Next.
13 In the Database Engine Configuration window, select Mixed mode (SQL Server authentication and
Windows authentication).
Specify the sa login password.
Note
Always use a strong password for the sa account and change the password periodically.
Add a (current) User as SQL Server administrator.
Accept or change data directories in the Data Directories tab.
In the TempDB tab, accept default values or configure the tempdb by following the recommendations
in the M3 Business Engine and Microsoft SQL Server - Best Practices for SQL Server 2017 in KB 2212202.
Do not enable FILESTREAM for Transact-SQL access in the FILESTREAM tab.
Click Next.
14 In the Feature Configuration Rules window, check for errors and warnings and click Next.
15 In the Ready to Install window, check the summary and click Install.
16 In the Complete window, click Close.

Install SQL Server 2017 Latest Cumulative Update


Download and install the recommended SQL Server latest cumulative update (CU), if any. For information
about Infor recommended CUs,see Software requirements Windows on page 37.

Modify SQL Server Settings 2017


Caution: Unless you are sure that you know what you are doing, we recommend that you do not modify
other settings than those noted in this document.
Note: For information about post-installation steps and additional modifications on the Database Server,
see M3 Business Engine and Microsoft SQL Server - Best Practices for SQL Server 2017 in KB 2212202.
1 Open the SQL Server Configuration Manager and connect to the installed SQL Server instance.

M3 Core Installation Planning Guide - Windows | 47


Prepare installation on the servers

2 Select the SQL Server Services. Ensure that these services are Running and the Start Mode is turned to
Automatic for:
• SQL Server (your instance)
• SQL Server Agent (your instance)

3 Select SQL Server Network Configuration > Protocols for (your instance). Ensure that the TCP/IP is Enabled.
4 Verify that the instance of SQL Server is configured to use a static port. If firewall is enabled on your server,
you must create firewall exceptions to enable access to this port.
5 Restart the database server and check that it is working correctly.

Install Platform Windows Server / SQL Server 2019

Install Windows Server


To install Windows Server, see the Windows Server documentation.
Ensure to perform Windows Update to install the latest updates.

Install Microsoft SQL Server 2019


Note: We recommend to perform Windows Update to enhance the SQL Server security and performance
before running the installation.
Preparations
• Ensure that you have your Microsoft SQL Server 2019 installation media, installation key, and operating
system installation media.
• Log on using an account that has Administrative rights.
• Disable any Antivirus software that is running as it can sometimes affect the installation. Ensure that you
have your Microsoft SQL Server 2019 installation media, installation key, and operating system installation
media.
• Shut down any services or applications that depend on SQL Server, Data Source Names (DSN), or Open
Database Connectivity (ODBC).
• Ensure that you have your Microsoft SQL Server 2019
• Close any unnecessary applications that access the registry.
• Close the Event Viewer.

M3 BE SQL Server Instance Requirements


• Mixed mode authentication.
• SQL Server collation Latin1_General_BIN2 for the system database.

M3 Core Installation Planning Guide - Windows | 48


Prepare installation on the servers

• SQL Server collation Latin1_General_BIN2 for the M3 Business Engine database.


• A static port for each instance.
1 Mount the Microsoft SQL Server 2019 installation media on the server.
2 Run setup.exe and select Installation/New SQL Server stand-alone installation or add features to an
existing installation.
3 Optionally, accept installation of Product Updates (if any) and click Next.
4 Optionally, check for warnings or errors in Install Rules, and click Next.
5 Select Perform a new installation of SQL Server in Installation Type, and click Next.
6 Enter the Product Key and click Next.
7 Accept the licensing terms in the License Terms window, and click Next.
8 Select this option in the window Feature Selection, and accept or change instance root directory and
Shared feature directory:
• Database Engine Services
Note: SQL Server Management Tools is no longer installed from the main feature tree and must be
downloaded separately.
Click Next.
9 In the Feature Rules window, optionally check for errors and warnings and click Next.
10 In the Instance Configuration window, leave the Default instance check box selected, or name the new
Named instance. Click Next.
11 In the Server Configuration window, accept the Virtual account or select a specific, dedicated Windows
user account (local or domain) for all SQL Server services and specify passwords. Select the check box
'Grant Perform Volume Maintenance Task privilege'.
See information in M3 Business Engine and Microsoft SQL Server - Best Practices for SQL Server 2019 in
KB 2212202.
12 In the Collation tab, choose Latin_General (Latin_General_BIN2) binary sort for Database Engine, and
click Next.
13 In the Database Engine Configuration window, select Mixed mode (SQL Server authentication and
Windows authentication).
Specify the sa login password.
Note
Always use a strong password for the sa account and change the password periodically.
Add a (current) User as SQL Server administrator.
Accept or change data directories in the Data Directories tab.
In the TempDB tab, accept default values or configure the tempdb by following the recommendations
in the M3 Business Engine and Microsoft SQL Server - Best Practices for SQL Server 2019 in KB 2212202.
In the MaxDOP tab, accept default values or configure by following recommendations in M3 Business
Engine and Microsoft SQL Server - Best Practices for SQL Server 2019 in KB 2212202.
In the Memory tab, configure Min Server Memory and Max Server Memory by following recommendations
in the M3 Business Engine and Microsoft SQL Server - Best Practices for SQL Server 2019 in KB 2212202.
Do not enable FILESTREAM for Transact-SQL access in the FILESTREAM tab.
Click Next.

M3 Core Installation Planning Guide - Windows | 49


Prepare installation on the servers

14 In the Feature Configuration Rules window, check for errors and warnings and click Next.
15 In the Ready to Install window, check the summary and click Install.
16 In the Complete window, click Close.

Install SQL Server 2019 Latest Cumulative Update


Download and install the recommended SQL Server latest cumulative update (CU), if any. For information
about Infor recommended CUs, refer to Software requirements Windows on page 37.

Modify SQL Server Settings 2019


Caution: Unless you are sure that you know what you are doing, we recommend that you do not modify
other settings than those noted in this document.
Note: For information about post-installation steps and additional modifications on the Database Server,
see M3 Business Engine and Microsoft SQL Server - Best Practices for SQL Server 2019 in KB 2212202.
1 Open the SQL Server Configuration Manager and connect to the installed SQL Server instance.
2 Select the SQL Server Services. Ensure that these services are Running and the Start Mode is turned to
Automatic for:
• SQL Server (your instance)
• SQL Server Agent (your instance)

3 Select SQL Server Network Configuration > Protocols for (your instance). Ensure that the TCP/IP is Enabled.
4 Verify that the instance of SQL Server is configured to use a static port. If firewall is enabled on your server,
you must create firewall exceptions to allow access to this port.
5 Restart the database server and check that it is working correctly.

Install Platform Windows Server / SQL Server 2022

Install Windows Server


To install Windows Server, see the Windows Server documentation.
Ensure to perform Windows Update to install the latest updates.

Install Microsoft SQL Server 2022


Note: We recommend that you perform a Windows Update to enhance the SQL Server security and performance
before running the installation.

M3 Core Installation Planning Guide - Windows | 50


Prepare installation on the servers

Preparations
• Ensure that you have your Microsoft SQL Server 2022 installation media, installation key, and operating
system installation media.
• Log on using an account that has Administrative rights.
• Disable any Antivirus software that is running as it can sometimes affect the installation.
• Shut down any services or applications that depend on SQL Server, Data Source Names (DSN), or Open
Database Connectivity (ODBC).
• Ensure that you have your Microsoft SQL Server 2022.
• Close any unnecessary applications that access the registry.
• Close the Event Viewer.

M3 BE SQL Server Instance Requirements


• Mixed mode authentication.
• SQL Server collation Latin1_General_BIN2 for the system database.
• SQL Server collation Latin1_General_BIN2 for the M3 Business Engine database.
• A static port for each instance.
1 Mount the Microsoft SQL Server 2022 installation media on the server.
2 Run setup.exe and select Installation/New SQL Server stand-alone installation or add features to an
existing installation.
3 Select the Edition of SQL Server 2022 to install and click Next.
4 Accept the licensing terms in the License Terms window, and click Next.
5 Optionally, check for warnings or errors in Install Rules, and click Next.
6 Clear the Azure Extension for SQL Server check box and click Next.
7 Select this option in the window Feature Selection, and accept or change instance root directory and
Shared feature directory:
Database Engine Services
Note: SQL Server Management Tools must be downloaded and installed separately.
Click Next.
8 In the Feature Rules window, optionally check for errors and warnings and click Next.
9 In the Instance Configuration window, leave the Default instance check box selected, or name the new
Named instance. Click Next.
10 In the Server Configuration window, accept the Virtual account or select a specific, dedicated Windows
user account (local or domain) for all SQL Server services and specify passwords. Select the check box
'Grant Perform Volume Maintenance Task privilege'.
11 On the Collation tab, select Windows collation designator and sort order Latin_General and select
Binary-code point, and click OK. Verify that Latin1_General_BIN2 has been customized and click Next.
12 In the Database Engine Configuration window, select Mixed mode (SQL Server authentication and
Windows authentication).
Specify the sa login password.
Note

M3 Core Installation Planning Guide - Windows | 51


Prepare installation on the servers

Always use a strong password for the sa account and change the password periodically.
Add a (current) User as SQL Server administrator.
Accept or change data directories in the Data Directories tab.
On the TempDB tab, accept default values or configure the tempdb by following the recommendations
in the M3 Business Engine and Microsoft SQL Server - Best Practices for SQL Server 2019 in KB 2212202.
On the MaxDOP tab, accept default values or configure by following recommendations in the M3 Business
Engine and Microsoft SQL Server - Best Practices for SQL Server 2019 in KB 2212202.
On the Memory tab, configure Min Server Memory and Max Server Memory by following recommendations
in the M3 Business Engine and Microsoft SQL Server - Best Practices for SQL Server 2019 in KB 2212202.
Do not enable FILESTREAM for Transact-SQL access in the FILESTREAM tab.
Click Next.
13 In the Feature Configuration Rules window, check for errors and warnings and click Next.
14 In the Ready to Install window, check the summary and click Install.
15 In the Complete window, click Close.

Install SQL Server 2022 Latest Cumulative Update


Download and install the recommended SQL Server latest cumulative update (CU), if any. For information
about Infor recommended CUs, refer to Software requirements Windows on page 37.

Modify SQL Server Settings 2022


Caution: Unless you are sure that you know what you are doing, we recommend that you do not modify
other settings than those noted in this document.
1 Open the SQL Server Configuration Manager and connect to the installed SQL Server instance.
2 Select the SQL Server Services. Ensure that these services are Running and the Start Mode is turned to
Automatic for:
• SQL Server (your instance)
• SQL Server Agent (your instance)

3 Select SQL Server Network Configuration > Protocols for (your instance). Ensure that the TCP/IP is Enabled.
4 Verify that the instance of SQL Server is configured to use a static port. If a firewall is enabled on your
server, you must create firewall exceptions to allow access to this port.
5 Restart the database server and check that it is working correctly.

M3 Core Installation Planning Guide - Windows | 52


Prepare installation on the servers

Post SQL Server Installation


Firewall considerations
• It is important to configure and secure SQL Server. Keep the server fire-walled and patched, and restrict
access on the server to only educated IT staff.
• Because Microsoft SQL Server communicates over port (1433, default), you must open the port in the
firewall.
• The SQL Server Browser service lets users connect to instances of the Database Engine that are not
listening on port 1433, without knowing the port number. To use SQL Server Browser, you must open
UDP port 1434. To promote the most secure environment leave the SQL Server Browser service stopped,
and configure clients to connect using the port number.

Antivirus considerations
Configure your antivirus software settings and ensure that you exclude SQL Server binaries, backups and,
above all, data files, transaction log files and the quorum disk (in a cluster configuration) from virus scanning.

Database considerations
It is also worth noticing that mixing different types of database implementations (that is, OLTP vs. OLAP) is
NOT recommended. OLTP databases usually have short transactions with many updates whereas reporting
databases, such as OLAP and data warehouse systems, have longer data-heavy queries.
Note:
M3 BE has mainly an OLTP performance profile. We strongly recommend NOT installing LBI/BPW database
on the same instance and database server.

Parameter Sensitive Plan Optimization


One change in SQL Server 2022 that may affect M3 Business Engine's CPU usage and performance is the
introduction of Parameter Sensitive Plan Optimization (PSPO). An advantage of PSPO is that it can reduce
parameter sniffing but while there may be benefits, it can also bring limitations of increased memory usage
and CPU load. Consider changing the default value of the PSPO parameter in the M3 BE database if you notice
an increased CPU load.

Install JVM
Install a JVM on both the Application and Database servers.
Note: On the Windows servers, Infor requires that both 32-bit and 64-bit java are installed.
Oracle has announced that the free Oracle JDK 8 support expired in January 2019. You can choose to pay
Oracle for extended support or you can choose to install a distribution of the OpenJDK from Amazon called
Amazon Corretto 8. For more information, see KB 2033057.

M3 Core Installation Planning Guide - Windows | 53


Prepare installation on the servers

Install Oracle JDK


1 Download the latest packages of the recommended version of Oracle Java SE Development Kit from:
http://www.oracle.com/technetwork/java/index.html.
2 Log on using an account that is a member of the built in local administrators group.
3 Double-click the installation file and follow the instructions in the installation wizard to install the JVM.
Infor recommends that you install the JVM directly under the root to avoid a path including blank spaces.

Install Amazon Corretto JDK


1 Download the latest available zip packages, both 32-bit and 64-bit of the recommended version of Amazon
Corretto JDK from: https://aws.amazon.com/corretto/.
2 Unzip the 32-bit zip file.
Infor recommends to unzip directly under root to avoid blank spaces in the path.
3 Rename the folder so that it is not overwritten by the next one. For example, set name to jdk1.8.0_202_32.
4 Repeat steps 2-3 but for the 64-bit zip package.

M3 Core Installation Planning Guide - Windows | 54


Handover to installation

Chapter 6: Handover to installation

Handover document
Use the Excel file worksheet published with the M3 Core guides. It serves as a handover document containing
the server set-up performed using this Installation Planning Guide. The document contains information about
server IP addresses and other details, and the required SW installations to be performed on each server.

M3 Core Installation Planning Guide - Windows | 55


M3 SW Components Overview

Chapter 7: M3 SW Components Overview

LifeCycle Manager
LifeCycle Manager is a framework that facilitates standardized and uniform installation, maintenance, and
management of M3 products. This framework enables administration and customization of several servers
and products from a centralized location.
The LifeCycle Manager (LCM) installation consists of three components:
• LifeCycle Manager Server
This is the central point of the architecture. This server hosts all of the installation components and
scripts. It also hosts a database that contains information about all of the managed servers and Infor
products installed on those servers.
• LifeCycle Manager Service
This must be installed on each server that you prefer to manage with LifeCycle Manager. For example,
the M3 Business Engine server or the Infor Smart Office server. To install a LifeCycle Manager Service, a
LifeCycle Manager Server must first be installed in the network.
• LifeCycle Manager Client
This is the user interface for LifeCycle Manager. It is used by all users who manage Infor applications on
the network. The client can be installed on each user’s desktop computer or on a centralized administration
client. The client cannot communicate directly with the LifeCycle Manager Services, but must log on to
the LifeCycle Manager Server. The server authenticates the user against an LDAP server.

M3 Foundation
M3 Foundation is a cross-platform runtime framework for the M3 Business Engine application logic. It provides
services for database access, application jobs and subsystem process management, client-server interaction,
output management and monitoring.
The M3 Foundation Management Pages provide common work management functions for the M3 Business
Engine environment. The main functionality includes:
• Monitoring the physical server from the logging and news pages.
• Managing subsystems using tools for smart cache, job management and more.
• Testing MI transactions.

M3 Core Installation Planning Guide - Windows | 56


M3 SW Components Overview

• Analyzing performance using profiling on subsystem or job level.

Infor ION Grid


The ION Grid is a Java-based application server that provides a distributed runtime environment for other
applications. Those other applications may, at any time, be added (deployed) or removed (undeployed) from
a grid. The distributed nature of a grid means that an instance of the Infor ION Grid may span multiple server
machines.
The ION Grid consists of several parts:

Host
A host is a server machine that is participating in a grid. The host may be a physical or a virtual machine. Each
grid has at least one host but may have several. A host may be a member of more than one grid.
Hosts operating in the same grid should not run the same operating system as each other. A grid can contain
any combination of hosts from the supported platforms.

Bootstrap
The Grid bootstrap is a JVM used to install, upgrade, and launch the grid on a specific host. The bootstrap
JVM is not owned by the grid but is in fact executed as a service, registered with the operating system. It is
decoupled in this way to enable the bootstrap or the Host Router (which it launches) to fail independently of
each other without causing total grid failure.

Host Router
The Host Router is a built-in default router JVM. It is started by the bootstrap and then there is exactly one
Host Router per host.
The host router is responsible for:
• Establishing the communication channels use for all grid internal communication
• Starting other grid JVMs on its host (nodes, other routers, and deploy nodes)
• Presenting a fixed point for communication with the grid from external clients (for example, the grid
administration ui)

Router
A router is a JVM that acts as an entry point that client applications can connect to. A router is configured to
listen for client requests on a given network interface and with several specified ports including HTTP, HTTP(S)
and sometimes other TCP/IP ports. Normally, the selected port number has to be made accessible through
firewalls, when applicable, since it must be reachable from clients.

M3 Core Installation Planning Guide - Windows | 57


M3 SW Components Overview

Node
A node is a JVM that is registered as being part of a grid where grid applications are running. A grid typically
has several nodes running different applications. Each node is running on one of the hosts that are part of
the grid.
Nodes operating in the same grid should not run the same Java version as each other. A grid can contain any
combination of nodes running the supported Java versions. A typical example of combining Java versions
could be using 32-bit and 64-bit editions together depending on the memory requirements for a specific node
or application.

Deploy Node
Deploy Nodes are used to execute deployment, upgrades, and undeployment of applications. The deploy
node is not necessarily launched on a host which is the target of an application deployment operation. Also,
one Deploy Node may perform a deployment operation with several hosts as targets.

Infor ION Grid Application Concepts


A user of the ION Grid should be aware of these concepts when installing and administering the grid:

Node Types
A node type defines what to run in a specific node. Each node is of exactly one node type. More precisely, the
node type defines what application to run in nodes of this type and may also define default values for properties
(for example, heap size). Node types are defined by the application developer.

Bindings
A binding defines where and how to run nodes of a specific node type. It can be seen as an association
between a node type and a set of hosts. To start a specific node type on a particular host, a binding that
associates the node type with the host is required. Properties required by the node or the application running
in the node may be defined per binding.
Bindings are defined when applications are installed by a grid administrator at runtime.

Applications
A grid application is a logical grouping of one or more application modules. An application may be running
in more than one node. It is then said to have more than one application instance. Applications for the grid
are packaged in gar files. A gar file is a type of zip file that can be installed in a grid. It contains Java class files
(jar files) and any other resources that the application may require.

M3 Core Installation Planning Guide - Windows | 58


M3 SW Components Overview

Grid Database Connectivity (GDBC)


The Grid Database Connectivity (GDBC) Grid Extension is a collection of database-related tools geared towards
aiding the usage of a database in a grid application. The purposes are:
• Decouple the application from the database driver and configuration.
With GDBC, each grid application has an implicit database that it may choose to use. The GDBC provides
an individual database connection string and database drivers for the grid application to use.
• Make a default database readily accessible for quick development startup.
The GDBC can use an H2 database. However, this is not recommended for a production environment.
Because H2 includes a Microsoft SQL Server mode, it is easier to write grid applications that are compatible
with both H2 and SQL Server. A developer can then initially develop using H2 and then switch the
application to use SQL Server at a customer site.

Event Hub and Event Analytics Introduction

Event Hub Background


Infor provides several applications--including M3, Infor Enterprise Search (IES), Infor Enterprise Collaborator
(IEC), Infor Process Automation (IPA) --that send events to other applications.
Examples:
• M3 database records are sent to IES
• M3 Business Message (MBM) initiator files are sent to IEC
• M3 application messages trigger workflows in IPA/PFI

The event format and communication method is proprietary for each application that receives events:
• Sockets with a proprietary protocol to IES
• SNDSTMF (M3 streamfile socket protocol) + XML to IEC
• Proprietary IPA/PFI client code

This is done point-to-point in a spaghetti solution where the event provider requires to implement different
event formats and communication for each event consumer. Each event consumer receives different types
of events from the event provider, for example M3 database events to IES, M3 media management events
(and more) to IEC, and M3 application messages to IPA/PFI. You cannot, for example, send an M3 database
event to IEC.
To send a non-standard event from M3 to IPA/PFI or IEC, you must add those by custom Java code in M3.
Simultaneously, IES receives many events from M3 without any custom Java code. Events are both sent from

M3 Core Installation Planning Guide - Windows | 59


M3 SW Components Overview

an application and received in a generic way. This leads to a hub-and-spoke solution which is exactly what
the Event Hub is.

What is Event Hub?


The Event Hub is a generic grid extension for sending events between Infor applications. The Event Hub is a
publisher-subscriber framework, that is, an application framework that enables applications to expose
historical data to other applications that are interested in receiving this data.
Examples:
• IES receives events on create, update, and delete operations on most M3 database records.
• IPA receives events on create, update, and/or delete operations on some M3 database records and when
some batch jobs exit.

Definition of terms

Event A discrete unit of historical data that an application


exposes that may be relevant to other applications.
Publisher An application that must publish events.
Subscriber An application that should receive events that are
published by another application.
Subscription A predicate indicating that a subscriber is to receive
a particular event. Subscriptions are given to the
Event Hub by the subscribers.
Event Hub A grid application that receives events from publish-
ers and routes the events to subscribers based on
subscriptions.

Highlights of Event Hub


Whenever some kind of business event happens in an application for example, you create a new customer
order, you release an item or print a purchase order, or even when you enter or exit a program or a panel,
there should be a possibility to send an event to the Event Hub. To accomplish this, you must use some simple
publisher Java classes delivered with the Event Hub. The performance penalty when calling the publisher
methods is low, so this can be implemented without affecting performance for the end user.
Applications that require to receive events also must use some simple subscriber Java classes. Because the
Event Hub is metadata driven by subscriptions (given by the subscribers), the application code of the publisher
is not required to be modified for every customer case. This supports "mods-free" applications.

M3 Core Installation Planning Guide - Windows | 60


M3 SW Components Overview

Publishers can dynamically connect to the Event Hub. Subscribers can also dynamically connect to the Event
Hub. The Event Hub will persist new event data received even though the subscriber is down, if set up to do
so. You can, for example, restart an application with a subscriber without losing any event data.
Note: You do not set up the Event Hub. Events are published to the Event Hub through a publisher application.
These published events are determined by the subscriptions in the subscriber application.

What Is Event Analytics?


The Event Analytics application enables you to analyze the events processed by the Event Hub. The Event
Hub is intentionally kept simple. It guarantees delivery of events to subscribers according to the subscriptions.
However, sometimes you may be required to analyze the events thoroughly for more refined routings. A good
example is to send events to Infor Process Automation only when an M3 item is released, that is, when the
M3 MITMAS record is updated from a lower status to status 20.
Event Analytics contains a subscriber and a publisher. In between the subscriber and the publisher, there is
a rules engine, Drools Expert by JBoss. Events are received by the subscriber and inserted into the rules engine
as facts, and the rules are fired based on matching filter conditions. You create your own rules based on facts
such as events, time, or custom-declared fact types. In a rule, you can post received events back to the Event
Hub, create and post new events, store data, and so on using standard Java code.

How to set up Event Hub and Event Analytics


Any production environment must to be set up using the Event Hub with GDBC and SQLServer.
For any other type of environment, you can choose either one of these alternatives:
• The same set-up as for the production environment.
• A set-up using GDBC and the H2 database.
• Using the Grid built-in Derby database.

For detailed information about the different alternatives, see ION Grid Security Administration Guide.

Events
An event is something that happens in an application which carries a business value--for example, an item is
updated or a batch job has finished. The event data is stored in a "document" and the actual event is the
operation on the document. Another way to put it is that the document is the object and the operation is the
verb. The event occurs in an application, for example, M3.
An event contains these data:
• Publisher. For example, M3
• Document name. For example, OOHEAD (order head in M3)

M3 Core Installation Planning Guide - Windows | 61


M3 SW Components Overview

• A list of document elements, each having these items:


• Element name. For example, ORSL (order status)
• Element value
• Old element value, if applicable
• Operation on the document: Create, Update, Delete, Start, eXit, Fail, reQuest, or Response. The operations
are hardcoded, but can be extended if required.
Note: The bold and uppercase letters are the operation characters. In subscription strings the operation
is given by its operation character.
• Tracking ID
• Sent timestamp

The order of the document elements is maintained through Event Hub and Event Analytics.

Publisher
Applications publishing events must run a simple publisher. The publisher will "tell" the application if someone
prefers the event or not, for example, an update of the item master table. Unwanted events are not sent to
the Event Hub.
If someone prefers the event, then the application must create an event containing application specific data.
The event is then posted to the Event Hub. The publisher is typically called within the database layer of an
application.

Subscriber
Applications subscribing to events must use some simple subscriber code. The subscriber will receive events
from the Event Hub according to the subscriptions given by the subscriber.

Subscription
A subscription contains this information:
• Publisher. For example, M3
• Document name. For example, OOHEAD
• One or several event operations

A subscription also provides properties for guaranteed event sequence (not implemented yet) and event
priority (P1, P2, and P3).

M3 Core Installation Planning Guide - Windows | 62


M3 SW Components Overview

A subscription can be defined by a single string using this layout (BNF format):

<syntax> ::= <publisher> ":" <documentName> [":" [<operation char>] [":" [("true" | "false")]
[":"[<priority>]]]]

For example, M3:OOHEAD:CUD:false:P2


A subscriber must define at least one subscription to receive any events.
Note: All subscriptions of subscribers are merged in the Event Hub and propagated to the publishers. A
publisher will not post an unwanted event to the Event Hub.

Persistence
The Event Hub secures event data and event data delivery by persistence. Incoming event data is persisted
together with outgoing event status, that is, if the event has been sent to a subscriber. When an event has
been sent to all subscribers, it is removed from the persistence. If a subscriber is busy, the events will be
persisted by the Event Hub until they can be processed.
Note: The events should only be persisted for a limited time. The Event Hub is not an archive.

Event Hub Schematic Overview


This is a schematic overview of the Event Hub:

M3 Core Installation Planning Guide - Windows | 63


M3 SW Components Overview

Event Analytics Technical Overview


An event received by the subscriber of Event Analytics is inserted as a fact object (using the class HubEvent)
into a stateful knowledge base. You can set up several independent stateful sessions in Event Analytics running
in separate threads. Then, all rules are fired. Lastly, the inserted fact object is retracted. Session Start, Session
Stop and Time (every minute) fact objects are inserted (and rules are fired) automatically.
In the rules, you can analyze the event data and post events using the publisher of Event Analytics, for example,
post an event only when the old status is 10 and the new status is 20. You can also create new (meta-)events,
for example, count number of new customer orders per customer and day. Stateful sessions' fact objects are
persisted automatically. Hence, you can restart Event Analytics without losing counter values.
You can put custom jar files into the "lib" subfolder in the session directory. These are loaded automatically
when starting the session.
Subscriptions for Event Analytics are defined as metadata attributes for rules in this format:

@subscription(subscription string)

When you (re-)load a session all subscriptions are merged and sent to the Event Hub.
Rule example:

rule "OOHEAD_20"
@subscription(M3:OOHEAD:U)
no-loop
when
event: HubEvent(publisher == "M3", documentName == "OOHEAD", operation == EventOperation.UPDATE,

elementValues["ORSL"] == "20", elementOldValues["ORSL"] == "10")


then
event.postEvent("OOHEAD_20");
end

You can also declare your own fact types, for example, counters.
Note: Do not store too much data for a session because all stored fact objects for a session must be handled
as one unit when serializing and deserializing for persistence. If a large amount of data must be stored, you
should use an external storage method instead.

High Availability for Event Hub

High Availability for Event Hub Overview


Since version 2.2, Event Hub can run in a HA configuration employing two or more horizontally scalable nodes.
One node is designated the primary role and handles the communication with clients under normal operation.
One of the other nodes are running in active backup mode, and only becomes operational in the event the
live primary node, for some reason, disappear. When an active backup node is promoted to live backup, one

M3 Core Installation Planning Guide - Windows | 64


M3 SW Components Overview

of the remaining passive backup nodes, if it exists, takes on the active backup role, ready to become the new
live backup, if necessary. When the live role moves to a new node, subscriber and publisher connections will
automatically fail-over to that new live node. This gives the Event Hub as a system the ability to continue
functioning after losing one or more of its nodes.
The primary and active/passive backup nodes do not share the same data directories on the file system;
instead, all data synchronization is done over the network. All persistent data received by the live node will
be synchronously replicated over to the active backup.
The different node roles are resolved during application start-up. The node that last held the live role will
become the new live primary node, and the fist of the other nodes to connect when the new primary has
started is elected the active backup role. All remaining nodes will take on a passive backup role. During
start-up, an active backup node should synchronize existing data from the live primary node first before it
could replace the primary should it fail. This explains that a replicating backup will not be fully operational
immediately after start, but only after it has finished synchronizing with the primary. The time it will take for
this to happen will depend on the amount of data to be synchronized and the speed of the network connection.
This also means that an active backup node will always wait until the live primary node is fully started before
completing its own start up. Hence, a cold start of the Event Hub application must always involve starting up
the node that last had the live role.

High Availability and Clients


The Event Hub publisher and subscriber, also called the clients, will transparently fail-over to a new live Event
Hub node without any loss of events. Any open transactions at the time of fail-over will be automatically
re-issued after the connection is successfully re-established. All released version two clients are capable of
automatic fail-over.
Note: Clients can be configured to circumvent the Grid based address lookup and connect to the Event Hub
server using a statically specified host and port. Clients configured to use a static host and port to connect
to Event Hub will not work reliably with an Event Hub deployed in high availability mode on more than one
host. If this kind of set up is a requirement, for example, when a client application should run in a Grid separate
from the Event Hub application, Event Hub must be configured to only run on a single host. The scale-in and
scale-out functionality in Grid can be used to govern the required number of nodes/hosts used by Event Hub.

M3 Web Services
M3 Web Services Server is the runtime engine for M3 Web Services which are wrappers for the business
functionality provided by supported applications such as M3 Business Engine.
The M3 Web Services Grid Management pages provide some basic administrative capabilities. For example,
you can view deployed web services, check the server setup for errors, do some basic configuration
management, and manage web service security.
To create your own web services, you must install the M3 Web Services Designer component which enables
you to design, model, deploy, and test web services.

M3 Core Installation Planning Guide - Windows | 65


M3 SW Components Overview

M3 UI Adapter
M3 UI Adapter serves as a middleware between M3 Business Engine and these user interfaces:
• Infor Smart Office
• M3 H5

The M3 UI Adapter on Grid is administered through the LifeCycle Manager client.

M3 H5
M3 H5 provides an HTML 5-based user interface for accessing work-related information and applications from
the M3 business system. It enables the user to run M3 programs under predefined workflows.
H5 contains features such as:
• Personalizations
• Shortcuts
• Enabled saving of Context Publisher settings
• Web mashups
• Multi-web browser support

For more information about installing H5, see the M3 Core Installation Guide.

M3 Ad Hoc Reporting
M3 Ad hoc reporting is a tool within M3 Business Engine that enables the building of your own M3 report over
any M3 standard or customer-build M3 table. With the Ad hoc reporting designer you can simulate at design
before committing to runtime (WYSIWYG). The Ad hoc reporting tool comes pre-populated with M3 BE table
definitions, standard sorting orders and views.
The output is always an XML file which is created by a batch job. Ad hoc report versions can be saved and
then submitted, online or through M3 BE job scheduler.

M3 Financial Business Messages


The M3 FBM are bundled country specific financial business messages used to communicate with local banking
systems.

M3 Core Installation Planning Guide - Windows | 66


M3 SW Components Overview

M3 Business Engine User Documentation


M3 Business Engine (BE) User Documentation provides full-text search capability for user documentation. It
is an application used by M3 H5 and Infor Smart Office to view online documentation. It is built with help files
that are context-sensitive at the form level. When a user clicks the Help icon on an M3 form, the M3 BE User
Documentation is launched and appropriate documentation topics are displayed.

Infor Enterprise Collaborator (IEC) overview

EC Server
The EC Server and EC client tools are installed separately. Both installations must connect to EC Database.
EC Database stores all the data for mappings, partner agreements, and runtime data. For example, message
logs and log settings.
EC Server is installed through LifeCycle Manager (LCM). EC client tools can be installed on a Windows machine
separate from the EC Server.
At runtime, EC Server and EC Database are the only necessary components.

Partner Administration tool


PA tool enables the user to define and manage the partner agreement information required by EC to send
and receive business messages between you and your partners. The data used for the process are stored in
a EC database. PA provides a core of services for controlling different specific tasks to support partner
administration.

Business Document Mapper tool


Mapper tool is used to create and deploy mappings. On a high level, a mapping is a description of how to
transform or translate messages or documents sent between internal and external resources. On a detailed
level, a mapping is an XML file expressing a transformation between input and output elements, and attribute
structures defined by XML schemas representing the input and output messages and documents. Mapper
provides the capabilities to define mappings, for example, for OAGIS BODs, EDI, EBS, financial messages, and
others.

M3 Core Installation Planning Guide - Windows | 67


M3 SW Components Overview

Restricted use
Business Document Mapper delivered in the Infor Enterprise Collaborator Tools package licensed under M3
Core Infrastructure and Technology is restricted to be used only for installing licensed content developed
and delivered by Infor.
It should not be used for modifying existing or developing new integrations in the Infor Enterprise Collaborator.
Modifications or development requires a license to the Business Document Mapper.

Flat File Definition tool


FFD tool is a set of design time tools that create flat file definition according to the specifications in a flat file
message. The FFD components are the Flat File Repository Manager and the Flat File Describer. Use these
components to develop and edit flat definitions.

EC Application components
MEC_Central node
This is a runtime component that runs as a grid node and provides file access service to all of the MEC_Process
and MEC_MapGen nodes. This node is also called CentralFileAccess (CFA).
MEC_Central node runs detections, agreements, and process dispatchers. This node uses a central file folder.
CFA delegates tasks to Process nodes. When there are no process nodes running, the MEC_Central node also
acts as a standalone node.

MEC_Process node
MEC_Process node is an additional runtime component used to run the process flow of agreements received
in EC through MEC_Central node and peer Process nodes. MEC_Process node is depends on MEC_Central
node to run.

MEC_MapGen node
MEC_MapGen node generates mappings for runtime and runs on Grid nodes. Depending on the BE database
type you use, you must add the corresponding API Channel for the BE connection where MEC_MapGen node
runs.

MEC_UI node
This is the graphical interface of EC Application in Grid, taking the place of the previous Web Administration
tool. You can access EC UI through EC Management page in Grid or through EC URL.

M3 Core Installation Planning Guide - Windows | 68


M3 SW Components Overview

From the UI page you can delete old data logs from EC database, configure log settings, view message logs,
view archived message files, and perform other EC management tasks.

EC Database
EC Database stores mapping data, partner agreements, and runtime log data. EC Database is required to run
the EC grid nodes (Central, MapGen, Process, and UI).

BOD Processor
The M3BODProcessor subscribes to events from Event Analytics, enhances and publishes them through Event
Hub to IEC. The BOD Processor processes BOD content based on rulespack archives that filter events that are
valid as BODs.
Verify that the M3 user SVCM3BOD is created and has user access to all M3 BE Company, Division, Warehouse
and Facilities information. To add or update user access for SVCM3BOD, select Related Options> Update
Access all Cmp/Div in 'User. Open' (MNS150) in M3 Business Engine.

M3 Workflow Executor
The Grid application M3WF provides web service interfaces, which enables ION workflows to interact with
M3 Business Engine API programs. For more information on the usage of M3 Workflow Executor, see M3
Content Guide for ION.

M3 Adaptation Kit overview


M3 Adaptation Kit (MAK) is an Integrated Development Environment (IDE) for M3 Business Engine (BE). MAK
is built as a plug-in to the open source Eclipse development framework and is used to perform changes and
troubleshoot M3 BE related components, excluding foundation components, at customer sites.
Here is a list of MAK supported features:
• Out interfaces
• View Definitions
• Language files
• Field Helps
• Debug of Programs in read-only mode

When Extended Access Mode is enabled, here are the additional supported features:

M3 Core Installation Planning Guide - Windows | 69


M3 SW Components Overview

• Programs
• Database interfaces
• Data structures

M3 Metadata Publisher overview


M3 Metadata Publisher is a tool used to explore M3-related metadata with its files (tables), fields (columns),
and relations between files-program and program-files. MDP can generate and show the metadata for unique
M3 Business Engine customer installation. These metadata are based on the Standard components, and
Market and Customer installed components.

OpenText StreamServe/Exstream
OpenText StreamServe/Exstream (referred to as StreamServe/Exstream throughout this document) transforms
M3 Business Engine data into predefined documents or report layouts. StreamServe/Exstream enables many
different formats and distribution channels for data (email, mobile, electronic invoice, printer and fax). Infor
has produced approximately 1000 predefined layouts for StreamServe/Exstream. The StreamServe/Exstream
product makes modification and adaptation of the predefined layouts.

M3 Core Installation Planning Guide - Windows | 70


Infor Enterprise Collaborator configuration, consideration, and dependencies

Chapter 8: Infor Enterprise Collaborator configuration,


consideration, and dependencies

This chapter explains how to configure Infor Enterprise Collaborator (IEC) based on the customers' requirement
during the pre-installation stage.

Hardware requirements
These factors affect IEC performance:
• Read-and-write speed
• RAM size and speed
• CPU clock speed and the number of cores
Read-and-write speed affects IEC performance the most, so use SSD drives to maximize the application's
performance.
IEC uses these spaces:

Space requirements Quantity


Database space 50 - 100GB
Disk space 10 - 20GB

The standard IEC configuration is:


• 1 * Central 1 - 2GB RAM
• N * Process 1 - 2GB RAM, typically N ≥ 1. ( 0 ≤ N ≤ 8)
• 1 * UI 512 MB RAM
• 1 * MapGen 512 MB RAM
Note: IEC runs on one machine for a small installation and two or more for larger installations. The standard
IEC configuration runs on 2 through 4 CPU cores per installation.

M3 Core Installation Planning Guide - Windows | 71


Infor Enterprise Collaborator configuration, consideration, and dependencies

Initial settings
IEC has installation settings that must be considered before and during installation. You must understand
these topics to correctly install IEC based on the customer's specifications.

DocArchiver.Level
You must always consider the document archive level. The DocArchiver.Level tier controls the folder structure
where IEC stores the messages and the number of documents that can be stored in the system. The number
of messages in the system depends on the inflow of messages and the maintenance frequency.
• DocArchiver.Level = 1, suitable for 8000 messages stored on disk
• DocArchiver.Level = 2, suitable for 100k messages stored on disk
• DocArchiver.Level = 3, suitable for 1.5M messages stored on disk (recommended setting)
• DocArchiver.Level = 4, suitable for 25M messages stored on disk (recommended setting)
• DocArchiver.Level = 5, suitable for 400M messages stored on disk (not recommended)

Throughput factors to consider


Throughput is primarily affected by the number of processing threads. These threads handle the
communication with M3 and the construction of the messages. When the number of processing threads is
changed or increased, other factors should also be changed to avoid subsequent bottlenecks.

Threads
Ideally, the number of threads directly correlates with the number of messages processed concurrently. Any
changes made to the number of threads will have an effect on throughput. You can modify several different
categories of threads but the primary one for message throughput is processing threads.
Note: The number of threads do not usually have a linear relationship to the message throughput. The
relationship is more logarithmic. Which is due to limitations or overhead in DB, HW, M3, and others.
For example, if 10 threads generate 10 messages per second, then 20 threads might generate 15 messages
per second.
Note: At some point, adding threads will decrease throughput due to hardware resource limitations, resulting
in excessive context switching.
The primary reason for having multiple threads is to negate IOPS waiting time induced by M3, DB, and the
file system. The optimum setting depends on the three aforementioned entities.

M3 Core Installation Planning Guide - Windows | 72


Infor Enterprise Collaborator configuration, consideration, and dependencies

Settings
The main thread that controls throughput is Runtime.ProcessWorker.MaxWorkers. This runtime controls the
maximum number of threads that will be created to run maps.
If the MaxWorkers is changed, then other properties should or must be changed, such as these properties:
• Inbound queues
• APIPool size
• DB pool size
• Heap size

Estimation
You must estimate the amount of threads required for the expected message throughput.
For example, if the message throughput is 10 messages per second, and each message takes 1.5 seconds to
process the list for the message, several factors must be considered.
From the first process log statement, “Running process: XYZ” to the last log statement “Finished processing
successfully.” It takes 1.5 seconds. After this, MaxWorkers = 10 * 1.5 which is 15, so 15 processing threads can
generate 10 messages per second, each message takes 1.5 seconds provided, there is no other overhead.
Because there is always some overhead, the recommendation would be 17-20 threads.

Verification
Verify the processes on the thread pool page. If the number of active process threads is fluctuating up to the
defined value, then the expected utilization has been reached and the configuration is good. If the number
of active process threads is fluctuating significantly below the defined value, then some other setting or
resource is affecting the throughput.

Heap size
Heap size does not directly affect throughput but it is affected by the message size and the number of messages
being processed concurrently. Since an estimation of the size of messages that is being processed concurrently
is difficult, you should try to make a worst case estimate by taking the resulting XML file size, multiply it with
20, and multiply it with the number of processing threads.
Heap estimate applies for the Central and Process node types and to MapGen and UI. MapGen and UI will
suffice with less heap. MapGen depends on the number of preload threads and UI depends on the number
of users and the type of operations performed. The MapGen and UI node types require a 256 to 1024MB heap.
Note: Messages that have streaming maps do not affect the heap size for the Central or Process nodes.
Messages that result in large XML files should have streaming mappings, and streaming requires that the map
is constructed to support this. The worst case scenario does not apply to ordered messages with the same
primary key, since only one primary key is processed at a time.

M3 Core Installation Planning Guide - Windows | 73


Infor Enterprise Collaborator configuration, consideration, and dependencies

Heap settings
Implement these heap installation settings:

Function Heap size


Central 512 MB to 1024 MB
Process 20 MB * XML file size * Runtime.ProcessWorker.Max-
Workers
MapGen 512 + (constant^preload) MB
User interface 512 MB

Queues
The internal queues in IEC balance out variations in load and the message processing time between different
modules. If the number of threads is increased, then generally, the preceding queue should also be increased.
The preceding queue length should be 1.5 times longer than the number of threads.
Note: The queue length affects the efficiency of the message prioritization. Better prioritization requires
longer queue lengths.

Queue settings
For maximum throughput, the queue lengths should preferably be set so that the subsequent module can
have all its threads pick one message from the queue without depleting it. You can enable the preceding
module time to produce new entries by setting the queue length to 1.5 *, which is the number of worker
threads of the subsequent module. The subsequent module will pick up the number of worker threads
simultaneously.
Implement these installation settings for queues:

Queue.class.Receive.MaxLengthHint = 1,5 * Runtime.DetectionWorker.MaxWorkers


Queue.class.Process.MaxLengthHint = 1,5 * Runtime.ProcessWorker.MaxWorkers
Queue.class.Agreement.MaxLengthHint = 1,5 * Runtime.AgreementWorker.MaxWorkers

APIPool
The APIPool maximum limit should be set so that there are always API-connections available, if necessary.
The APIPools limit, depends on the number of concurrent API-connections used in IEC, which in turn, depends
on the number of processing threads and the depth of API-loop levels inside the maps.
The maximum value can be calculated by multiplying the number of process threads by 3.
Note: The maximum value limit is 1000.

M3 Core Installation Planning Guide - Windows | 74


Infor Enterprise Collaborator configuration, consideration, and dependencies

APIPool settings:

MvxAPI.Pool.Connection.Max=3 * Runtime.ProcessWorker.MaxWorkers

DB pool
The DB pool maximum connection value depends mainly on the total number of threads. If the threads are
increased, then the maximum value should be increased correspondingly.
Note: There are different underlying pool implementations in IEC version 11.4.2 and 11.4.3. The IEC 11.4.3
version is more efficient and can be set at a slightly lower value.

DB pool settings
IEC uses a pool for its database connections. The database connections are used both for updating the
metadata of messages and for logging. If either of these consumers increases significantly, then the number
of database connections should also be increased, to avoid bottleneck. The number of database connections
should not be increased infinitely. Database connections are a limited resource and it will have an effect on
the database server and possibly on other applications that use the same database server.
Implement these installation settings for DB pool:

Recommended settings Definition


Database.ConnectionPoolExt.MinIdle = Increase if messages arrive in bursts
Database.ConnectionPoolExt.InitialSize = Increase if messages arrive in bursts
Database.ConnectionPoolExt.MaxIdle = + Same percentage that the threads were increased
with
Database.ConnectionPoolExt.MaxActive = + Same percentage that the threads were increased
with

Folder structure
IEC stores messages in hard drives, both temporary and permanently. If too many messages are stored in a
single folder, performance will be negatively affected when IEC is reading and writing files. You must choose
a suitable folder structure to prevent performance issues. After the folder structure is chosen and IEC has
processed messages, then the folder structure cannot be changed without significant rework.
The messages are either stored in a tree-shaped folder structure or a flat structure. The tree structure is the
recommended structure. The other parameter that controls the folder structure is depth. That specifies how
deep the tree should be. The structure is built up by creating folders based on the possible characters (16)
and their positions in the UUID. That implies that the total number of folders that will be created is 16^depth.

M3 Core Installation Planning Guide - Windows | 75


Infor Enterprise Collaborator configuration, consideration, and dependencies

The optimal file structure depends on the number of messages.


For example, given that the depth is set to 3, the UUID:
ea14ca5a-70d3-40a3-9adb-3bb93a507a09 will be located in the folder …\e\a\1.
Note: This setting should be considered and set before processing messages through IEC.

Calculating the required file system folder depth


You should estimate the suitable number of folder levels based on the number of messages and the time to
store them. Calculate the required number of folder levels based on these parameters:
• Messages per day
• The number of days the files are archived
• Maintenance schedule
• Maximum files per folder (recommended 200 to 500)
For example:
• Messages per day = 500,000
• The number of days the files are archived = 30
• Maintenance schedule = run every week
• Maximum files per folder (recommended 200 to 500) = 200
Calculation based on the example above:
• 500,000 (day) * ( 30 (days) + 7 (days, schedule) = 18,500,000 messages
• 200 (max files in folder) = 18,500,000 / 16^x , X ≈ 4. Thus DocArchiver.Level == 4.
Note: Set DocArchiver.Level to 5, at maximum, because each additional folder level comes with a slight
performance penalty for locating the files. You must balance this effect of having too few folders with too
many files, which will have a negative effect on performance.

Node deployment
IEC consists of different node types. Only the process node type can be scaled horizontally, that is, there can
be several instances of the process node. The different instances are not required to be located on the same
host. The CPU load and the thread load can be placed on different machines for better performance.
There is no straightforward formula for when it is more beneficial to instantiate a new node versus increasing
the number of processing threads. Internal tests have indicated that when the number of worker threads
reach 60, it is preferable to start considering instantiating a new node. The number varies significantly given
the underlying hardware and message types.

M3 Core Installation Planning Guide - Windows | 76


Infor Enterprise Collaborator configuration, consideration, and dependencies

Verifying behavior
You can view IEC performance by reading 3 main locations in its SAT UI. The key performance indicators are
the queues, threads and logs. Based on the information in these locations, you can see what module the
messages spend the most time and if that module is processing or working as much as it can, given the settings
it has.
You should perform a simple performance vetting of IEC.

Check queues
IEC functionality is divided into separate functional parts. There are queues between the various IEC parts.
Conclusions concerning which functional part is the slowest can be drawn based on in which queue build up
occurs.
The maximum length of the queues are not a fixed value, it is considered to be a value that you should aim
for performance reasons.
The queues also display a peak length. This value is often equal to or greater then the maximum value. The
reason for this is that if messages arrive in bursts then queues will fill up since the subsequent functionality
cannot keep up. This is particularly true if no messages have been processed before IEC is started.
The best approach to get reliable information regarding buildups in queues is to monitor that particular page
in SAT when IEC is processing a relevant message load.
If a functional part is significantly slower than the others, there are properties that control the maximum
number threads that the functional part can use.

Check thread pool


IEC functionality is divided into separate functional parts. Each functional part has a limitation on the number
of worker threads that it can use. Conclusions concerning which functional part is under or over worked can
be drawn based on how many percent of their threads were used.
The maximum number of threads for each functional part is a fixed value that will not be surpassed.
The threads page also display a peak length. This value is often equal to the maximum value. This enables
IEC to create threads to cope with messages arriving in bursts. This is particularly true if no messages have
been processed before IEC is started.
The best approach to get reliable information regarding functional parts thread utilization is to monitor that
particular page in SAT when IEC is processing a relevant message load. If a functional part has a significantly
higher thread use than the others, there are properties that control the maximum number threads that the
functional part can use.

M3 Core Installation Planning Guide - Windows | 77


Infor Enterprise Collaborator configuration, consideration, and dependencies

Check message log


IEC functionality is divided into separate functional parts. Each functional part logs into the IEC log as it starts
processing a message. If the log is viewed for one particular message, you can draw conclusions concerning
which functional part is consuming the most time and an unexpected amount of time.
It is usually informative to compare the message log for the same type of message both when IEC has less to
process and when IEC is under heavy load.

Example configurations
These are examples of an optimal configuration. They are not guaranteed to be suitable for any customer.
The three example configurations show a small, medium, and large installation.
These examples presume the installation does not have any prioritized, slow or ordered messages.
Settings and some brief explanation:
• Small; up to 10 messages per second
• Medium; approximately 25 messages per second
• Large; more than 50 messages per second
The message throughput depends on several factors, including the amount of orders, invoices and items.
• Number and nature of integrations planned for the system
• Plan for file persistence
• Plan for persistent storage. Map a network-attached storage rather than a specific physical local disk.
The primary limitation on throughput is the execution of maps and the more maps that can be concurrently
processed the better throughput. The primary property that controls the concurrency of maps execution is:

Runtime.ProcessWorker.MaxWorkers

Note: If this property is increased significantly, then other related properties shown below should be changed
and increased:

Queue.class.Process.MaxLengthHint
MvxAPI.Pool.Connection.Max
Database.ConnectionPoolExt.MaxActive
Runtime.TransferToPeerWorker.MaxWorkers

Small configuration
This configuration is for small throughput characteristics.

M3 Core Installation Planning Guide - Windows | 78


Infor Enterprise Collaborator configuration, consideration, and dependencies

Small characteristics
The customer does not have detailed knowledge regarding their integration's flow and it is not necessary
since an estimation indicates that their requirements are small.
• Peak load measured over 15 minutes; unknown
• Average load 1 hour; 2000 messages
• Average load per work day; 4000 orders, 2000 invoices, 2000 miscellaneous

Small throughput
Shown below is an example configuration of a small IEC installation with regards to message throughput. It
processes 5-7 messages per second given that the messages are of normal size and complexity. All throughput
related properties have their default standard value.

Small configuration settings


Use the default values provided.

Medium configuration
This configuration is for small throughput characteristics.

Medium characteristics
The customer does not have detailed knowledge regarding their integration's flow and it is not necessary
since an estimation indicates that their requirements are small.
• Peak load measured over 15 minutes; 15000
• Average load for 1 hour; 50000
• Average load per work day; 300000

Medium throughput
Shown below is an example configuration of a medium IEC installation with regards to message throughput.
It processes around 15 messages per second given that the messages are of normal size and complexity. All
throughput related properties that are not listed below have their default standard value. The configuration
is a sample configuration intended to describe the relationship between different throughput related properties.

M3 Core Installation Planning Guide - Windows | 79


Infor Enterprise Collaborator configuration, consideration, and dependencies

Medium configuration settings


Use the default values apart from the list below:

Database.ConnectionPoolExt.MaxActive = 20
Runtime.ProcessWorker.MaxWorkers = 30
Runtime.TransferToPeerWorker.MaxWorkers = 15
DocArchiver.Level = 3
Queue.class.Process.MaxLengthHint = 45

Note: The other existing properties have default values.

Large configuration
This configuration is for small throughput characteristics.

Large characteristics
The customer does not have detailed knowledge regarding their integration's flow and it is not necessary
since an estimation indicates that their requirements are small.
• Peak load measured over 15 minutes; 25000
• Average load for 1 hour; 80000
• Average load per work day; 500000

Large throughput
Shown below is an example configuration of a large IEC installation with regards to message throughput. It
processes around 25-30 messages per second given that the messages are of normal size and complexity. All
throughput related properties that are not listed below have their default standard value. The configuration
is a sample configuration intended to describe the relationship between different throughput related properties.
There should be 2 processing nodes with 40 ProcessWorker threads each. Update the min binding of the
process node to at least 2.

Large configuration settings


Use the default values apart from the list below:

Database.ConnectionPoolExt.MinIdle = 5
Database.ConnectionPoolExt.MaxIdle = 20
Database.ConnectionPoolExt.InitialSize = 5
Database.ConnectionPoolExt.MaxActive = 50
Runtime.ProcessWorker.MaxWorkers = 40
Runtime.TransferToPeerWorker.MaxWorkers = 20

M3 Core Installation Planning Guide - Windows | 80


Infor Enterprise Collaborator configuration, consideration, and dependencies

MvxAPI.Pool.Connection.Max = 200
DocArchiver.Level = 4

Queue.class.Process.MaxLengthHint = 50

Note: The other existing properties have default values.

M3 Core Installation Planning Guide - Windows | 81


LifeCycle Manager installation worksheets

Appendix A: LifeCycle Manager installation worksheets

Refer to this worksheet when you install LifeCycle Manager.

LDAP installation values


Determine these LDAP values. Refer to this worksheet when you install LifeCycle Manager.

Prompt Your value


LDAP server
Specify the host ID (DNS name or IP address) of the LDAP server.
Example
ldap.company.com

10.20.30.40

LDAP port
Specify the host port of the LDAP server.
Example
389 (LDAP)

636 (LDAPS)

Bind user (distinguished name)


Specify the distinguished name for the LifeCycle Manager Server to use when
binding to the directory service.
Example
cn=root

Bind user password


Specify the password for the bind user.
Note: The bind user password must not end with @.
SSL enabled
Optional. Specify whether secure socket communication is enabled to the
LDAP server.

M3 Core Installation Planning Guide - Windows | 82


LifeCycle Manager installation worksheets

Prompt Your value


Trust store
Optional. Required only if SSL is enabled. Specify the path to a JKS keystore
where the public server certificate of the LDAP server (or its certificate author-
ity) is stored.
Trust store password
Specify the password for the keystore.
Note: The trust store password must not end with @.
User prefix
Specify the attribute that LifeCycle Manager will use to display the user name
of users in the directory service.
Tivoli or ADAM Example: cn
Active Directory Example: sAMAccountName
Group prefix
Specify the attribute that LifeCycle Manager will use to display the group
name of groups in the directory service.
Example: cn
User suffix
Specify the base distinguished name which indicates the starting point for
LDAP searches of users in the directory service.
Example: OU=Users,DC=company,DC=com
Group suffix
Specify the base distinguished name which indicates the starting point for
LDAP searches of groups in the directory service.
Example
OU=Groups,DC=company,DC=com
Group member attribute
Specify the attribute for groups in the directory service that LifeCycle Manager
will use to determine which users are members of that group.
Example: member
User search filter
Specify the LDAP user filter that searches the user registry for users.
If you are installing LifeCycle Manager in an LDAP bind configuration, this
search must locate the same users as the search base provided during the
LDAP bind procedure.
Tivoli Example: (&(uid=%v)(objectclass=inetOrgPerson))
ADAM Example: (&(cn=%v)(objectclass=inetOrgPerson))
Active Directory Example: (&(|(cn=%v)(sAMAccountName=%v))
(objectClass=user))

M3 Core Installation Planning Guide - Windows | 83


LifeCycle Manager installation worksheets

Prompt Your value


Group search filter
Specify the LDAP user filter that searches the user registry for groups.
If you are installing LifeCycle Manager in an LDAP bind configuration, this
search must locate the same users as the search base provided during the
LDAP bind procedure.
Tivoli Example: (&(cn=%v)(objectclass=groupOfUniqueNames))
ADAM Example: (&(cn=%v)(objectclass=groupOfUniqueNames))
Active Directory Example: (&(cn=%v)(objectClass=group))
LCM admin group
Specify a group name in the user registry that point out the LifeCycle Manager
Administrators group. Members of this group can perform all tasks in LifeCycle
Manager.
LifeCycle Manager must find this group with an LDAP search using the group
search filter.
LCM user group
Specify a group name in the user registry that point out the LifeCycle Manager
user group. Members of this group can log on to LifeCycle Manager.
If this field is left blank, all users in LDAP (that can be found with an LDAP
search) using the user search filter can log on to LifeCycle Manager. LifeCycle
Manager must find this group with an LDAP search using the group search
filter.

M3 Core Installation Planning Guide - Windows | 84


LifeCycle Manager LDAP settings

Appendix B: LifeCycle Manager LDAP settings

LDAP settings are stored in the lcm.properties file, located in the LifeCycle Manager Server installation folder.

LDAP properties
This table shows each property in the LDAP section of the lcm.properties file.

Property Description
ldap.validation LDAP validation enabled/disabled. If set to false, no validation against LDAP
is performed (not recommended for production environments).
Example: true/false
ldap.server.x LDAP server number x
Example:
ldap.company.com

10.20.30.40

ldap.port.x LDAP port for LDAP server number x


Example:
389 (LDAP)

636 (LDAPS)

ldap.bind.user.x Bind user (distinguished name) for LDAP server number x


Example: CN=User,OU=Users,DC=company,DC=com
ldap.bind.password.x Password for the bind user for LDAP server number x. This password will
be automatically encrypted when the LifeCycle Manager Server is started.
Example: password
Note: The bind user password must not end with @.
ldap.ssl.enabled.x SSL (LDAPS) enabled/disabled for LDAP server number x
Example: true / false

M3 Core Installation Planning Guide - Windows | 85


LifeCycle Manager LDAP settings

Property Description
ldap.trust.store Path to Java keystore where the public server certificate of the LDAP server
(or its certificate authority) is stored. Only required if SSL is enabled.
Example
C:\\cert\\keystore.jks

ldap.trust.store.password Password for the Java keystore. Only required if SSL is enabled.
Example: password
Note: The trust store password must not end with @.
ldap.user.prefix The attribute that LifeCycle Manager will use to display the user name of
users in the directory service.
Example
sAMAccountName

cn

displayName

ldap.group.prefix The attribute that LifeCycle Manager will use to display the group name of
groups in the directory service.
Example
sAMAccountName

cn

name

ldap.user.suffix The base distinguished name which indicates the starting point for LDAP
searches of users in the directory service.
Example: OU=Users,DC=company,DC=com
ldap.group.suffix The base distinguished name which indicates the starting point for LDAP
searches of groups in the directory service.
Example: OU=Groups,DC=company,DC=com
ldap.group.member.attr The attribute for groups in the directory service that LifeCycle Manager will
use to determine which users are members of that group.
Example: member
ldap.user.filter LDAP filter that searches the user registry for users.
Example: (&(|(cn=%v)(sAMAccountName=%v))(objectClass=user))
ldap.group.filter LDAP filter that searches the user registry for groups.
Example: (&(cn=%v)(objectClass=group))
ldap.lcm.admin.group The LifeCycle Manager administrators group.
Example: LCMAdmins

M3 Core Installation Planning Guide - Windows | 86


LifeCycle Manager LDAP settings

Property Description
ldap.lcm.user.group The LifeCycle Manager user group. If this property is left blank, all users in
LDAP (that can be found with an LDAP search using the user search filter)
are allowed to log on to LifeCycle Manager.
Example: LCMUsers
ldap.days.before.password The number of days in advance that LifeCycle Manager will warn before the
.expiration password of the LDAP bind user expires. The default is 14 days.
Only used if Active Directory is used.
Example: 14

For more information about changing passwords, see LifeCycle Manager Administration Guide.

Multiple LDAP domain controllers


If you have multiple domain controllers, you can configure a failover solution for LifeCycle Manager. If one of
the servers goes down, LifeCycle Manager will try to contact the other instead.
However, in this version, LifeCycle Manager does not support LDAP validation against multiple domains.
To configure LDAP validation against multiple domain controllers, replace x in the properties described with
a number. The default LDAP server that was configured during the installation of the LifeCycle Manager Server
has number 0. Copy these properties and replace 0 with 1, 2, and 3 and so on.
This is an example:

ldap.server.0=ldap.company.com
ldap.port.0=389
ldap.bind.user.0=CN=User,OU=Users,DC=company,DC=com
ldap.bind.password.0=password
ldap.ssl.enabled.0=false
ldap.server.1=10.20.30.40
ldap.port.1=636
ldap.bind.user.1=CN=User,OU=Users,DC=company,DC=com
ldap.bind.password.1=password
ldap.ssl.enabled.1=true

M3 Core Installation Planning Guide - Windows | 87


M3 Foundation resilience on multiple hosts

Appendix C: M3 Foundation resilience on multiple hosts

The components within an M3 Business Engine installation can be replicated to avoid single points of failure.
In M3 Foundation, the coordinator and transaction server components enable multiple instances to run
simultaneously. These instances run in an active-passive configuration where one instance is active at any
time. This allows for implementing an active-passive high availability configuration. This procedure is intended
for installations running M3 Business Engine on the Windows platform with multiple hosts, enabling
components to be distributed across hosts for resilience.
Note: Only the M3 Business Engine server components (coordinator, transaction server, subsystems and
routers) are considered here, other applications not specifically stated must be considered separately. A
complete design or solution for high availability requires additional investigation.

Configuring M3 Foundation for resilience on multiple hosts


Required setup for this scenario:
• M3 BE Grid must be running on the Windows Platform, deployed on more than one host.
• M3 BE class files installed on the application server must be accessible from all hosts where the M3 BE
Environment is deployed.
• M3 BE subsystem bindings must be configured to run on any of the included hosts.
• A software or hardware network load balancer must be configured in front of the routers on the hosts,
to enable clients to be directed at one single entry point, that routes the traffic that depends on load and
availability.

Creating an Additional M3Coordinator Binding


This component encompasses the Transaction server, and is responsible for both job routing and transactional
lock handling and commit.
The M3Coordinator node is a singleton, that is, only one M3Coordinator node can operate at any time. The
secondary running node takes over if the primary node is unavailable, but the two nodes cannot share the
load.

M3 Core Installation Planning Guide - Windows | 88


M3 Foundation resilience on multiple hosts

Note: The M3UIAdapter connections are routed through the M3Coordinator. If the primary node fails, all
interactive sessions with M3 BE are lost, and the secondary node is available for re-log on.
To create an M3Coordinator binding for an additional host:
1 Right-click your environment and select the task Configure Application.
2 Look in the Bindings list and make a note of which host the M3Coordinator node is running on for later
use.
3 For Grid 11.1.11.0:
Click "+Add Binding"
For Grid 11.1.13.0:
Click "Bindings +Add"
4 Select the NodeType "Coordinator".
5 Type a name for the binding, for example M3Coordinator_2.
6 Specify Min, Initial, Max as 1, and select the alternative host to run on.
7 Click Add Binding.
8 Click Save, and confirm the configuration changes.

Creating an Additional Default Router Node


This component provides the entry point for most of the traffic into the Grid, including providing the HTTP
and HTTPS entry points.
To create an additional default grid router node on another host:
1 Right-click your grid and select the task Configuration Manager.
2 For Grid 11.1.11.0:
Click Routers
For Grid 11.1.13.0:
Click Communication > Routers
3 Make a note of which host the Default Router node is running on for later use.
4 Click "Add Router".
5 Type a name for the router, for example Default_Router_2.
6 Select the host to run the additional default router node on.
7 In the field "External Address", enter the host FQDN or IP address.
8 Enter the same port information and authentication methods as stated on the original Default Router
node.
9 Click "Add".
10 Click Save, and confirm the configuration changes.

M3 Core Installation Planning Guide - Windows | 89


M3 Foundation resilience on multiple hosts

Creating an Additional M3 Router Node


This component provides the entry point for M3-specific connections, including the API ports.
To create an additional M3-specific router node on another host:
1 Right-click your grid and select the task Configuration Manager.
2 For Grid 11.1.11.0:
Click Routers
For Grid 11.1.13.0:
Click Communication > Routers
3 Make a note of which host the M3 Router node is running on for later use.
4 Click "Add Router".
5 Type a name for the router, for example M3Router_2.
6 Select the host to run the additional M3 router node on.
7 Click "Add".
8 Click Save, and confirm the configuration changes.

Creating Additional M3 Connection Dispatchers


To create M3 connection dispatchers for the additional M3 Router node:
1 Right-click your environment and select the task Configure Application.
2 For Grid 11.1.11.0:
Click "+Add Connection Dispatcher"
For Grid 11.1.13.0:
Click "Connection Dispatchers +Add"
3 Select the same "Auth Type" as the existing M3Router "ME" connection dispatcher
4 In "Router", select the newly created M3Router.
5 Select the same port as the original M3Router "ME" connection dispatcher.
6 Repeat the procedure for each of the connection dispatches defined for the original M3Router.
7 Click Save, and confirm the configuration changes.

Configuring the Remote Class File Loader to Run on Either Host


The Remote Class File Loader is responsible for loading the class files when they are requested by an M3
Subsystem node. In these steps we configure the Remote Class File Loader to run on multiple hosts, and
configure M3 Foundation to use a direct file path to bypass the use of the Remote Class File Loader. Due to a
code dependency in M3 Foundation, the Remote Class File Loader is required to run, regardless of if it is used.
The M3 Foundation components depend on the M3 class loader.

M3 Core Installation Planning Guide - Windows | 90


M3 Foundation resilience on multiple hosts

To configure an M3RemoteClassProvider binding:


1 Right-click your environment and select the task Configure Application.
2 Click the "M3RemoteClassProvider" binding.
3 Select the two hosts that are used in the configuration.
4 Click Save Binding.
5 Click Save, and confirm the configuration changes.
Remote file loading must be configured from a shared network location.
By default, the files are loaded from the root file system of the Grid on the host where M3 BE was installed.
In a multi-host configuration, the files must be loaded from a shared network location to ensure that if one
host fails, the others can still operate. Override the default location for the class files in the M3 Subsystem
nodes by bypassing the M3RemoteClassProvider node.
Note: The M3RemoteClassProvider node must still be running, due to a coded dependency.

M3 Core Installation Planning Guide - Windows | 91

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy