arcad-builder 13.2 installation guide

North America & LATAM EMEA (HQ) Asia Pacific70 Main Street, Suite 105Peterborough NH 03458USA1-603-371-90741-603-371-3256 (support calls only)[email protected]

55 Rue Adrastée – Parc Altaïs74650 Chavanod/AnnecyFrance

+33 450 578 [email protected]

c/o Pramex Intl Ltd1 Austin Rd West Intl Commerce Centre7107B 71/F KowloonHong Kong

[email protected]

Publication Date: September, 2021

Prepared by the ARCAD Documentation and Consulting Teams

Installation GuideARCAD-Builder

Version 13.2

ARCAD-Builder v13.2Installation Guide |

Copyright © 1992-2021 by ARCAD. All rights reserved.

The following terms are names owned by International Business Machines Corporation in the United States,other countries, or both: AS/400®, ClearCase, ClearQuest®, DB2, DB2 Connect™, DB2 Universal Database™,ibm.com, IBM i, iSeries, System i, OS/400, Rational®, SP2, Service Pack, WebSphere. Java and all names basedon Java are owned by Oracle Corp. in the United States, other countries, or both. Eclipse is a registeredtrademark of Eclipse Foundation, Inc. Other names of companies, products or services are the property of theirrespective owners.

/ 48ARCAD • Copyright © 2021 • All Rights reserved. • arcadsoftware.com

http://www.arcadsoftware.com/

ARCAD-Builder v13.2Contact ARCAD | Installation Guide

Contact ARCAD

Headquartered in France at the foot of the Alps, ARCAD offers global services and has offices andpartners all over the world. ARCAD partners with leading-edge companies throughout the world tooffer full services, close to home.

Visit our website to Contact Us and find out more about our company and partners, or to request ademo.

The ARCAD Customer Portal is intended for current and potential customers that have full or trialversions of ARCAD software. If you already use or are interested in using an ARCAD product, theportal lets you view all of your current licenses and generate your own temporary license keys formost ARCAD products. It grants you access to the ARCAD product knowledge base (new releases,release notes and current documentation).

Do you have a request for change or have you encountered a bug? Log into the ARCAD Helpdesk andcreate a ticket.

ARCAD guarantees consultant support 24 hours a day, 5 days a week (24/5) to registered members.Calls received are redirected, according to the hour, to put you in contact with a support team in ornear your timezone.

Country Address Account Contact Support Contact

FranceARCAD Software (HQ)55 Rue Adrastée74650 Chavanod +33 4 50 57 83 96

[email protected]

Worldwide 24/7:+1 603 371 3256

France only:+33 450 57 28 00

[email protected]

ARCAD Helpdesk

GermanyARCAD Software Deutschland GmbHc/o Pramex International GmbHIm Trutz, Frankfurt 55 60322

China

ARCAD Software Products Private LmtdRoom D07, Floor 34, No.32, ZhujiangEast RoadTianhe District, Guangzhou

+86 (020)22324643+86 (020)[email protected]

IndiaARCAD SoftwareD-280/281/282, Vibhuti KhandGomti Nagar, Lucknow

Hong Kong

ARCAD Software Asiac/o Pramex Intl Ltd1 Austin Rd West Intl Commerce Centre7107B 71/F KowloonHong Kong

+852 3618 6118

USAARCAD Software Inc.70 Main Street, Suite 105Peterborough, NH 03458

+1 (603) 371-9074+1 (603)-371-3256 (support callsonly)[email protected]

Table 1: Contact ARCAD


https://arcadsoftware.com/about/contact/

https://customer.arcadsoftware.com/

https://akuiteo.arcadsoftware.com/akuiteo.clients

mailto:[email protected]


https://akuiteo.arcadsoftware.com/akuiteo.clients




ARCAD-Builder v13.2Installation Guide | Preface

Preface

Document purposeThis document is intended to guide you through the installation process for the ARCAD-Builderelements:

l the Builder Serverl the Builder Web Serverl the Builder web app

Intended audienceThis document is intended for system administrators, ARCAD administrators, or any person in chargeof installing ARCAD-Builder products.

Related documentationARCAD technical documentation can be accessed from the product's online help or by logging intothe Customer Portal on our website.

ARCAD SSL Configuration Guide

ARCAD Release Notes

ARCAD-Builder User Guide

ARCAD-Builder for Git Best Practices GuideTable 2: Related documentation

Publication recordUnless stated otherwise, all content is valid for the most current version of ARCAD-Builder listed aswell as every subsequent version.

Productversion

Documentversion

Publicationdate Update record

≥ 13.2 1.4 September,2021

No functional changesAdded troubleshooting information for the Builder Web Serverupdate

13.1 1.3 April, 2021

Documentation updated for product evolution.

l Added Migrating the Builder Server from ≤12.0 to ≥v12.1l Added Builder Server Linux installation instructionsl Updated all installation instructions to conform to standardAFS installers

12.0 1.2 March, 2020 Changed version numbering syntax to align with the ARCAD suiteNo functional changes

5.1 1.1 July, 2019 No functional changes

3.0 1.0 June, 2018 Initial publication

Table 3: ARCAD-Builder Installation Guide publication record


https://arcadsoftware.com/customer/


ARCAD-Builder v13.2Contents | Installation Guide

Contents

Contact ARCAD 3

Preface 4

Contents 5

SYSTEM REQUIREMENTS1 System requirements for the Builder Server 81.1 Windows 81.1.1 Hardware requirements 8

1.1.2 Software requirements 8

1.1.3 Remote Desktop Services 9

1.1.4 Host name resolution 9

1.1.5 Users, Groups and Environments for the Builder Server 10

1.2 Linux 101.2.1 Hardware requirements 10



1.2.4 Users, Groups and Environments for the Builder Server 11

1.3 IBM i 121.3.1 Hardware requirements 12



1.3.4 Users for the Builder Server 13

2 System requirements for the Builder Web Server 142.1 Windows 142.1.1 Hardware requirements 14


2.1.3 Remote Desktop Services 15


2.1.5 Users, Groups and Environments for the Builder Web Server 16

2.2 Linux 162.2.1 Hardware requirements 16



2.2.4 Users, Groups and Environments for the Builder Web Server 17

2.3 IBM i 182.3.1 Hardware requirements 18


