Transcription

ARISDOWNLOAD CLIENTCONFIGURATIONVERSION 10.0 - SERVICE RELEASE 18MAY 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 insubsequent 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 orregistered trademarks of Software AG and/or Software AG USA Inc. and/or its subsidiariesand/or its affiliates and/or their licensors. Other company and product names mentionedherein may be trademarks of their respective owners.Detailed information on trademarks and patents owned by Software AG and/or itssubsidiaries 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 athttps://softwareag.com/licenses and/or in the root installation directory of the licensedproduct(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, CopyrightNotices and Disclaimers of Third Party Products". For certain specific third-party licenserestrictions, please refer to section E of the Legal Notices available under "License Terms andConditions for Use of Software AG Products / Copyright and Trademark Notices of SoftwareAG Products". These documents are part of the product documentation, located athttps://softwareag.com/licenses and/or in the root installation directory of the licensedproduct(s).

DOWNLOAD CLIENT CONFIGURATIONContents1ARIS Download Client . 11.1Start ARIS Download Client. 11.2Configure ARIS Download Client .101.2.111.32Change the download path .2Change the configuration and logging path .3Change memory settings .4Use a different JRE .5Use server name as download folder name .5Configure the use of ARIS downloader .6Delete encrypted passwords. 7Make HTTPS connection mandatory . 7Enable SSL for ARIS Download Client .8Make TLS certificate available for ARIS Server .9Update certificate for ARIS Download Client applet . 10Logging .11Legal information . 122.1Documentation scope . 122.2Support . 12I

DOWNLOAD CLIENT CONFIGURATION1ARIS Download ClientUsers do not need a local ARIS Client installation (see ARIS Client Installation Guide). If ARISServer is installed, all authorized users can start ARIS Download Client using their browsersinstead.All necessary files are downloaded from the ARIS Server to a local directory. The systemchecks whether the ARIS download client already exists and still matches the client availableon this server. If needed, it downloads a new version of the ARIS Download Client, and thenstarts ARIS.This process requires a locally installed JRE. Settings from the ARIS Server configuration fileare passed to the configuration of the download client while starting the ARIS DownloadClient. The target directory and several settings can be configured (page 2) by anadministrator.If you are using Microsoft Internet Explorer, a Java applet can be used to start this processinstead. Other browsers are blocking Java applets due to security reasons. Up to ARIS version10.0.5, the use of a Java applet is configured by default. There is no need to change thedefault setting. If Java applets are blocked, an ARIS downloader JAR file is usedautomatically to start ARIS Download Client. You can force ARIS to only use ARIS downloaderand block Java applets (page 6).1.1Start ARIS Download ClientIf ARIS Server is installed, all authorized users can start ARIS Download Client using theirbrowsers.Prerequisite A Java Runtime Environment is installed on each computer from which ARIS DownloadClient will be started. Users need ARIS Architect or ARIS Designer license privileges. Users need function and access privileges according to their user roles. These privilegesare managed within the ARIS Administration as well as in ARIS Architect. If Java applets are not supported, the file extension .JAR must be assigned to the JRE onthe user’s computer.Procedure1.Open your browser and enter the link provided by your administrator:Syntax: http:// IP address or fully-qualified host name : load balancerport /# tenant name /homeYou must enter the port number only if the standard port 80 has been changed orredirected. The login dialog opens. Log in.1

DOWNLOAD CLIENT CONFIGURATION2.Click your user name (top right).3.Click Download Clients.4.Click the Start button beside the ARIS Download Client with which you want to work. Ifthe Java applet is used, ARIS Download Client starts immediately. Otherwise, an ARISdownloader JAR file is used.5.Save the ARIS downloader JAR file locally. The name of that file is a combination of theARIS Download Client product name and the server name. Therefore, for differentdownload clients different JAR files will be downloaded.6.Double-click the JAR file. The ARIS downloader starts. A progress dialog monitors theinitial download. The ARIS downloader checks whether the ARIS Download Client alreadyexists and still matches the client available on this server. If needed, it downloads a newversion of the ARIS Download Client. The Run ARIS dialog opens.7.Enter your user name and your password.8.Click OK.The ARIS Client is opened.1.2Configure ARIS Download ClientIf a user starts ARIS Download Client, all files are downloaded to a local directory.Administrators can change this location, as well as several other settings.WarningPlease change values in configuration files as described only if this is absolutely necessary. Ifchanges are not done correctly, they may cause severe issues. Possibly ARIS clients mightnot start or work reliably.1.2.1Change the download pathIf a user starts ARIS Download Client, all files are downloaded to a local directory. By default,on Microsoft Windows OS, all files are stored in subfolders of the user's profile, for example:%UserProfile%\ARIS10\DownloadClient\ the ARIS server's IP address or name You can also define the server name to be used for the folder name instead of the IP address(page 5).The folder size is about 200 MB per download, and grows with each update. If you are notabout to store the files in the user's profile, adm ave modified configuration files locally and document your modifications. After anupdate installation you can easily compare your saved file and copy the modified line intothe updated configuration file.Download clients do not store any passwords for any server connection. This affects all ARISservers in your system. All encrypted passwords are deleted from all configuration files.1.2.8Make HTTPS connection mandatoryBy default, the load balancer is set to allow both unencrypted HTTP (port 80) and encryptedHTTPS (port 443) access (see ARIS Cloud Controller (ACC) Command-line Tool.pdf). Youcan force all download clients of this ARIS Server to only use https connections (encrypteddata transfer TLS: Transport Layer Security, former called SSL: Secure Socket Layer).WarningIf you change settings in the arisloader.cfg file, the settings will be lost after an updatesetup.7

