Вы находитесь на странице: 1из 242

Infor Operating Service

Administration Guide

Release 12.0.x
Copyright © 2019 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 Operating Service 12.0.x
Publication Date: June 5, 2019
Document code: inforos_12.0.x_inforosag_on-premise_en-us
Contents

Contents

About this guide...............................................................................................................................13


Contacting Infor...............................................................................................................................13
Chapter 1: Infor OS administration.................................................................................................14
Maintaining the database user for SQL server................................................................................14
Changing the database user for ION Grid...................................................................................14
Changing the database user for ION Desk..................................................................................14
Changing the database user for ION Service..............................................................................14
Changing the database user for IDM...........................................................................................15
Changing the account for IFS communication.................................................................................15
Trusting the IFS certificate...............................................................................................................15
Importing the public key...............................................................................................................16
Upgrading the Grid JDK in a single server installation....................................................................16
Upgrading the Grid JDK in a multi-node server installation.............................................................16
Modifying the java heap space........................................................................................................17
Adjusting users for grid authentication............................................................................................17
Scaling and availability....................................................................................................................18
Infor ION Grid applications, bindings, nodes and modules.............................................................18
ION Desk application.......................................................................................................................18
ION Service application...................................................................................................................19
ION Search application...................................................................................................................20
Failover considerations....................................................................................................................20
Adding hosts....................................................................................................................................21
Enabling grid functionality...............................................................................................................21
Adding a custom BOD to the shredder service BOD registry.........................................................22
Updating certificates........................................................................................................................22
Updating the certificates in maintenance mode...........................................................................23
Updating the certificates in the SAML Session Provider..............................................................23

Infor Operating Service Administration Guide | 3


Contents

Changing the domain account password........................................................................................24


Renewing OAuth keys.....................................................................................................................24
Upgrading Windows with Infor OS installed....................................................................................24
Changing the AD FS identity provider used by Infor OS.................................................................25
Further considerations.................................................................................................................26
Promoting an Infor OS secondary node to the primary node..........................................................26
Chapter 2: Infor OS Manager...........................................................................................................28
Starting Infor OS Manager..............................................................................................................28
Login................................................................................................................................................28
Security mode.................................................................................................................................28
Bootstrap.........................................................................................................................................29
Registry...........................................................................................................................................29
Machines.........................................................................................................................................29
Clusters...........................................................................................................................................30
Application containers.....................................................................................................................30
Database instances.........................................................................................................................30
Applications.....................................................................................................................................30
Adding a new application to the Infor OS farm.............................................................................30
Downloading the Relying Party Trust PowerShell script for each application..............................31
System configurations.....................................................................................................................31
Tenant Configuration.......................................................................................................................31
Services...........................................................................................................................................32
Certificate........................................................................................................................................32
CloudSuites.....................................................................................................................................32
Truststore Certificates.....................................................................................................................32
Elastic Search configuration............................................................................................................32
Identity providers.............................................................................................................................32
Enabling Infor Communities.........................................................................................................33
Advance mode................................................................................................................................33
Enabling advance mode features.................................................................................................33
Chapter 3: Infor STS administration...............................................................................................34
STS overview..................................................................................................................................34
Understanding Infor STS process flow with Infor OS...................................................................34
STS Panel page..............................................................................................................................35

Infor Operating Service Administration Guide | 4


Contents

General settings..............................................................................................................................35
Download federated metadata........................................................................................................35
Identity Provider (IdP) connection...................................................................................................36
Creating an IdP connection..........................................................................................................36
Editing an IdP connection............................................................................................................38
Deleting an IdP connection..........................................................................................................38
Authentication store.........................................................................................................................38
Creating an authentication store (LDAP).....................................................................................38
Creating an authentication store (REST).....................................................................................40
Editing an authentication store.....................................................................................................41
Deleting an authentication store..................................................................................................41
Home Realm Discovery settings.....................................................................................................42
Service Provider (SP) connection...................................................................................................42
Creating an SP connection..........................................................................................................42
Editing an SP connection.............................................................................................................43
Deleting an SP connection...........................................................................................................44
Signing certificate............................................................................................................................44
Creating a signing certificate.......................................................................................................44
Activating a signing certificate......................................................................................................45
Deleting a signing certificate........................................................................................................45
General information.........................................................................................................................45
Changing the icon...........................................................................................................................46
Chapter 4: ION administration.........................................................................................................47
Managing queue memory parameters............................................................................................47
Scale out connect nodes.................................................................................................................48
Configure the expected load for the document flow elements.....................................................48
Resource consumption page...........................................................................................................49
Changing the number of connect nodes......................................................................................49
ION statistics widgets......................................................................................................................50
Prerequisite..................................................................................................................................50
Accessing ION statistics widgets.................................................................................................50
Security........................................................................................................................................51
ION widgets overview..................................................................................................................51
Configuring the widget.................................................................................................................52
Collecting ION Grid-related log files................................................................................................53

Infor Operating Service Administration Guide | 5


Contents

Log file collector...........................................................................................................................53


Programmatic upload of ION models (content)...............................................................................54
Upgrade instructions for custom email templates............................................................................54
Backing up the customized email templates................................................................................54
Redeploying your customized email templates............................................................................54
Chapter 5: Infor Ming.le administration.........................................................................................55
Admin Settings................................................................................................................................55
Manage Applications....................................................................................................................56
Manage Context/Utility Apps........................................................................................................67
General Settings..........................................................................................................................72
User Management...........................................................................................................................76
Manage Users.................................................................................................................................80
Users............................................................................................................................................80
External users..............................................................................................................................90
Client Access...............................................................................................................................92
Service Accounts.........................................................................................................................92
SCIM Accounts............................................................................................................................93
ERP Person IDs...........................................................................................................................94
Contacts.......................................................................................................................................95
Contact Groups............................................................................................................................96
Groups.........................................................................................................................................98
SCIM Groups.............................................................................................................................101
Identity Repository Groups........................................................................................................102
Security Roles............................................................................................................................103
Accounting Entities....................................................................................................................112
Locations....................................................................................................................................114
Document Authorizations...........................................................................................................115
Authorization Claim Values........................................................................................................116
Identity Repositories..................................................................................................................117
IFS ION-Person ID.....................................................................................................................119
Session Configuration................................................................................................................120
External Users...........................................................................................................................120
Settings > General Settings.......................................................................................................121
User Properties..........................................................................................................................123
Applications................................................................................................................................125

Infor Operating Service Administration Guide | 6


Contents

Data Management.........................................................................................................................125
Accessing the Data Management window.................................................................................125
Chapter 6: Homepages administration.........................................................................................127
Working with the Administration tool.............................................................................................127
Accessing the Administration tool..............................................................................................128
Working with settings....................................................................................................................128
Common settings.......................................................................................................................129
Page settings.............................................................................................................................130
Widget settings..........................................................................................................................131
Feature settings.........................................................................................................................132
Changing a setting.....................................................................................................................132
Adding a settings rule................................................................................................................133
Changing a setting rule..............................................................................................................134
Removing a setting rule.............................................................................................................134
Changing the order of setting rules............................................................................................134
Working with properties.................................................................................................................135
Adding a property......................................................................................................................135
Setting a mandatory page.............................................................................................................136
Setting an effective date range for a mandatory page...............................................................136
Identifying a mandatory page as a primary page.......................................................................136
Working with private pages...........................................................................................................137
Working with published pages.......................................................................................................137
Locating published pages..........................................................................................................139
Working with page permissions.................................................................................................140
Understanding permissions for pages.......................................................................................141
Locating the page ID for a page.................................................................................................142
Working with standard pages........................................................................................................142
Working with featured pages.........................................................................................................143
Viewing all featured pages.........................................................................................................144
Adding a page to featured pages...............................................................................................144
Removing a page from featured pages......................................................................................144
Working with Start Experience configuration.................................................................................145
Working with published widgets....................................................................................................146
Locating published widgets........................................................................................................147
Locating the widget ID of a widget.............................................................................................148

Infor Operating Service Administration Guide | 7


Contents

Working with widget permissions...............................................................................................149


Understanding permissions for widgets.....................................................................................150
Working with standard widgets......................................................................................................150
Working with featured widgets.......................................................................................................152
Viewing all featured widgets.......................................................................................................152
Adding a widget to featured widgets..........................................................................................153
Removing a widget from featured widgets.................................................................................153
Removing a widget from featured widgets in the administration tool.........................................153
Working with featured banner widgets..........................................................................................154
Working with tags..........................................................................................................................154
Working with Export......................................................................................................................155
Exporting homepages data........................................................................................................156
Working with Import.......................................................................................................................156
Importing homepages data........................................................................................................157
On-premises widget installation and upgrade...............................................................................157
Reference......................................................................................................................................158
Concepts....................................................................................................................................158
Chapter 7: IDM administration.......................................................................................................160
Starting and Stopping Infor Document Management....................................................................160
Starting and Stopping Infor Document Management Server.....................................................161
Starting and Stopping Infor Document Management StreamServe Adapter.............................161
Exporting and importing Infor Grid system settings...................................................................161
Infor Document Management Client Interface...............................................................................162
Client Configuration and Access................................................................................................162
Infor Document Management Client Features...........................................................................163
Infor Smart Office and Infor Document Management....................................................................167
Infor Document Management Maintenance..................................................................................167
Prerequisites..............................................................................................................................167
Roles..........................................................................................................................................167
Authorization using IFS..............................................................................................................168
Output Files................................................................................................................................169
Maintaining Data Models...........................................................................................................169
Attributes....................................................................................................................................169
Document Types........................................................................................................................170
Backup.......................................................................................................................................170

Infor Operating Service Administration Guide | 8


Contents

Data Migration............................................................................................................................170
Performance...............................................................................................................................172
Configuring Infor Document Management Server.....................................................................172
Configuring Event Hub Subscription..........................................................................................173
Configuring Infor Document Management Contextual Application for Ming.le...........................175
Filtering Available Document Types...........................................................................................176
Auditing in IDM...........................................................................................................................176
Creating read-only user access to IDM......................................................................................176
Infor Document Management Resource Server............................................................................177
Maintaining Conversion Types...................................................................................................177
Infor Document Management Control Center................................................................................178
Access Point..............................................................................................................................178
Information.................................................................................................................................178
Administration............................................................................................................................179
Tools...........................................................................................................................................196
Development..............................................................................................................................197
System Health............................................................................................................................197
User Roles.................................................................................................................................198
Synchronize Data Model............................................................................................................198
Document Output.......................................................................................................................199
Infor ION and Infor Document Management.................................................................................199
ION Configuration......................................................................................................................199
Appendix A: Microsoft SharePoint maintenance for IDM...........................................................201
Prerequisites.................................................................................................................................201
Document Library..........................................................................................................................201
Importing a document type to SharePoint.....................................................................................201
Adding a document type to SharePoint.........................................................................................202
Adding an attribute to a document type in SharePoint..................................................................202
Deleting an attribute from a document type in SharePoint............................................................203
Deleting a document type in SharePoint.......................................................................................203
Exporting a document type in SharePoint.....................................................................................203
Enabling templates........................................................................................................................204
Translating the columns of a document type in SharePoint...........................................................204
Creating Access Control Lists in SharePoint.................................................................................204
For SharePoint 2010..................................................................................................................205

Infor Operating Service Administration Guide | 9


Contents

For SharePoint 2013..................................................................................................................205


Appendix B: IBM DB2 Content Manager maintenance for IDM..................................................206
Prerequisites.................................................................................................................................206
Starting the application..............................................................................................................206
Creating an attribute......................................................................................................................206
Deleting an attribute......................................................................................................................207
Creating an item type....................................................................................................................207
Configuring an item type for free text search.................................................................................208
New Item Type Definition...............................................................................................................209
Using the Access Control Tab.......................................................................................................210
Using the Attributes Tab................................................................................................................210
Using the Auto-Linking Tab............................................................................................................211
Using the Foreign Keys Tab...........................................................................................................211
Using the Logging Tab...................................................................................................................212
Using the Document Management Tab.........................................................................................212
Using the User Exits Tab...............................................................................................................213
Saving or Cancelling an Item Type................................................................................................213
Deleting an Item Type....................................................................................................................213
Enabling templates........................................................................................................................214
MIME Types...................................................................................................................................214
Defining a MIME Type................................................................................................................215
Deleting a MIME Type................................................................................................................215
Languages.....................................................................................................................................215
Creating the Language and Language Code.............................................................................216
Translating Data Models................................................................................................................216
Translating Item Type.................................................................................................................216
Translating Child Components...................................................................................................217
Translating Regular Attributes....................................................................................................217
Translating Attribute Groups......................................................................................................217
Translating Link Types................................................................................................................218
Translating MIME Types.............................................................................................................218
Backing up Files in IBM DB2 Content Manager............................................................................218
Performance..................................................................................................................................219
Authentication................................................................................................................................219
Authorization.................................................................................................................................219

Infor Operating Service Administration Guide | 10


Contents

Creating an Access Control List.................................................................................................220


Importing a document type to IBM DB2 Content Manager...........................................................220
Appendix C: Document Links........................................................................................................221
Creating Document Links..............................................................................................................221
Appendix D: Archiving M3 BE Output..........................................................................................222
Knowledge prerequisites...............................................................................................................222
System requirements....................................................................................................................222
Process overview..........................................................................................................................223
Downloading files..........................................................................................................................223
Configuring your global project......................................................................................................223
Importing new files.....................................................................................................................223
Configuring DAFSettings.tbl.......................................................................................................224
Setting the Synchronous mode in OpenText StreamServe Persuasion.....................................224
Configuring your layouts for archiving...........................................................................................224
Adding function calls..................................................................................................................224
Editing processes.......................................................................................................................225
Changing the runtime.................................................................................................................225
Editing DAF.fcn...........................................................................................................................226
Configuring DAFKeys.tbl............................................................................................................226
Activating output to IDM................................................................................................................227
Activating archiving....................................................................................................................227
Appendix E: Restoring Redis functionality..................................................................................228

Appendix F: Elastic Search............................................................................................................229


Infor Search Configuration Service...............................................................................................229
Infor Search Indexing Service.......................................................................................................229
Infor Search Search Service.........................................................................................................230
Infor Search Scheduler Service.....................................................................................................230
Infor Search Streaming Service....................................................................................................230
Objective........................................................................................................................................230
Homepages widgets......................................................................................................................230
Elasticsearch Health Status widget............................................................................................231
Application/Index Statistics widget.............................................................................................231
Error codes....................................................................................................................................232
Configuration errors...................................................................................................................232

Infor Operating Service Administration Guide | 11


Contents

Indexing errors...........................................................................................................................234
Search errors.............................................................................................................................235
Common errors..........................................................................................................................237
OneView general functionality.......................................................................................................240
Creating indexes........................................................................................................................240
Indexing new objects..................................................................................................................240
Purging OneView data...............................................................................................................241
Troubleshooting..........................................................................................................................241

Infor Operating Service Administration Guide | 12


About this guide

About this guide

This guide describes the administration tasks to set up and maintain the Infor Operating Service in
accordance with the Infor Best Practice approach, which when followed ensures that you set up a
stable, easily maintainable and supportable Infor OS.

Intended audience
This guide is for professional services or system administrators who configure and maintain the system.

Locating product documents


You can find the documents in the product documentation section of the Infor Xtreme Support portal,
as described in "Contacting Infor."

Contacting Infor
If you have questions about Infor products, go to Infor Concierge at https://concierge.infor.com/ and
create a support incident.
If we update this document after the product release, we will post the new version on the Infor Support
Portal. To access documentation, select Search > Browse Documentation. We recommend that you
check this portal periodically for updated documentation.
If you have comments about Infor documentation, contact documentation@infor.com.

Infor Operating Service Administration Guide | 13


Infor OS administration

Chapter 1: Infor OS administration

Maintaining the database user for SQL server


You can maintain the sql database user for these resources:
• Grid Service
• ION Desk
• ION Service
• IDM

Changing the database user for ION Grid


You can find the instructions for Grid Service in the Infor ION Grid Administration Guide. See the
"Changing the Database User for the Grid" section.

Changing the database user for ION Desk


Complete these steps:
1 Open Infor ION Grid Management Pages > Applications.
2 Select IONDesk.
3 Open the menu and select Properties.
4 For ion.desk.db, change these properties:
• Desk database user name
• Desk database password
5 Click Update Property.
6 Restart the DeskNode.

Changing the database user for ION Service


Complete these steps:

Infor Operating Service Administration Guide | 14


Infor OS administration

1 Open Infor ION Grid Management Pages > Applications.


2 Select IONService application.
3 Open the menu and select Properties
4 For ion.service.db.properties, change these properties:
• Ion.persist.database.username
• Ion.persist.database.password
5 Click Update Property.

Changing the database user for IDM


1 Open Infor Grid Management Pages > Applications.
2 Select DocumentArchive.
3 Open the menu and select Properties.
4 For ION adapter, change these properties:
• Database user
• Database password
5 Click Update Property.

Changing the account for IFS communication


To change the service account as used by ION Service:
1 Open Infor ION Grid Management Pages > Applications.
2 Select IONService.
3 Click Management Pages.
4 Make the required changes to the Username and Password.
5 Save the changes.

Trusting the IFS certificate


If IFS communication is SSL based, a https binding is used, ensure the IFS SSL certificate is trusted
by ION.
If the IFS certificate is signed by a certificate authority standard trusted by the Java JDK, used for this
ION installation, you do not need to import the certificate. ION supports the use of a wild card certificate
at the IFS side.

Infor Operating Service Administration Guide | 15


Infor OS administration

Importing the public key


To import the public key of that SSL certificate, or the public key of the CA root certificate:
1 Select Infor Grid Management Pages > Applications.
2 Select IONService.
3 Click Management Pages.
4 Click Import Attribute Service Certificate.
5 Select a file and click Import.

Upgrading the Grid JDK in a single server installation


To update the JDK in a single server installation:
1 Make sure that the new JDK is installed.
2 Stop the grid.
3 Open the Command Prompt.
4 Change the directory to grid_root_installation_path\bin
5 Execute changejdk with the file path to the new JDK as the parameter. For example: changejdk
"c:\program files\java\[newjdk]"
6 Restart the grid.

Upgrading the Grid JDK in a multi-node server


installation
To update the JDK in a multi-node server installation:
1 Make sure that the new JDK is installed.
2 Stop the grid.
3 Open the Command Prompt.
4 Change the directory to grid_root_installation_path\bin
5 Execute changejdk with the file path to the new JDK as the parameter. For example: changejdk
"c:\program files\java\[newjdk]"
Repeat all of the preceding steps for all hosts before you continue with the next step.
6 Restart the grid on all hosts.

Infor Operating Service Administration Guide | 16


Infor OS administration

Modifying the java heap space


The Infor ION Grid applications consist of one or more nodes. Each node or JVM has assigned a default
heap size, which is based on common usage scenarios. You can adjustment the heap size if required.
To change the heap size of the nodes:
1 Select Infor ION Grid Management Pages > Applications.
2 Select the application which node or nodes you want to adjust, for example ION Service
3 Click Properties
4 Search for the property Node Memory > Max Heap.
5 Change the value of the Max Heap for the required node type.
Note: If you must set a Max Heap on node instance level, you must change the Display Complexity
to All. Currently, there are no known reasons to set a MAX Heap on instance level.
6 Save the changes.
7 Click Update Property.
8 Select Nodes.
9 Restart the related nodes.

Adjusting users for grid authentication


For the SAML Session Provider the name of the grid principal user is identified differently than for the
Windows Session Provider. In the context of an ION deployment, the SAML Session Provider uses
the identity2 claim to identify a user. For that reason you can adjust the grid-admin assignment definitions.
To adjust the grid-admin assignment definitions:
1 Open the Grid Management UI.
You probably must use the Grid AdminUI.cmd command to have authorizations to make changes.
2 Select Configuration Manager > Security > User Configuration > User and Role Mappings.
3 Verify if the users assigned to Roles are defined based on identity2.

Infor Operating Service Administration Guide | 17


Infor OS administration

Scaling and availability

Infor ION Grid applications, bindings, nodes and


modules
After the installation the Infor ION Grid contains several applications. The Infor ION Grid Management
Pages display these applications:
• ION Desk
• ION Service
• WindowsSessionProvider or SAMLSessionProvider
Each application consists of modules and nodes.
• A Module is a software component that provides functionality.
• A NodeType is a definition of one or more modules
• A NodeInstance (or Node) is an instantiation of a NodeType in a JVM.
• A Binding specifies for a NodeType how many instances must be available and at which hosts these
instances can be deployed.

ION Desk application


Functionality
The ION Desk grid application implements the ION Desk UI, including Navigation, Modeling pages,
Manage pages, the OneView UI and the ION Desk authorization pages.
The ION Desk Node is horizontally scalable. The ION Desk application is not expected to use many
system resources. A limited number of users will access ION Desk. The ION Desk node is by default
deployed at each Web Front.

Type
Web Front End

Nodes
ION Desk deploys a single Node, which binding is called DeskNode.

Infor Operating Service Administration Guide | 18


Infor OS administration

ION Service application


Functionality
The ION Service grid application is the core of the ION application. It is the server for the ION Desk
and Activities (Pulse) API and implements the BOD processing for Connect, Workflow and Event
Management.

Type
Backend

Nodes
Coordinator
Available only in the "ION full" edition, the coordinator node arranges the connect related
communication between ION Desk and ION Service. Among activation and deactivation of document
flows the coordinator will (re)distribute the document flow elements over the available connect
nodes. For the Coordinator node there is always a single instance. This node not expected to use
many resources.

Queue
Available only in the "ION full" edition, the Queue node manages the internal queues of ION. For
the Queue node there is always a single instance.
Resource usage is in memory and communication with the other nodes and the database.

JMSQueue
Available only in the "ION full" edition, this Node is instantiated on the host for which a JMS provider
is configured and the Queue node is not running. The JMSQueue can be instantiated once per
host.

Connect
Available only in the "ION full" edition, the Connect node deploys the document flow elements.
Multiple instances of the connect node can be configured, allowing distribution of document flow
elements over multiple connect node instances and with that over multiple hosts. For details see
"Scale out connect nodes." This node requires more resources.

Process
Available only in the "ION full" edition, the Process node arranges the processing of BODs for Event
management, Workflow and Pulse. The Process node always has a single instance. This node
requires more resources.

PulseAPI
Available only in the "ION full" edition, the PulseAPI node exposes the Pulse API. The PulseAPI
node always has a single instance.

ActivityDeck
Available only in the "ION full" edition, the ActivityDeck node is the server handling the read requests
from Pulse API . The ActivityDeck node always has a single instance.

Infor Operating Service Administration Guide | 19


Infor OS administration

OneViewEvent
Available only in the "ION full" edition, this node integrates with the ION Search application executing
search queries on the search engine.

OneViewApi
Available only in the "ION full" edition, this node integrates with the ION Search application registering
new events in the search engine

OneView
Available only in the "ION full" edition, this node integrates with the ION Search application both
registering new events in the search engine as well as executing search queries on the search
engine.

IONService
Only available in the "ION Embedded" edition, this node includes the ION backend functionality
except the handling of OneView events.The IONService node always has a single instance.

ION Search application


Functionality
The ION Search application provides the search engine used by ION OneView using Solr technology.
Type
Backend
Nodes
Deploys a single Node, which binding is called SolrWrapperNode.

Failover considerations
The Grid takes care of distributing the nodes of a grid application over the available hosts for that
application. The bindings of each node define how many instances of the node are expected to run.
When one of the hosts fails in a multiple hosts setup for the Infor ION Grid assigned to for example the
IONService application, the Grid ensures that nodes that were running on that host automatically are
started on another host. Downtime will be limited for the time the grid identifies the failure and start
time of the (ION) nodes. If you like to have a predefined distribution of the nodes over the hosts, you
can make use of the ‘preferred host’ option on the Grid binding to have a default distribution while
remaining to have the full fail-over capabilities.
Failover of Grid components See "Disaster Recovery" in the Infor ION Grid Administration Guide .
Grid components

Infor Operating Service Administration Guide | 20


Infor OS administration

For more details on the core Grid components like bootstrap service, Grid Routers, SessionProviders
see the Infor ION Grid Administration Guide.
Infor ION Grid scaling considerations
You can scale out by adding hosts to the Infor OS deployment. The Infor ION Grid takes care of
distributing the nodes of the applications over the available hosts for these applications.
Scaling is used for both availability and performance reasons. Use the grid counters to verify if your
current deployment is reaching the limits of the system resources.
For details, see "Monitoring the Grid" in the Infor ION Grid Administration Guide.

Adding hosts
For instructions on how to add a host, see the "Adding a node to your Infor OS farm" appendix in the
Infor Operating Service Installation Guide.

Enabling grid functionality


This section is applicable for both first-time users of ION 12.0 with a full use license as well as existing
customers who upgrade from any of the ION 11.1 Grid editions.
The base ION 12.0 environment installed using the Infor OS installer does not support the additional
ION grid functionality of scalability and availability. To enable these features you must execute a
separate add-on installer.
Ensure that a base ION 12.0 environment is available and take these steps:
1 Navigate to the folder where Infor_ION_Grid_Enablement_12.0_install.jar is present.
2 Double-click Infor_ION_Grid_Enablement_12.0_install.jar. The Welcome screen is displayed.
3 Click Next. The Grid installation directoryscreen is displayed.
4 Provide the value of the Grid installation directory. Select a valid ION grid installation folder where
ION is already installed.
5 Click Next. The ION Grid enablement installer checks for the availability of ION.
If an existing ION 12.0 installation cannot be found, this message is displayed: An ION
installation cannot be found. Select a valid ION Grid installation
directory.If there is an existing ION 12.0 installation on the server, this message is displayed:
This installer enables Grid functionality to scale your ION installation.
6 Click OK to proceed further, or click Cancel to return to the same page.
7 Click Install to start the installation. A progress dialog shows the result of the installation.
The installer checks at the end of the installation for the status of the ION application. If it takes too
long for the application to start the installer automatically attempts up to 10 times to retrieve the

Infor Operating Service Administration Guide | 21


Infor OS administration

status. If the final status is still not known, the installer finishes and displays the actual status at that
point in time.
When the installation finishes, a message displays informing you the ION grid enablement installation
has succeeded or failed.
The final results of the installation are logged in the log file. This file is stored in the folder: %Program
Data%\Infor\ION\installlog.
For example: C:\ProgramData\Infor\ION\installlog\GridEdition-Installer-
<timestamp>.log
8 Click Done to close the installer.

Adding a custom BOD to the shredder service BOD


registry
This task is necessary only if you use an Infor core application that supports custom BODs. See the
documentation related to the Infor core applications that you are integrating with Infor Ming.le to
determine if this task must be completed. If this task is not completed, Infor Ming.le cannot handle and
provide information in its user interface related to any custom BODs.
Custom BODs are delivered as part of content packs specific to some Infor applications and are defined
by Infor consultants or customers. Refer to documentation provided by the Infor application being
integrated with Infor Ming.le or contact the Infor consultant for your installation to determine if you must
generate these custom files and, if so, for which "NounNames."
To add a custom BOD to the shredder service BOD registry:
1 Log in to the Infor Ming.le server.
2 Open the folder: C:\Program Files\Infor\OS\Services\ShredderService\xml.
3 Copy an existing XML document and rename it to the custom BOD name.
4 In the XML document you just created, change the NounName to the custom BOD name. Also,
change all instances of the XPath, which is defined in the metadata xml, so that they match the
actual BOD xml.
5 Restart the Infor Ming.le shredder service in Windows Services.
6 Configure the authorization for the custom BOD by following the instructions in Document
Authorizations on page 115.

Updating certificates
Certificates used in Infor OS can be updated through the Infor OS Installer in maintenance mode.

Infor Operating Service Administration Guide | 22


Infor OS administration

Updating the certificates in maintenance mode


1 Open the command prompt as an administrator.
2 Navigate to the path where the already installed Infor OS setup is available.
3 Type this command: setup.exe -v"CERTIFICATEUPDATE=true". Make sure that there is no
space between -v and “CERTIFICATEUPDATE=true”
4 Select the maintenance mode option.
5 On the Certificate Update screen, add the Front-end, Back-end, and IONAPI related certificates
along with a valid password.
6 Continue with the rest of the maintenance installer and finish the maintenance installation.

Updating the certificates in the SAML Session Provider


After the installer has finished, the certificates must be updated in the SAML Session Provider.

Method 1 – AdminUIClassic.cmd
1 Go to the <InstallDir>/InforTechstackGrid/bin/ folder and select AdminUIClassic.
cmd.
2 Open Grid > Applications > SAMLSessionProvide > Management Pages > SAML Session
Provider Trust Stores.
3 Click Update Certificate.
4 After the certificates are updated, restart the SAML session provider.
5 After all the steps are done, open the portal and verify whether all the applications are loading without
issues.

Method 2 – AdminUI.cmd
1 Go to the <InstallDir>/InforTechstackGrid/bin/ folder and select AdminUI.cmd.
2 Go to Applications > SAMLSessionProvider > Management Pages > SAML Session Provider
Trust Stores.
3 Click Update Certificate.
4 After the certificates are updated, restart the SAML session provider.
5 After all the steps are done, open the portal and verify whether all the applications are loading without
issues.

Infor Operating Service Administration Guide | 23


Infor OS administration

Changing the domain account password


Changing the password of the Domain Account can be done in either an upgrade or maintenance
mode.
To change the password:
1 Open the command prompt as an administrator.
2 Navigate to the path where the already installed Infor OS setup is available.
3 Type this command: setup.exe -v"IFSUSERPWDUPDATE=true". Make sure that there is no
space between -v and "IFSUSERPWDUPDATE=true"
4 Select the maintenance mode option.
5 On the Update Password screen, enter the new password for the domain account.
6 Continue with the rest of the maintenance installer and finish the maintenance installation.

Renewing OAuth keys


OAuth keys can be renewed by running the Infor OS Installer in maintenance mode:
1 Start the installer through the command prompt with this parameter: v”RENEWGRIDOAU
THKEYS=TRUE”
2 Select the Modify option and click Next.
3 On the Choose Destination screen click Next.
4 On the Farm Database Configuration screen enter the database password and click Next.
5 Click Install.
6 To verify that the OAuth key has been renewed:
a Access the Grid by going to <InstallDir>/InforTechstackGrid/bin/ folder and
selecting AdminUI.cmd.
b Click the Security tab.
c Click the OAuth Credentials tab.
d Check to see that the created value has been updated.

Upgrading Windows with Infor OS installed


Infor does not recommend and cannot support in-place upgrades of Windows OS with Infor OS installed.
If you must up-version the operating system, we recommend that you provision a new server to host
Infor OS and expand your existing farm. Once complete, you will be able to decommission your old
server.
Prerequisite: Infor OS must be installed using an alias.

Infor Operating Service Administration Guide | 24


Infor OS administration

Recommended steps:
1 Provision a new server to host Infor OS.
2 Install Infor OS on the new server pointing at the existing installation.
3 Promote the new server to the primary Infor OS node.
4 Uninstall Infor OS from the original server.

Changing the AD FS identity provider used by Infor


OS
This process is for configuring a new AD FS Identity Provider to be used by Infor OS.
1 Obtain the Federation Metadata XML from your new AD FS farm:
https://{AD FS Farm}/FederationMetadata/2007-06/FederationMetadata.xml
2 Log in to Infor OS Manager.
3 Navigate to Identity Providers.
4 Click the add (+) button.
5 Provide these details:
Provider
Select the AD FS version that matches your new AD FS farm.

Provider Name
Provide a short description of your AD FS farm.

Import SAML Metadata


Import from file.

6 Click the browse button (...) and select the metadata XML file obtained in step 1.
7 Click Load.
8 Click Save.
9 Navigate to the Infor OS (FARM NAME) on the Infor OS Manager menu.
10 Change the identity provider to the newly created one.
11 Click Save. You are prompted to restart Infor OS Manager.
12 Log in to Infor OS Manager again.
13 Navigate to the Infor OS (FARM NAME) on the Infor OS Manager menu.
14 Select Redeploy SAML Session Provider.
15 Provide these details:
Identity Provider
Specify the new provider created in the previous steps.

IFS User
This is the IFS bootstrap user (pre-populated).

Infor Operating Service Administration Guide | 25


Infor OS administration

Password
Specify the password of your IFS bootstrap user.

16 Click OK.
17 Navigate to Identity Providers.
18 Download the PowerShell script associated with your newly created provider.
19 Navigate to Applications.
20 Download the PowerShell scripts associated with Grid-XiPlatform-<n>, INFORSTS, and XIPORTAL.
21 Run the downloaded scripts on your AD FS farm.
22 Restart your Infor OS farm.

Further considerations
If you have other applications configured for claims-based authentication, you must reconfigure them
for the new AD FS farm.
For details, see the relevant product documentation.

Promoting an Infor OS secondary node to the primary


node
In case the primary node fails, complete this task to promote a secondary node to take over primary
node role:
1 Log in to the server of the secondary node that will take the primary node role.
2 Check to see if the Infor Federation Services Timer Service, Infor Ming.le GraphDB Service, and
Infor Ming.le Shredder Service windows services are set to automatic start-up.
Access the Services application, find the services in the list, and check what the value is in the
Startup Type column. If the value is not Automatic:
a Select the service in the list.
b Click Restart Service.
c In the pop up, change the Startup type to Automatic.
d Click Apply.
3 Make sure that the Infor Federation Services Timer Service, Infor Ming.le GraphDB Service, and
Infor Ming.le Shredder Service Windows services have been started. If they are stopped:
a Select the service in the list.
b Click Start Service.
4 Run the Infor Redis Tool (Infor.Redis.exe):

Infor Operating Service Administration Guide | 26


Infor OS administration

a Access the Infor.Redis.Tool located in <InforOS root folder>\InstallGridHelper\In


for.Redis.Tool
b Input the Farm Database Host.
c Input the port number that the database uses.
d Input the Farm Database instance. If the default instance is used, no value is needed.
e Input the Farm Database name.
f Input the Farm Database user.
g Input the Farm Database user’s password.
h Run the Redis Tool.
5 Restart the Infor Ming.le Cache Service:
a In the Windows Services application, find the Infor Ming.le Cache Service in the list.
b Click Restart Service.
6 Access Infor ION Grid Manager.
7 Navigate to Applications.
8 Repeat these steps for all bindings for DataCatalog, DocumentArchive, IONProcess, IONSearch,
and Task Viewer:
a Select the Application.
b Click the list menu and select Bindings.
c Select Edit on the Node bindings.
d On the edit screen, select all for Hosts and select Global for Constraint.
9 Scale out the WindowsSessionProvider or the Task Viewer application:
a Select the application from the Applications tab.
b From the list menu select Deployment.
c Select Scale Out.
d Select the new Primary Host.
e Click Apply.
10 Log into Infor OS Portal.
11 Go to Admin Settings > General Settings.
12 Modify IFS Timer Service URL to match your new Primary Host to
tcp://<newHost>:<Port>/QuartzScheduler
For example, if the new Primary Host is InforOS2.domain.com and the IFS Timer Service runs on
port 555, the URL will be tcp://InforOS2.domain.com:555/QuartzScheduler
13 Click Save.
14 Restart the server.

Infor Operating Service Administration Guide | 27


Infor OS Manager

Chapter 2: Infor OS Manager

Starting Infor OS Manager


To start the Infor OS Manager, double click the Infor OS Manager icon on the desktop or navigate to
this folder and run the InforOSManager.exe file:
{Installation Folder}\OS\InforOSManager\InforOSManager.exe
If you have a need to run the Infor OS Manager in advanced mode, see Advance mode on page 33.

Login
To log into Infor OS Manager:
1 On the Infor OS Server, open Infor OS Manager by right-clicking the desktop icon and select Run
as Administrator.
2 Provide the Database Server. In the Database Server field provide the Host Name of Fully Qualified
Domain Name (FQDN) of the SQL Server.
3 Select the Database Type. The default type is SQL Server.
4 Provide the Port for the SQL Server.
5 Select the Authentication Mode. The default mode is SQL Server Authentication.
6 Provide the database system administrator's User Login.
7 Provide the database system administrator's Password.
8 Click the check mark icon to validate credentials and query what Infor OS farms are available.
9 When the validation is successful, select the Infor OS Farm. For example, InforOSFarm
10 Click Continue.

Security mode
Use the Redeploy SAML Session Provider option for these reasons.
• The Identity Provider/ADFS Signing certificate changed.

Infor Operating Service Administration Guide | 28


Infor OS Manager

• The Grid SAML Session Provider failed during the installation.

Bootstrap
You normally perform the bootstrap of the administrator user when you do the installation.
If the bootstrap process is successful during installation, this page is read only and displays the first
10 users in the system.
If the bootstrap process failed during installation, you can perform the bootstrap from this page. Use
the Bootstrap User option.

Registry
The Infor OS installer places the default registry metadata into a Registry database but shows the files
and schema version for the Registry contents on this page. If there is an update to the content that
does not require an upgrade of the Infor OS, you can add an Infor-provided registry content zip file to
this page.
To update the Registry content metadata:
1 Click Add.
2 On the Add Registry pop-up:
a Select the File Name. Browse to the Registry zip file.
b Select the application type:
• Infor Ming.le
• ION API
• Homepages Widgets

3 Click Upload. The new metadata is loaded to the Registry database, and the new content is available
in your Infor OS.

Machines
The Machines page lists the different servers where Infor OS is installed for this farm.

Infor Operating Service Administration Guide | 29


Infor OS Manager

Clusters
The Clusters page lists the different clusters of Infor OS that have been installed for this farm.

Application containers
The Application Containers page lists the different application containers of Infor OS that have been
installed for this farm.

Database instances
The Database Instances page lists the different database instances of Infor OS that have been installed
for this farm.

Applications
The Applications page lists the different applications that have been installed for this farm. You use
the Applications page to add new applications to the Infor OS farm and to download the Relying Party
Trust PowerShell script for each application.

Adding a new application to the Infor OS farm


Note: This task only adds an application to the Infor OS Manager to help you create a Relying Party
Trust PowerShell script. You must also add your application to the Infor Ming.le portal from Admin
Settings. For instructions, see Manage Applications on page 56.
1 To add a new application to the Infor OS farm, click Add and provide this information:
Application Name
Used only in the Infor OS Manager.

Description
Used only in the Infor OS Manager.

Select Application Type


This determines the set of claims your application will receive from the Federation Server.

Infor Operating Service Administration Guide | 30


Infor OS Manager

Relying Party Identifier


The identifier of the Relying Party Trust that will be created.

SSO URL
The Single Sign On URL specific to the application you are adding.

SLO URL
The Single Sign Out URL specific to the application you are adding.

Signing Certificate

2 Click Save to add the new application.

Downloading the Relying Party Trust PowerShell script for


each application
To download the Relying Party Trust PowerShell script for each application, select the download icon
for each application and browse to the download path. These PowerShell scripts must be executed in
your Federation Server. See the AD FS server configuration below.
Note: By default, the Infor OS installation creates XIPORTAL, INFORSTS and Grid-XiPlatform
applications. These PowerShell scripts should have been downloaded and executed in your Federation
(AD FS) server at the time of installation. See the Infor Operating Service Installation Guide, Version
12.0.x, for more information.

System configurations
The System Configurations page displays the System Configuration table from the Infor OS Farm
database.
Caution: This page runs the entire Infor OS configuration. Edits to this page should be undertaken
with the utmost care.

Tenant Configuration
The Tenant Configuration page shows the infrastructure-related settings for this system.

Infor Operating Service Administration Guide | 31


Infor OS Manager

Services
The Services page is a read-only page that lists the different web services that are available for this
Infor OS farm.

Certificate
The Certificate page shows a list of all certificates used in Infor OS. To update certificates, see Updating
certificates on page 22.

CloudSuites
In a single tenant cloud environment, this CloudSuites page is used to show the CloudSuite information
for the system.

Truststore Certificates
From the Truststore Certificates page, certificates can be uploaded to instruct ION API to trust any
infrastructure that uses these tickets.

Elastic Search configuration


Use the Elastic Search Configuration screen to update the Elastic Search YML file so that each
Elasticsearch node can discover one other after a node has been added. To do this, click Update ES
YML File.

Identity providers
The Identity Providers page displays the identity provider created during the installation.
If an identity provider has been added or updated, you can download the PowerShell script associated
with this identity provider by clicking the download icon and specifying the download path.

Infor Operating Service Administration Guide | 32


Infor OS Manager

Enabling Infor Communities


To enable Infor Communities (External Users – id.infor.com):
1 To create an Id.infor.com Idp while saving the IdentityProvider, select Id.Infor.Com from the
Provider drop-down list.
2 From here, you must get the metadata from the external communities SSO (PingFederate) to import:
a Click the download icon to download the Claims Provider Trust script (CPT).
b Download the Id.infor.com CPT script for external communities. To do so, right-click and select
Download Idp.infor.com.
c Run this ps in your ADFS server.

Advance mode
To run the Infor OS Manager in advance mode, you must run the InforOSManager.exe from a command
prompt with the advancemode parameter.
This parameter enables the user to edit machines, clusters, application containers, and database
instances, and system configurations.

Enabling advance mode features


To enable the advance mode features:
1 Open the command prompt.
2 Type: cd [drive]:\Program Files\Infor\OS\InforOSManager
3 Press Enter.
4 Type: InforOSManager.exe advancemode=true
5 Press Enter.
6 Log in to the Infor OS Manager to verify the advance mode features.

Infor Operating Service Administration Guide | 33


Infor STS administration

Chapter 3: Infor STS administration

STS overview
Infor STS facilitates and provides standards-based single sign-on (SSO) services to users of Infor
business applications when federated with an identity provider such as Microsoft Active Directory
Federation Services (ADFS) and/or an LDAP (Lightweight Directory Access Protocol) service such as
Microsoft Active Directory (MS AD).
Infor STS is a web-based service and supports the Security Assertion Markup Language (SAML) and
WS-Federation protocol standards for providing browser-based single sign-on to users of Infor
applications. When the Infor STS is configured with multiple external identity providers (IdP), it supports
Home Realm Discovery (HDR) and allows users and service providers (SP) to specify the IdP for
authentication.
Infor STS can act as both the identity provider (IdP) and service provider (SP). Infor STS, in the role
of identity provider, authenticates the users and issues the token to the Infor applications. Infor STS
can be configured as the service provider to delegate the authentication to customer identity providers.

Understanding Infor STS process flow with Infor OS

Infor Operating Service Administration Guide | 34


Infor STS administration

STS Panel page


The STS Panel page is the page that you see when you first access the STS administration user
interface, which can be launched from the shortcut that is created on your desktop after installation.
The info card displays your tenant ID in the top left corner. The count for IdP connections and SP
connections is 0. When you add IdP connections or SP connections, the corresponding count of
connections is reflected on this info card.
From this page, you can navigate to all components of your STS to make changes to the configuration.
To make changes to or add a connection, click the count shown in the circle to open the related page.
To make changes to all other tenant-specific settings, click Edit, which is displayed when you hover
your cursor over the panel.

General settings
The General Settings page contains global settings, which are not specific to any individual tenant.
These settings are defined during installation, and you do not need to change them. To access the
General Settings page, click the menu list icon to open the menu column, and click the General
Settings tab:
• Entity ID Prefix: This is the prefix of the entity ID of the STS. When an STS is created, an entity ID
created.
• Session Cookie Name Prefix: This is the SESSION_ID, which is set during installation and cannot
be edited.
• STS Base URL: This is the runtime URL prefix value. STS Runtime uses this base URL to construct
all other URLs dynamically, so changing this can affect your environment.
Caution: If you try to change any of these configurations, you may break the connection.

From the General Settings page, you can navigate to the STS Panel page by clicking the Home tab
on the left menu, which can be opened by using the menu list icon.

Download federated metadata


During the configuration of the identity provider or service provider trust, both parties require configuration
that includes both end-points for communication and public keys for signature verification. Infor STS
allows you to download this federation metadata from its administration user interface.
To navigate to the Download Federated Metadata page, click the Settings tab under your tenant
name drop-down menu, and then click theDownload Federated Metadata header button.

Infor Operating Service Administration Guide | 35


Infor STS administration

Use the Download Federated Metadata page to download different metadata XML files. Available for
download are:
• SAML/WS-Fed IdP Metadata XML
• WS-Fed IdP Metadata XML – This metadata file is used when Infor STS has the role of identity
provider for WS-Fed applications.
• SAML IdP Metadata XML - This metadata file is used when Infor STS has the role of identity provider
for SAML applications.
• SAML SP Metadata XML - This metadata file is used when Infor STS has the role of service provider
for SAML applications.
To download, click the link under the selected metadata, which is then downloaded as an XML file to
your computer.

Identity Provider (IdP) connection


An identity provider (IdP) is a service that authenticates users by using standards-based protocols
such as SAML and WS-Federation.
Authentication providers can be configured from the Infor STS administration console. Any SAML 2.0
supported identity providers can be federated with Infor STS.
When you use a third-party identity provider, metadata of the external identity providers can be imported
into Infor STS through a URL, a metadata file, or manually by completing the instructions in Creating
an IdP connection.
When not connecting to a third-party identity provider, you can complete the instructions in Authentication
Store to create a local authentication store.

Creating an IdP connection


1 Download and save the metadata file from the acting identity provider for theInfor STS.
Sample ADFS metadata URL: https://<ADFS HOSTNAME>/Federationmetadata/2007-
06/Federationmetadata.xml
2 Navigate to the IdP Connection page from the STS Panel page. Click the IdP connection count in
the circle.
3 To create an IdP connection, use one of these methods:
• Manually add an IdP connection by clicking Add.
• Import a metadata file by clicking Import from file.
• From a URL, import from a metadata file path by clicking Import from URL. This URL must be
accessible from the server in which you are running the STS user interface.
4 Specify this information:

Infor Operating Service Administration Guide | 36


Infor STS administration

Display Name
A human-readable name for your application.

Partner Entity ID
This should be the entity ID of your identity provider.

Description
A human-readable description for your identity provider.

Display Icon
This icon is reflected on the Home Realm Discovery page when you are selecting which identity
provider to sign in. To revert back to the default icon after making changes, you can do so by clicking
Get Default Icon.

Enable MFA
If selected, the MFA status of all users of the tenant becomes Enabled. At the time of login, the
user is challenged for a Time-based One-time Password (TOTP) if the user has already registered
a device for MFA. Emails to register MFA devices are automatically sent to all administrators.
After MFA is enabled, users can register MFA devices from user settings through the Infor OS
Portal.

Enable remote logout


When this check box is selected and then a logout is performed, the remote identity provider is
logged out as well. If this is option is not selected, then the logout request is not sent to the remote
identity provider. so, when logging in again, the user is not prompted for a user name/password.

Connection Endpoints
A list of endpoints for your application:
• Endpoint Type: SAML applications should have two endpoints, at minimum, an SSO and SLO
endpoint.
• Endpoint Binding: Binding used by IdP for this endpoint. STS supports POST and REDIRECT.
• Endpoint URL: Complete URL for this endpoint.

Primary Signing Certificate


This should be a file in a .cer format.

Secondary Signing Certificate


A secondary token signing certificate.

Signature Algorithm
The algorithm used by your application to sign requests. Supported algorithms are SHA1 and
SHA256. SHA256 is strongly recommended.

Sign Authentication Request


This check box is selected by default.

Assertion Identity Key


The claim value that an identity provider sends for the user who is trying to log in. Select from these
options:
• Name ID: Options for selecting the name ID
• Claim Identity Key: A text box to type in the key

Infor Operating Service Administration Guide | 37


Infor STS administration

• Script: Custom claim rules


This value, selected from a drop-down list, is used with the value from the Assertion Identity Key
to look up a user in IFS. The default value is UPN.

Editing an IdP connection


1 Navigate to the IdP Connection page from the STS Panel page. Click the IdP connection count in
the circle. A list of all available IdP connections that you have created is displayed.
2 To edit an IdP connection, click the edit icon next to the connection to change. A page for the selected
connection and relevant information is displayed.
3 Update the information for the IdP connection, and click Save.

Deleting an IdP connection


1 Navigate to the IdP Connection page from the STS Panel page. Click the IdP connection count in
the circle. A list of all available IdP connections that you have created is displayed.
2 To delete an IdP connection, click the delete icon next to the connection to delete.
3 Click Yes on the confirmation dialog to confirm the deletion.

Authentication store
When not connecting to a third-party identity provider, the LDAP User Store/Active Directory can be
configured as the authentication store in Infor STS for user credential validation.
Infor STS requires administrator credentials to bind with the user directory to validate user credentials
and also to retrieve the user information.

Creating an authentication store (LDAP)


Use the Authentication Store tab to manage your authentication stores. Use this page to provide
local authentication for STS without connecting to a remote IdP.
The Authentication Store tab is under your tenant name drop-down menu.
To create a new authentication store:
1 Click Add.
2 Specify this information:

Infor Operating Service Administration Guide | 38


Infor STS administration

Name
A human-readable name for your authentication store.

Authentication Store Type


Select LDAP from the drop-down.

Use LDAPS Check Box


To use LDAPS, you must select this check box. If you use LDAPS, you are required to upload a
SSL certificate.

LDAP URL
This is made up of your LDAP host and port. (ldap://{hostname}:{port})
The LDAP connection uses port 389, and secure LDAP connections use port 636.

Bind User
The administrator user who will bind with LDAP.

Bind User Password


The password for the administrator.

User Attribute
This field is used for searching for the user in LDAP. The property entered here specifies the attribute
that must be used to match the provided user name when a user is logging on.

User Object Class


This is a higher-level object of what you are searching. It specifies the object class of a user in the
LDAP schema.

User Search Scope


Defines the search scope for finding users. Possible values are: one, sub.

Search Base
Tree from which users are searched: (cn=username,dc=infor,dc=com)

Assertion Identity Key


This value in this field may be the same as the User Attribute value. It is used to look up the user
in IFS to verify that the user is active.

User Lookup field


This value, selected from a drop-down list, is used with the value from the Assertion Identity Key
to look up a user in IFS. The default value is UPN.
Note: The Assertion Identity Key and User Lookup field work together to verify the status of the
user. If UPN is selected from the drop-down in the User Lookup field, then the value in the Assertion
Identity Key must relate to this value.

Test Connection
After entering all the required fields, you must click Test Connection to validate that the connection
is successful. This button is located at the top of the page.

Infor Operating Service Administration Guide | 39


Infor STS administration

Creating an authentication store (REST)


The REST authentication store is another method of managing authentication stores This method,
however, should be used only with the API that is provided.
The Authentication Store tab is under your tenant name drop-down menu.
To create a new authentication store:
1 Click Add.
2 Specify this information:
Name
A human-readable name for your authentication store.

Authentication Store Type


Select REST from the drop-down.

Rest Endpoint
Select REST from the drop-down.

Authentication Store Type


Select OAUTH 1.0a, OAuth 2, or Basic from the drop-down.

Test Connection
After entering all the required fields, you must click Test Connection to validate that the connection
is successful. This button is located at the top of the page.

OAuth 1.0a
If selecting OAuth 1.0a, provide this information:
Consumer Key
The consumer key used to authenticate this service.

Consumer Secret
The consumer secret used to authenticate this service.

User Lookup field


This is used to look up the user in IFS. The REST API that is provided responds with an IFS User
Lookup value. The value in this field must match that returned value.

OAuth 2
If selecting OAuth 2, provide this information::
Client ID
The client ID to authenticate this service.

Infor Operating Service Administration Guide | 40


Infor STS administration

Client Secret
The client secret to authenticate this service.

Token Endpoint
The endpoint that is used to generate the OAuth 2 token.

User Lookup field


This is used to look up the user in IFS. The REST API that is provided responds with an IFS User
Lookup value. The value in this field must match that returned value.

Basic
If selecting Basic, provide this information:
Username
The user name to authenticate this service.

Password
The password to authenticate this service.

User Lookup field


This is used to look up the user in IFS. The REST API that is provided responds with an IFS User
Lookup value. The value in this field must match that returned value.

Editing an authentication store


1 Navigate to the Authentication Store page under your tenant name drop-down menu. A list of all
available authentication stores that you have created is displayed.
2 To edit an authentication store, click the edit icon next to the store to change. A page for the selected
store and relevant information is displayed.
3 Update the information for the authentication store, and click Save.

Deleting an authentication store


1 Navigate to the Authentication Store page under your tenant name drop-down menu. A list of all
available authentication stores that you have created is displayed.
2 To delete an authentication store, click the delete icon next to the store to delete.
3 Click Yes on the confirmation dialog to confirm the deletion.

Infor Operating Service Administration Guide | 41


Infor STS administration

Home Realm Discovery settings


Home Realm Discovery (HDR) is a feature in Infor STS where the end user can choose the authentication
provider to authenticate against from the available list of identity providers configured with Infor STS.
The user is then directed to the relevant identity provider to authenticate, based on the selection.
A default rule is added during Infor STS installation. To add actions to your rule, click the Name field
to open a popup with this information:
• Name: You may change this to any human-readable name for your rule.
• Evaluation Criteria: This is automatically set to default and cannot be edited.
• Actions: Listed under actions are all of the available IdP connections to which you can assign this
rule. Select the corresponding check boxes to assign the rule to the current IdP connection. When
you change these rules, you are changing the action for authentication.
Note: You cannot delete the authentication adapter rule.

Service Provider (SP) connection


In a federated authentication model, the web application is referred to as the service provider (SP).
Infor business applications that participate in web-based single sign-on are configured in the Infor STS
as service providers via a service provider connection. SAML and WS-FED based applications are
supported by Infor STS.
When an SP connection with an Infor application is created, it is done through OS Manager, and then
it is reflected within the STS administration user interface Service Provider Connections page.
When creating an SP connection with a third-party application, you make the connection within the
STS administration user interface, by completing the steps in Creating an SP connection.

Creating an SP connection
1 Navigate to the SP Connection page from the STS Panel page. Click the SP connection count in
the circle.
2 To create an SP connection, use one of these methods:
• Manually add an SP connection by clicking Add.
• Import a metadata file by clicking Import from file.
• From a URL, import from a metadata file path by clicking Import from URL. This URL must be
accessible from the server in which you are running the STS user interface.
3 Specify this information:
Display Name
A human-readable name for your application.

Infor Operating Service Administration Guide | 42


Infor STS administration

Partner Entity ID
This should be the entity ID of your service provider.

Description
A human-readable description for your service provider.

IFS Application Type


This is used to determine what claims to send, through integration with the IFS Claims Service.

Connection Endpoints
A list of endpoints for your application.
• Endpoint Type: SAML applications must have two endpoints, at minimum: an ACS and an SLO
endpoint. WS-Federation applications must have one WSFED endpoint.
• Endpoint Binding: Binding used by SP for this endpoint. STS supports POST and REDIRECT.
This is applicable only for SAML. WS-Federation connections do not have a binding or use
POST by default.
• Endpoint URL: Complete URL for this endpoint.

Primary Signing Certificate


This should be a file in a .cer format.

Secondary Signing Certificate


A secondary token signing certificate.

Signature Algorithm
The algorithm used by your application to sign requests. Supported algorithms are SHA1 and
SHA256. SHA256 is strongly recommended.

Sign Response
Whether the STS should sign responses sent to this service provider. This option is selected by
default an cannot be edited.

Sign Assertion
Whether the STS should sign assertions sent to this service provider.

Include Key Info


Whether the key information should be included in the signature. This option is selected by default.

Name Identifier Format


Qwerty

Authentication Context Class


URIs that specify authentication methods in SAML authentication requests.

Editing an SP connection
1 Navigate to the SP Connection page from the STS Panel page. Click the SP connection count in
the circle. A list of all available SP connections that you have created is displayed.

Infor Operating Service Administration Guide | 43


Infor STS administration

2 To edit an SP connection, click the edit icon next to the connection to change. A page for the selected
connection and relevant information is displayed.
3 Update the information for the SP connection, and click Save.

Deleting an SP connection
1 Navigate to the SP Connection page from the STS Panel page. Click the SP connection count in
the circle. A list of all available SP connections that you have created is displayed.
2 To delete an SP connection, click the delete icon next to the connection to delete.
3 Click Yes on the confirmation dialog to confirm the deletion.

Signing certificate
Infor STS includes a certificate management service, which allows the management of the certificates
used for digital signatures.
These signing certificates are used only by Infor STS to sign the SAML assertions sent to the identity
provider if it is acting as a service provider. If the role of Infor STS is an identity provider, these signing
certificates are to sign the SAML assertions sent to the service provider applications. Infor STS allows
the creation of locally signed certificates or import externally signed certificates.

Creating a signing certificate


Use the Signing Certificate tab to manage your signing certificates.
1 Click the Signing Certificate tab within the Settings tab under your tenant name drop-down menu.
2 To create a signing certificate, use one of these methods:
• Add a default certificate by clicking Add.
• Import a file (.pfx, .p12, .jks) by clicking Import from file.
3 When adding a new certificate, you are required to configure the certificate before it can be used.
Specify this information:
Certificate Name
By default, this field is populated with sts-signing. You may change this to any human-readable
name for your certificate.

Valid for days


By default, this is set to 730 days. You may change this to a value of your choice.

Key Details – RSA


This field is populated during installation and cannot be edited.

Infor Operating Service Administration Guide | 44


Infor STS administration

Signature Algorithm - SHA256withRSA


This field is populated during installation and cannot be edited.

Activating a signing certificate


When you activate a certificate, it becomes the active certificate that is used in your STS. You cannot
activate an expired certificate.
To activate a certificate:
1 Click the Signing Certificate tab within the Settings tab under your tenant name drop-down menu.
A list of all certificates available to you is displayed.
2 To activate a certificate, select the check box next to the certificate to activate and click Enable.

Deleting a signing certificate


You cannot delete an active certificate. You must first activate another certificate, and then you can
delete the first certificate.
To delete a certificate:
1 Click the Signing Certificate tab within the Settings tab under your tenant name drop-down menu.
A list of all certificates available to you is displayed.
2 Click the browse icon. To delete a certificate, select the check box next to the certificate to delete
and click Delete.

General information
The General Information tab displays settings specific to your tenant. TheGeneral Information tab
is within the Settings tab under your tenant name drop-down menu.

Field Description
Tenant ID This is the name of your tenant. It is pre-populat-
ed as Infor and cannot be edited.
Session Cookie Name When authentication happens and a session is
created, that specific session is assigned to this
specific cookie name: SESSION_ID_INFOR. This
cannot be edited.
Entity ID This is a unique ID to identify STS. This cannot
be edited.

Infor Operating Service Administration Guide | 45


Infor STS administration

Field Description
Session Maximum Timeout (in minutes) This is the length of time that the session can
remain idle. The default value is 960 minutes.
This value can be changed.
SLO Timeout (in seconds) This is the length of time that the Infor STS waits
during SLO for responses before reporting a lo-
goff failure. The default value is 10 seconds.
IdP SSO Redirect URL The URL where the browser is redirected when
an IdP-initiated SSO is performed.
Enable Proxy Mode When Infor STS as Proxy is enabled for a con-
nection, Infor STS is between the customer IDP
and PingFederate. For each tenant with a connec-
tion enabled with Infor STS as Proxy, a new
corresponding tenant is provisioned within Infor
STS. Each tenant provisioned within Infor STS
has a unique identifier that Infor STS sends to
PingFederate. Since Infor STS is able to asso-
ciate each tenant with a unique ID, the same
customer IDP connection can be used for multiple
tenants.

Changing the icon


Use the Change Icon page to change the icon that is on the bridge page when logging in to your
environment.
To change the icon:
1 Click the Change Icon tab within the Settings tab under your tenant name drop-down menu.
2 Click the browse button to upload your selected icon. Maximum size is 2MB. Supported file formats
are SVG, JPG/JPEG and PNG. Recommended dimensions are 100*100 pixels.
To change the icon back to the default, click Get Default Icon, which is displayed only after you
upload your own icon.

Infor Operating Service Administration Guide | 46


ION administration

Chapter 4: ION administration

Managing queue memory parameters


Adjustment of the parameters is not expected for most common deployment scenarios.
Each document flow element in ION has one or more queues that are linked. ION uses these internal
queues to decouple processing steps and simultaneously provide guaranteed delivery. For storage
the queues use the Infor_<farmname>_ION database, where each queue has its own set of tables.
When processing a BOD by a queue:
• A particular queue receives a BOD it keeps the BOD in memory and for persistent reasons stores
it in the database. The available memory is defined by the queue.memory.limit parameter, by
default 64Mb. If that memory is full the queue cannot keep all BODs in memory.
• A queue is requested to provide a BOD to the reading process. The BOD is taken from memory
and if not available, read from the database. When, the message is processed the BOD will be
removed from the database or memory.
The Queue node is managing the queues. For performance reasons the Queue node keeps the BODs
to process in memory to avoid reading messages (BODs) from the database.
Reading messages from the database affects the performance. For regular processing we recommend
that you prevent this. Only for bulk processing, such as initial loads or daily synchronization it is
unavoidable.
Apart from the memory queue size the Max Heap Size of the Queue node is adjustable.
Three important parameters that are related to the memory usage of the queues:
• The queue.memory.limit as described earlier defines the maximum queue memory available.
• The broker.memory.usage defines per broker the maximum available memory. In the case of
ION use the formula: broker.memory.usage = queue.memory.limit * 2
• The MaxHeapSize of the QueueNode specifies how much memory all queues together can use.
As a rule of thumb you can the formula: Queue Node Max Heap size = queue.memory.limit
* # of expected queues * 40%
The Max HeapSize of the Queue Node can be adjusted through the grid management UI.
For more information, see Modifying the java heap space on page 17.
Maintain the queue.memory.limit and broker.memory.usage parameter in the InforIONCBM
database, table ION_PROPERTY.

Infor Operating Service Administration Guide | 47


ION administration

Use this script to update the values:

/****** Update queue,memory.limit parameter SQL Server ******/


declare @maxmemory int
set @maxmemory = <max queue memory in bytes, default 67108864>
update [InforIONCBM].[dbo].[ION_PROPERTY]
set C_VALUE = @maxmemory
where C_PID = 'ion.queues' and C_KEY = 'queue.memory.limit'
update [InforIONCBM].[dbo].[ION_PROPERTY]
set C_VALUE = @maxmemory * 2
where C_PID = 'ion.queues' and C_KEY = 'broker.memory.usage';

/****** Update queue,memory.limit parameter Oracle ******/


update INFORIONCBM.ION_PROPERTY
set C_VALUE = <max queue memory in bytes, default 67108864>
where C_PID = 'ion.queues' and C_KEY = 'queue.memory.limit';
update [InforIONCBM].[dbo].[ION_PROPERTY]
set C_VALUE = <max queue memory in bytes * 2>
where C_PID = 'ion.queues' and C_KEY = 'broker.memory.usage';

Scale out connect nodes


This section is only relevant if you use the Infor ION Grid edition and have ION deployed over multiple
hosts.

Splitting document flow elements over multiple connect nodes


In case your connect nodes are consuming quite some resources, you can split the document flow
elements over multiple nodes. Change the binding for the connect nodes and influence the distribution
of document flow elements over these nodes.

Configure the expected load for the document flow elements


ION will distribute document flow elements over available connect nodes as evenly as possible,
considering the expected load of the elements.
Use the Resource Consumption page in ION Desk to specify the expected load per element.
1 Start ION Desk and click Configure > Resource Consumption.
2 Specify for each of the element the number of BODs to be processed by that element. Specify a
time unit, for example per day or week. If required adjust the default weight factor.
3 Click Activate.
If work was already distributed over multiple connect nodes, this distribution is recalculated.

Infor Operating Service Administration Guide | 48


ION administration

Resource consumption page


The resource distribution page is used to indicate the expected resource consumption per active
document flow element. This information is used by ION to balance distribution of document flow
elements over the available connect nodes.
This page provides the BODs you expect to be handled by each element for a certain time period. You
can choose your own time period as long as you keep it the same for all elements.
If you use one connect node, it is not mandatory to specify the details.
To access this page go to ION Desk, click Configure > Resource Consumption.

Buttons
Activate: based on the currently provided resource consumption expectation, ION will calculate
distribution of the active elements over the available connect nodes.
View: Opens the Connect Nodes page displaying the active distribution of document flow elements
over the available connect nodes.

Fields
Listed are the active document flow elements.
Type: identifies the document flow element type.
Name: the name of the document flow element.
Resource consumption: relative factor for the expected weight of this element type compared to the
other element types. Defaults are provided. You can adjust these weight factors to better reflect the
weight balance of your environment. For example, if you have implemented a very complex
transformation you can consider to raise the resource consumption for that element.
BODs per time unit: Indication how many BODs are expected to be processed by the document flow
element in a certain time unit. Use the same time unit for all elements.
Ratio: the calculated ratio based on resource consumption and BODs per time unit

Changing the number of connect nodes


Before you run this procedure, ensure that the relevant document flows are active. If needed, adjust
the resource consumption before running this procedure.
To remove a connect node:
1 Open Infor ION Grid Management UI > Applications
2 Click the ION Service application.
3 Click Bindings and edit the Connect binding.
4 Specify the Min parameter to the new number of connect nodes you expect.

Infor Operating Service Administration Guide | 49


ION administration

Ensure to set Initial and Max to the same value.


5 Save the binding.
The Grid automatically starts extra connect nodes if needed.
6 Save the change.
7 If you decreased the number of nodes:
a Go to the Topology View of the Infor ION Grid Management Pages.
b Click Stop Node to stop the relevant Connect Nodes.
c Select Shutdown immediately in the Stop Node Process dialog box and click OK.
d After the node or nodes are stopped, verify how the document flow elements are distributed over
the connect nodes.
8 Start ION Desk, click Configure > Resource Consumption.
9 Click View.
The available number of connect nodes is displayed and for each element it will show in which
connect node it is running.

ION statistics widgets


Using the Homepages application running in Infor Ming.le, you can create and configure ION statistics
widgets to monitor ION and its services such as ION Connect and ION Process. The widgets data is
taken from ION OneView. Only historical data is available.

Prerequisite
For Infor OS on premises, you should use Infor Ming.le 12.0.6 or later to access the Homepages
application hosting all the widgets.

Accessing ION statistics widgets


To access the ION statistics widgets:
1 In Infor Ming.le, click the App Switcher icon and click the Homepages application icon.
2 In the Homepages application, create a new page or select a page from the Page catalog. For
example:
a Select New Page from the action menu.
b Type ION in the Title field.
c Type ION statistics in the Description field.
d Confirm by clicking Create. You can start adding widgets on your home page.

Infor Operating Service Administration Guide | 50


ION administration

Security
Access to the widgets in the Homepages catalog and the widget content is protected by IFS Security
Roles applicable to ION Desk and Homepages.
The users having the access rights for ION Desk Manage pages are authorized to use the ION statistics
widgets.
Access to the ION widgets and their content is secured by the IFS roles mapped to the desk profiles
- permissions in the ION Desk.

Role Description
IONDeskSecurityAdmin Users with this role have full access to the security admin-
istration pages.
IONDeskAdmin Users with this role have full access to all ION Desk pages
except the security administration pages.

Content restrictions
Configuration Restricted by
Since <Time> System availability. The time range is limited by the time of the first event.
Location <Name> tenant
Document Type <Docu- tenant + view permissions in ION Desk: Desk Permissions – Manage –
ment> OneView - Documents
Connection Point tenant
<Name>
Workflow<Name> tenant

ION widgets overview


Name Description
Messages and Events Real-time counters of all inbound and outbound messages sent to and
from ION, and the number of open workflows, tasks and alerts. This widget
replaces the ION Insight widget.
Messages by docu- Overview of all inbound and outbound messages for a specific document
ment type. This widget replaces the ION by document widget.
Messages by connec- Overview of all inbound and outbound messages for a specific connection
tion point, including statistics on errors and queue size. This widget replaces
the ION by connection widget.

Infor Operating Service Administration Guide | 51


ION administration

Name Description
Workflow Status Overview of started, now open, stopped, and completed workflows since
the time specified, including statistics on completion lead time. This widget
replaces the ION Workflows widget.
Task Status Overview of these tasks:
• Tasks that are now open, including new, unassigned, and assigned
tasks
• Generated tasks
• Canceled tasks
• Taks that were completed since the time specified
This widget replaces the ION Tasks widget.
Alert Status Overview of these alerts:
• Alerts that are now open, including new, unassigned, and assigned
alerts
• Generated alerts
• Canceled alerts
• Alerts that were completed since the time specified
This widget replaces the ION Alerts widget.

Configuring the widget


Click the action icon on top of a widget to open the Configure Widget popup.
• For Inbound messages, only the messages that are inbound to ION are counted. The inbound
messages that are not related to the connection point are excluded.
• For Outbound messages, the messages created in a synchronous step in the middle of a document
flow (mapping, database activity, web service activity) are excluded.
• Configuration, including the time range, is not shared. The configuration popup is always per widget.
• The time configuration for each widget is set by default to since the beginning, which means
from the moment ION starts collecting the data. By default, this is the moment you start using ION.
However, older versions of ION, before 12.0.7, did not collect all required data. In that case, since
the beginning means since the moment version 12.0.7 or a higher version was installed. These
selections are displayed on the overlay Settings panel in this sample format: November 1, 2016
12:00 AM.
• The user can select the data refresh interval to be 1 second or 1 minute.

Infor Operating Service Administration Guide | 52


ION administration

Collecting ION Grid-related log files


From the host servers where ION is installed, you can use the log collector tool to collect and zip the
log files for the ION Grid applications.

Log file collector


To collect the ION log files from the system, you can use the log collector, collectLogFiles.bat.
This batch file collects the ION log files on the host and stores them in a zip file. You can find the
collectLogFiles.bat file in this folder:
Infor OS installation folder\InforTechStackGrid\grid\applications\IONService\
appdata\ion.connect.1\IONContainer\bin\
You must have access rights for the ION Grid folders to be able to run the log collector. Add your user
name to the Windows InforTechStackGrid_full user group or to an explorer trying to open the
folder: ION installation\ION\IONGrid.
Click Continue on the message that informs you that you are not authorized for this folder.
If no parameters are specified, the batch file creates this .zip file: ionlogcollection_timestamp.zip
You can find the file on the host where the .bat was run in the %TEMP% folder of the user with the ION
log files.
This table shows the parameters:

Parameter Description
-help Information about the usage.
-o[utputfile] Location and name of the zip file. Can include a
path. UNC paths are not supported. An example:
-o c:\temp\logcollector.zip
-n[oarchive] Will skip archive log files
-mtime numberOfDays Collects log files that were updated in the last
numberOfDays. numberOfDays: 0, or a negative
number.
For example: -mtime -1 collects log files that
were changed in the last 24 hours.

Infor Operating Service Administration Guide | 53


ION administration

Programmatic upload of ION models (content)


ION Desk offers the possibility to import ION models. As an alternative, you can use ION Rest APIs to
upload this content.
The swagger documentation for these APIs is available at this address: https://<xi techstach
host>:<port for a grid router>/api/provision/swagger/ui
To be authorized to execute these methods, you must access the ION Grid with credentials that have
the grid-provisioner grid security role. How you set this role depends on the authentication method
that you use to access these APIs. For more information, see the Infor ION Grid Security Administration
Guide.

Upgrade instructions for custom email templates


This information is applicable if you customized the email template for ION Pulse. There is no automatic
migration of customized email templates. The installer erases the existing email templates and overwrites
them with the new standard templates.
Before running the installer, make a backup of the customized email templates.
After running the installer, you redeploy your customized email templates.
Note: If you are upgrading from an Infor OS version that is prior to version 12.0.3, see KB solution
1834104 for details about applying the latest formatting to the customized email templates.

Backing up the customized email templates


Before running the installer, make a backup of the customized email templates:
1 Log on to your existing ION Desk application.
2 Navigate to Settings > Configuration > ION Service.
3 Select the Configuration Files tab, select the Email Templates section, and click Download.
4 Select a location of your choice and click Save to save the backup file of customized email templates.

Redeploying your customized email templates


To redeploy your customized email templates after the upgrade installer has run:
1 Navigate to Settings > Configuration > ION Service.
2 Select the Configuration Files tab, and select the Email Templates section.
3 Click Upload Updated Set of Templates to upload the backup file of customized email templates.

Infor Operating Service Administration Guide | 54


Infor Ming.le administration

Chapter 5: Infor Ming.le administration

Infor Ming.le is an application framework that provides a common user interface for integrated Infor
ERP applications. Infor Ming.le provides a centralized platform for employee collaboration where
information is shared and conversations are organized across Infor Ming.le.
The Infor Ming.le interface includes a top navigation panel with an application panel to activate the
display of Infor ERP applications. From the top navigation panel, you can click your user name to
access the profile panel. On the profile panel, Admin Settings and User Management options are
available.
Admin Settings
You use the Admin Settings menu option on the profile panel to manage applications, context and
utility applications, general settings, and drillbacks.
User Management
You use the User Management menu option on the profile pane to manage users and security settings.
Within Infor Ming.le there are many access rights. This documentation assumes you have all necessary
access rights for the task being performed.

Admin Settings
You use the Admin Settings menu option on the profile panel to manage applications, context and
utility applications, and general settings.
To access the Admin Settings window:
1 Click your name in the top level header to access the profile panel.
2 Click Admin Settings to open the Admin Settings window.
The Admin Settings window has these options:
• Manage Applications
• Manage Context/Utility Apps
• General Settings

Infor Operating Service Administration Guide | 55


Infor Ming.le administration

Manage Applications
On the Manage Applications page, you can manage all application icons. You can also add, edit, or
delete an application.
• Applications panel
• Add Application
• Edit Application
• Delete Application

Applications panel
All the application icons that you add to the portal are displayed on the panels. The first application
icon, located in the top left corner, is the default application to be loaded. You can rearrange the
application icons by dragging and dropping an icon at any time.
All other application icons are rearranged automatically. The pagination dots on the panels indicate
the number of the applications panels.

Add/Edit Application
To add an application to the Applications panel, click Add Application. An Add New Application
page is displayed.
To edit an application, double-click the application icon, an Application Details page is displayed. To
edit a particular type of application, refer to the corresponding Application Details section.
The application can be:
• Infor Application
• Non-Infor Application
Each application type is described in the sections below.

Infor
The Infor application is an on-premises Infor application that is installed, configured, and maintained
by the person or organization using the Infor application. You can add an Infor application to run within
the cloud framework.

Adding the Infor application


To add an Infor application:
1 Specify Infor Application as the Application Type.
2 Specify an application name and version.
3 Specify a Display Name to be displayed on the App Switcher panel.

Infor Operating Service Administration Guide | 56


Infor Ming.le administration

4 Click the application icon.


5 Specify a Logical ID instance name. It must be lowercase.
6 Select or clear Use Https.
7 Specify a Host Name.
8 Specify a Port #.
9 Specify a Context. If any context is defined in the Infor Registry, it is entered here as the default
context. You can overwrite this value.
10 Optionally, specify the Default Tenant.
11 Click Save.

Application Details
The Application Details page contains these tabs.
• Deployment Information
• Permissions
• Context/Utility Apps
• Custom Parameters
• Logical ID Fallback
Click Save at any time to save changes to one or more tabs.

Deployment Information
Under the Deployment Information tab, all the deployment details pertaining to the current application
are displayed. You can edit any value.

Permissions
Under the Permissions tab, you can add users and User Management security roles to the current
application, assign a permission level, and delete users and User Management security roles.

Adding users and User Management security roles


To add users and User Management security roles:
1 Click Add Users and/or Security Roles. An Add New Users and/or User Management Security
Roles overlay is displayed.
2 Enter a user's name or a User Management security role. A suggestion list is displayed.
3 Select from the suggestion list.
4 Select a permission level
5 Enter additional user names or User Management security roles as required.
6 Click Done. All selected users and User Management security roles are added to the list.

Deleting users and User Management security roles


To delete users and User Management security roles:

Infor Operating Service Administration Guide | 57


Infor Ming.le administration

1 Select the check box next to each user and User Management security role to delete.
2 Click Delete. A confirmation message is displayed.
3 Click Yes. All the selected users and User Management security roles are deleted from the list.

Context/Utility Apps
The Context/Utility Apps tab contains these sections:
• Context Apps
• Utility Apps

Context apps
Context apps are lightweight applications that communicate with the application frame to publish
contextual information to the user. These applications subscribe to information published by the
application frame and display only relevant content when it is available.
The purpose of associating a context application with an application is to make the context application
available to users. The user can then display the context applications in the right panel, based on the
user's permission level.
Default context applications, if any exist, are displayed under the Context Apps section. Default context
applications are either required or optional. By default, all the required applications are enabled
and optional applications are disabled. You can enable or disable default context applications at any
time. Use the switch control to change the status of the context application. The Edit Screen ID
Associations option is displayed if the context application subscribes to a context message. The
Settings option is displayed only when there is at least one setting to display. The maximum number
of context applications allowed to display under the Context Apps section is 20 per application instance.

Edit Screen ID Association


The Edit Screen ID Association functionality is used to associate application screens with a context
application. The context application can then be displayed in the right panel for this application screen.
On the Edit Screen ID Associations overlay, all default screen associations, if any exist for the current
context applications, are displayed. These default screen associations are not editable and cannot be
deleted. The maximum number of default screen associations displayed is 30.
All Screens is a read-only option, and it can be selected or cleared as predefined. If it is selected, you
cannot add or delete screen associations to the current application. If it is cleared, you can add and
delete screen associations to the current application. The maximum number of screen associations
that you can add is 20.

Adding a screen ID association


Use this option to associate a new screen ID with the current application.
To add a screen ID association:
1 Click Add to add a row to the bottom of the list.
2 Specify the Rule Type.

Infor Operating Service Administration Guide | 58


Infor Ming.le administration

3 Click the Value field. A cursor is displayed.


4 Enter the screen name. A suggestion list is displayed.
5 Select a screen ID.
6 Click Done. The new screen ID association is added to the list.

Editing a screen ID association


Use this option to edit a screen ID that you added to the current application.
To edit a screen ID association:
1 Specify the Rule Type, if you need to change it.
2 Click the Value field. A cursor is displayed.
3 Enter the screen name. A suggestion list is displayed.
4 Select a screen ID.
5 Click Done. The selected screen ID association is updated with the new value.

Deleting a screen ID association


Use this option to delete a screen ID that you added to the current application.
To delete a screen ID association:
1 Select one or more boxes next to the screen ID associations to delete.
2 Click Delete. A confirmation message is displayed.
3 Click Yes. The selected screen ID associations are deleted from the list.

Settings
Use this option to edit the context application settings. On the Settings overlay, all settings for the
current context application are displayed. You cannot add or delete these settings. You can only edit
the settings' values.

Editing a setting
To edit a setting:
1 Select the check box next to one or more settings to edit.
2 Click the Value field.
3 Click Delete to remove the current value.
4 Enter a new value.
5 Click Done. All selected settings are updated with the new values.

Add/Remove Context Applications


Use the Add/Remove Context Applications option to add other context applications to the current
application or to remove other context applications from the current application in the portal. The
Add/Remove Context Applications overlay has these panels:

Infor Operating Service Administration Guide | 59


Infor Ming.le administration

• Available
• Selected

Adding a context application


To add a context application:
1 Select one or more context applications. The selected context applications are highlighted.
2 Click the right arrow to move the selected context applications to the Selected panel.
3 Click Done.
All of the selected context applications are added to the Context Apps section. The context
applications are either required or optional. By default, all the required context applications are
enabled, and optional context applications are disabled. You can enable or disable the context
applications at any time. Use the switch control to change the status of context application. The
Edit Screen ID Associations option is displayed if the context application subscribes to a context
message. The Settings option is displayed only when there is at least one setting to display.

Removing a context application


To remove a context application:
1 Select one or more context applications. The selected context applications are highlighted.
2 Click the left arrow to move the selected context applications to the Available panel.
3 Click Done. The selected context applications are removed from the Context Apps section.

Utility apps
Utility apps are lightweight applications that display information unrelated to content in the application
frame. These applications do not communicate with the application frame and, if activated, only show
whenever this application is open.
Default utility apps, when any exist, are always displayed under the Utility Apps section. Default utility
apps are classified as required or optional. By default, required applications are enabled and the
optional applications are disabled; however, you can enable or disable a default utility app at any time.
Use the switch control to change the status of the utility app.
The Settings option is displayed when any utility app has at least one setting to display. The maximum
number of utility apps that can be displayed under the Utility Apps section is 20 per application instance.

Add/Remove Utility Applications


Use the Add/Remove Utility Applications option to add other utility applications to the current
application or to remove other utility applications from the current application in the portal.
The Add/Remove Utility Applications overlay has these panels:
• Available
• Selected

Infor Operating Service Administration Guide | 60


Infor Ming.le administration

Adding a utility application


To add a utility application:
1 Select one or more utility applications. The selected utility applications are highlighted.
2 Click the right arrow to move the selected utility applications to the Selected panel.
3 Click Done. The selected utility applications are added to the Utility Apps section.

Removing a utility application


To remove a utility application:
1 Select one or more utility applications. The selected utility applications are highlighted.
2 Click the left arrow to move the selected utility applications to the Available panel.
3 Click Done. The selected utility applications are removed from the Utility Apps section.

Reordering context/utility applications


To reorder context and utility applications:
1 Click the hamburger icon and hold down the mouse button until the row is highlighted.
2 Drag and drop the context or utility application to the new location.
The context and utility applications are renumbered.

Custom Parameters
Default custom parameters, if any exist, are displayed under the Custom Parameters tab. The default
name of the custom parameter is not editable. The parameter value is editable. You cannot delete the
default custom parameters. You can add new custom parameters to an application at any time. Both
the name and value of a new custom parameter are editable. You can also delete a custom parameter
that you add.

Adding a custom parameter


To add a customer parameter:
1 Click Add Parameter. The Add Parameter overlay is displayed.
2 Specify a name for the parameter.
3 Specify a value for the parameter.
4 Click Add. A new custom parameter is added to the list.

Editing a custom parameter


To edit a custom parameter:
1 Click the Value field and specify a new value, if required.
2 Click Save. The selected custom parameter is updated.

Infor Operating Service Administration Guide | 61


Infor Ming.le administration

Deleting a custom parameter


To delete one or more custom parameters:
1 Select one or more custom parameter boxes.
2 Click Delete. A confirmation message is displayed.
3 Click Yes. All the selected custom parameters are deleted from the list.

Logical ID Fallback
By default, no logical ID fallbacks are displayed under the Logical ID Fallback tab. You can add or
delete logical ID fallbacks to the list at any time.

Adding a logical ID fallback


To add a logical ID fallback:
1 Click Add ID. The Add New Logical ID Fallback overlay is displayed.
2 Specify an Incoming Logical ID.
3 Click Add. A new logical ID fallback is added to the list.

Deleting a Logical ID fallback


To delete a logical ID fallback:
1 Select one or more check boxes for the incoming logical IDs.
2 Click Delete. A confirmation message is displayed.
3 Click Yes. The selected incoming logical IDs are deleted from the list.

Non-Infor
A non-Infor application is any external application, not an Infor application. To display a non-Infor
application icon on the Applications panel, you must add a non-Infor application that will run in the Infor
Ming.le left panel.

Adding a Non-Infor application


To add a non-Infor application:
1 Specify Non-Infor as the Application Type.
2 Specify a Display Name to be displayed on the App Switcher panel.
3 Click the application icon.
4 Specify the application URL.
5 Specify the application Help URL.
6 Click Save.

Infor Operating Service Administration Guide | 62


Infor Ming.le administration

Application Details
The Application Details page contains these tabs.
• Deployment Information
• Permissions
• Context/Utility Apps
• Logical ID Fallback
Click Save at any time to save changes to one or more tabs.

Deployment Information
Under the Deployment Information tab, all the deployment details pertaining to the current application
are displayed. You can edit any value.

Permissions
Under the Permissions tab, you can add users and User Management security roles to the current
application, assign a permission level, and delete users and User Management security roles.

Adding users and User Management security roles


To add users and User Management security roles:
1 Click Add Users and/or Security Roles. An Add New Users and/or User Management Security
Roles overlay is displayed.
2 Enter a user's name or a User Management security role. A suggestion list is displayed.
3 Select from the suggestion list.
4 Select a permission level
5 Enter additional user names or User Management security roles as required.
6 Click Done. All selected users and User Management security roles are added to the list.

Deleting users and User Management security roles


To delete users and User Management security roles:
1 Select the check box next to each user and User Management security role to delete.
2 Click Delete. A confirmation message is displayed.
3 Click Yes. All the selected users and User Management security roles are deleted from the list.

Context/Utility Apps
The Context/Utility Apps tab contains these sections:
• Context Apps
• Utility Apps

Context apps

Infor Operating Service Administration Guide | 63


Infor Ming.le administration

Context apps are lightweight applications that communicate with the application frame to publish
contextual information to the user. These applications subscribe to information published by the
application frame and display only relevant content when it is available.
There are no default context applications for non-Infor application types. Therefore, no context
applications are displayed under the Context Apps section. You can add other context applications to
the current application in the portal by using the Add/Remove Context Applications option. The
maximum number of context applications allowed to display under the Context Apps section is 20 per
application instance.

Add/Remove Context Applications


Use the Add/Remove Context Applications option to add other context applications to the current
application or to remove other context applications from the current application in the portal. The
Add/Remove Context Applications overlay has these panels:
• Available
• Selected
By default, the Available panel contains all of the context applications that are available to you and all
context applications that you have added in the portal.

Adding a context application


To add a context application:
1 Select one or more context applications. The selected context applications are highlighted.
2 Click the right arrow to move the selected context applications to the Selected panel.
3 Click Done.
All of the selected context applications are added to the Context Apps section. The context
applications are either required or optional. By default, all the required context applications are
enabled, and optional context applications are disabled. You can enable or disable the context
applications at any time. Use the switch control to change the status of context application. The
Edit Screen ID Associations option is displayed if the context application subscribes to a context
message. The Settings option is displayed only when there is at least one setting to display.

Removing a context application


To remove a context application:
1 Select one or more context applications. The selected context applications are highlighted.
2 Click the left arrow to move the selected context applications to the Available panel.
3 Click Done. The selected context applications are removed from the Context Apps section.

Edit Screen ID Association


The Edit Screen ID Association functionality is used to associate application screens with a context
application. The context application can then be displayed in the right panel for this application screen.

Infor Operating Service Administration Guide | 64


Infor Ming.le administration

On the Edit Screen ID Associations overlay, all default screen associations, if any exist for the current
context applications, are displayed. These default screen associations are not editable and cannot be
deleted. The maximum number of default screen associations displayed is 30.
All Screens is a read-only option, and it can be selected or cleared as predefined. If it is selected, you
cannot add or delete screen associations to the current application. If it is cleared, you can add and
delete screen associations to the current application. The maximum number of screen associations
that you can add is 20.

Adding a screen ID association


Use this option to associate a new screen ID with the current application.
To add a screen ID association:
1 Click Add to add a row to the bottom of the list.
2 Specify the Rule Type.
3 Click the Value field. A cursor is displayed.
4 Enter the screen name. A suggestion list is displayed.
5 Select a screen ID.
6 Click Done. The new screen ID association is added to the list.

Editing a screen ID association


Use this option to edit a screen ID that you added to the current application.
To edit a screen ID association:
1 Specify the Rule Type, if you need to change it.
2 Click the Value field. A cursor is displayed.
3 Enter the screen name. A suggestion list is displayed.
4 Select a screen ID.
5 Click Done. The selected screen ID association is updated with the new value.

Deleting a screen ID association


Use this option to delete a screen ID that you added to the current application.
To delete a screen ID association:
1 Select one or more boxes next to the screen ID associations to delete.
2 Click Delete. A confirmation message is displayed.
3 Click Yes. The selected screen ID associations are deleted from the list.

Settings
Use this option to edit the context application settings. On the Settings overlay, all settings for the
current context application are displayed. You cannot add or delete these settings. You can only edit
the settings' values.

Infor Operating Service Administration Guide | 65


Infor Ming.le administration

Editing a setting
To edit a setting:
1 Select the check box next to one or more settings to edit.
2 Click the Value field.
3 Click Delete to remove the current value.
4 Enter a new value.
5 Click Done. All selected settings are updated with the new values.

Utility apps
Utility apps are lightweight applications that display information unrelated to content in the application
frame. These applications do not communicate with the application frame and, if activated, only show
whenever this application is open.
There are no default utility applications for non-Infor application types. Therefore, no utility applications
are displayed under the Utility Apps section. You can add other utility applications to the current
application in the portal by using Add/Remove Utility Applications option. The maximum number of
utility applications allowed to display under the Utility Apps section is 20 per application instance.

Add/Remove Utility Applications


Use the Add/Remove Utility Applications option to add other utility applications to the current
application or to remove other utility applications from the current application in the portal.
The Add/Remove Utility Applications overlay has these panels:
• Available
• Selected

Adding a utility application


To add a utility application:
1 Select one or more utility applications. The selected utility applications are highlighted.
2 Click the right arrow to move the selected utility applications to the Selected panel.
3 Click Done. The selected utility applications are added to the Utility Apps section.

Removing a utility application


To remove a utility application:
1 Select one or more utility applications. The selected utility applications are highlighted.
2 Click the left arrow to move the selected utility applications to the Available panel.
3 Click Done. The selected utility applications are removed from the Utility Apps section.

Logical ID Fallback

Infor Operating Service Administration Guide | 66


Infor Ming.le administration

By default, no logical ID fallbacks are displayed under the Logical ID Fallback tab. You can add or
delete logical ID fallbacks to the list at any time.

Adding a logical ID fallback


To add a logical ID fallback:
1 Click Add ID. The Add New Logical ID Fallback overlay is displayed.
2 Specify an Incoming Logical ID.
3 Click Add. A new logical ID fallback is added to the list.

Deleting a Logical ID fallback


To delete a logical ID fallback:
1 Select one or more check boxes for the incoming logical IDs.
2 Click Delete. A confirmation message is displayed.
3 Click Yes. The selected incoming logical IDs are deleted from the list.

Delete Application
Click Delete Application to remove an application from the Applications panel. If you want to add the
same application back to the Application panel, use the Add Application option.
The application can be:
• Infor Application
• Non-Infor Application

Deleting an application
To delete an application:
1 Click an application to select it. The Delete Application option is displayed.
2 Click Delete Application. A confirmation message is displayed.
3 Click Yes. The selected application is deleted from the App Switcher panel and cannot be accessed
by any user.

Manage Context/Utility Apps


You access the Manage Context/Utility Apps landing page by clicking the Manage Context/Utility
Apps link on the Admin Settings page.

Infor Operating Service Administration Guide | 67


Infor Ming.le administration

The context and utility applications are gadgets or mini applications that provide information at a glance
and easy access to frequently used tools. Once added, they display in the right panel and are readily
available to the user while working on any application page in Infor Ming.le.
The Manage Context/Utility Apps landing page displays a list of all default context and utility apps
and any other context and utility apps that you have added. From this page, you can add and view
context and utility app details.

Viewing details
The details page is displayed after you add a context or utility application or after you click a context
or utility application from the list view page:
• For a manually added context or utility application, the top section of the details page displays Name,
Type, Description, URL, and Help URL fields. These are editable fields.
• For a default context or utility application, the top section of the details page displays only Name,
Type, and Description fields. These are non-editable fields.

Permissions - CE Administration viewing details


You can add and delete permissions on the Permissions tab. The user/security roles that you add on
this tab have permission to see the context or utility application on the right panel of the application
page.

Adding users and User Management security roles


To add users and User Management security roles:
1 Click Add Users and /or IFS Security Roles.
2 Type the user’s name or security role name.
3 Click Done.
4 Click Save.

Granting access to all users


To grant access to all users, select the Grant access to all users check box and click Save. When
this check box is selected, all users who have permission to access the application can see this
context/utility application.

Deleting users and User Management security roles


To delete users and User Management security roles:
1 Select the users or security roles to delete.
2 Click Delete.
3 Click Yes on the confirmation overlay.

Infor Operating Service Administration Guide | 68


Infor Ming.le administration

Note: The Assign Permissions option is reserved for future use.

Context Messages
All default context messages are displayed under the Context Messages tab. You cannot delete
default context messages, but you can add and delete custom context messages.

Adding a context message


To add a context message:
1 Click Add Message.
2 Enter a message name.
3 Click Done.
4 Click Save.

Deleting a context message


To delete a context message:
1 Select one or more context messages to delete.
2 Click Delete.
3 Click Yes on confirmation overlay.

Settings
All default settings are displayed under the Settings tab. You can edit the default values. If no default
settings are defined, the Settings tab is not visible.

Application
All of the default application's associations with the context or utility application are displayed on the
Application tab. You cannot delete the default application's associations.
You can add and remove the application's associations for any other applications.

Enabling applications
The context applications can be enabled or disabled by default. To enable or disable the associated
applications, select or clear the Enabled check box and click Save.

Adding and removing applications


To add or remove a context or utility application's access to an application:
1 Click Add/Remove Application.

Infor Operating Service Administration Guide | 69


Infor Ming.le administration

2 Select an application to add in the left panel.


3 Click the right-pointing arrow to move the application to the Selected panel.
4 Repeat steps 2 and 3 to add more applications.
5 Select an application you want to remove in the right panel.
6 Click the left-pointing arrow to remove the application from the Selected panel.
7 Repeat steps 5 and 6 to remove more applications.
8 Click Done.
9 Click Save.

Deleting an application's association


To delete an application’s association:
1 Select one or more applications to delete.
2 Click Delete.
3 Click Yes on the confirmation overlay.

Save
Click Save to save all changes. When you click Save, a message is displayed to confirm that your
settings are saved.

Delete
You cannot delete a default context or utility application; therefore, no Delete option in available from
the details page. You can, however, delete a manually created context or utility application. A Delete
option is displayed in the top section of the details page for the manually created context and utility
applications.

Deleting a manually created context or utility application


To delete a manually created context or utility application:
1 Select an application to delete.
2 Click Delete..
3 Click Yes on the confirmation overlay.

Adding context and utility applications


The context and utility applications that you add can be associated with any application. Once added,
they are then available to users in the right panel of the Application page.

Infor Operating Service Administration Guide | 70


Infor Ming.le administration

Adding a context or utility application


To add a context or utility application:
1 Click Add Context/Utility App.
2 Provide these details:
• Type (required)
• Name (required)
• Description (required)
• URL (required)
• Help URL (optional)
3 Click Save.

Cancel
Click Cancel on the details page to navigate back to the list view page.

Managing drillbacks
The Manage Drillbacks option allows you to view and upload drillback view definition files. Drillbacks
are a mechanism by which links are created from one Infor application to another while running inside
Infor Ming.le. By default, a listing of drillback view files is displayed. Drillback view files can be present
only for Infor applications.
You can sort the list view of the Manage Drillbacks page by clicking the headers of the table.
You can filter the listing by typing in the text box within the header the search term you want to find.

Drillback view details


Clicking a drillback view entry from the list displays the details.
Driilback view files can be deleted if the drillback view file is uploaded in the portal. Use the Delete
option.
You can sort the details view of the Drillbacks view page by clicking the headers of the table.
You can filter the listing by typing in the text box within the header the search term that you want to
find.

Uploading drillbacks
Use the Upload Drillback XML button to open a file browser to select an XML file that contains the
drillback views. The new entry is displayed at the bottom of the drillback list view.

Infor Operating Service Administration Guide | 71


Infor Ming.le administration

General Settings
Use the General Settings option to set up automatic general settings. By default, email notifications
are not enabled. Users have the option to enable or disable the different types of email notifications
on their user profile page.
You can set these options:

Search settings Description


When searching include • This setting enables the search to the full
• Post Contents, and tags contents of the message or post.
• Tags only • This setting enables the searches based on
tags only.
Enable substring search This setting expands the users’ current search
functionality to search with substrings.

Display settings Description


Sort the user names on directory page by This setting determines the default option to be
used to sort the users’ names on the directory
page, listing them alphabetically by first or last
name. By default, it is set to First Name.
Maximum upload size for images and attach- This setting sets the maximum size of images
ments (in kilobytes) and files that can be uploaded.
Maximum size for profile pictures (in kilobytes) This setting sets the maximum size for the profile
picture.
Add Maximum Number of Alerts Displayed This setting determines the maximum number of
alerts displayed on the alerts page.
Add Maximum Number of Tasks Displayed This setting determines the maximum number of
tasks displayed on the tasks page.
Auto Refresh interval (in seconds) This setting sets the time (in seconds) between
page refreshes.
Restrict Out of Office Feature This setting removes the Out of Office feature
from the User Settings page.

Infor Operating Service Administration Guide | 72


Infor Ming.le administration

System settings Description


Enable Push Notifications Service This setting enables or disables the push notifica-
• Upload Credentials tions service.
• View Credentials • To upload the credentials (.ionapi file that you
download from an Infor Xtreme incident).
Refer to Infor Xtreme Knowledge Base article
1902398 to configure the push notification
service for your tenant.
See Configuring your tenant with the Mobile
Push Notification Service on page 75 for more
information.
• To view the credentials that have been previ-
ously uploaded.
ION Service URL This setting sets the URL that points to the Infor
ION server.
Graph Engine Message Queue This setting sets the folder location of the Graph
Message Queue.
Notification Engine Message Queue This setting sets the folder location of the Graph
Notifications.
Federation Services Timer Service URL This setting sets the URL for the Federation
Services Timer Service that is used to synchro-
nize users with Active Directory.
Tenant Logical ID This setting sets the logical ID of the Infor Ming.le
instance.
Cache expiration for messages and posts (in This setting sets the time in minutes after which
minutes) the cached messages and posts expire.
Time to cache ION task items (in seconds) This setting sets the time in seconds after which
the cached ION task items expire.
Number of users and groups to show in the drop- This setting sets the number of users and groups
down menu displayed in any drop-down menus.

Template creation parameters Description


Maximum number of steps per template This setting sets the maximum number of steps
allowed in each template created.
Maximum number of widgets per step This setting sets the maximum number of widgets
allowed in each step.

Infor Operating Service Administration Guide | 73


Infor Ming.le administration

Email Settings Description


Enable email notifications This setting enables or disables the option to al-
low Infor Ming.le to send email notifications to
users. This option must be selected for the other
email settings to work.
Enable email for Infor Ming.le activity summary This setting enables or disables the option to al-
low Infor Ming.le to send automatic daily activity
summary emails to your users.
SMTP server name This setting sets the SMTP server name of your
email server.
SMTP server port This setting sets the SMTP server port of your
email server.
User Anonymous Logon Select this option if your SMTP server does not
require a user name or password to log on.
SMTP user name This setting sets the SMTP user name that Infor
Ming.le uses to log on to the SMTP server.
SMTP Password This setting sets the SMTP password that Infor
Ming.le uses to log on to the SMTP server.
Use secure connection Select this option if your SMTP server requires
a secure (https) connection.
Email Sender Display Name This setting sets the alias of the name that shows
in the Infor Ming.le user’s email inbox as the email
sender.
Default email address This setting sets the email address that shows in
the Infor Ming.le user’s email inbox as the email
sender.
Infor Ming.le URL This setting sets the Infor Ming.le URL that is
used in any links within emails sent by Infor
Ming.le.
Infor Ming.le external URL This setting sets the Infor Ming.le URL that is
used in any links within emails sent by Infor
Ming.le to users who are external to your compa-
ny.
Language This setting determines the Infor Ming.le and
email language.
Time Zone This setting determines the Infor Ming.leand email
time zone.
Locale This setting determines the Infor Ming.le and
email locale.

Infor Operating Service Administration Guide | 74


Infor Ming.le administration

Email Settings Description


Email legal disclaimer This setting sets the legal disclaimer that is ap-
pended to each email that is sent by Infor Ming.le.
Sort the user name on directory page by This setting determines the default option to be
used to sort the users' names.
Display prompt when the user leaves the applica- This setting controls the display of the prompt
tion that warns the user that data entered may not be
saved when closing the window or leaving the
application.

Configuring your tenant with the Mobile Push Notification Service


An Infor Ming.le multi-tenant cloud environment has all of the configuration and infrastructure to connect
to platform-specific push notification services such as Apple Push Notification Service (APNs), Google
Cloud Messaging (GCM), and Windows Notification Service (WNS) for Infor Ming.le mobile applications.
For the push notification service to work within an on-premises environment, the on-premises instance
must call an Infor ION API running in a multi-tenant cloud environment. An authorized application with
a Backend Service type must be created in a multi-tenant cloud environment, and credentials must be
imported into an on-premises instance.
For every on-premises customer, a single backend service is created for each environment, and
corresponding credentials are provided to them.

Setting up the push notification feature


1 You must create an Infor Xtreme incident requesting Push Notification Service configuration. You
must create an incident for each environment type, for example, Test and Production.
Include the Infor OS version and environment type details on the Infor Xtreme incident.
An exclusive backend service is created specifically for you to download the credentials.
A copy of the credentials (.ionapi file) is attached to the Infor Xtreme incident.
2 Download the credentials zip file from the Infor Xtreme incident and save the zip file locally.
3 Log into your Infor Ming.le On-Premises edition.
4 From the User Menu, select Admin Settings > General Settings.
5 Select the Enable Push Notification Service check box.
6 Click Upload Credentials to upload the .ionapi file, extracted from the zip file that you saved.
7 Save your settings.

Infor Operating Service Administration Guide | 75


Infor Ming.le administration

User Management
User Management is accessed through the User Management menu option on the profile panel. This
option is available to the user who has one of these security roles:
• IFSApplicationAdmin
• DataAdministrator
• UserAdmin
• Infor-SystemAdministrator
To access User Management:
1 Click the profile icon to access the profile panel.
2 Click User Management.
The User Management application provides the capability for Infor applications to manage users. The
users for the Infor applications are first created within User Management. The user information is then
replicated across the different Infor applications.
The User Management application has the concepts of users, security roles, distribution groups,
accounting entities, and locations.
User Management has these menu options:
• Manage
• Configure
• Security Administration
• Metadata
• Applications
This table describes the functionality of each menu option.

Infor Operating Service Administration Guide | 76


Infor Ming.le administration

Menu option Use this menu to:


Manage > Users View and manage users including:
• Adding users from the identity repository
• Uploading users
• Syncing users
• Importing and exporting users
• Activating, disabling, and deleting users
• Assigning/Un-assigning:
• Security roles
• Accounting entities
• Locations
• Distribution groups
• Custom properties
• ERP Person IDs
• Client access (access can be revoked)
• Viewing user activity
• Exporting all users
• Activating users (this option is displayed only
when Create Users in Draft Status is en-
abled)
• Searching users by using Simple or Advanced
Search
Manage > External users View and manage external users who belong to
your system by way of Infor Communities at
Id.Infor.Com:
• Adding external users
• Activating and deactivating external users
• Searching for external users
Manage > Client Access View and manage clients that users have used
to access Infor Ming.le:
• Revoking client access
• Searching for clients
Manage > Service Accounts View and manage accounts that have been cre-
ated to allow applications a resource owner grant
to contact the Infor Authorization Service to obtain
a token for use in making API requests.
Manage > SCIM Accounts View and manage accounts that have been cre-
ated to access Infor Ming.le SCIM services.
Manage > ERP Person IDs View and manage the ERP person IDs that have
been added to your users.

Infor Operating Service Administration Guide | 77


Infor Ming.le administration

Menu option Use this menu to:


Manage > Contacts View and manage contacts including:
• Adding contacts
• Deleting contacts
• Assigning contacts to contact groups
Manage > Groups View and manage contact groups including:
• Adding contact groups
• Importing and exporting contact groups
• Deleting contact groups
• Assigning contacts to contact groups
Manage > Groups View and manage groups (previously named
distribution groups) including:
• Adding groups
• Importing and exporting groups
• Deleting groups
• Assigning users to groups
Manage > Groups > Identity Repository Groups View and manage identity repository groups in-
cluding:
• Adding identity repository groups
• Deleting identity repository groups
• Syncing users from identity repository groups
Configure > Master Data Types > Security Roles View and configure security roles including:
• Adding security roles
• Importing and exporting security roles
• Deleting security roles
• Assigning users to security roles
• Assigning documents to security roles
• Assigning groups to security roles
Configure > Master Data Types > Accounting View and configure accounting entities including:
Entities • Assigning users to accounting entities
• Assigning groups to accounting entities
Configure > Master Data Types > Locations View and configure locations including:
• Assigning users to locations
• Assigning groups to locations
Configure > Document Authorizations View and configure document authorizations in-
cluding assigning security roles to documents.
Security Administration > Identity Repositories > View and configure AD parameters including:
AD Parameters • Adding AD parameters
• Deleting AD parameters

Infor Operating Service Administration Guide | 78


Infor Ming.le administration

Menu option Use this menu to:


Security Administration > Identity Repositories > View and configure SCIM parameters to get and
SCIM Parameters publish users.
Security Administration > IFS Person ID View and configure the default setting for IFS
Person ID.
Security Administration > Session Configuration View and manage the idle session time-out de-
> Time-out tails.
Security Administration > External Users View and manage Infor communities parameters.
Security Administration > Settings > General View and configure other general settings:
Settings • SCIM configuration
• Manage features
1 Enable SCIM Service
2 Enable IFS Audit
3 Configure Open LDAP
4 Publish SecurityUserMaster BOD
5 Configure User Synchronization Interval
(min)
6 Ignore users that have an empty UPN
7 Allow Import
8 Enable capability to send emails with differ-
ent URLs
9 Use Idp Sign Out feature
• Account creation status
Create users in draft status.
• Application specific settings
Do not auto-generate a user alias while creat-
ing users.

Metadata > User Properties View and configure options for user properties.
Applications View deployed applications and associated secu-
rity roles.

Infor Operating Service Administration Guide | 79


Infor Ming.le administration

Manage Users

Users
All users who need access to Infor applications must be added as a user to User Management and
assigned a specific role. The system does not come with a predefined list of users.
The first set of a customer's users, referred to as bootstrap administrators, must be added while installing
and configuring Infor OS Installer.
Later, the customer's administrators can add and manage other users.
The Users page displays all users that are currently added to your User Management system. You can
add users and apply an action to a user or group of users. The actions available are:
• Activate Draft User (enabled for users created in Draft status)
• Activate
• Disable
• Delete
The “Definition Complete” column in the user's list view indicates whether all the mandatory user
properties are defined. The red icon indicates that some of the mandatory properties are not defined.
The green icon indicates that all the mandatory properties are defined for a given user.

Adding users
1 Click Add new item. The Add Users overlay is displayed.
2 Specify the path.
3 Optionally, select a User Filter.
4 Enter a search term and click the load button to load matching users from the configured identity
repository.
5 Select one or more users to be added and click Add.

Importing users
You can import users and their associated security role by clicking the import icon.
The supported file types are .csv and xml. The .csv file must contain a header. The supported variables
in the header are:
• PersonId
• EmailId
• FirstName
• LastName

Infor Operating Service Administration Guide | 80


Infor Ming.le administration

• Title
• Department
• UserAlias
• Status (Active, Inactive, and Draft)
• UserName
• UserIdentifier
• UPN
• Picture
• MinglePicture
• GenericProperty_<PropertyName>
• SecurityRole1, SecurityRole2, SecurityRole3,...SecurityRoleN
This table lists the field mapping of headers and columns in the .csv and xml file with the user properties:

Field name in import file Mapping in IFS


PersonId The IFS Person ID displayed on the user details page
EmailId The Email Address displayed on the user details page
FirstName The First Name displayed on the user details page
LastName The Last Name displayed on the user details page
Title The Title displayed on the user details page
Department The Department displayed on the user details page
UserAlias The M3 User Alias displayed on the user details page
Status The Status displayed on the user's listing page
UserName This is not displayed in the user interface
UserIdentifier The User ID displayed on the user details page
UPN The UPN displayed on the user details page
Picture The image on the user details page if MinglePicture is
not provided
MinglePicture The image on the user details page (this takes prece-
dence over Picture)
GenericProperty_<PropertyName> The property for the Landmark Actor ID and LN User are
displayed on the user details page. All the other proper-
ties are displayed under the Additional Properties tab
on the user details page.
SecurityRole1, SecurityRole2….Security- The security roles association is displayed under the
RoleN Security Role tab on the user details page

The UserIdentifier and UPN fields are required in the header row.

Infor Operating Service Administration Guide | 81


Infor Ming.le administration

Note: If you want to add Security Roles or Generic Properties through this import process, you must
use the XML file format. While importing with the CSV file format, Security Roles or Generic Properties
that do not exist in the system are ignored.
To append a domain to a user identifier, you must enter the domain name in the text box.
To update existing users, you must select the Update existing users check box.
To activate deleted users, you must select the Activate deleted users check box along with the Update
existing users check box. These options are disabled when the Create Users in Draft Status setting
is enabled.
To disable current users who are not in the import file, you must select the Disable users that
are not present in the import check box.
The import results are displayed in a popup window after the import process is successfully completed.
The results include the count of users that were created, skipped, and updated. The Download Results
link provides the results for each entry in the import file along with its result.

Caution: A user's email address must be unique. An email address cannot be shared between users.

Exporting users
You can export selected users and their associated security role by selecting the users, clicking the
export icon, and selecting the file format to use for the export: CSV or XML.
You can export all users and their associated security roles by clicking Export All Users and selecting
the file format to use for the export: CSV or XML.
When you select the Include deleted user(s) check box, the export file provides a list of all users
active at any given time even if that user has subsequently been deleted.
Note: If you are exporting users from one Infor Ming.le User Management to import into another Infor
Ming.le User Management system, the recommended file format is XML. The XML file format enables
you to add Security Roles or Generic Properties in the new system.

Uploading users
An Upload option is available in the user listing page when the User Selection parameter is set to
Manual.
Clicking Upload displays a popup window. In this window, the user must select an identity repository
path and a .csv file (comma separated file) and then click Upload to start uploading users.
All users in the .csv file are checked against the identity repository, using the value in the UserIdentifier
column. A user is added to User Management if a match is found. Any user that is not found is reported.
Note: The .csv file contains only one UserIdentifier column.

Infor Operating Service Administration Guide | 82


Infor Ming.le administration

Applying actions to users


The Action menu has multiple options to apply actions to the selected users. Each menu option is
enabled only when every selected user meets the rules for that particular action.
The Action menu consists of these options:
• Activate Draft User
• Activate
• Disable
• Delete

Activate a draft user


To activate a draft user:
1 Select one or more users. The users must be in Draft status.
2 Select Action > Activate Draft User. The status of the users is now Active.
Note: The status of the user can be moved from Draft to Active only if all mandatory user properties
are entered.

Bulk activate draft users


To bulk activate draft users:
1 Select Activate All Users displayed on the header when the Create users in draft state setting
is enabled.
2 Click Yes to start moving all users from Draft to Active status. The users for whom all of the
required properties are set are moved. When the process is completed, a summary is displayed in
the popup window.
3 Click Download Results to download a report of the results.

Activate a disabled user


To activate a disabled user:
1 Select one or more users who are in Disabled status.
2 Select Action > Activate. The status of the users is now Active.

Disable
To disable a user:
1 Select one or more users to disable. The users must have an Active status.
2 Select Action > Disabled. The users' status is now Disabled.

Infor Operating Service Administration Guide | 83


Infor Ming.le administration

Delete
To delete a user:
1 Select one or more users to delete.
2 Select Action > Delete. The users are deleted. If a new user is added at a later time and the new
user has the same email address as that of a deleted user, a warning message is displayed asking
if you want to re-add the deleted user.

Syncing users
The Sync option is available for these selections of the User Selection parameter in the AD Parameters
configuration:
• Manual
For the Manual user selection, clicking Sync synchronizes (updates) only the information of those
users already available from the identity repository with the User Management application.
• All Users
For the All Users selection, clicking Sync synchronizes the information of the identity repository
users with the User Management application. Users can be inserted or updated. Users are not
deleted during a synchronization action.

User details
The user details page contains these tabs:
• Details
• Security Roles
• Accounting Entities
• Locations
• Groups (previously named Distribution Groups)
• EAM Templates - if the Infor EAM application is provisioned
• HMS Templates - if the Infor HMS application is provisioned
• ERP Person IDs
• Additional Properties
• Client Access
• Activity
Note: Any changes made to a tab must be saved from that tab before you select a different tab. A
warning message is displayed if you try to switch tabs without saving.
When you click the drill-down icon next to a user, these user details are displayed:

Infor Operating Service Administration Guide | 84


Infor Ming.le administration

Field Description
First Name The user's first name is used in the Infor Ming.le
user profile.
The first name is not editable.
Last Name The user's last name is used in the Infor Ming.le
user profile.
The last name is not editable.
Email Address The user's email address is displayed as read-
only.
Caution: A user's email address must be
unique. An email address cannot be shared
between users.

UPN The UPN is displayed as read-only.


User ID The user's unique ID that is used when the user
signs in to the system. The user ID is not editable.
IFS Person ID The IFS Person ID is used as the user identifier
in Infor ION. This feature links the Infor
Ming.leInfor Ming.le user with the Infor ION
BODs.
By default, the IFS Person ID is set to the IFS
User GUID. If you must edit the IFS Person ID,
you can make the IFS Person ID editable by
changing the IFS Person ID setup to No Auto-
matic Setting on the IFS Person ID page
accessed from the Security Administration >
IFS Person ID menu. If you make changes, click
Save item.
Landmark Actor ID This is the user’s actor ID that is used by the
Landmark application. The status of this field can
be set to Mandatory or Optional based on the
setting in Metadata > User Properties > Actor
ID.
Note: This field is not displayed if the Landmark
application is not deployed.
Title The user's title is used in the Infor Ming.le user
profile.
This a read-only field.
Department The user's department is used in the Infor Ming.le
user profile.
This a read-only field.

Infor Operating Service Administration Guide | 85


Infor Ming.le administration

Field Description
Manager The user's manager is notified of tasks and alerts
assigned to the user when escalation occurs. The
manager must first be set up in the identity
repository before being assigned to a user. This
a read-only field.
Alternative Manager The user's alternative manager is notified of tasks
and alerts assigned to the user when escalation
occurs and the user's manager is not available.
The alternative manager must first be set up in
the identity repository before being assigned to
a user. The alternative manager can be updated.
IFS User GUID The IFS User GUID is the globally unique identi-
fier of the user.
M3 User Alias The M3 user alias is another identifier that can
be associated with the user. The value must be
in capital letters, and the number of characters
must be fewer than or equal to 10. UTF-8 charac-
ters are supported, but these characters are not
allowed: (/ ? < > \ : * | " )
Caution: If a user’s M3 User Alias is blank,
you can add an M3 user alias. After you create
the M3 user alias, you cannot edit or change it.
This property can be defined as a required or as
an optional user property on the Metadata >
User Properties page.
LN User This is the user's ID that is used by the LN appli-
cation. The status of this field can be set to
Mandatory or Optional based on the setting
in Metadata > User Properties.
Note: This field is not displayed if the Infor LN
application is not deployed.
Picture The user's picture is used in the Infor Ming.le
user profile.
Email Opt Out The user's email opt out setting is enabled when
the user selects the Email Opt Out link in any
Infor Ming.le email that is sent to the user.

Security Roles tab


Use the Security Roles tab to add or remove existing security roles to or from a user.

Infor Operating Service Administration Guide | 86


Infor Ming.le administration

Adding a security role to a user


To add a security role to a user:
1 From the Security Roles tab in User details, click Add new item.
2 On the Select Security Roles overlay, select one or more security roles.
3 Click Add on the Select Security Roles overlay to add the selected security roles. The overlay
remains open so that you can add more security roles. To add selected security roles and then
close the overlay, click Add & Close.
4 Click Save Item on the Security Roles tab.

Removing a security role from a user


To remove a security role from a user:
1 From the Security Roles tab in User details, select the security roles to remove.
2 Click Delete selected item(s).

Accounting Entities tab


Use the Accounting Entities tab to add or remove existing accounting entities to or from a user.
See Accounting Entities for the default accounting entities and their definitions.

Adding accounting entities to a user


To add accounting entities to a user:
1 From the Accounting Entities tab in User details, click Add new item.
2 On the Select Accounting Entities overlay, select one or more accounting entities.
3 Click Add on the Select Accounting Entities overlay to add the selected accounting entities. The
overlay remains open so that you can add more accounting entities. To add selected security roles
and then close the overlay, click Add & Close.
4 Click Save Item on the Accounting Entities tab.

Removing accounting entities from a user


To remove accounting entities from a user:
1 From the Accounting Entities tab in User details, select the accounting entities to remove.
2 Click Delete selected item(s).

Locations tab
Use the Locations tab to add or remove existing locations to or from a user.
See Locations for the default locations and their definitions.

Infor Operating Service Administration Guide | 87


Infor Ming.le administration

Adding locations to a user


To add locations to a user:
1 From the Locations tab in User details, click Add new item.
2 On the Select Locations overlay, select one or more locations.
3 Click Add on the Select Locations overlay to add the selected locations. The overlay remains open
so that you can add more locations. To add selected locations and then close the overlay, click Add
& Close.
4 Click Save Item on the Locations tab.

Groups tab

Adding a group to a user


To add a group to a user:
1 From the Groups tab in User details, click Add new item.
2 On the Select Groups overlay, select one or more groups.
3 Click Add on the Select Groups overlay to add the selected groups. The overlay remains open so
that you can add more groups. To add selected groups and then close the overlay, click Add &
Close.
4 Click Save Item on the Groups tab.

Removing a group from a user


To remove a group from a user:
1 From the Groups tab in User details, select the groups to remove.
2 Click Delete selected item(s).

ERP Person IDs tab


The ERP Person IDs tab is populated by any of your ERP applications that publish the SYNC Person
BOD.
The ERP Person ID is used as the identifier of the user in the ERP application, and this feature allows
you to link the Infor Ming.le user to the ERP application user.
The ERP Person IDs tab displays ERP person IDs that are associated with this user. You can add
and delete ERP person IDs.

Adding an ERP Person ID


To add an ERP person ID:
1 Click Add new item. A new row is added to the table.
2 Enter the required information.

Infor Operating Service Administration Guide | 88


Infor Ming.le administration

3 Click Save item.

Removing an ERP person ID


To remove an ERP person ID:
1 Select the ERP person ID to be removed.
2 Click Delete selected item(s).

Additional Properties tab


The Additional Properties tab displays all of the additional properties that your ERP applications
requires.
If your ERP applications do not require custom properties, this page displays only the “MinglePicture”
property. The value in MinglePicture is populated with the value if the user has uploaded a picture on
User Settings page in Infor Ming.le.

Updating additional properties


To change the value of one of your custom properties:
1 Click the value of the custom property. This is a text field.
2 Edit the value as required.
3 Click Save Item.

Client Access tab


The Client Access tab displays information about the different clients that this user has used to access
Infor Ming.le. You can revoke access from a particular client, if needed.

Revoking access
To revoke access:
1 Select the client to be revoked.
2 Click Revoke Access and click Yes on the Revoke Access prompt.
The user is now logged out of the client or device, and the current session is terminated.

Activity tab
The Activity tab displays the history of the user's activity. A time stamp of when the activity was
performed and who performed the activity is also displayed.
These activities are logged:

Infor Operating Service Administration Guide | 89


Infor Ming.le administration

Activity Description
Account Created When a new user is created in IFS, then this activity is logged
with an activity description of “Account created.”
User account activated by administra- If the user account is inactive, then the IFS administrator has
tor the ability to activate the user’s account. Once the user’s
account is activated by the IFS administrator, then this activ-
ity is logged with the activity description of “User account
activated by administrator.”
User account deactivated by adminis- When the IFS administrator disables the user (makes the
trator user inactive) in IFS, then this information is logged with an
activity description of “User account deactivated by adminis-
trator.”
User deleted by admin If the IFS administrator deletes a user, then this user is re-
moved from IFS. This activity is logged in IFS with the activity
description of “User deleted by admin.”
User details updated by admin If any user property is updated, then this activity is logged
with the activity description of “User details updated by ad-
min.”
User logon successful Once the user is successfully logged on, then this activity is
logged with the activity description of “User logon successful.”
User logoff successful Once the user is successfully logged off (by clicking Sign
out from the profile menu), then this information is logged
with the activity description of “User logoff successful.”

External users
The External Users page displays all external users who have been invited to the Infor Ming.le
application. These external users are users with accounts managed at Infor Ming.le Communities
(Id.Infor.com). From this page, you can add, activate, disable, or delete an external user.
The external users functionality is controlled by the Security Administration > External Users page.
If Enable Infor Ming.le Communities identities functionality is selected, then only the External
Users tab is displayed under the Manage menu.
See External Users on page 120 for more information.
The External Users feature is used to extend conversations and information sharing to external parties
such as suppliers, customers, or others not directly employed by your company within the Infor Ming.le
platform.

Infor Operating Service Administration Guide | 90


Infor Ming.le administration

Adding an external user


To add an external user:
1 Click Add new item.
2 Enter the external user's email address.
3 Click Save.
The external user is available to be invited to participate within Infor Ming.le by your Infor Ming.le
users. The external user must first create an account at Infor Ming.le Communities (Id.Infor.com).
Infor Ming.le sends an automated invitation to the external user to participate in Infor Ming.le and
to create an account as required.

Activating an external user


To enable a previously disabled external user:
1 Select the user to be activated. The user must be in Disabled status.
2 Click Action > Activate.
3 Confirm that the selected user is enabled. The user now has an Active status.
4 Alternatively, click Activate All to activate all users.

Disabling an external user


To disable an external user:
1 Select the user to be disabled. The user must be in Active status.
2 Click Action > Disable.
3 Confirm that the user is disabled. The user now has an Disabled status.
4 Alternatively, click Disable All to disable all users.

Deleting an external user


To delete an external user:
1 Select the user to be deleted.
2 Click Action > Delete.
3 Confirm the deletion.
The selected user is removed from the list view.

Infor Operating Service Administration Guide | 91


Infor Ming.le administration

Client Access
The Client Access page displays information about the different clients all users in the system have
used to access Infor Ming.le.

Revoking access
You can revoke access to Infor Ming.le from a particular client, if needed.

Revoking access
To revoke access:
1 Select the client to be revoked.
2 Click Revoke Access and click Yes on the Revoke Access prompt.
The user is now logged out of the client or device, and the current session is terminated.

Service Accounts
The Service Accounts page displays accounts that have been created to allow applications a resource
owner grant to contact the Infor Authorization Service to obtain a token for use in making API requests.
The Service Accounts page has the following actions:
• Add
• Delete
• Enable
• Disable

Adding a service account


To add a service account securely.
1 Click Add new item. An access key and secret key are generated.
2 Optionally, add a description and select a user name.
3 Click Save Item.

Caution: A Download Service Account Credentials confirmation is displayed with the message
that your service account credentials are available for download. This is your only opportunity to
download your credentials. You are responsible for storing these credentials securely.

4 Download your credentials.

Infor Operating Service Administration Guide | 92


Infor Ming.le administration

Deleting a service account


To delete a service account:
1 Select one or more service accounts to delete.
2 Click Delete Selected Item(s).
3 Confirm the deletion.
Note: Any applications that have been allowed a resource owner grant to contact the Infor Authorization
Service to obtain a token for use in making API requests will no longer be able to obtain a token.

Enabling a service account


To enable a service account:
1 Select one or more service accounts to be enabled. The service accounts must be in Disabled
status.
2 Click Enable Selected Item(s).
3 Confirm the enablement.

Disabling a service account


To disable a service account:
1 Select one or more service accounts to disable. The service accounts must be in Enabled status.
2 Click Disable Selected Item(s).
3 Confirm that the service account is disabled.
Note: Any applications that have been allowed a resource owner grant to contact the Infor Authorization
Service to obtain a token for use in making API requests will no longer be able to obtain a token.

SCIM Accounts
The SCIM Accounts page displays the SCIM Service URL and allows you to create an SCIM user
identifier and password to be used in a third-party SCIM application. You can also delete an SCIM user
identifier and its associated password.
Using a third-party SCIM application allows you to load users to Infor Ming.le in an automated fashion.
Depending on your third-party application, you may also have the option to synchronize users.

Adding an SCIM user identifier and password


To add an SCIM user identifier and password:

Infor Operating Service Administration Guide | 93


Infor Ming.le administration

1 Click Add new item. A new row is added to the table.


2 Enter an SCIM password and confirm the password.
3 Click Save.
4 Confirm you are changing SCIM Credentials. The SCIM user identifier is generated for you.
Note: By default, the newest SCIM user identifier is at the top of the list.

Deleting an SCIM user identifier and password


To delete an SCIM user identifier and password:
1 Select the user identifiers that you want to delete.
2 Click Delete selected item(s).
3 Confirm the deletion.
Note: Upon deletion, any third-party SCIM application that is configured to use this SCIM user
identifier no longer works.

Updating the SCIM password


The user can update or edit the password of the existing record. This warning message is displayed:

If you change your SCIM credentials, any existing systems that are currently
using SCIM will no longer work. Are you sure that you want to change your
SCIM credentials?
Click Yes on the message dialog to continue updating the password.

ERP Person IDs


The ERP Person IDs page is populated by any of your ERP applications that publish the SYNC Person
BOD. The ERP Person ID is used as the Infor Ming.le user to the ERP application user.
The ERP Person IDs page displays all of the ERP person IDs that are associated with your users. You
can add and delete ERP person IDs.

Adding an ERP person ID


To add an ERP person ID:
1 Click Add new item.
2 Search for and select the user to whom to add an ERP person ID.
3 Type the ERP Person ID and ERP Accounting Entity. Optionally, enter a valid Logical ID.

Infor Operating Service Administration Guide | 94


Infor Ming.le administration

4 Click Add to add this user.


5 Add additional ERP person IDs as required.
6 Click Add & Close to add the selected users.
7 Click Save item.
The details added here are now reflected on the user details page of the selected user.

Deleting an ERP person ID


To delete an ERP person ID:
1 Select the user and ERP Person ID combination to delete.
2 Click Delete selected item(s).
3 Confirm the deletion.
The deletion is now reflected on the user details page of the selected user as the record is now
removed from the selected user's ERP Person IDs tab.

Contacts
The Contacts page displays all of the contacts that have been added to your User Management system.
Infor ION can assign tasks and alerts to contacts, who are not users in Infor ION. Contacts are external
users who cannot access Infor ION. A contact does not receive the alert but receives an email from
Infor ION.
You can add and delete contacts, and you can view the contact's ID, full name, email address, and
contact groups.

Adding a contact
To add a contact:
1 Click Add new item.
2 To add up to five contacts, click Add more contacts.
3 Enter the required contact details.
4 Optionally, select an existing contact group to assign to this contact.
5 Click Save.

Deleting a contact
To delete a contact:
1 Select the contact to be deleted.

Infor Operating Service Administration Guide | 95


Infor Ming.le administration

2 Click Delete selected item(s).


3 Confirm the deletion.

Viewing contact details


When you click the drill-down icon next to a contact, you can view the contact's details, which include
the contact's full name, email address, and contact ID. You can edit this information as required.
On the Contact details page, you can select a tab to view the contact group with which is a contact is
associated. You can add and delete the contact group associations for this contact.

Adding a contact group to a contact


To add a contact group association to a contact:
1 Click Add new item.
2 On the Add Contact Groups overlay, select the contact group to associate with this contact.
3 Click Save.

Deleting a contact group from a contact


To delete a contact group association from a contact:
1 Select the contact group association to be deleted.
2 Click Delete selected item(s).
3 Click Save.

Contact Groups
A contact group is a grouping of contacts. The Contact Groups page displays:
• The name and description of the group
• A total number of contacts mapped to the group
You can add, import, export, and delete contact groups from this page.

Adding a contact group


To add a contact group:
1 Click Add new item.
2 Enter the name of the contact group.

Infor Operating Service Administration Guide | 96


Infor Ming.le administration

3 Add a description of the contact group.


4 Optionally, add a contact to the contact group.
See Adding a contact to a contact group on page 98 for details.
5 Click Save.

Importing contact groups


You can import contact groups and their associated users by clicking the import icon.
The only supported file type is .csv. The .csv file must contain a header. The supported variables in
the header are:
• Name
• Description
• EmailId
The Name and Description fields are required in the header row.
To update existing contact groups, you must select the Update existing contact groups check box.
The import results are displayed in a popup window after the import process is successfully completed.
The Download Results link provides the results for each skipped entry along with its reason.

Exporting contact groups


You can export contact groups and their associated users by clicking the export icon. An Export master
nodes confirmation is displayed. The only supported file type is .csv.

Deleting a contact group


To delete a contact group:
1 Select the contact group to delete.
2 Click Delete.
3 Confirm the deletion.
No contacts can be mapped to a contact group that is deleted.
See Deleting a contact from a contact group on page 98 for details.

Viewing contact group details


To view the details of a contact group, click the drill-down icon for the contact group. The contact group
details page is displayed. This page displays:
• The name and description of the contact group

Infor Operating Service Administration Guide | 97


Infor Ming.le administration

The Name and Description fields are read-only fields.


• A listing of all contacts associated with the contact group
You can add and delete contacts associated with the contact group.

Adding a contact to a contact group


From the Add New Contact Group page or from the Contact Group details page, you can add a contact
to a contact group.
To add a contact to a contact group:
1 Click Add.
2 On the Assign Contacts to Contact group overlay, search for and select a contact.
3 Click Add to add the contact.
4 Add additional contacts as required.
5 Click Add & Close to add the selected contacts and close the overlay.
6 Click Save.

Deleting a contact from a contact group


From the Add New Contact Group page or from the Contact Group details page, you can delete a
contact from a contact group.
To delete a contact from a contact group:
1 Select the contact to be removed.
2 Click Delete selected items.
3 Click Save.

Groups
A group is a grouping of users. This is used in Infor ION to group users. The Groups page displays:
• The name and description of the group
• The total number of users mapped to the group
You can add, import, export, delete, and view the details of groups from this page.

Adding a group
To add a group:
1 Click Add new item.

Infor Operating Service Administration Guide | 98


Infor Ming.le administration

2 Enter the name of the group.


3 Enter a description of the group.
4 Optionally, specify whether the group should be automatically added to new users.
5 Optionally, specify whether the group should be added to existing users.
Note: Adding the group to existing users is a one-time setting for this instance only. When you
save the group, all users in the system are added. The next time you view this page, the Assign
to existing users option is available as more users may have been added to the system.
6 Optionally, add a user to the group.
See Adding a user to a group on page 100 for details.
7 Click Save.

Importing groups
You can import groups and their associated users by clicking the import icon.
The only supported file type is .csv. The .csv file must contain a header. The supported variables in
the header are:
• Name
• Description
• UserIdentifier
• GroupId
The Name and Description fields are required in the header row.
To update existing groups, you must select the Update existing groups check box.
The import results are displayed in a popup window after the import process is successfully completed.
The Download Results link provides the results for each skipped entry along with its reason.

Exporting groups
You can export groups and their associated users by clicking the export icon. An Export master nodes
confirmation is displayed. The exported file a .csv file.

Deleting a group
Note: A group cannot be deleted if users are assigned to it. See Deleting a user from a group on page
100 for details.
To delete a group:
1 Select the group to delete.
2 Click Delete.
3 Confirm the deletion.

Infor Operating Service Administration Guide | 99


Infor Ming.le administration

Copying a group
To copy an existing group:
1 Select a record from the list view.
2 Click the copy icon.
3 Specify a name and description for the new group.
The value in the Name field must be unique.
This information is copied to the new group:
• Assign to New Users check box
The copied check box is selected.
• Assign to All Users check box
The copied check box is cleared.
• All associated users
• All associated groups

Viewing group details


To view details of a group, click the drill-down icon for the group. The Group details page is displayed.
This page displays:
• The name and description of the group
• A listing of all users and groups associated with the group
You can add or delete users and groups associated with the group.

Adding a user to a group


From the Add New Group page or from the Group details page, you can add a user to a group.
To add a user to a group:
1 Click Add.
2 On the Assign Users overlay, search for and select a user.
3 Click Add to add the user.
4 Add additional users as required.
5 Click Add & Close to add the selected users and close the overlay.
6 Click Save.

Deleting a user from a group


From the Add New Group page or from the Group details page, you can delete a user from a group.
To delete a user from a group:

Infor Operating Service Administration Guide | 100


Infor Ming.le administration

1 Select the user to be removed.


2 Click Delete selected items.
3 Click Yes in the confirmation dialog to delete the user.

Adding an identity repository group to a group


From the Add New Group page or from the Group details page, you can add an identity repository
group to a group.
To add an identity repository group to a group:
1 Click Add.
2 On the Assign Groups overlay, search for and select a group.
3 Click Add to add the group.
4 Add additional groups as required.
5 Click Add & Close to add the selected groups and close the overlay.
6 Click Save.

Deleting an identity repository group from a group


From the Add New Group page or from the Group details page, you can delete an identity repository
group from a group.
To delete an identity repository group from a group:
1 Select the identity repository group to be removed.
2 Click Delete selected items.
3 Click Yes on the confirmation dialog.

SCIM Groups
The SCIM Groups page displays a listing of all the SCIM groups added to your system. This page
displays:
• The name and description of the SCIM group
• The number of mapped users to the SCIM group
• The number of mapped security roles
You can view details of a SCIM group and map security roles to the SCIM group from this page.

Field Description
Name This is the name of the SCIM group. This is pro-
visioned by the SCIM agent. This is read-only.

Infor Operating Service Administration Guide | 101


Infor Ming.le administration

Field Description
Description This is the description of the SCIM group. This
is provisioned by the SCIM agent. This is read-
only.
Users These are the users who belong to the SCIM
group. The users are assigned to the group by
the SCIM agent. This is read-only.
Security Roles Users in the SCIM group are automatically asso-
ciated with the Security Roles. Security roles can
be associated or unassociated.

Adding a security role to a SCIM group


From the edit SCIM Group details page, you can add a security role to a SCIM group:
1 Click the Security Role tab.
2 Click the (+) icon.
3 Select security roles to add.
4 Click Add & Close to add the selected security roles.
5 Click Save.

Removing a security role from a SCIM group


From the edit SCIM Group details page, you can remove a security role from a SCIM group:
1 Click the Security Role tab.
2 Select one or more security roles.
3 Click the delete icon.
4 Confirm the deletion.
5 Click Save.

Identity Repository Groups


You can add and delete identity repository groups from this page.

Adding an identity repository group


To add an identity repository group:

Infor Operating Service Administration Guide | 102


Infor Ming.le administration

1 Click Add new item.


2 Select the path.
3 Optionally, select the group filter.
4 Filter the groups by using the Search text box.
5 Click Load.
6 Select the check box of the group that you want to register.
7 Click Add to continue registering groups.
8 Click Add and Close to register the selected groups.
9 Click Save.
The selected groups are added to the Identity Repositories list view.

Deleting an identity repository group


To delete an identity repository groups
1 Select the identity repository group to delete.
2 Click Delete.
3 Confirm the deletion.

Syncing users from an identity repository group


To use the automated synchronization process to add users from a selected identity repository group
to User Management:
1 Select the Sync Users check box.
2 Click Save.
The next time the automated synchronization process runs, all users from the selected identity
repository groups are added to User Management. Any changes to the identity repository group is
reflected in User Management as long as the Sync Users check box is checked.

Security Roles
The Security Roles page displays a listing of all security roles added to your system. The
application-specific security roles are added at the time of deploying or provisioning an application to
your system.
This page displays:
• The name and description of the security role
• An indicator to show if the security role is assigned to new users
• The application type of an application that triggered the creation of the security role
• The logical ID of an application that triggered the creation of the security role

Infor Operating Service Administration Guide | 103


Infor Ming.le administration

• The total number of mapped users and mapped documents in each security role
You can add, import, export, delete, and view details of a security role from this page.
Note: The default roles can be deleted.

Security Roles Specific to User Management (Infor Federation


Services)

Infor-SystemAdministrator
The “Infor-SystemAdministrator” is a system-wide role that applies to all Infor applications. Each user
who is assigned to this role is considered as the administrator for every application that is in the system
and, therefore, has access to all the applications, including User Management and Admin Settings.
Users cannot remove this role from their own user details.

IFSApplicationAdmin
Users who have this role can see the User Management menu item under the profile menu.
“IFSApplicationAdmin” is the administrator role for User Management.
This role is added to every administrator that is provisioned to a tenant. Users assigned to this role
have full permission to all the screens in User Management.
Users cannot remove this role from their own user details.
Users with this role can manage users, external users, contact groups, and distribution groups. They
can revoke client access and manage service accounts and SCIM accounts. They can manage security
roles, accounting entities, locations, and custom master data types. They also have access to the
Document Authorization page, which allows them to view document types and assign document types
to security roles.

DataAdministrator
Users who have this role can see the User Management menu item under the profile menu.
“DataAdministrator” is a User Management role that allows users to manage security roles, accounting
entities, locations, and custom master data types. Users with this role also have access to the Document
Authorization page, which allows them to view document types and assign document types to security
roles.
Users with this role have access to these menu items and all the functionality in each menu item:
• Configure > Master Data Types > Security Roles
• Configure > Master Data Types > Accounting Entities

Infor Operating Service Administration Guide | 104


Infor Ming.le administration

• Configure > Master Data Types > Locations


• Configure > Master Data Types > (any custom Master Data Types)
• Configure > Document Authorizations
• Metadata > User Properties
• Metadata > Custom Master Data Type

UserAdmin
Users who have this role can see the User Management menu item under the profile menu.
“UserAdmin” is a User Management role that allows users to manage users, the ERP person identifier,
external users, contact groups, and distribution groups. Users with this role can revoke client access,
manage service accounts, and SCIM accounts.
Users with this role have access to these menu items and all the functionality in each menu item:
• Manage > Users
• Manage > External Users
• Manage > Client Access
• Manage > Service Accounts
• Manage > SCIM Accounts
• Manage > ERP Person IDs
• Manage > Contacts
• Manage > Contact Groups
• Manage > Groups (previously named Distribution Groups)
• Manage > Identity Repository Groups

Security Roles Specific to Infor Ming.le

Infor-SuiteUser
“Infor-SuiteUser” is the end-user role. This is the default role assigned to all the users. Users with this
role have access to the portal only. The portal is one of the components of the Infor Ming.le application.
The portal consists of a top level header, an app switcher panel, search, the user menu, share,
bookmarks, and a right panel (context/utility applications panel). The users with this role only do not
have access to the social space or ION-related features.

MingleEnterprise
The “MingleEnterprise” role provides access to the social space component of the Infor Ming.le
application. The social space component consists of activity feeds, connections, groups, streams, and
templates.
Users who have this role can do these actions:

Infor Operating Service Administration Guide | 105


Infor Ming.le administration

• View the activity feed page


• Post messages to colleagues and groups
• Create new groups
• Connect to users and groups
• Create a new instance of a stream

MingleAdministrator
“MingleAdministrator” is the role assigned to users to have access to administration pages in Infor
Ming.le.
By design, the “MingleAdministrator" role is added to all applications in the tenant. The user with this
role can view all application icons on the App Switcher panel. The user's ability to open the application
and access functionality, however, is controlled by the application security.
Users who have this role can see the Admin Settings menu item under the profile menu.
Users who have this role can do these actions:
• Manage applications
• Manage context/utility applications
• Manage drillbacks
• Manage general settings
The user with the “MingleAdministrator” role also needs the “MingleEnterprise” role in order to administer
some of the users’ related features in social space.
These users can also do these actions:
• Manage users’ feeds and groups’ feeds
• Delete any Infor Ming.le group
• Deactivate the users and groups and also reactivate them

MingleIONEnabled
“MingleIONEnabled” is a role that allows users to access ION-related features within Infor Ming.le.
ION-related components consist of alerts, tasks, ION notifications, workflows and social objects.
Users who have this role can do these actions:
• View alerts and perform all the actions in the alerts
• View tasks and ION notifications and perform all the actions in the tasks and ION notifications
• Start the workflows manually
• Search for social objects
Alerts and Tasks options are displayed in the user menu for the users who have this role.

Infor Operating Service Administration Guide | 106


Infor Ming.le administration

MingleStreamsTemplateCreator
The “MingleStreamsTemplateCreator” role allows users to create stream templates within the Infor
Ming.le application. The stream templates are then used to create stream instances.

Security Roles Specific to the ION Desk Application

IONDeskSecurityAdmin
The “IONDeskSecurityAdmin” role allows users to create profiles that define the level of access to ION
Desk and further link this profile to an IFS role.

IONDeskAdmin
The “IONDeskAdmin” role provides full access to ION Desk except the security administration pages.
Users with this role can model and manage the integration and business process management flows,
and they can configure ION settings.

Security Roles Specific to the ION API Application

IONAPI-Administrator
This role allows administrators to add, delete, and configure API suites and authorized applications in
ION API.

IONAPI-User
This role allows users to view API suites and authorized applications in ION API.

Security Roles Specific to the Homepages Application

HOMEPAGES-User
Users with this role have access to Homepages in Infor Ming.le. A Homepages user might have
permission to create private and published pages, published widgets, all depending on the current
settings configuration. Homepages users can only update and delete their own content.

Infor Operating Service Administration Guide | 107


Infor Ming.le administration

HOMEPAGES-Administrator
Users with this role are administrators in Infor Ming.le Homepages. An administrative user has access
to the Homepages Administration tools and has full permission to all published pages, private pages,
and published widgets. An administrator can fully modify any published page or widget and also delete
private pages for other users. In the Administration tools, the administrator can configure settings to
control permission for IFS security groups.

HOMEPAGES-ContentAdministrator
Users with this role are content administrators in Infor Ming.le Homepages. Content administrative
users have full permission to content-related tasks so that they can create published content and
manage published content. They can create, edit, and delete any published page or widget – not only
their own content. It is not mandatory to use this role as the administrator has full access to all content
as well. A content administrator does not have access to any of the Administration tools. Content
administrators can only manage content via the Page and Widget Library or by actions under the
Advanced section in the Homepages menu, for example the Import page.

Security Roles Specific to the Infor Document Management (IDM)


Application

IDM-User
This role is required for access to IDM user interfaces and APIs. It grants access to all documents
without specific access control lists that prevent access for generic IDM-Users.

IDM-AdvancedUser
This role is for an advanced user with access to advanced tools such as mass update, mass delete,
and export. Misuse of these tools can result in considerable damage if used by unskilled personnel.
This role does not grant privileged access to any content. This role implicitly includes the “IDM-User.”

IDM-Administrator
This role is for a user who can create and alter document types and configure IDM. This role does not
grant privileged access to any content. This role implicitly includes the “IDM-AdvancedUser.”

IDM-SuperUser
This role provides full access to documents in IDM. Users with this role bypass the security model and
have access to all content. Use with care since this user can access and edit any document in the

Infor Operating Service Administration Guide | 108


Infor Ming.le administration

system with no restrictions. Note that a user repository administrator can add people to this role. This
role implicitly includes the “IDM-User.”

IDM-RelatedInformationUser
This role grants access to the IDM Related Information contextual application. A user with this role is
not granted access to other IDM interfaces. This role does not affect access to content in IDM, but the
role can (as all roles can) be used in the Access Control Lists (ACL) to manage authorization (access
to content/documents) within IDM.

Adding a security role


To add a security role:
1 Click Add new item. The Add Security Role page is displayed.
2 Enter the name of the security role.
3 Enter the description of the security role.
4 To add the security role to each new user, click Assign to new Users.
5 To assign this security role to every user that is currently in your system, click Assign to all existing
Users.
6 Optionally, add users to the security role.
a On the Users tab, click Add new item.
b On the Assign users to Security Roles overlay, search for and select a user.
c Click Add.
d Add additional users as required.
e Click Add & Close to add selected users and close the overlay.
7 Optionally, add documents:
a On the Documents tab, click Add new item.
b Select the documents you are mapping to this security role and click Add.
8 Optionally, add identity repository groups:
a On the Identity Repository Groups tab, click Add new item.
b On the Assign Groups overlay, search for and select a group.
c Click Add.
9 Click Save.

Importing security roles


You can import security roles and the associated users and groups by clicking the import icon.
The supported file type is .csv. The .csv file must contain a header. The supported variables in the
header are:

Infor Operating Service Administration Guide | 109


Infor Ming.le administration

• Name
• Description
• UserIdentifier
• GroupId
The Name and Description fields are required in the header row.
To update existing security roles, you must select the Update existing security roles check box.
The import results are displayed in a popup window after the import process is successfully completed.
The Download Results link provides the results for each skipped entry along with its reason.

Exporting security roles


You can export selected security roles and the associated users and groups by clicking the export icon.
An Export master nodes confirmation is displayed. The exported file is a .csv file.

Deleting a security role


Note: All mapped users, mapped identity repository groups, and mapped documents must be removed
from the security role before you delete the security role. None of the default roles can be deleted.
To delete a security role:
1 Select the security role to be deleted.
2 Click Delete.
3 Confirm the deletion.
Security roles that are added through BODs cannot be deleted.

Copying a security role


To copy an existing security role:
1 Select a record from the list view.
2 Click the copy icon.
3 Specify a name for the new security role.
The value in the Name field must be unique.
This information is copied to the new security role:
• Assign to New Users check box
The copied check box is selected.
• All associated users
• All associated groups
• All associated documents
The Assign to All Users check box is not copied.

Infor Operating Service Administration Guide | 110


Infor Ming.le administration

Viewing security role details


To view security role details, click the drill-down icon for the security role. The security role details page
is displayed. This page displays:
• The name and description of the security role
• An indicator that the security role is assigned to new users
• An option to assign the security role to all existing users
Also there are tabs to list all users, documents, and groups associated with the security role. You can
add or remove users, documents, and groups associated with the security role.

Adding users to the security role


To add users to the security role:
1 On the User tab, click Add new item.
2 On the Assign users to Security Roles overlay, search for and select a user.
3 Click Add to add the user.
4 Add additional users as required.
5 Click Add & Close to add selected users and close the overlay.
6 Click Save.
The newly added users are now displayed on the security roles details page.

Removing users from the security role


To remove users from the security role:
1 On the Users tab, select the user to be removed.
2 Click Delete.
3 Confirm the deletion.
The deleted users are removed from the security roles details page.

Adding documents to the security role


To add documents to the security role:
1 On the Documents tab, click Add new item.
2 Select the documents to map to this security role and click Add.
3 Click Save.
The newly added documents are now displayed on the security roles details page.

Infor Operating Service Administration Guide | 111


Infor Ming.le administration

Removing documents from the security role


To remove documents from the security role:
1 On the Documents tab, select the document to be removed.
2 Click Delete.
3 Confirm the deletion.
The deleted documents are removed from the security roles details page.

Adding identity repository groups to the security role


To add identity repository groups to the security role:
1 On the Identity Repository Groups tab, click Add new item.
2 Search for the group to map to this security role and click Add.
3 Click Save.
The newly added identity repository groups are now displayed on the security roles details page.

Removing identity repository groups from the security role


To remove identity repository groups from the security role:
1 On the Identity Repository Groups tab, select the group to be removed.
2 Click Delete.
3 Confirm the deletion.
The deleted identity repository groups are removed from the security roles details page.

Accounting Entities
When a new accounting entity is created by an Infor application, the application publishes a
Sync.AccountingEntity BOD. IFS subscribes to the Sync.AccountingEntity BOD and maintains a list of
accounting entities. IFS does not provide a way in which users can manually create accounting entities
in the IFS user interface.
The Accounting Entities page displays a listing of all accounting entities added to your system. This
page displays:
• The name and description of the accounting entities
• The total number of mapped users and mapped groups in each accounting entity

Viewing accounting entities


To view accounting entities details, click the drill-down icon for the accounting entity. The accounting
entity details page is displayed. This page displays the name and description of the accounting entity.

Infor Operating Service Administration Guide | 112


Infor Ming.le administration

Also, there are tabs to list all users and groups associated with the accounting entity. You can add or
remove users and groups associated with the accounting entity.

Adding users to an accounting entity


To add users to the accounting entity:
1 On the User tab, click Add new item.
2 On the Assign Users to Accounting Entity overlay, search for and select a user.
3 Click Add to add the user.
4 Add additional users as required.
5 Click Add & Close to add selected users and close the overlay.
6 Click Save.
The newly added users are now displayed on the accounting entity details page.

Removing users from an accounting entity


To remove users from the accounting entity:
1 On the Users tab, select the user to be removed.
2 Click Delete.
3 Confirm the deletion.
The deleted users are removed from the accounting entity details page.

Adding identity repository groups to an accounting entity


To add identity repository groups to the accounting entity:
1 On the Identity Repository Groups tab, click Add new item.
2 Search for the group to map this accounting entity and click Add.
3 Click Save.
The newly added identity repository groups are now displayed on the accounting entity details page.

Removing identity repository groups from an accounting entity


To remove identity repository groups from the accounting entity:
1 On the Identity Repository Groups tab, select the group to be removed.
2 Click Delete.
3 Confirm the deletion.

Infor Operating Service Administration Guide | 113


Infor Ming.le administration

The deleted identity repository groups are removed from the accounting entity details page.

Locations
When a new location is created in an Infor application, the application publishes a Sync.Location BOD.
IFS subscribes to the Sync.Location BOD and maintains a list of locations. IFS does not provide a way
in which users can manually create locations in the IFS user interface.
The Locations page displays a listing of all locations added to your system. This page displays:
• The name and description of the locations
• The total number of mapped users and mapped groups in each location

Adding users to a location


To add users to a location:
1 On the User tab, click Add new item.
2 On the Assign Users to Location overlay, search for and select a user.
3 Click Add to add the user.
4 Add additional users as required.
5 Click Add & Close to add selected users and close the overlay.
6 Click Save.
The newly added users are now displayed on the location details page.

Removing users from a location


To remove users from a location:
1 On the Users tab, select the user to be removed.
2 Click Delete.
3 Confirm the deletion.
The deleted users are removed from the location details page.

Adding identity repository groups to a location


To add identity repository groups to a location:
1 On the Identity Repository Groups tab, click Add new item.
2 Search for the group to map this location and click Add.
3 Click Save.

Infor Operating Service Administration Guide | 114


Infor Ming.le administration

The newly added identity repository groups are now displayed on the location details page.

Removing identity repository groups from a location


To remove identity repository groups from a location:
1 On the Identity Repository Groups tab, select the group to be removed.
2 Click Delete.
3 Confirm the deletion.
The deleted identity repository groups are removed from the location details page.

Document Authorizations
The Document Authorizations page displays all of the document types in your system and a total of
the security roles that have been mapped to each document type.
IFS document authorizations are used to limit the documents a user can see. Document authorization
limitations are based on document type, accounting entity, and location. To use these limits, ensure
that the security roles of the user have the document authorizations configured.

Viewing document details


To view document details, click the drill-down icon for the document. The document details page is
displayed. This page displays the security roles mapped to each document and an indicator that shows
if the document is also secured by accounting entity and location. You can map or remove a mapping
of a security role to a document from this page.

Mapping a security role to a document


To map a security role to a document:
1 Click Add new item. The Assign Security Roles to Documents overlay is displayed.
2 Select one or more security roles.
3 Optionally, select an accounting entity.
4 Optionally, select a location
5 Click Add.
6 Click Save.
The newly added roles are now displayed on the details page for the selected document.

Infor Operating Service Administration Guide | 115


Infor Ming.le administration

Removing a mapping of a security role to a document


To remove a mapping of a security role from a document:
1 Select the security role to be removed.
2 Click Delete.
3 Click Save.
The deleted roles are removed from the details page for the selected document.

Authorization Claim Values


Administrators can navigate to the Authorization Claim Values page to view, edit, and delete authorization
claim values. The page displays:
• The authorization claim value
• The description of the authorization claim
• The number of mapped security roles to the authorization claim value
Note: This feature is available only when JIT user provisioning is enabled.

Field Description
Authorization Claim Value Specify the value against which the incoming
assertion is to be matched.
Description Specify the description of the authorization claim.
Security Role This is the list of security roles the user is associ-
ated with if the incoming assertion contains a
matching authorization claim value.

Adding an authorization claim value


To add an authorization claim value:
1 On the Authorization Claim Values page, click the add icon (+).
2 Add a name. A description is optional.
3 Add or remove security roles to map them to the authorization claim value.
4 Click Save.

Deleting an authorization claim value


To delete an authorization claim value:
1 On the Authorization Claim Values page, select one or more authorization claim values to delete.
2 Click the delete icon.

Infor Operating Service Administration Guide | 116


Infor Ming.le administration

3 Confirm the deletion.

Identity Repositories

AD Parameters

Adding an AD parameter
To add an AD parameter:
1 Click Add.
2 Specify the Domain Name.
3 Specify the Active Directory Path for the domain.
4 Specify the User Name and User Password for the domain.
5 Ensure that the Is Active check box is selected. If this check box is cleared, all users that are
associated with the domain when the domain is synced are removed.
6 Select the value in User Selection.
Manual is the default value. In this case, User Management tracks the updates, removals, activations,
and deactivations of only the users who are manually added into User Management.
All Users: During the sync operation on the Manage Users page, the users are synchronized
with Active Directories. In addition, the IFS timer service that runs in the background periodically
synchronizes the changes to the User and Group definition, such as additions, removals, updates,
deactivations, and activations inside User Management with the Active Directory.
7 Click Save.

Deleting an AD parameter
To delete an AD parameter:
1 Select the AD parameter to delete.
2 Click Delete.
3 Confirm the deletion.
You cannot delete the AD parameter if the AD parameter is in Active status.

Viewing and editing an AD parameter


To view or to edit an AD parameter, click the edit icon for the AD parameter. The AD parameter details
page is displayed. This page displays existing AD parameter properties.

Infor Operating Service Administration Guide | 117


Infor Ming.le administration

The AD parameter configuration can be edited on the same screen. Click Sync All Users Now to start
the synchronization process.

SCIM Parameters

Enabling SCIM Parameter configuration


Before you can use SCIM, ensure that the SCIM Parameter configuration is enabled on the General
Settings page.
The options are:
Do Not Enable: Select this option to disable the SCIM parameter configuration.
Get Users: Select this option to get users from another Infor Ming.le User Management system.
Publish Users: Select this option to publish users to another Infor Ming.le User Management system.
SCIM-Publish/Get Users Interval (min): Enter a numeric value from 30 to 10080 in this
text box. This is the synchronization interval to synchronize users.
Note: The IFS Timer service must be restarted when changes are made to this configuration.

Adding an SCIM parameter - Get Users


Before you can use SCIM, you must set up the integration with IFS/User Management to add SCIM
parameters (Get Users option):
1 Click Add. Note that the Identity Repository Type is SCIM-Get Users because the Enable SCIM
Parameter Configuration setting is set to Get Users.
2 Enter a Name.
3 Enter a Path.
4 Enter a User Identifier.
5 Enter a Password.
6 Select the Is Active check box to activate this configuration.
7 Click Save.
When the configuration is completed, click Test to validate the connection. Click Get All Users to
schedule a job to get all users from another system. Click Status to display the status of all the
synchronizations.
A successful test message is displayed if all details in the record are correct.

Adding an SCIM parameter - Publish Users


Before you can use SCIM, you must set up the integration with IFS/User Management.

Infor Operating Service Administration Guide | 118


Infor Ming.le administration

To add an SCIM parameters (Publish Users option):


1 Click Add. Note that Identity Repository Type is SCIM-Publish Users because the Enable
SCIM Parameter Configuration setting is set to Publish Users.
2 Enter a Name.
3 Enter a Path.
4 Enter a User Identifier.
5 Enter a Password.
6 Select the Is Active check box to activate this configuration.
The User Selection is set to Manual by default. This selection can be changed to All Users.
7 Click Save.
If User Selection is Manual, then security roles can be added. The users who belong to the
associated security roles are published from one system to another.
If User Selection is All Users, then there is no need to specify security roles and the option to
add the security roles will not be displayed.
8 To specify security roles:
a Click the edit icon to go to the details page.
b Click Add on the Security Roles panel.
c Select the desired security roles from the dialog.
d Click Add.
e Click Save.
When the configuration is completed, click Test to validate the connection. Click Publish All Users
to schedule a job to publish all the users to another system. Click Publish Changed Users Now
to schedule a job to publish all the users that were changed to another system . Click Status to
display the status of all the synchronizations.

Deleting an SCIM parameter


To delete an SCIM parameter:
1 Select the SCIM parameter to delete.
2 Click Delete.
3 Confirm the deletion.

IFS ION-Person ID
By default the IFS ION-Person ID is set to the IFS User GUID of the user.
The IFS ION-Person ID parameter specifies how to complete the IFS ION-Person ID field on the user
details page.
The IFS ION-Person ID is used as the user identifier in Infor ION. This feature links the Infor Ming.le
user with the Infor ION BODs.

Infor Operating Service Administration Guide | 119


Infor Ming.le administration

Specify one of these values:


• No Automatic setting: The administrator manually completes this field. An external name must
be selected for this setting.
• Automatic Setting: An external name must be disabled for this setting
Note: When Automatic Setting is selected, the IFS ION-Person ID field is read only on the user
details page.
You can edit the IFS Person ID on the user details page if the setting is No Automatic Setting.

Session Configuration
You use the Session Configuration page to manage Time-Out options.

Time-out
Use the Time-out option in Security Administration > Session Configuration > Time Out to configure
the idle session time-out of your system. The time is measured in minutes, and you can enter a number
from 5 to 470. The default time-out is set to 470. This time-out applies to all users and applications in
Infor Ming.le.
Users are notified five minutes before an automatic sign-out occurs when the time-out is greater than
10 minutes. If the time-out is less than 10 minutes, users are notified two minutes before an automatic
sign-out occurs. This notification includes an option to reset the time-out timer and to allow the user to
continue working by clicking OK.
The idle session time-out starts again if the user leaves the system idle again.
If concurrent session is enabled, it is recommended to have a time-out no longer than 20 minutes. If
a user does not properly log out of a session, the user must wait the full time-out period before regaining
access to the system again.

External Users
The External Users feature is used to extend conversations and information sharing to external parties
such as suppliers, customers, or others not directly employed by your company within the Infor Ming.le
platform.
You can use the External Users page to turn the external users option on or off and allow users to
make invitations from the applications that are integrated with Infor Communities.
To enable the Infor Communities External Users functionality, select Enable Infor Communities
identities functionality.
If this option is disabled, you cannot view the External Users option on the Manage menu.

Infor Operating Service Administration Guide | 120


Infor Ming.le administration

To allow a user to invite new external users to your system, selectAllow applications to invite
External Users using Infor Communities identities. If this option is not enabled, all
external users must first be added to the system from the External Users page, accessed from Manage
Users > External Users.

Settings > General Settings


Use the General Settings page to configure general properties within User Management.

Setting name Setting type Comments


SCIM Configuration
Enable SCIM Parameter config- Radio buttons: Default selection should be the
uration • Don't Enable Don't Enable.
• Get Users If the Get Users radio button is
• Publish Users selected, then in the Adminis-
tration > Identity Repositories
> SCIM Parameters Security
screen, the Identity repository
type drop-down should display
SCIM-Get Users selected by
default as read-only. If the
Publish Users radio button is
selected, then display SCIM-
Publish Users by default as
read-only.
SCIM-Publish/Get Users Inter- Text Box By providing the value in this
val (min) field, you configure the system
Note: The IFS Timer Service to continuously publish/get
must be restarted when this users' definitions by using the
configuration is changed. SCIM service at each defined
interval. When blank or 0 is en-
tered in this field, this feature is
turned off.
Manage Features
Enable SCIM Service Check Box This setting enables and dis-
ables SCIM services. When
disabled, the SCIM Accounts
option under the Manage menu
is hidden.

Infor Operating Service Administration Guide | 121


Infor Ming.le administration

Setting name Setting type Comments


Enable IFS Audit Check Box When enabled, the system
starts logging all changes made
within User Management. All
logs are stored in a location de-
fined in the installer.
Configure Open LDAP Check Box
Publish Security User Master Check Box If enabled, then the Security
BOD User Master BOD is published
when there is a change in users
details.
User Synchronization Interval Text Box Text box that you use to enter
(min) a numeric value.
Ignore users that have an empty Check Box By default, this setting is dis-
UPN abled. When enabled, the IFS
will skip users that do not have
a UPN during the sync process.
Allow Import Check Box The check box should be en-
Note: To enable this feature, abled only when user synchro-
user synchronization must be nization is disabled for all the
turned off. AD repositories. When the Al-
low Import check box is select-
ed in IFS (on-premises), then
the Import option should be
visible on the Manage > Users
screen.
Enable capability to send emails Check Box If enabled, then only the Min-
with different URLs gleURLs menu item is dis-
played on the Configure >
Master Data Types menu
User Idp Sign Out Feature Check Box When enabled, AD FS is used
for sign out. If disabled, Infor
Ming.le is used for sign out. The
default is enabled.
Account Creation Status

Infor Operating Service Administration Guide | 122


Infor Ming.le administration

Setting name Setting type Comments


Create Users in Draft Status Check Box This setting allows the IFS ad-
ministrator to create users in a
Draft status. When enabled
(the check box is selected), any
new users created in IFS from
this point onward through all the
means (manually created, im-
port, and SCIM) are added with
the status of Draft.
The default state for the check
box is clear meaning that users
are created in an Active state.
Note: Users that are in Draft
status are not allowed to log in
to Infor Ming.le.
Application Specific Settings
When enabled, AD FS is used Check box This setting allows the user tp
for sign out. If disabled,Do not add the User Alias whenever a
auto-generate User Alias while user is added to IFS.
creating users

User Properties
Use these fields on the User Properties page to configure mapping and to create or edit custom
properties.

Standard Properties
Field Description
Edit User Alias, LN User, and Actor ID are the only
properties that are editable.
Property The property name as shown on the User details
page.
Description The description of the property.
Type You can have these property types:
• Simple Type
• External Name
• MasterData Type

Infor Operating Service Administration Guide | 123


Infor Ming.le administration

Field Description
Plural This indicates whether the field can have multiple
values. This field is a display-only field if this
property cannot have multiple values, for exam-
ple, Common Name.
Required This indicates whether the property requires a
value. A user receives an error message if one
or more properties are required and not filled.
The required field is editable only by an IFS ad-
ministrator for User Alias, LN User, and Actor
ID.
Used This indicates that the property is used by at least
one of the application types that is currently active
for this property.

Additional Properties
Field Description
Edit Name and Data Type are not editable for Addi-
tional Properties.
Property Property name as shown on the User details
page.
Description Description of the property.
Type Can have these property types:
• Number
• Boolean
• Multiselect
• Date
• Text
• Lookup
Required Indicates whether the property requires a value.
A user receives an error message if one or more
properties are required and not filled. The re-
quired field is editable only by an IFS administra-
tor for User Alias, LN User, and Actor ID.
Used Indicates that the property is used by at least one
of the application types that is currently active for
this property.

Infor Operating Service Administration Guide | 124


Infor Ming.le administration

Adding an additional property


You can add an additional property from the Additional Properties tab.
1 Click the + icon.
2 Specify a name, description, and data type for the property. Use this additional information for these
data types:
Boolean
In the List Options field, enter two values separated by a comma. For example: True, False.
If a default value is set, it must match one of the values entered in the List Options field.

Lookup
Use the + icon to enter values manually or click Bulk Upload to upload a .csv file with the values.
For the .csv file, the supported header variables are Value, Description, and Default. For Default,
either TRUE or FALSE are accepted values. Once values have been added, users can click
Download to download a .csv file of all of the values.

3 Optionally, select a default value for the property, and select the Required check box to require
users to enter a value for the property.
4 Click Save.

Applications
The Applications page is a read-only page that displays all the applications that have been activated
and added to User Management. The Applications page also displays the associated security roles.

Data Management
Use the Data Management menu option on the profile panel to download and delete messages and
posts, if you have the appropriate security role.
To access Activity Feed posts, you must be authorized to the MingleDataAdministrator role.

Accessing the Data Management window


To access the Data Management window:
1 Click your name in the top level header to access the profile panel.
2 Click Data Management to open the Data Management window.
The Data Management window has a User Data option.

Infor Operating Service Administration Guide | 125


Infor Ming.le administration

User Data
On the User Data page, you can manage Activity Feed post messages.
A grid is displayed with each user's full name, email address, Activity Feed post, and status.
The number represents the total posts or messages for that user in the system.

Working with collaboration posts data


1 Click the number in the Collaboration column to access all Collaboration posts for a user. The
detailed Collaboration Posts window is displayed.
2 Select to delete data for all posts or for a single post. For a single post, search by the post ID.
These options are available:
• Download Data: Download the user's posts.
• Soft Delete Data: Soft delete the user's posts so that they are removed from the user interface.
• Hard Delete Data: Hard delete the user's posts so that they are completely removed from the
system.

Infor Operating Service Administration Guide | 126


Homepages administration

Chapter 6: Homepages administration

Users who are members of the Homepages administrator role have access to the Administration tool.
Infor Ming.le Homepages have these IFS applications roles that can be assigned to users:

Role Description
HOMEPAGES-Administrator The Homepages administrator is a user with
permissions to use the Homepages Administra-
tion tools and with full access to all published
pages and widgets.
HOMEPAGES-ContentAdministrator The Content Administrator is a user with full ac-
cess to all published pages and widgets.

Working with the Administration tool


The Administration tool enables you to configure how the Homepages application works and to manage
content such as published pages and widgets. The Administration tools have a page for each area:

Area Description
Settings View and edit settings.
Features View and edit features.
Properties View and edit properties.
Private pages Manage private pages.
Published pages Manage published pages.
Standard pages Manage standard pages.
Published widgets Manage published widgets.
Standard widgets Manage standard widgets.
Featured pages Manage featured pages
Featured widgets Manage featured widgets
Featured banner widgets Manage featured banner widgets

Infor Operating Service Administration Guide | 127


Homepages administration

Area Description
Import Import settings and content.
Export Export settings and content.
Tags Manage page and widget tags.

Accessing the Administration tool


To access the Administration tool:
1 Click the page menu icon (…) on the page title bar.
2 Click Advanced.
3 Click Administration.
The Home view of the Administration tool displays a series of section cards. Open the administrative
sections by clicking the links on the section cards or use the links on the navigation pane.
You can use the switch button on the toolbar to move back and forth between the Administration
tool and Homepages.
4 Click X Close on the toolbar to close the Administration tool and return to Homepages.

Working with settings


The Settings page in the Administration tool displays a list of settings. You can change default setting
values, add setting rules, and change setting values for specific users and security roles.
Use the filter selector to narrow the visible settings in the All, Common, Page, Widget, and Feature
categories. You can also filter the visible settings by entering values in the filter text boxes in the list
columns.
You can navigate from the settings list to a list of rules for a setting by clicking a setting name. From
the list of setting rules, you can navigate to a list of users and roles to which the rule applies. To navigate
back to the previous list, use the breadcrumb navigation above the list.
The settings list contains this information:

Name Description
Setting name The name of the setting. Click the setting name
link to show a list of setting rules.
Value The default setting value. This value applies to
all users unless there is a setting rule that over-
rides the default value. Click the value link to
open the Edit Setting dialog for the default value.

Infor Operating Service Administration Guide | 128


Homepages administration

Name Description
Change date The date and time when the setting was last
changed.
Changed by The name or ID of the user who changed the
setting.
Rules The number of rules that exist for the setting.
Actions Action menu.

Common settings
Name Default value Description
Admin contact info blank Administrative contact information text. This
information is displayed in the About dialog.
Set this value so that the user knows whom to
contact.
Admin email blank An email address of an administrator or contact
person. This information is displayed next to
the Admin contact info text in the About dia-
log. Set this value so that the user knows whom
to contact.
Client log level Information The log level used by the client to log to the
browser console. This setting can be changed
for troubleshooting issues in the client.
Default language English (en-US) The default language to use if none of the lan-
guages accepted by the browser is supported.
Owner filter in catalogs True Authorizes users to use the Owned by filter in
the catalogs.
Note: This affects only the Owned by filter.
The other owner filters, My pages/widgets
and Anyone, are not affected by this setting.
Translate widget, page ti- True Authorizes users to create translations for
tle, and description published pages and widgets. This is a global
setting to enable or disable all users within a
tenant to this setting. The setting does not ac-
cept rules.
Note: Consider turning this setting off when a
single language is used.

Infor Operating Service Administration Guide | 129


Homepages administration

Page settings
Default
Name value Description
Access the Page True Authorizes users to open the Page Catalog.
Catalog Note: This setting is always enabled for an administrator.
Add a published True Authorizes users to add published pages from the Page Catalog or
page add published pages that have been shared in Infor Ming.le.
Note: This setting is always enabled for an administrator.
Create private True Authorizes users to create one or more private pages.
pages Note: This setting is always enabled for an administrator.
Default page N/A The default page or pages to display for a user with no pages. The
user may be a new user or an existing user who deletes all the pages
in My Pages. If no default page is set, an empty page is displayed
for the user unless one or more mandatory pages exist or a standard
page applicable to the user is available.
You can set multiple default pages and assign them to be displayed
to a user, group, or role. When multiple default pages exist, all of
them are displayed. When configuring a page, you can select how
the page is applied to the user, that is, the type of page.
• Private – The user receives a copy of the page and can modify
it.
• Published – The user receives the page as if it is added from
the Page catalog, and any future update to the page is made
available to the user.
Duplicate a pub- True Authorizes users to add a copy of a published page from the Page
lished page Catalog.
Note: The duplicated page becomes a private page for the user.
Note: This setting is always enabled for an administrator.
Export pages True Authorizes users to export pages from the AdvancedAuthorizes
users to add a copy of a published page from the menu.
Note: This setting is always enabled for an administrator.
Import pages True Authorizes users to import pages from the Advanced menu.
Note: This setting is always enabled for an administrator.
Mandatory pages N/A One or more pages that are mandatory for a user. A user cannot
remove a mandatory page.
You can specify an effective date for a mandatory page and identify
a specific page as a primary mandatory page.
Note: This setting can be used in combination with the Selection
of Homepage setting to make sure that a user always has a specific
initial page.

Infor Operating Service Administration Guide | 130


Homepages administration

Default
Name value Description
Max number of 3 The total number of private and published pages a user is authorized
pages to add.
Note: This value does not include any mandatory pages.
Max number of 20 The maximum number of widgets allowed on a page.
widgets on a Note: During import of a page, the Widgets on page max
page property (default is 50) in the grid properties overrides this number.
Publish pages to True Authorizes users to publish pages to the Page Catalog.
the Page Catalog Note: This setting is always enabled for an administrator.
Selection of True Authorizes users to select the initial page.
Homepage Note: Consider turning this setting off when used in combination
with the Mandatory pages setting to make sure that a user always
has a specific initial page.
Note: This setting is always enabled for an administrator.

Widget settings
Name Default value Description
Edit banner widgets True Authorizes users to add, re-
move, and resize widgets in
page banners. This setting has
no effect if the Banner Widget
feature is turned off.
Note: This setting is always
enabled for an administrator.
Note: This setting does not af-
fect if users can configure a
banner widget.
Publish widgets to the Widget True Authorizes a user to publish a
Catalog widget to the Widget Catalog.
Note: This setting is always
enabled for an administrator.

Infor Operating Service Administration Guide | 131


Homepages administration

Name Default value Description


Display restricted widgets on a True A restricted widget is one that
page the user does not have permis-
sion to access.
By default, displays restricted
widgets on the page as unautho-
rized to the user.
The administrator can change
the configuration to false to hide
the restricted widgets from view.
This setting does not affect un-
available widgets.

Feature settings
All new features that can be enabled or disabled are displayed in the feature settings section.
The value applies to all users. Rules cannot be applied to feature settings.
If the features are not available in an on-premises installation, the corresponding feature property may
be disabled in the Homepages properties in the grid management pages.

Name Default value Description


Banner Widget False Turns the Banner Widget func-
tionality on or off.
Note: Rules cannot be set for
this setting.
Note: The Banner widget was
previously named the Hero
widget.
Standard Pages True Turns Standard Pages on or off.
Note: Rules cannot be set for
this setting.

Changing a setting
You can change a setting for all users on the Settings page in the Administration tool.
Note: You can change settings for individual users or groups of users by adding setting rules.
To change a setting:
1 Open the Administration tool.

Infor Operating Service Administration Guide | 132


Homepages administration

2 From the page menu, click Settings, or click View Settings on the settings card on the start view.
3 Locate the setting to change.
Note: If you cannot find the setting, verify that the filter selector is set to All and clear any values
in the column filter text boxes.
4 Click the actions menu (…) for the setting to change.
5 Click Edit to display the Edit Setting dialog.
6 Change the setting value.
7 Click OK.
8 Click Save.
Note: You can discard your changes by clicking Discard.
9 Click OK to confirm.

Adding a settings rule


You can change settings for individual users or groups of users by adding setting rules. When a setting
rule matches a user, the value for the rule overrides the default setting value. The first rule that applies
to the user is used.
To add a setting rule:
1 Open the Administration tool.
2 From the page menu, click Settings, or click View Settings on the settings card on the start view.
3 Locate the setting to change.
4 Click the actions menu (…) for the setting to change.
5 Click Add Rule to display the Add Rule dialog.
6 Enter a name for the rule.
7 Change the setting value.
8 Search for a user or role to which to assign the rule.
To add a user:
a Start typing the name of the user in the Add user text box.
b Select the user to add the user to the Added list.
c Continue adding users, as required.
To add a role:
a Start typing the name of the security role in the Add role text box.
b Select the role to add it to the Added list. If no suggested list is displayed or the role is not in the
list, you can alternatively enter the role and click Add role.
c Continue adding roles, as required.
9 Click Add.
10 Click Save.
11 Click OK to confirm.

Infor Operating Service Administration Guide | 133


Homepages administration

Changing a setting rule


To change an existing setting rule:
1 Open the Administration tool, and open the Settings page.
2 Locate the setting to change.
3 Click the name of the setting to show a list of rules for that setting.
4 Select the rule to change.
5 Click Edit to show the Edit rule dialog or click Delete to remove a rule.
a Change the name of the rule.
b Change the setting value.
c Add and remove users and security roles.
6 Click OK.
7 Click Save.
8 Click OK to confirm.

Removing a setting rule


To remove an existing setting rule:
1 Open the Administration tool, and open the Settings page.
2 Locate the setting to remove.
3 Click the name of the setting to display a list of rules for that setting.
4 Select the rule to change.
5 Click Delete to remove the rule.
6 Click Save.
7 Click OK to confirm.

Changing the order of setting rules


When more than one rule matches a user, only the first matching rule is applied. You can change the
order in which the rules are evaluated.
To change the order of setting rules:
1 Open the Administration tool, and open the Settings page.
2 Locate the setting to change.
3 Click the name of the setting to display a list of rules for that setting.
4 Locate the rule to change.
5 Drag and drop the icon in the Reorder column to move the rule to a new location in the list. The list
is sorted sequentially with the rule with the highest priority first.

Infor Operating Service Administration Guide | 134


Homepages administration

6 Click Save.
7 Click OK to confirm.

Working with properties


The Properties page in the Administration tool shows a list of ad hoc properties. Ad hoc properties are
an advanced topic. In most cases, you do not use properties.
You can use ad hoc property values in widgets that support properties such as the Web widget. The
Web widget supports URL templates with replacement variables that can access ad hoc properties.
For example, you can specify a base URL as an ad hoc property to publish Web widgets that use that
property. The benefit is that you can update the base URL in one place for all widgets that use the
property.
These actions are available above the list:

Action Description
Add property Displays the Add Property dialog.
Import Displays the Import Properties dialog.
Export All Exports all properties to a JSON file.

These additional actions are available when at least one action is selected:

Action Description
Edit Displays the Edit Property dialog.
Note: Enabled only for a single selection.
Delete (<number>) Deletes the selected properties.
Export (<number>) Exports the selected properties.

Adding a property
To add a property:
1 Open the Administration tool, and open the Properties page.
2 Click Add Property to display the Add Property dialog.
3 Enter the name, area, description and value for the property. The area and description are optional
but are recommended.
4 Click Add.

Infor Operating Service Administration Guide | 135


Homepages administration

Setting a mandatory page


1 Click the page menu icon (…) on the page title bar.
2 Click Advanced.
3 Click Administration.
4 Under the Setting tab, find mandatory pages.
5 Click the menu icon (…) for mandatory pages.
6 Click Add rule.
7 Enter a name for your rule.
8 Click Add Pages to add the pages to which you want the rule to be applied.
9 Click Save.
10 Type the name of the users or the IFS security role to which you want the pages to be assigned.
11 Click Save.

Setting an effective date range for a mandatory page


When you set an effective date range for a mandatory page, the Date column for the mandatory page
displays a green clock icon to indicate that the page is using an active effective date.
A red clock icon indicates that the effective date has expired. Expired pages are shown as inactive in
the default pages list but are not removed automatically.
To set an effective date range for a mandatory page:
1 Click the page menu icon (…) on the page title bar.
2 Click Advanced.
3 Click Administration.
4 Under the Setting tab, find mandatory pages.
5 Click the menu icon (…) for mandatory pages.
6 Click Edit to display the list of mandatory pages.
7 Select the check box for the mandatory page to edit.
8 Click Set Date Range on the action menu.
9 On the Set date range dialog, specify an Available from and an Available to date to define the
effective date range.
10 Click Save.

Identifying a mandatory page as a primary page


You can identify one or more mandatory pages as a primary page. The primary mandatory page is
always shown as the home page, even when the user has set another page as the home page in My
Pages.

Infor Operating Service Administration Guide | 136


Homepages administration

To identify a mandatory page as a primary page:


1 Click the page menu icon (…) on the page title bar.
2 Click Advanced.
3 Click Administration.
4 Under the Setting tab, find mandatory pages.
5 Click the menu icon (…) for mandatory pages.
6 Click Edit to display the list of mandatory pages.
7 Select the check box in the Primary column to identify a page as a primary mandatory page.
8 Click Save.

Working with private pages


You use the Private Pages page in the Administration tool to manage the private pages for a user.
Note: Under normal circumstances, an administrator should not have to manage a user’s private
pages, but there are cases when it is useful. A user may have created a page that breaks the application
or the browser in a way that makes it impossible for the user to fix or remove the page. In this case,
the administrator can delete the erroneous page.
These actions are available above the list:

Action Description
Import Displays the Import Private Pages dialog.
Export All Exports the selected user's private pages.

These additional actions are available when at least one action is selected:

Action Description
Delete (<number>) Deletes the selected pages.
Export (<number>) Exports the selected pages to a zip file.

Working with published pages


The Published Pages page displays a listing of all published pages. If there are permissions set, then
the Permissions column contains the keyword Restricted. Users can set permissions as part of
publishing a page.
The Published Pages page has all actions available in the toolbar above the list. You can search, sort,
and filter to affect which pages are shown. To display more pages that match the search, click More

Infor Operating Service Administration Guide | 137


Homepages administration

below the list. All possible actions are available from the Actions menu. Actions that are only available
for either single or multiple select are enabled when they can be used.
These actions are available in the Actions menu:

Action Description
Delete Deletes the selected pages.
Note: If the page is configured as a mandatory
or default page in settings, you must manually
edit that setting and remove the page.
Export Exports the selected pages as a zip file.
Permissions > Edit Permissions Displays the Page Permissions dialog where
you can remove, add, and edit permissions.
Permissions > Copy Permissions Copies all permissions for the selected page to
the clipboard.
Permissions > Apply Copied Permissions Adds the permissions from the clipboard and
updates the values for existing groups and users
without removing existing entries.
Permissions > Replace Copied Permissions Clears any existing permissions and adds the
permissions from the clipboard.
Permissions > Clear Permissions Removes all permissions for the selected pages,
enabling all users to view the pages.
More > Publish to existing page Overwrites the target page with content, title, and
description of the selected page. Use this action
to work on a new version of a page and overwrite
the earlier version when the new page is done.
Users can then use the previous working version
of the page while the new version is being devel-
oped.
Note: All content except permissions and user
connections are updated with this action.
More > Take Ownership Makes you the owner of the page.
More > Change Ownership Opens the Change Owner dialog where you can
search and select a new owner for the page.
Note: Owners have permission to change a page
if they have permission to publish pages.
Export All Exports all published pages.
Note: This action includes all published pages
including those not yet retrieved by the client.

Infor Operating Service Administration Guide | 138


Homepages administration

Action Description
Import Imports a zip file with published pages.
The Import Published Pages dialog has Over-
write existing files and Preserve existing files
options. The default is to overwrite existing files.
Note: Pages exported from the page menu in
Homepages can be imported as published pages
if they are first added to a zip file.
For more information, see the "Publishing pages"
topic in the Infor Ming.le User Guide.

Note: Some actions are enabled only if the page has permissions or if permissions are available from
the clipboard. Other actions are enabled only for single select.

Locating published pages


You can search, sort, and filter to locate published pages. You can use these options individually or in
combination, depending on the scenario.
• Search
Use the search field to search within the title, description, and tags for all published pages. The
search field does not support wild cards. Any page that contains the search text is considered a
match. You can also use the search field to search by the page ID, which is the unique identifier of
a published page. When you search by page ID, the complete ID is required to find a match.
For information on how to locate the page ID, see Locating the page ID for a page on page 142.
• Sort
You can sort based on title, change date, or popularity. Use this option to find recently updated
pages or unused pages. The sort option does not affect which pages are displayed, only the order
by which the pages are retrieved. The default is Title A-Z.
• Filter
You can filter what pages are displayed, based on who made the last change, the owner, or
restrictions of a page. Use the filter option to find all published pages created by a user or to find
all restricted pages. When one or more filters are in use, There are active filters. is
displayed at the bottom of the list next to a Clear all option, available for deactivating the filters.

Infor Operating Service Administration Guide | 139


Homepages administration

Working with page permissions

Adding permissions
To add permissions:
1 Open the Administration tool, and open the Published Pages page.
2 Locate and select the page, click the Actions menu, and click Edit Permissions.
3 On the Page Permissions dialog, click the Add User or Group text box and type the name of a
user or a group.
4 Select the user or group in the search result.
5 In the list, select the Access level for the user or group.
• View Only
• Can Edit
Note: Can Edit implies that the user can edit the page, but the user must have Publish Pages
to the Page Catalog setting activated to be able to edit the page.
6 Repeat the steps above for additional users or groups.
7 Click Save.

Editing permissions
To edit permissions:
1 Open the Administration tool, and open the Published Pages page.
2 Locate and select the page, click the Actions menu, and click Edit Permissions.
3 On the Page Permissions dialog, click the Permissions drop-down and select Access Level (View
Only / Can Edit).
4 Click Save.

Removing permissions
To remove permissions:
1 Open the Administration tool, and open the Published Pages page.
2 Locate and select the page, click the Actions menu, and click Edit Permissions.
3 On the Page Permissions dialog, click the remove icon (x) next to the group or user to be removed.
4 Click Save.
You can also remove all permissions for the selected pages by clicking Clear Permissions on the
Actions menu.

Infor Operating Service Administration Guide | 140


Homepages administration

Understanding permissions for pages


You can set permissions on a page. By default, if no permissions are set, the page can be viewed by
everyone, but only the owner of the page and users belonging to the HOMEPAGES-ContentAdministrator
or HOMEPAGES-Administrator group can edit the page. If a user can edit a page, the user can make
changes to the page such as:
• Adding and removing widgets
• Changing the title, description, and page color
• Configuring widgets
These are the permission options:

Permission Description
No permissions set Everyone can view the page, but only the owner,
content administrators, and administrators can
edit the page.
Can Edit Permissions are added with Can Edit. Everyone
can view the page, and the page can be edited
only by the owner, content administrators, and
administrators as well as groups and users who
have been given the Can Edit permission.
Groups and users who have been given the Can
Edit permission must have the Publish pages
to the Page Catalog permission activated.
View Only Permissions are added with View Only. Only
the users who are added can view the page. The
page can be edited by the owner, administrators,
and any extra group or user who has the Can
Edit permission.
Disabled Users, roles, and groups that are added as "dis-
abled" cannot view or edit the page. The page is
not available in the Page Catalog. If someone
without view or edit rights already has the page
in My Pages, the page is shown as broken.
Note: The page owner, content administrators,
and administrators can always find a published
page in the page catalog and are always allowed
to edit the page, even when it is disabled.

Note: The Publish pages to the Page Catalog setting must be active for users to be able to edit
published pages. The default setting is true for content administrators and administrators.
Note: The rule that gives the highest level of permissions to a user is the rule that is recognized. For
example, if a page is disabled for everyone but Can Edit rights are assigned to a user or a group of
which the user is a member, that user or group has edit rights. If the rule for everyone is set to
Configure, everyone can edit the page. Even if you set an additional disable rule, that rule is not
enforced.

Infor Operating Service Administration Guide | 141


Homepages administration

Locating the page ID for a page


The page ID is the unique identifier for a page. To be able to find the page ID, you must add the page
to your pages so that it is displayed in My Pages.
To locate the page ID:
1 Click the page menu icon (…) on the page title bar.
2 Click My Pages.
3 Right-click the page title to open a context menu.
4 Click Copy to Clipboard.
• If prompted by the browser to allow access to the clipboard, select Yes/OK to allow Homepages
to add text to the computer clipboard.
• If your browser does not support this function, a dialog is displayed where you can manually
select and copy the information.
5 Open a text editor on your computer.
6 Use the command for pasting text, for example Ctrl+V.
7 In the pasted text, locate the Page ID.

Working with standard pages


Standard pages, similar to standard widgets, are predefined content. They are available in the Page
Catalog and can be used as default pages or mandatory pages. The purpose of standard pages is to
add predefined content to help you get started. You cannot edit, add, or delete standard pages from
the administration tool, but you can set permissions to affect the users, roles, and groups for which a
page should be available.
The Standard Pages page displays a listing of all standard pages. If permissions have been set, then
the Permissions column contains the keyword Restricted.
The Standard Pages page has all actions available in the toolbar above the list. You can search and
sort to affect which pages are shown. To access more pages that match the search, click More below
the list. When one or more search filters are in use, There are active filters. is displayed at
the bottom of the list next to a Clear all option, available for deactivating the filters.
All possible actions are available from the Actions menu. Actions that are available only for either
single or multiple selection are enabled when they can be used.
These actions are available from the Actions menu:

Action Description
Edit Permissions Displays the Page Permissions dialog where
you can remove, add, and edit permissions.

Infor Operating Service Administration Guide | 142


Homepages administration

Action Description
Reset Permissions (<number>) Deletes all tenant-specific authorizations for the
selected pages so that the permissions are reset
to the default permission settings from the reg-
istry.
Enable Enables the selected pages. These pages are
shown in the Page Catalog.
Disable Disables the selected pages. These pages are
excluded from the Page Catalog.
Note: Different from a published page, a disabled
standard page is not available to either adminis-
trators or content administrators.
Export Exports the selected pages as a zip file.
Publish as copy Publishes a copy of the selected page. This new
page is included on the Published Pages page.
Publish to existing page Overwrites the target page with the content, title,
and description of the selected standard page.
This action can be used to update pages that
have the correct permissions with new content.
Note: All content except for permissions are
updated when you use this action. This includes
the title, so when you are looking for the new
page, make sure to check for the new title.

Working with featured pages


A featured page is a page that is displayed in the start view in the Page Catalog. Adding a page to
feature pages is done from the Page Catalog. The most recently added featured pages are displayed
first.
By default, only five pages can be displayed as featured pages, but you can set as many as eight. If
more than eight pages are set, then the oldest featured pages are no longer included as featured
pages. The featured pages that are displayed to the user depend on the order in which the featured
pages are added and the permissions defined for the pages.
Note: In an on-premises installation, your grid administrator can change how many pages can be set
as featured.

Infor Operating Service Administration Guide | 143


Homepages administration

Viewing all featured pages


To open the Featured Pages tool, click the Featured pages link on the Featured content card on the
administration Home page, or click Featured pages from the action menu of the administration tool.
All featured pages are listed in the administrator's view. The order of the pages reflects the order by
which the pages were last accessed. Only the first five pages that a user is authorized to access are
shown as featured pages in the catalog for that user; therefore, as administrator, you cannot filter or
sort this list.
These actions are available from the Actions toolbar that is displayed when one or more pages are
selected:

Action Description
Edit Permissions Displays the Page Permissions dialog where
you can add, edit, and remove permissions.
Remove as featured (<number>) Removes the selected pages from featured
pages.

Adding a page to featured pages


To add a page to featured pages:
1 Open the Page Catalog.
2 Locate the page and click the page title to access the page detail panel.
3 Turn on the Featured switch.

Removing a page from featured pages


To remove a page from featured pages:
1 Open the Page Catalog.
2 Locate the page to remove and click the page title to access the page detail panel.
3 Turn off the Featured switch.

Removing a page from featured pages from the administration tool


To remove a page from featured pages from the administration tool:
1 Click Featured pages from the action menu of the administration tool.
2 Select the page to be removed.
3 Click Remove as featured.

Infor Operating Service Administration Guide | 144


Homepages administration

Working with Start Experience configuration


The Start Experience refers to the pages displayed to a first-time Homepages user. This is the same
experience that a user sees after deleting all pages in My Pages and logging in again. This topic
describes the options for configuring one or more pages within the Start Experience so that first-time
users can quickly become familiar with the Homepages content.
Infor provides content called standard pages, that may apply to a specific role, application, or CloudSuite.
Standard pages are candidates for the Start Experience. If a standard page is applicable to the user,
it is selected unless other pages are configured. Standard pages are automatically added to the Page
catalog. You can activate this feature in the Settings section of the Administration tool. See the "Working
with settings" topic.
From the available standard pages, only one page is assigned automatically to users and only if no
other pages are configured.
These settings control the pages displayed to the user:
• Default page
The Default page setting can have a list of pages configured. This setting applies only to users
who have no pages, whether the user is a first-time user or a user who has deleted all pages in My
Pages, and there is no mandatory page that applies to the user. The user is presented with all the
pages in the default page configuration. A user must have the correct permission to a page for it to
be added.
• Mandatory pages
The Mandatory pages setting enables you to provide a page from the Page catalog to all users
or users with specific roles. The pages are marked as mandatory, and the user cannot remove them
from My Pages. A mandatory page is always displayed as the first page regardless whether the
user has pages or not. Multiple mandatory pages may be added. The mandatory page is displayed
to the user depending on the user's permission. If you want users to start always with the first
mandatory page, turn off the Selection of Homepage setting.

These settings allow for configuration of the Start Experience. If there are applicable mandatory pages
for the user, then any default pages configured are not applied. The default page setting takes effect
onlyif the user has no pages or if the mandatory pages are included in those pages.
For more information about the settings configuration for a default page and mandatory pages, see
the "Page settings" topic.
To summarize, the pages presented to a new user or a user with no pages, are based on these page
types:
1 Mandatory pages
2 Default pages
3 Standard pages
These are exclusive so, if the user has the View permission configured for at least one mandatory
page, the default page is not applied. You must decide whether to present the user with suggested
pages (a default page) or mandatory pages.
For the standard pages, only one page is automatically added for the user, in this priority:

Infor Operating Service Administration Guide | 145


Homepages administration

1 Standard page for a cloud suite


2 Standard page for an application with a security role configured
3 Standard page for an application without a security role configured
4 Standard page with a security role configured
5 Standard page without additional configuration
Not all applications have standard pages. If you do not want the standard page to be part of the Start
Experience, disable the Standard Pages feature in Settings. The standard pages will not be available
in the catalog. If you still want to have them available, use the Create and Publish a copy actions for
the standard pages in the Page catalog. See "Working with standard pages."
For the user who has existing pages, the pages are displayed in this priority:
1 Private pages that the user created
2 Pages added from the Page Catalog
3 Mandatory pages are always added as the first page in the page list

Working with published widgets


The Published Widgets page displays a listing of all published widgets. When permissions are set, the
Permissions column contains the keyword Restricted. The default permission is for the published
widget to be displayed in the Widget Catalog.
The Published Widgets page has all actions available in the toolbar above the list. You can search,
sort, and filter to affect which widgets are shown. To display more widgets that match the search, click
More below the list. All possible actions are available from the Actions menu. Actions that are available
only for either single or multiple select are enabled only when they can be used.
These actions are available from the Actions menu:

Action Description
Delete Deletes the selected widgets.
Note: If the widget is used on a page, the widget
is displayed as inactive with an icon and a dialog
where you can search and select a new owner
for the widget. widget is not available
message.
Export Exports the selected widgets as a zip file.
Permissions > Edit Permissions Shows the Widget Permissions – Alerts dialog
where you can remove, add, and edit permis-
sions.
Permissions > Copy Permissions Copies all permissions for the selected widget to
the clipboard.

Infor Operating Service Administration Guide | 146


Homepages administration

Action Description
Permissions > Apply Copied Permissions Adds the permissions from the clipboard and
updates the values for existing groups and users
without removing existing entries.
Permissions > Replace Copied Permissions Clears any existing permissions and adds the
permissions from the clipboard.
Permissions > Clear Permissions Removes all permissions for the selected widgets.
This action enables all users to configure the
published widget and makes the published widget
available in the Widget Catalog.
More > View Details Displays information about the widget such as
the title, widget ID, owner ID, and widget URL.
More > Copy URL to Clipboard Copies the widget URL to the clipboard.
More > Take Ownership Makes you the owner of the widget.
More > Change Ownership Opens the Change Owner
Note: dialogOwners have permission to change
a widget if they have permission to publish wid-
gets.
Export All Exports all published widgets.
Note: This action includes all published widgets
including those not yet retrieved by the client.
Import Imports a zip file with published widgets.
The Import Published Widgets dialog has Over-
write existing files and Preserve existing files
options. The default is to overwrite existing files.
Note: You cannot import a published widget if
the standard or tenant widget upon which the
published widget is based is not available. These
widgets are skipped during the import.

Note: Some actions are displayed or enabled only if you click Copy Permissions and permissions
exist in the clipboard or if the widget has permissions.
For information on adding, updating, and removing widget permissions see Working with widget
permissions on page 149.

Locating published widgets


You can search, sort, and filter to locate published widgets. You can use these options individually or
in combination, depending on the scenario.
• Search

Infor Operating Service Administration Guide | 147


Homepages administration

Use the search field to search within the title, description, and tags for all published widgets. The
search field does not support wild cards. Any widget that contains the search text is considered a
match. You can also use the search field to search by the widget ID, which is the unique identifier
of a published widget. When you search by widget ID, the complete ID is required to find a match.
The published widgets list displays one row if the widget is found.
For information on how to locate the widget ID, see Locating the widget ID of a widget on page 148.
• Sort
You can sort based on title or change date. Use this option to find recently updated widgets. The
sort option does not affect which widgets are displayed, only the order by which the widgets are
retrieved. The default is Title A-Z.
• Filter
You can filter what widgets are displayed, based on who made the last change, the owner, or
restrictions of a widgets. Use the filter option to find all published widgets created by a user or to
find all restricted widgets.When one or more filters are in use, There are active filters. is
displayed at the bottom of the list next to a Clear all option, available for deactivating the filters.

Locating the widget ID of a widget


You can always locate the ID for a widget when you have the widget on a page. These instructions
assume that you already have the widget on a page and want to identify the widget ID. If the widget is
displayed as inactive with an icon and The widget is not available message, the unique ID
is available in the About dialog.
1 Click the widget menu (…) on the widget title bar.
2 Click About. For broken widgets the ID is displayed in the About dialog.
3 On the About dialog, right-click the content area to open a context menu, and click Copy to
Clipboard.
• If prompted by the browser to allow access to the clipboard, click Yes/OK to enable Homepages
to add text to the computer clipboard.
• If your browser does not support this function, a dialog is displayed where you can manually
select and copy the information.
4 Open a text editor on your computer.
5 Use the command for pasting text, for example Ctrl+V.
6 In the pasted text, locate the ID: text where you should find the widget ID.

Infor Operating Service Administration Guide | 148


Homepages administration

Working with widget permissions

Adding permissions
To add permissions:
1 Open the Administration tool, and open the Standard Widgets page or the Published Widgets page,
depending on the widget type for which you want to edit permissions.
2 Locate and select the widget, click the Actions menu, and click Edit Permissions.
3 In the Widget Permissions dialog, change the value in the drop-down for the Everyone row to
change the default permissions for all users.
4 To add other permissions, complete these steps:
a Select User, Role, or Group, as required.
b Click the Search field and start typing the name of the user, role, or group. The results are
displayed in a drop-down list. To narrow the search, enter more characters. If no results are
shown, confirm that you selected the correct User, Role, or Group option.
c Select the user, role, or group from the search result to add it to the list below the Everyone row.
d Set the Access Level. For more information about access levels, see Understanding permissions
for widgets on page 150.
e Select if the widget should be displayed in the Widget Catalog.
f Repeat these steps to add more user, role, and group permissions.
5 Click Save.

Editing permissions
To edit permissions:
1 Open the Administration tool, and open the Standard Widgets or Published Widgets page.
2 Locate and select the widget, click the Actions menu, and click Edit Permissions.
3 On the Widget Permissions dialog, go to the line of the user, role, or group.
4 Change the Access Level value in the drop-down list, and specify whether the widget should be
displayed in the Widget Catalog.
5 Click Save.

Removing permissions
To remove permissions:
1 Open the Administration tool, and open the Standard Widgets or Published Widgets page.
2 Locate and select the widget.
3 To remove all permissions, click the Actions menu, and click Clear Permissions.

Infor Operating Service Administration Guide | 149


Homepages administration

To remove selected permissions, click the Actions menu, and click Edit Permissions. On the
Widget Permissions dialog, click the remove icon (x) next to the user, role, or group to be removed.
4 Click Save.
Note: You cannot remove the Everyone* rule.

Understanding permissions for widgets


A Homepages administrator can set permissions for standard widgets and published widgets. A user
who is allowed to publish widgets can set permissions for the widget when publishing it.
These are the access levels:

Access Level Description


Disabled The widget is completely disabled and not avail-
able in the Widget Catalog. If a standard widget
is disabled, all published widgets based on that
widget are also disabled.
Note: For a published widget, the widget owner,
content administrators, and administrators can
always find the widget in the Widget Catalog, and
they are allowed to show and edit the widget,
even if it is disabled for everyone.
View The user can view the widget on a page but
cannot configure the widget.
Note: For widgets that require configuration, give
the user the Configure access level.
Configure The user can view the widget and open the wid-
get configuration.
Note: A published widget may have settings
disabled, preventing the user from accessing the
configuration menu.

When you set permissions, consider when the widget should be displayed in the Widget Catalog.
Certain widgets are configured by power users and content providers. You can hide a widget from
groups, roles, or users by setting the default so that the widget is not displayed in the Widget Catalog.

Working with standard widgets


The Standard Widgets page displays a listing of all standard widgets. If permissions have been set,
the Permissions column contains the keyword Restricted. The default permission is that a standard
widget is displayed in the Widget Catalog and that all users can configure the widget.

Infor Operating Service Administration Guide | 150


Homepages administration

As the administrator, you can set permissions to standard widgets by user, role, or group.
It is important to understand that changing the permissions on a standard widget affects all published
widgets that are based on that widget. If a standard widget is disabled, all published widgets based on
that widget are not available in the Widget Catalog, and pages that contain either the standard widget
or the published widget are displayed as inactive with an unavailable icon.
The Standard Widgets page has all actions available in the toolbars above the list:
• The static toolbar with actions available for all widgets
• The expanded toolbar, dynamically displayed with actions available for selected widgets
You can search, sort, and filter to affect which widgets are shown. To display more widgets that match
the search, click More below the list. When one or more filters are in use, There are active
filters. is displayed at the bottom of the list next to a Clear all option, available for deactivating the
filters.
All possible actions are available from the Actions menu. Actions that are available only for either
single or multiple selection are enabled when they can be used.
These actions are available from the Actions menu:

Action Description
Edit Permissions Displays the Widget Permissions dialog where
you can remove, add, and edit permissions.
Copy Permissions Copies all permissions for the selected widget to
the clipboard.
Apply Permissions Adds the permissions from the clipboard and
updates the values for existing groups and users
without removing existing entries.
Replace Permissions Clears any existing permissions and adds the
permissions from the clipboard.
Clear permissions Removes all permissions for the selected widgets.
This action enables all users to configure the
standard widget and makes it available in the
Widget Catalog.
Delete Deletes all versions of the selected standard
widgets.
Note: If the widget or a published widget based
on the widget is used on a page, the widget is
displayed as inactive with an icon and a widget
is not available message.
Export Exports one or more standard widgets as a zip
file.
Import Imports a zip file with standard widgets. For more
information, see "On-premises widget installation
and upgrade."

Infor Operating Service Administration Guide | 151


Homepages administration

Action Description
Show Active Displays only the widgets that apply to the tenant.
Show All Displays all widgets including those that have
dependencies to applications that are not avail-
able for the tenant.
Note: Only the last version of the widget is visible
even if Show All is selected.

Note: Some actions are displayed or enabled only if you click Copy Permissions and permissions
exist in the clipboard or if the widget has permissions.
Permissions apply to both standard and published widgets. For instructions on adding, updating, and
removing widget permissions, see Working with widget permissions." For information on understanding
widget permissions see "Understanding permissions for widgets."

Working with featured widgets


A featured widget is a widget that is displayed in the start view in the Widget Catalog. Adding a widget
to featured widgets is done from the Widget Catalog. The most recently added featured widgets are
displayed first.
The Featured widgets page in the administration tool lists all featured widgets. You can remove a
featured widget and edit permission of a featured widgets from this page. You cannot add a widget to
featured widgets from the administration tool.
Only five widgets can be displayed as featured widgets, but the administrator can set as many as eight.
If more than eight widgets are set, then the oldest featured widgets are no longer included as featured
widgets. The featured widgets that are displayed to the user depend on the order in which the featured
widgets are added and the permissions defined for the widgets.
Note: In an on-premises installation, your grid administrator can change how many widgets can be
set as featured.

Viewing all featured widgets


To open the Featured Widgets tool, click the Featured widgets link on the Featured content card on
the administration Home page, or click Featured widgets from the action menu of the administration
tool.
All featured widgets are listed in the administrator's view. The order of the widgets reflects the order
by which the widgets were last accessed. Only the first five widgets that a user is authorized to access
are shown as featured widgets in the Widget Catalog for that user; therefore, as administrator, you
cannot filter or sort this list.

Infor Operating Service Administration Guide | 152


Homepages administration

These actions are available from the Actions toolbar that is displayed when one or more widgets are
selected:

Action Description
Edit Permissions Displays the Widget Permissions dialog where
you can add, edit, and remove permissions.
Remove as featured (<number>) Removes the selected widgets from featured
widgets.

Adding a widget to featured widgets


To add a widget to featured widgets:
1 Open the Widget Catalog.
2 Locate the widget and click the widget title to access the widget detail panel.
3 Turn on the Featured switch.

Removing a widget from featured widgets


To remove a widget from featured widgets:
1 Open the Widget Catalog.
2 Locate the widget to remove and click the widget title to access the widget detail panel.
3 Turn off the Featured switch.

Removing a widget from featured widgets in the


administration tool
To remove a widget from featured widgets from the administration tool:
1 Click Featured widgets from the action menu of the administration tool.
2 Select the widget to be removed.
3 Click Remove as featured.

Infor Operating Service Administration Guide | 153


Homepages administration

Working with featured banner widgets


A featured banner widget is a widget that is displayed in the start view in the Banner Widget Catalog.
Adding a widget to featured banner widgets is done from the Banner Widget Catalog. The most recently
added featured banner widgets are displayed first.
The Featured banner widgets page in the administration tool lists all featured banner widgets. You
can remove a featured banner widget and edit permission of a featured banner widget from this page.
You cannot add a widget to featured banner widgets from the administration tool.
The featured banner widgets are managed in the Banner Widget Catalog and the Featured banner
widgets administration tool with the same steps used for featured widgets.
For more information on how to manage featured widgets see Working with featured widgets on page
152.

Working with tags


The Tags page displays a listing of all tag suggestions. The tag suggestions are used when searching
for tags in the catalogs and when adding tags to pages or widgets to the Edit Publish Configuration
dialogs. A tag is added to the suggestions when a widget or page is published with that tag applied.
The entity that is shown in the list only shows for what entity the tag was added. The tag is shown as
a suggestion for both entities (widgets and pages).
The tags tool can be used to add new tag suggestions or delete existing tag suggestions. You can
select to show only widget tags, page tags, or both, and you can search among the tags and sort them
based on title or change date.
Note: Widgets and pages can have tags that are not available in this list because they have been
deleted from the suggestions or added before this functionality was implemented.
These actions are available from the Actions menu:

Action Description
Delete Deletes the selected tags from the suggestion
list.
Note: Deleting a tag only removes it from the
suggestions. The tag can still be used in widgets
and pages. If the tag is added to both entities,
you must delete it from both entities to remove
the tag from the suggestion list.
Note: If another user publishes a widget or page
with the removed tag, the tag will be added to the
suggestions again.
Add Adds a tag to the suggestion list.

Infor Operating Service Administration Guide | 154


Homepages administration

Working with Export


Use Export to export all or part of the Homepages data from one environment to another. It is important
that the export be performed during a service window. Perform only one export or import at a time.
Plan for the use of this tool, and use it carefully.
These are the data categories that can be exported:

Main category Sub category Description Filter


Settings The homepage settings
default values configu-
ration
Settings rules The settings rules with
different values for dif-
ferent roles and users
User settings Personal settings val- User display name
ues for a user, for ex-
ample the selected de-
fault homepage
Properties Homepages properties.
The same properties
that are displayed in
the Properties page.
Published widgets Published widgets Default title
Published widget per- Permissions for a pub-
missions lished widget
Standard widget per- Permissions for stan-
missions dard widgets
Published pages Published pages Default title
Published page connec- The connections that
tions users have to the pub-
lished pages
Published page permis- Permissions for a pub-
sions lished widget
Private pages Private pages for users User display name
Standard page permis- Permissions for a stan-
sions dard page

Filter supports a list of values separated with a comma as well as a wild card search. A filter set to
Peter*, for example, includes all users starting with Peter in their display name. You can also enter
an email address in the Filter field to export:
• User settings

Infor Operating Service Administration Guide | 155


Homepages administration

• Published widgets
• Published pages
• Private pages
Filtering by email includes only the content of the email addressee for the export.
Sub-category can be exported only if the main category is selected.

Exporting homepages data


To export homepages data:
1 Open the Administration tool, and open the Export page.
2 Select the data categories to include in the exported zip file. By default, all categories are included.
3 Click Export to start the export.
4 Review the information messages at the bottom of the page. When Export operation
successful is displayed, the export is completed.
5 Click Download to download the exported data.
Note: Be aware of the relationship between pages and widgets. The export is not a thorough copy of
a page and all the widgets, but only the page data. For a page to work in a target environment, the
same widgets must be available.
Note: Be aware of the relationship between Infor Ming.le groups, users, and permissions. If rules and
permissions are exported, these entities must exist in the target environment as well.
Note: Perform a full export only during off hours or a service window.
Note: Filters for pages and widgets use the default title that is the title in the Administration tool listings
but not necessarily the title displayed in the catalogs.

Working with Import


Use Import to import all or part of the Homepages data to one environment from another. It is important
that the import be performed during a service window. Perform only one export or import at a time.
Plan for the use of this tool, and use it carefully.
Filter supports a list of values separated with a comma as well as a wild card search. A filter set to
Peter*, for example, includes all users starting with Peter in their display name. You can also enter
an email address in the Filter field to import:
• User settings
• Published widgets
• Published pages
• Private pages
Filtering by email includes only the content of the email addressee for the import.
For an overview of the data categories, see Working with Export on page 155.

Infor Operating Service Administration Guide | 156


Homepages administration

Importing homepages data


To import homepages data:
1 Open the Administration tool, and open the Import page.
2 Select the data categories to import from the exported zip file. By default, all categories are included.
Note: The zip file may not contain all categories.
3 Click Upload and browse and select a previously exported zip file.
4 When The file has been successfully uploaded is displayed, click OK.
5 Click Import.
6 Confirm that you want to import data by clicking Yes in the Import Homepage data dialog.
7 Review the information messages at the bottom of the page. When the Import operation
successful is displayed, the import is completed.
8 Close the Administration tool and start it again before verifying the newly imported data.
Note: Be aware of the relationship between pages and widgets. The import is not a thorough copy of
a page and all the widgets, but only the page data. For a page to work in a target environment, the
same widgets must be available.
Note: Be aware of the relationship between Infor Ming.le groups, users, and permissions. If rules and
permissions are imported, these entities must exist in the target environment as well.
Note: Perform a full import only during off hours or a service window.
Note: Filters for pages and widgets use the default title that is the title in the Administration tool listings
but not necessarily the title displayed in the catalogs.

On-premises widget installation and upgrade


Standard Widgets tab in the Admin tool. A widget installation package file can contain one or more
widgets and is a zip file containing widget zips.A HOMEPAGES-Administrator can install additional
widgets or upgrade existing widgets in an on-premises installation. You import a widget installation
package file or a single widget zip file on the
1 Create a widget installation package:
a A HOMEPAGES-Administrator can install additional widgets or upgrade existingFor each widget,
add the widget manifest, .js files and eventually other files (not .ts files) such as .html files or
images to a zip file. The files should be located directly within the widget zip file, not in folders.
If there is just one widget, this zip file can be directly imported in the import tool.
b To import multiple widgets, create a new zip file containing all of the widget zips from step a
above, again directly within the zip file, not in folders. Both new installations and upgrades can
be added to the same package.
2 Install a widget installation package or zip file:
a Open the Admin tool and go to the Standard Widgets tab.
b Click the Actions menu and select Import.
c In the install widgets dialog, locate and select the file (.zip).
d Click Import.

Infor Operating Service Administration Guide | 157


Homepages administration

When the import is successful, a message dialog with the number of imported widgets is displayed.
e Verify that the number of imported widgets includes all widgets.

Note: If a widget already exists in the database, it is overwritten.

Reference

Concepts
Name Description
Homepages administra- A user with permission to use the Homepages Administration tools and
tor with full access to all published pages and widgets.
Homepages content ad- A user with full access to all published pages and widgets.
ministrator
Local widget A widget that is local to a page. A local widget is not part of the Widget
Catalog.
Mandatory page A page that is added to your pages by an administrator. You cannot re-
move a mandatory page.
My pages Displays an overview of your pages, which you can manage.
Page A page contains one or more widgets in a responsive grid layout.
Page Catalog A location where you browse, search, and add published pages.
Page menu Provides actions related to Homepages.
Page menu icon Displays the page menu when clicked.
Page modes A page is displayed in different modes when you are changing the page
layout, previewing a page, publishing a page, or publishing a widget. A
page mode is indicated by a command bar with a title and actions.
Page navigator Navigate your pages.
Page panel The area that displays the content of a page.
Page title bar Displays the page title, page navigator, and the page menu icon.
Preview page mode A preview of a published page.
Private page A page that is private to a specific user. Private pages are displayed only
to the user who creates the page.
Published page A page that is published to the Page Catalog.

Infor Operating Service Administration Guide | 158


Homepages administration

Name Description
Published widget A configuration of a standard widget that has been published to the
Widget Catalog.
Standard widget A widget of a specific type with a default configuration.
Widget Widgets are small applications that provide quick access to information
or functionality and can be added to a page.
Widget Catalog A location where you browse, search, and add published widgets.
Widget content area Displays the widget content. The content depends on the widget type.
Widget menu Provides actions related to a widget.
Widget title bar Displays the widget title and the widget menu icon.

Infor Operating Service Administration Guide | 159


IDM administration

Chapter 7: IDM administration

Infor Document Management enables customers to manage business documents related to ERP
objects and make them available to the user. It provides a versatile solution for storing, sharing, reusing,
and archiving digital content.
This product reduces the time and cost for searching documents. Infor Document Management is
secure and provides granular access control, enabling users to add security and permissions down to
individual pieces of the document.
This document provides reference information for Infor Document Management administrators.

Who Should Read this Document?


This document is written for those who are administering Infor Document Management. It also serves
as a useful guide for those who want to understand how the product works and learn more about the
available functions.

Administrator Responsibilities and Tasks


As a system administrator, your role is to ensure the Document Management system is accessible for
users.
You must have the required knowledge to assist users in their daily tasks.
You are expected to maintain and troubleshoot the system in case of problems.
You are expected to maintain the data model. This includes document types, value sets, and access
control lists. All of these are located in the content repository.

Where to Find Installation and Configuration Information for Infor Document Management
Infor Document Management installation and configuration information is available in a separate
document Infor Document Management Installation Guide.

Starting and Stopping Infor Document Management


Infor Document Management is delivered as an Infor Grid application and its runtime lifecycle is managed
through the Grid management pages.

Infor Operating Service Administration Guide | 160


IDM administration

Starting and Stopping Infor Document Management Server


1 From the Grid Management pages, select the IDM instance you want to start/stop.
2 Click Start or Stop.

Starting and Stopping Infor Document Management


StreamServe Adapter
1 From the Windows Services Management Console, select the Infor Document Management
StreamServe Adapter service to start or stop.
2 Click Start or Stop.

Exporting and importing Infor Grid system settings

Navigating the main page


1 From the main page (index.html), navigate to the Grid through Management Pages >
Status:DocumentArchive > Configuration.
2 Alternatively, you can navigate to the Grid from Server Configuration >
ApplicationDocumentArchive.
3 Now you should be able to see options for Export Settings and Import Settings.

Exporting system settings


1 Click Export Settings to save configured bindings, context roots, and property settings to a file.
2 Provide a password.
3 Click Export Settings and save the file.
Note: The password is used to encrypt/decrypt sensitive data in the exported XML file.

Importing system settings


1 Click Import Settings.
2 Specify the password of the configuration file.
3 Click Next to open a pop-up window for resolving the mappings and review references to imported
entities.

Infor Operating Service Administration Guide | 161


IDM administration

4 Click Next to open another pop-up window to review merge conflicts. The imported file might have
some overlapping bindings, context roots, /or properties.
5 Use the check box to indicate whether to overwrite current settings.
6 Click Finish to apply imported settings.
7 On the last confirmation pop-up window, click View log to see all changes.

Infor Document Management Client Interface


The Infor Document Management solution supplies an HTML client that is integrated with Infor Ming.le.
This client provides an intuitive user interface for accessing and managing the documents stored within
IDM.

Client Configuration and Access


This section describes how to configure the IDM client and access to it.

Infor Document Management Client in Infor Ming.le


The Contextual Application can be configured in Ming.le to display contextual information stored in
IDM that is related to objects in other Ming.le applications.
For more information about configuring the Contextual Application, see Configuring Infor Document
Management Contextual Application for Ming.le.
Both the Infor Document Management Client and the Contextual Application are enabled in Infor Ming.le
by installing the Infor Document Management plug-in for Ming.le and completing the Infor Ming.le
Configuration Wizard.

Secure Your Clients


We strongly recommend only HTTPS access when using BASIC authentication mode. With BASIC
authentication mode, passwords will be sent with base64 encoding but unencrypted.
Depending on your system configuration, you may have the option to use only NTLM. If NTLM is
available, then we recommend using this option.

Infor Operating Service Administration Guide | 162


IDM administration

Infor Document Management Server Information


There is an HTML file included with the Server installation of the Infor Document Management that can
be used to retrieve information about the installation. Access it using this URL:

http://your_server:port/ca/index.html

Infor Document Management Client Access


Access the client using these URLs:
• Infor Ming.le:

https://your_server:port/ca/html/workspace/client.html
• Standalone:

https://your_server:port/ca/client/index.html

Infor Document Management Client Features


This section describes the main features of the IDM client interface.

Search Documents
You can search for the required records and view the corresponding details using the search facilities.
The search functions are the following:
• Attribute search
• Free text search
• Advanced search using query language
You can customize the following by configuring the properties in Control Center. For more information,
see Infor Document Management Control Center.
• The document types that should be displayed for the users can be modified using the Document
Types Filter.
• The columns to display and the order by which they appear can be modified using the Result List
table.
The following can be configured by editing the application properties in the grid management pages:
• The number of records that appear on a page using the property called Client Search Result Page
Size.
• The number of records that appear in the Contextual Application using the property called Related
Information Contextual Application Result Page Size.

Infor Operating Service Administration Guide | 163


IDM administration

• The maximum file size of uploaded files using the property called Maximum File Size.

Attribute Search
You can search for documents using their attribute data. To perform an attribute search:
1 Access the IDM search bar in the upper-left corner. Click the drop-down arrow.
2 Select a type from the Select Document Type drop-down list. The Select Attributes box is populated
based on the selection.
3 Select an attribute from the next drop-down list. For example, Id, Name, Description, Status.
4 Select a condition from the respective drop-down list and specify the value. The conditions change
based on the selected attributes.
5 You can create and combine search criteria indefinitely. You can also combine attribute criteria with
free text search criteria. Click + to add criteria to the search query.
As an administrator of IDM, you can search for documents that were created by a user that was
soft-deleted in the Infor Federated Services.
6 Click Search. The Result Area shows the records that match the search criteria.
For example, 'Find all Approved Images' using this search criteria:
a Select the document type as Image, the attribute as Status, the conditional operator as ‘=’, and
the value as Approved.
You must select an operator and a value if you select an attribute.
b Select a condition from the respective drop-down list. The conditions vary based on the selected
attribute type.

Free Text Search


If free text search is enabled for the document type, you can search for documents in these ways:
• Use words or sentences that are part of the item's attribute values.
• Use words or sentences that are part of the content of the file that is attached to the item.
For example, find all items that have attributes, or an attached file, containing the string "approved by
manager" for a certain document type.
1 In the free text search field at the top of the search area, specify the value "approved by manager".
2 Choose the document type.
3 Click Search. The Result Area shows the records that match the search criteria.
4 You can also search for a document type to trigger the attribute search.
Specify the document type name. A search suggestion with a "Document Type" label is displayed.
The label is highlighted in blue. Click this suggestion to open the search panel. Press Enter to
perform a free text search for the term in the bar.

Infor Operating Service Administration Guide | 164


IDM administration

Advanced Search
The language used is a query language called XQuery. This language is similar to XML Xpath
expressions. Advanced users can use this functionality to search for items. "/MDS_Image" is an example
of a query that searches the database for all images.
1 Click Show XQuery.
2 Specify the required query as the search criteria to fetch the appropriate records.
3 Click Search. The Result Area shows the records that match the search criteria.
The advanced search field is populated with the actual query in these situations:
• When you build a query using free text and attribute input.
• When you build a query using a shortcut in the navigation bar.

Manage Documents
Search for the documents using any search functionality. The results are displayed in the Result Area.
Click on any document from the Result Area to view the details in a new tab.

Editing a document
Use this procedure to edit documents:
1 From the Result Area, select the document to be edited. The details are displayed in a new tab.
2 Click the Checkout button to check out the document.
3 Make the necessary changes to the document details.
4 When done, click the Save button to make the changes permanent.
5 Check in the document by clicking the Check in button.

Deleting a document
Use this procedure to delete documents:
1 From the Result Area, select the document to be edited. The details are displayed in a new tab.
2 Click the Delete button to delete the document
The check in, check out, and delete actions, as well as an option to download the file, can also be
performed on an item from the search result list.

Reverting a document
Use this procedure to revert to previous versions of a document:
1 Click the History tab of an open document.
2 Click "Revert to this version" for the version you want to revert to.

Infor Operating Service Administration Guide | 165


IDM administration

Adding documents
This function allows you to add various documents. You can create a document from a template or
start with a blank document. A document template is pre-populated with attribute values and, if required,
a file. This file must be smaller than two GB.
The input fields and attributes are displayed based on the document type selection. The displayed
attributes reflect your organization's data model. Mandatory attributes have an asterisk (*) in front of
the attribute name.
Examples of attribute types are:
• Value set values
• Integer values
• Strings
• Date
• Time
• Tables

Adding a document
To add a document:
1 Click New Document.
2 Select a document type.
3 Select a blank document or a document template and click Create.
4 Complete the document attributes and attach a file to the document, as necessary.
5 Click Save to add the document.

Creating a template
Before you can create a template you must enable the template functionality. To enable the functionality,
use the Template enabled field in the General section of the Document Type Details form. See
Document Type Details form on page 181.
To create a template:
1 Check out and open a document, with or without the attributes completed or a file attached.
2 In the document, click the Properties tab.
3 Select the Enable template check box.
4 Complete the Template Name and, optionally, Template Details.
5 Click Save or Check in to create the template.

Infor Operating Service Administration Guide | 166


IDM administration

Infor Smart Office and Infor Document Management


Infor Smart Office is delivered with the IDM Client already installed.
Use the Infor Smart Office profile editor to configure and enable the IDM Client. For more information,
see Infor Smart Office Administration Guide.

Infor Document Management Maintenance


This section contains information about data modeling and how to maintain Infor Document Management.

Prerequisites
Before you can start working with Infor Document Management, you must have access to:
• Infor Document Management Client
• Infor ION Grid
Note: You must also have a valid user name and password to log in to the application with administrative
privileges.

Roles
This table shows the available roles:

Role Description
IDM-User This role is required for access to IDM user inter-
faces and APIs and grants access to all docu-
ments without specific access control lists.
IDM-AdvancedUser This role is for an advanced user with access to
advanced tools such as mass update, mass
delete, and export.
Caution: Access to these tools can result in
considerable damage if used by unskilled per-
sonnel.
This role does not grant privileged access to any
content. This role implicitly includes the IDM-Us
er.

Infor Operating Service Administration Guide | 167


IDM administration

Role Description
IDM-Administrator This role is for a user who can create and alter
document types and configure IDM. This role
does not grant privileged access to any content.
This role implicitly includes the IDM-Advanced
User.
IDM-SuperUser This role provides full access to documents in
IDM. Users with this role bypass the security
model and are granted access to all content. As-
sign this role with care as this user can access
and edit any document in the system with no re-
strictions. Note that a user repository administra-
tor can add people to this role. This role implicitly
includes the IDM-User.
IDM-RelatedInformationUser This role grants access to the IDM Related Infor-
mation contextual application. A user with this
role is not granted access to other IDM interfaces.
This role does not affect access to content in IDM,
but as with all roles, this role can be used in the
Access Control Lists (ACL). It can manage autho-
rization (access to content/documents) within
IDM.
IDMCAPTURE-User This role grants access to the Operator activities
in Ephesoft such as:
• Viewing batches.
• Opening batches.
• Scanning and uploading new documents.
IDMCAPTURE-Administrator This role has the same security as IDMCAPTUR
E-User, with additional access to Administrator
activities, such as:
• Managing batch classes.
• Managing batch instances.
• Managing folders and viewing reports
IDMCAPTURE-SystemAdministrator This role has the same security as IDMCAPTUR
E-Administrator with additional access to
System Configuration, where access can be
added or removed for other users

Authorization using IFS


The IDM roles should be managed through IFS.

Infor Operating Service Administration Guide | 168


IDM administration

Output Files
StreamServe creates two output files for each document. These files should be located in the newDir
directory, as specified in the adapter configuration.
One of the created files is a document file that is saved in the archive.
The other is a descriptive text file that contains meta-information about the document. It contains XML
formatted information, as in the example below:
The MDAS entity and ACL are mandatory nodes. Make sure that you use unique filenames for the
output from StreamServe. You can use timestamp or a similar feature in StreamServe, since they will
be overwritten if they have the same name and are put in queue.
The value of the entity node is the name of the item type. The document created will be of this type.
The value of ACL is the name of the action control list setting the authorization level of the document.
The child nodes of the attr nodes are the attribute values to associate with the document. The name
of each child node must be equal to an attribute in the item type and the value should be the actual
data put as attribute value in the newly created item. Repeat these type-value pairs for all attributes
that should be stored in IDM.
Any attributes that are not part of the chosen item type will be ignored with a logged level 2 warning.
This log occurs when Log Level 2 is set on the adapter.
Use CDATA encapsulation if the output from StreamServe may contain characters that are reserved
for XML, for example, < or >.

Maintaining Data Models


Infor Document Management stores different types of information like image files, PDF, and other
documents. You can use Infor Document Management to assign attributes on these documents. These
attributes are used to classify information contained in IDM and relate them to entities in an ERP.

Attributes
Attributes can be used to locate a document. An attribute can store:
• Units of data (metadata)
• Values that describe a certain characteristic
• Property of a document
You can group attributes to make attribute groups. For example, the address attribute can be made
up of a group of attributes including street, city, state and zip code.
You can also define attributes that have multiple values. Such attributes are called multi-valued
(collections) attributes, which are implemented as child components. For example, you can store
multiple addresses, home addresses, and work addresses.

Infor Operating Service Administration Guide | 169


IDM administration

You create an attribute to store a characteristic of an item.

Document Types
A document type is a template for defining, and later locating, similar items. It is a structure that contains
all the components and associated data.
For example, a document type may contain the attributes such as height, weight, or color. If you use
the same template, documents of the same type are consistently constructed. This helps you to locate
them and define new ones.

Backup
A backup strategy is an overall data management plan. It is necessary to understand how important
the data is to the function of an organization.
1 Stop your Infor Document Management application. This ensures that the metadata in the database
and the files will be in sync for your backup.
2 Create a backup of your database. See the documentation for your database for more information.
3 Create a backup of your files. The files are located in the Files Root folder, as specified in the
application properties in the Grid Management Pages. To create a backup simply make a copy of
the subfolder called "mainFiles". If you want a larger backup including image conversions and
cached data, copy the entire Files Root folder.
4 Start your Infor Document Management application.

Data Migration
There can be several reasons for migrating data between IDM installations. Typically when you cannot
perform an upgrade you would look at performing a data migration into a new installation of IDM.
There are different data migration paths, and depending on your choice, there are pros and cons with
each path:
• You need to replace broken or upgrade your hardware that forces you to re-install IDM
• You need to re-install Operating systems or other software that forces you to re-install IDM
• You are moving all data from a Production system to a test system
• You are moving partial data from a Production system to a Test system
• You are moving from one IDM edition to another
There are two main paths to choose from when migrating data:
• Use a backup / restore approach
• Use an export / import approach

Infor Operating Service Administration Guide | 170


IDM administration

It is recommended to use the backup / restore approach when:


• You need to replace broken or upgrade your hardware that forces you to re-install IDM
• You need to re-install Operating systems or other software that forces you to re-install IDM
• You are moving all data from a Production system to a test system
It is recommended to use the export / import approach when:
• You are moving partial data from a Production system to a test system
• You are moving from one IDM edition to another

The Backup / Restore approach


Using this approach means that we use the built in methods of the database and file system to first
make a backup of the entire data and then restore it elsewhere.

Pros Cons
IDs and Properties will be retained All data, no selection
History is included Multiple tools must be used
Is potentially faster Systems must be offline during backup
Potentially larger size
Possible upgrade of source system required or
installation ofsame version as source system in
the target system (backup filesmust be compati-
ble between databases)

The Export / Import approach


This approach includes using the export / import tools of IDM. Exports may need to be divided into
several smaller ones depending on the size of the installation.
The result will differ from the source system – by how much, depends on the migration (for example
document IDs and properties will change).

Pros Cons
Partial data can be migrated IDs and properties of documents will be new/up-
dated
A single IDM tool is used History (old versions) are not included (only lat-
est)
Systems can be online while migrating data The possibility of running the exporter several
times to extract large amounts of data
Potentially smaller size of export Potentially slower

Infor Operating Service Administration Guide | 171


IDM administration

Pros Cons
If SharePoint is in use, there is a limit of 5000
Documents per run with the Exporter tool

Performance
Performance refers to the way in which a system performs or functions given a particular workload.
Performance is typically measured in terms of response time, throughput and availability.
Response time is the elapsed time between a submitted request and the response from the return
request. Examples include the time taken by a database query, or the time taken to display a retrieved
document.
Throughput is a measure of the amount of work over a period of time. In other words, it is the number
of workload operations that can be accomplished per unit of time. Examples include database
transactions per minute, kilobytes of a file transferred per second, total number of legacy documents
imported per hour.
Performance problems may be caused by poor application and system design; inadequate system
resources such as CPU, memory, disks, and non-optimal tuning of system resources.
Performance tuning can be performed to improve the performance. It is a complex and iterative process.
It involves establishing quantitative objectives, constant system monitoring, and selective and careful
tuning to ensure that the objectives are met over time.

Configuring Infor Document Management Server


These properties can be configured by accessing the Application Properties page of the InforDocument
Management application in the Grid Management Pages.

General
• Files Root: The root for the file structure where files will be stored, for example, C:\IDM\Files.
For sizing guidelines, see Infor Document Management Install Guide.
• Server Base URL: The base URL which is used for example when creating public resource URLs.
If possible this is automatically calculated from the router information, but if needed this can be
overridden in this property. For example: https://<host>:<port>/.
• MIME Types: Maps file extension to file type. Only valid MIME types can be set. Forexample, image/
tiff or application/pdf. The Key field is for the extensionand Value is for the MIME type.

Client
• Client Search Result Page Size: States how many results to display in a page in the Infor Document
Management Web Client.

Infor Operating Service Administration Guide | 172


IDM administration

• Related Information Contextual Application Result Page Size: States how many search result hits
to show in one page in the Ming.leweb part for IDM called "Related information".
• Maximum File Size: The maximum size that a file can have. The unit of this property is MB.The
default value is 50MB.

Event hub
See Configuring Event Hub Subscription for information on how to configure the Event Hub properties.

Resource server
See Infor Document Management Resource Server for information on how to configurethe Resource
Server properties.

ION adapter
• Database Server: The address of the server hosting the SQL Server database to be usedfor ION
Workflow.
Note: The database server address must not contain protocol or portnumber.
• Database Password: The password of the user connecting to the database.
• Database User: The database user. Must have privileges to create and alter tables andto read,
insert, and update rows.
• Database Name: The name of the database to be used for ION integration.
• Database Schema: The database schema to be used when accessing the database.
• Database Port: The port to be used when accessing the database.

Configuring Event Hub Subscription


Infor Document Management can act as a subscriber to Events coming from Event Hub. Depending
on the Event type, IDM will find a specific document and update it with the changed information in the
Event. Only update is supported. If there are multiple documents found based on the keys in the Event,
they will be updated as well.
The Event Hub is configured in Infor Document Management Server with Grid properties.
1 To configure the Event Hub, enter the configuration view of the Infor Document Management
application in the Grid Management pages.
2 Click Edit Properties.
3 Under Application Defined Properties > Event Hub, find theServer property and click the Value cell.
4 In the Edit Property dialog box, type the server_name/IP:port to Event Hub, for example,
event.hub.server.infor.com:20005.
5 Click Create Property.
6 Find the Subscriptions property and click the Value cell.
All queued events for the IDM subscriber in Event Hub will be purged when you change the
Subscriptions property.
7 In the Edit Property dialog box, type subscription entries separated with semicolon.

Infor Operating Service Administration Guide | 173


IDM administration

A subscription entry should contain details about the Event Hub subscription, a document type
name, and key fields (any number) separated by a comma. The following shows the format for
writing a subscription entry:

event_hub_publisher:database_table:event_hub_operation,idm_docu
ment_type,search_key_maps
:update_key_maps:acl_map;
For example, M3:MITMAS:U,ADCSupInv,M3_CONO=ITNO:ADC_TotalAmount=ITNO,DIM2:{DI
VI}Acl;
The above example will evaluate to the following search query: /ADCSupInv[@M3_CONO="<theIn
comingValueOf_ITNO>"]. The Documents matching the query will be updated with the attribute
'ADC_TotalAmount' is set to the incoming new value of the source key ITNO and the attribute
M3_DIM2 will be updated to the incoming new value of the source key DIM2 The document will be
given the ACL '<theIncomingValueOf_DIVI>Acl' if it is supported by the document type.
You can follow the guide below to aid in constructing a subscription entry:
• Event Hub Publisher: Available event hub publishers can be found in your Event Hub installation.
• Database Table: Depending on the selected event hub publisher, there are different database
tables available for use. For example, if the event hub publisher is "M3", any table in M3 would
be a valid database table.
• Event Hub Operations: Event Hub Operations are typically CRUD (Create, Retrieve, Update,
Delete) operations, but more are available. The order of the letters in this string is not important.
For more information, see the Infor ION Grid ExtensionsInstallation and Administration Guide.
• IDM Document Type: The Infor Document Management document type identifier can be found
in your IDM installation.
• Search Key Maps: This is a list of key mappings that are required to find the correct document
to update in Infor Document Management. A search_key_map has the following format: idm_
key=source_key, where the source_key is a key from the publishing system and idm_key
is an attribute in IDM. You can include as many key maps as you need, the order of the keys is
not important.
Note: If the idm_key is left out of a map, it will default to M3_<source_key>.
• Update Key Maps: Optional. It has the following format: idm_key=source_key. If it’s left out,
all attributes matching the format M3_<source_key> will be updated.If provided, only the mapped
attributes will be updated in IDM and the mappings will determine which IDM attributes are
updated with which event source value.
• Access Control List Map: Optional. It is a map used to set the access control list (ACL) on the
updated items. To use the Access Control List Map, you also have to specify the Update Key
Maps. If left empty, it will not be used. Configure the Access Control List Map by setting '
{source_key}', more complex with source key combined with text '{source_key}some
Text{source_key}', or a predefined ACL like 'myOwnACL'.
For example, the Access Control List Map '{DIVI}ACL' will set the ACL on the documents to
‘<theIncomingValueOf_DIVI>ACL’ if its supported by the document type.
• Semi-colon (;): Separates the subscription entries. After the semi-colon you can start anew
subscription if you need more than one. You can have as many subscription entries as you
require.
8 Click Create Property.
9 Provide values for these properties:

Infor Operating Service Administration Guide | 174


IDM administration

• Username: Enter a username with 'search', 'update', and 'check in' access in the database. This
user will be used to update the items that will be updated from the Event Hub. This user will also
check in other users checked out items if the items are checked out and gets updated from the
Event Hub.
It is recommended to have a special user for this. Then it will be visible inthe client from where
the item is updated.
• Password: The password for the user. Is not required and should not be set if its not absolutely
necessary.
10 The following properties are optional and can be left as undefined:
• Language: The language code for the language to be used when creating a connection where
no language has been provided.
• Option: Sets additional options for the connection. Only supported by some contentrepositories
and implementation is content repository specific.
11 To save all the property configurations for Event Hub, click the Save button beside the Navigation.
12 The Save Configuration Changes dialog shows a summary of the changes. Click Save to finalize
all changes.
You do not have to restart the IDM Server, the value in the properties will take effect as soon as yousave
them in Grid.
You can test your new subscriber by simply making a change to the system that will normally triggeran
event in the Event Hub. For more information, see the Infor ION Grid Extensions Installation and
Administration Guide.

Configuring Infor Document Management Contextual


Application for Ming.le
The Infor Document Management contextual Application can be configured to listen to contextual
changes in any Ming.le-enabled product that publishes contextual changes (that is, when a selection
is changed from one item to another). The contextual Application will display related documents, based
on the business message context sent from the publishing product.
For example, when item "Bicycle123" is selected in the Item Master program of the M3 ERP system,the
Infor Document Management contextual Application will display a photo of the selected bicycle.
To make the Infor Document Management contextual Application understand what to display depending
on the inbound contextual message, a configuration must be made. This configuration will tell the Infor
Document Management contextual Application which documents to display – it maps input values to
a query/search string so the right documents are presented for the right publishing
object/program/system.
For information on how to edit the contextual business mappings, see Business Context Model.

Infor Operating Service Administration Guide | 175


IDM administration

Filtering Available Document Types


This functionality will filter out document types entirely from Infor Document Management. Filtering is
useful when you use the content repository for other things that you do not want available in Infor
Document Management. It is also useful if you have several IDM instances installed for different
purposes, but connected to the same content repository. The logic of filtering is as follows: if there are
no filters, all available document types will be present and available in IDM. However, if there are
filters,only document types in the filter will be present and available in IDM.
For example, to enable all document types – leave the filter empty. To enable only File, Image, and
Invoice document types – put File, Image, and Invoice in the filter. To enable all document types except
for Blueprint, you have to put all document types you want in the filter. For information on how to edit
the filter, see Document Types Filter.

Auditing in IDM
Auditing is enabled for configuration changes, that is, control center changes, by default.
To access the audit logs files:
1 Navigate to the Grid Management page.
2 Select Monitoring.
3 Search for "idm-audit".
We recommend that you frequently back up this log file.

Creating read-only user access to IDM


Complete these steps to create a read-only user for IDM, for example for auditing. This user gets read
access to all documents in IDM. External auditors could get this kind of access to simplify an audit.
1 Add the user of the auditor in IFS.
2 Create a new IFS security role, "Auditor", and add the auditor user to it.
3 Add two security roles to the auditor user: "IDM-User" and "Auditor".
4 For all ACLs in all document types, add the Auditor role and only enable the "Read" privilege.
5 Optionally, if the auditor must have only Read-Only and no Edit access that the role "IDM-User"
may give: ensure the "IDM-User" security role does not grant more than read privileges to any
document.
6 To revoke Auditor access, reverse the steps.

Infor Operating Service Administration Guide | 176


IDM administration

Infor Document Management Resource Server


The Infor Document Management Resource Server is an application with the responsibility to convert
IDM items into images that can be used for different purposes, for example, in the different clients that
use information from Infor Document Management. Typically these are thumbnail and preview images
that are shown in lists and such in the client's UI.
The Resource Server runs within the grid and communication from Infor Document Management Server
to the Resource Server is done inside the grid.
For initial configuration of the Resource Server, see Infor Document Management Installation Guide.

Maintaining Conversion Types


A conversion type is a configuration for one type of conversion that can be performed by the Resource
Server. A conversion type consists of these four properties:
• Width: The width in pixels for the converted image.
• Height: The height in pixels for the converted image.
• MIME type: The MIME type for the converted image.
• File Extension: The file extension for the converted image.
There are two groups of conversion types, predefined and user defined. The predefined types Thumbnail
and Preview, are two types of conversions that will be performed on all item types in Infor Document
Management. They should never be removed or the Resource Server will stop functioning. The values
of the Thumbnail and Preview conversion types can be altered to best suit the needs of the specific
application. User defined conversion types can be added when the need occurs.

Adding a New Conversion Type


Use this procedure to add a new conversion type:
1 From the IDM Grid Application page, access Configuration > Edit Properties.
2 Click the link in the column Value for the property Conversions in the table Resource Server.
3 Click Add New Entry and add a new name for the conversion in the Key column.
4 Click <empty list>.
5 Click Add New Entry and type Width:<width> (where <width> is the desired width in pixels).
6 Click Add New Entry and type Height:<height>(where <height> is the desired height in pixels).
7 Click Add New Entry and type Mime:<mime> (where <mime>is the desired MIME type. Supported
MIME types are image/png and image/jpeg)
8 Click Add New Entry and type FileExtension:<extension> (where <extension> is the desired file
extension. Supported file extensions are png and jpg).
9 Save all changes.
All user-defined conversion types can be edited when needed.

Infor Operating Service Administration Guide | 177


IDM administration

Linking Conversion Type to a Document Type


In order for the Resource Server to actually convert a document type into a specific conversion type,
a reference must be created between the document type and all conversion types that it should be
converted into.
1 From the IDM Grid Application page, access Configuration > Edit Properties.
2 Click the link in the column Value for the property Document Types and their Conversions in the
table Resource Server.
3 If the document type is not in the list click Add New Entry.
4 Type the name of your document type.
Note: This must be exactly the same as the document type (item type) in the Infor Document
Management Server.
5 Click the link in the Value column for the document type, select Add New Entry. Type in the name
of the conversion type that you wish to have the document converted into.
6 Save al changes.
Note: After having referenced a document type to a new conversion type the Resource Server
must be restarted for the changes to take effect.

Infor Document Management Control Center


This section describes the Control Center, a suite of tools provided for the administration and
configuration of IDM.

Access Point
To access the Control Center, click the gear icon next to the + Add Document button on the IDM
landing page and select Control Center.

Information
The Information menu contains these pages:
• Licenses
• Examples

Infor Operating Service Administration Guide | 178


IDM administration

Licenses
This page shows the licenses for third party software in the IDM client.

Examples
This page shows the guides and files that are required to perform these actions with IDM:
• Use the Java API.
• Use the .NET API.
• Capture a document through IDM Capture.
• Configure the Approval Workflow in ION.
• View definition file.
• Process a Content Document.
• See the Infor OAGIS documentation.

Administration
The Administration menu contains these pages:
• Document Type
• Value Set
• Import / Export

Document Type
Use this page to view, create, update, and delete document types.

Viewing document types


1 Navigate to Control Center > Administration > Document Type.
2 List of all document types is displayed on the left side of the page.
There is also a search bar for the document types.

Adding a document type


1 Navigate to Control Center > Administration > Document Type.
2 Click the New Document Type button.
3 Go through the New Document Type wizard.

Infor Operating Service Administration Guide | 179


IDM administration

The wizard navigates you through the whole process of creating a new document type. The wizard
consists of these pages:
• General
• Attributes
• ACL
For details, see "Document Type Details form".
4 On the last page of the wizard, click Done to save the new document type.
Click Previous to go back to earlier steps. Click Cancel to discard the new document type.
Note: To proceed to the next step, you must fix all validation issues that are displayed in the current
step.

Cloning a document type


1 Navigate to Control Center > Administration > Document Type.
2 Click the Copy Document Type button next to the selected document type name.
A New Document Type wizard is displayed with pre-filled fields with the selected document type
properties.
3 Go through the New Document Type wizard.
The wizard navigates you through the whole process of creating a new document type. The wizard
consists of these pages:
• General
• Attributes
• ACL
For details, see "Document Type Details form".
4 On the last page of the wizard, click Done to save the new document type.
Click Previous to go back to earlier steps. Click Cancel to discard the new document type.

Editing a document type


1 Navigate to Control Center > Administration > Document Type.
2 Select a document type to edit from the list of all document types. Alternatively, search for the desired
document type.
The Document Type details view is displayed. The view consists of these parts:
• General
• Attributes
• ACL
For details, see "Document Type Details form".
3 Update the document type properties as desired.
4 To save all changes, click Save Changes.

Infor Operating Service Administration Guide | 180


IDM administration

Note: When a document type contains unsaved changes, an indicator is displayed in the upper-right
corner of the Document Type details view.
Any changes that are made to the document type are saved only when you click Save Changes.
Some of the properties cannot be updated after they have been saved.

Deleting a document type


1 Navigate to Control Center > Administration > Document Type.
2 Click the Delete Document Type button next to the document type name in the list of all document
types.
3 Confirm the dialog.
4 After the request has been processed, a dialog box with the result is displayed.

Document Type Details form


The form consists of several parts, which are described below. You can use these parts to view and
modify the properties of a document type, its attributes, and its Access Control Lists (ACLs).

General

Field Description
Display Name Required. Name of the Document Type. Constraints: None
Business Context Attributes Configure which attributes and properties should be available in
the published business context message for documents of this
document type. You can view these messages in the context
viewer.
Name Required. The ID of the Document Type. The value is generated
from the name by default, but can also be changed manually.
This is automatically generated.
Constraints:
• ID format: Only letters (a-z, A-Z), digits (0-9), and underscore
(_) are allowed. The ID cannot start with a digit.
• Unique within all existing Document Types.
• Enabled only when a new Document Type is being created.
Document Title Choose the attribute that is used for the title of each document
of this type.
Text Searchable (Dis)allows text search on the documents stored under this Doc-
ument Type. Constraints:
• Enabled only for existing Document Types (disabled in the
New Document Type Wizard).

Infor Operating Service Administration Guide | 181


IDM administration

Field Description
Language Text search language. Constraints:
• Displayed and enabled only when Text Searchable check box
is selected.
Template Enables and disables the functionality to create documents of
the specified document type from documents that are pre-popu-
lated with attribute values and a file.
Use case sensitive LIKE Enables and disables the use of case sensitive LIKE searches
in the database. Select this check box when using Postgres as
a database and attribute indexes are added. Otherwise the index-
es are not used during searches in IDM.
Use unique ID When this check box is selected the items in the document type
get a generated unique ID that can be used as a reference. A
unique ID is not changed during a data migration and always
keep its value unlike an Internal ID.

Attributes
Allows the user to manage document type attributes.

Task Procedure
List attributes All attributes that are assigned to the current document type are
displayed in the list along the left edge of the form content.
Add an attribute 1 Click the + button.
2 Fill in the attribute details form
3 Apply changes by clicking the Save Changes button in the
upper-right corner.
Discard the changes by clicking the Delete button in the at-
tributes list.
Note: Applied changes are sent to the server only in these
situations:
• The wizard is finished, when creating a new document type.
• The Save button is clicked, when editing an existing docu-
ment type.

Infor Operating Service Administration Guide | 182


IDM administration

Task Procedure
Clone existing attribute of the 1 Click the attribute you want to clone and click Duplicate.
current document type 2 A New Attribute form is displayed with pre-filled fields using
the cloned attribute properties.
3 Update any of the properties if required.
4 Apply the changes by clicking the Save Changes button in the
upper-right corner.
Discard changes by clicking the Delete button in the attributes
list.
Note: Applied changes are sent to the server only in these
situations:
• The wizard is finished, when creating a new document type.
• The Save button is clicked, when editing an existing docu-
ment type.

Edit an attribute 1 Click an attribute to edit in the list of existing attributes.


2 Perform desired changes in the attribute details form.
3 Click the Save Changes button to apply changes.
Note: Applied changes are sent to the server only in these
situations:
• The wizard is finished, when creating a new document type.
• The Save button is clicked, when editing an existing docu-
ment type.
If there is existing data in these attributes, then some fields cannot
be edited.
Remove an attribute 1 Select the attribute and click Delete in the attribute list.
If you click Delete in the upper-right corner, the document type
is deleted.
2 Confirm the dialog.
Note: Applied changes are sent to the server only in these
situations:
• The wizard is finished, when creating a new document type.
• The Save button is clicked, when editing an existing docu-
ment type.
If there is existing data in these attributes, then they cannot be
deleted.
Reorder an attribute 1 Click the attribute for which you want to change the order.
2 Arrows are displayed at the top of the list. With the desired
attribute selected, click the up or down arrows to move the
attribute in the desired direction.
Alternatively, you can drag and drop attributes into the desired
order.
The order is displayed in the detailed document view for all doc-
uments of this type.

Infor Operating Service Administration Guide | 183


IDM administration

Attribute details form fields

Field Description
Display Name Required. The name of the attribute. A name is automatically
generated for you.
Data Type Data type of the attribute. Default value is String. Options:
• String
• Short (min: - 32,768, max: 32,767)
• Long (min -2³¹, max 2³¹-1)
• Decimal (unlimited)
• Date (format: YYYY-MM-DD)
• Timestamp (format: YYYY-MM-DD hh:mm:ss)
• Double (min: - 1.7976931348623157e+308, max:
1.7976931348623157e+308)
• Bool (true/false)
• Value Set (set of applicable options defined by the assigned
Value Set)
Constraints:
• GUID/User data
• Enabled only for new attributes.
Default value Optional. Default value of the attribute. Field has a form of a text
field, radio buttons (bool), or as a drop-down (Value Set). Con-
straints:
• Value has to match constraints defined by the attribute Data
Type, min, max, and sized properties.
• Not enabled for Date, Time, and Timestamp Data Types.
• Not enabled for multi-value attributes.
Min Optional. Minimum acceptable value. Constraints:
• Enabled only for numeric attributes (Short, Long, Decimal,
Double).
• Min/Max bounds defined by the Data Type.
Max Optional. Maximum acceptable value. Constraints:
• Enabled only for numeric attributes (Short, Long, Decimal,
Double).
• Min/Max bounds defined by the Data Type.
Value Set Required. Set of values for the attribute. Constraints:
• Enabled only for Value Set attributes.
Required Specifies whether the attribute is required. Constraints:
• Not enabled for multi-value attributes.

Infor Operating Service Administration Guide | 184


IDM administration

Field Description
Unique Specifies whether the values are supposed to be unique. Con-
straints:
• Not enabled for multi-value attributes

ACL
Allows the user to manage Access Control Lists (ACLs) that are assigned to the current document
type. ACLs are sets of user roles and privileges.
Default ACL: Optionally, you can select one of the document type’s ACLs as the default ACL. To do
this, select the radio button in the Default column of the ACL’s table row.

Task Procedure
List ACLs All ACLs that are assigned to the current Document Type are
displayed in the list.
Add a New ACL 1 Click the Add ACL button in the upper-right corner.
2 Add a name and description.
3 Set Secure attributes, which can only be edited by users with
the “SecureAttributes” privilege. To achieve this, put currently
existing attributes into the “Secure Attributes” category.
4 Add security roles and give each role privileges. Select an IFS
role from the drop-down and select the check boxes that cor-
respond to the correct permissions.
Note: Applied changes are sent to the server only in these situ-
ations:
• The wizard is finished, when creating a new document type.
• The Save button is clicked, when editing an existing document
type.
Edit an ACL 1 Select the ACL you want to edit and click the Edit button in
the top right of the table.
2 Edit the ACL’s properties and update the ACL’s roles as de-
sired.
3 Click Save to apply changes.
Note: Applied changes are sent to the server only in these situ-
ations:
• The wizard is finished, when creating a new document type.
• The Save button is clicked, when editing an existing document
type.

Infor Operating Service Administration Guide | 185


IDM administration

Task Procedure
Remove an ACL 1 Select the ACL you want to remove and click the Delete button
in the top right of the table.
2 Click Yes in the confirmation dialog box. The ACL is removed
from the list.
Note: Applied changes are sent to the server only in these situ-
ations:
• The wizard is finished, when creating a new document type.
• The Save button is clicked, when editing an existing document
type.

ACL details form

Field Description
Name Name of ACL. Constraints:
• ID format - only letters (a-z, A-Z), digit (0-9),
and underscore (_) are allowed. Value cannot
start with a digit.
• Unique within the current Document Type
ACLs. Enabled only for new ACLs.
Description Required. Description of the ACL. Constraints:
No constraints.
Secure Attributes Attribute level permissions.
This feature makes it possible to mark a set of
attributes in a document type as secure. If an at-
tribute is marked as secure only users that has
the "Edit Secure Attributes" privilege can change
the value of the attribute. All users can still see
the attribute and the value of the attribute.
To mark attributes as secure click the settings
icon to the right that opens the Secure Attributes
dialog. In this dialog all available attributes are
listed to the left and the attributes marked as se-
cure to the right. Use the arrow icons to mark or
unmark attributes as secure.
Roles List Add permissions for separate IFS roles. Select
a role from the drop-down, and then select the
check boxes to the right to enable the desired
privileges.

Infor Operating Service Administration Guide | 186


IDM administration

Related documents
In the IDM Control Center, users with Administrator privileges can create rules by which documents
are related.
1 Navigate to Control Center > Administration > Document Types.
2 Choose the document type for which you want to create a rule.
3 Click the Related Documents tab.
4 To add a rule, click Add New under the Items in Bundles list.
5 Specify the documents you want attached to the document type. You can perform this action in the
same way a search query is built.
6 Alternatively, add an XQuery to define the document bundle.
7 You can add multiple rules.
8 Save the rules.
9 To delete a rule, select the rule and click Delete.

ACL rules
In the IDM Control Center, users with Administrator privileges can use attribute values in documents
to secure these documents.
Example: You want all invoices over $500.00 to be private. Therefore, you create an ACL rule in the
Invoice document type, where the attribute is “Amount”, and it is greater than or equal to 500. The
XQuery, which can be displayed when you add or edit a rule, would look like this:
/Invoice[@Amount >= 500]
1 Navigate to Control Center > Administration > Document Types.
2 Click the ACL Rules tab.
3 To add a rule, click Add New in the Current Rules list.
4 Specify a description for the rule.
5 Specify the attributes you want to use to determine whether a document is secure. Do this similarly
to how you would build a search query.
6 Alternatively, add an XQuery to define the document bundle.
7 You can add multiple rules. The rules are followed in the order that they are listed.
Example: If you have a document that fits Rule 1, but not Rule 2, this document’s ACL is changed.
8 Save the rules.
9 To delete a rule, select the rule and click Delete.
10 To edit a rule, select the rule and edit it in place.

Value Set
Use this page to view and manage value sets.

Infor Operating Service Administration Guide | 187


IDM administration

Viewing value sets


1 Navigate to Control Center > Administration > Value Set.
2 The list of value sets is displayed on the left side of the page. You can also search for value sets.

Adding a value set


1 Navigate to Control Center > Administration > Value Set.
2 Click Add.
3 Specify a display name.
4 Edit the Name field if required.
5 Choose the data type.
6 Click Yes.

Adding values
1 Go to your newly created value set.
2 Click the Values tab.
3 Click Add to add a new value.
4 Specify a name and a value.
5 Click Yes.

Deleting values
1 Go to the appropriate value set.
2 Click the Values tab.
3 Click the value you want to delete.
4 Click Delete directly above the value table.
Note: If you click Delete in the title bar of the page, the whole value set is deleted.
5 Click Save Changes.

Editing values
1 Go to the appropriate value set.
2 Click the Values tab.
3 Click the value you want to edit.
4 Click Edit.
5 Edit the name or the value.
6 Click Yes.
7 Click Save Changes.

Infor Operating Service Administration Guide | 188


IDM administration

Import / Export
Use this page to export and import, through XML files, these components:
• Document types
• Value sets
• The configuration parts of Control Center:
• Document Types Filter
• Result List
• Business Context Model
• ION Configuration
If you use Microsoft SharePoint or IBM DB2 CM, see the appendices for exporting / importing Document
Types and Value Sets.

Using the Export tab


1 Navigate to Control Center > Administration > Import / Export and click the Export tab.
2 Optionally, perform one or more of these actions:
a Expand the Document Types part to select one or more document types.
b Expand the Value Sets part to select one or more value sets.
c Expand the Configuration part to select different parts such as Document Types Filter, Result
List, Business Context Model, and ION Configuration.
3 Click Export to create an export XML. A window is displayed with the configuration export preview.
4 Click Save to save the export XML.
5 Depending on the selection, the exported XML may contain these parts:
• documentTypeFilter - A list of document types that are included in Administration >
Configuration > Document Type Filter.
• resultLists - Result lists configuration.
• bcModels - Business context model configuration.

ION ION configuration


ion:isActive If publishing to ION is active or inactive.
ion:user Specify the ION user.
ion:documentTypes A list of document types publishing to ION.
ion:workflowConfiguration A workflow configuration.

Using the Import tab


1 Navigate to Control Center > Administration > Import / Export and click the Import tab.
2 Click Select XML file and browse for the XML file. A file validation applies. Only XML files that were
created by the exporter are accepted. If validation fails, Import XML file remains disabled.

Infor Operating Service Administration Guide | 189


IDM administration

3 When the configuration file is uploaded, an import preview is displayed and includes any or all of
these parts:

Document Types and Value Sets The list of document types and value sets to be
imported.
Document Type Filter A list of document types that is displayed for
the user when importing this configuration.
Result List Result list configuration to be imported.
Business Context Models Business context model configuration to be im-
ported.
ION ION configuration to be imported.

4 You can collapse or expand each part to see possible warnings or information:
• Warning - yellow sign: The warning sign does not disable Import XML file. We recommend that
you go through all warning messages before starting the importer. This could be due to these
situations:
• Some configuration parts already exist in the repository that might be overwritten, for example,
Result List.
• Some configuration parts already exist in the repository that might be lost, for example,
Document Type Filter.
• Information - blue sign: The information sign does not disable Import XML file. It is usually
displayed in these situations:
• If some parts cannot be imported, for example, Items.
• If some existing parts are merged with new ones from the XML file, for example, Result List.
• A green OK sign with no message required.
5 Click Import XML file to run the importer. When the import is finished, a report window is displayed
with an information table that summarizes the status of the import. If any error occurs during the
import, the error message informs the user what went wrong.
When the import is successful, Import XML file is disabled.

Configuration
This section describes various options for configuring Infor Document Management.

Business Context Model


The Business Context Model allows the mapping between a Business Context Model and a Search
Query to be specified. It is used to find documents from a Business Context Object instead of a query.
The key consists of four parts, used for mapping the Context Message. The keys are unique. The
Business Context Model table shows all the parts of the key. On every row in the table, you can perform
these actions:

Infor Operating Service Administration Guide | 190


IDM administration

• Edit a Business Context Model by clicking the edit icon.


• Delete the Business Context Model by clicking the delete icon.
To add a new Business Context Model, click the add button above the table.

Edit and Add pop up


For more information, click the 'i' button.

Field Description
Key The key consists of four parts, used for mapping
the Context Message. The key must be unique
and is case sensitive when matching against the
Context Message.
Entity, Product and Screen are optional and are
determined by the publishing system. Document
type are optional and are a Document type in In-
for Document Management content repository.
Note that the 'screenId' part of the business con-
text message is a concatenation of 'infor_prod-
uct_identifier' and 'product_screen_id' with a '_'
(underscore) in between, according to the Infor
Ming.le standard.
Example: |InforItemMaster| |m3| |MMS001|
|MDS_File|
xQuery The xQuery is required and is used when
searching for documents. The xQuery is an
xQuery from the Infor Document Management
search, where attribute values can be replaced
with variables from the Context Message by set-
ting {variable from Context Message}.
The xQuery can contain any variable that is
available in the Context Message (see Ming.le
standard definitions), e.g '{idX}' where 'X' is a
number between 1 and 15.
Example: /MDS_File[@MDS_Name="{id1}"]
Access Control List The access control list is optional and can be set
to an access control list name, one or more vari-
ables available in the Context Message, or a
string of text combined with variables. The result
must form a valid access control list.
Example: {id3}SomeText{id4}ACL

Infor Operating Service Administration Guide | 191


IDM administration

Field Description
Additional Attributes Additional attributes are used in addition to the
attributes in the xQuery. They are added but not
searched upon.
The attribute name is an attribute in the Infor
Document Management content repository and
the value should be a variable in the Context
Message or a string of text combined with vari-
ables.
Example: |MDS_Name| |{id1}| where value can
be '{id1}' or more complex like '{id1}-{id2}xxx{id3}'
You can only add additional attributes if document
type is set in the Key.
Click the Add button under the table to add a new
additional attribute. - Click the remove icon on
corresponding row to remove an additional at-
tribute.

Document Types Filter


The Document Types Filter allows the administrator to specify what document types should be displayed
to a user, based on the user's IFS security role.
Each filter consists of two lists of document types. On the left side is the list of all available document
types that are not selected (not visible to the user). On the right side are all selected ones (visible to
the user).

Filtering Document Types


Use this procedure to filter Document Types:
1 Click New filter.
2 Choose an IFS security role that this filter corresponds to.
3 Move all document types that should be visible to the right list.
4 Move all document types that should not be visible to the left list.
5 Click Save to apply the changes. Click Cancel to reset both lists.
6 Click Enable Filter to see the changes.
Note: When no document type is selected, all of them are visible to the user.

ION Configuration
The ION Configuration section is where the communication between IDM and ION is configured.
The first radio button "Publish to ION" is a general switch to enable or disable the IDM communication
with ION. If you do not have Infor ION installed, you should turn this off.

Infor Operating Service Administration Guide | 192


IDM administration

Below this option is a list of the document types present in IDM. You can select to individually turn
these on or off. If turned on, these are sent to ION as a Sync.ContentDocument message. ION then
handles these messages depending on its configuration.

Specific Workflow Configuration


To configure a specific ION workflow, click the + button next to the corresponding document type.

Field Description
Workflow Name Required. This is the name of the Workflow in
ION that you wish to launch.
Attribute Value & ACL For each of the states a Workflow can be in, you
can set these optional attributes and ACLs that
will be set against the document in IDM.
Input Parameters This allows you to map document attributes to
the ION Workflow Input parameters.
This is optional, depending on the configuration
of the workflow in ION.
For example, if an input parameter is required in
the workflow, then this configuration of this input
parameter becomes mandatory.
Output Parameters This allows you to map ION Workflow parameters
to attributes of a document. This will result in
these attributes being updated on the document
when the workflow has been successfully com-
pleted.

Languages
Defines additional languages that can be used in IDM to provide translations of the data model. Data
model translations include names of document types along with their attributes and also value sets
and their values.
The administrator can add languages by clicking the Add button in the languages section. There is a
list of languages supported by Infor Ming.le which can be chosen in the modal window. Selection of a
language can be done by its language code (IETF) or its name.
Once an additional language has been added to the list, the translation feature is made available
through the "translate" button. This button is displayed next to any data model name (Document Type,
Value Set) that the user wants to translate.

Result List
The Result List allows the administrator to specify which columns to display in various search result
lists.

Infor Operating Service Administration Guide | 193


IDM administration

The Result List table contains these items:


• Key: The name of the document type.
• Value: The list of strings where each string represents a column. The first entry isthe first column.

Adding a New Result


Use this procedure to add, edit, or delete a Result:
1 Specify the document type in the Key column.
2 Click Edit. The Results Properties window appears.
3 Click Add New Property to add new entries.
Click Delete the Property to remove unwanted entries.
4 Click Save to apply the changes. Click Cancel to discard the changes.

Deleting a Result
Use this procedure to delete a Result:
1 Click Delete to remove a result.
2 Confirm the operation.

Editing a Result
Use this procedure to edit a Result:
1 Click Edit. The Results Properties window appears.
2 Click Add New Property to add new entries.
Click Delete the Property to remove unwanted properties.
3 Click Save to apply the changes. Click Cancel to discard the changes.
Note: Result List is not sorted by default. It is possible to sort the table by clicking the Key header
column.

Retention Policies
With the retention policies configuration you can automatically archive, delete, or purge documents
from the system.

Creating a policy through XQuery


With the Enter Query Manually option selected, complete these steps to create a policy.
Each retention policy contains four parts:
• A switch to activate the policy
• An action
• A description

Infor Operating Service Administration Guide | 194


IDM administration

• An XQuery
In the retention policy configuration you can perform these actions:
• Click Add to add a retention policy.
• Enable the switch to run a retention policy.
• Click Edit to edit a retention policy.
• Click Delete to delete a retention policy.
Add and Edit menu
For more information, click Information in the menu.

Field Description
Active A switch that is used for activating or de-activating a retention policy.
Action The origin and destination of the data that is affected.
Description A short text that identifies the retention policy in plain English.
XQuery The result of the xQuery search in IDM defines the documents that
are affected by the retention policy. You can copy and paste the result
from the advanced search box in the document search. Relative time
functions can also be used for building a query. For more information,
click information, above Add.

Examples:
To archive Employee Applications 8 months after they are created:
/Employee_Application[@CREATETS < date()-yearMonth(-8)]
To delete all Invoices 6 months after their last modified date:
/Invoice[@LASTCHANGEDTS < date()-yearMonth(-6)]
To archive all photos one week after are created:
/Photos[@CREATETS < date()-date(-7)]

Creating a policy through the rule builder


You can now use a rule builder to create retention policies without the use of the XQuery language.
1 Select the Use Query builder option.
2 Add these fields:
Document type
The document type for which you want to create a policy.

Attribute or property
The criteria to determine whether the policy runs.

Operation
An operation for comparing values.

Infor Operating Service Administration Guide | 195


IDM administration

Value
The value to which to compare the document metadata.

Action
How you want the corresponding documents to behave when the policy runs.

3 If you create a policy through the query builder, you can view the XQuery expression if you click
Enter Query Manually.
Note: If you change the query in the manual box, you cannot go back to the query builder. It would
be required to create a new policy to return to the query builder.

Print
Use this page to select and manage a printing service. Currently, only Google Cloud Print is available.

Manage Service
The manage service function has these tabs:
• Manage credentials: Use this tab to upload the .json file that comes when you set up Google
Cloud Print. For details, see the "Google Cloud Print" section of the Infor IDM Output Management
guide.
• Accept printer: Use this tab to accept a printer that is used for Google Cloud Print. Specify the
printer ID and click Accept. For details, see the "Google Cloud Print" section of the Infor IDM Output
Management guide.
• Printers: Use this tab to view the printers that have been accepted in IDM, or search for the printers
by Printer ID, Printer Name, Description, or Date Created.

Email configuration
Administrators can change the template for emails in the Control Center.
1 Navigate to Control Center > Administration > Email Configuration.
2 Specify a display name for the new template.
3 Specify an XQuery, created in IDM search, that corresponds to a template that is stored in IDM.

Tools
The Tools menu contains the Utilities page.

Utilities
The page contains these links:

Infor Operating Service Administration Guide | 196


IDM administration

• Download - Downloads the installation files for the Utilities tool.


• Documentation - Downloads a guide that describes how to install and use the Utilities tool.

Development
The Development menu contains these pages:
• IDM REST API Documentation
• Java API
• .NET API
• Downloads

IDM REST API Documentation


This page shows the basic functions of the IDM client.

Java API
This page shows the JavaDocs for IDM and enables you to download the API.
Click Help to read a help text that describes how to use the page.

.NET API
This page shows the .NET API for IDM and enables you to download the API.
Click Help to read a help text that describes how to use the page.

Downloads
Use this page to download the StreamServe adapter or the Output Management Word Add-in

System Health
The System Health menu contains these pages:
• Health Check
• Self Healing

Infor Operating Service Administration Guide | 197


IDM administration

Health Check
Use this page to perform a health check on the systems that are active in IDM. Select one or all of the
systems and double click. The result is displayed in the Result box.

Self Healing
Use this page to start a self-heal action for the systems. The systems can self-heal by synchronizing
the data model.

User Roles
Due to the sensitive nature of the Control Center, access to it is restricted to the following User Roles:

Role Access
IDM-User Tools - Importer
IDM-AdvancedUser Configuration Exporter / Importer
Synchronize Data Model
Tools - All options (Export, Delete, Import)
IDM-SuperUser None
IDM-Administrator Configuration Exporter / Importer
Synchronize Data Model
Document Types
Value Sets
Configuration

Synchronize Data Model


Infor Document Management clients use caches to increase performance. Located in the Infor Document
Management Server, these caches contain information that can be retrieved fast.
You must refresh the caches whenever you change the setup of Infor Document Management or the
setup of the content repository with an external tool other than the Control Center. For example if you
use a repository specific admin client to add new Document Types or Value Sets then you will need
to synchronize the document management data model cache.
This is achieved by clicking the refresh icon Synchronize Data Model located at the top right corner of
the screen.

Infor Operating Service Administration Guide | 198


IDM administration

Document Output
The Document Output menu contains the Job Management page.

Job Management
Use this page to track when a user has emailed a document, printed a document, or saved the document
to IDM. This information is used for troubleshooting in case a job has not completed.
If a user performs any of the above actions, the job is displayed in the Job Management data table.
Jobs that are successful disappear from the view after they are finished.
This table shows information that is displayed in the data table:

Field Description
ID The job ID as stored in IDM.
Batch ID The batch ID if the job was performed with multi-
ple documents at a time.
Status The current state of the job.
Submitted by The user who submitted the job.
Date The date on which the job was submitted.
Time of submission The time at which the job was submitted.
Time to complete The time it took to submit the job.
Error message The reason the job failed.

You can also search using filters for ID, Batch ID, time ranges, status, and submitting user. To open
the job in IDM, click a link in the data table.

Infor ION and Infor Document Management


Infor Document Management is integrated with the Infor ION platform to trigger ION workflows for
specified documents and user actions in IDM.

ION Configuration
We have supplied a sample workflow to demonstrate a possible "approve" workflow that can be used
with IDM documents. To import and configure this sample workflow for use by IDM, log in to ION Desk
and follow these steps.

Infor Operating Service Administration Guide | 199


IDM administration

Import and Setup


Complete these steps:
1 Set up an application connection point.
• Name: 1
• Logical ID Type: daf
• Documents
• ContentDocument - Process (Receive in Application)
• ContentDocument - Sync (Send from Application)
2 Import Workflows.
• Workflow > Workflows > Import
• IDM_Approve_Workflow.xml
Note: The Approval workflow requires an ACL with name Private to be defined. If it is not, update
the ACL name for approved documents to a suitable value (Workflow > Workflows > IDM_Approve
> Decision table "Update ACL" > value under "Parameters To Be Set" - ACL).
3 Set up distribution lists for workflows.
• Workflows > IDM_Approve workflows
• Ming.le notification entity > Distribution > Add
• Approve entity > Approval Matrix > Add
4 Import activation policies.
• Workflow > Activation Policies > Import
• IDM_Approve_ActivationPolicy.xml
5 Import the Document Flow.
• Connect > Document Flows > Import
• IDM_DocumentFlow.xml
6 Verify that Connection Point is correctly paired with the Document Flow.
• Document Flows > IDM_DocumentFlow > IDM IObox entity (Application column:1)

Start the Workflows


Use this procedure to start the workflow:
1 Activate the workflow. Activate the Activation Policies.
2 Activate IDM_Document Flow.
For further details on how to configure and set up ION workflows, see the ION Process Administration
Guide.

Infor Operating Service Administration Guide | 200


Microsoft SharePoint maintenance for IDM

Appendix A: Microsoft SharePoint maintenance for


IDM

This appendix describes the maintenance of Microsoft SharePoint.

Prerequisites
Before you can start working with Microsoft SharePoint in Infor Document Management, you must have
access to the Microsoft SharePoint Client or SharePoint Designer.
You must also have a valid user name and password to log in to the application with administrative
privileges.
The following instructions explain the required steps for certain common tasks that are useful when
using IDM. These instructions apply to SharePoint 2010, but are similar for SharePoint 2013.
For more information refer to SharePoint documentation.

Document Library
With Microsoft SharePoint, you use Document Libraries for defining a consistent set of information
about the items you want to catalog. Only Document Libraries with at least one user defined column
will be visible in Document Archive.

Importing a document type to SharePoint


Use this procedure to import a document type to SharePoint.
1 Open the SharePoint client.
2 Access Site Actions > Site Settings > Galleries > List Templates.
3 In the Documents tab, click Upload Document.

Infor Operating Service Administration Guide | 201


Microsoft SharePoint maintenance for IDM

4 Select the document type to upload. For example, M3_SupplierInvoice.stp


5 Click Save.
6 Click Libraries, the click Create.
7 Select Library as the Filter Type.
8 Enter a name for the library.
9 Click Create.
10 Click Done.
Note: Document model files are included in the Infor Document Management installation package
named M3_SupplierInvoice.

Adding a document type to SharePoint


To add a document type in SharePoint:
1 Open the SharePoint client.
2 Open the Libraries page.
3 Click Create.
4 From the Installed Items list, select Document Library.
5 Specify a name for the library.
6 Click Create.
7 Click Done.

Adding an attribute to a document type in SharePoint


To add an attribute to a document type in SharePoint:
1 Open the SharePoint client.
2 Open the document library (document type) to which to add the attribute.
3 Select Library Settings.
4 Click Create column.
5 Give the column a name.
6 Select the type.
7 Depending of the selected type, set the constraints.
8 Click OK.

Infor Operating Service Administration Guide | 202


Microsoft SharePoint maintenance for IDM

Deleting an attribute from a document type in


SharePoint
To delete an attribute from a document type in SharePoint:
1 Open the SharePoint client.
2 Open the document library (document type) from which to delete the attribute.
3 Select Library > Library Settings.
4 Click the column to delete.
5 Click Delete.
6 Click OK.

Deleting a document type in SharePoint


Use this procedure to delete a document type in SharePoint.
1 Open the SharePoint client.
2 Open the document library (document type).
3 Select all documents.
4 Click Delete Document.
5 Click Library > Library Settings.
6 Click Delete this Document Library under Permissions and Management.
7 Click Site Actions > Site Settings.
8 Click List Templates in the Galleries column.
9 Select the document library template (document type).
10 Click Delete Document.

Exporting a document type in SharePoint


Use this procedure to export the definition of a Document Library as an STP file.
1 Open the SharePoint client.
2 Open the Document Library (document type).
3 Click the Library > Library Settings.
4 Click Save Document Library as Template under Permissions and Management.
5 Fill out the details and click Save.
6 Click Site Actions > Site Settings.
7 Click List Templates in the Galleries column.

Infor Operating Service Administration Guide | 203


Microsoft SharePoint maintenance for IDM

8 Select the item you want to save as an STP file.

Enabling templates
Complete this task to enable the functionality to create documents of a specified document type from
templates.
Templates are documents that are pre-populated with attribute values and a file. The template
functionality in IDM is based on these attributes:
• MDS_TemplateName
• MDS_TemplateDetails
To enable the template functionality:
1 Add the MDS_TemplateName and MDS_TemplateDetails attributes as described in Adding an
attribute to a document type in SharePoint on page 202.
2 Set the Attribute Type of each attribute to string.
3 Set the maximum length of MDS_TemplateName to 128 characters and the maximum length of
MDS_TemplateDetails to 512 characters.

Translating the columns of a document type in


SharePoint
Use this procedure to translate the columns of a document type in SharePoint.
1 Open the SharePoint client.
2 Open the Document Library (document type).
3 Click LIbrary > Library Settings.
4 In the Columns section, make the necessary changes or translations.
Note: The original / internal name of the column will not change, so for instance, XQueries will still
work the same.

Creating Access Control Lists in SharePoint


Access Control Lists (ACL) work by moving documents from a folder in a document library with specific
access rights to another folder in same document library with possibly different access rights. In this
way, it is possible to change a documents' access restrictions.

Infor Operating Service Administration Guide | 204


Microsoft SharePoint maintenance for IDM

Every folder in a document library is displayed as an ACL within IDM. Setting a special ACL on a
document in IDM moves the document in SharePoint to the corresponding folder.

For SharePoint 2010


1 Open the SharePoint client.
2 Click the document type under Libraries.
3 Click the Documents tab.
4 Click New Folder.
5 Give the folder the name of the access control list and click Save.
6 Add the appropriate permissions to the folder.

For SharePoint 2013


1 Open the SharePoint client.
2 Click on site Contents.
3 Click on the Document type.
4 Click Files tab.
5 Click New Folder.
6 Give the folder the name of the Access control list and click Save.
7 Add the appropriate permissions to the folder.

Infor Operating Service Administration Guide | 205


IBM DB2 Content Manager maintenance for IDM

Appendix B: IBM DB2 Content Manager maintenance


for IDM

This appendix describes maintenance of the Content Manager, specific to IBM DB2.

Prerequisites
Before you can start working with IBM DB2 Content Manager for Infor Document Management, you
must have access to IBM DB2 Content Manager (CM) Administration Client and DB2 Database and
WebSphere Application Server.
To be able to log in to IBM DB2 Content Manager (CM) Administration Client, you must have a valid
user name and password with administrative privileges.

Starting the application


Use this procedure to start the application.
1 Access the application by clicking Start > All Programs > IBM DB2 Content Manager Enterprise
Edition > System Administration Client. Make sure that the Server Type and Server Are Correct.
2 Enter User ID.
3 Enter Password.
4 Click OK. The System Administration Client page is displayed.

Creating an attribute
Use this procedure to create an attribute.
1 Expand Data Modeling in the navigation pane. Right click Attributes and select New to open the
New Attribute page.

Infor Operating Service Administration Guide | 206


IBM DB2 Content Manager maintenance for IDM

2 Enter the Name and Display Name. The Name that you entered is an internal name that uniquely
identifies an element in the library server and does not display in the client applications. The Display
name field allows for longer values, spaces, and other characters. This name is displayed in the
client applications.
3 Click the Translate button to translate the Display name to a preferred language.
4 Select the Attribute Type. The Attribute Type may be a character, variable, string etc. For more
information on specifying the Attribute Type refer IBM DB2 Content Manager Help provided in the
application itself.
5 Select the additional restrictions depending on the chosen Attribute Type. Click OK.
6 Click the Apply to save the information without closing the page/window.

Deleting an attribute
You cannot delete an attribute if it is part of an attribute group or used in an item type. To remove an
attribute from an item type, you must first delete the entire item type.
1 Expand Data Modeling in the navigation pane.
2 Click Attributes to display all of the attributes in the right pane.
3 Right click the attribute that you want to delete and click Delete.
4 Click OK.

Creating an item type


An item type is a template that consists of a root component, zero or more child components, and a
classification. Using DB2 Content Manager, you build item types for recording a consistent set of
information about the related items that you want to catalog.
Create item types to define and locate similar items later. You need to access all the tabs and enter
the details to complete the new item type creation.
1 Expand Data Modeling in the navigation pane. Right click Item Types and select New to open the
New Item Type Definition page.
2 Enter the Name and Display name. The Name that you entered is an internal name that uniquely
identifies an element in the library server and does not display in client applications. The Display
name field allows for longer values, spaces and other characters. This name is displayed in the
client applications.
3 Click the Translate button to translate the Display name to a preferred language.
4 Select the appropriate radio button for the New Version Policy for attributes field. This is to specify,
when the system creates new versions. Use only Never create or Always create. The Infor Document
Management system will not prompt users for new versions.

Infor Operating Service Administration Guide | 207


IBM DB2 Content Manager maintenance for IDM

5 Specify the maximum total versions by selecting the appropriate Maximum Total Versions radio
button. Specify the number of versions for the item.
6 Select the Item Type Classification from the drop down list box. The Item Type Classification may
be an item, resource item, document or document part. By default you should choose Document
for normal items and Item for value sets. For more information on the Item Type Classification, refer
IBM DB2 Content Manager Help provided in the application itself.
7 Select the Text Search to make the Resource item or Document as Text searchable.
8 Specify the Item retention period to know how long the library server should keep the item. This is
normally used only when complementing the IBM DB2 Content Manager with a Tivoli backend
system.
9 Select a document routing process from the Start item on process field drop down list box to
automatically start an item that is created in this item type on a previously defined document routing
process. IBM DB2 CM document routing processes are not supported by the Infor Document
Management system.
10 Enter the Priority.

Configuring an item type for free text search


Before you can configure Free Text Search, you must have installed IBM DB2 Net Search Extender,
which is part of IBM DB2 Content Manager.
The Net Search Extender is an add-on product for the DB2 database that is responsible for the free
text search and maintenance of the required text indexes. Net Search Extender should be installed
with every Infor Document Management installation.
The procedure configures PDF files for searching.
1 Create two new directories on your server hard-drive that will be used by the new text indexes.
These new directories should be created on the 'Library Server', which contains the IBM DB2
Database.
These new directories can be different based on the different item type used, or they can be shared
between item types.
For example: "D:\indexing\index" and "D:\indexing\tempfiles".
2 Verify that Text Search is enabled in your IBM DB2 Content Manager installation. You can use the
IBM DB2 Content Manager Administration Client to check this. The option Text Search option is
located in the Feature tab of the Library Server Configuration Properties.
3 In the Administration Client, open Properties for the item type you wish to configure for free text
search.
4 Select the Definition tab and check the Text Search box and click the Options button.
5 Select the format you want to search in the Format drop down menu.
For example, you would select TEXT if you wanted to search PDF documents as they contain pure
text.
6 Select '850' in the CCSID drop down menu, which corresponds to 'Latin-1'.

Infor Operating Service Administration Guide | 208


IBM DB2 Content Manager maintenance for IDM

A complete list can be found at the following link:


http://www-01.ibm.com/software/globalization/ccsid/ccsid_registered.jsp
7 Choose EN_US in the Language Code drop down menu, which corresponds to US English I.
8 Choose the two directories you created in Step 1 for your Index directory and Working directory.
For example, you would input "D:\indexing\index" for the Index directory, and "D:\indexing\tempfiles"
for the Working directory.
9 Select the User-Defined Function Name menu and choose either a pre-created plugin or your own
custom created plugin.
ICMfetchcontent is for basic text formats, while ICMfetchfilter is for rich text formats like PDFs and
MS Word Documents.
10 Enter how often you would like to update the index in the Index Update Settings box.
For example, to keep the indexes relatively updated, you would enter 1 for Changes before update,
and Update every 10 Minutes.
Consider how much you add/edit content, as well as how much content is in your installation as this
will affect overall performance. More frequent updates with less changes will have a negative impact
on system performance.
11 Apply all changes by clicking Apply > OK in the Text Search Options window, then Apply > OK in
the Library Server Configuration window.

New Item Type Definition


After you define the Item type, complete its creation by completing the tasks, available from different
tabs of the New Item Type Definition page/window. The information on how to perform this is provided
later in this topic.
The various tabs that are located on the New Item Type Definition window are:
• Access Control Tab
• Attributes Tab
• Auto Linking Tab
• Foreign Keys Tab
• Logging Tab
• Document Management Tab
• User Exit Tab

Infor Operating Service Administration Guide | 209


IBM DB2 Content Manager maintenance for IDM

Using the Access Control Tab


Use this procedure to associate ACLs with an item type.
1 Click the Access Control tab from the New Item Type Definition page/window.
2 Select Item Type Access Control List (ACL) from the drop down list box that you want to associate
with this item type.
3 Click the Create Access Control List button to create a new ACL. This step is optional.
4 Indicate if the Check ACL at field applied to the Item type level or Item level. If you specify Item type
level, the access control list applies exactly the same for all items of this type. This is a quick way
to check authorization but limits you to have the same authorization for all items of this type. If you
specify Item level, the authorization check is done based on each and every individual item.
5 In the For item level ACL checking, assign ACL field, specify how the access control list is applied
to new items when they are created and no specific ACL is set by the creating user. If you select
Item type ACL, the access control list that is defined above is used. If you select User’s default ACL,
the access control list that is defined as default ACL for the creating user is used. See User Properties
for more information.

Using the Attributes Tab


Use this procedure to specify attributes for an item type.
1 Select the Attributes tab.
2 Select the attributes or attribute groups that you want to add into the item type from the Available
attributes or groups list. Click Add > to add them to the Selected attributes and components list.
3 Specify whether the attribute is Required or Unique and represents the item in client applications if
you add a regular attribute. You can also enter the default value for the attribute. If it is an integer
type, you can modify the minimum and maximum values.
4 Specify a Delete rule if you add a reference attribute. You can use a reference attribute to point to
specific information contained in another item.
a If you specify Cascade, the source component is deleted when the target component is deleted.
b If you specify Restrict, you cannot delete the target because it is referenced by the source.
c If you specify Set null or No action, when the target is deleted, the source is set to null or no
action is taken.
If you had specified Always create or Prompt to create in the New Version Policy field on the
Definition page/window, then only the No action and Restrict delete rules for reference attributes
are enabled.

5 Enable Text searchable field by selecting the Text searchable check box and click the Options
button to open the Text Search Options window, when you add regular attributes into the item type.
6 Click Add/New Child> to add a child component. A child component is an optional second or lower
level of an item type. Each child component is directly associated with the level above it. Child
components are usually language managed attributes or tables in the Infor Document Management
system.

Infor Operating Service Administration Guide | 210


IBM DB2 Content Manager maintenance for IDM

a Enter the Child component name. This must be unique throughout the Library Server.
b Enter the Display Name, the name to display to end users in client application.
c Click Translate to open the Translate Display Name window. All of the available languages
defined in the system are listed. In the Translated Name column, type the translated display
name for the other languages. Click the OK button to save the information.
d Specify the Delete rule. Choose Restrict to indicate the root component cannot be deleted if it
contains a child component. Choose Cascade to indicate that when a root component is deleted,
the child component is also deleted.
7 Enter the Minimum cardinality and Maximum cardinality values for each item.

Using the Auto-Linking Tab


Auto-Linking is typically not used in Infor Document Management systems.
1 Select the Auto-linking tab to enable auto-linking.
2 Select Only show available matching attributes and groups check box to ensure that only attributes
and attributes groups at the same level are displayed. This step is optional.
3 Select the item type from the Item type to be linked to drop down list box. A list of attributes and
attribute groups for that item type is displayed.
4 Select attributes or attribute groups from the Current item type list and Item type to be linked to list.
You cannot link date, timestamp, or time attributes but can link only required attributes. You can
create links between root and child components of different item types. If you have a link from root
to root and child to root, the minimum cardinality must be greater than 0.
5 Select a Link type from the drop down list box to associate the attributes or attributes groups. All
links between the item types must be the same type.
6 Click Add to create a link set and add the attributes to the Associated attributes and groups list.
From the Item type linked to list under Associated attributes for link, select an item type. All attributes
from this item type that are linked to the current item type are displayed in the Associated attributes
and groups list.
7 Select the linked attribute in the lower table and click the Remove button to delete a link or change
the link type. You can then recreate the link as needed. This step is optional.
8 Use the Move up and Move down buttons to group the links together if you have a long list of linked
attributes. This step is optional.
After item types are linked based on the auto-link definitions, the link remains even if you change
the definition.

Using the Foreign Keys Tab


When you define a foreign key, you limit values that the users can enter for an attribute. Foreign keys
are used to connect values to value sets in a Infor Document Management system.

Infor Operating Service Administration Guide | 211


IBM DB2 Content Manager maintenance for IDM

1 Select the Foreign Keys tab.


2 Click Add to open the Define Foreign Key page/window.
3 Enter the Constraint name for the tie between the attributes.
4 Select Restrict as the Update rule so that the target cannot be updated. If you select No Action, the
target can be updated.
5 Select any of the following, Restrict, Cascade, No action, or Set null as the Delete rule.
a If you select Restrict, you cannot delete the target because it is referenced by the source.
b If you select Cascade, the source will be deleted when the target is deleted.
c If you select No action, deleting the target has no affect on the source.
d If you select Set null, deleting the target sets the source to null.
6 Select the source item type or child component from the Select Source Component list.
7 Select the Target item type or table. If you select an external table, enter the schema and name of
the target table. For a DB2 Content Manager item type target, the source and target attributes appear
in the Source attributes and Target attributes lists. Ensure that target attributes must be Require
and Unique.
8 Select attributes and click the Add button to pair the source and target attributes. For an external
table target, the source attributes appear in the Source attributes list. Select an attribute and type
a column name in the Target column field and click the Add button to pair the source attribute and
target column.
9 Select the Show target data as drop down in client box to have the target information displayed in
the eClient. This can be ignored for the Infor Document Management system. Value sets are always
displayed as drop down menus.
10 Click OK.

Using the Logging Tab


Logging is important and is used for debugging and troubleshooting purposes. Logs are used to track
records needed for audit and security reasons.
1 Select the Logging tab.
2 Select one or more check boxes to specify whether the library server logs an event when an item
is created, read, updated, or deleted.

Using the Document Management Tab


You can associate document parts (file types) with a document (item). The most common ones that
are ICMBase (for binary files) and ICMBASETEXT (for known text index-able files).
1 Select the Document Management tab.
2 Click Add to open the Define Document Management Relations page/window.

Infor Operating Service Administration Guide | 212


IBM DB2 Content Manager maintenance for IDM

3 Select a Part Type to associate with the document item type from the drop down list box.
4 Select an Access Control List to associate with the part type from the drop down list box.
5 Select the Resource Manager on which the part type is stored from the drop down list box.
6 Select the Collection on which the part is stored. There are two predefined collections that you can
choose or you can create your own collections. The predefined collections are TABLE.CLLCT001
and CBR.CLLCT001. TABLE.CLLCT001 is a BLOB (binary large object) collection. CBR.CLLCT001
is a file system collection. It is recommended to always use a file system collection.
7 Indicate the New Version Policy for the part type. If you click Prompt to create, the DB2 Content
Manager Client for Windows will prompt a user to create another version of an item or update the
current version of an item when making changes. You can prompt the user when an item's notelog
has been updated or when an annotation has been added, deleted, or changed. Select
ICMANNOTATION as the part type for annotations and ICMNOTELOG as the part type for notelogs.
Infor Document Management Clients do not support prompting for new versions.
8 Specify the Maximum total versions for the parts. When you reach the maximum versions specified,
DB2 Content Manager removes the oldest version and stores the latest versions.
9 Click OK.

Using the User Exits Tab


User exit routines are standard sets of code defined by any external application. You can see exit
routines as user defined plug-ins and this tab lets you specify which plug-ins to use. This is not normally
used in an Infor Document Management System.
1 Select the User Exits tab.
2 Enter the Function and the Dynamic link library (DLL) name, which contains those functions to
determine the processing that the client application performs when users Save, Search, and sort
items of this item type. You can also specify the processing that occurs when users store objects
on the Resource Manager.

Saving or Cancelling an Item Type


Save the new item type by clicking the OK or Apply button. Click the Cancel button to cancel the details.

Deleting an Item Type


You cannot delete an item type if there are any items of that type and contains data. If it does not
contain the data use the following steps to delete it.

Infor Operating Service Administration Guide | 213


IBM DB2 Content Manager maintenance for IDM

1 Expand Data Modeling in the navigation pane.


2 Click Item Types to display all of the item types in the right pane.
3 Right-click the item type that you want to delete and click Delete. The item type can only be deleted
if there are no items of this type in the database.

Enabling templates
Complete this task to enable the functionality to create documents of a specified document type from
templates.
Templates are documents that are pre-populated with attribute values and a file. The template
functionality in IDM is based on these attributes:
• MDS_TemplateName
• MDS_TemplateDetails
To enable the template functionality:
1 Add the MDS_TemplateName and MDS_TemplateDetails attributes as described in Creating an
attribute on page 206.
2 Set the Attribute Type of each attribute to string.
3 Set the maximum length of MDS_TemplateName to 128 characters and the maximum length of
MDS_TemplateDetails to 512 characters.

MIME Types
A MIME (Multipurpose Internet Mail Extension) type is an Internet standard for identifying the type of
object that is being transferred across the Internet. MIME types include many variants of text, audio,
image, and video data.
In DB2 Content Manager, when you create an object, you specify its MIME type. When an object of
that type is retrieved from the resource manager, your application reads the MIME type and determines
how to handle the object. For example, if the MIME type for an object is GIF, your application might
launch a Web browser to view the object.
Many MIME types comes with IBM DB2 Content Manager and a few more comes with Infor Document
Management but if you still need to add new ones this guide is to help you with that. Every MIME type
for all documents you store in the archive should be defined this way for the best system operation.

Infor Operating Service Administration Guide | 214


IBM DB2 Content Manager maintenance for IDM

Defining a MIME Type


Define the MIME type to tell your application how to handle an object retrieved from the resource
manager.
1 Expand Data Modeling in the navigation pane.
2 Right click MIME Types and select New to open the New MIME Type page.
3 Enter the Name and Display name. The Name that you entered is an internal name that uniquely
identifies an element in the library server and does not display in client applications. The Display
name field allows for longer values, spaces and other characters. This name is displayed in the
client applications.
4 Click Translate to translate the Display name to a preferred language.
5 Enter the MIME type. For example, image/jpeg. Refer http://www.iana.org/assignments/media-types/
for more information about MIME types.
6 Enter the Suffixes for the MIME type. A suffix is a file extension for example jpeg and is used in the
client application when downloading or exporting the files from the IBM DB2 Content Manager.
7 Specify the function for the Valid function field that might be performed on the MIME type. For
example, you might enable a .doc MIME type to be text searchable.
8 Enter an alternate application and path or relative path in the Application name field that a client
might use to view a particular MIME type. Click the Browse button to select an application name
from the file system.
9 Define options for running the application in the Application flags field. Click OK.

Deleting a MIME Type


Use this procedure to delete a MIME type.
1 Expand Data Modeling in the navigation pane.
2 Click MIME Types to display all of the MIME types in the right pane.
3 Right-click the MIME type that you want to delete and click Delete. A MIME type cannot be deleted
if it is used by any item in the database.

Languages
You need to define the languages in the library server if you have to set up your system for users who
speak different languages and also provide translated display names.
You must specify a language code if you plan to translate text from one language to another. A language
code is a three-character code that can be used to display attributes or item types in multiple national
languages. When you specify a language code, you also need to enter the equivalent word in that
language.

Infor Operating Service Administration Guide | 215


IBM DB2 Content Manager maintenance for IDM

Several pages/windows in the IBM DB2 CM System Administration Client have Display Name fields
that have a Translate button next to them mainly to translate the languages in the required languages.
All languages must be registered in IBM DB2 CM.
Some languages are supplied with IBM DB2 Content Manager and most M3 languages are supplied
with IDM, if you are still missing your language(s) you need to add them.

Creating the Language and Language Code


You can define the language and language code using Language Definition.
1 Expand Library Server Parameters in the navigation pane.
2 Right-click Language Definitions and select New to open the New Language Definition page.
3 Enter the Language in the Language field.
4 Select the Language Code from the Language Code drop-down list.
5 Click OK to save the language definition. Click the Apply button to save the language definition and
keep the page/window open to create another language definition.
6 The new language must also be added to the languages.xml configuration file in the Infor Document
Management Server application.
The created language definition is available in the administration client next time when the cache
is reloaded.

Translating Data Models


There are a few entities that need to be translated in order to introduce a new language in the data
models and are explained in this topic. The translation of your data models will enable your date model
parts (attributes etc) for other languages; it will not translate the actual data (attribute values).

Translating Item Type


You need to translate the name of the item type that already exists and few other entities that need to
be translated for the entire item type to be completely translated. For example, the child components,
language managed attributes, normal attributes, and attributes group. There are also certain other
aspects that need to be translated for the entire data model which are Link Types and MIME Types.
1 Expand Data Modeling in the navigation pane.
2 Select the Item Type and right-click on it to open the Properties in the Item Type Properties
page/window. The existing details are displayed.
3 Click Translate to translate the Name of the item type. Similarly you can translate all other item
types. Click OK.

Infor Operating Service Administration Guide | 216


IBM DB2 Content Manager maintenance for IDM

4 Click the Apply button to save the current details and keep the page/window open to translate
another detail.

Translating Child Components


Child components can be interpreted as "table attributes". These are attributes that can hold many
columns and rows of values. Child components may be table attributes and language managed attributes.
Only the "PCM_IMG_Name" is a "child component". PCM_ID and PCM_Status are attributes. ICP_Lang
is an attribute in the Child Component PCM_Img_Name.
You must translate all child components in the item type.
1 Translate the display name of the child components by clicking Translate on the Attributes tab. This
should be done for all the child components.
2 Click OK.

Translating Regular Attributes


You need to translate all the normal attributes. Since these are not maintained inside the item type,
they are not translated in the item type.
1 Select the Attributes from Data Modeling on the System Administration Client.
2 List the attributes by clicking Attributes. The attributes are displayed on the right pane.
3 Right-click and view the Properties of each attribute.
4 Translate each attribute using the Translate button from the Attribute Properties page/window. You
need to translate all the attributes. Click OK.

Translating Attribute Groups


Use this procedure to translate attribute groups
1 Select the Attribute Groups from Data Modeling on the System Administration Client.
2 List the attributes group by clicking the Attributes Group. The attributes are displayed on the right
pane.
3 Right-click and view the properties of each attribute group.
4 Translate each attribute group using the Translate button from the Attribute Group Properties
page/window. You need to translate all the attributes inside the attribute group. Click OK.

Infor Operating Service Administration Guide | 217


IBM DB2 Content Manager maintenance for IDM

Translating Link Types


Use this procedure to translate link types.
1 Select Data Modeling from System Administration Client.
2 Select Link Types from Item Types.
3 List the link types by clicking the Link Types. The link types are displayed on the right pane.
4 Right-click and view the properties of each link type.
5 Translate each link type using the Translate button from the Link Type Properties page/window.
Click OK.

Translating MIME Types


Use this procedure to translate MIME types
1 Select Data Modeling from System Administration Client.
2 Select the MIME Types from Item Types.
3 List the MIME types by clicking the MIME Types. The MIME types are displayed on the right pane.
4 Right-click and view the properties of each MIME type.
5 Translate each MIME type using the Translate button from the MIME Type Properties page/window.
Click OK.

Backing up Files in IBM DB2 Content Manager


Content Manager consists of many different parts. There are at least one Library Server and one
Resource Manager Database. You will also find related data, such as the access modules for the
Library Server, full text indexes, or the storage areas on the Resource Manager. These files are required
for the operation of Content Manager and needs to be backed up.
The main parts to back up:
• Library server database (including indexes and transaction files)
• Resource Manager database
• Resource Manager file area (this is normally a directory but can be blobs in a database depending
on how you installed IBM DB2 CM)
• Configuration files for IDM

Additional files that could also be backed up are:


• Initialization parameter files
• Password file
• Files that define the environment

Infor Operating Service Administration Guide | 218


IBM DB2 Content Manager maintenance for IDM

• Network configuration files

They are external files and are not part of the database, because they must be accessible for reading,
or even editing, when the database is down. The backup strategy must ensure that these files are also
backed up using the operating system.
For more information about backing up files, refer to the IBM DB2 CM Help.

Performance
A Content Manager system must run efficiently and effectively, and it must be able to perform the
expected workload within a business-required time frame. Designing, configuring, and tuning a Content
Manager system to achieve the desired results is essential for your business to succeed.
We can help you size the system for you specific needs.
For more information about Performance, see IBM Red Book (http://www.redbooks.ibm.com/) and IBM
DB2 CM Help.

Authentication
Authenticating users includes managing, creating, and importing user IDs and passwords.
A user ID must be created on each library server. Each library server has a set of users who can access
objects through it. You can limit a user's access to objects by assigning a privilege set when you create
that user. If a user must access more than one library server within the DB2® Content Manager system,
you must create a user ID on each library server that the user must access. The user ID can be the
same on every server, but each user ID must be unique within one library server.
Infor Document Management users are normally synchronized with the same LDAP as M3 Business
Engine to ensure minimal additional administration.
For more information about Authentication see IBM DB2 CM Help.

Authorization
User authorization is the method of controlling which users can log on, create other users, have a
particular type of access to specific items, and so on. The system administration client provides several
authorization objects to accomplish this including privileges, privilege groups, privilege sets, and access
control lists.

Infor Operating Service Administration Guide | 219


IBM DB2 Content Manager maintenance for IDM

An access control list consists of users, user groups and privileges associated with each. When you
associate an access control list with an item type, only the users on that list can access objects created
in the system under this item type. The actions that users can perform on these objects depend on the
privileges associated with them in the access control list.
User groups and roles can be synchronized with a LDAP server but specific authority configurations
for the archive must be managed in Infor Document Management – get the users/groups/roles from
LDAP but you need to setup which group/role can do what with a particular document.
For more information about Authorization see IBM DB2 CM Help.

Creating an Access Control List


Use this procedure to create an Access Control List
1 Expand Authorization in the navigation pane. Right click Access Control List and select New to open
the New Access Control List Definition page.
2 Enter the Name and Definition (optional).
3 Click Apply to save the information without closing the popup window, or click OK to save and close
the popup window.

Importing a document type to IBM DB2 Content


Manager
Use the Import XML feature in the Content Manager Administration Client to import document type
definitions in DB2 Content Manager.

Infor Operating Service Administration Guide | 220


Document Links

Appendix C: Document Links

You use document links to navigate from an M3 transactional object to any kind of document in Infor
Document Management. This is one of the most important features of IDM. It helps you find important
documents like a particular customer invoice, an item image, or a product document.
You can create dynamic links from M3 objects to information in the archive. Since these links are
dynamic, they change when the M3 objects change. It is the "current" match of attributes/meta data
that makes up the link.
All invoices in M3 use the same dynamic link to find the invoice PDF in Infor Document Management.
Since the invoice number (or any other key or multiple keys) is used, each M3 invoice number will refer
to a different invoice PDF in IDM.

Creating Document Links


You can define Document Links in Smart Office, or in M3 H5 Client.
You can use the new links after the program(s) are restarted in Smart Office.
Other users who want to use the new links you created in Smart Office must restart Smart Office (links
are loaded upon start of Smart Office).
For more information about defining document link types, see Infor Smart Office Administration Guide.
For more information on how to create document links in M3 H5 Client, see Link Manager in Infor M3
M3H5 Client User Guide.

Infor Operating Service Administration Guide | 221


Archiving M3 BE Output

Appendix D: Archiving M3 BE Output

This appendix describes how you can integrate M3 Output Management and StreamServe with
Document Archive to archive your M3 BE output.
First, you must enable the integration with some new and changed scripts to your global project, and
then you must make changes in the scripts for each layout that you want to enable for archiving with
Document Archive.
After the initial steps are completed, you can use archiving by selecting the Archive field in MNS205
for selected layouts.
These restrictions apply:
• This instruction is based on the standard layout package for StreamServe version 5.4. The process
can also be applied to StreamServe v4.x.
• The archiving can be done only on *FILE media in MNS204/MNS205 since there must be a physical
file created to be able to insert it into the document archive.
• The StreamServe Control Center must run in synchronous mode.

Knowledge prerequisites
Knowledge about the following is required:
• OpenText StreamServe and experience using it in an M3 BE context
• M3 BE programs and OpenText StreamServe layouts, prints, and messages
• Infor Document Management document types
• Access to the OpenText StreamServe server
• Access to Infor Document Management document types

System requirements
These system requirements must be met before you set up the archiving:
• OpenText StreamServe 5.6 environment must be installed and available
• Layouts for OpenText StreamServe must be installed

Infor Operating Service Administration Guide | 222


Archiving M3 BE Output

• Infor Document Management StreamServe Adapter must be installed on the OpenText StreamServe
server
Complete the instructions in this appendix to integrate Infor Document Management.

Process overview
1 Verify that the system requirements are met. See System requirements on page 222
2 Install the new files. See Downloading files on page 223
3 Configure your Global Project. See Configuring your global project on page 223
4 Configuring your layouts for archiving. See Configuring your layouts for archiving on page 224. You
must repeat this task for all of your layouts.
5 Activate output to IDM. See Activating output to IDM on page 227. You must repeat this task for all
of your layouts.

Downloading files
To install the new files:
1 Download this component from the extracted Infor OS Installer: Archive M3 BE Output
(ArchiveM3Output_<version>.zip)
2 Uunzip the files to a temporary location on your OpenText StreamServe server.

Configuring your global project


These tasks guide you in preparing the M3 Business Engine, Infor Document Management, and
StreamServe for archiving. You perform these tasks only once for each installation.

Importing new files


1 On your StreamServe server, go to the directory where your layouts are installed.
2 Open your global project (Global.dcproject). The global project is opened in the StreamServe Design
Center.
3 Double-click Global_resourceset.
4 Right-click the resource set and select Import from the menu.

Infor Operating Service Administration Guide | 223


Archiving M3 BE Output

5 Browse to the temporary location where you saved your downloaded installation files. Select the
files one by one and click Open.
6 Set the Resource Type to the following:
• For DAFSettings.tbl, the resource type is: Table
• For DAFKeys.tbl, the resource type is: Table
• For DAF.fcn, the resource type is: Function
7 Save all the files.

Configuring DAFSettings.tbl
1 Locate the DAFSettings.tbl in your Global_resourceset.
2 Change the ArchivePath to the location where your Document Archive StreamServe Adapter reads
new files, for example, D:\InforDocumentArchiveStreamServeAdapter\files\new
Note: If the Document Archive StreamServe adapter is not located on the StreamServe server,
map the network drive. It must be mapped so that the Windows Service running as Local System
has access to it.

Setting the Synchronous mode in OpenText StreamServe


Persuasion
If you run OpenText StreamServe Persuasion, you must add the -sync flag "-sync" to your file start.arg.
This ensures that the physical file has been created before an attempt to insert it into IDM is done.

Configuring your layouts for archiving


You must set up your layouts properly for IDM archiving.
Repeat this procedure for each layout that you want to archive.

Adding function calls


1 Open your layout project, for example, ARS121PF.dcproject.
2 Double-click the first message (all of them need to be changed) in the layout. As an example, see
ARS1210H.
3 Right-click the corresponding Event and select Script.

Infor Operating Service Administration Guide | 224


Archiving M3 BE Output

4 Uncomment Retrieved();.
Select the Always check syntax when leaving editor check box to minimize the risk for errors.
5 Click OK.
6 Right-click the corresponding Message (connected to the previously selected Event), and select
Script.
7 Uncomment BeforeMsg();.
8 Click Check Syntax to verify your code.
9 In the Editor, select Trigger After.
10 Uncomment AfterMsg();
11 Compile and ensure that no errors are shown.

Editing processes
There are usually two processes, one for format A4 and one for format Letter. This part must be repeated
for all processes in use.
1 Right-click the first process and select Script.
2 Make sure that there is a function call to BeforeProcess() inside the "if" clause. For example:

if (...) {
BeforeProcess();
}
3 Click Check Syntax to verify your code.
4 Copy the entire script content (Ctrl-A and Ctrl-C) to your clipboard.
5 In the Editor, select Trigger After.
6 Remove all the content in this view (Ctrl-A and Del) and replace with the copied script (Ctrl-V).
7 Replace the BeforeProcess() function call with AfterProcess().
8 Compile and ensure that no errors are shown.

Changing the runtime


1 In your Project window, navigate to your Runtime folder and double-click your runtime.
2 Right-click the Layout Runtime (in the middle) and select Script.
3 Add a function call to JobBefore();.
4 Click Check Syntax to compile the message.
5 In the Editor, select Trigger After.
6 Add a function call to JobAfter();.
7 Click Check Syntax to verify your code.
8 Save your project.

Infor Operating Service Administration Guide | 225


Archiving M3 BE Output

9 Select the Create start.arg check box and export your project.
10 Close the project.
11 Create a backup copy of the start.arg file for the OpenText StreamServe application where your
project will be deployed.
12 Stop the OpenText StreamServe application and deploy your project.
13 In a text editor, view your new start.arg file and verify that the new DAF.fcn is listed.
14 From your backup copy of the start.arg file, copy the list of .dux files and paste them into the new
start.arg.
15 Start the OpenText StreamServe application.

Editing DAF.fcn
Stream file values must be stored in StreamServe variables to be archived. In DAF.fcn, you must add
code to save these values. The $mvx_NAME variable contains the printer file name and an "if" clause
is needed for your layout.
1 Open your global project (Global.dcproject). The global project is opened in the StreamServe Design
Center.
2 In the Global_resourceset, double-click DAF.fcn.
3 In the pop-up screen, select the DAFSetArchiveIndex function and click Edit.
4 Add a new "if" clause:

if($mvx_NAME = "<your print file>")


5 Save stream file values to local script variables. See the example in the "if" clause for QUS606PF.
6 Click Check Syntax and click OK.
7 Save your project.

Configuring DAFKeys.tbl
The DAFKeys.tbl maps which StreamServe script variables should be sent to Document Archive
together with the document.
1 Open your global project (Global.dcproject). The global project is opened in StreamServe Design
Center.
2 In the Global_resourceset, double-click DAFKeys.tbl.
3 Add a new section for your printer file. As an example, see the existing section for QUS606PF.
4 Add rows for the mapping. Each row consists of three values:
• The first column contains the StreamServe printer file name followed by _ and a sequence
number, up to the maximum number of 40.
• The second column contains the variable used in DAF.fcn.
• The third column contains the Document Archive attribute name.

Infor Operating Service Administration Guide | 226


Archiving M3 BE Output

Note: Double check that all strings match.


5 Save and close the DAFKeys.tbl.
6 Export your project by using the StreamServe Design Center and deploy it by using the StreamServe
Control Center.

Activating output to IDM


Turn archiving on by editing a field in M3 Output Media Selection.Open, MNS205.
Repeat this procedure for each layout that you want to archive.

Activating archiving
1 In Infor Smart Office of Infor M3 H5, open M3 Output Media Selection.Open, MNS205.
2 Edit or add appropriate *FILE records. If you leave Prnt file, User, and Location blank, this is the
default setting unless there is a specific setting for certain combinations of the three.
3 Set the Path to a folder on the OpenText StreamServe server, for example, C:\MVXOUT_ PDF\.
4 Set the Destination file to a file name, for example, Archive to be used for the intermediate storage
of the file.
5 Verify that the generated name method is set to 0-Entered name.
6 Select the Archive check box.
Your archiving is now ready for use.

Infor Operating Service Administration Guide | 227


Restoring Redis functionality

Appendix E: Restoring Redis functionality

If there is a node failure in a multi-node installation that only contains two nodes, Redis will only work
with a single node from the Redis master node. The Redis master node is located on the primary Infor
OS node. If this node goes down, the Infor.Redis tool must be run. This tool is used to move the Redis
master node to the secondary node that is still running. This tool is needed only in environments that
only have two nodes. This tool does not have to be used in environments that have three or more
nodes.
To use the Infor.Redis tool:
1 Run the tool on the still functioning node.
2 Specify the Farm Database Host.
3 Specify the port number that the database uses.
4 Specify the Farm Database instance. If the default instance is used, no value is needed.
5 Specify the Farm Database name.
6 Specify the Farm Database user.
7 Specify the Farm Database user’s password.
After the data has been entered and all inputs are correct, the Infor.Redis tool runs and moves the
Redis master node to the current server.
8 Run the Redis Tool.
9 Restart the Infor Ming.le Cache Service.
10 Start the Infor Ming.le Shredder Service.
After this, the Redis functionality is restored. Once the Redis master node has been moved, the
secondary node will remain as the Redis master node. If the secondary node fails, then the tool
must be run to move the Redis master node back to the primary node.

Infor Operating Service Administration Guide | 228


Elastic Search

Appendix F: Elastic Search

Infor Search is a common platform that provides indexing and search capabilities for some of the Infor
OS components. Infor Search currently includes these Infor OS components:
• Infor Ming.le
• Infor Document Management
• Infor Chat
These applications use a common set of APIs for configuring, indexing, and searching for documents.
Infor Search Service is comprised of these services.
• Infor Search Configuration Service
• Infor Search Indexing Service
• Infor Search Service
• Infor Search Scheduler Service
• Infor Search Streaming Service

Infor Search Configuration Service


The Infor Search Configuration Service provides endpoints for adopting applications for these functions:
• Application configuration
• Create and modify repositories
• Endpoints to manage metadata
• Endpoints to perform critical Elastic Search operations across the cluster

Infor Search Indexing Service


The Infor Search Indexing Service provides endpoints for indexing data. Applications can either index
a single document or a batch of documents. The Indexing Service is integrated with the Infor Search
Streaming Service to receive a continuous flow of documents from the adopting application.

Infor Operating Service Administration Guide | 229


Elastic Search

Infor Search Search Service


The Infor Search Search Service is the run-time service that is invoked when the user performs a
search. This service includes several endpoints to search for data, retrieve the metadata associated
with each repository, pagination endpoints, and other endpoints to support search.

Infor Search Scheduler Service


The Scheduler Service provides jobs that are executed periodically to gather the cluster, node, and
usage statistics. Data collected by this service are used by the Index Statistics widget.
In addition to collecting data statistics, the Scheduler Service includes a job to perform a check on the
cluster to make sure adequate number of shards are allocated.

Infor Search Streaming Service


In cases where a continuous flow of documents is to be indexed, Infor Search uses the Infor Search
Streaming Service to access the document to be indexed. The adopting application publishes data to
the Infor OS PubSub Service and to the streaming service that is subscribing for the data. The adopting
application batches the data and calls the indexing service to index the data.
This service is currently used by Infor Chat only.

Objective
This appendix describes the Infor Search component, which is part of the Infor OS platform, and
Homepages widgets for use in monitoring critical information related to the Elasticsearch cluster and
usage. These widgets are packaged as part of the Infor OS installer.
This appendix also provides information for troubleshooting issues that may occur in the application
due to misconfiguration or other errors.

Homepages widgets
Infor OS is packaged with Homepages widgets that provide useful information about the Elasticsearch
cluster and usage.

Infor Operating Service Administration Guide | 230


Elastic Search

Elasticsearch Health Status widget


The Elasticsearch Health Status widget provides information about overall health of the Elastic Search
cluster. It includes this information:
• Cluster Status
The cluster status is displayed as green, yellow or red:
• Green indicates that the cluster is healthy, all indexes and shard allocations are available, and
no actions are required.
• Yellow indicates that the cluster is functional but that some of the indexes for which the primary
shards are allocated have replicas that are not allocated.
• Red indicates that there are one or more unassigned shards in the cluster.
• Total Number of Nodes
The total number of nodes that is part of the cluster at any given point in time is shown. If the number
of nodes is fewer than the number of nodes configured, corrective actions must be taken to make
sure the node is available.
• Total Number of Primary and Replica Shards
The total number of primary and replica shards on the cluster is shown. This information is important
to monitor as an excessive number of shards can cause a cluster to be unstable.
• Total Storage Space Used
This is the total storage space for the cluster.
• Total Indexes
This is the total number of indexes available in the cluster.

Application/Index Statistics widget


The Application Statistics Widget provides ElasticSearch usage information by application. The widget
can be configured to display usage information for one or more applications along with the time period,
ranging from the last five minutes to the last 30 days.
The widget can show statistics for these Infor OS applications:
• ION API Gateway
• ION Oneview
• Infor Search (IDM, Infor Ming.le and Infor Chat)
• Auditing and Monitoring
Use the drop-down to display statistics for a selected application or consolidated information for all
applications.
• Name of the application
• Total number of documents for that application
• Total number of documents added during the selected duration
• Storage increase during the selected duration
• Percentage increase in storage for the selected duration

Infor Operating Service Administration Guide | 231


Elastic Search

• Total storage space till date for that application

Error codes
Use these lists of the error codes that can be found in the log files. The lists include a description of
each error and the potential cause for troubleshooting issues.

Configuration errors
Error Code Error Description
FAIL_UNEXPECTED_ERROR An unexpected error occurred that was not caught
in the code. This type of error is non-specific and
must be tracked down in the log file and diag-
nosed according to its surrounding logs.
FAIL_ACCESS_DENIED The calling client does not have the correct per-
missions to the requested endpoint.
FAIL_MISSING_PARAMETER A parameter that was expected was not present
in the request payload.
FAIL_INVALID_PARAMETER_VALUE The value supplied for the given field is in an in-
valid format, for example, giving a sequence of
letters instead of an integer.
FAIL_INITIALIZE_CACHE Caching system failed for the specific request,
and a response may have been returned with a
delay.
FAIL_UNSUPPORTED_DATATYPE The data type supplied in an element’s configura-
tion is not supported by Elasticsearch.
FAIL_UNSUCCESSFUL_OPERATION Elastic Search call failure due to a bad payload
or non-existent objects.
FAIL_CLIENT_IO Elastic Search IO Failure.
FAIL_ALIASES_OPERATION Create/Update Elasticsearch Alias Failure.
AS_INVALID_APPLICATION_EXISTS An application with the given name already exists
for the tenant. Applications cannot have identical
names.
AS_INVALID_TENANT_APPLICATION_DELETE The tenant cannot be deleted until all of its appli-
cations have been deleted first.

Infor Operating Service Administration Guide | 232


Elastic Search

Error Code Error Description


AS_INVALID_OPERATION The analysis field within the indexSettings field
during the creation or breaking-change-update
of a repository is not of standard JSON format.
AS_INVALID_VALUE The threshold field within the indexSettings field
must have a value that is LOW, MED, or HIGH.
AS_INVALID_TENANT_ALREADY_ACTIVE The tenant to be activated is already in an active
state.
AS_INVALID_SPOTLIGHTCONFIGURATION The spotlightConfiguration field in the new or
updated repository definition has an invalid JSON
construction.
AS_NOSUCH_REPOSITORY The given repository name does not exist for a
tenant application.
AS_NOSUCH_TENANT_APPLICATION The provided logical ID for a given tenant appli-
cation does not exist in the database.
AS_NOSUCH_INDEX This is a critical error that should never happen.
The Elasticsearch index cannot be found.
AS_NOSUCH_DESTINATION_INDEX A critical error occurs during the process of re-
indexing the data from one Elasticsearch index
to another. If the destination index is not found,
this error occurs.
AS_FAIL_DEFINITION_ZIP_READ Failure occurred during the addition of default
repositories for a given application. The file where
an application’s default repositories are stored
was not read successfully. This most likely hap-
pens during an update tenant request or a new
application request.
AS_FAIL_ADD_DEFINITION Failure occurred while parsing an application's
definition to create its inner repositories and inter-
est centers, if any.
AS_FILE_PROCESS_ERROR An error occurred while reading from the file,
which defines the tenant’s default applications.
This most likely happens during the update of a
tenant, but generally should not happen. See the
previous error for further details.
AS_NOSUCH_VERSION A version of a given repository was not found in
the database. This is a critical error that should
not happen.

Infor Operating Service Administration Guide | 233


Elastic Search

Error Code Error Description


AS_FAIL_REGISTRY_READ An error may occur during the update of a tenant
when its inner applications are attempting to be
created or updated. The registry service that
contains the definitions to certain applications
has failed. This is a critical error that should not
happen. See previous errors for further details.
AS_INDEXMGMT_UNEXPECTED_ERROR A failure happens while reading from Elastic-
search. This happens during a re-indexing proce-
dure. This is a critical error that should not occur.
AS_FAIL_AUTHORIZATION Each user belonging to the tenant should have
_TOKEN_NOT_PROVIDED a valid authorization token to pass to the server
in order to validate itself. If such a token is miss-
ing, then this error occurs. This should never
happen for legitimate users.
AS_FAIL_SHARD_CONFIGURATION This is a critical error that should not occur but
may occur during the resizing of an Elasticsearch
cluster.

Indexing errors
Error code Error description
IS_MISSING_APPLICATION_LOGICAL_ID The given logical ID during the indexing of docu-
ments is not of an existing application. No appli-
cation for the tenant has such a logical ID.
IS_MISSING_DELETE_ELEMENTS This is a critical error that should not occur. As
of now, this may happen during the archiving of
a topic in the Infor Ming.le Chat application.
IS_INVALID_INDEXVERSION The version specified in the indexing request is
not valid. Currently, only version 1 and 2 are
supported, version 2 being that which supports
document versioning.
IS_INVALID_ELEMENTS This is a critical error that should not occur. As
of now, this may happen during the archiving of
a topic in the Infor Ming.le Chat application.
IS_FAIL_ELASTIC_INDEX_IO This is a critical error that should not occur. As
of now, this may happen during the archiving of
a topic in the Infor Ming.le Chat application. An
internal server error occurred while communicat-
ing with the Elasticsearch service.

Infor Operating Service Administration Guide | 234


Elastic Search

Search errors
Error code Error description
SS_MISSING_TENANTID This is a critical error that should not occur. The
tenant name is missing from the search request
payload, which should be identified by the tenan-
tId field.
SS_MISSING_SEARCHTERM This is a critical error that should not occur. The
search term to search is missing from the search
request payload that should be identified by the
terms field.
SS_MISSING_SEARCHTARGET This is a critical error that should not occur. The
specific repositories to search for the search re-
quest are missing. This should be identified by
the searchTargets field in the request payload.
SS_MISSING_LOGICALID_IN_SEARCHTAR- An application that is within the domain of
GET searchable applications has a missing logical ID.
SS_MISSING_QUERYBODY_IN_SEARCHTAR- An application that is within the domain of
GET searchable applications has a missing query. This
is an error that occurs during the validation of
applications during a private search.
SS_MISSING_APPLICATION_LOGI- The application logicalId field is missing from
CALID_IN_SEARCHTARGET the search request payload.
SS_MISSING_USERIDENTIFIER Each user belonging to the tenant has a unique
user identifier identified by the userIdentifier
field. A user’s identifier is always extracted to be
included in each search. This error should not
occur if the user is a legitimate user identifier.
SS_MISSING_BEARERTOKEN This is an error that should not occur for a legiti-
mate user. The bearer token, which is a security
token, should always be included in the search
payload.
SS_MISSING_REPOSITORYTARGET The repositoryTargets field is missing from the
search request payload.
SS_MISSING_LOGICALID_IN_REPOSITORY- An application logicalId field is missing from one
TARGET of the search targets in the given request payload.
SS_INVALID_EMPTY_REPOSITORYTARGET An application in the search request payload has
no inner repositories specified.
SS_INVALID_PARAMETER_FROM The from field in one of the applications in the
search request payload is invalid because the
value is less than 0.

Infor Operating Service Administration Guide | 235


Elastic Search

Error code Error description


SS_INVALID_PARAMETER_SIZE The size field in one of the applications in the
search request payload is invalid because the
value is less than 0.
SS_INVALID_VERSION The version field in the search request payload
has an invalid number. As of now, only 1 and 2
are supported.
SS_INVALID_EMPTY_TARGET No repositories are specified for an application
within the search request payload.
SS_NOSUCH_TENANT_MODEL This is a critical error during search. A tenant
model must be built to encompass the character-
istics of each search request. If the tenant model
fails to be created, then a search cannot take
place because the domain in which a user is al-
lowed to search is unknown.
SS_NOSUCH_APPLICATION_MODEL This is a critical error during search. The applica-
tion model makes up a part of the tenant model
(see the previous error), and without it MES does
not know which applications the user is allowed
to search within. The application model failed to
be built.
SS_NOSUCH_APPLICATION No application exists with the given application
logical ID for the search request payload.
SS_NOSUCH_REPOSITORY No repository exists with the given repository
name for the search request payload.
SS_FAIL_UNEXPECTED_ERROR This is a generic error that takes place during
search. This error can indicate various issues.
Navigate to the search service log file and inspect
the logs surrounding where the error occurred.
SS_FAIL_SEARCH_RESULT An API call to Elasticsearch during search was
not successful. This is an internal server error
that should not happen.
SS_FAIL_GENERAL This is a generic error that takes place during
search. This error can indicate various issues.
Navigate to the search service log file and inspect
the logs surrounding where the error occurred.

Infor Operating Service Administration Guide | 236


Elastic Search

Common errors
Error code Error description
CS_MISSING_INDEX_CONTEXT An error most likely occurred during the indexing
of documents when required fields are left blank.
The error message indicates which documents
were left blank.
CS_MISSING_INDEX_NAME_BUILDER An error occurred during the creation of a repos-
itory if an Elasticsearch alias name fails to be
constructed within the code.
CS_INVALID_TENANT An error is shared with all services to indicate
that the tenant with the supplied tenant name
within the concerning request payload is in an
inactive state or does not exist.
CS_NOSUCH_APPLICATION An error is shared with all services to indicate
that the supplied application logical ID within the
concerning request payload does not exist.
CS_NOSUCH_INDEX A critical error that should never occur. The error
indicates that Elasticsearch data for a given
repository could not be located.
CS_NOSUCH_TENANT An error is shared with all services to indicate
that the tenant with the supplied tenant name
within the concerning request payload does not
exist.
CS_NOSUCH_TABLE A critical error occurred indicating that a database
table could not be found.
CS_FAIL_ELASTIC_INDEX_IO An error occurred while performing an operation
in Elasticsearch. The error message indicates
which operation was being performed before
failure occurred.
CS_FAIL_USER_APPLICATION_SITE_LIST An error most likely occurred during a search.
The service failed to retrieve the list of applica-
tions to which a user has access and, therefore,
is allowed to search. Without this list, the search
cannot take place.
CS_FAIL_USER_APPLICA- An error most likely occurred during a search.
TION_SITE_LIST_AND_FALLBACK The service failed to retrieve the list of applica-
tions to which a user has access and, therefore,
is allowed to search. Without this list, the search
cannot take place.

Infor Operating Service Administration Guide | 237


Elastic Search

Error code Error description


CS_FAIL_INDEX_OPERATION An unsuccessful Elasticsearch operation oc-
curred. Rather than generating an error, Elastic-
search sends back the reason for an unsuccess-
ful operation. MES indicates within the error
message the reason for the failure.
CS_FAIL_INDEX_OPERATION An unsuccessful Elasticsearch operation oc-
curred. Rather than generating an error, Elastic-
search sends back the reason for an unsuccess-
ful operation. MES indicates within the error
message the reason for the failure.
CS_FAIL_ADD_CREATE_DATE The ies_create_date Elasticsearch field failed
to be created during a creation or breaking-
change-update of a repository. This field is to be
contained in each indexed document to indicate
the date it was created (indexed).
CS_FAIL_ADD_CREATE_TIMESTAMP The ies_create_timestamp Elasticsearch field
failed to be created during a creation or breaking-
change-update of a repository. This field is to be
contained in each indexed document to indicate
the time it was created (indexed).
CS_FAIL_PARSE_ELASTICSEARCH_CONFIG- A parsing error occurred in the attempt to create
URATION the Elasticsearch index during the creation or
breaking-change-update of a repository.
CS_FAIL_ADD_ACCT_ENTITY The ies_acct_entity Elasticsearch field failed to
be created during a creation or breaking-change-
update of a repository. This field is to be con-
tained in each indexed document to indicate its
accounting entity association (security feature).
CS_FAIL_ADD_ACCT_LOCATION The ies_acct_location Elasticsearch field failed
to be created during a creation or breaking-
change-update of a repository. This field is to be
contained in each indexed document to indicate
its location entity (security feature).
CS_FAIL_ADD_ACCT_DOCTYPE The ies_acc_doctyepe Elasticsearch field failed
to be created during a creation or breaking-
change-update of a repository. This field is to be
contained in each indexed document to indicate
its document type (security feature).
CS_FAIL_ADD_USERROLE The ims_security_role Elasticsearch field failed
to be created during a creation or breaking-
change-update of a repository. This field is to be
contained in each indexed document to indicate
its security role access (security feature).

Infor Operating Service Administration Guide | 238


Elastic Search

Error code Error description


CS_FAIL_ACCESS_OAUTHKEYINFO A failure occurred during an attempt to retrieve
the authentication key necessary to communicate
with external services.
CS_FAIL_IFS_ATTRIBUTESERVICE A failure occurred during an attempt to retrieve
the security features of a specific user. Such se-
curities are needed to determine which reposito-
ries and documents a user has access to during
a search.
CS_FAIL_TENANT_MODEL A critical error occurred during a search. A tenant
model must be built to encompass the character-
istics of each search request. If the tenant model
fails to be created, then a search cannot take
place because the domain in which a user is al-
lowed to search is unknown.
CS_FAIL_IFS_CLAIMRULES METADATASER- A failure occurred during an attempt to retrieve
VICE the security features of a specific user. Such se-
curities are needed to determine which docu-
ments a user has access to during a search.
CS_FAIL_PARSE_FACET_NESTED An error occurred during the creation or breaking-
change-update of a repository. This indicates that
an element within the repository definition con-
tains both nested = true and facet = tru
e. The issue is that a facet element cannot also
be a nested element.
CS_FAIL_PARSE_FACET_SECURITY An error occurred during the creation or breaking-
change-update of a repository. This indicates that
an element within the repository definition con-
tains facet = true and at the same time is a
security field. A security field is one that is named
accountingEntity, location, or documentType.
The issue is that a facet field cannot also be a
security field.
CS_FAIL_ID_FIELD_INVALID An error occurred during the creation or breaking-
change-update of a repository. This error indi-
cates that an element used for the primary key
(document ID) is not an element existing within
the repository definition. A primary key element
must be made up of existing elements.
CS_FAIL_INVALID_DOC_ID An error occurred during the creation or breaking-
change-update of a repository. This error indi-
cates that the primary key (document ID) supplied
in the repository definition has an invalid format.

Infor Operating Service Administration Guide | 239


Elastic Search

OneView general functionality

Creating indexes
• The index is created in the OneViewApi Grid Node:
• Right after the startup of the node (after necessary components are loaded), OneView starts the
index creation procedure.
• If indexes (Event, Message, Statistics) do not exist, the create index routine creates the indexes
and the attributes as defined in com.infor.ion.oneview.model.DocumentSearchModelNew
The routine iterates through the list of all attributes and assigns the correct type and name.
• This situation (including logs) is described in the „Migration Documentation – Happy Path“
• If indexes already exist, the create index routine does not override or re-create the indexes. The
following is logged:

Creating ElasticSearch index event, with number of shards 5 and replicas


1

Index event already exist,


{"root_cause":[{"type":"index_already_exists_exception","reason":
"index [event/ALvSAP3JSXmG2F7y1tIIJQ] already
exists","index_uuid":"ALvSAP3JSXmG2F7y1tIIJQ","index":"event"}],"
type":"index_already_exists_exception","reason":"index
[event/ALvSAP3JSXmG2F7y1tIIJQ] already
exists","index_uuid":"ALvSAP3JSXmG2F7y1tIIJQ","index":"event"}

ElasticSearch index event created


• Index validation is performed in the OneViewEvent node:
• Check that all indexes and attributes are correctly created.
• All attributes are iterated and validate that the names and types are correct.

Indexing new objects


The indexing procedure of the particular indexes is initiated by consuming the corresponding input
queues containing the objects to be indexed:
• Event index – populated by messages consumed from the ION-BodEvent-Q-environment_name
queue
This queue is populated by ION, when any event happens.
• Message index – populated by messages consumed from the
ION-BodEvent-Q-environment_name-MSG queue
This queue is populated by OneView. Only events of a particular type (BOD entered ION) are
forwarded to this queue.

Infor Operating Service Administration Guide | 240


Elastic Search

• Statistics index – populated by messages consumed from the


ION-BodEvent-Q-environment_name-ENR queue
This queue is populated by OneView. Events of a particular type are forwarded to this queue.

Each consumed message is processed by the corresponding processor in the specific manner based
on the type of the message, but all messages use a similar process:
• Consume object from queue
• Transform to the desired format
• Indexing
For indexing purposes, batching (io.searchbox.core.Bulk) is used.

Purging OneView data


This functionality initiates a long-running process that removes the object contents from Elastic Search.
Users can specify the time range of the data should to be removed.
The functionality is accessible from IONDesk > Configuration > Purge Data.
Note: When migration and cloning are running at the same time, only objects from the Elastic Search
(the new search engine) are removed. Final records counts for the old and new search engines may
differ.

Troubleshooting

Version conflicts
Version conflicts occur when more than one thread disrupts a single Elastic Search object. These errors
can be overlooked. The operation is repeated, and the ES object is not corrupted.

2019-02-12 09:57:13,573 +0000Z {} ERROR OneViewEventModule


com.infor.ion.oneview.engine.queue.runtimeconfig.MapperVersionCache: Ex
ception in mapping cache
com.infor.ion.oneview.engine.common.exception.OneViewException: ERROR 477
- Error in ES bulk atomic
upload : [One or more of the items in the Bulk request failed, check
BulkResult.getItems() for more
information.
version_conflict_engine_exception{"type":"version_conflict_engine_excep
tion","reason":"[event][910822b2-
5e14-37d6-ae90-cacc34f7a003]: version conflict, current version [264115]
is different than the one provided
[264114]","index_uuid":"2Vor0XANQQ2brsHQvZwnIA","shard":"9","in
dex":"event"} ] at
com.infor.ion.oneview.engine.search.common.bulk.BulkAtomicUpload.bulkU

Infor Operating Service Administration Guide | 241


Elastic Search

pload(BulkAtomicUpload.java:63)

Circuit breaking exceptions


To resolve circuit breaking errors that are displayed in the logs:
• Limited free storage space can be resolved by increasing the overall storage space.
• High (constantly above 75%) heap space consumption can be resolved by adding more nodes to
the cluster to split the workload.
• High CPU usage can be resolved by adding more nodes to the cluster to split the workload.
For more information, see
https://www.elastic.co/guide/en/elasticsearch/reference/current/circuit-breaker.html

Index create block exception


The ES Grid does not start because there is no available memory or storage.
This issue is resolved by exploring the logs and metering and adding more nodes or storage to overcome
the limitation.

Infor Operating Service Administration Guide | 242

Вам также может понравиться