3 System requirements for the Builder web app 19

INSTALLATION4 Installing the Builder Server 21



ARCAD-Builder v13.2Installation Guide | Contents

4.1 Windows 214.1.1 Install 21

4.1.2 Update 23

4.1.3 Uninstall 24

4.2 Linux 244.2.1 Install 25

4.2.2 Update 26

4.2.3 Uninstall 27

4.3 IBM i 284.3.1 Install 28

4.3.2 Update 30

4.3.3 Uninstall 31

5 Migrating the Builder Server from ≤12.0 to ≥v12.1 335.1 Prerequisites 335.2 Migrating on Windows 335.3 Migrating on Linux 365.4 Migrating on IBM i 38

6 Installing the Builder Web Server 416.1 Windows 416.1.1 Install 41

6.1.2 Update 43

6.1.3 Uninstall 43

6.2 Linux 446.2.1 Install 44

6.2.2 Update 45

6.2.3 Uninstall 45

6.3 IBM i 466.3.1 Install 46

6.3.2 Update 48

6.3.3 Uninstall 48



SYSTEMREQUIREMENTS

ARCAD-Builder v13.2Installation Guide | 1 System requirements for the Builder Server

1 System requirements for the Builder Server

1.1 Windows

1.1.1 Hardware requirementsThe following table lists the hardware components that are required for the Builder Server onWindows x64.

Requirement Value

System Architecture AMD64 and Intel EM64T

CPU DUAL Core processor minimum

Physical memory(RAM) 2GB minimum, 4GB recommended1

Virtual memory

l If physical memory is between 2GB and 16GB, then set virtual memoryto 1x the size of the RAM

l If physical memory is more than 16GB, then set virtual memory to16GB

Hard disk RAID storage or any secured storage with redundancy, backup andmonitoring

Disk Space Typical Install Type total: 10GB2

Video adapter 256 colors

Screen Resolution 1024x768 minimum

Network Any TCP/IP capable network interfaceTable 4: Builder Server Hardware Requirements - Windows

1.1.2 Software requirementsThe following table lists the software requirements for the Builder Server on Windows x64.

1Physical memory is used by this entity and all subsequent processes, operating systems and any other softwareinstalled on the server. Please refer to additional software vendors for additional physical memory requirements.2This size can be higher depending on the options selected and typical usage of the software, refer to Hard DiskSpace requirement planning section to determine your needs.



ARCAD-Builder v13.21 System requirements for the Builder Server | Installation Guide

Requirement Value

Operating system

l Windows 7 x64 - Professional, Enterprise, and Ultimate editionsl Windows 8 x64 and Windows 8.1 x64 - Pro and Enterprise editionsl Windows 10 x64 - Pro, Enterprise, and Education editionsl Windows Server 2008 x64 - Standard, Enterprise, DataCenter, andWeb editions

l Windows Server 2008 R2 x64 - Standard, Enterprise, DataCenter,Web, and Foundation editions

l Windows Server 2012 x64 - Standard, DataCenter, Essentials, andFoundation editions

l Windows Server 2012 R2 x64 - Standard, DataCenter, Essentials, andFoundation editions

Network protocoll TCP/IPv4l TCP/IPv4 with SSL

Filesystem NTFS or any journalized filesystemTable 5: Builder Server Software Requirements - Windows

1.1.3 Remote Desktop ServicesARCAD supports installing, configuring, and running all of its software through Remote DesktopServices, formerly known as Terminal Services, on Windows. To install, ARCAD recommends that youstart all configuration tools from the Terminal Server console session of the server using mstsc orconsole.

Platform-specific support information is as follows:

l Windows client operating systems: The Remote Desktop is only available in Single User Mode.l Windows server operating systems: You can have multiple Remote Desktop sessions.

1.1.4 Host name resolutionTypically, the computer on which you want to install the Builder Server is connected to a network.Ensure that the computer host name is resolvable through a Domain Name System (DNS) or acentrally-maintained TCP/IP host file, such as /etc/hosts (file is located inC:\Windows\System32\drivers\...). Use the ping command to ensure that your computer host name isresolvable.

Examplehostnameserverhostnameping serverhostnamepinging serverhostname.example.com [192.168.1.10] with32bytes of data:Reply from 192.168.1.10: bytes=32 time=138ms TTL=56

If your computer host name does not resolve, contact your system administrator.




1.1.5 Users, Groups and Environments for the Builder Server

NotePlease refer to your OS and system administrator for common securitypractices.

In order to install the Builder Server software you will need to log into the system with administratorprivileges.

The Builder Server does not need a dedicated group name. If the application is run as a service it willneed a user account with the ‘log on as a service’ right. This account will need ownership andread/write rights on directories and files where the software will be installed.

The special account LocalSystem can be used.

Depending on the configuration of the deployment processes, the user account might need rights onother directories and commands/software involved in the deployment processes.

The environment must be clean of variables which might affect java software such as JAVA_HOME,JDK_HOME, JRE_HOME, JAVA_OPTIONS, JAVA_OPTS, JVM_OPTS, CLASSPATH, etc.

Important!PATH must contain all java related binaries and tools.

TMP, TEMP, TMPDIR and TEMPDIR can be set to any desired temporary storage location.

1.2 Linux

1.2.1 Hardware requirementsThe following table lists the hardware components that are required for the Builder Server on Linux.

Requirement Value




Virtual memory



Hard disk RAID storage or any secured storage with redundancy, backup andmonitoringTable 6: Builder Server Hardware Requirements - Linux

1Physical memory is used by this entity and all subsequent processes, operating systems and any other softwareinstalled on the server. Please refer to additional software vendors for additional physical memory requirements.




Requirement Value


Network Any TCP/IP capable network interfaceTable 6: Builder Server Hardware Requirements - Linux

1.2.2 Software requirementsThe following table lists the software requirements for the Builder Server on Linux.

Requirement Value

Operating system Linux 64bits with support for Java 8 64bits

Runlevel Sever should be started in multi-user mode, commonly runlevel 3 or 5.


Filesystem Ext3, ext4 or any journalized filesystem.

SELINUX DisabledTable 7: Builder Server Software Requirements - Linux