DOWNLOAD CLIENT CONFIGURATIONPrerequisite You have write access to the ARIS installation directory. A valid SSL certificate is imported to the jre of the ARIS Client. The certificate is available for ARIS Server (page 9). Please make sure that the certificateis compatible with the Java version of all ARIS Clients.Procedure1.Open the arisloader.cfg file ( ARIS installation path \server\bin\work\work abs s, m,or l \base\webapps\abs\downloadClient\config).2.Set the value of ForceSSL to true:ForceSSL true3.Save the changes.WarningWhen performing an update setup all modifications made manually in CFG or XML files willbe lost.Save modified configuration files locally and document your modifications. After anupdate installation you can easily compare your saved file and copy the modified line intothe updated configuration file.All download clients of this ARIS Server only use https connections. This option cannot bedeactivated by ARIS users. The option on the Login dialog cannot be changed.1.2.9Enable SSL for ARIS Download ClientEven with valid certificates (that contain the correct server and domain name) purchasedfrom a reliable certificate authority (CA), it may occur that the corresponding root certificateis not available in the JRE currently being used. As a consequence, the JRE is unable tovalidate the certificate and thus considers it as unknown in the same way it does withcertificates that were created internally. This is why you must add the certificate to thecertificate store of the JRE in use.If ARIS Download Client is started using an ARIS downloader JAR file but not the Javaapplet, you can easily roll out an enhanced cacerts file. Just place it into the JRE installationpath on the machine were the ARIS Server is installed.1.To roll out the certificate for ARIS Download Client, open your file browser and navigate tothe JRE installation path, for example, c:\Program Files (x86)\java\jre\bin. This directorycontains the keytool.exe file.2.To update the required certs file located in the JRE installation path \lib\securitydirectory, open a Windows command prompt in this directory and run the command:8

DOWNLOAD CLIENT CONFIGURATIONkeytool.exe -importcert -file pathToCertFile -alias certificateAlias -keystore ARIS installation path client\jre\lib\security\cacerts -storepass keystorePassword Replace all placeholders with the proper value. Aside from those mentioned above: certificateAlias This placeholder represents a name you give to your certificate. Name it in a way thatyou can easily identify your certificate from the selection in the cacerts keystore. keystorePassword This placeholder represents the password to the cacerts keystore. Do not use adifferent password as the default value changeit.3.Copy the cacerts file, that was changed ( JRE installation path \lib\security), into theon this location: ARIS installationpath \server\bin\work\work abs s m l \base\webapps\abs\downloadClient\configIf users start ARIS Download Client using an ARIS downloader JAR file, this cacerts fileis downloaded and used.Users must restart their ARIS Download Client. Sometimes users are required to restart theirbrowsers. This forces Java to re-read the cacerts keystore.1.2.10Make TLS certificate available for ARIS ServerBy default, the loadbalancer runnable is set to allow both unencrypted HTTP (port 80) andencrypted HTTPS (port 443) access. In order to use TLS (former SSL), the certificate must fitto the load balancer's host name. Otherwise, client connections in particular web browserconnections will fail due to an invalid certificate.OBTAINING A VALID CERTIFICATEIf you want to use TLS, you need a valid certificate for the server on which the load balancer isrunning. This certificate must be signed by a certificate authority (CA). Please make sure thatthe 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 trustcertificates signed by such a CA. If your company uses own CA, use a certificate from this CA and add this CA to the truststore of all clients.ADDING A VALID CERTIFICATE TO THE LOAD BALANCERYour certificate must contain two parts:9

