ARIS Administrator User Manual

ARIS
ADMINISTRATOR USER
MANUAL
VERSION 10.0 - SERVICE RELEASE 18

MAY 2022
This document applies to ARIS Version 10.0 and to all subsequent releases.
Specifications contained herein are subject to change and these changes will be reported in
subsequent release notes or new editions.
Copyright © 2010 - 2022 Software AG, Darmstadt, Germany and/or Software AG USA Inc.,
Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
The name Software AG and all Software AG product names are either trademarks or
registered trademarks of Software AG and/or Software AG USA Inc. and/or its subsidiaries
and/or its affiliates and/or their licensors. Other company and product names mentioned
herein may be trademarks of their respective owners.
Detailed information on trademarks and patents owned by Software AG and/or its
subsidiaries is located at https://softwareag.com/licenses.
Use of this software is subject to adherence to Software AG's licensing conditions and terms.
These terms are part of the product documentation, located at
https://softwareag.com/licenses and/or in the root installation directory of the licensed
product(s).
This software may include portions of third-party products. For third-party copyright notices,
license terms, additional rights or restrictions, please refer to "License Texts, Copyright
Notices and Disclaimers of Third Party Products". For certain specific third-party license
restrictions, please refer to section E of the Legal Notices available under "License Terms and
Conditions for Use of Software AG Products / Copyright and Trademark Notices of Software
AG Products". These documents are part of the product documentation, located at
https://softwareag.com/licenses and/or in the root installation directory of the licensed
product(s).
ADMINISTRATOR USER MANUAL
Contents
1 About this manual .................................................................................................................................. 1
2 Introduction to ARIS.............................................................................................................................. 2
3 Manage ARIS ........................................................................................................................................... 3

3.1 Open ARIS Administration ...................................................................................................... 3
3.2 Manage licenses ........................................................................................................................ 4
3.2.1 License types and dependencies ............................................................................... 4
3.2.2 Consumed and expired licenses ................................................................................. 5
3.2.3 Import and display license file ..................................................................................... 6
3.2.4 Enable or disable license monitoring ......................................................................... 7
3.2.5 Delete licenses ................................................................................................................ 8
3.2.6 Create and activate license rule.................................................................................. 8
3.2.7 License rule types ........................................................................................................ 10
3.2.8 Download and upload license rules ........................................................................... 11
3.2.9 Generate License audit (password-protected) report ......................................... 12
3.2.10 Generate License usage rule validation report ...................................................... 13
3.3 Manage users and user groups............................................................................................ 14
3.3.1 Use case - Manage users ............................................................................................ 14
3.3.2 Create user ..................................................................................................................... 20
3.3.3 Default users ................................................................................................................. 22
3.3.4 Make a user a system user ......................................................................................... 24
3.3.5 Copy a system user ...................................................................................................... 26
3.3.6 Assign user groups to a user ..................................................................................... 28
3.3.7 Edit user .......................................................................................................................... 29
3.3.8 Log out user ................................................................................................................... 30
3.3.9 Create user group ......................................................................................................... 31
3.3.10 Copy user group............................................................................................................ 32
3.3.11 Edit user group .............................................................................................................. 33
3.3.12 Assign users to a user group ..................................................................................... 34
3.3.13 Delete user ..................................................................................................................... 35
3.3.14 Delete user group ......................................................................................................... 36
3.3.15 Delete all users/user groups ...................................................................................... 37
3.3.16 How can the password be changed? ....................................................................... 37
3.3.17 Available licenses in ARIS ........................................................................................... 38
3.3.18 Assign privileges and profiles .................................................................................... 39
3.3.18.1 Change a privilege for multiple users/user groups ................................. 39
3.3.18.2 Change multiple function, license, and database privileges for
user/user group .............................................................................................. 40
3.3.18.3 Assign license pool to user group ................................................................ 42
3.3.18.4 Tenant-wide function privileges .................................................................. 43
3.3.18.5 Database-wide function privileges ............................................................. 45
3.3.18.6 What function privileges can be assigned? .............................................. 48
3.3.18.7 What license privileges can be assigned? .................................................. 50
3.3.18.8 Assign profiles to users/user groups .......................................................... 51
3.3.18.9 What is a configuration administrator? ...................................................... 53
3.3.19 Handle password .......................................................................................................... 54
I
3.3.19.1 Change user password ................................................................................... 54

3.3.19.2 Request new password .................................................................................. 55
3.3.20 Apply LDAP .................................................................................................................... 56
3.3.20.1 Import users/user groups from LDAP ......................................................... 56
3.3.20.2 Synchronize users/user groups with the LDAP system ......................... 57
3.3.21 Use SCIM ......................................................................................................................... 58
3.3.21.1 Generate bearer token .................................................................................... 58
3.3.21.2 Copy bearer token to clipboard .................................................................... 59
3.3.21.3 Delete bearer token ......................................................................................... 60
3.3.22 Manage user data ......................................................................................................... 61
3.3.22.1 Back up user management data .................................................................. 61
3.3.22.2 Restore user management data ................................................................... 62
3.3.22.3 Export user statistics ...................................................................................... 62
3.3.22.4 Generate report ................................................................................................ 63
3.3.22.5 Generate License audit (password-protected) report ............................ 64
3.3.22.6 Generate License usage rule validation report ......................................... 65
3.3.22.7 Which reports exist?........................................................................................ 66
3.3.22.8 Active sessions and history........................................................................... 67
3.3.22.9 ARIS Architect 'Administration' tab versus ARIS Administration .........68
3.3.22.10 Delete and anonymize user accounts ......................................................... 69
3.3.23 Configure user management ..................................................................................... 70
3.3.23.1 Import configuration ....................................................................................... 70
3.3.23.2 Export configuration ........................................................................................ 71
3.3.23.3 Configure user for impersonation ................................................................ 72
3.3.23.4 Impersonation .................................................................................................. 73
3.3.23.5 What is the default user group? ................................................................... 74
3.3.23.6 Customize infrastructure............................................................................... 75
3.3.23.7 Kerberos ............................................................................................................. 76
3.3.23.7.1 Customize Kerberos settings .............................................................. 76
3.3.23.7.2 Upload Kerberos configuration files .................................................. 77
3.3.23.8 LDAP ................................................................................................................... 78
3.3.23.8.1 Add LDAP server .................................................................................... 78
3.3.23.8.2 Test connection to an LDAP server ................................................... 79
3.3.23.8.3 Edit connection to an LDAP server .................................................. 80
3.3.23.8.4 Upload LDAP truststore file................................................................. 81
3.3.23.8.5 Customize LDAP settings .................................................................... 81
3.3.23.8.6 Customize ARIS for LDAP server operations .................................. 82
3.3.23.8.6.1 Configure secure communication .......................................... 84
3.3.23.8.6.2 Allow login for LDAP users only ...............................................86
3.3.23.8.6.3 Configure single sign-on (LDAP) ............................................. 87
3.3.23.8.6.3.1 Use Kerberos ..................................................................... 88
3.3.23.8.6.3.2 Use SAML ............................................................................ 92
3.3.23.8.7 Using multiple LDAP servers............................................................... 93
3.3.23.9 User defined notifications ............................................................................. 94
3.3.23.9.1 Customize user-defined notifications .............................................. 94
3.3.23.9.2 Upload templates for notifications .................................................... 95
3.3.23.9.3 Customize default HTML templates for notifications ................... 96
II
3.3.23.9.4 Customize HTML templates for multiple locales ............................ 97

3.3.23.9.5 Variables for user-defined notifications .......................................... 98
3.3.23.10 Customize password policy ........................................................................... 99
3.3.23.11 SAML ................................................................................................................. 100
3.3.23.11.1 Customize SAML settings .................................................................. 100
3.3.23.11.2 Upload keystore file ............................................................................. 101
3.3.23.11.3 Upload truststore file ........................................................................... 101
3.3.23.12 Customize security settings ....................................................................... 102
3.3.23.13 Customize SMTP settings ............................................................................ 103
3.3.23.14 Customize user settings .............................................................................. 104
3.3.23.15 SCIM .................................................................................................................. 105
3.3.23.15.1 Customize SCIM settings ................................................................... 105
3.3.23.15.2 Generate bearer token ....................................................................... 106
3.3.23.15.3 Copy bearer token to clipboard ........................................................ 107
3.3.23.15.4 Delete bearer token............................................................................. 108
3.3.23.15.5 Specify SCIM client ............................................................................. 108
3.3.23.16 Customize Application switcher................................................................. 109
3.3.23.17 Customize OAuth 2.0 settings .....................................................................110
3.4 Display charts ......................................................................................................................... 111
3.5 Manage databases ................................................................................................................. 112
3.5.1 Manage database properties ....................................................................................118
3.6 Manage evaluation scripts .................................................................................................. 136
3.6.1 Reports.......................................................................................................................... 137
3.6.1.1 How to handle interrupted report execution........................................... 140
3.6.1.2 ARIS default reports ....................................................................................... 141
3.6.1.2.1 Standard ................................................................................................. 141
3.6.1.2.1.1 Report: Adapt object names and names of assigned
models ......................................................................................... 142
3.6.1.2.1.2 Report: Create process manual ............................................. 143
3.6.1.2.1.3 Report: Create template for data import ............................. 144
3.6.1.2.1.4 Report: Determine assignment structure ............................ 157
3.6.1.2.1.5 Report: Export attribute values for translation .................. 158
3.6.1.2.1.6 Report: Export graphic as a PDF (with preview) ................ 166
3.6.1.2.1.7 Report: Export graphic as PDF ............................................... 166
3.6.1.2.1.8 Report: Export RASCI chart..................................................... 167
3.6.1.2.1.9 Report: Generate job description............................................ 171
3.6.1.2.1.10 Report: Import data in Excel format...................................... 173
3.6.1.2.1.11 Report: Import translated attributes .................................... 186
3.6.1.2.1.12 Report: Number hierarchy levels ........................................... 186
3.6.1.2.1.13 Report: Output functions across multiple assignment
levels ............................................................................................ 187
3.6.1.2.1.14 Report: Output hierarchy (for MashZone) ........................... 189
3.6.1.2.1.15 Report: Output model information ........................................ 190
3.6.1.2.1.16 Report: Output model information considering various
aspects ......................................................................................... 191
3.6.1.2.1.17 Report: Output models and objects of the groups ............ 192
3.6.1.2.1.18 Report: Output object information ........................................ 193
3.6.1.2.1.19 Report: Output object information (for MashZone) ........... 194
III
3.6.1.2.1.20 Report: Output object information (table) ........................... 194

3.6.1.2.1.21 Report: Output objects in the sequence of modeling
(model graph) ............................................................................. 195
3.6.1.2.1.22 Report: Output occurrences of objects................................ 196
3.6.1.2.1.23 Report: RA(S)CI - Output organizational participations
in processes ............................................................................... 197
3.6.1.2.2 Administration...................................................................................... 199
3.6.1.2.2.1 Report: Adapt ARIS document storage links....................... 199
3.6.1.2.2.2 Report: Compare filters........................................................... 200
3.6.1.2.2.3 Report: Consolidate font formats ......................................... 200
3.6.1.2.2.4 Report: Consolidate objects.................................................... 201
3.6.1.2.2.5 Report: Export database content (interface for BI
tools or MashZone) .................................................................. 202
3.6.1.2.2.6 Report: Export relationship matrix ....................................... 204
3.6.1.2.2.7 Report: Format models ........................................................... 204
3.6.1.2.2.8 Report: Import of user data from User management ...... 205
3.6.1.2.2.9 Report: Move object definitions into model group ........... 206
3.6.1.2.2.10 Report: Output database information ..................................207
3.6.1.2.2.11 Report: Output filter information ........................................... 210
3.6.1.2.2.12 Report: Output group information ......................................... 212
3.6.1.2.2.13 Report: Output overview of reports, macros, and
semantic checks ....................................................................... 213
3.6.1.2.2.14 Report: Replace connections between IT system
contact roles .............................................................................. 214
3.6.1.2.2.15 Report: Replace font formats ................................................. 216
3.6.1.2.2.16 Report: Replace object types ................................................. 216
3.6.1.2.2.17 Report: Replace symbol types ................................................ 216
3.6.1.2.2.18 Report: Replace text attributes.............................................. 217
3.6.1.2.2.19 Report: Synchronize ARIS document storage link title
attributes with document titles ............................................. 217
3.6.1.2.2.20 Report: Transfer groups and users ....................................... 218
3.6.1.2.3 Process Governance ........................................................................... 218
3.6.1.2.3.1 Report: Find indirectly updated models ............................... 219
3.6.1.2.3.2 Report: Generate shortcuts ................................................... 220
3.6.1.2.3.3 Report: Model status overview .............................................. 220
3.6.1.2.3.4 Report: Output organizational structure ............................. 221
3.6.1.2.3.5 Report: Governance Process Mining export........................ 221
3.6.1.2.4 ARIS Risk and Compliance ................................................................ 223
3.6.1.2.4.1 Report: ARCM export ............................................................... 223
3.6.1.2.4.2 Report: ARCM user export for User management ............ 224
3.6.1.2.4.3 Report: Check for compliance with ARIS Risk and
Compliance modeling conventions ...................................... 225
3.6.1.2.4.3.1 Report: Verify semantics of audit templates ........... 226
3.6.1.2.4.3.2 Report: Verify semantics of controls .......................... 227
3.6.1.2.4.3.3 Report: Verify semantics of the hierarchy
structures ........................................................................ 228
3.6.1.2.4.3.4 Report: Verify semantics of policies .......................... 229
3.6.1.2.4.3.5 Report: Verify semantics of the questionnaire
templates ......................................................................... 230
IV
3.6.1.2.4.3.6 Report: Verify semantics of risks ................................ 231

3.6.1.2.4.3.7 Report: Verify semantics of control test
definitions ........................................................................ 232
3.6.1.2.4.3.8 Report: Verify semantics of user groups .................. 233
3.6.1.2.4.3.9 Report: Verify semantics of the users....................... 234
3.6.1.2.4.4 Report: Import user groups managed in ARCM ................. 235
3.6.1.2.4.5 Report: Main report for ARCM data transfer ...................... 236
3.6.1.2.4.6 Report: Migrate risk & compliance roles............................... 237
3.6.1.2.4.7 Report: Transfer risk & compliance data ............................ 238
3.6.1.2.4.8 Report: Output data allocation matrix ................................. 238
3.6.1.2.5 ARIS ....................................................................................................... 239
3.6.1.2.5.1 Report: Export graphic as PDF .............................................. 239
3.6.1.2.6 Analysis................................................................................................. 240
3.6.1.2.6.1 Report: Analyze application systems ................................... 241
3.6.1.2.6.2 Report: Analyze classification ............................................... 242
3.6.1.2.6.3 Report: Analyze media breaks ............................................... 245
3.6.1.2.6.4 Report: Analyze organizational change .............................. 246
3.6.1.2.6.5 Report: Analyze times/costs .................................................. 247
3.6.1.2.6.6 Report: Compare models ........................................................ 248
3.6.1.2.7 Automation .......................................................................................... 255
3.6.1.2.7.1 Report: Check consistency of data flow dependencies .. 255
3.6.1.2.7.2 Report: Find indirectly updated models .............................. 256
3.6.1.2.7.3 Report: Generate shortcuts .................................................... 257
3.6.1.2.7.4 Report: Model status overview ............................................... 257
3.6.1.2.7.5 Report: Output organizational structure ............................ 258
3.6.1.2.8 Balanced Scorecard ........................................................................... 259
3.6.1.2.8.1 Report: ARIS Strategy Scorecard ......................................... 259
3.6.1.2.8.2 Report - ARIS Strategy Scorecard (extended) .................. 260
3.6.1.2.8.3 Report: Analysis of strategic initiatives and processes .. 260
3.6.1.2.8.4 Report: Create BSC management view ................................ 261
3.6.1.2.8.5 Report: Create BSC overview ................................................ 264
3.6.1.2.8.6 Report: Export BSC KPIs ......................................................... 266
3.6.1.2.8.7 Report: Import BSC KPIs .......................................................... 267
3.6.1.2.8.8 Report: Perform BSC planned-actual comparison ............ 267
3.6.1.2.9 BPM ......................................................................................................... 271
3.6.1.2.9.1 Report: Analyze main success factors ................................. 271
3.6.1.2.9.2 Report: Evaluate process ........................................................ 272
3.6.1.2.10 Business Publisher .............................................................................. 272
3.6.1.2.10.1 Report: Start Publisher export ............................................... 273
3.6.1.2.10.2 Report: Start Publisher export (Process Governance) ..... 273
3.6.1.2.10.3 Report: HTML export................................................................. 274
3.6.1.2.10.4 Report: Show model graphics from group in Excel ........... 276
3.6.1.2.11 Use case: Business as unusual......................................................... 277
3.6.1.2.11.1 Report: Business judgement report ...................................... 277
3.6.1.2.11.2 Report: Process weak-point analysis ...................................278
3.6.1.2.11.3 Report: Weak-point overview ................................................. 279
3.6.1.2.12 Change management ........................................................................ 280
V
3.6.1.2.12.1 Report: Output task list ........................................................... 280

3.6.1.2.12.2 Report: Output change management history ..................... 281
3.6.1.2.12.3 Report: Output status changes and improvement
proposals .................................................................................... 282
3.6.1.2.12.4 Which attributes must be allowed by the filter for
reports? ...................................................................................... 283
3.6.1.2.13 Confirmation management .............................................................. 284
3.6.1.2.13.1 Report: Generate confirmation process schedulers
(APG use case) .......................................................................... 284
3.6.1.2.13.2 Report: Generate activated confirmation process
scheduler for changed items................................................. 285
3.6.1.2.13.3 Report: Output confirmation process details .................... 286
3.6.1.2.13.4 Report: Output confirmation processes overview .............287
3.6.1.2.14 Customer Experience Management ............................................... 288
3.6.1.2.14.1 Report: Analyze customer experience ................................ 288
3.6.1.2.14.2 Report: Create infographic for persona ............................... 291
3.6.1.2.14.3 What queries are available for customer experience
by default? ................................................................................. 295
3.6.1.2.15 Dashboard data................................................................................... 296
3.6.1.2.15.1 Report: CoE - Aggregated maturity level............................. 297
3.6.1.2.15.2 Report: CoE - Maturity level/Mandatory properties ......... 298
3.6.1.2.15.3 Report: CoE - Model age ......................................................... 298
3.6.1.2.15.4 Report: CoE - Number of processes/Model status ........... 298
3.6.1.2.15.5 Report: CoE - Representative objects ................................. 299
3.6.1.2.15.6 Report: CoE - Local and global maturity level ................... 299
3.6.1.2.15.7 Report: CoE - Conventions .................................................... 300
3.6.1.2.15.8 Report: CoE - Owner distribution.......................................... 300
3.6.1.2.15.9 Report: CoE - Validity date ..................................................... 300
3.6.1.2.15.10 Report: CoE - Governance....................................................... 301
3.6.1.2.15.11 Report: CXM - Analyze customer experience .................... 302
3.6.1.2.15.12 Report: CXM – Analyze customer journeys (TOP 7) .......... 303
3.6.1.2.15.13 Report: CXM - Critical journeys ............................................. 304
3.6.1.2.15.14 Report: CXM - Responsibility (Channel) .............................. 304
3.6.1.2.15.15 Report: CXM - Responsibility (Ownership) ......................... 305
3.6.1.2.15.16 Report: Strategy - KPIs with data ......................................... 305
3.6.1.2.15.17 Report: Strategy - Models and objectives .......................... 306
3.6.1.2.15.18 Report: Strategy - Objectives and KPIs ............................... 306
3.6.1.2.15.19 Report: Strategy - Objectives with data ............................. 307
3.6.1.2.15.20 Report: EA - Models and systems ......................................... 308
3.6.1.2.15.21 Report: EA - Relations between organizational units
and systems .............................................................................. 309
3.6.1.2.15.22 Report: EA - System redundancies ...................................... 309
3.6.1.2.15.23 Report: EA - System support .................................................. 310
3.6.1.2.15.24 Report: EA - System support for VACDs ............................... 311
3.6.1.2.15.25 Report: EA - Systems with data .............................................. 311
3.6.1.2.15.26 Report: EA/Alfabet - CAPEX/OPEX for organizational
units ............................................................................................. 312
3.6.1.2.15.27 Report: EA/Alfabet - System costs ....................................... 312
3.6.1.2.15.28 Report: EA/Alfabet - Systems with lifecycle data ............. 313
VI
3.6.1.2.15.29 Report: Export item data to tables ........................................ 313

3.6.1.2.15.30 Report: Matomo - Database-specific portal usage ........... 314
3.6.1.2.15.31 Report: Matomo - Global portal usage .................................. 315
3.6.1.2.16 Functions .............................................................................................. 316
3.6.1.2.16.1 Report: Output functions with organizational
elements...................................................................................... 316
3.6.1.2.16.2 Report: Output hierarchy of the functions .......................... 317
3.6.1.2.17 Governance........................................................................................... 318
3.6.1.2.17.1 Report: Find a value within a string ...................................... 318
3.6.1.2.17.2 Report: Retrieve GUIDs of model(s) and/or object(s) ....... 319
3.6.1.2.18 Internet of Things ............................................................................... 320
3.6.1.2.18.1 Report: Generate fact sheet for IoT objects....................... 320
3.6.1.2.19 IT architecture ...................................................................................... 321
3.6.1.2.19.1 Report: Display data flows ...................................................... 321
3.6.1.2.19.2 Report: Evaluate IT landscape ............................................... 324
3.6.1.2.19.3 Report: Import changes (IT Inventory) ................................ 326
3.6.1.2.19.4 Report: IT landscape administration - Assign access
privileges ..................................................................................... 327
3.6.1.2.19.5 Report: IT landscape administration - Assign
administration access privileges .......................................... 328
3.6.1.2.19.6 Report: IT landscape administration - Output access
privileges .................................................................................... 329
3.6.1.2.19.7 Report: IT landscape administration - Remove invalid
assignments .............................................................................. 329
3.6.1.2.19.8 Report: IT landscape administration - Update and
create PSU group structure ................................................... 330
3.6.1.2.19.9 Report: IT landscape administration - Update filter .......... 331
3.6.1.2.19.10 Report: Lifecycle management ............................................. 332
3.6.1.2.19.11 Report: Output information on capabilities ........................ 335
3.6.1.2.19.12 Report: Output information on IT objects ........................... 336
3.6.1.2.19.13 Report: Output IT landscape and architecture
information for MashApps....................................................... 337
3.6.1.2.19.14 Report: Output system fact sheet (PDF) ............................ 339
3.6.1.2.19.15 Report: Redundant applications (visualization of
redundancies) ........................................................................... 345
3.6.1.2.19.16 Report: System consolidation ................................................347
3.6.1.2.19.17 Report: System evaluation ..................................................... 349
3.6.1.2.19.18 Report: System list ................................................................... 350
3.6.1.2.19.19 Reports used internally ............................................................ 351
3.6.1.2.20 Open BPM ............................................................................................. 352
3.6.1.2.20.1 Report: EPC-to-BPMN transformation ................................ 352
3.6.1.2.20.2 Report: Open BPM consistency check................................. 353
3.6.1.2.20.3 Report: Validate BPMN diagram for export as a file ......... 353
3.6.1.2.20.4 Customize EPC-to-BPMN transformation .......................... 354
3.6.1.2.21 Organizational elements .................................................................... 357
3.6.1.2.21.1 Report: Determine organizational structure ....................... 357
3.6.1.2.21.2 Report: Output organizational elements with
connected objects ................................................................... 358
VII
3.6.1.2.22 PPM integration .................................................................................. 359

3.6.1.2.22.1 Report: Select PPM process type and create function
mapping...................................................................................... 359
3.6.1.2.22.2 Report: Transfer process model and mapping
information to PPM ................................................................... 361
3.6.1.2.23 Processes ............................................................................................. 362
3.6.1.2.23.1 Report: Create structure chart.............................................. 362
3.6.1.2.23.2 Report: Output functions with connected objects ........... 364
3.6.1.2.23.3 Report: Output functions with data and organizational
elements (VACD) ...................................................................... 365
3.6.1.2.23.4 Report: Output functions with times and costs ................ 366
3.6.1.2.23.5 Report: Output transitive relationships via functions ..... 366
3.6.1.2.24 QM .......................................................................................................... 368
3.6.1.2.24.1 Report: Output overview of structuring models ............... 368
3.6.1.2.25 Sample reports .................................................................................... 369
3.6.1.2.25.1 Report: Process manual (example) ...................................... 369
3.6.1.2.26 SAP ........................................................................................................ 370
3.6.1.2.26.1 Report: Automatic SAP synchronization with ARIS
(SAP Solution Manager 7.1) .................................................... 370
3.6.1.2.26.2 Report: Solution Manager 7.2 - Synchronize branch ........ 371
3.6.1.2.26.3 Report: Delete empty synchronization models .................. 371
3.6.1.2.26.4 Report: Replace logical components .................................... 372
3.6.1.2.26.5 Report: Create implementation project (Solution
Manager 7.1)................................................................................ 372
3.6.1.2.26.6 Report: Solution Manager 7.2 - Download branch ............. 373
3.6.1.2.26.7 Report: Automatic SAP synchronization with SAP
Solution Manager 7.1................................................................. 373
3.6.1.2.26.8 Report: Generate test case description ...............................374
3.6.1.2.26.9 Report: Generate test case description - SAP Solution
Manager ....................................................................................... 374
3.6.1.2.26.10 Report: Generate test case documentation - Library ....... 375
3.6.1.2.26.11 Report: Manage document links for the portal ................... 375
3.6.1.2.26.12 Report: Output list of required components ....................... 376
3.6.1.2.26.13 Report: Run consistency check ............................................. 376
3.6.1.2.26.14 Report: Specify SAP Fiori app base URL .............................. 377
3.6.1.2.26.15 Report: Synchronize scope information .............................. 377
3.6.1.2.27 SAP migration (Solution Manager 7.1 to 7.2) ................................ 378
3.6.1.2.27.1 Report: 01 SAP Solution Manager 7.2 migration –
Create root folder layer ............................................................ 379
Resolve shortcuts .................................................................... 380
Adjust transaction types ......................................................... 381
Adjust documentation ............................................................ 382
adjust system landscape ........................................................ 383
VIII

Adjust IDs ................................................................................... 384
3.6.1.2.27.7 Report: SAP Solution Manager 7.2 migration – Library .... 384
3.6.1.2.28 Six Sigma .............................................................................................. 385
3.6.1.2.28.1 Report: Calculate actual processing time for model of
type 'Value stream map' ......................................................... 385
3.6.1.2.28.2 Report: Collect overall process effectiveness data.......... 387
3.6.1.2.28.3 Report: CtX: Critical to X ......................................................... 388
3.6.1.2.28.4 Report: FMEA: Failure Mode and Effects Analysis ............ 389
3.6.1.2.28.5 Report: Import overall process effectiveness data .......... 390
3.6.1.2.28.6 Report: Kaizen process mapping .......................................... 390
3.6.1.2.28.7 Report: Mark critical factors .................................................. 392
3.6.1.2.28.8 Report: Project charter ........................................................... 393
3.6.1.2.28.9 Report: Report overview ......................................................... 394
3.6.1.2.28.10 Report: SIPOC input/output matrix ...................................... 394
3.6.1.2.29 Time recording .................................................................................... 395
3.6.1.2.29.1 Report: Create organizational chart..................................... 395
3.6.1.2.30 User management .............................................................................. 396
3.6.1.2.30.1 Report: License audit (password-protected) .................... 396
3.6.1.2.30.2 Report: License usage rule validation .................................. 397
3.6.1.2.30.3 Report: Output logged-in users ............................................. 397
3.6.1.2.30.4 Report: Output overview of licenses.................................... 398
3.6.1.2.30.5 Report: Output user groups with users and privileges .... 399
3.6.1.2.30.6 Report: Output users and privileges .................................... 400
3.6.1.2.31 Variants.................................................................................................. 401
3.6.1.2.31.1 Report: Output models and variants ..................................... 401
3.6.1.2.31.2 Report: Output objects and variants.................................... 402
3.6.1.2.32 Visio import .......................................................................................... 403
3.6.1.2.32.1 Report: Import Visio files ........................................................ 403
3.6.1.2.33 webMethods Integration................................................................... 404
3.6.1.2.33.1 Report: Consistency check - Library ................................... 404
3.6.1.2.33.2 Report: Import all services from CentraSite ....................... 404
3.6.1.2.33.3 Report: Internal reset of a service or change request ..... 405
3.6.1.2.33.4 Report: Output database information ................................. 405
3.6.1.2.33.5 Report: Perform part layout after the transformation
from XPDL to BPMN ................................................................. 405
3.6.1.2.33.6 Report: Prescript - Share with IT .......................................... 405
3.6.1.2.33.7 Report: Run all requested Publisher exports ..................... 406
3.6.1.2.33.8 Report: Run requested Publisher exports for the
current database ...................................................................... 407
3.6.1.2.33.9 Report: Service request - Generate change request
document ................................................................................... 407
3.6.1.2.33.10 Report: Service request - Generate requirements
document ................................................................................... 407
3.6.1.2.33.11 Report: Service synchronization - Web service -
Service request notification completed.............................. 407
3.6.1.2.33.12 Report: Service synchronization - Web service -
Update service from CentraSite ........................................... 408
IX
3.6.1.2.33.13 Report: SWIT - BPMN consistency check............................ 408

3.6.1.2.33.14 Report: SWIT - Check whether starting the process is
possible....................................................................................... 408
3.6.1.2.33.15 Report: SWIT - Complete task................................................ 408
3.6.1.2.33.16 Report: SWIT - Document Solution Design ......................... 408
3.6.1.2.33.17 Report: SWIT - Library ............................................................. 408
3.6.1.2.33.18 Report: SWIT - Retrieve user tasks ....................................... 409
3.6.1.2.33.19 Report: SWIT - Web service - Check whether update
by IT is allowed .......................................................................... 409
3.6.1.2.33.20 Report: SWIT - Web service - Output process.................... 409
3.6.1.2.33.21 Report: SWIT - Web service - Retrieve ARIS version ........ 409
3.6.1.2.33.22 Report: SWIT - Web service - Retrieve CentraSite
connection ................................................................................. 409
3.6.1.2.33.23 Report: SWIT - Web service - Transfer ................................. 410
3.6.1.2.33.24 Report: SWIT - Web service - Transfer metadata ............... 410
3.6.1.2.33.25 Report: SWIT - Web service - Transfer process to ARIS ... 410
3.6.1.2.33.26 Report: Upload webMethods documentation to
document storage..................................................................... 410
3.6.1.2.33.27 Report: Validate BPMN diagram for sharing with IT .......... 410
3.6.1.2.33.28 Report: Validate filter for system check ...............................411
3.6.1.2.33.29 Report: XML layout ..................................................................... 411
3.6.1.2.33.30 Report: XML2BPMN2 pre-processing script ........................411
3.6.1.2.33.31 Report: XPDL2BPMN - post-processing script....................411
3.6.2 Macros ........................................................................................................................... 412
3.6.3 Semantic checks ........................................................................................................ 418
3.6.3.1 Profiles ............................................................................................................. 419
3.6.3.2 Rule types ........................................................................................................ 421
3.6.4 ARCM reports.............................................................................................................. 425
3.6.5 Common files ............................................................................................................... 427
3.6.6 Scheduled reports ..................................................................................................... 428
3.6.7 Fonts............................................................................................................................. 455
3.7 Manage documents ............................................................................................................. 456
3.7.1 Permanent documents ............................................................................................ 456
3.7.2 Temporary documents .............................................................................................. 457
3.7.3 Scheduled reports ..................................................................................................... 458
3.7.4 Display charts for documents ................................................................................ 458
3.7.5 Use ARIS document storage with WebDAV ......................................................... 458
3.7.6 Export statistics ......................................................................................................... 459
3.7.7 Use metadata ............................................................................................................. 459
3.7.7.1 Define custom metadata for documents ................................................ 460
3.7.7.2 Delete custom metadata............................................................................. 460
3.7.7.3 Display document properties ...................................................................... 461
3.7.7.4 Edit document properties ............................................................................ 461
3.7.7.5 Generate a dashboard link .......................................................................... 462
3.7.7.6 Edit document tags ...................................................................................... 463
3.7.7.7 Delete tags of a document ......................................................................... 463
3.7.7.8 Change the document owner .................................................................... 464
3.7.8 Use folders .................................................................................................................. 465
3.7.8.1 Create folder in ARIS document storage ................................................. 465
X
3.7.8.2 Display folder details .................................................................................... 465

3.7.8.3 Edit folder details .......................................................................................... 466
3.7.8.4 Folder Dashboarding .................................................................................... 466
3.7.8.5 Move folders in ARIS document storage ..................................................467
3.7.8.6 Manage folder access for user groups..................................................... 468
3.7.8.7 Manage folder access for users ................................................................ 469
3.7.8.8 Access privileges for folders ...................................................................... 470
3.7.8.9 Show assigned users or user groups ........................................................ 471
3.7.8.10 Exclude fold er(s) from search.................................................................... 472
3.7.8.11 Delete folder in ARIS document storage .................................................. 472
3.7.8.12 Charts for documents................................................................................... 473
3.7.8.12.1 'Number of documents' chart ........................................................... 473
3.7.8.12.2 'Used space' chart ............................................................................... 473
3.7.8.12.3 'Most viewed documents' chart .......................................................473
3.7.8.12.4 'Most changed documents' chart ....................................................473
3.7.8.12.5 'Largest documents' chart ................................................................ 473
3.7.8.12.6 'Latest documents' chart................................................................... 473
3.7.8.12.7 'Document status overview' chart ................................................. 474
3.7.8.12.8 'Outdated documents' chart ............................................................ 474
3.7.8.13 Options for models or objects .................................................................... 474
3.7.8.14 External document management systems............................................. 474
3.7.8.15 Delete and anonymize user accounts ...................................................... 474
3.7.9 Pages in ARIS document storage ........................................................................... 475
3.7.9.1 ARIS document storage attribute types................................................... 475
3.7.9.2 Document details ........................................................................................... 476
3.7.9.3 Document history .......................................................................................... 477
3.7.9.4 Document relations ...................................................................................... 478
3.7.9.5 Document versions ....................................................................................... 479
3.7.9.6 Folder access privileges for user groups ................................................ 480
3.7.9.7 Folder access privileges for users ............................................................. 481
3.7.9.8 Folder ............................................................................................................... 482
3.7.9.9 Folder details ................................................................................................. 483
3.7.9.10 Folder history ................................................................................................. 484
3.7.9.11 Select document page ................................................................................ 485
3.7.9.12 Select tags page ........................................................................................... 486
3.7.9.13 Upload document page ............................................................................... 487
3.7.10 Configure Document storage ................................................................................. 488
3.7.10.1 Import configuration .................................................................................... 488
3.7.10.2 Export configuration .................................................................................... 489
3.7.10.3 Customize infrastructure settings ........................................................... 489
3.7.10.4 Add third-party document management system - Basic Auth ......... 490
3.7.10.5 Add a third-party document management system - OAuth ............... 491
3.7.10.6 Test connection to a third-party document management system .. 493
3.7.10.7 Edit document management system ....................................................... 493
3.7.10.8 Delete third-party document management system............................. 494
3.7.10.9 Customize quota and restrictions............................................................. 495
3.7.10.10 Configure full-text search .......................................................................... 495
3.7.10.11 Configure WebDAV ....................................................................................... 496
XI
3.8 Manage portal ........................................................................................................................ 497

3.8.1 Publish databases ...................................................................................................... 497
3.8.2 Change sort order of published databases ......................................................... 498
3.8.3 Specify a default database...................................................................................... 498
3.8.4 Allow model comparison .......................................................................................... 499
3.9 Configure the user interface .............................................................................................. 501
3.9.1 Create modification set ............................................................................................. 501
3.9.2 Duplicate modification set ...................................................................................... 502
3.9.3 Save ARIS modification set ..................................................................................... 503
3.9.4 Restore ARIS modification set ................................................................................ 503
3.9.5 Select modification set ............................................................................................ 504
3.9.6 Rename modification set ......................................................................................... 505
3.9.7 Edit modification set ................................................................................................. 505
3.9.7.1 Edit user interface ........................................................................................ 506
3.9.7.1.1 Customize font and colors ............................................................... 506
3.9.7.1.2 Restore default font and color ........................................................ 509
3.9.7.1.3 Select languages ................................................................................. 510
3.9.7.1.4 Upload logo ............................................................................................ 511
3.9.7.1.5 Restore default logo ........................................................................... 512
3.9.7.1.6 Customize the header ........................................................................ 512
3.9.7.1.7 Customize the sidebars ..................................................................... 513
3.9.7.1.8 Advanced customization ................................................................... 515
3.9.7.1.8.1 Customize 'Home' elements ................................................... 515
3.9.7.1.8.2 Customize Fact sheets (Overview, Steps) ........................... 516
3.9.7.1.8.3 Customize 'Steps' ...................................................................... 518
3.9.7.1.8.4 Customize buttons .................................................................. 520
3.9.7.1.8.5 Customize font sizes in general ............................................. 521
3.9.7.1.8.6 Customize ARIS Process Board ............................................ 522
3.9.7.1.8.7 Customize Legacy settings.................................................... 523
3.9.7.2 Manage Fact sheets ..................................................................................... 524
3.9.7.2.1 Define layout ....................................................................................... 524
3.9.7.2.2 Add fact sheet ..................................................................................... 525
3.9.7.2.3 Add fact sheet for a new item ......................................................... 526
3.9.7.2.4 Change order of fact sheets globally ............................................. 526
3.9.7.2.5 Change order of fact sheets for an item ........................................ 527
3.9.7.2.6 Delete fact sheet ................................................................................ 528
3.9.7.2.7 Edit fact sheet ..................................................................................... 529
3.9.7.2.7.1 Customize fonts and colors ................................................... 530
3.9.7.2.7.2 Customize icons and text ........................................................ 531
3.9.7.2.7.3 Enable/Disable toolbars for a fact sheet ............................ 533
3.9.7.2.7.4 Add a subordinate sheet to a fact sheet ............................ 533
3.9.7.2.7.5 Change order of the subordinate sheets ............................ 534
3.9.7.2.7.6 Remove a subordinate sheet from a fact sheet ................ 535
3.9.7.2.7.7 Edit a property of ItemList type of the Overview tab....... 536
3.9.7.2.7.8 Edit a property for a single value of the Overview tab ..... 537
3.9.7.2.7.9 What can be configured in fact sheets? ............................. 538
3.9.7.2.7.10 Dashboards................................................................................ 539
3.9.7.2.7.11 Mini fact sheets ........................................................................ 539
XII
3.9.7.2.7.11.1 Enable mini fact sheets ................................................ 539

3.9.7.2.7.11.2 Customize display options and properties ............... 540
3.9.7.2.7.11.3 Change property order for mini fact sheets ............. 541
3.9.7.2.7.11.4 Delete property from mini fact sheet ........................ 542
3.9.7.3 Edit 'Home' ..................................................................................................... 543
3.9.7.3.1 Edit the background .......................................................................... 544
3.9.7.3.2 Add 'My contacts' component ......................................................... 545
3.9.7.3.3 Add 'Diagram' component ................................................................ 546
3.9.7.3.4 Add 'Recent changes' component................................................... 547
3.9.7.3.5 Add 'Quick links' component ............................................................ 548
3.9.7.3.6 Add external web page ..................................................................... 549
3.9.7.3.7 Add 'My favorites' component ......................................................... 550
3.9.7.3.8 Add 'What's new' component........................................................... 550
3.9.7.3.9 Add 'Dashboard' component ............................................................ 551
3.9.7.3.10 Edit a component of the 'Home' tab............................................... 552
3.9.7.3.11 Delete a component from the 'Home' tab ..................................... 553
3.9.7.4 Manage items ................................................................................................ 554
3.9.7.4.1 Find item identifier ............................................................................. 554
3.9.7.4.2 Add items ............................................................................................. 555
3.9.7.4.3 Edit items ............................................................................................. 556
3.9.7.4.4 Add item properties ............................................................................ 557
3.9.7.4.5 Edit item properties ........................................................................... 558
3.9.7.4.6 Property templates ............................................................................ 559
3.9.7.4.7 Allow Connect Viewer users to edit ............................................... 560
3.9.7.4.8 ARIS Viewer Contribution ................................................................. 562
3.9.7.5 Manage plugins ............................................................................................. 564
3.9.7.5.1 Activate a plugin ................................................................................. 564
3.9.7.5.2 States for plugins ............................................................................... 565
3.9.7.6 Manage hierarchies ...................................................................................... 566
3.9.7.6.1 Create navigation hierarchy ............................................................ 566
3.9.7.6.2 Edit navigation hierarchy .................................................................. 567
3.9.7.6.3 Enable navigation hierarchy ............................................................ 568
3.9.7.6.4 Disable navigation hierarchy ........................................................... 569
3.9.7.6.5 Delete navigation hierarchy ..............................................................570
3.9.7.6.6 What does the navigation hierarchy define?.................................570
3.9.7.6.7 What to remember regarding hierarchies? .................................... 572
3.9.7.6.8 Hierarchy root element ...................................................................... 573
3.9.7.7 Edit components ............................................................................................ 573
3.9.7.7.1 Customize diagrams ........................................................................... 573
3.9.7.7.1.1 Customize name and languages............................................ 574
3.9.7.7.1.2 Customize display options ...................................................... 574
3.9.7.7.1.3 Enable/Disable the Hide non-configured objects
functionality ...............................................................................578
3.9.7.7.1.4 Enable/Disable the change view functionality.................. 580
3.9.7.7.1.5 Restore ARIS default settings ................................................ 581
3.9.7.7.2 Customize extended search component ...................................... 582
3.9.7.7.2.1 Add items and properties to filter ........................................ 582
XIII
3.9.7.7.2.2 Change order of filter items and properties ....................... 583

3.9.7.7.2.3 Remove items and properties from filter ............................ 583
3.9.7.7.3 Customize mini fact sheets.............................................................. 584
3.9.7.7.3.1 Customize white list for mini fact sheets ........................... 585
3.9.7.7.3.2 Customize display options and properties ......................... 586
3.9.7.7.3.3 Change property order for mini fact sheets .......................587
3.9.7.7.3.4 Delete property from mini fact sheet .................................. 588
3.9.7.7.3.5 Mini fact sheets ........................................................................ 589
3.9.7.7.4 Customize steps ................................................................................. 589
3.9.7.7.4.1 Exclude symbols ....................................................................... 590
3.9.7.7.4.2 Include excluded symbols again ............................................ 591
3.9.7.7.4.3 Add group property .................................................................. 591
3.9.7.7.4.4 Change order of the properties............................................. 592
3.9.7.7.4.5 Customize colors for steps .................................................... 593
3.10 Administrate automated processes ................................................................................ 595
3.10.1 Open process administration .................................................................................. 595
3.10.2 What is 'Process administration' used for ............................................................ 595
3.10.2.1 What does 'Activities' provide? .................................................................. 596
3.10.2.2 What does 'Archive' and 'Archive history' provide? ............................... 597
3.10.2.3 What does 'Assignments' provide? ............................................................ 597
3.10.2.4 What does 'Console' provide? .................................................................... 598
3.10.2.5 What does 'Context' provide? .................................................................... 598
3.10.2.6 What does 'Details' provide?....................................................................... 598
3.10.2.7 What does 'Diagram' provide? .................................................................... 599
3.10.2.8 What does 'History' provide? ...................................................................... 599
3.10.2.9 What does 'Human task' provide? ............................................................. 600
3.10.2.10 What does 'Instances' provide? .................................................................. 601
3.10.2.11 What does 'Variables' provide? ................................................................... 601
3.10.3 Tasks of the Process Governance administrator ............................................... 602
3.10.4 Find process instances ............................................................................................ 603
3.10.5 Deploy executable processes ................................................................................. 603
3.10.6 Start governance process in process administration ....................................... 604
3.10.7 How many process instances can be started? ................................................... 605
3.10.8 Where can the executable process be started? ................................................. 605
3.10.9 What is an executable process? ............................................................................. 605
3.10.10 Context for executable processes......................................................................... 606
3.10.11 Export process administration content as a CSV file ........................................ 606
3.10.12 Send reminder about executing human task ...................................................... 607
3.10.13 Suspend/resume execution of process instance .............................................. 607
3.10.14 Terminate execution of process instance ........................................................... 608
3.10.15 Suspend/resume recurrence for executable process ...................................... 609
3.10.16 Delete executable process ....................................................................................... 610
3.10.17 Suspend, resume, or terminate simulation runs ................................................. 610
3.10.18 Use process instance archive .................................................................................. 612
3.10.19 Prioritize and deprioritize process instances ....................................................... 614
3.10.20 How to handle large volume data ........................................................................... 615
3.10.21 What is the escalation manager? ............................................................................ 615
3.10.22 Find and correct problems in processes ............................................................... 615
XIV
3.10.22.1 List processes and display instance/version .......................................... 616

3.10.22.2 Review input and output data of activity ................................................. 617
3.10.22.3 Restart failed activities................................................................................. 618
3.10.22.4 Skip failed activities ...................................................................................... 619
3.10.22.5 Skip human tasks .......................................................................................... 620
3.10.22.6 Correct and restart failed process instances .......................................... 621
3.10.22.7 Re-trigger failed process instances ......................................................... 622
3.10.23 Display information ................................................................................................... 623
3.10.23.1 Display information about executable processes ................................. 623
3.10.23.2 Display information about activities......................................................... 624
3.10.23.3 Display human tasks of process instances............................................. 625
3.10.23.4 Display information about variables ......................................................... 626
3.10.23.5 Display and delegate executors of human tasks................................... 626
3.10.23.6 Which status can activities have?............................................................. 628
3.10.23.7 Which status can process instances have? ............................................ 629
3.10.23.8 Statuses in My tasks .................................................................................... 630
3.10.24 Handle simulation ....................................................................................................... 631
3.10.24.1 Display simulation information ................................................................... 631
3.10.24.2 Release simulated process ......................................................................... 632
3.10.24.3 Delete simulation runs ................................................................................. 632
3.10.25 Configure Process Governance.............................................................................. 633
3.10.25.1 Import configuration .................................................................................... 633
3.10.25.2 Export configuration .................................................................................... 634
3.10.25.3 Set up sending notifications to Process Governance
administrators ............................................................................................... 634
3.10.25.4 Customize notification settings ................................................................ 635
3.10.25.5 Enable/Disable HTML e-mail notifications.............................................. 635
3.10.25.6 Customize HTML templates for e-mail notifications ......................... 636
3.10.25.7 What variables can you use? ....................................................................... 637
3.10.25.8 Usable tags..................................................................................................... 638
3.10.25.9 List of allowed attributes inside each tag ............................................... 640
3.10.25.10 Customize infrastructure settings ........................................................... 640
3.10.25.11 Customize Publishing ................................................................................... 641
3.10.25.12 Customize Reporting ................................................................................... 642
3.10.25.13 Customize workflow policies...................................................................... 642
3.10.25.14 Customize pools ............................................................................................ 643
3.10.25.15 Customize user interface ............................................................................ 644
3.11 Administrate Collaboration ................................................................................................ 645
3.11.1 Open Collaboration .................................................................................................... 645
3.11.2 Privileges of coordinators and administrators.................................................... 646
3.11.3 Check activities flagged as inappropriate............................................................. 647
3.11.4 Manage portal feeds .................................................................................................. 647
3.11.5 Synchronize access privileges ............................................................................... 648
3.11.6 Database access privileges for Collaboration ..................................................... 649
3.11.7 What is the synchronization user? ........................................................................ 649
3.11.8 Manage announcements ......................................................................................... 650
3.11.9 Configure ARIS document storage user............................................................... 650
3.11.10 Configure database user .......................................................................................... 651
3.11.11 Display dashboards ................................................................................................... 652
XV
3.11.12 Clean up and export activities ................................................................................ 653

3.11.13 Configure notifications ............................................................................................ 653
3.11.14 Customize e-mail notifications .............................................................................. 654
3.11.15 Delete and anonymize user accounts................................................................... 655
3.11.16 Keyboard shortcuts for Collaboration................................................................... 656
3.11.17 Configure Collaboration ............................................................................................ 657
3.11.17.1 Customize Collaboration .............................................................................. 657
3.11.17.2 Refresh list of published databases .......................................................... 657
3.11.17.3 Synchronize databases ............................................................................... 658
3.12 Integrate ARIS and ARIS Process Mining........................................................................ 659
3.12.1 Prerequisites............................................................................................................... 660
3.12.2 Configure the integration ........................................................................................ 660
3.12.3 Configure the transfer of ARIS users to ARIS Process Mining ........................ 669
3.12.3.1 Enable the identity management service ............................................... 669
3.12.3.2 Configure the identity management service .......................................... 671
3.12.4 Transfer ARIS users to ARIS Process Mining ........................................................ 673
3.12.5 Configure login to ARIS using ARIS Process Mining credentials .....................674
3.12.5.1 Configure login with ARIS Process Mining credentials ......................... 675
3.13 Manage SAP Solutions ......................................................................................................... 679
3.13.1 Import configuration set providing SAP content ................................................ 679
3.13.2 Select the View Providing SAP Content ............................................................... 680
3.13.3 Configure ARIS Online Guide.................................................................................... 681
3.13.4 Publish databases in ARIS (ARIS Online Guide) .................................................. 682
3.13.5 Make log files available ............................................................................................. 682
3.14 Enable SAP® Enable Now .................................................................................................. 683
3.15 Manage configuration languages..................................................................................... 684
3.16 Configure content types .................................................................................................... 684
3.16.1 Enable content type configuration ....................................................................... 685
3.16.2 Open content types page ........................................................................................ 685
3.16.3 Create content type set ........................................................................................... 686
3.16.4 Copy a content type set ........................................................................................... 686
3.16.5 Import content types set ......................................................................................... 687
3.16.6 Export a set of content types ................................................................................. 687
3.16.7 Activate a set of content types .............................................................................. 688
3.16.8 Deactivate a set of content types ......................................................................... 688
3.16.9 Display and edit content types set details .......................................................... 689
3.16.10 Edit a content type set ............................................................................................. 689
3.16.10.1 Models ............................................................................................................. 690
3.16.10.1.1 Add model content types ................................................................. 690
3.16.10.1.2 Edit model content types .................................................................. 691
3.16.10.1.3 Remove model types ......................................................................... 692
3.16.10.1.4 Delete model content type ............................................................... 693
3.16.10.2 Objects ............................................................................................................ 693
3.16.10.2.1 Add object content types ................................................................. 693
3.16.10.2.2 Add derived symbols ......................................................................... 695
3.16.10.2.3 Edit object content types ................................................................. 695
3.16.10.2.4 Remove object types .......................................................................... 697
XVI
3.16.10.2.5 Delete object content type ............................................................... 697

3.16.10.3 Connections ................................................................................................... 698
3.16.10.3.1 Add connection content types ........................................................ 698
3.16.10.3.2 Edit connection content types ........................................................ 699
3.16.10.3.3 Remove connection types ................................................................ 700
3.16.10.3.4 Delete connection content type ..................................................... 700
3.16.10.4 Properties groups .......................................................................................... 701
3.16.10.4.1 Add property group ............................................................................. 701
3.16.10.4.2 Edit a property group.......................................................................... 702
3.16.10.4.3 Move property group .......................................................................... 702
3.16.10.4.4 Delete a property group .................................................................... 703
3.16.10.5 Properties ....................................................................................................... 704
3.16.10.5.1 Add attribute property ...................................................................... 704
3.16.10.5.2 Add relation........................................................................................... 705
3.16.10.5.3 Add XML property ................................................................................ 707
3.16.10.5.4 Edit a property..................................................................................... 708
3.16.10.5.5 Display usage of properties ..............................................................709
3.16.10.5.6 Move property ...................................................................................... 709
3.16.10.5.7 Move property to a different group ................................................. 710
3.16.10.5.8 Delete a property ................................................................................. 710
3.16.10.6 Hierarchies ....................................................................................................... 711
3.16.10.6.1 Import a hierarchy ................................................................................ 711
3.16.10.6.2 Copy a hierarchy ................................................................................... 711
3.16.10.6.3 Create a hierarchy ............................................................................... 712
3.16.10.6.4 Display and edit hierarchy details.................................................... 713
3.16.10.6.5 Activate a hierarchy............................................................................ 714
3.16.10.6.6 Deactivate a hierarchy ....................................................................... 714
3.16.10.6.7 Add hierarchy root .............................................................................. 715
3.16.10.6.8 Display and edit root details.............................................................. 715
3.16.10.6.9 Define start elements ......................................................................... 716
3.16.10.6.10 Add a hierarchy child item to a hierarchy ....................................... 717
3.16.10.6.11 Display and edit hierarchy item details .......................................... 718
3.16.10.6.12 Display and edit hierarchy item/property details ........................ 718
3.16.10.6.13 Add a navigation child to a hierarchy ............................................. 719
3.16.10.6.14 Display and edit navigation item details ........................................720
3.16.10.6.15 Delete an item ...................................................................................... 720
3.16.10.6.16 Delete a hierarchy ............................................................................... 721
3.16.10.7 Portal search ................................................................................................... 722
3.16.10.7.1 Import a search .................................................................................... 722
3.16.10.7.2 Add item to search .............................................................................. 722
3.16.10.7.3 Move search item ................................................................................ 723
3.16.10.7.4 Delete item from search .................................................................... 724
3.16.11 Delete a content type set ......................................................................................... 724
3.17 Configure ARIS Method ....................................................................................................... 725
3.17.1 Model types .................................................................................................................. 725
3.17.1.1 Create model type ......................................................................................... 727
3.17.1.2 Use other attributes in model types ......................................................... 730
XVII
3.17.1.3 Use other symbols in model types ............................................................. 731

3.17.1.4 Change 'Structural' setting for model type ............................................. 732
3.17.1.5 Change 'Default' setting for model type................................................... 733
3.17.1.6 What is a default symbol? ............................................................................ 734
3.17.1.7 Use other connections in model types .....................................................734
3.17.1.8 Get information about object symbols and connections ..................... 736
3.17.1.9 Rename model type in all languages ......................................................... 737
3.17.1.10 Rename model type in current language ................................................ 738
3.17.1.11 Reset model type name in current language .......................................... 739
3.17.1.12 Reset model type .......................................................................................... 740
3.17.1.13 Delete model type .......................................................................................... 741
3.17.2 Object types ................................................................................................................. 742
3.17.2.1 Modify object type ......................................................................................... 743
3.17.2.2 Use other attributes in object types.......................................................... 745
3.17.2.3 Assign other models to object types......................................................... 746
3.17.2.4 Change 'Insert object' setting for object assignment .......................... 748
3.17.2.5 Change 'Unique' setting for object assignment .....................................749
3.17.2.6 Rename object type in all languages ........................................................750
3.17.2.7 Rename object type in current language ................................................. 751
3.17.2.8 Reset object type name in current language .......................................... 752
3.17.2.9 Reset object type ........................................................................................... 753
3.17.3 Object symbols ............................................................................................................ 754
3.17.3.1 Derive object symbols .................................................................................. 756
3.17.3.2 Use other symbol graphics for object types ...........................................758
3.17.3.3 Use other symbols for object types........................................................... 759
3.17.3.4 Change 'Structural' setting for object symbol ....................................... 760
3.17.3.5 Change 'Default' setting for object symbol ............................................. 761
3.17.3.6 Rename object symbol in all languages ................................................... 762
3.17.3.7 Rename object symbols in current language .......................................... 763
3.17.3.8 Reset object symbol name in current language .....................................764
3.17.3.9 Reset object symbol ...................................................................................... 765
3.17.3.10 Delete object symbol .................................................................................... 766
3.17.4 Connection types ....................................................................................................... 767
3.17.4.1 Modify connection type................................................................................ 769
3.17.4.2 Use other attributes in connection types ................................................. 771
3.17.4.3 Assign other models to connection types ............................................... 772
3.17.4.4 Change 'Insert object' setting for connection assignment .................. 773
3.17.4.5 Change 'Unique' setting for connection assignment ............................ 774
3.17.4.6 Rename connection types in all languages ............................................. 775
3.17.4.7 Rename connection type in current language ....................................... 776
3.17.4.8 Reset connection type name in current language ................................. 777
3.17.4.9 Reset connection type ................................................................................. 778
3.17.5 Attribute types ............................................................................................................ 779
3.17.5.1 Create attribute type ................................................................................... 780
3.17.5.2 Add default values to attribute types ...................................................... 786
3.17.5.3 Rename default values ................................................................................. 787
3.17.5.4 Assign attribute symbols ............................................................................ 788
3.17.5.5 Move an attribute type to an attribute type group ................................789
3.17.5.6 Use attribute type in other models ............................................................ 791
XVIII
3.17.5.7 Use attribute type in other objects............................................................ 792

3.17.5.8 Use attribute type in other connections .................................................. 793
3.17.5.9 Rename attribute type in all languages .................................................... 794
3.17.5.10 Rename attribute type in current language ............................................ 795
3.17.5.11 Reset attribute type name in current language ..................................... 796
3.17.5.12 Reset Attribute type...................................................................................... 797
3.17.5.13 Delete attribute type ..................................................................................... 798
3.17.6 Attribute type groups ................................................................................................ 799
3.17.6.1 Create attribute type group ........................................................................ 801
3.17.6.2 Move attribute type group .......................................................................... 803
3.17.6.3 Add attribute type to attribute type group ............................................. 804
3.17.6.4 Rename attribute type group in current language ............................... 805
3.17.6.5 Reset attribute type group name in current language ........................ 806
3.17.6.6 Rename attribute type group in all languages ....................................... 807
3.17.6.7 Reset attribute type group ......................................................................... 808
3.17.6.8 Delete attribute type group ........................................................................ 809
3.17.7 Attribute symbols ....................................................................................................... 810
3.17.7.1 Derive attribute symbols ...............................................................................811
3.17.7.2 Change attribute symbol ............................................................................. 812
3.17.7.3 Rename attribute symbol in current language ....................................... 813
3.17.7.4 Reset attribute symbol name in current language ................................ 814
3.17.7.5 Rename attribute symbol in all languages ............................................... 814
3.17.7.6 Reset attribute symbol ................................................................................. 815
3.17.7.7 Delete attribute symbol ................................................................................ 816
3.17.8 Make method extensions available......................................................................... 817
3.17.9 Reset method items ................................................................................................... 817
3.17.10 Restore ARIS Method ................................................................................................. 818
3.17.11 Filters............................................................................................................................. 819
3.17.11.1 Import filter .................................................................................................... 820
3.17.11.2 Create filter .................................................................................................... 820
3.17.11.2.1 Create filter based on a database .................................................... 821
3.17.11.2.2 Merge filters ......................................................................................... 822
3.17.11.2.3 Create a filter from scratch .............................................................. 823
3.17.11.2.4 Assign filter to users .......................................................................... 830
3.17.11.3 Export filter ..................................................................................................... 831
3.17.11.4 Copy filter ....................................................................................................... 832
3.17.11.5 Rename filter ................................................................................................. 833
3.17.11.6 Edit filter ......................................................................................................... 834
3.17.11.6.1 Modify filter settings .......................................................................... 835
3.17.11.6.1.1 Change set of model types .................................................... 835
3.17.11.6.1.2 Change set of object types .................................................... 836
3.17.11.6.1.3 Change set of connection types........................................... 838
3.17.11.6.1.4 Change set of object symbols used in model types
(filter) .......................................................................................... 839
3.17.11.6.1.5 Change object symbol sorting (filter) .................................. 840
3.17.11.6.1.6 Change attribute sorting (filter)............................................. 841
3.17.11.6.1.7 Change set of connection types used in model types
(filter) .......................................................................................... 842
XIX
3.17.11.6.1.8 Change the set of allowed model types .............................. 844

3.17.11.6.1.9 Change the set of connection assignments (filter).......... 845
3.17.11.6.1.10 Change the set of model attributes (filter) ........................ 846
3.17.11.6.1.11 Change the set of object attributes (filter) ........................ 848
3.17.11.6.1.12 Change the set of connection attributes (filter) ............... 849
3.17.11.6.1.13 Rename filter in all languages ............................................... 850
3.17.11.7 Delete filter ...................................................................................................... 851
3.18 Manage model templates ................................................................................................... 852
3.18.1 Applied templates...................................................................................................... 852
3.18.2 Available templates ................................................................................................... 854
3.18.2.1 Change settings ............................................................................................. 861
3.18.3 Font formats (Templates) ........................................................................................ 865
3.19 Manage configuration sets ................................................................................................ 866
3.19.1 Save configuration set ............................................................................................. 866
3.19.2 Duplicate configuration set..................................................................................... 867
3.19.3 Restore configuration set ........................................................................................ 867
3.19.4 Delete configuration set .......................................................................................... 868
3.19.5 What to consider with customized configuration sets? ................................... 868
3.19.6 What are the special features in terms of languages? ...................................... 869
3.20 Manage applications ........................................................................................................... 870
3.20.1 Applications ................................................................................................................ 870
3.20.1.1 Create application ........................................................................................ 870
3.20.1.2 Edit application............................................................................................... 871
3.20.1.3 Create or edit ARIS Process Mining application ......................................872
3.20.1.4 Display application details .......................................................................... 873
3.20.1.5 Generate client ID and client secret ......................................................... 873
3.20.1.6 Refresh application list ................................................................................ 874
3.20.1.7 Display active sessions ............................................................................... 874
3.20.1.8 Refresh active sessions .............................................................................. 874
3.20.1.9 Terminate all active sessions ......................................................................875
3.20.1.10 Display history ................................................................................................875
3.20.1.11 Refresh application history ........................................................................ 876
3.20.1.12 Delete application ......................................................................................... 876
3.20.2 Scopes........................................................................................................................... 877
3.20.2.1 Display scope details ................................................................................ 878
3.20.2.2 Display history ............................................................................................... 878
3.20.2.3 Refresh scope history ................................................................................... 879
3.20.3 APIs ............................................................................................................................... 880
3.20.3.1 Display API details ......................................................................................... 881
3.20.3.2 Display history ................................................................................................ 881
3.20.3.3 Refresh API history ...................................................................................... 882
3.21 Manage server tasks ........................................................................................................... 883
3.21.1 Display server tasks .................................................................................................. 883
3.21.2 Server tasks area ....................................................................................................... 883
3.21.3 Running tasks list ...................................................................................................... 884
3.21.4 Completed tasks list.................................................................................................. 885
3.21.5 Toggle auto-refresh .................................................................................................. 885
XX
3.21.6 Cancel report .............................................................................................................. 886

3.22 Manage ARIS Server and tenants..................................................................................... 887
3.22.1 ARIS Cloud Controller (ACC).................................................................................... 887
3.22.1.1 How to start ARIS Cloud Controller (ACC) ............................................... 888
3.22.1.2 How to connect nodes................................................................................. 890
3.22.1.3 How to list runnables .................................................................................... 891
3.22.1.4 How to handle special characters............................................................. 892
3.22.1.5 What runnables are available? ................................................................... 893
3.22.1.6 Security advice ............................................................................................... 897
3.22.1.6.1 Safety recommendation: Block AJP ports ....................................897
3.22.1.6.2 Check open AJP ports (Ghostcat vulnerability) .......................... 898
3.22.1.7 Use cases......................................................................................................... 901
3.22.1.7.1 Change the default agent user's password .................................. 901
3.22.1.7.2 Start and stop runnables .................................................................. 902
3.22.1.7.3 Deactivate runnable .......................................................................... 902
3.22.1.7.4 Activate runnable ............................................................................... 903
3.22.1.7.5 Provide additional memory .............................................................. 903
3.22.1.7.6 Reconfigure autostart settings ....................................................... 904
3.22.1.7.7 Make TLS certificate available for ARIS Server ............................ 905
3.22.1.7.8 Redirect ports...................................................................................... 906
3.22.1.7.9 Redirect HTTPS port ........................................................................... 907
3.22.1.7.10 Collect log files (ACC) ........................................................................ 908
3.22.1.7.11 Delete log files ..................................................................................... 909
3.22.1.7.12 ARIS Administration/ARIS Risk and Compliance.......................... 910
3.22.1.7.12.1 Specify a white list for ARIS Administration ....................... 910
3.22.1.7.12.2 Use existing ARIS document storage and ARIS
Administration for ARIS Risk and Compliance ..................... 911
3.22.1.7.13 Process Governance ............................................................................ 911
3.22.1.7.14 ARIS Aware ............................................................................................ 911
3.22.1.7.14.1 Make enhancements available ............................................... 912
3.22.1.7.15 ARIS Publisher ...................................................................................... 913
3.22.1.7.15.1 Provide ARIS Publisher license files ...................................... 913
3.22.1.7.15.2 Reconfigure settings ................................................................ 914
3.22.1.7.15.3 Configure the service 'Create static ARIS Publisher
export' for Process Governance ............................................ 915
3.22.1.7.16 Collaboration ........................................................................................ 916
3.22.1.7.16.1 Specify a black list for Collaboration .................................... 916
3.22.1.7.16.2 Create synchronization user .................................................. 917
3.22.1.7.16.3 Anonymize Collaboration user ............................................... 917
3.22.1.7.16.4 Force synchronize Collaboration users ................................ 918
3.22.1.7.17 Tenant Management........................................................................... 919
3.22.1.7.17.1 Create a tenant .......................................................................... 919
3.22.1.7.17.2 Back up a tenant ...................................................................... 920
3.22.1.7.17.3 Delete a tenant ......................................................................... 923
3.22.1.7.17.4 Restore a tenant ....................................................................... 925
3.22.1.7.17.5 What data is backed up and restored? ................................ 926
3.22.1.7.17.6 Copy a tenant to a different server ...................................... 928
XXI
3.22.1.7.17.7 How to adjust timestamps related to ARIS document

storage........................................................................................ 930
3.22.1.7.18 Database connection.......................................................................... 931
3.22.1.7.18.1 Provide JDBC drivers ............................................................... 931
3.22.1.7.18.2 Update external service (database clusters) ..................... 932
3.22.1.7.18.3 Configure the database connection for additional
schemes ..................................................................................... 932
3.22.1.7.18.4 Move the database management system .......................... 934
3.22.1.7.19 Elasticsearch ....................................................................................... 936
3.22.1.7.19.1 Check user name and password (Elasticsearch) .............. 936
3.22.1.7.19.2 Change user name and password (Elasticsearch) ............ 937
3.22.1.7.19.3 Disable authentication for Elasticsearch ............................ 938
3.22.1.7.20 Health check ........................................................................................ 939
3.22.1.7.20.1 Show node ................................................................................. 939
3.22.1.7.20.2 Monitor runnable's health ...................................................... 940
3.22.1.7.20.3 Configure health monitoring ................................................. 942
3.22.1.7.21 Mailing ................................................................................................... 945
3.22.1.7.21.1 Configure ARIS Agent mail server connection .................. 945
3.22.1.7.21.2 Configure SMTP mail server connection............................. 948
3.22.1.7.22 Third-party document management systems (TDMS) .............. 950
3.22.1.7.22.1 Make TDMS available ............................................................... 950
3.22.2 Tenant Management tool.......................................................................................... 951
3.22.2.1 Open Tenant Management ......................................................................... 952
3.22.2.2 Manage tenants ............................................................................................ 953
3.22.2.2.1 Create tenant ...................................................................................... 953
3.22.2.2.2 Lock tenant .......................................................................................... 954
3.22.2.2.3 Activate tenant ................................................................................... 954
3.22.2.2.4 Allow access ........................................................................................ 954
3.22.2.2.5 Copy tenant ......................................................................................... 955
3.22.2.2.6 Back up tenant .................................................................................... 955
3.22.2.2.7 Download last backup file................................................................. 956
3.22.2.2.8 Download specific backup file .......................................................... 957
3.22.2.2.9 Restore tenants ................................................................................... 957
3.22.2.2.9.1 Restore tenant from backup file ........................................... 958
3.22.2.2.9.2 Restore tenant from backup list (from Tenants page) .... 959
3.22.2.2.9.3 Restore tenant from backup list (from Backups page) .... 961
3.22.2.2.10 Delete tenant ....................................................................................... 962
3.22.2.2.11 Manage filters ...................................................................................... 963
3.22.2.2.11.1 Copy filters ................................................................................ 963
3.22.2.2.11.2 Export filters .............................................................................. 964
3.22.2.2.11.3 Import filters .............................................................................. 964
3.22.2.2.11.4 What are filters?........................................................................ 965
3.22.2.2.12 Manage templates .............................................................................. 966
3.22.2.2.12.1 Copy templates......................................................................... 966
3.22.2.2.12.2 Export templates ....................................................................... 967
3.22.2.2.12.3 Import templates ....................................................................... 967
XXII
3.22.2.2.12.4 Use templates ........................................................................... 968

3.22.2.2.13 Manage reports and related files .................................................... 969
3.22.2.2.13.1 Copy reports .............................................................................. 969
3.22.2.2.13.2 Export reports ............................................................................ 970
3.22.2.2.13.3 Import reports ............................................................................ 971
3.22.2.2.13.4 Copy files..................................................................................... 971
3.22.2.2.13.5 Export files .................................................................................. 972
3.22.2.2.13.6 Import files .................................................................................. 973
3.22.2.2.13.7 What is an ARIS report? ........................................................... 974
3.22.2.2.14 Manage databases .............................................................................. 976
3.22.2.2.14.1 Copy databases ......................................................................... 976
3.22.2.2.14.2 Export databases ...................................................................... 977
3.22.2.2.14.3 Import databases ......................................................................978
3.22.2.3 Manage backups ............................................................................................ 979
3.22.2.3.1 Define backup folder .......................................................................... 979
3.22.2.3.2 Open backup list .................................................................................. 979
3.22.2.3.3 Delete backup file ............................................................................... 980
3.22.2.4 Manage schedules ........................................................................................ 980
3.22.2.4.1 Enter backup options ........................................................................ 980
3.22.2.4.2 Create schedule ................................................................................... 981
3.22.2.4.3 Edit schedule ....................................................................................... 982
3.22.2.4.4 Lock schedule ..................................................................................... 982
3.22.2.4.5 Activate schedule............................................................................... 983
3.22.2.4.6 Delete schedule .................................................................................. 983
3.22.2.5 Display charts ................................................................................................ 983
3.22.2.6 Open user management .............................................................................. 984
3.22.2.7 Open portal management ........................................................................... 984
3.22.2.8 Log out ............................................................................................................ 984
3.22.2.9 Configure Tenant Management ................................................................ 985
3.22.2.9.1 Configure infrastructure tenant ..................................................... 985
3.22.2.9.2 Configure user for impersonation .................................................. 986
3.22.2.9.3 Configure operational tenants .........................................................987
3.22.2.9.4 Configure existing tenants............................................................... 989
3.22.2.10 Good to know ................................................................................................. 990
3.22.2.10.1 How to manage logged information ............................................... 990
3.22.2.10.2 How to adjust timestamps related to ARIS document
storage .................................................................................................. 990
3.22.2.10.3 Which users can manage tenants? ................................................. 991
3.22.2.10.4 What privileges and settings does the user 'superuser'
require? .................................................................................................. 991
3.22.2.10.5 What privileges and settings does an authorized user
require? ................................................................................................. 992
3.22.2.10.6 Impersonation ..................................................................................... 994
3.22.2.10.7 What data is backed up and restored? .......................................... 995
3.22.2.10.8 What is the Tenants page used for? ................................................ 997
3.22.2.10.9 What is the Assets page used for? ............................................... 1000
3.22.2.10.10 What is the Backups page used for? ............................................ 1000
3.22.2.10.11 What is the Schedules page used for?......................................... 1002
XXIII
3.22.2.10.12 Where to save backup files?........................................................... 1003

3.22.3 ARIS Cloud Controller (ACC).................................................................................. 1004
3.22.3.1 How to handle special characters........................................................... 1006
3.22.3.2 Create a tenant ............................................................................................ 1007
3.22.3.3 Back up a tenant ......................................................................................... 1008
3.22.3.3.1 What data is backed up and restored? ......................................... 1010
3.22.3.4 Restore a tenant .......................................................................................... 1012
3.22.3.5 Copy a tenant to a different server ......................................................... 1014
3.22.3.6 Delete a tenant ............................................................................................. 1016
3.22.3.7 How to start ARIS Cloud Controller (ACC) .............................................. 1018
3.22.4 y-tenantmgmt command-line tool ..................................................................... 1020
3.22.5 Monitoring health ..................................................................................................... 1022
3.22.5.1 Monitor file space ........................................................................................ 1022
3.22.5.2 Monitoring memory usage ........................................................................ 1023
3.22.5.3 Monitoring CPU load................................................................................... 1024
3.22.5.4 Monitoring thread pool size ...................................................................... 1024
3.22.5.5 Using ACC interface ................................................................................... 1024
3.22.5.5.1 Open ARIS Infrastructure overview...............................................1025
3.22.5.5.1.1 How to use the Infrastructure overview ........................... 1026
3.22.5.5.1.1.1 Runnables view ............................................................ 1026
3.22.5.5.1.1.2 Nodes view ..................................................................... 1027
3.22.5.5.1.1.3 Available actions (ARIS Infrastructure overview). 1028
3.22.5.5.1.1.3.1 Add node ............................................................ 1031
3.22.5.5.1.1.3.2 Show Runnables view or Nodes view ......... 1032
3.22.5.5.1.1.3.3 Run all health checks for all nodes ............. 1033
3.22.5.5.1.1.3.4 Run all health checks for this node ............. 1034
3.22.5.5.1.1.3.5 Run all health checks for this runnable ..... 1034
3.22.5.5.1.1.3.6 Run health checks automatically ................ 1035
3.22.5.5.1.1.3.7 Show health check results ............................ 1036
3.22.5.5.1.1.3.8 Download log files (ACC interface) .............. 1037
3.22.5.5.1.1.3.9 Remove node .................................................... 1037
3.22.5.5.1.1.3.10 Switch monitoring on and off....................... 1038
3.22.5.5.2 Open the Health check overview .................................................. 1039
3.22.5.5.2.1 How to use the health check overview ............................. 1040
3.22.5.5.2.1.1 Available actions (Health check overview) ............. 1041
3.22.5.5.2.1.1.1 Sort reported health check results ............. 1044
3.22.5.5.2.1.1.2 Filter reported issues and states ................. 1044
3.22.5.5.2.1.1.3 Show information for support ...................... 1045
3.22.5.5.2.1.1.4 Show JSON data.............................................. 1046
3.22.5.5.3 Open Health check schedules overview ...................................... 1047
3.22.5.5.3.1 How to use the Health check schedules overview ......... 1048
3.22.5.5.3.1.1 Create health check schedule .................................. 1050
3.22.5.5.3.1.2 Edit schedule ................................................................. 1051
3.22.5.5.3.1.3 Deactivate selected schedules ..................................1052
3.22.5.5.3.1.4 Delete selected schedules ..........................................1052
3.22.5.5.3.1.5 Delete schedule ............................................................ 1053
3.22.5.5.3.1.6 Activate selected schedules ..................................... 1053
XXIV
3.22.5.5.3.1.7 Run selected schedules ............................................. 1054

3.22.5.5.3.1.8 Run schedule ................................................................ 1054
3.22.5.5.3.1.9 Refresh list .................................................................... 1055
3.22.5.5.4 What checks are performed? ......................................................... 1056
3.22.5.6 Using ACC commands ............................................................................... 1058
3.22.5.6.1 Monitor runnable's health ............................................................... 1058
3.22.5.6.2 Show node ..........................................................................................1059
3.22.5.6.3 Configure health monitoring.......................................................... 1060
3.22.6 ARIS Server Administrator..................................................................................... 1063
3.22.6.1 Execute the backupsystemdb command .............................................. 1074
3.22.6.2 Execute the restoresystemdb command ............................................... 1075
3.22.6.3 Execute the updatesystemdb command ............................................... 1076
3.22.6.4 Execute the userwipeout command ....................................................... 1077
3.22.7 Command line tools for the ARIS Administration .............................................. 1078
3.22.7.1 Password encryption .................................................................................. 1079
3.22.7.2 Tenant Management ................................................................................... 1081
3.22.7.3 Parameters for y-tenantmgmt.bat/y-tenantmgmt.sh ...................... 1082
3.22.7.4 List of technical names of audit events ................................................. 1097
3.22.7.5 LDAP synchronization ................................................................................ 1100
3.22.7.6 Data migration .............................................................................................. 1103
3.22.8 Command line tools for ARIS document storage .............................................. 1105
3.22.9 Command line tools for Process Governance ..................................................... 1112
3.22.10 Parameters for y-ageclitool.bat/y-ageclitool.sh ............................................... 1113
3.22.11 Parameters for y-export4ppm.bat/y-export4ppm.sh ..................................... 1120
4 Glossary .............................................................................................................................................. 1121
5 Legal information............................................................................................................................. 1159

5.1 Documentation scope........................................................................................................ 1159
5.2 Support ................................................................................................................................. 1159
XXV
1 About this manual

This manual contains the excerpt from ARIS Help, which describes how to set up ARIS using
the user interface. All contents are available in the ARIS Help when you log in to ARIS with an
administrator license.
The basis of this manual is a hypertext system, so the formatting and sequential structuring
of the manual might not accurately reflect the actual structure of the information.
1
2 Introduction to ARIS
ARIS is an integrated environment in which you can create, display, and change processes, as
well as discuss and improve them jointly with other ARIS users. ARIS provides role-based
access to the content.
As a process expert, you receive access to the corresponding views and options for analyzing
and improving processes.
In ARIS projects participants can directly enter comments about modeled processes and
discuss improvement potential with others. With dashboards (page 1128) KPIs can be
visualized and controlled and relevant documents can be entered and distributed. The
seamless integration with existing ARIS installations is ensured, which also allows users to
cooperate concerning existing processes using integrated social media.
The functional scope of ARIS depends on the license being used.
News on ARIS is available in ARIS Community.
(https://www.ariscommunity.com/system/files/files/ARIS_10_SR16_Features_Overview.pd
f)
Note: You can watch videos for some procedures in the help. If your browser is unable to open
the quick videos within the help, please use a different browser. The videos are also available
in ARIS Community (https://www.ariscommunity.com/help/quick-videos).
Where to find technical documents:
 ARIS installation package (see Documents > English folder structure)
 Empower (https://empower.softwareag.com/)
 ARIS Download Center (https://aris.softwareag.com/)
2
3 Manage ARIS
You can configure ARIS so that it suits your needs.
Depending on your administrator privileges, you have access to the described areas. For
example, you can see the user administration only if you have the User administrator
function privileges.
3.1 Open ARIS Administration

Centrally manage users, user groups, privileges, licenses, documents, and configurations for
all ARIS products.
Prerequisite
You have administrator function privileges.
Procedure
Click Application launcher > Administration. ARIS Administration opens.
Depending on your administrator function privileges, you have access to various components
of the ARIS Administration, for example, User management or Configuration.
ARIS video tutorial

ARIS Architect 'Administration' tab versus ARIS Administration
(https://www.ariscommunity.com/videos/aris-architect-administration-tab-versus-aris-ad
ministration-0) (approx. 1 minute)
3
3.2 Manage licenses

Centrally manage licenses for all ARIS products to grant users the privileges required for the
programs they use.
3.2.1 License types and dependencies

You can use only one license type for each product. Exceptions are the Named user and
Cross-client license types.
LICENSE TYPES FOR CLIENT PRODUCTS

The license types for client products must be assigned manually to users or user groups. You
can increase the number of licenses by installing additional licenses.
NAMED USER
Users assigned to this license type have guaranteed login as the license is registered in their
name. The number of licenses that can be assigned is specified in the license file.
CONCURRENT USER
For this license type, the number of users who can log in at the same time is specified. The
assigned users share the available licenses. If the number of users logged in is the same as
the number of available licenses, no other users can log in. The user must wait until another
user logs off. However, the administrator can end (page 30) the sessions of users.
Difference between 'Named user' and 'Concurrent user' license type
Concurrent user Named user

Assignment Via user or user group Via user or user group
License volume Unlimited Limited number
Guaranteed login No Yes
Term of guaranteed login Current session Unlimited
CROSS-CLIENT
This license type corresponds to a license of the Named user type. However, it can be
imported and used for various tenants. It is intended for administrators who manage several
tenants. The assigned users can log in with all tenants.
SERVER LICENSES
The license types for server products are activated automatically after the import.
4
DEPENDENCIES WITHIN PRIVILEGES

 There are certain license privileges that you cannot assign to a user in combination with
others. For example, you cannot assign ARIS Architect and ARIS Designer to a user at the
same time.
 You can only activate the subgroups of a license privilege if the superior license privilege
is activated. If you remove a superior license privilege of a user, the user also
automatically loses the assignment to the subgroups.
3.2.2 Consumed and expired licenses
WHEN IS A LICENSE CONSUMED?

A license is consumed as soon as a user logs in and a session is created. Please note that a
license is not only consumed when a user starts working, like creating models in ARIS or
administrating processes. If various licenses are assigned to a user, the license with the
higher value is consumed first.
Example
User A is assigned to the licenses ARIS Connect Viewer and ARIS Connect Designer (both
Concurrent user license type). After login, the ARIS Connect Designer license is consumed.
EXPIRED LICENSES
Expired licenses are marked in the license overview: . Users or groups can no longer be
assigned. Login is impossible with an expired license. You can delete (page 8) expired license
files. Before deleting licenses, back up user data, if required, in order to be able to reuse (page
62) them when new license are available. In the configuration, you can specify that
administrators are notified before a license expires.
5
3.2.3 Import and display license file

Import a license file to give users the required privileges for the programs.
Prerequisite
You have the License administrator function privilege.
Procedure
1. Click Application launcher > Administration. ARIS Administration opens.
2. Click Licenses > Product.
3. Click Import license file. The corresponding dialog opens.

4. Select the relevant license file.
5. Click Upload.
The license file is transferred. It is shown how many licenses were imported, as well as which
licenses could not be installed and why. To display information about licenses , such as the
expiration date, number of licenses, click the relevant license, and select Open license
file. The license file is displayed as an XML file.
If license exhaustion notification is enabled in Configuration (User management >
User-defined notifications > Licenses > Notify about license exhaustion), license
administrators receive a notification once the specified number of licenses is reached.
You can now assign users the required license privileges. If you need additional licenses later,
simply import the new license file as described above.
6
3.2.4 Enable or disable license monitoring

You can customize the license monitoring as required.
Prerequisite
You have the Technical configuration administrator function privilege.
Procedure
2. Click Licenses > Monitoring > Configuration.
3. Click Edit.
4. Enable ( ) or disable ( ) license monitoring. License monitoring is disabled by default.
5. The license monitoring interval is indicated in minutes. By default, it is set to 5 minutes
and should not be changed because this value guarantees an optimum outcome for the
report evaluation (page 13).
6. Specify how long the license monitoring events are to be stored. By default, they are
stored for 365 days.
7. Click Save.
Your settings are saved. If you enabled license monitoring, you can now generate the License
usage rule validation report (page 13).
7
3.2.5 Delete licenses

You can delete license files when they have expired. Before deleting licenses, back up user
data, if required, in order to be able to reuse (page 62) them when new license are available. In
the configuration, you can specify that administrators are notified before a license expires.
Expired licenses are marked in the license overview: . Users or groups can no longer be
assigned. Login is impossible with an expired license.
Prerequisite
You have the License administrator function privilege.
Procedure
2. Click Licenses > Product.

3. Click the relevant product or a subgroup.
4. Move the mouse pointer over the relevant license. The buttons of the available functions
are displayed.
5. Click Delete license file.

The license file is deleted.
3.2.6 Create and activate license rule

Create license rules for the License usage rule validation report. You can have multiple
license rules, but only one can be activated.
Prerequisite
Procedure
2. Click Licenses > Monitoring > Rules.

3. Click Create. The corresponding dialog opens.
4. Enter a name and select the rule type (page 10).
5. Click Create. The license rule is created.
6. In the row of the newly created license rule, click Edit license rule. The fact sheet is
displayed.
7. Under License rule properties, click Edit. The corresponding dialog opens.
8. If required, also enter the license rule name in other languages.
8
9. For Aggregated weighting rule types, enter a Threshold.

10. Click Save. The license rule properties are saved.
11. Create a license group for the license rule. To do so, click Add under License groups. The
corresponding dialog opens.
12. Enter a license group name. If required, also enter the name in other languages.
13. For Aggregated weighting license rule types, click Add, select the relevant product
codes, for example, ARIS Connect Viewer(YCSCC) and ARIS Connect
Designer(YCSDC), and enter a weighting for each.
For Base & Peak license rule types, click Add, select the relevant product codes, and
enter a limit for each.
For DBP license rule types, enter a Threshold and select the relevant product codes.
14. Click Save.
The license group for the license rule is created.
15. Click Back. The Application management page is displayed.
16. In the row of the newly created license rule, click Activate license rule.
The license rule is created and activated. From now on, you can generate the License usage
rule validation report (page 13).
To delete a license rule, click Delete in the row of the relevant license rule.
9
3.2.7 License rule types

You can select the following license rule types when you create a license rule (page 8).
AGGREGATED WEIGHTING
A threshold is specified for the license rule and a weighting is assigned to each product
contained in the license rule. The number of unique users who are consuming licenses from
the license group is multiplied by the respective weighting of the license. If the calculated
total value exceeds the threshold, the license usage exceeds the purchased license volume.
Example
The license group contains ARIS Connect Designer licenses (weighting = 10) and ARIS
Connect Viewer licenses (weighting = 5). The specified threshold is 100. At a given point in
time, nine users are logged in with ARIS Connect Designer licenses and two with ARIS
Connect Viewer licenses. The calculated value of the consumed licenses is 100 (= 9 x 10 + 2 x
5) and therefore the license usage is not exceeded. As soon as an additional unique user logs
in, the threshold is exceeded.
BASE & PEAK

A limit is specified for each product contained in the license rule. If the number of unique
users who are consuming licenses from the license group exceeds the specified limit of the
respective product, the license usage exceeds the purchased license volume.
Example
The license group contains ARIS Connect Designer licenses (limit = 10) and ARIS Connect
Viewer licenses (limit = 5). At a given point in time, ten users are logged in with ARIS Connect
Designer licenses and four with ARIS Connect Viewer licenses. Therefore, no limit is exceeded
(base). As soon as an additional user logs in with ARIS Connect Designer license, the limit
specified for this product is exceeded (peak).
DBP (DIGITAL BUSINESS PLATFORM)

The maximum number of products (threshold) and the products that can be concurrently
used within a license group are specified (license bundle). Furthermore, a user should not use
more than one license of a product concurrently. If the number of unique users who are
consuming licenses from the license group exceeds the specified threshold, or if a user logs in
with both products, the license usage exceeds the purchased license volume.
10
Example
The license bundle of the license group contains ARIS Connect Designer licenses and ARIS
Connect Viewer licenses. The specified threshold is 10. At a given point in time, nine users are
logged in with ARIS Connect Designer licenses and an additional user is logged in with ARIS
Connect Viewer license. As soon as the user who is logged in with ARIS Connect Viewer
license logs in with ARIS Connect Designer license, the threshold is exceeded.
3.2.8 Download and upload license rules

You can download and upload license rules as JSON file. The license rules are also included in
the backup of user management data (page 61).
Prerequisite
Procedure
2. Click Licenses > Monitoring > Rules.
3. In the row of the license rule you want to download, click Download license rule. The
4. Select Save File and click Ok.
The license rule file is saved as JSON file in the selected folder.
5. To upload a license rule file, click Upload above the list of license rules. The
6. Click Select file. The corresponding dialog opens.
7. Navigate to the JSON file you want to upload as a license rule.
8. Select the relevant file, then click Open.
9. Click Upload.
The license rule is displayed in the list of license rules.
Before you use it as the active license rule for the License usage rule validation report,
check whether the license rule properties and the license groups are still valid. Example: If you
uploaded a license rule from an older ARIS version, check whether the product codes used for
the license group exist in the system.
11
3.2.9 Generate License audit (password-protected) report

If your contract with Software AG contains a term under which you must regularly provide the
usage data of the purchased licenses, generate the License audit (password-protected)
report. This report is applicable to Concurrent and Named user licenses. For detailed
information, contact your local Software AG sales organization
(https://www.softwareag.com/corporate/company/global/offices/default.html).
Prerequisite
 You have the User administrator, Configuration administrator, and License
administrator function privileges.
 License monitoring is enabled in Licenses > Monitoring > Configuration.
Procedure
2. Click User management. The list of users is displayed.
3. Click Additional functions.
4. Click Generate report. The corresponding dialog opens.

5. Select License audit (password-protected) report.
6. Click Run.
The report is output as a password-protected ZIP file containing an Excel file and a JSON file.
Send this password-protected report to Software AG for evaluation.
12
3.2.10 Generate License usage rule validation report

Generate a report that lists the license usage based on the license rule. This report is
applicable to Concurrent and Named user licenses.
Prerequisite
 License monitoring is activated (page 7) ( Licenses > Monitoring > Configuration).
 An active license rule is available (page 8) ( Licenses > Monitoring > Rules).
Procedure

5. Select License usage rule validation report.
6. Click Run.
The report is output as an Excel file.
13
3.3 Manage users and user groups

Users and privileges are managed centrally in ARIS Administration for all ARIS products. The
role-dependent data access is controlled by privileges and filters that are assigned per
database in ARIS Architect on the Administration tab.
3.3.1 Use case - Manage users

This use case provides a comprehensive description of all procedures that administrators
must carry out for a tenant (page 1153) so that all authorized employees can work with ARIS
Architect. We recommend that you use ARIS Administration to manage users, user groups,
privileges, licenses, documents, configurations, and processes in ARIS. This is what the use
case is based on. Using User Management is advisable only for users of ARIS Risk and
Compliance, ARIS Publisher, PPM, and MashZone.
Scenario
After installation, the following system users exist: 'superuser (page 1151)' and 'system (page
1156)'. They are responsible for the user management of an activated tenant (page 1153). The
server was started, the password for the system user (page 1152) superuser has not been
changed yet.
USER MANAGEMENT IN ARIS ADMINISTRATION

Prerequisite
You have administrator function privileges.
Procedure
1. Open ARIS Administration and log in as 'superuser'.
3. Change the passwords for the users 'superuser' and 'system'.
a. Change the passwords of the users superuser and system (page 1156) to prevent
unauthorized access to the system. These users are created automatically after
installation and have comprehensive function privileges and authorizations.
b. Click the user whose password you want to change.
c. Click Edit.
d. Enable the Change password check box. The Old password, New password, and
Confirm password fields are displayed.
e. Enter a new password, and reenter it. If you want to use the webMethods integration,
passwords must not contain a colon.
14
f. Click Save.
The password is changed. The user receives a notification by e-mail.
4. Import the license purchased.
a. Click Licenses > Product.
b. Click Import license file. The corresponding dialog opens.

c. Select the relevant license file.
d. Click Upload.
The license file is transferred. It is shown how many licenses were imported, as well
as which licenses could not be installed and why.
5. Create users.
a. Click Add user. The Create user form opens.

b. Enter the user name, first and last name, e-mail address, if applicable, and password.
If no password was specified for the user, a password is automatically generated for
the first login and sent to the user. After the first login, the password must be
changed. If a user that already exists in the LDAP system is created, the user name
must match. The e-mail address is transferred automatically. For the other
specifications you can enter any characters you wish because this information will
automatically be transferred from the LDAP system after the user is created.
The user name does not necessarily have to correspond to a person's first or last
name. To comply with the GDPR (page 1139), a randomly selected character string is
used, or an abbreviation of the first and/or last name.
c. Click Save. The details view of the user is displayed.
The user is created. If no password was specified for the user, a password is
automatically generated for the first login and sent to the user. After the first login,
the password must be changed.
6. Alternatively, import LDAP users.
a. Click Additional functions.
b. Click Start LDAP import. The button is active only if an LDAP system is
configured on the server.
c. Select whether you want to import only users or user groups and associated users.
d. Select if you want to use the default filter or create a custom one.
e. Click Preview to check how many users or user groups are imported. The number is
displayed, as well as up to 100 elements to be imported in alphabetical order.
f. Click Start import.
15
The users or user groups and associated users are transferred from the LDAP system
according to the selected options.
7. Create user groups.
a. Click User management and select User groups. The list of user groups opens.
b. Click Add user group.

c. Enter the name of the user group and an optional description.
d. Click Save.
The user group is created.
8. Alternatively, import LDAP user groups.
a. Click Additional functions.
b. Click Start LDAP import. The button is active only if an LDAP system is
c. Select whether you want to import only users or user groups and associated users.
d. Select if you want to use the default filter or create a custom one.
e. Click Preview to check how many users or user groups are imported. The number is
f. Click Start import.
9. Assign a user group to the user.
a. Click the user whose user group association you want to change.
b. Click Associated user groups.
c. Click Edit assignment. The Associate user groups dialog opens.

d. Enable the check boxes of the relevant items in the Available user groups box, and
click Add. The user groups are transferred to the Associated user groups box.
e. Click OK.
The user group is assigned to the user.
10. Assign function privileges to the user, if required.
a. Click the user you wish to assign function privileges to. The user data is displayed.
b. Click Privileges. The list of function privileges is displayed.
c. Enable ( ) the check boxes of the privileges whose assignment you want to add.
The user is assigned the selected privileges. This provides the user with privileges for
functions (for example, the Database administrator function privilege).
11. Assign license privileges to the user.
16
a. Click the user you wish to assign license privileges to. The user data is displayed.
b. Click Privileges. The list of function privileges is displayed.
c. Click License privileges.
d. Enable ( ) the check boxes of the privileges whose assignment you want to add.
The user is assigned the selected privileges. This provides the user with access to the
ARIS products relevant to him.
Users can now log in with their assigned privileges.
For each ARIS database (page 118), you can grant access privileges to user groups or users.
Product-specific privileges are assigned in each ARIS product.
USER MANAGEMENT IN ARIS ARCHITECT

Procedure
These actions can also be carried out by users with the Database administrator and User
1. Start ARIS Architect.
2. Log in as system user and connect to the default tenant.
Please use the new password that you just changed in ARIS Administration. ARIS
Architect starts.
3. Create databases. All users with the Database administrator function privilege can do
so.
4. Click ARIS > Administration or ARIS > Explorer.
5. Click Navigation in the bar panel if the Navigation bar is not activated yet.
6. In the Explorer tree, right-click your connection to the ARIS Server and select New >
Database.
7. Enter a name. Do not use any special characters.
8. Enable the Versionable check box if you want the content of the new database to be
versioned.
9. Click OK. The database is created and displayed in the Navigation bar, either as a
non-versionable or versionable database.
All users and user groups are automatically transferred from ARIS Administration.
10. Assign access privileges.
11. Assign function privileges to users and user groups.
12. Assign filters to users and user groups. (page 830)
The database is available to authorized users.
17
1. Assign access privileges for database groups. These actions can be carried out by all
users with the User administrator function privilege.
2. Click ARIS > Explorer.

3. Log in to the database.
5. Right-click the group for which you want to edit the access privileges, and select
Properties.
6. Click Access privileges (users) or Access privileges (user groups) on the Selection
tab.
7. Select the users/user groups for which you want to assign privileges.
8. Select the required access privileges. You can assign Read (r), Write (w), and Delete (d)
access privileges. The Version (v) access privilege is available for versionable databases
only. The selection is displayed in the Privileges column.
9. If you click the Pass on privileges button, the selected access privileges are applied to all
subgroups. This also applies to all new subgroups created below this group in the future.
10. Click OK.
After the user logs in to the database again the changed access privileges will be in effect.
1. Assign database-specific function privileges to users and user groups.
2. In ARIS Architect, click ARIS > Administration.
5. In the Navigation bar, click Users or User groups.
6. In the table, right-click the user or user group, and select Properties.
7. Click Function privileges on the Selection tab.
8. In the Assign column, click the relevant function privileges. You can assign only function
privileges that are assigned to you, too.
You cannot change function privileges for system users.
If you selected User in the Navigation bar and are logged on as system user, you can
enable the System user check box. This user receives all function and access privileges.
9. Click OK.
The function privileges are now assigned for this database.
18
For users to be able to view specific content of the database, you assign access
privileges to them.
1. Assign filters to users and user groups.
7. Click Method filter on the Selection tab.
8. In the Assign column, enable the checkboxes of the relevant filters.
9. Click OK.
The selected filters are assigned. Users can now log in using these filters.
You can select a default filter for each database. This filter is automatically assigned when
you create users and user groups.
All users with the corresponding privileges can work with ARIS Architect.
For new databases, these privileges must be assigned by authorized users.
ARIS video tutorial

19
3.3.2 Create user

Create a user for authorized employees. The default users (page 22) system, superuser,
arisservice, and guest are created automatically. You can create additional system users
(page 24).
Prerequisite
You have the User administrator function privilege.
Warning
If this user is also modeled in an organizational chart, all differing data and assignments are
overwritten when the executable process is subsequently generated or the organizational
chart is updated. This does not apply to LDAP users.
To prevent this, enable the attribute Consider user group association from user
management.
Procedure
3. Click Add user. The Create user form opens.

4. Enter the user name, first and last name, e-mail address, if applicable, and password. If no
password was specified for the user, a password is automatically generated for the first
login and sent to the user. After the first login, the password must be changed. If a user
that already exists in the LDAP system is created, the user name must match. The e-mail
address is transferred automatically. For the other specifications you can enter any
characters you wish because this information will automatically be transferred from the
LDAP system after the user is created.
The user name does not necessarily have to correspond to a person's first or last name.
To comply with the GDPR (page 1139), a randomly selected character string is used, or an
abbreviation of the first and/or last name.
5. Click Save. The details view of the user is displayed. If no password was specified for the
user, a password is automatically generated for the first login and sent to the user. After
the first login, the password must be changed.
6. Assign a user group to the user, if required.
7. Click Associated user groups.
8. Click Edit assignment. The Associate user groups dialog opens.
20
9. Enable the check boxes of the relevant items in the box of the available items, then click
Add. The items are transferred to the box of the associated items. To remove items
from the associated items box, enable the check boxes of the relevant items in this box,
and click Remove. To associate all available items, click Add To associate all
available items, click Add all, and click Remove all to remove all items.
10. Click Save.

11. Click Privileges. The list of function privileges is displayed. A distinction is made between
privileges assigned directly and those assigned via a user group.
12. Enable ( ) the check boxes of the privileges whose assignment you want to add.
In order to make a user a system user, enable all function privileges.
13. Click License privileges. A distinction is made between privileges assigned directly and
those assigned via a user group.
15. To manage access privileges for the entire database, click Database privileges. To
manage access privileges on a database group level, use Configuration > Databases
instead.
17. Click Edit. The Edit database privileges dialog opens.

18. Select the relevant privilege from the list.
19. Click OK.
The user is created with the corresponding user group and privilege assignments. The user
cannot be created if a mandatory field was not filled out or a user name was entered that is
already in use by another user in the system. LDAP users are indicated by a different symbol
( ) than the other users ( ).
Additional information about the user is displayed under Attributes.
To transfer a user's group and privilege assignments to a new user, go to the overview of
users and click Copy user in the row of the relevant user. Enable the check box of
assignments to be transferred and add the remaining data, such as user name, first and last
name, etc. of the new user.
21
3.3.3 Default users

Warning
To prevent unauthorized access to the ARIS system, after installation or data migration,
always change the default passwords of all users that are automatically created (page 22)
(arisservice user, guest user, system user, superuser user) on all operational tenants, as
well as on the infrastructure tenant (master).
'SYSTEM' USER
The system user is created automatically. By default, the system user has all function
privileges. This user can log in to Process administration, ARIS Administration, User
Management, and ARIS Process Board. In ARIS Architect and ARIS Designer, this user has all
access privileges for all database groups of all databases. This user only uses up a license if a
license privilege is activated for this user. The default password is manager. You should
change the default password to prevent unauthorized access. You can change all user data
except for the user name.
Having more than one system user can avoid problems, if, for example, your single system
user has forgotten his password. You can create (page 24) additional system users or copy
(page 26) the existing system user. If your only system user was deleted accidentally, create
a new one by using the superuser. The user can only be deleted individually (page 35). Enable
the Generate, if not available option ( Application launcher > Administration >
Configuration > User management > Users >) so that the user is automatically generated
again at startup with the last saved password.
'SUPERUSER'
The user superuser is created automatically. By default, this user is assigned the User
management, License management, and Configuration administrator function privileges.
This user can also enable this function privilege for other users. Users of the superuser type
do not use up a license. They manage the system administration, but cannot use ARIS
products due to license restrictions. The default password is superuser. You should change
the default password to prevent unauthorized access. The password of the superuser is very
important, as it is the only user who cannot be deleted. You can change all user data except
for the user name. The superuser can recreate the other default users (system, arisservice,
guest) if they were deleted.
22
'ARISSERVICE' USER
The user arisservice is created automatically. By default, this user is assigned the Database
administrator and Process Governance administrator function privileges. This user only
uses up a license if a license privilege is activated for this user. The default password is
arisservice. You should change the default password to prevent unauthorized access. You
can change all user data except for the user name. The user can only be deleted individually
(page 35). Enable the Generate, if not available option ( Application launcher >
Administration > Configuration > User management > Users >) so that the user is
automatically generated again at startup with the last saved password.
'GUEST' USER
The user guest is created automatically. By default, no function or license privileges are
assigned to this user. This user serves technical purposes only. It is not for use by end users.
Logging in to ARIS or other Software AG products with this user is not allowed. Further
information is available in the Software AG license terms (http://softwareag.com/licenses).
The user can only be deleted individually (page 35). Enable the Generate, if not available
option ( Application launcher > Administration > Configuration > User management
> Users >) so that the user is automatically generated again at startup with the last saved
password.
23
3.3.4 Make a user a system user

Create additional system (page 22) users. Having more than one system user can avoid
problems, if, for example, your single system user has forgotten his password.
Prerequisite
You have the User administrator function privilege. If all users including the system users
are deleted, use the superuser. The superuser cannot be deleted.
Procedure

3. Click the relevant user. The user data is displayed.
4. Click Edit.
5. Click Privileges. The list of function privileges is displayed.
6. Enable all check boxes.
Now, the user is a system user. The system user has all function privileges. This user can log
in to Process administration, ARIS Administration, User Management, and ARIS Process
Board. In ARIS Architect and ARIS Designer, this user has all access privileges for all database
groups of all databases.
If your only system user was deleted accidentally, create a new one by using the superuser.
MAKE A USER A SYSTEM USER FOR A SPECIFIC DATABASE

System users have all function and access privileges in a database. To be on the safe side,
create additional system users besides the system user system.
1. Click Application launcher > Administration > Configuration > Databases.

2. Select the database and click Properties > Function privileges.
3. Click Users and use the filter to navigate to the related user that you want to make a
system user for this database.
4. Enable the System user check box.
The user receives all function and access privileges for this database. This changes the
privileges in ARIS only. The function privileges of a user in ARIS Administration are not
affected.
24
To reject system user privileges, clear the respective check boxes. If the Database
administrator function privilege was assigned to a user in ARIS Administration, this user has
full access to all databases of the tenant. For such users, you cannot disable the System user
check box. System users can only revoke privileges from users that are system users in single
databases.
25
3.3.5 Copy a system user

Copy an existing system (page 22) user. Having more than one system user can avoid
problems, if, for example, your single system user has forgotten his password.
Prerequisite
Warning
If this user is also modeled in an organizational chart, all differing data and assignments are
overwritten when the executable process is subsequently generated or the organizational
chart is updated. This does not apply to LDAP users.
To prevent this, enable the attribute Consider user group association from user
management.
Procedure

3. Click the relevant user. The user data is displayed.
4. Click Copy. The Copy user form opens.

5. Enable Transfer function privileges.
6. Enable Transfer user group associations and/or Transfer license privileges, if
required.
7. Enter the user name, first and last name, e-mail address, if applicable, and password. If no
password was specified for the user, a password is automatically generated for the first
login and sent to the user. After the first login, the password must be changed. If a user
that already exists in the LDAP system is created, the user name must match. The e-mail
address is transferred automatically. For the other specifications you can enter any
characters you wish because this information will automatically be transferred from the
LDAP system after the user is created.
The user name does not necessarily have to correspond to a person's first or last name.
To comply with the GDPR (page 1139), a randomly selected character string is used, or an
abbreviation of the first and/or last name.
8. Click Save.
26
An additional system user is created. The system user has all function privileges. This user
can log in to Process administration, ARIS Administration, User Management, and ARIS
Process Board. In ARIS Architect and ARIS Designer, this user has all access privileges for all
database groups of all databases. If no password was specified for the user, a password is
automatically generated for the first login and sent to the user. After the first login, the
password must be changed.
27
3.3.6 Assign user groups to a user

You can change the assignment of user groups for a user. User groups define the tasks or
functions that a person performs in a company. A certain set of function, license, and
database privileges, as well as profiles, is assigned to different user groups. If a user group is
assigned to a user, the user has all privileges and profiles assigned to that user group. A user
can belong to several different user groups at the same time. Function and license privileges
can be assigned through the group or directly to the user. The type of assignment is displayed
in Users > <user name> > Privileges.
Prerequisite
Procedure

3. Click the user whose user group association you want to change.
4. Click Associated user groups.
5. Click Edit assignment. The Associate user groups dialog opens.

6. Enable the check boxes of the relevant user groups in the Available user groups box,
and click Add. The user groups are transferred to the Associated user groups box. To
remove user groups from the Associated user groups box, enable the check boxes of
the relevant user groups in this box, and click Remove. To associate all available items,
click Add all, and click Remove all to remove all items.
7. Click OK.
The user groups assigned to the user have been changed.
If required, product-specific groups must additionally be created and assigned in each ARIS
product.
28
3.3.7 Edit user

Edit user accounts. You cannot change the user name. If you are using an LDAP system, you
cannot change the password either.
Prerequisite
Procedure

3. Click the user whose data you want to change. The user data is displayed.
4. To change or delete a user's picture, click Change picture. If a different picture is

uploaded in ARIS Administration or in Collaboration, it is automatically transferred to the
other application.
5. Click Edit.
6. Change the relevant information, such as name, e-mail address, etc.
7. To change a password, enable Change password. The Old password, New password,
and Confirm password fields are displayed.
8. Click Save.
9. Enter a new password, and reenter it. If you want to use the webMethods integration,
10. Change the user group assignment (page 28), if necessary.
11. If required, change the profile or the function, license, and database privileges for the
user (page 40).
The user's data is changed. After you have changed the password, the user is informed per
e-mail about the new password.
29
3.3.8 Log out user

You can end the sessions of users. This can be necessary, for example, if all licenses of the
Concurrent user license type (page 4) are used up because users have forgotten to log out.
It can also be useful to end sessions if the assignment of function or license privileges was
changed, as these privileges only take effect after users have logged in again.
Prerequisite
LOG OUT SINGLE USER

Procedure

3. Click the user you wish to log out. The user data (details) is displayed.
4. Click Active sessions.
5. Click Log out user.

6. Click OK.
The user is logged out and can log back in again.
LOG OUT MULTIPLE USERS USING A SPECIFIC LICENSE

Procedure
2. Click Privileges, and select License privileges.
3. Click the license privilege for which you want to log out users.
5. Enable the check boxes of the users you want to log out.
6. Click Log out user.

7. Click OK.
The users are logged out.
To obtain an overview of all users currently logged in, export (page 62) a user statistics.
30
3.3.9 Create user group

Create a new user group. User groups define the tasks or functions that a person performs in
a company. A certain set of function, license, and database privileges, as well as profiles, is
assigned to different user groups. If a user group is assigned to a user, the user has all
privileges and profiles assigned to that user group. A user can belong to several different user
groups at the same time.
Prerequisite
Procedure
2. Click User management and select User groups. The list of user groups opens.
3. Click Add user group.

4. Enter the name of the user group and an optional description. If a user group that already
exists in the LDAP system is created, the user group names must match. This is the only
way to assign an existing ARIS user group with the LDAP user group.
5. Click Save.
The user group is created. Now, you can assign users to the user group (page 34).
product.
Tip
To transfer user and privilege assignments of a group to a new group, go to the overview of
groups and click Copy group in the row of the relevant group. Enable the check box of
assignments to be transferred and add the remaining data, such as group name, etc. of the
new group.
31
3.3.10 Copy user group

You can copy user groups.
Prerequisite
Procedure
3. Move the mouse pointer over the user group you want to copy. The buttons of the
available functions are displayed.
4. Click Copy user group.

5. Click Transfer user associations to assign the users of the group copied to the new
group.
6. Click Transfer privilege assignments to assign the function privileges of the group
copied to the new group. License privileges are transferred only with the Concurrent
user license type. For the other license types, the license privileges must be assigned
(page 39) in a separate step.
7. Enter the name of the user group.
8. Click Save.
The user group is created based on the group copied. If applicable, assign the group the
required license privileges.
product.
32
3.3.11 Edit user group

You can change user group data. If required, product-specific groups must additionally be
created and assigned in each ARIS product.
Prerequisite
Procedure
3. Click the user group whose data you want to change.
4. Click Edit.
5. Change the description, if necessary.
6. Click Save.
7. Change the user assignment (page 34), if necessary.
8. Change the function privileges for the user group, if necessary.
The user group data is changed.
33
3.3.12 Assign users to a user group

You can change the assignment of users for a user group. Function and license privileges can
be assigned through the group or directly to the user. The type of assignment is displayed in
Users > <user name> > Privileges.
Prerequisite
Procedure
3. Click the user group whose user association you want to change.
4. Click Associated users.
5. Click Edit assignment. The Associate users dialog opens.
6. Add all users you want to assign to the group. Use the Filter to limit the list of users,
based on specific search criteria.
Enable the check boxes of the relevant items in the box of the available items, then click
Add. The items are transferred to the box of the associated items. To remove items
from the associated items box, enable the check boxes of the relevant items in this box,
and click Remove. To associate all available items, click Add all, and click
Remove all to remove all items.
7. Click OK.
The users associated to the user group have been changed.
product.
34
3.3.13 Delete user

Delete users when they are no longer relevant.
Prerequisite
Warning
Do not delete your system user (page 22). Having more than one system user can avoid
problems. If your single system user was deleted accidentally, create a new one by using the
superuser (page 22). The superuser cannot be deleted.
If you delete the default users system, arisservice, and guest, the Generate, if not available
option (ARIS Administration > Configuration > User management > Users >) is
automatically disabled and the users are no longer generated at startup with the last saved
password until you manually enable the option again. The superuser can recreate the other
default users (system, arisservice, guest) if they were deleted.
Procedure

3. Move the mouse pointer to the relevant user name. The buttons of the available functions
are displayed.
4. Click Delete. The Confirmation dialog opens.

5. Click OK. The user data is deleted. It takes about 30 minutes until the deletion is written to
the log files.
6. To comply with GDPR (page 1139), delete the log files of ARIS Administration/User
Management 30 minutes after deletion of the user data. You can find them in this path:
<Your installation
folder>\ARIS<version>\server\bin\work\work_umcadmin_<size>\base\logs
7. Delete the log files.
The user data and the log files are deleted.
To delete several users at the same time, enable the check boxes for the relevant users, and
click Delete. Make sure not to enable any check boxes of default users (system,
arisservice, guest), as they cannot be deleted by bulk deletion. They can only be deleted
individually like described above. To anonymize users according to GDPR, refer to the online
help of the respective component (page 69).
35
3.3.14 Delete user group

You can delete user groups that are no longer relevant.
Prerequisite
Procedure
3. Move the mouse pointer over the relevant user group name. The buttons of the available
functions are displayed.

5. Click OK.
The user group is deleted.
To delete several user groups at the same time, enable the check boxes for the relevant
groups, and click Delete.
36
3.3.15 Delete all users/user groups

If you want to set up user management from scratch, you should delete all users and user
groups. This is recommended before you change to or deactivate LDAP, for example.
The superuser cannot be deleted. The other default users (page 22) system, arisservice, and
guest can only be deleted individually (page 35). They are not deleted if you include them in
bulk deletion ( Remove all or Delete, with multiple users selected at a time).
Prerequisite
Procedure
3. Click Remove all. The Confirmation dialog opens.

4. Click OK.
All users and user groups are deleted except for the default users.
3.3.16 How can the password be changed?

There are several possibilities for changing a user's password. Passwords of LDAP users
cannot be changed.
PASSWORD IS CHANGED BY THE ADMINISTRATOR

A user with the User management function privilege can change the passwords of other
users.
CHANGE PASSWORD MANUALLY

A password can be changed (page 54) manually in the user management (Change
password).
GENERATE PASSWORD
Alternatively, a password can be generated (page 54) automatically in the user management
(Generate password).
PASSWORD IS CHANGED BY THE USER

The user has two possibilities for changing his password in the login dialog.
37
CHANGE PASSWORD
If a user's password has expired, he will be asked to change it in the login dialog (Change
password). The user will receive an e-mail containing the new password.
RESET PASSWORD
If the user has forgotten his password, he can request a new one (Reset password). The rest
of the procedure depends upon whether a one-stage or two-stage password change is
enabled (Administration > Configuration > User management). For the one-stage change
the user immediately receives an e-mail with the new password. For a two-stage change the
user first receives an e-mail asking him to confirm the resetting of his password within a
specific period of time. The user receives a new password after he has confirmed.
3.3.17 Available licenses in ARIS

For working with ARIS, the Designer and Viewer licenses are available.
DESIGNER
 The ARIS Connect Designer license gives users access to the entire repository. They can
access models, documents, and dashboards and feeds. In the Models & Object area, for
example, users can create, edit, and delete models in databases.
 The ARIS Connect Designer license can be extended with the ARIS Aware license. The
ARIS Aware license allows users to see and configure dashboards for which they have
view rights. The users can see the dashboards, for example, in the Dashboards fact sheet.
VIEWER
 The ARIS Connect Viewer license enables users to view models in databases. This
means that these users use databases for review and information purposes.
 The ARIS Connect Viewer license can be extended with the ARIS Aware license. The
ARIS Aware license allows users to see configured dashboards for which they have view
rights. The users can see the dashboards, for example, in the Dashboards fact sheet.
 The Contribution license is an additional license to users using an ARIS Connect Viewer
license. If you have both the ARIS Connect Viewer and Contribution license privilege,
you can change the values of specific model types and objects (page 562), create new or
reuse existing items, as well as delete items in the Published content view.
38
3.3.18 Assign privileges and profiles
3.3.18.1 Change a privilege for multiple users/user groups

Assign a function or a license privilege for multiple users or user groups.
Prerequisite
Procedure

4. Click the function privilege you want to assign. The current assignment is displayed.
5. Click Edit assignment. The Associate users/user groups dialog opens.

6. Enable the check boxes of the relevant items in the box of the available items, then click
Add. The items are transferred to the box of the associated items. To remove
users/user groups from the Associated users/user groups box, enable the check boxes
of the relevant users/user groups in this box, and click Remove. To associate all
available items, click Add all, and click Remove all to remove all items.
7. Click OK.
8. Click License privileges. The list of license privileges is displayed.
9. Repeat steps 3 - 5 to assign a license privilege to multiple users or user groups.
The user/user group is assigned the corresponding privileges. If users are assigned a privilege
directly and via associated user groups, this is detected automatically so that the user only
uses one license.
39
3.3.18.2 Change multiple function, license, and database

privileges for user/user group
Assign the relevant function, license, and database privileges to allow usage of specific
programs and functions. Product-specific privileges are assigned in each ARIS product.
There are certain license privileges that you cannot assign to a user in combination with
others. For example, you cannot assign ARIS Architect and ARIS Designer to a user at the
same time.
You can only activate the subgroups of a license privilege if the superior license privilege is
activated. If you remove a superior license privilege of a user, the user also automatically
loses the assignment to the subgroups.
Prerequisite
CHANGE FUNCTION, LICENSE, AND DATABASE PRIVILEGES FOR INDIVIDUAL

USERS
Procedure

2. Click the user whose privileges you want to change.
3. Click Privileges. The list of function privileges is displayed. A distinction is made between
privileges assigned directly and those assigned via a user group.
4. Enable ( )/disable ( ) the check boxes of the privileges whose assignment you want to
add/remove.
In order to make a user a system user, enable all function privileges.
5. Click License privileges. A distinction is made between privileges assigned directly and
those assigned via a user group.
add/remove.
instead.
add/remove. No database privileges are assigned yet.

11. Click OK.
40
The user is assigned the selected privileges. The assignment of these privileges is displayed
as Granted in the overview of function and license privileges for a user.
CHANGE FUNCTION PRIVILEGES FOR ALL MEMBERS OF A USER GROUP

Procedure
2. Click the user group whose privileges you want to change.
add/remove.
5. Click License privileges.
instead.
add/remove. No database privileges are assigned yet.

11. Click OK.
All members of the user group are assigned the selected privileges. The assignment of these
privileges is displayed as Via user group in the overview of function and license privileges for
a user.
Product-specific privileges are assigned in each ARIS product.
The following special features apply for process automation:
If the Process Governance administrator function privilege has been assigned to the user
in the model but not in user management, the user is also assigned the Process Governance
administrator function privilege in user management the next time the executable process is
generated. If the user has the Process Governance administrator function privilege from
user management but not from the model, the Process Governance administrator function
privilege is removed from the user in user management the next time the executable process
is generated.
41
3.3.18.3 Assign license pool to user group

Assign a number of licenses (license pool) exclusively to a user group.
Prerequisite
 You have the User administrator function privilege.
 License pools at user group level is enabled in ARIS Administration configuration
(Security > Advanced settings).
 The used license type (page 4) is Concurrent user.
Procedure
3. Click the user group whose license limit you want to change.
4. Click Privileges > License privileges.
5. Move the mouse pointer over the relevant license. The buttons of the available functions
are displayed.
6. Click Change licenses. The corresponding dialog opens.
7. Enable the Granted check box.
8. Enter the number of licenses you want to assign in the Assigned licenses box.
9. Click Save.
The licenses are assigned to the user group.
42
3.3.18.4 Tenant-wide function privileges

Function privileges provide users with specific functions and control their privileges.
Additionally, the user must be assigned to a license privilege. You can assign (page 40) the
following function privileges to users or user groups. Tenant-wide function privileges are
assigned in ARIS Administration. Depending on your license, the offered function privileges
may vary.
ARCM ADMINISTRATOR
Manage ARIS Risk and Compliance system settings and run data exports/imports.
ARCM SYNCHRONIZATION ADMINISTRATOR

Synchronize databases, models, or groups from ARIS or ARIS to ARIS Risk and Compliance.
ARIS CONNECT ADMINISTRATOR

Specify which version of which database is to be published, and manage the corporate
design.
ANALYSIS ADMINISTRATOR
Back up, restore, and manage the analysis database of a tenant. Import and export queries
and ad hoc analyses.
ANALYSIS PUBLISHER
Publish and delete ad hoc analyses and queries for other users. Back up ad hoc analyses and
queries.
COLLABORATION ADMINISTRATOR
Manage private groups, flagged posts, announcements, and e-mail templates.
COMPONENT ADMINISTRATOR
Add, start, stop, and remove components on the ARIS Cloud Controller server.
CONFIGURATION ADMINISTRATOR
Configure ARIS Server, export and import a tenant's configuration files, for example, ARIS
filters, templates, and XML structures.
CONFIRMATION AUDITOR
Monitor all confirmation process schedulers and confirmation processes.
43
CONFIRMATION MANAGER
Create confirmation process schedulers and confirmation processes. Edit and monitor all
confirmation process schedulers and confirmation processes.
CONFIRMATION OWNER
Create confirmation process schedulers and confirmation processes. Edit and monitor own
DASHBOARD ADMINISTRATOR
Create and manage visual content in ARIS, for example, dashboards.
DATABASE ADMINISTRATOR
Manage tenant databases. System user in all databases.
DOCUMENT ADMINISTRATOR
Manage documents, document versions, folders, and access privileges in ARIS document
storage.
IMPERSONATION
Manage data in other tenants using impersonated users and their privileges.
LICENSE ADMINISTRATOR
Use ARIS Administration/User Management to import, export, or delete licenses.
PORTAL ADMINISTRATOR
Manage the portal's corporate design.
PPM USER
Use PPM.
PROCESS GOVERNANCE ADMINISTRATOR

Manage Process Governance processes.
PUBLISHER ADMINISTRATOR
Generate, update, and delete ARIS Publisher exports.
PUBLISHING ADMINISTRATOR
Specify which version of which database is to be published in the portal.
SCRIPT ADMINISTRATOR
Manage report scripts and macros of a tenant.
44
SERVER ADMINISTRATOR
Query and terminate sessions on ARIS Server. Back up and update the system database, and
display database statistics and all databases.
SERVICE ADMINISTRATOR
Register external systems and services (for example, external database systems, mail servers,
or proxy servers) on the ARIS Cloud Controller server.
TECHNICAL CONFIGURATION ADMINISTRATOR

Configure systems, such as LDAP or SMTP, use ARIS Administration/User Management to
import or export configuration files, and manage documents.
TENANT ADMINISTRATOR
Create, back up, restore, and delete tenants on the ARIS Cloud Controller server.
UML VIEWER
View UML content in ARIS.
User administrator
Manage users, user groups, and privileges in ARIS Administration/User Management.
3.3.18.5 Database-wide function privileges

You can assign function privileges to provide users and user groups with specific
functionality and thus control their authorizations across a database. You assign function
privileges for databases in ARIS Architect on the properties pages of users or user groups.
Attribute formatting
Users with this function privilege can format attributes.
Change Management
Users with this function privilege can:
 modify proposals
 propose and modify measures
 specify end dates for measures
 set priorities
 define persons responsible
Database backup
Users with this function privilege can back up the database.
45
Database export
 transfer database content to other databases (merge)
 export and import database content.
Database management
 edit database properties
 edit database attributes
 create, modify, and delete languages
Database reorganization
Users with this function privilege can reorganize the database.
Font format management
Users with this function privilege can create, change, or delete font formats in the database
on the Administration tab.
Lock permanently
Users with this function privilege can lock group content, objects, and models during Release
Cycle Management. Permanently locked database items are displayed, but they can only be
edited by the user who locked them. This user and, in ARIS Architect, system users can
remove the lock.
Method changes
Users with this function privilege can change the color or line weight of objects in models by
changing the Fill color, Line color, Line style, and Weight boxes on the Format >
Representation > Object appearance page.
As a result, only the appearance of this object occurrence differs from the default appearance
defined in ARIS Method.
To change ARIS Method you need the Configuration administrator function privilege in
ARIS Administration.
Prefix management
Users with the Prefix management function privilege can manage database prefixes and
change this attribute for all database items for which they have the Write access privilege.
Prefixes of a database are managed on the Administration tab on the Identifier properties
page. By assigning a particular prefix to a user, you can identify the users who have created
database items.
Report automation
46
Users with the Report automation function privilege can run reports as scheduled reports.
The group Scheduled reports is displayed in the Explorer tree.
Show user management
Displays the database items Users and User groups on the Administration tab. Users with
this function privilege cannot edit users/user groups.
User management
Displays the database items Users and User groups on the Administration tab.
Users with this function privilege can edit user groups and users who are not system users.
 Assign method filters (page 830)
 Assign function privileges
 Assign access privileges
 Specify default method filter
Users can only assign privileges which they have themselves.
In addition to database-wide functional privileges, there are tenant-wide functional privileges
(page 43).
47
3.3.18.6 What function privileges can be assigned?

Function privileges provide users with specific functions and control their privileges.
Additionally, the user must be assigned to a license privilege. You can assign (page 40) the
following function privileges to users or user groups. Additional privileges can be assigned in
each ARIS product at the database level.
ARCM ADMINISTRATOR
Manage ARIS Risk and Compliance system settings and run data exports/imports.
ARCM SYNCHRONIZATION ADMINISTRATOR

Synchronize databases, models, or groups from ARIS or ARIS to ARIS Risk and Compliance.
ARIS CONNECT ADMINISTRATOR

Specify which version of which database is to be published, and manage the corporate
design.
ANALYSIS ADMINISTRATOR
Back up, restore, and manage the analysis database of a tenant. Import and export queries
and ad hoc analyses.
ANALYSIS PUBLISHER
Publish and delete ad hoc analyses and queries for other users. Back up ad hoc analyses and
queries.
COLLABORATION ADMINISTRATOR
Manage private groups, flagged posts, announcements, and e-mail templates.
COMPONENT ADMINISTRATOR
Add, start, stop, and remove components on the ARIS Cloud Controller server.
CONFIGURATION ADMINISTRATOR
Configure ARIS Server, export and import a tenant's configuration files, for example, ARIS
filters, templates, and XML structures.
CONFIRMATION AUDITOR
Monitor all confirmation process schedulers and confirmation processes.
48
CONFIRMATION MANAGER
Create confirmation process schedulers and confirmation processes. Edit and monitor all
CONFIRMATION OWNER
Create confirmation process schedulers and confirmation processes. Edit and monitor own
DASHBOARD ADMINISTRATOR
Create and manage visual content in ARIS, for example, dashboards.
DATABASE ADMINISTRATOR
Manage tenant databases. System user in all databases.
DOCUMENT ADMINISTRATOR
Manage documents, document versions, folders, and access privileges in ARIS document
storage.
IMPERSONATION
Manage data in other tenants using impersonated users and their privileges.
LICENSE ADMINISTRATOR
Use ARIS Administration/User Management to import, export, or delete licenses.
PORTAL ADMINISTRATOR
Manage the portal's corporate design.
PPM USER
Use PPM.
PROCESS GOVERNANCE ADMINISTRATOR

Manage Process Governance processes.
PUBLISHER ADMINISTRATOR
Generate, update, and delete ARIS Publisher exports.
PUBLISHING ADMINISTRATOR
Specify which version of which database is to be published in the portal.
SCRIPT ADMINISTRATOR
Manage report scripts and macros of a tenant.
49
SERVER ADMINISTRATOR
Query and terminate sessions on ARIS Server. Back up and update the system database, and
display database statistics and all databases.
SERVICE ADMINISTRATOR
Register external systems and services (for example, external database systems, mail servers,
or proxy servers) on the ARIS Cloud Controller server.
TECHNICAL CONFIGURATION ADMINISTRATOR

Configure systems, such as LDAP or SMTP, use ARIS Administration/User Management to
import or export configuration files, and manage documents.
TENANT ADMINISTRATOR
Create, back up, restore, and delete tenants on the ARIS Cloud Controller server.
UML VIEWER
View UML content in ARIS.
USER ADMINISTRATOR
Manage users, user groups, and privileges in ARIS Administration/User Management.
ARIS video tutorial

3.3.18.7 What license privileges can be assigned?

License privileges provide users with specific products and components. You can assign
(page 40) the license privileges to users or user groups ( Application launcher >
Administration > User management > Users > <user name> > Privileges > License
privileges or Application launcher > Administration > User management > User
groups > Privileges > License privileges). Move the mouse pointer over a license privileges
name to display the description. Additional privileges can be assigned in each ARIS product at
the database level.
50
3.3.18.8 Assign profiles to users/user groups

Assign the relevant profile to enable a profile-based view of ARIS. Profiles are applied in
addition to the function and license privileges. If more than one profile is assigned, the user
can switch between these profiles via <user name> > Profiles > <profile_xy>. Only one
profile can be active at a time. You can assign the following profiles to users or user groups in
Profile name Views and functionalities

CoE member The Overview fact sheet is displayed when a model is
selected in Published content.
Contributor The Steps fact sheet is displayed when a model is selected in

the Published content view. If the Steps fact sheet is
not available, the Overview fact sheet is displayed.
Designer The Diagram fact sheet is displayed when a model is

Manager/Owner The Dashboards fact sheet is displayed when a model is

Viewer  The Steps fact sheet is displayed when a model is

selected in the Published content view. If the Steps
fact sheet is not available, the Overview fact sheet is
displayed.
 The Tasks area is not available.
 The Contribute function is not available.
Viewer (accessible)  The Steps fact sheet is displayed when a model is

selected in the Published content view. If the Steps
fact sheet is not available, the Overview fact sheet is
displayed.
 The Tasks area is not available.
 The Contribute function is not available.

 ARIS document storage and Process Governance are not
available.
These profiles are predefined in the XML configuration.
Prerequisite
51
ASSIGN PROFILES TO INDIVIDUAL USERS

Procedure

3. Click the user you want to assign a profile to. The user data is displayed.
4. Click Privileges > Profile. The list of profiles is displayed. A distinction is made between
profiles assigned directly and those assigned via a user group.
5. Enable/disable the check boxes of the profiles whose assignment you want to
add/remove.
The user is assigned the selected profiles.
ASSIGN PROFILES TO ALL MEMBERS OF A USER GROUP

Procedure
3. Click the user group you want to assign a profile to. The user data is displayed.
4. Click Privileges > Profile. The list of profiles is displayed.
5. Enable/disable the check boxes of the profiles whose assignment you want to
add/remove.
All members of the user group are assigned the selected profiles. The assignment of these
profiles is displayed in the overview of profiles for a user as Via user group.
52
3.3.18.9 What is a configuration administrator?

Configuration administrators are authorized to adapt the configuration settings of a tenant.
Therefore, they require the Configuration administrator function privilege (page 40).
Configuration administrators can manage content only if they have the required function
privileges related to the content.
Configuration administrators perform the following tasks depending on their additional
function privileges:
 Configure user management (page 70) (User administrator function privilege required)
 Configure Document storage (page 488) (Document administrator function privilege
required)
 Configure Process Governance (page 633) (Process Governance administrator
function privilege required)
 Configure Collaboration (page 657) (Collaboration administrator function privilege
required)
For advanced configuration, you need the ARIS Enterprise Administration license privilege
(page 40). The ARIS Enterprise Administration license privilege additionally allows
configuration administrators to do the following:
 Configure model types (page 725), object types (page 742) and object symbols (page
754), connection types (page 767), attribute types (page 779) and attribute symbols (page
810), and attribute type groups (page 799).
 Manage filters (page 819)
 Manage configuration languages (page 684)
 Manage font formats used in the Conventions section (page 865)
 Manage model templates (page 852)
 Manage content type sets (page 684)
 Manage databases (page 118) (Database administrator function privilege required)
 Manage evaluation scrips and macros (page 136).
53
3.3.19 Handle password

Assign a new password to a user or generate it automatically. You can request a new
password if you have forgotten your current password.
3.3.19.1 Change user password

Assign a new password to a user or generate it automatically. Passwords of LDAP users
cannot be changed.
Prerequisite
CHANGE PASSWORD MANUALLY

Procedure

3. Click the user whose password you want to change. The user data is displayed.
4. Click Edit.
5. Enable the Change password check box. The Old password, New password, and
Confirm password fields are displayed.
6. Enter a new password, and reenter it. If you want to use the webMethods integration,
7. Click Save.
GENERATE PASSWORD
Procedure

3. Click the user whose password you want to change. The user data is displayed.
4. Click Generate password. The button is only displayed for users who are not LDAP
users.
54
3.3.19.2 Request new password

You can request a new password if you have forgotten your current password. If an LDAP
system is used for user management, please contact your LDAP administrator to request a
new password.
Procedure
1. Click Reset password in the Login dialog. The corresponding dialog opens.
2. Enter your user name.
3. Click Reset password.
Depending on your configuration, you will either receive an e-mail with a new password
immediately or you must first confirm your password change using a link.
55
3.3.20 Apply LDAP

You can import users from the LDAP system and you can synchronize user and user group
data with the data stored in the LDAP system.
3.3.20.1 Import users/user groups from LDAP

You can import users from the LDAP system.
Prerequisite
Procedure
4. Click Start LDAP import. The button is active only if an LDAP system is configured
on the server.
5. Select whether you want to import only users or user groups and associated users.
6. Select if you want to use the default filter or create a custom one.
7. Click Preview to check how many users or user groups are imported. The number is
8. Click Start import.
56
3.3.20.2 Synchronize users/user groups with the LDAP

system
You can synchronize user and user group data with the data stored in the LDAP system. LDAP
users are indicated by a different symbol ( ) than the other users ( ).
Prerequisite
Procedure

3. Click the user or user group you wish to synchronize.
4. Click Synchronize with LDAP. The button is active only if an LDAP system is
Data is transferred from the LDAP system for the selected item.
57
3.3.21 Use SCIM

ARIS supports SCIM (page 1150) with SAML 2.0.
3.3.21.1 Generate bearer token

If you suspect that your bearer token (page 1124) is no longer safe, you can generate a new
bearer token and hand it over to your SCIM administrator.
We recommend that you use your own local user who has the Technical configuration
administrator function privilege and the User administrator function privilege. This user
can generate a bearer token and forward it together with the SCIM end point URL to the SCIM
administrator.
Prerequisite
 SCIM (page 1150) is enabled and correctly configured in ARIS Administration >
Configuration > User management > SCIM.
Procedure
1. Click Application launcher > Administration. The Administration opens with the
Configuration view.

3. Click your user name. The bearer token is always user-specific. In principle one bearer
token is sufficient system-wide.
4. Click SCIM bearer token.
5. Click Generate bearer token. The dialog opens.

6. Click OK to confirm.
If the bearer token is newly created, the bearer token is displayed in the SCIM bearer token
field. If a bearer token already exists, the Generate bearer token dialog opens and you can
confirm that a new bearer token should be created.
58
3.3.21.2 Copy bearer token to clipboard

You can copy the bearer token (page 1124) to the clipboard to hand it over to your SCIM
administrator so that he can import it.
Prerequisite
Procedure
Configuration view.

4. Click Copy to copy the bearer token to the clipboard.
You can hand over the bearer token to your SCIM administrator so that he can import it.
59
3.3.21.3 Delete bearer token

You can delete a bearer token.
Prerequisite
Procedure
Configuration view.

5. Click Delete.
The bearer token is deleted.
60
3.3.22 Manage user data

You can backup and restore management data, export user statistics and generate reports
(page 66) about users, user groups, privileges, licenses, assignments, etc.
3.3.22.1 Back up user management data

You can create a backup file based on the data in user management. Optionally, you can
include the user statistics.
To avoid data inconsistencies and possible data loss, you must not perform any of the
following activities in parallel, neither manually nor scheduled:
- Deleting any Process Governance process instance, process version, or process
- Archiving Process Governance process instances
- Backup/restore tenant (containing Process Governance or ARIS document storage data)
Prerequisites
 If you want to include the user statistics, the property User statistics in backup
(com.aris.umc.user.statistics.backup) must be enabled in the configuration (see ARIS
help: ARIS Administration > Configuration > User management > Security > Advanced
settings). By default, this property is disabled.
Procedure
4. Click Back up data. The Back up user management data dialog opens.
5. Enter a password and confirm it. The password is required for restoring this file.
6. Optionally, you can include the user's photos in the data backup.
7. Click Start.
The user management data is saved in JSON format in a ZIP file. The file is separated into
several areas to enable even large data volumes to be saved easily: users, user groups, user
settings, licenses, license rules, pictures, privileges, configuration, and charts. Backups from
an ARIS installation version 9.7 and older can be restored. Backups from the current ARIS
installation cannot be restored in older versions.
61
3.3.22.2 Restore user management data

You can restore previously backed up user management data in Administration. Deactivate
LDAP before restoring the data to speed up the process. Backups from an ARIS installation
version 9.7 and older can be restored. Backups from the current ARIS installation cannot be
restored in older versions.
Prerequisite
Procedure
4. Click Restore data. The corresponding dialog opens.

5. Select the backup file.
6. Enter the password to open the file.
7. Click Start.
The user management data is restored.
3.3.22.3 Export user statistics

Export statistics about users. Optionally, you can export usage patterns, assignments,
changes to data and database items made by the user, the information used most often or
the information used last, etc.
Prerequisites
 Generate user statistics (com.aris.umc.audit.enabled) is enabled in the configuration
(User management > Security > Advanced settings). If License monitoring (User
management > License monitoring > General) is enabled, Generate user statistics is
automatically enabled.
Procedure
4. Click Export user statistics. The corresponding dialog opens.
62
5. Select the information that the report should output (event type). Ensure that the
maximum number of entries included do not exceed 500.000.
6. Select the output format.
7. Select the time period over which the statistics should be created.
8. If you want to delete the generated statistics directly after export, enable Purge user
statistics. To prevent large amounts of data from accumulating, the generated statistics
are automatically deleted after the specified number of days ( Configuration >
Security > Advanced settings > Purge user statistics older than this number of
days).
9. Click OK.
The user statistics are output in the selected format.
3.3.22.4 Generate report

Generate reports (page 66) about users, user groups, privileges, licenses, assignments, etc.
Prerequisite
Procedure

5. Select the relevant report.
6. Select the output format.
7. Click Start.
8. Click OK.
63
3.3.22.5 Generate License audit (password-protected)

report
report. This report is applicable to Concurrent and Named user licenses. For detailed
(https://www.softwareag.com/corporate/company/global/offices/default.html).
Prerequisite
 License monitoring is enabled in Licenses > Monitoring > Configuration.
Procedure

5. Select License audit (password-protected) report.
6. Click Run.
The report is output as a password-protected ZIP file containing an Excel file and a JSON file.
Send this password-protected report to Software AG for evaluation.
64
3.3.22.6 Generate License usage rule validation report

Generate a report that lists the license usage based on the license rule. This report is
applicable to Concurrent and Named user licenses.
Prerequisite
 License monitoring is activated (page 7) ( Licenses > Monitoring > Configuration).
 An active license rule is available (page 8) ( Licenses > Monitoring > Rules).
Procedure

5. Select License usage rule validation report.
6. Click Run.
65
3.3.22.7 Which reports exist?

You can generate the following reports as Excel files.
LICENSE AUDIT (PASSWORD-PROTECTED)

Lists the maximum consumption of each license per day.
USER GROUPS WITH ASSIGNED USERS AND PRIVILEGES

Outputs a list of the selected user groups and the users assigned to them, along with the
function and license privileges granted to the user via the group.
ACTIVE USER SESSIONS

Outputs a list of all users currently logged in to ARIS, along with the start date and time of the
session.
ASSIGNED AND UNUSED ARIS LICENSES

Outputs the total number of products and licenses, along with the number of licenses used
and available.
LICENSE USAGE RULE VALIDATION

Based on the license rule specified, this report lists the license violations that occur in the
system.
USERS WITH ASSIGNED PRIVILEGES

Outputs a list of the selected users with their assigned function and license privileges.
66
3.3.22.8 Active sessions and history

USERS > <USER NAME> > ACTIVE SESSIONS
Obtain information on the time the user was logged in. This is where you can also log out the
user (page 30).
USERS/USER GROUPS > <USER NAME/USER GROUP NAME> > HISTORY

Retrieve information on the events including their timestamp of a user/user group:
USERS
 User created
 User updated
 Privilege assigned
 User assigned to a group
 Synchronized with LDAP
 Login failed
 Password changed
USER GROUPS
 User group created
 User group updated
 Privilege assigned
 User assigned
 Synchronized with LDAP
67
3.3.22.9 ARIS Architect 'Administration' tab versus ARIS

Administration
Users and privileges are managed centrally for all databases and ARIS products of an
activated tenant. The role-dependent data access is controlled by access privileges and
filters that are assigned per database in ARIS Architect on the Administration tab.
ARIS ADMINISTRATION
Centrally manage users, user groups, privileges, licenses, and configurations for all databases
of a tenant. This ensures single sign-on for various ARIS products. Users can also be created
using an LDAP system.
'ADMINISTRATION' TAB IN ARIS ARCHITECT

When you create a database, all users and user groups from the user management are
automatically imported into the database. Administrators assign function and access
privileges, as well as filters (page 830) to users and user groups in each database so that only
authorized users can view certain database content or perform specified actions. Use the
prefix management to track which user created or changed database items.
ARIS video tutorial

68
3.3.22.10 Delete and anonymize user accounts

Users can only be deleted (page 35) in ARIS Administration. To anonymize users in the
different ARIS components according to GDPR (page 1139), follow the instructions of the
respective online help or manual:
 ARIS Cloud Controller (ACC) Command-line Tool manual
 ARIS Server Administrator Command-line Tool manual
 ARIS document storage Command-Line Tool manual
 ARIS Process Governance Command-Line Tool manual
 User Management Command-Line Tool manual
 ARIS Risk and Compliance online help > Procedures > Use ARIS Risk and Compliance
administration > Anonymize users and Specify anonymization patterns
 Collaboration > online help > Administrate Collaboration > How can user accounts be
deleted and anonymized?
After anonymization, users and their activities are shown with Anonymized user instead of
with the user name.
69
3.3.23 Configure user management

You can customize general settings of your system's user management.
3.3.23.1 Import configuration

You can import ARIS document storage settings that were exported as a backup or exported
from another tenant to overwrite the current user management configuration. This includes,
for example, security settings or the configuration of user management systems such as
LDAP (page 1142) or SCIM (page 1150). We recommend that you backup (page 71) your existing
configuration before you import a configuration in case that the imported configuration does
not meet your expectations.
Prerequisite
Procedure
Configuration view.
2. Click Configuration.
3. Click User management.
4. Click Import configuration file.

The Import configuration file dialog opens. Navigate to the location where the configuration
file is stored and import it. The new configuration is active immediately and no system restart
is required.
70
3.3.23.2 Export configuration

You can export ARIS document storage settings that were imported as a backup or imported
from another tenant to overwrite the current user management configuration. Only changed
properties will be exported. However, cross-tenant are not exported. Cross-tenant properties
are properties that are used system-wide and can only be changed using ARIS Cloud
Controller. For more information, refer to ARIS Cloud Controller (ACC) Command-line Tool
manual.
Prerequisite
 You have the Technical configuration administrator function privilege.
 You have allowed pop-ups for the pages of ARIS Administration.
Procedure
Configuration view.
4. Click Export current configuration as a file.

You can save the configuration file at the relevant location for further use.
71
3.3.23.3 Configure user for impersonation

Impersonation (page 73) enables a user to assume another user account. The user can then
perform operations that are actually only permitted for the other account. This configuration
must be set for each tenant.
Prerequisite
Procedure
1. Log in to User Management.
Click the link that was provided to you or that you have saved as a bookmark in your
browser, for example, http://myServer:1080/#myTenant/adminUsers. The Log in
dialog opens.
2. Enter the name of the infrastructure tenant in the Tenant field, for example, master.
3. Enter your user name and your password.
4. Click the user for which you want to allow impersonation.
7. Activate the Impersonation function privilege.
8. Log out.
9. Log in (page 3) to ARIS.
Configuration view.

13. Click the arrow next to Users.
14. Click General.
15. Click Edit.

16. Click in the Impersonation target users field.
17. Enter the users for which you want to allow impersonation as a comma-separated list.
Warning
If the ARIS server was updated, make sure to reenter the user names for all operational
tenants in the Impersonation target users field again.
18. Click Save.

You have allowed users to use impersonation.
72
3.3.23.4 Impersonation
Users manage tenants on behalf of the user superuser. This requires the creation of these
users in the user management for the infrastructure tenant, for example, master (page 72). To
use impersonation, users require the Impersonation function privilege in the infrastructure
tenant.
For Tenant Management, they also require the User administrator, Tenant administrator,
and Technical configuration administrator function privileges.
In all other operational tenants, for example, default, the user superuser must be defined as
the target for impersonation (page 985). Impersonation enables users to back up tenants in
which they do not exist as a user.
To back up and restore the data, the superuser user requires the following function
privileges in all operational tenants:
 Analysis administrator
 ARCM administrator
 Collaboration administrator
 Database administrator
 Dashboard administrator
 Document administrator
 License administrator
 Portal administrator
 Process Governance administrator
 Server administrator
 Technical configuration administrator
 User administrator
73
3.3.23.5 What is the default user group?

You can configure a default user group in the ARIS Administration. This group must exist in
the ARIS Administration. A user is automatically assigned to this default user group whenever
a user is created.
All local users who were created after specifying a default user group are automatically
assigned to this group.
You can specify an LDAP user group as default user group. All LDAP users in the LDAP group
are assigned to this group.
Hidden users such as, for example, arisservice, are never assigned to the default user group.
74
3.3.23.6 Customize infrastructure

You can customize general settings of your system infrastructure, for example, format of
e-mail in HTML.
You can customize your system configuration as required. You carry out this part of the
configuration in ARIS Administration.
You can change properties that are highlighted as cross-tenant properties only by using the
ARIS Cloud Controller command-line tool. To change the settings, enter the following:
reconfigure umcadmin_<size of your installation, s, m, or l> JAVA-D<property
name>="<value>"
Example
reconfigure umcadmin_m JAVA-Dcom.aris.umc.loadbalancer.url="https://myserver.com"
Prerequisite
Procedure
Configuration view.
3. Click User Management.
4. Click Infrastructure. To configure further settings, click a configuration category.
5. Click Edit.
The Cross-tenant symbol indicates that the settings made apply to all tenants on
this server and cannot be changed.
6. Adjust your settings.
7. Click Save.
You have customized your system configuration.
75
3.3.23.7 Kerberos
Kerberos is a computer network authentication protocol that works on the basis of tickets to
allow nodes communicating over a non-secure network to prove their identity to one another
in a secure manner.
3.3.23.7.1 Customize Kerberos settings

configuration in ARIS Administration. Adapt you Kerberos (page 1141) settings.
name>="<value>"
Example
Prerequisite
Procedure
Configuration view.
4. Click the arrow next to Kerberos.
5. Click a configuration category.
6. Click Edit.
8. Click Save.
76
3.3.23.7.2 Upload Kerberos configuration files

You can upload the Kerberos configuration file or the key table.
Prerequisite
Procedure
Configuration view.
4. Click the arrow next to Kerberos. The Cross-tenant symbol indicates that the
settings made apply to all tenants on this server and cannot be changed.
5. Click General.
6. To upload the key table file, click Upload under the Key table field. To upload the
configuration file, click Upload under the Configuration file field. You find this file on
your installation medium under Add-ons\Kerberos. The dialog for uploading a file opens.
7. Select the relevant file.
You have uploaded a configuration file.
CREATING A KEY TABLE FILE

If you have no key table file available, generate a key table file using the JRE tool ktab.exe. To
do so, enter the following in the console:
ktab -a userPrincipalName@REALM password -n 0 -append -k umc.keytab
DISPLAY EXISTING KEY TABLE FILE

You can display the content of an existing key table file using the JRE tool ktab.exe. To do so,
enter the following in the console:
ktab -l -e -t -k FILE:C:\<file location of the umc.ktab file>\umc.ktab
77
3.3.23.8 LDAP
LDAP is an application protocol from the network technology. LDAP enables information from
a distributed, location-independent, and hierarchical database in a network to be queried and
modified.
3.3.23.8.1 Add LDAP server

LDAP (page 1142) enables information from a distributed, location-independent and
hierarchical database in a network to be queried and modified.
You can use multiple LDAP servers with ARIS.
The migration to multiple LDAP servers is irreversible. Any existing LDAP data needs to be
deleted manually before the migration.
Prerequisite
Procedure
Configuration view.
4. Click the arrow next to LDAP.
5. Click General settings.
6. Click Edit.
7. Enable Use LDAP.
8. If you want to use ARIS with multiple LDAP systems, enable Activate multiple LDAP
integration and click OK in the Confirmation of property value change dialog.
9. Click Save.
10. Click Add. The Add LDAP server dialog opens.

11. Enter the following:
 ID of the LDAP server
 Display name of the LDAP server
 LDAP server URL
 LDAP server fallback URL
 User name of the user who has access to the LDAP content
78
 Password of this user

 Specify whether to use SSL and in which mode.
 Specify whether to verify host names and certificates.
 Simultaneous connections are a cross-tenant property. You can change them only
using ARIS Cloud Controller. For more information, refer to ARIS Cloud Controller
(ACC) Command-line Tool manual.
 Specify the connection timeout
 Specify the read timeout
12. Click Save.
13. Click Save.

You have added an LDAP server.
If you want to specify more than one LDAP server, proceed with step 10 of the procedure
steps mentioned above.
To delete an LDAP server, click the arrow next to the relevant LDAP server, click Connection,
and click Delete.
3.3.23.8.2 Test connection to an LDAP server

Prerequisite
Procedure
Configuration view.
5. Click the arrow next to the relevant LDAP server.
6. Click Connection.
7. Click Test connection.

A message is displayed, whether or not the connection to the LDAP server specified is valid.
79
3.3.23.8.3 Edit connection to an LDAP server

Prerequisite
Procedure
Configuration view.
7. Click Edit.
 ID of the LDAP server
 Display name of the LDAP server
 LDAP server URL
 LDAP server fallback URL
 User name of the user who has access to the LDAP content
 Password of this user
 Specify whether to use SSL and in which mode.
 Specify whether to verify host names and certificates.
 Simultaneous connections are a cross-tenant property. You can change them only
using ARIS Cloud Controller. For more information, refer to ARIS Cloud Controller
(ACC) Command-line Tool manual.
 Specify the connection timeout
 Specify the read timeout
9. Click Save.
You have edited an LDAP server connection.
80
3.3.23.8.4 Upload LDAP truststore file

You can upload the truststore file.
Prerequisite
Procedure
Configuration view.
6. Click Truststore. You must have generated a truststore file.
7. Click Upload. The Truststore dialog opens. Select the truststore file you want to use
and click Upload.
You have uploaded a truststore file
3.3.23.8.5 Customize LDAP settings

Prerequisite
Procedure
Configuration view.
81

8. Click Edit.
10. Click Save.

3.3.23.8.6 Customize ARIS for LDAP server operations

You can configure ARIS for LDAP server operations.
Prerequisite
Procedure
Configuration view.
6. Click Edit.
7. Enable Use LDAP.
8. If you want to upload a configuration, ensure that you have disabled pop-up blockers in
the browser.
Click Truststore. You must have generated a truststore file.
9. Click Upload. The Truststore dialog opens. Select the truststore file you want to use
and click Upload.
11. Configure the URL for the LDAP system. Click Connection.
12. Configure the LDAP URL by entering an ID, a name, and the URL in the Server URL field,
for example:
ldap://hqgc.mycompany.com:3168.
82
13. Configure the fallback URL of the LDAP backup system in the Server URL (fallback) field.
This backup system takes over automatically if the LDAP server cannot be reached via its
primary URL.
14. Click Save.

15. Click Behavior.
16. Click Edit.

17. Enter the path to the user group in the Group search paths field.
18. Enter the path to the users in the User search paths field.
19. If you configure only one LDAP server, you can skip this step.
If you use a system with multiple LDAP servers, you must configure referrals.
Select ignore if you do not want to search all configured LDAP servers. The LDAP
operations are performed only on the primary LDAP server.
Select follow if you want to execute the operations on all configured LDAP servers.
Select throw if you want to execute the operations on all configured LDAP servers. All
valid users are included, and the result is logged. Valid users and invalid users are listed in
the LDAP.log file.
20. Click Save.

To ensure that the import of LDAP users does not fail despite any errors that might occur,
for example, if names are duplicated, click LDAP > General settings > Advanced
settings and enable Skip errors.
You have configured ARIS for LDAP server operations.
83
3.3.23.8.6.1 Configure secure communication

You can encrypt the communication between ARIS and the LDAP server.
To do so, you have two mutually exclusive options:
 STARTTLS
This transforms a connection that was originally untrusted into an encrypted connection
without using a specific port.
 SSL
The connection between ARIS and the LDAP server is established using a specific port.
Prerequisite
 The LDAP server has a valid SSL certificate and LDAPS is activated.
 ARIS Administration trusts the LDAP server (the SSL certificate of the LDAP server or the
certification authority is stored in the JRE database of trustworthy certificates).
STARTTLS
You can use STARTTLS to configure encrypted communication between ARIS and the LDAP
server.
Procedure
Configuration view.
7. Click Edit.
8. Configure the URL for the LDAP system. To do so, enter the URL as in the Server URL
field, for example:
primary URL.
10. Enable Use SSL.
11. Select STARTTLS from the SSL mode list.
84
12. ARIS must trust the LDAP server used. Therefore, we recommend that you use the LDAP
server with a certificate signed by a public certification authority. If your certificate is
signed by a public certification authority and stored in the list of trustworthy certificates
of your JRE, you do not need to configure anything else.
13. Upload LDAP truststore file (page 81).
SSL
Procedure
1. Start ARIS.
2. Click Application launcher > Administration.
8. Click Edit.
9. Configure the URL for the LDAP system. To do so, enter the URL as in the Server URL
field, for example:
primary URL.
11. Enable Use SSL.
12. Select SSL from the SSL mode list.
13. ARIS must trust the LDAP server used. Therefore, we recommend that you use the LDAP
server with a certificate signed by a public certification authority. If your certificate is
signed by a public certification authority and stored in the list of trustworthy certificates
of your JRE, you do not need to configure anything else.
14. Upload LDAP truststore file (page 81)
85
3.3.23.8.6.2 Allow login for LDAP users only

To allow only LDAP users to log in to ARIS Architect and ARIS, you need to configure the
system accordingly.
Prerequisite
Procedure
Configuration view.
5. Click the arrow next to General settings.
6. Click Advanced settings.
7. Enable Prevent login of manually created users.
Only LDAP users and the following users can log in: system, superuser, arisservice, and
guest.
86
3.3.23.8.6.3 Configure single sign-on (LDAP)

If you are using Microsoft® Active Directory Domain Services, you can configure SSO (single
sign-on) (page 1150). This allows users to work with all ARIS components as soon as they are
logged in to the domain. Separate login to ARIS components is not required.
Please contact your LDAP administrator before you change any configuration.
To use SSO, you must use LDAP with either Kerberos or SAML.
Prerequisite
Server
 Users who want to use SSO must have a valid Microsoft® Active Directory Domain
Services user login.
 This user is available in ARIS Administration.
 ARIS Administration authenticates against LDAP.
 Microsoft® Active Directory Domain Services supports Kerberos-based authentication
(default) and the service principal name of the ARIS Server is entered in the following
format: HTTP/<hostname>, for example, HTTP/mypc01.my.domain.com.
Client
 The client computers and servers are connected to the same Microsoft® Active Directory
Domain Services.
 The browser has been configured accordingly.
87
3.3.23.8.6.3.1 Use Kerberos

Kerberos is a network authentication, allowing nodes to communicate using an invisible
network and to securely make their identity known to each other. Kerberos is the
recommended method for user authentication in Microsoft® Windows networks. In addition, it
is widely used with Linux operating systems and is designed for use with all major platforms.
Procedure
Configuration view.
4. Click the arrow next to Kerberos.
5. Click General.
If you do not have a Kerberos configuration file, take the kbr5.conf from your installation
media under Add-ons\Kerberos. Name it, for example, krb5.conf, add the following
lines, and adjust the configuration to meet your requirements.
[libdefaults]
default_tgs_enctypes = des-cbc-md5 des-cbc-crc des3-cbc-sha1 aes128-cts
aes128-cts-hmac-sha1-96 aes256-cts aes256-cts-hmac-sha1-96 rc4-hmac
arcfour-hmac arcfour-hmac-md5
default_tkt_enctypes = des-cbc-md5 des-cbc-crc des3-cbc-sha1 aes128-cts
permitted_enctypes = des-cbc-md5 des-cbc-crc des3-cbc-sha1 aes128-cts
6. To upload the configuration file, click Upload under the Configuration file field. You
find this file on your installation medium under Add-ons\Kerberos.
7. Click Edit.
8. Enable Use Kerberos.
9. In the Principal field, enter the technical user name given by the administrator.
If the Service Principal Name in the keytab is, for example, mypc01@MY.DOMAIN.COM,
the values of the property com.company.aris.umc.kerberos.servicePrincipalName
must contain the Service Principal Name exactly as specified in the keytab file.
10. In the Realm field, configure the realm for the Kerberos service. Enter the fully qualified
domain name in uppercase letters.
Example: MYDOMAIN.COM.
11. In the KDC field, configure the fully qualified name of the KDC to be used.
88
12. Optional:
a. Click Advanced settings.
b. Enable Debug output.
The debug output of the program that the user wishes to log into is saved in the file
system.out of the respective program. For user management, for example, this is
located in the directory <ARIS installation
directory>/work_umcadmin_m/base/logs.
You have configured SSO using Kerberos in ARIS Administration.
You can use Kerberos with multiple LDAP systems (page 93).
CLIENT CONFIGURATION
Configure the browser settings to allow SSO. SSO has been tested with the following
browsers:
 Microsoft® Internet Explorer® (version 11 or higher)
 Mozilla Firefox®
Prerequisite
 SSO must be configured for the servers.
 The browser used supports a Kerberos-based authentication.
You need to empty the Kerberos ticket cache of each client first, in order to avoid obsolete
tickets if Microsoft® Active Directory Domain Services were changed. Delete the Kerberos
ticket cache by executing the command klist.exe purge. If the purge program is not available
on the client computer, you can also simply log off the client computer from the domain and
log in again.
89
MICROSOFT® INTERNET EXPLORER®

Microsoft® Internet Explorer® supports Kerberos authentication only if the ARIS Server is part
of your local intranet.
Procedure
1. Start Microsoft® Internet Explorer®.
2. Click Tools > Internet Options.
3. Activate the Security tab and click Local Intranet.
4. Click Sites, and select Advanced.
5. Add the URL of the ARIS Server that was configured for SSO. Add the DNS host name and
the IP address of the ARIS Server.
6. Optional: Disable the Require server verification (https:) for all sites in this zone
check box.
7. Click Close, and select OK.
8. Click Custom level and make sure that no user-defined settings affect your new
settings.
9. Find the User Authentication section. Verify whether the Automatic logon only in
Intranet zone option is enabled.
10. Click OK.
11. Close and restart Microsoft® Internet Explorer®.
MOZILLA FIREFOX®
In Mozilla Firefox®, you can define trustworthy sites using the computer name, IP address, or a
combination of both. You can use wildcards.
Procedure
1. Start Mozilla Firefox®.
2. Enter about:config in the address box and press Enter. Confirm a message, if required.
3. Enter network.negotiate in the Search box and press Enter, if required.
4. Double-click network.negotiate-auth.trusted-uris.
5. Enter the computer name or the IP address of the ARIS Server that you configured for
SSO, and click OK.
6. Close and restart Mozilla Firefox®.
If you prefer to use an encryption stronger than AES 128bit and this is allowed in your
country, replace the JCE Policy file of the JDK of your ARIS Server with the Java
Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files 6
90
(http://www.oracle.com/technetwork/java/javase/downloads/index.html). This allows

unlimited key length.
If you cannot replace the Policy files, but still want to use SSO, you need to apply a procedure
allowed by the JDK for encrypting Kerberos tickets, for example, AES 128bit.
91
3.3.23.8.6.3.2 Use SAML

SAML (Security Assertion Markup Language) is an XML framework for exchanging
authentication and authorization information. SAML provides functions to describe and
transfer security-related information.
Prerequisite
 The SAML identity provider supports the HTTP POST binding as specified by the SAML 2.0
specification.
 If you use multiple LDAP systems, the user names must be unambiguous through all
LDAP systems. Otherwise, no SSO is possible.
 SSO must be configured for the servers.
Procedure
Configuration view.
4. Click the arrow next to SAML.
5. Click General.
6. Click Edit.
7. Enable Use SAML.
8. Enter the ID of the identity provider in the Identity provider ID field.
9. Enter the ID of the service provider in the Service provider ID field.
10. Enter the end point of the identity provider that is used for single sign-on in the Single
sign-on URL field.
11. Enter the end point of the identity provider that is used for single log-out in in the Single
logout URL field.
You have configured SSO using SAML in ARIS Administration. If you use multiple LDAP
systems (page 93), the user names must be unambiguous through all LDAP systems.
Otherwise, no SSO is possible.
You can use SAML with multiple LDAP systems (page 93).
92
3.3.23.8.7 Using multiple LDAP servers
KERBEROS
Even if you have configured multiple LDAP systems, you can use only one LDAP server with
Kerberos authentication.
When using multiple LDAP systems, the Ignore realm from service ticket property under
Kerberos -> Advanced Settings must be enabled.
SAML
If a user is created during login using SAML, the user name will not have any prefix and is
assigned to the default user group. This user is not mapped to any LDAP server.
SINGLE SIGN-ON
If users have the same login ID in different LDAP servers, the Single sign-on (page 87) login
fails. Users must enter their passwords manually instead.
93
3.3.23.9 User defined notifications

You can specify whether or not users are informed about, for example, their creation,
password changes, or a license expiration.
3.3.23.9.1 Customize user-defined notifications

Variables (page 98) may be used to personalize the content of a notification of ARIS
Administration. Variables can be used in both notification subject and body.
Prerequisite
 You have uploaded (page 95) the relevant templates for user-defined notifications.
Procedure
Configuration view.
4. Click the arrow next to User-defined notifications.
6. Click Edit.
8. Click Save.
94
3.3.23.9.2 Upload templates for notifications

You can upload the templates for user-defined notifications.
Prerequisite
Procedure
Configuration view.
5. Click a category.
6. Click Upload. The dialog for uploading a file opens.

7. Click Select file. Select the relevant file.
8. Click Upload. A confirmation prompt is displayed.
9. Click Close.
You have uploaded a template for notifications.
95
3.3.23.9.3 Customize default HTML templates for

notifications
You can customize the templates for user-defined notifications. Variables (page 98) may be
used to personalize the content of a notification of ARIS Administration. Variables can be
used in both notification subject and body.
Prerequisite
Procedure
Configuration view.
6. Click Upload. The corresponding dialog opens.

7. Enable Advanced template configuration.
8. Select Default.
10. If you want to preview the HTML template, click Preview. An e-mail is sent to your user
and you can check the template you are customizing. If you want to exchange the logo,
make sure that the logo is saved on the server to grant access whenever e-mails are
automatically sent.
11. Click Save.
You have customized the default HTML e-mail template.
96
3.3.23.9.4 Customize HTML templates for multiple locales

You can customize the templates for user-defined notifications. Variables (page 98) may be
used to personalize the content of a notification of ARIS Administration. Variables can be
used in both notification subject and body.
Prerequisite
Procedure
Configuration view.
6. Click Upload. The corresponding dialog opens.

7. Enable Advanced template configuration.
8. Select a locale.
10. If you want to preview the HTML template, click Preview. An e-mail is sent to your user
and you can check the template you are customizing. If you want to exchange the logo,
make sure that the logo is saved on the server to grant access whenever e-mails are
automatically sent.
11. Click Save.
You have customized the HTML e-mail template for a locale. If an e-mail is sent to a user and
a notification language is specified for this user, the corresponding HTML template is now
used for this language.
97
3.3.23.9.5 Variables for user-defined notifications

Variables (page 98) may be used to personalize the content of a notification of ARIS
Administration. Variables can be used in both notification subject and body. The following
variables are supported:
TEXT NOTIFICATIONS:
 @tenant.name - Name of the tenant the user belongs to
 @user.login - Login of a user receiving notifications
 @user.givenName - First name of a user receiving notifications
 @user.lastName - Last name of a user receiving notifications
 @user.password - (New) password of a user receiving notifications
The following variables are supported for license-related events:
 @license.serial - Serial number of a license
 @license.productName - Name of a licensed product
 @license.expiry - Expiration date of a licensed product in the format YYYY-MM-DD
HTML NOTIFICATION
 ${tenant.name} - Name of the tenant the user belongs to
 ${user.login} - Login of a user receiving notifications
 ${user.givenName} - First name of a user receiving notifications
 ${user.lastName} - Last name of a user receiving notifications
 ${user.password} - (New) password of a user receiving notifications
 ${user.otpSecret}- Token secret of a user receiving notifications
The following variables are supported for license-related events:
 ${license.serial} - Serial number of a license
 ${license.productName} - Name of a licensed product
 ${license.expiry} - Expiration date of a licensed product in the format YYYY-MM-DD
98
3.3.23.10 Customize password policy

You can customize the password policies such as length or strength of a password depending
on the use of special characters, numbers, etc.
Prerequisite
Procedure
Configuration view.
4. Click the arrow next to Password policy.
6. Click Edit.
8. Click Save.
99
3.3.23.11 SAML
SAML is an XML framework for exchanging authentication and authorization information.
SAML provides functions to describe and transfer security-related information. ARIS supports
SAML 2.0.
3.3.23.11.1 Customize SAML settings

ARIS supports SAML 2.0. You can customize the SAML settings for your ARIS system.
name>="<value>"
Example
Prerequisite
Procedure
Configuration view.
6. Click Edit.
8. Click Save.
100
3.3.23.11.2 Upload keystore file

You can upload the keystore file.
Prerequisite
Procedure
Configuration view.
5. Click Keystore.

You have uploaded a keystore file.
3.3.23.11.3 Upload truststore file

You can upload the truststore file.
Prerequisite
Procedure
Configuration view.
5. Click Truststore. You must have generated a truststore file.

You have uploaded a truststore file
101
3.3.23.12 Customize security settings

name>="<value>"
Example
Prerequisite
Procedure
Configuration view.
4. Click the arrow next to Security.
6. Click Edit.
8. Click Save.
102
3.3.23.13 Customize SMTP settings

name>="<value>"
Example
Prerequisite
Procedure
Configuration view.
4. Click the arrow next to SMTP.
6. Click Edit.
8. Click Save.
103
3.3.23.14 Customize user settings

You can configure a default user group in the ARIS Administration. This group must exist in
the ARIS Administration. A user is automatically assigned to this default user group whenever
a user is created.
All local users who were created after specifying a default user group are automatically
assigned to this group.
You can specify an LDAP user group as default user group. All LDAP users in the LDAP group
are assigned to this group.
Hidden users such as, for example, arisservice, are never assigned to the default user group.
Prerequisite
Procedure
Configuration view.
6. Click Edit.
8. Click Save.
104
3.3.23.15 SCIM
System for Cross-Domain Identity Management (SCIM) is designed to facilitate the
management of user identities in cloud-based applications and services. ARIS supports SCIM
2.0.
3.3.23.15.1 Customize SCIM settings

configuration in ARIS Administration. ARIS supports SCIM (page 1150) with SAML 2.0.
administrator.
Prerequisite
Procedure
Configuration view.
4. Click the arrow next to SCIM.
6. Click Edit.
8. Click Save.
105
3.3.23.15.2 Generate bearer token

If you suspect that your bearer token (page 1124) is no longer safe, you can generate a new
bearer token and hand it over to your SCIM administrator.
administrator.
Prerequisite
Procedure
Configuration view.

5. Click Generate bearer token. The dialog opens.

6. Click OK to confirm.
If the bearer token is newly created, the bearer token is displayed in the SCIM bearer token
field. If a bearer token already exists, the Generate bearer token dialog opens and you can
confirm that a new bearer token should be created.
106
3.3.23.15.3 Copy bearer token to clipboard

You can copy the bearer token (page 1124) to the clipboard to hand it over to your SCIM
administrator so that he can import it.
Prerequisite
Procedure
Configuration view.

4. Click Copy to copy the bearer token to the clipboard.
You can hand over the bearer token to your SCIM administrator so that he can import it.
107
3.3.23.15.4 Delete bearer token

You can delete a bearer token.
Prerequisite
Procedure
Configuration view.

5. Click Delete.
The bearer token is deleted.
3.3.23.15.5 Specify SCIM client

You can specify a SCIM client.
Prerequisite
Procedure
Configuration view.
5. Click a SCIM client.
6. Click Edit.
8. Click Save.
You have specified a SCIM client.
108
3.3.23.16 Customize Application switcher

You can enable a specific ARIS Process Mining system and specify the relevant URL. Process
Mining is the visualization and analysis of business processes on the basis of event logs using
algorithms and mathematical methods.
Prerequisite
 You have an ARIS Process Mining system running.
 You have the ARIS Process Mining administrator function privilege.
Procedure
Configuration view.

3. Click the arrow next to Application switcher.
4. Click General.
5. Click Edit.
6. Enable Link to ARIS Process Mining.
7. Enter the relevant URL.
8. Enter the tenant.
9. Click Save.
You have enabled and configured ARIS Process Mining.
109
3.3.23.17 Customize OAuth 2.0 settings

configuration in ARIS Administration. ARIS supports OAuth 2.0 (page 1146).
Prerequisite
Procedure
Configuration view.
4. Click the arrow next to OAuth 2.0.
6. Click Edit.
8. Click Save.
110
3.4 Display charts

Charts represent accumulated statistics data graphically. You can view charts for the
following areas: Overview, Users, Documents, Modeling, and Governance. Charts can be
used, for example, to perform real-time checks.
Prerequisite
You have the following function privileges:
 User administrator (user-related charts in Overview and Users charts)
 Document administrator (ARIS document storage-related charts in Overview and
Documents charts )
 Database administrator (database-related charts in Overview and Modeling charts)
 Process Governance administrator (Process Governance-related charts in Overview
and Governance charts)
automatically enabled. Only the Users > License usage chart is displayed regardless of
this activation.
Procedure
2. Click Charts.
3. Click the relevant area, for example, Modeling.
The charts for the selected area are displayed. The user management charts do not contain
any data for technical users by default (system, superuser, arisservice, and guest). Move the
mouse pointer over a chart to view an explanation.
You can update the charts to reflect the current state by clicking Refresh. You can also
export (page 62) statistics on usage patterns, assignments, changes to data and database
items made by the user, the information used most often or the information used last, etc.
111
3.5 Manage databases

Databases contain all information of your models and objects, classified in groups. Only
authorized users have access to database content they need for work. The content they see
and the actions they can take vary depending on the granted privileges in the User
management and the privileges you can define for each database.
If you have the ARIS Enterprise Administration license privilege and the Database
administrator function privilege, you can manage all databases available on a tenant. Click
Application launcher > Administration > Configuration > Databases to get an
overview about all default settings for each database and whether you can use multiple data
versions.
For indicated databases, users can create multiple model versions. Keep in mind that for
versionable databases, the amount of required memory increases. Over-sized databases
can cause performance issues.
You can do the following:
In the overview table, you can change the default filter, language, font format, or palette.
Defaults are automatically used for a database when a user logs in.
For each database, you can apply a default palette. You can change the default palette to
display all model objects of a database in a different style. The ARIS default palette contains
the most current symbols. The ARIS default palette (classic) contains all object symbols
used in ARIS 7.2 Method.

2. To change the palette, in the Default palette column, click the palette that is currently
used for the database.
3. Select the palette and click Save.
The palette is assigned as the default palette. All objects are displayed in the database using
the symbols of the selected palette.
If you have switched from the classic to the current symbol palette, all model objects are
enlarged. Therefore, you may need to adapt the layout of the models in ARIS Architect (for
detailed information (../../../../../../../abs/help/en/handling/ba/#/home216459/en/1), see
ARIS Architect online help).
Font formats that you create for databases define the representation of database content in
models. These font formats are available only in the database for which they are created. This
enables you to individually design models and deviate from the conventions defined for your
company. Font formats are closely related to templates (page 968).
For each database, you can select the font format that is automatically used if users have not
assigned a template to models.
112

2. To change the font format, in the Default font format column, click the font format that
is currently used for the database.
3. Select the font format that you want to use and click Save.
The font format is automatically used to display model content if no template is assigned.
To ensure that users can read text regardless of the selected language, you can choose a
default database language. The default language of a database is used to display text that
was not entered in the current language. For example, names that are not entered in the
current language are otherwise displayed as <Untitled>, which makes work more difficult. If
users enter all language-dependent text attributes in the default language, the displayed
written text is legibly, though not uniformly in one language.
To change the default language, proceed as follows.

2. To change the language, in the Default language column, click the language that is
currently used for the database.
3. Select the language in which all attribute values are specified and click Save.
The selected language is used as an alternative database language. Note that you must enter
all language-dependent attribute values in the selected language to prevent items from being
displayed as <Untitled>.T
For each database, you can select a method filter that is automatically used to log in
authorized users. Filters provide users with only the information and methods relevant to
them.

2. To change the method filter, in the Default filter column, click the filter that is currently
used for the database.
If <Invalid filter> is displayed, the database was restored to the tenant but the related
default method filter was not available at that time. In this case, first import (page 820)
the method filter and then assign it as the default filter.
3. Select the filter and click Save.
The method filter is automatically assigned to authorized users and user groups.
Create database
You can add databases to the tenant and make them available to authorized users.

2. Click Create database.
113
3. Enter the database name. You can enter numbers, spaces, letters, and the following
special characters: - _ . ( ). Note that using special characters can cause problems when
such databases are called by command-line tools and special characters are not escaped
correctly.
4. Enable Versionable if you want to allow users to create multiple model versions. Keep in
mind that for versionable databases, the amount of required memory increases.
5. Click Create.
The database is added to the list. Specify (page 118) all database Properties as required.
Restore a database
You can restore databases using ADB backup files that you created in ARIS, ARIS Architect, or
Tenant Management for ARIS version 7.2 and later. You can also use the Restore database
function to copy databases to multiple tenants or to convert an existing database to a
versionable database.

2. Select the database and click Restore. Make sure that sufficient disk space is
available for restoring large databases. This may exceed the memory requirements stated
in the document ARIS System Requirements.
3. Click Select file, navigate to the ADB backup file, and click Open.
4. If a database of the same name already exists on this tenant, enter a different database
name. Otherwise, the action is stopped to prevent the database content from being
overwritten. You can enter numbers, spaces, letters, and the following special characters:
- _ . ( ). Note that using special characters can cause problems when such databases are
called by command-line tools and special characters are not escaped correctly.
5. If the backup file is protected by a password, specify the password that was entered
when the database was backed up.
6. If you restore a database that was backed up from ARIS 7.2, you must enter the pasword
of the system user of the ARIS 7.2 system.
7. Choose whether you want to store multiple data versions in the restored database.
Versionable databases increase the amount of memory required. To reduce the size of a
versionable database, select Versionable database with current data only, no
previous versions. This will only import current data from the backup file, but no
versions.
8. Click Restore.
The database is available on this tenant.
If you selected a database, you can do the following:
Copy a database
114
You can copy databases to use them for similar projects.

2. Select the database and click Copy.
3. Enter the database name that you want to use for the copy. You can enter numbers,
spaces, letters, and the following special characters: - _ . ( ). Note that using special
characters can cause problems when such databases are called by command-line tools
and special characters are not escaped correctly.
4. Click Copy.
The database is available for all users of the tenant who have access to the source database.
Change (page 118) the database settings as required.
Delete a database
You can delete databases that you no longer want to use. Make sure that the database that
you want to delete is not published in ARIS.
Warning
All data contained will be lost. Make sure to back up the database before you delete it. You can
always restore a database from its backup file.

2. Select the database and click Delete.
3. To confirm the action, click Delete.
The database is no longer available.
Rename a database in the current language
You can change the name of a database in the current language.

2. Select the database and click Rename.
3. Enter the database name. You can enter numbers, spaces, letters, and the following
special characters: - _ . ( ). Note that using special characters can cause problems when
such databases are called by command-line tools and special characters are not escaped
correctly.
4. Click Rename.
The database is renamed.
Reorganize a database
You can automatically delete object and connection definitions that do not have occurrences
in any model in the database. This reduces the size of databases.
115
For safety, back up databases before reorganization. Then you can restore the data at any
time.
Warning
If you are using an object library, you should reorganize databases only when each object
definition occurs in at least one overview model. If elements have already been created for
later use but do not yet occur in models, these elements are deleted during the consolidation.

2. Select the database and click Reorganize.
3. Enable the required settings:
 Delete all object and connection definitions that are not used in models
If enabled, this option deletes all definitions that are not used. If definitions were
created based on user-defined method types and these method types are later
deleted from the tenant configuration, the association required for reorganization is
no longer available. In this case reorganization is canceled. To avoid this,
automatically replace missing item types. Items for which the type assignment is
missing are then automatically assigned the type specified in ARIS Method.
 Delete connection definitions that are used in matrix models only
If enabled, this option deletes only connection definitions that are used in matrix
models.
 Replace missing symbols, model, or attribute types
If reorganization is canceled because user-defined method types were deleted,
enable the required options. Items for which the type assignment is missing are then
automatically assigned the type specified in ARIS Method.
4. Click Reorganize.
If you do not change the default settings, the result overview is displayed automatically. The
result overview lists all results of the reorganization jobs cumulatively. If you disable Show
always, the results are shown only if you click Show reorganization jobs.
You can check detailed results for each reorganization, download details as a text file, or
delete results that you no longer need from the overview.
Back up a database
Save the content of your databases before making any major changes.

2. Select the database and click Back up. The name of the database is used as the
name of the backup file.
3. If multiple versions are available, select the database content that you want to back up.
116
Workspace: Indicates the database content that has not yet been versioned. It can be
edited.
Current version: Corresponds to the last versioned database content. This version
includes the entire versioned content of a database.
Change list number: Number and description of a version of the database content. You
can select a specific change list. This reduces the size of the backup file because only the
content of the selected change list is included.
4. Enable the Encrypt backup file option to prevent unauthorized users from restoring the
database and having full access to the content.
5. Enter a password and confirm it. Make sure to remember the specified password.
Otherwise, you cannot restore the database content using this backup file.
6. Click Back up, specify the file path and file name if required, and click Save.
The file is saved according to the settings specified in your browser. If errors occur when you
back up large databases, use the backup mechanism in your database management system
(DBMS). Make sure that sufficient disk space is available. This may exceed the memory
requirements stated in the document ARIS System Requirements.
You can restore database content based on the content saved in this file or make the
databases available to multiple tenants.
To manage settings for a database, click Properties (page 118). Click Defaults to
change the default settings for a database.
117
3.5.1 Manage database properties

administrator function privilege, you can manage all databases available on a tenant. If you
select a database and click Properties, you can manage the following:
Languages
For each database, you can manage the languages in which users can enter text, such as the
names of models and objects, or other language-dependent attribute values. A set of
database languages is provided automatically when a new database is created.
The selected language in which the user interface is displayed is automatically used as the
database language. Users can change the language used or edit attribute values in multiple
languages at the same time.
Add language
Add a language in which users specify text attributes, such as the names and descriptions of
database items.

2. Select the database and click Properties > Languages.
3. Click Add language.
4. Select the required language from the listed system languages that are available on your
machine.
5. Enable the Default language check box if you want to use this language as the default
language. The default language of a database is used to display text that was not entered
in the current language.
6. Select the font that you want to use for this language. Do not select fonts written in red.
These fonts cannot display letters in the selected language.
7. Select the related script. The script defines the font family for which the font is used, for
example, Western or Japanese.
8. Select the color, style, and the font size as required.
The language is available to all users of the database.
118
Edit font used for a language

The text font is selected when adding a language to a database. You can change this font.

3. Select the language and click Edit font.
7. Click Change font.
Text in this language uses the selected font.
Use as default language


3. Select the language in which all attribute values are specified and click Use as
default.
displayed as <Untitled>.
119
Delete a database language

Delete database languages that are no longer required.

3. Select the languages you want to delete. You cannot delete the default language.
Warning
If you delete a language, all attributes specified in the deleted language are also deleted
from the database. To prevent data loss, back up the database before you delete
languages.
4. Click Delete.
The selected languages are no longer available. All attributes specified in the deleted
languages are deleted.
120
Font formats
A font format is a kind of template to represent a font. This set of global parameters defines
the appearance of text characters in a specific style and size for a particular language.
company. Font formats are closely related to templates (page 968). To ensure that the models
comply with the conventions of the corporate branding, assign the correct template. When
users assign a template to a model, the font formats used in the template are automatically
created in the font format management of the related database. Only font formats used in
attributes and related objects that occur in models are added. Not adding unused fonts
ensures that the size of the database volume is manageable.
If no template was assigned, the default font format of the database is used.
Create font format.
Add font formats that you use to format individual models. You can also set a font format as
the default font format for the database.

2. Select the database and click Properties > Font formats.
3. Click Create font format.
All attributes are displayed in the language with which you logged in.
4. Select the configuration language in which you want to enter the name. The font format
is automatically applied to the selected language.
5. Select the font that you want to use for this font format in the selected language. Do not
select fonts written in red. These fonts cannot display letters in the selected language.
8. Select Use as default if you want to use the font format as default for this database.
9. Click Apply.
The font format is added.
Users can use the font format for individual models or you can assign it to the database as the
default font format.
121
Copy
For each database, you can copy and modify font formats that you can use when no
templates are assigned to models.

3. Select the font format and click Copy.
The copied font format is added to the list. The number added indicates the copy.
You can modify the font format. Users can use the font format for individual models or you
can assign it to the database as the default font format.
Delete
You can delete font formats that are no longer in use.

3. Select the font format and click Delete.
The font format is deleted and no longer available.
After deleting a font format, the database elements that used the deleted font format switch
to the default font format of the database.
Edit font format.

For each database, you can modify font formats that you can use when no templates are
assigned to models.

3. Select the font format and click Edit.
122
Change lists
A change list contains selected contents from a database that are versioned together and
saved in a change list under a change list number (page 1125). Change lists are sorted in
ascending order.
Versioned database content can include individual models, multiple models without
interdependencies, related models, group content, or the entire database contents.
A description of the change list characterizes the versioned contents. The change list
description records who versioned which database content, when, and why. Opening a
change list (page 1157) displays the database content you selected for versioning. You can
select models or the entire database content.
You can Delete change list numbers that are no longer needed.
You can delete old versions of databases that are no longer in use. Deleting obsolete versions
helps reduce the size of versionable databases and the time for backing up large databases.

2. Select the database and click Properties > Change lists.
3. Move the mouse pointer to the required change list number to keep and click Delete.
All previous versions of the database get deleted. The current change list number will
remain as the oldest version.
To prevent data loss, create a back up of the database that contains all versions.
All previous versions of the database are deleted. The change list from which you started the
action is displayed as the oldest version of the database.
123
Variant management
Choose how to handle model and object variants in versionable database.

Enable enhanced variant management.
You can enable variant management for versionable databases (page 1129).
Prerequisite
 You have the ARIS Enterprise Administration license privilege.
 You have the Database administrator function privilege.
Procedure
3. Click Databases.
4. Select the database and click Properties > Variant management.
5. Enable the Enable enhanced variant management check box. By enabling the
enhanced variant management, the "classic" variant creation in ARIS Architect is
deactivated. This means that you can no longer create variants in this database with ARIS
Architect, so variant creation for this database is only possible in ARIS.
6. In the breadcrumb navigation, click Databases. The list of the databases is displayed. If
you want to create the master model in a language other than the current default
language, perform the following steps.
7. Click Properties > Languages.
8. For the language you want to set as the default language click Use as default. If the
selected language is already the default language, Use as default is not available.
If you want to use different languages for the master model and model variants, you must
set the default language as the language, in which the master model is created.
9. Exit the databases configuration.
You can use variant management for this database. Master owners (page 1142) can capture
general processes in master models and trigger the roll-out across national borders. Variant
owners (page 1156) must adapt the model variants to their country-specific requirements
with system support.
124
Manage exclusion groups.

You can define exclusion groups to store objects to be excluded from variant creation. If
model variants are created, objects stored in exclusion groups are placed as occurrence
copies instead of object variants.
Warning
If you create an object collection before using the objects in models, keep in mind that objects
not used in models are deleted during a database reorganization.
Define exclusion groups
Prerequisite
Procedure
3. Click Databases.

5. Click the name of the database in which you want to define an exclusion group and click
Properties > Variant management.
6. Click Add exclusion group. The bar opens and you can expand the database groups.
If you want to create a new group as an exclusion group, click Create group, enter a
name, and click OK.
7. Select the group you want to exclude from variant creation and click Add exclusion
group. The selected group is listed.
8. Follow the same steps to exclude other groups.
9. Enable the check box Consider exclusion groups in ARIS Architect if the groups should
also be considered as exclusion groups in ARIS Architect. If you have enabled the
Enhanced variant management check box, Consider exclusion groups in ARIS
Architect is gray because ARIS Architect does not provide enhanced variant
management.
You defined the groups that contain objects, which are excluded from variant creation.
125
Remove exclusion groups

You can remove the Excluded status for groups so that variants are created instead of
occurrence copies (page 1147) for the content when creating model variants.
Prerequisite
Procedure
3. Click Databases.

5. Click the database that contains the exclusion group you want to delete and click
6. Enable the check boxes of the exclusion groups you want to remove so that variants can
be created again for their contents.
7. Click Remove exclusion groups.
The selected exclusion groups are removed.
126
Function privileges
To perform certain actions in a database, users need the related function privileges that you
can assign for each database. The database-related function privileges come in addition to
the function privileges that can be assigned tenant-wide in ARIS Administration (page 48).
Manage function privileges.
Users and user groups that have the Database administrator function privilege in ARIS
Administration automatically have all function privileges and access to all the databases of a
tenant. You cannot change privileges of database administrators or tenant-wide system
users.

3. Click User groups or Users and click the entry to which you want to grant function
privileges.
4. Enable the required privileges.
If you selected Users, you can see the function privileges that are individually assigned to
the user, the privileges the user inherited from the user groups, and the sum of privileges
the user has.
Single users or members of user groups receive all the function privileges granted for this
database. This changes the privileges in ARIS only. The function privileges of a user in ARIS
Administration are not affected.
Manage system users for a database.


affected.
127
databases.
128
Access privileges
Use access privileges to control which data is accessible to users. Based on their access
privileges, users can see, comment, create/edit, delete, or version models and objects.
Allow user groups or single users access to database groups.
To view, comment, edit, delete, and version database content, users need access privileges to
the related database groups. To save time, you can grant access to user groups so that all
members have access to the selected database groups. You can also grant access to
individual users. Users that have the Database administrator function privilege in the ARIS
Administration automatically have access to all the databases of a tenant. You cannot change
privileges of database administrators or tenant-wide system users.

2. Select the database and click Properties > Access privileges.
3. Select the database group for which you want to change access privileges for user
groups or users. Click the Expand and Collapse icons to navigate the hierarchy, or
use the filter to find database groups. You can create missing subgroups.
On the right-hand side, all user groups are listed to which you can grant access privileges.
If you select Users, all users are listed.
4. Click Edit to manage the access privileges of a user group. For users, you can only
manage access privileges that were granted to the user.
5. Select the required set of access privileges to be granted.
No access (----)
Users see the group structure of the database. Group contents are not displayed.
Read (r---)
The group content is displayed. Users can open models but neither change models and
objects, nor add or delete new items.
Read + Comment (rc--)
The group content is displayed. Users can use all functions of Collaboration in ARIS.
Read + Write (rw--)
The group content is displayed. Users can change models and objects, add new items, delete
object occurrences from models, but not object definitions.
Read + Write + Delete (rwd-)
The group content is displayed. Users can modify models and objects and add and delete
items.
129
Read + Version (r--v)

The group content is displayed. Users can open and version models but neither change
models and objects, nor add or delete new items.
Read + Comment + Version (rc-v)
The group content is displayed. Users can use all functions of Collaboration in ARIS and open
and version models. Users cannot add, change, or delete database items.
Read + Write + Version (rw-v)
object occurrences from models, and version models. Object definitions cannot be deleted.
Read + Write + Delete + Version (rwdv)
The group content is displayed. Users can modify models and objects, add and delete items,
and version models.
If you want to only grant access to the selected database group, click Apply. If you want to
grant access to all subordinate database groups as well, click Pass on.
Access privileges have been granted.
Create database group.

Add database groups to databases.

3. Click the Expand and Collapse icons to navigate the hierarchy, or use the filter
to find database groups.
4. Select the database group to which you want to add the subordinate group.
5. Click Create group.
6. Specify the name of the group and click Create group.
The database group is added. Access permissions are the same as the ones granted for the
superior database group.
Change the access permissions if required.
130
Statistics
The Statistics page gives you an overview about the size and numbers of items available in
each database of the tenant. The information provided can help you to reduce the size of a
database. Reducing the database size can improve the performance. Use the Show statistics
about list to enable the database items that you want to see in the dashboard of the selected
chart type.
The Statistics dashboard gives an overview about all items stored in a database.
1. Select the database and click Properties > Statistics. The dashboard shows the
number of database items (default selection).
2. Expand the Show statistics about list and select the database items that you want to
see in the dashboard. Your selection only remains until you log in again.
3. If required, select another chart type to display the result as bars or pie chart.
The chart is displayed.
To print the chart, download the chart as a graphic, or download the used data set, click the
Chart menu.
If you observe basic factors from the start, you can optimize a database's size in terms of
content. This results in faster database operations, such as backup and restore. Furthermore,
administrative tasks become significantly easier. Consider this example: If you assign or
change access privileges through the user groups, you do this only once for all users of the
user group, instead of repeating the procedure for each user.
 Just create the required user groups and delete user groups that you no longer need.
 Delete database languages that are no longer in use from the database and the
configuration. If a language comes back in use, you can create it again.
 Create only those font formats that you use and delete the ones you do not require.
 Create only the filters and templates that you use, and delete the ones you do not require.
The Filters are not stored in the databases but will users to work only with the items they
require.
 Assign users access privileges to users through the user groups.
 Reduce the size and resolution of images and embedded objects. For example, you can
insert large logos in models and reduce their display size later, but they still take up the
space required for their original size. If models with logos are versioned, the logos even
take up this space in the database multiple times.
 Distribute objects in different groups. For example, this makes sense because the group
structure of a database reflects organizational structures of an environment. In this case,
it makes no sense to save all object in the main group, for example. Database operations
are faster if each group contains up to 1000 objects.
131
 Therefore, it is recommended that you keep only objects that you really need in the
database. If objects that no longer have any occurrences in any model have piled up,
create a database backup and reorganize. During the reorganization, all objects that no
longer have occurrences in any model are deleted.
 Use suitable model sizes. The large size of a model that contains many objects affects
both the model legibility and performance.
 Modeling
 Use occurrence copies if you want to use the same object in different models.
 Use variants only for models and objects that differ. When creating model variants,
you can decide which objects are to be created as a new variant, for which objects
existing variants are to be used, and for which objects occurrence copies are to be
created.
 Versioning
 Version only models that must be versioned. If you version the entire database every
time, it becomes very large.
 Do not create versions to save intermediate results. For this, we recommend
database backups.
 Delete versions you no longer need.
132
Identifier
By assigning identifiers to users, you can identify the users who created database items. If
you activate Identifiers, the Identifier attribute is specified for each created database item.
Therefore, the individual identifier assigned to a user is used as a prefix and a sequential
number is added. If no individual identifier has been assigned to users, the default identifier of
the database is assigned automatically. STD is used by default. You can manage identifiers if
you have the database-related Prefix management function privilege.
Create identifier
Add identifiers that you can assign to users of the database.

2. Select the database and click Properties > Identifiers.
3. Click Create identifier.
4. Specify the identifier. You can enter up to 20 characters without blanks, such as @ % & ' (
)*+,-./0123456789:;<=>?ABCDEFGHIJKLMNOPQRSTUVWXYZ[\
] ^ _ ` a b c d e f g h i j k l m n o p q r s t u v w x y z { | } ~.
Identifiers are always saved in uppercase. Lower case letters are converted automatically
into uppercase letters.
5. If you want to use the identifier as default identifier for the database, enable Use as
default.
6. Click Create.
The identifier is available.
You can assign identifiers to users. Identifiers are specified for database items if you have
activated automatic ID assignment.
Activate identifiers
Automatically specify the Identifier attribute value for new database items. If you have
assigned individual identifiers to users, the related value is used. If no individual identifier is
assigned, the default identifier is specified.

3. Click Activate identifiers.
You have activated automatic ID assignment so that you can identify the users who created
database items. If you no longer need to identify users, click Deactivate identifiers.
133
If you select an identifier, you can do the following:
Edit identifier
You can change the identifier.

3. Select the identifier and click Edit.
4. Change the identifier and click Update.
The identifier was changed.
The changed identifier is specified for new database items when ID assignment is activated.
Former Identifier attribute values remain.
Delete identifier
You can delete identifiers you no longer need.

3. Select the identifier and click Delete.
The identifier is deleted.
From now on, the default identifier of the database will be used for those users that had the
deleted identifier assigned.
Use as default
For each database, you can select an identifier that is automatically used for users who have
no individual identifier assigned.

3. Select the identifier and click Use as default.
In this database, the identifier is used as default.
134
Assign identifier to user

You can assign identifiers to users to identify the users who created database items.

3. Click User assignment.
4. Select the users and click Assign identifier. All identifiers of the database are
shown.
5. Select the required identifier and click Apply.
The identifier is used for the selected users. You can change the assignment any time.
The identifier is specified for new database items when identifiers are activated.
135
3.6 Manage evaluation scripts

ARIS is supplied with numerous standard scripts. Authorized ARIS users can analyze and
process data using scripts that you provide.
If you have the ARIS Enterprise Administration license privilege and the Script
administrator function privilege, you can manage ARIS reports (page 137), scheduled reports
(page 428), ARCM reports (page 425), semantic checks (page 418), and macros (page 412) for
each tenant. You can also manage all files (page 427) that are used by different scripts and
handle fonts (page 455) used for evaluation. To manage evaluation scripts,
click Application launcher > Administration > Configuration > Evaluations.
When updating ARIS, all ARIS standard scripts and files are overwritten and customer-specific
changes to these files are discarded. Copied scripts and files and those you have created
yourself are not overwritten. Always adapt copies of report, macro, and JS files, and any other
files.
You can perform basic operations in this section. If you are familiar with the JavaScript and
ARIS Script programming languages, you can edit or write
(../../../../../../../abs/help/en/handling/ba/#/home/59140/en/1) your own scrips in ARIS
Architect.
WHAT DO YOU WANT TO DO?

Manage reports (page 137)
Manage ARCM reports (page 425)
Manage common files (page 427)
Manage macros (page 412)
Manage semantic checks (page 418)
Manage scheduled reports (page 428)
Manage fonts used by scrips and model generation (page 455)
136
3.6.1 Reports
A report is a script that can be applied to similar database content. You can use a report, for
example, to collect database content and group it according to specific aspects, output the
relationships (page 1148) between database elements, generate comparison tables, or display
multiple uses of database items. You can also use reports to change database content, such
as entering attribute (page 1124) values or correcting the layout of models (page 1143).
You can generate reports in the repository or in the modeling component for the selected
objects or the open model.
process data using scripts that you provide. The package and license that you have
purchased will determine the range of reports available to you.
administrator function privilege, you can perform basic report management in ARIS
Administration. If you are familiar with the JavaScript and ARIS Script programming
languages, you can edit or write
Architect.
To manage reports in ARIS Administration, click Application launcher >
Administration > Configuration > Evaluations and select Reports. If you modify
scripts, always make the changes in copies of standard scripts and files. When updating ARIS,
all ARIS standard scripts and files are overwritten and customer-specific changes to these
files are discarded. Copied scripts and files and those you have created yourself are not
overwritten.
All scripts are organized in a clear structure using categories.
CATEGORIES
You can Create a category if you have no category selected.
If you select a category, you can do the following:
Rename a category
Delete a category
Import a script
137
REPORTS
If you select a report, you can do the following:
Edit report properties

 Change the name, subject, author, company, and description in multiple languages.
 Make a report available to users.
 Make a report available in ARIS.
 Check the 'Open dialog', 'Recoverable', and 'Write to database' settings.
 Select an evaluation filter to reduce the number of evaluated items.
 Change output options.
 Change page layout.
 Change advanced properties, such as 'Enable timeout', 'Complexity', and imported
files.
 Change security settings.
By default, all users of a tenant are allowed to access report scripts.
1. Click Application launcher > Administration > Configuration > Evaluations

and select Reports.
2. Select the related category and select the script.
3. Click Edit properties.
4. In the Author field, press the keys CTRL+ALT+SHIFT+K. The Security settings are
shown at the bottom of the page.
5. Select the required options.
You can allow execution but deny editing to prevent users from changing the script code.
Or you can restrict execution to users whose assigned licenses contain a defined string.
You can also combine both options.
6. Click OK.
7. Enter a password.
Warning
You must remember this password. Otherwise, you cannot modify the script code or
change the security settings for this script again.
8. Click Apply to save the changes.
Security settings are applied.
138
Duplicate the report script

Delete the report script
Export the report script
Restrict access for execution
139
3.6.1.1 How to handle interrupted report execution

If the ARIS Server is restarted unexpectedly or data is restored while a report is running, the
report is stopped immediately. The state of execution remains unclear. This can lead to data
inconsistency if, for example, a Process Governance workflow was executing several reports
that modify data or a long-running report was writing to the database.
If you activate the Recoverable control (Report properties > General) for related reports, a
unique runtime ID is written or received from Process Governance. If the report runs
successfully, the ID is deleted. If report execution is interrupted, a caller can restart the report
with exactly this runtime ID. All data stored for this ID (key/value pairs) are added to the
script. The script can now use these values to determine what happened during the last
execution and resume.
To test this, start the script debugger in ARIS Architect and the runtime ID is created. If you
interrupt the execution of the debugger (Stop) and start it again (Start/Step into/Step over),
the key/value pairs are stored. The stored values are retained and the script can react to
them. The runtime ID is not deleted until you call Reset execution data or you close the
debugger.
140
3.6.1.2 ARIS default reports

purchased will determine the range of reports available to you. If you have the ARIS
Enterprise Administration license privilege and the Script administrator function privilege,
you can perform basic report management in ARIS Administration. If you are familiar with the
JavaScript and ARIS Script programming languages, you can edit or write
Architect.
3.6.1.2.1 Standard
Users with the Script administrator function privilege will find all standard reports available
in this category. If you have the ARIS Enterprise Administration license privilege and the
Script administrator function privilege, you can perform basic report management in ARIS
Administration. To manage reports in ARIS Administration, click Application launcher >
Administration > Configuration > Evaluations and select Reports. In ARIS Architect
you can manage reports on the Administration > Evaluations> Report tab. If in the
General properties of a report script the Available to users option is selected, authorized
users can start the report.
Never modify standard reports. If you want to create custom reports based on standard
report scripts, make changes to copies. Standard scripts and JS files are overwritten each
time the program is updated. Any changes to original files are lost.
141
3.6.1.2.1.1 Report: Adapt object names and names of

assigned models
USE
Optionally renames assigned models. The models receive the name of the object to which
they are assigned. Spaces that are not needed are optionally removed. All changes are logged.
CONTEXT
Groups
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
142
3.6.1.2.1.2 Report: Create process manual
USE
This report outputs all data from the selected processes up to the selected assignment level.
In ARIS Architect, graphics and/or an appendix may be output, as well, if required.
CONTEXT
Models of type:
 BPMN process diagram (BPMN 2.0)
 BPMN process diagram (BPMN 1.x)
 E-Business scenario diagram
 EPC
 EPC (material flow)
 EPC (column display)
 EPC (horizontal table display)
 EPC (table display)
 EPC (row display)
 Industrial process
 Office process
 Process schedule
 UML Activity diagram
 PCD
 PCD (material flow)
 Value-added chain diagram
OUTPUT FORMAT
 RTF
 PDF
 DOC
143
3.6.1.2.1.3 Report: Create template for data import
USE
The report creates an Excel template in the current output directory. This template is required
for importing data with the Import data in Excel format (page 173) report.
CONTEXT
Group
OUTPUT
The output is an Excel workbook, which you can use as the template for the data import.
Enter the required information in the tables in this template in the database language you will
be using to log in for the data import. To display instructions on this page for completing the
columns, click the various links. The names of the worksheets and column titles have not
been adapted in the template. The names of the templates in this description are in
parentheses. Please do not change them in the template. Otherwise, the data cannot be
imported.
On the Model structure (Model_Structure), Model attributes (Model_Att), Objects
(Objects), and Connections (Cxns) worksheets, you define the items to be created in the
database. Depending on whether you want to create models or only object and connection
definitions, you may not have to fill out all of the worksheets. Ensure that empty cells really do
not contain any characters, for example, spaces. If spaces exist the report will not run without
errors.
On the Assign model types (Mapping_Mod), Assign object types (Mapping_Obj), Assign
symbol types (Mapping_Sym), Assign connection types (Mapping_CXN), and Assign
attribute types (Mapping_Attr) worksheets, you assign the corresponding ARIS Method to
each of your own terms.
MODEL STRUCTURE (MODEL_STRUCTURE)

Use this table to define the structure of the models that will be created in the database.
144
In the example shown, the models created are Lending products of the Product tree type
and Banking organization of the Organizational chart type. In addition, object definitions
are created, and occurrences of the objects are inserted in the models and linked with the
specified connections.
Specify the following columns:
Model type (M_TYPE)

In each row, enter the model type to be used for model creation.
Define the model types on the Assign model types worksheet. Please use the same name for
each model type in all worksheets so that a unique assignment is possible.
Symbol (SYMBOL)
For each object, enter the name of the symbol to be used to represent that object in the
model. These values must also be entered in the Symbol column on the Objects worksheet.
If you specify the Symbol column on the Objects worksheet, you do not have to enter
anything in the Object type column. If you entered values in both columns, the value from
the Symbol column is always used.
Define the names of the symbols on the Assign symbol types worksheet. Please use the
same name for each symbol in all worksheets so that a unique assignment is possible.
145
Connection type (CXNS)

Starting with the row for the 2nd level object in a model, enter the connection type. Define
the connection types on the Assign connection types worksheet. If you enter the
connection types here, you do not have to edit the Connections worksheet unless you want
to create connection attributes.
Please use the same name for each connection type in all worksheets so that a unique
assignment is possible.
Model name and 1st level object (Object_name)

Enter the name of the object for the first hierarchy level. This name is used as the model
name, as well. A model is generated for each of the objects you enter in this column.
If you define objects with identical names and of the same type in this column, a model is
automatically assigned to the superior object.
2nd level object (Object_name)

Enter the name of the object for the second hierarchy level.
All objects you define here are linked to the 1st level object with the connection entered in the
Connection type column.
nth level object (Object_name)

Enter the name of the objects for the next hierarchy level.
All objects you define here are linked to the object at the previous level using the connection
entered in the Connection type column.
MODEL ATTRIBUTES (MODEL_ATT)

Use this table to define the model attributes in the language you will be using to log in for the
data import.
In the example shown, the Description and Person responsible attributes are specified for
the Lending products, Credit cards, and Banking organization models. The Person
responsible attribute is specified for the Credit banking business organizational chart.
You can specify any number of attributes. Because of the limited number of columns in an
Excel table, you can specify a maximum of 250 attributes in each table.
146
If you require more than 250 attributes, you can insert additional connection tables. Note that
the name of each connection table must be unique and begin with the prefix Model
attributes_(Model_Att_).
Model type (M_TYPE)

Enter the model type in each row. The model attribute values are transferred to the database
only for models of this type.
Define the model types on the Assign model types worksheet.
Model (NAME)
Enter the name for each model. The model name corresponds to the object name you used in
the Model name and 1st level object column in the Model structure worksheet. Please use
the same description for each name in all worksheets so that a unique assignment is possible.
<Attribute> (Attribute1-n)
As column headers, enter valid attribute type names to be specified for the models.
Define the attribute type names on the Assign attribute types worksheet. Please use the
same name for each attribute type name in all worksheets so that a unique assignment is
possible.
Handling of different attribute types
In general, attributes are specified as a string in the Excel table and imported. This handling
was extended for the following attribute base types:
Boolean: You can enter the values true/false and 0/1.
147
Time/Date attributes: can be imported as a string, the format being language-dependent;

the format that may be imported must therefore match the representation in Attribute
Editing. For the following attribute types, the script language does additionally support
language-independent formatting:
Date: MM/DD/YYYY format
Time: hh:mm:ss.000;MM/DD/YYYY format
OBJECTS
Use object tables to define the objects to be generated. Only objects that are unique with
regard to their name and object type will be created in the database. Objects with identical
names but of a different type are permitted, but must be included in the Connections (Cxns)
worksheet.
the name of each connection table must be unique and begin with the prefix
Objects_(Objects_).
In the example shown, the Digit attribute is specified for the General lending and Personal
lending objects, the Cost center attribute is specified for the Banking organization object,
and the E-mail address attribute is specified for persons.
Symbol (SYMBOL)
model.
Use the name you entered in the Symbol column on the Model structure worksheet.
148
Object type (O_TYPE)

If you did not enter values in the Symbol column enter the object type for each object.
You define object types on the Assign object types worksheet.
Object (NAME)
Enter the name of the objects for which the attributes are to be specified in the database. Use
the names you specified on the Model structure and Objects worksheets.
As column headers, enter valid attribute type names to be specified for the objects.
possible.
Objects_(Objects_).
149

CONNECTIONS (CXNS)
Use connection tables to define the connections to be created between each source object
and target object. If the method does not allow a connection to be created in this direction,
the connection will be drawn from the target object to the source object if that is possible. If
no connection type has been entered in the mapping table or if the connection type is not
valid, a connection is only created if precisely one connection type between the source and
target objects is defined in the method.
Connections_(Cxns).
After you have filled in the Connection type (Cxns) column on the Model structure
worksheet, you do not need to edit the Connections (Cxns) worksheet unless you want to
specify connection attributes.
In the second table on this worksheet, you can enter the object types for the respective
source and target objects as well as their names, if required. Use this table if you create
objects of different object types but with identical names. If all of the object names are
different, use the first table.
Connections can only be created if you have defined the source objects and target objects to
be used on the Objects (Objects) worksheet, and occurrences of the objects already exist in
models. If you define connections between objects without occurrences in models, the
connections cannot be drawn.
150
Connection type (C_TYPE)

Enter the connection type for which attributes are to be specified. Define the connection
types on the Assign connection types worksheet. Please use the same name for each
connection type in all worksheets so that a unique assignment is possible.
If you have specified connection types on the Model structure worksheet, you do not need
to edit the Connections worksheet unless you want to specify connection attributes.
Object type (source object) (SO_TYPE)

Enter the object types of the objects that are the source of the connection. You define object
types on the Assign object types worksheet. Always use the identical name.
You need to specify the column only if you are creating objects with the same name and of
different object types, and if you have not entered any connections on the Model structure
worksheet.
Object type (target object) (TO_TYPE)

Enter the object types of the objects that are the target of the connection. You define object
worksheet.
Source object (SOURCE)

Enter the names of the objects that are the source of the connection. Use the names you
specified on the Model structure and Objects worksheets.
Target object (TARGET)

Enter the names of the objects that are the target of the connection. Use the names you
151
<Attribute> (<AttributeA-N>)
As column headers, enter valid attribute type names to be specified for the connections.
possible.
Connections_(Cxns).

ASSIGN MODEL TYPES (MAPPING_MOD)

In this allocation table, you must assign the API names from the ARIS Method to the model
types you specified in the Model type (M_TYPE) column on the Model structure
(Model_Structure) and Model attributes (Model_Att) worksheets.
Model type (column A)

Specify the model types you entered in the Model type column on the Model structure and
Model attributes worksheets. Please use the same name for your model types in all
worksheets so that a unique assignment is possible.
API name (column B)

For each model type, specify the type number or the API name from ARIS Method. A type from
ARIS Method will then be assigned to each model type you have defined.
For user-defined model types, use the corresponding GUID of the user-defined type. The
GUID is displayed if you click Configuration > Method > Model types in the Navigation bar
on the Administration tab (../../handling/ba/58888.htm), select the relevant model type in
the table and click Properties.
152
Each API name represents one item of the ARIS Method. The API names for the model types
are listed in the Method help (Help > Method help) or on the Administration tab under
Configuration > Method > Model types in the Navigation bar. To open the context-sensitive
Method help, open a model of the type you require, click in the model background, and press
Ctrl + F1. Copy the API name, for example, MT_ORG_CHRT, and paste it into the table.
153
ASSIGN OBJECT TYPES (MAPPING_OBJ)

In this allocation table you must assign the API names from the ARIS Method to the object
types you specified on the Model structure (Model_Structure) and Objects (Objects)
worksheets.
You do not have to edit this table if you have filled in the Symbol (SYMBOL) columns in each
of the worksheets.
Object type (column A)

Use the object types you specified on the Model structure and Objects worksheets. Please
use the same name for your objects in all worksheets so that a unique assignment is possible.
API name (column B)

For each object type, specify the API name from ARIS Method. A type from ARIS Method will
then be assigned to each object type you have defined.
For user-defined object types, use the corresponding GUID of the user-defined type. The
GUID is displayed if you click Configuration > Method > Object types in the Navigation bar
on the Administration (../../handling/ba/58888.htm) tab, select the relevant object type in
the table, and click Properties.
Each API name represents one item of the ARIS Method. The API names for the object types
Configuration > Method > Object types in the Navigation bar. To open the
context-sensitive Method help, select an object of the type you require and press Ctrl+F1.
Copy the API name, for example, OT_FUNC, and paste it into the table.
ASSIGN SYMBOL TYPES (MAPPING_SYM)

symbols you specified on the Model structure (Model_Structure) and Objects (Objects)
worksheets.
Symbol type (column A)

Use the names of the symbols you specified on the Model structure and Objects
worksheets. Please use the same name for your symbols in all worksheets so that a unique
API name (column B)

For each symbol, specify the API name from ARIS Method. A type from ARIS Method will then
be assigned to each symbol you have defined.
For user-defined symbol types, use the corresponding GUID of the user-defined type. The
GUID is displayed if you click Configuration > Method > Symbols in the Navigation bar on
the Administration tab (../../handling/ba/58888.htm), select the relevant symbol type in the
table, and click Properties.
154
Each API name represents one item of the ARIS Method. The API names for symbol types are
listed on the Administration tab under Configuration > Method > Symbols in the
Navigation bar.
ASSIGN CONNECTION TYPES (MAPPING_CXN)

In this allocation table you must assign the API names from the ARIS Method to the
connection types you specified on the Model structure (Model_Structure) and
Connections (Cxns) worksheets.
Connection type (column A)

Use the connection types you specified on the Model structure and Connections
worksheets. Please use the same name for your connection types in all worksheets so that a
unique assignment is possible.
API name (column B)

For each connection type, specify the API name from ARIS Method. A type from ARIS Method
will then be assigned to each connection type you have defined.
For user-defined connection types, use the corresponding GUID of the user-defined type. The
GUID is displayed if you click Configuration > Method > Connection types in the Navigation
bar on the Administration tab (../../handling/ba/58888.htm), select the relevant connection
type in the table, and click Properties.
Each API name represents one item of the ARIS Method. The API names for connection types
are listed on the Administration tab under Configuration > Method > Connection types in
the Navigation bar.
ASSIGN ATTRIBUTE TYPES (MAPPING_ATTR)

In this allocation table you must assign the API names from the ARIS Method to the attribute
types you specified on the Model attributes, Objects, and Connections worksheets.
Attribute type (column A)

Use the attribute types you specified on the Model attributes, Objects, and Connections
worksheets. Please use the same name for your attribute types in all worksheets so that a
155
API name (column B)

For each attribute type, specify the API name from ARIS Method. A type from ARIS Method
will then be assigned to each attribute type you have defined.
For user-defined attribute types, use the corresponding GUID of the user-defined type. The
GUID is displayed if you click Configuration > Method > Attribute types in the Navigation
bar on the Administration tab (../../handling/ba/58888.htm), select the relevant attribute
Each API name represents one item of the ARIS Method. The API names for the attribute
types are listed in the Method help (Help > Method help) or on the Administration tab under
Configuration > Method > Attribute types in the Navigation bar. To open the
context-sensitive Method help, select an item, start Attribute Editing (F8), select a table
value, and press Ctrl+F1. Copy the API name, for example, AT_NAME, and paste it into the
table.
156
3.6.1.2.1.4 Report: Determine assignment structure
USE
Evaluates all selected models and all models assigned to the objects up to a configurable
structural depth. The selected models and the objects of the models that have assignments
are output by type and in alphabetical order within the type.
You can specify the report output in more detail by setting an assignment level. For example,
if you select assignment level 1, only the selected models are described in the report output. If
you select assignment level 2, the report output describes all selected models and all models
assigned to an object in a selected model.
The description of the selected models is sorted by model type at the first structural level.
Models of a specific type are described by name in alphabetical order. The description of
objects within a selected model occurs at the second structural level of the report output. As
with the models, Object type and Name are used as sorting criteria. If an assigned model is
described for an object, this is done at the next subordinate structural level in the report
output.
CONTEXT
Model
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
157
3.6.1.2.1.5 Report: Export attribute values for translation
USE
Exports language-dependent text attributes to an Excel file for translation purposes. You can
either manually translate these text attributes or use one of the supported translation
engines.
MANUAL TRANSLATION
MACHINE TRANSLATION
Exports attribute values to an Excel file using a supported translation engine or writes
translated text into the database. If you selected Machine translation, you must specify the
following settings.
Select translation engine

Select the translation engine you want to use for automatic translation. The translation
systems are not included in ARIS. You can use the free services of the translation providers.
However, you must book a service to use the full services.
Specify engine-related options

 DeepL Translator
If you want to use DeepL Translator to automatically localize your exported text attributes,
specify the following settings. For detailed information about the settings, see the DeepL API
documentation (https://www.deepl.com/docs-api).
Authentication key
This option is related to the auth_key DeepL API request parameter.
Enter a valid authentication key to connect to your DeepL API Pro or your DeepL APT Free
account.
Split sentences
This option is related to the split_sentences DeepL API request parameter.
(Optional) Splits the input into sentences or treats the input as one sentence.
You can select:
No splitting: The input is treated as one sentence. For applications that send one sentence
per text parameter, DeepL API advises to select this option, which prevents the engine from
splitting the sentence unintentionally.
Split on punctuation and on newlines: After a punctuation mark and line breaks, the input is
split into separate parts.
Split on punctuation: After a punctuation mark, the input is split into separate parts. Line
breaks do not trigger splitting.
158
Use default setting: Uses the DeepL default setting (1=Split on punctuation and line brakes)
Preserve formatting
This option is related to the preserve_formatting DeepL API request parameter.
(Optional) Uses the original formatting, typically with some corrections, such as sentence
punctuation and upper/lower case at the beginning of the sentence.
Formality
This option is related to the formality DeepL API request parameter.
(Optional) Presents the translated text in a more formal or informal language style. Valid
options are:
Use default setting: enables you to use all target languages.
more: formal language
less: colloquial language
The more and less options currently only works for the following target languages: DE
(German), FR (French), IT (Italian), ES (Spanish), NL (Dutch), PL (Polish), PT-PT, PT-BR
(Portuguese), and RU (Russian).
 Google Cloud Translation
If you want to use Google Cloud Translation to automatically localize your exported text
attributes, specify the following settings. For detailed information about the settings, see the
Google Translation API documentation
(https://cloud.google.com/translate/docs/reference/rest/v2/translate).
API key
This option is related to the key Google Cloud Translation API query parameter.
Enter a valid API key to connect to this API.
Format
This option is related to the format Google Cloud Translation API query parameter.
You can select the format of the source text, either HTML or plain-text.
Use default setting: selects the Google default parameter html.
 Azure Translator
If you want to use Microsoft Azure Translator to automatically localize your exported text
attributes, you must have an Azure subscription
(https://azure.microsoft.com/en-us/free/cognitive-services/) and a Translator resource
(https://portal.azure.com/).
Specify the following settings. For detailed information about the settings, see the Microsoft
Azure Translator documentation
(https://docs.microsoft.com/en-us/azure/cognitive-services/translator/).
159
Subscription key
Enter a valid key to access your Cognitive Service API. You can find the key on the Azure
portal Keys and Endpoint page. For details about keys, see Microsoft Azure Product
documentation > Quickstart
(https://docs.microsoft.com/en-us/azure/cognitive-services/translator/quickstart-translato
r?tabs=java#translate-text).
Base URL
The Base URL defines the geographical endpoint from which the Microsoft Translator handles
requests.
The default value is api.cognitive.microsofttranslator.com and indicates Global
(non-regional). If your resource is located in a specific region, you can use other endpoints,
such as United States (api-nam.cognitive.microsofttranslator.com), Europe
(api-eur.cognitive.microsofttranslator.com), or Asia Pacific
(api-apc.cognitive.microsofttranslator.com). You can also use your Translator resource in a
specific Resource region to ensure that requests are handled from a specific country.
For details about settings, see Microsoft Azure Product documentation > Translator v3.0
(https://docs.microsoft.com/en-us/azure/cognitive-services/translator/reference/v3-0-ref
erence).
API version
This option is related to the mandatory api-version Microsoft Azure Translator request
parameter.
This is the API version requested by the client. Set the API version value to 3.0.
Region
This option is related to the Ocp-Apim-Subscription-Region Microsoft Azure Translator
request parameter.
The value of the Region option is the region of the Microsoft Azure Translator resource. This
value is optional if you specified the default Base URL (api.cognitive.microsofttranslator.com)
that stands for Global (non-regional).
If your resource is located in a specific region, you can use other endpoints, such as United
States (api-nam.cognitive.microsofttranslator.com), Europe
(api-eur.cognitive.microsofttranslator.com), or Asia Pacific
(api-apc.cognitive.microsofttranslator.com). You can also use your Translator resource in a
specific Resource region to ensure that requests are handled from a specific country.
For details about settings, see Microsoft Azure Product documentation > Translator v3.0
(https://docs.microsoft.com/en-us/azure/cognitive-services/translator/reference/v3-0-ref
erence).
160
Category ID
This option is related to the optional category Microsoft Azure Translator query parameter.
The Category ID setting specifies the category (domain) of the translation. This parameter is
used to get translations from a customized system built with Custom Translator
(https://docs.microsoft.com/en-us/azure/cognitive-services/translator/customization). Add
the Category ID from your Custom Translator project details
(https://docs.microsoft.com/en-us/azure/cognitive-services/translator/custom-translator/
how-to-create-project#view-project-details) to this parameter to use your deployed
customized system. Default value is: general.
Character limit
Throttling limit for translation per hour.
The Character limit is based on your Microsoft Azure Translator subscription tier. If you
exceed the limit, for example by sending too much of the character quota too fast, the
Translator will return an out of quota response. You can send unlimited concurrent requests.
For details, see Microsoft Azure Product documentation > Text translation > Reference >
Request limits
(https://docs.microsoft.com/en-us/azure/cognitive-services/translator/request-limits).
Text type
This option is related to the optional textType Microsoft Azure Translator query parameter.
The Text type setting defines whether the text being translated is plain text or HTML text.
Any HTML must be a well-formed, complete element. Possible values are: plain (default) or
html.
Profanity action
This option is related to the optional profanityAction Microsoft Azure Translator query
parameter.
The Profanity action setting specifies how to treat profanities in translations. Possible
values are: NoAction (default), Marked or Deleted. To understand how to treat profanity, see
Microsoft Azure Product documentation > Translate > Handle profanity
(https://docs.microsoft.com/en-us/azure/cognitive-services/translator/reference/v3-0-tra
nslate#handle-profanity).
161
Profanity marker
This option is related to the optional profanityMarker Microsoft Azure Translator query
parameter.
The Profanity marker setting specifies how to mark profanities in translations. Possible
values are: Asterisk (default) or Tag.To understand how to treat profanity, see Microsoft
Azure Product documentation > Translate > Handle profanity
(https://docs.microsoft.com/en-us/azure/cognitive-services/translator/reference/v3-0-tra
nslate#handle-profanity).
Include alignment
This option is related to the optional includeAlignment Microsoft Azure Translator query
parameter.
The Include alignment setting specifies whether to include the alignment projection from
the source text into the translated text. Possible values are: true or false (default).
Include sentence length

This option is related to the optional includeSentenceLength Microsoft Azure Translator
query parameter.
The Include sentence length setting specifies whether to include sentence boundaries for
the input text and the translated text. Possible values are: true or false (default).
Allow fallback
This option is related to the optional allowFallback Microsoft Azure Translator query
parameter.
The Allow fallback setting specifies that the service is allowed to fall back to a general
system when a custom system does not exist.
If enabled, the service is allowed to fall back to a general system when a custom system does
not exist.
If disabled, the translation should only use systems trained for the category specified in the
request. If a translation for language A to language B requires chaining through a pivot
language C, then all the systems in the chain (A->C and C->B) should be custom and have the
same category. If a system with the specific category is not found, the request will return a
400 response status code.
162
Export and translate

Exports attribute values translated on the fly to an Excel file. After proofreading, you can
import the generated Excel file into the same database using the Import translated
attributes (page 186) report.
You also have the option to directly add translated attribute values to the source database or
overwrite translated text in the excel file. Please note that already localized text might be
overwritten and that this may result in incorrect translations.
The options you can select will change based on the context, for which you started the report.
Source language
Database language in which the values are specified. This language is the source language for
the translation. The output table contains all values to be translated in the penultimate
column Attribute value (source language). Enter the translated values in the last column
Attribute value (target language).
Target language
Database language into which the exported values are to be translated. Enter the values in
this language in the last table column Attribute value (target language). The entries in the
penultimate column (source language) act as the source.
Replace current translation in output file

Text that has already been localized in the database will be overwritten in the output file by
the text from the selected translation engine. This option affects only the output file. The
content in the database remains unchanged until you import the generated Excel file into the
same database using the Import translated attributes (page 186) report.
Warning
If text you use has not been reviewed, you risk overwriting the localized database content
with incorrect translations.If you back up the database before you run the report with this
option, you can recover the database if required.
Write translated values in database

Writes the translated text into the database.
Warning
If text you use has not been reviewed, you risk overwriting the localized database content
with incorrect translations. If you back up the database before you run the report with this
option, you can recover the database if required.
163
Database
The report writes all database-specific attribute values specified to the related Excel table.
The Attribute value (source language) column lists the source text that was used for
translation.
Check the machine-translated text in the Attribute value (target language) column.
Groups
The report writes all related attribute values, such as Name or Description, to the related
Excel table. The Attribute value (source language) column lists the source text that was
used for translation.
Models
The report writes all model-specific attribute values specified to the related Excel table. The
Attribute value (source language) column lists the source text that was used for
translation.
Ensure that you do not change attribute values such as SAP ID.
Objects
The report writes all object-specific attribute values specified to the related Excel table. The
translation.
Ensure that you do not change attribute values such as SAP ID.
Connections
The report writes all specified connection-specific attribute values to the related Excel table.
The Attribute value (source language) column lists the source text that was used for
translation.
Shortcuts
The report writes the names of model shortcuts to the related Excel table. The Attribute
value (source language) column lists the source text that was used for translation.
164
Free-form text
The report writes all attribute values used as free-form text to the related Excel table. The
translation.
Font formats
The Font formats option is only available if you start the report for a database. The report
writes all names of font formats used in the database to the related Excel table. The
translation.
Export only attributes not specified in target

Exports only attributes that are not specified in the selected target language.
You cannot select this option when the Also include attributes not specified in source
option is also selected.
Also include attributes not specified in source

Also exports attributes that are only specified in database languages other than the selected
source language.
You cannot select this option when the Export only attributes not specified in target
option is also selected.
Include subgroups
Also evaluates the subgroups. The Include subgroups option is only available if you start the
report for a database group. If you started the report for a database, all groups are included.
CONTEXT
 Database
 Group
 Model
 Object
OUTPUT FORMAT
 XLS
 XLSX
165
3.6.1.2.1.6 Report: Export graphic as a PDF (with preview)
USE
This report exports a model graphic as a PDF file. The model preview is shown in the Select
output options dialog.
CONTEXT
Models
OUTPUT FORMAT
PDF
3.6.1.2.1.7 Report: Export graphic as PDF
USE
This report exports a model graphic as a PDF file.
CONTEXT
Models
OUTPUT FORMAT
PDF
166
3.6.1.2.1.8 Report: Export RASCI chart

The Export RASCI chart report is not available in ARIS anymore. If you still want use this
report:
 Import it from the ARIS installation media.
 Make sure that:model, object, and connection types used in processes differ from the
modeling conventions.
RESPONSIBLE (R)
 decides on (API name CT_DECD_ON)
 decides on (API name CT_DECID_ON)
 carries out (API name CT_EXEC_1)
 carries out (API name CT_EXEC_2)
 accepts (API name CT_AGREES)
ACCOUNTABLE (A)
 is IT responsible for (API name CT_IS_DP_RESP_1)
 is IT responsible for (API name CT_IS_DP_RESP_2)
 is technically responsible for (API name CT_IS_TECH_RESP_1)
 is technically responsible for (API name CT_IS_TECH_RESP_3)
SUPPORTIVE (S)
 contributes to (API name CT_CONTR_TO_1)
 contributes to (API name CT_CONTR_TO_2)
 is assigned to (API name CT_IS_ASSIG_1)
 can be assigned to (API name CT_CAN_BE_ASSIG)
CONSULTED (C)
 has consulting role in (API name CT_HAS_CONSLT_ROLE_IN_1)
 has consulting role in (API name CT_HAS_CONSLT_ROLE_IN_2)
167
INFORMED (I)
 must be informed about (API name CT_MUST_BE_INFO_ABT_1)
 must be informed about (API name CT_MUST_BE_INFO_ABT_2)
 must be informed on cancellation (API name CT_MUST_BE_INFO_ON_CNC_1)
 must be informed on cancellation (API name CT_MUST_BE_INFO_ON_CNC_2)
 must inform about result of (API name CT_MUST_INFO_ABT_RES_OF)
 must inform about result of (API name CT_MUST_INFO_ABT_RES)
 Group (API name OT_GRP)
 Employee variable (API name OT_EMPL_INST)
 Organizational unit (API name OT_ORG_UNIT)
 Organizational unit type (API name OT_ORG_UNIT_TYPE)
 Person (API name OT_PERS)
 Role (API name OT_PERS_TYPE)
 Position (API name OT_POS)
 System organizational unit type (API name OT_SYS_ORG_UNIT_TYPE)
 EPC (API name MT_EEPC)
 EPC (column display) (API name MT_EEPC_COLUMN)
 EPC (material flow) (API name MT_EEPC_MAT)
 EPC (row display) (API name MT_EEPC_ROW)
 EPC (table display) (API name MT_EEPC_TAB)
 EPC (horizontal table display) (API name MT_EEPC_TAB_HORIZONTAL)
 Industrial process (API name MT_IND_PROC)
 Office process (API name MT_OFFICE_PROC)
 PCD (API name MT_PRCS_CHN_DGM)
 PCD (material flow) (API name MT_PCD_MAT)
 BPMN collaboration diagram (BPMN 2.0) - (API name
MT_BPMN_COLLABORATION_DIAGRAM)
 BPMN process diagram (BPMN 2.0) (API name MT_BPMN_PROCESS_DIAGRAM)
 Enterprise BPMN collaboration diagram (API name
MT_ENTERPRISE_BPMN_COLLABORATION)
 Enterprise BPMN process diagram (API name MT_ENTERPRISE_BPMN_PROCESS)
 Function allocation diagram (API name MT_VAL_ADD_CHN_DGM)
This model must be assigned to a process model.
168
The Export RASCI chart report has been replaced by the RA(S)CI - Output organizational
participations in processes (page 197) report that evaluates process models created under
special modeling conventions.
USE
The report creates a so-called RASCI chart, which is used to identify roles and responsibilities
in an organizational change process. Since improvement processes do not run on their own, it
is necessary to describe who has to do what for an improvement to occur.
The acronym RASCI stands for the initial letters of the responsibilities listed below. In RASCI
charts, the connections between organizational units and functions are indicated with the
letters R, A, S, C or I.
 Responsible (R) - Responsible for implementation. The person(s) providing the initiative
for implementation (by others) or performing the activity themselves. More than one
person can be responsible.
 Accountable (A) - Responsible in the sense of approving, authorizing, or signing off.
The person who has the responsibility in a legal or business sense. A single person is
responsible for a function in this sense.
 Supportive (S). This role indicates that several actors contribute to the function of
supporting the person accountable.
 Consulted (C). A person whose advice is sought. Also interpreted as a responsibility from
a business perspective.
 Informed (I) - to be informed. A person who receives information about the progress or
result of the activity or has the privileges required to receive information.
The result of the report is an Excel workbook containing several tables. Each process model
included creates a table. The first table consists of a full list of the functions and
organizational units of the process models included.
169
CONTEXT
 Individual process
 List of processes
 Process hierarchy
OUTPUT FORMAT
XLS
170
3.6.1.2.1.9 Report: Generate job description
USE
Generates a job description for each selected organizational element and considers all
processes and functions involved.
The following information can be output for each function:
 Organizational elements of the functions
 Data
 IT
 Improvement potential
If you start the report for models, only the modeled items are included. If you start the report
for objects, all relevant object definitions are evaluated.
By default, the carries out connection is evaluated for the Executing relationship. The
following connections are included for the Participating relationship:
 has consulting role in
 is IT responsible for
 is technically responsible for
 must be informed about
 must be informed on cancelation
 must inform about result of
Script administrators can change the content of the output.
If you output functional weak points, all information is output as for the job description.
However, the selected organizational unit is listed along with all organizational units.
CONTEXT
MODELS OF TYPE
 EPC
 FAD
 Office process
 VACD
171
OBJECTS OF TYPE
 Group
 Organizational unit
 Organizational unit type
 Person
 Role
 Location
 Position
 System organizational unit
 System organizational unit type
OUTPUT FORMAT
 DOC
 XLS
172
3.6.1.2.1.10 Report: Import data in Excel format
USE
The report can create models, objects, and connections and specify the defined attributes.
Assignment relationships are represented, as well. If you do not use the Model structure
worksheet, object definitions and connections are created in the database with the attributes
defined. Since connections are defined by the objects they connect, they are not created
unless they occur between objects in models. In that case, no models are generated.
Only items contained in your current method filter are included. If objects with the same
names already exist, they will be imported. It is advisable to consolidate these objects
afterwards.
The import is based on an Excel template that you output using the Create template for
data import (page 144) report.
Enter the required information in the tables in this template in the database language you will
be using to log in for the data import. To display instructions on this page for completing the
columns, click the various links. The names of the worksheets and column titles have not
been adapted in the template. The names of the templates in this description are in
parentheses. Please do not change them in the template. Otherwise, the data cannot be
imported.
On the Model structure (Model_Structure), Model attributes (Model_Att), Objects
(Objects), and Connections (Cxns) worksheets, you define the items to be created in the
database. Depending on whether you want to create models or only object and connection
definitions, you may not have to fill out all of the worksheets. Ensure that empty cells really do
not contain any characters, for example, spaces. If spaces exist the report will not run without
errors.
On the Assign model types (Mapping_Mod), Assign object types (Mapping_Obj), Assign
symbol types (Mapping_Sym), Assign connection types (Mapping_CXN), and Assign
attribute types (Mapping_Attr) worksheets, you assign the corresponding ARIS Method to
each of your own terms.
MODEL STRUCTURE (MODEL_STRUCTURE)

Use this table to define the structure of the models that will be created in the database.
173
In the example shown, the models created are Lending products of the Product tree type
and Banking organization of the Organizational chart type. In addition, object definitions
are created, and occurrences of the objects are inserted in the models and linked with the
specified connections.
Model type (M_TYPE)

In each row, enter the model type to be used for model creation.
Define the model types on the Assign model types worksheet. Please use the same name for
each model type in all worksheets so that a unique assignment is possible.
Symbol (SYMBOL)
model. These values must also be entered in the Symbol column on the Objects worksheet.
Connection type (CXNS)

Starting with the row for the 2nd level object in a model, enter the connection type. Define
the connection types on the Assign connection types worksheet. If you enter the
174
connection types here, you do not have to edit the Connections worksheet unless you want
to create connection attributes.
Please use the same name for each connection type in all worksheets so that a unique
Model name and 1st level object (Object_name)

Enter the name of the object for the first hierarchy level. This name is used as the model
name, as well. A model is generated for each of the objects you enter in this column.
If you define objects with identical names and of the same type in this column, a model is
automatically assigned to the superior object.
2nd level object (Object_name)

Enter the name of the object for the second hierarchy level.
All objects you define here are linked to the 1st level object with the connection entered in the
Connection type column.
nth level object (Object_name)

Enter the name of the objects for the next hierarchy level.
All objects you define here are linked to the object at the previous level using the connection
entered in the Connection type column.
MODEL ATTRIBUTES (MODEL_ATT)

Use this table to define the model attributes in the language you will be using to log in for the
data import.
In the example shown, the Description and Person responsible attributes are specified for
the Lending products, Credit cards, and Banking organization models. The Person
responsible attribute is specified for the Credit banking business organizational chart.
175
Model type (M_TYPE)

Enter the model type in each row. The model attribute values are transferred to the database
only for models of this type.
Define the model types on the Assign model types worksheet.
Model (NAME)
Enter the name for each model. The model name corresponds to the object name you used in
the Model name and 1st level object column in the Model structure worksheet. Please use
the same description for each name in all worksheets so that a unique assignment is possible.
As column headers, enter valid attribute type names to be specified for the models.
possible.
176

OBJECTS
Use object tables to define the objects to be generated. Only objects that are unique with
regard to their name and object type will be created in the database. Objects with identical
names but of a different type are permitted, but must be included in the Connections (Cxns)
worksheet.
Objects_(Objects_).
In the example shown, the Digit attribute is specified for the General lending and Personal
lending objects, the Cost center attribute is specified for the Banking organization object,
and the E-mail address attribute is specified for persons.
Symbol (SYMBOL)
model.
Use the name you entered in the Symbol column on the Model structure worksheet.
177
Object type (O_TYPE)

If you did not enter values in the Symbol column enter the object type for each object.
You define object types on the Assign object types worksheet.
Object (NAME)
Enter the name of the objects for which the attributes are to be specified in the database. Use
the names you specified on the Model structure and Objects worksheets.
As column headers, enter valid attribute type names to be specified for the objects.
possible.
Objects_(Objects_).
178

CONNECTIONS (CXNS)
Use connection tables to define the connections to be created between each source object
and target object. If the method does not allow a connection to be created in this direction,
the connection will be drawn from the target object to the source object if that is possible. If
no connection type has been entered in the mapping table or if the connection type is not
valid, a connection is only created if precisely one connection type between the source and
target objects is defined in the method.
Connections_(Cxns).
After you have filled in the Connection type (Cxns) column on the Model structure
worksheet, you do not need to edit the Connections (Cxns) worksheet unless you want to
specify connection attributes.
In the second table on this worksheet, you can enter the object types for the respective
source and target objects as well as their names, if required. Use this table if you create
objects of different object types but with identical names. If all of the object names are
different, use the first table.
Connections can only be created if you have defined the source objects and target objects to
be used on the Objects (Objects) worksheet, and occurrences of the objects already exist in
models. If you define connections between objects without occurrences in models, the
connections cannot be drawn.
179
Connection type (C_TYPE)

Enter the connection type for which attributes are to be specified. Define the connection
types on the Assign connection types worksheet. Please use the same name for each
connection type in all worksheets so that a unique assignment is possible.
If you have specified connection types on the Model structure worksheet, you do not need
to edit the Connections worksheet unless you want to specify connection attributes.
Object type (source object) (SO_TYPE)

Enter the object types of the objects that are the source of the connection. You define object
worksheet.
Object type (target object) (TO_TYPE)

Enter the object types of the objects that are the target of the connection. You define object
worksheet.
Source object (SOURCE)

Enter the names of the objects that are the source of the connection. Use the names you
Target object (TARGET)

Enter the names of the objects that are the target of the connection. Use the names you
180
<Attribute> (<AttributeA-N>)
As column headers, enter valid attribute type names to be specified for the connections.
possible.
Connections_(Cxns).
181

ASSIGN MODEL TYPES (MAPPING_MOD)

In this allocation table, you must assign the API names from the ARIS Method to the model
types you specified in the Model type (M_TYPE) column on the Model structure
(Model_Structure) and Model attributes (Model_Att) worksheets.
Model type (column A)

Specify the model types you entered in the Model type column on the Model structure and
Model attributes worksheets. Please use the same name for your model types in all
worksheets so that a unique assignment is possible.
API name (column B)

For each model type, specify the type number or the API name from ARIS Method. A type from
ARIS Method will then be assigned to each model type you have defined.
For user-defined model types, use the corresponding GUID of the user-defined type. The
GUID is displayed if you click Configuration > Method > Model types in the Navigation bar
on the Administration tab (../../handling/ba/58888.htm), select the relevant model type in
the table and click Properties.
Each API name represents one item of the ARIS Method. The API names for the model types
Configuration > Method > Model types in the Navigation bar. To open the context-sensitive
Method help, open a model of the type you require, click in the model background, and press
Ctrl + F1. Copy the API name, for example, MT_ORG_CHRT, and paste it into the table.
182
ASSIGN OBJECT TYPES (MAPPING_OBJ)

types you specified on the Model structure (Model_Structure) and Objects (Objects)
worksheets.
You do not have to edit this table if you have filled in the Symbol (SYMBOL) columns in each
of the worksheets.
Object type (column A)

Use the object types you specified on the Model structure and Objects worksheets. Please
use the same name for your objects in all worksheets so that a unique assignment is possible.
API name (column B)

For each object type, specify the API name from ARIS Method. A type from ARIS Method will
then be assigned to each object type you have defined.
For user-defined object types, use the corresponding GUID of the user-defined type. The
GUID is displayed if you click Configuration > Method > Object types in the Navigation bar
on the Administration (../../handling/ba/58888.htm) tab, select the relevant object type in
the table, and click Properties.
Each API name represents one item of the ARIS Method. The API names for the object types
Configuration > Method > Object types in the Navigation bar. To open the
context-sensitive Method help, select an object of the type you require and press Ctrl+F1.
Copy the API name, for example, OT_FUNC, and paste it into the table.
ASSIGN SYMBOL TYPES (MAPPING_SYM)

symbols you specified on the Model structure (Model_Structure) and Objects (Objects)
worksheets.
Symbol type (column A)

Use the names of the symbols you specified on the Model structure and Objects
worksheets. Please use the same name for your symbols in all worksheets so that a unique
API name (column B)

For each symbol, specify the API name from ARIS Method. A type from ARIS Method will then
be assigned to each symbol you have defined.
For user-defined symbol types, use the corresponding GUID of the user-defined type. The
GUID is displayed if you click Configuration > Method > Symbols in the Navigation bar on
the Administration tab (../../handling/ba/58888.htm), select the relevant symbol type in the
table, and click Properties.
183
Each API name represents one item of the ARIS Method. The API names for symbol types are
listed on the Administration tab under Configuration > Method > Symbols in the
Navigation bar.
ASSIGN CONNECTION TYPES (MAPPING_CXN)

In this allocation table you must assign the API names from the ARIS Method to the
connection types you specified on the Model structure (Model_Structure) and
Connections (Cxns) worksheets.
Connection type (column A)

Use the connection types you specified on the Model structure and Connections
worksheets. Please use the same name for your connection types in all worksheets so that a
API name (column B)

For each connection type, specify the API name from ARIS Method. A type from ARIS Method
will then be assigned to each connection type you have defined.
For user-defined connection types, use the corresponding GUID of the user-defined type. The
GUID is displayed if you click Configuration > Method > Connection types in the Navigation
bar on the Administration tab (../../handling/ba/58888.htm), select the relevant connection
Each API name represents one item of the ARIS Method. The API names for connection types
are listed on the Administration tab under Configuration > Method > Connection types in
the Navigation bar.
ASSIGN ATTRIBUTE TYPES (MAPPING_ATTR)

In this allocation table you must assign the API names from the ARIS Method to the attribute
types you specified on the Model attributes, Objects, and Connections worksheets.
Attribute type (column A)

Use the attribute types you specified on the Model attributes, Objects, and Connections
worksheets. Please use the same name for your attribute types in all worksheets so that a
184
API name (column B)

For each attribute type, specify the API name from ARIS Method. A type from ARIS Method
will then be assigned to each attribute type you have defined.
For user-defined attribute types, use the corresponding GUID of the user-defined type. The
GUID is displayed if you click Configuration > Method > Attribute types in the Navigation
bar on the Administration tab (../../handling/ba/58888.htm), select the relevant attribute
Each API name represents one item of the ARIS Method. The API names for the attribute
types are listed in the Method help (Help > Method help) or on the Administration tab under
Configuration > Method > Attribute types in the Navigation bar. To open the
context-sensitive Method help, select an item, start Attribute Editing (F8), select a table
value, and press Ctrl+F1. Copy the API name, for example, AT_NAME, and paste it into the
table.
CONTEXT
The report is run as a group report – all items are created within this group. This means that
the objects can also be imported multiple times and consolidated subsequently, if required.
OUTPUT
When the report is run, the following errors are logged in a document:
 Errors in an Excel table, such as invalid type numbers.
 Objects or connections that cannot be created.
 Attributes that cannot be created (for example, assignment of String to Integer
attribute).
Errors that may occur during data transfer are written to a log file as text, including a
specification of the sheet name, row number and column number.
185
3.6.1.2.1.11 Report: Import translated attributes
USE
Imports an Excel file with translated, language-dependent text attributes of database items in
the selected target language.
You can create this Excel file using the Export attribute values for translation (page 158)
report.
CONTEXT
Database
3.6.1.2.1.12 Report: Number hierarchy levels
USE
Numbers objects of a selected model by their graphic position in the model.
CONTEXT
Models of type:
 Authorization hierarchy
 CD diagram
 Cost category diagram
 Function tree
 Knowledge structure diagram
 Objective diagram
 Organizational chart
 Product/Service tree
 Product/Service tree (graphic)
 Product tree
 Structuring model
 Technical terms model
186
3.6.1.2.1.13 Report: Output functions across multiple

assignment levels
USE
Outputs the following information for the selected models:
 Functions across multiple assignment levels
 Functions across multiple assignment levels according to ISO certification
The model attributes, the group, and the model graphic are output for the models, while the
standard items are output additionally in the case of evaluation according to ISO certification.
THE FOLLOWING INFORMATION IS OUTPUT FOR EACH MODEL EVALUATED

 Chapter number
 Model name
 Model type
 Function to which the model is assigned.
 Name of the group in which the model is saved.
 Specified model attributes
 Functions of the model are described in the order in which they are created within a
partial path in the model. For each function, the chapter number and the name of the
function are output.
 Model graphic (optional)
 Model type of the assigned models to be evaluated (optional)
Functions that occur in multiple models are only described once. Each subsequent
occurrence in the report output contains a reference to this description.
ASSIGNED MODELS ARE HANDLED AS FOLLOWS

 All functions with assignments are determined.
 If an assigned model is a function allocation diagram, the evaluation is performed in the
same way as for associations within the selected model.
 From the set of remaining assignments, select one to be examined in more detail. You can
choose your own prioritization, for example, based on the model type. In turn, all
functions are analyzed for the assigned model.
You have the option of restricting the report output by specifying the assignment level to be
analyzed in detail. For each assignment outside this range, the report output shows only the
model name and type.
187
OUTPUT
The output is created as text incorporating tables for the model and object information and is
divided into chapters. The REPORT1 to REPORT4 styles are used for chapter headings. This
enables you to create tables of contents in the output documents.
At the first level, the output is structured based on the models you have selected. The
structural level is increased by one if the assigned model is a model with control flow. For all
other assigned models, the structural level remains unchanged.
The descriptions of the functions in a model can be sorted numerically, alphabetically, by
symbol type, or topologically. If you select numerical sorting, the functions in a model should
be numbered. The numbering of a function uses the number specified in the Type 1 attribute
type in the Function type attribute type group.
The attributes, relationships, and assigned models for which the types can be determined are
evaluated. Like selected models, the assigned models are evaluated up to a configurable
structural level.
If you selected the topological sort criterion, the report output may contain additional
information depending on the model class of the model in question.
The following table provides an overview of the model classes in question and the resulting
special features of the output with topological sorting:
Model class Special feature

Directed graph with associations Beginning and end of process, as well as start and
end of path.
Hierarchy Chapter numbers of functions reflect the position of

the object in the model hierarchy.
Central object type If the model described is a function allocation

diagram, the structural level in the report output is
not increased. The allocations are described at the
level of the object to which the model is assigned.
Process selection matrix The scenarios in a process selection matrix and the
processes assigned to them are evaluated in the
same way as function trees, with the scenario
taking on the function of the root. Main processes
are not included.
188
CONTEXT
Model
OUTPUT FORMAT
 PDF
 DOC
 DOCX
 ODT
 RTF
 HTML
3.6.1.2.1.14 Report: Output hierarchy (for MashZone)
USE
Based on the configuration, the report specifies all relevant hierarchical relationships of
objects and outputs them in an Excel table. In addition, all specified attributes of the objects
are output.
CONTEXT
Object
OUTPUT FORMAT
XLS
189
3.6.1.2.1.15 Report: Output model information
USE
Outputs information about the selected models, the objects contained in the model, and the
relationships of the objects in the model. Apart from name and type, the groups, additional
attributes, and model graphic can also be output.
For object relationships, you can also output the name and type of the target object.
You can also use the report Output model information considering various aspects (page 191).
CONTEXT
Models
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
190
3.6.1.2.1.16 Report: Output model information considering

various aspects
USE
Outputs model information to an Excel table. A worksheet is created for each aspect. If you
start the report from ARIS, all aspects are output. In other products, the following options are
available:
 Data
 IT
 Organizational elements
 Objectives/KPIs
 Products/Services
 Risks
 Others
 List functions that have occurrences in models
 Include assigned function allocation diagrams (FADs)
 Integrate information from the FAD into the superior model
For each aspect, the related functions can be listed, as well. Individual or integrated
evaluations can be carried out for function allocation diagrams (FAD). For integrated
evaluations, the functions from the FAD are integrated in the model.
CONTEXT
Models and groups
OUTPUT FORMAT
 XLS
 XLSX
191
3.6.1.2.1.17 Report: Output models and objects of the

groups
USE
For the selected groups, this report outputs all contained models and objects including their
name and type. The groups are sorted alphabetically per hierarchy level, the models and
objects are sorted by type and name. If you start the report from ARIS, all model or object
attributes and model graphics are output. Subgroups are ignored. In other products, select
the required options. The data is output as a text or in a table.
CONTEXT
Group
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
192
3.6.1.2.1.18 Report: Output object information
USE
Outputs the relationships and target objects at definition level for the selected objects.
Optionally, you can output the groups and the attributes for both the source and target
objects.
The output is in table format.
CONTEXT
Object
OUTPUT FORMAT
 RTF
 PDF
 HTML
 DOC
 XLS
 XLSX
 DOCX
 ODT
193
3.6.1.2.1.19 Report: Output object information (for

MashZone)
USE
Outputs the attributes specified and the relationships to other objects for the selected
objects. In addition, the attributes of the connected objects are output. Relationships can be
evaluated at either occurrence or definition level for selected object occurrences.
CONTEXT
Object
OUTPUT FORMAT
XLS
3.6.1.2.1.20 Report: Output object information (table)
USE
Outputs the attributes specified and the relationships to other objects for the selected
objects.
Relationships can be evaluated at either occurrence or definition level for selected object
occurrences.
The output is in Excel table format.
CONTEXT
 Object
 Model
OUTPUT FORMAT
XLS
194
3.6.1.2.1.21 Report: Output objects in the sequence of

modeling (model graph)
USE
Outputs the objects for all selected models in the sequence of modeling. The result
corresponds to the graphical structure of the model.
The data is output as text.
CONTEXT
Model
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
195
3.6.1.2.1.22 Report: Output occurrences of objects
USE
The occurrences in models are listed for the selected object definitions.
CONTEXT
Object
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 DOCX
 ODT
 XLS
 XLSX
 XML
196
3.6.1.2.1.23 Report: RA(S)CI - Output organizational

participations in processes
USE
This report supplies information on which organizational elements participate in the activities
(functions) of a process and in what manner. Organizational responsibilities and participations
are output in a matrix.
The report returns plausible results if your processes and the organizational responsibilities
for the individual activities conform to the modeling conventions required.
RA(S)CI stands for Responsible, Accountable, (Supportive), Consulted, Informed.
By default, this report does not return any Supportive information. To output this
information, your script administrator must set the g_bRASCI variable to true.
The matrix shows which organizational unit participates in activities of a process and in what
manner:
 Responsible indicates the person who assumes execution responsibility. It shows who is
responsible for performing an activity, who actually does the activity, but also who
assumes the supervising responsibility.
 Accountable indicates the person who is ultimately answerable for the correct and
thorough completion of a task. This may be the person in charge of managing the costs,
that is, the person assuming project budget responsibility. The decides on and accepts
connections are evaluated to identify this responsibility.
 Consulted indicates the person who has a consulting role. This organizational unit -
typically a group of subject matter experts - is asked for advice before making a final
decision or taking final action.
 Informed indicates the person who must be informed. It indicates who is kept up to date
on the progress or completion of a task.
In the RACI matrix, RACI data is displayed under the following conditions:
 The connections are used in the selected process model.
 The connections are used in a function allocation diagram that is assigned to a function
of the selected process model.
197
The result of the report is an Excel workbook containing several tables. Each process model
included creates a table. The first table consists of a full list of the functions and
organizational units of the process models included.
CONTEXT
 Individual process
 List of processes
 Process hierarchy
OUTPUT FORMAT
XLS
198
3.6.1.2.2 Administration
users can start the report. These scripts are available depending on the package you have
purchased and on the privileges the user was granted.
3.6.1.2.2.1 Report: Adapt ARIS document storage links
USE
For each migrated database holding ARIS document storage links, this report is to be run. It
modifies ARIS document storage links for the use of ARIS 10.
If ARIS document storage is in use all ARIS document storage links must be adapted in ARIS
Architect. As the ARIS Server URL and the tenant name are part of the links (highlighted), the
links will not work after migration. The Modify ARIS document storage links report adapts all
links for the use with ARIS 10. The highlighted parts of the links will be adapted as follows:
 ARIS9.8.x ARIS document storage link
https://aris9srv.eur.co.com:1080/documents/rest/links/afa43c5e-b225-4bd9-a4a9-
71d5d23b4420?tenantid=default&revision=1
 ARIS10 ARIS document storage link
https://aris10srv.eur.co.com:1081/documents/rest/links/afa43c5e-b225-4bd9-a4a9
-71d5d23b4420?tenantidtenantid=tenant1&revision=1
The old ARIS Server URL is updated to the new ARIS 10 URL.
CONTEXT
Database
199
3.6.1.2.2.2 Report: Compare filters
USE
This report compares two method filters based on the selected options. You can output either
the differences or the entire content of the filters.
CONTEXT
The report can be started for two filters on the Administration (../../handling/ba/58888.htm)
tab.
OUTPUT
The output is an Excel file.
3.6.1.2.2.3 Report: Consolidate font formats
USE
After transferring contents from multiple databases to one database, you can consolidate
multiple font formats of a database into one font format. For the font format that you want to
keep, you must specify the Master font format attribute.
CONTEXT
Database
200
3.6.1.2.2.4 Report: Consolidate objects
USE
Consolidates objects with identical names.
Before the report is run, you have to select the master objects by activating any attribute of
the Boolean type.
CONTEXT
Group
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
201
3.6.1.2.2.5 Report: Export database content (interface for

BI tools or MashZone)
USE
The report exports the selected contents in the form of an XML file. You can use the output
file for an import into MashZone and various BI tools supporting XML import. You can also
start this report as a scheduled report for the context Database, Group, Model, or Object. If
you select a group, all subgroups are automatically included.
Since this report has been developed for scheduled execution you cannot use dialogs.
Therefore, you need to define export options in the report script by adapting the parameters
of the variables:
Parameter Description (true) Standard

(allowed)
g_bExportCompleteG Creates groups of items that true
roupPaths you have implicitly selected for (true/false)
export in the XML file. Implicit
items are, for example, items
that you include in the export
by enabling the Assignment
level and Relationship level
options. If you do not enable
this option, these items will be
created in the main group
during a subsequent import.
g_bExportFormatedA Outputs formatted attribute false

ttrDefs definitions (true/false)
g_nHierarchyDepth Specifies the level up to which 0 (>= 0)

assignments are to be
exported.
202
Parameter Description (true) Standard

(allowed)
g_bIsSimpleExport Restricts the export to the false
necessary items. (true/false)
For example, the graphic
settings or GUIDs of specific
items are not exported. The
missing GUIDs are generated
upon import, and other missing
information is replaced with
default settings.
We recommend that you do not
import the file generated
during the export to ARIS
because the missing GUID can
result in redundant data in the
XML file in ARIS (for
example, fonts).
g_nRelationDepth Specifies the depth to which 0 (>= 0)

object definitions linked by
connections are to be exported
too.
g_bZipExport Compresses the output file in false

ZIP format. (true/false)
g_bAddDTD Transfers the DTD so that the true

output file is properly displayed (true/false)
locally.
CONTEXT
 Database
 Group
 Model
 Object
OUTPUT FORMAT
XLS
203
3.6.1.2.2.6 Report: Export relationship matrix
USE
Exports the content of the relationship matrix to an Excel table.
CONTEXT
 Group
 Model
OUTPUT FORMAT
XLS
3.6.1.2.2.7 Report: Format models
USE
Transfers the following settings to the selected models:
 Apply template
 Background color and wallpaper
 Attribute display (Text attributes in symbol, Remove color behind text)
 Show/Hide assignment icons
 Zoom factor
 Grid and grid width
 Print options (Print scale, Page orientation, Remove colors from model item and
background)
 Connection appearance (New connections only right-angled, Bridge height, Rounding)
For the changes to take effect, the models must be closed.
CONTEXT
Model
204
3.6.1.2.2.8 Report: Import of user data from User

management
USE
You can import the user data from User management in ARIS Administration/User
Management into ARIS Architect in order to subsequently export the data from ARIS into an
XML file, which is then imported into ARIS Risk and Compliance. To import the users and their
groups imported from ARIS Administration/User Management from ARIS Architect into ARIS
Risk and Compliance, they must be integrated in the authorization diagrams in line with ARIS
Risk and Compliance conventions. The data is imported as follows:
 Users are imported as objects of Person type.
 User groups are imported as objects of Role type.
 Group associations are imported as connections of performs type.
Group associations are displayed as models of Organizational chart type.
CONTEXT
Group
CATEGORY
Administration
OUTPUT FORMAT
No output
RESULT
The data is transferred from ARIS Administration/User Management to ARIS Architect.
205
3.6.1.2.2.9 Report: Move object definitions into model

group
USE
Start this report for the group from which you want to move object definitions. You have the
option to include all subgroups. In the dialog, you specify for each object type whether
objects are to be moved to the groups where models are stored or to the selected target
group.
Moving objects to a specific target group enables you to simply consolidate objects later on.
When objects are moved to groups where models are stored, objects that have occurrences in
multiple models are assigned according to the model type prioritization. You can prioritize
model types in the dialog.
Tip
If objects do not appear to have been moved, refresh the view (F5) after completion of the
report or log in to the database again.
CONTEXT
Group
206
3.6.1.2.2.10 Report: Output database information
USE
You can select the following output options:
Function privileges of users/user groups

Outputs the function privileges for all users and user groups.
Table
Displays the assignment in a table.
Text
Outputs user groups and users in text form. User groups, users, and their function privileges
are output in a structured format.
Database languages
Outputs all languages that are managed in the database.
Database font formats

Outputs all font formats that are managed in the database. The output is in table format. The
following information is output:
Name of font format
Font
Default font format of the database
Size
Color
Style
Character set
Mark used
Marks font formats in the table that are used in the database.
With description and full name

Also outputs the description and full name.
The function privileges are output as text or in a table, while the languages and font formats
are output in a table.
207
The example shows all information output in Word.
CONTEXT
Database
208
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
209
3.6.1.2.2.11 Report: Output filter information
USE
Output allowed model types

Outputs the model types included in the filter. The model types are assigned to the relevant
ARIS view in the output table.
Output allowed model attributes

Outputs the model attributes included in the filter. All attribute types included are listed for
each model type.
Output allowed symbol types

Outputs the symbol types included in the filter. All symbol types and object types included are
listed for each model type.
Output allowed object attributes

Outputs the object attributes included in the filter. All attribute types included are listed for
each object type.
Output allowed assignments

Outputs the assignments included in the filter. All assignable model types are listed for each
object type.
Output allowed relationship types

Outputs the relationship types included in the filter. All allowed relationship types are listed
for each model type. In addition, the symbol types between which the relationship type can
be used are listed.
Output allowed relationship attribute types

Outputs the relationship attribute types included in the filter. All attribute types included are
listed for each relationship type.
210
The output is in table format. The example shows a Word output of the allowed model types:
CONTEXT
 Method filter
 Evaluation filter
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
211
3.6.1.2.2.12 Report: Output group information
USE
Include subgroups
Also evaluates the subgroups. The Include subgroups option is only available if you start the
report for a database group. If you started the report for a database, all groups are included.
Output 'Description/Definition' attribute

Outputs the text for this attribute.
Output group path

Outputs the group path.
Output user groups, users, and access privileges

Outputs user groups and users. The access privileges of the users and user groups are listed.
The output is in table format.
The example shows a Word output of user groups, users, and access privileges, including all
subgroups:
212
CONTEXT
Group
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
3.6.1.2.2.13 Report: Output overview of reports, macros,

and semantic checks
USE
This report outputs a table that lists all reports, macros, and semantic checks managed on
this tenant.
CONTEXT
Database
OUTPUT FORMAT
XLS
213
3.6.1.2.2.14 Report: Replace connections between IT

system contact roles
USE
This report replaces connections of type is responsible for (CT_IS_RESP_1) based on the
value specified in the Responsibility type (AT_SUPPORT_TYPE) attribute. The new
connection types for IT system contact roles will then be used. This will make responsibilities
visible on IT fact sheets in the portal. Do not start the report for databases from which you
generate IT Inventory.
REPLACEMENT DEPENDING ON THE ATTRIBUTE VALUE
Value New connection type

Hotline support is responsible (hotline support) for
AVT_SUPPORT_TYPE_HOTLINE CT_RESPONSIBILITY_HOTLINE_SUPPORT
1st level support CT_RESPONSIBILITY_1ST_LEVEL_SUPPOR

AVT_SUPPORT_TYPE_1ST T
2nd level support CT_RESPONSIBILITY_2nd_LEVEL_SUPPOR

AVT_SUPPORT_TYPE_2ND T
3rd level support CT_RESPONSIBILITY_3RD_LEVEL_SUPPOR

AVT_SUPPORT_TYPE_3RD T
System integrator CT_RESPONSIBILITY_SYSTEM_INTEGRATIO

AVT_SUPPORT_TYPE_SYS_INTEGRATOR N
Facility operator CT_RESPONSIBILITY_FACILITY_OPERATOR

AVT_SUPPORT_TYPE_FACILITY_OPERATOR
Operating responsibility CT_RESPONSIBILITY_OPERATING

AVT_SUPPORT_TYPE_OPERATION_RESP
System responsibility CT_RESPONSIBILITY_SYSTEM

AVT_SUPPORT_TYPE_SYS_RESP
Operational failure recording CT_RESPONSIBILITY_OPERATIONAL_FAUL

AVT_SUPPORT_TYPE_FAILURE_RESP T_RECORDING
System responsibility (substitute) CT_SUBSTITUTE_RESPONSIBILITY_SYSTE

AVT_SUPPORT_TYPE_SUBST_SYS_RESP M
214
Value New connection type

Application responsibility CT_RESPONSIBILITY_APPLICATION
AVT_SUPPORT_TYPE_FREE_12
Operating responsibility (substitute) CT_SUBSTITUTE_RESPONSIBILITY_OPERA

AVT_SUPPORT_TYPE_SUBST_OPERATION_ TING
RESP
Free support type 1 to 11 Can be defined.

AVT_SUPPORT_TYPE_FREE_1 to _11
If an attribute value is maintained, the old connection definition and all occurrences are
deleted. The new connection definition is created and placed in all diagrams as well as
embedded connections. The old connection's attribute values are copied to the new ones, as
well as the formatting. For the Free support type 1 - 11 attributes other connection types can
be mapped.
Script administrators can change the default settings.
CONTEXT
Database
OUTPUT FORMAT
The result is logged as an Excel file.
215
3.6.1.2.2.15 Report: Replace font formats
USE
Changes the labels of database items. Select a font format that you want to replace with
another font format of the database.
CONTEXT
Database
3.6.1.2.2.16 Report: Replace object types
USE
Replaces objects of defined object types in the database. Occurrences and connections are
changed in models. Tables are ignored. When assigning these object types, you must also
assign symbol and connection types allowed by the method.
The log file lists all objects that were not replaced.
CONTEXT
Database
3.6.1.2.2.17 Report: Replace symbol types
USE
The report replaces the current symbol with the new symbol for all objects of the selected
type. The symbols are replaced in the models only if this is allowed by the method and not
prevented by the filter in use. Symbols cannot be replaced if connections are not allowed for
the new symbols you selected.
In the report dialog you can specify that default symbols of object definitions are also
replaced.
Please back up your database before replacing symbols. You can use the restore function
afterwards to restore the original status. If a filter prevents the replacement of symbols,
objects will continue to be displayed in the models with their original symbol.
CONTEXT
 Database
 Object
216
3.6.1.2.2.18 Report: Replace text attributes
USE
Finds and replaces text attribute contents of groups, models, objects, and relationships.
As this action can have large impact on the database and the replacement cannot be undone
automatically, make sure to have backed up the database.
CONTEXT
Group
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
3.6.1.2.2.19 Report: Synchronize ARIS document storage

link title attributes with document titles
USE
This report is to be run for databases that were used in earlier ARIS versions and that contain
ARIS document storage links for which the corresponding ARIS document storage Title
attribute is not specified. The report adds the relevant values to the empty ARIS document
storage Title attributes by retrieving the document titles of the corresponding ARIS
document storage Link attributes.
CONTEXT
Database
217
3.6.1.2.2.20 Report: Transfer groups and users
USE
Transfers the group structure to another database without models and objects, as well as the
user and user group privileges.
CONTEXT
Group
3.6.1.2.3 Process Governance

These scripts are available depending on the package you have purchased and on the
privileges the user was granted.
218
3.6.1.2.3.1 Report: Find indirectly updated models
USE
The Find indirectly updated models report checks whether objects used in this model were
changed outside the model. The report checks whether the date of the Last change object
attribute is more recent than that of the model attribute. Changing the object attribute does
not automatically result in a change to the model attribute. In other words, if an object is
changed outside the model, resulting in the Last change object attribute being updated, the
Last change model attribute is not updated automatically. If the date of the Last change
object attribute of an object that has an occurrence in the model is more recent than that of
the model attribute, a timestamp is added in the Last check for object changes model
attribute (attribute type group Process automation).
CONTEXT
 Group
If required, subgroups can be included in the check.
 Model
CATEGORY
Automation
RESULT
A message shows whether indirectly updated models were or were not found. If indirectly
updated models are found, they are marked with a timestamp. You can use a time stamp to
search for models that were updated indirectly.
219
3.6.1.2.3.2 Report: Generate shortcuts
USE
The Generate shortcuts report generates shortcuts for models and the assigned function
allocation diagrams in a selected group. This enables you to find models that have function
allocation diagrams assigned to them in order to trigger an automated approval procedure for
these models, for example.
CONTEXT
The report can be started for all model types. As an option, function allocation diagrams that
are assigned to process interfaces can be ignored.
CATEGORY
Automation
RESULT
Models that have function allocation diagrams assigned to them are listed. You can use this
information to trigger an automated approval procedure for these models, for example.
3.6.1.2.3.3 Report: Model status overview
USE
The report Model status overview outputs an overview of the status of models in Release
Cycle Management.
CONTEXT
The report can be started for groups, including subgroups, or models.
CATEGORY
Automation
RESULT
The report outputs model name, model type, model status, process manager, and model path
for the selected models.
220
3.6.1.2.3.4 Report: Output organizational structure
USE
The report Output organizational structure outputs the organizational structure that the
Process Governance process is based on.
CONTEXT
The report can be started for models of the Organizational chart type and objects of the
Organizational unit, Group, Position, Role, and Person type, for which an occurrence exists
in an organizational chart. As an option, you can define the assignment level down to which
assigned models are to be included in the report.
CATEGORY
Automation
RESULT
The organizational hierarchy is displayed in Excel format, and saved automatically under the
name and location selected in the wizard.
3.6.1.2.3.5 Report: Governance Process Mining export
USE
ARIS Process Miningis a tool to analyze process event data. This helps, for example, to see
which paths are executed more frequently.
This report collects all completed activities from Process Governance for all Process
Governance instances on the system and exports them as a CSV file.
CONTEXT
Activity
CATEGORY
Automation
221
RESULT
The CSV file contains a row for each collected completed activity with the following meta data
in each row:
 Process name
 Instance ID
 ID
 Name
 Type
 Status
 Start date
 End date
222
3.6.1.2.4 ARIS Risk and Compliance

Here, you can find details on ARCM reports. These reports are only available in ARIS Architect.
3.6.1.2.4.1 Report: ARCM export
USE
Looks up all objects and models which can be mapped via the entries inside
aris2arcm-mapping.xml and exports them as entries to an XML file. The report cannot be
run by users. It is started by the report Main report for ARCM data transfer (page 236).
CONTEXT
Database, group, model, object
CATEGORY
ARIS Risk and Compliance
RESULT
An XML file is generated.
223
3.6.1.2.4.2 Report: ARCM user export for User

management
USE
This report exports all objects of the Person type to a text document. The report uses the
user group and role assignment to check whether users are assigned the Contribute or
Operate license privilege. Users without user group assignment are assigned the Contribute
license privilege. Users with the Incident owner and Policy addressee roles are also
assigned the Contribute license privilege. Users with other valid ARIS Risk and Compliance
roles are assigned the Operate license privilege.
For detailed information, refer to chapter Export modeled users in ARIS Risk and
Compliance - Administration Guide.
CONTEXT
Database, group
CATEGORY
OUTPUT FORMAT
TXT
RESULT
A text file including the Login, First name, Last name, and E-mail address attributes is
exported. Users that were not exported because required attributes were not specified are
displayed. You can use this information to specify the missing attributes and then restart the
report.
224
3.6.1.2.4.3 Report: Check for compliance with ARIS Risk

and Compliance modeling conventions
USE
Outputs a report of all verifications on modeling for import into ARIS Risk and Compliance. The
master report Check for compliance with ARIS Risk and Compliance modeling
conventions executes all individual semantic reports. Only this semantic report can be run by
the report wizard. When you model data for ARIS Risk and Compliance in ARIS, you must
observe certain conventions. If these conventions are not observed, the import of data from
ARIS into ARIS Risk and Compliance is canceled. For detailed information on modeling, please
refer to the ARIS Risk and Compliance conventions guides.
CONTEXT
Database, group
CATEGORY
OUTPUT FORMAT
TXT
RESULT
If the modeling conventions were not observed, the modeling errors are listed. You can use
the resulting log file to correct the modeling errors.
225
3.6.1.2.4.3.1 Report: Verify semantics of audit templates
USE
Verifies the modeled audit templates for import into ARIS Risk and Compliance. The master
report Check for compliance with ARIS Risk and Compliance modeling conventions
executes all individual semantic reports. Only this semantic report can be run by the report
wizard.
When you model data for ARIS Risk and Compliance in ARIS, you must observe certain
conventions. If these conventions are not observed, the import of data from ARIS into ARIS
Risk and Compliance is canceled. For detailed information on modeling, please refer to the
ARIS Risk and Compliance conventions guides.
CONTEXT
Group
CATEGORY
OUTPUT FORMAT
TXT
RESULT
226
3.6.1.2.4.3.2 Report: Verify semantics of controls
USE
Verifies the modeled controls and control execution definitions for import into ARIS Risk and
Compliance. The master report Check for compliance with ARIS Risk and Compliance
modeling conventions executes all individual semantic reports. Only this semantic report
can be run by the report wizard.
CONTEXT
Group
CATEGORY
OUTPUT FORMAT
TXT
RESULT
227
3.6.1.2.4.3.3 Report: Verify semantics of the hierarchy

structures
USE
Verifies the modeled hierarchy structures for import into ARIS Risk and Compliance. The
the report wizard.
CONTEXT
Group
CATEGORY
OUTPUT FORMAT
TXT
RESULT
228
3.6.1.2.4.3.4 Report: Verify semantics of policies
USE
Verifies the modeled policies for import into ARIS Risk and Compliance. The master report
Check for compliance with ARIS Risk and Compliance modeling conventions executes all
individual semantic reports. Only this semantic report can be run by the report wizard.
CONTEXT
Group
CATEGORY
OUTPUT FORMAT
TXT
RESULT
229
3.6.1.2.4.3.5 Report: Verify semantics of the

questionnaire templates
USE
Verifies the modeled questionnaire templates for import into ARIS Risk and Compliance. The
the report wizard.
CONTEXT
Group
CATEGORY
OUTPUT FORMAT
TXT
RESULT
230
3.6.1.2.4.3.6 Report: Verify semantics of risks
USE
Verifies the modeled risks for import into ARIS Risk and Compliance. The master report Check
for compliance with ARIS Risk and Compliance modeling conventions executes all
CONTEXT
Group
CATEGORY
OUTPUT FORMAT
TXT
RESULT
231
3.6.1.2.4.3.7 Report: Verify semantics of control test

definitions
USE
Verifies the modeled control test definitions for import into ARIS Risk and Compliance. The
the report wizard.
CONTEXT
Group
CATEGORY
OUTPUT FORMAT
TXT
RESULT
232
3.6.1.2.4.3.8 Report: Verify semantics of user groups
USE
Verifies the modeled user groups for import into ARIS Risk and Compliance. The master report
CONTEXT
Group
CATEGORY
OUTPUT FORMAT
TXT
RESULT
233
3.6.1.2.4.3.9 Report: Verify semantics of the users
USE
Verifies the modeled users for import into ARIS Risk and Compliance. The master report
CONTEXT
Group
CATEGORY
OUTPUT FORMAT
TXT
RESULT
234
3.6.1.2.4.4 Report: Import user groups managed in ARCM
USE
This report enables modelers to import object-specific user groups that were created in ARIS
Risk and Compliance. These user groups are created in ARIS as definitions of role objects
(OT_PERS_TYPE). After the import, the created user group objects can be used in the
respective models to define user group responsibilities in ARIS Risk and Compliance. For each
user group created in ARIS, the attributes Name, Description, ARCM role and ARCM role
level, and ARCM GUID are set accordingly. If the user group is deactivated in ARIS Risk and
Compliance, the attribute Deactivated is set to true, otherwise to false. If a user group from
ARIS Risk and Compliance already exists in ARIS, the group's Name and Description are
updated. All user groups are created in the group for which this report was run. If the report
was run for the database, a new group Imported ARCM user groups is created as a subgroup
of the main group. For detailed information, refer to Import user groups managed in ARCM
in the online help of ARIS Risk and Compliance.
CONTEXT
Database, group
CATEGORY
235
3.6.1.2.4.5 Report: Main report for ARCM data transfer
USE
Transfers GRC-relevant master data objects (for example, risks) along with their assigned
objects (for example, hierarchies or user groups) from ARIS to ARIS Risk and Compliance. This
report cannot be run by users. It is started by the report Transfer risk & compliance data in
ARIS Architect and ARIS. The report transfers all objects and models for which the Transfer
data to ARIS Risk and Compliance model attribute (AT_AAM_EXPORT_RELEVANT) is
enabled. You can simulate the transfer of data from ARIS to ARIS Risk and Compliance to
verify whether the changes that would occur due to the transfer are correct and executed
without errors.
CONTEXT
Database, group, model, object
CATEGORY
RESULT
The data is transferred to ARIS Risk and Compliance. If the option is enabled, a log file that
contains transfer details is generated.
236
3.6.1.2.4.6 Report: Migrate risk & compliance roles
USE
This report migrates the ARCM-relevant role and role level modeling. Up to version 10.0.17,
both roles and role levels were modeled in ARIS as ARCM-relevant Role objects
(OT_PERS_TYPE) objects that were distinguished by applying strict naming conventions. The
report migrates the individual ARCM-relevant Role objects (OT_PERS_TYPE) that represent
either ARCM roles or ARCM role levels into Role objects (OT_PERS_TYPE) that include both
roles and role levels as defined attribute values. When you run this report for a database, this
report migrates all individual ARCM-relevant role and role level objects and updates the
corresponding user groups in ARIS Risk and Compliance. When you run this report for a group,
the report migrates only the individual ARCM-relevant role and role level objects of this group
and its subgroups. Make sure that all models that include ARCM-relevant roles and role levels
are closed when the report is run. Otherwise, the report cannot update these models. For
detailed information, refer to Migrate risk & compliance roles in the online help of ARIS Risk
and Compliance.
CONTEXT
Database, group
CATEGORY
237
3.6.1.2.4.7 Report: Transfer risk & compliance data
USE
Triggers the transfer of GRC-relevant master data objects (for example, risks) along with their
assigned objects (for example, hierarchies, or user groups) from ARIS to ARIS Risk and
Compliance. Executable from ARIS Architect and if the option is enabled, also in ARIS (ARIS
Architect > ARIS > Administration > Evaluations > Reports > ARIS Risk and
Compliance > Transfer risk & compliance data > Properties > General > Availability >
Available only in ARIS Architect must be disabled). By default, this report is disabled for
ARIS. This report triggers the Main report for ARCM data transfer.
3.6.1.2.4.8 Report: Output data allocation matrix

This report is only available if the ARIS accelerators for GDPR reports were imported.
This report serves as an enhanced analysis tool for GDPR-relevant data and the relations of
the data to processes or organizational units. The report creates a matrix of both object types
including relevant GDPR information to check whether or not this assessment matches for
both object types. Thereby, 'white spots' in the GDPR assessment can be identified.
APPLICATION
ARIS Architect
CONTEXT
Group
CATEGORY
OUTPUT FORMAT
XLS
238
3.6.1.2.5 ARIS
3.6.1.2.5.1 Report: Export graphic as PDF
USE
This report exports a model graphic as a PDF file.
CONTEXT
Models
OUTPUT FORMAT
PDF
239
3.6.1.2.6 Analysis
240
3.6.1.2.6.1 Report: Analyze application systems
USE
Determines for all functions in the selected processes whether they are supported by
application systems, application system types, computers, or application system classes.
Also identifies for all function transitions whether there is a break in the application systems,
application system types, computers, or application system classes. A break exists when the
preceding and subsequent functions do not have at least one identical assignment.
CONTEXT
Models of type:
 EPC (event-driven process chain)
 Office process
 PCD (process chain diagram)
 VACD (value-added chain diagram)
OUTPUT FORMAT
 TXT
 XSL
241
3.6.1.2.6.2 Report: Analyze classification
USE
This analysis classifies all objects of a type according to the selected attribute. You can use
this to test the consistency of your processes and flexibly analyze process-relevant factors.
If you start the analysis for models, for example, to compare an actual process with a target
process, the analysis is automatically limited to functions. To examine other objects, select
the relevant objects and run the analysis for the selection. Make sure that you only select
objects of one type.
In this way, you can classify all process contents according to your own criteria. For example,
you can find out quickly and easily whether your process steps include mainly value adding or
non-value adding activities. You can also determine the degree to which your processes are
automated. The parameters derived from this can be used as a basis for comparison.
For example, you can identify
 whether your target process has improved relative to the actual process based on your
target parameters, or
 which process variants come closer to achieving your objective (for example, achieving
the objective of the Collections department process in the Private customer business
segment compared with the Business customer business segment).
This analysis evaluates all possible aspects, for example, including
 IT systems
How many piloted systems are used?
How many systems are scheduled to be shut down soon?
 Risks
How many risks with a high probability of occurrence exist, as opposed to risks with a low
probability of occurrence?
If you run this analysis in a Publisher export, the Assessment of value added attribute is
automatically evaluated.
CONTEXT
 Models
 Objects of one type
242
OUTPUT
The analysis is summarized in an Excel workbook. The number of worksheets varies
depending on whether you are analyzing models or objects.
The following example is based on an analysis of the Purchase order processing (actual)
and Purchase order processing (target) models. The Assessment of value added attribute
is evaluated separately for each model. In this case, one worksheet is output with a table and
one with charts.
TABLE
243
CHARTS
CONTEXT
 Models
 Objects of one type
OUTPUT FORMAT
 XLS
 XLSX
244
3.6.1.2.6.3 Report: Analyze media breaks
USE
Determines for all function transitions in the selected processes whether there is a break in
the information carriers (for example, document, hard disk, log file, file, or telephone). A break
exists when two consecutive functions with information carriers do not have at least one
identical information carrier each.
It will also be determined how many functions do not have at least one identical input and
output information carrier.
CONTEXT
Models of type:
 Office process
OUTPUT FORMAT
 TXT
 XLS
245
3.6.1.2.6.4 Report: Analyze organizational change
USE
Determines for all function transitions in the selected processes whether there is a change in
the executing organizational unit, group, person, or position.
Organizational assignments to functions can be done by means of the contributes to or
carries out connection type. If multiple organizational elements of a function are allocated
using connections of the contributes to type, all organizational elements are required to
carry out the function. For carries out connections, only one organizational element is
required, that is, the organizational elements represent alternatives.
As a result of the alternatives during the organizational execution of the function, two values
are counted for the number of organizational changes. If a change is possible but not required
(alternative), the value of minimum changes does not increase, but the value of maximum
changes does. In the case of mandatory change, both numbers are increased.
Within the process, rules are viewed as AND rules during evaluation for the sake of simplicity.
CONTEXT
Models of type:
 Office process
OUTPUT FORMAT
 TXT
 XLS
246
3.6.1.2.6.5 Report: Analyze times/costs
USE
Lists all functions of the processes, and outputs the attribute values for times/costs. This
enables you to identify time and cost-intensive functions for which you need to define
optimization measures.
The calculations in the table are always based on Frequency per day. Values specified in the
database are automatically converted. If you enter values manually in the table you need to
make sure that you specify Frequency/Daily and do not overwrite formulas.
CONTEXT
Models of type:
 EPC
 Office process
 PCD
 VACD
OUTPUT FORMAT
XLS
247
3.6.1.2.6.6 Report: Compare models
USE
This report analyzes models based on defined options. You can compare several models with
each other directly or determine comparison models for an individual source model, even
across different databases, as well as determine model versions and then compare them with
the source model. You can specify whether the output shows all items that have been
changed, all items that exist only in the source model, or all items that exist only in
comparison models. All objects, connections, free-form texts, and graphic objects are
included.
On the one hand, the scope of the model comparison (existence comparison) enables you to
output the differences in the existence of objects between target model (source model) and
actual models (comparison models). On the other hand, you can analyze the differences in the
attributes (attribute comparison) and relationships (relationship comparison) of shared
objects.
Apart from the option to compare models across databases, optional selection criteria are
available that enable you to determine the actual models (comparison models). You can also
define when objects are to be considered identical.
You can select the following options:
COMPARISON OPTIONS
Within the database
Specifies that the model comparison is performed within the current database.
Between databases
Specifies that the model comparison is performed between models of different databases. If
you enable this option, you can select the database containing the comparison models.
Database
Specify the database in which the model to be used for comparison is stored.
This field offers all databases of the current tenant.
Different versions of the selected model

Specifies that the model comparison is performed between the selected model and its
versions.
The prerequisite for this comparison is that the selected model is saved in a versionable
database and has at least one version.
248
Master model or model variants of the selected model

Specifies that the selected model is compared with its master model if it is a model variant, or
that it is compared with one of its model variants if it is a master model.
Models with identical attribute

Specifies that the selected model is compared with models if their attribute value matches a
selected attribute.
Use the Attribute field to specify which attribute type must match for a model to be used for
a comparison.
Attribute
Specify which attribute value must match for a model to be used for a comparison.
Match case
Specify that the case must match when checking the attribute value.
For example, if this check box is enabled the attribute value Process is not identical with the
attribute value process for the Name attribute, and therefore, the models are not compared.
Models with identical GUID

Compares models having an identical GUID.
The GUID is a string that uniquely identifies items worldwide. It is automatically assigned by
the system.
Any comparison models

Enables you to compare the source model with any model.
INCLUDE
Items contained only in the source model
Specifies that items are displayed that exist only in the source model and do not occur in the
comparison models.
Items contained only in comparison models

Specifies that items are displayed that exist only in the second comparison model and do not
occur in the source model.
Changed items of both models

Specifies that all changed items in both models are displayed.
Changed items of all models

Specifies that all changed items in all models are displayed.
249
ITEMS
Model properties
Specifies that changed model properties are to be displayed, for example, model template,
background color, or model attributes.
Object definitions
Specifies that all changes to the object definitions in terms of the following aspects are
displayed: attributes, assignments, and default symbol.
You can compare model semantics by enabling the option Object definition and disabling
the option Object occurrences (symbols).
In this case, the semantic content is considered to be identical if a model contains two object
occurrences, each of which has a connection to two objects, or a model contains one object
occurrence with two connections to two objects.
Object attributes
Specifies that changed attributes are to be output.
System attributes
Specifies that changed system attributes are to be displayed, for example, time of generation,
last user, etc.
Object occurrences (symbols)

Specifies that all changes relating to the object symbol for the object occurrences are
displayed.
You can compare model semantics by enabling the option Object definition and disabling
the option Object occurrences (symbols).
In this case, the semantic content is considered to be identical if a model contains two object
occurrences, each of which has a connection to two objects, or a model contains one object
occurrence with two connections to two objects.
Appearance
Specifies that all changes relating to the appearance of object occurrences (shading, line
style, fill color, etc.) are displayed.
Position/Size
Specifies that changes to object occurrences in terms of their positioning in the modeling
area and their size are displayed.
Attribute placement
Specifies that changes to the attribute placement for object occurrences are displayed.
250
Connection definition
Specifies that all changes to the connection definitions in terms of attributes and
assignments are displayed.
Connection attributes
Specifies that changed attributes are to be output.
Connection occurrences (arrow symbols)

Specifies that all changes relating to the arrow symbol for the connection occurrences are
displayed.
Connection appearance
Specifies that all changes relating to the appearance of the connection occurrences (color,
style, arrow to source, etc.) are displayed.
Connection alignment
Specifies that changes of the connection alignment are output. The connection alignment
changes if a connection is anchored at a different place at the object (connection anchor
point). It also changes if the number of angles of a connection changes. Usually, the
connection direction changes at connection angles.
Connection attribute placement

Specifies that changes are output as soon as attributes of connection occurrences are placed
at a different position, removed, or replaced by others.
Graphic objects
Specifies that changes to the graphic objects (position, size, shape, etc.) are displayed.
Free-form text
Specifies that changes to free-form texts (position, content, etc.) are displayed.
ADDITIONAL IDENTIFICATION CRITERIA FOR IDENTICAL OBJECTS

Objects with identical attribute
Enables you to select an attribute that serves as a criterion to identify objects as identical. If
you select this option, you can also include upper/lower case as well as line breaks and
spaces.
Objects can be defined as identical if they are of the same type and have a selected attribute,
for example, NAME, that matches. When you use an identical attribute to compare objects,
note that the assignment of the objects is not necessarily unique. In this case, you have to
ensure uniqueness by means of internal conventions. If the corresponding attribute is not
specified, no objects that are the same as this object can be determined because in this case,
that would be all objects for which the attribute was not specified.
251
Match case
Finds only objects with names that match precisely with regard to upper and lower case.
Include line breaks and spaces

Only includes attribute values that are exact matches in terms of line breaks and spaces.
CONTEXT
The comparison includes all "normal" ARIS models. Only the following models are not included
in the model comparison:
 UML models
 Matrix models
 Process instantiation model (PIM)
 Shift calendar
OUTPUT FORMAT
The output is an Excel workbook. Below is an example of a model comparison including
different model versions.
252
These tables will be output:
Summary
This table summarizes all comparison options.
Comparison result
This table summarizes all changes in the form of an overview.
Yellow means an update, red means that items have been deleted, and green means that
items have been added.
253
Comparison details
This table summarizes all differences in detail.
Graphics
This table displays the differences in the model graphics in color.
254
3.6.1.2.7 Automation
3.6.1.2.7.1 Report: Check consistency of data flow

dependencies
USE
This report cannot be started directly by the user. It has to be started via the macro with the
same name. The report checks the consistency of dependencies between objects of an EPC
and associated data flows.
CONTEXT
 Group
 Model
The report is startet on models of EPC and Data flow diagram type.
CATEGORY
Automation
OUTPUT
 XLS
 XLSX
255
3.6.1.2.7.2 Report: Find indirectly updated models
USE
The Find indirectly updated models report checks whether objects used in this model were
changed outside the model. The report checks whether the date of the Last change object
attribute is more recent than that of the model attribute. Changing the object attribute does
not automatically result in a change to the model attribute. In other words, if an object is
changed outside the model, resulting in the Last change object attribute being updated, the
Last change model attribute is not updated automatically. If the date of the Last change
object attribute of an object that has an occurrence in the model is more recent than that of
the model attribute, a timestamp is added in the Last check for object changes model
attribute (attribute type group Process automation).
CONTEXT
 Group
 Model
CATEGORY
Automation
RESULT
A message shows whether indirectly updated models were or were not found. If indirectly
updated models are found, they are marked with a timestamp. You can use a time stamp to
search for models that were updated indirectly.
256
3.6.1.2.7.3 Report: Generate shortcuts
USE
The Generate shortcuts report generates shortcuts for models and the assigned function
allocation diagrams in a selected group. This enables you to find models that have function
allocation diagrams assigned to them in order to trigger an automated approval procedure for
these models, for example.
CONTEXT
The report can be started for all model types. As an option, function allocation diagrams that
are assigned to process interfaces can be ignored.
CATEGORY
Automation
RESULT
Models that have function allocation diagrams assigned to them are listed. You can use this
information to trigger an automated approval procedure for these models, for example.
3.6.1.2.7.4 Report: Model status overview
USE
The report Model status overview outputs an overview of the status of models in Release
Cycle Management.
CONTEXT
The report can be started for groups, including subgroups, or models.
CATEGORY
Automation
RESULT
The report outputs model name, model type, model status, process manager, and model path
for the selected models.
257
3.6.1.2.7.5 Report: Output organizational structure
USE
The report Output organizational structure outputs the organizational structure that the
Process Governance process is based on.
CONTEXT
The report can be started for models of the Organizational chart type and objects of the
Organizational unit, Group, Position, Role, and Person type, for which an occurrence exists
in an organizational chart. As an option, you can define the assignment level down to which
assigned models are to be included in the report.
CATEGORY
Automation
RESULT
The organizational hierarchy is displayed in Excel format, and saved automatically under the
name and location selected in the wizard.
258
3.6.1.2.8 Balanced Scorecard

3.6.1.2.8.1 Report: ARIS Strategy Scorecard
USE
The report provides relevant content in the form of an Excel file that can be used for creating
a BSC dashboard in MashZone.
CONTEXT
Models of type BSC Cause-and-effect diagram
OUTPUT FORMAT
XLS
259
3.6.1.2.8.2 Report - ARIS Strategy Scorecard (extended)
USE
The report provides relevant ARIS content in the form of an Excel file that can be used for
creating a BSC dashboard in MashZone. The report is based on the ARIS Strategy Scorecard
report. It enables the additional output of previous KPI data, but cannot be run as a scheduled
report.
CONTEXT
Models of type BSC Cause-and-effect diagram
OUTPUT FORMAT
XLS
3.6.1.2.8.3 Report: Analysis of strategic initiatives and

processes
USE
Prioritize individual initiatives and processes of your Balanced Scorecard. Determines the
effectiveness of individual initiatives and processes considering superior objectives and
critical factors at the end of the cause-and-effect chain and average total costs.
CONTEXT
Models of type:
 BSC Cause-and-effect diagram
 Function tree
 Value-added chain diagram (VACD)
OUTPUT FORMAT
XLS
260
3.6.1.2.8.4 Report: Create BSC management view
USE
Calculates the degree of goal accomplishment for KPIs, objectives, and success factors of
your Balanced Scorecard, and creates a graphical representation. In addition, it outputs
initiatives, functions, and change management attributes. Errors in models can also be
indicated.
THE FOLLOWING KPIS AND ATTRIBUTES MUST BE SPECIFIED

 Actual value (KPI)
 Plan value (KPI)
 Tolerance range (KPI)
 Weighting (connection between KPI and strategic objective)
OUTPUT OPTIONS
Strategic objectives and success factors
Outputs the defined objectives and success factors. The degree of goal accomplishment of an
objective or a success factor is calculated based on the degree of goal accomplishment of the
allocated KPIs and the KPI weighting.
You can also output the initiatives/functions.
Strategic objectives and success factors with KPIs
Outputs the defined objectives and success factors along with the relevant KPIs. The degree
of goal accomplishment of an objective or a success factor is calculated based on the degree
of goal accomplishment of the allocated KPIs and the KPI weighting. The degree of goal
accomplishment of a KPI is calculated based on the attributes Plan value, Actual value,
Minimum value, and Maximum value, and the KPI evaluation.
You can also output the initiatives/functions.
KPIs
Outputs the achievement of objectives of the defined KPIs.
Output initiatives/functions
If you selected the option Strategic objectives and success factors or Strategic
objectives and success factors with KPIs, the initiatives and the name of the employee
who is responsible for implementing an initiative are output for each evaluated strategic
objective and each evaluated success factor.
Output change management attributes
Additionally outputs all changes managed by change management.
261
Example
You can find sample models in the demo database.
Depending on the selected output options, you receive the following output:
Strategic objectives and success factors
Strategic objectives and success factors with KPIs
262
KPIs
CONTEXT
Models of type:
 Function tree
OUTPUT FORMAT
 HTML
 DOC
263
3.6.1.2.8.5 Report: Create BSC overview
USE
Creates an overview of the following information contained in the selected and assigned
Balanced Scorecard models:
 Strategies
 Perspectives
 Objectives
 Success factors
 KPIs
 Initiatives
 Processes
 Application systems
 Change management
The information is offered in various combinations, of which you can choose one.
The table shows which attributes are evaluated for strategic objectives, KPIs, and initiatives:
Information Objective/Succes KPI Initiative

s factor
Name x x x
Actual time x
period
Plan value x
Actual value x
Status x
Data source x
Person x
responsible
Start date x
End date x
Layout x
264
The data is output in tables. For each perspective of a model, a table is output in the sequence
indicated above.
CONTEXT
Models of type:
 Function tree
OUTPUT FORMAT
 HTML
 DOC
265
3.6.1.2.8.6 Report: Export BSC KPIs
USE
Exports KPIs and KPI attributes of your Balanced Scorecard to an Excel file. You can edit the
attributes in Microsoft® Excel and then make them available in ARIS again using the Import
BSC KPIs (page 267) report. You can assign an export ID to identify the data. This allows you,
for example, to keep a record of the progression of individual KPIs over time in Microsoft®
Excel.
Identifier that uniquely identifies the data. By default, an ID consisting of the date, time, and
logged-in user is assigned. You can also enter a different identifier. Ensure that you enter the
correct ID when importing.
OUTPUT OPTIONS
The table below is an example of the output file obtained:
CONTEXT
Models of type:
 Function tree
OUTPUT FORMAT
XLS
266
3.6.1.2.8.7 Report: Import BSC KPIs
USE
Imports KPI attributes from an Excel file that was previously created using the Export BSC
KPIs (page 267) report. You can use the export ID and model name to determine which
records you want to import.
CONTEXT
Database
3.6.1.2.8.8 Report: Perform BSC planned-actual

comparison
USE
Calculates the degree of goal accomplishment for KPIs, objectives, and success factors of
your Balanced Scorecard in the actual time period. The results of this analysis are
documented in BSC cause-and-effect diagrams that are selected or assigned to the objects
of the selected organizational charts, structuring models, function trees, or value-added
chain diagrams.
Ensure that the affected models are closed during report execution. Otherwise, the changes
cannot be displayed in the models. If you start the macro of the same name, open models are
also included.
You can also use this report to reset the model appearance after a BSC planned-actual
comparison.
OUTPUT OPTIONS
Calculate and mark achievement of objectives
Calculates the degree of goal accomplishment for the strategic objectives and success
factors. The calculated values can be graphically represented in various forms at the object
occurrences in the models.
cannot be displayed in the models.
Show plan and actual values at the objects
Displays the values of the Actual value and Plan value attributes for the objects in models.
No degrees of goal accomplishment are calculated and graphically represented.
267
If you output this report for a model for which degrees of goal accomplishment have
previously been calculated and graphically represented, this information is deleted.
Show icons representing achievement of objectives at the objects

Arrows indicate the degree of goal accomplishment inside the models.
The actual value of the evaluated KPI lies in the range

between the minimum value and the alarm value.
The actual value of the evaluated KPI lies in the range

between the alarm value and the plan value.
The actual value of the evaluated KPI is greater than the plan
value.
If you have not enabled the check box, and models already contain these icons, the icons are
hidden after the planned-actual comparison.
Represent degree of goal accomplishment in color at objectives and KPIs
Shows the degree of goal accomplishment of KPIs, strategic objectives, and success factors
in color in the models.
The following table shows the criteria according to which the object occurrences are colored:
Red The actual value of the evaluated KPI lies in the range
between the minimum value and the alarm limit.
Yellow The actual value of the evaluated KPI lies in the range
between the alarm limit and the plan value.
Green The actual value of the evaluated KPI is greater than the plan
value.
If you have not enabled the check box, and selected models contain colored object
occurrences, object occurrences are displayed with the default icons after the
planned-actual comparison.
Reset marks
268
Resets all graphical changes inside the models that were set by previous planned-actual
comparisons. Degrees of goal accomplishment are not recalculated.
Example
You can find sample models in the demo database.
If you have enabled all check boxes under Calculate and mark achievement of objectives,
the model is adjusted as follows:
269
CONTEXT
Models of type:
 Function tree
OUTPUT FORMAT
 HTML
 DOC
270
3.6.1.2.9 BPM
3.6.1.2.9.1 Report: Analyze main success factors
USE
This report analyzes success factors with regard to the Success - Actual, Success - Target,
and Success - Competitor attributes. Depending on the selected context, all success factors
are included that are contained in the selected objective diagrams or in the objective diagram
assigned to the selected business segment.
The values of the success factors at the lowest level of detail are compared graphically. The
hierarchy of the success factors is reflected in the output structure.
CONTEXT
 Models of the Objective diagram type
 Objects of the Business segment type
OUTPUT FORMAT
HTML
271
3.6.1.2.9.2 Report: Evaluate process
USE
Based on the functions within the selected value-added chain diagrams, this report creates a
process portfolio with regard to the process performance and fulfillment of the success
factors.
CONTEXT
Models of the VACD type
OUTPUT FORMAT
HTML
3.6.1.2.10 Business Publisher

From ARIS 10.0.13.0 on ARIS Publisher and IT Inventory are no longer delivered. This means
that you can no longer install or update ARIS Publisher Server. You can still use your current
ARIS Publisher installation, but since this component is no longer supported, no more features
will be developed. We strongly recommend using the ARIS portal (Published content) instead
of ARIS Publisher in the future.
272
3.6.1.2.10.1 Report: Start Publisher export
USE
Creates a Publisher export with the contents of the selected database. The name of the
export is Test export. It is automatically released.
The name Test export was defined in the script. Change the name before you run the report
again because exports with identical names are not generated.
CONTEXT
Database
3.6.1.2.10.2 Report: Start Publisher export (Process

Governance)
USE
Creates a Publisher export with the contents of the selected database. The name of the
export is Test export. It is automatically released.
The name Test export was defined in the script. Change the name before you run the report
again because exports with identical names are not generated.
CONTEXT
Database
273
3.6.1.2.10.3 Report: HTML export
USE
This report creates an HTML export. For example, you can publish process models and
documents as HTML pages independently of platforms via Internet or intranet.
Use this report only on medium or large size installations and do not publish all groups of a
large database. Otherwise, the performance of the system will be affected.
You can make the following settings in the script:
 Key: WP_SelectedDBLanguage
The value defines the database language. Attribute values are specified and displayed in
the selected language.
Always enter a combination of the language and the country, for example, en_US.
 Key: WP_SelectedOutputPath
The value specifies the path to the directory in which the generated HTML pages are to
be saved.
 Key: WP_ConsiderHierarchies
true ,means Include hierarchies: all assigned models are automatically exported up to
the selected assignment level ( see key: WP_AssigLevel).
 Key: WP_AssigLevel
Defines the assignment level: Level up to which assignments are to be included in the
export (values between 1 and 100).
 Key: WP_TreeView
Navigation tree: Specifies the data view in the navigation tree, which is displayed in the
HTML export.
 Key: WP_UpdateWeb
true means Update: Adds individual or multiple models and groups to an existing HTML
export and updates it.
false means Overwrite export:Overwrites the existing export with the selected content
and deletes all previous pages.
 Key: WP_ExportObjects
true means Output object information: Creates object information pages for the
models to be exported.
 Key: WP_ObjectTypes
Creates object information for each object of the entered type.
274
 Key: WP_UsePrintScale
true means Use print scale: Original size in which models are displayed. This value was
selected as the print scale for each model (Format > Print).
false means, that the initial scaling is used.
 Key: WP_InitialScale
Initial scaling: Original size is 10 to 200 % of the size of appearance.
 Key: WP_ZoomSteps
Scaling levels: Levels in %, for enlarging or reducing models in the browser.
 Key: WP_Transparent
true means Transparent: Displays models without a background. If wallpaper is assigned
to models it is not displayed in the browser.
 Key: WP_BlackWhite
true means Black and white: Displays models in grayscale.
 Key: WP_ModelSort
Defines the default sort criterion for model lists. You can sort lists alphabetically in
ascending (0) or descending (1) order.
 Key: WP_ObjectSort
Defines the default sort criterion for object lists. You can sort lists alphabetically in
ascending (0) or descending (1) order.
 Key: WP_AttributeSort
Defines the default sort criterion for attribute lists. You can sort lists alphabetically in
ascending (0) or descending (1) order, or sort them by method (2).
 Key: WP_LinkList
Defines links that can be run from the export.
Links, for example, to documents, Internet sites, or e-mail addresses that call up an
e-mail program (mailto:info@company.xyz.com) are converted into hyperlinks. These are
available on different tabs in the export.
 Key: WP_CopyDocs
true means Copy documents: Creates copies of linked documents. Users always open
these copies from the export instead of accessing the original documents.
Furthermore, you can specify the name of the required HTML layout by using the variable
layoutname. The export is then created in this layout.
275
CONTEXT
 Groups
 Models
3.6.1.2.10.4 Report: Show model graphics from group in

Excel
This report is available automatically in all exports and can be started by every Publisher
export user.
USE
The report generates an Excel file with all of the models contained in the group. One
worksheet is created per model. In addition to the model graphic, standard information such
as name or the last edit, etc. is displayed.
CONTEXT
The report can only be started for groups.
276
3.6.1.2.11 Use case: Business as unusual

For more information, watch the Business as Unusual video.
3.6.1.2.11.1 Report: Business judgement report
USE
With this report, the business manager decides which risk solutions are to be promoted with
regard to risk mitigation or solution deployment. All associated risks that have not been
addressed yet (Implementation status (solution) is NULL) and that the business manager
must decide on are listed by activity by this report.
All activities related to the model are reported as long as they have at least one associated
risk, including all functions from subordinate models. The report contains a section for each
activity with all relevant data, broken down into one page per risk. You can record the
following:
 the proposed solution
 notes
 the priority of deployment
 the approval or rejection including the date and signature
277
CONTEXT
 Database
 Group
 Model of the Value-added chain diagram type
OUTPUT FORMAT
 PDF
 DOCX
3.6.1.2.11.2 Report: Process weak-point analysis
USE
This report enables the process manager to easily filter and sort critical activities and high
risks, tackling the most urgent and important ones first, with a view to take forward the
selected few for mitigation (implementation) plan.
The report lists all model functions (activities) and their assigned models, with their assessed
criticality and associated risks including impact and probability.
CONTEXT
 Database
 Group
 Model of the following types:
 Enterprise BPMN collaboration diagram
 Enterprise BPMN process diagram
 EPC
OUTPUT FORMAT
XLSX
278
3.6.1.2.11.3 Report: Weak-point overview
USE
This report provides an overview of all identified weak points and their solution status.
The report specifies all risk objects that are defined in a value-added chain diagram, BPMN
diagram, or an EPC, and that are linked to a function. All relevant information about the risk
objects, including any associated activity and model, are displayed in the Excel Workbook
(*.xlsx) output file.
CONTEXT
 Database
 Group
 Model of the following types:
 EPC
OUTPUT FORMAT
XLSX
279
3.6.1.2.12 Change management

3.6.1.2.12.1 Report: Output task list
USE
Creates a task list for modelers or process managers. It contains all models and objects that
have to be changed.
CONTEXT
Group
OUTPUT FORMAT
DOC
280
3.6.1.2.12.2 Report: Output change management history
USE
Evaluates the change management history as text or in a table.
The following information that was defined and reset during change management is output in
terms of time:
 Improvement potential
 Measure
 Remark
 Priority
 Status
 Responsible
 End date
CONTEXT
 Model or
 Object
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
281
3.6.1.2.12.3 Report: Output status changes and

improvement proposals
USE
Provides the following optional information:
 List of improvement proposals
 List of status changes of objects and models
If you output improvement proposals, a table of objects and models for which improvement
proposals exist is generated. All items for which an improvement attribute was specified and
for which the improvement manager has at least the Read access privilege are listed.
If you output the status changes, a list is created containing the objects and models whose
status has changed. This enables the improvement manager to keep track of the items that
were changed in the database. In addition, the value of the Status (CMA) attribute can be
copied into the Last status (CMA) attribute.
CONTEXT
Group
OUTPUT FORMAT
XLS
282
3.6.1.2.12.4 Which attributes must be allowed by the filter

for reports?
To enable you to output change management results using reports, the following attributes
must be allowed by the method filter you are using when logging in to the database:
For models and objects
Attributes API name
Status (CMA) AT_STATUS
Name AT_NAME
Identifier AT_ID
Type AT_TYPE_6
For objects
Attributes API name

Priority AT_PRIO_3
End date AT_DEADL
Measure AT_ACTION_2
Responsible AT_RESPON
Improvement potential AT_IMPROVE
Reported on AT_REGIST
Remark AT_NOTE_2
283
3.6.1.2.13 Confirmation management

Here, you can find details on confirmation management reports.
3.6.1.2.13.1 Report: Generate confirmation process

schedulers (APG use case)
USE
This report generates confirmation process schedulers in ARIS Risk and Compliance.
This demo report shows as an example how to use a report script to generate activated
confirmation process schedulers for objects and/or models. The report uses uses the
attributes specified in the attribute group Confirmation Management.
This report is intended for integration into an Process Governance (APG) workflow.
By default the report is disabled.
CONTEXT
Standard objects and models in ARIS and ARIS Architect.
CATEGORY
Confirmation Management
284
3.6.1.2.13.2 Report: Generate activated confirmation

process scheduler for changed items
USE
This report generates activated confirmation process schedulers in ARIS Risk and Compliance
based on the last change date.
The report checks the last change date for all objects and models in the selected group. The
last change date is compared with the threshold date entered by the user. For all objects and
models whose last change date is more recent than the threshold date, an activated
confirmation process scheduler will be generated in ARIS Risk and Compliance based on the
confirmation management attributes specified for the objects and models.
CONTEXT
CATEGORY
Confirmation Management
285
3.6.1.2.13.3 Report: Output confirmation process details
USE
This report shows the details of the confirmation process of an ARIS item. By default the
report is disabled. To ensure the reports are not available to all ARIS users, restrict access to
certain user groups (ARIS Architect > ARIS > Administration > Evaluations > Reports
> Confirmation management > <report xy> > Properties > Restrict access).
CONTEXT
CATEGORY
OUTPUT FORMAT
PDF
RESULT
Name of the confirmation processes, start and end date, current status, confirmation text,
number of attached documents, total number of addressees, and number of addressees in
the respective status. List of confirmations with name of the addressees, confirmation date,
and status. If addressees were removed from a running confirmation process before they
have confirmed, a list of the removed addressees is also displayed in the confirmation process
details report. Addresses that are removed after they have confirmed are nevertheless
displayed in the list of confirmations.
286
3.6.1.2.13.4 Report: Output confirmation processes

overview
USE
This report shows an overview of the confirmation processes of an ARIS item. By default the
report is disabled. To ensure the reports are not available to all ARIS users, restrict access to
certain user groups (ARIS Architect > ARIS > Administration > Evaluations > Reports
> Confirmation management > <report xy> > Properties > Restrict access).
CONTEXT
CATEGORY
OUTPUT FORMAT
PDF
RESULT
List of confirmation processes with start and end date, current status of confirmation
processes, number of attached documents, total number of addressees, and number of
addressees in the respective status.
287
3.6.1.2.14 Customer Experience Management

3.6.1.2.14.1 Report: Analyze customer experience
USE
This report uses an infographic to visualize how customers experience their interaction with
the company during a customer journey and is intended to help identify customer satisfaction
as well as customer issues.
The following information is evaluated and displayed:
 Customer journey steps with customer touchpoints
The representation of the infographic is optimized for up to eight customer journey steps
per model. If this number is exceeded, it can lead to representation problems.
 Moment of truth and pain points with description
 Best practice
 Importance to customer & customer feeling (satisfaction)
 Percentage proportion of pain points in the customer journey map
 Number of internal processes impacted
 Percentage proportion of satisfied customers
288
In order for the report to be run and for it to deliver meaningful results, the following
conditions must be met:
 If multiple customer touchpoints are specified for each customer journey step, only
the first customer touchpoint is analyzed.
 If models contain more than eight customer journey steps, a message is displayed. In this
case the infographic that is output may lack clarity as a column is added for each
customer journey step.
289
 The following attributes must be specified for the customer touchpoint:

 Description (Constants.AT_DESC)
 Customer feeling (Constants.AT_CUSTOMER_FEELING)
 Importance to customer (Constants.AT_IMPORTANCE_TO_CUSTOMER)
 Best practice (Constants.AT_BEST_PRACTICE)
 Pain point (Constants.AT_PAIN_POINT)
 Description of pain point (Constants.AT_DESCRIPTION_PAIN_POINT)
 Moment of truth (Constants.AT_MOMENT_OF_TRUTH)
 Description of moment of truth
(Constants.AT_DESCRIPTION_MOMENT_OF_TRUTH)
 For the customer journey step, the Overall customer experience attribute
(Constants.AT_OVERALL_CUSTOMER_EXPERIENCE) must be specified.
CONTEXT
 Model of Customer journey map type
 Object of Customer journey type
OUTPUT FORMAT
 DOC
 DOCX
 ODT
 PDF
290
3.6.1.2.14.2 Report: Create infographic for persona
USE
This report outputs an infographic that visualizes all persona-related data you have specified.
The following information is evaluated and displayed:
In order for the report to be run and for it to deliver meaningful results, make sure that the
following attributes are specified for Persona objects:
291
Attribute Example
Name Lukas Andrews
Description/Definition This text is shown beneath the About topic.

Lukas has been interested in technology for many years. As a
software engineer, he makes a living with programming innovative
mobile apps. But his highest priority is the well-being of his family.
For him, a car needs to be both functionally well designed and have
enough space to accommodate the entire family for holiday trips.
Personally, he owns many electronic gadgets. Generally, he is
sensitive to cost but can get carried away if he sees an innovative
solution.
The following attributes must be specified for the Customer Experience Management
attributes:
Attribute Example
Age 32
Family status married
Location Saarbruecken
Job title Software Engineer
Personality  conscientious
 detail oriented
 humorous
 playful
Frustration  reading manuals

 services that are overly time consuming
 sharing his personal data to unknown entities
Goals  save money for buying a house

 get promoted in his company
 exercise his favorite sport more often: Climbing
Quote The Best Things in Life Are Free
You can link images either in the Customer Experience Management attribute type group or
in the ARIS document storage attribute type group.
292
Customer Experience ARIS document storage Image/position

Management attribute attribute
Portrait image link ARIS document storage Portrait; at the top
Link 1
Descriptive image Link 1 ARIS document storage Electronic gadgets; image on the
Link 2 left.
Descriptive image Link 2 ARIS document storage Climbing; image in the center.
Link 3
Descriptive image Link 3 ARIS document storage Family; image on the right.
Link 4
Some content is only shown in the infographic if the Persona object is related to a Customer
segment object. The belongs to relationship is evaluated.
293
In this example, the Family Customer segment is shown because the Lukas Andrews
Persona occurs in a Customer segmentation map and this Persona object is related to the
Family Customer segment object.
CONTEXT
Object of Persona type
OUTPUT FORMAT
 DOC
 DOCX
 RTF
 ODT
 PDF
294
3.6.1.2.14.3 What queries are available for customer

experience by default?
Available queries
 Find all processes related to customer journeys
All processes with their associated customer journeys are output.
Start object: Function
 Find customer touchpoints clustered by associated channel
The customer touchpoints belonging to a channel are output.
Start object: Distribution channel
 Find customer touchpoints clustered by associated ownership
All customer touchpoints for which the selected organizational unit is responsible are
output.
Start object: Organizational unit
 Find customer touchpoints clustered by associated risk
The customer touchpoints belonging to a risk are output.
Start object: Risk
 Find risks and initiatives for all customer touchpoints
All customer touchpoints are output along with their associated risks and strategic
initiatives.
Start object: Customer journey
 Find risks and initiatives for bad customer touchpoints only
All bad customer touchpoints are output along with their associated risks and strategic
initiatives.
 Get full customer journey overview (for data maintenance)
A table is output showing a complete overview of the customer journey.
295
3.6.1.2.15 Dashboard data

In this category you find reports needed to generate data feed input for default ARIS Aware
Dashboards. The code of these reports cannot be modified. If you like to modify the code, in
order to define your own dashboards, import the required reports from the ARIS installation
package. Only the reports that are to be run as scheduled reports are described. Other reports
in this category that must not be run individually are not described. They are used by the
described reports.
For some reports, parameters can be specified. These parameterized reports are to be started
frequently using report schedules. This keeps the dashboards up to date. The scheduled
reports themselves trigger related reports. Each report collects specific pieces of information.
The results are stored in ARIS document storage as XML report output files. These pieces of
information are formed into dashboards. That is why dashboards correlate very closely to the
set of executed reports.
296
3.6.1.2.15.1 Report: CoE - Aggregated maturity level
USE
This report evaluates the following Center of Excellence use cases using several
subordinated reports.
 Maturity level
 Mandatory properties
 Number of processes
 Model status
 Model age
The results are aggregated along the process hierarchy so that each level of the process
hierarchy will provide an aggregated result for its complete child hierarchy.
The report provides various parameters allowing customizing without changing the report
code.
OUTPUT
Generates the following files stored in this subfolder: ARIS document
storage/Dashboarding/United Motor Group/CoE (page 465).
 COE_MATURITY_LEVEL.XML
 COE_MANDATORY_PROPERTIES.XML
 COE_NUMBER_OF_PROCESSES.XML
 COE_MODEL_STATUS.XML
 COE_REPRECENTATIVE_OBJECTS.XML
 COE_MODEL_AGE.XML
The report results are used as input for the Center of Excellence (CoE) dashboards.
CONTEXT
Database
297
3.6.1.2.15.2 Report: CoE - Maturity level/Mandatory

properties
USE
This report provides the evaluation algorithms for the following Center of Excellence use
cases:
 Maturity level
 Mandatory properties
It is invoked by the CoE - Aggregated maturity level report and is not intended to be started
by users.
3.6.1.2.15.3 Report: CoE - Model age
USE
This Center of Excellence report provides the evaluation algorithms for the Model age use
case.
by users.
3.6.1.2.15.4 Report: CoE - Number of processes/Model

status
USE
This report provides the evaluation algorithms for the following Center of Excellence use
cases:
 Number of processes
 Model status
by users.
298
3.6.1.2.15.5 Report: CoE - Representative objects
USE
This report collects representative objects for the items in the evaluated hierarchy.
by users.
3.6.1.2.15.6 Report: CoE - Local and global maturity level
USE
This report evaluates the following Center of Excellence use cases using several
subordinated reports.
 Conventions
 Owner distribution
 Validity date
code.
OUTPUT
 COE_CONVENTIONS.XML
 COE_OWNER_DISTRIBUTION.XML
 COE_VALIDITY_DATE.XML
CONTEXT
Database
299
3.6.1.2.15.7 Report: CoE - Conventions
USE
This Center of Excellence report provides the evaluation algorithms for the Conventions
use case.
It is invoked by the main CoE - Local and global maturity level report and is not intended to
be started by users.
3.6.1.2.15.8 Report: CoE - Owner distribution
USE
This internal Center of Excellence report provides the evaluation algorithms for the Owner
distribution use case.
3.6.1.2.15.9 Report: CoE - Validity date
USE
This internal Center of Excellence report provides the evaluation algorithms for the Validity
date use case.
300
3.6.1.2.15.10 Report: CoE - Governance
USE
This report evaluates the 'Governance' Center of Excellence use case that includes the
following workflows:
 Submit change request
 Approve model
 Share model
code.
OUTPUT
 COE_PROCESS_INSTANCES.XML
 COE_PROCESS_INSTANCES_SHARE.XML
 COE_PROCESS_INSTANCES_APPROVAL.XML
 COE_PROCESS_INSTANCES_CHANGE_REQUEST.XML
 COE_HUMAN_TASKS.XML
 COE_HUMAN_TASKS_APPROVAL.XML
 COE_HUMAN_TASKS_CHANGE_REQUEST.XML
 COE_HUMAN_TASK_ASSIGNMENTS.XML
CONTEXT
Database
301
3.6.1.2.15.11 Report: CXM - Analyze customer experience
USE
This report provides the answers to the following questions and provides a general overview:
 Which business drivers influenced the journey?
 How happy is the customer?
 Which customer touchpoints are critical?
 Overview of risks and initiatives.
code.
OUTPUT
Generates the CMX_ANALYZE_CUSTOMER_EXPERIENCE.XML file. The Get a general
overview document is stored in this subfolder: ARIS document
storage/Dashboarding/<database name; default=United Motor Group>/CXM (page 465).
The report result is used as input for the CXM - Analyze customer experience data feed.
This data feed is related to the Customer experience and Customer journey map
dashboards.
CONTEXT
Database
302
3.6.1.2.15.12 Report: CXM – Analyze customer journeys

(TOP 7)
This report answers the following questions:
 Which customer journey is the most critical?
 Which customer lifecycle
 Which stage is the most critical?
code.
OUTPUT
Generates the CXM_ANALYZE_CUSTOMER_JOURNEYS.XML document stored in ARIS
document storage. The Analyze customer journeys (TOP 7) document is stored in this
subfolder: ARIS document storage/Dashboarding/<database name; default=United Motor
Group>/EA (page 465).
The report result is used as input for the CXM - Analyze customer journeys data feed. This
data feed is related to the Customer experience CXM dashboard.
CONTEXT
Database
303
3.6.1.2.15.13 Report: CXM - Critical journeys
USE
This report answers the following questions:
 Which customer journey is the most critical?
 Which customer lifecycle stage is the most critical?
code.
OUTPUT
Generates the CXM_CRITICAL_JOURNEYS.XML file. The Which customer
journey/customer lifecycle stage is the most critical? document is stored in this
Group>/CXM (page 465).
The report result is used as input for the Customer Experience (CXM) dashboards.
CONTEXT
Database
3.6.1.2.15.14 Report: CXM - Responsibility (Channel)
USE
This report provides the answers to the question: Who is responsible for the customer
touchpoints (Channel)?
code.
OUTPUT
Generates the CMX_RESPONSIBLE_CHANNEL.XML file. The Who is responsible for the
customer touchpoints (Channel)? document is stored in this subfolder: ARIS document
The report result is used as input for the CXM - Responsible channel data feed. This data
feed is related to the Responsibilities CXM dashboard.
CONTEXT
Database
304
3.6.1.2.15.15 Report: CXM - Responsibility (Ownership)
USE
This report provides the answer to the following question: Who is responsible for the
customer touchpoints (Ownership)?
code.
OUTPUT
Generates the CMX_RESPONSIBLE_OWNER.XML file. The Who is responsible for the
customer touchpoints (Ownership)? document is stored in this subfolder: ARIS document
The report result is used as input for the CXM - Responsible owner data feed. This data feed
is related to the Responsibilities CXM dashboard.
CONTEXT
Database
3.6.1.2.15.16 Report: Strategy - KPIs with data

This report creates a table with all KPIs in the database. Each KPI's quantitative and
qualitative goal accomplishments are included.
The goal accomplishments are calculated according to Balanced Scorecard methodology.
For the calculation of the goal accomplishment values, at least the actual and the plan values
of the KPI have to be maintained. In case of an inverse KPI, the maximum value is required as
well, but only for the quantitative goal accomplishment.
code.
OUTPUT
Generates the EA_KPIS_WITH_DATA.XML file. Strategy - KPIs with data document is
stored in this subfolder: ARIS document storage/Dashboarding/<database name;
default=United Motor Group>/EA (page 465).
The report result is used as input for the EA - Goal accomplishment (KPIs per objective)
data feed. This data feed is related, for example, to the EA dashboard for objectives
dashboard.
CONTEXT
Database
305
3.6.1.2.15.17 Report: Strategy - Models and objectives

This report creates a table with models of the Strategy diagram model type and the
Objective diagram model type, both of which contain objectives. In addition, all objectives
that the models contain are listed.
The Business Strategy extension pack is required for ARIS Architect or ARIS Designer in
order to have the required attribute types available.
code.
OUTPUT
Generates the EA_MODELS_AND_OBJECTIVES.XML file. The Strategy - Models and
objectives document is stored in this subfolder: ARIS document
storage/Dashboarding/<database name; default=United Motor Group>/EA (page 465).
The report result is used as input for the EA - Goal accomplishment (objectives) data feed.
This data feed is related, for example, to the EA dashboard for objectives dashboard.
CONTEXT
Database
3.6.1.2.15.18 Report: Strategy - Objectives and KPIs

This report creates a table with all objectives and their KPIs.
code.
OUTPUT
Generates the EA_OBJECTIVES_AND_KPIS.XML file. Strategy - Objectives and KPIs
document is stored in this subfolder: ARIS document storage/Dashboarding/<database name;
The report result is used as input for the EA - Goal accomplishment (KPIs per objective)
data feed. This data feed is related, for example, to the EA dashboard for objectives
dashboard.
CONTEXT
Database
306
3.6.1.2.15.19 Report: Strategy - Objectives with data

This report creates a table that includes all objectives of the database. The goal
accomplishment is also provided for each objective.
The goal accomplishment is calculated as a weighted sum of the quantitative goal
accomplishment values of the connected KPIs. This is done only if a weighting value was
specified for all connections to KPIs, and if goal accomplishment values can be calculated for
all KPIs. For the latter to be possible, the actual value and the plan value must have been
specified for each KPI. For an inverse KPI, the maximum value must be available as well.
The calculation is carried out in line with the Balanced Scorecard methodology and in the
same way as in the Create BSC management view report (page 261).
The Business Strategy extension pack is required for ARIS Architect or ARIS Designer in
order to have the required attribute types available.
code.
OUTPUT
Generates the EA_OBJECTIVES_WITH_DATA.XML file. The Strategy - Objectives with
data document is stored in this subfolder: ARIS document storage/Dashboarding/<database
name; default=United Motor Group>/EA (page 465).
The report result is used as input for the EA - Goal accomplishment (objectives) data feed.
This data feed is related, for example, to the EA dashboard for objectives dashboard.
CONTEXT
Database
307
3.6.1.2.15.20 Report: EA - Models and systems

This report creates a table listing models of the Application system type diagram type and
all the IT systems contained in the models.
The Enterprise Architecture Management extension pack is required for ARIS Architect or
ARIS Designer.
code.
OUTPUT
Generates the EA_MODELS_AND_SYSTEMS.XML file. The Models and systems document
is stored within this subfolder: ARIS document storage/Dashboarding/<database name;
The report result is used as input for the data feeds:
 EA - ASTD - Systems with life cycle phase in twelve months
 EA - ASTD - Systems with life cycle phase today
 EA - ASTD - System redundancies
 EA - ASTD - Systems with data
The data feeds are related to the EA Application system type diagram dashboard.
CONTEXT
Database
308
3.6.1.2.15.21 Report: EA - Relations between organizational

units and systems
This report creates a table with pairs of organizational units and IT systems. Such a pair is
included in the table if a system supports an organizational unit (via a function and optionally
a position or role), or an organizational unit is responsible for a system. The report also takes
hierarchies of functions and organizational units into account.
code.
OUTPUT
Generates the EA_UNIT_SYSTEM.XML file. The Relations between units and systems
document is stored in this subfolder: ARIS document storage/Dashboarding/<database name;
The report result is used as input for the EA - Organizational unit - Systems with lifecycle
data and the EA - Organizational unit - Systems expired data feeds. These data feeds are
related to the EA dashboard for organizational units dashboard.
CONTEXT
Database
3.6.1.2.15.22 Report: EA - System redundancies

This report creates a table listing all IT system pairs that have common capabilities. In each
pair, System A is considered to be the potential replacement for System B. For each pair, the
capability overlap is shown as a percentage.
code.
OUTPUT
Generates the EA_SYSTEM_REDUNDANCIES.XML file. The System redundancies in the
use of capabilities document is stored in this subfolder: ARIS document
The report result is used as input for the EA - System - System redundancies data feed.
This data feed is related, for example, to the EA dashboard for organizational units dashboard.
CONTEXT
Database
309
3.6.1.2.15.23 Report: EA - System support

This report creates a table that includes all IT systems of the database, as well as the
organizational units and functions they support. Each row in the table consists of an
Application system type object, the supported object, the object type, the support count,
and a rank. The supported objects are identified by first retrieving the IT systems as well as
the process support units connected to them, and then retrieving the organizational units and
functions connected to the process support units.
ARIS Designer.
code.
OUTPUT
Generates the EA_SYSTEM_SUPPORTS.XML document stored in ARIS document storage.
The System supports document is stored in this subfolder: ARIS document
The report result is used as input for the EA - System - Supported organizational units data
feed. This data feed is related to the EA dashboard for IT systems.
CONTEXT
Database
310
3.6.1.2.15.24 Report: EA - System support for VACDs

This report traverses the hierarchy of value-added chain diagrams (VACDs) and counts how
many functions in EPCs assigned to VACDs are supported by an IT system. An IT system
supports a function if the IT system is linked to the function via a connection of the supports
type. The report creates a table listing the support count and a rank for each combination of
an IT system with a VACD.
code.
OUTPUT
Generates the EA_SYSTEMS_VACD_SUPPORTS.XML file. The document is stored in this
The report result is used as input for the EA - System Supported processes data feed. The
data feed is related to the EA dashboard for IT systems dashboard.
CONTEXT
Database
3.6.1.2.15.25 Report: EA - Systems with data

This report creates a table listing all IT systems of the database. For each system, various
types of information are provided, such as the Data center costs and Criticality attributes,
or the number of interfaces.
ARIS Designer.
code.
OUTPUT
Generates the EA_SYSTEMS_WITH_DATA.XML file. The Systems with data document is
stored within this subfolder: ARIS document storage/Dashboarding/<database name;
The report result is used as input for the EA - Organizational unit - Systems with data data
feed. This data feed is related to the EA dashboard for organizational units dashboard.
CONTEXT
Database
311
3.6.1.2.15.26 Report: EA/Alfabet - CAPEX/OPEX for

organizational units
This report creates a table that includes the capital expenses (CAPEX) and operational
expenses (OPEX) over time for all organizational units of the database that also exist in a
connected Alfabet system. Each row contains the name, ARIS GUID, and Alfabet GUID of the
organizational unit, the year to which the cost values refer, as well as the CAPEX and OPEX
cost values themselves.
code.
OUTPUT
Generates the EA_CAPEX_OPEX.XML file. The Capex/Opex document is stored in this
The report result is used as input for the EA - OrgUnit - CAPEX/OPEX data feed. This data
feed is related to the EA dashboard for organizational units dashboard.
CONTEXT
Database
3.6.1.2.15.27 Report: EA/Alfabet - System costs

This report creates a table listing all IT systems of the database that also exist in Alfabet. For
each system and year, the table contains a row providing the cost values for the various cost
types as specified in Alfabet.
code.
OUTPUT
Generates the EA_SYSTEM_COSTS.XML file. System costs document is stored in this
The report result is used as input for the EA - System (costs over time) data feed. This data
feed is related, for example, to the EA dashboard for IT systems dashboard.
CONTEXT
Database
312
3.6.1.2.15.28 Report: EA/Alfabet - Systems with lifecycle

data
This report creates a table listing all Application system type objects of the database. It also
provides the lifecycle data for each object. These data originate from an Alfabet system - if
one is connected to the database - or from the relevant ARIS attributes.
ARIS Designer.
code.
OUTPUT
Generates the EA_SYSTEM_LIFECYCLE.XML document stored in ARIS document storage.
The System with lifecycle data document is stored in this subfolder: ARIS document
The report result is used as input for the EA - Organizational unit - Systems with lifecycle
data and the EA - Organizational unit - Systems expired data feeds. These data feeds are
related to the EA dashboard for organizational units dashboard.
CONTEXT
Database
3.6.1.2.15.29 Report: Export item data to tables

This report is working with parameters only. These parameters are related to the current ARIS
configuration.
You must specify the items and the properties for these items. While running, the report
collects these user specified properties and writes the output to ARIS document storage.
code.
CONTEXT
Database
313
3.6.1.2.15.30 Report: Matomo - Database-specific portal

usage
This report creates ARIS database-specific portal usage statistics. Therefore, it accesses an
external Matomo instance that contains a collection of ARIS portal events, retrieves specific
Matomo reports, and adds ARIS data to them, if required.
The following Matomo reports are retrieved:
 PageTitles report
 CustomDimension report
 SiteSearchKeywords report
To use the Matomo - Global portal usage (page 315) and Matomo - Database-specific portal
usage (page 314) reports, make sure to have Matomo installed and configured and the report
parameters specified accordingly.
OUTPUT
Generates several XML documents stored in the ARIS document
storage/Dashboarding/<database name; default=United Motor Group>/Matomo subgroup.
The report result is used as input for the Matomo - Publications dashboard.
CONTEXT
Database
314
3.6.1.2.15.31 Report: Matomo - Global portal usage

This report creates global portal usage statistics. Therefore, it accesses an external Matomo
instance that contains a collection of ARIS portal events, retrieves specific Matomo reports,
and adds ARIS data to them, if required.
The following Matomo reports are retrieved:
 VisitsSummary report
 BrowserVersions report
 BrowserEngines report
 Language report
 OsVersions report
To use the Matomo - Global portal usage (page 315) and Matomo - Database-specific portal
usage (page 314) reports, make sure to have Matomo installed and configured and the report
parameters specified accordingly.
The parameters must be specified according to the required Matomo settings. If the settings
are specified several output files are generated.
OUTPUT
Generates several XML documents stored in this subfolder: ARIS document
storage/Dashboarding/Matomo (page 465).
The report result is used as input for the Matomo - Technical KPIs dashboard.
CONTEXT
Database
Since a context is mandatory for ARIS reports, an ARIS database must be specified as context
for this report. However, the database will not be evaluated by the report and it therefore
does not matter which database is selected.
315
3.6.1.2.16 Functions
3.6.1.2.16.1 Report: Output functions with organizational

elements
USE
Describes the assignments of the selected functions to their organizational elements. You
have the option to evaluate either all connections between a function and an organizational
element, or only the connection type carries out.
The functions are output in alphabetical order. The data is output as text or in a table.
CONTEXT
Objects of the Function type.
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
316
3.6.1.2.16.2 Report: Output hierarchy of the functions
USE
Describes the hierarchy of the functions in the database. All functions of the database that
are process-oriented subordinates are output for the selected functions. Both relationships
within models (for example, Function tree) and assignment relationships between functions
and assigned models (for example, EPC) are included.
Functions belonging to the same assignment level are sorted alphabetically; the data is
output as text.
CONTEXT
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
317
3.6.1.2.17 Governance
3.6.1.2.17.1 Report: Find a value within a string
USE
This report selects an ARIS user group and returns the user group attributes.
CONTEXT
Models
OUTPUT FORMAT
XML File (*.xml)
318
3.6.1.2.17.2 Report: Retrieve GUIDs of model(s) and/or

object(s)
USE
This report outputs two lists of identifiers: the GUID of models or the GUID of objects. Input
data may be models and/or objects.
CONTEXT
Models
OUTPUT FORMAT
XML File (*.xml)
319
3.6.1.2.18 Internet of Things

3.6.1.2.18.1 Report: Generate fact sheet for IoT objects
USE
This report collects relevant data related to IoT objects and generates a fact sheet. If the
report is started from models, all contained IoT objects are evaluated.
CONTEXT
 Models
 IoT objects
OUTPUT FORMAT
 PDF
 DOC
 DOCX
 ODT
 RTF
 HTM
320
3.6.1.2.19 IT architecture
You can find tips for handling in the help (Special topics and features > Enterprise
Architecture Management).
3.6.1.2.19.1 Report: Display data flows
Category Macros > IT architecture management

Name Display data flows
Description Using the Display data flows report, the user is able to create a
table of data flows on the basis of one or more application
system types. This report can also be run as a macro directly in
the model. The conventions described earlier must be adhered
to.
321
Figure 1: Connection assignment for IT system interface specification
In the table, all objects are output with their name, with the entries sorted alphabetically in
the following order:
 System
 Connected systems
 Data
 Protocol
 Direction
322
AS A MACRO
Figure 2: Output of the 'Display data flows' macro
AS A REPORT
System Connected systems Data Protocol Direction

ProOn order
processing A plan <--
ProOn order
processing MatReq/1 Material data DDF 567 -->
ProOn order
processing MatReq/1 Order data DDF 567 -->
ProOn order ProOn resource

processing planning -->
ProOn order
processing ProOn billing -->
323
3.6.1.2.19.2 Report: Evaluate IT landscape
USE
You can use this report to represent the degree of standardization and the operating state in
the form of bar or pie charts. You select the diagram type and degree of aggregation in the
dialog.
You can start the report either for the IT landscape planning context or the assignment
context. Depending on the context you selected, different elements are evaluated.
CONTEXT
 Database
 Models
 Objects of the following type:
 Application system
 Application system class
 Application system type
 Architecture element
 Capability
 Cluster/Data model
 DBMS type
 Function
 Group
 Hardware component type
 Information carrier
 Location
 Operating system type
 Person
 Position
 Product/Service
 Programming language
324
 Protocol
 Role
 Service type
YOU SELECT THE CONTEXT OF IT LANDSCAPE PLANNING IN ONE OF THE

FOLLOWING WAYS:
 by selecting a model that contains column and row headers,
 by selecting column or row headers,
 by selecting process support units (PSUs), or
 by selecting object occurrences of header object types or process support units (PSUs).
All associated PSUs and their assignments are evaluated for the IT landscape planning
context thus defined.
YOU SELECT THE CONTEXT OF ASSIGNMENTS IN ONE OF THE FOLLOWING

WAYS:
 by selecting assignment objects or their occurrences,
 by selecting any component that is used for documenting the technical architecture and
is therefore associated with an IT system (Application system type object type), or
 by selecting application system classes used in a quadrant of a system portfolio.
If you have selected quadrants or components, all relevant assignments are also considered.
If assignments are IT system instances or application system classes, all associated IT
systems will be included in the selection. The relevant process support information (IT
landscape planning context) will be found for all assignments found or selected. In contrast to
directly selected IT landscape planning context (see above), only those assignments are
evaluated that are directly selected or related to the selection.
OUTPUT FORMAT
An output file is created according to the context and chart options you selected. It contains
all required charts including the legend and short description.
 RTF
 PDF
 ODT
 TXT
 DOC
 DOCX
325
3.6.1.2.19.3 Report: Import changes (IT Inventory)
USE
This report imports approved changes from ARIS IT Inventory into the database.
CONTEXT
The report is run as a database report.
326

access privileges
IT landscape planners and enterprise architects need the Write access privilege for all
process support units of their area of responsibility.
This report assigns the required access privileges to the selected user groups to give them
access to all groups in which the process support units of the selected row and column
headers are stored.
Start the report for models or column/row header objects.
Select the relevant column/row header objects, the user groups whose privilege assignment
you want to update, and the required access privileges.
To run the report, you must belong to a user group to which all IT landscape administrators
are assigned, or you must have logged in as a system user.
Figure 3: IT landscape administration - Assign access privileges
327

administration access privileges
All IT landscape administrators need the Write access privilege for the entire group structure
of the process support unit.
This report assigns the required access privileges to the selected user groups to give them
access to all groups and subgroups in which the process support units of the selected row
and column headers are stored.
Select the relevant column/row header objects, the user groups whose privilege assignment
you want to update, and the required access privileges.
Run this report as a system user or IT landscape administrator.
To run the report you need the User management function privilege. The report is not
available to other users in the wizard. Only user groups with the User management function
privilege can be selected in the dialog.
Figure 4: IT landscape administration - Assign administration access privileges
328
3.6.1.2.19.6 Report: IT landscape administration - Output

access privileges
This report provides an overview of assigned access privileges. The access privileges of users
and user groups, as well as the group paths are output for all process support units and their
row/column header objects.
You can start this report from databases, models (independent of the type), process support
units, and row/column header objects.
Figure 5: IT landscape administration - Output PSU access privileges
3.6.1.2.19.7 Report: IT landscape administration - Remove

invalid assignments
This report checks whether all assignments are still valid based on the configuration file. The
filter criteria are defined in the configuration file <ARIS Server> > Evaluations > Common files >
psmReportConfig.xml. All invalid assignments occurring in a process support map are
output in a table. For example, assignments are invalid if the required attribute values are not
specified. Optionally, you can delete invalid assignments.
Figure 6: Remove invalid assignments
329
3.6.1.2.19.8 Report: IT landscape administration - Update

and create PSU group structure
This report is run once for a database of the previous version and moves all existing process
support units (PSUs) into the group structure required for privilege management.
Run this report only if you have created the process support map with the previous version
and want to migrate the data now.
Using this stucture as well as the reports IT landscape administration - Assign access
privileges and IT landscape administration - Assign administration access privileges you can
manage access privileges for process support units.
The group structure is inserted below any chosen group. If necessary, you can define this
group on the Administration (../../handling/ba/58888.htm) tab in the configuration file <ARIS
Server>/Evaluations/Common files/psmReportConfig.xml. If no group has been defined there,
the main group is automatically used. The following group structure is created for each
process support unit:
 Group named after the object type in the column header
in this example: Function
 Group named after the column header
in this example: Send contract documents to supervisor
 Group named after the object type in the row header
in this example: Organizational unit.
 Group named after the row header
in this example: Production UMG America.
The process support unit is moved to this group. The privileges of the original PSU group
are applied to the new group, that is, the access privileges of the process support unit
remain unchanged after report execution.
The figure shows the database-wide movement of process support units to the Process
support unit subgroup.
The process support unit highlighted in the process support map is moved to the following
subgroup:
330
Function > Send contract documents to supervisor > Production UMG America.
Figure 7: Privilege management for a PSU
3.6.1.2.19.9 Report: IT landscape administration - Update

filter
This report ensures that the filter contains all information required for running IT landscape
macros. To run the report select the filter you want to update and the Entire method filter. In
the dialog, select the column and row header objects and the assignments to be contained in
the filter. The process support objects already contained in the filter are automatically
activated.
You need the configuration administrator password.
Figure 8: IT landscape administration - Update filter
331
3.6.1.2.19.10 Report: Lifecycle management
USE
Depending on the selected context, the report visualizes the lifecycle management of IT
components (application system types) or IT system instances (application systems).
Optionally, this can be done in the form of a table output. For selected models or object
occurrences it is also possible to color the occurrences contained in the model according to
their current status. In addition, the occurrences can be reset to the default.
The Lifecycle management report relates to either the standardization of an IT component

or the operation of an IT system (instance). The selected element is used to decide which
lifecycle is used as a basis. If application system types are selected, attributes that relate to
standardization are evaluated. If application systems are selected, the report relates to
operation attributes.
A table can be output if required, which contains not only the text output of the relevant start
times of the individual statuses, but also a time bar and graphical output.
Figure 9: Wizard of the 'Lifecycle management' report
As a further option, it is possible to display the current statuses of the IT components or IT

system instances at any time (dynamic simulation of an IT map). Object occurrences are
332
colored according to their attribute values in relation to a comparison date entered by the
user. This comparison date is indicated by an arrow () in the output. The period under
consideration can also be specified, if required. To color objects in an open model, start the
macro with the same name for the model.
Sample output for lifecycle management of IT system instances:
Figure 10: Sample output of the 'Lifecycle management' report
Sample output for lifecycle management of IT components (standardization):
Figure 11: Sample output for lifecycle management of IT components
CONTEXT
 Operating system type
 DBMS type
 Technical term
 Function
 Hardware component
 Hardware component type
 Performance
 Programming language
 Protocol
333
OUTPUT FORMAT
 PDF
 DOC
 RTF
 HTML
 XLS
334
3.6.1.2.19.11 Report: Output information on capabilities
USE
Outputs the following optional information for objects of the Service type, Capability, or IS
service type:
 Application systems supporting a selected object
 Data managed by a selected object
 Data used by the applications of a selected object
 Data created by the applications of a selected object
 Functions supported by a selected object
 Hardware on which the applications of a selected object are running
 IS services of a selected service type or a selected capability and the processes they
support
By default, the name of the identified objects is output. Optionally, you can also output the
group in which the object definition is saved (Output path).
CONTEXT
Objects of type
 Service type
 Capability
 IS service
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
335
3.6.1.2.19.12 Report: Output information on IT objects
USE
Outputs the following optional information for objects of the Application system type, IT
function type, or Socket type:
 Data used by an IT element.
 IS elements supported by an IT element.
 Functions supported by an IT element.
 Data used by IS elements that are supported by an IT element.
 Data created by IS elements that are supported by an IT element.
 Hardware components on which an IT system is running.
By default, the name of the identified objects is output. Optionally, you can also output the
group in which the object definition is saved (Output path).
CONTEXT
Objects of type
 IT function type
 Socket
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
336
3.6.1.2.19.13 Report: Output IT landscape and architecture

information for MashApps
This report outputs IT landscape and architecture information for visualization in MashApps.
You have two selection options on the basis of which the information is compiled. You can
select either the context of IT landscapes or the context of assignments.
YOU SELECT THE CONTEXT OF IT LANDSCAPES IN ONE OF THE FOLLOWING

WAYS:
 by selecting a model that contains column and row headers,
 by selecting definitions or occurrences of column and row header objects or process
support units.
All of the relevant process support units and assignments are included.
YOU SELECT THE CONTEXT OF ASSIGNMENTS IN ONE OF THE FOLLOWING

WAYS:
 by selecting definitions or occurrences of assignment objects.
 by selecting every permitted type of component object used for documenting the
technical architecture and having a relationship to an IT system (object type Application
system type) or an application system class that is defined as a quadrant of a system
portfolio.
If you select quadrants or components, all relevant assignments are searched for. If
assignments are either IT system instances or application system classes, all relevant IT
systems will be included in the evaluation. Process support information will be output for all
assignments found and selected. In contrast to the direct selection of an IT landscape
context, only the assignments are included that are selected or indirectly related to the
selection.
The information is output in an Microsoft Excel document independently of the type of
selection.
337
THE FOLLOWING WORKSHEETS ARE CREATED

 Process support unit: This table contains the context of the IT landscape.
 Assignment: This table shows assignment and process support information.
 Application system type: This table contains assignment objects that are of type
Application system type by default. You can customize this type in configuration file
psmReportConfig.xml.
 System components: This table shows the relationships between IT systems and the
components used.
 Components: This table contains all relevant components and the standardization
status.
 Architecture: This table contains all relevant information on architecture and structural
elements.
 Application systems: This table shows all instances and the lifecycle information for
each application system.
 Application system class: This table contains the GUID and the name for all assigned
application system classes.
The output file serves as input for MashApps. Each table contains non-redundant information
as in a relational database. The required keys (GUID) are always available. With this you can
provide MashApps with the information.
338
3.6.1.2.19.14 Report: Output system fact sheet (PDF)
Category Report > IT architecture management

Name System fact sheet
Description The system fact sheet describes a system with respect to the
following aspects:
 System description
 Contact (person, organizational unit)
 Service level agreements
 Capabilities
 Processes
 Information architecture
 Architecture set
 Operation
Context Objects of the Application system type type
Output PDF, RTF, HTML, DOC, XLS
If the modeling conventions are met, all information that describes an IT system (application
system type) can be output in condensed form in a system fact sheet.
SAMPLE OUTPUT FOR SYSTEM FACT SHEET:

ProOn order processing
System description
System name: ProOn order processing
Short description: Order processing for CKD shipments
Full name: ProOn software order processing module
Description: The Order processing module is part of the ProOn software

system and provides functionality for CKD shipments.
339
Manufacturer of the Proprietary system

application:
Number of internal Up to 1000

users:
Number of external 0
users:
Criticality Very high

(importance of the
application system):
Individual Yes
development/Standa
rd software:
Standardization Standard
status:
Figure 12:
Green
Individual Yes
development/Standa
rd software:
Standardization Standard
status:
Figure 13:
Green
340
Contact (person)
Name: John Smith
Telephone number: +49 19882 982 298
E-mail address: j.smith@unicorp.com
Department:
UK4-P1
Contact (organizational unit)
Name: Sales
Service level agreements
Max. downtime per month: Less than 1 hour
Availability: 99.9 percent
Guarantee/Warranty until: 31.12.2009
Documents and links
User guide: http://dms.ids.com/usman.pdf
Administration guide: http://dms.ids.com/adman.pdf
341
Capabilities
Arrangement of monthly programs
Order management
Order tracing
Price calculation
Product data management
The system is used in the following processes
Process customer order

Deliver

Check credits

Create customer order

Create products

Customer needs created
Customer needs created
342
Fix and edit conditions

Replicate customer order

Schedule order
Information architecture
Managed data
Material data
Order data
System interfaces
Connected systems Data Protocol Direction
A plan <--
MatReq/1 Material data DDF 567 -->
MatReq/1 Order data DDF 567 -->
ProOn resource -->

planning
ProOn billing -->
343
Figure 14: Model
Architecture set
Architecture layer Architecture element IT components
Business process-specific Programming languages ---

components & services
Hardware server ---
Operating systems ---
Development Databases (DBMS) IBM DB2
Oracle
344
3.6.1.2.19.15 Report: Redundant applications (visualization

of redundancies)
Category IT architecture management

Name Redundant applications
Description This report determines redundancies in the use of functions, capabilities, and/or
data objects for the selected application system types. Optionally, the information
can be output exclusively for redundant applications.
Context Objects (see below)
Output RTF/Word, PDF, HTML, Excel
The report determines redundancies of application system types with regard to the following
object types:
 Functions
 Capabilities
 Data objects
The following connections from/to the application system type are evaluated:
 supports function
 supports capability
 is input for/has as output data objects
That is, a redundancy exists if there is more than one application system type with the same
relationship to specific functions, capabilities, or data objects.
SAMPLE OUTPUT
Application system Capabilities Is additionally supported Redundan

by cy
A plan Order management ProOn order processing 1.0
A plan Price calculation ProOn order processing 1.0
A plan Product data management ProOn order processing 2.0
ProOn resource planning
ProOn Bill of materials for CKD kits 0.0
ProOn Billing of CKD shipments 0.0
ProOn order Order management A plan 1.0

processing
345
ProOn order Order tracing 0.0

processing
ProOn order Price calculation A plan 1.0

processing
ProOn order Product data management A plan 2.0

processing
ProOn resource planning
ProOn resource Aggregation of amounts per 0.0

planning part number and fixed date
ProOn resource Product data management A plan 2.0

planning
ProOn order processing
346
3.6.1.2.19.16 Report: System consolidation
Category Report > IT architecture management

Name System consolidation
Description This report enables you to analyze IT systems in terms of the

process support they provide. The report analyzes business
processes with regard to redundancies in the IT support. It shows
which IT systems potentially provide the functionality required by
the processes and which IT systems really do supply processes
with this required functionality. Thus, the to-be architecture can
be derived and IT projects can be initiated. The purpose of this is to
minimize redundant IT support in the future.
Context Objects of the Function type.
Output RTF, PDF, HTML, DOC, XLS
SAMPLE OUTPUT
347
LEGEND
A specific capability of an IT system is required for a process to run. No IT
Figure 15: X
system supports the required capability.
An IT system supports a particular process with a specific capability.
Figure 16: Name
An IT system supports a specific capability that a process requires. This

capability is also supported by another system. Therefore, the IT system is
Figure 17: Name an alternative system.
Support by an IT system is not required for a process to run.
348
3.6.1.2.19.17 Report: System evaluation
Category IT architecture management

Name System evaluation
Description Based on the application system types within the selected application
system type diagrams, this report creates a system portfolio with regard
to the Data center costs and Criticality attributes.
Context Models
Application system type diagram
Value-added chain diagram
Output HTML
Below, a sample output of the System evaluation report is shown.
Figure 18: Sample output of the 'System evaluation' report
349
3.6.1.2.19.18 Report: System list
USE
This report optionally creates the following output:
 Based on the selected IT components: all application systems using these IT components.
 Based on the selected processes: all application systems used in the process.
 Based on the selected processes: all application systems used in the process, as well as
the IT components used by these application systems.
If the report is run for processes, it is also possible to evaluate the processes in the assigned
models up to a specified assignment level.
CONTEXT
 Models
 Application systems
 IT components
OUTPUT FORMAT
 PDF
 DOC
 RTF
 HTML
 XLS
350
3.6.1.2.19.19 Reports used internally

The following reports are run by macros and cannot be started in the Report Wizard by users.
Name Description Run by Visible to users
IT landscape administration This report cannot be run by users. Macro No

- Copy content It is started by the macro with the
same name.
IT landscape administration This report cannot be run by users. Macro No

- Generate matrix It is started by the macro with the
same name.
Edit process support unit This report cannot be run by users. Macro No
It is started by the macro with the
same name.
Add process support This report cannot be run by users. Macro No

assignments It is started by the macro with the
same name.
351
3.6.1.2.20 Open BPM

3.6.1.2.20.1 Report: EPC-to-BPMN transformation
USE
Transforms a model of type EPC into a to a diagram of type Enterprise BPMN
collaboration diagram or BPMN collaboration diagram (BPMN 2.0) depending on the
option selected. You can select which diagram type the transformation should generate. If
the report is run from a context containing multiple models of type EPC, a report with detailed
transformation results is generated for each of the models.
CONTEXT
Groups, Models
OUTPUT FORMAT
 RTF
 PDF
 HTML
 DOC
 DOCX
 XLS
 XSLX
 ODT
352
3.6.1.2.20.2 Report: Open BPM consistency check
USE
This report validates the selected diagram and checks whether it can be exported via BPMN
serialization. All objects that are not compliant with the modeling conventions are marked.
CONTEXT
Model of the BPMN Collaboration diagram (BPMN 2.0) type
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
3.6.1.2.20.3 Report: Validate BPMN diagram for export as a

file
USE
This report validates the selected diagram and checks whether it can be exported via BPMN
serialization. All objects that are not compliant with the modeling conventions are marked.
CONTEXT
Model of the BPMN Collaboration diagram (BPMN 2.0) type
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
353
3.6.1.2.20.4 Customize EPC-to-BPMN transformation

You can edit the EPC-to-BPMN transformation report.
If you update your system, the standard reports are overwritten. Therefore, copy the
EPC-to-BPMN transformation report and open the new report for editing.
To start the customized report, start the report from the Evaluate tab bar or add your own
button to the Evaluate tab bar.
You see parameters for customizing as comments within the script.
REUSING OBJECT DEFINITIONS

 True: Specifies that the definitions are reused for satellites of a BPMN task placed in the
assigned Function allocation diagram model. The default value is true.
 False: Specifies that a new definition is created for each satellite of a BPMN task placed in
the assigned Function allocation diagram model.
var reuseDefinitions = true;
TRANSFORM OBJECTS FROM FUNCTION ALLOCATION DIAGRAMS

 True: Specifies that all objects that were placed in the Function allocation diagram
model, which is assigned to a function in the EPC, are transferred to the BPMN diagram.
 False: Only the transformation-relevant objects that were placed in the Function
allocation diagram model, which is assigned to a function in the EPC, are transferred to
the BPMN diagram. The default value is false.
var transformAllFADObjects = false;
ENABLE OR DISABLE THE SEMANTIC CHECK

 True: Specifies that the semantic check that validates the EPC is performed before the
EPC-to-BPMN transformation starts. If the semantic check finds errors, the faulty models
are skipped during the transformation. You are notified which models contain errors. The
default value is true.
 False: Disables the execution of the semantic check that validates the EPC. The
EPC-to-BPMN transformation transforms all models, regardless of whether the models
are valid.
This is recommended if you modified the transformation without adapting the semantic
check.
var semanticCheckEnabled = true;
354
TASK GENERATING OPTIONS

You can change the transformation rules. You can specify which satellites of a function in the
EPC should generate which task types (User task, Service task, or Manual task) in the
corresponding BPMN diagram.
If you modify the script, we recommend that you either customize the semantic check or
disable it.
For example, you can, specify that the transformation of an object of type Position linked to a
function with a connection of type carries out does not generate an object of type Manual
task but an object of type Abstract task.
To do so, remove the following entry from the array satellitesCreatingManualTasks in the
transformation script.
{cxn:Constants.CT_EXEC_1, obj:Constants.OT_POS}
On the other hand, you can, for example, specify that the transformation of an object of type
IoT object linked to a function with a connection of type is used by generates an object of
type Service task instead of an abstract task. To do so, add the following entry to the array
satellitesCreatingServiceTasks in the transformation script.
{cxn:Constants.CT_IS_USED_BY, obj:Constants.OT_IOT_OBJECT}
The following rules are available:
 The transformation converts satellites that are connected to functions with the following
connections in the EPC to objects of the User task type in the BPMN diagram.
var satellitesCreatingUserTasks = [
{cxn:Constants.CT_IS_REPR_BY, obj:Constants.OT_SCRN}
];
connections in the EPC to objects of the Manual task type in the BPMN diagram.
var satellitesCreatingManualTasks = [
{cxn:Constants.CT_EXEC_2, obj:Constants.OT_PERS_TYPE},
{cxn:Constants.CT_EXEC_2, obj:Constants.OT_ORG_UNIT_TYPE},
{cxn:Constants.CT_EXEC_1, obj:Constants.OT_ORG_UNIT},
{cxn:Constants.CT_EXEC_1, obj:Constants.OT_POS},
{cxn:Constants.CT_EXEC_1, obj:Constants.OT_GRP}
];
connections in the EPC to objects of the Service task type in the BPMN diagram.
var satellitesCreatingServiceTasks = [
{cxn:Constants.CT_CAN_SUPP_1, obj:Constants.OT_APPL_SYS_TYPE},
{cxn:Constants.CT_CAN_SUPP_1, obj:Constants.OT_FUNC_CLUSTER}
];
The transformation converts satellites that are connected to functions with the following
connections in the EPC to objects of the Service task type in the BPMN diagram.
An additional restriction applies to satellitesCreatingServiceTasks.
355
If a symbol is listed here, but its object type is not listed under
satellitesCreatingServiceTasks, it is ignored and vice versa.
var satelliteSymbolsCreatingServiceTasks = [
{cxn:Constants.CT_CAN_SUPP_1, sym:Constants.ST_BUSINESS_SERVICE},
{cxn:Constants.CT_CAN_SUPP_1, sym:Constants.ST_SW_SERVICE_TYPE}
];
356
3.6.1.2.21 Organizational elements

3.6.1.2.21.1 Report: Determine organizational structure
USE
Reproduces the modeled structure at occurrence level for the selected organizational charts.
The data is output as text, indents are used to indicate the different assignment levels.
CONTEXT
Models of the Organizational chart type.
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
357
3.6.1.2.21.2 Report: Output organizational elements with

connected objects
USE
Describes the assignments of the selected organizational elements to functions or other
organizational elements.
Optionally, the following assignments are evaluated
 All connections to functions
 The carries out connection type to functions
 All connections to organizational elements
In addition, you can output the attributes and groups for all objects.
CONTEXT
Objects of type:
 Group
 Position
 Person
 Role
 Position
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
358
3.6.1.2.22 PPM integration

3.6.1.2.22.1 Report: Select PPM process type and create

function mapping
USE
The report is run on a selected EPC or BPMN model in ARIS. The report selects a PPM process
type or process type group to import the connected functions. Based on the data being
imported, the report creates an ARIS matrix model and an EPC or BPMN model based on the
selected model type. The imported PPM functions are mapped to the functions used in the
generated process in ARIS.
In PPM, process instances (processes) are classified according to process types. Process
types are summarized to process type groups. The process types and process type groups
are organized hierarchically in a process tree. Process types and process type groups
provide a number of measures, dimensions, relations, and functions, which are registered at
the respective process type or process type group.
CONTEXT
EPC or BPMN
359
PARAMETERS
The following PPM parameters are required.
 PPM credentials: PPM user name and the corresponding password to log in to the PPM
client.
 PPM server URL: URL of the PPM server that provides the PPM client you want to
connect to.
 PPM client: Name of the PPM client you want to connect to. A PPM client provides all
configuration files and applications required to extract data from a source system and
configure it for further processing. The client provides the data extracted and
transformed from various data sources.
The following ARIS parameters are required.
 Name of the matrix model to be created: Name of the matrix model created by the
report, based on the data imported from PPM. The matrix model generated in ARIS maps
the functions imported from PPM.
 Name of the process to be created: Name of the EPC or BPMN created by the report,
based on the data imported from PPM. The process generated in ARIS represents the
function flow model imported from PPM.
360
3.6.1.2.22.2 Report: Transfer process model and mapping

information to PPM
USE
The report transfers both the process model (to-be) belonging to a PPM process type (as-is)
and a corresponding mapping of ARIS objects to PPM objects to PPM. This transfer is the
basis for checking whether all process instances were run in conformance with the originally
planned process.
The report is run on the EPC or BPMN model created by the Select PPM process type and
create function mapping (page 359) report.
CONTEXT
EPC or BPMN
PARAMETERS
The following PPM parameters are required.
 PPM credentials: PPM user name and the corresponding password to log in to the PPM
client.
 PPM server URL: URL of the PPM server that provides the PPM client you want to
connect to.
 PPM client: Name of the PPM client you want to connect to. A PPM client provides all
configuration files and applications required to extract data from a source system and
configure it for further processing. The client provides the data extracted and
transformed from various data sources.
361
3.6.1.2.23 Processes
3.6.1.2.23.1 Report: Create structure chart
USE
Uses the process structure as the basis for creating a block structure similar to a structure
chart. In addition, the carries out or supports connections to organizational elements,
application system types, IT function types, and model types are evaluated at definition or
occurrence level.
The following options are available for the extended output:
 Output of function relationships of assigned function allocation diagrams
 Output of trivial events (to structure your output transparently, you can restrict the
output to the events that are relevant to the evaluation)
 Output of the function descriptions
The report is output as a table in Word or RTF format.
362
CONTEXT
Models of type:
 EPC
 Office process
OUTPUT FORMAT
 RTF
 DOC
363
3.6.1.2.23.2 Report: Output functions with connected

objects
USE
Outputs the model attributes, the model graphic, and the functions including the objects
connected to them for the selected process models.
Optionally, you can select the following connected objects:
 Executing organizational elements
 Data elements (input/output data)
 Supporting application systems
You can specify the evaluation direction between the functions and the connected objects. In
addition, you can also evaluate assigned function allocation diagrams.
CONTEXT
Models of type:
 Office process
364
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
3.6.1.2.23.3 Report: Output functions with data and

organizational elements (VACD)
USE
Outputs model attributes, model graphic, and the Name and Description/Definition functions
for the selected value-added chain diagrams.
The organizational elements and the input/output data of the functions are also output.
The data is output in a table in alphabetical order.
CONTEXT
Models of the Value-added chain diagram type.
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
365
3.6.1.2.23.4 Report: Output functions with times and costs

This report is now available as Analyze time/costs (page 247) in the Analysis category.
3.6.1.2.23.5 Report: Output transitive relationships via

functions
USE
Optionally outputs the model attributes, the model graphic, and the relationships between the
following objects for the selected process models:
 Executing organizational elements
 Data elements (input/output data)
 Supporting application systems
Optionally, you can also evaluate assigned function allocation diagrams.
CONTEXT
Models of type:
 Office process
366
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
367
3.6.1.2.24 QM
3.6.1.2.24.1 Report: Output overview of structuring models
USE
Evaluates the models assigned to the structural elements for selected structuring models.
The data is output as text or in a table.
CONTEXT
Models of the Structuring model type
OUTPUT FORMAT
 RTF
 PDF
 HTML
 TXT
 DOC
 XLS
368
3.6.1.2.25 Sample reports

Sample scripts demonstrate the various topics and functions. The scripts are not part of the
standard scope of supply.
3.6.1.2.25.1 Report: Process manual (example)

This report is only available if your script administrator has activated the Available to users
optionn in the General properties dialog of a report script.
USE
This report script is a sample created in the design view. It shows how to create report scripts
without having programming knowledge.
This report script is generally output as text, but you can also create an Excel output.
CONTEXT
Objects
OUTPUT FORMAT
 Rich Text Format (*.RTF)
 Adobe PDF files (*.PDF)
369
3.6.1.2.26 SAP
Some reports described in this category are not available yet. These reports are only sample
report scripts demonstrating the functionality. The reports are not part of the standard scope
of supply. You can import the scripts from the ARIS installation package
..\Content\Reports\Extension_pack_SAP\).
3.6.1.2.26.1 Report: Automatic SAP synchronization with

ARIS (SAP Solution Manager 7.1)
This report is only a sample report script demonstrating the functionality. The report is not
part of the standard scope of supply. You can import the script from theARIS installation
package ..\Content\Reports\Extension_pack_SAP).
USE
This report shows how SAP synchronization can be performed in a Process Governance
environment using ARIS for SAP® Solutions and SAP® Solution Manager 7.1 when the
synchronization direction is from SAP® Solution Manager 7.1 to ARIS.
CONTEXT
Object of the Function object type.
OUTPUT FORMAT
TXT
370
3.6.1.2.26.2 Report: Solution Manager 7.2 - Synchronize

branch
This report is only a sample report script demonstrating the functionality.
USE
This sample script shows how to start SAP synchronization with SAP Solution Manager 7.2 for
a defined branch using a report script. You must modify the script accordingly before you can
use it.
If you do not want to write a script from scratch, simply adapt the copy of this script to suit
your requirements. To obtain information on ARIS Script commands, move the mouse pointer
to a command in the script code and press the F1 key. ARIS Script also provides detailed
information about objects used by the Report component interface related to SAP Solution
Manager 7.2 (../../../en/script/ba/#/home/report_SUBPATH_SM72/en/1).
CONTEXT
OUTPUT FORMAT
TXT
3.6.1.2.26.3 Report: Delete empty synchronization models
USE
This report cleans up the database. Empty models and groups created during the SAP®
synchronization are deleted.
CONTEXT
 Database group
 Models
OUTPUT FORMAT
 TXT
 XLSX
 XLS
 HTM
 PDF
 RTF
371
3.6.1.2.26.4 Report: Replace logical components
USE
This report replaces logical components so that transferred items can be used. Logical
components must be replaced if they are not part of the system landscape. They can be
replaced only with a component that is contained in the system landscape.
CONTEXT
 Database group
 Database
OUTPUT FORMAT
 DOC
 DOCX
 ODT
 RTF
 HTM
 XLS
 XLSX
3.6.1.2.26.5 Report: Create implementation project

(Solution Manager 7.1)
USE
This report transforms the template project managed in this group into a synchronizable
implementation project.
CONTEXT
Database group
OUTPUT FORMAT
TXT
372
3.6.1.2.26.6 Report: Solution Manager 7.2 - Download

branch
This report is only a sample report script demonstrating the functionality.
USE
This sample script shows how to download a branch from SAP Solution Manager 7.2 using a
report script. You must modify the script accordingly before you can use it.
If you do not want to write a script from scratch, simply adapt the copy of this script to suit
your requirements. To obtain information on ARIS Script commands, move the mouse pointer
to a command in the script code and press the F1 key. ARIS Script also provides detailed
information about objects used by the Report component interface related to SAP Solution
Manager 7.2 (../../../en/script/ba/#/home/report_SUBPATH_SM72/en/1).
CONTEXT
Database group
OUTPUT FORMAT
TXT
3.6.1.2.26.7 Report: Automatic SAP synchronization with

SAP Solution Manager 7.1
This report is only a sample report script demonstrating the functionality. The report is not
part of the standard scope of supply. You can import the script from theARIS installation
package ..\Content\Reports\Extension_pack_SAP).
USE
This report shows how SAP synchronization can be performed in a Process Governance
environment using ARIS for SAP® Solutions and SAP® Solution Manager 7.1 when the
synchronization direction is from ARIS to SAP® Solution Manager 7.1.
CONTEXT
OUTPUT FORMAT
TXT
373
3.6.1.2.26.8 Report: Generate test case description
USE
This report creates a test case description for user-definable test projects that you created
using Test Designer. Based on the selected object definitions a document is created that
contains all relevant data, including graphics, if required. The generated document can
automatically be assigned to the test object in the function allocation diagram. It is saved
under the specified path.
CONTEXT
Object definitions
OUTPUT FORMAT
 PDF
 DOC
 XLS
3.6.1.2.26.9 Report: Generate test case description - SAP

Solution Manager
USE
This report creates a test case description for test projects that you created using Test
Designer. Based on the selected processes a document is created that contains all relevant
data, including graphics, if required. The generated document can automatically be assigned
to test objects in the function allocation diagram (optional). It is saved under the specified
path. Furthermore, the document is prepared for transfer to SAP® Solution Manager. The
next time you transfer documents during synchronization with SAP® Solution Manager, these
documents will automatically be entered on the 'Test cases' tab.
For the report to run properly, script administrators need to specify project-specific settings.
CONTEXT
Object definitions
OUTPUT FORMAT
 PDF
 DOC
 XLS
374
3.6.1.2.26.10 Report: Generate test case documentation -

Library
USE
This report cannot be run by users. It starts automatically when the following reports are run:
 Generate test case description
 Generate test case description - SAP Solution Manager
For the report to run properly, script administrators need to specify project-specific settings.
CONTEXT
Objects
OUTPUT FORMAT
 PDF
 DOC
 DOCX
 ODT
 XLSX
 XLS
3.6.1.2.26.11 Report: Manage document links for the portal

USE
This report creates document links for information carriers, thus enabling you to open SAP®
Solution Manager documents from within the portal ( Published content). These links can
also be deleted using the report.
The process will be logged as report output file.
CONTEXT
Database group
OUTPUT FORMAT
 PDF
 DOC
 DOCX
 ODT
 RTF
 TXT
375
3.6.1.2.26.12 Report: Output list of required components
USE
Creates a table including all SAP® components required for the scenario.
CONTEXT
OUTPUT FORMAT
 RTF
 HTML
 DOC
 XLS
3.6.1.2.26.13 Report: Run consistency check
USE
The report checks the project structure for potential violations of the consistency rules. For
data transfer to work correctly between ARIS and SAP® Solution Manager the consistency
rules must be complied with.
When saving relevant elements, this report is started by the macro with the same name if the
macro has been activated.
CONTEXT
The consistency check starts for all SAP-relevant:
 Models of following types with a specified SAP model type:
 EPC
 BPMN collaboration diagram (BPMN 2.0)
 Objects of the Function type with a specified SAP function type.
OUTPUT FORMAT
XLS
376
3.6.1.2.26.14 Report: Specify SAP Fiori app base URL
USE
This report makes SAP Fiori® Apps available in ARIS. For each object of type Screen that
belongs to the Fiori application transaction type located in the selected branch and that is
related to the selected logical component, the report specifies the base URL as an attribute
value of the Link 1 system attribute. To be able to use SAP Fiori® Apps in ARIS, you must run
this report for each branch based on the related logical component.
CONTEXT
Database
OUTPUT FORMAT
 XLSX
 XLS
3.6.1.2.26.15 Report: Synchronize scope information
USE
Synchronizes the scope information of your enterprise process models and the SAP® process
models. Specify whether you want to update the enterprise process models or the SAP®
process models.
Functions in assigned models are included, if required.
CONTEXT
Objects of type:
 Function
 Screen
377
3.6.1.2.27 SAP migration (Solution Manager 7.1 to 7.2)

All reports in this category are to be used for migrating SAP Solution Manager 7.1 projects
contained in an ARIS database to SAP Solution Manager 7.2-based SAP solutions. This is why
these reports are only available in ARIS Architect.
378
3.6.1.2.27.1 Report: 01 SAP Solution Manager 7.2 migration

– Create root folder layer
USE
Use this report as the first for migrating SAP Solution Manager 7.1 projects contained in an
ARIS database to SAP Solution Manager 7.2-based SAP solutions.
This report copies all root functions of the Folder function type from the SAP Solution
Manager 7.2 branch structure to the SAP Solution Manager 7.1 project structure. The model
linked to the SAP Solution Manager 7.2-based solution root contains two folders, namely
Process Step Library and Business Processes. Both folders are required for SAP
synchronization.
When executed, the root level structure in both the project as well as the solution's branch is
identical. The 7.1 project root has assigned a model of the project model type, containing the
Process Step Library function of the repository folder function type and the Business
Processes function of the folder function type. The Business Processes function has an
assigned model. Its name is the same as the folder type and it now contains the scenarios. If
used, an additional test project folder is created as root object within the business process
structure. This folder contains the test scenarios. While migrating, the root folder will be
identified to set all test designer markers to the related items.
CONTEXT
Databases holding former SAP Solution Manager 7.1 projects to be migrated to SAP solutions
using SAP Solution Manager 7. 2.
OUTPUT FORMAT
XLS
379

– Resolve shortcuts
USE
This report is the second to be used while migrating databases containing SAP projects, using
SAP Solution Manager 7.1 to SAP solutions, using SAP Solution Manager 7.2.
Only run this report if the 7.1 project uses shortcuts. It replaces each shortcut occurrence by a
new occurrence based on definition which is a copy of the shortcut's definition.
In EPC based models the report creates a new definition from the one used by the shortcut.
The definition is identical in attributes and direct properties to the definition of the shortcut.
Only the name carries the copy prefix. The definition is placed into the database group where
the model is stored. It creates a new occurrence based on the old one. The new occurrence is
identical in all properties to the old one, e. g. attribute occurrences, unions, symbols, position,
size, etc. New connections based on the old ones are created. The new ones are identical in all
direct properties to the old ones (arrow style, connection point, pen, etc.). Assignments or
master relations are ignored as they refer to the original only.
Since the migration ID of the 7.2 solution is the same for shortcuts and the activity they refer
to, the shortcuts will receive the same SAP IDs. Assignments from the shortcut definition will
be ignored. The symbol for the new occurrence is specified in the project configuration. As it
is not available to the report, you must select the desired symbol.
In BPMN-based models distinct definitions for shortcuts already exist. You only need to
replace the BPMN call activity by a task of your choice. However on process level the
disband process on SAP side will create new steps. These are unknown to ARIS. There is no
way to create a mapping for them. You must remodel the process manually after the
respective steps have been synchronized to ARIS.
In the 7.1 project for each occurrence with the shortcut symbol type you now have a new
definition with the same attributes and a new identical occurrence. It looks exactly the same
as before, except the symbol type has changed from shortcut to the one you have defined.
In BPMNTM the User task is in use instead of Call activity. All Call activity properties have
been removed.
When executed all migrated shortcuts are listed in the report output file.
380
CONTEXT
OUTPUT FORMAT
XLS

– Adjust transaction types
USE
This report is the third to be used while migrating databases containing SAP projects, using
This report consolidates the different transaction types for URLs. The values Long URL, SAP
URL application and Predefined URLs from directory for the Transaction type attribute
are converted to Web address or file.
When executed all actions are listed in the report output file.
CONTEXT
OUTPUT FORMAT
XLS
381

– Adjust documentation
USE
This report is the fourth to be used while migrating databases containing SAP projects, using
This report replaces symbols types. As in 7.2 solutions, the Training and the General
document document types are no longer available. These symbol types are replaced by the
Project documentation symbol type by default.
When executed all actions are listed in the report output file.
CONTEXT
OUTPUT FORMAT
XLS
382

– adjust system landscape
USE
This report is the fifth to be used while migrating databases containing SAP projects, using
The report changes all values in the SAP component attribute, both on the function and
executable level. Also, all attributes of the system application types in the system
landscape are replaced by the values of the 7.2 system. In 7.1 ARIS projects, the logical
component is represented as the name of the logical SAP component. It is maintained as an
attribute on the step and executable level. In the system landscape, it is maintained as
logical component attribute in the respective application system type definition. Unused
logical components will not be corrected.
When running the report, you first have to choose the database containing the downloaded
SAP Solution Manager 7.2 branch, and you need to connect to the SAP system holding your
SAP Solution Manager 7.1 project. This is to map the migration ID provided by SAP to the
SAP ID used by ARIS in 7.1 projects. You can retrieve the values for application server and
instance number from your SAP log on. If prompted for the logical component group to be
used in ARIS, select the one that matches the logical component group in SAP Solution
Manager 7.2 for executables that have not maintained one.
When the report is executed, all changed objects are listed in the report output file, as well as
all SAP components to be changed.
CONTEXT
OUTPUT FORMAT
XLS
383

– Adjust IDs
USE
This report is the sixth to be used while migrating databases containing SAP projects, using
This report adjusts the 7.1 project on the ID level. It also adjusts the project origin, containing
the synchronization type and the branch ID of the branch as well as the project configuration.
7.2 SAP IDs are mapped to the 7.1 project's structure elements. Structure elements are
scenarios, processes and process steps. In the 7.2 solution, the 7.1 ID is maintained in the
Source ID attribute. SAP IDs are exchanged on object and model level.
When running the report, you first have to choose the database containing the downloaded
SAP Solution Manager 7.2 branch, and you need to connect to the SAP system holding your
SAP Solution Manager 7.1 project. This is to map the migration ID provided by SAP to the
SAP ID used by ARIS in 7.1 projects. You can retrieve the values for application server and
instance number from your SAP log on. If prompted for the logical component group to be
used in ARIS, select the one that matches the logical component group in SAP Solution
Manager 7.2 for executables that have not maintained one.
When the report is executed, all objects that were exchanged and all objects that were not
exchanged are listed in the report output file. Objects that were not exchanged might belong
to shortcuts or object definitions that are no longer used in the project.
CONTEXT
OUTPUT FORMAT
XLS
3.6.1.2.27.7 Report: SAP Solution Manager 7.2 migration –

Library
This report is used by all other SAP Solution Manager 7.2 migration reports. Users cannot start
this report from the Report Wizard.
384
3.6.1.2.28 Six Sigma

3.6.1.2.28.1 Report: Calculate actual processing time for

model of type 'Value stream map'
USE
The report is started for models of the Value stream map type.
It represents all of the process steps in models of the Value stream map type, along with
their average process runtime and process reliability. It calculates the actual processing time
and shows the differences between cycle time and actual processing time of the process.
The report consists of two pages.
385
The first page provides a text overview of the facts, while the second page displays the facts
graphically.
CONTEXT
Models
OUTPUT FORMAT
 Excel 97 - 2003 Workbook (*.xls)
 Excel Workbook (*.xlsx)
386
3.6.1.2.28.2 Report: Collect overall process effectiveness

data
USE
It provides an overview of your process steps in terms of errors, output, and process time.
You must enter some of the data for the report yourself.
CONTEXT
Models
OUTPUT FORMAT
387
3.6.1.2.28.3 Report: CtX: Critical to X
USE
The report can be started for models of the Objective diagram and CtX-tree type. It collects
all the critical factors for a process.
It generates a Microsoft® Excel spreadsheet that provides an overview of all critical factors
occurring in process models and shows their relationships to functions.
CONTEXT
Models of type:
 CtX-tree
 Objective diagram
OUTPUT FORMAT
388
3.6.1.2.28.4 Report: FMEA: Failure Mode and Effects

Analysis
USE
The report is started for SIPOC models. It finds weak points (critical factors) and calculates
the Risk Priority Number (RPN). You enter some of the data for the report yourself. The first
sheet of the Microsoft® Excel output of the report shows the points you need to enter
yourself.
CONTEXT
Models
OUTPUT FORMAT
389
3.6.1.2.28.5 Report: Import overall process effectiveness

data
USE
It imports data from an Excel file (*.xls) into a model of the Value stream map type. It
calculates the availability rate, quality rate, performance rate, and the overall process
effectiveness for each process.
CONTEXT
Models
OUTPUT FORMAT
-.-
3.6.1.2.28.6 Report: Kaizen process mapping
USE
The report is started for models of the Value stream map or EPC type.
It creates an Excel file (*.xls) for all selected models and assignments (optional), so that the
user can see the lean type assigned to each process. The following lean types are possible:
 No selection
 Waste
 Waste, but needed
 Value added
390
391
CONTEXT
Models
OUTPUT FORMAT
3.6.1.2.28.7 Report: Mark critical factors
USE
This report is started for SIPOC diagrams, fishbone diagrams, CtX-tree diagrams, or KPI trees.
Depending on the model for which the report is started, it identifies all Input/Output (SIPOC)
data, as well as all occurrences of type concerns (fishbone diagram), Critical to X (CtX tree),
or KPIs (KPI tree). It finds all occurrences in the process models (Value-added chain diagram,
EPC), opens the models, and marks the occurrences.
CONTEXT
Models
OUTPUT FORMAT
392
3.6.1.2.28.8 Report: Project charter
USE
The report is started for SIPOC models. It provides a project overview in terms of problem
areas, results, start and end date, so that each project member knows the status of the
relevant project. You must enter some of the data for the report.
CONTEXT
Models
OUTPUT FORMAT
393
3.6.1.2.28.9 Report: Report overview
USE
This report provides an overview of available Six Sigma reports.
CONTEXT
Models
OUTPUT FORMAT
-.-
3.6.1.2.28.10 Report: SIPOC input/output matrix
USE
The report is started for SIPOC models and shows a matrix of input and output combinations.
It illustrates how significant a specific combination of input and output can be for the
process.
The report generates a matrix for each function in a SIPOC model in order to evaluate
combinations of input and output data.
CONTEXT
Models
OUTPUT FORMAT
394
3.6.1.2.29 Time recording

3.6.1.2.29.1 Report: Create organizational chart
USE
This report is used in connection with the Time recording rule set in ARIS Optimizer.
The report Create organizational chart is started for one (or several selected) process
models. There an organizational chart is created as an assignment in the process model per
organizational unit. The report inquires, how many organizational elements you wish to
assign. Then it creates the model. If you call up the report from the same selection once
again, it deletes the assignments. This happens for purposes of anonymization, if for example,
a process is modeled in a company with one position, but several employees fill the position.
CONTEXT
Models
OUTPUT FORMAT
395
3.6.1.2.30 User management

Here, users with the Script administrator function privilege will find all standard reports that
are available in this category on the Administration > Evaluations > Report tab.
They cannot be run by users from ARIS Architect. However, these reports are available in the
user management of ARIS Administration ( Additional functions > Generate report).
Only edit these reports if you are experienced in using ARIS Script to ensure that their
function and output remains free of errors.
3.6.1.2.30.1 Report: License audit (password-protected)

report. Send this password-protected report to Software AG for evaluation. For detailed
(https://www.softwareag.com/corporate/company/global/offices/default.html). This report
can only be run from ARIS. This report is applicable to Concurrent and Named user licenses.
USE
This report lists the maximum consumption of each license per day. Days on which no
licenses are consumed are not displayed in the report.
CONTEXT
User Management in ARIS.
OUTPUT FORMAT
Password-protected ZIP containing an Excel file and a JSON file.
396
3.6.1.2.30.2 Report: License usage rule validation

This report can only be run from ARIS. This report is applicable to Concurrent and Named
user licenses.
USE
This report lists the license usage based on the license monitoring rule that is configured in
CONTEXT
User Management in ARIS.
OUTPUT FORMAT
XLS
3.6.1.2.30.3 Report: Output logged-in users

This report cannot be run from ARIS Architect. However, it is available to user administrators
in the user management of ARIS Administration ( Additional functions > Generate
report). Only edit this report if you are experienced in using ARIS Script to ensure that their
USE
This report lists all users currently logged in to this tenant. It also shows the corresponding
login date and time.
CONTEXT
 Filter
 Database
 Group
 Model
 Object
OUTPUT FORMAT
XLS
397
3.6.1.2.30.4 Report: Output overview of licenses

USE
This report lists all licenses (page 50) for the tenant. It shows the assignment of licenses to
users, the number of licenses consumed, and the number of licenses still available for use.
CONTEXT
 Filter
 Database
 Group
 Model
 Object
OUTPUT FORMAT
XLS
398
3.6.1.2.30.5 Report: Output user groups with users and

privileges
USE
This report lists all user groups of this tenant along with the associated users. It shows all
license (page 50) and function privileges from ARIS Administration that users are granted
automatically when being member of a user group.
CONTEXT
 Filter
 Database
 Group
 Model
 Object
OUTPUT FORMAT
XLS
399
3.6.1.2.30.6 Report: Output users and privileges

USE
This report lists all users of this tenant and shows the license (page 50) and function
privileges assigned to them in ARIS Administration.
CONTEXT
 Filter
 Database
 Group
 Model
 Object
OUTPUT FORMAT
XLS
400
3.6.1.2.31 Variants
3.6.1.2.31.1 Report: Output models and variants
USE
Evaluates the selected objects and their variants up to a configurable variant level. Objects
and variants at one level are output in alphabetical order.
CONTEXT
Models
OUTPUT FORMAT
 Word 97 2003 document (*.DOC)
 Word document (*.DOC)
 Open Document Text (*.ODT)
 HTML file (*.HTM)
 Text file (*.TXT)
401
3.6.1.2.31.2 Report: Output objects and variants
USE
Evaluates the selected models and their variants up to a configurable variant level. Models
and variants at one level are output in alphabetical order.
CONTEXT
Objects
OUTPUT FORMAT
 Word 97 2003 document (*.DOC)
 Word document (*.DOC)
 Open Document Text (*.ODT)
 HTML file (*.HTM)
 Text file (*.TXT)
402
3.6.1.2.32 Visio import

3.6.1.2.32.1 Report: Import Visio files
USE
Imports Microsoft® Visio files of the VDX and VSDX types to ARIS. The Visio drawing types
are converted into predefined model types, the shapes into predefined symbols. This mapping
of Visio items to ARIS items can be changed by script administrators.
CONTEXT
Group
403
3.6.1.2.33 webMethods Integration

3.6.1.2.33.1 Report: Consistency check - Library

This report validates the selected diagram and checks whether it can be shared with IT. All
objects that are not compliant with the modeling conventions are marked.
3.6.1.2.33.2 Report: Import all services from CentraSite
USE
This report imports all available services from CentraSite.
CONTEXT
Group
OUTPUT
Adobe PDF Files (*.pdf)
404
3.6.1.2.33.3 Report: Internal reset of a service or change

request
This report is used for Software AG Designer integration. The report is used to reset attribute
CentraSite requests running to 0.
This report can be run from a business service for which a service request is in process or
from a software service type for which a change request is in process.
3.6.1.2.33.4 Report: Output database information

This report is used for Software AG Designer integration and must not be changed or deleted.
This report is called from Software AG Designer via Process Governance.
The report outputs the names of all databases on this tenant.
3.6.1.2.33.5 Report: Perform part layout after the

transformation from XPDL to BPMN
This report is used for Software AG Designer integration and performs a partial layout after
the transformation from XPDL into BPMN.
3.6.1.2.33.6 Report: Prescript - Share with IT

This report must not be changed or deleted. The report outputs the prescript for the import or
update of processes from Software AG Designer.
405
3.6.1.2.33.7 Report: Run all requested Publisher exports
USE
This report automatically runs all exports to ARIS Publisher requested by webMethods
integration at the specified time (independently of the database).
CONTEXT
Database
OUTPUT FORMAT
 Adobe PDF Files (*.pdf)
 HTML Files (*.htm)
 OpenDocument Text (*.odt)
 Rich Text Format (*.rtf)
 Text File (*.txt)
 Word 97 - 2003 Document (*.doc)
 Word Document (*.docx)
 XML File (*.xml)
406
3.6.1.2.33.8 Report: Run requested Publisher exports for

the current database
USE
This report must not be changed or deleted. This report runs the requested ARIS Publisher
exports for the current database within the scope of webMethods integration. This is done in
the process of sharing with IT.
CONTEXT
Database
OUTPUT FORMAT
 Adobe PDF Files (*.pdf)
 HTML Files (*.htm)
 Rich Text Format (*.rtf)
3.6.1.2.33.9 Report: Service request - Generate change

request document
This report must not be changed or deleted. This report creates a change request document
for CentraSite used to request a service change.
3.6.1.2.33.10 Report: Service request - Generate

requirements document
This report must not be changed or deleted. This report creates a requirements document for
CentraSite used to request a service.
3.6.1.2.33.11 Report: Service synchronization - Web service

- Service request notification completed
This report must not be changed or deleted. This report completes a service request. It is
called by CentraSite to notify ARIS that a service requested in ARIS is completely
implemented or that its implementation was canceled.
407
3.6.1.2.33.12 Report: Service synchronization - Web service

- Update service from CentraSite
This report must not be changed or deleted. This report updates a service with a newer
version from CentraSite. It is called by CentraSite to update a service in ARIS
3.6.1.2.33.13 Report: SWIT - BPMN consistency check

This report checks a BPMN diagram for modeling errors.
3.6.1.2.33.14 Report: SWIT - Check whether starting the

process is possible
This report checks if the process can be synchronized with ARIS.
3.6.1.2.33.15 Report: SWIT - Complete task

This report completes a BPM workflow task.
3.6.1.2.33.16 Report: SWIT - Document Solution Design

This report generates a Solution Design in PDF format.
3.6.1.2.33.17 Report: SWIT - Library

This report must not be changed or deleted. This report serves as a library for other reports. It
provides functions needed by several reports that include the term SWIT in their name.
408
3.6.1.2.33.18 Report: SWIT - Retrieve user tasks

This report retrieves all tasks of a user's BPM workflow and makes them accessible to the
user.
3.6.1.2.33.19 Report: SWIT - Web service - Check whether

update by IT is allowed
The report is used by the workflow to exchange data between webMethods and ARIS.
3.6.1.2.33.20 Report: SWIT - Web service - Output process

The report is used for Software AG Designer integration and is called by Software AG Designer
via Process Governance.
It returns XPDL representations of a BPMN diagram, as well as BPMN diagram metadata, such
as the model name, the link to the model in ARIS Publisher, etc.
3.6.1.2.33.21 Report: SWIT - Web service - Retrieve ARIS

version
This report retrieves the ARIS version in use.
3.6.1.2.33.22 Report: SWIT - Web service - Retrieve

CentraSite connection
This report retrieves data required for importing XPDL files from CentraSite for the workflow.
409
3.6.1.2.33.23 Report: SWIT - Web service - Transfer

The script uses an XPDL file (parameter) representing a BPMN diagram to create a BPMN
diagram in a group (parameter) of a database (parameter).
3.6.1.2.33.24 Report: SWIT - Web service - Transfer

metadata
This report is used by Software AG Designer to transfer metadata of the workflow to ARIS.
3.6.1.2.33.25 Report: SWIT - Web service - Transfer process

to ARIS
The script writes an XPDL representation of a BPMN diagram to an attribute of a BPMN
diagram.
3.6.1.2.33.26 Report: Upload webMethods documentation to

document storage
This report uploads the webMethods documentation for a process to ARIS document storage.
3.6.1.2.33.27 Report: Validate BPMN diagram for sharing

with IT
This report must not be changed or deleted. This report validates the selected diagram and
checks whether it can be shared with IT. All objects that are not compliant with the modeling
conventions are marked.
410
3.6.1.2.33.28 Report: Validate filter for system check

This report is used for Software AG Designer integration and validates the filter used for the
system check.
3.6.1.2.33.29 Report: XML layout

It enables easy generation, formatting, and output of XML-based text.
3.6.1.2.33.30 Report: XML2BPMN2 pre-processing script

This report must not be changed or deleted. Prescript for the transformation of an XML file to
the BPMN 2.0 format. The script prepares a BPMN file for import. The import is performed by
the XML2BPMN2 transformation.
3.6.1.2.33.31 Report: XPDL2BPMN - post-processing script

This report must not be changed or deleted. Post-processing script for cleanup within the
scope of the webMethods integration
411
3.6.2 Macros
A macro is a sequence of instructions that become automatic when called.
You can start macros manually in ARIS Architect or automatically in ARIS Architect and ARIS.
To start macros automatically, you can define that a macro is started when a certain event
occurs.
purchased will determine the range of macros available to you.
Architect.
To manage macros in ARIS Administration, click Application launcher >
Administration > Configuration > Evaluation and select Macros.
CATEGORIES
Use categories to organize your scripts in a clear structure.

and select Macros.
2. Click Create category.
3. Enter the name of the new category and click Apply.
The category is displayed only in the current language.
To display the category in multiple interface languages, you must rename the category in
each language. If you do not specify a category in a particular language, the category is
displayed in English.
412

Rename a category
You can change the name of a category or specify the name in a different language. You
cannot change the name of the Standard category.

and select Macros.
2. Select the category and click Rename.
3. Select the related language.
4. Enter the name in the selected language and click Apply.
The category is renamed in the current language.
Delete a category
You can delete a category and all the scripts that it contains. Software AG recommends that
you first export the scripts in order to have backup files.

and select Macros.
2. Select the category that you want to delete. You cannot delete the Standard category.
3. Click Delete.
4. Click Delete to confirm.
The category and all scripts that it contains are deleted.
Import a script
You can import scripts from export files or import common files that a script uses during
runtime. This enables you to provide scripts from another tenant or import scripts from a
previous version.

and select Macros.
2. Click the category into which you want to import the script.
3. Import.
4. Select the related import file and click Open.
5. If the script already exists in a category, you must confirm in order to import a copy into
the selected category.
6. If the script executes imported common files during runtime, you can enable the required
file and confirm the import of the file. Otherwise, the current common file on the tenant is
used.
The script is imported.
413
Create macro
MACROS
When you select a macro, you can do the following:
Edit macro properties
You can rename macro scripts in multiple languages or change other text attributes.

and select Macros.
4. Select the language in which you want to edit the text fields.
5. Overwrite the name, subject, author, company, or description, as required.
6. Select the next language, if required, and edit the text fields in turn.
7. Click Apply.
The changes are saved.
 Make a macro available to users.
 Change the context for which a macro can be started.
You can specify the database items for which the script can be started. Users can run
the script only for the database items you specify as context.

and select Macros.
4. Click Context and enable the related options. If you enabled Model or Object, you can
specify the types for which users can start the script.
If you select model types on which derived model types are based and the Include
derived types check box is not enabled, the script can still be run for the derived model
types. If you enable model types on which derived model types are based, but have
disabled the derived types, the script is still available for the disabled derived model
types.
The script is available for the selected context.
414
 Manage the events that can trigger macro execution.

Use evaluation filters to reduce the number of items that are evaluated and listed in the
output.

and select Macros.
4. Click Evaluation filter and enable Use evaluation filter. All evaluation filters created
(page 823) for this tenant are listed.
5. Select the related filter.
The script evaluates only items that are contained in the evaluation filter.
 Change output options
You can specify whether a script generates an output file and select the file type of the
output file.

and select Macros.
4. Click Output.
5. Enable Generate output file and select the required file types.
You can select the file formats to use for the generated output files. If in the scripts you use
fonts that are not installed on the operating system on the machine on which ARIS Server is
running, you must add these missing fonts. If a font is missing, the content using the font is
not readable. The missing fonts are not rendered correctly in the output files, or when pasting
a copied model to another application.
415
Change page layout

If the PDF, RTF, or DOC format was enabled as possible output format for a script, you can
change the page properties for generated output files.

and select Macros.
4. Click Page layout and change the settings as required.
Output files in the PDF, RTF, or DOC format use the defined page settings.
 Change the set of imported files.
Duplicate the macro script
Duplicate standard scripts and files to prevent your changes from being lost. During a system
update, all standard scripts and files are automatically overwritten to provide you with the
newest features.

and select Macros.
2. Click the category in which you keep the script.
3. Select the related script and click Duplicate.
The script has been duplicated.
You can modify the duplicated script. The duplicated script will not be overwritten during an
ARIS update because it has a new GUID.
Delete the macro script
You can delete scripts that you no longer require, such asa report scrips. If you export the
scripts first, you can make them available again at any time.

and select Macros.
3. Select the script and click Delete.
The script is no longer available on the tenant.
416
Export the macro script

You can save scripts as export files if you want to store different versions or to make scripts
available on multiple tenants.

and select Macros.
3. Select the script and click Export.
4. If the script executes imported common files during runtime, you can enable the required
files and confirm the inclusion of the files in the export file. Otherwise, only the script is
exported.
5. Navigate to the file location where you want to save the file and click Save.
The script has been saved.

By default, all users of a tenant have access to all scripts. You can make scripts available only
to members of defined user groups.

and select Macros.
3. Select the script, click Restrict access, and enable Restrict access to user groups.
All user groups available on this tenant are displayed. Make sure that a related user group
was created in ARIS Administration (page 31).
4. Enable the related user groups and click Apply.
The script can be run only by members of the selected user groups.
417
3.6.3 Semantic checks

administrator function privilege, you can manage semantic checks in ARIS Administration.
process data using scripts that you provide.
You can use semantic checks to ensure correct modeling in ARIS. Your models are checked
using the defined rules. The rules ensure that your business process models are logically
structured in ARIS and are meaningful. Only models such as these can produce meaningful
and correct analysis results in further work and be used to help make decisions. If models do
not adhere to the rules, the check shows detailed error descriptions, warnings, or notes. You
can run semantic checks for selected content, the content of a group, or for an opened model
and its objects. Based on the rules that a semantic check is verifying, you can start a check
for multiple elements or only for one element or element type, for example only for models of
a certain type.
ARIS system administrators can run the Output overview of reports, macros, and semantic
checks report (page 213) in ARIS Architect to provide detailed information about all semantic
checks that are available on this tenant.
Semantic checks include profiles, rule types and rules (page 421). All rules are categorized in
multiple rule types. Manage the semantic check profiles (page 419) that you use to start a
semantic check. Profiles contain the start context and specific rules to be checked.
418
3.6.3.1 Profiles
ARIS is supplied with numerous default profiles. Authorized ARIS users can start semantic
checks using the profiles that you provide. You can run semantic checks for selected content,
the content of a group, or for an opened model and its objects.
To manage semantic check profiles in ARIS Administration, click Application launcher >
Administration > Configuration > Evaluations and select Semantic checks > Profiles.
The profiles contain semantic check rules that are categorized in multiple rule types. You can
combine several rules of one particular rule type or rules of different rule types in a profile. For
example, profiles can combine rules that are only applicable to specific model or object types.
The existing rules in ARIS are all assigned to specific profiles. Individual rules can occur in
various profiles.
You can Create a profile, Import a profile if you have no profile selected. If you select
a profile, you can Edit properties, Export and Delete the profile.
You can save semantic check profiles as export files if you want to store different
versions or to make profiles available on multiple tenants.

and select Semantic checks > Profiles.
2. Select the profile and click Export.
3. Depending on your Web browser, navigate to the file location where you want to save the
file and click Save.
The profile has been saved.
You can change the settings of semantic check profiles if required.

2. Select the profile and click Edit properties.
3. Modify the settings as required.
4. Click Apply.
The profile was modified.
419
You can import semantic check profiles from export files if available. This enables you
to provide profiles from another tenant or import profiles from a previous version.

2. Click Import.
3. Select the related APX import file and click Open.
4. If the profile already exists, you must confirm to overwrite the current profile.
The profile is imported.
You can create individual profiles that users can use to start semantic checks.

2. Click Create profile.
4. Specify the entries in all required languages. Name and Description are especially
important.
6. Select the context for which you want to make the profile available.
7. Click Rules and add the required rules from multiple rule types.
8. Click Apply.
The profile is available.
To change the settings of the profile, click Edit properties.
420
3.6.3.2 Rule types

To manage semantic check rule types in ARIS Administration, click Application launcher >
Administration > Configuration > Evaluations and select Semantic checks > Rule
types.
The rule types contain all rules available on a tenant. Related rules are well structured in
multiple rule types. When you create a profile, you add the rules from these rule types that are
relevant for the profile.
<_a > contains two different sets of rule types. The set of expandable rule types comprises all
rules whose properties you can easily adapt to your requirements. The set of predefined rule
types contain rules that you can only modify if you have knowledge of the JavaScript and
ARIS Script programming languages.
PREDEFINED RULE TYPES

For rules contained in the predefined rule types, you cannot modify the rule properties. If you
want to adapt predefined rule types in ARIS Architect or define your own rules, you require
knowledge of the JavaScript and ARIS Script programming languages.
 Assignment rules
Check the relationship of an object definition to its assigned models. If the assigned
model meets the conditions of the rule, it is recognized as a complete and correct
assignment. The assignment rules are combined in groups that relate to specific object
types.
 Rules for a BPMN diagram (BPMN 2.0)
These rules validate BPMN diagrams according to BPMN Specification 2.0.
 Rules for a service-oriented BPMN diagram
These rules validate BPMN diagrams according to BPMN Specification 1.0.
 Rules for a service-oriented EPC
Check the relationships and structures within one or more service-oriented models of the
EPC type.
 Rules for an EPC-to-BPMN transformation
This rule type checks whether a model of type 'EPC' can be transformed into a BPMN
Solution Design.
421
 Rules for checking consistency of service allocation

Some M2E features (mostly the EPC-to-BPMN transformation and the export to
webMethods) are used to evaluate models of service-enabled processes. Therefore, these
models must be consistent and complete. Consistency rules define criteria that support
correct modeling of such models.
 Rules for time-based modeling
This rule type checks the process schedule consistency of functions and assigned
models, as well as the time consistency of functions in project schedules and superior
functions, or the time consistency across the model hierarchy.
 Semantic check for Process Governance
Checks whether the relationships and the structure of models comply with the modeling
conventions so that automation can be enabled.
 Structure rules
Check the relationships and structures in the selected models. This check is model
type-specific. Accordingly, the rules are combined in groups that pertain to specific
model types. Model checking always takes place at occurrence level.
EXTENDABLE RULE TYPES

Extendable rule types contain rules that you can extend or modify without having
programming knowledge. This means that you can modify the rule properties as required.
 Allocation rules
Check allocations of objects of one type to objects of a different type using defined
relationship types.
 Existence rules
Check the consistency of contents among multiple models. You can use these rules to
check how frequently an object type occurs in source and target models of a specific
type.
 Model attribute rules
Check whether selected attribute types are specified for all models of a specific type.
 Object attribute rules
Check whether selected attribute types are specified for all objects of a specific type.
This check takes place at the definition level.
 Relationship attribute rules
Check whether selected attributes are specified for all relationships of a certain
connection type.
422
You can Create a rule type, Import a rule type if you have no rule type selected. If you
selected a rule type, you can Edit properties, Export and Delete rule types. If you
have selected a rule from an expandable rule type, you can Edit properties of the rule.
You can change the settings of expandable semantic check rules if required. You
cannot change properties of rules contained in predefined rule types.

and select Semantic checks > Rule types.
2. Click the expandable rule type and click the rule.
5. Click Apply.
The Rule was modified.
You can save semantic check rule types as export files if you want to store different
versions or to make rule types available on multiple tenants.

2. Select the rule type and click Export.
3. Depending on your Web browser, navigate to the file location where you want to save the
file and click Save.
The rule type has been saved.
You can change the settings of semantic check rule types if required.

2. Select the rule type and click Edit properties.
4. Click Apply.
The rule type was modified.
423
You can import semantic check rule types from export files if available. This enables you
to provide rule types from another tenant or import rule types from a previous version.

2. Click Import.
3. Select the related ASX import file and click Open.
4. If the rule type already exists, you must confirm to overwrite the current rule type.
The rule type is imported.
Create your own rule type.

2. Click Create rule type.
4. Specify the entries in all required languages. Name and Description are especially
important.
6. Specify the settings as required.
7. Click Apply.
The rule type is created.
424
3.6.4 ARCM reports

ARCM reports are scripts that users can execute only in ARIS Risk and Compliance.
purchased will determine the range of reports available to you.
Architect.
To manage ARCM reports in ARIS Administration, click Application launcher >
Administration > Configuration > Evaluations and select ARCM Reports. If you modify
scripts, always make the changes in copies of standard scripts and files. When updating ARIS,
all ARIS standard scripts and files are overwritten and customer-specific changes to these
files are discarded. Copied scripts and files and those you have created yourself are not
overwritten.
CATEGORIES
Rename a category
Delete a category
Import a script
REPORTS
If you select a report, you can do the following:
Edit report properties
 Make a report available to users.
 Check 'Open dialog' settings.
 Change output options.
 Change page layout.
425
 Change advanced properties, such as 'Enable timeout', 'Complexity', and imported

files.
 Change security settings.
By default, all users of a tenant are allowed to access report scripts.

and select Reports.
4. In the Author field, press the keys CTRL+ALT+SHIFT+K. The Security settings are
shown at the bottom of the page.
5. Select the required options.
You can allow execution but deny editing to prevent users from changing the script code.
Or you can restrict execution to users whose assigned licenses contain a defined string.
You can also combine both options.
6. Click OK.
7. Enter a password.
Warning
You must remember this password. Otherwise, you cannot modify the script code or
change the security settings for this script again.
Security settings are applied.
Duplicate the report script
Delete the report script
Export the report script
426
3.6.5 Common files

Common files, such as js, gif, or xml files, are files that are available for the shared use of
evaluation scripts. Common files can be imported and executed automatically by a script
during runtime. To make files available to a script, you must add these files to the Imported
files list (advanced properties) of the script.
administrator function privilege, you can manage common files in ARIS Administration. To do
so, click Application launcher > Administration > Configuration > Evaluations
and select Common files. If you modify scripts, always make the changes in copies of
standard scripts and files. When updating ARIS, all ARIS standard scripts and files are
overwritten and customer-specific changes to these files are discarded. Copied scripts and
files and those you have created yourself are not overwritten.
You can import common files. If you selected common files, you can do the following:
Duplicate file
Delete file
Export file
Unlock file
You can unlock files that currently cannot be edited because you have the file open in ARIS
Architect at the same time.

and select Common files..
2. Select the file and click Unlock.
The file is no longer locked and you can edit the file.
427
3.6.6 Scheduled reports

Scheduled reports are reports that start automatically at a specified point in time. You can
schedule a report that strongly affects system performance is to run only at night when no
one works with the system. Scheduled reports run in the background and you can view the
results later.
To create report schedules, users must have the Report automation function privilege that
administrators can assign for each database. These users can manage their own schedules in
the repository.
Languages
Add language
database items.

machine.
428





default.
429


Warning
languages.
4. Click Delete.
430
Font formats
Create font format.


431
Variant management
Prerequisite
Procedure
3. Click Databases.
432

Warning
Prerequisite
Procedure
3. Click Databases.

name, and click OK.
management.
433

Prerequisite
Procedure
3. Click Databases.

434
Function privileges
users.

privileges.
the user has.


affected.
435
databases.
Access privileges

No access (----)
Read (r---)
436
Read + Write (rw--)

items.
and version models.
1. If you want to only grant access to the selected database group, click Apply. If you want
to grant access to all subordinate database groups as well, click Pass on.


437
Statistics
chart type.
Chart menu.
require.
438
 Modeling
created.
 Versioning
database backups.
Identifier
Create identifier

439
default.
6. Click Create.

database items.
If you no longer need to identify users, click Deactivate identifiers.
Edit identifier

Delete identifier

440
Use as default


shown.
Various report scripts are delivered with ARIS, which you can automatically execute as long as
they do not require user input. Therefore, you can only use reports that in the general
properties have the Open dialogs check box is disabled.
You may specify when and how often a report should be automatically executed.
Prerequisites
 You have the Report automation function privilege for the related database.
Administrators can edit the database properties to apply this privilege to your user.
Languages
441
Add language
database items.

machine.

442

default.

Warning
languages.
4. Click Delete.
Font formats
443
Create font format.

444
Change lists
ascending order.
You can Delete change list numbers that are no longer needed.
You can delete old versions of databases that are no longer in use. Deleting obsolete versions
helps reduce the size of versionable databases and the time for backing up large databases.

2. Select the database and click Properties > Change lists.
3. Move the mouse pointer to the required change list number to keep and click Delete.
All previous versions of the database get deleted. The current change list number will
remain as the oldest version.
To prevent data loss, create a back up of the database that contains all versions.
All previous versions of the database are deleted. The change list from which you started the
action is displayed as the oldest version of the database.
Variant management
Prerequisite
Procedure
3. Click Databases.
445

Warning
Prerequisite
Procedure
446
3. Click Databases.

name, and click OK.
management.
Prerequisite
Procedure
3. Click Databases.

447
Function privileges
users.

privileges.
the user has.

affected.
448
databases.
Access privileges

No access (----)
Read (r---)
Read + Write (rw--)
449

items.
and version models.
1. If you want to only grant access to the selected database group, click Apply. If you want
to grant access to all subordinate database groups as well, click Pass on.

Statistics
450
chart type.
Chart menu.
require.
451
 Modeling
created.
 Versioning
database backups.
Identifier
Create identifier

default.
6. Click Create.
452


database items.
If you no longer need to identify users, click Deactivate identifiers.
Edit identifier

Delete identifier

Use as default
453


shown.
 You have access to this script. Administrators can restrict access to certain user groups.
 You have read access to all required database groups.
1. Click Application launcher > Models & Objects. The Models & Objects view in the
repository is opened.
2. Click Scheduled reports. All schedules are listed in the Scheduled reports view that
are available in the database.
3. Click Create schedule and specify the settings as required.
Depending on the report selected, you can set, for example, the database as context for
which the report can be started or you select the context from the database.
Depending on the report selected, you can set the database as context for which the report
can be started or specify database items as context.
1. Make sure to select the method filter that contains all items that you want to add. Entire
method contains all items.
2. Click Add context items.
3. Select the database items. The items available depend on the report selected. You can
either navigate the folder structure or search for the items to add.
4. Click Add to context.
454
Select the report that you want to be started by your schedule. The settings to specify in the
schedule vary, depending on the report selected.
1. Click Select a report.
2. Click the report that you want to use.
3. Click Apply.
If the first execution is in the future, the report is automatically active and runs as soon as the
defined point in time is reached.
You can manage your schedules accordingly. Administrators can manage all schedules (page
428) available on a tenant.
administrator function privilege, you can manage all report schedules in ARIS
Administration.
To manage schedules in ARIS Administration, click Application launcher >
Administration > Configuration > Evaluations and select Scheduled reports.
You can activate or deactivate report schedules or delete schedules you no longer require.
3.6.7 Fonts
administrator function privilege, you can manage the fonts that are available for data
evaluation and model graphic generation on this tenant.
You must add any missing fonts that you use in scripts and models, but that are not provided
by the operating system of ARIS Server. If the used fonts are missing, unreadable content
might be displayed. The missing fonts are not rendered correctly in output files, or when you
paste a copied model to another application. This can occur, for example, in Japanese, if the
default attribute font MS UI Gothic is missing. In this case, add at least the msgothic.ttc font
file..
When ARIS Server is installed on a Windows® operating system, all fonts saved in the Fonts
folder of the operating system are available for report and model graphic generation. Linux
operating systems usually provide a smaller set of fonts. If ARIS Server is installed on a Linux
operating system, usually no Windows® standard fonts are available. To prevent unreadable
content or incorrect line breaks, make sure to add all used fonts from your Windows®
operating system.
To manage the fonts used by evaluation scripts, click Application launcher >
Administration > Configuration > Evaluation and select Fonts. You can do the
following:
Import fonts
Delete fonts
455
3.7 Manage documents

ARIS document storage enables you to manage temporarily or permanently saved
documents.
The documents saved there can be used during runtime of an executable process, for
example, attached to an e-mail.
All file formats are allowed for documents.
Temporary documents (page 457) are deleted automatically after the executable process is
terminated. Permanent documents (page 456) are kept until they are deleted explicitly.
Access restriction on folder level is possible in ARIS document storage for users (page 469) or
user groups (page 468).
You can work with documents in the repository or in the portal.
ARIS document storage was tested with 40.000 document items. This includes documents,
document versions, or folders. We recommend monitoring the number and overall size of
stored document items and archiving older document items if the amount of 40.000 is
exceeded.
3.7.1 Permanent documents

Permanent documents remain in the ARIS document storage until they are explicitly deleted.
You can set up (page 468) access restrictions on the folder level for permanent documents.
If you use Process Governance, it is recommended that you specify that documents are to be
saved permanently in ARIS document storage when modeling a dialog for an executable
process, otherwise the location for these documents within ARIS document storage cannot
be specified in the dialog. These documents are called temporary documents (page 457).
You can restrict access privileges on folder level only, not for individual documents. Users
having the Document administrator function privilege can access all folders. If no roles are
defined for access to a folder, all users have access to it.
456
3.7.2 Temporary documents

Temporary documents are documents that were not explicitly uploaded to ARIS document
storage but were added to the process during process instance runtime if you use Process
Governance. They can be transformed into permanent documents and added to ARIS
document storage if required.
Temporary documents are also saved in the safe area of ARIS document storage when you
use an external document management system. These documents are deleted when the
process instance is terminated.
You can transform a temporary document into a permanent document by moving it to ARIS
document storage.
457
3.7.3 Scheduled reports

Scheduled reports are reports that start automatically at a defined point in time.
They run in the background and you can view the results later. For example, you can define
that a report that strongly affects system performance is to run only at night when no one is
working with the system.
You specify the schedule for reports in ARIS Architect. For further information please refer to
the Evaluate data > Use reports > Create schedule for report chapter of the ARIS Architect
online help.
3.7.4 Display charts for documents

You can display various charts for documents.
Prerequisite
Procedure
1. Open ARIS and log in with your user name and password.
2. Click Charts.
3. Click Documents.
The charts for documents are displayed.
3.7.5 Use ARIS document storage with WebDAV

ARIS document storage supports WebDAV. You can connect only one tenant with a specific
repository.
To grant users without the Document management role access to ARIS document storage
content, ARIS document storage can be used as a WebDAV network drive.
With a Microsoft® Windows 7 operating system you just need to connect the relevant network
and access ARIS document storage directly. With older operating systems, you need to use
Web folders (select Tools > Map Network Drive > Sign up for online storage connect to a
network server in Microsoft® Windows Explorer). If this does not work, you must configure
your computer as follows.
458
Procedure
1. Open the Registry Editor.
2. Navigate to
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parame
ters and find the DWORD entry BasicAuthLevel.
3. Check if the value of this entry is 2. If the value of this entry differs, please change it to 2.
If the DWORD entry does not exist, create it.
4. With operating systems older than Microsoft® Windows 7 you also need to find the
DWORD entry UseBasicAuth. If it does not exist, create it.
5. Change the value of this entry to the hexadecimal value 1. Thus, you enable HTTP Basic
Access Authentication for SSL and non-SSL connections.
6. Close the Registry Editor.
7. Restart Microsoft® Windows.
You can now use ARIS document storage as a WebDAV network drive.
3.7.6 Export statistics

You can export statistics for documents if Generate usage statistics is configured for ARIS
document storage.
Prerequisite
You have the Document administrator function privilege.
Procedure
1. Click Application launcher > Documents.
2. Click Administrative actions.
3. Click Export statistics. If you want to export all event types, enable the check box in
front of Event types.
You can save the document statistics file of ARIS document storage at the relevant location
for further use.
3.7.7 Use metadata

Metadata can be used to classify documents and is displayed in the properties (page 461) of a
document.
459
3.7.7.1 Define custom metadata for documents

You can define custom metadata for documents saved in ARIS document storage. You can
define attributes of type String or Value. If you define an attribute of type Value, you need to
specify the allowed value range. For example, this user-defined metadata could be the color
(green, blue, yellow) or the company size (small, medium, large). This metadata can be used to
classify documents and is displayed in the properties (page 461) of a document.
Prerequisite
Procedure
2. Click the arrow next to ARIS document storage.
3. Click Open properties. The details (page 483) of the folder are displayed.
4. Click Attribute types.
5. Click Add new attributes. The Add attribute type dialog opens. Add the relevant
attribute type.
You have defined custom metadata.
A user-defined attribute type cannot be changed. You can add or delete values.
3.7.7.2 Delete custom metadata

You can delete custom metadata.
Prerequisite
Procedure
2. Click the arrow next to ARIS document storage.
5. Move the mouse pointer over the attribute type to be deleted.
6. Click Delete.
You have deleted custom metadata.
460
3.7.7.3 Display document properties

You can view the properties of a document or a folder.
Prerequisite
Procedure
2. Click a folder in the navigation.
3. Click the relevant document. The Document details page opens.
The properties of the document are displayed.
3.7.7.4 Edit document properties

You can edit the properties of a document.
Prerequisite
Procedure
4. Edit the document properties, for example, change the description.
5. Click OK.
You have edited the properties of the document.
461
3.7.7.5 Generate a dashboard link

You can generate a link to a permanent document (page 456) located in ARIS document
storage. This link can be used in data feeds or dashboards for ARIS Aware.
Prerequisite
 You have the Dashboard administrator function privilege.
 You have an ARIS Designer (page 50) or ARIS Viewer license.
 Your ARIS Server is enabled for ARIS Aware.
Procedure
2. Click the document for which you want to generate a link to the document location in
ARIS document storage.
3. Click Show server location.
4. Click Copy to clipboard.
The link to the document is copied to the clipboard and can be used in data feeds or
dashboards for ARIS Aware.
462
3.7.7.6 Edit document tags

You can edit the tags of a document. You cannot edit an existing tag, you can only delete it
and replace it with a new one.
Prerequisite
Procedure
4. Click Edit.
5. Enter a new tag. You can separate multiple tags by a comma.
6. Click Save.
You have edited the tags of the document.
3.7.7.7 Delete tags of a document

You can delete the tags of a document.
Prerequisite
Procedure
4. Click Edit.
5. Click the little cross beside the tag name.
6. Click Save.
You have deleted a tag.
463
3.7.7.8 Change the document owner

You can change the owner of a document.
Prerequisite
You have the ARIS Designer license.
Procedure
4. Click Edit.
5. Next to the Owner field, click Edit. The Select owner dialog opens.
6. Enter a character string that is part of the user name of the new owner. The matching
users are displayed.
7. Enable the relevant user.
You have changed the owner of a document.
464
3.7.8 Use folders

The folder structure of ARIS document storage provides a better overview and the possibility
to specify access privileges (page 468).
3.7.8.1 Create folder in ARIS document storage

You can manage documents in your ARIS document storage. For a better overview, create a
folder structure.
Prerequisite
You have the license right ARIS Designer and have the corresponding permissions
(Document administrator, Local administrator, or write permission).
Procedure
3. Click the arrow next to a folder to open the menu.
4. Click Add folder.

5. Enter a name for the folder, and click OK.
You have created a new folder.
3.7.8.2 Display folder details

You can view the details of a folder.
Prerequisite
Procedure
2. Click the relevant folder, and click the arrow to open the menu.
3. Click More.
4. Click Open properties.

The details (page 483) of the folder are displayed.
465
3.7.8.3 Edit folder details

You can edit the properties of a folder.
Prerequisite
Procedure
3. Click More.
5. Click Edit.
You can edit the properties (page 483) of the folder.
3.7.8.4 Folder Dashboarding

Data is collected by scheduled reports (page 458) and form the basis for data feeds that are
stored in the Dashboarding folder in ARIS document storage.
These reports generate XML files.
By default, all users have access to the Dashboarding folder. Therefore, it is strongly
recommended that you restrict the access (page 468) to the Dashboarding folder and all its
subfolders to the user that is configured in the URL alias.
The United Motor Group database is supplied with your ARIS installation by default. With this
database, you receive a set of default dashboards that can be displayed within ARIS.
By default, at least the following folders are available in the Dashboarding folder:
 Collaboration - containing the dashboards for Collaboration
 Governance - containing the dashboards for Process Governance
 Matomo - containing the dashboards collected by Matomo
Under United Motor Group folders
 CoE - containing the dashboards for Center of Excellence
 CXM - containing the dashboards for Customer Experience Management
 EA - containing the dashboards for Enterprise Architecture
 Exported Tables - containing the dashboards for metadata, for example, for the person
responsible for a process
466
 GRC - containing the dashboards for Governance, Risk & Compliance (GRC)
 IoT - containing the dashboards for Internet of Things
 Matomo - containing the dashboards collected by Matomo from the United Motor Group
database
 PPM - containing the dashboards for ARIS Process Performance Manager
 SAP - containing the dashboards for ARIS for SAP® Solutions
 Strategy - containing the dashboards for Business strategy
3.7.8.5 Move folders in ARIS document storage

You can move folders in your ARIS document storage. The subfolders contained are also
moved to the target folder.
Prerequisite
 You have the ARIS Connect Designer license privilege.
 You have access privileges (page 469) for the source folder and read and write privileges
for the target folder.
Procedure
4. Click Move to another folder.

5. Select the folder and click OK.
You have moved a folder and its subfolders.
467
3.7.8.6 Manage folder access for user groups

By default, no access privileges are defined in ARIS document storage. All users have access
to all folders - including the root folder - and documents. You can limit the access (page 470)
to individual folders of ARIS document storage so that not all ARIS document storage users
can access all folders and their contents.
Warning
If you edit the access of a user or a user group to a folder for the first time, you also must
adapt the access privileges of the remaining users or user groups accordingly. Otherwise, all
the remaining users or user groups will have no access at all.
Prerequisite
Procedure
3. Click More.

5. Click Access privileges.
6. Click Users groups.
7. Enable the check boxes of the user groups whose access privileges you want to change.
8. Click Edit access privileges. The Edit access privileges dialog opens.
9. Enable Pass access privileges on to all subfolders if users or user groups should have
access to the subfolders below the selected folder. Select the relevant access privilege
from the list.
10. Click OK.
You have restricted the access to ARIS document storage folders.
Tip
If you want to change the access privileges for a single user group, move the mouse pointer
to the row of the relevant user group and click Edit access privileges.
468
3.7.8.7 Manage folder access for users

to all folders - including the root folder - and documents. You can limit the access (page 470)
to individual folders of ARIS document storage so that not all ARIS document storage users
can access all folders and their contents.
Warning
If you edit the access of a user or a user group to a folder for the first time, you also must
adapt the access privileges of the remaining users or user groups accordingly. Otherwise, all
the remaining users or user groups will have no access at all.
Prerequisite
Procedure
3. Click More.

6. Click Users.
7. Enable the check boxes of the users whose access privileges you want to change.
8. Click Edit access privileges. The Edit access privileges dialog opens.
9. Enable Pass access privileges on to all subfolders if users or user groups should have
access to the subfolders below the selected folder. Select the relevant access privilege
from the list.
10. Click OK.
You have restricted the access to ARIS document storage folders.
Tip
If you want to change the access privileges for a single user, move the mouse pointer to the
row of the relevant user and click Edit access privileges.
469
3.7.8.8 Access privileges for folders

to all folders - including the root folder - and documents. You can limit the access to
individual folders of ARIS document storage so that not all ARIS document storage users can
access all folders and their contents. The following access privileges exist:
 All access privileges
The users or user groups with this privilege have full access to the folder and can view,
edit, create subfolders and delete the folder but cannot assign privileges to users or user
groups. They can upload new documents, new document versions, and delete
documents.
 Folder administration access
The users or user groups members with this privilege are local administrators for the
folder and can view, edit, create subfolders, delete the folder, and assign privileges to the
users and groups. But they cannot assign the Folder administration access privilege to
other users or user groups. They can upload new documents, new document versions,
and delete documents.
When the Folder administration access privilege of a folder is revoked, the user also
loses the Folder administration access privilege for all the subfolders that have implicit
pass-on behavior. Thus, if no other restrictions apply, all users have access to these
folders again.
 Reset access privileges
The users or user groups with this privilege can revoke the permission on the folder if
already assigned.
 'Read" access privilege
The users or user groups with this privilege can view the folder but are unable to upload
new documents and new document versions or delete documents in the folder nor create
new subfolders.
 'Read + Write' Access privilege
The users or user groups with this privilege can view and edit the properties of the folder
and create subfolders. They can upload new documents, new document versions, and
delete documents.
470
3.7.8.9 Show assigned users or user groups

You can restrict the view to those users or user groups who have access privileges to the
selected folder.
Prerequisite
Procedure
3. Click More.

6. Click Users or User groups.
7. Enable Show assigned users.
Users or user groups who have access privileges to folders in ARIS document storage are
displayed.
471
3.7.8.10 Exclude fold er(s) from search

You can exclude ARIS document storage folders from the search.
Prerequisite
 You have read and write privilege for the relevant folders.
Procedure
3. Click More.
5. Click Edit.
6. Enable Exclude from search.
7. Click Save.
You have excluded folders from the search. If you search for documents that are located in
the excluded folder, no document is found. Only the folders not excluded are searched
through. This has no effect on the subfolders of the excluded folder.
3.7.8.11 Delete folder in ARIS document storage

You can manage documents in your ARIS document storage. For a better overview, create a
folder structure.
Prerequisite
Procedure

5. Click OK.
You have deleted the folder.
472
3.7.8.12 Charts for documents
3.7.8.12.1 'Number of documents' chart

This chart only displays information.
It shows the total number of all documents per repository in ARIS document storage, if
multiple repositories exist. Otherwise, the total number of documents is displayed.
3.7.8.12.2 'Used space' chart

This chart is a speedometer display.
If memory space (in kilobyte) for ARIS document storage for a tenant is restricted, the
memory used is shown in the form of a speedometer. If no maximum memory space has been
defined, the memory used is shown in megabytes.
3.7.8.12.3 'Most viewed documents' chart

This chart is a bar chart.
It shows the 15 most viewed or downloaded documents including their file size.
3.7.8.12.4 'Most changed documents' chart

It shows the 15 most changed documents including their file size.
3.7.8.12.5 'Largest documents' chart

It shows the 20 largest documents including their file size.
3.7.8.12.6 'Latest documents' chart

This chart is a simple list.
This chart shows the 15 latest documents.
473
3.7.8.12.7 'Document status overview' chart

This chart is a pie chart.
It shows the distribution and number of documents in the various document statuses.
Document statuses are In progress, Under review, Reviewed, Rejected, and Published.
3.7.8.12.8 'Outdated documents' chart

This chart is a simple list.
This chart shows the 15 oldest documents.
3.7.8.13 Options for models or objects

There are two options to connect documents with an object or model: The first is using the
ARIS document storage attribute of an object or model. In the document details, documents
connected with an object are preceded by the symbol, and documents connected with a
model are preceded by the symbol.
The second option is to assign documents to an object or model in the modeling component.
The assignment is marked by the link symbol for objects and for models.
In this case, the document details show that this document is connected via attributes with
an object ( ) or a model ( ).
The second option includes direct attachment to an object or model in the modeling
component. This is marked by the or link symbols.
3.7.8.14 External document management systems

This is where permanent documents (page 456) are managed. The storage for temporary
documents (page 457) is not affected by this.
Available is Microsoft® SharePoint 2013.
3.7.8.15 Delete and anonymize user accounts

Users can only be deleted (page 35) in ARIS Administration. Then, they must be anonymized
according to GDPR (page 1139). Users are anonymized either with y-admintool.bat for
474
Windows operating systems or y-admintool.sh for Unix operating systems. For detailed
information, refer to ARIS document storage Command-Line Tool.
After anonymization, activities of ARIS document storage users, such as uploads of
documents, downloads of documents, changes to metadata, are shown with Anonymous
instead of with the user name.
3.7.9 Pages in ARIS document storage
3.7.9.1 ARIS document storage attribute types

Enables the definition of custom metadata for documents saved in ARIS document storage.
This page is available only for the root folder.
GENERAL BUTTONS
Add new attributes
Opens the Add attributes types dialog in which you can enter new attribute types for
documents.
TABLE
Key
Specifies the key of the attribute. This is the name that is displayed in front of the box of
allowed values.
Type
Specifies the type of the attribute.
Value range
Specifies the values that a user-defined attribute may have.
Edit
Opens the Change attribute type dialog. This is only available for attributes of the Value
data type.
Delete
Deletes a value from the list of allowed values for an attribute of the Value type.
475
3.7.9.2 Document details

Displays document details.
GENERAL BUTTONS
Buttons on the top right, whose functionality applies to the entire document including its
versions.
Upload new version
Download
Lock
Unlock
Delete
Edit
Enables the editing of a document.
TABLE
File name
Displays the name of the document.
Path
Displays the path to the document.
Title
Displays the title of the document.
Current version
Displays the current version of the document. During a new upload of the document the last
number is increased. When the document status is changed, the number in the middle is
increased. The states New, Approved, Rejected, In process, and To be approved exist.
Revision
Shows the number of the revision for the selected document. Each time a document is
checked out and changed, a new revision number is assigned.
Status
Shows the status of the document. The states New, Approved, Rejected, In process, and To
be approved exist.
ID
476
Displays the ID of the document.
File size
Displays the size of the file.
Owner
Displays the name of this document's owner.
Locked by
Displays who has opened or locked the selected document.
Created by
Displays who created the document in ARIS document storage.
Created on
Displays the creation date of the document.
Description
Displays a detailed description of the document if the description is specified.
List of tags
Displays tags, if they exist. You can add new tags and edit or delete existing ones.
Link
Displays the link to the physical location.
Optional: Custom metadata

Displays the custom metadata, if defined.
3.7.9.3 Document history

Displays the history of a document.
GENERAL BUTTONS
versions.
Upload new version
Download
Lock
Unlock
Delete
477
TABLE
Timestamp
Shows the timestamp of the change to a document to the second, as well as the date of the
change.
User name
Shows the user name that the user who performed the change was logged in with.
Event
Shows the change made, for example, an update of the document relationship or a change to
a document's metadata.
Details
Shows the event in detail.
3.7.9.4 Document relations

Displays the relationships of a document.
GENERAL BUTTONS
versions.
Upload new version
Download
Lock
Unlock
Delete
TABLE
Type
Shows the type of the relationship, for example, ARIS_Model, if the document is directly
connected to a model. The following relationship types are displayed:
- The document is connected to a model via a link (ARIS document storage attribute type
group)
- The document is connected to an object via a link (ARIS document storage attribute type
group)
- The document is connected directly to a model (ARIS_Model)
478
- The document is connected directly to an object (ARIS_OBJECT)
Reference
Shows the document's reference to a model or object. The GUID of the model or object is
shown, as well.
Delete
Deletes the relation of the document.
If, for example, the document is connected with a model, this relationship is deleted from the
model.
A confirmation prompt is shown. Click OK to delete the relation. If you decide not to delete the
relation, click Cancel.
3.7.9.5 Document versions

Displays the versions of a document.
GENERAL BUTTONS
versions.
Upload new version
Download
Lock
Unlock
Delete
TABLE
Revision
Shows the number of the revision for the selected document. Each time a document is
checked out and changed, a new revision number is assigned.
Size
Displays the size of the file.
Changed on
Shows the date a document version was changed.
Changed by
Shows which user changed a version of a document.
479
Comment
Shows the comment entered when changing the version of the document.
Status
Shows the status information of the document. The following status information is possible:
 NEW
 ON_APPROVAL
 IN_PROGRESS
 APPROVED
 REJECTED
 PUBLISHED
VERSION-SPECIFIC BUTTONS
If you move the mouse pointer to the row of a version the version-specific buttons are
displayed.
Open version
Delete
3.7.9.6 Folder access privileges for user groups

Displays the folder access privileges of the associated user groups.
GENERAL BUTTONS
Delete
Deletes the selected folder, its subfolders and all documents in them.
Enter search term field

Enter the name of the user group or user you want to edit.
Pass on access privileges to all subfolders

Activates the function based on which the restriction of access privileges is extended to all
subordinate folders of the selected folder.
480
TABLE
User group name
Displays the name of the user group.
Access type
Displays the access privilege of a folder for a user group or a user.
Edit
Opens the Edit access privileges dialog.
3.7.9.7 Folder access privileges for users

Displays the folder access privileges assigned to users.
GENERAL BUTTONS
Delete
Enter search term field

Enter the name of the user group or user you want to edit.
Pass on access privileges to all subfolders

Activates the function based on which the restriction of access privileges is extended to all
subordinate folders of the selected folder.
TABLE
User name
Displays the name of the user.
Full name
Displays the full name of a user.
Access type
Displays the access privilege of a folder for a user group or a user.
Edit
Opens the Edit access privileges dialog.
481
3.7.9.8 Folder
Displays the content of a folder.
GENERAL BUTTONS
Upload
Opens the dialog to upload a new document.
Refresh
Refreshes the page displayed.
TABLE
Name
Displays the name of the document.
File type
Displays the file type of the document.
Status
be approved exist.
Upload new version

be approved exist.
Download
be approved exist.
Open properties
Opens the properties of the document.
Move to another folder

Opens the Move document dialog.
Delete
Deletes the document from ARIS document storage.
482
3.7.9.9 Folder details

Displays the details of a folder. (page 465)
GENERAL BUTTONS
Delete
Edit
Enables editing mode for the folder details.
TABLE
Folder name
Displays the name of the folder.
Path
Displays the path to the folder.
ID
Displays the ID of the folder.
Created by
Displays who created the folder in ARIS document storage.
Created on
Displays the creation date of the folder.
Exclude from search

Enables that folders are excluded from the search. If you search for documents that are
located in the excluded folder, no document is found. Only the folders not excluded are
searched through. This has no effect on the subfolders of the excluded folder.
483
3.7.9.10 Folder history

Displays the folder history.
GENERAL BUTTONS
Delete
Refresh
Refreshes the page displayed.
TABLE
Timestamp
Displays the timestamp of the changes to the folder details.
User name
Displays the user who changed the folder details.
Event
Displays what changes were made to the folder, for example, the creation of a new subfolder.
Details
Displays a detailed comma-separated list of the changes made to the folder.
484
3.7.9.11 Select document page

Enables selection of the documents you want to add. Multiple selection is possible.
Double-click to add a single document to the selection.
ARIS document storage

Enables you to select a document that is stored in ARIS document storage.
Microsoft® SharePoint 2013

Enables you to select a document that is stored in a third-party document management
system.
Properties
Opens the Document properties dialog. This dialog displays document properties, such as
file name, version, and file type.
Previous version
Opens the Document versions dialog, which displays a list of document versions with the
corresponding change list numbers, the change date, and the name of the editor.
Add to selection
Adds the selected document to the document selection.
Clear selection
Clears the selection. All documents are removed from the selection.
Remove document
Removes the selected document from the selection. Multiple selection is possible. Select
adjacent documents by holding down the Shift key and clicking the first and last document.
Select individual objects by holding down the Shift key and clicking the relevant documents.
EXPLORER TAB
Click the small right arrow in order to navigate to further subfolders.
Selected documents
Displays the list of documents already included in the selection.
485
SEARCH TAB
Find what
Enables you to enter a term that occurs in the title, file name, description, or tags of the
document.
Search result
Displays the documents that match the search criteria.
Selected documents
Displays the list of documents already included in the selection.
3.7.9.12 Select tags page

From the available tags, select those you want to use for marking the document.
Specify tag filter...

Used for entering a search term to restrict the number of the tags displayed existing in the
system. When you enter the first letters the display is restricted to the tags that fit your input.
Select tags to be added

Enable the check box in front of the tags you wish to identify the document with.
486
3.7.9.13 Upload document page

Enables the upload of the required document.
File
Enter the name of the file. To search your file system, click Browse.
Location
Enables you to select the location where files are to be saved in ARIS document storage. Click
the small right arrow in order to navigate to further subfolders. To browse, click Browse
next to the box.
Comment
Enables you to enter a comment that will be displayed in the Document versions dialog.
Title
Used to enter the title of the document to be uploaded.
Description
Used to enter the description of the document to be uploaded.
Tags
Displays tags, if they exist. You can add new tags and edit or delete existing ones.
Enter suggestions here

Used to enter new tags. Press Enter to transfer the new tag.
Delete individual tag

Click Delete to delete an individual tag or selected tags for this document. Multiple
selections are allowed.
Delete all tags

Click Delete all tags from list to delete all tags for this document.
Find
Click Find to search for corresponding tags for this document in your ARIS document
storage.
487
3.7.10 Configure Document storage

You can customize general settings of ARIS document storage.

for example, infrastructure settings, the configuration of third-party document management
systems, or quota and restrictions settings. We recommend that you backup (page 489) your
existing configuration before you import a configuration in case that the imported
configuration does not meet your expectations.
Prerequisite
Procedure
Configuration view.
3. Click Document storage.

is required.
488

from another tenant to overwrite the current user management configuration.
Prerequisite
Procedure
Configuration view.

You can save the configuration file of ARIS document storage at the relevant location for
further use.
3.7.10.3 Customize infrastructure settings

You can customize the infrastructure for your document storage, for example, the path for
mobile uploads.
Prerequisite
Procedure
Configuration view.
4. Click Infrastructure. To configure advanced settings, click the arrow next to
Infrastructure and click Advanced settings.
5. Click Edit.
Properties that are highlighted as cross-tenant properties ( ) can only be changed using
ARIS Cloud Controller Command-line Tool (ACC). To change these settings enter the
following:
489
reconfigure adsadmin_<size of your installation, s, m, or l> JAVA-D<property

name>="<value>"
Example
reconfigure adsadmin_m JAVA-Dcom.aris.ads.thumbnails.queue.size="40"
7. Click Save.
You have customized your document storage configuration.
3.7.10.4 Add third-party document management system -

Basic Auth
You can configure a third-party document management system.
The systems available are ARIS Adapter for Microsoft® SharePoint 2016 and ARIS Adapter
for Microsoft® SharePoint 2019. Please contact your local Software AG sales organization
(http://www.softwareag.com) for other third-party document management systems.
Prerequisite
Procedure
Configuration view.
3. Click the arrow next to Document management system.
5. Click Edit.
6. Enable Use third-party document management system.
7. Optional: If you want to use more than one third-party document management system,
enable Support for multiple document management systems.
8. Click Save.
9. Click Add. The Add document management system server dialog opens.
10. Select the authentication scheme. Basic Auth and OAuth are available. Select Basic
Auth.
 the server ID
 the display name of the server
490
 the type of the third-party document management system. If you want to use
Microsoft® SharePoint 2016 or Microsoft® SharePoint 2019, select TDMS. If you want
to use Microsoft® SharePoint 2013, select SP2013.
 the server URL
 the user name of the user allowed to access the third-party document management
system content
 the password of this user
 the path to the root folder
 the site collection
12. Click Save.
You have added a third-party document management system.
If you want to specify more than one third-party document management system, proceed
with step 12 of the procedure steps mentioned above.
3.7.10.5 Add a third-party document management system

- OAuth
You can configure a third-party document management system.
Prerequisite
 OAuth is configured in Microsoft® SharePoint 2016 or Microsoft® SharePoint 2019.
 The client ID and the client secret are available.
Procedure
Configuration view.
6. Click Edit.
7. Enable Use third-party document management system.
491
8. Optional: If you want to use more than one third-party document management system,
enable Support for multiple document management systems.
9. Click Save.
10. Click Add. The Add document management system server dialog opens.
11. Select the authentication scheme. Basic Auth and OAuth are available. Select OAuth.
As soon as you have selected OAuth, Client ID and Client secret is displayed instead of
the fields User name and Password.
 the server ID
 the display name of the server
 the type of the third-party document management system
 the server URL
 the client ID
 the client secret
 the path to the root folder
 the site collection
13. Click Save.
You have added a third-party document management system.
If you want to specify more than one third-party document management system, proceed
with step 12 of the procedure steps mentioned above.
492
3.7.10.6 Test connection to a third-party document

management system
You can test the connection to a third-party document management system.
Prerequisite
Procedure
Configuration view.
4. Click the arrow next to the relevant document management system.
6. Click Test connection.

A message is displayed, whether or not the connection to a third-party document
management system server specified is valid.
3.7.10.7 Edit document management system

Prerequisite
Procedure
Configuration view.
7. Click Edit.
493
9. Click Save.
You have customized your document storage configuration.
3.7.10.8 Delete third-party document management system

Prerequisite
Procedure
Configuration view.

8. Click OK.
You have deleted a third-party document management system.
494
3.7.10.9 Customize quota and restrictions

You can configure the quota and restrictions for your document storage.
Prerequisite
Procedure
Configuration view.
4. Click Quota and restrictions.
5. Click Edit.
7. Click Save.
You have configured the quota and restrictions for your document storage.
3.7.10.10 Configure full-text search

You can customize the settings for the full-text search in your document storage.
Prerequisite
Procedure
Configuration view.
4. Click Full-text search.
5. Click Edit.
Properties that are highlighted as cross-tenant properties ( ) can only be changed using
ARIS Cloud Controller Command-line Tool (ACC). To change these settings enter the
following:
reconfigure adsadmin_<size of your installation, s, m, or l> JAVA-D<property
name>="<value>"
Example
495
reconfigure adsadmin_m JAVA-Dcom.aris.ads.thumbnails.queue.size="40"

7. Click Save.
You have customized the settings for the full-text search in your document storage.
3.7.10.11 Configure WebDAV

You can display the WebDAV (page 1158) settings in your document storage.
Prerequisite
Procedure
Configuration view.
4. Click WebDAV.
5. Click Edit.
7. Click Save.
The Cross-tenant symbol indicates that the settings made apply to all tenants on this
server and cannot be changed.
496
3.8 Manage portal

By default, ARIS provides the classic configuration set and the default configuration set as
examples. Using these as a basis, you can define modification sets to customize how data is
displayed.
3.8.1 Publish databases

Publish the databases you want to make available under Published content. There, users
with a Viewer or Designer license can access the fact sheets (page 1130) of the models and
objects of the databases.
To start executables and download SAP documents, or to have the ARIS Online Guide
available, you must import (page 679) the SAP-related configuration sets for the portal and
publish the database in Published content (page 497).
Prerequisite
 You have the Publishing administrator function privilege.
Procedure
2. Click Portal > Publish databases if it is not already selected. The Configuration tab
displays the Publish databases area. All available databases are displayed.
3. Enable the check boxes of the databases you want to publish in Published content.
4. For versioned databases, select the relevant version.
5. Click Apply.
The content of the databases is published in Published content in the selected configuration
or modification set (page 504). If databases are available in Published content they cannot
be deleted in ARIS.
497
3.8.2 Change sort order of published databases

You can sort published databases that are offered by the process portal.
Prerequisite
You have the Publishing administrator function privilege.
Procedure
Configuration view.
2. Click Portal > Publish databases on the Configuration tab. All available databases are
displayed. The check boxes of published databases are enabled. If you want to publish
further databases to be shown in the process portal, enable the check boxes of these
databases. (page 497)
3. Position the mouse pointer over the row of the database you want to move. The move
symbols are displayed.
4. Click Move up to shift the database one row up.
5. Click Move down to shift the database one row down.
6. Click Move to top to shift the database to the top of the database list.
7. Click Apply.
You have changed the sort order of the published databases. The published database at the
top of the list is the default database (page 498).
3.8.3 Specify a default database

You can specify which database to use for a user who has not yet selected a database for
work with.
Prerequisite
You have the Publishing administrator function privilege.
Procedure
1. Click your initials. The user menu opens.
2. Click Administration. The Configuration tab displays the Publish databases area.
All available databases are displayed. The check boxes of published databases are
enabled. If you want to publish (page 497) further databases to be shown in the process
portal, enable the check boxes of these databases.
498
3. Move the mouse pointer over the row of the published database for which you want to
define as the default database. The move symbols are displayed.
4. Click Move to top to shift the database to the top of the database list.
5. Click Apply.
You have defined the default database.
3.8.4 Allow model comparison

You can allow model comparison of versions of a database or of models between different
databases.
IN A DATABASE
You can specify that models can be compared with a version. That is valid for versionable
databases that have been published and contain versions.
Prerequisite
 The database in use is versionable and contains versions.
Procedure
enabled.
allow model comparison. The Allow model comparison symbol is displayed.
4. Click Allow model comparison. The Select comparison database dialog is opened.
5. Leave the Comparison enabled check box enabled.
6. Click the Version field and select the version to use for model comparison.
7. Click Save.
You have defined version models with which the current models of the database can be
compared. The Allow model comparison symbol of the database is colored and users can
compare the model versions in the fact sheet Diagram.
499
BETWEEN DATABASES
You can specify that models of different databases can be compared. That is valid for
versionable databases that contains at least one version.
Prerequisite
 The database in use is versionable and contains versions.
Procedure
enabled.
allow model comparison. The Allow model comparison symbol is displayed.
4. Click Allow model comparison. The Select comparison database dialog is opened.
5. Click the Database field and select the database to use for model comparison.
6. Click the Version field and select the version to use for model comparison.
7. Click Save.
You have defined with which version models of which database the current models of the
current database can be compared. The Allow model comparison symbol of the database
is colored and users can compare the model versions in the fact sheet Diagram.
500
3.9 Configure the user interface

By default, ARIS provides the classic configuration set and the default configuration set as
examples. Using these as basis, you can define modification sets to customize how data is
displayed in the portal. You can either specify item types in the modification sets (page 554)
or specify item types in the content type configuration (page 684).
It is recommended to save the customized modification set once it is finished. After a
software update, you can restore the customized modification set to restore the look and feel
of the portal.
3.9.1 Create modification set

You can create (page 501) your own modification sets based on the classic configuration set,
on the default configuration set or based on a user-defined configuration set. To start
executables and download SAP documents, or to have the ARIS Online Guide available, you
must import (page 679) the SAP-related configuration sets for the portal and publish the
database in Published content (page 497). If you require additional user-defined
configuration sets, please contact your local Software AG sales organization
(http://www.softwareag.com).
Prerequisite
You have the Portal administrator function privilege.
Procedure
Configuration view.
2. Click Portal > Manage configuration sets. All available configuration and modification
sets are displayed.
3. Click Create in the Configuration and modification sets area. The Create modification
set dialog opens.
4. Enter the name for the new modification set.
5. In the Template box, select the configuration set that your new modification set is to be
based on.
6. Click Create.
The modification set is created. It contains all elements from the selected template.
Change (page 505) the new modification set by adding the required items, properties, and
fact sheets, or by adapting existing ones.
501
To delete the modification set, move the mouse pointer over the relevant modification set and
click Delete. Click Delete to confirm. The configurations of deleted modification sets will
be lost.
3.9.2 Duplicate modification set

on the default configuration set or based on a user-defined configuration set. If you require a
user-defined configuration set, please contact your local Software AG sales organization
Prerequisite
Procedure
Configuration view.
sets are displayed.
3. Move the mouse pointer over a user-defined modification set.
4. Click Duplicate.
The modification set is created with a technical name. It contains all elements from the
selected modification set. You can rename (page 505) the modification set.
502
3.9.3 Save ARIS modification set

Save user-defined modification sets (page 501) for data migration or before you modify them.
You can restore saved modification sets at any time or provide them on other servers.
Prerequisite
Procedure
Configuration view.
sets are displayed.
4. Click Backup.
5. Save the file in any directory.
The <name of the modification set>.zip backup file is downloaded.
Based on this backup, you can restore this version of the modification set (page 503).
3.9.4 Restore ARIS modification set

Restore saved modification sets (page 503).
Prerequisite
 You have the Portal administrator function privilege.
 You have access to the backup file.
Procedure
Configuration view.
sets are displayed.
3. Click Restore. The file selection dialog opens.
4. Double-click the ZIP file (syntax: <name of the modification set>.zip).
If a modification set with the same name exists, it is overwritten. If you want to keep the
original modification set, you must define another name before the import (page 505).
503
3.9.5 Select modification set

Select the modification set to show the portal data. By default, ARIS provides the classic
configuration set and the default configuration set. If required, user-defined modification
sets (page 501) and restored modification sets (page 503) are also displayed here.
on the default configuration set or based on a user-defined configuration set. If you require
further modification sets, please contact your local Software AG sales organization
Prerequisite
Procedure
Configuration view.
sets are displayed.
4. Click Activate.
The selected configuration or modification set is marked as (active).
All of the databases selected for the portal are published in the configuration or modification
set selected.
504
3.9.6 Rename modification set

Change the names of modification sets.
Prerequisite
Procedure
Configuration view.
sets are displayed.
4. Click Rename. The Rename modification set dialog opens.

5. Enter the new name.
6. Click Rename.
All of the databases selected for the portal are published in the configuration or modification
set selected.
3.9.7 Edit modification set

Edit your modification sets created based, for example, on the classic configuration set or the
default configuration set. The provided configuration sets Classic and Default cannot be
edited.
Prerequisite
 You have created (page 501) your own modification (page 1145) set.
Procedure
Configuration view.
sets are displayed. You can edit the modification sets (page 501).
3. Click Edit in the row of the relevant modification set.

The Define modification set page opens and you can edit the modification set.
505
3.9.7.1 Edit user interface

As a portal administrator, you customize the user interface.
3.9.7.1.1 Customize font and colors

Customize the font and colors to match the corporate brand of your company.
Prerequisite
Procedure
Configuration view.

4. Click User interface.
5. Click Customize font and color.
6. Scroll to Basic settings.
7. Specify the required settings.

The changes are applied. The page is refreshed if the modification set was specified as
active.
506
Example
Default font and colors:
507
Customized font and color:
508
3.9.7.1.2 Restore default font and color

You can undo all font, color, and logo settings you have specified.
Prerequisite
Procedure
Configuration view.

5. Click Customize font and color.
7. Click Restore defaults.

The default settings are loaded. The page is refreshed if the modification set was specified as
active.
509
3.9.7.1.3 Select languages

Customize the languages to follow the requirements of your company.
Prerequisite
 The selected languages are available as the interface, method, and database language
(page 869).
Procedure
Configuration view.

5. Click Select language.
6. In the Current language list, select the languages you do not require, and then click
Deactivate. The languages are added to the More languages list.
7. In the More languages list, select the languages you require, and then click Activate.
The languages are added to the Current language list.
8. Click Apply.

The activated languages are available for selection by ARIS users.
510
3.9.7.1.4 Upload logo

Select the graphics file you want to display as the logo.
Prerequisite
 You have access to a graphic file in PNG format.
Procedure
Configuration view.

5. Click Insert logo.
6. Click Browse next to the Logo field and navigate to the required logo file. You can upload
SVG and PNG files.
7. Click Open.
The graphic is uploaded. It is shown in the header of ARIS portal.
511
3.9.7.1.5 Restore default logo

You can undo all font, color, and logo settings you have specified.
Prerequisite
Procedure
Configuration view.

5. Click Insert logo.
6. Click Restore defaults.
The default logo is loaded and the page is refreshed.
3.9.7.1.6 Customize the header

You can customize the header background color, as well as text and highlighting color.
Prerequisite
Procedure
Configuration view.

6. In the Basic settings section, customize the header background color, and text and
highlighting color.
512
You have changed the header.
Example
Default header:
Header with green background, light yellow highlighting and yellow ochre text:
3.9.7.1.7 Customize the sidebars

You can customize the background color of the sidebars.
Prerequisite
Procedure
Configuration view.

6. Click the color indicated in the Color for sidebar background line. Customize the sidebar
background color .
7. Click OK.

You have changed the left and right sidebar.
513
Example
Default sidebar:
Sidebar with light blue background:
514
3.9.7.1.8 Advanced customization
3.9.7.1.8.1 Customize 'Home' elements

You can customize the elements of the Home page.
Prerequisite
Procedure
Configuration view.

5. Click Show advanced settings.
6. Scroll down to Home elements (Quick start, Contact).
7. Customize the background color and the tile size, color, and font color.

You have customized the Home page of ARIS.
Example
Default Home page:
515
Customized Home page:
3.9.7.1.8.2 Customize Fact sheets (Overview, Steps)

You can customize fact sheets, such as Overview and Steps.
Prerequisite
You have created (page 501) your own modification (page 1145) set.
Procedure
Configuration view.

6. Scroll down to Fact sheets (Overview, Steps).
7. Customize the colors and font sizes.

You have customized the fact sheets of ARIS.
516
Example
Default Overview fact sheet:
Custom Overview fact sheet:
517
3.9.7.1.8.3 Customize 'Steps'

You can customize the Steps fact sheet.
Prerequisite
Procedure
Configuration view.

6. Scroll down to Steps.
7. Customize the colors, box sizes, and font sizes.

You have customized the Steps.
Example
Default Steps fact sheet:
518
Custom Steps fact sheet:
519
3.9.7.1.8.4 Customize buttons

You can customize the buttons.
Prerequisite
Procedure
Configuration view.

6. In the Buttons (for example, Save or Cancel) section, customize the button colors and
shapes.
You have changed the button colors and shapes.
Example
Default buttons:
Customized buttons:
520
3.9.7.1.8.5 Customize font sizes in general

You can customize the general font sizes.
Prerequisite
Procedure
Configuration view.

6. Scroll down to Font sizes.
7. Customize the font sizes for the different text sizes.
You have customized the font sizes in general.
521
3.9.7.1.8.6 Customize ARIS Process Board

You can customize the logo, as well as the logo height and width of ARIS Process Board.
Prerequisite
Procedure
1. Copy the new logo to <installation
directory>\server\bin\work\work_apg_s\base\webapps\processboard\tasklist,
for example,
C:\SoftwareAG\ARIS10\server\bin\work\work_apg_s\base\webapps\processboa
rd\tasklist.
Configuration view.

7. Scroll down to Process Governance.
8. Enter the file name of the new logo.
9. Enter the height of the new logo in pixels.
10. Enter the width of the new logo in pixels.
11. Click Save.
You have changed the logo of ARIS Process Board.
522
3.9.7.1.8.7 Customize Legacy settings

You can customize the operation border and the color for highlighting on the header tab for
older modification sets. These settings are no longer used in the current ARIS version.
Prerequisite
Procedure
Configuration view.

6. Scroll down to Legacy settings.
7. Customize the operation borders and the color for highlighting on the header tab.
You have customized the legacy settings.
523
3.9.7.2 Manage Fact sheets

Manage fact sheets for your own modification (page 501) set.
3.9.7.2.1 Define layout

For new items (page 555) to be displayed you need to define the position on the overview
page where the content is to be shown in the fact sheet.
Prerequisite
Procedure
Configuration view.

4. Click Fact sheets on the Define modification set page. All items available for fact
sheets are displayed.
5. Move the mouse pointer over the item you want to change the overview page for, for
example, Process.
6. Click Edit. The Edit fact sheet page opens. All subordinate sheets are listed.
7. Ensure that an overview page is available. If this is not the case, click Add and select
Overview.
8. Move the mouse pointer over the Overview entry.
9. Click Edit. The Edit subordinate sheet page opens. The items of the different areas
are displayed.
If the overview belongs to an item that is in the package and the overview has not yet
been edited, the System layout is enabled.
10. Select the layout of the page. This enables you to specify how the content of the areas is
to be arranged.
11. Click Add in the areas and select the property to be displayed in the relevant area.
If a property of the ItemList type is displayed in an area, this property can be edited
(page 536).
12. Click Delete to delete entries.
524

The new modification set is created and adjusted.
For the portal to be displayed with this modification set, you need to select (page 504) the
new modification set for display.
3.9.7.2.2 Add fact sheet

You can add a fact sheet.
Prerequisite
Procedure
Configuration view.

4. Click Fact sheets on the Define modification set page.
5. Click Add fact sheet. The Create fact sheet dialog opens.
6. In the Source box, enter the name of the item for which information is to be displayed on
this fact sheet. You can use only items that have not yet been assigned to another fact
sheet.
7. Click Create. The fact sheet is created. It includes an overview page by default. The
selected item is added to the list. As long as no more item properties are assigned to this
page, only the name of the item is displayed in the title bar. The overview itself is empty.

The changes are available to users in the portal. To test the changed modification set, select
(page 504) it for publishing.
To delete the factsheet, click Delete. and click Delete to confirm the deletion.
525
3.9.7.2.3 Add fact sheet for a new item

You can add a fact sheet for a new item.
Prerequisite
 You have created (page 555) a new item.
Procedure
Configuration view.

5. Click Add fact sheet. The Create fact sheet dialog opens.
6. In the Source box, enter the name of new item (page 555) for which information is to be
displayed on this fact sheet.
7. Click Create. The fact sheet is created. It includes an overview page by default. The
selected item is added to the list. As long as no more item properties are assigned to this
page, only the name of the item is displayed in the title bar. The overview itself is empty.

3.9.7.2.4 Change order of fact sheets globally

You can change the order of fact sheets globally.
Prerequisite
Procedure
Configuration view.
526

5. Select an item
6. Move the mouse cursor over the fact sheet you want to move.
7. If you want to change the order of a fact sheet, click Up or Down.
If you want to move a fact sheet to the top, click Top.

new modification set for display. If you change the order in a specific fact sheet (page 534),
this configuration overwrites the globally defined order of the subordinate fact sheets.
3.9.7.2.5 Change order of fact sheets for an item

You can change the order of fact sheets for an item.
Prerequisite
Procedure
Configuration view.

5. Move the mouse pointer over the item you want to change, for example, Process.
6. Click Edit. The Edit fact sheet page opens. All subordinate pages shown on the fact
sheet are listed.
7. Click Edit in the Dashboards row. Move the mouse cursor over Dashboards and click
Edit.
8. Move the mouse cursor over the dashboard you want to move.
9. If you want to change the order of a dashboard, click Up or Down.
527
If you want to move a dashboard to the top, click Top.

new modification set for display. If you change the order in a specific dashboard, this
configuration overwrites the globally (page 526) defined order of the dashboards. If
dashboards are also specified for a component, they are grouped and displayed in the order
specified.
3.9.7.2.6 Delete fact sheet

You can delete a fact sheet.
Prerequisite
Procedure
Configuration view.

4. Move the mouse cursor over the fact sheet you want to delete.
5. Click Delete. A confirmation prompt is displayed.

6. Click Delete.
The fact sheet and its overview page is deleted.
528
3.9.7.2.7 Edit fact sheet

You can edit fact sheets.
Prerequisite
Procedure
Configuration view.

5. Move the mouse pointer to the item you want to change, for example, Process.
sheet are listed.
7. Click Add. The Add subordinate sheet dialog opens. All pages you can add are displayed.
Typically, the pages Overview, Steps, Table, RACI, Diagram, Tasks, Documents, and
Dashboards of ARIS Aware are offered.
8. Select an entry and click Add.
9. Specify the contents to be displayed in the fact sheet.

529
3.9.7.2.7.1 Customize fonts and colors

You can customize fact sheets, such as Overview and Steps.
Prerequisite
Procedure
Configuration view.

6. Scroll down to Fact sheets (Overview, Steps).
7. Customize the colors and font sizes.

You have customized the fact sheets of ARIS.
Example
Default Overview fact sheet:
530
Custom Overview fact sheet:
3.9.7.2.7.2 Customize icons and text

You can customize the elements of the Home page.
Prerequisite
Procedure
Configuration view.

6. Scroll down to Home elements (Quick start, Contact).
7. Customize the background color and the tile size, color, and font color.

You have customized the Home page of ARIS.
531
Example
Default Home page:
Customized Home page:
532
3.9.7.2.7.3 Enable/Disable toolbars for a fact sheet

You can enable or disable toolbars for a fact sheet
Prerequisite
Procedure
Configuration view.

6. Click Edit. The Edit fact sheet page opens.

7. Click Toolbars.
8. Enable/Disable the toolbars to be displayed on the fact sheet.
3.9.7.2.7.4 Add a subordinate sheet to a fact sheet

You can add a subordinate sheet to a fact sheet.
Prerequisite
Procedure
Configuration view.

533
sheet are listed.
7. Click Add.
8. Select a subordinate sheet from the list.
9. Click Add.

3.9.7.2.7.5 Change order of the subordinate sheets

You can the change the order of subordinate sheets.
Prerequisite
Procedure
Configuration view.

sheet are listed.
7. Move the mouse cursor over a subordinate sheet you want to move.
8. If you want to change the order of a subordinate sheet, click Up or Down.
If you want to move a subordinate sheet to the top, click Top.

new modification set for display. This configuration overwrites the globally defined order
(page 526) of the subordinate fact sheets.
534
3.9.7.2.7.6 Remove a subordinate sheet from a fact sheet

You can remove a subordinate sheet from a fact sheet.
Prerequisite
Procedure
Configuration view.

sheet are listed.
7. Move the mouse pointer to the subordinate sheet you want to remove, for example,
Overview.
8. Click Delete.

535
3.9.7.2.7.7 Edit a property of ItemList type of the

Overview tab
You can edit a property of the ItemList type of the Overview tab.
Prerequisite
Procedure
Configuration view.

sheet are listed.
7. In the row of an item of the Overview item, click Edit. If the overview belongs to an
item that is in the package and the overview has not yet been edited, the System layout
is activated, which cannot be changed.
8. Select a custom layout. If you keep the System layout, the properties cannot be changed.
9. Move the mouse pointer over the relevant item of the ItemList type and click Edit.
10. Select a custom layout.
The Table option displays the items in a table. The first row in the table displays the item
name. You can configure the display of additional properties. These appear as additional
rows.
The List option displays the items that were previously shown in a table or an embedded
page as a simple list. In the overview, all properties except the item name are hidden. If
you have selected the List option and activated the modification set, you cannot switch
back to the table modification set.

536
3.9.7.2.7.8 Edit a property for a single value of the

Overview tab
You can edit a property for a single value of the Overview tab.
Prerequisite
Procedure
Configuration view.

sheet are listed.
7. In the row of an item of the Overview item, click Edit. If the overview belongs to an
item that is in the package and the overview has not yet been edited, the System layout
is activated, which cannot be changed.
9. Move the mouse pointer over a property that contains a single value and click Edit.
The Select property template page is displayed.
10. Enable the Custom layout. If you keep the System layout, the properties cannot be
changed.
11. Select a template from the Template list.
12. Optional: Select the label position from the list.
13. Optional: Click Browse to select an icon. The icon is displayed in front of the label.

The preview is displayed in the Preview area. For the portal to be displayed with this
modification set, you need to select (page 504) the new modification set for display.
To remove the icon from the property, click Remove.
537
3.9.7.2.7.9 What can be configured in fact sheets?

Using fact sheets, you configure how the pages are displayed that open when you click a
process in the navigation. The fact sheet for a process includes the subordinate pages you
defined in the fact sheet configuration (page 525).
Example
The subordinate pages shown are configured for a process:
The result of configuring the fact sheet for a process looks like this:
538
3.9.7.2.7.10 Dashboards
You find all information about configuration and use of dashboards in the ARIS Aware
chapter.
3.9.7.2.7.11 Mini fact sheets

You can specify mini fact sheets globally for fact sheets.
3.9.7.2.7.11.1 Enable mini fact sheets

You can enable mini fact sheet for an object.
Prerequisite
Procedure
Configuration view.

5. Move the mouse pointer over the item you want to change, for example, Function.
sheet are listed.
7. Click Mini fact sheet.
8. Enable Enable mini fact sheets.

You have enabled the mini fact sheet for an item.
539
3.9.7.2.7.11.2 Customize display options and properties

You can customize the mini fact sheet for objects.
Prerequisite
Procedure
Configuration view.

sheet are listed.
9. Move the mouse pointer over the relevant property and click Edit.
10. Select a custom property template. If you keep the System template, the properties
cannot be changed.
To add a new property group, click Add group. The Select group property template
page is displayed. Adjust your settings. Click Back. The Application management
page is displayed.

You have customized the mini fact sheet of these objects.
540
3.9.7.2.7.11.3 Change property order for mini fact sheets

You can change the order of the mini fact sheets for objects.
Prerequisite
Procedure
Configuration view.

sheet are listed.
9. Move the mouse cursor over the property you want to move.
10. If you want to change the order of a property, click Up or Down.
If you want to move a property to the top, click Top.

You have changed the order of the mini fact sheets of these objects.
541
3.9.7.2.7.11.4 Delete property from mini fact sheet

You can delete a property from a mini fact sheet of an object.
Prerequisite
Procedure
Configuration view.

sheet are listed.
9. Move the mouse cursor over the property you want to delete.
10. Click Delete.

You have deleted a property from a mini fact sheets of this object.
542
3.9.7.3 Edit 'Home'

Customize the start page (Home) of the portal. The picture shows the default look and feel of
Home.
543
3.9.7.3.1 Edit the background

Define your own layout for Home. You can select layouts with one, two, or three columns.
Prerequisite
Procedure
Configuration view.

4. Click Home.
The components that are initially displayed in the Home view are displayed.
5. Click Edit background.

6. Click Change image to customize the background image. The dialog opens.
a. Select the image you want to use.
b. From the Arrangement list, select Repeat if the image should be repeated to fill the
screen. If you want to extend the image to the screen size, select Fill screen.
If you want to configure a background without an image, click Color and select the color
or enter the color values.
7. Click Save.
The changes are displayed. This is only a preview to check how the customization looks like.
The changes are effective to other users as soon as you activate (page 504) the modification
set.
544
3.9.7.3.2 Add 'My contacts' component

Define your own layout for Home. You can add contacts to list all users of the current ARIS
server with User administrator function privileges.
Prerequisite
Procedure
Configuration view.

4. Click Home.
5. Click Add Component.

6. Select My contacts.
The contacts are now displayed on the preview of the Home page. You can change the size
by dragging the border. And you can position Diagram by drag and drop. The changes are
effective to other users as soon as you activate (page 504) the modification set.
545
3.9.7.3.3 Add 'Diagram' component

Define your own layout for Home. You can specify a diagram to be displayed as a start model
on Home.
Prerequisite
 You have copied the item identifier (page 554) to the clipboard.
Procedure
Configuration view.

4. Click Home.

6. Select Diagram. Diagram is inserted on the preview of the Home page. You can change
the size by dragging the border. And you can position Diagram by drag and drop.
7. Click the inserted Diagram component.
8. Click Edit. The Edit diagram dialog opens.

9. Specify the name of the Diagram component in the various languages. The name is
displayed as header of the Diagram component. You can display more languages. The
entered name is displayed as header of the component.
10. Click Add to specify a start model for the Home page. You can specify one start
model per database.
11. Select the database for which you want to add the start model.
12. Start typing the name of the model you want to specify as start model. All matching
models are displayed.
13. Select the model you want to specify as start model.
14. Click Save.
For this modification set, the diagram is displayed as start model of the database in Home.
546
3.9.7.3.4 Add 'Recent changes' component

Define your own layout for Home. You can create a Recent changes area. You can also
define another name for this area. Moreover, the languages, the number of changes
displayed, and a time interval for changes can also be configured.
Prerequisite
Procedure
Configuration view.

4. Click Home.

6. Select Recent changes.
7. Click Edit. The Edit recent changes dialog opens. Configure the name, the
languages, the number of changes displayed, and a time interval for changes.
8. Click OK.
The recent changes are now displayed on the preview of the Home page. You can change the
size by dragging the border. And you can position Diagram by drag and drop. The changes
are effective to other users as soon as you activate (page 504) the modification set.
547
3.9.7.3.5 Add 'Quick links' component

Define your own layout for Home. You can add Quick links. You can add a quick link that can
start, for example, an app or a web page from the Quick link area of the Home page.
Prerequisite
Procedure
Configuration view.

4. Click Home.

6. Select Quick links. Quick links are now displayed on the preview of the Home page. The
changes are effective to other users as soon as you activate (page 504) the modification
set.
7. Select the component.
8. Click Edit. The Edit 'Quick start' dialog opens.

9. Click New to add a new tile. The Add tile dialog opens
10. Enter the name in the various languages.
11. Enter the URL to which the tile links to. Enter the entire URL in the form
http://<server>:<port>/<app path>.
12. Enable In a new tab to display the tile in a new tab in the browser.
13. Select a symbol as a PNG file for the tile.
14. Click OK.
15. Move the mouse cursor over the row of the tile you want to move.
16. Use the arrows to change the order of the tile.
The configured links are now displayed on the preview of the Home page. You can change the
size by dragging the border. And you can position Diagram by drag and drop. The changes
are effective to other users as soon as you activate (page 504) the modification set.
548
3.9.7.3.6 Add external web page

Define your own layout for Home. You can add an external web page, for example, your
company's home page.
Prerequisite
Procedure
Configuration view.

4. Click Home.

6. Select IFrame.
7. Click Edit. The Edit IFrame dialog opens.

8. Enter the name in the various languages.
9. Enter the entire IFrame URL in the form http://<server>:<port>/<web page>.
10. Click OK.
The configured IFrame item is now displayed on the preview of the Home page. You can
change the size by dragging the border. And you can position Diagram by drag and drop. The
changes are effective to other users as soon as you activate (page 504) the modification set.
549
3.9.7.3.7 Add 'My favorites' component

Define your own layout for Home. You can add My favorites.
Prerequisite
Procedure
Configuration view.

4. Click Home.

6. Select My favorites.
The favorites are now displayed on the preview of the Home page. You can change the size
by dragging the border. And you can position Diagram by drag and drop. The changes are
3.9.7.3.8 Add 'What's new' component

Define your own layout for Home. You can create a What's new area to list information about
changes to models.
Prerequisite
Procedure
Configuration view.

4. Click Home.
550
6. Select What's new.

What's new is now displayed on the preview of the Home page. You can change the size by
dragging the border. And you can position Diagram by drag and drop. The changes are
3.9.7.3.9 Add 'Dashboard' component

Define your own layout for Home. You can specify a dashboard to be displayed on Home.
Prerequisite
Procedure
Configuration view.

4. Click Home.

6. Select Dashboard. Dashboard is inserted on the preview of the Home page. You can
change the size by dragging the border. And you can position Diagram by drag and drop.
7. Click the inserted Dashboard component.
8. Click Edit. The Edit dashboard dialog opens.

9. Select a dashboard from the list. If you use ARIS Process Mining in a combined
deployment with ARIS Enterprise and you have the ARIS Process Mining license, the ARIS
Process Mining analyses are available in the list.
10. Click Save.
For this modification set, the dashboard is displayed in Home.
551
3.9.7.3.10 Edit a component of the 'Home' tab

Define your own layout for Home. You can configure the appearance of Home.
Prerequisite
Procedure
Configuration view.

4. Click Home.
6. Click Edit. The corresponding dialog opens. Proceed as described in the chapter that
describes how to add a specific component.
7. Make your changes.
8. Click OK.
The changed components are now displayed on the preview of the Home page of the
database. The changes are effective to other users as soon as you activate (page 504) the
modification set.
552
3.9.7.3.11 Delete a component from the 'Home' tab

Define your own layout for Home. You can configure the appearance of Home.
Prerequisite
Warning
You cannot restore the Welcome area if you have deleted it.
Procedure
Configuration view.

4. Click Home.
6. Click Delete.
The changed components are now displayed on the preview of the Home page of the
database. The changes are effective to other users as soon as you activate (page 504) the
modification set.
553
3.9.7.4 Manage items

Add and edit items of your custom modification (page 501) set. The provided configuration
sets Classic and Default cannot be edited.
3.9.7.4.1 Find item identifier

You can find item identifiers for diagrams so that diagrams can be displayed on the ARIS
Home page.
Procedure
1. Click Application launcher > Published content.
2. Select the database in which the relevant diagram is stored.
3. Click Groups.
4. Navigate to the required diagram and click it. The model is displayed.
5. In the address bar of your browser, select the part of the URL that starts immediately
after the entry item/ and ends before the next / slash.
6. Copy the selected text to the clipboard by pressing Ctrl + C.
You can use the item identifier of this diagram (page 546) to configure the Home page.
Tip
If you want to configure start models for multiple databases, it is recommended to copy the
various identifiers into a text file, and then copy them into the configuration from there.
Example
554
3.9.7.4.2 Add items

You can add items.
Prerequisite
Procedure
Configuration view.

4. Click Items. All items defined in this modification set for groups, models, and objects are
displayed. You can use these items in fact sheets and define which information is
displayed where.
5. Click Create item. The dialog opens.

6. Enter the technical name of the new item as an identifier, for example, Process diagram.
The identifier must be unique for all content types.
7. For each language, enter the name of the element that it is to be displayed. At least one
language must be maintained.
8. In the Source box, select the type of ARIS item, for example, Object or Model.
9. Enter the object or model type names. All types that you can use are displayed during
input. Types that have already been assigned to other items are not shown.
10. Click an entry. The type is added.
11. Add further types, if necessary.
12. Optional: If you want to specify the default symbol, click Show advanced settings. Add
further default symbols, if necessary.
13. Click Create. The item is displayed in the list.

15. To test the changed modification set, activate (page 504) it.
As soon as a fact sheet has been configured (page 525), the changes are available to all users
of the portal.
The new item is displayed in the Search area.
555
3.9.7.4.3 Edit items

You can edit items.
Prerequisite
Procedure
Configuration view.

displayed. You can use these items in fact sheets and thus define which information is
displayed where.
6. Click Edit. The Edit item page opens.
Identifier, name, type, and ARIS items are shown on the overview page of the Process
item. In this example these are various model types whose information for the Process
item is displayed in the portal. They are model types for representing business processes.
7. Click Edit. The Edit item dialog opens.
8. If required, change the name displayed in the portal in all languages, for
example, Process to Business process.
9. Click OK. The changes are applied and the dialog closes.
10. Next to the ARIS items box, click Add. The Add ARIS item dialog opens.
11. Add more items from ARIS. In the Process example, you can select model types that have
not been used for the Process item yet.
12. Click Add. The model list is completed and the dialog closes.
13. Click Delete to delete entries.

14. Optional: If you want to specify the default symbol, click Show advanced settings. Add
further default symbols, if necessary.
15. Click Back.

16. To test the changed modification set, select (page 504) it for publishing.
556
3.9.7.4.4 Add item properties

Item properties determine the information available and displayable for the item in the portal.
You can edit custom properties.
You can allow users who have both the ARIS Viewer and the Contribution license privileges
to edit certain properties. This is also possible for properties that have already been defined in
the selected template of the modification set.
Prerequisite
Procedure
Configuration view.

displayed where.

7. Click Properties. All properties of the item that can be displayed in the portal are listed.
8. Click Create property. The corresponding dialog opens.

9. Enter the technical name of the new property as an identifier.
10. For each language enter the name of the property that it is to be displayed with in the
portal. Always specify the name in English as well because English is used as the default
language if a language is missing.
11. In the Data mapping box, select the type of ARIS item whose information is to be
available. This depends on the type of item for which you are defining the property.
12. For models you can select Attributes, Occurrence contained, or Related assigned
models, while you can select Attributes, Related objects, or Object to object for
objects. If you select Attribute and the attribute type, for example, Description, the
descriptive texts for objects or models are searched and provided. For Connected
objects, select connection and object type. This finds all objects associated with an
object. Occurrences contained provides all objects of a model.
557
13. Specify the settings described depending on the item type.

14. Click Create. The new property is displayed in the table.
15. In order to be able to test the changed property, it must first be assigned to an area in a
fact sheet. To test the changed modification set, select it for publishing.
The changes are available to users in the portal.
3.9.7.4.5 Edit item properties

Item properties determine the information available and displayable for the item in the portal.
You can edit the properties.
to edit certain properties. This is also possible for properties that have already been defined in
the selected template of the modification set.
Prerequisite
Procedure
Configuration view.

displayed where.

7. Click Properties. All properties of the item that can be displayed in the portal are listed.
8. Move the mouse pointer to the property you want to change, for example, Process.
9. Click Edit.
10. For each language enter the name of the property that it is to be displayed with in the
portal. Always specify the name in English as well because English is used as the default
language if a language is missing.
558
11. In the Data mapping box, select the type of ARIS item whose information is to be
available. This depends on the type of item for which you are defining the property.
12. For models you can select Attributes, Occurrence contained, or Related assigned
models, while you can select Attributes, Related objects, or Object to object for
objects. If you select Attribute and the attribute type, for example, Description, the
descriptive texts for objects or models are searched and provided. For Connected
objects, select connection and object type. This finds all objects associated with an
object. Occurrences contained provides all objects of a model.
13. Specify the settings described depending on the item type.
14. Click OK.

16. In order to be able to test the changed property, it must first be assigned to an area in a
fact sheet. To test the changed modification set, select it for publishing.
The changes are available to users in the portal.
3.9.7.4.6 Property templates

There are four different templates for properties:
 Text (value_meta_text)
This template is used for attribute values that consists of text.
 E-Mail (value_meta_email)
This template is used for attribute values that consists of text.
 Link (value_meta_link)
This template is used for attribute values that are links.
 Image (value_meta_image)
This template is used for attribute values that are images or links to images.
You can configure a label and/or an icon for each template can. The icon is displayed in front
of the label.
559
3.9.7.4.7 Allow Connect Viewer users to edit

along with the corresponding access privileges to edit item properties that represent
attribute values in the Published content view.
Prerequisite
Procedure
Configuration view.

displayed where.
7. Click Properties. All properties of the item that can be displayed in the Published
content view are listed.
8. Move the mouse pointer to the property you want to edit.
9. Click Edit. The Edit property dialog opens.
10. Enable Editing allowed.
560
11. Click OK.

13. To test the changed modification set, activate (page 504) it.
Users who have both the ARIS Viewer and the Contribution license privileges can edit the
item.
561
3.9.7.4.8 ARIS Viewer Contribution

If you have both the ARIS Viewer and Contribution license privilege, you can change items
and values for the following predefined items in the Published content view. 'Predefined'
means that these items and their values were configured to be editable in the program by
default.
This means that not all items of the following model and object types can be changed. Only
those can be changed that were designed to be editable by the underlying concept and were
set up accordingly by the configuration.
Please note that this is a sample configuration, which means that other items may have been
configured to be editable in your installation.
MODEL TYPES
 Application system type diagram
 BPMN collaboration diagram (BPMN 2.0)
 Business controls diagram
 EPC
 Function allocation diagram
 Risk diagram
 KPI allocation diagram
OBJECT TYPES
 Application system class
562
 Cluster/Data model
 Entity type
 Event
 Technical term
 Function
 Information carrier
 KPI instance
 Class
 Lane
 List
 Message
 Participant
 Person
 Risk
 Risk category
 Role
 Location
 Position
 Control test definition
ATTRIBUTES
ARIS Viewer Contribution enables you to edit attributes that are based on the following base
types:
 Boolean
 Value
 Floating point number domain
 Integer domain
 Floating point number
 Integer
 Date
 One-liner
563
 Multi-line text
 Link/File
Text formatting is ignored and cannot be assigned. If you are expected to enter numbers, the
field is colored red if you do not enter a numerical value.
Please note that Binary Large Object (BLOB) and combined attributes are not supported.
3.9.7.5 Manage plugins

A plugin is a software extension or an optional module that adds functionality to ARIS. Plugins
cannot run without the main software they are integrated in.
As a ARIS administrator, you customize the plugins. If you want to use plugins in the portal,
you need extended configuration sets with plugins enabled that you cannot configure in ARIS
Administration, please contact your local Software AG sales organization
Plugins used together with ARIS must be written in Java Script and must have a valid
signature. This signature is generated by Software AG and must be copied to the server.
3.9.7.5.1 Activate a plugin

You can activate a plugin predefined in a configuration set.
Prerequisite
 You have a customized configuration that allows plugins.
 You have created a customized modification (page 501) set based on the customized
configuration set that allows plugins.
Procedure
1. Open a user-defined modification set that allows plugins for editing.
2. Edit your modification sets created based, for example, on the classic configuration set or
the default configuration set. The provided configuration sets Classic and Default
cannot be edited.
Prerequisite
564
Procedure
Configuration view.

The Define modification set page opens and you can edit the modification set.
1. Click Plugins on the Define modification set page.
2. Click Activate.
The plugin is active. The configuration set (page 866) defines the view in which the plugin is
displayed.
Click Deactivate to deactivate a plugin.
3.9.7.5.2 States for plugins

A plugin can have the following states:
 Active
The plugin can be used.
 Disabled
The plugin was manually disabled.
 Development
Either the plugin has no signature yet, or an incorrect signature was applied less than two
weeks ago and needs to be adjusted.
 Invalid
Either the plugin has no signature yet, or an incorrect signature was applied more than
two weeks ago and can no longer be adjusted.
565
3.9.7.6 Manage hierarchies

Define your own navigation options for the portal. You can use hierarchies (page 570) to
control how portal users can quickly navigate to relevant information. These hierarchies map
the relationships between superior and subordinate item types.
3.9.7.6.1 Create navigation hierarchy

You can define your own hierarchies for each user-defined modification set.
Prerequisite
 If you want to use a root element (page 573), the GUID or the item ID of the root element
must be available on the clipboard.
Procedure
Configuration view.

4. Click Hierarchies on the Define modification set page.
All hierarchies defined in this modification set for navigation are displayed. By default,
these are the hierarchies from the template from which the user-defined modification set
was derived, for example, Processes, Organizations, IT systems, or Groups. You can
activate or deactivate these hierarchies marked with system, or change the order in
which they are displayed in the portal.
Unused hierarchies are shown in strikethrough formatting and are not displayed in the
portal.
5. Click Create. The corresponding dialog opens.
6. Specify the name for the hierarchy to be displayed in the portal in all languages. This
name is shown in the portal as another navigation option. If the name is not specified in a
language, it is displayed in English in the portal.
7. Click Next. The Create hierarchy – Specify hierarchy structure page opens.
8. Click Select item. All items that are defined in the modification set are displayed.
9. Select the first item. The item is inserted.
566
10. Move the mouse pointer over the item and click Add.
11. Click Select item/property and select an entry. The second item must be of the same
type as the first item. If it is not, a hierarchy cannot be created. The selected property or
the item is made subordinate without space. The name of the property of the subordinate
item is shown in parentheses.
12. Add further items in the same manner. The hierarchy is symbolized by indents.
13. Click Finish if you do not want to insert a root element (page 573). Otherwise, click Next
to insert a root element.
a. Click Add. The Specify root element dialog opens.
b. Paste the GUID or item ID from the clipboard.
c. Click OK. The GUID of the item is displayed in the list.
d. Click Finish.
14. Activate (page 568) the hierarchy.
The navigation is available to users in the portal. To test the changed modification set,
activate (page 504) it.
3.9.7.6.2 Edit navigation hierarchy

Use hierarchies to define the navigation in the portal. These hierarchies map the relationships
between superior and subordinate items.
Prerequisite
Procedure
Configuration view.

567
portal.
5. To edit a hierarchy, move the mouse pointer over the row for a deactivated hierarchy and
click Edit.
6. Change the hierarchy.
7. Click Finish.
The changed navigation is available to users in the portal. To test the changed modification
set, activate (page 504) it.
3.9.7.6.3 Enable navigation hierarchy

Prerequisite
Procedure
Configuration view.

portal.
568
5. To display a hierarchy, move the mouse pointer over the row for a deactivated hierarchy
and click Enable.
The Groups hierarchy from the classic configuration set cannot be combined with any
other hierarchy. If the Groups hierarchy is activated, all other hierarchies are
automatically deactivated. If you activate another hierarchy, the Groups hierarchy is
automatically hidden.
The changed navigation is available to users in the portal. To test the changed modification
set, activate (page 504) it.
3.9.7.6.4 Disable navigation hierarchy

Prerequisite
Procedure
Configuration view.

portal.
5. To disable a hierarchy, move the mouse pointer over the row for an activated hierarchy
and click Disable.
The navigation hierarchy is disabled.
569
3.9.7.6.5 Delete navigation hierarchy

Prerequisite
Procedure
Configuration view.

portal.
5. To delete a hierarchy, move the mouse pointer over the row for a deactivated hierarchy
and click Delete.
The navigation hierarchy is deleted.
3.9.7.6.6 What does the navigation hierarchy define?

Using the navigation hierarchy, you define the navigation options for the portal. The example
shows the configuration of the hierarchy for a group.
The second item must be of the same type as the first item. If it is not, a hierarchy cannot be
created. Items of the same type are arranged without space.
570
Example
Subgroups and processes are configured for the group:
The result looks like this in the portal:
571
3.9.7.6.7 What to remember regarding hierarchies?

Hierarchies define the way in which portal users receive relevant information. Hierarchies that
are based on the default template have only one level.
Hierarchies that are based on the classic template have multiple levels, and you can expand
and collapse groups.
From a technical perspective, a hierarchy always has a tree structure and is level-based. A
level can be made up of models, objects, or groups. It may contain a superior item and
multiple subordinate items. In contrast, a level can have multiple subordinate items.
572
You can use multiple hierarchy definitions in a hierarchy configuration. For example, you can
specify the following hierarchy definitions in a configuration:
Navigation in process models (value-added chain diagrams, EPCs, and function allocation
diagrams), navigation in the organization (organizational charts, organizational units, roles,
and groups), and navigation in the IT systems within an organization.
3.9.7.6.8 Hierarchy root element

A root element is the model or object that is used as the top-level element in the hierarchy
(page 566) you have defined. This element is displayed when you open the hierarchy in the
portal.
If you want to use a specific item from an ARIS database as the top-level hierarchy element,
for example, a specific model or object, this must be defined as the root element. You require
the GUID, which you can copy from the Properties dialog for the model or object in ARIS
Architect, for example.
3.9.7.7 Edit components

You can configure global settings for certain components, for example, diagrams or steps for
a specific model.
3.9.7.7.1 Customize diagrams

You can configure global settings for diagrams.
573
3.9.7.7.1.1 Customize name and languages

You can specify the name in different languages.
Prerequisite
Procedure
Configuration view.

4. Click Components on the Define modification set page.
5. Click Edit in the Diagram row. The Edit component dialog opens.
6. If you want to rename the Diagram component, click Edit in the Edit component
property area. The dialog opens.
7. Change the name in the required languages. If you want to maintain more languages,
click Show more languages. Enter the name in the desired languages.
8. Click OK.

You have specified the name in different languages for the Component tab.
3.9.7.7.1.2 Customize display options

You can specify the display options for the Diagram fact sheet.
Prerequisite
574
DIAGRAM GRAPHIC SIZE

Procedure
Configuration view.

6. Scroll to Display options.
7. Disable the Default display settings check box. This enables the subordinated controls
for editing.
8. Enable the relevant option for the diagram graphic size.
If you select Fit to window, the zoom factor is selected such that the entire model is
displayed.
If you select Fit width displays the model so that its full width can be seen.
If you select Fit height displays the model so that its full height can be seen.
If you select Defined size, you define the zoom factorwith which the model is displayed.
You can enter a zoom factor between 1 and 200.
Click Back. The Application management page is displayed.

You have customized the display option of the diagram on the Component tab.
ENABLE/DISABLE THE ASSIGNMENT FILTER

Procedure
Configuration view.

for editing.
575
Enable Filter by hierarchy configuration.

The diagrams show an assignment icon only for objects that have a diagram assigned to them
which can also be accessed via the navigation hierarchy. For example, if a user-defined
hierarchy includes value-added chains and processes only, the assignment icon is not
displayed for functions to which only a model of the Function allocation diagram type is
assigned.
ENABLE/DISABLE THE HIDE NON-CONFIGURED OBJECTS FUNCTIONALITY

Procedure
Configuration view.

for editing.
8. Disable the Hide non-configured objects check box. In this case non-configured objects
are displayed as frames in the models.
Enable the Hide non-configured objects check box. In this case non-configured objects
are not displayed in the models.

You have specified that non-configured objects in models are displayed as empty frames or
are not displayed.
576
Example
Model displayed with Hide non-configured objects functionality disabled:
The same model displayed with Hide non-configured objects functionality enabled:
577
3.9.7.7.1.3 Enable/Disable the Hide non-configured

objects functionality
You can specify that non-configured objects on the Diagram fact sheet are displayed as
empty frames or are not displayed at all. Non configured-objects are objects that are not
contained in the current method filter or are in groups for which the user does not have read
privileges.
Prerequisite
Procedure
Configuration view.

6. Scroll to the Display options area.
for editing.
8. Disable the Hide non-configured objects check box. In this case non-configured objects
are displayed as frames in the models.
Enable the Hide non-configured objects check box. In this case non-configured objects
are not displayed in the models.

You have specified that non-configured objects in models are displayed as empty frames or
are not displayed.
578
Example
Hide non-configured objects functionality disabled:
Hide non-configured objects functionality enabled:
579
3.9.7.7.1.4 Enable/Disable the change view functionality

You can enable or disable the change view functionality.
Prerequisite
Procedure
Configuration view.

6. Scroll to View generation.
7. Configure whether the Change view functionality is enabled. To do so enable Enable
view generation.

You have enabled/disabled the change view functionality of the diagram on the Component
tab.
580
3.9.7.7.1.5 Restore ARIS default settings

You can restore the ARIS default settings for the Diagram fact sheet.
Prerequisite
Procedure
Configuration view.

6. Scroll to Restore default settings.
7. Click Restore default settings. The dialog opens.
8. Confirm the dialog by clicking Restore default settings.

The ARIS default settings for the Diagram fact sheet of the component are restored.
581
3.9.7.7.2 Customize extended search component

You can configure the settings for the extended search.
3.9.7.7.2.1 Add items and properties to filter

You can configure the settings for the extended search.
You can add items and properties to the filter.
Prerequisite
Procedure
Configuration view.

5. Click Edit in the Extended search row. The Edit component page is displayed.
6. In the Specify item filter area, click Edit. The corresponding dialog opens.
7. Under Available filters, enable the items you want to be displayed in the filter list of the
search and click Add. To enable all items, click Add all. You can enter the first characters
in the Enter a search term field to reduce the number of items displayed.
8. Click OK.
9. In the Specify property filter area, click Edit. The corresponding dialog opens.
10. Under Available filters, enable the properties you want to be displayed in the properties
list of the search and click Add. To enable all properties, click Add all. You can enter the
first characters in the Enter a search term field to reduce the number of properties
displayed.
11. Click OK.

You have added items and properties to the filter.
582
3.9.7.7.2.2 Change order of filter items and properties

You can change the order of items or properties of the filter for the extended search.
Prerequisite
Procedure
Configuration view.

6. In the Specify item filter or in the Specify property filter area, click Edit.
7. If you want to change the order of filter items or properties, click Up or Down. If
you want to move a filter item or a property to the top, click Top.

You have changed the order of items or properties of the filter for the extended search.
3.9.7.7.2.3 Remove items and properties from filter

You can remove items and properties from the filter.
Prerequisite
Procedure
Configuration view.
583
6. In the Specify item filter area, click Edit. The corresponding dialog opens.
7. Under Assigned filters, enable the items you want to be removed from the filter list of
the search and click Remove. To disable all items, click Remove all.
8. Click OK.
9. In the Specify property filter area, click Edit. The corresponding dialog opens.
10. Under Assigned filters, enable the properties you want to be removed from the
properties list of the search and click Remove. To disable all properties, click Remove all.
11. Click OK.

You have removed items and properties from the filter.
3.9.7.7.3 Customize mini fact sheets

You can configure mini fact sheets for objects globally. All global settings for mini fact sheets
can be overwritten for single types by the fact sheet settings (page 539).
Prerequisite
Procedure
Configuration view.

5. Click Edit in the Mini fact sheets row. The Mini fact sheets page is displayed.
6. Configure the display options and the properties.

You have configured the mini fact sheets for objects globally.
584
3.9.7.7.3.1 Customize white list for mini fact sheets

You can specify the items for which mini fact sheets should be displayed globally.
Prerequisite
Procedure
Configuration view.

6. Click in the field that contains the items for which mini fact sheets should be displayed.
Enter the name of the item you want to add and click Return.
7. Click Delete on the item you want to remove.

You have customized the white list for mini fact sheets globally.
585
3.9.7.7.3.2 Customize display options and properties

You can specify the default templates and properties of the mini fact sheets globally.
Prerequisite
 You have specified a white list for the mini fact sheet.
Procedure
Configuration view.

7. Move the mouse pointer over the relevant property and click Edit.
8. Select a custom property template. If you keep the System template, the properties
cannot be changed. The properties displayed belong to item type Default object.
9. To add a new property, click Add.
To add a new property group, click Add group. The Select group property template
page is displayed.
10. Adjust your settings. Click Back. The Application management page is displayed.

You have customized the display options and properties globally.
586
3.9.7.7.3.3 Change property order for mini fact sheets

You can change the order of the mini fact sheets globally.
Prerequisite
Procedure
Configuration view.

7. Move the mouse cursor over the property you want to move.
8. If you want to change the order of a property, click Up or Down.
9. If you want to move a property to the top, click Top.

You have changed the order of the mini fact sheets globally.
587
3.9.7.7.3.4 Delete property from mini fact sheet

You can delete a mini fact sheet.
Prerequisite
Procedure
Configuration view.

7. Move the mouse cursor over the property you want to delete.
8. Click Delete.

You have deleted a mini fact sheet.
588
3.9.7.7.3.5 Mini fact sheets

You can enable and customize mini fact sheets for objects. If you hover over an object on the
Diagram fact sheet, they are displayed.
3.9.7.7.4 Customize steps

You can configure global settings for steps.
Prerequisite
Procedure
Configuration view.

5. Click Edit in the Steps row.

6. Click Details. The Edit component page is displayed. Add or delete properties for
processes, functions, and events and define their hierarchy.
7. Optional: Edit the properties of processes, functions, and events.
a. Move the mouse pointer over a property that you want to change.
b. Click Edit. The Select property template page is displayed.

c. Enable the Custom layout. If you keep the System layout, the properties cannot be
changed.
589
d. Select a template from the Template list.

e. Optional: Select the label position from the list.
f. Optional: Click Browse to select an icon. The icon is displayed in front of the label.
g. Click Back. The Application management page is displayed.

You have configured the steps on the Component tab.
3.9.7.7.4.1 Exclude symbols

You can exclude symbols from the Steps fact sheet.
Prerequisite
Procedure
Configuration view.


6. Click Overview. The Excluded symbols page opens.
7. Click Add. The corresponding dialog opens.
8. Enter the first characters of the symbol name and select the symbol.
9. Press Enter.
10. Continue with steps six to remove additional symbols from the Steps fact sheet.
11. Click Add.

You have excluded symbols from the Steps fact sheet.
590
3.9.7.7.4.2 Include excluded symbols again

You can include excluded symbols in the Steps fact sheet.
Prerequisite
Procedure
Configuration view.


6. Click Overview. The Excluded symbols page opens.
7. Move the mouse pointer to the symbol you want to include in the Steps fact sheet again
and click Delete.

You have included symbols in the Steps fact sheet again.
3.9.7.7.4.3 Add group property

You can add a group of independent properties.
Prerequisite
Procedure
Configuration view.
591

6. Click Details. The Edit component page is displayed. Add or delete group properties for
processes, functions and events, and define their hierarchy.
7. Click Add group. The Edit embedded sheet page is displayed.
8. Select a template from the Template list. You can specify different settings depending
on the selected template.
9. Optional: Click Edit group properties to specify the group properties. The corresponding
dialog opens.
10. Enter a name. You can specify the name in multiple languages.
11. Optional: Select the label position from the list.
12. Optional: Click Browse to select an icon. The icon is displayed in front of the label.
13. Click OK.

You have added a group of independent properties to the steps of a component.
3.9.7.7.4.4 Change order of the properties

You can change the order of items or properties of the filter for the extended search.
Prerequisite
Procedure
Configuration view.


6. Click Details. The Edit component page is displayed.
592
7. If you want to change the order of the properties, click Up or Down.

You have changed the order of items or properties of the filter for the extended search.
3.9.7.7.4.5 Customize colors for steps

You can customize the text color.
Prerequisite
Procedure
Configuration view.

6. In the Fact sheets (Overview, Steps) customize the text colors.
7. In the Steps section, customize the colors.
8. Click Save.
You have changed the text color.
593
Example
Default colors on Steps page:
Customized colors on Steps page:
594
3.10 Administrate automated processes

Process administration (page 595) in ARIS provides information and functions pertaining to
automated processes.
ARIS video tutorial
3.10.1 Open process administration

You can perform different actions in process administration and retrieve information.
Prerequisite
You have the Process Governance administrator (page 602) function privilege.
Procedure
2. Click Process administration.

The functions and information of process administration are available.
Depending on whether you select Processes, an executable process, a version, or a process
instance of an executable process, different information and functions are displayed.
ARIS video tutorial

Process administration overview
(http://www.ariscommunity.com/videos/process-administration-aris-connect-overview)
(approx. 4 minutes)
3.10.2 What is 'Process administration' used for

Process administration provides information about executable processes as well as
control and error handling functions (page 602). You need the Process Governance
administrator function privilege.
Warning
595
Depending on the selected process level and menu item, various information and functions
are available.
Process levels
The superordinate menu items display information for all processes. The menu items in the
information area apply only to the selected process.
ARIS video tutorial

(approx. 4 minutes)
Find and correct problems in processes
(http://www.ariscommunity.com/videos/learn-how-find-problems-process-and-correct-pro
cesses) (approx. 4 minutes)
3.10.2.1 What does 'Activities' provide?

Activities are displayed if you have selected a process instance of an executable process. It
displays the activities of the executable process of the BPMN process diagram (BPMN 1.x)
type. To skip (page 619) an activity, move the mouse pointer over the relevant row, and click
Skip activity.
596
3.10.2.2 What does 'Archive' and 'Archive history' provide?

The archived instances (page 612) are listed. Use Show/hide filter to restrict the number
of process instances displayed according to various criteria. You can export the data as a CSV
file ( ).
To unarchive instances, move the mouse pointer over the relevant table row and click
Unarchive selected instances. To permanently delete archived instances, move the mouse
pointer over the relevant table row and click Delete.
To suspend archiving, unarchiving, or deletion, click Suspend in the progress dialog.
Alternatively, you can use the suspend function in Archive history. Please note that
operations that have been already completed are not reverted. Example: An operation is
running to archive ten instances. You suspend the operation after three instances have
already been archived. Only the seven remaining instances are not archived.
To resume the operation, open Archive history, click Resume in the row of the previously
suspended archiving execution. This is also helpful if an operation was suspended
automatically, for example, during a backup.
Click Archive history to display the list of archiving executions (ARCHIVING, UNARCHIVING,
DELETE). You can export the data as a CSV file ( ).
Warning
3.10.2.3 What does 'Assignments' provide?

Assignments display the assigned users for a human task. To delegate (page 626) a human
task, move the mouse pointer over the relevant task, and click Delegate task.
597
3.10.2.4 What does 'Console' provide?

The console can be shown for all processes or for a process instance. The following messages
are displayed:
 Log messages for process instance execution.
 Messages that were generated by the user interface during execution of process
instances (log, server, and user management messages). You can filter the messages by
their severity.
You can export the data as a CSV file ( ).
3.10.2.5 What does 'Context' provide?

The context and the process settings can be displayed for the process version or the process
instance. The execution context determines from which items (database, group, model/object
type, document), in which applications (for example, ARIS), and by which users a governance
process can be started. You must specify the context before generating the executable
process. After this, it can no longer be changed for the generated process version. If no
execution context is defined, the governance process can be started for all items (Without
context option). The defined execution context is displayed in Process administration.
The context selected for the process instance is displayed in the navigation tree (page 595)
and in Instances (page 601).
3.10.2.6 What does 'Details' provide?

Details (page 623) provide different information, such as ID, status and business status (page
629), priority, depending on whether you selected a process, a process version, process
instance, or a human task.
598
3.10.2.7 What does 'Diagram' provide?

Diagram is displayed if you have selected a version of an executable process or a process
instance of an executable process. Use Toggle between EPC and BPMN diagram to toggle
between the EPC display of the executable process and the BPMN diagram generated by the
automatic model transformation.
Activities that are currently running or have failed are selected in both models (EPC and
BPMN diagram). Compared to the EPC, the BPMN diagram can contain additional activities as
these are required for the technical process. In this case, the last selected activity remains
selected in the EPC until the next matching activity is reached.
All processes involved are displayed for executable processes that consist of multiple
processes.
 If nothing is active, the start model is displayed.
 If an object is active, the models containing active objects are displayed.
To display the properties of the running activity, click the Show details button.
3.10.2.8 What does 'History' provide?

History is displayed if you have selected a process instance of an executable process.
Activities run by process instances are listed. If an entry contains a process instance with the
Failed status, the activity can be restarted (page 618) from here.
To display the input/output data or the simulation data for simulated activities, click the
activity in the table.
To get additional details of an input activity, you can display the corresponding activity in the
history table. In the row of the relevant input activity, click Show associated activity in the
history. Alternatively, you can click Used by so that all activities for which the selected
activity acts as an input activity are displayed.
Click Input variables or Output variables to show the values read (input) or stored (output)
during execution of an activity.
Click Input data or Output data to check the data. Additionally, you can click Show
details to display the XML data. For restartable failed activities the tracking ID is displayed.
599
3.10.2.9 What does 'Human task' provide?

The human tasks of all executable processes are displayed. Use Show/hide filter to
restrict the number of process instances displayed according to various criteria. You can sort
the table by different columns, for example, by status. You can export the data as a CSV file
( ).
To display a specific instance/version, move the mouse pointer over the relevant table row
and click Display process instance or Display process version.
To display (page 626) detailed information about a specific human task, move the mouse
pointer over the relevant human task, then select Show details. Here, you can send (page
607) a reminder to the executors. To check the assigned users and delegate (page 626) a
human task, click Assignments.
Statistics data in the form of charts (page 111) for human tasks are available under ARIS
Administration > Charts > Governance > Human tasks.
600
3.10.2.10 What does 'Instances' provide?

It provides an overview of the process instances and their various technical and business
statuses (page 629). Use Show/hide filter to restrict the number of process instances
displayed according to various criteria. You can sort the table by different columns, for
example, by status. You can export the data as a CSV file ( ).
You can check if process instances failed so that you can correct (page 621) and restart them,
if required.
To display a specific instance/version, move the mouse pointer over the relevant table row
and click Display process instance or Display process version.
To archive instances that have the status Completed, enable the relevant instances ( ) and
click Archive selected instances.
To prioritize/deprioritize multiple instances simultaneously, open Instances, enable the
relevant instances ( ), and click Increase priority/ Decrease priority. The function is
is only available if all selected instances meet the prerequisites for priorization.
Statistics data in the form of charts (page 111) for Governance processes are available under
ARIS Administration > Charts > Governance > Processes.
Warning
3.10.2.11 What does 'Variables' provide?

The variables can be shown for all processes, for a process version, or for a process instance.
The variables used and their values are listed. You can export the data as a CSV file ( ).
To display the XML data of the variable value, click a variable in the table. To show the
previous values of a variable including their timestamps, click History. Additionally, you can
show the values read (input) or stored (output) during execution of an activity. Once you
selected a variable in the table, you can use Show details to display or hide Value as XML
and History.
601
3.10.3 Tasks of the Process Governance administrator

The Process Governance administrator manages the executable processes. Process
administration provides information about executable processes as well as control and error
handling functions (page 602). Depending on the selected process level and menu item,
various information and functions are available.
 Deploy (page 603) executable process.
 Start (page 604) governance processes in Process administration, for example,

older versions of the process.
 Deactivate (page 610) executable processes.
 Restart (page 618) activities in the status FAILED.
 Suspend/resume (page 607) the execution of process instances.
 Terminate (page 608) the execution of process instances if, for example, the executable
process is no longer relevant.
 Prioritize and deprioritize (page 614) process instances
 Use the process instance archive (page 612) to improve performance.
 Configure recurrences for an executable process.
 Suspend/resume (page 609) the recurrence of an executable process.
 Suspend the recurrence of an executable process
 Resolve error in process.
 Read privileges for the Console (page 598) bar also at the process level.
 View all tasks of other users in My tasks.
Statistics data in the form of charts (page 111) for Governance processes are available under
ARIS Administration > Charts > Governance > Processes.
602
3.10.4 Find process instances

Find process instances that have a certain status or property.
Prerequisites
Procedure
1. Open Process administration.

a. Click Application launcher > Administration. ARIS Administration opens.
b. Click Process administration.

2. Click Instances. The list of process instances is displayed.
3. Click Show/Hide filter. The filter criteria are displayed.

4. Enable ( ) the relevant filter criteria, for example, a business status (page 629) or the
status (page 605) QUEUED. You can combine different filter criteria.
5. Click Apply filter.
The list of process instances that match the selected filter criteria is displayed.
3.10.5 Deploy executable processes

To use mini workflows or start governance processes in ARIS, executable processes must be
provided. The executable processes for mini workflows are automatically generated. For
processes in ARIS Architect the executable process is generated there and then it is
automatically deployed in ARIS. As an alternative, you can manually deploy executable
processes in Process administration of ARIS.
Prerequisite
 You have the Process Governance administrator (page 602) function privilege.
 You have a ZIP file of an executable process.
Procedure


2. Click Processes in the navigation bar, if not already activated.
3. Click Deploy executable process in the navigation bar. The corresponding dialog
opens.
603
4. Select the relevant ZIP files. You can select up to ten process zip files with a maximum
size of 10 MB each.
5. Click Deploy.
6. Check the deployment result in the dialog.
7. Click Close.
The executable processes are deployed.
Now you can start the governance process (page 604) ( ).
3.10.6 Start governance process in process administration

You can start the executable process in Process administration for processes or
process versions.
Prerequisite
Procedure


2. Navigate to the executable process you want to start, or to the process version.
3. Under Processes, click the relevant process or process version.
4. Click Start governance process. The Select context dialog opens. The items are
displayed on which the executable process can be started depending on the specified
execution context.
5. Select the relevant model. To select multiple models, hold down the Ctrl key and click the
required models one after the other.
6. Click OK.
The governance process is started for the selected item.
604
3.10.7 How many process instances can be started?

The number of process instances that can be processed in parallel by the engine is limited to
1000 per Process Governance node by default (Configuration > Process Governance >
Infrastructure > Batch processing size). However, depending on the workflow complexity,
it can be necessary to reconfigure this number, for example when using
 Custom report scripts or local services
 High number of parallel branches
 Deeply nested branches
 Large number of activities per instance
 Many task assignments per task (users/user groups)
The process instances have the RUNNING status. If the specified batch processing size is
reached, the process instances started additionally have the QUEUED status. You can display
(page 603) them in Instances. This Cross-tenant setting applies to all tenants on this
server. To change it, use ARIS Cloud Controller. For further information, refer to ARIS Cloud
Controller (ACC) Command-line Tool manual.
Archive completed process instances regularly to avoid a large number of instances that can
have a negative effect on runtime and start times in Process administration and
Process Governance.
3.10.8 Where can the executable process be started?

The executable process can be started in ARIS Architect, ARIS Designer, ARIS, or in the ARIS
Process administration. The message displayed after starting the governance process
can be specified individually for each process (EPC, VACD).
3.10.9 What is an executable process?

An executable process is a process that reflects a certain process flow in your company with
all the related steps. All information relevant to Process Governance is recorded in EPCs,
value-added chain diagrams, organizational charts, dialogs, and data flows (BPM process).
The BPM process is automatically transformed into a technical process that can be executed
by Process Governance. All relevant information for the BPM process is interpreted,
transformed into a BPMN diagram, and all relevant models and objects are archived. The
BPMN diagram is the basis for Process Governance. It controls the governance process. The
executable process can then be started for a specified context.
605
3.10.10 Context for executable processes

The execution context determines from which items (database, group, model/object type,
document), in which applications (for example, ARIS), and by which users a governance
process can be started. You must specify the context before generating the executable
process. After this, it can no longer be changed for the generated process version. If no
execution context is defined, the governance process can be started for all items (Without
context option). The defined execution context is displayed in Process administration.
3.10.11 Export process administration content as a CSV file

You can export data of Human tasks (page 600), Instances (page 601), Variables (page
601), Archive (page 597), or Console (page 598), for example, for evaluation purposes.
Procedure


2. Click Human tasks, Instances, Variables, or Console, or go to Processes and click the
process instance and then History.
3. Click Export as a CSV file in the navigation bar. The corresponding dialog opens.
4. Select the output options.
5. Click Export.
The content is exported as a CSV file.
606
3.10.12 Send reminder about executing human task

You can send reminders about human tasks to the relevant executors.
Procedure


2. Open the relevant human task.
3. Click Send reminder.

The users assigned to the human tasks as executors receive an e-mail with the information
that the task is to be edited.
If 75% of the processing time has expired, the executors automatically receive a reminder. If
the task is not edited by the due date the escalation manager (page 615) is notified. Statistics
data in the form of charts (page 111) for human tasks are available under ARIS
ARIS video tutorial

(approx. 4 minutes)
3.10.13 Suspend/resume execution of process instance

You can suspend the execution of a process instance. This can be useful, for example, if a
server outage would cause the process execution to fail.
Procedure


2. Click the relevant process instance under Processes.
3. Click Suspend.
The execution of the process instance is suspended. It has the status Suspended.
4. To continue it, click Resume.
607
Unlike the Suspend recurrence function, it is not the creation of recurrences that is
suspended for the entire process, but only the execution of this process instance.
Example
The Save data process is started at midnight each night. The process comprises the two
steps Copy data and Archive data.
 Suspend recurrence
If Suspend recurrence is selected, the process will no longer be started as of the

next night and will not not resume until Resume recurrence is selected. However, all
running process instances are completed.
 Suspend process instances
If Suspend is selected at night for a running process instance that has just finished
copying data, this specific process instance is suspended, in other words, the data will no
longer be archived. Process execution stops at this point. The next night, however, a new
instance of the process is started, and the data is backed up and archived. The
suspended process instance will not continue to run until Resume is selected.
3.10.14 Terminate execution of process instance

You can terminate the execution of a process instance permanently if, for example, the
executable process is no longer relevant.
Procedure


3. Click Terminate.
The execution of the process instance is terminated permanently.
608
3.10.15 Suspend/resume recurrence for executable process

You can suspend the recurrence of an executable process and resume it later. Processes for
which a recurrence has been configured in ARIS Architect are identified in process
administration by the symbol .
Procedure


2. In the navigation, click the relevant process version under Processes.
3. Click Suspend recurrence.

The recurrence is suspended.
4. To continue it with the existing configuration, click Resume recurrence.
Unlike the Suspend function, the creation of recurrences is suspended for the entire
process, not just for the execution of a given process instance.
Example
The Save data process is started at midnight each night. The process comprises the two
steps Copy data and Archive data.
 Suspend recurrence
If Suspend recurrence is selected, the process will no longer be started as of the

next night and will not not resume until Resume recurrence is selected. However, all
running process instances are completed.
 Suspend process instances
If Suspend is selected at night for a running process instance that has just finished
copying data, this specific process instance is suspended, in other words, the data will no
longer be archived. Process execution stops at this point. The next night, however, a new
instance of the process is started, and the data is backed up and archived. The
suspended process instance will not continue to run until Resume is selected.
609
3.10.16 Delete executable process

You can deactivate the executable process if, for example, this process is outdated and
should therefore no longer be used.
Warning
When a generated executable process is deactivated, the process version and all related
information, such as instances, subprocesses, etc., are removed from Process
administration. The deactivated processes are not exported to ARIS Process Performance
Manager.
Procedure


2. Under Processes, click the process, process version, or process instance.
3. Click Delete.
The selected item is deactivated.
3.10.17 Suspend, resume, or terminate simulation runs

You can suspend and resume active simulation runs or terminate them. This can be useful, for
example, if a server outage would cause the process execution to fail.
Prerequisite
Procedure

610
2. Click the relevant process instance under Processes. Processes versions for which a
Process Governance Simulation was performed are marked with , simulation runs and
process instances with .
3. To suspend a simulation run, click the relevant process instance and select Suspend.
4. Use Resume to continue the simulation run at a later time.
5. To stop a simulation run, select Terminate. The simulation run is terminated and
cannot be restarted.
The simulation run is suspended, resumed, or terminated depending on the selected action.
611
3.10.18 Use process instance archive

Archive completed process instances regularly to avoid a large number of instances that can
have a negative effect on runtime and start times in Process administration and
Process Governance. Archiving instances gives you the following advantages:
 Process Governance starts faster.
 The process runtime is reduced.
 A better overview of your process instances.
You can only archive instances that have the status (page 629) Completed.
During archiving, the data of the corresponding instances is moved from the Process
Governance database to an archive entry of ARIS document storage. Each tenant has its own
archive. The information about simulation, recurrence, and substitution is not archived. If you
want to automatically archive process instances, for example every night at a certain time,
write a report in ARIS Script
(../../../../../../../abs/help/en/script/ba/index.htm#scripthelp.html) and schedule it. This is
done in ARIS Architect (../../../../../../../abs/help/en/handling/ba/index.htm#72345.htm).
Warning
Prerequisites
 The instances have the COMPLETED status (page 629).
Procedure



4. Enable ( ) the COMPLETED status.
5. Click Apply filter. The list of completed process instances is displayed.
612
6. Enable ( ) the instances to be archived. You can archive a maximum of 100 instances in
one step.
7. Click Archive selected instances. (The function is only available if at least one
instance is enabled.)
The instances are removed from the Instances (page 601) list and are displayed in the
Archived instances (page 597) list.
8. To move instances back from the archive to the Instances list, open the Archived
instances list, move the mouse pointer over the relevant table row, and click
Unarchive archived instances.
9. To permanently delete archived instances, open the Archived instances list, move the
mouse pointer over the relevant table row and click Delete.
10. To suspend archiving, unarchiving, or deletion, click Suspend in the progress dialog.
Alternatively, you can use the suspend function in Archive history. Please note that
operations that have been already completed are not reverted. Example: An operation is
running to archive ten instances. You suspend the operation after three instances have
already been archived. Only the seven remaining instances are not archived.
To resume the operation, open Archive history, click Resume in the row of the
previously suspended archiving execution. This is also helpful if an operation was
suspended automatically, for example, during a backup.
Your operations were performed.
Alternatively, you can archive all completed instances of a process version. To do so, click the
relevant process version under Processes, then click Archive all completed instances.
The archiving functionality can affect the total runtime and size of the backup.
613
3.10.19 Prioritize and deprioritize process instances

For each tenant there is a queue of process instances waiting to be executed. Each newly
started process instance is appended to the end of the queue according to the first in, first
out principle. However, you can prioritize process instances so that they are preferably
executed.
The priority queue is limited to 100 process instances by default (Configuration > Process
Governance > Infrastructure > Priority queue size). If the specified priority queue size is
exceeded, so that no further process instances can be prioritized, a message is displayed.
This Cross-tenant setting applies to all tenants on this server. To change it, use ARIS
Cloud Controller. For further information, refer to ARIS Cloud Controller (ACC)
Command-line Tool manual.
Prerequisite
 The instances have the Running status (page 629).
Procedure


3. Click Increase priority. The Prioritized status is set and displayed in Details. The
process instance is executed with a higher priority.
4. Click Decrease priority to remove the Prioritized status. The Prioritized status is
removed.
5. To display the process instances with Prioritized status, click Instances.

7. Enable ( ) the Priority status filter.
8. Click Apply filter.
The process instances with Prioritized status are displayed.
To prioritize/deprioritize multiple instances simultaneously, open Instances, enable the
relevant instances ( ), and click Increase priority/ Decrease priority. The function is
is only available if all selected instances meet the prerequisites for priorization.
614
3.10.20 How to handle large volume data

As an alternative to the features in process administration, you can use the reports of ARIS
Script to handle large data volumes. For example:
 Delete process instances
 List archived instances
 Delete archived instances
 Unarchive archived instances
We recommend that you do not run these reports during core time, as this can have a
significant negative impact on performance.
For detailed information, refer to ARIS > Help > ARIS Script > Methods for reports and
semantic checks > Global objects > Report component interfaces > Process > Process.
3.10.21 What is the escalation manager?

The escalation manager is the user who is notified when a human task is not completed by
any executor by the due date. It is specified in the data flow diagram or in the model using an
organizational element and the is escalated to connection.
3.10.22 Find and correct problems in processes

To ensure a smooth process flow the Process Governance administrator must be able to
query information on processes and intervene, if required. Information and functions are
provided in process administration (page 595) in ARIS for this purpose. If problems occur
during process execution, for example, if an error occurs during an automated task or the
recipient of an e-mail message is not recorded as a user, the Process Governance
administrator is informed by e-mail.
ARIS video tutorial

615
3.10.22.1 List processes and display instance/version

You can display a list of process instances in their various statuses (page 629). You can check
if process instances failed so that you can correct (page 621) and restart them, if required.
Procedure


3. Click Filter to restrict the number of process instances displayed based on various
criteria.
4. Select filter criteria.
5. Click Apply filter. The list is filtered according to the selected filter criteria. To display the
unfiltered list of process instances, click Reset filter.
6. To display a specific instance/version, move the mouse pointer over the relevant table
row and click Display process instance or Display process version. The
instance/version is selected in the Explorer tree.
The list of process instances in their various statuses is displayed.
You can also display instances or versions in the Explorer tree by using Human tasks.
ARIS video tutorial

616
3.10.22.2 Review input and output data of activity

When you receive an e-mail informing you that an activity has failed you can review the input
and output data of the activity to find out whether they caused the failure.
Procedure


2. Select the process instance of the executable process containing the failed activity. You
were informed about the relevant activity in the notification.
3. Click History.
4. Click the activity whose execution failed.
Input and output data of the activity are displayed. Review the data.
You can change the output data using the function Skip activity (page 619).
ARIS video tutorial

617
3.10.22.3 Restart failed activities

You can restart failed (page 629) activities. You are notified by e-mail if an activity failed.
Prerequisite
Restart failed process instances is enabled in the configuration (page 633) ( Application
launcher > Administration > Configuration > Process Governance >
Infrastructure). By default, this property is disabled.
Procedure


2. Click the process instance of the executable process containing the failed activity. You
were informed about the relevant activity in the notification.
3. Click History.
4. Move the mouse pointer over the activity whose execution failed. The buttons of the
5. Click Retry.
The activity is restarted with the same data as the failed activity.
If the activity cannot be restarted, you will receive a notification. You can skip (page 619) the
activity.
ARIS video tutorial

618
3.10.22.4 Skip failed activities

If a restart (page 618) is impossible, you can skip failed activities. You are notified by e-mail if
an activity failed.
Procedure


3. Click Activities. The process instance activities are listed.
4. Move the mouse pointer over the activity you want to skip. The buttons of the available
functions are displayed.
5. Click Skip activity. If output data was specified for the activity, a dialog opens for
you to correct the data and thus avoid further failure. If no output data was specified for
the activity, the activity is skipped immediately.
6. Change the output data.
7. Click Save.
The process continues with the next activity.
ARIS video tutorial

619
3.10.22.5 Skip human tasks

You can skip activities of instances that you suspended before. This is useful if the activity
would fail or if none of the executors assigned to the human task are available and therefore
the instance could not be completed.
Procedure


3. Click Suspend. The execution of the process instance is suspended. It has the status
Suspended.
4. Click Activities. The process instance activities are listed.
5. Move the mouse pointer over the human task you want to skip. The buttons of the
6. Click Skip activity. If output data was specified for the activity, a dialog opens for
you to correct the data and thus avoid further failure. If no output data was specified for
the activity, the activity is skipped immediately.
7. Change the output data.
8. Click Save.
The human task is skipped and set to Completed status. Now you can resume (page 607) the
instance. If this human task is the last activity of the process, the instance is also set to
Completed status and therefore does not need to be resumed.
ARIS video tutorial

620
3.10.22.6 Correct and restart failed process instances

You can restart failed (page 629) process instances. You are notified by e-mail if a process
instance failed.
Procedure


3. Click Filter, select the filter Status and the status FAILED.
4. Click Apply filter. The list of failed process instances is displayed.
Alternatively, you filter process instances with the filter ID by entering the ID of the failed
process instance, which you received in the notification.
5. Move the mouse pointer over the process instance you want to correct. The buttons of
the available functions are displayed.
6. Click Display process instance. The instance is displayed.

7. Click Console to obtain further information on why the instance failed.
8. Correct the errors that led to the process instance failing.
9. Click the relevant process instance.
10. Click History.
11. Move the mouse pointer over the activity whose execution failed. The buttons of the
12. Click Retry.

The activity is restarted and the process instance continues.
ARIS video tutorial

621
3.10.22.7 Re-trigger failed process instances

You can re-trigger process instances that failed on the system side because, for example,
services that a data flow requires for execution are not available. You are notified by e-mail if
a process instance failed.
Alternatively, enable Re-trigger instances failed on system side to automatically re-trigger
a process instance based on the same data when the system is available again and Process
Governance is restarted ( Application launcher > Administration > Configuration
> Process Governance > Infrastructure). By default, it is disabled. For detailed information,
refer to Customize infrastructure settings (page 640).
Procedure


3. Click Filter, select the filter Status and the status FAILED.
4. Click Apply filter. The list of failed process instances is displayed.
Alternatively, you filter process instances with the filter ID by entering the ID of the failed
process instance, which you received in the notification.
5. Move the mouse pointer over the process instance you want to correct. The buttons of
the available functions are displayed.
6. Click Display process instance. The instance is displayed.

7. Click Console to obtain further information on why the instance failed.
8. Click Re-trigger process instance. This button is available only if the instance has
the Failed status (page 629).
The process instance is re-triggered and set to the Running status if the execution was
successful this time.
622
3.10.23 Display information

Process administration in ARIS provides functions (page 595) for process automation and
information about executable processes.
3.10.23.1 Display information about executable processes

In Process administration, existing executable processes are displayed. You receive
detailed information on processes, process versions/instances, and human tasks.
Procedure


2. Click the process, process version, process instance, or human task.
3. Activate the required function in the navigation bar.

The information available for this item is displayed. Processes versions for which a Process
Governance Simulation was performed are marked with , simulation runs and process
instances with . Processes for which a recurrence has been configured in ARIS Architect
are identified in process administration by the symbol . Statistics data in the form of charts
(page 111) for Governance processes are available under ARIS Administration > Charts >
Governance > Processes.
ARIS video tutorial

(approx. 4 minutes)
623
3.10.23.2 Display information about activities

You can display details of an activity.
Procedure


3. Click History.
4. Click the relevant activity in the table.
5. Click Input activities.
6. Click Show associated activity in the history to display the corresponding activity in
the history table. Then click Input activities again.
Alternatively, you can click Used by so that all activities for which the selected activity
acts as an input activity are displayed.
7. Click Input variables or Output variables to show the values read (input) or stored
(output) during execution of an activity.
8. Click Input data or Output data to check the data. Additionally, you can click Show
details to display the XML data. For restartable failed activities the tracking ID is
displayed.
The relevant details are displayed.
624
3.10.23.3 Display human tasks of process instances

You can display the human tasks associated with a process instance.
Procedure


2. Click the process instance whose human tasks you want to display.
3. Click Show tasks.

The associated human tasks are displayed.
ARIS video tutorial

(approx. 4 minutes)
625
3.10.23.4 Display information about variables

You can display detailed information of a variable (page 601), for example, value, value
history, XML data.
Procedure


2. Click Variables to display the variables of all processes. Or click the relevant process
version or process instance under Processes and then click Variables. The variables
used with their value, timestamp, type and scope are displayed.
3. To display the XML data of the variable value, click a variable in the table.
4. To show the previous values of a variable including their timestamps, click History.
Additionally, you can show the values read (input) or stored (output) during execution of
an activity.
5. Once you selected a variable in the table, you can use Show details to display or hide
Value as XML and History.
The details of the variable selected are displayed.
To export (page 606) the content, click Export as a CSV file in the navigation bar.
3.10.23.5 Display and delegate executors of human tasks

You can display the executors of human tasks and delegate tasks.
Prerequisites
 A task must have been selected in the list.
 The task must have been assigned to a user group.
 The status of this task is New or In process.
 The user to whom the task has been transferred belongs to the allowed group (data flow:
Group of allowed delegates).
Procedure


2. Click Human tasks.
626
3. Move the mouse pointer over the relevant task. The buttons of the available functions are
displayed.
4. Click Show details. The human task is displayed in Processes.
5. Click Navigate to occurrence in Explorer tree, to show the location of the human
task.
6. Click Assignments.
7. Move the mouse pointer over the relevant task. The buttons of the available functions are
displayed.
8. Click Delegate task. The corresponding dialog opens.

9. Enter the first characters of the group, user name, first name, or last name, and click
Find. If hits exist for the current search, the results are displayed.
10. To select a group or user, select the relevant element. If you select a group, you also need
to select a user.
11. Optionally, enter a comment, such as a reason or notes for the new executor.
12. Click Delegate.
The task is passed on to the selected executor and its status (page 630) is displayed as
Delegated.
Statistics data in the form of charts (page 111) for human tasks are available under ARIS
ARIS video tutorial

(approx. 4 minutes)
627
3.10.23.6 Which status can activities have?

An activity can have any of the following statuses:
 ACTIVE
The activity is just being performed.
 TERMINATED
The Process Governance administrator terminated the activity manually during process
execution. This may be called for if, for example, the executable process is no longer
relevant.
 FAILED
The activity could not be performed completely due to an error. Failed activities can be
restarted after the error is fixed.
 SUSPENDED
The activity has been automatically canceled.
 COMPLETED
The activity was completely performed.
628
3.10.23.7 Which status can process instances have?
STATUS
A process instance can have any of the following statuses:
 Running
The process instance is running the process.
 Suspended
The Process Governance administrator suspended (page 607) the process instance
manually during process execution. This can be useful, for example, if a server outage
would cause the process execution to fail.
 Terminated
The Process Governance administrator terminated (page 608) the process instance
manually during process execution. This may be called for if, for example, the executable
process is no longer relevant.
 Failed
The process instance was not able to pass through the process completely due to an
error. Failed process instances can be restarted (page 621) after the error is fixed or
re-triggered (page 622).
 Idle
The process instance is in wait state because something unforeseen has happened while
the process was passed through. The Process Governance administrator must check and
resolve this.
 Completed
The process instance has completely passed through the process.
BUSINESS STATUS
The Business status is displayed in ARIS Process Board, My tasks, as well as in views and
filters of process administration (page 595), if the Business Status variable is added to the
variable catalog. For mini workflows and micro workflows, the business status are
implemented by default, such as Waiting for approval. For detailed information, refer to Add
'Business Status' variable to variables catalog in the online help of ARIS Architect.
629
3.10.23.8 Statuses in My tasks

Tasks can have the following statuses in My tasks:
 New
The task has not been edited since it was assigned, or it was reset.
 In process
The task was partially edited, and the editor then finished editing by selecting Save to
save the current input and resume editing at a later time.
 Active
Tasks to be edited, that is, tasks in the New or In process state.
 Overdue
The specified processing time of the task has expired. If the list contains overdue tasks,
the number is displayed in the top bar.
 Suspended
The process instance that triggers this human task has been suspended in the
Process administration.
 Being edited by another user
This status is set automatically as long as a task that was assigned to several possible
executors is currently being edited by one of them. Tasks with this status are displayed
with a gray background in the list.
 Failed
The task could not be performed because a problem occurred.
 Completed
Editing of the task was completed with OK. Further editing is no longer possible. However,
you can open the task with a double-click to view details. Tasks with this status are
displayed with a gray background and with strikethrough formatting in the list.
 Passed on
Editing of the task was passed on from the executor to another user for a specific period
of time.
 Delegated
Editing of the task was passed on permanently from the original assignee to another user.
The task remains in the list of the original assignee with this status.
 Task assignment failed
The task was not completed by any executor before its due date. The group of executors
contained either no executors or no active executors.
630
3.10.24 Handle simulation

The simulation of executable processes (Process Governance Simulation) enables you to test
the modeling of processes before release. The automated execution of all process passes and
the possible data combinations is less error-prone and quicker than the manual method.
3.10.24.1 Display simulation information

In Process administration, the processes for which Process Governance Simulation was
performed are displayed. Processes versions for which a Process Governance Simulation was
performed are marked with , simulation runs and process instances with . You receive
further information and tips regarding errors. If the simulation of a process instance fails, the
Process Governance administrator receives a notification and a message is displayed in
Console (page 598).
Procedure


3. Click Details (page 598), if not already activated, to display information about the status
and progress of the simulated process instances.
4. To display simulation data for simulated activities, click History (page 599), and activate
the relevant activity in the table.
5. If you need an overview of the process instances a simulation was performed for, click
Instances (page 601). The simulated activities are marked with in the Simulated
column.
6. To display messages regarding the process instance, activate the Console (page 598) bar.
The various process passes of the instance are displayed under the process instance, for
example, when an XOR operator is used in the process.
This information can be used to resolve modeling errors and optimize the process.
631
3.10.24.2 Release simulated process

You can release process versions that were created and checked by Process Governance
Simulation, that is, transform the simulated process into a normal process. It is not possible to
start a governance process for processes generated by the simulation ( / ). This can be
done after the transformation into a released process.
Procedure


2. Select the relevant process version.
3. Click Transform simulated version into a normal process.

The process version is transformed into a normal process.
3.10.24.3 Delete simulation runs

You can delete terminated simulation runs to make Process administration clearer.
Processes versions for which a Process Governance Simulation was performed are marked
with , simulation runs and process instances with .
Prerequisite
Procedure


2. Under Processes click the relevant simulation run.
3. Click Delete.
4. Confirm the confirmation prompt by clicking OK.
The simulation run is deleted and removed from Process administration.
632
3.10.25 Configure Process Governance

You can customize general settings of Process Governance.

for example, infrastructure settings, publishing settings, or the workflow policies. We
recommend that you backup (page 634) your existing configuration before you import a
configuration in case that the imported configuration does not meet your expectations.
Prerequisite
 You have the Process Governance administrator function privilege.
Procedure
Configuration view.
3. Click Process Governance.

is required.
633

from another tenant to overwrite the current user management configuration.
Prerequisite
 You have the Process Governance administrator function privilege.
Procedure
Configuration view.

You can save the configuration file of Process Governance at the relevant location for further
use.
3.10.25.3 Set up sending notifications to Process

Governance administrators
You can specify that Process Governance administrators receive e-mail notifications if
problems occur during process execution for users modeled in an organizational chart
relevant to Process Governance.
Prerequisite
Procedure
1. Assign the relevant users Process Governance administrator privileges.
2. Also, specify (page 20) the E-mail address attribute for the Process Governance
administrators.
The Process Governance administrators will automatically receive an e-mail if problems occur
during process execution, for example, if an error occurs during execution of an automated
task or if the recipient of an e-mail message has not been entered as a user.
634
3.10.25.4 Customize notification settings

You can enable that e-mail notifications are simulated. That means that they are not sent to
their recipients.
Prerequisite
Procedure
Configuration view.
4. Click Notifications.
5. Click Edit.
6. Adjust you settings.
7. Click Save.
You have enabled/disabled that e-mail notifications are simulated.
3.10.25.5 Enable/Disable HTML e-mail notifications

You can enable that e-mail notifications are sent in HTML format.
Prerequisite
Procedure
Configuration view.
5. Click Edit. Click Enable HTML e-mail to enable/disable that e-mails are sent in HTML
format.
6. Click Save.
You have enabled/disabled HTML e-mail notifications.
635
3.10.25.6 Customize HTML templates for e-mail

notifications
You can customize (page 638) the HTML templates for notifications that are automatically
sent, for example, for reminder, escalation, or substitution e-mails. You can customize the
HTML template in different languages. The templates consist of an HTML and a non-HTML
section for these two possible modes. Due to security reasons, JavaScript is not allowed.
If you want to use the HTML templates and after customization, you must be redeploy each
process to use the new HTML templates. For already deployed process, e-mails will work the
same as before.
Variables (page 637) may be used to personalize the content of a notification. Variables can
be used in both notification subject and body.
Prerequisite
 You have knowledge in HTML and CSS (page 1128).
Procedure
Configuration view.
5. For the relevant e-mail type, click Edit. You can customize the HTML e-mail
templates in the template editor. If you click Preview, the customized e-mail is sent to
your e-mail address. You find further information about the variables you can use for this
specific e-mail type if you click Help.
6. Click Save template.
You have customized the HTML e-mail template for notifications.
636
3.10.25.7 What variables can you use?

Variables may be used to personalize the content of a notification. Variables can be used in
both notification subject and body. You can use different variables depending on the e-mail
type. The following variables are supported:
 $processBoardLink
ARIS Process Board URL link. Can be used in an escalation, reminder, and task assignment
e-mail.
 $body
To use text content that has been mapped in the corresponding dataflow in ARIS
Architect. Can be used in all e-mails.
 $connectLogoUrl
URL of the ARIS logo.
 $subject
Use subject that has been mapped in the corresponding dataflow in ARIS Architect. Can
be used in all e-mails.
 $serverUrl
Server URL link. Can be used in all e-mails.
 $processName
Process name. Can be used in substitution, escalation, reminder, and assignment e-mails.
 $activityName
Name of the activity.
 $tenantName
Tenant name. Can be used in most e-mails.
 $taskAssignee
User to whom the task was assigned. an escalation e-mail.Only used in
 $taskUrl
Link to task.
 $editTaskUrl
Link to edit task.
 $dueDate
Date when the task should be complete. Can be used in a reminder e-mail.
 $substitutee
Target user who acts as the substitute. Can be used in a substitution e-mail.
 $originalUser
637
Username of the user who make the substitution. Can be used in a substitution e-mail.
 $originalUserDisplayName
Display name(Last Name,First Name) of the user who make the substitution.
 $substitutionRole
Substitution role. Can be used in a substitution e-mail.
 $substitutionStartDate
Substitution start date. Can be used in a substitution e-mail.
 $substitutionEndDate
Substitution end date. Can be used in a substitution e-mail.
3.10.25.8 Usable tags

You can use the following tags:
 p - paragraph
 div - used as a container for HTML elements
 h1, h2, h3, h4, h5, h6 - heading 1 to heading 6
 ul - unnumbered list
 ol - ordered list
 li - list
 blockquote - indicates that the enclosed text is an extended quotation
 b - bold
 i - italic
 font - specifys the font face, font size, and color of text
 s - strikethrough
 u - underlined
 o - overline position
 sup - superscript
 sub - subscript
 ins - defines a text that has been inserted into a document. Browsers will usually
underline inserted text.
 del - defines text that has been deleted from a document. Browsers will usually strike a
line through deleted text.
 strong - used to define text with strong importance. The content inside is typically
displayed in bold.
638
 style - used to define style information (CSS (page 1128)) for a document. Inside the
<style> element you specify how HTML elements should render in a browser.
 tt - was used in HTML 4 to define teletype text
 code - defines some text as computer code in a document
 big - was used in HTML 4 to define bigger text
 small - defines a smaller text
 br - inserts a single line break in a text
 span - inline container used to mark up a part of a text, or a part of a document
 em - emphasis
 html - represents the root of an HTML document
 head - container for metadata.
 img - used to embed an image
 body - defines the document body
 a - defines a hyperlink
 table - defines an HTML table
 tr - table row
 td - defines a standard data cell in an HTML table
 rect - used to create a rectangle and variations of a rectangle shape when using SVG
(page 1151) shapes
 tbody - used to group the body content in an HTML table
 thead - used to group header content in an HTML table
 pre - text in a <pre> element is displayed in a fixed-width font, and the text preserves
both spaces and line breaks. The text will be displayed exactly as written in the HTML
source code.
 meta - defines metadata about an HTML document
 th - defines a header cell in an HTML table
 hr - defines a thematic break in an HTML page, for example, a shift of topic
639
3.10.25.9 List of allowed attributes inside each tag
Tags Attributes
a "href","rel","target"
img "src"
meta "http-equiv","content", "charset"
table "border","cellpadding","cellspacing"
div "align"
td "colspan", "valign"
tr "rowspan"
Allowed in all tags "id", "class", "style", "type", "height", "width", "class", "align", "title",
"name"
3.10.25.10 Customize infrastructure settings

configuration in ARIS Administration. You can configure your Process Governance
infrastructure (page 615).
Properties that are highlighted as cross-tenant properties can only be changed using ARIS
Cloud Controller Command-line Tool. To change the settings, enter the following command:
reconfigure apg_<size of your installation, s, m, or l> JAVA-D<property
name>="<value>"
Example
reconfigure apg_m
JAVA-Dcom.idsscheer.age.activity.ws.call.timeout="https://myserver.com"
Prerequisite
Procedure
Configuration view.
4. Click Infrastructure.
640
5. Click Edit.
7. Click Save.
3.10.25.11 Customize Publishing

name>="<value>"
Example
reconfigure apg_m
Prerequisite
Procedure
Configuration view.
4. Click Publishing.
5. Click Edit.
7. Click Save.
641
3.10.25.12 Customize Reporting

Prerequisite
Procedure
Configuration view.
4. Click Reporting.
5. Click Edit.
7. Click Save.
3.10.25.13 Customize workflow policies

Prerequisite
Procedure
Configuration view.
4. Click Workflow policies.
5. Click Edit.
7. Click Save.
642
3.10.25.14 Customize pools

name>="<value>"
Example
reconfigure apg_m
Prerequisite
Procedure
Configuration view.
4. Click Pools.
5. Click Edit.
7. Click Save.
643
3.10.25.15 Customize user interface

configuration in ARIS Administration. You can customize the columns of My tasks.
Prerequisite
Procedure
Configuration view.
5. Click Edit.
6. Adjust your settings. You can change the order of the table columns using the arrow
symbols.
7. Click Save.
You have customized the columns of My tasks.
644
3.11 Administrate Collaboration

Collaboration is the platform for cooperation across teams. With Collaboration, information
can be exchanged faster, knowledge can be shared, and cooperation across borders is
improved. As an Collaboration administrator you have several options (page 646) for
managing Collaboration.
3.11.1 Open Collaboration

Open Collaboration to exchange information, share knowledge, etc.
Prerequisites
 Collaboration is enabled in ARIS Administration configuration ( Application launcher >
Administration > Configuration > Collaboration > General settings > Activate
Collaboration).
 You have at least the ARIS Connect Viewer license privilege.
 You have the required database access privilege (page 649).
Procedure
Click Application launcher > Collaboration.
Collaboration opens.
As an Collaboration administrator you have several options (page 646) for managing
Collaboration.
645
3.11.2 Privileges of coordinators and administrators
COORDINATORS
 Are responsible for managing the group profile, privileges, access, and feed activity
facilitation.
 Can delete their groups.
As the creator of a group, you are automatically the coordinator. You can assign coordinator
privileges to other group members, as well. If there is no coordinator anymore for a group, for
example, because all users with coordinator privileges for a group were deleted, Collaboration
administrators can manage the group and assign coordinator privileges.
COLLABORATION ADMINISTRATORS
 Have the same privileges as coordinators.
 Manage the posts that users have flagged as inappropriate (page 647).
 Can synchronize (page 648) access privileges.
 Can manage (page 650) announcements.
 Can configure ARIS document storage user (page 650) and database user (page 651).
 Can assign user groups from ARIS Administration to a Collaboration user group.
 Can display (page 652) dashboards.
 Can clean up and export (page 653) activities.
 Can view all posts and delete them.
 Can configure (page 653) and customize (page 654) e-mail notifications.
 Can customize (page 657) Collaboration in ARIS Administration.
Collaboration administrator is a function privilege assigned in ARIS Administration.
646
3.11.3 Check activities flagged as inappropriate

Check content flagged as inappropriate and decide whether it must be deleted.
Prerequisite
 Flagging activities is enabled in ARIS Administration configuration ( ARIS
Administration > Configuration > Collaboration > General settings > Flag
activities).
 You have the Collaboration administrator function privilege.
Procedure
1. Click Application launcher > Collaboration.
2. Under Administration, click Check flagged activities. The activities flagged as
inappropriate are displayed.
3. Verify whether the Collaboration terms of use have been violated.
4. Click Allow if the content does not violate the terms of use.
5. Click Comment to enter a comment or further information for a post.
6. Click Delete if the content violates the terms of use, and then click OK.
The flagged activity was checked and is either deleted or will continue to be shown depending
on the result. Alternatively, you can check the flagged activities in your notifications.
3.11.4 Manage portal feeds

Edit portal feed subscriptions of Collaboration users. You can cancel subscriptions completely
or just for individual users. Canceled subscriptions cannot be added here again.
Prerequisite
Procedure
2. Under Administration, click Manage portal feeds. The followed items are displayed.
3. Click Delete to unsubscribe from a portal feed. This removes the entire stream along with
all activities and posts.
4. Click OK.
5. To cancel the subscription for individual followers, click Edit in the row for the relevant
item. The followers are displayed.
647
6. Click Unfollow in the row for the follower whose subscription you want to cancel.
7. Click OK.
8. Click Save.
The selected subscriptions will be canceled. The corresponding feed in no longer displayed in
My portal feeds for the selected users.
3.11.5 Synchronize access privileges

For some interactions in Collaboration, users need special access privileges, for example, to
post on portal feeds. These access privileges are assigned (page 40) in ARIS Administration or
in ARIS Architect. To use updated privileges at once, synchronize them manually in
Collaboration.
Prerequisite
Procedure
2. Under Administration, click Manage portal feeds.
3. Click Synchronize privileges.
4. Click Execute.
The access privileges from ARIS Architect are updated. The users can now work with the
relevant content.
648
3.11.6 Database access privileges for Collaboration

For some interactions in Collaboration, users need special access privileges, for example, to
post on portal feeds. These access privileges are assigned (page 40) in ARIS Administration or
in ARIS Architect. You can synchronize (page 648) the privileges in Collaboration manually,
after you edited them in ARIS Architect. The following database access privileges are relevant
to Collaboration:
 No access (----)
No portal content is displayed.
 Read (r---)
Portal content is displayed. Users can read posts added to models, and they can like,
share, bookmark, tag, and flag them. However, they cannot comment on models.
 Read + Comment (rc--), Read + Write (rw--) (and all other types of rw access)
Portal content is displayed. Users can use all functions of Collaboration.
For detailed information about access privileges, refer to the help in ARIS Architect (ARIS
Configuration and Administration).
3.11.7 What is the synchronization user?

The synchronization user serves technical purposes only. No function or license privileges are
assigned to this user. The synchronization user is required for synchronization processes
executed in the background of Collaboration, for example, to synchronize the user data
between ARIS Administration and Collaboration.
The synchronization user is automatically generated for every newly created tenant. If the
synchronization user is not available, the system (page 22) user is used instead, provided that
the default password of the system user was not changed. If the system user cannot be
used, you must manually create the synchronization user using ARIS Cloud Controller. The
technical name of the synchronization user, for example in ARIS Advanced Controller, is
_aris_tech_user_ecp_techuser. For detailed information, refer to ARIS Cloud Controller
(ACC) Command-Line Tool, chapters Create synchronization user and Force synchronize
Collaboration users.
649
3.11.8 Manage announcements

Publish information important for all colleagues as an announcement. Announcements are
always displayed on the top of any feed or stream of all users. Additionally, they are
highlighted by the background color. Only one announcement is possible at a time, that is, if a
new announcement is published, it replaces the previous one.
Prerequisite
Procedure
2. Under Administration, click Manage announcements.
3. Enter the announcement title.
4. Enter or copy your text into the text box. Up to 2000 characters are available.
5. Click OK.
Your announcement is published in All company feed and My feed of all colleagues. Users
can hide the announcement in their feed by clicking Remove.
If the announcement is outdated, delete it (Administration > Manage announcements).
3.11.9 Configure ARIS document storage user

Specify a user responsible for the generation of dashboards. The data of dashboards is stored
in ARIS document storage. The dashboard data from Collaboration is automatically updated to
ARIS document storage every day. Only one ARIS document storage user (page 468) can be
specified at a time. For detailed information about access to ARIS document storage (page
468), please refer to Manage documents help.
Prerequisite
 You have the Dashboard administrator function privilege.
Procedure
2. Under Administration click Configure document user.
3. Enter the user name and the password of the relevant user.
4. Click OK.
The ARIS document storage user is specified.
650
3.11.10 Configure database user

Specify a user responsible for the interaction with ARIS server. The users login information is
required for processes executed in the background, for example, the activation of automatic
following ( Application launcher > Administration > Collaboration > Configure
database user). Only one database user can be specified at a time.
Prerequisite
 The user to be configured as database user must have the Database administrator
function privilege.
Procedure
2. Under Administration, click Configure database user.

3. Enter the user name and the password of the relevant user.
4. Click OK.
5. The database user is specified.
651
3.11.11 Display dashboards

You can view statistics data using dashboards. Dashboards can be used, for example, to
perform controls in real time.
Prerequisite
 You have at least the MashZone Viewer license privilege.
automatically enabled.
 Your ARIS Server is enabled for ARIS Aware.
 ARIS document storage user is specified (page 650).
Procedure
2. Under Administration, click Dashboards.

3. Click the relevant area (Overview, Content, Users, Groups).
The dashboards for the selected area are displayed.
Example
652
3.11.12 Clean up and export activities

You can delete activities from before a specified date in order to remove outdated content
from Collaboration. This makes the feed overview more transparent. To archive this data, you
can create an export. These elements are stored in the export: Comments, tags including
hashtags and system tags, external links, links to models, bookmarks, likes, etc.
Depending on the configuration, the activities are exported as a ZIP file or the ZIP file is stored
in ARIS document storage and you can download it later ( Application launcher >
Administration > Configuration > Collaboration > General settings > Export activities
as a ZIP file instantly).
Procedure
2. Under Administration, click Clean up and export.
3. Click the Activities older than box. The calendar opens.
4. Select the date from which all earlier activities are to be deleted or exported.
5. Click OK.
6. Specify whether the activities should be exported and/or deleted.
7. Depending on your selection, click Export, Export and delete or Delete.
According to your specifications, the activities older than the date entered are deleted and/or
exported. The export is saved as a ZIP file.
Archive the ZIP file on your computer. To do so, move the mouse pointer over the relevant
export. The buttons of the available functions are displayed. Click Download ZIP file. If
export files are outdated, you can remove them from the list by clicking on Delete Zip file.
3.11.13 Configure notifications

You can specify the time for daily e-mail notifications and the day for weekly e-mail
notifications. Defaults are AM 00:00 and Monday respectively. The global settings are used
for all users who have not specified an e-mail frequency in their own account yet ( View
notifications > Change your notification settings).
Prerequisite
You have the Collaboration administrator function privilege.
Procedure
2. Under Administration, click Configure notifications.
653
3. Select a time for the daily digest e-mail (Daily digest at).
4. Select a day for the weekly digest e-mail (Weekly digest on).
5. Select a global frequency (Global settings).
6. Click Save.
The e-mail notifications will be sent to the users at the time and on the day you specified.
3.11.14 Customize e-mail notifications

You can customize the e-mail notification layout by editing the HTML template. You can, for
example, adapt font size and font color as well as the background color.
Prerequisite
 You know how to edit HTML code.
Procedure
2. Under Administration, click Configure notifications.
3. Click Customization. The HTML template is displayed.
4. Edit existing HTML tags or add new ones. See the example below.
5. Under the HTML template, click Help to receive information about important
keywords used in the HTML template.
6. Click Save.
7. Under the HTML template, click Send preview e-mail to receive an e-mail with a
preview of your customized design.
The customized layout is created.
Click Restore defaults below the HTML template to undo all the settings you have made.
The default settings are loaded and the template is refreshed.
Tip
Alternatively, you can edit the template with an external HTML editor. To do so, copy the
template to your clipboard ( ).
Example
Change the background color of the e-mail and the heading.
 Replace the tag <body class="mail-font-family">
654
with <body class="mail-font-family" style="background-color: #0899CC;"> in order

to use a blue background color.
 Replace the tag <h3 class="mail-heading body-heading">$emailTitle</h3>
with <h3 class="mail-heading body-heading">My customized e-mail template</h3>
in order to use the heading My customized e-mail template.
Your preview e-mail should now look like this:
3.11.15 Delete and anonymize user accounts

Users can only be deleted (page 35) in ARIS Administration. To anonymize Collaboration users
(page 917) according to GDPR (page 1139), use ARIS Cloud Controller. For detailed information,
refer to ARIS Cloud Controller (ACC) Command-Line Tool.
After anonymization, activities of Collaboration users, such as posts, comments, groups, are
shown with Anonymized user instead of with the user name. The same applies to
dashboards. To distinguish the anonymized users from each other, a number is automatically
added to Anonymized user. This number is increased by one for each additional anonymized
user, for example, Anonymized user2. Pictures of anonymized users are no longer shown.
User profiles, bookmarks, filters, etc. of anonymized users in Collaboration are deleted.
655
3.11.16 Keyboard shortcuts for Collaboration

The following shortcuts are available in Collaboration.
Keyboard shortcuts can be performed on selected items. Selected items can be identified by
the focus (page 1139) in the program.
Shortcut Action
Page down Scrolls the screen down. The scroll distance may vary depending on the
application.
End Moves to the lower entries if they cannot be displayed completely due to
the window size or the screen resolution.
Page up Scrolls the screen up. The scroll distance may vary depending on the
application.
Home Moves to the upper entries if they cannot be displayed completely due to
the window size or the screen resolution.
Tab  Opens the navigation for page sections if you press Tab immediately
after opening the page.
 Highlights the next control or input box.
 Jumps from the Comment box to the Tag, Link, and File
symbols that you can use to attach tags, links, or files to your
comment. It also jumps to the other input fields and to the Post
button.
Shift + Tab Highlights the previous control or input box.
Right arrow/ Moves the cursor through the text in input boxes.
Left arrow
Up arrow/ Selects the previous/next item in lists.

Down arrow
Enter Opens the attachment fields and places the cursor in the input field if the
Tag or Link symbol is selected. Opens the Select document dialog when
the File symbol is selected.
 Posts the comment when the Post button is selected.
 Executes the highlighted button.
 Opens the dialog/the selection list of the highlighted item.
Ctrl + Enter Posts a comment when the Post button is active.
656
3.11.17 Configure Collaboration

You can customize general settings of Collaboration.
3.11.17.1 Customize Collaboration

You can customize Collaboration.
Prerequisite
Procedure
Configuration view.
3. Click Collaboration.
5. Click Edit property in the row of the property you want to configure.
If Collaboration is deactivated, the properties are also deactivated and cannot be edited.
You have configured Collaboration.
3.11.17.2 Refresh list of published databases

You can refresh the list of published databases.
Prerequisite
Procedure
Configuration view.
3. Click Collaboration. If Collaboration is deactivated, the properties are also deactivated
and cannot be edited.
4. Click Configure database.
5. Click Refresh database list.
You have refreshed the list of published databases.
657
3.11.17.3 Synchronize databases

If a user name is set for the Person responsible model attribute of a model in an ARIS
database, this user automatically becomes a follower of this model. Once the automatic
following is activated in Collaboration), this user can see all model activities in My feed, and
receives notifications about them. However, this only applies if this user has at least the Read
(r---) access privilege in the corresponding ARIS database.
If a different user name is set for the Person responsible model attribute at a later point in
time, the automatic following remains activated for the previous user until this user manually
stops following this model (Unfollow).
SYNCHRONYZE MANUALLY
You can synchronize a database manually at any time.
Prerequisite
Procedure
Configuration view.
3. Click Collaboration. If Collaboration is deactivated, the properties are also deactivated
and cannot be edited.
5. Move the mouse cursor in the row of the database you want to synchronize.
6. Click Refresh database list.
You have refreshed the content of a database for Collaboration.
CONFIGURE DATABASE FOR AUTOMATICALLY SYNCHRONIZATION

You can enable that the database is synchronized at a certain time every day if
Automatically follow users/Automatically follow groups/Automatically follow models is
enabled.
Procedure
Configuration view.
3. Click Collaboration.
658

5. Move the mouse cursor in the row of the database you want to synchronize.
6. Click Edit.
7. Select the time when the database should be synchronized.
You have configure the database for automatically synchronization. The synchronization is
performed daily until you turn it off.
3.12 Integrate ARIS and ARIS Process Mining

The integration of ARIS and ARIS Process Mining provides you with the following additional
options and functionalities.
If you use ARIS Process Mining in a combined deployment with ARIS Enterprise and you have
the ARIS Process Mining license, you do not have to configure the integration of ARIS and
ARIS Process Mining.
For the integration of ARIS Process Mining and ARIS, we recommend that you configure at
least the following features.
 Link to open ARIS from ARIS Process Mining
 Link to open ARIS Process Mining from ARIS
 Transfer of process variants from ARIS Process Mining to ARIS
For detail on transferring process variants, see the chapter Transfer process variants to
ARIS in the ARIS Process Mining online help.
 Process conformance analysis
For more information on performing a process conformance check using ARIS Process
Mining, see the chapter Analyze process conformance.
The Configure integration (page 660) chapter describes the configuration steps you need to
perform in ARIS Process Mining and ARIS.
In addition, you can optionally extend the integration by configuring the following features.
 Log in to ARIS using ARIS Process Mining credentials (page 674)
 Transfer ARIS users to ARIS Process Mining (page 673)
659
3.12.1 Prerequisites
PREREQUISITES FOR ARIS PROCESS MINING

You have the User admin function privilege.
You have the Data admin function privilege.
PREREQUISITES FOR ARIS

NOTE
To be able to use the variants transfer from ARIS Process Mining to ARIS, a user account with
the same name and the email address as user name must be available in ARIS Process Mining
and ARIS.
3.12.2 Configure the integration

To configure the integration of ARIS Process Mining and ARIS, open both applications in
parallel in separate web browser tabs. For some settings, you must copy data from one
application to the other.
Procedure
OPEN THE ARIS INTEGRATION PAGE IN ARIS PROCESS MINING

1. Open ARIS Process Mining.
2. Click the Navigation menu icon -> Administration in the program header.
3. Click ARIS integration in the Administration panel.
660
The ARIS integration page opens.
CONNECT ARIS PROCESS MINING TO ARIS AND ENABLE THE LINK TO ARIS
Specify the ARIS project room that you want to connect to and enable the link to ARIS that
allows you to jump from ARIS Process Mining to ARIS.
1. Enable the Enable ARIS integration option.
2. Under Configure your ARIS integration, enable ARIS Enterprise.
Specify the URL of your ARIS Enterprise edition including the project room to which you
want to connect. You can copy the URL from the browser address bar. Specify the URL in
the following form.
https://<host name>/#<ARIS project room name>
Example
https://mycompany.ariscloud.com/#my_ARIS_ProjectRoom
3. Under Include ARIS Portal into navigation menu, enable the Include into navigation
menu option.
4. Click Apply.
The link to ARIS is enabled.
Keep the ARIS integration page open.
661
To display the ARIS Portal link in the Navigation menu ( ), you must reload the ARIS
Process Mining tab. It may take a few minutes before the link is available in the menu.
Example
Connect ARIS Enterprise and enable the ARIS Portal link.
OPEN ARIS ADMINISTRATION

1. Open ARIS in a separate tab of your web browser.
ARIS Administration opens.
662
CONNECT ARIS TO ARIS PROCESS MINING AND ENABLE THE LINK TO ARIS
PROCESS MINING
Specify the ARIS Process Mining project room that you want to connect to and enable the link
to ARIS Process Mining that allows you to jump from ARIS to ARIS Process Mining.
1. Click Configuration -> User management.

2. Click the arrow next to Application switcher.
3. Click General.
4. Click Edit.
5. Enable the Enable connection to ARIS Process Mining option.
6. Enter the ARIS Process Mining URL, for example, https://mc.ariscloud.com.
7. In the Tenant input box, enter the name of the ARIS Process Mining project room you
want to connect to, for example, my_ProcessMining_ProjectRoom.
8. Click Save.
The link to ARIS Process Mining is enabled.
To display the link in the Application launcher ( ), you must reload the ARIS tab. It may take
a few minutes before the link is available in the menu.
Example
Connect ARIS Process Mining and enable the ARIS Process Mining link in ARIS.
663
ENABLE AND CONFIGURE THE VARIANT TRANSFER

You must first create a connection in ARIS before you can configure the variant transfer in
1. Click Applications.
2. Click Add application.

3. Enter a name, for example, Connection to ARIS Process Mining.
4. Enter an optional description.
5. Select Authorization code in the Grant type drop-down menu.
6. Enter UserProfile in the Scopes input field.
7. Enter the Redirect URL for your ARIS Process Mining project room.
https://<host name>/umc/rest/oauth/callback?tenant=<tenant ID>&provider=umc
Replace <host name> with the host name of the ARIS Process Mining URL. The default
host name is processmining.ariscloud.com. Replace <tenant ID> with the name of the
ARIS Process Mining project room to which you want to connect.
Example
https://processmining.ariscloud.com/umc/rest/oauth/callback?tenant=my_Process
Mining_ProjectRoom&provider=umc
8. Click + Add.
9. Click Save.
You have created a connection to ARIS Process Mining.
664
The created application provides a client ID, client secret, and well-known URL. You need the
access data to configure the variant transfer in ARIS Process Mining. Copy the data to the
clipboard and insert it into the corresponding fields in ARIS Process Mining.
Example
Access data provided by the application.
CONFIGURE VARIANT TRANSFER IN ARIS PROCESS MINING

1. Open the ARIS Process Mining tab with the ARIS integration page.
2. Under Transfer process variants to ARIS Repository, enable the Enable variants
export option.
3. Copy the client ID, client secret, and well-known URL provided by the application created
in ARIS and insert them in the corresponding input fields.
665
Example
4. Click Apply.
The variant transfer is enabled and configured.
ENABLE AND CONFIGURE REFERENCE PROCESS TRANSFER FOR

CONFORMANCE ANALYSIS
You must first create an ARIS system integration in ARIS Process Mining before you can
configure the required connection in ARIS.
Prerequisite
The link to ARIS Process Mining must be enabled, as shown above.
1. Click Create ARIS system integration at the bottom of the ARIS integration page.
The corresponding dialog opens.
2. Enter a name, for example, ARIS ConfCheck, and an optional description.
3. Ensure that Client credentials is selected as Grant type (OAuth).
4. Click Add. The Connect access data dialog opens.
The dialog provides the client ID and secret. You need the access data in the next step to
configure the process transfer in ARIS. Copy the data to the clipboard and insert it into
the corresponding fields on the ARIS Process Mining integration page, as shown in step
8 below.
666
Example
Access data of the ARIS system integration.
When you click Done, the dialog closes and the ARIS system integration is created and
listed in the System integration component with the name you specified. You can ignore
the status of the system integration displayed in the list.
5. Open the ARIS tab with the ARIS Administration.
6. Click Applications.
7. Click the ARIS Process Mining button. The Details page of the miningserver
application opens.
8. Click the Edit button.

9. Specify the application settings.
a. You can enter an optional description, for example, Process conformance check.
b. Enter the client-credentials key in the corresponding input field.
Copy the client ID and secret from the ARIS system integration, as shown in step 4.
Connect the client ID and secret to the client-credentials key as follows:
<client ID>/<secret key>
Example
ef1bf998-9658-4433-94d6-1fe8209ab36b/81cbce47-1e67-43c3-a26c-764d85a471
26
667
c. Specify the API scope in the Scopes input field. If you register ARIS Process Mining to
perform a conformance check, add the ConformanceCheck API scope.
d. Click Save.
Example
Configure the miningserver application.
The reference process transfer for conformance analysis is enabled and configured.
You can now transfer BPMN models from ARIS to ARIS Process Mining. This feature enables
you to perform a conformance check using ARIS Process Mining.
The Transfer as reference process to ARIS Process Mining button is available in the
ARIS Model designer. Open a BPMN model, open the Model tab, click the Conformance
check button -> Transfer as reference process to ARIS Process Mining.
668
3.12.3 Configure the transfer of ARIS users to ARIS Process

Mining
You can transfer user data, such as first name, last name, or e-mail address, from ARIS to
ARIS Process Mining. You can also remove transferred users from ARIS Process Mining.
For details on transferring and deleting ARIS users, see the chapter Transfer ARIS users to
ARIS Process Mining (page 673).
To configure the user transfer, perform the following steps.
 Enable identity management service in ARIS Process Mining. (page 669)
 Configure identity management service in ARIS. (page 671)
3.12.3.1 Enable the identity management service

Enable the identity management service in ARIS Process Mining.
Procedure
2. Click Identity management in the Administration panel.
3. Enable the Enable Identity management service option.
The identity management service is enabled. A token and a URL to the SCIM Rest API endpoint
are displayed in the corresponding Token and URL fields.
You need the data to configure the identity management service in ARIS. You can copy the
provided token and URL to the clipboard and paste them in the corresponding fields on the
ARIS Process Mining integration page. See the next chapter Configure identity
management (page 671).
669
Example
Enable identity management in ARIS Process Mining.
670
3.12.3.2 Configure the identity management service

Configure the identity management service (SCIM) in ARIS.
Prerequisite
The identity management service is enabled in ARIS Process Mining. (page 669)
Procedure

5. Click SCIM client.
6. Click Edit.
7. Make your settings.
a. Enable the Provisioning option.
b. Specify a connection name, for example, ARIS Process Mining.
c. Copy the token and URL of the SCIM Rest API endpoint created in ARIS Process
Mining (page 669).
Paste the URL into the Connection URL input field.
Paste the token into the Secret token input field.
d. Enable the Use e-mail address as user name option to enable the user to log in to
For more details on configuring SCIM, see the ARIS online help.
8. Click Save.
You have enabled and configured the identity management service.
You can now transfer existing users from ARIS to ARIS Process Mining (page 673).
671
Example
Configure the SCIM client for ARIS Process Mining.
672
3.12.4 Transfer ARIS users to ARIS Process Mining

You can transfer existing users and user groups from ARIS to ARIS Process Mining and
remove already transferred users and user groups from ARIS Process Mining.
You can create user groups in ARIS and transfer them to ARIS Process Mining. The users
included in a group are created in ARIS Process Mining. If users are removed from the group,
they are also removed from ARIS Process Mining.
Prerequisite
The identity management service is enabled in ARIS Process Mining. (page 669)
The identity management service is configured in ARIS. (page 671)
Procedure
1. Open ARIS.

4. Click Additional functions > Provision users. The corresponding dialog opens.
5. In the Available users/user groups box, select the users or user groups you want to
transfer to ARIS Process Mining.
6. Click Add. The selected users are added to the Provisioned users/user groups box.
7. If you want to remove provisioned users or user groups from ARIS Process Mining, select
the users or user groups in the Provisioned users/user groups box and click Remove.
8. Click OK.
The selected users or user groups are transferred to ARIS Process Mining or removed from
When users are transferred to ARIS Process Mining, the users are notified by e-mail that they
can log in to ARIS Process Mining. A user must create a password to log in to ARIS Process
Mining.
NOTE
The transferred users are created in ARIS Process Mining without the required function
privileges and user roles. To enable users to log in, you must assign them the necessary
permissions and user roles. For details, see the chapter Manage users.
673
Example
Provision users and user groups in ARIS.
3.12.5 Configure login to ARIS using ARIS Process Mining

credentials
ARIS Process Mining users can log in to ARIS using ARIS Process Mining credentials. When
using the link to ARIS or transferring variants to ARIS, the user no longer needs to log in to
ARIS.
After you have configured the login (page 675), the Login with ARIS Process Mining button
is displayed in the ARIS login dialog.
When you click Login with ARIS Process Mining, the ARIS Process Mining login dialog opens.
Enter your ARIS Process Mining user name and password and click Login.
NOTES
 The user credentials used for login do not need to be registered in ARIS. In this case, a
temporary user without access to a database is created in ARIS. If you want to access a
database, your user must be registered in ARIS.
 If external single sign-on (SSO) via SAML or similar is used in ARIS, login with ARIS
Process Mining credentials is not available.
674
Example
ARIS login dialog to log in with ARIS Process Mining credentials.
3.12.5.1 Configure login with ARIS Process Mining

credentials
You must first create a new ARIS system integration before you can configure the login in
ARIS.
A dedicated client ID, client secret, and a well-known URL are generated for each ARIS system
integration. You need the access data to configure a secure connection in ARIS.
Procedure
CREATE A NEW ARIS SYSTEM INTEGRATION FOR LOGIN WITH ARIS PROCESS
MINING
1. Open ARIS Process Mining.
3. Click ARIS integration in the Administration panel
4. Click Create ARIS system integration at the bottom of the ARIS integration page.
The corresponding dialog opens.
5. Enter a name, for example, ARIS integration, and an optional description.
675
6. Select Authorization code as authentication method in the Grant type (OAuth)

drop-down menu.
7. Specify the Authorization callback URL that is used to authenticate the ARIS Process
Mining user to ARIS.
https://<host name>/umc/rest/oauth/callback?tenant=<tenant ID>&provider=umc
Replace <host name> with the host name of the ARIS installation. Replace <tenant ID>
with the ARIS project room you want to login to.
Example
https://mycompany.ariscloud.com/umc/rest/oauth/callback?tenant=my_ARIS_Project
Room&provider=umc
8. Click Add. The Connect access data dialog opens. The dialog provides the client ID,
client secret, and well-known URL. You need the access data to configure a connection in
ARIS. Copy the access data to the clipboard and paste it into the corresponding fields on
the User management page in ARIS, as described in step 16.
Example
ARIS integration access data
676
When you click Done, the dialog closes and the ARIS system integration is created and
listed in the System integration component with the name you specified. You can ignore
the status of the system integration displayed in the list.

12. Click the arrow next to OAuth2.0.
13. Click General.
14. Click Edit.

15. Enable Use OAuth2.0.
The connection between ARIS Process Mining and ARIS is established using the OAuth
protocol. For more details on configuring OAuth, see the ARIS online help.
16. Copy the client ID, client secret, and well-known URL from the ARIS system integration
you created, as described in step 8. Insert the data into the corresponding input fields of
the OAuth2.0 configuration.
17. Click Save.

You have configured a connection to ARIS Process Mining.
You can now log in to ARIS using ARIS Process Mining credentials. (page 674)
677
Example
Configure a connection to ARIS Process Mining.
678
3.13 Manage SAP Solutions

Some features of ARIS for SAP® Solutions are available in ARIS, if your ARIS administrator has
configured the system in ARIS as well as in ARIS Architect. For details, see ARIS for SAP®
Solutions manual and ARIS Requirements for SAP® Solutions manual available in the ARIS
Download Center (https://aris.softwareag.com/) or on Empower
(https://empower.softwareag.com/).
3.13.1 Import configuration set providing SAP content

To start executables and download SAP documents, or to have the ARIS Online Guide
available, you must import (page 679) the SAP-related configuration sets for the portal and
publish the database in Published content (page 497).
Prerequisite
 You have access to the Add-ons folder that is contained in the ARIS installation package.
You can download it from the ARIS Download Center (login required).
Procedure
1. Start ARIS.
3. Click Portal > Manage configuration sets.
5. Navigate to the classicSAP.zip or defaultSAP.zip archive file that is contained in the
ARIS installation package (Add-ons/Extension pack SAP/Configuration sets).
6. Double-click the ZIP file.
The imported configuration set is listed.
If you activate this configuration set (page 680) and publish the databases (page 497), the
Run SAP executable, Download SAP documents, and ARIS Online Guide actions are available.
679
3.13.2 Select the View Providing SAP Content

Select the classicSAP or defaultSAP configuration set to display portal data.
Prerequisite
 You have the ARIS Designer license privilege.
 You have imported the classicSAP or the defaultSAP view (page 679).
 You have the Portal publisher function privilege.
Procedure
1. Start ARIS.
3. Click Configuration > Portal > Manage configuration sets. All available views are
displayed. The current view is marked.
4. Move the mouse pointer over the created view, for example, classicSAP or defaultSAP.
If the configuration sets are not available, your Portal administrator must import (page
679) them.
5. Click Activate.
All databases selected for the portal are published in the selected view.
680
3.13.3 Configure ARIS Online Guide

If the ARIS Online Guide is used for making documents that were created in the SAP ® system
specially for your business processes available across the company, configure your custom
settings to call the ARIS Online Guide.
Prerequisite
ARIS and the SAP® system have been configured for using the ARIS Online Guide.
Procedure
1. Log on to the SAP system.
2. Start the /n/IDS/AOG_USER executable. The ARIS Online Guide - User-specific
settings dialog opens.
3. Enable the Use ARIS Online Guide check box.
4. Select the Connect option to display the ARIS Online Guide in the portal in ARIS.
5. If you also want to use the F1 help from the SAP system in addition to the ARIS Online
Guide, enable the Also show default help check box.
6. Enter the required connection data for ARIS Server and tenant on which the database
was published as a portal. You administrator might already have specified default entries
that you do not need to edit.
Base URL for Connect
URL for the relevant ARIS Server:
http://<server name>
Tenant
Tenant that manages the database published as a portal.
7. Save your changes.
The settings have been applied.
If you changed the default values set by your administrator and want to restore them, click
Restore defaults.
681
3.13.4 Publish databases in ARIS (ARIS Online Guide)

If you plan to use ARIS Online Guide to make documents available across the company which
were specially created for your business processes in the SAP® system during customizing,
please make the databases available in Published content of ARIS.
Prerequisite
Procedure
1. Start ARIS.
3. Click Portal > Publish databases if it is not already selected. The Configuration tab
displays the Publish databases area. All available databases are displayed.
4. Enable the check boxes of the databases you want to publish in Published content.
5. For versioned databases, select the relevant version.
6. Click Apply.
The content of the databases is published in Published content in the selected configuration
or modification set (page 504). If databases are available in Published content they cannot
be deleted in ARIS.
3.13.5 Make log files available

After transferring projects/branches or performing SAP synchronization all actions are
logged. The files can be opened after each action and will be saved automatically. If log files
are not saved in project or solution configurations in ARIS Architect, make sure that, in ARIS
document storage configuration, the txt file extension is configured as valid extension.
Procedure
1. Start ARIS.
5. Select Quota and restrictions.
6. Click Edit.
682
7. Make sure that txt is listed in the Valid file extensions field, and that the txt file type
extension is not restricted.
8. Click Save.
Log files with txt extensions can be transferred.
3.14 Enable SAP® Enable Now

The native interface between ARIS and SAP® Enable Now Producer allows documentation
and other knowledge objects, such as simulations and courses, to be quickly and easily added
to ARIS process structures.
ARIS processes and substructures can be imported into the SAP® Enable Now Producer, to
add learning content. Afterwards, the links to the published learning content can be exported
and can be started directly in ARIS from the corresponding process node.
The import process supports common ARIS model types such as BPMN and EPC. Custom
model types can be specified optionally. Process models can be imported as media objects
additionally, to use them in learning content.
If you want to use the native interface between ARIS and SAP® Enable Now, the following
prerequisites must be met in ARIS:
Prerequisites
 ARIS Server installation, version 10.0.0.7 or higher.
 ARIS Server extension pack for SAP Enable Now.
 ARIS users who transfer data between ARIS and SAP Enable Now must have:
 ARIS for SAP Enable Now (YCSEN) license privilege,
 Read, Write, and Delete (rwd-) access privilege in the ARIS database and target
group that allow users to create models and objects.
 A method filter that contains all required model, object, and connection types.
For detailed information about configuration and the use of SAP® Enable Now, such as ARIS
Import and ARIS Export, refer to the related SAP online help.
Video tutorials are available for registered SAP customers

ARIS Integration with SAP Enable Now
683
3.15 Manage configuration languages

Use configuration languages to specify the names and descriptions of all items that are
managed in the Configuration section for this tenant, such as method items (page 725),
filters (page 819), templates (page 852), font formats (page 865), content type sets (page
684), and evaluation scripts (page 136).
If you have the ARIS Enterprise Administration license privilege and the Configuration
administrator function privilege,you can manage languages that are available in the
Conventions section on this tenant.
Use the buttons and links on this page to start the required action. If you start an action, the
breadcrumbs can take you back to the required page.
You can perform the following actions:
Add languages
Remove language
3.16 Configure content types

From ARIS in 10.0 <Service Release 15, you have two options to adapt the content used in
ARIS. You can either specify the items and properties (page 554) as you are used to, or you
use the Content type configuration.
You can adapt the content types to specify the content to display. You do so under
Conventions > Content types.
You can specify the content to display by activating the Content type configuration. With
this configuration, you have extended options to specify the content used in ARIS. After you
apply the extended configuration options, you cannot switch back to the configuration used
in earlier versions without losing the configuration you extended.
By default, each content type set has exactly one default content type for a model, object,
group, and connection.
These content types define groups and properties for all other content types of the same kind
(model, object, group, connection). Self-defined content types can overwrite the default
properties if you use the same identifier.
If the Content type configuration is enabled and the relations are specified, you can model
relations using the Properties panel of ARIS and the Connected objects tab of the
Properties bar in ARIS Architect.
For example, you can connect satellites to an object of type Function instead of manually
assigning a function allocation diagram for the object.
684
3.16.1 Enable content type configuration

You can enable the content type configuration for the portal to configure what method
content is displayed in ARIS.
Prerequisite
 A content type set is active (page 688).
 You have the Configuration administrator function privilege.
Procedure
Configuration view.
3. Click Content type configuration and enable it.
You can adapt the content displayed in ARIS (page 689).
3.16.2 Open content types page

You can open the Conventions page to edit or create content type sets.
Prerequisite
You have the Configuration administrator function privilege.
Procedure
2. Click Conventions.
3. Click Content types.
The list of content type sets is displayed. If you have not created any content type set, the
Default set is displayed.
685
3.16.3 Create content type set

You can create a set of content types. You can adapt the content types to specify the
content to display. You cannot change the Default set but you can create a copy and adapt
the copy.
Prerequisite
Procedure
1. Open content types page. (page 685)
2. Click Create new set. The Create new content type set dialog is displayed.
3. Select the relevant language.
4. Enter name and description for the content type set.
You have created a new content type set.
3.16.4 Copy a content type set

You copy an existing set of content types.
Prerequisite
Procedure
2. Select the content type set you want to copy.
3. Click Copy.
The set of content types is copied and displayed in the list of the content type sets.
You can edit (page 689) the set of content types.
686
3.16.5 Import content types set

You can import an existing set of content types. You have two options: Import from file or
Import from portal. If you choose Import from portal, only the items and properties are
imported from the configuration you specified under Define modification set > Items (page
554). If the content type set already exists, it is overwritten.
Prerequisite
Procedure
2. Click Import.
3. Select either Import from file to import a set of content types from a file. Select
Import from portal to import the content types you have specified under Define
modification set > Items (page 554).
You have imported a set of content types. For each content type, the structure of the
property groups and the configuration for the relation properties of the active configuration
or of the default configuration are applied, especially the configuration of the satellite
modeling.
3.16.6 Export a set of content types

You can download an existing set of content types.
Prerequisite
Procedure
2. Select the content type set you want to download.
3. Click Export.
The set of content types is downloaded.
687
3.16.7 Activate a set of content types

You can activate a set of content types. Enabling the content type configuration allows you
to use the satellite modeling.
Prerequisite
Procedure
2. Select the content type set you want to activate.
3. If you want to activate the content type set only for modeling, click Activate content
type set only for modeling in the Active (modeling) column and click Only for
modeling.
If you want to activate the content type set for modeling and in published content, click
Activate content type set for modeling and published content in the Active
(published content).
Depending on you selection, the set of content types is activated only for modeling or for
modeling and published content. What is activated is highlighted in green .
3.16.8 Deactivate a set of content types

You can deactivate a set of content types.
Prerequisite
Procedure
2. Select the content type set you want to deactivate.
3. If you want to deactivate the content type set only for the published content, click
Active in published content in the Active (published content) column.
If you want to deactivate the content type set for modeling and in published content,
click Active in modeling in the Active (modeling) column.
Depending on you selection, set of content types is deactivated only for the published
content or for modeling and published content. What is activated is highlighted in blue .
688
3.16.9 Display and edit content types set details

You can display the details of a set of content types.
Prerequisite
 You have created a set of content types.
Procedure
2. In the row of a content type set, click Details. The dialog opens.
The details of the content type set are displayed. You can change the name, language, and
description of the content type set.
3.16.10 Edit a content type set

You can edit an existing set of content types. If you have already adapted ARIS Method, the
changes are already present in Content types. With the ARIS Method defined in this section,
configuration administrators (page 53) ensure that only the defined method items are used.
Detailed information on method items is available in the ARIS Method help
(../../../../../../../abs/help/en/method/#/home/methodhelp/en/1).
Prerequisite
Procedure
2. Click the relevant content type set you want to edit.
The content types of this content type set is displayed.
You can edit the content type set. You can add models (page 690), objects (page 693),
connections (page 698), properties (page 704), and property groups (page 701).
689
3.16.10.1 Models
You can specify which models to display and use in ARIS.
3.16.10.1.1 Add model content types

You can add model content types to a content type set.
Prerequisite
Procedure
2. Click the content type set you want to edit.
3. In the Models section, click Create content type. The dialog opens.
6. Click Add model type. The dialog opens.

7. Click the model types that you want to add. You can filter the list by typing the first
letters of the model type you want to add.
8. Click Close.
9. If you want to use a model type for Contribution, click Used for contribution.
10. Optional: If you want to restrict the models by an attribute value, in the Attributes row,
click the arrow.
If you have created multiple model content types with the same model type, you must
restrict the models by an attribute value. Otherwise, you get an error notification. The
behavior of these model content types is undefined.
a. Start typing the name of the attribute you want to restrict. The matching attributes
are displayed.
b. Select the attribute that you want to restrict to a specific value and specify the value
and language.
11. Optional, only for Contribution: If you want to specify the group path to where the
models are stored, in the Location for new models row, click the arrow.
690
12. Enter the group path and select the language. The settings in this section are used only
by Contribution and not by ARIS Designer or ARIS Designer. The path of the group within
the main group is specified. In the following example, a group named Contribution
containing another group named My assigned models is created in the main group:
Contribution/My assigned models.
13. Click Save.
You have added a model content type.
Tip
You find more information about the items when you click Information.
3.16.10.1.2 Edit model content types

You can edit the model content types.
Prerequisite
Procedure
3. Click the arrow next to Models.
4. In the row of the relevant model item, click Details. The dialog opens.
7. Click Add model type. The dialog opens.

8. Click the model types that you want to add. You can filter the list by typing the first
letters of the model type you want to add.
9. Click Close.
10. If you want to use a model type for Contribution, click Used for contribution.
11. Optional: If you want to restrict the models by an attribute value, in the Attributes row,
click the arrow.
691
If you have created multiple model content types with the same model type, you must
restrict the models by an attribute value. Otherwise, you get an error notification. The
behavior of these model content types is undefined.
a. Start typing the name of the attribute you want to restrict. The matching attributes
are displayed.
b. Select the attribute that you want to restrict to a specific value and specify the value
and language.
models are stored, in the Location for new models row, click the arrow.
containing another group named My assigned models is created in the main group:
14. Click Save.
You have edited a model content type.
Tip
3.16.10.1.3 Remove model types

You can remove model types from a model content type.
Prerequisite
Procedure
4. In the row of the relevant model item, click Details. The dialog opens.
5. In the row of the relevant model type, click Delete.

6. Click Save.
The model type is removed from the model content types.
692
3.16.10.1.4 Delete model content type

You can delete model content types.
Prerequisite
Procedure
4. In the row of the relevant model item, click Delete. The dialog opens.
You have deleted a model content type.
3.16.10.2 Objects
You can specify which objects to display and model in ARIS.
3.16.10.2.1 Add object content types

You can add object items to a set of content types.
Prerequisite
Procedure
3. In the Objects section, click Create content type. The dialog opens.
4. Enter the technical name of the new item as an identifier, for example, Capability. The
identifier must be unique for all content types.
Click Add object type. The dialog opens.
693
6. Click the object types that you want to add. You can filter the list by typing the first
letters of the object type you want to add.
7. Click Close.
8. If you want to use an object type for Contribution, click Used for contribution.
9. Optional: If you want to restrict the objects by an attribute value, in the Attributes row,
click the arrow.
If you have created multiple object content types of the same object type, you must
restrict the object either by an attribute value or a symbol, or both. Otherwise, you get an
error notification. The behavior of these object content types is undefined.
a. Start typing the attribute name you want to exclude. The matching attributes are
displayed.
b. Select the attribute that you want to exclude and specify the value and language.
10. Optional: Enable Symbol type restrictions. If you enable Symbol type restrictions, you
can restrict the object types to specific symbols. You can enable that only the selected
symbol is used or that all other symbols are used.
You can add and remove symbols.
objects are stored, in the Location for new objects row, click the arrow.
containing another group named My assigned objects is created in the main group:
Contribution/My assigned objects.
13. Click Save.
You have added an object content type.
Tip
694
3.16.10.2.2 Add derived symbols

You can add derived symbols (page 754) to relation properties, which are already restricted by
symbols.
Prerequisite
Procedure
3. In the Objects section, click More.
4. Select Add derived symbols. The dialog opens.

5. All relation properties are searched for derived symbols. If derived symbols are available
for the symbols that are configured as filter for the relation property, they are displayed.
6. Select the derived symbols you want to add or select all.
7. Click Add to properties.
The derived symbols are added and you can use them when adding object content types
(page 693).
The derived symbols are added in the same way as the original symbol is configured. This
could be as a filter on Published content or as a symbol for creation when editing models
and a symbol for contribution.
3.16.10.2.3 Edit object content types

You can edit the object items of a set of content types.
Prerequisite
Procedure
695
3. Click the arrow next to Objects.
4. In the row of the relevant object item, click Details.
Click Add object type. The dialog opens.

5. Click the object types that you want to add. You can filter the list by typing the first
letters of the object type you want to add.
6. Click Close.
7. If you want to use an object type for Contribution, click Used for contribution.
8. Optional: If you want to restrict the objects by an attribute value, in the Attributes row,
click the arrow.
displayed.
objects are stored, in the Location for new objects row, click the arrow.
containing another group named My assigned objects is created in the main group:
Contribution/My assigned objects.
12. Click Save.
You have added an object content type.
Tip
696
3.16.10.2.4 Remove object types

You can remove object types from an object content type.
Prerequisite
Procedure
4. In the row of the relevant object item, click Details. The dialog opens.
5. In the row of the relevant object type, click Delete. If the object content type is
referenced by at least one relation property, a dialog that lists all these properties is
displayed. If you delete the object content type, the properties are adapted and the
references are deleted.
6. Click Save.
The object type is removed from the object content type.
3.16.10.2.5 Delete object content type

You can delete the object content types.
Prerequisite
Procedure
4. In the row of the relevant object, click Delete. The dialog opens.
5. Click Delete to confirm. A message is displayed if the object type has relations.
You have deleted the object content type.
697
3.16.10.3 Connections
You can specify which connections to display and model in ARIS.
3.16.10.3.1 Add connection content types

You can add connections to a set of content types.
Prerequisite
Procedure
3. In the Connections section, click Create content type. The dialog opens.
4. Enter the technical name of the new item as an identifier. The identifier must be unique
for all content types.
6. Click Add connection types. The dialog opens.

7. Click the connection types that you want to add. You can filter the list by typing the first
letters of the connection type you want to add.
8. Click Close.
9. Optional: If you want to restrict the connections by an attribute value, click the arrow
next to the Attributes (Optional) row.
If you have created multiple connection content types of the same connection type, you
must restrict the connection by an attribute value. Otherwise, you get an error
notification. The behavior of these connection content types is undefined.
displayed.
10. Click Save.
You have added a connection content type.
Tip
698
3.16.10.3.2 Edit connection content types

You can edit the connection items from a set of content types.
Prerequisite
Procedure
3. Click the arrow next to Connections.
4. In the row of the relevant connection item, click Details.
5. Click Add connection types. The dialog opens.

6. Click the connection types that you want to add. You can filter the list by typing the first
letters of the connection type you want to add.
7. Click Close.
8. Optional: If you want to restrict the connections by an attribute value, click the arrow
next to the Attributes (Optional) row.
If you have created multiple connection content types of the same connection type, you
must restrict the connection by an attribute value. Otherwise, you get an error
notification. The behavior of these connection content types is undefined.
displayed.
9. Click Save.
You have edited a connection content type.
Tip
699
3.16.10.3.3 Remove connection types

You can remove connection types from a connection content type.
Prerequisite
Procedure
4. In the row of the relevant connection item, click Details. The dialog opens.
5. In the row of the relevant connection type, click Delete.

6. Click Save.
The connection type is removed from the connection content types.
3.16.10.3.4 Delete connection content type

You can delete connection content types.
Prerequisite
Procedure
4. In the row of the relevant connection item, click Delete.

5. Click Yes to confirm.
You have deleted a connection content type.
700
3.16.10.4 Properties groups

You can specify the property groups to display and use in ARIS.
3.16.10.4.1 Add property group

You can add property groups.
Prerequisite
Procedure
3. Click the model, object, or connection item to which you want to add a property group.
4. Click Add property group. The dialog opens.

5. Enter the identifier, name, and language.
6. Click Save.
You have added the property group.
Tip
701
3.16.10.4.2 Edit a property group

You can edit a property group.
Prerequisite
Procedure
3. Click the model, object, or connection item for which you want to edit a property group.
4. In the line of the relevant property group, click More.
5. Select Show details to display the details of a property group. The dialog opens.
6. Change name and language.
You have edited the property group.
Tip
3.16.10.4.3 Move property group

You can move the property groups.
Prerequisite
Procedure
3. Click the model, object, or connection for which you want to move a property group.
4. In the line of the property group you want to move, click More.
5. Select Move up to move the property group up or select Move down to move the
property group down.
You have moved the property group.
702
3.16.10.4.4 Delete a property group

You can delete the property groups. You cannot delete the General property group.
Prerequisite
Procedure
3. Click the model, object, or connection for which you want to delete a property group.
4. In the line of the property group you want to move, click More.
5. Click Delete to delete the property group.

You have deleted the property group.
703
3.16.10.5 Properties
You can specify the properties to display and model in ARIS. You can specify and group
properties for models, object, and connections.
3.16.10.5.1 Add attribute property

You can add attribute properties.
Prerequisite
Procedure
3. Click the model or object to which you want to add a property.
4. Scroll to the relevant property group.
5. Click Create property.
6. Select Add attribute. The dialog opens.

7. Enter the identifier. The identifier must be unique only for this content type. For example,
you can have two object content types and both can have a property with identifier desc.
8. Optional: For each language, enter the name of the property that is displayed in the
portal. The name specified here is used only in the portal, not during modeling. By default,
the name that comes from ARIS Method is used.
9. Enter the attribute type. Start typing the attribute name to filter the list of attributes.
10. Select the relevant attribute.
11. Based on the property type, you can specify the data type, enable the property for editing
in the portal, and specify whether to use formatting in the publication. You can enable the
Handle as a user option if you want that the Select user(s) dialog is displayed when
modeling, for example, a person responsible.
12. Click Save.
You have added an attribute property.
Tip
704
3.16.10.5.2 Add relation

You can add relations. Relations include connections, implicit connections, implicit
relationships, as well as assignments (page 1124), and variant relationships. Therefore, the
term relation is a superordinate term for all links that can exist between objects and models.
Prerequisite
Procedure
3. Click the object to which you want to add a relation.
6. Select Add relation. The dialog opens.

7. Enter identifier, name, and language. The identifier must be unique only for this content
type. For example, you can have two object content types and both can have a property
with identifier desc. For each language, enter the name of the element that it is to be
displayed. At least one language must be maintained.
8. In the View section, specify the configuration for the portal.
a. You can add and remove content types. To add content types, click Add content
type. Select the target content types for the relations. To remove a content type,
click Delete.
b. Optional: Enable Target object types refinement.
You can add or remove object types. To add object types, click Add object
types. To delete an object type, click Delete.
c. In the Type section, specify whether you want to consider objects on definition level
(page 1129), objects that have occurrences (page 1147) in a model or in assignments
(page 1123). If you select Occurrences in assignments, you must select the model
type in which the assignments exist.
705
d. You can add and remove connection types. You must add at least one connection. To
add connections types, click Add connection types. Select the connection
types for the relation. To remove a connection type, click Delete. The Details of
configured relations displays the connections that are allowed according to the
ARIS method at the definition level.
e. Optional: For connections that can be both an incoming and an outgoing connection,
you can restrict the direction.
10. In the Edit section, specify the subset of settings that are used by ARIS Designer to
display and edit the related content on the Connected objects tab of the property panel
or ARIS Designer to display and edit the related content in the property panel. The same
applies to Contribution in the portal.
a. In the Type section, specify whether you want to consider objects on definition level
(page 1129), occurrences (page 1147) in a model or in assignments (page 1123). The
available options depend on the settings you defined in the View section. You can
enable only one option. If you select Occurrences in assignments, you must select
the model type in which the assignments exist. If you already selected a model in the
View section, you cannot select a model for assignments.
If you want to disable the Edit settings, enable the Read-only option.
b. Select all source and target object that have a connection for use in ARIS Designer or
ARIS Designer or for Contribution.
c. Optional: Specify the symbol types for creation in ARIS Designer or ARIS Designer.
The symbol list contains a subset of the symbols specified in the View section or the
symbols specified for the target content types.
d. Optional: Specify the symbol type for creation in Contribution.
e. Optional: Specify the assignment settings. The settings in this section are used only
by Contribution and not by ARIS Designer or ARIS Designer.
Specify the language, model name, and group for models. You can include the
expression ${name} if you want to use the object name in a model name for the
assignment. Example: My object ${name} assignment.
Enter the group path and select the language. The path of the group within the main
group is specified. In the following example, a group named Contribution containing
another group named My assigned models is created in the main group:
706
If you enable the Relative path option, the assigned model is generated in the group
of the object for which you created an assignment in a subgroup with the specified
name.
11. Click Save.
You have added the relation.
Tip
3.16.10.5.3 Add XML property

You can add properties in XML format. Properties in XML format support more extensive
configuration, unlike relations and attribute properties. When you save an XML property, the
XML is validated.
Prerequisite
Procedure
3. Click the model, object, or connection to which you want to add an XML property.
6. Select Add XML. The dialog opens.

7. Enter the name and language. For each language, enter the name of the element that it is
to be displayed. At least one language must be maintained. The XML must contain an
identifier. This identifier is read from the XML snippet and placed into the read-only
identifier field. The identifier must be unique only for this content type. For example, you
can have two object content types and both can have a property with identifier desc.
8. Click Save.
You have added the XML property.
707
Tip
We recommend that you write the XML property in an XML editor. Using an XML editor helps
you to write a valid XML snippet. You find more information about the items when you click
Information.
3.16.10.5.4 Edit a property

You can edit a property.
Prerequisite
Procedure
3. Click the model, object, or connection for which you want to edit a property.
5. Click the relevant property. The dialog opens.
6. Make you changes.
7. Click Save.
You have edited the property.
Tip
708
3.16.10.5.5 Display usage of properties

You can display whether a property is used in other properties or hierarchies.
Prerequisite
Procedure
2. Click on the content type set for which you want to display the usage of the properties for
a content type.
3. Click on the content type set for which you want to display the usage of the properties for
a content type.
4. Click the model, object, or connection for which you want to display the usage of a
property.
6. Select the relevant property.
7. Click References.
All properties and hierarchies that use the content type are displayed. The name, the content
type and the type of the property is displayed.
3.16.10.5.6 Move property

You can move a property to a different property group.
Prerequisite
Procedure
3. Click the model, object, or connection for which you want to move a property.
4. Click the arrow next to the relevant property group.
5. In the line of the property you want to move, click More.

6. Select Move up to move the property up or select Move down to move the
property down. You can select multiple properties and move them using drag and drop.
You have moved the property.
709
3.16.10.5.7 Move property to a different group

You can move the properties to a different property group.
Prerequisite
Procedure
3. Click the model, object, or connection for which you want to move a property to a
different property group.
4. Click the arrow next to the relevant property group.
5. In the line of the property you want to move, click More.

6. Select Move to to set a different property group for the property.
7. Select the relevant property group from the list and click OK.
You have moved the property to a different property group.
Tip
You can move properties using drag and drop.
3.16.10.5.8 Delete a property

You can delete a property.
Prerequisite
Procedure
3. Click the model, object, or connection from which you want to delete a property.
4. In the line of the property you want to delete, click More.
5. Click Delete to delete the property. The dialog opens.

You have deleted the property.
710
3.16.10.6 Hierarchies
Hierarchies specify what the Published content displays.
3.16.10.6.1 Import a hierarchy

You can import an existing hierarchy. If you have already an existing hierarchy, the imported
hierarchy overwrites the existing one. We recommend that you backup (page 687) your
existing configuration before you import a configuration in case that the imported
configuration does not meet your expectations.
Prerequisite
Procedure
You cannot import a hierarchy of an active content type set. You must deactivate the
content type set first. To do so, click Manage sets and in the row of the relevant set, click
Active. The content type set is deactivated.
3. Click the content type set for which you want to import a hierarchy.
4. Click Hierarchies.
5. You can only import a hierarchy if no hierarchy is selected. Click Import from portal.
You have imported a hierarchy.
3.16.10.6.2 Copy a hierarchy

You can copy an existing hierarchy.
Prerequisite
Procedure
2. Click the content type set for which you want to copy a hierarchy.
711
4. Select the hierarchy you want to copy.
5. Click Copy.
You have copied a hierarchy.
3.16.10.6.3 Create a hierarchy

You can create a new hierarchy.
Prerequisite
Procedure
4. Click Create new hierarchy.
You have created a hierarchy.
Example
The following image displays the definition of a process hierarchy.
712
The following image shows, what the Published content on the Processes tab will display
for the Processes hierarchy.
3.16.10.6.4 Display and edit hierarchy details

You can display the hierarchy details.
Prerequisite
Procedure
4. Select the hierarchy for which you want to display the details.
5. Click Details. The dialog opens.

The hierarchy details are displayed. The hierarchy identifier and name are displayed. You can
edit the name in multiple languages and the identifier, if needed.
713
3.16.10.6.5 Activate a hierarchy

You can activate an existing hierarchy.
Prerequisite
Procedure
4. Select the hierarchy you want to activate.
5. Click Activate.
You have activated a hierarchy. Only active hierarchies are displayed on the Published
content page.
3.16.10.6.6 Deactivate a hierarchy

You can deactivate an existing hierarchy.
Prerequisite
Procedure
4. Select the hierarchy you want to deactivate.
5. Click Deactivate.
You have deactivated a hierarchy.
714
3.16.10.6.7 Add hierarchy root

You can add hierarchy root. This is required.
Prerequisite
Procedure
2. Click the content type set for which you want to specify a hierarchy root.
4. Click the hierarchy item to which you want to add a hierarchy root.
5. Click Create hierarchy root. The dialog opens.
6. Specify the settings. Specify the root content type and a corresponding property leading
to the same content type for root item retrieval.
Information contains information regarding the optional parent property.

You have added a hierarchy root to the hierarchy.
3.16.10.6.8 Display and edit root details

You can display the root item details.
Prerequisite
Procedure
4. Select the hierarchy for which you want to display the root details.
5. In the row of the root item, click Details. The dialog opens.
The root item details are displayed. The root content type and a corresponding property
leading to the same content type for root item retrieval are displayed.
715
3.16.10.6.9 Define start elements

You can define start elements. This is not required. Start elements are, for example, a specific
model or group in a database. You can, for example, define several start elements if you use
several databases.
Prerequisite
Procedure
4. Click the relevant hierarchy.
5. Click Define start elements. The dialog opens.
6. Click Add.
7. Enter the GUID (page 1140) of the start element. To find the GUID, do the following.
a. Click Application launcher > Models & Objects.
b. If you have more than one database, select the relevant database.
c. In the row of the group or model, click More.
d. Select Technical information. The dialog opens.

e. Copy the GUID. You can paste the GUID to the relevant field.
8. Click Confirm.
9. Specify whether the hierarchy should be displayed in case the start element is not
accessible in the database.
10. Click Save.
You have defined a start element for the hierarchy.
Tip
You find more information about the elements when you click Information.
716
3.16.10.6.10 Add a hierarchy child item to a hierarchy

You can add hierarchy child items to a hierarchy. Hierarchy children are displayed in the
hierarchy tree.
Here you select a property. Then the hierarchy-creating property and the result hierarchy
elements (content types) are added. If you do not want some of the automatically inserted
result content types to be part of the hierarchy tree, you can delete them later. You can add
them again later by editing the properties of the hierarchy item property.
Prerequisite
Procedure
4. Click the hierarchy item to which you want to add a child item.
5. Click Add hierarchy child. The dialog opens.

6. Specify the settings.
You have added a hierarchy child to the hierarchy item.
717
3.16.10.6.11 Display and edit hierarchy item details

You can display the hierarchy child details.
Prerequisite
Procedure
5. In the row of the hierarchy child item, click Details. The dialog opens.
The hierarchy child details are displayed. You can can select a property. Then the
hierarchy-creating property and the result hierarchy elements (content types) are added. If
you do not want some of the automatically inserted result content types to be part of the
hierarchy tree, you can delete them later. You can add them again later by editing the
properties of the hierarchy item property.
3.16.10.6.12 Display and edit hierarchy item/property details

You can display the hierarchy child/property details.
Prerequisite
Procedure
5. In the row of the hierarchy child item/property, click Details. The dialog opens.
The hierarchy child/property details are displayed. You can can select a property.
718
3.16.10.6.13 Add a navigation child to a hierarchy

You can add navigation child items to a hierarchy. Navigation children are objects used to
specify which tree item should be selected in the portal tree if an item of the child type is
selected in another panel.
Navigation child items do not occur in the portal tree.
Prerequisite
Procedure
4. Click the hierarchy item to which you want to add a child item.
5. Click Add navigation child. The dialog opens.

6. Specify the settings.
You added a navigation child to the hierarchy item.
Tip
719
3.16.10.6.14 Display and edit navigation item details

You can display the navigation child item details.
Prerequisite
Procedure
5. In the row of the navigation child item, click Details. The dialog opens.
The navigation child item details are displayed.
Tip
3.16.10.6.15 Delete an item

You can delete hierarchy items.
Prerequisite
Procedure
5. In the row of the relevant item, click Delete.
You have deleted a hierarchy item.
720
3.16.10.6.16 Delete a hierarchy

You can delete an existing hierarchy.
Prerequisite
Procedure
2. Click the content type set for which you want to delete a hierarchy.
4. Select the hierarchy you want to delete.
5. Click Delete.
You have deleted a hierarchy.
721
3.16.10.7 Portal search

You define here which content types are to be included in the search and the order of the
filter criteria for the advanced search in the portal.
3.16.10.7.1 Import a search

You can import an existing search configuration. If you have already an existing search
configuration, the imported configuration overwrites the existing one. We recommend that
you backup (page 687) your existing configuration before you import a configuration in case
that the imported configuration does not meet your expectations.
Prerequisite
Procedure
2. Click the content type set for which you want to import a search.
You cannot import a search configuration of an active content type set. You must
deactivate the content type set first. To do so, click Manage sets and in the row of the
relevant set, click Active. The content type set is deactivated.
3. Click Portal search.
4. Click Import from portal.
You have imported an existing search configuration.
3.16.10.7.2 Add item to search

You can add search items to the search to be displayed in the portal.
Prerequisite
Procedure
2. Click the content type set for which you want to configure the portal search.
722
4. Click Add to search. The dialog opens.

5. Select the items you want to add.
6. Click Add.
You have added search items to the search to be displayed in the portal.
Tip
3.16.10.7.3 Move search item

You can change the order in which the search filter for the advanced search is displayed in
the portal.
Prerequisite
Procedure
2. Click the content type set for which you want to move a search item.
4. In the line of the search item, you want to move, click More.
5. Select Move up to move the search item up or select Move down to move the
search item down. You can select multiple properties and move them using drag and
drop.
You have changed the order in which the search filter for the advanced search is displayed in
the portal.
723
3.16.10.7.4 Delete item from search

You can delete search items from the portal search.
Prerequisite
Procedure
2. Click the content type set for which you want to delete an item from the portal search.
4. Select the items you want to remove from the search.
5. Click Delete.
You have deleted search items from the search. Deleted items are no longer displayed on the
advanced search in the portal.
3.16.11 Delete a content type set

You can delete an existing set of content types. The ARIS default configuration cannot be
deleted.
Prerequisite
Procedure
2. Select the set of content types you want to delete.
3. Click Delete. The dialog opens.

The set of content types is deleted.
724
3.17 Configure ARIS Method

With the ARIS Method defined in this section, configuration administrators (page 53) ensure
that only the defined method items are used. Detailed information on method items is
available in the ARIS Method help
(../../../../../../../abs/help/en/method/#/home/methodhelp/en/1). No method help is available
for user-defined, derived, and customized types.
You can modify the set of objects, symbols, attributes, models, and connections so that these
sets are available in all databases of a project room. Therefore, you must assign the method
extensions, such as attribute types, to other items like model types, and allow them to be
used in filters (page 819).
You can make method extensions available to databases on another project room by
exporting (page 831) method filters and transferring the method extensions during the
subsequent filter import (page 820). To continue using user-defined or customized method
items from previous ARIS versions, you must import (page 820) the previous filters that
contain all user-defined and customized items. These items are created and thus become
visible only due to the filter import. You must restore the databases of previous versions on
your current project room after the filter import.
In this section, you can also manage configuration languages (page 684).
3.17.1 Model types

Model types are templates for models that define which attributes are available, which object
symbols a model can contain, and how these objects relate to other objects. If you define a
set of model types for each tenant, you ensure that the appearance of all items complies with
your company's corporate design.
Models are a collection of objects (page 1146) and connections (page 1126). Models are
graphic representatives of processes, structures, data, etc. of a company. Models, objects,
and connections are described in detail by attributes (page 1124). While objects represent
activities, states, data, etc., connections represent how objects relate to each other.
Models are based on model types (page 1145) that specify certain rules, such as which
connections are allowed between objects and thus, how they relate to each other.
Configuration administrators (page 53) can rename model types or delete the ones you do not
want to use. If you have special modeling requirements that are not covered by the provided
ARIS Method items, you can create your own ARIS model types from scratch or derive them
from existing model types.
725
To continue using user-defined or customized method items from previous ARIS versions,
you must import (page 820) the previous filters that contain all user-defined and customized
items. These items are created and thus become visible only due to the filter import. You must
restore the databases of previous versions on your current tenant after the filter import.
On the Model Types page, you can find all model types that are included in the ARIS Method
of this tenant. Use the filter to find the type you want to continue with. The table contains
the following columns. If you click a header, the column entries are sorted.
Name
Shows the type name in the current language. The names shown are related to the Type
column.
Type number
Number assigned to a specific API name in ARIS Method. Type number and API name are
unique identifiers for database items that are used to define types in ARIS Method. You can
find detailed information on method items in the ARIS Method help
(../../../../../../../abs/help/en/method/#/home/methodhelp/en/1). No Method help is available
for user-defined method items. If you want to call user-defined method items in scripts,
please use the GUID of the item instead of the type number. The GUID can be found on the
Properties page of the item.
API name/GUID
Name for ARIS Method items that are assigned to a specific type number. You can find
detailed information on method items in the ARIS Method help
(../../../../../../../abs/help/en/method/#/home/methodhelp/en/1). If you created your own
method items, the Globally Unique Identifier (GUID) is used instead.
Type
The Type column indicates whether an ARIS Method item is any of the following types:
 Unchanged original (Default)
 Item that you cannot modify (Default (not configurable))
 Modified item that was based on an original (Derived)
 Item that was changed by an authorized user (Customized)
 Item that was added to the default ARIS Method (User-defined).
726
3.17.1.1 Create model type

If you have special modeling requirements that are not covered by the provided ARIS Method
items, you can create your own ARIS model types from scratch or derive them from existing
model types. This ensures that the appearance of all items complies with your company's
corporate design. If you do not want to create a type from scratch, you can save time and
derive your new type from an existing default type.
Prerequisite
 If you have created your own method items, such as models (page 725), objects (page
742), symbols (page 754), attributes (page 779), and connections (page 767), on a
different tenant, make sure to import the method filter (page 820) that contains these
user-defined method items into this tenant.
Procedure
4. Click Model types.
5. Click Create model type.
If you want to create a model type based on an existing one, select the base model type
and click Derive model type.
6. Select all configuration languages that you use on this tenant.
7. Enter the attribute values, such as Name and Description. You cannot edit certain
attributes that are set by the system, such as Original name, API name, or GUID.
Warning
You must enter all values in each language. If you do not enter the name and description
in a language, users who log in with this language will not be able to find this filter
because (Untitled) is displayed as the filter name.
8. Assign the required attributes that you want to make available in models of this new type.
9. Click Attributes to select the attribute types that you want to make available for this
model type. If you just created the model type but you have not yet assigned any
attributes, the Show only assigned view displays all locked attributes. Locked items
are mandatory items. That means that you cannot remove or modify them.
10. Select the Show all view. All available attributes (attribute types) are shown.
727
11. To assign the required attributes, enable the controls in the Assigned column.
Use the filter to quickly find attributes or sort the columns. If you are looking for
attributes you configured, filter the list using the User-defined keyword. If you click a
header, the column entries are sorted.
12. Click Assign. In the Show only assigned view, all selected attributes are listed and
shown as assigned.
13. Check the assignment. Click Remove to delete selected attributes from the model
type.
14. If the assignment is OK, click Apply.
15. Select the symbols that should be used to place model objects.
16. Click Symbols and decide how objects should be displayed in models of this type. In the
Show All view, select at least one object symbol that you want to make available. In
contrast to the table you used to assign attributes (page 730), here the columns Object
type and Symbol are additionally available. You can use these columns to quickly find the
required symbols.
17. Select a default symbol if required. The default symbol is used for the assigned object
type if users insert this object in a model of this type.
18. Select an editable symbol and click More.

19. Click Enable 'Default' or Disable 'Default', as required.
20. Decide whether an object symbol represents a basic object or a satellite. Basic objects are
mandatory model objects transporting information that is distinctive for the model. Basic
objects are used to build the typical structure of a model. Satellites only contain
additional information.

22. Click Enable 'Structural' or Disable 'Structural', as required.
23. Click Assign. In the Show only assigned view, all selected symbols are listed and shown
as assigned.
24. Check the assignment. Click Remove to delete selected symbols from the model type.
26. Decide which connections should be available in your new model type.
27. Click Connections and decide how objects should be connected to each other in models
of this type. For detailed information about how to connect object symbols and object
types, click Information and use the required view (page 736).
You can either select the connections from a list, or you can decide which object symbols
or which object types are connected.
728
28. If you want to select connection types that are available for a model type, click from all
available connection types.
If you just created the model type but you have not yet assigned any connections, the
Show only assigned view displays all mandatory connection types that are locked.
Locked items are mandatory items. That means that you cannot remove or modify
them.
a. Select the Show all view to select the required types.
b. To assign the required connections, enable the controls in the Assigned column.
c. Use the filter to quickly find connections or sort the columns.
29. If you want to select connections that are available between distinct source object
symbols and target object symbols, click between object symbols. This action is
appropriate when object types provide multiple object symbols. In this case, you can
decide how to connect objects that use a specific object symbol.
a. Enable the source object symbols from which the connection should point. Use the
filter to find a list entry.
b. Enable the target object symbols to which the connections should point.
c. Select the required connection types. If you just created the model type but you
have not yet assigned any connections, the Show only assigned view displays all
mandatory connection types that are locked. Locked items are mandatory items.
That means that you cannot remove or modify them.
d. Select the Show all view to select the required types.
30. If you want to select connections that are available between source object types and
target object types, click between object types. In this case, users can connect objects
using the selected connections regardless of which object symbols are displayed.
a. Enable the source object type from which the connection should point. Use the
b. Enable the target object types to which the connections should point.
31. Click Assign. In the Show only assigned view, all selected connections are listed and
shown as assigned.
32. Check the assignment. Click Remove to delete selected connections from the model
type.
729

34. Click Apply.
35. Add (page 835) your new model type to the method filter that users should use for login.
The model type is created and can be used in filters (page 819).
Your new model type is available for all users of this tenant who logged in with a method filter
that contains your new model type.
3.17.1.2 Use other attributes in model types

If you want to change the set of attributes that are available in model types, proceed as
follows.
Prerequisite
Procedure
5. Click the entry that you want to change. Use the filter to find a list entry.
model type. If you just created the model type but you have not yet assigned any
7. Select the Show all view. All available attributes (attribute types) are shown.
shown as assigned.
730
type.
All selected attribute types are available in models of this type.
3.17.1.3 Use other symbols in model types

If you want to change assigned object symbols, proceed as follows.
Prerequisite
Procedure
required symbols.
7. Select a default symbol if required. The default symbol is used for the assigned object
type if users insert this object in a model of this type.

10. Decide whether an object symbol represents a basic object or a satellite. Basic objects are
mandatory model objects transporting information that is distinctive for the model. Basic
objects are used to build the typical structure of a model. Satellites only contain
additional information.
731

13. Click Assign. In the Show only assigned view, all selected symbols are listed and shown
as assigned.
14. Check the assignment. Click Remove to delete selected symbols from the model type.
All selected object symbols are available in models of this type.
3.17.1.4 Change 'Structural' setting for model type

You can decide whether an object symbol in a model represents a basic object or a satellite.
Basic objects are mandatory model objects transporting information that is distinctive for the
model. Basic objects build the typical structure of a model. Satellites contain additional
information.
Prerequisite
Procedure
4. Click Model types.Click the entry that you want to change. Use the filter to find a list
entry.
required symbols.

8. Click Apply.
The setting is changed.
732
3.17.1.5 Change 'Default' setting for model type

A default symbol is an object symbol that is automatically used when users insert an object in
a model.
A default symbol is the object symbol that is used to represent the object if users insert an
object of this type into a model. You specify default symbols for object types and model
types.
Object types
If you assign a single object symbol to an object type, you do not need to define a default
symbol. You must specify a default symbol for each object type that can have multiple
occurrences in a model, that is, the object can be displayed using multiple object symbols. In
this case, the default symbol is displayed automatically when users place the object in a
model. Users can add any other object symbols for modeling that are available for this object.
If the object definition has no information about the default symbol, the default symbol
specified for the model type is used to create occurrence copies in a model.
Model types
If no default symbol is specified at an object type, the model generation function and the
function for creating an occurrence copy use the default symbol specified for the model type.
Prerequisite

Procedure
6. Click Symbols.
733

9. Click Apply.
3.17.1.6 What is a default symbol?

types.
Object types
Model types
3.17.1.7 Use other connections in model types

To change the set of assigned connections, proceed as follows.
Prerequisite
Procedure
734
6. Click Connections and decide how objects should be connected to each other in models
of this type. For detailed information about how to connect object symbols and object
types, click Information and use the required view (page 736).
If you just created the model type but you have not yet assigned any connections, the
Show only assigned view displays all mandatory connection types that are locked.
them.
b. To assign the required connections, enable the controls in the Assigned column.
c. Use the filter to quickly find connections or sort the columns.
8. If you want to select connections that are available between distinct source object
symbols and target object symbols, click between object symbols. This action is
appropriate when object types provide multiple object symbols. In this case, you can
decide how to connect objects that use a specific object symbol.
a. Enable the source object symbols from which the connection should point. Use the
target object types, click between object types. In this case, users can connect objects
using the selected connections regardless of which object symbols are displayed.
a. Enable the source object type from which the connection should point. Use the
735
10. Click Assign. In the Show only assigned view, all selected connections are listed and
shown as assigned.
type.
All selected connections are available in models of this type.
3.17.1.8 Get information about object symbols and

connections
To change the set of assigned connections (page 734), you need knowledge of how to
connect object symbols and object types. To get detailed information, use the views available
on the Information pages.
Prerequisite
Procedure
6. Click Information and use one of the views to find the relevant information.
a. If you want to know which symbols you can connect with a connection type, focus a
connection and click Connections with source and target.
736
b. Select the connection type. Use the filter to find a list entry. All source objects
and target objects that you can connect using this as a the connection type are
listed.
c. If you want to know which connections to use to connect target symbols, focus a
source symbol and click Symbols with outgoing connections.
d. Select the source symbol. All related connections that can point out from the
selected symbol are displayed.
e. Select a connection type to see the related target symbols. In this case, the active
names are shown because the connection points from the source to the target. The
name of a connection type is always used as the active name.
f. If you want to know which connections to use to connect source symbols, focus a
target symbol and click Symbols with incoming connections.
g. Select the target symbol. All related connections that can point to the selected
symbol are displayed.
h. Select a connection type to see the related source symbols. In this case, the
passive names are shown because the connection points from the target to the
source.
The results are not displayed permanently. Make sure to take a screen shot of the screens.
This will help you to change the set of provided connection types (page 734).
3.17.1.9 Rename model type in all languages

You can change the names and descriptions of model types.
Prerequisite
Procedure
737
6. Select all required languages, then overwrite the names and change the descriptions in
each language as required.
7. Click Apply.
The names and descriptions are changed. For default ARIS Method items, the original names
always remain so that you can easily reset your modifications to the default state.
3.17.1.10 Rename model type in current language

You can change the name of a model type in the current language. You cannot modify types
of the Default (not configurable) type.
Prerequisite
Procedure
5. Select the name that you want to change. Use the filter to find a list entry.
6. Click Rename.
7. Change the name as required.
8. Click Save.
The name is changed in the current language. The type changes to Customized. This makes
it easy to find renamed items using Customized as a filter. For default ARIS Method items,
the original name always remains so that you can easily reset your modifications to the
default state.
738
3.17.1.11 Reset model type name in current language

You can reset the name of user-defined and customized model types in the current language.
Prerequisite
Procedure
6. Click Rename. The current name is displayed.
7. Click Reset. The original name is used in the current language.
8. Click Save.
The name is changed in the current language.
739
3.17.1.12 Reset model type

You can replace one or several of the changed method items on this tenant with items from
the standard ARIS method.
Prerequisite
Procedure
5. Enter Customized as a keyword and filter the list to find all customized types that you
can reset.
6. Enable the items that you want to reset to the default state.
7. Click Reset.
Warning
All selected customized method items are deleted and replaced by default ARIS Method
items. Make sure that you exported (page 831) method filters containing customized
method items before you proceed. Then you can restore customized method items by
importing (page 820) the filters again.
8. Click Reset.
All selected items are reset to the default state.
740
3.17.1.13 Delete model type

If you no longer want to use a user-defined or a derived model type, you can delete it from the
ARIS Method of a tenant. To prevent users from using a model type, you must remove it from
the available method filters. In this case, you do not have to delete the model type from the
ARIS Method of your tenant.
Prerequisite
Procedure
5. Select the entries that you want to delete. Use the filter to find the list entries.
You can delete only user-defined and derived types. Because default types are
mandatory in ARIS Method, and customized types are renamed default types, you cannot
delete those two types.
6. Click Delete.
The selected model types are deleted from the ARIS Method of this tenant.
741
3.17.2 Object types

Object types are templates for model objects that define which attributes are available, which
object symbols a model can contain, and how these objects relate to other objects. If you
define a set of object types for each tenant, you ensure that the appearance of all items
complies with your company's corporate design.
An object is a container for information. Its information content is supplemented by attributes
(page 1124), Thus, an object represents a given situation, an activity, a status, etc. For
example, it represents a work step or an organizational unit of a company. Linked together in
models (page 1143), the occurrences (page 1147) reflect the reality of companies.
An object consists of a definition (page 1146) and an occurrence (page 1147), derived from an
object type (page 1146).
Configuration administrators (page 53) can rename object types or delete the user-defined
types you do not want to use. If you have special modeling requirements that are not covered
by the provided ARIS Method items, you can modify existing object types as required.
On the Object types page, you can find all object types that are included in the ARIS Method
Name
column.
Type number
API name/GUID
742

Type
3.17.2.1 Modify object type

items, you can modify existing object types as required. This ensures that the appearance of
all items complies with your company's corporate design. You cannot create or derive object
types, but you can rename them and change the set of attributes, symbols, and connections
allowed for modeling.
Prerequisite
Procedure
4. Click Object types.
743
Warning
8. Assign the required attributes that you want to make available for objects of this type.
object type. If you just created the object type but you have not yet assigned any
10. Select the Show all view.
shown as assigned.
13. Check the assignment. Click Remove to delete selected attributes from the object
type.
14. Select the model types that you want to allow users to assign to objects of this type.
15. Click Assignments to select the model types that you want to provide as object
assignments for objects of this type. If you just created the object type but you have not
yet assigned any model types, the Show only assigned view displays all locked model
types. Locked items are mandatory items. That means that you cannot remove or
modify them.
17. To assign the required models, enable the controls in the Assigned column.
Use the filter to quickly find model types or sort the columns. If you are looking for
model types you configured, filter the list using the User-defined, Derived, or
Customized keywords. If you click a header, the column entries are sorted.
18. Click Assign. In the Show only assigned view, all selected models are listed and
shown as assigned.
19. Decide whether users can only assign one model of this type to the object or if multiple
models of this type can be assigned.
20. Select the editable model type and click More.

21. Click Enable 'Unique' or Disable 'Unique', as required.
744
22. Decide whether an occurrence of the object to which the model is assigned is inserted to
the assigned model or if the assigned model should be empty.

24. Click Enable 'Insert object' or Disable 'Insert object', as required.
25. Check the assignment. Click Remove to delete selected models from the object type.
27. Click Connections to see which connections are available between model objects. You
cannot modify the set of connections.
If you want to change the connection types that users can use to connect object symbols
or objects of a certain type, you must modify the set of connection types in the related
model type (page 734).
28. Click Apply.
29. Add (page 836) the object type to the method filter that users will use for login.
The object type is changed and is available for all users of this tenant who logged in with a
method filter that contains this object type.
If you want to use a different symbol for a model object, you must first derive the object
symbol (page 756) and change the symbol graphics (page 758).
3.17.2.2 Use other attributes in object types

If you want to change attributes that are assigned to object types, proceed as follows.
Prerequisite
Procedure
5. Click the name of the object type that you want to edit.
745
object type. If you just created the object type but you have not yet assigned any
shown as assigned.
10. Check the assignment. Click Remove to delete selected attributes from the object
type.
All selected attribute types are available for objects of this type.
3.17.2.3 Assign other models to object types

If you want to change the set of models that can be assigned to objects, proceed as follows.
Prerequisite
Procedure
746
6. Click Assignments to select the model types that you want to provide as object
assignments for objects of this type. If you just created the object type but you have not
yet assigned any model types, the Show only assigned view displays all locked model
types. Locked items are mandatory items. That means that you cannot remove or
modify them.
shown as assigned.
10. Decide whether users can only assign one model of this type to the object or if multiple
models of this type can be assigned.

13. Decide whether an occurrence of the object to which the model is assigned is inserted to
the assigned model or if the assigned model should be empty.

16. Check the assignment. Click Remove to delete selected models from the object type.
All selected models can be assigned to objects of this type.
747
3.17.2.4 Change 'Insert object' setting for object

assignment
You can decide whether an occurrence of the object to which the model is assigned is
inserted to the assigned model or if the assigned model should be empty.
Prerequisite
Procedure
6. Click Assignments to select the model type for which you want to change the setting.

9. Click Apply.
10. The setting is changed.
748
3.17.2.5 Change 'Unique' setting for object assignment

Decide whether users can only assign one model of a type to the object or if multiple models
of a type can be assigned.
Prerequisite
Procedure

9. Click Apply.
749
3.17.2.6 Rename object type in all languages

You can change the names and descriptions of object types. You cannot modify types of the
Default (not configurable) type.
Prerequisite
Procedure
7. Click Apply.
750
3.17.2.7 Rename object type in current language

You can change the name of user-defined, customized, and default object types in the
current language. You cannot modify types of the Default (not configurable) type.
Prerequisite
Procedure
6. Click Rename.
8. Click Save.
default state.
751
3.17.2.8 Reset object type name in current language

You can reset the name of user-defined and customized object types in the current language.
Prerequisite
Procedure
5. Select the name of the object type that you want to change. Use the filter to find a
list entry.
8. Click Save.
752
3.17.2.9 Reset object type

Prerequisite
Procedure
can reset.
7. Click Reset.
Warning
8. Click Reset.
753
3.17.3 Object symbols

Object symbols are graphical representations of object types. They are displayed in models
and lists.
Configuration administrators (page 53) can only rename default, customized, and derived
object symbols or delete symbols of these types that you do not want to use. If you have
special modeling requirements that are not covered by the provided ARIS Method items,
create your own object symbols by deriving (page 756) them from existing object symbols. In
derived symbols, you can replace (page 758) the default symbols of ARIS Method with your
own user-defined symbols. You can design user-defined symbols in AMF format using ARIS
Symbol Editor.
Use ARIS Symbol Editor to create user-defined symbols. To open ARIS Symbol Editor, start
ARIS Architect and click ARIS > Symbol Editor (for details, refer to the ARIS Symbol Editor
online help (../../../../../../../abs/help/en/handling/ba/#/home/68185/en/1)).
On the Object symbols page, you can find all symbol types that are included in the method
filter with which you logged in. Use the filter to find the type you want to continue with.
The table contains the following columns. If you click a header, the column entries are sorted.
Name
column.
Symbol
Symbol graphics in AMF format that are currently used to place objects in models or used as a
thumbnail to display objects in lists.
Object type
Object types that use the related object symbol to be placed in models or as a thumbnail to
display objects in lists. If the Object type column contains multiple entries with the same
name, also use the Type number and the API name/GUID columns to find the specific
object.
Type number
754
API name/GUID
Type
755
3.17.3.1 Derive object symbols

Object symbols are graphical representations of object types. They are displayed in models
and lists. You can replace the default symbols of ARIS Method with your own user-defined
symbols. You can design user-defined symbols in AMF format using ARIS Symbol Editor.
If you want to use self-designed symbol graphics in AMF format, you must first derive a
related object symbol. You cannot change symbol graphics in default object symbols.
Prerequisite
 You have access to an AMF graphic file that was created using ARIS Symbol Editor.
Procedure
4. Click Object symbols.
5. Select the name of the object symbol from which you want to derive your new object
symbol. User-defined symbols inherit the method settings of the original symbols, that is,
they are automatically available in all models in which the original symbols are allowed.
For this reason, make sure that you use the most suitable object symbol as the basis of
your derived object symbol. The connections are also inherited from the original symbol.
Use the filter to find the most suitable object symbol. If the Object type column
contains multiple entries with the same name, also use the Type number and the API
name/GUID columns to find the specific object.
6. Click Derive symbol.
756
Warning
9. Change the used symbol graphic.
10. Click Symbol and click Browse.
11. Select the AMF graphic file and click Open.
12. Click Apply. The selected symbol is displayed in the Symbol column.
13. Change the set of model types to make the derived symbol available in additional models.
14. Click Used in model types to select the model types in which you want to provide the
object symbol. The Show only assigned view displays all locked model types. Locked
items are mandatory items. That means that you cannot remove or modify them.
model types you configured, filter the list using the User-defined keyword. If you click a
shown as assigned.
type.
20. Click Apply.
21. Add (page 839) your derived object symbol to the method filter that users will use for
login. Derived object symbols inherit the method settings of the original symbols, that is,
they are automatically available in all models in which the original symbols are allowed.
The connections are also inherited from the original symbol.
Your derived object symbol is available for all users of this tenant who logged in with a
method filter that contains your new object symbol.
757
3.17.3.2 Use other symbol graphics for object types

If you want to change the object symbol that is used to place objects in models, proceed as
follows. You can change only derived object symbols.
Prerequisite
 You have derived (page 756) an object symbol.
Procedure
5. Click the name of the derived object symbol that you want to change. Use the filter to
find the object type. If the Object type column contains multiple entries with the same
name, also use the Type number and the API name/GUID columns to find the specific
object.
The selected object symbol displays objects of the selected type.
758
3.17.3.3 Use other symbols for object types

If you want to make object symbols available in other models, proceed as follows.
Prerequisite
Procedure
4. Click the name of the object symbol that you want to change. Use the filter to find the
object type.. If the Object type column contains multiple entries with the same name,
also use the Type number and the API name/GUID columns to find the specific object.
object symbol. The Show only assigned view displays all locked model types. Locked
shown as assigned.
type.
The selected object symbol is available in models of the selected types.
759
3.17.3.4 Change 'Structural' setting for object symbol

You can decide whether an object symbol in a model represents a basic object or a satellite.
Basic objects are mandatory model objects transporting information that is distinctive for the
model. Basic objects build the typical structure of a model. Satellites contain additional
information.
Prerequisite
Procedure
6. Click Used in model types.

9. Click Apply.
760
3.17.3.5 Change 'Default' setting for object symbol

A default symbol is an object symbol that is automatically used when users insert an object in
a model.
types.
Object types
Model types
Prerequisite
Procedure
6. Click Used in model types..
761

9. Click Apply.
3.17.3.6 Rename object symbol in all languages

You can change the names and descriptions of the object symbols. You cannot modify types
of the Default (not configurable) type.
Prerequisite
Procedure
7. Click Apply.
762
3.17.3.7 Rename object symbols in current language

You can change the name of user-defined, customized, and default object symbols in the
current language. You cannot modify types of the Default (not configurable) type.
Prerequisite
Procedure
6. Click Rename.
8. Click Save.
default state.
763
3.17.3.8 Reset object symbol name in current language

You can reset the name of user-defined and customized object symbols in the current
language.
Prerequisite
Procedure
8. Click Save.
764
3.17.3.9 Reset object symbol

Prerequisite
Procedure
can reset.
7. Click Reset.
Warning
8. Click Reset.
765
3.17.3.10 Delete object symbol

If you no longer want to use an object symbol, you can delete it from the ARIS Method of a
tenant. To prevent users from using an object symbol, you must remove it from the available
method filters. In this case, you do not have to delete the object symbol from your extended
ARIS Method of the tenant.
Prerequisite
Procedure
5. Select the derived object symbols that you want to delete. Use the filter to find the
list entries.
6. Click Delete.
The selected object symbols are deleted from ARIS Method of this tenant.
766
3.17.4 Connection types

Connection types are templates for connections. A connection is the graphical representation
of a relationship between two objects in a model. Use connection types to define which
objects to connect, the attributes to use for the connections, the models to assign to the
connections, and the models that include the connections.
Configuration administrators (page 53) can rename and modify connection types. You cannot
create or derive connection types. Because default types are mandatory in ARIS Method, and
customized types are renamed default types, you cannot delete those two types.
On the Connection types page, you can find all the connection types that are included in the
ARIS Method of this tenant. Use the filter to find the type you want to continue with. The
table contains the following columns. If you click a header, the column entries are sorted.
Name
column.
The name of a connection type is related to the orientation of a connection. The names listed
in this column are the active names. The active name is identical with the name of the
connection type. The active name indicates that the connection runs from the source to the
target object.
Passive name
Lists the names of connections running from the target to the source object.
Type number
API name/GUID
767

Type
768
3.17.4.1 Modify connection type

items, you can modify connection types. You can rename connection types and change the
set of attributes, connection assignments, and model types that allow connections of this
type. You cannot create or derive connection types.
Prerequisite
Procedure
4. Click Connection types.
Warning
You should also change the passive name. When renaming, use the original passive name
as a reference.
8. Click Connected objects to view the objects that users can connect using this
connection type. You cannot modify the set of objects.
9. Assign the required attributes that you want to make available for connections of this
type.
connection type. The Show only assigned view displays all locked attributes. Locked
769

shown as assigned.
14. Check the assignment. Click Remove to delete selected attributes from the
connection type.
16. Select the model types that you want to allow users to assign to connections of this type.
17. Click Assignments to select the model types that you want to provide as assignments for
connections of this type. The Show only assigned view displays all locked model types.
them.
shown as assigned.
type.
23. Click Connected objects to view which connections are available between model
objects. You cannot modify the set of connections.
24. Click Used in model types to view the models in which connections of this type are
available. You cannot modify the set of models.
25. Click Apply.
26. Add (page 838) the connection type to the method filter that users should use for login.
The connection type is updated and available for all users of this tenant who logged in with
the method filter that contains this connection type.
770
3.17.4.2 Use other attributes in connection types

If you want to change the set of attributes that users can see or specify, proceed as follows.
Prerequisite
Procedure
connection type. The Show only assigned view displays all locked attributes. Locked
shown as assigned.
10. Check the assignment. Click Remove to delete selected attributes from the
connection type.
All selected attribute types are available for connections of this type..
771
3.17.4.3 Assign other models to connection types

If you want to change the set of models that can be assigned to connections, proceed as
follows.
Prerequisite
Procedure
6. Click Assignments to select the model types that you want to provide as assignments for
connections of this type. The Show only assigned view displays all locked model types.
them.
shown as assigned.
type.
All selected models can be assigned to connections of this type.
772
3.17.4.4 Change 'Insert object' setting for connection

assignment
You can decide whether the connection to which the model is assigned and related objects
are inserted to the assigned model or if the assigned model should be empty.
Prerequisite
Procedure

9. Click Apply.
10. The setting is changed.
773
3.17.4.5 Change 'Unique' setting for connection

assignment
Decide whether users can only assign one model of a type to the connection or if multiple
models of a type can be assigned..
Prerequisite
Procedure

9. Click Apply.
774
3.17.4.6 Rename connection types in all languages

You can change the names and descriptions of connection types. You cannot modify types of
the Default (not configurable) type.
Prerequisite
Procedure
5. Click the entry that you want to change. Use the filter to find a list entry. The original
names, the current active and passive names, and the descriptions are displayed in the
selected language.
7. Click Apply.
775
3.17.4.7 Rename connection type in current language

You can change the active name of user-defined, customized, and default connection types
in the current language. You cannot modify types of the Default (not configurable) type.
Prerequisite
Procedure
6. Click Rename.
8. Click Save.
default state.
776
3.17.4.8 Reset connection type name in current language

You can reset the name of user-defined and customized connection types in the current
language.
Prerequisite
Procedure
8. Click Save.
If you changed the passive name as well, make sure to reset (page 775) this name to the
original passive name as well.
777
3.17.4.9 Reset connection type

Prerequisite
Procedure
can reset.
7. Click Reset.
Warning
8. Click Reset.
778
3.17.5 Attribute types

Attribute types (attributes) are related to other ARIS Method items. Attributes are properties
of items, such as models (page 1143) and objects (page 1146), that are used to describe the
items in more detail. Typical attributes are Name, Type, Description/Definition and Last
change. Certain attributes, such as Name and Description/Definition, are set by the user.
Other attributes, such as Type, and Last change, are set by the system. You cannot change
attributes set by the system.
Configuration administrators (page 53) can rename attribute types or delete the ones you do
no longer want to use. If you have special modeling requirements that are not covered by the
provided ARIS Method items, you can create your own attribute types.
On the Attribute types page, you find all the attributes that are included in the ARIS Method
Name
column.
Data type
Classification that defines which type of value attributes of this type have. A string, for
example, is a data type that classifies text and an integer is used to classify whole numbers.
Type number
API name/GUID
779
Type
Attribute type groups
The Attribute type groups column shows the group structure in which the attribute type is
stored. The path to the attribute type contains superior and subordinate groups that are
separated by forward slashes /. If no group is listed, the attribute type currently is located at
the top level. If an attribute type is available in multiple groups, the groups are listed in
multiple lines. Use attribute type groups to create a structure for your attribute types. With
the groups, users can find the required attributes when modeling. If you do not use groups, all
unstructured attributes are displayed at the top level when users edit attributes.
3.17.5.1 Create attribute type

items, you can create your own attribute types.
Prerequisite
Procedure
5. Click Create attribute type.
780
Warning
Verify that you select the settings you require in this dialog, because you cannot change
the settings after the attribute type is created.
6. Select the data type to use to specify the attribute values.
If you create an attribute type (page 780), you can select the following data types. The data
type determines the values that you can specify.
Verify that you selected the data type you require, because you cannot change the selected
data type after the attribute type is created.
Multi-line text
Multi-line text attributes contain text strings that span multiple lines. You can apply
paragraph format to each line, and character format to individual words or characters.
Boolean
With boolean attributes, you can switch a state. You can specify that the attribute is activated
(the check box is enabled and the value is True) or not activated (the check box is cleared
and the value is False). If the attribute is not specified , it will not be included in an
analysis procedure.
Value
Value attributes can hold a set of different values that you define when creating the attribute
type. You can only select one value from the defined set.
Integer
Integer attributes can only contain an integer that is a number, such as 15, 3, 0, or −1543 (the
set of integers is denoted by Z).
Floating point number
Floating point number attributes contain integers that are separated by a decimal point, such
as 3.1428. For this data type, you can enter any (positive or negative) value with decimal
places. ARIS rounds off these values to two decimal places.
Date
For this data type, you can enter a date in the mm/dd/yy format. You can also specify the
date using the calendar.
Time
Time attributes contain a time stamp such as 08:15:23 (hh:mm:ss), which is taken exactly at
the time of specifying the attribute.
781
Point in time
Point in time attributes contain the date and the exact time of the day, such as 12/11/2021,
8:57:11 PM (mm/dd/yyyy, hh:mm:ss). If you use this data type, a calendar iopens, so that
you can select the required date and time.
Duration
Duration attributes contain values that represent a time span in the dddd.hh.mm.ss format.
If you specify a value for hour, minute, or second greater than the allowed range, this value is
recalculated automatically. Example: If you enter 100:26:00:00, the value is changed to
101:02:00:00.
Link/File
Link/File attributes contain a string linking to a URL or a file. You can enter a path to a file or a
URL that points to a web site.
Note that you cannot create combined attributes and that Binary Large Object (BLOB)
attributes are not supported.
Detailed information on method items is available in the ARIS Method help
(../../../../../../../abs/help/en/method/#/home/methodhelp/en/1).
1. Choose whether to enable or disable the Is editable and the Is language-dependent
check boxes.
Defines whether or not users can specify different attribute values in each language. If you
disable the check box, the attribute value is automatically set to the same value in all
languages. This setting is used for the SAP ID attribute type, for example.
Specifies whether or not users are allowed to enter and modify the values of the new
attribute type. If you do not enable the check box, values can only be modified by the system.
1. Click Create.
Warning
4. Save the attribute type in a suitable attribute type group.
5. Click Groups to select the attribute type group in which you want to copy the attribute
type. The Show only assigned view displays all locked attribute type groups. Locked
782

7. To move the attribute type to a group, enable the controls in the Assigned column. If
you do not select a group, the attribute type is displayed at the top level when users edit
attributes. Use the filter to quickly find attribute type groups or sort the columns.
The attribute type that you moved is still part of the original group. The assignment of an
attribute type to an attribute type group applies to all languages.
8. Click Assign. In the Show only assigned view, all selected groups are listed and
shown as assigned.
9. Check the assignment. Click Remove to delete the attribute type from selected
groups.
11. If you created an attribute type of the Value data type, define a set of default values for
users to select.
12. Click Values & Symbols. All values are listed in the current language.
13. Click Add value. The New value line is added.
14. If you want to use symbols for specified and not specified attribute values, assign
symbols as required.
15. Click Values & Symbols. The following steps depend on the data type of the selected
attribute.
If you selected an attribute that does not use the Value data type, you can specify two
symbols that users can place in models. If placed the symbols indicate whether an
attribute is specified or not.
a. To select a symbol, click Change.
b. Select the attribute symbol from the list and click Use symbol.
Use the filter to find a list entry. If you are looking for attribute symbols you
configured, filter the list using the User-defined keyword. If you click a header, the
column entries are sorted.
c. Select the attribute symbol from the list and click Use symbol.
d. Select the second symbol if required. To remove symbols from selected values, click
Change > Use no symbol.
If you selected an attribute type of the Value data type, all values are listed in the current
language. Use the <Is not set> value to place a symbol indicating that this attribute is not
specified if required.
e. Select a value and click Assign symbol.
f. Select the attribute symbol from the list and click Use symbol.
783
g. Check the listed values. To remove symbols from selected values, click Assign
symbol > Use no symbol.
16. If the values are OK, click Apply.
17. Make the new attribute type available in model types.
attribute type as a model attribute. The Show only assigned view displays all locked
model types. Locked items are mandatory items. That means that you cannot remove
or modify them.
shown as assigned.
type.
24. Make the new attribute type available in object types.
25. Click Used in object types to select the object types in which you want to provide the
attribute type as an object attribute. The Show only assigned view displays all locked
or modify them.
27. To assign the required object types, enable the controls in the Assigned column.
Use the filter to quickly find object types or sort the columns. If you are looking for
object types you configured, filter the list using the User-defined keyword. If you click a
28. Click Assign. In the Show only assigned view, all selected object types are listed and
shown as assigned.
29. Check the assignment. Click Remove to delete selected attributes from the attribute
type.
784
31. Make the new attribute type available in connection types.

32. Click Used in connection types to select the connection types in which you want to
provide the attribute type as a connection attribute. The Show only assigned view
displays all locked connection types. Locked items are mandatory items. That means
that you cannot remove or modify them.
34. To assign the required connection types, enable the controls in the Assigned column.
Use the filter to quickly find connection types or sort the columns.
35. Click Assign. In the Show only assigned view, all selected connection types are listed
and shown as assigned.
36. Check the assignment. Click Remove to delete selected connections from the
attribute type.
38. Click Apply.
39. Add the attribute type to the method filter that users should use for login. You can add it
as a model attribute (page 846), an object attribute (page 848), or a connection attribute
(page 849).
The attribute type is created and can be used in filters.
The new attribute type is available for all users of this tenant who logged in with a method
filter that contains the new type.
785
3.17.5.2 Add default values to attribute types

If you created your own attribute types (page 780) of the Value data type, you can define a
set of default values for users to select. You cannot add values to default ARIS attribute types
based on the Value data type, but you can rename the values (page 787).
Specify that different symbols are to be displayed for the values if symbols are placed.
Prerequisite
Procedure
7. Click Add value. The New value line is added.
8. Select the value and click Rename.
9. Change the name as required and click Save. Do so in each language that you provide.
10. Use the Move up and Move down buttons to change the sort order. In this order
default values are provided for users to select.
11. Check the list of values. Click Remove values to delete selected values from the
attribute type.
The values are available for users using the attribute type.
You can specify (page 788) to display different symbols for the values if the symbols are
placed in models.
786
3.17.5.3 Rename default values

You can rename default values that are used in attribute types of the Value data type. You
cannot modify types of the Default (not configurable) type.
Prerequisite
Procedure
7. Select the value and click Rename.
8. Change the name as required and click Save. Do so in each language that you provide.
9. Use the Move up and Move down buttons to change the sort order. In this order
default values are provided for users to select.
10. Check the list of values. Click Remove values to delete selected values from the
attribute type.
The values are renamed in the selected languages.
787
3.17.5.4 Assign attribute symbols

Specify to display different symbols for the values if the symbols are placed in models. You
cannot specify symbols for attribute types of the Default (not configurable) type.
Prerequisite
Procedure
6. Click Values & Symbols. The following steps depend on the data type of the selected
attribute.
If you selected an attribute that does not use the Value data type, you can specify two
symbols that users can place in models. If placed the symbols indicate whether an
attribute is specified or not.
a. To select a symbol, click Change.
b. Select the attribute symbol from the list and click Use symbol.
c. Select the attribute symbol from the list and click Use symbol.
d. Select the second symbol if required. To remove symbols from selected values, click
Change > Use no symbol.
If you selected an attribute type of the Value data type, all values are listed in the current
language. Use the <Is not set> value to place a symbol indicating that this attribute is not
specified if required.
e. Select a value and click Assign symbol.
f. Select the attribute symbol from the list and click Use symbol.
788
g. Check the listed values. To remove symbols from selected values, click Assign
symbol > Use no symbol.
The attribute symbols are assigned to values.
3.17.5.5 Move an attribute type to an attribute type group

Use attribute type groups to create a structure for your attribute types. With the groups,
users can find the required attributes when modeling. If you do not use groups, all
unstructured attributes are displayed at the top level when users edit attributes. Move the
attribute type to the required attribute type group.
Prerequisite
Procedure
4. Click the type that you want to move. Use the filter to find a list entry. The original
name, the name, and the description are displayed in the selected language.
5. Click Groups to select the attribute type group in which you want to copy the attribute
type. The Show only assigned view displays all locked attribute type groups. Locked
7. To move the attribute type to a group, enable the controls in the Assigned column. If
you do not select a group, the attribute type is displayed at the top level when users edit
attributes. Use the filter to quickly find attribute type groups or sort the columns.
The attribute type that you moved is still part of the original group. The assignment of an
789
8. Click Assign. In the Show only assigned view, all selected groups are listed and
shown as assigned.
9. Check the assignment. Click Remove to delete the attribute type from selected
groups.
All selected attribute types are copied to the selected attribute type group.
790
3.17.5.6 Use attribute type in other models

If you want to make attributes available in other model types, proceed as follows.
Prerequisite
Procedure
attribute type as a model attribute. The Show only assigned view displays all locked
or modify them.
shown as assigned.
type.
The selected attribute type is available in models of the selected types..
791
3.17.5.7 Use attribute type in other objects

If you want to make attributes available in other object types, proceed as follows.
Prerequisite
Procedure
5. Click Used in object types to select the object types in which you want to provide the
attribute type as an object attribute. The Show only assigned view displays all locked
or modify them.
7. To assign the required object types, enable the controls in the Assigned column.
Use the filter to quickly find object types or sort the columns. If you are looking for
object types you configured, filter the list using the User-defined keyword. If you click a
8. Click Assign. In the Show only assigned view, all selected object types are listed and
shown as assigned.
9. Check the assignment. Click Remove to delete selected attributes from the attribute
type.
The selected attribute type is available in objects of the selected types.
792
3.17.5.8 Use attribute type in other connections

If you want to make attributes available in other connection types, proceed as follows.
Prerequisite
Procedure
5. Click Used in connection types to select the connection types in which you want to
provide the attribute type as a connection attribute. The Show only assigned view
displays all locked connection types. Locked items are mandatory items. That means
that you cannot remove or modify them.
7. To assign the required connection types, enable the controls in the Assigned column.
Use the filter to quickly find connection types or sort the columns.
8. Click Assign. In the Show only assigned view, all selected connection types are listed
and shown as assigned.
9. Check the assignment. Click Remove to delete selected connections from the
attribute type.
The selected attribute type is available in connections of the selected types.
793
3.17.5.9 Rename attribute type in all languages

You can change the names and descriptions of attribute types.. You cannot modify types of
the Default (not configurable) type.
Prerequisite
Procedure
7. Click Apply.
794
3.17.5.10 Rename attribute type in current language

You can change the name of an attribute type in the current language. You cannot modify
types of the Default (not configurable) type.
Prerequisite
Procedure
6. Click Rename.
8. Click Save.
default state.
795
3.17.5.11 Reset attribute type name in current language

You can reset the name of an attribute type in the current language.
Prerequisite
Procedure
8. Click Save.
796
3.17.5.12 Reset Attribute type

Prerequisite
Procedure
4. Click Attribute types..
can reset.
7. Click Reset.
Warning
8. Click Reset.
797
3.17.5.13 Delete attribute type

If you no longer want to use user-defined attribute types, you can delete them from ARIS
Method of a tenant. To prevent users from using an attribute type, you must remove it from
the available method filters. In this case, you do not have to delete the attribute types from
your extended ARIS Method of the tenant.
Prerequisite
Procedure
5. Select the user-defined attribute types that you want to delete. Use the filter to find
the list entries.
6. Click Delete.
The selected attribute types are deleted from ARIS Method of this tenant.
798
3.17.6 Attribute type groups

Attribute type groups are folders in which you store attribute types. Use attribute type groups
to create a structure for your attribute types. With the groups, users can find the required
attributes when modeling. If you do not use groups, all unstructured attributes are displayed
at the top level when users edit attributes.
Configuration administrators (page 53) can create attribute type groups as subgroups,
rename them, or delete the ones you do not want to use anymore.
On the Attribute type groups page, you find all attribute type groups of the tenant. Use the
filter to find the required groups. The table contains the following columns. If you click a
Name
Shows the name of the attribute type groups in the current language. The names shown are
related to the Type column.
Type number
API name/GUID
Type
799
Attribute type groups

The Attribute type groups column shows the group structure that is used to categorize
attribute types. The path to the related attribute type group contains superior and
subordinate groups that are separated by forward slashes /. If a subgroup is assigned to
multiple groups, paths are listed in multiple lines. If no group is listed, the attribute type group
currently is located at the top level.
800
3.17.6.1 Create attribute type group

You can use attribute type groups to organize various attribute types of your choice. For
example, you can group project-specific attribute types, which enables you to edit them
efficiently.
Prerequisite
Procedure
4. Click Attribute type groups.
5. Click Create attribute type group.
Warning
8. If you want to insert your new group as a subgroup, move it to the related superior group.
9. If you want to insert the group as a subgroup, select Superior groups. The Show only
assigned view displays all groups in which the selected group is currently inserted.
11. To move the attribute type group, select the superior group. You can select multiple
superior groups. Use the filter to quickly find attribute type groups or sort the columns.
801
12. If you want to assign subgroups to your new group, move the related groups below it.
13. If you want to insert subgroups into the selected group, select Subgroups. The Show
only assigned view displays all groups that are currently assigned to the selected group.
14. Select the Show all view and select the subgroup. You can select multiple subgroups.
Use the filter to quickly find attribute type groups or sort the columns.
15. Move the attribute types to your new attribute type group.
16. Click Attributes. The Show only assigned view displays all attributes that are currently
available in this group. Locked items are mandatory items. That means that you cannot
remove or modify them.
18. To add attribute types to the group, enable the controls. Use the filter to quickly find
attribute types or sort the columns.
Attribute types that you moved are still part of the original group. The assignment of an
shown as assigned.
20. Check the assignment. Click Remove to delete selected attribute types from the
group.
21. Click Apply.
The attribute type group is created.
Your new attribute type group is available to all users of this tenant who logged in with a
method filter that has attributes contained in this group.
802
3.17.6.2 Move attribute type group

To build a structure, select an attribute type group below which the selected attribute type
group will be inserted as a subgroup, or select subordinated groups.
Prerequisite

Procedure
5. Click the attribute type group that you want to move. Use the filter to find a list entry.
6. If you want to insert the group as a subgroup, select Superior groups. The Show only
assigned view displays all groups in which the selected group is currently inserted.
8. To move the attribute type group, select the superior group. You can select multiple
superior groups. Use the filter to quickly find attribute type groups or sort the columns.
9. If you want to insert subgroups into the selected group, select Subgroups. The Show
only assigned view displays all groups that are currently assigned to the selected group.
10. Select the Show all view and select the subgroup. You can select multiple subgroups.
Use the filter to quickly find attribute type groups or sort the columns.
11. Click Assign.In the Show only assigned view, all selected groups are listed and shown
as assigned. The attribute type group that you moved is still part of the original group.
The assignment of an attribute type to an attribute type group applies to all languages.
803
12. Check the assignment. Use the Remove button to delete the attribute type group from
selected groups.
The structure of the attribute type groups is changed accordingly..
3.17.6.3 Add attribute type to attribute type group

unstructured attributes are displayed at the top level when users edit attributes. Move the
attribute type to the required attribute type group.
Prerequisite
Procedure
4. Click the attribute type group to which you want to add the attribute types. Use the
5. Click Attributes. The Show only assigned view displays all attributes that are currently
available in this group. Locked items are mandatory items. That means that you cannot
remove or modify them.
7. To add attribute types to the group, enable the controls. Use the filter to quickly find
attribute types or sort the columns.
Attribute types that you moved are still part of the original group. The assignment of an
shown as assigned.
9. Check the assignment. Click Remove to delete selected attribute types from the
group.
804

All selected attribute types are copied to the attribute type group.
3.17.6.4 Rename attribute type group in current language

You can change the name of an attribute type group in the current language. You cannot
modify types of the Default (not configurable) type.
Prerequisite
Procedure
6. Click Rename.
8. Click Save.
default state.
805
3.17.6.5 Reset attribute type group name in current

language
You can reset the name of an attribute type group in the current language to the original
name as defined in ARIS Method.
Prerequisite
Procedure
8. Click Save.
806
3.17.6.6 Rename attribute type group in all languages

You can change the names and descriptions of attribute type groups. You cannot modify
Prerequisite
Procedure
7. Click Apply.
807
3.17.6.7 Reset attribute type group

Prerequisite
Procedure
can reset.
7. Click Reset.
Warning
8. Click Reset.
808
3.17.6.8 Delete attribute type group

If you no longer want to use user-defined attribute type groups, you can delete them from the
ARIS Method of a tenant.
Prerequisite
Procedure
5. Select the user-defined attribute type group that you want to delete. Use the filter
to find the list entries.
6. Click Delete.
The selected attribute type group is deleted from ARIS Method on this tenant. If attribute
types were stored only in this group, the attribute types are not deleted but moved to the top
level of the structure.
809
3.17.7 Attribute symbols

Attribute symbols are symbols that you use to specify the values for attribute types. You can
place attribute symbols in the modeling area instead of the values of attribute types.
If you have special needs for modeling that are not covered by the provided ARIS Method
items, configuration administrators (page 53) can create attribute symbols by deriving (page
811) them from existing attribute symbols. In derived symbols, you can replace (page 812) the
default symbols of ARIS Method with your own user-defined symbols. You can design
user-defined symbols in AMF format using ARIS Symbol Editor.
On the Attribute symbols page, you can find all symbol types that are included in ARIS
Method on this tenant.
Name
column.
Symbol
Graphic in AMF format that is currently used to place attribute values in models.
Type number
API name/GUID
Type
810
3.17.7.1 Derive attribute symbols

Attribute symbols are symbols that you use to specify the values for attribute types. You can
place attribute symbols in the modeling area instead of the values of attribute types. You can
replace the default symbols of ARIS Method with your own user-defined symbols.
If you want to use self-designed symbol graphics in AMF formats, you must first derive a
related attribute symbol. You cannot change symbol graphics in default attribute symbols.
Prerequisite
Procedure
3. Click Attribute symbols.
4. Select the name of the symbol from which you want to derive your new attribute
symbol.
Use the filter to find the most suitable symbol.
5. Click Derive symbol.
811
Warning
8. Change the used symbol graphic.
12. Click Apply.
13. Add your derived attribute symbol to the method filter that users will use for login.
Your derived attribute symbol is available to all users of this tenant who logged in with a
method filter that contains your new symbol.
3.17.7.2 Change attribute symbol

If you want to change the symbol that is used to place attribute values in models, proceed as
follows. You can change only derived attribute symbols.
Prerequisite
 You have derived (page 811) an attribute symbol.
Procedure
812
4. Click the name of the derived attribute symbol that you want to change. Use the filter
to find the symbol.
Users can use the attribute symbol in models to display attribute values as a symbol.
3.17.7.3 Rename attribute symbol in current language

You can change the name of an attribute symbol in the current language.. You cannot modify
Prerequisite
Procedure
6. Click Rename.
8. Click Save.
default state.
813
3.17.7.4 Reset attribute symbol name in current language

You can reset the name of derived and customized attribute symbols in the current language.
Prerequisite
Procedure
8. Click Save.
3.17.7.5 Rename attribute symbol in all languages

You can change the names and descriptions of attribute symbols.
Prerequisite
Procedure
814
7. Click Apply.
3.17.7.6 Reset attribute symbol

Prerequisite

Procedure
can reset.
7. Click Reset.
815
Warning
8. Click Reset.
3.17.7.7 Delete attribute symbol

If you do not want to use a derived attribute symbol any longer, you can delete it from ARIS
Method on a tenant. To prevent users from using an attribute symbol, remove it from the
available method filters. In this case, you do not need to delete the attribute symbol from ARIS
Method on your tenant.
Prerequisite
Procedure
5. Select the entries that you want to delete. Use the filter to find the list entries.
You can delete only user-defined and derived types. Because default types are
mandatory in ARIS Method, and customized types are renamed default types, you cannot
delete those two types.
6. Click Delete.
The selected attribute symbols are deleted from ARIS Method on this tenant.
816
3.17.8 Make method extensions available

By default, a tenant uses the items defined in ARIS Method. Configuration administrators can
adapt (page 725) items to the requirements of the company.
To make changed method items available to users, you must create (page 820) a filter that
includes the changed items. You can also add the new contents to an existing filter.
Once you have created a new filter, you must assign it to users (page 830) or user groups so
that users can log in using this filter. Users logged in with this filter can use these method
extensions when modeling.
You can make method extensions available to databases on another tenant by exporting
(page 831) method filters and transferring the method extensions during the subsequent
filter import (page 820).
3.17.9 Reset method items

Prerequisite
Procedure
4. Click any method item, such as Model types..
can reset.
817
7. Click Reset.
Warning
8. Click Reset.
3.17.10 Restore ARIS Method

If you want to delete all method items that you created and reset modified items on this
tenant, restore the default ARIS Method.
Prerequisite
Procedure
3. Click any method item, such as Model types.
4. Click Restore ARIS Method.
Warning
All user-defined and customized method items are deleted and replaced by default ARIS
Method items. Make sure that you exported (page 831) method filters containing
customized method items before you proceed. Then you can restore customized method
items by importing (page 820) the filters again.
5. Click Restore.
Only method items that are contained in the default ARIS Method are available on this tenant..
818
3.17.11 Filters
Use filters to support uniform modeling and accelerated evaluation for each tenant. Filters
provide users with only the information and methods relevant to them. If you log in using a
specific method filter and create a model, for example, only the model types relevant to your
work are offered to you for selection. You can use only the objects, symbols, attributes,
models, and connections permitted in the model.
Use the filter to find a list entry. Configuration administrators (page 53) manage filters:
 Method filters
A method filter contains a subset of ARIS Method, which the configuration administrator
can define for specific users and user groups, or for a specific task. To have access to
user-defined method extensions, you must assign the extensions to a filter. When
modeling, all object, connection, and attribute types are available for the model type that
are contained in the method filter. Thus, the content offered to users is exactly the
content they need to perform their tasks.
 Evaluation filters
An evaluation filter reduces the number of database elements to be analyzed. For
example, when you run a report, you can restrict the method content for evaluation by
using an evaluation filter. The method content is restricted to the content that is
activated in both the method filter you used when logging in to the database and the
evaluation filter you selected. The advantage of evaluation filters is that the running time
of a report is reduced and that only relevant content is included in comprehensive
processes.
On the Filters page, you can find all filters that are available to users of this tenant. Use the
filter to find a list entry. The table contains the following columns. If you click a header, the
Name
Shows the name of the filter in the current language.
Description
Shows the description of the filter in the current language. You can add or change the
description at any time by clicking the name of a filter.
Filter type
Indicates whether the filter is a method filter or an evaluation filter.
819
3.17.11.1 Import filter

provide users with only the information and methods relevant to them.
You can import filters from filter export files (.filter). These files are automatically created
when you export (page 831) a filter. Use the files to deliver all contained method extensions
from one tenant to another or to overwrite the current content of a related filter.
Warning
If a filter with the same GUID already exists, it will be overwritten. To merge filters, first copy
(page 832) the current filter and import the older version of the filter. You can then merge
(page 822) the two versions.
Prerequisite
Procedure
4. Click Filters.
5. Check whether the filter already exists. If you do not want to overwrite its content, copy
the current filter before you proceed.
6. Click Import, select the filter file, and click Open.
The filter is imported.
To use the filter, log in for modeling with this filter.
3.17.11.2 Create filter

820
If you do not want to create a filter from scratch (page 823), you can save time and generate
a filter (page 821) based on the content that is used in a database. You can also merge filters
(page 822) into a new filter containing the merged set of method items.
3.17.11.2.1 Create filter based on a database

You can quickly create filters based on a database that already contains the method contents
you require. In this way, you create project-specific filters, for example, based on similar prior
projects. You can then edit (page 835) the filters and modify them to match project-specific
requirements.
Prerequisite
Procedure
4. Click Filters.
5. Next to Create filter, click Menu > Generate from database.
6. Select the database that contains the required content.
7. Select the method filter to log into that database. Make sure that this filter contains the
required method content. If you are not sure about the filter, use the Entire method
filter. In this case, all items are included but only the items used in the database are added
to the new filter.
8. Click Generate filter.
10. Enter the attribute values, such as Name and Description. You cannot edit the GUID that
is set by the system.
821
Warning
11. Select the kind of filter that the filter is to be used for. You can select Method filter or
Evaluation filter.
12. Select a metamodel if required. If you enable UML 2.5, all contained elements are
permitted by the filter. Users can create UML diagrams using this filter.
13. Modify (page 835) the filter to match specific requirements.
The filter is created.
Start ARIS Architect and assign the filter to users or user groups (page 830).
3.17.11.2.2 Merge filters

You can combine filters quickly based on your existing filters by merging them. In this way,
you create project-specific filters, for example, based on similar prior projects. You can then
edit the filters and modify them to match project-specific requirements.
Prerequisite
Procedure
4. Click Filters.
5. Next to Create filter, click Menu > Merge filters.
6. Select the filters that contain the required method items.
7. Click Generate filter.
822
Warning
Evaluation filter.
3.17.11.2.3 Create a filter from scratch

If you do not want to create a filter from scratch (page 823), you can save time and generate
a filter (page 821) based on the content that is used in a database. You can also merge filters
(page 822) into a new filter containing the merged set of method items.
Prerequisite
Procedure
4. Click Filters.
5. Click Create filter.
823
Warning
Evaluation filter.
Select a metamodel if required. If you enable UML 2.5, all contained elements are
8. Add model types that you want to use in the filter.
9. Click Model types. The Show only types allowed view displays all items that users can
use. Locked items are mandatory items. That means that you cannot remove or modify
them. If you just created the filter from scratch, the list is empty.
11. Enable the model types that you want to make available.
Use the filter to quickly find model types. If you are looking for model types you
configured, filter the list using the User-defined, Derived, or Customized keywords. If
you click a header, the column entries are sorted.
12. Click Allow. In the Show only types allowed view, all selected models are listed and
indicated as allowed.
13. Check the selection. Click Remove to delete selected models from the filter.
14. Add object types that you want to use in the filter.
15. Click Object types. The Show only types allowed view displays all items that users can
17. Enable the object types that you want to make available.
Use the filter to quickly find object types. If you are looking for object types you
18. Click Allow. In the Show only types allowed view, all selected objects are listed and
19. Check the selection. Click Remove to delete selected objects from the filter.
824
20. Add connection types that you want use in the filter.
21. Click Connection types. The Show only types allowed view displays all items that users
can use. Locked items are mandatory items. That means that you cannot remove or
modify them. If you just created the filter from scratch, the list is empty.
23. Enable the connection types that you want to make available.
Use the filter to quickly find connection types. If you are looking for connection types
you configured, filter the list using the Derived or Customized keywords. If you click a
24. Click Allow. In the Show only types allowed view, all selected connections are listed
and indicated as allowed.
25. Check the selection. Click Remove to delete selected connections from the filter.
26. Add object symbols that users can place into each model type.
27. Click Occurrences > Symbols. All model types that you added (page 835) to the filter are
listed.
28. Select the first model type to change the set of symbols. Use the filter to find the list
entries.
Note that you must change the set of symbols for each allowed model type in turn.
29. Select the Show all view. All object symbols contained in the filter are listed. If models or
symbols are missing, you must first add them to the filter before you can proceed.
Use the filter to find the list entries. If you are looking for symbols you configured, filter
the list using the Derived or Customized keywords. If you click a header, the column
entries are sorted.
30. Select the symbols that users will use to place related model objects.
31. Click Allow. In the Show only types allowed view, all selected symbols are listed and
32. Check the selection. Click Remove to delete selected symbols from the model type in
this filter.
Object symbols are sorted by ARIS Method when they are offered to users for modeling.
33. To change this order, click Order and select the symbols that you want to move.
34. Click the Up and Down to move the symbols in the list.
If you want to undo your changes, click Reset. This restores the default sort order as
35. Add connection types that users can use in each model type.
825
36. Click Occurrences > Connections. All model types that you added (page 835) to the filter
are listed.
37. Select a model type to change the set of connections. Note that you must change the
set of connections for each allowed model type in turn. If types are missing, you must
first add them to the filter before you can proceed.
b. To allow the required connections, enable the controls in the Name column and
click Allow. Use the filter to quickly find connections or sort the columns.
39. If you want to select connections that are available between source object symbols and
target object symbols, click between object symbols. This action is appropriate when
object types provide multiple object symbols.
a. Enable the source object symbols from which the connection should point.
c. Select the Show all view.
d. Select the connections that users will use to connect related model objects.
e. Click Allow.
target object types, click between object types. In this case, you see objects that can be
connected regardless of which object symbols are displayed.
a. Enable the source object type from which the connection should point.
e. Click Allow.
In the view, all selected connections are listed and indicated as allowed.
41. Check the selection. Click Remove to delete selected connections from the model type
in this filter.Show only types allowed
42. Add model types that users can assign to each object type.
43. Click Assignments > Object assignments. All object types that you added (page 836) to
the filter are listed.
826
44. Select the first object type and change the set of model types that users can assign.
Note that you must change the set of model types for each allowed object type in turn.
45. Select the Show all view. All allowed models (model types) are shown. If models or
objects are missing, you must first add them to the filter before you can proceed.
Use the filter to find the list entries. If you are looking for items you configured, filter
the list using the Derived, User-defined, or Customized keywords. If you click a header,
the column entries are sorted.
46. Select the models that users will assign to the related model objects.
48. Check the selection. Click Remove to no longer allow the assignment of selected
models.
49. Add model types that users can assign to each connection type.
50. Click Assignments > Connection assignments. All connection types that you added
(page 838) to the filter are listed.
51. Select the first connection type and change the set of model types that users can
assign. Note that you must change the set of model types for each allowed connection
type in turn.
52. Select the Show all view. All models (model types) that you added (page 835) to the filter
are shown. If connections or models are missing, you must first add them to the filter
before you can proceed.
53. Select the models that users will assign to the related connections.
models.
56. Add attribute types that users can specify for each model type.
57. Click Attributes > Model attributes. All model types that you added (page 835) to the
filter are listed.
58. Select the first model type and change the set of model attributes that users can
specify. Note that you must change the set of attributes for each allowed model type in
turn.
827
The Show only assigned view displays all allowed and locked attributes. Locked
59. Select the Show all view. All available attributes are listed.
60. Select the attributes that users can specify for models.
61. Click Allow. In the Show only types allowed view, all selected attributes are listed and
62. Check the selection. Click Remove to no longer allow users to specify selected
attributes.
The attributes are sorted by ARIS Method when they are offered to users for modeling.
63. To change this order, click Order and select the attributes that you want to move.
64. Click Up and Down to move the attributes in the list.
65. Add attribute types that users can specify for each object type.
66. Click Attributes > Object attributes. All object types that you added (page 836) to the
filter are listed.
67. Select the first object type and change the set of object attributes that users can
specify. Note that you must change the set of attributes for each allowed object type in
turn.
69. Select the attributes that users can specify for objects.
attributes.
74. Add attribute types that users can specify for each connection type.
75. Click Attributes > Connection attributes. All connection types that you added (page
838) to the filter are listed.
828
76. Select the first connection type and change the set of connection attributes that users
can specify. Note that you must change the set of attributes for each allowed connection
type in turn.
78. Select the attributes that users can specify for connections.
attributes.
829
3.17.11.2.4 Assign filter to users

To enable users to log in with a particular filter, assign filters to users or user groups.
Prerequisite
You have the User management function privilege.
Procedure
6. Click Method filter on the Selection tab.
7. In the Assign column, enable the checkboxes of the relevant filters.
8. Click OK.
The selected filters are assigned. Users can now log in using these filters.
You can select a default filter for each database. This filter is automatically assigned when
you create users and user groups.
830
3.17.11.3 Export filter

You can back up filters to filter export files (.filter). Use the files to deliver all contained
method extensions from one tenant to another or to overwrite the current content of a
related filter.
Prerequisite
Procedure
4. Click Filters.
5. Select the filter that you want to save and click Export.
The file is saved according to the settings specified in your browser.
You can use the filter back up file to import the filter to another tenant or to restore a filter.
831
3.17.11.4 Copy filter

Copy filters for easy modification (page 835). If you import (page 820) a filter that already
exists, make sure to copy the current version first.
Prerequisite
Procedure
4. Click Filters.
5. Select the filter that you want to duplicate.
6. Click More > Copy.

Warning
Evaluation filter.
832
3.17.11.5 Rename filter

You can rename a filter in the current language.
Prerequisite
Procedure
4. Click Filters.
6. Click Rename.
7. Enter the name and click Save
The filter is listed with its new name.
833
3.17.11.6 Edit filter

You can modify a filter using the content of a database, merging filter content, or manually
modify multiple filter settings.
Prerequisite
Procedure
4. Click Filters.
5. Select the filter that you want to update. You cannot modify the content of the Entire
method filter, which automatically contains all method items available on the related
tenant. Use the filter to find a list entry.
6. Click Edit filter and decide how to update the filter.
If you want to update the filter using the content of a database, click Based on database.
a. Select the database that contains the required method items.
b. If you want to delete the current content of the filter and replace it by the method
items used in the database, enable the Overwrite filter with database content
check box. If you disable the check box, the filter content remains and the method
items used in the database are added.
If you want to update the filter merging multiple filters, click Merge filters and select the
required filters.
Using the related tabs, you can manually modify the filter settings (page 835).
7. After you complete the selection, click Apply.
The filter is updated.
To use the filter, log in for modeling with this filter.
834
3.17.11.6.1 Modify filter settings

You can modify filters you created (page 820) or default filters that come with ARIS. You
cannot modify the content of the Entire method filter, which automatically contains all
method items available on the related tenant.
To make only method items available to users that are relevant for their work, you must first
manage the global sets of model types (page 835), object types (page 836) and connection
types (page 838) that are contained in a filter. Then you must define how users can use these
items:
 Which objects can users place in each model type and which object symbols are available
(page 839)?
 How can users connect model objects (page 842)?
 Which models can users assign to model objects (page 844) and to connections (page
844)?
 Which attributes can users specify for models (page 846), objects (page 848) and
connections (page 849)?
3.17.11.6.1.1 Change set of model types

You can modify the set of model types that you can make available to users with a filter.
Prerequisite
Procedure
4. Click Filters.
835
6. Click Model types. The Show only types allowed view displays all items that users can
8. Enable the model types that you want to make available.
Use the filter to quickly find model types. If you are looking for model types you
10. Check the selection. Click Remove to delete selected models from the filter.
The model types are available in the filter.
You can now allow users that log in with this filter to use these model types together with
defined method items (page 835).
3.17.11.6.1.2 Change set of object types

You can modify the set of object types that you make available to users with a filter.
Prerequisite
Procedure
836
4. Click Filters.
6. Click Object types. The Show only types allowed view displays all items that users can
8. Enable the object types that you want to make available.
Use the filter to quickly find object types. If you are looking for object types you
9. Click Allow. In the Show only types allowed view, all selected objects are listed and
10. Check the selection. Click Remove to delete selected objects from the filter.
The object types are available in the filter.
You can now allow users that log in with this filter to use these object types together with
defined method items (page 835).
837
3.17.11.6.1.3 Change set of connection types

You can modify the set of connection types that you make available to users with a filter.
Prerequisite
Procedure
4. Click Filters.
tenant.
6. Click Connection types. The Show only types allowed view displays all items that users
can use. Locked items are mandatory items. That means that you cannot remove or
modify them. If you just created the filter from scratch, the list is empty.
8. Enable the connection types that you want to make available.
Use the filter to quickly find connection types. If you are looking for connection types
you configured, filter the list using the Derived or Customized keywords. If you click a
9. Click Allow. In the Show only types allowed view, all selected connections are listed
and indicated as allowed.
10. Check the selection. Click Remove to delete selected connections from the filter.
The connection types are available in the filter.
You can now allow users that log in with this filter to use these connection types together
with defined method items (page 835).
838
3.17.11.6.1.4 Change set of object symbols used in model

types (filter)
You can modify the set of object symbols for each allowed model type that you make
available to users with a filter.
Prerequisite
Procedure
4. Click Filters.
listed.
entries.
Note that you must change the set of symbols for each allowed model type in turn.
8. Select the Show all view. All object symbols contained in the filter are listed. If models or
symbols are missing, you must first add them to the filter before you can proceed.
Use the filter to find the list entries. If you are looking for symbols you configured, filter
the list using the Derived or Customized keywords. If you click a header, the column
entries are sorted.
9. Select the symbols that users will use to place related model objects.
10. Click Allow. In the Show only types allowed view, all selected symbols are listed and
839
11. Check the selection. Click Remove to delete selected symbols from the model type in
this filter.
14. If you want to undo your changes, click Reset. This restores the default sort order as
Users that log in with this filter can use the selected object symbols in the selected model
types.
3.17.11.6.1.5 Change object symbol sorting (filter)

Object symbols are sorted by ARIS Method when they are offered to users for modeling. You
can change this order in the method filter.
Prerequisite
Procedure
4. Click Filters.
listed.
840
entries.
Notice that you must modify the set of symbols for each allowed model type in turn.
For users that log in with this filter, the object symbols are provided in the defined sort order.
3.17.11.6.1.6 Change attribute sorting (filter)

Attribute types are sorted by ARIS Method when they are offered to users for modeling. You
can change this order in the method filter.
Prerequisite
Procedure
4. Click Filters.
6. Click Attributes > Model attributes, Object attributes, or Connection attributes. All
models that you added (page 835) to the filter are listed.
841
7. Select the first type to change the set of attributes. Use the filter to find the list
entries.
Note that you must change the sort order for each type in turn if required.
For users that log in with this filter, attributes are provided in the defined sort order.
3.17.11.6.1.7 Change set of connection types used in model

types (filter)
You can modify the set of connection types for each allowed model type that you make
available to users with a filter.
Prerequisite
Procedure
4. Click Filters.
842
6. Click Occurrences > Connections. All model types that you added (page 835) to the filter
are listed.
7. Select a model type to change the set of connections. Note that you must change the
set of connections for each allowed model type in turn. If types are missing, you must
first add them to the filter before you can proceed.
b. To allow the required connections, enable the controls in the Name column and
click Allow. Use the filter to quickly find connections or sort the columns.
9. If you want to select connections that are available between source object symbols and
target object symbols, click between object symbols. This action is appropriate when
object types provide multiple object symbols.
a. Enable the source object symbols from which the connection should point.
e. Click Allow.
target object types, click between object types. In this case, you see objects that can be
connected regardless of which object symbols are displayed.
a. Enable the source object type from which the connection should point.
e. Click Allow.
In the view, all selected connections are listed and indicated as allowed.
11. Check the selection. Click Remove to delete selected connections from the model type
in this filter.Show only types allowed
Users that log in with this filter can use the selected connections in the selected model types.
843
3.17.11.6.1.8 Change the set of allowed model types

For each allowed object type, you can modify the set of available model types. In this way, you
define which models users can assign to model objects.
Prerequisite

Procedure
4. Click Filters.
6. Click Assignments > Object assignments. All object types that you added (page 836) to
the filter are listed.
7. Select the first object type and change the set of model types that users can assign.
Note that you must change the set of model types for each allowed object type in turn.
8. Select the Show all view. All allowed models (model types) are shown. If models or
objects are missing, you must first add them to the filter before you can proceed.
9. Select the models that users will assign to the related model objects.
844
models.
Users that log in with this filter can assign the models to the related objects.
3.17.11.6.1.9 Change the set of connection assignments

(filter)
For each allowed connection type, you can modify the set of available model types. In this
way, you define which models users can assign to which connection.For each allowed
connection type, you can modify the set of available model types. In this way, you define
which models users can assign to which connection.
Prerequisite
Procedure
4. Click Filters.
6. Click Assignments > Connection assignments. All connection types that you added
(page 838) to the filter are listed.
7. Select the first connection type and change the set of model types that users can
assign. Note that you must change the set of model types for each allowed connection
type in turn.
845
8. Select the Show all view. All models (model types) that you added (page 835) to the filter
are shown. If connections or models are missing, you must first add them to the filter
before you can proceed.
9. Select the models that users will assign to the related connections.
models.
Users that log in with this filter can assign the models to the related connections.
3.17.11.6.1.10 Change the set of model attributes (filter)

You can modify the set attributes (page 779) that users can specify for models.
Prerequisite
Procedure
4. Click Filters.
846
6. Click Attributes > Model attributes. All model types that you added (page 835) to the
filter are listed.
7. Select the first model type and change the set of model attributes that users can
specify. Note that you must change the set of attributes for each allowed model type in
turn.
9. Select the attributes that users can specify for models.
attributes.
Users that logged in with this filter can specify the selected attributes for models.
847
3.17.11.6.1.11 Change the set of object attributes (filter)

You can modify the set attributes (page 779) that users can specify for model objects.
Prerequisite
Procedure
4. Click Filters.
6. Click Attributes > Object attributes. All object types that you added (page 836) to the
filter are listed.
7. Select the first object type and change the set of object attributes that users can
specify. Note that you must change the set of attributes for each allowed object type in
turn.
9. Select the attributes that users can specify for objects.
attributes.
848

Users that logged in with this filter can specify the selected attributes for objects.
3.17.11.6.1.12 Change the set of connection attributes

(filter)
You can modify the set attributes (page 779) that users can specify for connections..
Prerequisite
Procedure
4. Click Filters.
6. Click Attributes > Connection attributes. All connection types that you added (page
838) to the filter are listed.
7. Select the first connection type and change the set of connection attributes that users
can specify. Note that you must change the set of attributes for each allowed connection
type in turn.
849
9. Select the attributes that users can specify for connections.

attributes.
Users that logged in with this filter can specify the selected attributes for connections.
3.17.11.6.1.13 Rename filter in all languages

You can change the names and descriptions of filters in all available languages.
Prerequisite
Procedure
4. Click Filters.
5. Click the filter that you want to rename. Use the filter to find a list entry.
850
Warning
Evaluation filter.
10. Click Apply.
The names and descriptions are changed.
3.17.11.7 Delete filter

You can delete filters that should no longer be used by users. If you export (page 831) filters
first, you can make deleted filters available (page 820) again.
Prerequisite
Procedure
4. Click Filters.
5. Select the entries that you want to delete.
6. Click Delete.
The filters are deleted from the tenant.
851
3.18 Manage model templates

Use templates to specify the graphic properties of models, object symbols, and connections.
Model templates contain basic settings that change the appearance and attribute placements
of models and contained items all at once. This enables you to apply settings defined once to
all relevant models. Using the templates supplied or those you create yourself will enable you
to easily customize your models according to your requirements.
Configuration administrators can create templates (page 854) and assign templates to a
model type (page 852). If a model of this type is created or imported from ARIS Express
(http://www.ariscommunity.com/aris-express), the applied template is used automatically.
Users can assign templates to models. When users assign templates to models, the settings
made in the templates overrule all default settings for models and contained elements as well
as database-related settings, such as font formats. All new objects and connections added to
such models appear like defined in the template that was assigned last. When settings were
changed for individual object definitions, these settings remain even if templates are applied.
Moreover, you can assign multiple templates to models. This means that you can assign a
template to a model to change the size of objects, for example, and another that places the
required attributes above the objects. Both changes take effect. Assigning multiple templates
is possible for existing objects only. If you create new objects, only the template you assigned
last will be applied to them.
3.18.1 Applied templates

administrator function privilege, you can apply templates to model types. If a model of this
type is created or imported from ARIS Express
To open the Assigned templates page, click Application launcher > Administration >
Configuration > Conventions > Applied templates.
If you get a message that model types are currently not available, this indicates that other
licenses with additional elements are available in ARIS Architect. However, you can use the
templates in ARIS as well as in ARIS Architect. But you can only apply templates to certain
model types in ARIS Architect.
852

Apply template to a model type
You can apply a template to a model type. If users create models of this type, this template is
used.
1. Click Application launcher > Administration > Configuration > Conventions.

2. Click Applied templates.
3. Click Apply template.
4. Select the model type. If you select <All model types>, the template is applied to all
models that users will create in the future.
5. Select the template.
6. Click Apply.
The selected template is applied to the model type. If users create models of this type, this
template is used.
Edit assignment to apply another template
You can change the template that is currently applied to the model type.

3. Select the model type.
4. Click Edit.
6. Click Save.
The selected template is applied to the model type. If users create models of this type, this
template is used. Models that were created before you changed the assignment are not
affected.
Delete mapping for a model type
You can delete the model type from the list so that no template will be applied in the future.

3. Select the model type.
4. Click Delete.
The model type no longer uses a template.
853
3.18.2 Available templates

If you have ARIS Enterprise Administration license privilege and the Configuration
administrator function privilege, you can manage all model templates available on this
tenant.
You have an overview of all templates that are available on the tenant.
Create template
Add templates that users can apply to models or configuration administrators can apply to
model types. Templates ensure that the appearance of all items complies with your
company's corporate design.

2. Click Available templates.
3. Click Create template.
4. Click Select languages.
6. Enter the name and description.
Warning
in a language, users who log in with this language will not be able to find this template
because (Untitled) is displayed as the template name.
7. Click Apply. The Content of template - <name of the template> page is displayed.
8. Add content to the template, such as object symbols, connections, and models.
If you just created a template, you can add object symbols, connections, and models. If you
edit a template, you can add or remove content from the selectes template.
1. Click Model types. You see all assigned types as well as additional information related to
ARIS Method. The Changed column indicates whether you have only added content to
the template, but not modified the appearance or attribute placement yet. If No shows in
the column, make sure to modify the items appearance as required, so that the items look
different when users apply the template to the models. You can edit or remove multiple or
single items.
2. Click Add models and add the required model types.
854
3. On the Edit models page, change how the models look if the template is assigned to the
models. If you have added <All Model types>, you can change the appearance of all
models at once. Use this option when, for example, you want to apply the same model
background to all models.
4. Click Symbol types to add object symbols or Connection types to add connections to
the template. You see all assigned types as well as additional information related to ARIS
Method. The Changed column indicates whether you have only added content to the
template, but not modified the appearance or attribute placement yet. If No shows in the
column, make sure to modify the items appearance as required, so that the items look
single items.
5. Click Add symbol or Add connection. Use the Filter items by model type page to
reduce the number of displayed items on the related page. To show fewer items, select
model types that contain the items that you want to add. If this page is hidden, click
Show Filter.
6. Select the required model types. You can either enter a search term or reduce the
model types displayed by a method filter. You can also combine the two filters, for
example, if you want to change the appearance of symbols in your function allocation
diagrams related to your SAP branches. To combine filters enter the term Function
allocation diagram to the filter and select a method filter related to the branch, such
as Process-driver SAP.
7. Click Apply filter. All related items are displayed. Enter an item name or key word to find
the required items to add. If items are missing, click Show all to discard the filters.
8. Select the required items. If you add connections, you will find multiple connections
with the same name. This makes it tricky to find the ones you are looking for. To find
connections, use the Connection information buttons to find out which connections are
available in model types and which objects you can connect.
9. Click Add symbols or Add Connections.
The Edit symbols or the Edit connections page is displayed for selected items.
Now you can change the appearance and attribute placement for those items. Change the
appearance of object symbols, connections, and models.
When you create or edit a template, you can make object symbols, connections, and models
appear differently if users apply templates to the models.
1. Click Model types. You see all the types that are already assigned as well as additional
information related to ARIS Method.
2. Select an entry and click Edit models.
855
3. Change how the models and contained items will look if the template is assigned to the
models. To change the model appearance, specify the settings (page 861) of the
properties that define the appearance and the attribute placement.
4. Click Symbol types or Connection types to change the way these items look if the
template is assigned to the models.
5. Select an entry and click Edit symbols or Edit connections.
6. On the Edit appearance tab, use the preview to verify your changes. To reset changes to
the ARIS default settings, click Undo.
The template has been updated.
Change the attribute placement of object symbols and connections. When you create or edit a
template, you can change the attribute placement for object symbols and connections.
1. Click Symbol types or Connection types to change the way the selected attributes of
these items are placed if the template is assigned to the models.
3. Click Edit attribute placement and select the required attribute from the list. If an
attribute type is missing, click Add and select the item to add.
4. Use the preview to verify your changes. To reset changes to the ARIS default settings,
click Undo.
The settings for attribute placement are changed for this template.
The model template is available for users to be applied to models.
Edit template
You can edit the name and description of a template or change the content, the appearance,
or attribute placement of items.

4. Click Edit.
The Content of template - <name of the template> page is displayed.
Edit the template as required.
856
Manage content, such as object symbols, connections, and models.

If you just created a template, you can add object symbols, connections, and models. If you
edit a template, you can add or remove content from the selectes template.
1. Click Model types. You see all assigned types as well as additional information related to
ARIS Method. The Changed column indicates whether you have only added content to
the template, but not modified the appearance or attribute placement yet. If No shows in
the column, make sure to modify the items appearance as required, so that the items look
single items.
2. Click Add models and add the required model types.
3. On the Edit models page, change how the models look if the template is assigned to the
models. If you have added <All Model types>, you can change the appearance of all
models at once. Use this option when, for example, you want to apply the same model
background to all models.
4. Click Symbol types to add object symbols or Connection types to add connections to
the template. You see all assigned types as well as additional information related to ARIS
Method. The Changed column indicates whether you have only added content to the
template, but not modified the appearance or attribute placement yet. If No shows in the
column, make sure to modify the items appearance as required, so that the items look
single items.
5. Click Add symbol or Add connection. Use the Filter items by model type page to
reduce the number of displayed items on the related page. To show fewer items, select
model types that contain the items that you want to add. If this page is hidden, click
Show Filter.
6. Select the required model types. You can either enter a search term or reduce the
model types displayed by a method filter. You can also combine the two filters, for
example, if you want to change the appearance of symbols in your function allocation
diagrams related to your SAP branches. To combine filters enter the term Function
allocation diagram to the filter and select a method filter related to the branch, such
as Process-driver SAP.
7. Click Apply filter. All related items are displayed. Enter an item name or key word to find
the required items to add. If items are missing, click Show all to discard the filters.
8. Select the required items. If you add connections, you will find multiple connections
with the same name. This makes it tricky to find the ones you are looking for. To find
connections, use the Connection information buttons to find out which connections are
available in model types and which objects you can connect.
857
9. Click Add symbols or Add Connections.

The Edit symbols or the Edit connections page is displayed for selected items.
Now you can change the appearance and attribute placement for those items.
Change appearance of object symbols, connections, and models.

When you create or edit a template, you can make object symbols, connections, and models
appear differently if users apply templates to the models.
1. Click Model types. You see all the types that are already assigned as well as additional
information related to ARIS Method.
2. Select an entry and click Edit models.
3. Change how the models and contained items will look if the template is assigned to the
models. To change the model appearance, specify the settings (page 861) of the
properties that define the appearance and the attribute placement.
4. Click Symbol types or Connection types to change the way these items look if the
template is assigned to the models.
6. On the Edit appearance tab, use the preview to verify your changes. To reset changes to
the ARIS default settings, click Undo.
The template has been updated.
Change attribute placement of object symbols and connections.

When you create or edit a template, you can change the attribute placement for object
symbols and connections.
1. Click Symbol types or Connection types to change the way the selected attributes of
these items are placed if the template is assigned to the models.
3. Click Edit attribute placement and select the required attribute from the list. If an
attribute type is missing, click Add and select the item to add.
4. Use the preview to verify your changes. To reset changes to the ARIS default settings,
click Undo.
The settings for attribute placement are changed for this template.
858
Rename template or change description

You can edit the names and descriptions of templates in each language that you use on the
tenant.

4. Click Rename.
5. Click Select languages.
7. Enter the name and description.
Warning
in a language, users who log in with this language will not be able to find this template
because (Untitled) is displayed as the template name.
8. Click Apply.
The changes are displayed.
Import template
You can import templates from template export files. With template export files, you can
move templates to other tenants or restore templates.
Warning
If a template with the same GUID already exists, it will be overwritten. To merge templates
manually, first copy the current template and import the older version.

3. Click Import.
4. Select the related file (.template). To navigate to the file to select, click Select file.
5. Click Import. The import starts.
6. If the template already exists, the imported template overwrites the existing content.
Click OK to confirm the import operation.
The template is available.
859
Copy template
You can duplicate templates to modify the default templates, for example, templates that are
updated automatically with each ARIS update. This prevents overwriting default or existing
templates on the tenant when importing templates.

4. Click Copy.
The template is duplicated using a new GUID. A number is added to the original name.
Export template
You can export templates to create back-up files or to import templates into another tenant.

4. Click Export.
5. Enter the file name to use for the template export file.
6. Click Export.
The template is exported to the related file.
Delete template
You can delete templates that are no longer required from a tenant. If the template was
applied to elements, the elements will still be shown as they were defined in the template that
you have deleted.
We recommend exporting the template to a backup file before deleting the template.

4. Click Delete.
The template is deleted from the tenant.
860
3.18.2.1 Change settings

MODELS
To change the look of models, you specify the following settings.
Background color
Specifies the color of the modeling area. The color box shows the current background color.
Clicking the color box opens the Choose color dialog for you to select the required color.
Size of appearance [%]
Specifies the size of diagrams in the modeling area. The lower the percentage you specify, the
larger the model section that is displayed and the smaller the diagram elements you place.
New connections right-angled
Specifies that new connections may be only right-angled and not straight. If you clear this
check box, you can also create straight connections in the model.
Connection bridge height [%]
Specifies the height of connection bridges for crossing connections in the model. The higher
the value in %, the higher the bridge. A preview of the specified bridge height is displayed.
Connection rounding intensity [%]
Specifies the degree of connection rounding for connections with directional changes in the
model. The higher the value in %, the stronger the rounding.
Display wallpaper
Displays the graphic as a wallpaper that is assigned to the related database.
Use grid
Displays the grid in the diagram window and aligns objects, edges, and other diagram
elements to the grid according to the grid width when placing them.
Grid wit [%]
Changes the distance between points in the grid that you can display in the diagram window.
Model items are aligned on the grid.
Hide assignment icon
Hides the assignment icons in models.
If you assign a model to objects, for example, to describe them in more detail, the object is
added an assignment icon. This icon symbolizes the assigned model and you can open the
model by double-clicking the assignment icon.
861
Remove color behind text

Applies a light background to text areas contained in objects. This setting improves the
readability of the text in dark-colored objects. This setting is also useful when text in colored
object areas is hard to read when printed.
Text attributes in symbol
Specifies how text placed inside object symbols is to be handled.
TEXT EXTENDS BEYOND SYMBOL

The text extends beyond the symbol borders.
RESIZE SYMBOL
The symbols are changed in height and width to suit the text inside. Object scaling is not
possible if you enabled the Resize symbol option in the model properties. In this case the
object handles are grey and the input boxes are no longer accessible.
MULTI-LINE TEXT
The text is displayed on multiple lines. If the text does not completely fit into the symbol, the
remaining text is cut off and is replaced with three dots (...).
SINGLE-LINE TEXT
The text is displayed on one line. If it extends beyond the border of the object, the remaining
text is cut off and is replaced with three dots (...).
OBJECT SYMBOLS
For symbols, you can change the size, color and shading as well as the line color, weight, and
style.
862
Fill color
Displays the setting options that can be used to specify the colors of objects.
Line color
Changes the color of the line that borders the object symbol.
Line style
Specifies the type of line.
You can choose from the styles Solid, Dashed or Dotted.
Line weight [pt]
Changes the width of the line that borders the object symbol.
Symbol width [%]
Width in %. Change the width of the symbol. 100% corresponds to the default ARIS size.
Symbol height [%]
Height in %. Change the height of the symbol. 100% corresponds to the default ARIS size.
Shaded
Adds a shading to the object symbol.
3D
Displays the object symbol with additional shadows and emphasis to produce a
three-dimensional impression.
CONNECTIONS
For connections, you can change the color, style, arrow heads and line weight.
Line color
Changes the color of the line that connects object symbols in models.
Line style
Specifies the type of line.
You can choose from the styles Solid, Dashed or Dotted.
Line weight [%]
Changes the width of the line that connects object symbols in models.
Arrow towards source
Provides the connection ends that can be used to link the connection to the source item. If
you select ARIS default, the shape predefined by ARIS is used.
Arrow towards target
Provides the connection ends that can be used to link the connection to the target item. If
you select ARIS default, the shape predefined by ARIS is used.
863
ATTRIBUTE PLACEMENT
You can also specify which attribute is displayed where on a connection or symbol and in
which font format.
Placement
Specifies where the selected attribute is placed. Use the preview to check your selection.
Alignment
Places the selected attribute left-aligned, right-aligned, or centered.
With attribute name
Displays the name of the placed attribute in the model in addition to the attribute value. The
attribute name is written directly in front of the attribute value.
As a symbol
Displays specific attributes as a symbol.
If such an attribute was specified and placed, for example, the Existence attribute, the As a
symbol check box is displayed. If you enable the check box, for the Existence attribute, a
plus sign is placed in the model instead of Yes and a minus sign instead of No.
Font format
Assigns the required font format from the list of available font formats to the selected
attribute.
Character formatting
Displays existing font formatting of texts or text fragments.
864
3.18.3 Font formats (Templates)

administrator function privilege, you can manage font formats that are used in model
templates on this tenant. To open the Font formats page, click Application launcher >
Administration > Configuration > Conventions > Font formats.
Create font format
Edit font format
Copy font format
Delete font format
865
3.19 Manage configuration sets

The user interface of ARIS is based on configuration and modification sets. By default, ARIS
provides the classic configuration set and the default configuration set. You cannot change
the default configuration sets.
You can create (page 501) modification sets (page 1145) based on the default configuration
sets to customize the user interface to match your corporate design.
If you need extended configuration sets with different functions that you cannot configure in
ARIS Administration, please contact your local Software AG sales organization
3.19.1 Save configuration set

You can save a configuration set. You can restore saved configuration sets at any time or
provide them on other tenants.
Prerequisite
Procedure
Configuration view.
sets are displayed.
3. Move the mouse pointer over a configuration set.
4. Click Backup.
5. Save the file in any directory.
The <name of the configuration set>.zip backup file is downloaded.
866
3.19.2 Duplicate configuration set

You can generate a new modification set by duplicating a configuration set.
Prerequisite
Procedure
Configuration view.
sets are displayed.
4. Click Create modification set.

The modification set is created below the selected configuration set. It contains all elements
from the selected configuration set.
3.19.3 Restore configuration set

If you require further modification sets, please contact your local Software AG sales
organization (http://www.softwareag.com). Restore a saved configuration set.
Prerequisite
 You have access to the backup file.
Procedure
Configuration view.
sets are displayed.
4. Double-click the ZIP file (syntax: <name of the configuration set>.zip).
867
The configuration set is tested, and is applied if it is an error-free configuration set. Notes are
displayed in yellow, errors in red. The configuration set is displayed in the list with the original
name. If a configuration set with the same name exists, an error message is displayed. An
already existing configuration set cannot be overwritten. The classic and default
configuration sets cannot be overwritten or deleted.
3.19.4 Delete configuration set

You can delete a configuration set. The classic and default configuration sets cannot be
overwritten or deleted.
Prerequisite
Procedure
Configuration view.
sets are displayed.
4. Click Delete.
The configuration set is no longer available in ARIS.
3.19.5 What to consider with customized configuration sets?

Configuration sets are based on XML files and allow a comprehensive customization of ARIS.
By default, ARIS provides the classic configuration set and the default configuration set.
Advanced configuration changes require the use of XML configuration. Please contact
Software AG (https://empower.softwareag.com/) for a customization request or participate
in the 742-xx ARIS Connect Portal Configuration training
(https://learning.softwareag.com/enrol/index.php?id=198). Please note that
customization and training services are not covered by the standard Software AG software
maintenance agreement. Configuration changes can only be performed by Software AG if you
request and agree to them. Errors in XML configuration may have serious impact. You may
not be able to start ARIS again.
868
3.19.6 What are the special features in terms of languages?

You can select all languages (page 510) that ARIS supports. When a user selects a language,
they specify which interface, method, and database language is used. Ideally, these are
available in the selected language. If a language is not available, the procedure is as follows.
INTERFACE LANGUAGE IS NOT AVAILABLE IN SELECTED LANGUAGE

Available interface languages are installed.
If you have selected the language Quechua (Bolivia) and this language is not available as the
interface language, the interface items, for example, the links, are displayed in English.
METHOD LANGUAGE IS NOT AVAILABLE IN SELECTED LANGUAGE

The interface language is used.
For example, if you have selected the language Quechua (Bolivia) and this language is not
available, model, object, and attribute names are displayed in English if you have selected
English as the interface language.
DATABASE LANGUAGE IS NOT AVAILABLE IN SELECTED LANGUAGE

The default language (page 1122) for the database is used.
For example, if you have selected the language Quechua (Bolivia) and this language is not
available, all entries you specify for attributes are added in the English database language if
you have selected English as the default language. In the modeling component, for example,
the current database language is displayed after the model name using a language code.
869
3.20 Manage applications

You can manage applications. You can add and delete applications from the system.
Use application management for certain functions or systems in the ARIS environment. The
application management registers and manages the systems you require. This way you make
ARIS Process Mining or SAP applications known as trustworthy at ARIS.
3.20.1 Applications
You can create, edit, and delete customer-specific applications such as ARIS Process Mining
or SAP systems.
The Applications page shows the applications available. The installed applications are
marked as Internal. Internal applications cannot be deleted. Applications that you have
added are marked as External.
3.20.1.1 Create application

You can create and register a customer-specific application. Internal applications are
automatically installed when you install the system.
Prerequisite
Procedure
1. Open the Application management page.
2. Click Add application. The application details page opens.
3. Enter the name, the description, and the scope of the application. The scope is required
input.
4. Click Save. The application is created. The Client ID and the Client secret are displayed.
You can copy them to register ARIS in this application as trustworthy.

You can transfer the client ID and client secret to the third-party application.
870
3.20.1.2 Edit application

You can edit a customer-specific application. Internal applications cannot be changed.
Prerequisite
Procedure
2. In the row of the relevant application, click Show application. Click the relevant
application.
3. Click Edit.
4. Edit the name, description, and scope for the application.
5. Click Save.
6. The client ID and the client secret are displayed. You can copy them to use register ARIS
in the application.

You have edited the application.
You can also generate (page 873) a new client ID and client secret to register ARIS in this
application as trustworthy.
871
3.20.1.3 Create or edit ARIS Process Mining application

If you use ARIS Process Mining in a combined deployment with ARIS Enterprise and you have
the ARIS Process Mining license, you do not have to configure the integration of ARIS and
You can create the connection to an ARIS Process Mining system. There are two possible
scenarios (page 659). The first scenario is that you create the application in ARIS. Then ARIS
serves as the authorization server and ARIS Process Mining is the authorization client. You
can then log in to ARIS Process Mining with your ARIS credentials.
The second scenario is that ARIS is created as an application in ARIS Process Mining. ARIS
Process Mining serves as the authorization server and ARIS as the authorization client. Then
you can log in to ARIS with your ARIS Process Mining credentials. If the corresponding user
does not exist in ARIS and the Create user option is enabled in ARIS, then the user will be
automatically created in ARIS.
This scenario is described in this procedure.
Prerequisite
 You have enabled (page 109) ARIS Process Mining.
Procedure
2. Click the ARIS Process Mining button. The Details page of the miningserver
application opens.
3. Click the Edit button.

4. Specify the application settings.
a. You can enter an optional description, for example, Process conformance check.
b. Enter the client-credentials key in the corresponding input field.
Copy the client ID and secret from the ARIS system integration, as shown in step 4.
Connect the client ID and secret to the client-credentials key as follows:
<client ID>/<secret key>
Example
ef1bf998-9658-4433-94d6-1fe8209ab36b/81cbce47-1e67-43c3-a26c-764d85a471
26
c. Specify the API scope in the Scopes input field. If you register ARIS Process Mining to
perform a conformance check, add the ConformanceCheck API scope.
d. Click Save.
872

You have all data that you need to enter in the ARIS Process Mining system. As soon as the
data is entered in ARIS Process Mining, you can log in to ARIS with your ARIS Process Mining
credentials.
3.20.1.4 Display application details

You can display the details of an application.
Prerequisite
Procedure
2. Click the relevant application. The application details page opens.
The application details are displayed.
You can generate a new Client ID and Client secret.
3.20.1.5 Generate client ID and client secret

You can generate a new client ID and a new client secret for an application.
Prerequisite
Procedure
3. Click Generate client ID and client secret. You have generated a client ID and a
client secret for the application.
You can copy and use them with the application.

You can transfer the client ID and client secret to the third-party application.
873
3.20.1.6 Refresh application list

You can refresh the list of registered applications.
Prerequisite
Procedure
2. Click Refresh.
The list of registered applications is refreshed.
3.20.1.7 Display active sessions

You can display the active sessions for an application.
Prerequisite
Procedure
The active sessions for an application are displayed.
You can terminate applications.
3.20.1.8 Refresh active sessions

You can refresh the list of the active sessions for an application.
Prerequisite
Procedure
4. Click Refresh.
The list of the active sessions for an application is refreshed.
874
3.20.1.9 Terminate all active sessions

You can terminate all active sessions of an application.
Prerequisite
Warning
Note that if you terminate an internal application, your system could no longer work as
expected.
Procedure
4. Click Close application.

All sessions of the application are terminated.
3.20.1.10 Display history

You can display the history of an application.
Prerequisite
 You have the Log application changes option enabled.
Procedure
3. Click History.
The application history is displayed. All changes to the application are listed, for example,
creating or updating the application.
875
3.20.1.11 Refresh application history

You can refresh the history of an application.
Prerequisite
Procedure
3. Click History.
4. Click Refresh.
The history of an application is refreshed.
3.20.1.12 Delete application

You can delete a customer-specific application. Internal applications cannot be deleted.
Prerequisite
Warning
The application is deleted. If any active sessions are generated or exist for the application, the
sessions are also deleted. The sessions used become unusable.
Procedure
2. In the row of the relevant application, click Delete application.

The application is deleted.
876
3.20.2 Scopes
You can display the details and history of a scope.
Scopes and APIs are created when you start the umcadmin_<size: s, m, or l> runnable. This
server component manages users, permissions, licenses, LDAP connectivity and SSO.
Each scope has one or more APIs.
Available scopes are:
 Conformance check
The Conformance check scope is implemented to fit to the ARIS Process Mining
conformance checks. A process conformance check analyzes whether an executed and
measured process instance of a production system is compliant with a designed process
model in ARIS.
 Default
The Default scope is used to authenticate and establish the communication between the
components of the installed system. These applications are marked as internal.
 Export
The Export scope is designed for applications that intend to consume the export API of
Tenant Management
(../../../../../../../tm/static/help/en/handling/index.htm#220196.htm).
 Extractor
The Extractor scope is designed to import data from ARIS Process Mining and SAP if
they are integrated into ARIS.
The Extractor scope enables the import of ARIS Process Mining and SAP data if they are
integrated into ARIS.
 Import
The Import scope is designed for applications that intend to consume the import API of
Tenant Management
(../../../../../../../tm/static/help/en/handling/index.htm#220196.htm) to import data.
 UserProfile
The UserProfile scope is designed to share the user token with the client applications
and allow them to invoke the APIs intended for them.
 ConformanceCheck
The ConformanceCheck scope is designed for the ARIS Process Mining conformance
check process.
 MiningPubApi
The public API enables the upload of external data into ARIS Process Mining.
877
 ARIS Connector for SAP Solutions

If you are using ARIS in a cloud scenario, such as ARIS Enterprise edition, you must
install ARIS Connector for SAP Solutions to exchange data between ARIS and SAP®
Solution Manager 7.2 without a VPN connection.
3.20.2.1 Display scope details

You can display the scope details.
Prerequisite
Procedure
2. Click Scopes.
3. Click the relevant scope. The scope details page opens.
The scope details are displayed.

You can display the history of a scope.
Prerequisite
Procedure
2. Click Scopes.
4. Click History.
The scope history is displayed.
878
3.20.2.3 Refresh scope history

You can refresh the history of a scope.
Prerequisite
Procedure
2. Click Scopes.
4. Click History.
5. Click Refresh.
The history of a scope is refreshed.
879
3.20.3 APIs
You can display the details and history of an API.
The APIs available are listed here. Each scope has one or more APIs.
Available APIs are:
 Dataset
The Dataset API enables the query of SAP data records.
 Export
The Export API enables the export of data from Tenant Management
(../../../../../../../tm/static/help/en/handling/index.htm#220196.htm).
 Extractor
The Extractor API enables the integration of ARIS Process Mining and SAP.
 Import
The Import API enables the import of data into Tenant Management
(../../../../../../../tm/static/help/en/handling/index.htm#220196.htm) and thus into User
Management.
 Token
The Token API enables access to User Management using OAuth authentication.
 MiningPubApi
The Public API enables the upload of external data into ARIS Process Mining.
 ARIS Connector for SAP Solutions
If you are using ARIS in a cloud scenario, such as ARIS Enterprise edition, you must
install ARIS Connector for SAP Solutions to exchange data between ARIS and SAP®
Solution Manager 7.2 without a VPN connection.
880
3.20.3.1 Display API details

You can display the API details.
Prerequisite
Procedure
2. Click APIs.
3. Click the relevant API. The API details page opens.
The API details are displayed.

You can display the history of an API.
Prerequisite
Procedure
2. Click APIs.
4. Click History.
The API history is displayed.
881
3.20.3.3 Refresh API history

You can refresh the history of an API.
Prerequisite
Procedure
2. Click APIs.
4. Click History.
5. Click Refresh.
The history of an API is refreshed.
882
3.21 Manage server tasks

Centrally check server tasks, such as reports, merge operations, or backups. You can cancel
report executions. This might be necessary, for example, if incorrect reports are executed.
3.21.1 Display server tasks

You can check which server tasks (page 883), such as reports, merge operations, or backups,
are performed and which server tasks are completed.
Prerequisite
You have the ARIS Connect administrator and Server administrator function privileges.
Procedure
2. Click Server tasks.

3. Click Running tasks or Completed tasks.
Running tasks or completed tasks are listed. You can cancel reports (page 886).
3.21.2 Server tasks area

The Server tasks area lists current and completed server tasks, such as reports, merge
operations, or backups, of a tenant. You can see which tasks are running in the background of
the tenant and which tasks have been completed and no longer consume resources.
You can use the Running tasks list to cancel a task (page 886) of the category Report.
Canceled tasks are listed in the Completed tasks list with the status Canceled.
The Completed task list displays a maximum of 1.000 tasks. When more tasks are completed,
the oldest tasks are removed from the list. Entries older than seven days are automatically
removed from the list.
883
3.21.3 Running tasks list

The Running tasks list has the following columns. You can sort the columns in the table in
ascending and descending order.
Column Content
Category Outputs the category of the server task, such as XML Import, DB Restore,
Merge and Report.
Name Name of the task.
User Name of the user who started the task.
State Status of the task, for example, Initializing and Running. Depending on the
category of the task, additional information is provided, for example, The
request is in the processing queue for reports.
Server Server on which the task is executed.
Start time Month, day, and time at which the task was started.
Duration Duration of the task in milliseconds, seconds, minutes, etc.
884
3.21.4 Completed tasks list

The Completed tasks list has the following columns. You can sort the columns in the table in
ascending and descending order.
Column Content
Category Outputs the category of the server task, such as XML Import, DB Restore,
Merge and Report.
Name Name of the task.
User Name of the user who started the task.
State Status of the task, for example, Completed or Canceled.
Server Server on which the task was executed.
Start time Month, day, and time at which the task was started.
Duration Duration of the task in milliseconds, seconds, minutes, etc.
3.21.5 Toggle auto-refresh

You can switch auto-refresh on or off for server tasks (page 883). If you have enabled
auto-refresh, new tasks are displayed immediately after they are created.
Prerequisite
You must have the ARIS Connect administrator and Server administrator function
privileges to view server tasks.
Procedure
Configuration view.
2. Click Server tasks.
3. Click Toggle auto-refresh to enable auto-refresh. The icon is underlined to indicate

that auto-refresh is enabled and new tasks are displayed immediately after they are
created.
4. Click Toggle auto-refresh again if you want to disable auto-refresh. The icon is no
longer underlined. To view new tasks from now on, click Refresh.
You have defined whether the tasks are updated automatically or manually.
885
3.21.6 Cancel report

In the Server tasks (page 883) area, you can cancel the execution of a task of the Report
category, that is, the execution of running reports.
Prerequisite
You must have the ARIS Connect administrator and Server administrator function
privileges to view server tasks.
Warning
Canceling a report execution "kills" the report, that is, canceling a report does not guarantee
data consistency. If, for example, a report has changed data, these changes are not rolled
back by the cancelation.
Procedure
Configuration view.
2. Click Server tasks. The tasks currently running are listed.

3. From the user column, determine the name of the user who started the report. Inform the
user that the report is to be canceled and he must press F5 to continue working in ARIS
when the cancel dialog opens. This closes the cancel dialog and work in the program is
possible again.
4. In the row of the report you want to cancel, click Cancel. The confirmation dialog
opens.
5. Click Yes.
The report is canceled and displayed in Completed tasks with the status Canceled. The user
who started the report is informed of the cancelation by a cancelation dialog.
886
3.22 Manage ARIS Server and tenants

Server administrators monitor the system and manage ARIS Server and tenant data using
various tools.
ARIS tenants are containers that provide their own ARIS Administration and ARIS data set,
such as configuration, ARIS Method, databases, scripts, and so on. An <_a_ server> may have
multiple tenants installed that access the functionality of the server, but their data is
independent of each other.
After the installation of ARIS Server two tenants are available:
 The infrastructure master tenant manages administrative users and all other tenants.
 The default tenant is available for operational use.
If you need additional operational tenants to provide different sets of databases, users,
configurations or ARIS methods you can easily create them. Additional operational tenants
require a new set of ARIS licenses. Licenses must be unique in all tenants.
If you have installed an ARIS Server using an external database management system, all
additionally created tenants are available as well. If you are going to create additional tenants
for ARIS10.0 to migrate data from ARIS 9.8.7 or later, make sure to use identical names in both
ARIS versions.
Administrators can manage tenants in different ways. For example:
 Manage tenants using the Tenant Management tool (page 951)
 Tenant management using command line tools (page 1020)
 Create tenants using ACC (page 919)
 Backup tenants using ACC (page 920)
 Restore tenants using ACC (page 925)
 Copy tenants using ACC (page 928)
 Delete tenants using ACC (page 923)
Please make sure to manage users and licenses for all tenants.
3.22.1 ARIS Cloud Controller (ACC)

ACC is a command-line tool (see ARIS Cloud Controller (ACC) Command-Line Tool.pdf
(../../documents/3 Installation/31 Initial installation/312 Server/3121 Basic (Single node)/ARIS
Cloud Controller (ACC) Command-Line Tool.pdf)) for administrating and configuring an ARIS
installation. It communicates with ARIS Agents on all nodes. You can use it in multiple modes.
887
3.22.1.1 How to start ARIS Cloud Controller (ACC)

installation. It communicates with ARIS Agents on all nodes.
Warning
Using ACC commands will deeply affect your system. This requires profound knowledge of
the technical ARIS infrastructure and environment. The required know-how can be acquired
only by attending the training course ARIS Server Installation, available via Global Education
Services (https://softwareag.com/training). If you use ACC commands without this
knowledge or without the services of Software AG, according to the standard Software AG
software maintenance agreement, we cannot guarantee proper functioning.
ARIS Cloud Controller (ACC) can be used in three modes:
INTERACTIVE MODE (DEFAULT)

ACC runs with an interactive shell, allowing you to manually issue commands.
BATCH MODE
Activated by specifying a command file with the -f command line parameter (see ACC
command line parameters below). ACC will execute the commands in the file in the given
sequence and exit after execution or if one of the commands fails.
A command file line starting with # will be interpreted as a comment line and ignored by ACC.
COMMAND MODE
You can directly pass a single command to ACC as a command line parameter. The command
will be executed and ACC will exit afterwards.
When passing commands directly as a command line parameter, you must be careful when
escaping strings in your command, for example, double-quote-delimited parameters. The
operating system command shell will consume the double quotes, leaving your string
parameter un-escaped. So please escape the quote characters and special characters.
Examples
If you issue the command in command mode, for example:
set remote.repository.url="http://something.com/repo"
You must enter:
acc.bat -h localhost -u <user name> -pwd <remoteAccessPassword> set
remote.repository.url=\"http://something.com/repo\"
888
If you enter:
remote.repository.url="http://something.com/repo"
ACC will return an error message, for example:
line 1:52 mismatched character '<EOF>' expecting '\n'
Invalid or erroneous command "set
remote.repository.url=http://something.com/repo ": line 1:30 extraneous
input ':' expecting EOF
Use "help" to display a list of available commands.
This also affects passwords and names containing special characters. If you try to back up
your tenants using the following command, make sure to escape the quote characters and
the special character & used in the password User&12345.
If your username or password includes any special character, add a backslash (\) before the
character for ACC to process the special character as a string. That is, if there is an
ampersand (&), in your password, add a backslash before the ampersand.
./acc.bat -h localhost -u Clous -pwd g3h31m -p 18011 -c
../generated.apptypes.cfg backup tenant default username=\"admin\"
password=\"User\&12345\"
To get information about the usage of ACC commands, enter help or help <command>.
WINDOWS OPERATING SYSTEM

To start ACC under a Windows operating system click Start > All Programs > ARIS >
Administration > Start ARIS Cloud Controller. If you have changed agent user credentials
you must enter the user name and/or the password.
LINUX OPERATING SYSTEM

To start ACC under a Linux operating system, execute the acc10.sh shell script instead. To do
so, enter: su -c acc10.sh aris10. After the ARIS Server installation has completed on a Linux
operating system, the aris10 user is locked and has no password. Command-line tools (sh
files), such as ARIS Server Administrator or ARIS Cloud Controller can only be started by
the aris10 user related to the ARIS Agent.
 To unlock the aris10 user, enter: passwd -u aris10
 To interactively enter a password, enter: passwd aris10
 To start the command-line tools, enter: su -c acc10.sh aris10 or su -c arisadm.sh aris10
 To execute these command-line tools as an ARIS user that has no root privileges, you
must enter the password of the aris10 user.
 To copy files manually into the ARIS directory, as the aris10 user use the commands: su
aris10 and sudo aris10
889
As an ARIS user that has no root privileges, you must make sure that the files have the
correct ownership (aris10).
 To lock the aris10 user again enter: passwd -l aris10
3.22.1.2 How to connect nodes

When you start ACC in one of the three usage modes without any additional command line
parameter, it will by default connect to the node installed by the setup program. There are
three options to specify nodes you want to control with ACC:
 You can use the add node command to put the individual cloud nodes under ACC's
control. This requires profound knowledge of the technical ARIS infrastructure and
environment. The required know-how can be acquired only by attending the training
course ARIS Server Installation.
 Alternatively, you can list all your cloud nodes in a node file and pass this file to the ACC
with the \-n (or --nodefile) command line option.
 If you only want to connect to a single node and issue commands there, you can also use
the ACC's -h (or --host) command line option to directly specify the host or IP name of
the node you want to control with ACC.
890
3.22.1.3 How to list runnables

Start ACC and enter list to monitor the status of all runnables. This example shows ACC of a
current ARIS Server installation for a medium number of users.
ACC+ localhost>list
Node localhost - 16 installed runnables.
ID State Version Type
zoo_m STARTED 10.0.18.0 com.aris.runnables.zookeeper-run-prod
postgres_m STARTED 10.0.18.0 com.aris.runnables.PostgreSQL-run-prod
cloudsearch_m STARTED 10.0.18.0 com.aris.cip.y-cloudsearch-run-prod
elastic_m STARTED 10.0.18.0
com.aris.runnables.elasticsearch-run-prod
umcadmin_m STARTED 10.0.18.0 com.aris.umcadmin.y-umcadmin-run-prod
adsadmin_m STARTED 10.0.18.0 com.aris.adsadmin.y-adsadmin-run-prod
abs_m STARTED 10.0.18.0
com.aris.modeling.components.y-server-run-prod
octopus_m STARTED 10.0.18.0
com.aris.octopus.y-octopus_server-run-prod
apg_m STARTED 10.0.18.0 com.aris.age.age-run-prod
copernicus_m STARTED 10.0.18.0
com.aris.copernicus.copernicus-portal-server-run-prod
ecp_m STARTED 10.0.18.0 com.aris.runnables.ecp-run-prod
simulation_m STARTED 10.0.18.0
com.aris.modeling.components.simulationserver.y-simuserver-run-prod
loadbalancer_m STARTED 10.0.18.0
com.aris.runnables.httpd.httpd-run-prod
dashboarding_m STARTED 10.0.18.0
com.aris.dashboarding.dashboarding-run-prod
businesspublisher_m STARTED 10.0.18.0
com.aris.modeling.components.businesspublisher.y-bp-server-run-prod
arcm_m STARTED 10.0.18.0 com.aris.arcm.arcm-run-prod
The state of all runnables represented by their instance IDs is listed. Possible states are:
 UNKNOWN: The runnable state is not yet known. This state is shown directly after ARIS
Agent was started.
 STOPPED: The runnable is currently not running.
 STARTING: The runnable is starting, but this process is not complete yet.
 STARTED: The runnable is running.
 STOPPING: The runnable is stopping, but this process is not complete yet.
 DEACTIVATED: The runnable is not in use. It has been deactivated manually and can be
activated if necessary. If the dashboarding runnable is in this state, that does not have
to be an error. This runnable is deactivated if ARIS Server was installed without ARIS
Aware.
 DOWN: This runnable started and crashed. ARIS Agent will attempt to automatically
restart the runnable momentarily.
891
 FAILED: This runnable has crashed. ARIS Agent has given up trying to restart the
runnable.
If a runnable does not start properly, read the Basic Troubleshooting guide.
3.22.1.4 How to handle special characters

If you pass a command to a command-line tool, such as ARIS Cloud Controller, special
characters used in names, passwords, or user names may cause issues.
Examples
You must enter:
If you enter:
892
3.22.1.5 What runnables are available?

This table lists all runnables run by ARIS Server for a medium number of users installation.
That's why all runnables end with _m. Installations for a small or a large number of users are
typified with _s or _l. If ARIS was installed using the setup program, the default instance IDs
are used as shown in the table.
Runnable ARIS Server ARCM

Runnables run by different server types
Instance ID: zoo_m x x

Name: Service registry
Description:
This runnable is a server component
managing the communication, configuration
and status information of all available
runnables and external services.
Instance ID: postgres_m x x

Name: Modeling database
Description:
Internal standard database system storing all
ARIS databases (modeling data) and the
system databases (ARIS method, filters,
templates, languages, fonts, font formats and
script data).
This database can be replaced by an external
Oracle® or Microsoft® SQL database.
Instance ID: cloudsearch_m x x

Name: Search index
Description:
Main full-text search and graph structure
index for modeling data. It allows fast access
to the data stored in the modeling database,
Oracle® or Microsoft® SQL database.
893

Instance ID: elastic_m x x
Name: Document index (Elasticsearch)
Description:
Main full-text search index for documents and
collaboration data. It also stores users, user
groups, licenses, and privileges.
Instance ID: adsadmin_m x x

Name: ARIS document storage management
Description:
Server component managing ARIS document
storage.
Instance ID: umcadmin_m x x

Name: ARIS Administration/User Management
Description:
Server component managing users,
permissions, licenses, LDAP connectivity and
SSO.
Instance ID: loadbalancer_m x x

Name: Load balancer
Description:
Central point of entry for all ARIS clients to
the entire ARIS application, typically accessed
via HTTP ports 80 or 1080, or HTTPS ports
443 or 1443. It distributes the workload across
the installed components.
Instance ID: abs_m x x

Name: Main server component
Description:
Server component for modeling, publishing,
and operations on modeling data including
report execution.
894

Instance ID: apg_m x
Name: Process Governance
Description:
Process Governance server component.
Executes processes and provides managing
user interfaces.
Instance ID: copernicus_m x

Name: Portal
Description:
Server component providing the portal in
ARIS.
Instance ID: octopus_m x

Name: Analysis
Description:
Server component processing ad hoc
analyses and queries triggered in ARIS
Architect or ARIS Designer.
Instance ID: ecp_m x

Name: Collaboration
Description:
Server component of the collaboration
component in ARIS.
Instance ID: simulation_m x

Name: Simulation
Description:
Server component of the simulation
functionality in ARIS Architect.
Instance ID: dashboarding_m x

Name: Dashboards (ARIS Aware)
Description:
Server component of the dashboarding
component in ARIS.
895

Instance ID: businesspublisher_m From ARIS 10.0.13.0 on ARIS Publisher and
Name: ARIS Publisher server IT Inventory are no longer delivered. This
means that you can no longer install or
Description:
update ARIS Publisher Server. You can still
Server component of the ARIS Publisher
use your current ARIS Publisher installation,
functionality in ARIS Architect.
but since this component is no longer
supported, no more features will be
developed. We strongly recommend using
the ARIS portal (Published content) instead
Instance ID: arcm_m x

Name: ARIS Risk and Compliance server
Description:
Server component of ARIS Risk and
Compliance.
Instance ID: hds_m x

(optional; not by setup)
Name: Heavy-duty Server (HDS)
Description:
HDS is an additional component that reduces
the load of ARIS reports running on you abs
instance.
Instance ID: cdf_m x

Name: Cloud Decoupling Framework (CDF)
Description:
CDF is a queue that can be used to decouple
synchronous accesses to services. It is
required for communication between the abs
instance and the hds instance.
If multiple arcm runnables are installed, a cdf
runnable is mandatory.
896

Instance ID: ces_m x
Name: Enterprise search (CES)
Description:
CES is an extension that provides the
powerful enterprise search.
3.22.1.6 Security advice

Due to the Tomcat (Ghostcat) vulnerability, you are recommended to block (page 897) access
to all AJP ports if you use an ARIS version prior to 10.0.12.0.
3.22.1.6.1 Safety recommendation: Block AJP ports

The Apache JServ Protocol (AJP) is a binary protocol that can proxy incoming requests
from a web server to an application server behind the web server. AJP is a highly trusted
protocol. It must not be made available to untrusted clients because they could gain access to
confidential information or execute code on the application server.
ARIS uses AJP for communication between the loadbalancer runnable that bases on Apache
HTTPD and ARIS applications that base on Apache Tomcat. The vulnerable Tomcat AJP
connector is mandatory and must stay active for ARIS applications.
If you have installed ARIS Server according to our recommendations, you can block access to
the ports of all runnables except the HTTP and HTTPS ports used by the loadbalancer
runnable by setting appropriate firewall rules. By default these HTTP and HTTPS ports are 80
and 443 on Windows operating systems and 1080 and 1443 on Linux operating systems.
To prevent unauthorized access, check that the AJP ports of your ARIS installations are only
accessible from networks from which users access ARIS (page 898). The show node ACC
command gives an overview of open AJP ports. It lists all ports used by ARIS runnables. The
connector.ajp.port parameter (in former ARIS versions called CATALINA_AJP_PORT)
identifies AJP ports. If any of these ports are accessible from an external network, you must
block access immediately by your firewall.
897
Important: If your ARIS system is a multiple node installation, the AJP ports must remain open
for data transfer between multiple nodes. These open AJP ports do not represent a security
gap, because distributed ARIS installations must always be protected by a firewall.
3.22.1.6.2 Check open AJP ports (Ghostcat vulnerability)

To prevent unauthorized access, check that the AJP ports of your ARIS installations are only
accessible from networks from which users access ARIS (page 898).
Procedure
1. Start ARIS Cloud Controller (ACC) (page 888).
2. To check ports used by runnables, enter: show node
The list is displayed. Navigate to the Known used ports section.
Port Runnable Port Parameter
443 loadbalancer_m HTTPD.ssl.port Set
explicitly
1080 loadbalancer_m HTTPD.port Set
explicitly
14200 cloudsearch_m zookeeper.application.instance.port Set
explicitly
14201 cloudsearch_m JAVA-DCSHTTPPORT Set
explicitly
14206 cloudsearch_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14220 elastic_m ELASTICSEARCH.http.port Set
explicitly
14226 elastic_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14230* elastic_m ELASTICSEARCH.transport.tcp.port Set
explicitly
14240 postgres_m postgresql.port Set
explicitly
14250 cdf_m connector.http.port Set
explicitly
14251 cdf_m connector.ajp.port Set
explicitly
14256 cdf_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14281 zoo_m clientPort DEFAULT
14296 zoo_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14400 abs_m connector.http.port Set
explicitly
14401 abs_m connector.ajp.port Set
explicitly
14406 abs_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14410 adsadmin_m connector.http.port Set
explicitly
898
14411 adsadmin_m connector.ajp.port Set

explicitly
14416 adsadmin_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14420 apg_m connector.http.port Set
explicitly
14421 apg_m connector.ajp.port Set
explicitly
14426 apg_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14430 copernicus_m connector.http.port Set
explicitly
14431 copernicus_m connector.ajp.port Set
explicitly
14436 copernicus_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14440 ecp_m connector.http.port Set
explicitly
14441 ecp_m connector.ajp.port Set
explicitly
14446 ecp_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14450 hds_m connector.http.port Set
explicitly
14451 hds_m connector.ajp.port Set
explicitly
14456 hds_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14460 octopus_m connector.http.port Set
explicitly
14461 octopus_m connector.ajp.port Set
explicitly
14466 octopus_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14470 simulation_m connector.http.port Set
explicitly
14471 simulation_m connector.ajp.port Set
explicitly
14476 simulation_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14480 umcadmin_m connector.http.port Set
explicitly
14481 umcadmin_m connector.ajp.port Set
explicitly
14486 umcadmin_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14490 dashboarding_m connector.http.port Set
explicitly
14491 dashboardging_m connector.ajp.port Set
explicitly
14496 dashboarding_m JAVA-Dcom.sun.management.jmxremote.port Set
explicitly
14497 dashboarding_m JAVA-Xrunjdwp\:transport Set
explicitly
The highlighted connector.ajp.port Port parameter indicates all open AJP ports.
899
3. If any of these ports are accessible from an external network, you must block access
immediately by your firewall.
You have secured the system.
Important: If your ARIS system is a multiple node installation, the AJP ports must remain open
for data transfer between multiple nodes. These open AJP ports do not represent a security
gap, because distributed ARIS installations must always be protected by a firewall.
900
3.22.1.7 Use cases

In these chapters product-related examples for configuring the system are available.
3.22.1.7.1 Change the default agent user's password

The ARIS Agent user has access to ARIS Cloud Controller (ACC). If you did not change the
default password during the setup process you should do so manually to prevent
unauthorized access.
Procedure
2. Change the password: set password = "<enter the new password>"
3. Stop ACC. Enter: exit
4. Restart ACC.
5. Enter the new password.
6. If you use the Start icon for ARIS Cloud Controller (Start > All Programs > ARIS >
Administration > ARIS Cloud Controller) you can change the password command line
parameter within the ACC shortcut. If you do not change the password it will be
prompted every time you start ACC.
If you run an ARIS server setup after you have changed the password, enter the changed
credentials.
901
3.22.1.7.2 Start and stop runnables

The start modus had been selected during the setup process. If you have chosen the option
Start automatically all runnables will be started in the right order.
Runnables can also be started and stopped independently, but most runnables will not work
on their own. You must start all needed runnables in the right order.
 Enter startall to get all runnables started in correct order.
 Enter start <instanceId>, for example, start abs_m to start only the runnable abs
(Modeling & Publishing (Business server)).
 Enter stopall to stop all runnables.
 Enter stop <instanceId>, for example, stop abs_m to only stop one runnable.
If you run ARIS on a laptop (8 GB) for demonstration purposes you might want to stop
runnables you do not need to ensure more memory for the system.
3.22.1.7.3 Deactivate runnable

Deactivation is useful, if you do not yet use a certain runnable, but maybe need it later. If you
activate the runnables again, you can still use the setup program to update your ARIS version.
To deactivate runnables is safer than removing or shutting them down.
A deactivated runnable cannot be started with a start command. They will be ignored by the
startall command and the agent's runnable autostart.
Prerequisites
Runnables are in STOPPED or FAILED state.
Procedure
2. To deactivate the runnable enter, for example: deactivate simulation_m
The simulation runnable will not be started, until you have activated it again (page 903).
902
3.22.1.7.4 Activate runnable

You can activate runnables that have been deactivated (page 902). This is required before
starting an update setup.
Procedure
2. To activate the runnable enter, for example: activate simulation_m
The simulation runnable can be started again.
3.22.1.7.5 Provide additional memory

If you have performed an installation for small (s), medium (m) or large (l) memory
requirement, you can provide additional memory for runnables.
Procedure
2. Enter reconfigure <runnable> +JAVA-Xmx="<memory requirement>".
The affected runnables will be started after the settings have been updated.
Examples
 reconfigure abs_s +JAVA-Xmx="1152m"
The memory settings for the modeling runnable of an s installation will be increased to
max. 1152 MB.
 reconfigure abs_m +JAVA-Xmx="6G"
The memory settings for the modeling runnable of an m installation will be increased to 6
GB.
903
3.22.1.7.6 Reconfigure autostart settings

Using the autostart.mode parameter, you can reconfigure runnables to start automatically
when the windows service starts. This parameter is used as a node setting valid for all
runnables at a node. Do not use the autostart.mode parameter for runnables. For runnables
use the set runnable property command to set their autostart parameter to true. If you do
not want a runnable to be started, you must deactivate (page 902) it.
Procedure
2. To change settings for one node, enter for example:
set autostart.mode="all"
To change settings for all nodes, enter for example:
on all nodes set autostart.mode="all"
You can use the following values:
all: starts all runnable automatically.
off: no runnable is started automatically.
autostart.flag: only those runnables which have their autostart set to true (by invoking
the set runnable property command) are started automatically.
last.started: only those runnables that were started the last time are started
automatically. These are all runnables for which an explicit start command had been
issued, without being followed by an explicit stop or kill command.
Runnables are started automatically when ARIS Agent starts up, but only if the
autostart.mode is set to all, autostart.flag, or last.started or if ARIS Agent finds all
runnables to be either in state STOPPED or UNKNOWN after starting up. This prevents ARIS
Agent from starting up runnables if ARIS Agent itself but not the entire node is manually
restarted and the runnables themselves are still active.
904
3.22.1.7.7 Make TLS certificate available for ARIS Server

By default, the loadbalancer runnable is set to allow both unencrypted HTTP (port 80) and
encrypted HTTPS (port 443) access. In order to use TLS (former SSL), the certificate must fit
to the load balancer's host name. Otherwise, client connections in particular web browser
connections will fail due to an invalid certificate.
OBTAINING A VALID CERTIFICATE

If you want to use TLS, you need a valid certificate for the server on which the load balancer is
running. This certificate must be signed by a certificate authority (CA). Please make sure that
the certificate is compatible with the Java version of all ARIS clients.
 You can buy a certificate from an official CA. Most clients in particular browsers will trust
certificates signed by such a CA.
 If your company uses own CA, use a certificate from this CA and add this CA to the trust
store of all clients.
ADDING A VALID CERTIFICATE TO THE LOAD BALANCER

Your certificate must contain two parts:
 The private key used to encrypt information sent back to the client (file extension .key).
 The server certificate (file extension .crt).
1. Put the *.key file and the *.crt file into a ZIP archive.
2. Copy this ZIP file to a local directory that can be accessed by ARIS Cloud Controller (ACC).
4. Stop the loadbalancer runnable. Enter, for example: stop loadbalancer_m
5. Enter the ACC command enhance loadbalancer_<s, m, or l> with sslCertificate local
file "<path to the ZIP file>"
Example: enhance loadbalancer_m with sslCertificate local file
"c:\\temp\\lbcert.zip".
If you have blanks or special characters in the path, you must put it in quotes and use a
double backslash instead of a single slash. Alternatively, use single forward slashes, for
example: "c:/temp/lbcert.zip".
6. Start the loadbalancer runnable again. Enter, for example: start loadbalancer_m
The SSL certificate is available.
If ARIS clients cannot perform connections to servers using TLS certification, you need to
provide an additional certificate (see: Basic Troubleshooting Guide).
905
3.22.1.7.8 Redirect ports

In case of port conflicts (see Basic Troubleshooting Guide) redirect the ports, for example,
the default HTTP port 80 or the HTTPS port 443.
Procedure
2. Run a reconfigure command on the loadbalancer runnable.
To make the loadbalancer runnable know through which ports users are now accessing
it, you need to run an ACC reconfigure command with the following syntax:
reconfigure loadbalancer_<SIZING>
HTTPD.zookeeper.application.instance.http.port=<externalHttpPort>
HTTPD.zookeeper.application.instance.port=<externalHttpsPort>
Replace <SIZING> with the sizing you used to install ARIS Server, such as s, m, or l.
Replace <externalHttpPort> with the port from which you redirect to the physical HTTP
port of the loadbalancer runnable (usually port 80).
Replace <externalHttpsPort> with the port from which you redirect to the physical
HTTPS port of the loadbalancer runnable (usually port 443).
This example tells the loadbalancer runnable in an m size installation that users are now
accessing it through the redirected ports 80 and 443:
reconfigure loadbalancer_m HTTPD.zookeeper.application.instance.http.port=80
HTTPD.zookeeper.application.instance.port=443
ARIS users access ARIS using the redirected ports.
If runnables do not start up properly, resolve possible port conflicts.
906
3.22.1.7.9 Redirect HTTPS port

To make ARIS accessible under a privileged port on a Linux system, a user with root privileges
has redirect the ports, for example, the HTTP port 80 or the HTTPS port 443.
If you have forced the loadbalancer runnable to use HTTPS using an ACC command, such as:
reconfigure loadbalancer_m +HTTPD.EnforceHTTPS="true"
connections cannot be established. This is because users are forwarded to https://<server
name>:1443/ instead of https://<server name>.
You must redirect the HTTPS port to 443.
Procedure
2. Enter:
reconfigure loadbalancer_m HTTPD.redirect.https.port=":443"
You must enter a colon followed by the port number.
Users are forwarded correctly.
907
3.22.1.7.10 Collect log files (ACC)

If problems occur during operation, you can use log files to find and resolve errors. You can
download zipped log files related to each runnable or you can download all available log files.
Procedure
2. To collect log files, for example related to the abs_l runnable and save them in the
specified directory, enter: collect log files for abs_l to C:\logfiles
To collect all log files, enter: collect log files or collect logfiles
You can use additional parameters. To get information about the usage of ACC
commands, enter help or help <command>.
All log files are stored as a ZIP archive.
If you cannot solve the problems and have a maintenance agreement, please send an error
description and the ZIP archives containing collected log files as well as the entire contents of
the log and config directories to the ARIS Global Support via Empower
(https://www.softwareag.com/corporate/services/support/default).
908
3.22.1.7.11 Delete log files

Log files may contain private data of ARIS users, such as IP addresses, MAC addresses, or
user names. In order to comply with the General Data Protection Regulation (GDPR), you can
collect log files using ACC or the ACC interface, find personal data related to deleted users
(page 35), and manually delete or anonymize log file entries in source files.
Warning
If you delete log files (page 909), Software AG might no longer be able to support you in order
to resolve software problems.
In order to delete all log files, you must stop (page 902) the related runnables to allow
unhindered access to all files. If you do not stop the runnables, some files may be locked and
cannot be deleted.
Procedure
2. To delete log files, for example related to the abs_l runnable, enter: delete log files for
abs_l
To delete all log files, enter: delete log files or delete logfiles
All log files that are not accessed by a runnable are deleted. Log files that were not deleted
are listed.
909
3.22.1.7.12 ARIS Administration/ARIS Risk and Compliance

If you have installed ARIS Risk and Compliance and ARIS Server you can force ARIS Risk and
Compliance to use the ARIS Administration of the ARIS Server.
3.22.1.7.12.1 Specify a white list for ARIS Administration

You can specify a white list for ARIS Administration.
A white list or black list is a positive or negative list with which systems can be protected.
White lists and black lists pursue opposing strategies.
A white list contains all permitted URLs. A blacklist, on the other hand, specifically excludes
URLs.
Procedure
1. Navigate to <ARIS installation path>\server\bin\work\work_umcadmin_m, for
example, C:\ARIS10.0\server\bin\work\work_umcadmin_m.
3. Stop the ARIS Administration runnable. Enter, for example, stop umcadmin_<s, m, or l>.
4. You must use regular expressions for the white list. A regular expression is a character
string used to describe sets of character strings using certain syntactic rules.
Enter reconfigure umcadmin_<s, m, or l>
"JAVA-Dcom.aris.umc.whitelist.url.regex.pattern"="<comma-separated list of
regular expressions>".
Example
If you want to allow a URL whose name consists of one word in lowercase letters and
begins with https:// and ends with .com, use the following regular expression:
https://[a-z]+.com
if you want to allow graphics of jpg typewhose names consist of mixed-case
alphanumeric characters, and which are located in subdirectories of a URL that begins
with https:// and ends with .com, use the following regular expression:
https://([a-z]*.)[a-z]*[.com](/[a-z]*)(/[a-z]*)(/[A-Za-z0-9_]+.jpg)
5. Start the ARIS Administration runnable. Enter, for example, start umcadmin_<s, m, or l>.
You have specified a white list for ARIS Administration.
You can remove the white list again. To do so, proceed as described above and configure
reconfigure umcadmin_m -"JAVA-Dcom.aris.umc.whitelist.url.regex.pattern".
910
3.22.1.7.12.2 Use existing ARIS document storage and ARIS

Administration for ARIS Risk and Compliance
After you have installed ARIS Risk and Compliance this installation uses a separate set of
runnables, for example, ARIS Administration or ARIS document storage. This means that the
administrator has to manage users and documents. If you already use ARIS Server and have
installed ARIS Risk and Compliance later you can reconfigure your ARIS Risk and Compliance
runnable to your productive ARIS Server installation. This will make ARIS Risk and Compliance
available to all users of your productive system and only one ARIS document storage will be in
use.
Make sure to start the ACC of your ARIS Risk and Compliance installation.
2. To reconfigure ARIS Risk and Compliance and force that runnable to use the ARIS
Administration of your ARIS Server installation, enter: reconfigure arcm_<s,m or l>
zookeeper.connect.string="<ARISServer>\\:14281"
ARIS Risk and Compliance is now accessible via the ARIS Server name, for example,
http://arisserver/arcm by all users managed within the ARIS Administration of your
productive system.
To ensure more memory for the ARIS Risk and Compliance system you can shut down all
other runnables or remove them.
3.22.1.7.13 Process Governance

For information on Process Governance customization, please refer to the Process
Governance Command-Line tool.PDF and the Process Governance Customizing. PDF.
Where to find technical documents:
 ARIS installation package (see Documents > English folder structure)
 Empower (https://empower.softwareag.com/)
 ARIS Download Center (https://aris.softwareag.com/)
3.22.1.7.14 ARIS Aware

You can make custom widgets available for ARIS Aware.
911
3.22.1.7.14.1 Make enhancements available

If you want to use self-designed widgets, LESS files, or CSS files in your ARIS Aware
dashboards you must enhance each dashboarding runnable of your ARIS Server installation
with these files. Enhanced files are not affected by an update setup. They will be preserved.
Procedure
2. To make the custom resource available enter, for example: enhance dashboarding_m
with customResource local file "C:\\mywidgets.zip"
double backslash instead of a single slash.
The ZIP file including its contained folder structure is automatically extracted to the path:
%INSTANCEDDIR%\base\webapps\mashzone
912
3.22.1.7.15 ARIS Publisher

In this chapter product-related examples for configuring the system are available.
From ARIS 10.0.13.0 on ARIS Publisher and IT Inventory are no longer delivered. This means
that you can no longer install or update ARIS Publisher Server. You can still use your current
ARIS Publisher installation, but since this component is no longer supported, no more features
will be developed. We strongly recommend using the ARIS portal (Published content) instead
3.22.1.7.15.1 Provide ARIS Publisher license files

You can provide license files for ARIS Publisher Server using ACC. All other licenses are
managed by ARIS Administration.
Procedure
1. Save the zip file to a local directory that can be accessed by ARIS Cloud Controller (ACC),
for example: d:/Publisher_Server_key.zip
3. Stop the businesspublisher runnable. Enter, for example: stop businesspublisher_l
4. Provide the license using this command: enhance <runnable> with license local file
<path to the saved file>
Example: enhance businesspublisher_l with license local file
"d:\\Publisher_Server_key.zip"
double backslash instead of a single slash. Alternatively, use single forward slashes, for
example: "d:/Publisher_Server_key.zip".
5. Start the businesspublisher runnable. Enter, for example: start businesspublisher_l.
The license is available.
913
3.22.1.7.15.2 Reconfigure settings

You can change settings entered during the setup process. Use the reconfigure ACC
command to change settings, such as ports (page 906). When performing an update setup all
modifications made manually in CFG or XML files will be lost.
In this example, the connection parameters to Process Governance are adjusted.
Procedure
2. Reconfigure businesspublisher_<s, m, or l> and force that runnable to use the ARIS
Administration of your ARIS Server installation.
Ensure that all values used in the reconfigure command, for example, for the keys
username or password actually match to the values used in the <ARIS installation
path>\server\bin\work\work_businesspublisher_<s, m or l>\base\webapps\businesspub
lisher\config\webappserver.cfg file and the umcconfig.cfg file. If typos were made
during the setup process, the affected values must be adjusted.
For better readability, the parameters of the command are shown with line-wraps. For
execution you must enter a single-line command.
bp.age.host="<aris-design-or-connect-srv>.domain.tld"
bp.age.port=80
3. For execution enter a single-line command. For better readability, the parameters of the
reconfigure command are shown with line-wraps, for example:
reconfigure businesspublisher_<s, m, or l>
bp.ado.database="com.idsscheer.aris.businesspublisher.application.dao.database.AOracl
eDAO"
bp.db.driver="oracle.jdbc.OracleDriver"
bp.db.url="jdbc:oracle:thin:@//oracle-srv.domain.tld:1521:oracle_sid"
bp.db.validation.query="select 1 from dual"
bp.db.username="ARISBP"
bp.db.passwd="ARISBP"
bp.arisbpdata="ARISBPDATA"
bp.arisbpindex="ARISBPINDEX"
bp.login.module="UMCLogin"
bp.umc.server.url="http://<aris-design-srv>.domain.tld:<port number>/umc"
bp.umc.admin.login="superuser"
bp.umc.admin.passwd="<superuser's password>"
914
bp.age.host="<aris-design-srv>.domain.tld"
bp.age.port=80
This businesspublisher_<s, m, or l> runnable is reconfigured. Publisher users are
authenticated via ARIS Administration and ARIS document storage will be available if it has
been connected to the ARIS Publisher Server.
These modifications will not be affected by update setups. When performing an update setup
all modifications made manually in CFG or XML files will be lost.
3.22.1.7.15.3 Configure the service 'Create static ARIS

Publisher export' for Process Governance
You can change settings entered during the setup process. Use the reconfigure ACC
command to change settings, such as ports (page 906). When performing an update setup all
modifications made manually in CFG or XML files will be lost. You can configure, that the
Create - Static ARIS Publisher export service supports the port information.
Procedure
1. Start ARIS Cloud Controller (ACC) (page 888) on your <_apg_server>.
2. Enter the folllowing command, for example: reconfigure apg_m
JAVA-Dcom.idsscheer.age.serviceenabling.staticExport.wsServer="<myARIShost>:
<port>/aris/apgstatic"
Ensure that all values used in the reconfigure command, for example, for the keys
username or password actually match the values used in the <ARIS installation
path>\server\bin\work\work_apg_<s, m or l>. If typing errors happened during the setup
process the affected values must be adjusted.
This apg_m runnable is reconfigured.
These modifications will not be affected by update setups. When performing an update setup
all modifications made manually in CFG or XML files will be lost.
915
3.22.1.7.16 Collaboration
In this chapter related examples for configuring the system are available.
3.22.1.7.16.1 Specify a black list for Collaboration

You can specify a black list for Collaboration. Collaboration is the platform for cooperation
across teams. With Collaboration, information can be exchanged faster, knowledge can be
shared, and cooperation across borders is improved. Collaboration is a forum in which users
can mention any URL in posts. It is therefore more appropriate to define a black list.
A white list or black list is a positive or negative list with which systems can be protected.
White lists and black lists pursue opposing strategies.
A white list contains all permitted URLs. A blacklist, on the other hand, specifically excludes
URLs.
Procedure
1. Navigate to <ARIS installation path>\server\bin\work\work_ecp__<s, m, or l>, for
example, C:\ARIS10.0\server\bin\work\work_ecp_m.
3. Stop the Collaboration runnable. Enter, for example, stop ecp_<s, m, or l>.
4. You must use regular expressions for the white list. A regular expression is a character
string used to describe sets of character strings using certain syntactic rules.
Enter reconfigure ecp_<s, m, or l>
"JAVA-Dcom.aris.umc.blacklist.url.regex.pattern"="<comma-separated list of
regular expressions>".
Example
If you want to block yahoo.com, use the following regular expression:
(http(s)?://)?([\\w-]+\\.)+[\\w-]+[\\yahoo\\.com]+(/[/?%&=]*)?
5. Start the Collaboration runnable. Enter, for example, start ecp_<s, m, or l>.
You have specified a black list for ARIS Administration.
You can remove the black list again. To do so, proceed as described above and configure
reconfigure ecp_m -"ecp.blacklist.url.regex.pattern".
916
3.22.1.7.16.2 Create synchronization user

The synchronization user serves technical purposes only. No function or license privileges are
assigned to this user. The synchronization user is required for synchronization processes
executed in the background of Collaboration, for example, to synchronize the user data
between ARIS Administration and Collaboration.
The synchronization user is automatically generated for every newly created tenant. If the
synchronization user is not available, the system (page 22) user is used instead, provided that
the default password of the system user was not changed. If the system user cannot be
used, you must manually create the synchronization user using ARIS Cloud Controller. By
default, the synchronization user name is _aris_tech_user_ecp_techuser.
Procedure
2. To create the synchronization user enter, for example:
enhance umcadmin_m with createUser trigger only options tenant.name=<tenant
name> tenant.user.name="<user name>" tenant.user.pwd="<user password>"
affected.user="<synchronization user name>" affected.email="<synchronization
user e-mail>" affected.pwd="<synchronization user password>"
as.technical.user="true"
set tenant default data for app umc ecpTechnicalUserName="<synchronization
user name>" ecpTechnicalUserPassword="<synchronization user password>"
The user is created and made available for the ecp runnable.
3.22.1.7.16.3 Anonymize Collaboration user

You can anonymize deleted Collaboration users according to GDPR (page 655).
Prerequisites
The user was deleted in ARIS Administration.
Procedure
2. To anonymize, for example, the deleted y4711 user on ecp_m enter: invoke
anonymizeUser on ecp_m anonymize.user=y4711
Activities of this Collaboration user, such as posts, comments, groups, are shown with
Anonymized user instead with the y4711 user name. If several users are anonymized a
number is added, such as Anonymized user 2.
917
3.22.1.7.16.4 Force synchronize Collaboration users

You can transfer users managed in ARIS Administration to Collaboration. This can affect all
users or list of users.
Prerequisites
The user executing the command is then system user or has the Collaboration
administrator function privilege.
Procedure
2. To transfer all users from ARIS Administration, enter, for example: invoke refreshUsers
on ecp_m tenant.id=tenant01
3. To transfer a list of users, enter, for example: invoke refreshUsers on ecp_m
tenant.id=tenant01 user.list="user1,user2,user39"
The list of user names must be comma separated without blanks.
By default system user credentials are used. If you execute the command as a user
holding the Collaboration administrator function privilege, you must specify you user
credentials, such as:
invoke refreshUsers on ecp_m tenant.id=tenant01 tenant.user=<user name>
tenant.user.pwd=<password>
or:
invoke refreshUsers on ecp_m tenant.id=tenant01 tenant.user=<user name>
tenant.user.pwd=<password> user.list="user1,user2,user39"
Users managed in ARIS Administration are available in Collaboration.
918
3.22.1.7.17 Tenant Management

In this chapter related examples for configuring the system are available.
3.22.1.7.17.1 Create a tenant

After the installation of ARIS the default tenant is available. If you need additional tenants to
provide different sets of databases, users, configurations or ARIS methods you can easily
create tenants. If you are going to create additional tenants for ARIS10.0 to migrate data from
ARIS 9.8.7 or later, make sure to use identical names in both ARIS versions. You can also
create tenants using the ARIS Administration's command line tools (page 1020) or Tenant
Management (page 951).
Prerequisites
 ARIS Server installation
 Users need the User administrator function privilege.
 If you use an external database system that was configured using the delivered database
scripts (see ARIS Server Installation Guide), assign the tenants (page 932) to these
schemes before running the command as described below.
Warning
For tenant names please only use up to 25 lowercase ASCII characters and numbers. The
name must begin with a character. Special characters, such as _ and characters, for example,
in Chinese, Cyrillic or Arabic cannot be used.
Procedure
2. Enter: create tenant <tenant name> username=<user name of a user holding the
required privileges> password=<this user's password>.
Example: create tenant test01 master.tenant.user.name = admin
master.tenant.user.pwd= tenantmanager123
You can even change parameters for the new tenant. You must specify additional
parameters in case you use an external database management system, for example
(Oracle):
919
create tenant test01 database.admin.user="system"

database.admin.password="manager" dbinstanceid="db0000000000"
database.schema.tablespace.default="ARISDATA"
database.schema.tablespace.temporary="TEMP"
database.schema.name=aris_test01"
database.schema.password="*ARIS!1dm9n#yy"
The tenant test01 will be created.
3. The administrator must import licenses, create users and user groups and assign
privileges and licenses for the test01 tenant.
4. Start a ARIS client and log in using this tenant. The system database will be created for
that tenant.
The tenant is created and can be backed up (page 920).
3.22.1.7.17.2 Back up a tenant

You can back up tenant data (page 926) using the ARIS Cloud Controller (ACC). If you want to
include the user statistics, the property User statistics in backup
(com.aris.umc.user.statistics.backup) must be enabled in the configuration (see ARIS help:
ARIS Administration > Configuration > User management > Security > Advanced settings).
Please note that no user can work on this tenant during the backup process.
Prerequisites
 Users need the following function privileges. The function privileges depend on the
license. Therefore, you may not be able to assign all of the function privileges shown.
 Analysis administrator  License administrator
 ARCM administrator  Portal administrator
 Collaboration administrator  Process Governance administrator
 Database administrator  Server administrator
 Dashboard administrator  Technical configuration administrator
 Document administrator  User administrator
920
Warning
Do not store backup files (page 1003) in ARIS document storage.
Tenant data is fully backed up only if the user executing the commands has sufficient
privileges for all components in every tenant and if all components were selected for the
backup.
User administration audit events are not part of the tenant backup.
Extensions, for example, TLS/SSL certificates (page 905), SAP® Java Connector, and JDBC
drivers (page 931), added using the enhance ACC command are not backed up.
Procedure
2. Enter: backup tenant <tenant name> to <pathToBackUpFile> encryption.key
<encryption password or encryption key> username=<user name of a user holding
the required privileges>password=<this user's password>
such as: backup tenant default to "f:\\backupDefault.acbcrypt"
encryption.key=str3ngG3h31m username=y1234 password=managery1234. If
values contain special characters, you must quote the strings and special characters. If a
password for example is User&12345, you must enter password=\"User\&12345\"
Make sure to save the backup file on external media, such as a NAS or file server. Notice
the double backslashes. Alternatively, use a single forward slash. If no file name is
specified, the file name is generated as for unencrypted files, but with the file extension
acbcrypt instead of acb. The encryption password must be at least 8 characters long
and contain at least 3 out of the 4 following character classes: lower-case letter,
upper-case letter, digit, special character (such as any non-whitespace, non-letter,
non-digit character).
The backup is started. The complete backup is written to one single acb archive file. If you
encrypted the backup file, the file extension is acbcrypt.
921
If a tenant backup containing Process Governance data takes a long time to complete,
Process Governance downtime is likely to be long. To reduce Process Governance downtime
while the backup is in process, you can set the Use snapshot-based backup mode property
in the Process Governance configuration. For details, refer to the ARIS online help (Manage
ARIS > Set up Process Governance > Valuable information >What infrastructure properties are
available?).
You can restore (page 925) this tenant using the related archive file. Using the restore
tenant command will copy the content to an existing tenant. Process Governance backup
archives greater than 2 GB might lead to insufficient TEMP space issue when restoring them
into ARIS with Oracle back end. For such large backups, extend the temp tablespace size
before restoring operation executed.
You can manage tenants also using the ARIS Administration's command line tools (page 1020)
or Tenant Management tool (page 951).
922
3.22.1.7.17.3 Delete a tenant

If you delete a tenant all tenant information are lost:
 Databases
 User data (users, privileges and licenses)
 ARIS document storage data including all access rights
 Process Governance data
 Ad hoc analyses and queries
Prerequisites
Warning
If you delete a tenant all tenant information are lost.
Procedure
1. Back up (page 920) the tenant in order to be able to restore (page 925) data again.
3. Enter: delete tenant <Tenant name> username=<user name of a user holding the
required privileges> password=<this user's password>
Deletes the specified tenant and all its associated data from the system. User name and
password of an administrative user have to be specified using the parameters
master.tenant.user.name and master.tenant.user.pwd, respectively. If values contain
special characters, you must quote the strings and special characters. If a password for
example is User&12345, you must enter password=\"User\&12345\"
Warning
If the optional force keyword is used, the security question Are you sure? is not
displayed and the tenant and its data will be deleted without further prompting the user.
The tenant has been deleted.
923
You can also manage tenants using the ARIS Administration's command line tools (page 1020)
or Tenant Management (page 951).
924
3.22.1.7.17.4 Restore a tenant

You can restore tenant data (page 926) or copy the content of this tenant (page 928) to a
different ARIS server. You need to have access to the relevant back-up archive file containing
the data of a tenant:
Warning
No user can work on this tenant during the restore process. All current data of a running
tenant will be deleted and replaced by the data of the backup file. Data related to ARIS
Administration will not be deleted but merged. The tenant name and current user data will be
untouched. If users were deleted after the tenant has been backed up, these users will be
available again. Make sure to delete those users.
Process Governance backup archives greater than 2 GB might lead to insufficient TEMP space
issue when restoring them into ARIS with Oracle back end. For such large backups, extend the
temp tablespace size before restoring operation executed.
Prerequisites
 You need access to the relevant back-up archive file.
925
Procedure
2. To restore the tenant, enter: restore tenant <tenant name> from <pathToBackUpFile>
encryption.key <encryption password or encryption key> username=<user name of
a user holding the required privileges> password=<this user's password>
such as: restore tenant default from "f:\\backupDefault.acbcrypt"
encryption.key=str3ngG3h31m username=y1234 password=managery1234
or as an example for the use of an unencrypted acb file: restore tenant default from
"f:\\backupDefault.acb" username=y1234 password=managery1234
Notice the double backslashes. Alternatively, use a single forward slash. If values contain
The tenant will be restored.
3. Make sure to change the standard user's passwords again.
The tenant is restored. You can also manage tenants using the Tenant Management tool
(page 951) or the ARIS Administration's command line tools (page 1020).
If you have restored a tenant from an ARIS 10 SR5 backup file or earlier containing ARIS
document storage data, you must adjust the timestamps manually (page 930) (see
y-admintool.bat command-line tool).
3.22.1.7.17.5 What data is backed up and restored?

If you back up tenants, the current state of the following data is saved in different folders in
the tenant backup zip file.
backup. In ARIS 10 all started runnables are automatically taken into account when executing
tenant backup/restore commands.
Warning
926
Content Required function privileges Component (runnable)

Data from ARIS User administrator ARIS Administration/User
Administration, Technical configuration Management
for example, users, privileges. administrator (umcadmin_<s, m, or l>)
User statistics are not
included by default. If you
want to include the user
statistics, the property User
statistics in backup
(com.aris.umc.user.statistic
s.backup) must be enabled in
the configuration (see ARIS
help: ARIS Administration >
Configuration > User
management > Security >
Advanced settings).
Licenses License administrator

User administration audit
events are not part of the
tenant backup.
System database (page 1152) Server administrator Modeling & Publishing

Contains filters, templates, (abs_<s, m, or l>)
and font formats, but also
ARIS Method and all
evaluation scripts, macros
and scheduled reports.
ARIS databases (page 1122) Database administrator
Ad hoc analyses and queries Analysis administrator Analysis

(octopus_<s, m, or l>)
ARIS document storage data, Document administrator ARIS document storage

including Process Governance (adsadmin_<s, m, or l>)
archives
Technical configuration
Documents and access administrator
privileges
927

Process Governance data Process Governance Process Governance
administrator (apg_<s, m, or l>)
Collaboration data Collaboration administrator Collaboration

(ecp_<s, m, or l>)
ARIS Risk and Compliance ARCM administrator ARIS Risk and Compliance
data (arcm_<s, m, or l>)
Dashboards and feeds Dashboard administrator ARIS Aware

(dashboarding_<s, m, or
l>)
ARIS portal views, Portal administrator ARIS portal

modification sets, and (copernicus_<s, m, or l>)
configuration sets.
3.22.1.7.17.6 Copy a tenant to a different server

You can copy the content of a backed up tenant to a different ARIS Server. This procedure
can also be used to migrate data in case of an upgrade installation. You need to have access
to the relevant back-up archive file containing the data of a tenant:
 All databases
 All user data (users, privileges and licenses)
 All ARIS document storage data including all access rights
 All Process Governance data
 All ad hoc analyses and queries
Prerequisites
 You need access to the relevant back-up zip file
928

Procedure
1. Create a tenant (page 919) on the ARIS Server where the tenant will be copied to and
import the licenses.
3. To restore Process Governance data, stop the Process Governance runnable first. To do
so enter, for example: stop apg_m
4. Enter: restore tenant <Tenant name> from <pathToBackUpFile> encryption.key
the required privileges> password=<this user's password>
example is User&12345, you must enter password=\"User\&12345\". You must enter
the user credentials of the server's ARIS Administration you have created the new tenant.
If you are about to migrate data, you might use the standard name and password
system/manager.
5. In case you restored Process Governance data, restart the Process Governance runnable.
To do so enter, for example: start apg_m
All data of the backup file will be copied to the new tenant. Current data will be deleted except
the name of the new tenant, as well as user credentials. The current user data will be
available again. Please make sure to delete those users.
In case of a migration process the default credentials will automatically be in use. To prevent
unauthorized access to the ARIS system, after installation or data migration, always change
the default passwords of all users that are automatically created (page 22) (arisservice user,
guest user, system user, superuser user) on all operational tenants, as well as on the
infrastructure tenant (master).
You can also create tenants using the ARIS Administration's command line tools (page 1020)
929
3.22.1.7.17.7 How to adjust timestamps related to ARIS

document storage
In previous ARIS versions, ARIS document storage stored timestamps, for example Creation
time and Update time, referred to documents and folders in local server time and without
any time zone information. If data was moved between ARIS Servers or if a tenant was
restored from a backup file, timestamps were likely adjusted using a wrong time offset.
Since ARIS 10 SR6, Coordinated Universal Time (UTC) is mandatory for timestamps stored
by ARIS document storage. Because time zone information in existing data is not available,
the timestamps of existing documents and folders cannot be adjusted automatically. After
the update to ARIS 10 SR6, you must manually adjust timestamps. In a Windows-based
installation with local time UTC-2, for example, use the y-admintool.bat command-line tool
and, considering UTC offset of your ARIS Servers>, enter the following:
y-admintool.bat -s https://localhost -t default adjustTimestamps -offset "-120" -u
system -p manager
If you have restored a tenant from backup file created with ARIS 10 SR5 or earlier, you must
adjust the timestamps as well.
930
3.22.1.7.18 Database connection

This chapter provides information on configuring ARIS Server in order to use an external
database management system.
3.22.1.7.18.1 Provide JDBC drivers

During the setup procedures of ARIS Server or ARIS Publisher Server using Oracle or Microsoft
SQL Server the JDBC driver is provided automatically. You can enhance JDBC drivers
manually.
Procedure
1. Download the JDBC driver from the Microsoft or Oracle Web Sites to local directory that
can be accessed by ARIS Cloud Controller (ACC).
For example: d:\ojdbc<number>.jar.
3. Stop the server runnables. Enter: stopall.
4. Provide the JDBC driver using the enhance command. If you have blanks or special
characters in the path, you must put it in quotes and use a double backslash instead of a
single slash.
5. Example: enhance abs_l with webappsClasspath local file "d:\\ojdbc<number>.jar"
The file is copied to the <ARIS installation
directory>\server\bin\work\work_abs_l\base\lib. The source file can be deleted.
6. Delete obsolete JDBC driver files from the <ARIS installation
directory>\server\bin\work\work_abs_l\base\lib. If you add the latest file to update
your JDBC driver with the enhance ACC command, both driver files, the obsolete file and
the latest file are present. As a result, runnables will not start correctly because the JDBC
driver to be used cannot be determined.
7. Start the server runnables. Enter: startall
The driver is available.
931
3.22.1.7.18.2 Update external service (database clusters)

If you have performed an installation using an Oracle or Microsoft SQL database cluster you
need to reconfigure the external service after the installation process.
This procedure shows an example for an Oracle database.
Procedure
2. To connect to an Oracle cluster using a JDBC URL you may use this example:
update external service <dbserviceID>
url="jdbc:oracle:thin:@(DESCRIPTION=ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP
) (HOST=<virtual-ip-oracle-cluster>)(PORT = <target
port>)))(CONNECT_DATA=(SERVICE_NAME=cluster-database-name)))"
driverClassName="oracle.jdbc.OracleDriver" username="<cip_app_user>"
password="<new_cip_app_pwd>" maxIdle=15 maxActive=100 maxWait=10000
removeAbandoned=false removeAbandonedTimeout=600 logAbandoned=true
defaultAutoCommit=false rollbackOnReturn=true host=<target_host>
jmxEnabled=true validationQuery="select 1 from dual" testOnBorrow=true
ARIS Server can be started using the Oracle cluster.
3.22.1.7.18.3 Configure the database connection for

additional schemes
ASSIGN TENANT TO DATABASE SCHEMA

During the setup process you have created an empty Oracle or Microsoft SQL schema for an
additional tenant (see ARIS Server Installation Guide). Additionally created tenants must be
assigned to the database schema. Replace values in angle brackets, such as <tenant name>
with your own values, such as new tenant1.
2. To discover the database service ID (<dbserviceID>, such as db000000000), enter:
list external services
assign tenant <tenant name> to service <dbserviceID> com.aris.cip.db.schema =<schema
name>
name must begin with a character. Special characters, such as _ and characters, for
example, in Chinese, Cyrillic or Arabic cannot be used.
932
3. To create a new tenant, enter:

create tenant <tenant name>
The new tenant is available on ARIS Server.
ADDITIONAL SETTINGS
To enable validationQuery for external database connections (Oracle & Microsoft SQL) please
use the correct validation query for the DBMS.
For Oracle use:
validationQuery="select 1 from dual" and testOnBorrow=true
For Microsoft SQL use:
validationQuery="select 1" and testOnBorrow=true
For better readability, the parameters of the command are shown with line-wraps. For
execution you must enter a single-line command.
During registration of external service add parameters, for example, for Oracle:
register external service db
url="jdbc:oracle:thin:@<target_host>:<target_port>:<oracle_sid>"
driverClassName="oracle.jdbc.OracleDriver"
username="<cip_app_user>
password="<cip_app_pwd>"
maxIdle=15
maxActive=100
maxWait=10000
removeAbandoned=false
removeAbandonedTimeout=600
defaultAutoCommit=false
rollbackOnReturn=true
host=<target_host>
port=<target_port>
jmxEnabled=true
validationQuery="select 1 from dual"
testOnBorrow="true"
After the external service was already registered, for example, for Oracle:
update external service <dbserviceID>
url="jdbc:oracle:thin:@<target_host>:<target_port>:<oracle_sid>"
driverClassName="oracle.jdbc.OracleDriver"
username="<cip_app_user>"
password="<cip_app_pwd>"
maxIdle=15
maxActive=100
maxWait=10000
removeAbandoned=false
removeAbandonedTimeout=600
defaultAutoCommit=false
rollbackOnReturn=true
host=<target_host>
jmxEnabled=true
933
validationQuery="select 1 from dual"

testOnBorrow="true"
ENABLE VALIDATIONQUERY FOR EXTERNAL POSTGRESQL CONNECTION

1. Enter: stopall
2. Enter: reconfigure <postgres_runnable> dbsp.validationQuery="select 1"
dbsp.testOnBurrow=true
3. Enter: startall
The database connection is configured.
3.22.1.7.18.4 Move the database management system

If you run ARIS using an external database management system and the operational database
server has moved, you must update the settings, for example, the IP address and the server
name.
Procedure
2. Stop all runnables, except the zoo runnable (service registry).
3. Determine the service ID of the external database service to be changed. Enter: list
external services
4. Check the current settings of the external database settings. Enter: show external
service <service ID>
Example: show external service db0000000000
Depending on the database system in use different settings are displayed.
Output example (Oracle):
Service db0000000000 (Type DB)
Parameters:
...
host sbrva100.com.ad.aaf
...
url jdbc:oracle:thin:@//sbrva100.com.ad.aaf:1521/aris
...
Output example (Microsoft SQL Server):
Service db0000000000 (Type DB)
Parameters:
934
...
host sbrva100.com.ad.aaf
...
url jdbc:sqlserver://sbrva100.com.ad.aaf;DatabaseName=aris10db;instanceName=aris
...
5. Change the required settings using the update external service command.
Example (Oracle):
update external service <service ID> url="jdbc:oracle:thin:@//<Oracle server>:<listener
port>/<instance name>" host=<Oracle server>
Example (Microsoft SQL Server):
update external service <service ID> url="jdbc:sqlserver://<Microsoft SQL
Server>:<listener port>;DatabaseName=<database name>;instanceName=<instance
name>" host=<Microsoft SQL Server>
6. Check the applied database schema. Enter: list tenant <name> data for service db
Output example (default tenant):
Data of tenant default tenant for application db
Key Value
com.aris.cip.db.schema aris_default
com.aris.ecp.db.schema aris_default
name default
7. Change the schema settings for all tenants, if required. Enter:
set tenant <tenant name> data for service db com.aris.cip.db.schema=<new schema
name>
Example (master tenant):
set tenant master data for service db com.aris.cip.db.schema=aris10_master
(com.aris.ecp.db.schema not needed)
Example (default tenant):
set tenant default data for service db com.aris.cip.db.schema=aris10_default
com.aris.ecp.db.schema=aris10_default
8. Check the new settings using the commands:
show external service <service ID>
list tenant <tenant name> data for service db
9. Start all runnables. Enter: startall
935
3.22.1.7.19 Elasticsearch
The Document index (Elasticsearch) is a basic component that contains the full-text search
index for documents and collaboration data. It also stores users, user groups, licenses, and
privileges. By default, the elastic_<s, m, or l> runnable (Elasticsearch) uses generic user
credentials required for communication with other ARIS runnables.
3.22.1.7.19.1 Check user name and password

(Elasticsearch)
By default, the elastic_<s, m, or l> runnable (Elasticsearch) uses generic user credentials
required for communication with other ARIS runnables. You can check the user name and
password in use.
Procedure
1. Navigate to <ARIS installation path>\server\bin\work\work_elastic_m, for example,
C:\ARIS10.0\server\bin\work\work_elastic_m.
2. Open the instanceId.elasticsearch file with a text editor.
3. Copy the instance ID, for example:
elasticsearch0000000000
5. Once ACC is initialized, enter show service elastisearch<ID>, for example:
show service elasticsearch0000000000
User name and password are displayed.
You can change (page 937) the user name and the password if required.
936
3.22.1.7.19.2 Change user name and password

(Elasticsearch)
By default, the elastic_<s, m, or l> runnable (Elasticsearch) uses generic user credentials
required for communication with other ARIS runnables. You can check (page 936) and change
the user name and the password if required.
Procedure
2. Once ACC is initialized, enter:
reconfigure elastic_<s, m, or l> +ELASTICSEARCH.aris.api.user.name="<new user
name" +ELASTICSEARCH.aris.api.user.password="<new password>"
for example:
reconfigure elastic_m +ELASTICSEARCH.aris.api.user.name="administrator"
+ELASTICSEARCH.aris.api.user.password="Thssmynwpsswrd"
3. Stop the Collaboration runnable ecp_<s, m, or l>. Enter, for example:
stop ecp_m
4. Restart the Collaboration runnable. Enter, for example:
5. start ecp_m
You have changed the user credentials required for the Elasticsearch.
937
3.22.1.7.19.3 Disable authentication for Elasticsearch

You can switch off the authentication for the Elasticsearch.
Warning
Disabling authentication is not recommended and must be considered carefully. It bears a
potentially risk to data security.
Procedure
2. Once ACC is initialized, enter: reconfigure elastic_<s, m, or l>
+ELASTICSEARCH.aris.api.deactivate.authentication="true"
for example: reconfigure elastic_m
+ELASTICSEARCH.aris.api.deactivate.authentication="true"
You have disabled the authentication for the Elasticsearch.
938
3.22.1.7.20 Health check

You can monitor the health of a specific runnable as well as the health of the whole system.
3.22.1.7.20.1 Show node

The show node command shows machine monitoring information concerning CPU, memory
and disk usage. If a threshold is violated, it will be shown.
Prerequisite
Health monitoring parameters are set (page 942).
Procedure
2. Make sure that the runnables have been started.
3. Enter: show node
The output will be in tabular format and look like this example:
939
3.22.1.7.20.2 Monitor runnable's health

The health command determines a variety of health values for each runnable.
The exact list of health values available depends on the specific runnable. However, a few
basic measurements are available to all runnables, in particular the CPU load and its memory
usage. For all Java-based runnables, additional information is available.
Prerequisite
Procedure
2. Make sure that the runnable has been started.
3. Enter, for example: show instance zoo_m health
The output will look like this example:
The first column shows the name of the measured value and its physical unit, for example,
megabytes, percent, etc.
The second column shows the current value of the health value. Note that this is not
measured the moment the command is executed. The agent plugin will take measurements
periodically, and this column will show the result of the last measurement.
The third column shows the range of possible values, for example, minimum and maximum
value. If no minimum or maximum value can be determined or the value does not have an
ordinal value scale a - is shown instead.
The fourth and fifth columns show the minimum and maximum values, respectively. These
values were observed since the runnable or the ARIS Agent had last been restarted, but only
if the health value measured has an ordinal value scale. For values measured without an
ordinal value scale, - will be shown.
The sixth column shows the low or high warning thresholds for the measured value, if the
measured health value has an ordinal value scale and if thresholds have been configured.
940
The seventh column shows the state of the measured value if the measured health value has
an ordinal value scale and if a low and/or high threshold has been configured. The state can
be either OK, LOW or HIGH. If in LOW or HIGH state, the column will also show for how long
the value has been in that state already.
941
3.22.1.7.20.3 Configure health monitoring

If you use the health monitoring (page 1022), using ACC, make sure to configure the system.
Procedure
2. Enter the parameters described below.
THRESHOLDS
Thresholds for monitored values can be configured using agent configuration parameters:
Parameter Description
monitoring.high.cpu.threshold.percent High CPU usage threshold
(0.0 – 1.0, default 0.8) (relative, in percent)
monitoring.relative.low.disk.space.warnin Low memory threshold

g.threshold.percent (relative, in percent)
(0.0 – 1.0, default 0.03)
monitoring.absolute.low.disk.space.warni Low disk space threshold

ng.threshold.megabytes (absolute, in megabytes)
(default 1000)
Warning
ARIS Agent not only warns against
insufficient disk space. When the default
value (1000 MB) is reached, all runnables are
immediately shut down (killall) to avoid data
inconsistencies. Runnables cannot be
restarted. ARIS Agent autostart is disabled.
THRESHOLD MEASUREMENT
The measurement can be configured by the following parameters:
monitoring.interval Interval in milliseconds, in which the
(default 1000) measurement will be done.
monitoring.high.cpu.number.of.intervals. Number of measurements with CPU load

warning.threshold above threshold before a warning state is
(default 10) reached
942
monitoring.high.mem.usage.number.of.int Number of measurements with memory
ervals.warning.threshold usage above threshold before a warning
(default 10) state is reached.
monitoring.low.disk.space.number.of.inte Number of measurements with free disk

rvals.warning.threshold space below threshold before a warning state
(default 10) is reached.
MAIL NOTIFICATION
Mail notification can be configured by the following parameters:
mail.notification.enable true enables automatic mailing.
d
(default: false)
mail.smtp.host Qualified hostname or IP of the mail server.
mail.smtp.port Port of the mail server.

(common: 25)
mail.smtp.username User name on the mail server. If this parameter is set, the
applications will implicitly enable SMTP authentication. There
is NO dedicated parameter to explicitly enable SMTP
authentication.
mail.smtp.password Mail server password for the specified user.
mail.sender.address Sender's e-mail address.
mail.sender.name Sender's name.
mail.recipients Recipient's e-mail address.

This parameter is multivalued, specify several recipients
separated with commas, for example:
set mail.recipients = "a@abc.com","b@abc.com"
mail.recipients.cc Recipient's e-mail address (Carbon Copy(CC)).

This parameter is multivalued (see mail.recipients)
943
mail.on.system.events Defining events triggering e-mail notification.
This parameter is multivalued, specify several event types
separated by comma, for example:
set mail.on.system.events =
MACHINE_STATE_CPU_LOAD_HIGH, MACHINE_STATE_
Possible values:
 MACHINE_STATE_LOW_DISK_SPACE_PERCENT
 MACHINE_STATE_OK_DISK_SPACE_PERCENT
 MACHINE_STATE_LOW_DISK_SPACE
 MACHINE_STATE_OK_DISK_SPACE
 MACHINE_STATE_CPU_LOAD_HIGH
 MACHINE_STATE_CPU_LOAD_OK
 MACHINE_STATE_MEMORY_USAGE_HIGH
 MACHINE_STATE_MEMORY_USAGE_OK
944
3.22.1.7.21 Mailing
This chapter provides information on configuring automatic mailing.
3.22.1.7.21.1 Configure ARIS Agent mail server connection

If only ARIS Agent is installed but no ARIS server you can activate automatic mailing in order
to receive technical information from ARIS Agent. This will inform administrators, for example,
about performance problems concerning ARIS Agent.
1. Start ARIS Cloud Controller (ACC) (page 888) on the machine where ARIS Agent is
installed.
2. Enter the following lines one after the other.
Example:
set mail.notification.enabled=true
set mail.smtp.host=mailserver.us
set mail.smtp.port=25
set mail.smtp.username=<user name>
set mail.smtp.password=<password>
set mail.recipients=aris.administrator1@company.com
set mail.recipients.cc=aris.administrator2@company.com
set mail.sender.address=<COMPUTERNAME>@us.co
ARIS Agent mail server connection is set.
d
(default: false)

(common: 25)
authentication.
945



Possible values:
mail.on.state.change Defining events triggering e-mail notification if a runnable is in

(default: FAILED) the state FAILED.
946
mail.on.runnable.monito Defining events triggering e-mail notification.
ring.events This parameter is multivalued (see mail.on.system.events).
Possible values:
 RUNNABLE_MONITORING_HIGH_THRESHOLD_EXCEEDE
D
 RUNNABLE_MONITORING_LOW_THRESHOLD_EXCEEDED
947
3.22.1.7.21.2 Configure SMTP mail server connection

If you did not enter the SMTP server connection parameters during the setup process of a
previous ARIS version you need to register your SMTP server manually.
2. Enter, for example:
register external service smtp host="YourMailServerAddressWithDomain" port=25
3. Check that setting entering:
list external services
SMTP mail server configuration is set.
You can modify SMTP configuration parameters using the update external service
command.
Default
Parameter Type Description
value
Host String Qualified hostname or IP of the SMTP server.
host
Port Integer 25 Port of the SMTP server.

port
User name String User name on the SMTP server. If this

username parameter is set, the applications will
implicitly enable SMTP authentication. There
is NO dedicated parameter to explicitly enable
SMTP authentication.
Password String Password for the user on the SMTP server.

password
Sender address String Sender's e-mail address.

sender.address
TLS Boolean false Specifies if SMTP server is TLS enabled.

use.tls
948
Default
Parameter Type Description
value
TLS mode String STARTTL Specifies the method used to secure the
tls.mode S connection. Accepted values are STARTTLS
and SSL. STARTTLS upgrades an initially
insecure connection to an encrypted one
without requiring a dedicated port for secure
communication, whereas SSL immediately
establishes a secured connection on a
dedicated port.
949
3.22.1.7.22 Third-party document management systems

(TDMS)
This chapter provides information on configuring ARIS Server to use an external TDMS.
3.22.1.7.22.1 Make TDMS available

If you want to use third-party document management systems, you must enhance the ARIS
document storage runnable with a custom jar file. The systems available are ARIS Adapter
for Microsoft® SharePoint 2016 and ARIS Adapter for Microsoft® SharePoint 2019. Please
contact your local Software AG sales organization (http://www.softwareag.com) for other
third-party document management systems.
Procedure
1. Save the custom jar file for the third-party document management system.
3. Stop the ARIS document storage runnable. Enter, for example: stop adsadmin_m
4. Provide the custom jar file for the third-party document management system using the
enhance command. If you have blanks or special characters in the path, you must put it
in quotes and use a double backslash instead of a single slash.
Example: enhance adsadmin_m with webappsClasspath local file
"d:\\dms-adapter.jar"
The file has been made available. The source file can be deleted.
5. Start the ARIS document storage runnable. Enter: start adsadmin_m
The third-party document management system is available.
You must configure the settings for the TDMS in ARIS Administration, refer to chapter
Manage ARIS > Configure ARIS > Set up Document storage > Add third-party document
management system of the ARIS online help.
950
3.22.2 Tenant Management tool

Tenant Management enables users (page 985) to centrally manage all of a company's ARIS
tenants on the infrastructure tenant.
All tenant data (page 995) can be backed up from the running system manually or using a
schedule.
Users with appropriate privileges can back up all data (page 995) from tenants using
schedules. They thus create restore points. All data from the tenant is saved in a backup list.
Any number of schedules can be created for each tenant. If you create a large number of
schedules and backups, make sure the storage medium has sufficient capacity.
Prerequisites
 The user name and password have been entered in the backup options (page 980).
 The default location for saving backup files was changed (page 979) to a different folder
on a physical drive to prevent that files stored in the default location are automatically
deleted when you perform an update setup.
Warning
Procedure
1. Click Schedules. The schedules for all tenants are displayed.
2. Click Create schedule. The Create schedule dialog opens.
3. Enter the description for the backup. This text makes it easier to select the relevant
backup when restoring the tenant.
4. Select the time for the automatic backup. You can set an automatic backup daily or on a
particular day of the week. Select a time on the hour as the start time.
5. Select the maximum number of backups to be saved in the tenant backup list for this
schedule. If you select 10, a maximum of the 10 last versions can be restored.
6. Select the tenant to be backed up.
7. Click OK.
The schedule is created.
951
An additional backup is added to the tenant backup list (page 1000) at the specified time. If
the selected number of backups already exists, the oldest is removed to free up space for the
new backup.
If no content is displayed, add a node (page 1031) to manage tenants.
If you installed ARIS using the ARIS Server setup program, the Tenant Management user
interface is available. The Tenant Management user interface is run automatically with the
user account of the superuser user. In order for other users to be able to log in (page 952),
you must configure the infrastructure tenant (page 985). This assigns users in the
infrastructure tenant privileges for impersonation (page 73), along with additional function
privileges.
Once all operational tenants are configured (page 987), impersonation enables users to
assume the account of the superuser system user in order to perform administration tasks.
After the ARIS Server was updated, for all operational tenants make sure to specify
superuser in the Impersonation target users field again.
If you want existing tenants that were not created using Tenant Management to be managed
centrally, you have to adjust the configuration of these tenants (page 989).
3.22.2.1 Open Tenant Management

System users and users (page 985) to whom the required privileges are assigned can log in to
Tenant Management on the infrastructure tenant.
 They know the passwords for the system users system or superuser.
 They have login privileges (page 985).
Procedure
1. Click the link that was provided to you or that you have saved as a bookmark in your
browser (syntax: <server name>:<port>/tm). The Tenant Management login dialog opens.
The name of the infrastructure tenant is displayed. You cannot select any other.
2. Select the interface language. You cannot change the language once you have logged in.
Clicking Forgot password enables you to reset the password.
Warning
If you reset the password for the user system or superuser, other users can no longer
log in with these user names. Automated processes, for example, automatic backups, can
no longer be performed.
4. Click Log in.
You can manage all tenants in the system.
952
3.22.2.2 Manage tenants

All tenants in the system are managed on the Tenants page (page 997).
3.22.2.2.1 Create tenant

Create tenants centrally.
Procedure
1. Click Tenants.
2. Click Create tenant. The dialog opens.
3. Enter the name using lowercase letters or numbers.
4. Select the required license file.
5. Click OK.
The tenant has been created.
If it is not displayed, click Refresh.

You can add content to the new tenant by using a backup file from another tenant. If the
backup file contains user data, you must change the passwords of the arisservice user,
guest user, system user, and superuser user. This is because the passwords for the listed
users are not imported from the backup file but are copied from the infrastructure tenant
(master).
If you did not not change the passwords on the infrastructure tenant, you must change the
passwords on the restored tenant again.
953
3.22.2.2.2 Lock tenant

Deactivate tenants. This means that users whose licenses are managed on that tenant can no
longer log in to the programs. All databases are locked.
Procedure
1. Click Tenants.
2. At the end of the row for the tenant, click More > Lock.
The tenant is locked. It is no longer available to users and its status is shown in the list as
Locked. If the change is not displayed, click Refresh.
3.22.2.2.3 Activate tenant

Activate locked tenants. This means that users with appropriate privileges whose licenses are
managed on that tenant can log in to all programs again. All data is available again.
Procedure
1. Click Tenants.
2. At the end of the row for the tenant, click More > Activate.
The tenant is activated. It is available to users again and its status is shown in the list as
Active. If the change is not displayed, click Refresh.
3.22.2.2.4 Allow access

Add missing permissions to the superuser, if impersonation (page 73) failed. This can occur, if
tenants were added by ARIS Cloud Controller (ACC) but functional privileges are missing.
Procedure
1. Click Tenants. The status of the tenants is displayed. If the Impersonation failed
status is shown, the tenant is not accessible for users.
2. At the end of the row for the tenant, click More > Allow access. The Allow access
dialog opens.
3. Enter the user credentials of a user with sufficient privileges, for example, system.
4. Click OK.
The missing privileges are applied to the superuser. Impersonation should work and the
Active state is shown. If the change is not displayed, click Refresh.
954
3.22.2.2.5 Copy tenant

Copy tenants, for example, to create new tenants based on existing ones. Licenses are no
longer valid in copied tenants as licenses have to be uniquely assigned to a specific tenant.
Procedure
1. Click Tenants.
2. At the end of the row for the tenant, click More > Copy. The Copy tenant dialog
opens.
3. Enter the name using lowercase letters or numbers.
4. Select a valid license file for this tenant.
5. Click OK.
The tenant is copied. It contains all the content of the tenant you have copied.
3.22.2.2.6 Back up tenant

Users with appropriate privileges can manually back up all data (page 995) from tenants. They
thus create a restore point. All information about the tenant is saved in a backup list. If you
want to include the user statistics, the property User statistics in backup
Warning
Prerequisite
The default location for saving backup files was changed (page 979) to a different folder on a
physical drive to prevent that files stored in the default location are automatically deleted
when you perform an update setup.
Procedure
1. Click Tenants.
955
2. At the end of the row for the tenant you want to back up, click More > Backup. The
Back up tenant dialog opens.
3. Select the content to be included in the backup and enter a description for the backup
version. This text makes it easier to select the relevant version when restoring (page 959)
the tenant.
The Now option is enabled by default. It means that the backup is performed once after
you have closed the dialog.
4. Select another option if you want to define a backup schedule (page 981).
5. Click OK. The tenant is backed up. During backup, the Backup in progress symbol is
displayed in the Last backup column.
The selected content of the tenant (page 995) was saved in the backup list if a check mark
and timestamp appear in the Last backup column. The system administrator is informed by
e-mail whether the action was completed successfully or whether warnings or errors
occurred.
available?)
You can restore (page 959) the tenant with this data at any time.
3.22.2.2.7 Download last backup file

You can save individual versions of backup files from backup lists locally, in order to restore
tenants (page 959). To download the current version, proceed as follows:
Prerequisite
The tenant has been backed up (page 955).
Procedure
1. Click Tenants.
2. At the end of the row for the tenant, click More > Download.
3. If you want to encrypt the backup file, enter a password. The password must be at least 8
characters long and contain at least 3 out of the 4 following character classes:
 lower-case letter
 upper-case letter
956
 digit
 special character (such as any non-whitespace, non-letter, non-digit character).
The latest backup version of the tenant is downloaded to the directory you have specified as
the download directory in your browser settings.
3.22.2.2.8 Download specific backup file

You can save individual backup files from backup lists (page 1000) locally, in order to restore
tenants (page 959).
Prerequisite
Procedure
1. Click Backups.
2. At the end of the row for the relevant tenant, click Open backup list. The Backup list
- <tenant> dialog opens.
3. Select the relevant backup based on the description and the backup date.
4. At the end of the row, click More > Download.

5. If you want to encrypt the backup file, enter a password. The password must be at least 8
characters long and contain at least 3 out of the 4 following character classes:
 lower-case letter
 upper-case letter
 digit
 special character (such as any non-whitespace, non-letter, non-digit character).
The backup file is downloaded to the directory you have specified as the download directory
in your browser settings.
3.22.2.2.9 Restore tenants

Users with appropriate privileges can restore all data (page 995) for backed up tenants based
on either a backup list saved in the ARIS installation directory or a locally saved backup file
(page 956).
957
3.22.2.2.9.1 Restore tenant from backup file

You can restore the tenant based on a backup file that you have downloaded from its backup
list.
Prerequisites
 The tenant has been backed up (page 955).
 Make sure you have downloaded (page 957) the required backup file.
 Make sure that changes made since the last backup have been manually backed up
(databases, configuration, system database).
Warning
Procedure
1. Click Tenants.
2. Back up the current status of the tenant. If changes made since the last backup have not
been entirely saved, you can restore them.
3. At the end of the row for the tenant you want to restore, click More > Restore. A
dialog of the same name opens.
4. Click OK in the Warning dialog. The Restore tenant dialog opens.
5. Click File.
6. Click Select.
7. Navigate to the directory to which you have downloaded the backup file.
958
8. Double-click the archive file you want to use to restore the tenant. The .crypt extension
indicates encrypted backup files. For these files the related encryption password is
required to restore a tenant.
9. If you have selected an encrypted backup file, enter the password used for encryption.
10. Click Next and select the content to be restored.
11. Click OK.
The tenant is restored. All data is overwritten with the data version from the backup (page
995). Changes made and data added since the last backup are lost.
Administrators can restore lost data if the data has been manually backed up before restoring
the tenant (see Prerequisites).
3.22.2.2.9.2 Restore tenant from backup list (from Tenants

page)
Users with appropriate privileges can restore all data (page 995) for backed up tenants based
on a backup list saved in the ARIS installation directory.
Prerequisites
Warning
959

Procedure
1. Click Tenants.
2. At the end of the row for the tenant, click More > Restore. A warning is displayed.
4. Select Backup.
Move the mouse over the individual entries to show a description. The description lists all
components whose data has been backed up in square brackets. You can find the
relevant backup using the description and the timestamp.
6. Click Next.
7. Select the content to be restored.
8. Click OK.
960
3.22.2.2.9.3 Restore tenant from backup list (from

Backups page)
Users with appropriate privileges can restore all data (page 995) for the tenant from its
backup list.
Prerequisite
Warning
Procedure
1. Click Backups.
2. At the end of the row for the tenant, click Open backup list. The Backup list -
<tenant> dialog opens.
3. At the end of the row for the relevant backup, click More > Restore.
5. Select Backup.
Move the mouse over the individual entries to show a description. The description lists all
components whose data has been backed up in square brackets. You can find the
relevant backup using the description and the timestamp.
7. Click Next.
961
8. Select the content to be restored.

9. Click OK.
3.22.2.2.10 Delete tenant

Delete tenants when they are no longer required. You cannot delete infrastructure tenants,
for example, the master tenant.
You can delete tenants immediately that are in the Prepared for deletion state and the
Failed state. Tenants in the Active state and the Locked state must be prepared for
deletion first.
Warning
All data is deleted. Make sure the tenant has been backed up (page 955). You can then restore
it if required.
Procedure
1. Click Tenants.
2. At the end of the row for the tenant you want to delete, click More > Prepare for
deletion or Delete.
A warning is displayed to inform you that all data will be deleted.
3. Click OK. If the tenant was in the state Prepared for deletion or Failed, the tenant
is deleted. The state Being deleted is displayed until the tenant s removed from the
list.
If it was in the state Active or Locked, the tenant is now in the state Being
prepared for deletion. Because this process takes some time, the tenant is locked for
the duration. You must wait until it is in state Prepared for deletion to delete it.
962
3.22.2.2.11 Manage filters

All filters (page 965) of this tenant can be managed on the Assets page.
On this page you can copy, import and export filters, templates, report scripts and databases
(page 953).
Status information is available.
Actions are logged as and all logged pieces of information can be

displayed if required.
To open logged information, click Open . If you close the section, the number of logged
status information is set to . All messages are available until they are deleted .
3.22.2.2.11.1 Copy filters

Copy filters (page 965) to different tenants immediately.
Procedure
1. Click Tenants.
2. Click the relevant tenant. The Information pages gives an overview of this tenant.
3. Click Assets. The navigation tree allows navigating to all filters, templates, reports, and
related files, as well as to databases.
4. Click Filters. All filters are listed.
5. Activate the controls of the filters to be copied. To activate all at once, click the control in
the Filters heading. The number of selected items is displayed along with the Copy
assets, Import assets and Export assets action buttons.
6. Click Copy assets. The Copy assets to tenants dialog opens. All tenants are listed to
which the filters can be copied. If the list is too long, you can specify the tenant name in
the field next to the source tenant.
7. Activate the controls of all target tenants the filters are to be copied to.
8. Click OK.
If the filters already exist, they are overwritten in the target.
The filters are copied to the selected tenants.
963
3.22.2.2.11.2 Export filters

Export filters (page 965) from this tenant to a filter export archive.
Procedure
1. Click Tenants.
4. Click Filters. All current filters are listed.
5. Activate the controls of the filters to be exported. To activate all at once, click the control
in the Filters heading. The number of selected items is displayed along with the Copy
6. Click Export assets. The filters are zipped to an archive file. The name of the archive
file has the format:
<source tenant name><time stamp>.zip
7. Select the next action. You can either open the file or save it.
8. Click OK.
The filters are downloaded from the tenant and saved to the archive file.
You can import filters from this file to different tenants (page 964).
3.22.2.2.11.3 Import filters

Import filters (page 965) to this tenant from a filter export archive.
Prerequisites
You have access to a filter archive file created by a filter export (page 964), or to a filter
export file created in ARIS Architect.
Procedure
1. Click Tenants.
4. Click Filters. All current filters are listed.
5. Click Import assets. The Import assets to tenant dialog opens.

6. Click Select. The file browser opens.
964
7. Navigate to the source file. Select either a filter archive file (*.zip) or a filter export file
(*.filter), and click Open. The file browser closes.
8. Click OK.
If filters with the same GUID already exist in the tenant, they are overwritten.
The filters are imported from the filter archive to the tenant.
3.22.2.2.11.4 What are filters?

Filters are divided into method filters and evaluation filters (page 965) and provide restricted
and user-specific method contents. Filters are an effective way to support uniform modeling
and accelerated evaluation. They make it possible to provide users with only the information
and methods relevant to them. If you log in using a specific method filter and create a model,
for example, only the model types relevant to your work are offered to you for selection.
Filters are contained in the configuration. There is one configuration for each tenant, and its
content can be used by all databases of the tenant. Only configuration administrators (page
53) can create, edit, export, or import filters. To have access to user-defined method
extensions you must assign them to a filter. Users who log in with this filter can use the
method extensions for modeling and evaluation.
METHOD FILTER
Subset of ARIS Method, which the configuration administrator can define for specific users,
user groups or for a specific task. If you log in using a specific method filter and want to
create a new model, only the relevant model types contained in that method filter are offered
to you for selection. When modeling, all object, connection, and attribute types are available
for the model type that are contained in the method filter. Thus, the content offered is exactly
the content you need for performing your tasks. Method filters are an effective means of
supporting uniform modeling and make it possible to provide users with only the information
and methods relevant to them.
EVALUATION FILTER
Filter that restricts the method contents. The method content is restricted to the content that
is activated in both the method filter you used when logging in to the database and the
evaluation filter you selected. The advantage of evaluation filters is that only relevant content
is included in the case of comprehensive processes.
965
3.22.2.2.12 Manage templates

All templates (page 968) of this tenant are managed on the Assets page.
(page 953).

3.22.2.2.12.1 Copy templates

Copy templates to different tenants immediately.
Procedure
1. Click Tenants.
4. Click Templates. All current templates are listed.
5. Activate the controls of the templates to be copied. To activate all at once, click the
control in the Templates heading. The number of selected items is displayed along with
the Copy assets, Import assets and Export assets action buttons.
which the templates can be copied. If the list is too long, you can specify the tenant name
in the field next to the source tenant.
7. Activate the controls of all target tenants the templates are to be copied to.
8. Click OK.
If the templates already exist, they are overwritten in the target.
The templates are copied to the selected tenants.
966
3.22.2.2.12.2 Export templates

Export templates from this tenant to a template backup archive.
Procedure
1. Click Tenants.
4. Click Templates. All templates are listed.
5. Activate the controls of the templates to be exported. To activate all at once, click the
control in the Templates heading. The number of selected items is displayed along with
6. Click Export assets. The templates are zipped to an archive file. The name of the
archive file has the format:
8. Click OK.
The templates are downloaded from the tenant and saved to the archive file.
You can import templates from this file to different tenants (page 967).
3.22.2.2.12.3 Import templates

Import templates to this tenant from a template export archive.
Prerequisites
You have access to a template archive file created by a template export (page 967), or to a
template export file created in ARIS Architect.
Warning
If templates with the same GUID already exist in the tenant, they are overwritten.
Procedure
1. Click Tenants.
4. Click Templates. All current templates are listed.
967

7. Navigate to the source file. Select either a template archive file (*.zip) or a template
export file (*.template), and click Open. The file browser closes.
8. Click OK.
The templates are imported from the archive file to the tenant.
3.22.2.2.12.4 Use templates

all relevant models. Using the templates supplied or those you create yourself will enable you
to easily customize your models according to your requirements.
Configuration administrators can create templates (page 854) and assign templates to a
model type (page 852). If a model of this type is created or imported from ARIS Express
Users can assign templates to models. When users assign templates to models, the settings
made in the templates overrule all default settings for models and contained elements as well
as database-related settings, such as font formats. All new objects and connections added to
Moreover, you can assign multiple templates to models. This means that you can assign a
template to a model to change the size of objects, for example, and another that places the
required attributes above the objects. Both changes take effect. Assigning multiple templates
is possible for existing objects only. If you create new objects, only the template you assigned
last will be applied to them.
968
3.22.2.2.13 Manage reports and related files

All reports of this tenant are managed on the Assets page.
(page 953).

3.22.2.2.13.1 Copy reports

Copy reports (page 974) to different tenants immediately.
Procedure
1. Click Tenants.
4. Click Evaluations > Reports > <report category>. All current reports of this report
category are listed.
5. Activate the controls of the reports to be copied. To activate all at once, click the control
in the Reports heading. The number of selected items is displayed along with the
Copy assets, Import assets and Export assets action buttons.
which the reports can be copied. If the list is too long, you can specify the tenant name in
the field next to the source tenant.
7. To copy the reports from this category to the same category on the target tenants,
activate the controls of all target tenants the reports are to be copied to.
969
To copy the reports from this category to several categories on the target tenants,
activate the Select target category for the report on each tenant option, and specify
the target categories on the different tenants.
8. Click OK.
If the reports with the same GUID already exist, they are overwritten in the target.
The reports are copied to the selected tenants.
Make sure that all common files used by these reports are available (page 971) as well.
3.22.2.2.13.2 Export reports

Export reports (page 974) from this tenant to a report backup archive.
Procedure
1. Click Tenants.
5. Activate the controls of the reports to be exported. To activate all at once, click the
control in the Reports heading. The number of selected items is displayed along with the
Copy assets, Import assets and Export assets action buttons.
6. Click Export assets. The reports are zipped to an archive file. The name of the archive
8. Click OK.
The reports are downloaded from the tenant and saved in the archive file.
You can import reports from this file to different tenants (page 971).
970
3.22.2.2.13.3 Import reports

Import reports (page 974) to this tenant from a report archive.
Prerequisites
You have access to a report archive file created by a report export (page 970), or to a report
export file created in ARIS Architect.
Procedure
1. Click Tenants.

7. Navigate to the source file. Select either a report archive file (*.zip) or a filter export file
(*.arx), and click Open. The file browser closes.
8. Click OK.
If reports with the same GUID already exist on the tenant, they are overwritten.
The reports are imported from the export file to the tenant.
3.22.2.2.13.4 Copy files

Copy all relevant files used by reports directly to different tenants.
Procedure
1. Click Tenants.
4. Click Evaluations > Common files. All current files are listed.
5. Activate the controls of the files to be copied. To activate all at once, click the control in
the Files heading. The number of selected items is displayed along with the Copy
971
6. Click Copy assets. The Copy assets to tenants dialog opens. All operational tenants
are listed to which the files can be copied. If the list is too long, you can specify the tenant
name in the field next to the source tenant.
7. Activate the controls of all target tenants the files are to be copied to.
8. Click OK.
If identical files already exist, they are overwritten in the target.
The files are copied to the selected tenants.
3.22.2.2.13.5 Export files

Export all relevant files used by reports from this tenant to a file archive.
Procedure
1. Click Tenants.
5. Activate the controls of the files to be exported. To activate all at once, click the control in
the Files heading. The number of selected items is displayed along with the Copy
6. Click Export assets. The files are zipped to an archive file. The name of the archive
8. Click OK.
The files are downloaded from the tenant and saved to the archive file.
You can import common files from this file to different tenants (page 973).
972
3.22.2.2.13.6 Import files

Import all relevant files used by reports to this tenant from a file archive. If you copy reports
to different tenants (page 969) make sure that all common files used by these reports are
copied as well.
Prerequisites
You have access to the archive file created by a file export (page 972), or to a file exported
from ARIS Architect.
Procedure
1. Click Tenants.

7. Navigate to the source file. Select either a file archive (*.zip) or a single file (*.js or *.xml),
and click Open. The file browser closes.
8. Click OK.
If identical files already exist on the tenant, they are overwritten.
The files are imported to the tenant.
973
3.22.2.2.13.7 What is an ARIS report?

With ARIS reports, you evaluate any number of similar database items. You can analyze
processes and document the results taking into account various aspects. To start a report,
select the content in the Explorer tree, in models, or in search results, etc., and click either a
report or Start report on the Evaluate tab bar. The Report Wizard always offers you those
reports that enable plausible evaluations. Depending on the output format selected, the data
is automatically transferred to the locally installed programs, such as Microsoft® Word,
Microsoft® Excel, or Microsoft® Internet Explorer, and Adobe® Acrobat®.
The Report Wizard assists you in outputting a report. It accesses report scripts that are
included in the package. Information on the reports is located in the Description box in the
wizard. For example, you can automatically output content for translation and insert the
translated text back into the database.
A report includes only those models, objects, relationships and attributes that are allowed in
the current evaluation filter.
Reports are opened in the program that is linked to the result format. For example, if you have
selected the DOC output format, the result is displayed in Microsoft® Word on the computer
where the ARIS Client is running. If Microsoft Word® is not installed, the report is displayed in
your Internet browser.
Write your own scripts or adapt copies of existing scripts. To do this, you require knowledge of
the JavaScript and ARIS Script programming languages. If you have no experience in
writing scripts, you can create simple report scripts as template-based reports.
ARIS is supplied with numerous standard scripts. We generally recommend documenting all
changes to scripts externally so that the documentation can be used to ensure that they are
incorporated correctly during the update process.
REPORTS/MACROS/REPORT TEMPLATES AND FILES

Do not make any changes to the standard scripts we supply. Always adapt copies of report,
macro, and JS files, and any other files. There are exceptions, for example, the file
atsall<language code>.js.
When updating ARIS, all ARIS standard scripts and files are overwritten and customer-specific
changes to these files are discarded. Copied scripts and files and those you have created
yourself are not overwritten.
If you have changed files we supplied but not copied them, before the update
(updatesystemdb) they must be exported and then imported after the update. This enables
you to retain your adapted standard scripts from the previous version. However, in this case
you do not receive any corrections or updates to the files we supplied.
974
SEMANTIC CHECKS
We recommend creating custom rule types and custom profiles for semantic checks, in which
the ARIS standard rule types and rules are referenced.
This is not possible for configurable rule types (relationship attribute rules, model attribute
rules, object attribute rules, existence rules, and allocation rules). If you have added rules to
these rule types, you must export the rule types before the update and then import them
after the update.
Further information and scripting tutorials are available in the ARIS Community at:
 http://www.ariscommunity.com/group/reports-macros-aris
(http://www.ariscommunity.com/group/reports-macros-aris)
 http://www.ariscommunity.com/users/eva-klein/2010-04-27-aris-scripting-tutorials
(http://www.ariscommunity.com/users/eva-klein/2010-04-27-aris-scripting-tutorials)
975
3.22.2.2.14 Manage databases

Databases contain all models and objects, classified in groups. If you are using versioned
databases, you can open defined database versions (page 1157). You can back up databases
so that a particular version can be restored at a later date or to provide databases on other
tenants. If you back up versioned databases, all versions of the database are included.
On each tenant different sets of databases can be managed (page 118).
You can manage all databases of this tenant on the Assets page.
(page 953).

3.22.2.2.14.1 Copy databases

Copy databases to different tenants immediately.
Procedure
1. Click Tenants.
4. Click Databases. All databases are listed.
5. Activate the controls of the databases to be copied. To activate all at once, click the
control in the Databases heading. The number of selected items is displayed along with
6. Click Copy assets. The Copy assets to tenants dialog opens. All operational tenants
are listed to which the database can be copied. If the list is too long, you can specify the
tenant name in the field next to the source tenant.
7. Activate the controls of all target tenants the databases are to be copied to.
8. Click OK.
If databases already exist, they are overwritten in the target.
The databases are copied to the selected tenants.
976
3.22.2.2.14.2 Export databases

Export databases from this tenant to a database export archive.
Procedure
1. Click Tenants.
4. Click Databases. All filters are listed.
5. Activate the controls of the databases to be exported. To activate all at once, click the
control in the Databases heading. The number of selected items is displayed along with
6. Click Export assets. The databases are zipped to an archive file. The name of the
archive file has the format:
8. Click OK.
The databases are downloaded from the tenant and saved to the archive file.
You can import databases from this file to different tenants (page 978).
977
3.22.2.2.14.3 Import databases

Import databases to this tenant from an export archive.
Prerequisites
You have access to a database archive file created by a database export (page 977), or to a
database backup file (*.adb) created in ARIS Architect.
Procedure
1. Click Tenants.
4. Click Databases. All current databases are listed.

7. Navigate to the source file. Select either a database archive file (*.zip) or a database
backup file (*.adb), and click Open. The file browser closes.
8. Click OK.
If databases with the same GUID already exist in the tenant, they are overwritten.
The databases are imported from the file to the tenant.
978
3.22.2.3 Manage backups

All backup lists for the tenants are managed on the Backups page (page 997).
3.22.2.3.1 Define backup folder

By default, backups are stored in the ARIS Server installation directory
(..\server\bin\work\work_umcadmin_<s, m, or l>\backup). Define a different folder on a
physical drive in order to keep data update-proof (page 1003). As the default backup folder is
overwritten by the update, all backups are lost.
Prerequisite
You have access to ARIS Cloud Controller (ACC)
Procedure
2. Enter, for example: reconfigure umcadmin_m JAVA-Dtm.backup.folder =
"C://backups"
double backslash instead of a single slash.
Make sure to use a physical drive. Mapped drives cannot be accessed.
3. Exit ACC.
All backup files are saved in the backups subfolder on drive C.
3.22.2.3.2 Open backup list

Display all backups of a tenant.
Prerequisite
Procedure
1. Click Backups.
2. At the end of the row for the tenant, click Open backup list.
The Backup list - <tenant> dialog opens. In addition to the file name and the backup time, all
components (page 995) whose data has been backed up are displayed.
979
3.22.2.3.3 Delete backup file

If you want to reduce the number of saved backups, you can delete individual entries from
backup lists.
Before deleting backups from backup lists, you can download (page 957) them, for example,
for external storage.
Prerequisite
Procedure
1. Click Backups.
2. At the end of the row for the tenant, click Open backup list. The Backup list -
<tenant> dialog opens.
4. At the end of the row, click More > Delete.

The selected backup file is deleted without prompting for confirmation.
3.22.2.4 Manage schedules

All automatically performed tenant backups are managed on the Schedules page.
3.22.2.4.1 Enter backup options

In order to create scheduled backups (page 981) and save them in the ARIS installation
directory, you must enter the user data for the user with appropriate privileges.
Prerequisite
The default location for saving backup files was changed (page 979) to a different folder on a
physical drive to prevent that files stored in the default location are automatically deleted
when you perform an update setup.
Procedure
1. Click Administrator > Options. The Enter backup options dialog opens.
2. Enter the user name superuser. This user account can be used to perform all scheduled
backups.
If you enter a different user name, make sure that this user has the required function
privileges, so that all data (page 995) can be backed up.
980
3. Enter the associated password.

4. Click OK.
Your entries have been saved. By default, backups are stored in the ARIS Server installation
directory (..\server\bin\work\work_umcadmin_<s, m or l>\backup) on behalf of this user
until the user credentials are changed.
If you have not yet defined a different folder (page 979) on a physical drive, make sure to save
the backup folder before starting an update setup. As the default backup folder is
overwritten, all backups are lost.
3.22.2.4.2 Create schedule

Users with appropriate privileges can back up all data (page 995) from tenants using
schedules. They thus create restore points. All data from the tenant is saved in a backup list.
Any number of schedules can be created for each tenant. If you create a large number of
schedules and backups, make sure the storage medium has sufficient capacity.
Prerequisites
 The user name and password have been entered in the backup options (page 980).
 The default location for saving backup files was changed (page 979) to a different folder
on a physical drive to prevent that files stored in the default location are automatically
deleted when you perform an update setup.
Warning
Procedure
2. Click Create schedule. The Create schedule dialog opens.
3. Enter the description for the backup. This text makes it easier to select the relevant
backup when restoring the tenant.
4. Select the time for the automatic backup. You can set an automatic backup daily or on a
particular day of the week. Select a time on the hour as the start time.
5. Select the maximum number of backups to be saved in the tenant backup list for this
schedule. If you select 10, a maximum of the 10 last versions can be restored.
981
6. Select the tenant to be backed up.

7. Click OK.
The schedule is created.
An additional backup is added to the tenant backup list (page 1000) at the specified time. If
the selected number of backups already exists, the oldest is removed to free up space for the
new backup.
3.22.2.4.3 Edit schedule

Change the settings for automatic tenant backups.
Procedure
2. At the end of the row for the relevant schedule, click More > Edit. The Edit schedule
dialog opens.
3. Change the settings.
4. Click OK.
The changes have been saved.
At the specified time, the backup is started and added to the tenant backup list (page 1000).
3.22.2.4.4 Lock schedule

End automatic backup using a schedule.
Procedure
2. At the end of the row for the relevant schedule, click More > Lock.
The schedule is no longer executed. It is displayed with the status Schedule locked. The
tenant is no longer backed up using this schedule.
982
3.22.2.4.5 Activate schedule

Activate automatic backup for locked schedules (page 982).
Procedure
1. Click Schedules. The schedules for all tenants are displayed. Locked schedules are
indicated by the status Schedule locked.
2. At the end of the row for the locked schedule, click More > Activate.
The schedule is executed again. It is displayed with the status Schedule activated. The
tenant is backed up using this schedule again.
3.22.2.4.6 Delete schedule

Delete schedules that you no longer require for backing up tenants.
Procedure
2. At the end of the row for the relevant schedule, click More > Delete.
The schedule is deleted without prompting for confirmation. The tenant is no longer backed
up using this schedule.
3.22.2.5 Display charts

Charts represent accumulated statistics data graphically. For real-time monitoring, you can
view statistics data in the form of charts for the Users, Documents, Modeling, and
Governance areas.
Procedure
1. Click Tenants.
In the row for the relevant tenant, click More > Display charts. A warning informs you
that you will automatically be logged out of Tenant Management.
2. Close the warning by clicking OK.
The charts for this tenant are displayed. You have been logged out of the infrastructure
tenant.
983
3.22.2.6 Open user management

Centrally manage users, user groups, privileges, licenses, and configurations for all databases
of a tenant.
Procedure
1. Click Tenants.
In the row for the relevant tenant, click More > Open user management. A warning
informs you that you will automatically be logged out of Tenant Management.
User management for this tenant opens. You have been logged out of the infrastructure
tenant.
3.22.2.7 Open portal management

Configure the portal for a tenant.
Procedure
1. Click Tenants.
In the row for the relevant tenant, click More > Open portal management. A warning
informs you that you will automatically be logged out of Tenant Management.
Portal management for this tenant opens. You have been logged out of the infrastructure
tenant.
3.22.2.8 Log out

When you have completed your management activities, click Administrator > Log out.
984
3.22.2.9 Configure Tenant Management

If you installed ARIS using the ARIS Server setup program, the Tenant Management user
interface is available. The Tenant Management user interface is run automatically with the
user account of the superuser user. In order for other users to be able to log in (page 952),
you must configure the infrastructure tenant (page 985). This assigns users in the
infrastructure tenant privileges for impersonation (page 73), along with additional function
privileges.
Once all operational tenants are configured (page 987), impersonation enables users to
assume the account of the superuser system user in order to perform administration tasks.
After the ARIS Server was updated, for all operational tenants make sure to specify
superuser in the Impersonation target users field again.
If you want existing tenants that were not created using Tenant Management to be managed
centrally, you have to adjust the configuration of these tenants (page 989).
3.22.2.9.1 Configure infrastructure tenant

In order for users to be able to log in to Tenant Management, they must have been assigned
impersonation privileges (page 73) by a system user in this node's infrastructure tenant and
also require additional function privileges. Impersonation enables users to use the account of
the system user superuser to perform administration tasks. If this node has been
accidentally removed, please make sure to add it (page 1031) again.
Prerequisite
You are a system user or have the User administrator and Impersonation function
privileges.
Procedure
1. Click the link that was provided to you or that you have saved as a bookmark in your
browser, for example, http://myServer:1080/umc. The User Management login dialog
opens.
3. Enter the user name superuser and the associated password.
4. Click Log in. The User management tab is displayed.

5. Click the user superuser.
6. Enter a valid e-mail address. This assures that the system administrator is informed
whether backups were completed successfully or whether warnings or errors occurred.
985
8. Make sure that in addition to the assigned privileges at least the following function
privileges are activated:
 Impersonation
 Tenant administrator
The user superuser now has the required privileges in the infrastructure tenant.
If necessary, create users as substitutes and assign them the required function privileges in
the same way.
For users to be able to use Tenant Management, you must configure all operational tenants
(page 987).
3.22.2.9.2 Configure user for impersonation

Impersonation (page 73) enables a user to assume another user account. The user can then
perform operations that are actually only permitted for the other account. This configuration
must be set for each tenant.
Prerequisite
Procedure
1. Log in to User Management.
Click the link that was provided to you or that you have saved as a bookmark in your
browser, for example, http://myServer:1080/#myTenant/adminUsers. The Log in
dialog opens.
7. Activate the Impersonation function privilege.
8. Log out.
9. Log in (page 3) to ARIS.
Configuration view.
986

14. Click General.
15. Click Edit.

17. Enter the users for which you want to allow impersonation as a comma-separated list.
Warning
If the ARIS server was updated, make sure to reenter the user names for all operational
18. Click Save.

You have allowed users to use impersonation.
3.22.2.9.3 Configure operational tenants

Impersonation enables users to use the account of the system user superuser to perform
administration tasks.
To enable Tenant Management to establish connections to tenants, the user superuser must
have all function privileges required for backup and restore in all operational tenants and
must be defined as a target for impersonation.
Prerequisite
You are a system user or have the User administrator and Impersonation function
privileges.
Procedure
1. Open ARIS Administration for an operational tenant, for example, http://<server
name>:<port>/#default/home).
2. Log in as a system user or a user with the User administrator and Technical
configuration administrator function privileges.
3. Click your name > Administration. ARIS Administration opens.
6. Select the Users entry in the drop-down list.
7. Click General.
8. Click Edit.
987

10. Enter the user name superuser.
If the ARIS server was updated, make sure to reenter the user name for all operational
11. Click Save. All users that have the Impersonation and Tenant administrator
function privileges on the infrastructure tenant take on the identity of superuser and
inherit all of the superuser privileges.

13. Select the user superuser. The details will be displayed.
15. Activate the function privileges required for backing up and restoring:
The function privileges depend on the license. Therefore, you may not be able to assign
all of the function privileges shown.
16. Log out of ARIS Administration.
The user superuser has the privileges to manage data for the default tenant.
17. Enter the user superuser under Impersonation target users in all other operational
tenants in your system in turn, and assign the required function privileges.
The user superuser has the privileges to manage all data for the tenants (page 995). All
substitutes can log in using their user name and manage tenants on behalf of the system
user superuser.
988
3.22.2.9.4 Configure existing tenants

To enable Tenant Management to establish connections to tenants that were not created
using Tenant Management, you must adjust the configuration of these tenants.
Add missing permissions to the superuser, if impersonation (page 73) failed. This can occur, if
tenants were added by ARIS Cloud Controller (ACC) but functional privileges are missing.
Procedure
1. Click Tenants. The status of the tenants is displayed. If the Impersonation failed
status is shown, the tenant is not accessible for users.
2. At the end of the row for the tenant, click More > Allow access. The Allow access
dialog opens.
3. Enter the user credentials of a user with sufficient privileges, for example, system.
4. Click OK.
The missing privileges are applied to the superuser. Impersonation should work and the
Active state is shown. If the change is not displayed, click Refresh.
989
3.22.2.10 Good to know

This section provides background information to assist you in carrying out the relevant
procedures.
3.22.2.10.1 How to manage logged information

3.22.2.10.2 How to adjust timestamps related to ARIS

document storage
In previous ARIS versions, ARIS document storage stored timestamps, for example Creation
time and Update time, referred to documents and folders in local server time and without
any time zone information. If data was moved between ARIS Servers or if a tenant was
restored from a backup file, timestamps were likely adjusted using a wrong time offset.
Since ARIS 10 SR6, Coordinated Universal Time (UTC) is mandatory for timestamps stored
by ARIS document storage. Because time zone information in existing data is not available,
the timestamps of existing documents and folders cannot be adjusted automatically. After
the update to ARIS 10 SR6, you must manually adjust timestamps. In a Windows-based
installation with local time UTC-2, for example, use the y-admintool.bat command-line tool
and, considering UTC offset of your ARIS Servers>, enter the following:
y-admintool.bat -s https://localhost -t default adjustTimestamps -offset "-120" -u
system -p manager
If you have restored a tenant from backup file created with ARIS 10 SR5 or earlier, you must
adjust the timestamps as well.
990
3.22.2.10.3 Which users can manage tenants?

The user superuser and users to which the required privileges are assigned by the user
superuser can manage tenants.
If users with appropriate privileges start Tenant Management, they do this as the user
superuser. This is facilitated by the Impersonation function privilege, which is assigned to
relevant users on the infrastructure tenant (page 73).
3.22.2.10.4 What privileges and settings does the user

'superuser' require?
The user account for the user superuser is used to automatically perform tenant
management for each tenant. For this purpose, the user superuser requires appropriate
function privileges in the infrastructure tenant and in all operational tenants, and must have
been defined as a target for impersonation.
 Function privileges in infrastructure tenant
For tenant management, the user superuser requires the following additional function
privileges in the infrastructure tenant:
 Impersonation
The user has additional function privileges by default, for example, License administrator.
 Function privileges and settings in all operational tenants
The user superuser does not require any license privileges, but does require certain function
privileges. To ensure that each operational tenant, for example, default, is completely backed
up, the user superuser needs the following function privileges in each operational tenant:
991

If a function privilege is not assigned, for example, Analysis administrator, ad hoc analyses
and queries for this tenant are not backed up. The number of function privileges depends on
the relevant tenant's licenses. For this reason, not all of the specified function privileges may
be displayed for every tenant.
SETTINGS IN THE USER CONFIGURATION

The user superuser must be defined as a target for impersonation (page 73) in every
operational tenant, for example, default. Thus, all users that have the Impersonation
function privilege in the infrastructure tenant inherit its privileges and can manage tenants.
3.22.2.10.5 What privileges and settings does an authorized

user require?
Other users can also manage tenants if they are not created as users in operational tenants,
because management is always carried out in the name of the user superuser using
impersonation (page 73). The following requirements have to be met:
 The users must be created in the infrastructure tenant.
 The users have the required function privileges in the infrastructure tenant.
 The user 'superuser' has the required function privileges in the infrastructure tenant and
in all operational tenants, and has been defined as a target for impersonation in all
operational tenants.
The user account for the user superuser is used to automatically perform tenant
management for each tenant. For this purpose, the user superuser requires appropriate
function privileges in the infrastructure tenant and in all operational tenants, and must have
been defined as a target for impersonation.
 Function privileges in infrastructure tenant
For tenant management, the user superuser requires the following additional function
privileges in the infrastructure tenant:
 Impersonation
992
The user has additional function privileges by default, for example, License administrator.
 Function privileges and settings in all operational tenants
The user superuser does not require any license privileges, but does require certain function
privileges. To ensure that each operational tenant, for example, default, is completely backed
up, the user superuser needs the following function privileges in each operational tenant:
If a function privilege is not assigned, for example, Analysis administrator, ad hoc analyses
and queries for this tenant are not backed up. The number of function privileges depends on
the relevant tenant's licenses. For this reason, not all of the specified function privileges may
be displayed for every tenant.
SETTINGS IN THE USER CONFIGURATION

The user superuser must be defined as a target for impersonation (page 73) in every
operational tenant, for example, default. Thus, all users that have the Impersonation
function privilege in the infrastructure tenant inherit its privileges and can manage tenants.
993
3.22.2.10.6 Impersonation
Users manage tenants on behalf of the user superuser. This requires the creation of these
users in the user management for the infrastructure tenant, for example, master (page 72). To
use impersonation, users require the Impersonation function privilege in the infrastructure
tenant.
For Tenant Management, they also require the User administrator, Tenant administrator,
and Technical configuration administrator function privileges.
In all other operational tenants, for example, default, the user superuser must be defined as
the target for impersonation (page 985). Impersonation enables users to back up tenants in
which they do not exist as a user.
To back up and restore the data, the superuser user requires the following function
privileges in all operational tenants:
994
3.22.2.10.7 What data is backed up and restored?

If you back up tenants manually (page 955) or use a scheduled backup (page 981), the current
state of the following data is saved in backup lists.
backup. Extensions, for example, TLS/SSL certificates (page 905), SAP® Java Connector, and
JDBC drivers (page 931), added using the enhance ACC command are not backed up. In ARIS
10 all started runnables are automatically taken into account when executing tenant
backup/restore commands.

Advanced settings).

tenant backup.

ARIS Method and all
995



archives
privileges


(ecp_<s, m, or l>)

l>)

configuration sets.
Make sure to save backup files on external media, such as a NAS or file servers (page 1003).
You require the same function privileges to restore (page 959) the data.
996
3.22.2.10.8 What is the Tenants page used for?

On this page you can manage all tenants in the system. If there are more than 100 tenants,
the Page navigation is displayed.
You can use the Search function to reduce the number of tenants displayed, even while
entering the name of the relevant tenant. You can also refresh the list and create
tenants (page 953).
To resort the following list, click one of the column headings Tenant, Status, or Last backup.
Tenant
All tenants on all ARIS servers that are managed by this infrastructure tenant are listed. It
provides an overview of each tenant. Click More at the end of each row to see all available
actions for each tenant.
If you click a tenant, the following pages are available:
 Information
Gives an overview of this tenant's information.
 Assets
Allows backup, restoring and copying of filters, templates, report scripts, and databases.
 Backups
Shows all backups of this tenant and provides all actions for tenant management.
 Schedules
Shows all schedules for this tenant and provides all actions for tenant management.
Status
Describes the status of the tenant:
Read-only
This tenant cannot be managed. Infrastructure tenants are read-only so that they cannot be
inadvertently locked or deleted. In this case, access to ARIS would no longer be possible.
Active
This tenant is available to all users with appropriate privileges. Users can edit data they are
authorized to use in the programs and function assigned to them.
You can manage active tenants.
Locked
This tenant is not available. Users cannot log in.
You can manage locked tenants.
997
Tenant corrupt; deletion possible after cooldown

A severe error occurred while this tenant was created or copied. This tenant cannot be used
nor deleted. You must wait until it is in the Failed status to delete (page 962) it.
Failed
This tenant was corrupted. You can delete (page 962) it now.
Access denied
A connection to this tenant cannot be established. This may be due to any of the following:
 The ARIS server that manages this tenant is not available.
 The user you used to log in to Tenant Management has not been defined for
impersonation (page 985) for the tenant.
 This tenant is the infrastructure tenant and cannot be managed.
Impersonation failed
This tenant is not yet available due to missing functional privileges for impersonation. This
status can occur if a tenant was created using ARIS Cloud Controller (ACC), but the superuser
is lacking functional permissions.
Being prepared for deletion
This tenant cannot be used anymore. It was prepared for deletion (page 962). The deletion of
a tenant takes some time. This status is shown as long as the process is not completed. After
the process is completed, the status switches to Prepared for deletion.
Prepared for deletion
This tenant was prepared for deletion. You can delete (page 962) it now.
Utilization
Describes the average number of logins in the current week relative to the number of
licenses.
Unknown
The average utilization cannot be determined because the tenant is either locked or a
connection has failed.
Low
The average number of logins this week is lower than the number of licenses.
Average
The average number of logins this week is lower than three times the number of licenses.
High
The average number of logins this week is three times the number of licenses or higher.
Licenses
998
Illustrates the percentage usage of all licenses using a progress bar.
It remains green until all licenses are used.
If all licenses are used, the bar turns red. No further users can log in on the tenant.
A warning is also displayed if at least one individual license from the total quantity of
licenses is used up, for example, Simulation. In this example, all users can still use ARIS
Architect. However, simulation is no longer available.
Moving the mouse over the bar displays the number of available and used licenses in a
pop-up. Clicking the bar displays the information in a dialog.
Last backup
Indicates when the tenant was last backed up.
If there is no backup of a tenant, the message Not yet backed up is displayed.
During backup, the Backup in progress symbol is displayed in this column.
Once the tenant has been backed up, the Tenant backup complete symbol is displayed.
The backup list on the Backups page is extended.
The times specified relate to the location of the ARIS server. If a tenant is managed by an ARIS
server in another time zone, the date and time at the location is displayed in the language
used at that location.
Clicking the link downloads the current backup file to your computer.
If an error occurs during the backup, the warning Backup failed is displayed. Check
whether the user account you used to perform the backup has the required privileges.
The user superuser and users to which the required privileges are assigned by the user
superuser can manage tenants.
999
If users with appropriate privileges start Tenant Management, they do this as the user
superuser. This is facilitated by the Impersonation function privilege, which is assigned to
relevant users on the infrastructure tenant (page 73).
Status information

3.22.2.10.9 What is the Assets page used for?

(page 953).

3.22.2.10.10 What is the Backups page used for?

On this page you can manage the backups for all tenants in the system. If there are more than
100 tenants, the Page navigation is displayed.
You can use the Search function to reduce the number of tenants displayed, even while
entering the name of the relevant tenant. You can also refresh the list and create
backups (page 955).
To change the sorting of the list, click a column title.
Tenant
All backed up tenants are listed. In addition to the tenant name, the server name is displayed.
Number of backups
Shows the number of individual backups saved for this tenant. Each backup is entered in the
backup list for the tenant. Both the scheduled backups and those started manually are listed.
1000
Last backup
whether any privileges (page 995) for the backup are missing, that users have access
privileges (page 991), and that all components (page 995) have been started.
Clicking Open backup list at the end of the row lists all backups for the selected tenant.
The backup file contains the following columns:
File
File name of the backup file.
The file name contains the date of the backup. The file contains the backed up data for the
components that are listed in the description.
Description
Text that was entered when creating the backup or the schedule.
During the backup, all components (page 995) whose data has been backed up is added to the
description in square brackets.
Created on
Date and timestamp showing when the backup file was created.
Status information

1001
3.22.2.10.11 What is the Schedules page used for?

On this page you can manage the schedules for all tenants. If there are more than 100
tenants, the Page navigation is displayed.
You can use the Search function to reduce the number of schedules displayed, even while
entering the tenant name. You can also refresh the list and create schedules (page
981).
To resort the list, click one of the column headings Tenant, Status, or Last backup.
Tenant
Lists all schedules for the tenants.
Any number of schedules can be created for each tenant. In addition to the tenant name, the
server name is displayed.
If you create a large number of schedules and backups, make sure the storage medium has
sufficient capacity.
Status
Displays the status of the schedule:
Schedule activated
This schedule is active and is performed on the specified dates.
Schedule locked
This schedule is deactivated. It will not be executed until it has been reactivated.
Frequency
Displays the times at which the backups are started.
A backup can be performed on the hour, daily, or on a particular day of the week.
Description
Text that was entered when creating the schedule.
During the backup, all components (page 995) whose data has been backed up is added to the
description in square brackets.
Archived backups
Displays the maximum number of backups saved in the tenant backup list for this schedule.
For example, if you select 10, only the last ten backups are displayed and you can restore only
these last ten backups.
Last backup
1002
whether any privileges (page 995) for the backup are missing, that users have access
privileges (page 991), and that all components (page 995) have been started.
Status information

3.22.2.10.12 Where to save backup files?

Make sure to save backup files on external media, such as a NAS or file servers. To check the
directory in use, click Administration > Options. If the default backup directory is still in use,
change (page 979) the location for backup files before you backup a tenant (page 955).
Warning
If you store backup files on the same machine where ARIS Server is installed, the system will
slow down because with each backup the free disk space will decrease.
You must not save backup files using ARIS document storage. ARIS document storage is a
repository for documents used by end users in the portal. These files by default are accessible
by all ARIS users and can be downloaded. ARIS designers with corresponding write
permissions and document administrators have access to the document repository. These
users can download, move, or delete files. This may lead to unauthorized access to backup
files if stored in ARIS document storage. If you save a backup file, a database or other
microservice backup in ARIS document storage, the next tenant backup also contains this
content. This increases the amount of data per backup and does not comply with
microservice architectural principles.
1003
3.22.3 ARIS Cloud Controller (ACC)

Warning

BATCH MODE
COMMAND MODE
Examples
You must enter:
1004
If you enter:


1005
To lock the aris10 user again enter: passwd -l aris10
3.22.3.1 How to handle special characters

If you pass a command to a command-line tool, such as ARIS Cloud Controller, special
characters used in names, passwords, or user names may cause issues.
Examples
You must enter:
If you enter:
1006
3.22.3.2 Create a tenant

After the installation of ARIS the default tenant is available. If you need additional tenants to
provide different sets of databases, users, configurations or ARIS methods you can easily
create tenants. If you are going to create additional tenants for ARIS10.0 to migrate data from
ARIS 9.8.7 or later, make sure to use identical names in both ARIS versions. You can also
create tenants using the ARIS Administration's command line tools (page 1020) or Tenant
Management (page 951).
Prerequisites
 Users need the User administrator function privilege.
 If you use an external database system that was configured using the delivered database
scripts (see ARIS Server Installation Guide), assign the tenants (page 932) to these
schemes before running the command as described below.
Warning
name must begin with a character. Special characters, such as _ and characters, for example,
Procedure
2. Enter: create tenant <tenant name> username=<user name of a user holding the
required privileges> password=<this user's password>.
Example: create tenant test01 master.tenant.user.name = admin
master.tenant.user.pwd= tenantmanager123
You can even change parameters for the new tenant. You must specify additional
parameters in case you use an external database management system, for example
(Oracle):
create tenant test01 database.admin.user="system"
database.admin.password="manager" dbinstanceid="db0000000000"
database.schema.tablespace.default="ARISDATA"
database.schema.tablespace.temporary="TEMP"
database.schema.name=aris_test01"
database.schema.password="*ARIS!1dm9n#yy"
The tenant test01 will be created.
3. The administrator must import licenses, create users and user groups and assign
privileges and licenses for the test01 tenant.
1007
4. Start a ARIS client and log in using this tenant. The system database will be created for
that tenant.
The tenant is created and can be backed up (page 920).
3.22.3.3 Back up a tenant

You can back up tenant data (page 926) using the ARIS Cloud Controller (ACC). If you want to
include the user statistics, the property User statistics in backup
Please note that no user can work on this tenant during the backup process.
Prerequisites
Warning
backup.
User administration audit events are not part of the tenant backup.
1008
Procedure
2. Enter: backup tenant <tenant name> to <pathToBackUpFile> encryption.key
the required privileges>password=<this user's password>
such as: backup tenant default to "f:\\backupDefault.acbcrypt"
encryption.key=str3ngG3h31m username=y1234 password=managery1234. If
values contain special characters, you must quote the strings and special characters. If a
password for example is User&12345, you must enter password=\"User\&12345\"
Make sure to save the backup file on external media, such as a NAS or file server. Notice
the double backslashes. Alternatively, use a single forward slash. If no file name is
specified, the file name is generated as for unencrypted files, but with the file extension
acbcrypt instead of acb. The encryption password must be at least 8 characters long
and contain at least 3 out of the 4 following character classes: lower-case letter,
upper-case letter, digit, special character (such as any non-whitespace, non-letter,
non-digit character).
The backup is started. The complete backup is written to one single acb archive file. If you
encrypted the backup file, the file extension is acbcrypt.
available?).
You can restore (page 925) this tenant using the related archive file. Using the restore
tenant command will copy the content to an existing tenant. Process Governance backup
archives greater than 2 GB might lead to insufficient TEMP space issue when restoring them
into ARIS with Oracle back end. For such large backups, extend the temp tablespace size
before restoring operation executed.
You can manage tenants also using the ARIS Administration's command line tools (page 1020)
or Tenant Management tool (page 951).
1009
3.22.3.3.1 What data is backed up and restored?

If you back up tenants, the current state of the following data is saved in different folders in
the tenant backup zip file.
backup. In ARIS 10 all started runnables are automatically taken into account when executing
tenant backup/restore commands.
Warning

Advanced settings).

tenant backup.
1010

ARIS Method and all


archives
privileges


(ecp_<s, m, or l>)

l>)

configuration sets.
1011
3.22.3.4 Restore a tenant

You can restore tenant data (page 926) or copy the content of this tenant (page 928) to a
different ARIS server. You need to have access to the relevant back-up archive file containing
the data of a tenant:
Warning
Prerequisites
 You need access to the relevant back-up archive file.
Procedure
2. To restore the tenant, enter: restore tenant <tenant name> from <pathToBackUpFile>
encryption.key <encryption password or encryption key> username=<user name of
a user holding the required privileges> password=<this user's password>
1012
such as: restore tenant default from "f:\\backupDefault.acbcrypt"

encryption.key=str3ngG3h31m username=y1234 password=managery1234
The tenant will be restored.
3. Make sure to change the standard user's passwords again.
The tenant is restored. You can also manage tenants using the Tenant Management tool
(page 951) or the ARIS Administration's command line tools (page 1020).
1013
3.22.3.5 Copy a tenant to a different server

You can copy the content of a backed up tenant to a different ARIS Server. This procedure
can also be used to migrate data in case of an upgrade installation. You need to have access
to the relevant back-up archive file containing the data of a tenant:
 All databases
 All user data (users, privileges and licenses)
 All ARIS document storage data including all access rights
 All Process Governance data
 All ad hoc analyses and queries
Prerequisites
 You need access to the relevant back-up zip file
Procedure
1. Create a tenant (page 919) on the ARIS Server where the tenant will be copied to and
import the licenses.
3. To restore Process Governance data, stop the Process Governance runnable first. To do
so enter, for example: stop apg_m
4. Enter: restore tenant <Tenant name> from <pathToBackUpFile> encryption.key
the required privileges> password=<this user's password>
1014
example is User&12345, you must enter password=\"User\&12345\". You must enter
the user credentials of the server's ARIS Administration you have created the new tenant.
If you are about to migrate data, you might use the standard name and password
system/manager.
5. In case you restored Process Governance data, restart the Process Governance runnable.
To do so enter, for example: start apg_m
All data of the backup file will be copied to the new tenant. Current data will be deleted except
the name of the new tenant, as well as user credentials. The current user data will be
available again. Please make sure to delete those users.
In case of a migration process the default credentials will automatically be in use. To prevent
unauthorized access to the ARIS system, after installation or data migration, always change
the default passwords of all users that are automatically created (page 22) (arisservice user,
guest user, system user, superuser user) on all operational tenants, as well as on the
infrastructure tenant (master).
You can also create tenants using the ARIS Administration's command line tools (page 1020)
1015
3.22.3.6 Delete a tenant

If you delete a tenant all tenant information are lost:
 Databases
 User data (users, privileges and licenses)
 ARIS document storage data including all access rights
 Process Governance data
 Ad hoc analyses and queries
Prerequisites
Warning
If you delete a tenant all tenant information are lost.
Procedure
1. Back up (page 920) the tenant in order to be able to restore (page 925) data again.
3. Enter: delete tenant <Tenant name> username=<user name of a user holding the
required privileges> password=<this user's password>
Deletes the specified tenant and all its associated data from the system. User name and
password of an administrative user have to be specified using the parameters
master.tenant.user.name and master.tenant.user.pwd, respectively. If values contain
Warning
If the optional force keyword is used, the security question Are you sure? is not
displayed and the tenant and its data will be deleted without further prompting the user.
The tenant has been deleted.
1016
You can also manage tenants using the ARIS Administration's command line tools (page 1020)
1017
3.22.3.7 How to start ARIS Cloud Controller (ACC)

Warning

BATCH MODE
COMMAND MODE
Examples
You must enter:
1018
If you enter:


1019
 To lock the aris10 user again enter: passwd -l aris10
3.22.4 y-tenantmgmt command-line tool

The batch file y-tenantmgmt.bat can be used to manage tenants. Enter the tool name
followed by /? or -? to see the usage instructions, for example y-tenantmgmt.bat -?.
Please use y-tenantmgmt.bat for Windows® operating systems and y-tenantmgmt.sh for
Unix operating systems.
Warning
Using some advanced ACC commands, you can create a tenant, import a license and restore a
database in one step. If you do not use the standard database system, please make sure to
create additional schemes in your Oracle or Microsoft SQL database management system and
you have assigned the tenants (page 932) to these schemes.
You must redirect (page 906) the ports in case of a Linux operating system.
Prerequisites
 Users need the function privileges License administrator, User administrator,
Technical configuration administrator.
Users need to login as superuser or they need either an ARIS Architect license or an
ARIS UML Designer license.
Procedure
1. Open a command prompt (Start > Run > cmd).
2. Enter y-tenantmgmt.bat followed by /? or -? to display the help, for example
y-tenantmgmt.bat -?.
Enter y-tenantmgmt.bat -t <tenant name> <command> -u <user name> -p
<password> to enter a command (page 1082). Parameters may differ.
1020
After creating a tenant, you must import the relevant license and create the users. You can do
so from the command line or using the graphical user interface ARIS Administration.
You are recommended to change the password of the default user system immediately after
the installation.
1021
3.22.5 Monitoring health

The monitoring of physical resources is important to keep ARIS running properly. You can
monitor the system using the ACC interface (page 1024) or ACC commands (page 1058).
3.22.5.1 Monitor file space

Monitor the file system of the ARIS installation. When the usage exceeds 85%, increase the
disk space.
If the space is consumed by normal usage of the application, for example, many databases,
many documents, etc., the available disk space must be increased. Check whether disk space
can be made available. You may delete out dated log files (see ARIS Cloud Controller (ACC)
guide). Also check, whether heap dumps have been created. They can consume a large part
of disk space. There is one directory where special attention to the free disk space is
recommended (/home/ARIS/cloudagent/work/work_cloudsearch_l/rsindex/). The folder
size depends on the size and the structure of the ARIS user data, actually stored in the
connected database management system. We recommend increasing the available disk
space, if the used space exceeds 75 % of the available disk space.
If ARIS document storage is used extensively, these runnables should be actively monitored,
too. Depending on the number and size of the document items, it might be necessary to
increase the available disk space regularly.
1022
3.22.5.2 Monitoring memory usage

Every runnable has a JAVA-Xmx configuration parameter. It has to be monitored, if the
memory usage is rising over time.
Peaks are not a problem, if they do not break the limit. If the system is suffering over a longer
time, for example, the memory usage is higher than 70% for more than one hour, check for
rarely occurring use cases. They might explain the high memory consumption. This can be:
 an exceptional number of parallel running Process Governance processes
 more users accessing as usual
 expensive reporting
 running database maintenance operations
 assigning user access right over the whole database etc.
If the defined limit for memory consumption is exceeded, there are two possible measures:
 Extend the heap size for the concerned runnable. This can be done in ACC with a
configure command for the JAVA-Xmx parameter (page 903). But this step only makes
sense, if enough additional memory is available.
 Scale up by increasing the resources, for example, adding a new node/runnable of the
same type or assigning more memory to the virtual machine and increasing the
JAVA-Xmx parameter for the runnable to use this memory.
For advanced ARIS server installations Software AG strongly recommends that you
request an installation service by Global Consulting Services. You can order that service
from your Software AG sales representative (page 1159).
1023
3.22.5.3 Monitoring CPU load

A continuous high level of CPU usage can be an indicator that it might be necessary to scale
up/out the system.
For the CPU load the same arguments as for the heap usage regarding peaks are true. So if a
high CPU load is detected (> 60% for more than one hour), first it should be analyzed, if short
peaks or exceptional use cases are the reason. If this is the case no direct reaction is needed.
If the defined limit for CPU usage is exceeded, there are two possible measures:
 Extend the number of CPU’s available for the runnable.
 Scale up by increasing the resources of the current node, for example, assigning more
CPU cores to the virtual machine or scale out by adding a new node/runnable of the same
type.
For advanced ARIS server installations Software AG strongly recommends that you
request an installation service by Global Consulting Services. You can order that service
from your Software AG sales representative (page 1159).
3.22.5.4 Monitoring thread pool size

For most runnables the ajpNumWorkerThreads parameter and the httpNumWorkerThreads
parameter are set. Those values should be monitored.
If they regularly exceed 80% of the configuration parameter of the runnable, it has to be
scaled out by adding a new runnable of the same type.
For advanced ARIS Server installations Software AG strongly recommends that you request
an installation service by Global Consulting Services. You can order that service from your
Software AG sales representative (page 1159).
3.22.5.5 Using ACC interface

The ACC interface provides the ARIS Infrastructure overview (page 1026) and the Health
check overview (page 1040).
To have a clear picture of the states of all runnables, check whether the system works
properly. Health checks can be executed instantly to identify possible issues. Use the Health
check schedules overview (page 1048) to manage the schedules that run health checks
automatically (page 1035). Be aware that permanent monitoring (page 1038) of all nodes has
an impact on system performance.
1024
3.22.5.5.1 Open ARIS Infrastructure overview

The ARIS Infrastructure overview shows the status of the runnables of connected nodes.
Procedure
1. Make sure that the ARIS server to which you want to connect is running.
2. Open your browser and enter the URL: http(s)://<server
name>:<port>/acc/ui&tenant=master
for example: https://aris10srv.eur.co.umg:1080/acc/ui&tenant=master
The login dialog of the infrastructure tenant opens. In a standard installation, the master
tenant is the infrastructure tenant by default.
If you are already logged in, you must log out and confirm the warning.
3. Select the interface language.
4. Enter the credentials of the system user or the superuser.
5. Click Log in. The Nodes view of the infrastructure tenant is displayed. It gives an
overview of the runnables of the node.
6. Add the node if it is not on display (page 1031).
The information of the node is displayed as a table (page 1027). For the Runnables view (page
1026), use the top slider. To get a clear picture of the states of all runnables, use the actions
available in the ARIS Infrastructure overview (page 1028).
The health status is shown for runnables that provide such information, after a health check
was started. The checks (page 1056) can be executed automatically (page 1035) or
on-demand (page 1033). Therefore, it might take a moment before the result is shown. You
can either start all health checks for single nodes (page 1034), check all runnables (page
1033) at once, or run all health checks for a single runnable (page 1034).
1025
3.22.5.5.1.1 How to use the Infrastructure overview

To have a clear picture of the states of all runnables, check whether the system works
properly. Health checks can be executed instantly to identify possible issues. Use the Health
check schedules overview (page 1048) to manage the schedules that run health checks
automatically (page 1035). Be aware that permanent monitoring (page 1038) of all nodes has
an impact on system performance.
If you have added (page 1031) nodes to the infrastructure, information related either to
runnables or nodes (page 1032) can be displayed.
Health checks can be run either for a single runnable (page 1034), a single node (page 1034),
or for all connected nodes (page 1033). Basic results, such as OK, WARNING, FAILED, or
ERROR, are shown in both views.
3.22.5.5.1.1.1 Runnables view

The Runnables view displays all available runnables. For the ABS runnable, for example, the
runnable's instance name used on each related node is shown. The color of the dot indicates
the state of a runnable. If in state STARTED, the dot is green. The sizing l (large) and m (m) is
also indicated. java, appserver, or binary refer to the technology used.
If the Health column shows no entries, the runnables health was not checked yet. OK
indicates that the runnables work fine. If issues are reported, click the related entry in the
Health column to find detailed information in the Health check overview (page 1039).
1026
3.22.5.5.1.1.2 Nodes view

The Nodes view lists all ARIS Servers added to the ARIS Infrastructure. You get all information
as provided in the Runnable view (page 1026), but in a more detailed way. In addition to the
Runnables view, the state, description application type, and the related ARIS version is listed
for each runnable. The color of the dot indicates the state of a runnable. If in state STARTED,
the dot is green.
To collapse or and expand the table, click the table header of a node. If collapsed, the node
name, the number of runnables, the number of detected warnings, and the ARIS Agent's
status is shown.
1027
3.22.5.5.1.1.3 Available actions (ARIS Infrastructure

overview)
These actions are available in both views, the Runnables view (page 1026) and the Nodes view
(page 1027):
 Enables you to open the help system, open the ARIS Tenant Management, and to log
out.
 Add node (page 1031) and
 Run all health checks for all nodes (page 1033)

 You can filter displayed content using the Type to filter... field.
If you have activated (page 1032) the Nodes view and click More, all actions available for
this node are displayed.
Run all health checks for this node (page 1034)
Download all log files for this node (page 1037)

Switch monitoring on and off (page 1038)
Remove node (page 1037)
1028
If issues are reported, as in the following example for the nyaris54srv node, click the table
header and check the issues (page 1039).
If you click a row, such as abs_l, the CPU load and the JVM heap usage monitoring is
displayed.
If you move the mouse pointer to a row, the following action buttons are faded in:
1029
Opens the Parameter and Monitoring page. The Parameter page lists all parameters set
for the runnable.
The Monitoring page shows all results of the currently tracked performance metrics. Note
that tracking a large number of metrics reduces overall server performance. If ARIS slows
down dramatically, switch off monitoring (page 1038) for the related node.
Run all health checks for this node (page 1034). If a runnable contains a subset of
runnables, such as the umcadmin runnable, which contain the acc, tm, and umc runnables,
health checks can be started for the subordinate runnable if health checks are available.
Download all log files related to the runnable (page 1037).
Show results opens the Health check overview of this runnable.
1030
3.22.5.5.1.1.3.1 Add node

If no ARIS Server information is displayed or an ARIS Server is missing, administrators can add
missing nodes.
1. Open the ACC interface (page 1024).
2. Click Add node. The Add node dialog opens.

3. Enter the logical name of the node, as it should be displayed.
4. Enter the server name. This is the host name of the machine where the ARIS server is
installed.
You can determine the host name from the related ARIS URL (see highlighted part).
Example:
https://nyaris59srv.us.my.com/#default/home
5. The used valid port is shown. Do not change that number.
6. Enter the ARIS agent user's credentials.
7. Click Add.
The node's information is shown.
You can change the way information is displayed (page 1032).
1031
3.22.5.5.1.1.3.2 Show Runnables view or Nodes view

All information can be displayed either related to runnables or nodes.
Prerequisite
The required nodes were added (page 1031).
Procedure
1. Click Nodes to list all ARIS Servers.
You get all information as provided in the Runnable view (page 1026), but in a more
detailed way. In addition to the Runnables view, the state, description application type,
and the related ARIS version is listed for each runnable. To collapse or and expand the
table, click the table header of a node. If collapsed, the node name, the number of
runnables, the number of detected warnings, and the ARIS Agent's status is shown.
1032
2. Click Runnables to display all runnables available in this ARIS infrastructure. For the ABS
runnable, for example, the runnable's instance name used on each related node is shown.
The color of the dot indicates the state of a runnable. If in state STARTED, the dot is
green. The sizing l (large) and m (m) is also indicated. java, appserver, or binary refer to
the technology used. If the Health column shows no entries, the runnables health was
not checked yet. OK indicates that the runnables work fine. If issues are reported, click
the related entry in the Health column to find detailed information in the Health check
overview (page 1039).
Information is displayed in the selected view.
3.22.5.5.1.1.3.3 Run all health checks for all nodes

To have a clear picture of the states of all runnables for all nodes, check whether the system
works properly. You can perform the checks instantly to identify possible issues.
Prerequisite
Procedure
2. Click Run all health checks for all nodes.

The result is displayed in the Health column.
If you click on the result, for example, OK, detailed results of all performed checks (page 1056)
are shown. Detailed information on specific check results are available on click, as well as the
JSON results.
1033
3.22.5.5.1.1.3.4 Run all health checks for this node

To have a clear picture of the states of all runnables for this node, check whether the system
works properly. You can perform the checks instantly to identify possible issues.
Prerequisite
Procedure
2. Activate the Nodes view (page 1032).
3. Click More > Run all healthchecks for this node.

JSON results.
3.22.5.5.1.1.3.5 Run all health checks for this runnable

To have a clear picture of one runnable's state, check whether the system works properly.
The checks can be executed instantly to identify possible issues.
Prerequisite
Procedure
3. Move the mouse pointer to the desired runnable and click Run healthcheck.
JSON results.
1034
3.22.5.5.1.1.3.6 Run health checks automatically

Create schedules to run health checks automatically. This allows you to carry out extensive
checks on a regular basis if possible performance influences do not have any negative
effects.
Prerequisite
Procedure
2. Click Health check schedules. All schedules are displayed. You can create, execute,
modify, and delete health check schedules.
3. Click Add health check schedule. The Add health check schedule dialog opens.
4. Enter the name of the new schedule.
5. Enable the Activate this schedule check box. This will execute the schedule as defined
after you have saved this schedule.
6. Enter the e-mail addresses of all recipients who are to be informed about the health
check result. Add the addresses one after the other. To correct an e-mail address, delete
the address and add it again.
7. Select the reason for sending e-mails.
8. Select the runnables for which you want to run scheduled health checks.
Warning
If you select runnables whose health checks affect system performance, ARIS may slow
down for the period in which the health check is performed. Make sure that the schedules
performing those health checks are executed at an appropriate time.
9. Enter the credentials of the ARIS user who will perform the planned health check. This
user must have sufficient permissions, for example, similar to the permissions of the
superuser.
10. Click Next. The Specify schedule dialog opens.
1035
11. Select the frequency for performing the automatic health check. You can run it only once
or set a specific time period for the health check to be started frequently. Select the date
on which the health check will be started for the first time and the date on which it will be
started for the last time. You can specify the exact time when the health check will be
performed for the first and the last time. The syntax for entering the time of day is
<hh:mm>.
12. Click Create schedule.
The health check schedule is saved and listed.
You can modify the schedule (page 1051) if required.
3.22.5.5.1.1.3.7 Show health check results

If health checks have been performed (page 1033), you can review these results.
2. Move the mouse pointer to the runnable you want to review and click the health check
result in the Health column. The ARIS Health check overview (page 1040) is shown. All
results of the specific checks are displayed.
3. Click one of the results for more detailed information.
The test results are shown.
You can collect log files (page 1037) related to each runnable or you can download all available
log files.
1036
3.22.5.5.1.1.3.8 Download log files (ACC interface)

If problems occur during operation, you can use log files to find and resolve errors. You can
download zipped log files related to each runnable or you can download all available log files.
Prerequisite
Procedure
2. Move the slider to Nodes. All runnables of each node are listed.
3. If you want to collect all log files of a node, click More > Download log files.
4. If you want to collect log files of a specific runnable, move the mouse pointer to the
related row and click Download log files.
A ZIP archive created to be opened or saved.
If you cannot solve the problems and have a maintenance agreement, please send an error
description and the ZIP archives containing collected log files as well as the entire contents of
the log and config directories to the ARIS Global Support via Empower
(https://www.softwareag.com/corporate/services/support/default).
3.22.5.5.1.1.3.9 Remove node

If you do not want to check the health of a node, you can remove it from the ARIS
Infrastructure page.
Procedure
3. Move the mouse pointer to the table header of the node that you want to remove.
4. Click More > Remove node.

The node is deleted from the list.
You can add (page 1031) it again, if required.
1037
3.22.5.5.1.1.3.10 Switch monitoring on and off

On the Monitoring page all results of the currently tracked performance metrics are shown
on the fly. Tracking a large number of metrics reduces overall server performance. If ARIS
slows down dramatically, switch off monitoring for the related node.
Procedure
3. Click More > Monitoring and move the slider to the Off position.
Monitoring is switched off for this node.
To start monitoring again, move the slider to the On position.
If you do not want to switch off monitoring, you can run health checks using schedules (page
1035).
1038
3.22.5.5.2 Open the Health check overview

If incidents are reported, for example, in the Nodes view (page 1027), click the table header of
the related node to review the states of each runnable.
Prerequisites
You ran health checks, either automatically (page 1035), on all nodes (page 1033), on a single
node (page 1034) or for a single runnable (page 1034).
Procedure
Click an entry in the Health column, such as WARNING, FAILED, or ERROR, or click Show
results (page 1040). You can also check runnables that are in the state OK.
The health check overview opens. You see all results reported by performed health checks.
To review the incidents in detail, use the actions available in the Health check overview (page
1041).
1039
3.22.5.5.2.1 How to use the health check overview

If issues are reported in the Runnables view (page 1026) or in the Nodes view (page 1027),
click the related entry in the Health column to find detailed information in the overview (page
1039). Show results (page 1040) also provides access to this page.
The Health check overview shows all results of performed health checks.
1040
3.22.5.5.2.1.1 Available actions (Health check overview)

The health check overview shows all results detected by performed health checks.
You can sort the health check results by state or in alphabetical order, using the following
buttons:
Sort by state
Sort alphabetically
If you click the number in the red field, only errors and failed checks are displayed. The orange
field indicates the number of health check results in the WARNING state.
The next example shows results that report errors and failed checks. The name of the health
check and a short description are displayed for each incident.
1041
Show information for support shows the entire JSON string returned by all health
checks of this node. It is already marked so that you can copy it for further support.
If you click ERROR or FAILED in the health check overview, you receive more detailed
information returned by the related health check. In this example, a license is missing or
invalid. If you click the arrow, additional technical information is displayed.
The next example shows a failed Read Lock health check (page 1056). This check failed
because the calculated ratio is greater than the maximum value of 30.
1042
You can find additional information if you click the arrow to expand the dialog.
The Show JSON data link opens a dialog that displays the JSON string returned by this single
health check.
If you click to open the ARIS Infrastructure overview (page 1022), the
results are still visible there. Do not use the Back button of your browser. Otherwise, the
health check results will no longer be displayed.
1043
3.22.5.5.2.1.1.1 Sort reported health check results

You can sort reported health check results by state or in alphabetical order.
Prerequisites
You ran health checks, either on all nodes (page 1033), on a single node (page 1034) or for a
single runnable (page 1034).
Procedure
1. Open the ARIS Health check overview (page 1039). You see all results reported by
performed health checks.
2. Click the required button:
Sort by state
Sort alphabetically
The health check results are sorted as required.
You can reduce the number of displayed results by filtering (page 1044) the view.
3.22.5.5.2.1.1.2 Filter reported issues and states

If many incidents are reported, you can reduce the number of reported warnings, errors and
failed health check results.
Prerequisites
Procedure
2. Click the number, for example in the red field, to only display health check results in the
states ERROR or FAILED. The orange field indicates the number of health check results in
the state WARNING.
Only health check results in the selected state are displayed.
1044
3.22.5.5.2.1.1.3 Show information for support

You can review the entire JSON string returned by all health checks of the node.
Prerequisites
Procedure
2. Click Show information for support.

The entire JSON string is marked so that you can copy it for further support.
You can also review the JSON string returned by a single health check (page 1046).
1045
3.22.5.5.2.1.1.4 Show JSON data

You can review the JSON string returned by a single health check.
Prerequisites
Procedure
1. Open the Health check overview (page 1039). You see all results reported by performed
health checks.
2. Click the result you want to review the JSON string for.
3. Click the Show JSON data link.
The JSON string is shown.
You can also review the entire JSON string returned by all health checks of the node (page
1045).
1046
3.22.5.5.3 Open Health check schedules overview
If you have added health check schedules (page 1035), you can run health checks
automatically. This allows you to carry out extensive checks on a regular basis if possible
performance influences do not have any negative effects.
Prerequisite
Procedure
Click Health check schedules.
The Health check schedules overview opens. You can see all schedules that were added.
Authorized users can manage (page 1048) all ARIS Health Check schedules.
To review the incidents in detail, use the actions available in the Health check overview (page
1041).
1047
3.22.5.5.3.1 How to use the Health check schedules

overview
If you have added (page 1031) nodes to the infrastructure, information related to either
runnables or nodes (page 1032) can be displayed.
Health checks can be run either for a single runnable (page 1034), a single node (page 1034),
or for all connected nodes (page 1033).
If you have added health check schedules (page 1035), you can run health checks
automatically. This allows you to carry out extensive checks on a regular basis if possible
performance influences do not have any negative effects.
If you click a row in the list, more details of the related schedule are shown.
The overview provides the following information:

Schedule
Lists added schedules that perform health checks on selected runnables. The color of the dot
indicates the status of a schedule.
State
The color of the dot indicates the status of a schedule. If active, the dot is green. Active
schedules are executed as defined. Gray dots indicate deactivated schedules.
Health checks
Lists the runnables for which health checks are executed.
Next start
Shows the date and time when the scheduled health checks will start the next time.
Last start
Shows the date and time of the last execution.
1048
Last duration
Lists how long it took to perform all health checks the last time the schedule was executed.
Last result
Shows the result of the last execution. If you click this result, the related health check
overview (page 1041) is displayed.
These icons are available if you have selected at least one schedule.
Activate selected schedules (page 1053)
Deactivate selected schedules (page 1052)
Delete selected schedules (page 1052)
Run selected schedules (page 1054)
Refresh list (page 1055)
If you move the mouse pointer to a row, the following action buttons are faded in:
Edit schedule (page 1051)
Run schedule (page 1054)
Delete schedule (page 1053)
1049
3.22.5.5.3.1.1 Create health check schedule

Create schedules to run health checks automatically. This allows you to carry out extensive
checks on a regular basis if possible performance influences do not have any negative
effects.
Prerequisite
Procedure
2. Click Health check schedules. All schedules are displayed. You can create, execute,
modify, and delete health check schedules.
3. Click Add health check schedule. The Add health check schedule dialog opens.
4. Enter the name of the new schedule.
5. Enable the Activate this schedule check box. This will execute the schedule as defined
after you have saved this schedule.
6. Enter the e-mail addresses of all recipients who are to be informed about the health
check result. Add the addresses one after the other. To correct an e-mail address, delete
the address and add it again.
7. Select the reason for sending e-mails.
8. Select the runnables for which you want to run scheduled health checks.
Warning
If you select runnables whose health checks affect system performance, ARIS may slow
down for the period in which the health check is performed. Make sure that the schedules
performing those health checks are executed at an appropriate time.
superuser.
1050
11. Select the frequency for performing the automatic health check. You can run it only once
or set a specific time period for the health check to be started frequently. Select the date
on which the health check will be started for the first time and the date on which it will be
started for the last time. You can specify the exact time when the health check will be
performed for the first and the last time. The syntax for entering the time of day is
<hh:mm>.
12. Click Create schedule.
The health check schedule is saved and listed.
You can modify the schedule (page 1051) if required.
3.22.5.5.3.1.2 Edit schedule

You can modify existing schedules.
Prerequisite
Health check schedules are available (page 1050).
Procedure
2. Click Health check schedules. All schedules are displayed.
3. Move the mouse pointer to the schedule that you want to modify and click More >Edit.
The Edit schedule dialog opens.
4. Change settings as required.
superuser.
If you do not enter user credentials, the user name and the password is used that was
specified when the schedule was created.
7. Change settings as required and click Save changes.
The schedule was updated.
1051
3.22.5.5.3.1.3 Deactivate selected schedules

You can deactivate schedules if related health checks are no longer required.
Prerequisite
Procedure
3. Select the schedules that you want to deactivate. You can recognize active schedules by
the green dot.
4. Click Deactivate selected schedules.

The selected schedules are deactivated. Health checks are no longer executed.
3.22.5.5.3.1.4 Delete selected schedules

You can delete schedules if related health checks are no longer required.
Prerequisite
Procedure
3. Select the schedules that you want to delete.
4. Click Delete selected schedules. A warning is displayed.

5. Click Delete.
The selected schedules are deleted.
1052
3.22.5.5.3.1.5 Delete schedule

You can delete a schedule if related health checks are no longer required.
Prerequisite
Procedure
3. Move the mouse pointer to the schedule that you want to delete and click Delete
schedule. A warning is displayed.
4. Click Delete.
The selected schedule is deleted.
3.22.5.5.3.1.6 Activate selected schedules

If existing schedules are deactivated, you can activate them in order to run health checks
automatically again.
Prerequisite
Procedure
3. Select the schedules that you want to activate. You can recognize inactive schedules by
the gray dot.
4. Click Activate selected schedules.

The selected schedules are active again. Health checks are executed as defined.
1053
3.22.5.5.3.1.7 Run selected schedules

You can execute schedules immediately.
Prerequisite
Procedure
3. Select the schedules that you want to execute.
4. Click Run selected schedules.

The selected schedules are started. Health checks are executed as defined. E-mails are sent
to the persons responsible.
3.22.5.5.3.1.8 Run schedule

You can execute a single schedule immediately.
Prerequisite
Procedure
3. Move the mouse pointer to the schedule that you want to run and click Run
schedule.
The selected schedule is started. Health checks are executed as defined. E-mails are sent to
the persons responsible.
1054
3.22.5.5.3.1.9 Refresh list

You can update the content displayed in the Health check schedules overview.
Prerequisite
Procedure
2. Click Health check schedules. All schedules are displayed..
3. If schedules are missing, click Refresh list.

The page content is up to date.
1055
3.22.5.5.4 What checks are performed?

For each runnable providing health information, a different set of checks is performed. As an
example, the set performed for the abs runnable is described here:
 Read Lock
This check compares the average time it takes to access a synchronized resource with
the average time it takes to access a non-synchronized resource on the system. From the
measured times it calculates a ratio. A high ratio means that access to synchronized
resources is relatively slow, which could have a negative effect on the computation speed
of ARIS.
The check fails if the ratio is greater than 30. Because a large set of test data objects is
necessary to accurately calculate the result, the check is executed only once an hour in
the background.
 Threads
This check detects threads running longer than 5 minutes. This could indicate an infinite
loop. All AJP and HTTP threads currently running are constantly monitored.
 JIT Compiler
This check detects whether the JIT compiler is active. If the JIT compiler is active, the
check also monitors the state of the used code cache volume.
The check fails if the JIT compiler is not active or if the used code cache volume is at 90%
of the maximum.
 CPU Loop
This check helps to identify JIT and VM performance problems. The check executes a
short but extensive computation and measures the time needed to calculate the result.
The check fails if the calculation takes more than 2,5 seconds.
 Documents
This check detects whether the number of documents (revisions included) stored in ARIS
document storage complies with the license in use.
Green: If the number of documents is < 40.000.
Yellow: If the number of documents is >= 40.000.
Red: The check fails if the number of documents is > 10.000.000.
 Self Host Lookup
This check identifies the host name of the machine via its IP address.
The check fails if the host name cannot be resolved or if the call takes longer than 30
milliseconds.
1056
 ZooKeeper Connection
Checks whether the server is connected to ZooKeeper. If the server is not connected, the
check fails.
 ZooKeeper Leader
Ensures that there is a leading abs runnable instance for the abs application type
registered in ZooKeeper.
 DB Query
Checks whether a database connection can be created and measures the time for
executing a set of standard database queries.
The test fails if the database connection cannot be created or if the average execution
time is longer than a calculated threshold.
 DB Latency
This check tests whether a valid database connection can be created and measures the
latency between the ARIS system and the database backend via multiple ping requests.
The check fails if the database cannot be reached or if the average response time
exceeds 300 milliseconds.
 Database Connection Pool
The check detects the number of active database connections and the maximum number
of active database connections in the system.
The check fails if the number of active connections is equal to or exceeds 95% of the
maximum.
 CloudSearch Access
This check obtains all registered CloudSearch instances in the system and sends a ping
request to them.
The check fails if there are no CloudSearch instances registered or if no CloudSearch can
be reached.
1057
3.22.5.6 Using ACC commands

You can monitor the health of a specific runnable as well as the health of the whole system.
3.22.5.6.1 Monitor runnable's health

The health command determines a variety of health values for each runnable.
The exact list of health values available depends on the specific runnable. However, a few
basic measurements are available to all runnables, in particular the CPU load and its memory
usage. For all Java-based runnables, additional information is available.
Prerequisite
Procedure
2. Make sure that the runnable has been started.
3. Enter, for example: show instance zoo_m health
The output will look like this example:
The first column shows the name of the measured value and its physical unit, for example,
megabytes, percent, etc.
The second column shows the current value of the health value. Note that this is not
measured the moment the command is executed. The agent plugin will take measurements
periodically, and this column will show the result of the last measurement.
The third column shows the range of possible values, for example, minimum and maximum
value. If no minimum or maximum value can be determined or the value does not have an
ordinal value scale a - is shown instead.
1058
The fourth and fifth columns show the minimum and maximum values, respectively. These
values were observed since the runnable or the ARIS Agent had last been restarted, but only
if the health value measured has an ordinal value scale. For values measured without an
ordinal value scale, - will be shown.
The sixth column shows the low or high warning thresholds for the measured value, if the
measured health value has an ordinal value scale and if thresholds have been configured.
The seventh column shows the state of the measured value if the measured health value has
an ordinal value scale and if a low and/or high threshold has been configured. The state can
be either OK, LOW or HIGH. If in LOW or HIGH state, the column will also show for how long
the value has been in that state already.
3.22.5.6.2 Show node

The show node command shows machine monitoring information concerning CPU, memory
and disk usage. If a threshold is violated, it will be shown.
Prerequisite
Procedure
2. Make sure that the runnables have been started.
3. Enter: show node
The output will be in tabular format and look like this example:
1059
3.22.5.6.3 Configure health monitoring

If you use the health monitoring (page 1022), using ACC, make sure to configure the system.
Procedure
2. Enter the parameters described below.
THRESHOLDS
Thresholds for monitored values can be configured using agent configuration parameters:
monitoring.high.cpu.threshold.percent High CPU usage threshold
(0.0 – 1.0, default 0.8) (relative, in percent)
monitoring.relative.low.disk.space.warnin Low memory threshold

g.threshold.percent (relative, in percent)
(0.0 – 1.0, default 0.03)
monitoring.absolute.low.disk.space.warni Low disk space threshold

ng.threshold.megabytes (absolute, in megabytes)
(default 1000)
Warning
ARIS Agent not only warns against
insufficient disk space. When the default
value (1000 MB) is reached, all runnables are
immediately shut down (killall) to avoid data
inconsistencies. Runnables cannot be
restarted. ARIS Agent autostart is disabled.
THRESHOLD MEASUREMENT
The measurement can be configured by the following parameters:
monitoring.interval Interval in milliseconds, in which the
(default 1000) measurement will be done.
monitoring.high.cpu.number.of.intervals. Number of measurements with CPU load

warning.threshold above threshold before a warning state is
(default 10) reached
1060
monitoring.high.mem.usage.number.of.int Number of measurements with memory
ervals.warning.threshold usage above threshold before a warning
(default 10) state is reached.
monitoring.low.disk.space.number.of.inte Number of measurements with free disk

rvals.warning.threshold space below threshold before a warning state
(default 10) is reached.
MAIL NOTIFICATION
d
(default: false)

(common: 25)
authentication.


1061
Possible values:
1062
3.22.6 ARIS Server Administrator

The command line tool ARIS Server Administrator is available if you have installed ARIS
Server or the ARIS Administrator Tools (see ARIS Client Installation Guide).
If you have installed ARIS Server, navigate to ARIS installation
path>\server\bin\work\work_abs_<s, m, or l>\tools\arisadm and run the batch file.
On Linux operating systems ARIS Server Administrator (arisadm.sh) is available if the
aris10adm-<number>-1.x86_64 file was installed (see ARIS Server Installation - Linux).
You can start ARIS Server Administrator from any client computer and access the databases
on the server:
1. Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if
you accepted the program group suggested by the installation program. Under a Linux
operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c
arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is
launched in interactive mode.
2. Establish a connection to the server and tenant:
Syntax: server <server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager
ARIS Server Administrator is connected to the server.
Enter help or help <command> to get information about the usage of the commands.
Use the console application ARIS Server Administrator to back up or restore a tenant
configuration or to manage the ARIS databases of a tenant, for example. The individual
commands are transferred as command line parameters. The program provides information
on the success and effect of each command executed.
You can start ARIS Server Administrator from any computer on which the ARIS Client is
installed either in interactive mode or command-line mode. In command-line mode you can
perform actions automatically as there are no prompts in this mode. If you log in as a system
user that has at least the Database administrator function privilege in ARIS Administration
for each tenant, you can manage all databases of this tenant.
You start interactive mode by clicking Start > Programs > ARIS > Administration > ARIS
Server Administrator 10.0.
You start command-line mode by opening the command prompt from the directory <ARIS
installation directory>\tools\ArisAdm.
You can use the following commands and options for the syntax of command-line mode:
<_arisadm><version>.exe [<option>] <command> [<command argument 1>]
or for the syntax of interactive mode:
1063
<command> [<command argument 1>]

 If you use values with special characters (example: & in the password), you must enclose
the value in quotes. For additional information, please refer to the help and support
center for your operating system.
 On the server, system messages in ARIS Server Administrator are always output in the
ARIS installation language.
 For example, if you use scripts for daily backups, we strongly recommend that you
protect these scripts at the operating system level, or enter passwords encrypted.
Option Description
-s <server[:<port>]> Server on which the command should be carried out.
-u <user> <password> User name and password of a system user with the
required privileges.
-l <file name> Enables the logging of all program operations in the

specified log file. The file indicates which operation was
performed at what time and with what result.
-enc IBM<code page Specifies a code page to display diacritical characters

number> correctly. If you do not enter an option parameter, the
original character set of IBM PC 437 is used.
If diacritical characters, such as é, ó or ñ used in Spanish,
Portuguese or French are displayed as Ã©, Ã³, or Ã±, enter
the option -enc IBM850.
If problem occur in other languages, try other code page
numbers, such as:
850 Multilingual (DOS-Latin-1), Western Europe
720 Arabic alphabet
737 Greek alphabet
775 Estonian, Lithuanian, and Latvian alphabet
852 Slavic languages (Latin-2), Central and East Europe
855 Cyrillic alphabet
857 Turkish alphabet
-cf <command file> Starts a command file containing executable commands.
-sc <schema context> Context the schema uses. ARIS is set as the default.
-t <tenant> Tenant for which the command should be carried out. The
default is no tenant.
1064
Option Description
-ssl The SSL connection used.
Replace the text surrounded by <pointed brackets> by your individual values. The parts of the
command that are surrounded by [brackets] are optional. You can use them if necessary.
Default commands are listed below. Advanced commands are described in related documents
if required.
Command Description and syntax

backup Saves a database <dbname> as an adb file in a directory
<archivedir>.
If the backup is started using the -c option, saving the database
to the backup file starts only after all ongoing operations, such
as a merge procedure or an XML import, are complete.
Syntax
backup <dbname>|-c |all <archivedir> [-p <password for
encryption>] [<alternatename>]
backupasn Extracts the state that corresponds to the specified change list
number <asn> from a versioned database <dbname> to an ADB
file in the directory <archivedir>. You can select either a change
list number <asn> or 'head' as a state. 'head' represents the last
versioned state
Syntax
backupasn <dbname>|all <archivedir> <asn>|head [-p
<password for encryption>] [<alternatename>]
backupsystemdb Saves the central system database (page 1152) that contains
data such as filters, model templates, and scripts in an ADB file
in a directory <archivedir>.
Syntax
backupsystemdb <archivedir> [<alternatename>]
backupunversioned Saves a versioned database <dbname> as a non-versioned ADB
file in a directory <archivedir>.
Syntax
backupunversioned <dbname> <archivedir>
1065

clearchartdata Removes statistics data that is used, for example, to generate
charts displayed in ARIS Administration > Charts > Modeling.
You can remove statistics data for one or all databases entirely
or ahead of a certain date. The date must be given as
dd/mm/yyyy.
Syntax
clearchartdata <dbname> [date]
<dbname>: If you enter the name of a database, only statistic
data of this specific database is deleted.
all: Deletes statistic data of all databases on this tenant.
date: Deletes statistic data from a certain date [dd/mm/yyy].
copy Copies a database from <fromdbname> to <todbname>.

Syntax
copy <fromdbname> <todbname>
createdb Creates a new ARIS database with the name <dbname>.
Syntax
createdb <dbname> [versioned]
delete Deletes the database <dbname>. When using the force option,
the database will be deleted even if users are logged in.
Syntax
delete <dbname>|all [force]
dropversions Deletes all versions of a database <dbname> up to the version
<new min version>.
Syntax
dropversions <dbname> <new min version>
encrypt Encrypts passwords <password> for use in batch files.
Syntax
encrypt <password>
exit Exits the interactive mode.
1066

exportscript Exports a script of type
<MACRO|REPORT|REPORTTEMPLATE|SEMCHECK|PROFILE>
with the identifier <scriptid> to an export directory
<exportdirectory>.
Syntax
<scriptid> <exportdirectory>
help help provides an overview of all commands including syntax
description and possible parameters. help <command> provides
help for the command you specified.
Syntax
help [<command>]
importfilter Imports a method filter <importfile>.
Syntax
importfilter <importfile>
importscript Imports a script <importfile> of type

<MACRO|REPORT|REPORTTEMPLATE|SEMCHECK|PROFILE> in
the specified category <categoryname>.
Syntax
importscript
<importfile> <categoryname>
indexstate Displays the status of the internal cloud search data index.
Syntax
indexstate <database name>
interactive Starts the program in the interactive mode.
kill Closes the connection <sessionid> of the current tenant.

Syntax
kill <sessionid>|all
1067

killtask Terminates the given server activity <taskid> on instance
<instanceid>, for example, a report that is unable to complete.
Syntax
killtask <instance id> <task id> [force]
To obtain the <instanceid> and <taskid> identifiers, use the
monitor command.
list Lists all of the tenant's registered databases. By default, only

the databases of the current schema context will be listed.
When using the all option, all databases will be listed (including
BO databases, for example).
Syntax
list [all]
lockdb Locks the database with the name <dbname>, or all databases.
Users can no longer log in.
Syntax
lockdb <dbname>|all
maintain Starts the regeneration of search indexes (Cloud Search) for the
specified ARIS database or all ARIS databases. Given the fact
that running this command may be very time-consuming, it is
recommended that you run it only if an error occurs and that
you schedule a corresponding maintenance window.
Syntax
maintain <dbname>|all
1068

maintainancemode Indicates the current maintenance mode. maintenancemode
on prevents ARIS Server from automatically updating
databases. This can help you reduce the downtime after an ARIS
Server update because time-consuming maintenance jobs are
automatically stopped for all databases. If you use this option,
make sure to run the maintain command manually for related
databases if required. If you select maintenancemode off, all
database maintenance jobs are run again.
Starts the regeneration of search indexes (Cloud Search) for the
specified ARIS database or all ARIS databases. Given the fact
that running this command may be very time-consuming, it is
recommended that you run it only if an error occurs and that
you schedule a corresponding maintenance window.
Syntax
maintain <dbname>|all
Syntax
maintainacemode on|off
no parameter: Reports the current mode.
on: Turns the maintenance mode on and prevents ARIS Server
from maintaining databases.
off: Turns the maintenance mode off and allows ARIS Server
maintaining databases automatically.
migrate Migrates an ARIS 7.1 or 7.2 database <dbname> from an ADB file
<archive>, or migrates all ADB files from a directory
<archivedir>. You need the password of the system user
system to migrate an individual database. To migrate multiple
databases the passwords must be supplied to every single
database in command-line mode. Use the -fv option (forward
versioning) to store database versions only for ARIS versions
prior to 10.0.14.
Syntax
migrate [<archive>|<archivedir>]|<systempassword> [-fv]
monitor Displays all tenant activities in progress, such as backup, XML

export etc.
1069

rename Renames the database from <olddbname> to <newdbname>.
When using the force option, the database will be renamed even
if users are still logged in.
Syntax
rename <olddbname> <newdbname> [force]
reorg Semantically reorganizes the database <dbname> or all
databases by deleting all objects and connection definitions that
do not have occurrences in any model.
Options available:
 CXNDEFS_IN_MATRIX_MODELS
Connection definitions for which no occurrence exists are
not deleted when used in models of type Matrix model.
 USERDEF_CONTENT_SYMBOLS
User-defined symbols that are not allowed by ARIS Method
on the current server are replaced by the method-based
default symbol.
 USERDEF_CONTENT_MODELS
User-defined models that are not allowed by ARIS Method
on the current server are deleted.
 USERDEF_CONTENT_ATTRS
User-defined attributes that are not allowed by ARIS
Method on the current server are deleted.
 NO_DEFS
If you do not set an option, object definitions for which no
occurrence exists are deleted by default.
Syntax
<dbname>|all [options]
restore Restores a database <dbname> from an ADB file <archive>, or
restores all ADB/BDB files from a directory. Use the -fv option
(forward versioning) to store database versions only for ARIS
versions prior to 10.0.14.
Syntax
restore <archive>|<archivedir> [<dbname>] [-p
<password for decryption>] [-b <bucket ID>] [-fv]
1070

restoresystemdb Restores the central system database that contains data such
as filters, model templates, and scripts from a system database
backup file (ADB) <archive>. You can also update the system
database using the updatesystemdb command
After performing an update setup, update the system
configuration of each operational tenant (filters, templates, and
scripts) based on the supplied system database (page 1152)
(<ARIS installation package>..\Content\SystemDB\*.adb). Any
content you have created is retained.
Syntax
updatesystemdb <archive>
You can execute the command for several tenants at the same
time.
Syntax
restoresystemdb <archive>
restoreunversioned Generates a non-versioned database <dbname> from an ADB
file <archive> of a versioned database. Also restores databases
based on multiple ADB/BDB files of a directory.
Syntax
restoreunversioned <archive>|<archivedir>
[<dbname>] [-p <password for decryption>]
restoreversioned Generates a versioned database <dbname> from an ADB file
<archive> of a non-versioned database. Also restores databases
based on multiple ADB/BDB files of a directory. In case the
option -no_baseline is specified, no initial version in archive is
created. Use the -fv option (forward versioning) to store
database versions only for ARIS versions prior to 10.0.14.
Syntax
restoreversioned <archive>|<archivedir> [<dbname>]
[-p <password for decryption>] [-no_baseline] [-fv]
schemacontext Changes the schema context of the current tenant. Thus, it is
possible to save ARIS Optimizer databases. Possible values are
aris and bo.
Syntax
schemacontext <new schema context>
1071

server Changes the current ARIS Server.
Syntax
server <server[:<port>]> <tenant> <user> [<password>]
[-ssl]
sessions Displays all database connections of the current tenant.
Syntax
sessions [byuser|bydatabase]
set Displays or changes tenant settings. If no parameters are
specified, all settings are displayed. If only <key> is entered, all
settings are deleted. If <key> is entered together with <value>,
the settings are changed accordingly.
Syntax
set [<key>] [<value>]
setindexbucket Specifies the bucket ID for a database.
Syntax
setindexbucket <dbname> <bucket ID>
setindexrank Sets the initial index rank for a database <dbname>. The higher
the rank <rank>, the earlier the index is started during cloud
search startup. The rank is a number, for example, 5.
Syntax
setindexrank <dbname> <rank>
statistic Returns the number of all database objects.
Syntax
statistic <dbname>|all
threaddump Triggers a thread dump on instance <instanceID>. An instance
ID can refer to a runnable, such as abs <s, m, or l> or report <s,
m, or l>, or to a runnable type, such as abs or report.
The thread dump is written to the threaddump.log file.
Syntax
threaddump <instanceID>
unlockdb Unlocks the database with the name <dbname>, or all
databases.
Syntax
unlockdb <dbname>|all
1072

updatesystemdb After performing an update setup, update the system
configuration of each operational tenant (filters, templates, and
scripts) based on the supplied system database (page 1152)
(<ARIS installation package>..\Content\SystemDB\*.adb). Any
content you have created is retained.
Syntax
updatesystemdb <archive>
You can execute the command for several tenants at the
same time.
userwipeout Clears the user identification of one or multiple deleted users
from one or all databases. The attributes Last modifier,
Creator, and the user name in change list descriptions is set to
unknown.
Syntax
userwipeout <dbname>|all [<user>][,<user>]
version Displays the versions of the programs and libraries in use.
In the following example, a database is reorganized, whereby all of the objects and
connections in the database that do not have an occurrence are deleted.
Warning
If you are using an object library, you should reorganize databases only when each object
definition occurs in at least one overview model. If elements have already been created for
later use but do not yet occur in models, these elements are deleted during the consolidation.
Reorganization in interactive mode
1. Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0. The
MS DOS input window opens and ARIS Server Administrator is launched in interactive
mode.
2. Use the server command to connect to the relevant ARIS Server:
Syntax
server <server name>[:<port number>] <tenant> <user name>
The parts of the command that are surrounded by brackets are optional, that is, you can
use them if necessary.
Example
server arissrv.eur.ag:80 default system
The password is requested.
1073
3. Enter the user's password. In this example, manager. The connection is established.
4. Enter the command for the reorganization of the United Motor Group database:
reorg "United Motor Group"
The database is reorganized. The deleted items are listed.
Reorganization in command-line mode
1. Open the command prompt from the directory <ARIS installation
directory>\tools\ArisAdm.
2. Enter the command line parameters:
Syntax
arisadm<version> -s <server name> -t <tenant> -u <user name> <password>
reorg <database name>
Example
arisadm.bat -s arissrv.eur.ag -t default -u system manager reorg "United
Motor Group"
The database is reorganized. The deleted items are listed.
To obtain information on the ARIS Server administrator commands, enter help or help
<command>.
3.22.6.1 Execute the backupsystemdb command

You can save the central system database (page 1152) as ADB file in a directory <archivedir>
manually. It contains data such as filters, model templates, scripts, and ARIS method
extensions, such as user-defined attributes, models or objects.
If you use ARIS 9.8 service release 2 or newer versions, the system database will be backed up
automatically during a tenant backup (page 920).
Prerequisites
 ARIS Server Administrator is installed.
 You know the credentials of the superuser, or you have the Server administrator function
privilege.
Procedure
1074

3. Enter backupsystemdb <archivedir>[<alternatename>].
The system configuration, managing, for example, ARIS method extensions, report scripts,
scheduled reports, macros, semantic checks, filters and templates, of this tenant will be
saved.
3.22.6.2 Execute the restoresystemdb command

Restores the central system database (page 1152) that contains data such as ARIS method
extensions, filters, model templates, and scripts from a previously saved system database
(page 1074) (ADB file) <archive>. You can also update the system database using the
updatesystemdb (page 1076) command.
Prerequisites
privilege.
 You have access to the backup file (<archive>)
Procedure
3. Enter restoresystemdb <archive>.
The system configuration, managing, for example, report scripts, macros, semantic checks,
filters and templates, of this tenant will be restored.
1075
3.22.6.3 Execute the updatesystemdb command

When you update the ARIS Server using the update setup, the default tenant's system
database is updated automatically. For all additional tenants you must update the system
databases with the provided database manually. If you do not update system databases, all
updates, for example, ARIS method extensions, concerning scripts, filters and templates will
not be available.
Prerequisites
privilege.
 You have access to the most recent system database (<downloaded installation
package>/Content/SystemDB/<ADB file>)
 You have backed up all data that will be overwritten during the update.
Procedure
3. Enter updatesystemdb <name of ADB file>.
The system configuration of this tenant, managing, for example, ARIS method extensions,
report scripts, scheduled reports, macros, semantic checks, filters, and templates, will be
updated. User-defined changes made in the configuration will remain.
1076
3.22.6.4 Execute the userwipeout command

Even if a user is deleted in the User Management of the ARIS Administration (page 35), in ARIS
databases the user name stays visible in the Creator and the Last modifier model and object
attributes, and in change list descriptions. This also applies to archived models and objects.
You can anonymize user data according to GDPR (page 1139).
Warning
Make sure to only anonymize deleted users. If you anonymize existing users, the user names
are anonymized in all attributes, such as Creator, Last modifier, and the user names in
change list descriptions.
Prerequisites
privilege.
 The database must be locked for other users.
Procedure
3. Enter: userwipeout <dbname>|all <user>,<user>
User identifications of one or multiple users are deleted from one or all databases. The
attributes Last modifier, Creator, and the user name in change list descriptions is set to
unknown.
1077
3.22.7 Command line tools for the ARIS Administration

ARIS provides a set of command-line tools that can be used to perform administrative
operations.
There are always at least two tenants, the tenant default and the tenant master. Most
command-line operations require user authentication. The provided user must have sufficient
permissions to perform the requested operation, for example, a tenant create, read, update or
delete can only be performed by administrators of tenant master.
 ARIS must be running.
 The command-line tools must be executed in the following path:
ARIS installation path>/server/bin/work/word_umcadmin_< your installation size, for
example, s,m, or l>/tools/bin for Windows® operating systems
and
ARIS installation path>/cloudagent/bin/work/word_umcadmin_< your installation size,
for example, s,m, or l>/tools/bin for Linux operating systems.
The following command line tools are provided:
 y-datadump.bat
 y-elasticsearch.bat
 y-ldapsync.bat
 y-password.bat
 y-tenantmgmt.bat
For more information about parameters and commands please type the tool name followed by
/? or -?, for example y-datadump.bat -?.
For Unix operating systems, command-line tools (sh files) can only be started by the aris10
user, for example, enter: su -c y-datadump.sh aris10.
 y-datadump.sh
 y-elasticsearch.sh
 y-ldapsync.sh
 y-password.sh
 y-tenantmgmt.sh
1078
3.22.7.1 Password encryption

There are many places where you might want to use and store a password. The
y-password.bat can be used to encrypt these passwords. Enter the tool name followed by /?
or -? to see the usage instructions, for example y-password.bat -?.
Procedure
Open a command prompt on the above folder (Start > Run > cmd).
1. Enter y-password.bat <option> <password>
2. Mark and copy the encrypted password and paste it to your configuration file or use it
directly from command line.
The following is output:
[CLI] Setting verbosity level... [VALUE: 0=OFF]
[CLI] Plain: <password>
[CLI] Encrypted: f4a28327ad2f0c87336dd74fe0a70c39
General usage
Options Description
-?, -h, --help Show help
Default: false
Commands Description
encrypt encrypts the password
Example
Input
y-password.bat encrypt aris
Output
[CLI] Plain: aris
[CLI] Encrypted: f4a28327ad2f0c87336dd74fe0a70c39
Usage of an encrypted password from command line
This example shows how to use the encrypted password while executing the LDAP
synchronization from the command line.
Input
1079
y-ldapsync.bat syncUser -au <user_name> -u system -p

{crypted}f4a28327ad2f0c87336dd74fe0a70c39
Output
1080
3.22.7.2 Tenant Management

The batch file y-tenantmgmt.bat can be used to manage tenants. Enter the tool name
followed by /? or -? to see the usage instructions, for example y-tenantmgmt.bat -?.
Please use y-tenantmgmt.bat for Windows® operating systems and y-tenantmgmt.sh for
Unix operating systems.
Warning
Using some advanced ACC commands, you can create a tenant, import a license and restore a
database in one step. If you do not use the standard database system, please make sure to
create additional schemes in your Oracle or Microsoft SQL database management system and
you have assigned the tenants (page 932) to these schemes.
Prerequisites
 Users need the function privileges License administrator, User administrator,
Technical configuration administrator.
Users need to login as superuser or they need either an ARIS Architect license or an
ARIS UML Designer license.
Procedure
2. Enter y-tenantmgmt.bat followed by /? or -? to display the help, for example
y-tenantmgmt.bat -?.
Enter y-tenantmgmt.bat -t <tenant name> <command> -u <user name> -p
<password> to enter a command (page 1082). Parameters may differ.
After creating a tenant, you must import the relevant license and create the users. You can do
so from the command line or using the graphical user interface ARIS Administration.
You are recommended to change the password of the default user system immediately after
the installation.
1081
3.22.7.3 Parameters for

y-tenantmgmt.bat/y-tenantmgmt.sh
General usage
Options Description
-?, -h, --help Show help, default: false
-s, --server URL of the server, for example, http://my_host_url:<port number other
than default port 80 or 1080 (page 906)>
Commands Description Parameters

anonymize Anonymizes the audit Please note that you must wait at least 30 minutes
log files. after the deletion of the user from User
This is compliant to Management before you can start the
GDPR. The General anonymization process.
Data Protection Usage: anonymize [options]
Regulation (GDPR) Options:
protects individuals’
* -n, --name
personal data within
Name of the user or user group
the European Union. It
-p, --password
also regulates the
export of personal data Password of executor, default: superuser
outside the EU. GDPR * -type, --type
is a regulation by the UUID type is user or user group
European Parliament,
-u, --user
the Council of the
User name of the executor, default: superuser
European Union, and
the European
Commission.
1082

assignLicense Assigns a license to Usage: assignLicense [options]
user. Options:
-ag, --affectedGroup
Name of affected user group, default: []
-au, --affectedUser
User name of affected user, default: []
* -l, --license
Product code, default: []
-p, --password
Password of the executor, default: superuser
-u, --user
assignPrivilege Assigns privileges Usage: assignPrivilege [options]

Options:
Name of affected user group, default: []
-au, --affectedUser
User name of affected user, default: []
-p, --password
* -pr, --privilege
Privilege, default: []
-u, --user
1083

assignUser Associates a user to a Usage: assignUser [options]
user group. Options:
* -ag, --affectedGroup
Name of affected user group
* -au, --affectedUser
User name of affected user
-p, --password
-u, --user
changePasswor Changes a password. Usage: changePassword [options]

d Options:
* -ap, --affectedPassword
Password of affected user
-p, --password
-u, --user
checkLicense Checks tenant license. Usage: checkLicense [options]

Options:
* -l, --license
-p, --password
-u, --user
1084

createGroup Creates a user group. Usage: createGroup [options]
Options:
-ad, --affectedDescription
Description of affected user group
-p, --password
-u, --user
createMiningSe Creates ARIS Process Usage: createMiningServer [options]

rver Mining server Options:
application
-aid, --applicationClientId
Client ID of the affected application
-asec, --applicationClientSecret
Client secret of the affected application
-as, --applicationScopes
API scopes of the affected application
-p, --password
Password of editor
Default: superuser
-u, --user
User name of editor
Default: superuser
1085

createTenant Creates a new tenant. Usage: createTenant [options]
Options:
-u, --user
-p, --password
-t, --tenant <TENANTNAME> (mandatory)
For tenant names please only use up to 25
lowercase ASCII characters and numbers. The
name must begin with a character. Special
characters, such as _ and characters, for example,
--arisservicePassword (-arisservicep)
<PASSWORD>
--superuserPassword (-superuserp) <PASSWORD>
--systemPassword (-systemp) <PASSWORD>
1086

createUser Creates a new user. Usage: createUser [options]
Options:
Description of affected user
-ae, --affectedEmail
E-mail address of affected user
-af, --affectedFirstName
First name of affected user
-al, --affectedLastName
Last name of affected user
-ap, --affectedPassword
Password of affected user
-p, --password
-u, --user
deleteGroup Deletes a user group. Usage: deleteGroup [options]

Options:
-p, --password
-u, --user
1087

deleteLicense Deletes the licenses Usage: deleteLicense [options]
for a product. Options:
* -l, --license
Product code
-p, --password
-u, --user
deleteTenant Deletes an existing Usage: deleteTenant [options]

tenant. Options:
-p, --password
-u, --user
deleteUser Deletes an existing Usage: deleteUser [options]

user. Options:
--user (-u) <USERNAME> (mandatory)
--password (-p) <PASSWORD> (mandatory)
--tenant (-t) <TENANTNAME> (mandatory)
--affectedUser (-au) <USERLOGIN> (mandatory)
1088

exportAuditLog Exports audit events Usage: exportAuditLog [options]
Export Options:
-ed, --endDate
End date in format yyyy-MM-dd HH:mm:ss
-ev, --eventTypes
Comma-separated list of events (page 1081)
Default: ALL
-f, --file
Name and location of the export file
* -ff, --fileFormat
Format of the file to be exported as CSV or JSON. If
the format is not specified, events will be exported
in CSV format.
Default: CSV
-p, --password
Password of editor
Default: superuser
-sd, --startDate
Start date in format yyyy-MM-dd HH:mm:ss
-u, --user
User name of editor
Default: superuser
exportConfig Exports configuration Usage: exportConfig [options]

of tenant. Options:
-f, --file
Configuration file, default: umc.properties
-p, --password
-u, --user
1089

getTenant Prints information Usage: getTenant [options]
about a tenant. Options:
-p, --password
-u, --user
getUser Prints information Usage: getUser [options]

about a user. Options:
-p, --password
-u, --user
importConfig Updates configuration Usage: importConfig [options]

of tenant. Options:
-f, --file
Configuration file, default: umc.properties
-p, --password
-u, --user
1090

importConfigFil Updates the tenant Usage: importConfigFile [options]
e configuration file. Options:
-f, --file
Configuration file
-o, --option
Configuration option
-p, --password
-u, --user
importLicense Imports license files Usage: importLicense [options]

for a tenant . Options:
-f, --file
Lincense file, default: license.zip
-p, --password
-u, --user
listPrivileges Lists the privileges of Usage: listPrivileges [options]

the user mentioned in Options:
the command
-au, --affectedUser
-p, --password
-u, --user
1091

listTenants Lists all existing Usage: listTenants [options]
tenants. Options:
-p, --password
-u, --user
purgeAuditLog Deletes all audit logs of Usage: purgeAuditLogByUser [options]

ByUser a deleted user. Options:
* -ed, --endDate
End date in format (yyyy-MM-dd HH:mm:ss)
-p, --password
-sd, --startDate
Start date in format (yyyy-MM-dd HH:mm:ss)
u, --user
1092

saveApplication Registers an external Usage: saveApplication [options]
application. Options:
-aid, --applicationClientId
Client ID of the affected application
-asec, --applicationClientSecret
Client secret of the affected application
-ad, --applicationDescription
Description of the affected application
-an, --applicationName
Application name of the affected application
-as, --applicationScopes
API scopes of the affected application
-p, --password
Password of editor
Default: superuser
-u, --user
User name of editor
Default: superuser
unassignLicens Removes a license Usage: unassignLicense [options]

e from user. Options:
-au, --affectedUser
* -l, --license
Product code
-p, --password
-u, --user
1093

unassignPrivile Removes the privilege Usage: unassignPrivilege [options]
ge assignment. Options:
-au, --affectedUser
-p, --password
* -pr, --privilege
Privilege
-u, --user
unassignUser Removes a user from a Usage: unassignUser [options]

user group. Options:
-p, --password
-u, --user
1094

updateLicense Replaces the license Usage: updateLicense [options]
file for a tenant. Options:
-f, --file
Lincense file, default: license.zip
* -l, --license
-p, --password
-u, --user
updateUser Updates an existing Usage: updateUser [options]

user. Options:
Description of affected user
-ae, --affectedEmail
E-mail address of affected user
-af, --affectedFirstName
First name of affected user
-al, --affectedLastName
Last name of affected user
-p, --password
-u, --user
Examples
The following line creates a tenant with name test. Please pay attention to the order of
parameters.
y-tenantmgmt.bat -s http://my_aris_host.com -t test createTenant -u system
-p manager
The following line creates a new tenant with name test01, port used 81, and initial system
user password abc. Please pay attention to the order of parameters.
1095
y-tenantmgmt.bat -s http://my_aris_host.com:81 -t test01 createTenant -u

system -p manager -systemp abc
The following line gets information of the default tenant.
y-tenantmgmt.bat -s http://my_aris_host.com -t default getTenant -u system
-p manager
The following line updates the configuration of default tenant.
y-tenantmgmt.bat -s http://my_aris_host.com -t default importConfig -f
sldapconfig.properties -u superuser -p superuser
The following line assigns a license configuration to the user my_user.
y-tenantmgmt.bat -s http://my_aris_host.com-t default -assignLicense au
my_user -l YCZUS -u system -p manager
1096
3.22.7.4 List of technical names of audit events

 CONFIG_CHANGE
 CONFIG_FILE_IMPORT
 CONFIG_FILE_DELETION
 DATA_IMPORT
 GROUP_CREATION
 GROUP_UPDATE
 GROUP_DELETION
 GROUP_GROUP_ASSIGNMENT
 USER_GROUP_ASSIGNMENT
 ESCALATION_MANAGER_GROUP_ASSIGNMENT
 GROUP_GROUP_UNASSIGNMENT
 USER_GROUP_UNASSIGNMENT
 ESCALATION_MANAGER_GROUP_UNASSIGNMENT
 LDAP_IMPORT
 LDAP_SYNC
 LICENSE_IMPORT
 LICENSE_DELETION
 LICENSE_SEAT_ALLOCATION
 LICENSE_SEAT_DEALLOCATION
 LICENSE_USER_LIMIT_VIOLATION
 LICENSE_USER_GROUP_LIMIT_VIOLATION
 LOGIN_SUCCESSFUL
 LOGIN_FAILED
 LOGIN_RENEWAL
 LOGOUT
 LOGOUT_FORCED
 ORGCHART_UPDATE
 ORGCHART_DELETION
 OTP_GENERATION
 PASSWORD_CHANGE
 PASSWORD_RESET
 PASSWORD_TRANSFER
1097
 PICTURE_IMPORT
 PICTURE_DELETION
 PRIVILEGE_ASSIGNMENT
 PRIVILEGE_UNASSIGNMENT
 TENANT_CREATION
 TENANT_UPDATE
 TENANT_DELETION
 USER_CREATION
 USER_UPDATE
 USER_DELETION
 USER_SETTING_ADDED
 USER_SETTING_REMOVED
 IMPERSONATION_SUCCESSFUL
 IMPERSONATION_FAILED
 AUDIT_PURGE
 LICENSE_RULE_CREATED
 LICENSE_RULE_UPDATED
 LICENSE_RULE_DELETED
 LICENSE_RULE_ACTIVATED
 LICENSE_RULE_DEACTIVATED
 APPLICATION_CREATION
 APPLICATION_UPDATE
 APPLICATION_DELETION
 APPLICATION_TOKEN_REFRESH
 APPLICATION_SESSION_CREATION
 APPLICATION_SESSION_DESTROY
 APPLICATION_CLIENT_CREDENTIALS_GENERATED
 API_SCOPE_CREATION
 API_SCOPE_UPDATE
 API_SCOPE_DELETION
 API_CREATION
 API_UPDATE
 API_DELETION
1098
 AUTHORIZATION_CODE_CREATION
 AUTHORIZATION_CODE_DELETION
 CONFIRM_CONSENT_CREATION
 CONFIRM_CONSENT_DELETION
 EXTERNAL_ACCESS_TOKEN_CREATION
 EXTERNAL_ACCESS_TOKEN_DELETION
 REFRESH_TOKEN_CREATION
 REFRESH_TOKEN_DELETION
 SCIM_PROVISION_SUCCESSFUL
 SCIM_PROVISION_FAILED
1099
3.22.7.5 LDAP synchronization

The batch file y-ldapsync.bat can be used to synchronize the ARIS Administration with
LDAP. Enter the tool name followed by /? or -? to see the usage instructions, for example
y-ldapsync.bat -?.
Procedure
2. Enter y-ldapsync.bat -s <http://host_url:<port number other than default port 80
or 1080 (page 906)>> -t <tenant name> <command> -u <user name> -p <password>
Users are synchronized or imported from an LDAP system.
General usage
Options Description
-u User name of the relevant user.
-p Password of the relevant user.
-f LDAP search filter
-s, --server URL of the server, for example, http://my_host_url:<port number other
than default port 80 or 1080 (page 906)>
-t, --tenant Tenant name

Default: default
importUsers Imports users from an LDAP system, the spelling is case sensitive.
* -f, --filter
Search filter for LDAP as defined in RFC 2254, for example, '(cn=*)'. The
filter will be combined with the configured import filters.
-p, --password
Password of the executor
Default: superuser
-u, --user
User name of the executor
Default: superuser
1100
importGroups Imports a hierarchy from an LDAP system, the spelling is case sensitive.
* -f, --filter
Search filter for LDAP as defined in RFC 2254, for example, '(cn=*)'. The
filter will be combined with the configured import filters.
-p, --password
Default: superuser
-u, --user
Default: superuser
removeUserAttr Deletes an attribute of a user in the ARIS Administration.

ibute -au,--affectedUser
-aa,-affectedAttribute
Attribute of affected user
syncUser Synchronizes a specific existing user with an LDAP system, the spelling
is case sensitive.
syncUsers Synchronizes existing users with an LDAP system, the spelling is case
sensitive.
-p, --password
Default: superuser
-u, --user
Default: superuser
1101
syncGroup Synchronizes a specific existing group with an LDAP system, the spelling
is case sensitive.
Name of the affected user group
-p, --password
Default: superuser
-u, --user
Default: superuser
syncGroups Synchronizes existing groups with an LDAP system, the spelling is case
sensitive.
-p, --password
Default: superuser
-u, --user
Default: superuser
Example 1
y-ldapsync.bat -s http://my_aris_host.com -t default importUsers -u system -p manager -f
(cn=userID)
[CLI] Importing users... [TENANT: 30ff3081-aa9e-33e7-a7d7-5f9d00ae89ee, FILTER:
(cn=userID)]
[CLI] Users successfully imported. [TENANT: 30ff3081-aa9e-33e7-a7d7-5f9d00ae89ee,
COUNT: 1]
[CLI] CN=myuser,OU=Users,DC=mydomain
Example 2
Import all users from an LDAP system.
y-ldapsync.bat -s http://my_aris_host.com:81 -t default importUsers -u system -p manager
-f (cn=*)
1102
3.22.7.6 Data migration

Enter the tool name followed by /? or -? to display the instructions, for example
y-datadump.bat -?. In case of a data import, the target database has to be empty.
Warning
Procedure
2. Enter y-datadump.bat -s <http://host_url:<port number other than default port 80
or 1080 (page 906)>> -t <tenant name > <command> -u <user name> -p >password> -f
<dump file>
In this case, a dump file written containing the database content. The following is output:
[CLI] Exporting data... [TENANT: 30ff3081-aa9e-33e7-a7d7-5f9d00ae89ee, FILE: C:\out.zip]
[CLI] Data successfully exported. [TENANT: 30ff3081-aa9e-33e7-a7d7-5f9d00ae89ee]
General usage
Options Description
-f File name of the dump file.
-s, --server URL of the server, URL of the server, for example, http://my_host_url:<port
number other than default port 80 or 1080 (page 906)>
-t, --tenant Tenant name

Default: default
1103
export Exports all data of the specified tenant to a data dump file. Currently, a
dump contains the following information:
 tenant
 users
 groups
 user-group assignments
 profile pictures (optional)
 permissions, dependent on the privileges of the user who enters the
command
 licenses, dependent on the privileges of the user who enters the
command
 configuration, dependent on the privileges of the user who enters the
command
The data is stored in JSON format and packed into an encrypted ZIP file.
The ZIP file can be restored using the same command line tool.
import Imports a data base dump from a file.
Example
In this example, data is exported into a dump file.
y-datadump.bat -s <http://host_url> -t default export -u system -p manager -f
"C:\backup\backup.zip"
1104
3.22.8 Command line tools for ARIS document storage

ARIS document storage provides a set of command-line tools that can be used to perform
administrative operations.
<ARIS installation path>/server/bin/work/work_adsadmin_<your installation size, for
example, s,m, or l>/tools/bin for Windows® operating systems
and
ARIS installation path>/cloudagent/bin/work/work_adsadmin_<your installation size, for
example, s,m, or l>/tools/bin for Linux operating systems.
Please use y-admintool.bat for Windows operating systems and y-admintool.sh for Unix
operating systems. For Unix operating systems, command-line tools (sh files) can only be
started by the aris10 user, for example, enter: su -c y-admintool.sh aris10.
General usage
Options Description
-s, --server URL of ARIS document storage
-t, --tenant ID of the tenant. The default value is default.
-umc, URL of User Management

--umcserver

adjustTimestam Modifies the time stamp --password (-p) <PASSWORD>. The default
ps that is set while creating password is manager.
or updating documents --user (-u). The default user name is system.
and folders.
* -offset
The timestamp is modified
Offset to add (+) or to remove (-) in minutes,
for all documents and
for example:
folders on a tenant.
"-210". The default value is "0".
Usage: adjustTimestamps
[options]
1105

anonymize Anonymizes the user --password (-p) <PASSWORD>
information for Password of the executor. The default
documents and folders password is manager.
Usage: anonymize By default, no access privileges are defined in
[options] ARIS document storage. All users have access
to all folders - including the root folder - and
This is compliant to GDPR. documents. You can limit the access (page
The General Data 470) to individual folders of ARIS document
Protection Regulation storage so that not all ARIS document storage
(GDPR) protects users can access all folders and their contents.
individuals’ personal data Please note:
within the European If you delete only one user from the user list or
Union. It also regulates the from user groups that have access to the
export of personal data folder and then anonymize the folder data, all
outside the EU. GDPR is a actions related to the folder data are
regulation by the anonymized. This means that the
European Parliament, the anonymization does not only affect the data of
Council of the European the deleted user.
Union, and the European
Before you delete a user, get the user ID of a
Commission.
specific user from the user details in the user
management.
* -n, --name
Name of the user or user group
* -type, --type
Type of the user or user group
-u, --user
User name
Password of the executor. The default
password is system.
The user name is replaced by the string
anonymous.
1106

bulkimport Imports all files and -a, --attributes
folders from a specified Creates metadata for every uploaded
directory to ARIS document, for example: "description:initial
document storage. The upload for migration step|labels:big
folder structure of the data,external,draft|source:sharepoint".
source is retained.
This example shows how to specify the
Usage: bulkimport Description attribute and that custom
[options] attributes are created if required attributes
Alternatively, you can were not available by default (title, description,
import large datasets to tags, owner). The character | is used to
ARIS document storage separate the values. However, it must not be
using a report. To do so, used within a value.
contact your local --password (-p) <PASSWORD>
Software AG sales
organization
password is manager.
(https://www.softwareag.
--repository (-r) <Repository name>.
com/corporate/company/
The default repository is the portal repository
global/offices/default.htm
used in ARIS document storage or in the
l).
repository view in ARIS. The default value is
portal.
You must specify the target repository only if
you do not use the default repository.
A different repository could be the ARIS Risk
and Compliance repository for example.
-sw, --stopwatch
Enables the benchmarking for bulk import of
documents and folders.
The default value is false.
--user (-u) <USERNAME>
User name of the executor. The default user
name is system.
-deltaimportfile
Delta import: If errors have occurred during an
import, an importerrors.log file is created in
the current working directory, for example,
../tools/bin/importerrors.log. To import the
documents listed in the log file, specify the 1107
following:

-deltaimportfile "./importerrors.log".
In this case, the path parameter is ignored, and
only the files specified in the importerrors.log
file are imported.
-logfile
Specifies the name to be used for the log file
when the loglevel parameter is set, for
example, %LOGS%adsimport.log.
If nothing is specified, but logging is enabled
using the loglevel parameter, the
adsimport.log file is saved to the current
working directory. The default value is
adsimport.log.
-loglevel
Specifies the log level for the bulk import of
documents. When set to standard, only
document names and IDs are logged. When set
to hyperlinks, the HTTP links of documents
are also logged. The default value is none.
* -path
Directory path to be used for bulk import of
documents, for example,
C:/import/documents/. From the last folder
specified, the folder structure is reproduced in
the repository of ARIS document storage.
Example: If the source folder has the following
structure
C:/import/documents/folder1/folder2,
running the command-line tool using the
-path option will generate the structure
documents/folder1/folder2 in ARIS
document storage.
1108

-overwrite
If this option is enabled (-overwrite true),
existing documents and folders are deleted
and newly created according to the specified
directory structure.
* -path
The directory path to be used for the bulk
import of documents, for example,
C:/import/documents/. From the last folder
specified, the folder structure is reproduced in
the repository of ARIS document storage.
Example: If the folder containing the
documents to be imported has the following
structure
C:/import/documents/folder1/folder2,
running the command-line tool using the
-path option will generate the structure
documents/folder1/folder2 in ARIS
document storage.
-toplevelfolder
If this property is set, the top-level folder
specified in -path parameter is ignored during
import. If the documents to be imported are
located at a level lower than a given folder
mydocs, and, for example, the path
/mydocs/folder1/folder2 is used with this
option, only the structure of the folders
subordinate to the mydocs level is mirrored
during the import and created directly below
the root directory in ARIS document storage. If
this property is not set (which is the default),
the top-level folder is mirrored as well in the
ARIS document storage repository, that is, the
entire structure /mydocs/folder1/folder2 is
created below the root directory. The default
value is false.
1109

deleteAccessPri Removes all access --folderId (* -f)
vileges restrictions from a The folder ID is required to delete all access
specified folder. privileges.
Usage: --password (-p) <PASSWORD>. The default
deleteAccessPrivileges password is manager.
[options]
--user (-u). The default user name is system.
name is system.
-orphandata
Deletes the access privileges assigned to
deleted user groups. The default value is false.
-passon
Deletes the access privileges from the folder
hierarchically. The default value is false.
exportConfig Exports the configuration --file (-f)

of ARIS document storage. Configuration file. The default value is
Usage: exportConfig adsConfig.properties.
[options] --password (-p) <PASSWORD>. The default
importConfig Updates the configuration --file ( -f)

of ARIS document storage The configuration file to be imported. The
of this tenant. default value is adsConfig.properties.
Usage: importConfig --password (-p) <PASSWORD>. The default
[options] password is manager.
reindex Re-indexes the ARIS --password (-p) <PASSWORD>. The default

document storage password is manager.
database. --user (-u). The default user name is system.
Usage: reindex [options]
1110

thumbnails Creates thumbnails for --password (-p) <PASSWORD>
pictures. Password of the executor. The default
Usage: thumbnails password is manager.
[options] --repository (-r) <Repository name>.
The default repository is the portal repository
used in ARIS document storage or in the
repository view in ARIS. The default value is
portal.
You must specify the target repository only if
you do not use the default repository.
A different repository could be the ARIS Risk
and Compliance repository for example.
name is system.
Example
y-admintool.bat -s http://my_aris_host.com:1080 -umc http://my_aris_host.com:1080 -t
default bulkimport -u system -p manager -path d:\my_documents
1111
3.22.9 Command line tools for Process Governance

Process Governance provides a set of command-line tools that can be used to perform
administrative operations.
Warning
<ARIS installation path>/server/bin/work/work_apg_<your installation size, for example,
s,m, or l>/tools/bin for Windows® operating systems
and
<ARIS installation path>/cloudagent/bin/work/work_apg_<your installation size, for
example, s,m, or l>/tools/bin for Linux operating systems.
 y-ageclitool.bat
 y-export4ppm.bat
 y-setenv.bat
This command-line tool is called by the y-ageclitool.bat or y-ageclitool.sh and configures
the environment as required.
For more information about parameters and commands please type the tool name followed by
/? or -?, for example y-ageclitool.bat /?.
On Unix operating systems, only the aris10 user can start the command-line tools (sh files),
except for the y-setenv.sh file. For example, enter: su -c y-ageclitool.sh aris10.
 y-ageclitool.sh
 y-export4ppm.sh
 y-setenv.sh
This command-line tool is called by the y-ageclitool.bat or y-ageclitool.sh and configures
the environment as required.
1112
3.22.10 Parameters for y-ageclitool.bat/y-ageclitool.sh

Please use y-ageclitool.bat for Windows® operating systems and y-ageclitool.sh for Unix
operating systems. On Unix operating systems, only the aris10 user can start the
command-line tools (sh files), except for the y-setenv.sh file. For example, enter: su -c
y-ageclitool.sh aris10.
General usage
Options Description
1113

anonymize This command anonymizes the Usage: y-ageclitool [command]
given user in Process [options]
Governance data, for example, in -apg, --apg-endpoint
substitution logs or audit logs.
All user names are replaced with
-du, --deleted user name
anonymous.
User name of the deleted user
This is compliant to GDPR. The
Mandatory parameter
General Data Protection
Regulation (GDPR) protects
individuals’ personal data within -p, --password
the European Union. It also Password of executer
regulates the export of personal
Default: manager
data outside the EU. GDPR is a
regulation by the European
* -t, --tenant
Parliament, the Council of the
European Union, and the Tenant name
European Commission. The -umc, --umc-endpoint
Process Governance services
can write user specific data to
-u, --user
attributes. These attribute
User name of executer
values can be anonymized with
Default: system
the help of customized reports
in order to meet the The user name is replaced by the string
requirements of the General anonymous.
Data Protection Regulation
(GDPR (page 1139)). Please
contact your local Software AG
sales organization
1114

cancelHTOfCom Cleans up pending human tasks Usage: y-ageclitool [command]
pletedInstance belonging to process instances [options]
that are already completed. -apg, --apg-endpoint
-ht, --human-task-id
-p, --password
Password of executer
Default: manager
* -t, --tenant
Tenant name
-umc, --umc-endpoint
-u, --user
Default: system
1115

findSubstitutees This command finds all users for Usage: y-ageclitool [command]
whom a given user acts as a [options]
substitute. -apg, --apg-endpoint
-p, --password
Default: manager
-su, --substitue the login name of the
user
login name of the substitute
Mandatory parameter
* -t, --tenant
Tenant name
-u, --user
Default: system
1116

getConfigProper This command returns the value Usage: y-ageclitool [command]
ty of a configuration property. [options]
You can retrieve both -apg, --apg-endpoint
cross-tenant and
tenant-specific properties. You
* -k, --config property key
can also retrieve hidden
properties.
* -t, --tenant
The output of the command
Tenant name
contains only the value of the
property. If a property value is
empty, the output is an empty -u, --user
string. User name of executer
Default: system
-p, --password
Default: manager
1117

purgeAuditlogs The command deletes all audit Usage: y-ageclitool [command]
logs from a start date, if [options]
specified, up to, and including, -p, --password
the specified end date. The start
date and the end date must be in
Default: manager
the format yyyy-MM-dd
-t, --tenant
Tenant name
Mandatory parameter
-u, --user
Default: system
-sd, --startDate
Start date
-ed, --endDate
End date
Mandatory parameter
rebalance This command distributes the Usage: y-ageclitool [command]

process instances equally [options]
among the Process Governance -p, --password
nodes if the
PROCESS_INSTANCE_BASED
Default: manager
assignment strategy is
-u, --user
configured. Users can perform
this command on the User name of executer
infrastructure tenant (master) Default: system
only.
1118

setConfigProper This command sets the value of Usage: y-ageclitool [command]
ty a configuration property. [options]
You can specify the -apg, --apg-endpoint
configuration property value for
a tenant-specific property. You
* -k, --config property key
can also specify hidden
properties if they are
* -v, --config property value
tenant-specific.
* -t, --tenant
Tenant name
-u, --user
Default: system
-p, --password
Default: manager
Example
y-ageclitool.bat findSubstitutees -s http://myarishost.com:1080 -apg
http://myarishost.com:1080 -umc http://myarishost.com:1080 -t default -u system -p
manager -su substitutesname
1119
3.22.11 Parameters for y-export4ppm.bat/y-export4ppm.sh

Please use y-export4ppm.bat for Windows operating systems and y-export4ppm.sh for
Unix operating systems. On Unix operating systems, only the aris10 user can start the
command-line tools (sh files), except for the y-setenv.sh file. For example, enter: su -c
y-ageclitool.sh aris10.

export4ppm Exports data for use in Usage: export4ppm [options]
ARIS Process Performance --apg-endpoint (-apg)
Manager
--end-date (-e)
--file (-f)
Name and location of the file to be exported.
--password (-p) <PASSWORD>
--start-date ( -s)
--tenant (* -t)
Tenant name
--umc-endpoint (-umc)
name is system.
Example
y-export4ppm.bat export4ppm -apg http://myarishost.com:1080 -umc
http://myarishost.com:1080 -t default -u system -p manager -s startDate -e endDate
1120
4 Glossary
In the glossary you will find explanations of basic technical terms.
A
ACCESS PRIVILEGE
With the access privileges you can control which content is accessible to specific users or
user groups. Based on their access privileges, users can see, comment, create/edit, delete, or
version models and objects. You assign access privileges to users, user groups, or database
groups on the properties pages. Administrators manage users, user groups, cross-database
and cross-product privileges and licenses for all ARIS products in ARIS Administration.
No access (----)
Read (r---)
Read + Write (rw--)
items.
1121

and version models.
ADB FILE
File extension of the ARIS database file format.
ARIS backs up ARIS databases in files of this format.
ARIS DATABASES
On each tenant different sets of databases can be managed (page 118).
ARIS MODELING ENVIRONMENT

The ARIS modeling environment is the area of an application where you can model your
company-wide process architecture. ARIS modeling environments help you model processes
quickly with automatic modeling functions and allows you to use data in other ARIS
applications. For example, ARIS Architect, ARIS, or ARIS Advanced provide an ARIS modeling
environment.
DEFAULT LANGUAGE
Database language that is used to display database content if attribute values are not
specified in the database language that is currently used. When you create a database,
English (United States) is selected automatically. On the Administration tab, you can
change the default language.
API NAME
The API name is a unique identifier for database items. You can use the API name to address
database items with the ARIS API (page 1123) programming interface.
Information about API names is available in ARIS Architect on the Administration tab below
the Method folder structure. Specific information from the Method help is available by
selecting an item, for example, an object, a connection, or a model, and pressing Ctrl + F1.
ARIS ADMINISTRATION
Manages users, user groups, privileges, licenses, documents, configurations, and processes
for a tenant (page 1153).
1122
ARIS API
ARIS API is a programming interface with which you can access ARIS and its data from
external applications.
ARIS CONNECT GOVERNANCE INBOX

As soon as the first change request is made, the ARIS Connect Governance Inbox database
is automatically created in ARIS. It contains a Requirements inbox for each person responsible
with a model of the Requirements tree type. An object of the Requirement type is created
for each change request. As the process continues, the realization status of the object is
automatically changed depending on which status the person responsible has selected
(Approve, Reject). This enables all change requests to be monitored in the ARIS Connect
Governance Inbox database.
ASSIGNMENT
A model assigned to an object by an assignment relationship (page 1124).
If a model is assigned to an object, this can be indicated by an assignment icon (page
1123). An assignment enables you, for example, to use a model to describe objects in detail
and thus get from a rough plan to a detailed plan.
ASSIGNMENT ICON
Icon that shows that one or more models are assigned to an object by an assignment
relationship (page 1124).
You can open assigned models by double-clicking the assignment icon. The assignment icon
is displayed if you have disabled the Hide assignment icons option.
The assignment icon may look different and may be placed at different points in the object.
The positioning depends on the model template you are using.
You can also assign an assignment icon of your own to a database. It is displayed to the right
of the icons.
1123
ASSIGNMENT RELATIONSHIP
Relationship of an object to a model assigned (page 1123) to it.
You can create an assignment relationship using drag and drop or using the object properties
dialog. The assignment relationship is displayed at the object by an assignment icon (page
1123).
ATTRIBUTE
Attributes are properties of items, such as models (page 1143) and objects (page 1146), that
are used to describe the items in more detail. Typical attributes are Name, Type,
Description/Definition and Last change. Certain attributes, such as Name and
Description/Definition, are set by the user. Other attributes, such as Type, and Last
change, are set by the system. You cannot change attributes set by the system.
Attributes can be used in many ways. Depending on the value of the attributes, decisions can
be made, for example, who is responsible for executing an activity, which follow-up activities
are necessary, and in which context an item is relevant.
In addition, there are attributes that take time zones into account (page 1153).
B
BEARER AUTHENTICATION
HTTP authentication scheme that involves security tokens. These tokens are called bearer
tokens (page 1124). This authentication can be understood as give access to the bearer of
this token.
BEARER TOKEN
Bearer tokens are used in combination with bearer authentication (page 1124).
The bearer token is a cryptic string, usually generated by the server in response to a login
request. The client must send this token when request access to protected resources.
BPMN
Business Process Model and Notation (BPMN) is a graphical notation used to describe
business processes.
1124
BUSINESS STATUS
In addition to the technical status for process instances, users such as process designers can
use the Business status to filter, find, and monitor process instances. The Business status
is displayed in ARIS Process Board, My tasks, as well as in views and filters of process
administration (page 595), if the Business Status variable is added to the variable catalog.
For mini workflows and micro workflows, the business status are implemented by default,
such as Waiting for approval. For detailed information, refer to Add 'Business Status'
variable to variables catalog in the online help of ARIS Architect.
C
CHANGE LIST (VERSIONING)
ascending order.
CHANGE LIST NUMBER (VERSIONING)

Number and description of a version of the database content. Change list numbers can be
used to select versions for viewing (page 1157). You have only read access to the content.
Change lists are sorted in ascending order.
COMPARISON MODEL
Model that is generated for comparison purposes from two models, which exist in different
versions (page 1157) or are connected to each other by a variant relationship (page 1156).
CONFIGURATION SET
A configuration set specifies the graphical user interface of ARIS. Configuration sets are
based on XML files and cannot be changed within ARIS, but only in the relevant XML file. By
default, ARIS provides the classic configuration set and the default configuration set.
You can specify a modification set (page 1145) based on a configuration set.
1125
CONFIRMATIONS
With confirmations, a company can prove that users were informed about published ARIS
content or related changes, for example, changes in guidelines or processes, and that the
employees confirmed to adhere to these. Confirmations can be used, for example, for audits,
corporate governance systems, or a quality management system.
CONFIRMATION PROCESS
A confirmation process is automatically generated by the confirmation process scheduler
(page 1126) at the specified start date. For detailed information, refer to What is a
confirmation process.
CONFIRMATION PROCESS SCHEDULER

A confirmation process scheduler automatically generates the confirmation process and the
confirmations at the specified start date. It can be defined that the process is generated only
once or that the process is generated recurrently, for example, quarterly or annually. For
detailed information, refer to What is a confirmation process.
CONNECTION
A visible relationship (page 1148) between objects (page 1146) that shows how objects relate
to each other. This graphical representation of a relationship is created during modeling.
A connection is usually represented by lines in the modeling area. If a direction is relevant, the
line has an added arrow. One example is the connection of the is predecessor of type
between functions in models of the EPC (event-driven process chain) type.
CONNECTION, IMPLICIT
Invisible connection.
Implicit connections are created if the Create implicit connections for overlapping objects
option is enabled and objects are placed within objects. In the displayed dialog, you can
decide whether to hide any connections and, if so, which connections to hide for these
objects. The difference between implicit connections and implicit relationships is that an
implicit connection can be represented by a line in the modeling area. This line is displayed
again, for example, if you drag an object from another object down into the free area of the
modeling area.
Example of implicit connections:
1126
Place a function on another function in a model of the EPC type.
In an EPC (column display) model type, place an organizational unit and an application
system in the Carries out & Supports column of the Organizational elements &
Application system row. Then place a function in this column.
Two implicit connections are created automatically. The implicit connection is responsible
for from the organizational unit to the function and supports from the application system to
the function.
This needs to be differentiated from implicit relationships (page 1149).
CONTENT TYPE CONFIGURATION

If enabled and the relations are specified, you can model relations using the Properties panel
of ARIS and the Connected objects tab of the Properties bar in ARIS Architect.
1127
CRON EXPRESSION
String consisting of six to seven fields that is separated by a space and represents a time.
Normally, a CRON expression is used to define routine jobs that are executed automatically at
certain times by the system.
Fields
 Seconds, mandatory field, valid value: 0-59, valid characters: *, /, , -.
 Minutes, mandatory field, valid value: 0-59, valid characters: *, /, , -.
 Hours, mandatory field, valid value: 0-59, valid characters: *, /, , -.
 Day in month, mandatory field, valid value: 0-59, valid characters: *, /, , -.
 Month, mandatory field, valid value: 0-12 or JAN-DEC, valid characters: *, /, , -.
 Day of the week, mandatory field, valid value: 0-7 or SUN-SAT, valid characters: *, /, , -, ?,
L, C, #.
 Year, not a mandatory field, valid value: 1970-2010, valid characters: *, /, , -.
CSS
Cascading Style Sheets is a style sheet language used for describing the presentation HTML
documents.
CURRENT VERSION/LAST VERSION (VERSIONING)

Corresponds to the last versioned database content. This version includes the entire
versioned content of a database. You have only read access to the content.
In principle, this is the last change list (page 1125) created for a database (versioning state
(page 1157)).
D
DASHBOARDS
Dashboards are interactive applications that collect, combine, and visualize data from
different data sources, for example, ARIS table or CSV files. Dashboards are composed of
individual widgets (for example, line chart or grid). They obtain their data from data sources
and display them.
Dashboards make it easy to visualize and analyze information. You can combine data from
any original source and visualize them using graphic elements, filter the displayed results
interactively and thus analyze them intuitively.
1128
DATABASE
On each tenant different sets of databases can be managed.
DEFINITION COPY
Copy of the object definition, that is of the entire object, rather than just the occurrence
(page 1147) as is the case with the occurrence copy (page 1147).
The definition copy creates a new object. The occurrence, which is created when creating the
definition copy, refers to the new object.
You can create copies of objects. When copying an object, you can decide whether you wish
to create a new object (a definition copy) or a new object symbol for an existing object (an
occurrence copy).
It makes sense to create a definition copy for an existing object if a new object is to have
properties similar to those of the source object.
For example, you have modeled the object Plant 1 and specified its properties. You now wish
to create the object Plant 2, which has properties similar to Plant 1. In this case, it is advisable
to create a definition copy of Plant 1. Object Plant 2 is thus given all the properties of object
Plant 1, but exists independently of it. You now simply need to change the properties that
differ from those of object Plant 1, for example, by changing the name to Plant 2.
This involves significantly less work for you than creating the object from scratch and having
to enter all the properties again.
Some attributes are not copied when the definition copy is created. For example, it does not
make sense to copy the identifier of an object because the identifier represents a unique ID of
an object.
E
ESCALATION MANAGER
The escalation manager is the user who is notified when a human task is not completed by
any executor by the due date. It is specified in the data flow diagram or in the model using an
organizational element and the is escalated to connection.
1129
EVALUATION FILTER
An evaluation filter reduces the number of database elements to be analyzed. For example,
when you run a report, you can restrict the method content for evaluation by using an
evaluation filter. The method content is restricted to the content that is activated in both the
method filter you used when logging in to the database and the evaluation filter you selected.
The advantage of evaluation filters is that the running time of a report is reduced and that
only relevant content is included in comprehensive processes.
F
FACT SHEETS
Fact sheets show facts about an item in various views. Facts can be displayed in text form or
graphically. Facts in text form are, for example, item descriptions or lists of elements that are
structured in tables. In ARIS, you can assign fact sheets to various items (page 538), such as
processes, functions, events, and documents.
In the Classic and Default views delivered with ARIS as standard the following fact sheets
are assigned to a process:
OVERVIEW
Gives an overview of the item selected, for example, displays variant relationships of the
selected item or the content of a selected group.
1130
If you have selected a model, additional headings are shown depending on the context.
Content that can be used to navigate to other content is displayed as links.
DOCUMENTATION
The Documentation fact sheet provides supplementary internal and external information on
models and objects. The Documentation fact sheet is visible to users when information is
provided for a model or an object.
1131
STEPS
Transparently displays all steps of a process model. Regardless of the process size, you can
view only the previous, current, and subsequent process steps. For the current step, the
relevant information is provided in the form of links.
You can easily navigate to the top of the Steps fact sheet and you can easily navigate
between the Steps and the Diagram fact sheet.
The following information is provided for operators:
Information Operator Symbol
AND
all paths are relevant OR/AND
XOR/AND
AND
one or more paths are
possible
OR/AND
1132
Information Operator Symbol
XOR/OR
XOR
AND/XOR
exactly one path is relevant

OR/XOR
Gateway
complex decision Rule
TABLE
To open the Table fact sheet, click Application launcher > Published content,
navigate to the database group in which the process model is saved, such as EPC and BPMN
processes, and click the model name and Table.
The Table fact sheet lists the functions that a process of type EPC and BPMN contains, as
well as the roles assigned to them. In the tables, you can add columns and remove added
columns again.
You can sort the functions in different ways by clicking the column title.
1133
You can open a matrix based on the Table fact sheet to clearly display the interrelations
between the individual roles and functions.
RACI
A RACI matrix displays the activities (functions) of a process and the associated
organizational responsibilities. A RACI matrix is only displayed if RACI information is available
for a selected process model. You can sort the functions of a matrix .
1134
DIAGRAM
To open the Diagram fact sheet, click Application launcher > Published content,
Navigate to the database group in which the model is saved, and select the model name and
Diagram.
The Diagram fact sheet displays the diagram graphically. Depending on the diagram type,
different functions are available.
 You can find model items ( ) in the diagram. Click Properties to show the properties
of a model or a model item.
 You can open assigned models ( ).
 You can change the view of the diagram ( ) to show the aspects you want to focus on.
 To change the size of diagrams, use the view bar ( ).
You can switch on mini fact sheets ( ) to display object information.
1135
DASHBOARDS
Shows the dashboards available for the selected diagram.
The Dashboard fact sheet is shown to users who have the ARIS Aware license (page 38).
TASKS
Shows your tasks created by mini workflows or Process Governance processes. For editing,
selected tasks are opened in My tasks.
EXECUTABLES
Executables are displayed in Published content if you are using ARIS for SAP Solutions and if
this function has been configured (page 679).
1136
You can start the executable automatically via the default server in each row displaying a
Transaction code. Click the arrow head to display all registered SAP Servers. The default
server selected is indicated by a check mark.
To start the executable, click an SAP Server or a URL. The Login dialog opens.
Log on to the SAP system in the current language and the executable starts. The login
remains valid until you log out of the portal or enter different login data. To delete the current
SAP logon data, click the arrow head and then Reset logon data. For the next executable
start, you need to log on to the SAP system again.
1137
If you click an executable on the Executables page, such as SDQ1, its fact sheet (page 1130)
including detailed information is displayed. If documents are available, you will be able to
download them.
DOCUMENTS
Lists documents assigned to models, for example, by the Link 1 - Link 4 attributes. The list
displays the latest approved version of each document. These documents are stored in ARIS
document storage. Click a document to download it. You can open the downloaded
document.
Confirmations
The following fact sheets are assigned to matrix models:
Overview
Matrix
Tasks
Documents
Confirmations
1138
FOCUS
Selection marker that marks the item that is selected. There are certain occurrences of
selection markers, such as text cursors.
The focus is usually surrounded by colored frames, which can be dashed or solid.
You can often start actions for the selected items using the Enter key or the space bar.
FONT
Set of text characters in a specific style and size. The type design of fonts is the typeface. For
example, ARIAL is a typeface family, ARIAL bold is a typeface, and ARIAL bold 12 point is a
font.
FULLY-QUALIFIED HOST NAME (FQHN)

The fully-qualified host name (FQHN) is the host name that is specified as the IP address of a
computer or as a fully-qualified domain name (FQDN) in the following form:
my.department.example.com.
FUNCTION PRIVILEGE
Control tasks that users can perform.
You can assign function privileges to provide users and user groups with specific
functionality and thus control their authorizations across a database. You assign function
privileges for databases in ARIS Architect on the properties pages of users or user groups. In
ARIS Administration, administrators manage users, user groups, cross-database and
cross-product privileges and licenses for all ARIS products.
G
GDPR
The General Data Protection Regulation (GDPR) protects individuals’ personal data within the
European Union. It also regulates the export of personal data outside the EU. GDPR is a
regulation by the European Parliament, the Council of the European Union, and the European
Commission.
GEOGRAPHICAL MAP
A geographical map is a representation of the Earth upon a flat surface.
1139
GEOJSON
GeoJSON is an open format to represent geographic data. The JavaScript Object Notation is
used for this.
GRAPHIC OBJECTS
Graphic elements without implicit semantic meaning. They can be used, for example, to
indicate model areas, to specially highlight objects that are thematically linked, or to prepare
models so that they are suitable for presentation.
Graphic objects include circles, ellipses, squares, rectangles, lines, and polygons.
GRID
Placement marks in the modeling area in the form of dots that you can show for modeling
support.
Placement marks indicate the minimum spacing between one model item and another. If you
move an item, it is moved accordingly by increments of one gridline.
GROUPING
Grouped model items.
Grouped items can be moved, enlarged, or reduced, and deleted as if they were one item.
GUID
Globally Unique Identifier (GUID).
The GUID is a string that renders items unique anywhere in the world.
I
IMPERSONATION
Impersonation enables a user to perform actions on behalf of a different user account, for
example, backup and restore tenants. This requires the creation (page 72) of a user in the user
management for the infrastructure tenant, for example, master. This user must be assigned
all licenses and privileges that are needed for the action.
INFOGRAPHICS
Infographics (also information graphics) are visual representations of content. By combining
images and text, it is easy for users to understand the information contained.
Infographics can simplify complicated topics. The data is displayed quickly and clearly.
1140
INFRASTRUCTURE TENANT
Specifies the tenant with special privileges for managing other tenants, components, and the
By default, the master tenant is the infrastructure tenant. The system users system and
superuser have administrative privileges, that is, they can access ARIS Administration and
Tenant Management.
Users with the relevant privileges can specify other infrastructure tenants in ARIS
Administration.
J
JAAS
Java Authentication and Authorization Service (JAAS).
A Java interface that enables you to provide services for authentication and access privileges
in Java programs. JAAS supports user-based authentication.
KERBEROS
A distributed authentication service for open and insecure computer networks.
JSON
JavaScript Object Notation
Compact data format in an easy-to-read text form for data exchange between applications.
Any valid JSON document must be a valid JavaScript and be interpretable.
L
LANE MODEL
Synonym for Swimlane model.
Model displayed in columns/rows or as a table.
Lanes are columns and/or rows. They include only specific object types and they structure
the modeled information. An implicit relationship is often created between objects in a row.
A model of the EPC (table display) type is a lane model.
1141
LAST VERSION/CURRENT VERSION (VERSIONING)

Corresponds to the last versioned database content. This version includes the entire
versioned content of a database. You have only read access to the content.
In principle, this is the last change list (page 1125) created for a database (versioning state
(page 1157)).
LDAP
Lightweight Directory Access Protocol (LDAP).
Application protocol from network technology. LDAP enables information from a distributed,
location-independent, and hierarchical database in a network to be queried and modified.
LESS
Leaner Style Sheets is a dynamic preprocessor style sheet language that can be compiled
into Cascading Style Sheets (CSS) (page 1128).
In addition to the normal CSS instructions, LESS offers nesting of rules, which can avoid code
repetitions.
M
MASTER
Model/Object from which a model/object is derived.
A variant relationship (page 1156) exists between the master and the derived model/object
(variant (page 1156)).
MASTER OWNER
Role in the context of variant management (page 1156).
A user with this role creates a master model that is rolled out to model variants in different
regions in the context of variant management. Variant owners (page 1156) adapt the model
variants.
1142
METHOD FILTER
Filter restricting the total number of ARIS Method items and thus offering only those items for
modeling that are required.
By applying a specific method filter, only the model types included in this method filter will be
offered for selection when creating new models. When modeling, all object, connection, and
attribute types are available for the model types that are contained in the method filter. Thus,
the content offered is exactly the content you need for performing your tasks. Method filters
are an effective means of supporting uniform modeling and make it possible to provide users
with only the information and methods relevant to them.
MINI TOOLBAR
Toolbar of objects used for placing and drawing connections.
It is displayed if you have disabled Smart Modeling and select an object in the model.
MODEL
Models are a collection of objects (page 1146) and connections (page 1126). Models are
graphic representatives of processes, structures, data, etc. of a company. Models, objects,
and connections are described in detail by attributes (page 1124). While objects represent
activities, states, data, etc., connections represent how objects relate to each other.
Models are based on model types (page 1145) that specify certain rules, such as which
connections are allowed between objects and thus, how they relate to each other.
MODEL TEMPLATE
all relevant models. When users assign templates to models, the settings made in the
templates overrule all default settings for models and contained elements as well as
database-related settings, such as font formats. All new objects and connections added to
A template assigned to a model type is automatically applied to newly created and imported
models of this model type.
1143
Moreover, you can assign multiple templates to models. All changes from templates are valid
that are assigned one after another. This means that you can assign a template to a model to
change the size of objects, for example, and another that places the required attributes above
the objects. Both changes take effect.
1144
MODEL TYPE
A template that defines which objects a model (page 1143) can contain and how these objects
relate to other objects. It defines the context in which the derived models are relevant.
The model type EPC, for example, defines the context Process because the objects it
contains reflect the sequence of states, activities, and changed states, among other things. In
contrast, models derived from the model type Organizational chart are located in the
context Organization; they visualize the organizational structure of a company, for example,
which organizational units exist, how organizational units are linked hierarchically, who
manages the organizational units, and who is assigned to them.
MODIFICATION SET
A modification set is a copy of a configuration set (page 1125). A modification set can be
edited by administrators to adapt the graphical user interface of ARIS to their own needs.
Administrators create (page 501) and enable custom modification sets for you based on the
classic configuration set or default configuration set to change the appearance of the portal.
The modification sets are displayed indented under the respective configuration set that
served as a basis.
MY TASKS/TRACKING
 My tasks
My tasks is used for editing tasks that are provided by Process Governance during
process execution. The list of tasks that you are responsible for in terms of processing are
displayed. Use the filter to limit the list.
 Tracking provides an overview of a user's active tasks.
Displays the active tasks that you triggered by starting the process. As soon as a task is
completed and the next task in the process is active, the completed task is removed the
list.
1145
O
OAUTH 2.0
The ndustry-standard protocol for authorization. OAuth 2.0 focuses on client developer
simplicity while providing specific authorization flows for web applications, desktop
applications, mobile phones, and living room devices.
OBJECT
An object is a container for information. Its information content is supplemented by attributes
(page 1124), Thus, an object represents a given situation, an activity, a status, etc. For
example, it represents a work step or an organizational unit of a company. Linked together in
models (page 1143), the occurrences (page 1147) reflect the reality of companies.
An object consists of a definition (page 1146) and an occurrence (page 1147), derived from an
object type (page 1146).
OBJECT DEFINITION
Object in the database for which you specify all relevant attributes.
Object definitions are displayed in models as an object occurrence (page 1147) using the
selected default symbols. All the object definitions in a database make up the object library
(page 1146). When modeling, object definitions are automatically created in the group in which
the model is saved. Object definitions can also be created in Explorer.
OBJECT LIBRARY
Collection of object definitions (page 1146) in a database. Object libraries provide modelers
with the required objects. This ensures that only allowed objects actually occur in models.
If you are using object libraries, you should create an occurrence for each object in the library
in an overview model. This ensures that all object definitions occur and are not accidentally
deleted during the consolidation of the database.
OBJECT TYPE
Object types characterize the type of objects (page 1146) that are permissible within a model
type (page 1145). Object types of the EPC (Event-driven process chain) include Event,
Function, and Rule, for example.
Object types represent different procedures, activities, states, etc. For example, the Function
object type can represent both the Send delivery note activity and the Check parts
availability activity. Therefore, it represents a technical task or activity to support one or
more business objectives. You define a function by placing it in the modeling area and
assigning attributes to it, for example, name, costs, or times. The function then describes a
1146
specific task. A model type contains structurally non-relevant and structurally relevant object
types.
An object type can occur in multiple model types. For example, the Function object type
occurs in the Function tree model type which represents the hierarchical structure of
functions. Functions are also used in the EPC model type which represents functions in their
chronological-logical order.
OCCURRENCE
Graphical representation of objects, connections, and free-form texts.
It is used to represent items in a model.
With an occurrence copy (page 1147), several occurrences of an object can be created. These
can differ within a model and/or in different models, that is, object symbol, size, color, and
attribute placements can be set individually and thus be different.
If the placed text attributes of an occurrence are changed, the changes are applied to all
occurrences at which the text attribute has also been placed. For example, if the name of an
object is changed, the change is displayed for all occurrences.
OCCURRENCE COPY
Copy of the occurrence (page 1147), that is, only the graphical representation of an object,
rather than the entire object as with the definition copy (page 1129).
All occurrence copies of an object represent the underlying object definition.
You can create copies of objects. When copying an object, you can decide whether you wish
to create a new object (a definition copy) or a new object symbol for an existing object (an
occurrence copy).
It is helpful to create a copy of the object symbol for an existing object - that is, only a copy of
the occurrence of an object - if exactly the same object is used at various positions in the
model or in different models.
For example, if, in the model, you are creating, Plant 1 supplies goods at various points of the
model, it is advisable to use occurrence copies at these points. These refer to the same
object, and any changes to this object apply to all occurrence copies.
If you want to rename Plant 1 to Plant A, for example, you only need to do this for ONE of the
occurrences: The names of all other occurrences are simultaneously changed to Plant A.
1147
OTP
One-Time Pad (OTP).
This one-time pad is a symmetric encryption method for transferring secret messages. This
encryption method is characterized by the fact that it uses a key of the same length as the
message itself.
The OTP is information-theoretically secure and has proven to be impossible to crack –
provided that it is used properly.
P
PERSONAS
Personas are fictional characters that characterize the features of people of a target group.
Personas are used to illustrate the differences between user types.
In the customer experience environment, a persona represents a customer segment and its
main characteristics. Each persona provides a specific set of information describing that
person representing a user type in more detail.
PROCESS MODELS
Process models represent a sequence of processing steps (functions/activities) as well as
changes of state (events) that result from the processing steps.
For example, a process step is Correct customer data, the change of state is Customer
data is up to date.
Models of the type EPC and BPMN process belong to process models.
R
RELATIONSHIP
Connection that can exist between model elements and among models.
Relationships include connections (page 1126), implicit connections, implicit relationships
(page 1149), assignment (page 1124), and variant relationships. Therefore, the term
relationship is a superordinate term for all links that can exist between objects and models.
1148
RELATIONSHIP, IMPLICIT
Assignment relationship, that is, a relationship between objects for which no visible
connection is drawn.
You create this relationship by assigning a model to an object.
This needs to be differentiated from implicit connections.
REPORT
A report is a script that can be applied to similar database content. You can use a report, for
example, to collect database content and group it according to specific aspects, output the
relationships (page 1148) between database elements, generate comparison tables, or display
multiple uses of database items. You can also use reports to change database content, such
as entering attribute (page 1124) values or correcting the layout of models (page 1143).
ROOT ELEMENT
Model or object that is used as the top element in a hierarchy in the portal. This element is
displayed when you open the hierarchy in the portal.
RUNNABLE
ARIS server component providing functionality to the ARIS clients. Runnables are physically
installed on a node.
Depending on the ARIS server type different runnables are used to provide full functionality.
Runnables can be managed using ARIS Cloud Controller (ACC). The InstanceID of the ARIS
Server program component is used as the name for the runnable.
S
SAML
Security Assertion Markup Language (SAML).
XML framework for exchanging authentication and authorization information. SAML provides
functions to describe and transfer security-related information.
1149
SATELLITE
A satellite is an object that can be inserted in a model or diagram but is not structurally
relevant (page 1151) in the model or diagram.
For example, an object of the Organizational unit type is a satellite in an event-driven
process chain (EPC). In a model of the Organizational chart type, on the other hand, an
object of the Organizational unit type is a structurally relevant object.
SCIM
The System for Cross-domain Identity Management is designed to facilitate the management
of user identities in cloud-based applications and services.
ARIS supports SCIM 2.0.
SEMANTIC CHECK
A semantic check is a script that contains modeling conventions. It can be applied to models
(page 1143) and indicates whether the modeling conventions have been followed. If the model
does not adhere to the rules, the check shows detailed error descriptions, warnings, or notes.
SINGLE LOG-OUT (SLO)

The advantage of using SLO is that users need to log out only once from the network.
SINGLE SIGN-ON (SSO)

With SSO or single sign-on the user only needs to authenticate himself once with his user
name and password to access all services, programs and computers without logging in again.
If services, programs, and computers request a new authentication when accessed by the
user the authentication is carried out by the underlying SSO mechanism.
SSL
Secure Socket Layer (SSL).
Security software for encrypting data that is exchanged between programs.
START MODEL
A start model is a model that serves as an entry point into a database. It is useful to use the
model to represent the structure of a database. You can use assigned models (page 1123) to
enable users to jump to the various areas of the database. Only one model per database can
be set as the start model. By setting a model as the start model, it will be displayed in Home.
1150
STRUCTURALLY RELEVANT OBJECTS

Basic model objects.
These are objects that indicate the distinctive feature of a model. For a model of the
Organizational chart type, the objects Organizational unit, Role, and Person are
structurally relevant objects, for example. Using these items, you can build the typical
hierarchy of an organizational chart.
The Event and Function objects are typical for the EPC model type (page 1145) and are thus
structurally relevant to a business process. You can use these to establish a typical control
flow. The Organizational unit, Role, and Person objects can also be inserted into an EPC.
However, these objects do not constitute the distinctive feature of a business process. As
structurally irrelevant objects, they act as satellites and add more detailed information to the
process model. For example, you can insert organizational units and link them to functions
to illustrate who carries out those functions.
An object that can be inserted in a model or diagram but is not a structurally relevant object is
known as a satellite (page 1150).
SUPERUSER
The user superuser is created automatically. By default, this user is assigned the User
management, License management, and Configuration administrator function privileges.
This user can also enable this function privilege for other users. Users of the superuser type
do not use up a license. They manage the system administration, but cannot use ARIS
products due to license restrictions. The default password is superuser. You should change
the default password to prevent unauthorized access. The password of the superuser is very
important, as it is the only user who cannot be deleted. You can change all user data except
for the user name. The superuser can recreate the other default users (system, arisservice,
guest) if they were deleted.
SVG
Scalable Vector Graphics.
SVG defines vector-based graphics in XML format.
1151
SYSTEM DATABASE
This database manages the content of a tenant located in the Configuration and
Evaluations folders, which is displayed on the Administration tab in ARIS Architect. This
content includes filters, templates, fonts and font formats, but also ARIS Method and all
common files, report scripts, scheduled reports, semantic checks and macros.
The system database is created automatically while the first user is logging in to ARIS. The
content is available to all databases of this tenant. The ARIS Service Administrator commands
backupsystemdb, restoresystemdb, and updatesystemdb can be used to save and
restore this data centrally.
SYSTEM USERS
System users are users who have all function and access privileges in a database and who
have the required privileges (page 22) in the ARIS Administration. System users can be
created by the system administrator (user system) or by another system user.
The system user system is created automatically. This user has full access to all databases of
a tenant. The name system cannot be changed. A system user should immediately change
the password manager in ARIS Administration to prevent unauthorized access. The function
and access privileges of tenant-wide system users cannot be changed at database level. To
withdraw privileges from a system user of a single database, another system user must
disable (page 24) the System user check box on the user's Function privileges properties
page in ARIS Architect. As a result, the user's privileges can be changed. After this, the user
has no access privileges.
The system user system assumes the administrator role of the system administrator and has
all function and access privileges in all databases of a tenant. Authorized persons can use this
emergency user to log in to any database, even if you are using an external system, such as
LDAP (page 1142), for authentication.
The name system cannot be changed. The System user check box for this user (Function
privileges properties page in ARIS Architect) cannot be disabled either. You should
immediately change the password manager to prevent unauthorized access.
To avoid problems, you should create (page 24) additional system users. Having more than
one system user can avoid problems, for example, if one system user has forgotten his
password. If you forgot the passwords of all your system users, the full range of functions is
no longer available and full data access is no longer possible.
1152
T
TAG
Keyword or term assigned to information, such as an Internet bookmark, a digital image, a
database record, or a computer file. This kind of metadata helps describe an item and allows it
to be found again by browsing or searching.
TENANT
A tenant is a container providing its own ARIS Administration (page 1122) and ARIS data set,
such as configuration, ARIS method, databases, scripts, etc.
Each tenant provides users with a particular set of functionalities and specific data
depending on their licenses and privileges.
TILE SERVERS
A tile server is the service that generates rendered images (tiles) from a database. The tile
server hosts the Open Street Map (OSM) data.
TIME ZONE-DEPENDENT ATTRIBUTES

Time zone-dependent attributes are attributes (page 1124) that take the current time zone
into account when they are displayed. The values of the attributes are adjusted depending on
the time zone in which they are displayed.
Time-zone dependent attributes are:
 Time of generation: AT_CREAT_TIME_STMP
 Last change: AT_LAST_CHNG_2
 Time of last semantic check: AT_TIME_OF_LAST_SEMANTIC_CHECK
 (Internal attribute: AT_TIME_STAMP)
STORING
In the database, these attributes are stored in Greenwich Mean Time (GMT + 0). When the
attributes are displayed to users in the attribute editor, designer, Diagram fact sheet,
etc., they are first converted to the client's local time.
When the values are changed by a user in his local client time zone, the values are
internally converted to GMT + 0 and stored in the database.
REPORTS
When a report is started from a client, the client's time zone is transferred to the server.
The server converts the time zone-dependent attributes when creating the output.
1153
When a report is run as a scheduled report, no client information is available and no

conversion can be performed. Therefore, the time zone-dependent attribute is displayed
as if the server were in the GMT + 0 time zone.
REPORT SCRIPT API

You should always use the methods accepting a string as a parameter to change the
value of time attributes. Example:
oDef.Attribute(Constants.AT_SAP_TIME_GEN, 0).setValue("07:12:45;11/19/2018");
RECOMMENDATION
We recommend not using java.util.Date, especially the setValue() methods, which
accept a Date object as a parameter: most of the various constructors of Date perform
automatic conversion depending on the client's time zone. Converting a date to a
character string, for example, via toString(), also performs conversion to the client's time
zone.
Example
This example assumes that both users are accessing the same server.
A user in Germany creates an object on Nov. 19 2018 4:12PM. (Based on his operating
system local, the creation time is displayed as 19.11.2018 16:12.) If another user located
in San Francisco looks at the Time of generation attribute, the value is not Nov. 19 2018
4:12PM, but Nov. 19 2018 7:12AM, because San Francisco is 9 hours behind German
time.
TLS
Transport Layer Security (TLS).
TLS is known under the name of its predecessor Secure Sockets Layer (SSL) and is an
encryption protocol for the secure transfer of data on the Internet.
U
UML (UNIFIED MODELING LANGUAGE)
UML is a graphical modeling language for specifying, constructing, and documenting
software, parts of software, and other systems. This "unified" modeling language specifies
the notations of the modeling terms and their relationships. It also defines the graphical
notation, the static structures, and the dynamic processes.
1154
URI
Uniform Resource Identifier. A string that is used to uniquely identify an abstract or physical
resource.
URIs are used to describe resources (such as Web sites, other files, calls for Web services) on
the Internet.
URIs can be incorporated as a string (encoded with a character set) into digital documents,
particularly those in HTML format, or written by hand. A link from one Web site to another is
called a hyperlink.
URL
Uniform Resource Locator, a particular type of URI (page 1155) (Uniform Resource Identifier).
URLs identify a resource via the network protocol used (for example, http or ftp) and the
location of the resource (for example, of a service) in a network.
The term URL is often used synonymously with URI because URLs were the first and are still
the most frequently used type of URI.
URL ALIAS
Defining a URL alias enables you to shorten the link used in dashboards and data feeds. If you
use an alias, you only specify the path to the location where the data is stored. You do not
need to enter the entire URL. Furthermore, adapting the alias enables you to import this kind
of data to a different server.
If you have updated ARIS 10.0 Service Release 1 to version 10.0 Service Release 2, you need to
recreate the URL alias that WAS defined for ARIS 10.0 Service Release 1. Delete the URL alias
at first and add a new URL alias with the same data.
USER GROUP
Group for users with the same user profile, for example, Designer.
You can create a user group to which you assign the license, function, and access privileges
of the user profile. All users you assign to the user group get the license, function, and access
privileges of the user group.
USER NAME
Name of a user (for example, system) for access to a database. The user name does not
necessarily have to correspond to a person's real name.
Access to a database is possible if a user logs in to it with the combination of user name and
password that has previously been stored for the database. This is the case when the system
administrator or a user with the User management function privilege creates the new user.
1155
USER 'SYSTEM'
The system user system assumes the administrator role of the system administrator and has
all function and access privileges in all databases of a tenant. Authorized persons can use this
emergency user to log in to any database, even if you are using an external system, such as
LDAP (page 1142), for authentication.
The name system cannot be changed. The System user check box for this user (Function
privileges properties page in ARIS Architect) cannot be disabled either. You should
immediately change the password manager to prevent unauthorized access.
To avoid problems, you should create (page 24) additional system users. Having more than
one system user can avoid problems, for example, if one system user has forgotten his
password. If you forgot the passwords of all your system users, the full range of functions is
no longer available and full data access is no longer possible.
V
VARIANT
Model/Object "derived" from another model/object, known as the master (page 1142).
The derived model/object has a reference to the GUID (page 1140) of its master, known as the
variant relationship (page 1156).
VARIANT MANAGEMENT
A procedure by which (master processes (standard processes) are rolled out to regions. In the
regions, the master process are adapted to the regional conditions. This ensures that the
approved, standardized process is executed across country borders. The master owner (page
1142) creates the master model, the variant owners (page 1156) create the model variants.
VARIANT OWNER
Role in the context of variant management (page 1156).
A user with this role creates and adapts the model variant of the master model and thus
makes the standard process released by the master owner (page 1142) available to other
users on a region-specific basis.
VARIANT RELATIONSHIP
Reference in a variant to the GUID of its master (page 1142).
When you create variants of objects or models, they receive a reference to the GUID (page
1140) of their master. The model or object created as a variant can be changed as required,
1156
irrespective of the master item. However, the master model/object and the model/object
variant "know" each other. With variant relationships, you can use scripts, for example, to
evaluate differences between items.
VERSION
A version is an image of a model that represents the unique state of the model at the time it
was versioned in a change list (page 1125).
A version represents a modification of a model and, for example, in Release Cycle
Management, you can determine which version is valid from which point in time. Therefore,
versions cannot be modified.
The editable state of a model is Workspace (page 1158) and the last version created is the
current version (page 1128), and the other versions are associated with the Change list
numbers (page 1125) (Versioning state (page 1158)).
VERSIONABLE
Refers to databases that are prepared to save versions (page 1157).
When creating databases, you can specify that databases are to be prepared for versioning.
VERSION NUMBER
Number assigned to a model during versioning.
The number relates to the model whose versions (page 1157) are numbered in ascending
order.
VERSIONING STATE
Image of database content recorded at a certain point in time. Individual models, several
models, or all models of a database that are available at the time of versioning can be
versioned. The versioned content of a database is summarized in a change list (page 1125). A
versioning state can include models of different versions (page 1157) with different or
identical version numbers (page 1157) that represent a specific state.
Workspace (page 1158) represents the state of models and/or objects that is editable and has
not yet been versioned.
The current version (page 1128) or last version contains the changes that were last versioned.
It contains the revisions associated with the last change list number (page 1125).
1157
W
WEBDAV
Web-based Distributed Authoring and Versioning (WebDAV ) is a network protocol to make
files available over the Internet. Entire directories can be transferred and a version control is
also specified.
WIDGET
In ARIS, a widget is an interactive graphical dashboard component, such as a bar chart, grid,
or vector map, that visualizes data from various data sources, such as ARIS table or CSV files.
WORKSPACE (VERSIONING)
Indicates the database content that has not yet been versioned. It can be edited. See also
Versioning state (page 1157).
X
XML PROPERTIES
Properties in XML format support more extensive configuration, unlike relations and attribute
properties. When you save an XML property, the XML is validated.
1158
5 Legal information
5.1 Documentation scope

The information provided describes the settings and features as they were at the time of
publishing. Since documentation and software are subject to different production cycles, the
description of settings and features may differ from actual settings and features. Information
about discrepancies is provided in the Release Notes that accompany the product. Please
read the Release Notes and take the information into account when installing, setting up, and
using the product.
If you want to install technical and/or business system functions without using the
consulting services provided by Software AG, you require extensive knowledge of the system
to be installed, its intended purpose, the target systems, and their various dependencies. Due
to the number of platforms and interdependent hardware and software configurations, we
can describe only specific installations. It is not possible to document all settings and
dependencies.
When you combine various technologies, please observe the manufacturers' instructions,
particularly announcements concerning releases on their Internet pages. We cannot
guarantee proper functioning and installation of approved third-party systems and do not
support them. Always follow the instructions provided in the installation manuals of the
relevant manufacturers. If you experience difficulties, please contact the relevant
manufacturer.
If you need help installing third-party systems, contact your local Software AG sales
organization. Please note that this type of manufacturer-specific or customer-specific
customization is not covered by the standard Software AG software maintenance agreement
and can be performed only on special request and agreement.
5.2 Support
If you have any questions on specific installations that you cannot perform yourself, contact
your local Software AG sales organization
(https://www.softwareag.com/corporate/company/global/offices/default.html). To get
detailed information and support, use our websites.
If you have a valid support contract, you can contact Global Support ARIS at: +800
ARISHELP. If this number is not supported by your telephone provider, please refer to our
Global Support Contact Directory.
1159
ARIS COMMUNITY
Find information, expert articles, issue resolution, videos, and communication with other ARIS
users. If you do not yet have an account, register at ARIS Community.
PRODUCT DOCUMENTATION
You can find the product documentation on our documentation website.
In addition, you can also access the cloud product documentation. Navigate to the desired
product and then, depending on your solution, go to Developer Center, User Center or
Documentation.
PRODUCT TRAINING
You can find helpful product training material on our Learning Portal.
TECH COMMUNITY
You can collaborate with Software AG experts on our Tech Community website. From here
you can, for example:
 Browse through our vast knowledge base.
 Ask questions and find answers in our discussion forums.
 Get the latest Software AG news and announcements.
 Explore our communities.
 Go to our public GitHub and Docker repositories and discover additional Software AG
resources.
PRODUCT SUPPORT
Support for Software AG products is provided to licensed customers via our Empower Portal
(https://empower.softwareag.com/). Many services on this portal require that you have an
account. If you do not yet have one, you can request it. Once you have an account, you can,
for example:
 Download products, updates and fixes.
 Add product feature requests.
 Search the Knowledge Center for technical information and tips.
 Subscribe to early warnings and critical alerts.
 Open and update support incidents.
1160

ARIS Administrator User Manual

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ARIS Administrator User Manual

Uploaded by

Copyright:

Available Formats

ARIS

VERSION 10.0 - SERVICE RELEASE 18

3 Manage ARIS ........................................................................................................................................... 3

3.3.19.1 Change user password ................................................................................... 54

3.3.23.9.4 Customize HTML templates for multiple locales ............................ 97

3.6.1.2.1.20 Report: Output object information (table) ........................... 194

3.6.1.2.4.3.6 Report: Verify semantics of risks ................................ 231

3.6.1.2.12.1 Report: Output task list ........................................................... 280

3.6.1.2.15.29 Report: Export item data to tables ........................................ 313

3.6.1.2.22 PPM integration .................................................................................. 359

3.6.1.2.27.6 Report: 06 SAP Solution Manager 7.2 migration –

3.6.1.2.33.13 Report: SWIT - BPMN consistency check............................ 408

3.7.8.2 Display folder details .................................................................................... 465

3.8 Manage portal ........................................................................................................................ 497

3.9.7.2.7.11.1 Enable mini fact sheets ................................................ 539

3.9.7.7.2.2 Change order of filter items and properties ....................... 583

3.10.22.1 List processes and display instance/version .......................................... 616

3.11.12 Clean up and export activities ................................................................................ 653

3.16.10.2.5 Delete object content type ............................................................... 697

3.17.1.3 Use other symbols in model types ............................................................. 731

3.17.5.7 Use attribute type in other objects............................................................ 792

3.17.11.6.1.8 Change the set of allowed model types .............................. 844

3.21.6 Cancel report .............................................................................................................. 886

3.22.1.7.17.7 How to adjust timestamps related to ARIS document

3.22.2.2.12.4 Use templates ........................................................................... 968

3.22.2.10.12 Where to save backup files?........................................................... 1003

3.22.5.5.3.1.7 Run selected schedules ............................................. 1054

4 Glossary .............................................................................................................................................. 1121

5 Legal information............................................................................................................................. 1159

1 About this manual

3.1 Open ARIS Administration

ARIS video tutorial

3.2 Manage licenses

3.2.1 License types and dependencies

LICENSE TYPES FOR CLIENT PRODUCTS

Difference between 'Named user' and 'Concurrent user' license type

Concurrent user Named user

License volume Unlimited Limited number

Guaranteed login No Yes

Term of guaranteed login Current session Unlimited

DEPENDENCIES WITHIN PRIVILEGES

3.2.2 Consumed and expired licenses

WHEN IS A LICENSE CONSUMED?

3.2.3 Import and display license file

2. Click Licenses > Product.

3. Click Import license file. The corresponding dialog opens.

3.2.4 Enable or disable license monitoring

2. Click Licenses > Monitoring > Configuration.

3.2.5 Delete licenses

2. Click Licenses > Product.

5. Click Delete license file.

3.2.6 Create and activate license rule

2. Click Licenses > Monitoring > Rules.

9. For Aggregated weighting rule types, enter a Threshold.

15. Click Back. The Application management page is displayed.

3.2.7 License rule types

BASE & PEAK

DBP (DIGITAL BUSINESS PLATFORM)

3.2.8 Download and upload license rules

2. Click Licenses > Monitoring > Rules.

3.2.9 Generate License audit (password-protected) report

 License monitoring is enabled in Licenses > Monitoring > Configuration.

2. Click User management. The list of users is displayed.

3. Click Additional functions.