1.2.3 Host name resolutionTypically, the computer on which you want to install the Builder Server is connected to a network.Ensure that the computer host name is resolvable through a Domain Name System (DNS) or acentrally-maintained TCP/IP host file, such as /etc/. Use the ping command to ensure that yourcomputer host name is resolvable.



1.2.4 Users, Groups and Environments for the Builder Server


If you are installing the software from an X Window System workstation or X terminal, then log in asroot and enable remote display.

1This size can be higher depending on the options selected and typical usage of the software, refer to Hard DiskSpace requirement planning section to determine your needs.




In order to install the Builder Server software you will need to log into the system with administratorprivileges.

ARCAD-Builder does not need a dedicated group name, although a dedicated user account with adedicated group should be created. This account will need ownership and read/write rights ondirectories and files where the software will be installed.

The special account root should not be used to run the software but is needed to install services.





1.3 IBM i

1.3.1 Hardware requirementsThe following table lists the hardware components that are required for the Builder Server on IBM i.

Requirement Value

Physical memory(RAM) RAM: 2GB minimum physical memory (4GB recommended)1


Network Any TCP/IP capable network interfaceTable 8: Builder Server Hardware Requirements - IBM i

1.3.2 Software requirementsThe following table lists the software requirements for the Builder Server on IBM i.

Requirement Value

Operating system IBM i ≥7.1Table 9: Builder Server Software Requirements - IBM i

1Physical memory is used by this entity and all subsequent processes, operating systems and any other softwareinstalled on the server. Please refer to additional software vendors for additional physical memory requirements.2This size can be higher depending on the options selected and typical usage of the software, refer to Hard DiskSpace requirement planning section to determine your needs.




Requirement Value


Java JRE JRE/JDK v8

At least one instance of the Remote Execution Server (REXEC) must be running.Table 9: Builder Server Software Requirements - IBM i

1.3.3 Host name resolutionTypically, the partition on which you want to install the Builder Server is connected to a network.Ensure that the partition host name is resolvable through a Domain Name System (DNS) or thecentrally-maintained TCP/IP host table (go CFGTCP, option 10).

Use the PING command to ensure that your computer host name is resolvable.

ExamplePING RMTSYS(hostname)Verifying connection to host systemhostname.domain.com at address 192.168.0.10.PING reply 1 from 192.168.0.10 took 18 ms. 256 bytes.TTL 64.


1.3.4 Users for the Builder ServerLog into the system with a profile with the following special authorities:

l *ALLOBJl *JOBCTL

Important!These rights are required only when installing the product.



ARCAD-Builder v13.2Installation Guide | 2 System requirements for the Builder Web Server

2 System requirements for the Builder Web Server

2.1 Windows

2.1.1 Hardware requirementsThe following table lists the hardware components that are required for the Builder Web Server onWindows x64.

Requirement Value




Virtual memory



Disk Space Typical Install Type total: 1GB



Network Any TCP/IP capable network interfaceTable 10: Builder Web Server Hardware Requirements - Windows

2.1.2 Software requirementsThe following table lists the software requirements for the Builder Web Server on Windows x64.

1Physical memory is used by this entity and all subsequent processes, operating systems and any other softwareinstalled on the server. Please refer to additional software vendors for additional physical memory requirements.



ARCAD-Builder v13.22 System requirements for the Builder Web Server | Installation Guide

Requirement Value

Operating system

l Windows 7 x64 - Professional, Enterprise, and Ultimate editionsl Windows 8 x64 and Windows 8.1 x64 - Pro and Enterprise editionsl Windows 10 x64 - Pro, Enterprise, and Education editionsl Windows Server 2008 x64 - Standard, Enterprise, DataCenter, andWeb editions

l Windows Server 2008 R2 x64 - Standard, Enterprise, DataCenter,Web, and Foundation editions

l Windows Server 2012 x64 - Standard, DataCenter, Essentials, andFoundation editions

l Windows Server 2012 R2 x64 - Standard, DataCenter, Essentials, andFoundation editions


Filesystem NTFS or any journalized filesystemTable 11: Builder Web Server Software Requirements - Windows

2.1.3 Remote Desktop ServicesARCAD supports installing, configuring, and running all of its software through Remote DesktopServices, formerly known as Terminal Services, on Windows. To install, ARCAD recommends that youstart all configuration tools from the Terminal Server console session of the server using mstsc orconsole.

Platform-specific support information is as follows:

l Windows client operating systems: The Remote Desktop is only available in Single User Mode.l Windows server operating systems: You can have multiple Remote Desktop sessions.

2.1.4 Host name resolutionTypically, the computer on which you want to install the Builder Web Server is connected to anetwork. Ensure that the computer host name is resolvable through a Domain Name System (DNS) ora centrally-maintained TCP/IP host file, such as /etc/hosts (file is located inC:\Windows\System32\drivers\...). Use the ping command to ensure that your computer host name isresolvable.






2.1.5 Users, Groups and Environments for the Builder Web Server


In order to install the Builder Web Server software you will need to log into the system withadministrator privileges.

The Builder Web Server does not need a dedicated group name. If the application is run as a service itwill need a user account with the ‘log on as a service’ right. This account will need ownership andread/write rights on directories and files where the software will be installed.

The special account LocalSystem can be used.




2.2 Linux

Important!To install the Builder Web Server on Linux, you must already have aweb server installed that runs on a JDK (not just a JRE) and is capableof deploying war files.

2.2.1 Hardware requirementsThe following table lists the hardware components that are required for the Builder Web Server onLinux x64.

Requirement Value




Table 12: Builder Web Server Hardware Requirements - Linux




ARCAD-Builder v13.22 System requirements for the Builder Web Server | Installation Guide

Requirement Value

Virtual memory






Network Any TCP/IP capable network interfaceTable 12: Builder Web Server Hardware Requirements - Linux

2.2.2 Software requirementsThe following table lists the software requirements for the Builder Web Server on Linux x64.

Requirement Value

Operating system Linux 64bits with support for Java 64 bits

Runlevel Server should be started in multi-user mode, commonly runlevel 3 or 5


Filesystem Ext3, ext4 or any journalized filesystem

SELINUX DisabledTable 13: Builder Web Server Software Requirements - Linux