DOWNLOAD CLIENT CONFIGURATION 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).3.Start ARIS Cloud Controller (ACC).4.Stop the loadbalancer runnable. Enter, for example: stop loadbalancer m5.Enter the ACC command enhance loadbalancer s, m, or l with sslCertificate localfile " 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 adouble backslash instead of a single slash. Alternatively, use single forward slashes, forexample: "c:/temp/lbcert.zip".6.Start the loadbalancer runnable again. Enter, for example: start loadbalancer mThe SSL certificate is available.If ARIS clients cannot perform connections to servers using TLS certification, you need toprovide an additional certificate (see: Basic Troubleshooting Guide).1.2.11Update certificate for ARIS Download Client appletThis procedure is to be followed only if the JAVA applet is used to start ARIS Download Client.Certificates are valid for a certain period of time. After this period certificates expire. If theJAVA certificate for the jar file that contains the applet on the ARIS Server has expired, youmust update it.You can update the certificates by replacing the y-aris-client-loader.jar file manually.Procedure1.Log in to the Software AG Download Center (https://aris.softwareag.com), either asGuest or with an existing account.2.Click Additional General.3.Download the ARIS.JavaCertificates.zip file.4.Select the folder where the downloaded ARIS.JavaCertificates.zip file is stored.5.Unzip the file and select the folder appropriate to your ARIS version, for example,10.0.4.1234196.10

DOWNLOAD CLIENT CONFIGURATION6.Use the contained y-aris-client-loader.jar file to overwrite the file in the correspondingfolder.The default ARIS Web Client Components directory is ARIS installationdirectory server\bin\work\work abs {s m l}\base\webapps\abs\downloadClient\lib. If you have chosen another installation path, the directory applies as appropriate.The certificates related to the Java applet are updated.1.3LoggingActivities considering the download or the start process of ARIS clients are recorded. Under%UserProfile%\ARIS version \log and %temp% you will find files, such asARISLauncher timestamp .log or StartARISFailed timestamp .log.11

DOWNLOAD CLIENT CONFIGURATION22.1Legal informationDocumentation scopeThe information provided describes the settings and features as they were at the time ofpublishing. Since documentation and software are subject to different production cycles, thedescription of settings and features may differ from actual settings and features. Informationabout discrepancies is provided in the Release Notes that accompany the product. Pleaseread the Release Notes and take the information into account when installing, setting up, andusing the product.If you want to install technical and/or business system functions without using theconsulting services provided by Software AG, you require extensive knowledge of the systemto be installed, its intended purpose, the target systems, and their various dependencies. Dueto the number of platforms and interdependent hardware and software configurations, wecan describe only specific installations. It is not possible to document all settings anddependencies.When you combine various technologies, please observe the manufacturers' instructions,particularly announcements concerning releases on their Internet pages. We cannotguarantee proper functioning and installation of approved third-party systems and do notsupport them. Always follow the instructions provided in the installation manuals of therelevant manufacturers. If you experience difficulties, please contact the relevantmanufacturer.If you need help installing third-party systems, contact your local Software AG salesorganization. Please note that this type of manufacturer-specific or customer-specificcustomization is not covered by the standard Software AG software maintenance agreementand can be performed only on special request and agreement.2.2SupportIf you have any questions on specific installations that you cannot perform yourself, contactyour local Software AG sales company/global/offices/default.html). To getdetailed information and support, use our websites.If you have a valid support contract, you can contact Global Support ARIS at: 800ARISHELP. If this number is not supported by your telephone provider, please refer to ourGlobal Support Contact Directory.12

DOWNLOAD CLIENT CONFIGURATIONARIS COMMUNITYFind information, expert articles, issue resolution, videos, and communication with other ARISusers. If you do not yet have an account, register at ARIS Community.PRODUCT DOCUMENTATIONYou can find the product documentation on our documentation website.In addition, you can also access the cloud product documentation. Navigate to the desiredproduct and then, depending on your solution, go to Developer Center, User Center orDocumentation.PRODUCT TRAININGYou can find helpful product training material on our Learning Portal.TECH COMMUNITYYou can collaborate with Software AG experts on our Tech Community website. From hereyou 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 AGresources.PRODUCT SUPPORTSupport 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 anaccount. 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.13

DOWNLOAD CLIENT CONFIGURATION 2 2. Click your user name (top right). 3. Click Download Clients. 4. Click the Start button beside the ARIS Download Client with which you want to work. If the Java applet is used, ARIS Download Client starts immediately. Otherwise, an ARIS downloader JAR file is used. 5. Save the ARIS downloader JAR file locally .