2.2.3 Host name resolutionTypically, the computer on which you want to install the Builder Web Server is connected to anetwork. Ensure that the computer host name is resolvable through a Domain Name System (DNS) ora centrally-maintained TCP/IP host file, such as /etc/hosts. Use the ping command to ensure that yourcomputer host name is resolvable.



2.2.4 Users, Groups and Environments for the Builder Web Server





If you are installing the software from an X Window System workstation or X terminal, then log in asroot and enable remote display.

In order to install the Builder Web Server software you will need to log into the system withadministrator privileges.

ARCAD-Builder does not need a dedicated group name, although a dedicated user account with adedicated group should be created. This account will need ownership and read/write rights ondirectories and files where the software will be installed.

The special account root should not be used to run the software but is needed to install services.





2.3 IBM i

2.3.1 Hardware requirementsThe following table lists the hardware components that are required for the Builder Web Server onIBM i.

Requirement Value

Physical memory (RAM) 1GB minimum, 2GB recommended1


Network Any TCP/IP capable network interfaceTable 14: Builder Web Server Hardware Requirements - IBM i

2.3.2 Software requirementsThe following table lists the software requirements for the Builder Web Server on IBM i.

Requirement Value

Operating system IBM i IBM i ≥7.1


Java JRE JRE/JDK v8Table 15: Builder Web Server Software Requirements - IBM i




ARCAD-Builder v13.23 System requirements for the Builder web app | Installation Guide

3 System requirements for the Builder web app

Supported browsers:

l Internet Explorer 9+l Google Chrome 29+l Firefox 23+l Safari 6+l Opera 15+l iOs 6+l Android 4 (Limited)

Browser plug-ins are required by the default client; only JavaScript needs to be enabled.

Support on mobile browsers has some limitations.



INSTALLATION

ARCAD-Builder v13.24 Installing the Builder Server | Installation Guide

4 Installing the Builder Server

The Builder Server is required to use the Builder web app. The Builder web app connects directly tothe Builder Server to define and execute all the various actions in the build process.

The Builder Server can be installed on Windows, Linux and IBM i.

4.1 Windows

The Builder Server runs as a Windows service.

4.1.1 InstallThe installation process takes approximately 5 minutes. It is a simple procedure similar to most otherWindows applications. For trouble-free installation, it is recommended that you close all activeWindows applications before beginning the installation.

NoteIf the tool is already installed on your computer, reinstalling it willupdate it to the new version automatically.

Follow the subsequent steps to install the Builder Server on Windows.

Step 1 Copy the .exe file to your machine and execute it to launch the wizard. Your profile must haveadministrator privileges to run the execution file.

Step 2 From the Select Setup Language window, select the language for the installation.

Step 3 Review and accept the license agreement.

The License Agreement page presents the ARCAD license agreement for you to review.Please read it carefully. When you have reviewed the agreement, select I accept theagreement.

Step 4 Confirm the installation location.

The Select Destination Location screen displays the default location where ARCAD elementswill be installed. If you prefer to install the software elements in a different location, eithertype in the location, or click Browse... to navigate to and select the alternate location.

The default root location is C:\Program files\ARCAD Solutions\.

A sub-folder for each ARCAD application you install will be created at this location.

Step 5 Install.

The Ready to Install screen enables you to review and change or confirm the setupparameters provided and to launch the installation.

To change a setup parameter, click < Back and return to the necessary screen.

If you agree with the installation parameters displayed, click Install to start the copy phase ofthe installation process. The process may take a moment while the windows services arelaunched.



ARCAD-Builder v13.2Installation Guide | 4 Installing the Builder Server

As the installation proceeds, a status bar displays its progress. Each element copied appearsabove the status bar. Click Cancel to interrupt the installation.

Step 6 Confirm the program's shortcut location.

The Select Start Menu Folder screen displays the default location where a shortcut will becreated in your computer’s Start menu. If you prefer to install the shortcut under a differentgroup, either type the location here, or click Browse... to navigate to and select the alternatelocation.

The default root folder is ARCAD Solutions\.

If you do not want to create a start menu folder, select the Don't create a Start Menu foldercheckbox.

Step 7 Define the TCP ports to use.

Important!The ports defined here will be used to configure theconnection.

Press Enter/Next to use the default ports.

The Builder Server is an independent AFS server with an embedded H2 database.

The Builder Server's default HTTP port is 5252, and the default HTTPS port is 52520.

To disable a port, enter 0 when asked for the port number.

Important!If you are using other ARCAD Group products, it isrecommended to use the default ports to avoid any conflictswith other servers.

If an application is already using it, the default port will be the next available port,chronologically. It is possible to manually change the port after installation.

Step 8 Select the Windows user account.

The Builder Server runs as a Windows service. Select the user account that will be used tomanage the service.

By default, the local system account is selected. If you do not want to use that account, youcan select any user account with enough privileges to run a Windows service, and have a readand write access to the folder where ARCAD-Builder is installed.

Step 9 Complete the setup process. The final page of the wizard displays confirmation that the setupwas a success. Click Finish to close the setup wizard.

Step 10 Verify the Windows Service is running.

The final screen of the installation process enables you to automatically open the LocalServices Management Console. If the Open Windows service checkbox is selected, theServices window opens after clicking Finish. This window enables you to verify that its statusis set to "Started".

Result The Builder Server is installed and available for use.




4.1.2 Update

Important!If you are updating from any inferior version to ≥v12.1, you mustfollow the migration instructions. You cannot simply update theBuilder Server to ≥v12.1.

If you are updating from any version prior to v12.1 to any other versionprior to v12.1, the migration is not necessary; the update will functionas described here.

If you already have ≥v12.1 installed and are updating to a later versionstill, the migration is not necessary; the update will function asdescribed here.

ReferenceFor more information about migrating the Builder Server from ≤v12 to≥12.1, refer to Migrating the Builder Server from ≤12.0 to ≥v12.1 onpage 33.

Updating the Builder Server is similar to the installation process in that it is launched via theinstallation .exe. However, after the update is complete, the database must also be updated.

NoteIf you are updating without uninstalling, the majority of theinstallation preferences are saved and automatically reused.

To change the saved values, uninstall completely and define newvalues by reinstalling from scratch.

Follow the subsequent steps to update the Builder Server on Windows.





Step 4 Install.











Result The Builder Server is updated and available for use.

Update the integrated H2 database. To ensure that the H2 database is fully compatible with theupdated server, run the Update database to latest version script before starting to work withARCAD-Builder.

Update the database from the Server Configuration Settings in the Builder web app.

Step 1 Access the server's scripts.

1. Connect to the updated Builder Server.2. Open the Configuration view. You may need to right-click on the server to find this

option if it isn't in the navigator's toolbar.3. Select Database > Database Scripts to open the Database Scripts editor.

Step 2 Select Update ARCAD-Builder database to latest version from the SQL Scripts drop-down.

Step 3 Click the Actions drop-down menu and select Run.

Step 4 After a few moments, Click the Actions drop-down menu and select Refresh list. Whenthe Execution status is Terminated, the DB is updated.

Result The DB is updated.

4.1.3 UninstallFollow the subsequent steps to uninstall the Builder Server from Windows.

Step 1 Log into the system with an administrator account.

Step 2 Either launch the uninstall.exe located in the installation directory

- or -

Open Add or Remove Programs (Start > Control Panel), find the module in the list ofinstalled software and select Uninstall.

Step 3 Remove any remaining files in the installation path and remove any remaining configurationfiles in the user directory.

Result The Builder Server is completely uninstalled.

4.2 Linux




4.2.1 InstallFollow the subsequent steps to install the Builder Server on Linux.

Step 1 Transfer the .tar.gz to the /tmp directory on the target system.

Step 2 Open a terminal session and go to the installation directory.

Examplecd /opt

NoteBy default, the server is intended to be installed in the /optdirectory. If you install it in a different directory, you will haveto update the server's scripts (see Step 7 Edit the scripts.).

Step 3 Execute the following command to extract the tar.gz archive into the current directory:

tar xzf Builder-Server.tar.gz

Step 4 [Optional] If you need to change the listening port(s) for the server, you must do so now.





To change the ports, open the load/com.arcadsoftware.server.restful.cfg in a text editor andchange the following properties:

l port=<new HTTP port number> -or- <0> to disable the HTTP portl portssl=<new HTTPS port number> -or- <0> to disable the HTTPS port

Step 5 Create a specific user and group to run the server's process:

Exampleuseradd...groupadd

Step 6 Change the ownership of the installation directory to give it to the user and group that willrun the Builder Server:

chown username:groupname -R /opt/Builder-Server

Step 7 Edit the scripts.

Open the following scripts in a text editor to set the variables to match your executionenvironment:




l bin/Builder-Servero Line 8: set AFS_HOME to the installation directory if it was not installed in /opt/...by default.

o Line 12: set AFS_USER to the new user.

l bin/Builder-Server.serviceo Lines 8-14: update the paths so they match the installation directory.o Line 16: set the user to the new user.o Line 17: set the group to be the new user's or any group of your choice.

l load/com

Step 8 [Optional] Execute the following command to install the Builder Server as a systemd service:

cd /etc/systemd/systemsystemctl link /opt/Builder-Server/bin/Builder-Server.servicesystemctl enable Builder-Serversystemctl start Builder-Server


4.2.2 Update





After the Builder Server is updated, the database must also be updated.

Follow the subsequent steps to update the Builder Server on Linux.

Step 1 Transfer the updated Builder-Server.tar.gz. and the Builder-Server_Update.sh script to the/tmp directory on the target system.

Step 2 Open a terminal session and go into the /tmp directory: cd /tmp

Step 3 Mark the _Update.sh as being executable:

chmod +x Builder-Server_Update.sh

Step 4 Open the _Update.sh with a text editor and make the following changes:




l Line 9: uncomment and set the AFS_HOME variable to the installation directory.l Line 10: change the AFS_URL to match the address and port the server is listening on.l Line 12: change the AFS_OSUSER to the user running the server.l Line 13: change the AFS_OSGROUP to the group running the server.l Lines 16-19: uncomment the line corresponding to the way the server must be started.l Lines 22-25: uncomment the line corresponding to the way the server must be stopped.

Step 5 Run the _Update.sh:

./Builder-Server_Update.sh

NoteYou can keep the _Update.sh for future updates, unless statedotherwise in the release notes.











4.2.3 UninstallFollow the subsequent steps to uninstall the Builder Server on Linux.

Step 1 Stop the service using the service manager of your Linux distribution or use the scriptprovided.

ExampleService command:

systemctl stop Builder-Server

Script command:

/opt/Builder-Server/bin/Builder-Server stop




Step 2 Uninstall the service, if any, using the tools from your Linux distribution.

Examplesystemctl disable Builder-Serverrm /etc/systemd/system/Builder-Server.servicesystemctl daemon-reloadsystemctl reset-failed

Step 3 Remove the software from the installation directory.

Examplerm –rf /opt/Builder-Server

Step 4 Remove any remaining files based on the server’s configuration.


4.3 IBM i

The Builder Server can be installed and updated manually on IBM i or, depending on your securitypolicy, remotely from any machine running Java.


4.3.1 InstallFollow the subsequent steps to install the Builder Server on IBM i.

Step 1 Copy the installation .jar file to any directory (such as the /tmp) on the target IBM i IFS or themachine that will orchestrate the remote installation.

Step 2 Launch the installation setup.

If you are installing manually on IBM i:

1. Open a session on the target IBM i using the QSECOFR profile or an equivalent.2. Open a command line interpreter using the command QSH. Reach the location where you

have copied your installation file.3. In the command line interpreter, launch the setup using the installation command.

Examplejava -jar Setup_Builder-Server-x.x.x._IBM i.jar

If you are installing remotely from Windows or Linux:

1. Launch the setup from the location on the machine orchestrating the installation usingthe command above. This will open a prompt asking for the Remote IBM iname/address.




2. Enter the name/address of the target IBM i.3. Login using the QSECOFR profile or an equivalent.

Step 3 Define the installation location.

Example/HOME/...

Step 4 Define the AFS Starter Installation library and iASP which will contain the AFS Starter (autility program used to start the Builder Server on IBM i).

By default they are AFSSTARTER and *SYSBAS.


Important!The ports defined here will be used to configure theconnection.







Step 6 Define the Job user that will run the Builder Server.

Step 7 Define the job queue library (*LIBL) then the job queue (JOBQ) in which the job will besubmitted.

ExampleJob queue library [ARCAD_SYS]Job queue [ARCAD_CTL]

Step 8 Define the name of the AFS instance to register in the AFSSTARTER.

By default it is PRODUCT-AFS-ID.


NoteWhen the Builder Server is installed on IBM i, and if the list ofARCAD Servers is empty (which is the case after a fresh installation),then ARCAD-Builder automatically creates a new ARCAD Server




connection to the localhost address. The hostname is localhost (toconnect locally to the IBM i) and user/password are left blank toconnect with the user profile currently running the Builder Server'sJob.

4.3.2 Update





Updating the Builder Server is similar to the installation process in that it is launched via theinstallation .jar file. However, after the update is complete, the database must also be updated.

NoteIf you are updating without uninstalling, the majority of theinstallation preferences are saved and automatically reused.

To change the saved values, uninstall completely and define newvalues by reinstalling from scratch.

Follow the subsequent steps to update the Builder Server on IBM i.









Examplejava -jar Setup_Builder-Server-x.x.x._IBM i.jar




Step 3 Define the installation location.

Example/HOME/...

Point to original installation location to use the same settings defined for the originalinstallation (ports, installation location, service user).











4.3.3 UninstallFollow the subsequent steps to uninstall the Builder Server on IBM i.

Step 1 Open a session on the IBM i where the server is installed, using the QSECOFR profile or anequivalent.

Step 2 Stop and delete the service using the following commands:

ADDLIBLE <AFSSTARTER LIBRARY NAME>ENDAFSSVR BUILDERDLTAFSSVR BUILDER DELETE(*YES)



ARCAD-Builder v13.25 Migrating the Builder Server from ≤12.0 to ≥v12.1 | Installation Guide

5 Migrating the Builder Server from ≤12.0 to ≥v12.1

The v12.1 release included major changes to the structure of the Builder Server. Because of thesechanges, it is impossible to update the Builder Server using the regular method(s). If you are runningany version of the Builder Server that is inferior or equal to v12, you must install the ≥v12.1 and thenmigrate your existing data.

Important!You must follow these instructions to transfer your existing data froma previous version of the Builder Server to ≥v12.1. You cannot simplyupdate your Builder Server to v12.1.

This section provides steps to help you migrate your existing configuration from any version of theBuilder Server below v12.1 to v12.1. You can migrate from one machine to another and from oneOS to another (by carefully taking responsibility for the changes in path names etc).

The migration process will help you transfer the following data from your old server to the ≥v12.1Builder Server:

1. The SSH Keys.2. The GIT repositories that use the SSH keys to connect ARCAD-Builder and GIT.3. The external SCM settings that define how the webhooks open versions corresponding to

different branches of GIT repositories.4. The SCM references, development environments, and your log ins and passwords.5. The build models and their macros.6. The build execution details, job logs and attachments.

The following configuration is not restored during this migration process and must be redefined onthe new server:

l The ARCAD-Builder Server Connections

The migration tool will automatically pull all of your data from the existing Builder Server. This datawill be made available to you via a .zip file. You must then manually copy the extracted data onto thenew server.

Follow the subsequent steps to extract your data, install the new server and copy your data to the newserver.

5.1 Prerequisites

You are running any version less than or equal to v12.0 of the Builder Server and you wish to update to≥12.1.

5.2 Migrating on Windows

Step 1 Create a migration directory on the machine where your current Builder Server is running.

Step 2 Copy the migration tool into this folder. The migration tool is a .jar file called ARCAD-Builder-Migration.jar. It is located in theMigration folder in the installation package.



ARCAD-Builder v13.2Installation Guide | 5 Migrating the Builder Server from ≤12.0 to ≥v12.1

Step 3 Ensure that the old Builder Server is running.

Step 4 Open the command prompt and change the directory path to the new migration directory.

Step 5 Execute the migration tools from the migration directory using the command

When prompted to enter the server's location, enter the existing server's URL.

Examplehttp://localhost:<port>

Result The migrate tool peruses your old server and collects all of the data to extractautomatically. A .zip file containing all of your extracted data is created in themigration directory.

Step 6 Stop the old server.

Step 7 Install the new Builder Server. The new service will start automatically.

NoteBecause the default installation location is not the samestarting with v12.1, you can use the default installation pathswithout worrying about overriding the existing server.

The original default installation location for any Builder Serverprior to v12.1 is C:\Program Files (x86)\ARCADSolutions\builder\Server.

The new default installation location for the Builder Server≥v12.1 is C:\Program Files\ARCAD Solutions\ARCAD-BuilderServer.

NoteBecause the old server is stopped, you can use the same portto install the new server. The default installation port for theBuilder Server is 5252. If you do not use the default port, or ifthe port you use here is different from the original server'sport, there may be additional steps to take further along inthis process.

Step 8 Stop the new Builder Server.

Step 9 Unzip the .zip file created by the migration tools.

Step 10 [Optional] Manage the port on which your new server is installed.

If you entered a different port number for the new server and no longer wish to use the portoccupied by the old server, youmust delete the load/com.arcadsoftware.server.restful.cfgfile from the /load directory. Deleting this file will remove the old server's port number andthe new server will run on the port defined during installation.

Warning!You must delete this file before copying the /load directory tothe new server (as described in the next step). If you migratethis file, the new port defined when you installed the newserver will be overridden with the old port via this file.




If you wish to continue to use the original port from the old server, there are no additionalsteps to take outside of this procedure. The port number will be migrated via theload/com.arcadsoftware.server.restful.cfg file.

Step 11 Copy the contents of the .zip file to the new server.

Copy the extracted /load, /database, /ssh, and /file directories straight into the new server'sroot folder. This makes the old server's configuration and data available in the new server.The copy will override the existing directories created by default during installation.

NoteThere is no /ssh folder created automatically duringinstallation. Copying the /ssh folder into the root of the newserver will create this directory and automatically make yourssh keys available on the new server. If you create ssh keys inyour new server before migrating your keys from the oldserver and then copy the old folder over, you risk overridingany new ssh keys created on the new server.

Step 12 [Optional] If required, because your original server was modified, there may be additionalsteps to take. Read each set of instructions below to find out if they apply to yourconfiguration.

1. Migrate the /server directory, if it exists.

If a /server directory exists in the zip file, then your old server had exceptionalconfiguration that must be migrated in addition to the default data. If it exists, copy thecontents of the /server directory directly into the root of the new server's installationdirectory.

Important!Do not copy the /server directory itself. Copy only itscontents into the new root. The new server should notinclude a /server sub-directory.

2. Migrate any external configuration, if it exists.

If a /<letter> directory exists in the zip file, and if you are changing the machine on whichthe Builder Server is installed, then your old server had exceptional configuration thatmust be migrated in addition to the default data. This means that your original serverwas reconfigured to save data outside of the original relative paths. Using absolute pathsto store data from the Builder Server is not default behavior. To migrate yourexceptional configuration, copy the contents of the /<letter> directory directly into thecorresponding /<letter> drive on the new machine.

Important!Do not copy the /<letter> directory itself. Copy only itscontents into the new drive.

If you have not changed machines, there are no additional steps to take outside of thisprocedure because any data will still exist in your current drive.

Step 13 Restart the new Builder Server and check that your data is now available on your new servervia the Builder web app.




If there are any errors and you are missing content, check that all of your content wascorrectly extracted in the .zip file.

Step 14 Uninstall the old Builder Server.

Run the uninstaller from old server's installation directory.

Result All previous build details/joblogs and attachment are successfully migrated from your oldBuilder Server to the new Builder Server v12.1.

5.3 Migrating on Linux




Step 4 Open the command prompt and change the directory path to the new migration directory.

Step 5 Execute the migration tools from the migration directory using the command java -jarARCAD-Builder-Migration.jar







The original default installation location for any Builder Serverprior to v12.1 is /opt/builder/server.

The new default installation location for the Builder Server≥v12.1 is /opt/Builder-Server.



















If a root directory exists in the zip file, and if you are changing the machine on which theBuilder Server is installed, then your old server had exceptional configuration that mustbe migrated in addition to the default data. This means that your original server was




reconfigured to save data outside of the original relative paths. Using absolute paths tostore data from the Builder Server is not default behavior. To migrate your exceptionalconfiguration, copy the contents of the root directory directly into the correspondingroot drive on the new machine.

Important!Do not copy the root directory itself. Copy only itscontents into the new root.

If you have not changed machines, there are no additional steps to take outside of thisprocedure because any data will still exist in your current root.




Disable and remove the service (if installed as a service) and delete the installation directory:rm -rf <builder_server_directory>.


5.4 Migrating on IBM i




Step 4 Open Qshell and change the directory path to the new migration directory.

Step 5 Execute the migration tools from the migration directory using the command java -jar./ARCAD-Builder-Migration.jar



To check directory: SELECT * FROM afsstarter/afsservers








The original default installation location for any Builder Serverprior to v12.1 is /home/builder.

The new default installation location for the Builder Server≥v12.1 is /home/Builder-Server.



















If a root directory exists in the zip file, and if you are changing the machine on which theBuilder Server is installed, then your old server had exceptional configuration that mustbe migrated in addition to the default data. This means that your original server wasreconfigured to save data outside of the original relative paths. Using absolute paths tostore data from the Builder Server is not default behavior. To migrate your exceptionalconfiguration, copy the contents of the root directory directly into the correspondingroot drive on the new machine.

Important!Do not copy the root directory itself. Copy only itscontents into the new root.

If you have not changed machines, there are no additional steps to take outside of thisprocedure because any data will still exist in your current root.




Remove the BUILDER instance from AFSSTARTER (run ADDLIBLE AFSSTARTER, thenDLTAFSSVR INSTANCE(BUILDER)) and delete the installation directory with RD DIR('<builder_server_directory>') SUBTREE(*ALL) RMVLNK(*YES).




ARCAD-Builder v13.26 Installing the Builder Web Server | Installation Guide

6 Installing the Builder Web Server

The web server is a Web Application Container (Jetty) (IBM i, Windows and Linux), which is a J2EEApplication Server. It grants access to the web application. The web server can be added to an existinginternal web server you may have, such as Tomcat, or you can use the lightweight jetty that ARCADdelivers to install autonomously.

Important!If you already have a Web Application Container running on themachine (a Jetty or Tomcat), it is not necessary to install the BuilderWeb Server to access the Builder web app. You can install the for theBuilder web app manually using your current Web ApplicationContainer. To do this, copy the .war into the folder C:\ProgramFiles\ARCAD Solutions\Jetty\webapps.

6.1 Windows

The Builder Web Server runs as a Windows service.

6.1.1 InstallThe installation process takes approximately 5 minutes. It is a simple procedure similar to most otherWindows applications. For trouble-free installation, it is recommended that you close all activeWindows applications before beginning the installation.


Follow the subsequent steps to install the Builder Web Server on Windows.

NoteIf the Builder Web Server is already installed on your computer,reinstalling it will update it to the new version automatically.





Step 4 Confirm the installation location.

The Select Destination Location screen displays the default location where ARCAD elementswill be installed. If you prefer to install the software elements in a different location, eithertype in the location, or click Browse... to navigate to and select the alternate location.



ARCAD-Builder v13.2Installation Guide | 6 Installing the Builder Web Server

The default root location is C:\Program files\ARCAD Solutions\Jetty.

A sub-folder for each ARCAD application you install will be created at this location.

Step 5 Confirm the program's shortcut location.

The Select Start Menu Folder screen displays the default location where a shortcut will becreated in your computer’s Start menu. If you prefer to install the shortcut under a differentgroup, either type the location here, or click Browse... to navigate to and select the alternatelocation.

The default root folder is ARCAD Solutions\Jetty Web Server.

If you do not want to create a start menu folder, select the Don't create a Start Menu foldercheckbox.

Step 6 Install.






Important!The ports defined here will be part of the URL in your browserwhen connecting to the administration console, viewingreports or accessing the Builder web app.

NoteIf the Builder Web Server is behind a proxy or a load balancer,the Virtual Host URL field will set the value of the "X-Forwarded-Host" HTTP header, enabling you to identify theoriginal host requested by the client.


The Builder Web Server is an independent AFS server.

The Builder Web Server's default HTTP port is 8080, and the default HTTPS port is 8443.







Step 8 Select the Windows user account.

The Builder Web Server runs as a Windows service. Select the user account that will be usedto manage the service.

By default, the local system account is selected. If you do not want to use that account, youcan select any user account with enough privileges to run a Windows service, and have a readand write access to the folder where ARCAD-Builder is installed.




Result The Builder Web Server (Jetty) is installed and available for use.

ReferenceFor more information about configuring and working with the Builderweb app, refer to the ARCAD-Builder User Guide

6.1.2 UpdateThe Jetty that runs the Builder Web Server can be updated in two ways. You can manually replace the.war file or launch an updated installation package. All of the steps below are handled automatically ifyou update the Builder Web Server by reinstalling it.

Follow the subsequent steps to manually update the Builder Web Server on Windows.

Step 1 Stop the Jetty.

Step 2 Replace the exiting .war in the Jetty’s /webapps folder. The replacement .war can be found inthe installation package.

Step 3 Clean the Jetty work directory from older installed version.

Step 4 Restart the Jetty.

Result The Builder Web Server is updated and ready for use.

6.1.3 UninstallFollow the subsequent steps to uninstall the Builder Web Server from Windows.

Step 1 Log into the system with an administrator account.

Step 2 Either launch the uninstall.exe located in the installation directory

- or -




Open Add or Remove Programs (Start > Control Panel), find the module in the list ofinstalled software and select Uninstall.

Step 3 Remove any remaining files in the installation path and remove any remaining configurationfiles in the user directory.

Result The Builder Web Server is completely uninstalled.

6.2 Linux

6.2.1 InstallFollow the subsequent steps to install the Builder Web Server on Linux.

Step 1 Transfer the .tar.gz to the /tmp directory on the target system.

Step 2 Open a terminal session and go to the installation directory.

Examplecd /opt

NoteBy default, the server is intended to be installed in the /optdirectory. If you install it in a different directory, you will haveto update the server's scripts (see Step 7 Edit the scripts.).

Step 3 Execute the following command to extract the tar.gz archive into the current directory:

tar xzf jettyJettyWebServer.tar.gz

Step 4 [Optional] If you need to change the listening port(s) for the server, you must do so now.





To change the ports, open the start.d/http.ini and the /https.ini files in a text editor andchange the following properties:

l jetty.http.port=<new HTTP port number>l both the jetty.httpConfig.securePort= and the jetty.ssl.port=must be changed to the<new HTTPS port number>.

To disable the ports, rename the .ini file(s).

Step 5 Create a specific user and group to run the server's process:




Exampleuseradd...groupadd

Step 6 Change the ownership of the installation directory to give it to the user and group that willrun the Builder Web Server:

chown username:groupname -R /opt/jettyJettyWebServer

Step 7 Edit the scripts.

Open the following scripts in a text editor to set the variables to match your executionenvironment:

l bin/jetty.sho Line 97: set JETTY_HOME to the installation directory if it was not installed in/opt/... by default.

o Line 100: set JETTY_USER to the new user.

l bin/jetty.serviceo Lines 7-10: update the paths so they match the installation directory.o Line 16: set the user to the new user.o Line 17: set the group to be the new user's or any group of your choice.

l load/com

Step 8 [Optional] Execute the following command to install the Builder Web Server as a systemdservice:

cd /etc/systemd/systemsystemctl link /opt/jettyJettyWebServer/bin/jettyjetty.servicesystemctl enable jettyjettysystemctl start jettyjetty

Result The Builder Web Server is installed and available for use.

6.2.2 UpdateFollow the subsequent steps to update the Builder Web Server on Linux.

Step 1 Stop the Jetty.

Step 2 Replace the product's .war file found under /opt/JettyWebServer/webapps with the new one.


Step 4 Restart the Jetty.

Result The Builder Web Server is updated and available for use.

6.2.3 UninstallFollow the subsequent steps to uninstall the Builder Web Server on Linux.

Step 1 Stop the service using the service manager of your Linux distribution or use the scriptprovided.




ExampleService command:

systemctl stop jetty

Script command:

/opt/jetty/bin/jetty stop

Step 2 Uninstall the service, if any, using the tools from your Linux distribution.

Examplesystemctl disable jettyrm /etc/systemd/system/jetty.servicesystemctl daemon-reloadsystemctl reset-failed

Step 3 Remove the software from the installation directory.

Examplerm –rf /opt/jetty

Step 4 Remove any remaining files based on the server’s configuration.


6.3 IBM i

The Builder Web Server can be installed and updated manually on IBM i or, depending on yoursecurity policy, remotely from any machine running Java.


6.3.1 InstallFollow the subsequent steps to install the Builder Web Server on IBM i.






Examplejava -jar Setup_jetty-x.x.x._IBM i.jar







Step 3 Define the user that will run the jetty. If it doesn't already exist, the installer will attempt tocreate it. By default the user is jetty.

Step 4 Define the Jetty Installation library which will contain the wrapper used to start jetty serverson IBM i. By default the library is JETTY.

Step 5 Define the installation path for the jetty on the IFS. By default the path is /home/jetty.


Important!The ports defined here will be part of the URL in your browserwhen connecting to the administration console, viewingreports or accessing the Builder web app.

NoteIf the Builder Web Server is behind a proxy or a load balancer,the Virtual Host URL field will set the value of the "X-Forwarded-Host" HTTP header, enabling you to identify theoriginal host requested by the client.







Step 7 Connect to the remote IBM i and start the Jetty subsystem using the installation location.

ExampleSTRSBS SBS(JETTY/JETTY).

Result The Builder Web Server is installed and available for use.




6.3.2 UpdateFollow the subsequent steps to update the Builder Web Server on IBM i.

Step 1 Stop the Jetty: JETTY/ENDJTYSVR.

Step 2 Replace the exiting .war in the Jetty’s /webapps folder. The replacement .war can be found inthe installation package.


Step 4 Restart the Jetty: JETTY/STRJTYSVR.

Result The Builder Web Server is updated and available for use.

6.3.3 UninstallFollow the subsequent steps to uninstall the Builder Web Server on IBM i.

Step 1 Open a session on the IBM i where the server is installed, using the QSECOFR profile or anequivalent.

Step 2 Stop and delete the service using the following commands:

JETTY/ENDJTYSVRDLTLIB JETTY

Step 3 Remove the server using the following command:

rm –rf /home/jetty




arcad-builder 13.2 installation guide

Documents