Loftware Spectrum®

Version 4.7.1

Installation and Configuration Guide

© July 2023 by Loftware, Inc. All rights reserved. Version 4.7.1 Rev B

Loftware, Loftware Spectrum, LLM, Loftware Label Design, Loftware Print Server, LPS, Loftware
Connector, Global Marking Solutions, I-Push, and I-Pull are all registered trademarks of Loftware,
Inc. Loftware WebAccess, LWA, and Loftware Web Services are trademarks of Loftware, Inc. SAP is
a registered trademark of SAP AG in Germany and in several other countries. Oracle and Java are
registered trademarks of Oracle and/or its affiliates. All other marks are the property of their
respective owners. Loftware Spectrum contains barcode components licensed from
IDAutomation.com, Inc. These products may only be used as part of and in connection with Loftware
Spectrum.

Loftware, Inc., 249 Corporate Drive, Portsmouth, NH 03801

Phone: 603.766.3630
[email protected]
www.loftware.com
Contents

Installing Loftware Spectrum 10

Preparing for Installation 11
Installation Checklist 12
Information Needed to Install Spectrum Database in Oracle 14
Information Needed to Install Spectrum Database in PostgreSQL 16
Deploying Spectrum in Amazon Relational Database Service 17
High Availability and Failover 17
Port Requirements for Cloud-Based Services 17
Additional Download Packages 18
Installing the Spectrum Database 19
Install Spectrum Database in Oracle on Windows Server 20
Install Spectrum Database in Oracle on Linux 29
Install Spectrum Database in PostgreSQL on Windows Server 38
Install Spectrum Database in PostgreSQL on Linux 48
Installing the Spectrum Application 57
Install Spectrum Application on Windows Server 58
Install Spectrum Application on Linux 69
Install Spectrum Application on Linux using Command Line (AWS) 80
License Spectrum 90
A. Get Your Server ID from Spectrum 90
B. Sign in to the Loftware Licensing Server 91
C. Create a New License 92
D. Enter the License in Spectrum 94
Sign in to Spectrum 95
Spectrum Root Folder 96
After Installing Spectrum 97
Installing Spectrum Enterprise for Medical Device 98
Installing for Distributed Services 99

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 2

 Install Spectrum on an Additional Windows Server 100
Install Spectrum on an Additional Linux Server 108
Next Steps 117
Removing a Spectrum Application Server 118
Remove the Spectrum Application from a Server Running Windows
Server 118
Remove the Spectrum Application from a Server Running Linux 119
Installing a Multi-Site Deployment 121
Install Spectrum Database at a Facility Site 122
Install Spectrum Application at a Facility Site 122
Installing Loftware DaVinci 124
Deploy and Configure the Loftware DaVinci Application 124
Configure Loftware DaVinci in Label Design 128
Add the System Property 128
Configuring HTTPS 130
Using Your Own Certificate 130
A. Implement an Existing Certificate 130
B. Configure SSL in Tomcat 132
C. Configure Servers in Spectrum 134
Using the Spectrum Self-Signed Certificate 135
Display the Contents of Keystore 136
Installing the Command Line Interpreter (CLI) 137
Configuring Spectrum 144
Set the Browser Session Timeout 146
Set the Application Server Tomcat Java Memory Parameters 147
Setting the Memory Pool Parameters in Windows 147
Setting the Memory Pool Parameters in Linux 148
Change JMX Configuration 149
Disable JMX in Windows 149
Disable JMX in Linux 150
Configuring Spectrum for SNMP Support 151

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 3

 Remove SNMP ACL File Security 155
Change the Archive Data Retention Time 155
Synchronize Application and Database Servers' Clocks 156
Set a Default LDAP Domain 157
Add an LDAPS Certificate 158
Set Server Domain Names 159
Change Service Ports 159
Change the Source of Spectrum Help 161
Provide Static Help to Users 162
Provide Dynamic Help to Users (Recommended) 162
Spectrum LoftStore Utility 162
Usage 162
Available Commands [cmd] 163
Apply an SQL Script to the Spectrum Embedded Database 163
View Default Users and PDF Print Location 165
Turn Off the Default View Address 165
Optimizing Database Storage When Necessary 166
When to Apply the Optimization Setting 166
Guidelines for Applying the Optimization Setting 167
How to Change the Database Optimization Setting 168
Updating the LOFTUSER Password 169
Configure Lambda Function and Event Rules in AWS 172
Upgrading Loftware Spectrum 184
Preparing to Upgrade 186
Determine the Existing Database Configuration 187
Check Technical Requirements 187
Create a Backup of your Existing Spectrum Database 187
Create a Backup of your Configuration Files 188
Third Party JDBC Drivers 188
Integration for Use with SAP® Applications 188
Upgrading the Spectrum Database 189

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 4

 Upgrade Spectrum Database in Oracle on Windows Server 190
Upgrade Spectrum Database in Oracle on Linux 198
Upgrade Spectrum Database in PostgreSQL on Windows Server 205
Upgrade Spectrum Database in PostgreSQL on Linux 211
Upgrade Spectrum Embedded Database on Windows Server 216
Spectrum Application Backup 217
Spectrum Database Backup 217
Upgrading the Spectrum Application 221
Upgrade Spectrum Application on Windows Server 222
Upgrade Spectrum Application on Linux 226
Java Options 230
After Upgrading Spectrum 233
Oracle Integrations 234
Upgrading the Command Line Interpreter (CLI) 234
Upgrading Spectrum Remote Print 236
Upgrade the Remote Print Agent to the Loftware Print Agent 238
Upgrading Spectrum for Distributed Services 239
Upgrading a Multi-Site Deployment 241
Starting Services for Multi-Site Deployment 242
Managing the Loftware DaVinci Password 242
Upgrading Spectrum with SSO 244
Using the Driver Installer 245
Driver Installer Basics 245
Logging Features 245
DriverInstaller.properties File 246
Driver Installer Syntax 247
Basic Command Structure 247
Uninstalling Spectrum 250
Uninstall the Spectrum Application and Service 250
Uninstall the Embedded Database 254
Uninstall the Remote Print Agent 258

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 5

 Uninstall the Loftware Print Agent 259
Maintaining and Protecting Spectrum 260
Managing the Loftware-Supplied Embedded Database 261
Automatic Backup and Recovery 261
Spectrum Database Recovery 261
Change the Location of the Flash Recovery Area 262
Change Database Backup Settings 262
Update the Database Backup Duration 262
Update the Database Backup Schedule 263
Backing Up the Full Spectrum Instance 264
Spectrum Application Backup 264
Spectrum Database Backup 264
Restore the Spectrum Instance 266
Taking a Snapshot of a Spectrum Instance 268
Export a Spectrum Instance Snapshot 268
Import a Spectrum Instance Snapshot 269
Logging 270
Managing Offline Storage 271
A. Identify your current archive file location 271
Loftware Spectrum with Embedded Database 271
Loftware Spectrum with Oracle Database Server 272
B. Identify your current archive retention value 272
Loftware Spectrum with Embedded Database 272
Loftware Spectrum with Oracle Database Server 273
C. Develop a plan for managing the archive files 273
D. Create an automatic process of moving the archive files 273
Disable Creation of Database Dump File 273
Logging 275
Spectrum Database Installation Logging 276
Windows Event Viewer 276
Loftware-Supplied Embedded Database Installation 277

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 6

 Additional Logs 277
Backup and Recovery Logging 277
Spectrum Application Server Logging 278
Spectrum Application Activity Logs 278
Spectrum Application Server Logs 279
Event (Application) Logging 279
Log4j 2 Configuration File 280
Logging Levels 280
Configure Log Files 282
Adjust Rollover Triggers 282
Configure Appenders 283
Package-Level Loggers 283
Spectrum Log Files 283
System Log (spectrum.log) 284
UI to Server Message Log (spectrum-amf.log) 284
Critical Event Log (spectrum-critical.log) 284
Data Map Log (spectrum-data.log) 284
Driver Install Log (spectrum-drv-install-svc.log) 284
Integration Event Log (spectrum-integration.log) 285
Printing Event Log (spectrum-print.log) 285
Security Event Log (spectrum-security.log) 285
SOAP Web Service Log (spectrum-soap.log) 286
Entity Sync Log (spectrum-sync-entity.log) 286
Transaction Sync Log (spectrum-sync-transaction.log) 286
User Event Log (user-rules.log) 286
Appendix A: Technical Requirements for Spectrum 4.7.1 287
Server Requirements for Spectrum 4.7.1 289
Requirements for Loftware Spectrum Database Server 289
Requirements for Loftware Spectrum Application Server 291
Port Requirements for Cloud-Based Services 292
Requirements for Multi-Site Deployment 293

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 7

 Requirements for Loftware Spectrum Facility Database Server in a
Multi-Site Deployment 293
Constraints If Upgrading an Embedded Database 294
Requirements for Loftware Spectrum Business Intelligence Server 295
Server Performance Tips 296
Configuring for High Availability with Distributed Services 296
Optimizing Performance 297
Client Computer Requirements for Spectrum 4.7.1 298
Requirements for Spectrum Client Computers 298
Requirements for Mobile Devices 300
Requirements for Spectrum Remote Print Client Computers 300
Other Requirements for Integrations 302
Requirements for Cloud Applications Integration 303
Requirements for Oracle Applications Integration 305
Requirements for Integration for use with SAP® Applications 306
Appendix B: Users and Privileges for the Spectrum Database 307
Oracle Database Users 308
PostgreSQL Database Roles 317
Appendix C: About General Data Privacy Regulation (GDPR) 320
Best Practices in Protecting Your Spectrum Data 321
Configuring Spectrum for GDPR Compliance 322
Before you Begin 322
Create a Backup of your Existing Spectrum Instance 322
Spectrum Application Backup 322
Spectrum Database Backup 322
Loftware-Supplied Database Backup 323
Configure GDPR Compliance 323
Using Encrypted Connections 324
Edit GDPR System Property 324
Enable GDPR Compliance 325
Configuring Cross Reference Table Encryption 326

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 8

 Encrypt Cross Reference Table Columns 326
Clear Archive and Audit Tables 326
Configure Loftware Business Intelligence 326
Encryption of Personal Information 327
Database Encryption 327
Username 328
eSignature 328
Workflow 328
Redact Personal Information 328
Configuring Password Rules 328
Manage Password Authentication Rules 329
Password Pattern Examples 330
Password Contents Examples 330
Downloading Personal Information 331
Download Personal Information 331
Download Your Personal Data 331

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 9

Installing Loftware Spectrum

This section describes how to prepare for and install Loftware Spectrum®. For
information on upgrading from an existing version of Spectrum, see Upgrading Loftware
Spectrum.

Installing Spectrum involves the following tasks:

l Preparing for Installation

l Installing the Spectrum Database
l Installing the Spectrum Application

Note: The order of the tasks is important. The Spectrum database must be installed
before the Spectrum application.

After Spectrum is installed, continue to the following tasks depending on your

configuration of Spectrum:

l License Spectrum
l Sign in to Spectrum
l Installing for Distributed Services (if applicable)
l Installing a Multi-Site Deployment (if applicable)
l Installing Loftware DaVinci (if applicable)
l Configuring HTTPS
l Installing the Command Line Interpreter (CLI)
l Configuring Spectrum

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 10

Preparing for Installation

This section describes how to prepare for installing Loftware Spectrum.

Important: Be sure to review the Release Notes included in the release package for
additional information, such as known issues and workarounds related to installing,
upgrading, and using Spectrum.

This section describes how to prepare for installing Loftware Spectrum.

Installation Checklist 12

Information Needed to Install Spectrum Database in Oracle 14

Information Needed to Install Spectrum Database in PostgreSQL 16

Deploying Spectrum in Amazon Relational Database Service 17

High Availability and Failover 17

Port Requirements for Cloud-Based Services 17

Additional Download Packages 18

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 11

Installation Checklist

This section helps you plan and prepare for the installation of Loftware Spectrum.
Loftware recommends that you fill out the following table to use as a guide during the
installation process.

Spectrum Database Response

Are you installing the Spectrum database in an Oracle database Oracle

or PostgreSQL database? PostgreSQL

What is the operating system of the computer you are using to Windows Server
install the Spectrum database? Linux

Where are you installing the Spectrum database? Amazon RDS

Local Server
Private Cloud

What is the full path of the Spectrum Database Server?

Spectrum Application Response

What is the operating system of the computer you are using to Windows Server
install the Spectrum application? Linux

Are you enabling HTTPS on the Spectrum Application Server? Yes

No

Spectrum Add-On Capabilities Response

DaVinci Compare Yes

Are you installing the DaVinci label comparison web application? No

Business Intelligence Yes

Are you installing Loftware Spectrum Business Intelligence? No

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 12

Spectrum Enterprise for Medical Device Yes
Are you installing Spectrum Enterprise for Medical Device? No

Distributed Services Yes

Are you installing the Spectrum application in a distributed No
services environment (with one database and multiple application
servers)?

Multi-Site Deployment Yes

Are you installing a multi-site deployment of Spectrum (where No
objects can be configured at a headquarters and replicated to
facilities)?

Configuration Options Response

Spectrum Root Folder Name

The root folder, initially named Default, should be changed after
installation to something relevant to your organization. Changing
the root folder name after you have started using Spectrum is not
recommended. What is the new name for your root folder?

Encrypted Connections Yes

Are you required to comply with the General Data Protection No
Regulation (GDPR) of the EU?

Disaster Recovery Yes

Are you configuring for disaster recovery? No

LPS to Spectrum Migration Yes

Are you migrating your data from an existing Loftware Printer No
Server (LPS) instance to a Spectrum instance?

Spectrum to Spectrum Transfer Yes

Are you transferring your data from one Spectrum instance to No
another?

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 13

Information Needed to Install Spectrum Database in Oracle

If you are installing the Spectrum database in Oracle, gather the following information
before beginning the installation process. Loftware recommends that you fill out the
following table to use as a guide during the installation process. The Response column
contains examples in italics.

Required Information Response

Location on the client computer C:\app\oracle\product\12.x.x\dbhome_1

where Oracle Database is installed /app/oracle/product/12.x.x/dbhome_1
(ORACLE_HOME)

Location on the client computer C:\app\oracle

where Oracle software and /app/oracle
configuration files are stored
(ORACLE_BASE)

Spectrum database name without orcl or loftstore

domain

Spectrum database domain loftwareinc.com

Spectrum database hostname dbserver

Spectrum database port 1521

Spectrum database connection type SID or SN

(System Identifier or Service Name)

Spectrum database System Identifier SID orcl or loftstore

or Service Name SN orcl.loftwareinc.com

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 14

Required Information Response

Location on the client computer C:\app\Administrator\oradata\orcl

where data for the Spectrum /app/administrator/oradata/orcl
database is stored (datafile location)

Whether your Oracle Database is Yes

using bigfile tablespaces No

Location to store print job data C:\Loftware\Spectrum\LoftStore\exports\archive

(job archive datafile location) /opt/loftware/spectrum/loftstore/exports/archive

Number of months to store archive 12

data (job archive retention)

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 15

Information Needed to Install Spectrum Database in PostgreSQL

If you are installing the Spectrum database in PostgreSQL, gather the following
information before beginning the installation process. Loftware recommends that you fill
out the following table to use as a guide during the installation process. The Response
column contains examples in italics.

Required Information Response

Spectrum database name without postgres11 or loftstore

domain new Database: loftstore

Spectrum database hostname dbserver

KOB05215

Spectrum database port 5432

5432

Location to store print job data C:\Loftware\Spectrum\LoftStore\exports\archive

(job archive datafile location) /opt/loftware/spectrum/loftstore/exports/archive
share the folder for access of KOB05220/21(create file system)

Number of months to store archive 12

data (job archive retention) 1 (Month)

Location of the PostgreSQL binary C:\Program Files\PostgreSQL\11\bin

(bin) directory /opt/postgreSQL/11/bin
/usr/lib/postgresql14/bin/

PostgreSQL database username postgres

postgres

Location to create the Spectrum C:\Loftware\LoftStore\data

database tablespaces /opt/loftware/spectrum/loftstore/data/
(unless using existing tablespaces)

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 16

Deploying Spectrum in Amazon Relational Database Service

You can use Amazon Relational Database Service (Amazon RDS) for Oracle Database
or for PostgreSQL for your Spectrum database (LoftStore).

High Availability and Failover

You can provide high availability and failover to your database by using Amazon's Multi-
AZ deployment. Multi-AZ Deployment can be selected when creating a database
instance or restoring a snapshot, or you can convert an existing database instance from
Amazon's console.

Note: When failing over to a different Availability Zone, there will be a 60 to 120 second
interval during which the Spectrum Application Server cannot connect to the database.
For more information about how Amazon RDS handles failover, see Amazon Relational
Database Service - High Availability (Multi-AZ).

Port Requirements for Cloud-Based Services

When running a Spectrum Application Server with multiple services in a cloud-based

system such as Amazon Web Services (AWS), you must open ports on the firewall to
allow for communication between the Spectrum Application Servers and the Spectrum
Database Server.

The following ports need to be opened for UDP and TCP inbound and outbound.

Note: Although these are the default ports, your site may use different port assignments.

l 8080 l 61616
l 8443 l 16161
l 1521

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 17

Additional Download Packages

When the main installation tasks on the server are complete, there are additional options
packaged in files that reside on the Spectrum Application Server in the following location:

<SPECTRUM_HOME>\product\webapps\downloads\

Note: <SPECTRUM_HOME> represents the folder on the Spectrum Application Server

in which the Spectrum application is installed. For example, in Windows Server this
might be C:\Loftware\Spectrum\Spectrum, and in Linux this might be
/opt/loftware/spectrum/Spectrum. Although procedures in this documentation typically
use backslashes in operating system paths, you should use forward slashes if required
by your operating system.

To download the packages from a remote client computer using a browser, use the
following address:

http://<SpectrumServer>:8080/downloads/

Note: Although 8080 is the default port assignment, your site may use a different port
assignment.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 18

Installing the Spectrum Database

Loftware Spectrum uses a dedicated persistent data structure named LoftStore as the
Spectrum database. This can be installed into an existing Oracle database or
PostgreSQL database. Alternatively, you can use Amazon Relational Database Service
(Amazon RDS) for Oracle Database or for PostgreSQL.

This section describes how to install the Spectrum database, LoftStore. Before
performing the procedures in this section, be sure you have reviewed and completed the
questions in Preparing for Installation.

To install the Spectrum database, use the following procedure for your operating system
and database:

Install Spectrum Database in Oracle on Windows Server 20

Install Spectrum Database in Oracle on Linux 29

Install Spectrum Database in PostgreSQL on Windows Server 38

Install Spectrum Database in PostgreSQL on Linux 48

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 19

Install Spectrum Database in Oracle on Windows Server

The Spectrum database is a dedicated persistent data repository called LoftStore that
can be installed in an existing Oracle database on Amazon RDS, a local server, or a
private cloud. This section describes how to install the Spectrum database in Oracle on a
server running a Windows Server operating system.

Installing the Spectrum database in Oracle on Windows Server involves the following
tasks:

A. Check Prerequisites
B. Create Installation Folders
C. Install the Spectrum Database (LoftStore)

The following references are used in this section:

l Spectrum Database Server refers to the LoftStore/Oracle Database host server.

l Client refers to the computer from which you are running the Spectrum database
installation. The client computer is running a Windows Server operating system.

A. Check Prerequisites

Prerequisites for the Database Server

The prerequisites for the Spectrum Database Server include the following.

l You are using one of the following:

l Oracle Database 19c
l Oracle Database 12c, version 12.2.0.1
l Oracle Database 12c, version 12.1.0.1 or later 12.1 versions
l Oracle Database 11g, version 11.2.0.4 or later
l You are not installing into a container database. If using a version of Oracle
Database that includes a Create as Container database option, that check box
must be cleared in the Typical Install Configuration window.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 20

 l The Database Character Set configuration option in Oracle is set to Unicode
(AL32UTF8).

Important! Oracle recommends using the Unicode character set AL32UTF8, as

UTF8 is no longer supported.

l You have created a backup of the existing database (a recommended best

practice).
l You have already created a database instance.
l You are performing the Spectrum database installation as an Administrator in
Windows Server. This user must have the necessary privileges to run the Oracle
administrative tools.
l For an existing database, you have considered any password expiration policies
that could impact the behavior of the Spectrum instance and have made allowances
as needed for the Spectrum database user (default is loftuser). For more
information, refer to Oracle Database Users.

Prerequisites for the Installing Computer

The prerequisites related to the installing computer include the following.

l There is network connectivity to the Spectrum Database Server.

l Oracle Administrative client is installed to run SQL*PLUS and IMPDP.
l The Spectrum Database Server has access to the following on the installing
computer:
l Path for the DMP file used to create the schemas
l Path for the archive output files
l Path to the new database datafiles

B. Create Installation Folders

Perform the following steps on the client computer and the Spectrum Database Server.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 21

 1. From the Loftware Spectrum installation package, copy the LoftstoreLoad-win.zip
file to a temporary folder on the client computer.

2. Create a new folder for this installation package.

Recommended Location

C:\Loftware\Spectrum\LoftStore

3. Extract the contents of LoftstoreLoad-win.zip package to the new folder.

Example

Using the recommended location, the following folders are created:

l C:\Loftware\Spectrum\LoftStore\data
l C:\Loftware\Spectrum\LoftStore\exports
l C:\Loftware\Spectrum\LoftStore\load
l C:\Loftware\Spectrum\LoftStore\setup

4. On the Spectrum Database Server, identify or create a folder for the data load. This
can be a temporary folder.

5. From the \exports folder you extracted, copy LOFTSTORE.DMP to the data load
folder.

6. On the Spectrum Database Server, identify or create a folder for the Spectrum
archive data. This folder must be managed for long term archive data collection. For
more information, see Managing Offline Storage.

Example

C:\Loftware\Spectrum\LoftStore\exports\archive

7. On the Spectrum Database Server, identify or create a folder for the new Oracle
datafiles.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 22

C. Install the Spectrum Database (LoftStore)

You must perform the Spectrum database installation as an Administrator in Windows

Server. This user must have the necessary privileges to run the Oracle administrative
tools.

To install the Spectrum database, perform the following steps.

1. Open a Command Prompt window as an Administrator in Windows Server and

navigate to the setup folder created when you extracted the LoftstoreLoad-win.zip
file.

2. Do the following to provide information about your system necessary to configure

the loading of the database.

a. Run the following command:

configureDBLoad

b. Respond to the following prompts:

Important! Do not accept the default values, because they only offer a
limited local configuration. Loftware recommends specifying values for the
installation prompts that match your site's configuration.

Enter LOFTSTORE_HOME [default value]:

<LOFTSTORE_HOME> refers to the folder in which the database

configuration files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore. If you do not accept the default value, you
can set this location as a system variable for easier reference.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 23

 Enter ORACLE_HOME [default value]:

ORACLE_HOME defines the full folder path of the Oracle components on the
client computer running the installation. The default value is imported from the
system variable of the same name. If you do not accept the default value, you
can set this location as a system variable for easier reference. Example:
C:\app\oracle\product\12.x.x\dbhome_1.

Enter ORACLE_BASE [default value]:

ORACLE_BASE is the root of the Oracle installed folders on the client

computer running the installation, and specifies the upper portion of the
ORACLE_HOME full folder path. Example: C:\app\oracle

Enter LoftStore database name without domain [default value]:

The Spectrum database name without domain distinguishes it from any other
databases on the server. Example: orcl or loftstore

Enter LoftStore database domain [default value]:

Database domain identifies the network domain for this database. Example:
loftwareinc.com

Enter LoftStore database hostname [default value]:

The hostname of the Spectrum database identifies the server where the
database is installed. Example: DBServer or localhost

Enter LoftStore database port [default value]:

The port value on the database server for the Spectrum database, which
identifies the TCP/IP endpoint for a host connection. Example: 1521

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 24

 Enter LoftStore database connection type (System Identifier
(SID) or Service Name (SN)) [default value]:

The database connection type to use, which must be one of the following:
l The System Identifier (SID) identifies a specific instance of the database
on your server.
l The Service Name (SN) is a representative name for the database,
which is usually the Global database name, consisting of the database
and domain names. The SN needs to be the fully qualified service name
your site uses. Consult your database administrator for your site's fully
qualified naming convention.

Enter LoftStore database SID or SN [default value]:

The System Identifier (SID) or Service Name (SN) of the specific instance of
the Spectrum database on your server.
l Example for SID: loftstore or orcl
l Example for SN: orcl.loftwareinc.com

Enter LoftStore datafile location [default value]:

The database data file location contains the actual data for the Spectrum
database. This path must be available to the database server. Example:
C:\app\Administrator\oradata\orcl

Are Bigfile tablespaces in use? (Y|N) [default value]:

Bigfile tablespaces is an Oracle feature. Consult your database administrator

and the Oracle documentation to determine if your system is using this
feature.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 25

 Use Loftware-supplied tablespaces? (Y|N) [default value]:

To use new Loftware-supplied tablespaces created by the installer, enter Y

(recommended).

To use existing tablespaces, enter N and provide your custom tablespace

names at the following prompts.

Important! The custom tablespace names must use lowercase alphanumeric

characters only.

Enter the tablespace for LoftSpec [SPECTRUM_MAIN]

Enter the tablespace for Loftaudit [SPECTRUM_AUDIT]

Enter the tablespace for Loftarch [SPECTRUM_ARCH]

Enter the tablespace for Loftxref [SPECTRUM_CUST]

Enter the tablespace for DaVinci [SPECTRUM_DAVINCI]

Example
mycustomname_spectrum_main
mycustomname_spectrum_audit
mycustomname_spectrum_arch
mycustomname_spectrum_cust
mycustomname_spectrum_davinci

Enter LoftStore dump file location [default value]:

The folder containing the LOFTSTORE.DMP file on the database server to be

used to load data for the installation. This path must be available to the
database server. Example:
C:\Loftware\Spectrum\LoftStore\exports

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 26

 Enter job archive datafile location [default value]:

Job archive datafile location is where print jobs and all related messages are
stored after they go out of the database. This path must be available to the
database server. Example:
C:\Loftware\Spectrum\LoftStore\exports\archive

Enter job archive retention in months [default value]:

Job archive retention specifies the how many months you want to store the
archive data. The number of months does affect database size. Example: 12

When configureDBLoad finishes running, continue to the next step.

3. Do the following to perform the loading of the database.

a. Run the following command:

ls_schemas

b. Respond to the following prompts:

Is the LoftStore database being deployed in Amazon RDS (Y|N)
[default value]:

If you are deploying an Amazon RDS instance of the Spectrum database,

enter Y for yes. Otherwise, enter N for no.
If you responded yes, respond to the following prompts.

Enter Amazon RDS master username:

Reenter Amazon RDS master username:
Enter the password for lwadmin:
Reenter the password for lwadmin:
Enter the password for loftuser:
Reenter the password for loftuser:
Enter the password for loftreports:
Reenter the password for loftreports:
Enter the password for LOFTDVUSER :
Reenter the password for LOFTDVUSER :

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 27

 If you responded no, respond to the following prompts.

Enter the password for SYS:

Reenter the password for SYS:
Enter the password for loftuser:
Reenter the password for loftuser:
Enter the password for loftreports:
Reenter the password for loftreports:
Enter the password for LOFTDVUSER :
Reenter the password for LOFTDVUSER :

Note: You may see error messages regarding dropping user and
tablespaces during ls_schemas processing, permission denied to set
parameter "loft_spec.user_id", tables declared WITH OIDS are not
supported, or cannot issue GRANT on the "pg_write_server_files" role.
These errors can be ignored at this time.

The Spectrum database (LoftStore) is now available as an instance in the Oracle

database.

Next Step

You have completed installing the Spectrum database. Continue with Installing
the Spectrum Application.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 28

Install Spectrum Database in Oracle on Linux

The Spectrum database is a dedicated persistent data repository called LoftStore that
can be installed in an existing Oracle database on Amazon RDS, a local server, or a
private cloud. This section describes how to install the Spectrum database in Oracle on a
server running a Linux operating system.

Installing the Spectrum database in Oracle on Linux involves the following tasks:

A. Check Prerequisites
B. Create Installation Folders
C. Install the Spectrum Database (LoftStore)

The following references are used in this section:

l Spectrum Database Server refers to the LoftStore/Oracle Database host server.

l Client refers to the computer from which you are running the Spectrum database
installation. The client computer is running a Linux operating system.

A. Check Prerequisites

Prerequisites for the Database Server

The prerequisites related to the Spectrum Database Server include the following.

l You are using one of the following:

l Oracle Database 19c
l Oracle Database 12c, version 12.2.0.1
l Oracle Database 12c, version 12.1.0.1 or later 12.1 versions
l Oracle Database 11g, version 11.2.0.4 or later
l You are not installing into a container database. If using a version of Oracle
Database that includes a Create as Container database option, that check box
must be cleared in the Typical Install Configuration window.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 29

 l The Database Character Set configuration option in Oracle is set to Unicode
(AL32UTF8).

Important! Oracle recommends using the Unicode character set AL32UTF8, as

UTF8 is no longer supported.

l You have created a backup of the existing database (a recommended best

practice).
l You have already created a database instance.
l You are performing the Spectrum database installation as the Linux user that was
created during the installation of the Oracle Database software. This user is
typically named oracle and has the necessary privileges to run the Oracle
administrative tools.
l For an existing database, you have considered any password expiration policies
that could impact the behavior of the Spectrum instance and have made allowances
as needed for the Spectrum database user (default is loftuser). For more
information, refer to Oracle Database Users.

Prerequisites for the Installing Computer

The prerequisites related to the installing computer include the following.

l There is network connectivity to the Spectrum Database Server.

l Oracle Administrative client can connect with SQL*PLUS and IMPDP.
l The Spectrum Database Server has access to the following on the installing
computer:
l Path for the DMP file used to create the schemas
l Path for the archive output files
l Path to the new database datafiles

B. Create Installation Folders

Perform the following steps on the client computer and the Spectrum Database Server.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 30

 1. From the Loftware Spectrum installation package, copy the LoftstoreLoad-linux.zip
file to a temporary folder on the client computer.

2. Create a new folder for this installation package.

Recommended Location

/opt/loftware/spectrum/loftstore

3. Extract the contents of LoftstoreLoad-linux.zip package to the new folder.

Example

Using the recommended location, the following folders are created:

l /opt/loftware/spectrum/loftstore/data
l /opt/loftware/spectrum/loftstore/exports
l /opt/loftware/spectrum/loftstore/load
l /opt/loftware/spectrum/loftstore/setup

4. On the Spectrum Database Server, identify or create a folder for the data load. This
can be a temporary folder.

5. From the /exports folder you extracted, copy LOFTSTORE.DMP to the data load
folder.

6. On the Spectrum Database Server, identify or create a folder for the Spectrum
archive data. This folder must be managed for long term archive data collection. For
more information, see Managing Offline Storage.

7. On the Spectrum Database Server, identify or create a folder for the new Oracle
datafiles.

C. Install the Spectrum Database (LoftStore)

You must perform the Spectrum database installation as the Linux user that was created
during the installation of the Oracle Database software. This user is typically named
oracle and has the necessary privileges to run the Oracle administrative tools.

To install the Spectrum database, perform the following steps.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 31

 1. Open a terminal window and navigate to the setup folder created when you
extracted the LoftstoreLoad-linux.zip file.

2. Do the following to provide information about your system necessary to configure

the loading of the database.

a. Run the following command:

configureDBLoad.sh

b. Respond to the following prompts:

Important! Do not accept the default values, because they only offer a
limited local configuration. Loftware recommends specifying values for the
installation prompts that match your site's configuration.

Enter LOFTSTORE_HOME [default value]:

<LOFTSTORE_HOME> refers to the folder in which the database

configuration files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore. If you do not accept the default value, you
can set this location as a system variable for easier reference.

Enter ORACLE_HOME [default value]:

ORACLE_HOME defines the full folder path of the Oracle components on the
client computer running the installation. The default value is imported from the
system variable of the same name. If you do not accept the default value, you
can set this location as a system variable for easier reference. Example:
/app/oracle/product/12.x.x/dbhome_1

Enter ORACLE_BASE [default value]:

ORACLE_BASE is the root of the Oracle installed folders on the client

computer running the installation, and specifies the upper portion of the
ORACLE_HOME full folder path. Example: /app/oracle

Enter LoftStore database name without domain [default value]:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 32

 The Spectrum database name without domain distinguishes it from any other
databases on the server. Example: orcl or loftstore

Enter LoftStore database domain [default value]:

Database domain identifies the network domain for this database. Example:
loftwareinc.com

Enter LoftStore database hostname [default value]:

The hostname of the database identifies the server where the Spectrum
database is installed. Example: DBServer or localhost

Enter LoftStore database port [default value]:

The port value on the database server for the Spectrum database, which
identifies the TCP/IP end point for a host connection. Example: 1521

Enter LoftStore database connection type (System Identifier

(SID) or Service Name (SN)) [default value]:

The database connection type to use, which must be one of the following:

l The System Identifier (SID) identifies a specific instance of the database

on your server.
l The Service Name (SN) is a representative name for the database,
which is usually the Global database name, consisting of the database
and domain names. The SN needs to be the fully qualified service name
your site uses. Consult your database administrator for your site's fully
qualified naming convention.

Enter LoftStore database SID or SN [default value]:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 33

 The System Identifier (SID) or Service Name (SN) of the specific instance of
the Spectrum database on your server.
l Example for SID: loftstore or orcl
l Example for SN: orcl.loftwareinc.com

Enter LoftStore datafile location [default value]:

The database data file location contains the actual data for the Spectrum
database. This path must be available to the database server. Example:
/app/administrator/oradata/orcl

Are Bigfile tablespaces in use? (Y|N) [N]:

Bigfile tablespaces is an Oracle feature. Consult your database administrator

and the Oracle documentation to determine if your system is using this
feature.

Use Loftware-supplied tablespaces? (Y|N) [default value]:

To use new Loftware-supplied tablespaces created by the installer, enter Y

(recommended).

To use existing tablespaces, enter N and provide your custom tablespace

names at the following prompts.

Important! The custom tablespace names must use lowercase alphanumeric

characters only.

Enter the tablespace for LoftSpec [SPECTRUM_MAIN]

Enter the tablespace for Loftaudit [SPECTRUM_AUDIT]

Enter the tablespace for Loftarch [SPECTRUM_ARCH]

Enter the tablespace for Loftxref [SPECTRUM_CUST]

Enter the tablespace for DaVinci [SPECTRUM_DAVINCI]

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 34

 Example
mycustomname_spectrum_main
mycustomname_spectrum_audit
mycustomname_spectrum_arch
mycustomname_spectrum_cust
mycustomname_spectrum_davinci

Enter LoftStore dump file location [default value]:

The folder containing the LOFTSTORE.DMP file on the database server to be

used to load data for the installation. This path must be available to the
database server. Example:
/opt/loftware/spectrum/loftstore/exports

Enter job archive datafile location [default value]:

Job archive datafile location is where print jobs and all related messages are
stored after they go out of the database. This path must be available to the
database server. Example:
/opt/loftware/spectrum/loftstore/exports/archive

Enter job archive retention in months [default value]:

Job archive retention specifies the how many months you want to store the
archive data. The number of months does affect database size. Example: 12

When configureDBLoad finishes running, continue to the next step.

3. Do the following to perform the loading of the database.

a. Run the following command:

ls_schemas.sh

b. Respond to the following prompts:

Is the LoftStore database being deployed in Amazon RDS (Y|N)
[default value]:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 35

 If you are deploying an Amazon RDS instance of the Spectrum database,
enter Y for yes. Otherwise, enter N for no.
If you responded yes, respond to the following prompts.

Enter Amazon RDS master username:

Reenter Amazon RDS master username:
Enter the password for lwadmin:
Reenter the password for lwadmin:
Enter the password for loftuser:
Reenter the password for loftuser:
Enter the password for loftreports:
Reenter the password for loftreports:
Enter the password for LOFTDVUSER :
Reenter the password for LOFTDVUSER :

If you responded no, respond to the following prompts.

Enter the password for SYS:

Reenter the password for SYS:
Enter the password for loftuser:
Reenter the password for loftuser:
Enter the password for loftreports:
Reenter the password for loftreports:
Enter the password for LOFTDVUSER :
Reenter the password for LOFTDVUSER :

Note: You may see error messages regarding dropping user and
tablespaces during ls_schemas processing, permission denied to set
parameter "loft_spec.user_id", tables declared WITH OIDS are not
supported, or cannot issue GRANT on the "pg_write_server_files" role.
These errors can be ignored at this time.

The Spectrum database (LoftStore) is now available as an instance in the Oracle

database.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 36

Next Step

You have completed installing the Spectrum database. Continue with Installing
the Spectrum Application.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 37

Install Spectrum Database in PostgreSQL on Windows Server

The Spectrum database is a dedicated persistent data repository called LoftStore that
can be installed in a PostgreSQL database. These instructions are for installing the
Spectrum database in PostgreSQL on a server running a Windows Server operating
system.

Installing the Spectrum database in PostgreSQL on Windows Server involves the

following tasks:

A. Check Prerequisites
B. Create Installation Folders
C. Install the Spectrum Database (LoftStore)

The following reference is used in this document:

l Spectrum Database Server refers to the LoftStore/PostgreSQL host server.

A. Check Prerequisites

The prerequisites for the Spectrum Database Server include the following.

l You have installed and are using a supported version of PostgreSQL for Spectrum
4.7.1. For the most recent list of supported PostgreSQL database versions, see
Requirements for Loftware Spectrum Database Server in the Spectrum User Guide
(Help).

Note: If needed, you can download the installer from

https://www.postgresql.org/download. For more information about installing and
configuring PostgreSQL, see the PostgreSQL website
(https://www.postgresql.org).

l You have installed the psql utility.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 38

 l You have confirmed that the PostgreSQL locale settings LC_COLLATE and LC_
CTYPE are properly configured for your operating system and language. In
addition, it is recommended that the server encoding in PostgreSQL is set to
Unicode (UTF8).
l You have created a backup of the existing database (a recommended best
practice).
l You are performing the Spectrum database installation as an Administrator in
Windows Server.
l You have set the system environment variable PATH to reference the location of
the psql utility.
l For an existing database, you have considered any password expiration policies
that could impact the behavior of the Spectrum instance and have made allowances
as needed for the Spectrum database user (default is loftuser). For more
information, refer to PostgreSQL Database Roles.

B. Create Installation Folders

To prepare for installation of the Spectrum database, perform the following steps on the
Spectrum Database Server.

1. From the Loftware Spectrum installation package, copy the LoftstoreLoad-

PSQL.zip file to a temporary folder.

2. Create a new folder for this installation package. This is referred to as your
<LOFTSTORE_HOME> folder.

Recommended Location

C:\Loftware\Spectrum\LoftStore

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 39

 3. Extract the contents of LoftstoreLoad-PSQL.zip package to the new
<LOFTSTORE_HOME> folder.

Example

Using the recommended location, the C:\Loftware\Spectrum\LoftStore\setup folder

is created.

4. For the Spectrum database tablespaces, decide which of the following you want to
use:
l Tablespaces created by the installer with default names (recommended).
l Tablespaces created by the installer with custom names.
l Tablespaces that already exist with custom names.

5. If you want to use tablespaces created by the installer with default names, skip this
step (recommended).
If you want to use tablespaces created by the installer with custom names or use
tablespaces that already exist with custom names, do the following.

a. Navigate to the setup folder you extracted, and then open the
loftstore.properties.tmpl file in a text editor.

b. Under the # Tablespace Names section, edit the following to be the custom
names of the tablespaces to be created by the installer or of the existing
tablespaces.

Important! The custom tablespace names must use lowercase alphanumeric

characters only.

loftstore.tbsp.main=${cust_prefix}SPECTRUM_MAIN
loftstore.tbsp.audit=${cust_prefix}SPECTRUM_AUDIT
loftstore.tbsp.arch=${cust_prefix}SPECTRUM_ARCH
loftstore.tbsp.cust=${cust_prefix}SPECTRUM_CUST
loftstore.tbsp.davinci=${cust_prefix}SPECTRUM_DAVINCI

Example

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 40

 loftstore.tbsp.main=mycustomname_spectrum_main
loftstore.tbsp.audit=mycustomname_spectrum_audit
loftstore.tbsp.arch=mycustomname_spectrum_arch
loftstore.tbsp.cust=mycustomname_spectrum_cust
loftstore.tbsp.davinci=mycustomname_spectrum_davinci

6. Identify or create a folder to store the Spectrum archive data (the print job data and
related messages that are no longer in use). This folder must be managed for long-
term archive data collection. For more information, see Managing Offline Storage.

Example

C:\Loftware\Spectrum\LoftStore\exports\archive

7. The Spectrum archive data folder must be owned by the user who runs the
PostgreSQL service (the NETWORK SERVICE user). To grant the necessary
permissions to the archive data folder, do the following.

a. Right-click the folder and select Properties.

b. Click the Security tab.

c. Click Edit to change permissions.

d. Click Add.

e. Under Enter the object names to select, type NETWORK SERVICE and
then click OK.

f. Under Permissions for NETWORK SERVICE, select all the check boxes
under Allow.

g. Click Apply, and then click OK.

C. Install the Spectrum Database (LoftStore)

To install the Spectrum database, perform the following steps as an Administrator in

Windows Server.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 41

 1. Open a Command Prompt window and navigate to the setup folder created when
you extracted the LoftstoreLoad-PSQL.zip file.

2. Do the following to provide information about your system necessary to configure

the loading of the database.

a. Run the following command:

postgresConfig

b. Respond to the following prompts:

Important! Do not accept the default values, because they only offer a
limited local configuration. Loftware recommends specifying values for the
installation prompts that match your site's configuration.

Enter LOFTSTORE_HOME [default value]:

<LOFTSTORE_HOME> refers to the folder in which the database

configuration files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore. If you do not accept the default value, you
can set this location as a system variable for easier reference.

Enter LoftStore database name without domain [default value]:

The Spectrum database name without domain distinguishes it from any other
databases on the server. Example: Postgres11 or loftstore

Enter LoftStore database hostname [default value]:

The hostname of the Spectrum database identifies the server where the
database is installed. Example: DBServer or localhost

Enter LoftStore database port [default value]:

The port value on the database server for the Spectrum database, which
identifies the TCP/IP end point for a host connection. Example: 5432

Enter job archive datafile location [default value]:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 42

 The location you identified or created in a previous step to store the Spectrum
archive data. This location must be available to the database server.
Example: C:\Loftware\Spectrum\LoftStore\exports\archive

Enter job archive retention in months [default value]:

Specify how many months you want to store the archive data. The number of
months affects database size. Example: 12

Enter the path to the PostgreSQL binary (bin) directory

[default value]:

Enter the location of the PostgreSQL installation binary (bin) folder for
executable programs. Example: C:\Program
Files\PostgreSQL\11\bin

When postgresConfig finishes running, continue to the next step.

3. For the Spectrum database tablespaces, if you decided in an earlier step to use
existing tablespaces with custom names, skip this step.
If you decided to use tablespaces created by the installer with default names or
custom names, do the following to create the tablespaces.

a. Run the following command:

prereq
Respond to the following prompts:
Enter the postgres admin username:

Enter the PostgreSQL administrator login role (comparable to a username or

group name) for the PostgreSQL server that is used to sign in to the database
by database administrators.
Example: postgres

Enter the password for <postgres>:

Enter the password for the PostgreSQL administrator login role.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 43

 Reenter the password for <postgres>:

Confirm the password for the PostgreSQL administrator login role.

Is the LoftStore database being deployed in Amazon RDS (Y|N)

[default value]:

If you are deploying an Amazon RDS instance of the Spectrum database,

enter Y for yes. Otherwise, enter N for no.

Enter the LoftStore database file location for TBS [default

value]:

Specify the folder where you want the tablespaces to be created. The folder
does not have to exist yet.
Example: C:\Loftware\LoftStore\data

Password for user <postgres>:

Confirm the password for the PostgreSQL administrator login role.

4. Do the following to perform the loading of the database.

a. Run the following command:

ls_schemas

b. Respond to the following prompts:

Enter the postgres admin username:

Enter the PostgreSQL administrator login role (comparable to a username or

group name) for the PostgreSQL server that is used to sign in to the database
by database administrators. Example: postgres

Enter the password for <postgres>:

Enter the password for the PostgreSQL administrator login role.

Reenter the password for <postgres>:

Confirm the password for the PostgreSQL administrator login role.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 44

 Enter the password for loftuser:

Enter a password for the Spectrum database user (loftuser).

Reenter the password for loftuser:

Confirm the password for the Spectrum database user (loftuser).

Enter the password for LOFTDVUSER:

Enter a password for the Spectrum DaVinci database user (loftdvuser).

Reenter the password for LOFTDVUSER:

Confirm the password for the Spectrum DaVinci database user (loftdvuser).

Note: You may see error messages regarding dropping user and
tablespaces during ls_schemas processing, permission denied to set
parameter "loft_spec.user_id", tables declared WITH OIDS are not
supported, or cannot issue GRANT on the "pg_write_server_files" role.
These errors can be ignored at this time.

The Spectrum database (LoftStore) is now available as an instance in the

PostgreSQL database.

5. On the Spectrum Database Server, do the following to set up archive jobs for
Spectrum.

a. Navigate to application data (AppData) folder of the PostgreSQL

administrator login role.

Example

C:\Users\postgres\AppData\Roaming

Tip: To find the location of the AppData folder (also known as the
%APPDATA% system environment variable), open a Command Prompt
window and run the echo %APPDATA% command.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 45

 b. Navigate to the postgresql folder, or create a secure postgresql folder if one
does not exist.

Example

C:\Users\postgres\AppData\Roaming\postgresql

c. In a text editor, open the PostgreSQL password file pgpass.conf, or create a

pgpass.conf file if one does not exist.

Important! The pgpass.conf file must be stored in a secure folder.

d. Add the following text for the PostgreSQL administrator login role:

<hostname>:<port>:<database>:<username>:<password>

Example

localhost:5432:loftstore:postgres:mypassword

e. Save and close the file.

f. Open a Command Prompt window and navigate to the <LOFTSTORE_

HOME>\setup folder.

g. Run the following command to add the Spectrum Archive jobs to the Windows
Task Scheduler:
schedule_jobs

h. Open the Windows Task Scheduler and confirm that:

l Both of the archiving tasks are displayed, archive_jobs_loftstore and
manage_archive_tables_loftstore
l The correct account is specified under When running the task, use the
following account
l Run whether user is logged on or not is selected

Tip: PostgreSQL remote connections are closed by default. To open access for remote
connection, edit the IPv4 local connections address in the ~/data/pg_hba.conf file
on the PostgreSQL server before installing the Spectrum application.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 46

Next Step

You have completed installing the Spectrum database. Continue with Installing
the Spectrum Application.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 47

Install Spectrum Database in PostgreSQL on Linux

The Spectrum database is a dedicated persistent data repository called LoftStore that
can be installed in a PostgreSQL database. These instructions are for installing the
Spectrum database in PostgreSQL on a server running a Linux operating system.

Installing the Spectrum database in PostgreSQL on Linux involves the following tasks:

A. Check Prerequisites
B. Create Installation Folders
C. Install the Spectrum Database (LoftStore)

The following reference is used in this document:

l Spectrum Database Server refers to the LoftStore/PostgreSQL host server.

A. Check Prerequisites

The prerequisites for the Spectrum Database Server include the following.

l You have installed and are using a supported version of PostgreSQL for Spectrum
4.7.1. For the most recent list of supported PostgreSQL database versions, see
Requirements for Loftware Spectrum Database Server in the Spectrum User Guide
(Help).

Note: If needed, you can download the installer from

https://www.postgresql.org/download. For more information about installing and
configuring PostgreSQL, see the PostgreSQL website
(https://www.postgresql.org).

l You have installed the psql utility.

l You have confirmed that the PostgreSQL locale settings LC_COLLATE and LC_
CTYPE are properly configured for your operating system and language. In
addition, it is recommended that the server encoding in PostgreSQL is set to
Unicode (UTF8).

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 48

 l You have installed the postgresql-contrib package that matches your target version
of PostgreSQL.
l If the PostgreSQL database is on a server running Red Hat Enterprise Linux, you
have a Red Hat subscription.
l You have created a backup of the existing database (a recommended best
practice).
l You are performing the Spectrum database installation as the Linux user that acts
as the PostgreSQL system user (default is postgres).

Note: By default, the PostgreSQL system user does not have a password. If you
prefer not to give this user a password, you may run the installation scripts as a
sudo user from a login shell for the PostgreSQL system user (for example, sudo
su - postgres), however the sudo user cannot run the scripts directly.

l You have set the system environment variable PATH to reference the location of
the psql utility.
l For an existing database, you have considered any password expiration policies
that could impact the behavior of the Spectrum instance and have made allowances
as needed for the Spectrum database user (default is loftuser). For more
information, refer to PostgreSQL Database Roles.

B. Create Installation Folders

To prepare for installation of the Spectrum database, perform the following steps on the
Spectrum Database Server.

1. From the Loftware Spectrum installation package, copy the LoftstoreLoad-

PSQL.zip file to a temporary folder.

2. Create a new folder for this installation package. This is referred to as your
<LOFTSTORE_HOME> folder.

Recommended Location

/opt/loftware/spectrum/loftstore mkdir -p

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 49

 3. Extract the contents of LoftstoreLoad-PSQL.zip package to the new
<LOFTSTORE_HOME> folder. unzip LoftstoreLoad-PSQL.zip

Example

Using the recommended location, the /opt/loftware/spectrum/loftstore/setup folder

is created.

4. Ensure that the loftstore folder, all subfolders, and all files are owned by and
accessible to the PostgreSQL system user or modify if necessary.

5. For the Spectrum database tablespaces, decide which of the following you want to
use:
l Tablespaces created by the installer with default names (recommended).
l Tablespaces created by the installer with custom names.
l Tablespaces that already exist with custom names.

6. If you want to use tablespaces created by the installer with default names, skip this
step (recommended).
If you want to use tablespaces created by the installer with custom names or use
tablespaces that already exist with custom names, do the following.

a. Navigate to the setup folder you extracted, and then open the
loftstore.properties.tmpl file in a text editor.

b. Under the # Tablespace Names section, edit the following to be the custom
names of the tablespaces to be created by the installer or of the existing
tablespaces.

Important! The custom tablespace names must use lowercase alphanumeric

characters only.

loftstore.tbsp.main=${cust_prefix}SPECTRUM_MAIN
loftstore.tbsp.audit=${cust_prefix}SPECTRUM_AUDIT
loftstore.tbsp.arch=${cust_prefix}SPECTRUM_ARCH
loftstore.tbsp.cust=${cust_prefix}SPECTRUM_CUST
loftstore.tbsp.davinci=${cust_prefix}SPECTRUM_DAVINCI

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 50

 Example

loftstore.tbsp.main=mycustomname_spectrum_main
loftstore.tbsp.audit=mycustomname_spectrum_audit
loftstore.tbsp.arch=mycustomname_spectrum_arch
loftstore.tbsp.cust=mycustomname_spectrum_cust
loftstore.tbsp.davinci=mycustomname_spectrum_davinci

7. On the Spectrum Database Server, identify or create a folder to store the Spectrum
archive data (the print job data and related messages that are no longer in use).
This folder must be owned by the PostgreSQL system user and managed for long-
term archive data collection. For more information, see Managing Offline Storage.

Example

/opt/loftware/spectrum/loftstore/exports/archive (get shared folders via df -H)

/opt/loftware/spectrum/loftstore/job-archive
C. Install the Spectrum Database (LoftStore)

To install the Spectrum database, perform the following steps as the PostgreSQL system
user.

1. Open a terminal and navigate to the setup folder created when you extracted the
LoftstoreLoad-PSQL.zip file.

2. Do the following to provide information about your system necessary to configure

the loading of the database.

a. Run the following command:

./postgresconfig.sh

b. Respond to the following prompts:

Important! Do not accept the default values, because they only offer a
limited local configuration. Loftware recommends specifying values for the
installation prompts that match your site's configuration.

Enter LOFTSTORE_HOME [default value]:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 51

 <LOFTSTORE_HOME> refers to the folder in which the database
configuration files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore. If you do not accept the default value, you
can set this location as a system variable for easier reference.

Enter LoftStore database name without domain [default value]:

The Spectrum database name without domain distinguishes it from any other
databases on the server. Example: postgres11 or loftstore

Enter LoftStore database hostname [default value]:

The hostname of the Spectrum database identifies the server where the
database is installed. Example: dbserver or localhost

Enter LoftStore database port [default value]:

The port value on the database server for the Spectrum database, which
identifies the TCP/IP end point for a host connection. Example: 5432

Enter job archive datafile location [default value]:

The location you identified or created in a previous step to store the Spectrum
archive data. This location must be available to the database server.
Example: /opt/loftware/spectrum/loftstore/exports/archive

Enter job archive retention in months [default value]:

Specify how many months you want to store the archive data. The number of
months affects database size. Example: 12

Enter the path to the PostgreSQL binary (bin) directory

[default value]:

The location of the PostgreSQL installation binary (bin) folder for executable
programs. Example: /opt/postgreSQL/11/bin

When postgresconfig finishes running, continue to the next step.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 52

 3. For the Spectrum database tablespaces, if you decided in an earlier step to use
existing tablespaces with custom names, skip this step. If you decided to use
tablespaces created by the installer with default names or custom names, do the
following to create the tablespaces.

a. Run the following command:

./prereq.sh

b. Respond to the following prompts:

Enter the postgres admin username:

Enter the PostgreSQL administrator login role (comparable to a username or

group name) for the PostgreSQL server that is used to sign in to the database
by database administrators.
Example: postgres

Enter the password for <postgres>:

Enter the password for the PostgreSQL administrator login role.

Reenter the password for <postgres>:

Confirm the password for the PostgreSQL administrator login role.

Is the LoftStore database being deployed in Amazon RDS (Y|N)

[default value]:

If you are deploying an Amazon RDS instance of the Spectrum database,

enter Y for yes. Otherwise, enter N for no.

Enter the LoftStore database file location for TBS [default

value]:

Specify the folder where you want the tablespaces to be created. The folder
does not have to exist yet.
Example: /opt/loftstore/data

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 53

 Password for user <postgres>:

Confirm the password for the PostgreSQL administrator login role.

4. Do the following to perform the loading of the database.

a. Run the following command:

./ls_schemas.sh

b. Respond to the following prompts:

Enter the postgres admin username:

Enter the PostgreSQL administrator login role (comparable to a username or

group name) for the PostgreSQL server that is used to sign in to the database
by database administrators. Example: postgres

Enter the password for <postgres>:

Enter the password for the PostgreSQL administrator login role.

Reenter the password for <postgres>:

Confirm the password for the PostgreSQL administrator login role.

Enter the password for loftuser:

Enter a password for the Spectrum database user (loftuser).

Reenter the password for loftuser:

Confirm the password for the Spectrum database user (loftuser).

Enter the password for LOFTDVUSER:

Enter a password for the Spectrum DaVinci database user (loftdvuser).

Reenter the password for LOFTDVUSER:

Confirm the password for the Spectrum DaVinci database user (loftdvuser).

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 54

 Note: You may see error messages regarding dropping user and tablespaces
during ls_schemas processing, permission denied to set parameter "loft_
spec.user_id", tables declared WITH OIDS are not supported, or cannot issue
GRANT on the "pg_write_server_files" role. These errors can be ignored at this
time.

The Spectrum database (LoftStore) is now available as an instance in the

PostgreSQL database.

5. On the Spectrum Database Server, do the following to set up archive jobs for
Spectrum.

a. Create a .pgpass password file owned by the PostgreSQL System User and
located in that user's home folder (/home/<username>). If the file is created in
any other directory, the directory must be accessible to the PostgreSQL
System User, and an environment variable named PGPASSFILE must be set
to specify the file. If the PGPASSFILE environment variable is needed, it
should be defined in /etc/environment. Otherwise this variable will not be
available to the crontab jobs created by schedule_jobs.sh.

b. Add the following to the .pgpass file for the PostgreSQL administrator login
role:

<hostname>:<port>:<database>:<username>:<password>

Example

localhost:5432:loftstore:postgres:mypassword

c. Set 0600 permissions on the .pgpass file.

Example

chmod 0600 /home/postgres/.pgpass

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 55

 d. Run the following command as a user with sudo privileges. For <username>,
substitute the username of the PostgreSQL system user.
./schedule_jobs.sh <username>

Example

./schedule_jobs.sh postgres check jobs are running with: crontab -l

Tip: PostgreSQL remote connections are closed by default. To open access for remote
connection, edit the IPv4 local connections address in the ~/data/pg_hba.conf file
on the PostgreSQL server before installing the Spectrum application.

Next Step

You have completed installing the Spectrum database. Continue with Installing
the Spectrum Application.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 56

Installing the Spectrum Application

This section describes how to install the Loftware Spectrum® application. Before
performing the procedures in this section, be sure you have completed Preparing for
Installation and Installing the Spectrum Database.

To install the Spectrum application, use the following procedure for your operating
system and database:

Install Spectrum Application on Windows Server 58

Install Spectrum Application on Linux 69

Install Spectrum Application on Linux using Command Line (AWS) 80

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 57

Install Spectrum Application on Windows Server

This section describes how to install the Loftware Spectrum application on a server
running the Windows Server operating system. Before performing the procedures in this
section, be sure you have completed Installing the Spectrum Database.

To install the Spectrum application, perform the following steps as a user with
administrator privileges.

1. Verify that resolutions for all hostnames are working, including your Spectrum
Application Server.

2. From the Loftware Spectrum installation package, copy the SpectrumWeb

executable file to the server where you are installing the Spectrum application and
service.

3. Navigate to the folder where you copied the SpectrumWeb file and double-click the
file. The progress of the installation file extraction is displayed. This may take
several minutes.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 58

 4. After preparation is complete, the Loftware Spectrum installation window is
displayed. Select a language for the installer, and then click OK.

5. Review the Introduction dialog, and then click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 59

 6. In the Choose Install Folder dialog, enter a location to install Spectrum or click
Choose to select or create a folder location, and then click Next.

7. In the Installation Type dialog, select Initial and then click Next.

Note: The Additional application server option is for installing Spectrum in a

distributed services environment, not for installing a facility in a multi-site
deployment. For more information, see Installing for Distributed Services or
Installing a Multi-Site Deployment.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 60

 8. In the Database Configuration dialog, do the following:

a. Under Spectrum database option, select whether you have installed the
LoftStore database into PostgreSQL or Oracle database.

b. Enter the JDBC connection string to database in the appropriate format for
your database type:
l PostgreSQL:
jdbc:postgresql://<Host_or_IPaddress>:<port>/<DatabaseName>
Example: jdbc:postgresql://MyHostName:5432/loftstore

l Amazon RDS for PostgreSQL:

jdbc:postgresql://<FQDNendpoint>:<port>/<DatabaseName>
Example: jdbc:postgresql://example.abc123xyz789.us-east-
2.rds.amazonaws.com:5432/loftstore

l Oracle with SID:

jdbc:oracle:thin:@<Host_or_IPaddress>:<port>:<SID>
Example: jdbc:oracle:thin:@MyHostName:1521:orcl

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 61

 l Oracle with Service Name:
jdbc:oracle:thin:@<Host_or_IPaddress>:<port>/<ServiceName>
Example: jdbc:oracle:thin:@MyHostName:1521/orcl.example.com

l Amazon RDS for Oracle:

jdbc:oracle:thin:@<FQDNendpoint>:<port>:<SID>
Example: jdbc:oracle:thin:@example.abc123xyz789.us-east-
2.rds.amazonaws.com:1521:orcl

Important! Do not use "localhost" in the string, as this may cause the
installation to fail in a later step. Instead, use the host name or IP address.

c. If you are deploying an Amazon RDS instance of LoftStore, select the

Database is located on Amazon RDS check box.

Note: If you are uncertain about the database configuration information,

consult your database administrator. The installer must be able to connect to
the database or the installation will fail.

d. If you have unique names for the LoftStore schema, select the Use custom
database schema names check box. This is not recommended unless you
are installing Spectrum Cloud and need to match schema names with
headquarters.

Note: Click Help > About and then click Schema configuration to view the
schema names in an existing instance.

e. Click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 62

 9. In the Database Credentials dialog, do the following:

a. Under Credentials for Spectrum database user, enter the username (default
is loftuser) and password that you set for the Spectrum database user during
the Spectrum database installation.

b. Under Credentials for DaVinci database user, enter the username (default is
loftdvuser) and password that you set for the DaVinci database user during
the Spectrum database installation.

c. Click Next.

10. If you selected the Use custom database schema names check box in a previous
step, enter the names in the Schema Configuration dialog and then click Next. The
schema names should match those configured at headquarters.

Note: Click Help > About and then click Schema configuration to view the
schema names in an existing instance.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 63

 Example

l Spectrum: example1_loftspec
l Audit: example1_loftaudit
l Archive: example1_loftarch
l Reports: example1_loftreports
l Admin: example1_loftadmin
l Cross Reference: example1_loftxref
l DaVinci: example1_loftdv

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 64

11. In the Spectrum Deployment Configuration dialog, do the following:

a. Accept the default port numbers or change them if necessary.

l JMX Port: The Java Management Extensions (JMX) port used to
monitor and manage your resources remotely.
l JMS Port: The Java Message Service (JMS) port used to communicate
with the server.
l Integration Port: The port used for JMS integrations.

b. Under Secure Integration, select whether the JMS integrations are secure
(Yes) or not secure (No).

c. Click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 65

12. In the Tomcat Deployment Configuration dialog, do the following:

a. Modify the Service Name if desired.

b. For Timeout, modify the number of minutes for a session timeout if desired.

Important! Loftware recommends setting the session timeout to 30 minutes.

For the following reasons, disabling the session timeout is not
recommended:

l Security: A session that never times out can be accessed and used by
unintended users
l Efficiency: A session that never times out continues to use resources
until a sign out or Spectrum Application Server restart

c. For Memory, modify the Tomcat Java memory settings as needed for your
configuration of Spectrum. For additional information or assistance, contact
Loftware.

d. If needed, modify the HTTP Port or HTTPS Port numbers.

e. For Protocol, select whether you are going to use HTTP (not secure) or
configure HTTPS (secure) to connect to Spectrum.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 66

 f. For Shutdown Port, enter the port number for the Tomcat shutdown
command.

g. Click Next.

13. Review the Pre-Installation Summary dialog. If correct, click Install to proceed with
the installation, otherwise click Previous to return to a previous step and change
settings as needed.

After clicking Install, the installation begins. This may take several minutes.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 67

 14. After the Spectrum application is installed, the Install Complete dialog is displayed.
Click Done to close the installer.

The Loftware Spectrum service is automatically started. You can verify that the Loftware
Spectrum service is running from the Services console in Windows Server.

Next Step

You have completed installing the Spectrum application. Continue with License
Spectrum.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 68

Install Spectrum Application on Linux

This section describes how to install the Loftware Spectrum application on a Linux server.
Before performing the procedures in this section, be sure you have completed Installing
the Spectrum Database.

Before You Begin

l The Linux Standard Base (lsb) package is required to install the Spectrum
application on Linux. Use the lsb_release -a command to check for this package. If
the lsb_release command is not found, download the latest lsb package.
l Create a new group named "loftware", and optionally a new loftware user to install
the Spectrum application. The new or existing loftware user must have "sudo"
access privileges.

Important! If the new or existing user is not set up for "automatic" sudo, a
password prompt dialog box may display behind the installation window.

l Create the install location for the Spectrum application, which should be owned by a
member of group "loftware".

l Verify that resolutions for all hostnames are working, including your Spectrum
Application Server.

l The following instructions require a graphical user interface (GUI) based desktop
environment. To install the Spectrum application using command line, see Install
Spectrum Application on Linux using Command Line (AWS).

Install the Spectrum Application

To install the Spectrum application, perform the following steps.

Note: The SpectrumWeb.bin file needs to be owned and run by the loftware user in
group "loftware".

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 69

 1. From the Loftware Spectrum installation package, copy the SpectrumWeb.bin file
to the server where you are installing the Spectrum application and service.

2. Log in to the server from the GUI desktop environment.

3. From the terminal session, navigate to the folder where you copied the file.

4. Run the SpectrumWeb.bin file. The progress of the installation file extraction is
displayed. This may take several minutes.

Important! If the new or existing user is not set up for "automatic" sudo, a
password prompt dialog box may display behind the installation window. The GUI
desktop environment cannot continue processing until you enter the password.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 70

 5. After preparation is complete, the Loftware Spectrum installation window is
displayed. Select a language for the installer, and then click OK.

6. Review the Introduction dialog, and then click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 71

 7. In the Choose Install Folder dialog, enter a location to install Spectrum or click
Choose to select or create a folder location, and then click Next.

8. In the Installation Type dialog, select Initial and then click Next.

Note: The Additional application server option is for installing Spectrum in a

distributed services environment, not for installing a facility in a multi-site
deployment. For more information, see Installing for Distributed Services or
Installing a Multi-Site Deployment.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 72

 9. In the Database Configuration dialog, do the following:

a. Under Spectrum database option, select whether you have installed the
LoftStore database into PostgreSQL or Oracle database.

b. Enter the JDBC connection string to database in the appropriate format for
your database type:
l PostgreSQL:
jdbc:postgresql://<Host_or_IPaddress>:<port>/<DatabaseName>
Example: jdbc:postgresql://MyHostName:5432/loftstore

l Amazon RDS for PostgreSQL:

jdbc:postgresql://<FQDNendpoint>:<port>/<DatabaseName>
Example: jdbc:postgresql://example.abc123xyz789.us-east-
2.rds.amazonaws.com:5432/loftstore

l Oracle with SID:

jdbc:oracle:thin:@<Host_or_IPaddress>:<port>:<SID>
Example: jdbc:oracle:thin:@MyHostName:1521:orcl

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 73

 l Oracle with Service Name:
jdbc:oracle:thin:@<Host_or_IPaddress>:<port>/<ServiceName>
Example: jdbc:oracle:thin:@MyHostName:1521/orcl.example.com

l Amazon RDS for Oracle:

jdbc:oracle:thin:@<FQDNendpoint>:<port>:<SID>
Example: jdbc:oracle:thin:@example.abc123xyz789.us-east-
2.rds.amazonaws.com:1521:orcl

Important! Do not use "localhost" in the string, as this may cause the
installation to fail in a later step. Instead, use the host name or IP address.

c. If you are deploying an Amazon RDS instance of LoftStore, select the

Database is located on Amazon RDS check box.

Note: If you are uncertain about the database configuration information,

consult your database administrator. The installer must be able to connect to
the database or the installation will fail.

d. If you have unique names for the LoftStore schema, select the Use custom
database schema names check box. This is not recommended unless you
are installing Spectrum Cloud and need to match schema names with
headquarters.

Note: Click Help > About and then click Schema configuration to view the
schema names in an existing instance.

e. Click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 74

10. In the Database Credentials dialog, do the following:

a. Under Credentials for Spectrum database user, enter the username (default
is loftuser) and password that you set for the Spectrum database user during
the Spectrum database installation, and then confirm the password.

b. Under Credentials for DaVinci database user, enter the username (default is
loftdvuser) and password that you set for the DaVinci database user during
the Spectrum database installation, and then confirm the password.

c. Click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 75

11. If you selected the Use custom database schema names check box in a previous
step, enter the names in the Schema Configuration dialog and then click Next. The
schema names should match those configured at headquarters.

Note: Click Help > About and then click Schema configuration to view the
schema names in an existing instance.

Example

l Spectrum: example1_loftspec
l Audit: example1_loftaudit
l Archive: example1_loftarch
l Reports: example1_loftreports
l Admin: example1_loftadmin
l Cross Reference: example1_loftxref
l DaVinci: example1_loftdv

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 76

12. In the Spectrum Deployment Configuration dialog, do the following:

a. Accept the default port numbers or change them if necessary.

l JMX Port: The Java Management Extensions (JMX) port used to
monitor and manage your resources remotely.
l JMS Port: The Java Message Service (JMS) port used to communicate
with the server.
l Integration Port: The port used for JMS integrations.

b. Under Secure Integration, select whether the JMS integrations are secure
(Yes) or not secure (No).

c. Click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 77

13. In the Tomcat Deployment Configuration dialog, do the following:

a. Modify the Service Name if desired.

b. For Timeout, modify the number of minutes for a session timeout if desired.

Important! Loftware recommends setting the session timeout to 30 minutes.

For the following reasons, disabling the session timeout is not
recommended:

l Security: A session that never times out can be accessed and used by
unintended users
l Efficiency: A session that never times out continues to use resources
until a sign out or Spectrum Application Server restart

c. For Memory, modify the Tomcat Java memory settings as needed for your
configuration of Spectrum. For additional information or assistance, contact
Loftware.

d. If needed, modify the HTTP Port or HTTPS Port numbers.

e. For Protocol, select whether you are going to use HTTP (not secure) or
configure HTTPS (secure) to connect to Spectrum.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 78

 f. For Shutdown Port, enter the port number for the Tomcat shutdown
command.

g. Click Next.

14. Review the Pre-Installation Summary dialog. If correct, click Install to proceed with
the installation, otherwise click Previous to return to a previous step and change
settings as needed.

After clicking Install, the installation begins. This may take several minutes.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 79

 15. After the Spectrum application is installed, the Install Complete dialog is displayed.
Click Done to close the installer.

The Loftware Spectrum service is automatically started. You can verify that the Loftware
Spectrum service is running with the command sudo service spectrum status. If
you need to start the Loftware Spectrum service manually, use the command sudo
service spectrum start.

Next Step

You have completed installing the Spectrum application. Continue with License
Spectrum.

Install Spectrum Application on Linux using Command Line (AWS)

This section describes how to install the Loftware Spectrum application on a Linux server.
This process can also be used to install the Loftware Spectrum application on a Linux
server in AWS. Before performing the procedures in this section, be sure you have
completed Installing the Spectrum Database.

Installing the Spectrum application on a Linux server using command line involves the
following tasks:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 80

 A. Create the Necessary Group and User

B. Test the User

C. Create the Installation Location

D. Install the Spectrum Application

A. Create the Necessary Group and User

In this procedure you need to create a group and a user to install Spectrum. This user
must have sudo access.

1. Log in to the system as root, and then open a Terminal session. If you are using
AWS, connect to the EC2 instance running AWS Linux and elevate to "sudo"
privileges.

2. Create a group named "loftware".

# groupadd loftware

3. Create a loftware user, for example, "lwadmin", or you may already have an
established user you want to assign as a Loftware installer/administrator:
# useradd lwadmin

4. Set a password for the new user.

# passwd lwadmin
Changing password for user USERNAME.
New password:
Retype new password:
passwd: all authentication tokens updated successfully.

5. Assign the user to the loftware group as its primary group.

# usermod -g loftware -G wheel lwadmin

6. Edit the /etc/sudoers file.

# visudo

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 81

 7. Locate the following line, and remove the comment character (#) to grant sudo
access to users in the group wheel.
## Allows people in group wheel to run all commands
# %wheel ALL=(ALL) NOPASSWD: ALL

8. Save the changes and exit the editor.

B. Test the User

In this example the user is "lwadmin". Your site may use a different user.

1. Switch to the new user.

# su lwadmin

2. Verify the user is a member of the required groups.

$ groups
loftware wheel

3. Run the sudo whoami command to verify the user is acting as root.
$ sudo whoami
[sudo] password for lwadmin:
root

C. Create the Installation Location

The Spectrum installation location must be created and writable by a member of group
"loftware".

1. Use the sudo command.

Su -

2. Make the folder, "/opt/loftware/spectrum".

mkdir -p /opt/loftware/spectrum

3. Change the ownership of the folder to your designated Loftware user ("lwadmin" in
this example).
chown -R lwadmin:loftware /opt

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 82

 4. Exit the sudo command.
exit

D. Install the Spectrum Application

Note: The SpectrumWeb.bin file needs to be owned and run by the loftware user
(usually lwadmin) in group "loftware".

1. Verify that resolutions for all hostnames are working, including your Spectrum
Application Server.

2. Copy the SpectrumWeb.bin file to the server on which you will install the Spectrum
Application Server and service. Log in to the server as the user you created and
open a Terminal session. If you are using AWS, connect to the EC2 instance
running AWS Linux as the user you created.

3. Navigate to the folder where you copied the installer.

4. You may need to make the file executable.

# chmod u+x SpectrumWeb.bin

5. Run the installer.

./SpectrumWeb.bin -i console

Note: The installer may take a few minutes to prepare the installation files.

6. Under Choose Locale, enter the number of the language the installer should
display.
Choose Locale...
----------------
1- Deutch
->2- English
3- Español
4- Français
5- Português (Brasil)

CHOOSE LOCALE BY NUMBER: 2

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 83

 7. Read the Introduction, and then press Enter.
PRESS <ENTER> TO CONTINUE:

8. Specify the Spectrum installation folder location, and then press Enter.
Choose Install Folder
---------------------
Where would you like to install Spectrum?

Default Install Folder: /opt/loftware/spectrum

ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT:

/opt/loftware/spectrum

9. For Installation Type, select 1 to indicate you are installing Spectrum for the first
time on an Initial Application Server, and then press Enter.
Installation Type
-----------------
Initial or Additional

->1 - Initial
2 - Additional

Note: The Additional application server option is for installing Spectrum in a

distributed services environment, not for installing a facility in a multi-site
deployment. For more information, see Installing for Distributed Services or
Installing a Multi-Site Deployment.

10. For Database Type, indicate whether you have installed the LoftStore database into
PostgreSQL or Oracle database.
Database Type
-------------
Database Type

->1 - PostgreSQL
2 - Oracle

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 84

11. For Database Connection, enter the JDBC connection string in the appropriate
format for your database type.
Database Configuration
----------------------
Database Connection

JDBC connection string to database:

l PostgreSQL:
jdbc:postgresql://<Host_or_IPaddress>:<port>/<DatabaseName>
Example: jdbc:postgresql://MyHostName:5432/loftstore

l Amazon RDS for PostgreSQL:

jdbc:postgresql://<FQDNendpoint>:<port>/<DatabaseName>
Example: jdbc:postgresql://example.abc123xyz789.us-east-
2.rds.amazonaws.com:5432/loftstore

l Oracle with SID:

jdbc:oracle:thin:@<Host_or_IPaddress>:<port>:<SID>
Example: jdbc:oracle:thin:@MyHostName:1521:orcl

l Oracle with Service Name:

jdbc:oracle:thin:@<Host_or_IPaddress>:<port>/<ServiceName>
Example: jdbc:oracle:thin:@MyHostName:1521/orcl.example.com

l Amazon RDS for Oracle: jdbc:oracle:thin:@<FQDNendpoint>:<port>:<SID>

Example: jdbc:oracle:thin:@example.abc123xyz789.us-east-
2.rds.amazonaws.com:1521:orcl

Important! Do not use "localhost" in the string, as this may cause the installation to
fail in a later step. Instead, use the host name or IP address.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 85

12. Indicate whether you are deploying an Amazon RDS instance of LoftStore.
Database Configuration
----------------------
Database located on Amazon RDS

->1- TRUE
2- FALSE

13. Indicate if you want to create unique names for the LoftStore schema. This is not
recommended unless you are installing Spectrum Cloud , and need to match
schema names with headquarters. .
Use custom database schema names
--------------------------------
Use custom database schema names

1- Yes
->2- No

14. Enter the username and password that you set for the Spectrum database user
during the Spectrum database installation, and then confirm the password.
Get UserID for Spectrum database user
-------------------------------------
Loftware User

Username (Default: loftuser):

Password:

======================================
Confirm Loftware User Password
------------------------------

Confirm:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 86

15. Enter the username and password that you set for the DaVinci database user
during the Spectrum database installation, and then confirm the password.
Get UserID for DaVinci database user
------------------------------------
Loftware User

Username (Default: loftdvuser):

Password:

======================================
Confirm Loftware User Password
------------------------------

Confirm:

16. Enter the port numbers for your configuration.

Spectrum Deployment Configuration
---------------------------------

JMX Port: (Default: 3833):

JMS Port: (Default: 55555):

Integration Port: (Default: 55556):

17. Indicate whether the JMS integrations are secure.

Secure Integration
------------------

Secure Integration

1- Yes
->2- No

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 87

18. Modify the number of minutes for a session timeout, the Tomcat Java memory
settings for your configuration, the service name (name), HTTP port (port), HTTPS
port (SSL), and the port number for the Tomcat shutdown command (shutdown), as
needed.
Tomcat Deployment Configuration
---------------------------------

Session Timeout (Default: 30):

Memory (Xms==Xmx) (megabytes): (Default: 8192):
Name (Default: spectrum):
Port (Default: 8080):
SSL (Default: 8443):
Shutdown (Default: 8005):

19. Indicate whether you are going to configure HTTPS (secure) to connect to
Spectrum, or use HTTP (not secure) to connect to Spectrum.
HTTP or HTTPS
------------------

Use HTTPS connection

1- Yes
->2- No

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 88

 20. Review the Pre-Installation Summary, and then press Enter when ready to
continue. The installation process begins.
Installing...
-------------

When complete, Installation Complete is displayed.

Installation Complete
---------------------
Congratulations. Spectrum has been successfully installed to:
/opt/loftware/spectrum

PRESS <ENTER> TO EXIT THE INSTALLER:

Next Step

You have completed installing the Spectrum application. Continue with License
Spectrum.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 89

License Spectrum

The Loftware Licensing Server is a secure self-service website that allows you to access
and manage your Spectrum licenses as needed based on your contract entitlements.
You can license Spectrum only after you have installed the Spectrum Application Server.

For information on creating a high availability (HA) license, a disaster recovery (DR)
license, or a headquarters or facility license for a multi-site deployment of Spectrum, see
the Loftware Spectrum Licensing User Guide.

Note: After installing and starting Spectrum, the following error is written to the
spectrum.log file every 30 seconds until Spectrum is licensed:
No license found for type: PRODUCTION.

Note: For help with the Loftware Licensing Server or to have this process completed for
you, contact Loftware Customer Account Management.

Licensing Spectrum involves the following tasks:

A. Get Your Server ID from Spectrum

B. Sign in to the Loftware Licensing Server

C. Create a New License

D. Enter the License in Spectrum

A. Get Your Server ID from Spectrum

1. Open Spectrum from a supported browser. The sign in page is displayed.

Example

Enter the following in the address field of your browser, where spectrum-server is
the name of the server hosting Spectrum for your organization:
http://spectrum-server:8080/loftwarespectrum

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 90

 2. Enter your user name using the format username@domain, and then enter your
password.

3. Click Sign in.

4. Copy the Server ID number by selecting the text and then pressing Ctrl+C.

B. Sign in to the Loftware Licensing Server

1. Open a new tab in the supported web browser and enter:

https://loftwarelicensing.loftware.com

2. Enter a valid email address and password.

Note: If you need information to sign in, contact your company’s Loftware
administrator or click Register Your Company.

3. Click Login.

Note: If you see the Please Log in as Your Company page and need information
to sign in, contact Loftware Customer Account Management.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 91

C. Create a New License

1. If applicable, on the Contract Selection page of the Loftware Licensing Server,

select your contract number from the Select Contract field.

2. Select Create a New License and then click Next. The Create a License page
appears.

3. Select the installation location from the Select Location field, and then click Next.

Note: If your location is not available in the drop-down list, click Add a New
Location. If you need to discuss potential changes to your existing list of locations,
contact Loftware Customer Account Management.

Add a New Location

To add a new location, use the following procedure.

a. Click the Add a new Location link from the Create a New License page. The
Add a Location page appears.

b. Enter the Location Name and the location details, and then click Save. The
Main Menu page appears.

c. Click Create a New License, and then click Next.

d. Select your new installation location from the Select Location field, and then
click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 92

 The General Information pane appears.

4. In the General Information pane:

a. Select Production or Non-Production from the Usage field.

Note: The options available are based on your entitlements.

l If generating a Production license, your entitlements are based on the

available components. For example, if you have purchased 600 print
seats, and have already created a Production license with 400 print
seats, only 200 print seats would be available for the new license.
l If generating a Non-Production license, your entitlements are based on
your contract.

b. Select a version from the Version field.

c. Click Next. The Server Information pane appears.

5. In the Server Information pane:

a. Select an available server to license from the Server to License field.

Note: Available servers are based on the type of licenses available per your
contract.

b. Enter a name for the server in the Server Name field.

Note: This is for informational purposes only and does not impact the
licensing process.

c. In the Server ID field, press Ctrl+V to paste the server ID number copied from
Spectrum.

d. Select the operating system in the Operating System field.

Note: This is for informational purposes only and does not impact the
licensing process.

e. Click Next. The Other Product/Features pane appears.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 93

 6. In the Other Product/Features pane, select the quantities of the available
components for the new license, up to the Quantity Available, and then click Next.

Note: The creation of a new license can result in decreasing the available quantity
for future use.

7. Read the License Generation Information, and then click Generate to confirm you
want to generate a license. The details of the license display including the license
text.

Note: You can view these details later by selecting View an Existing License from
the Main Menu page.

8. Copy the text in the License Text field by clicking inside the box to select the text
and then pressing Ctrl+C.

D. Enter the License in Spectrum

1. In Spectrum, paste the license text copied from the Loftware Licensing Server into
the entry field.

Tip: If the Install license page is not displayed, click Help > Install license.

2. Click Install license.

3. Sign in to Spectrum again.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 94

Sign in to Spectrum

To sign in to Spectrum, use this procedure.

Note: Signing into Spectrum simultaneously as different users from the same
workstation is not supported.

1. Open Spectrum from a supported browser. The sign in page is displayed.

Example

Enter the following in the address field of your browser, where spectrum-server is
the name of the server hosting Spectrum for your organization:
http://spectrum-server:8080/loftwarespectrum

2. Enter your user name in the Username field using the format username@domain.

3. Enter your password in the Password field.

4. Click Sign in. If you are signing in for the first time, you may be asked to change
your password.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 95

Spectrum Root Folder

After installing Spectrum and before you create

any objects, you should go to Access Control and
rename the root folder (initially named Default) to
something relevant to your organization.

Important! Changing the root folder name after

you have started using Spectrum is not
recommended.

Note: In a multi-site deployment, the name of the root folder must be the same at the
headquarters (HQ) and at each facility associated with that HQ.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 96

After Installing Spectrum

Now that you have installed, licensed, and signed in to Spectrum, do one or more of the
following depending on your configuration of Spectrum:

l If you are installing Spectrum Enterprise for Medical Device, see Installing
Spectrum Enterprise for Medical Device.
l If you are configuring a distributed Spectrum environment, see Installing for
Distributed Services.
l If you are configuring a multi-site deployment of Spectrum, see Installing a Multi-
Site Deployment.
l If you want to use Loftware DaVinci to compare label templates in Label Design,
see Installing Loftware DaVinci.
l If you want to configure HTTPS for Spectrum, see Configuring HTTPS.
l If you intend to support SAP BC-XOM integrations, then you must install the
Loftware Spectrum Command Line Interpreter (CLI) on the SAP Application Server
to prepare for Loftware Spectrum® Integration for use with SAP® Applications. For
more information, see Installing the Command Line Interpreter (CLI).
l If your license includes Spectrum Business Intelligence (BI), see the
Loftware Spectrum Business Intelligence Installation Guide for information about
installing and accessing Spectrum BI.

Important: The Spectrum BI package included with Spectrum 4.7.1 is not

compatible with the Spectrum database in PostgreSQL 14 or later. If you have
installed the Spectrum database in PostgreSQL 14 or later and are using
Spectrum BI, contact Loftware Technical Support for more information.

If none of the above apply to your Spectrum configuration, or when you have completed
all applicable tasks, continue with Configuring Spectrum.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 97

Installing Spectrum Enterprise for Medical Device

Spectrum Enterprise for Medical Device is a comprehensive product offering all the
features and benefits of Spectrum, plus medical industry-specific objects and capabilities
designed to accelerate the implementation of your Loftware labeling solution.

After you have installed Spectrum, use the following procedure to install Spectrum
Enterprise for Medical Device.

Note: <SPECTRUM_HOME> represents the folder on the Spectrum Application Server

in which the Spectrum application is installed. For example, in Windows Server this
might be C:\Loftware\Spectrum\Spectrum, and in Linux this might be
/opt/loftware/spectrum/Spectrum. Although procedures in this documentation typically
use backslashes in operating system paths, you should use forward slashes if required
by your operating system.

1. Stop the Loftware Spectrum service on the Spectrum Application Server.

2. Copy the MedDeviceIndustryPack5.0.lip file to the <SPECTRUM_

HOME>/product/SolutionPacks folder.

Note: If you do not have the MedDeviceIndustryPack5.0.lip file, contact Loftware.

3. Start the Loftware Spectrum service.

For information on implementing and customizing the Spectrum Enterprise for Medical
Device objects and applications, see the Spectrum Enterprise for Medical Device Guide.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 98

Installing for Distributed Services

This section describes how to install Spectrum in a distributed services environment.

Before you begin, note the following:

l Be sure you have completed the Spectrum installation on your initial Spectrum
Application Server. For more information, see Installing Loftware Spectrum.
l If you intend to use an HTTPS connection for Spectrum, you must complete the
installation of Spectrum on the initial and all additional servers before configuring
HTTPS on any server.

To install Spectrum in a distributed services environment, use one of the following

procedures:

Important! All Spectrum Application Servers in a distributed environment must use the
same operating system family and brand.

l Install Spectrum on an Additional Windows Server

l Install Spectrum on an Additional Linux Server

If you need to remove a Spectrum Application Server from a distributed services

environment, see Removing a Spectrum Application Server.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 99

Install Spectrum on an Additional Windows Server

This section describes how to install the Loftware Spectrum application on an additional
server running the Windows Server operating system for use in a distributed services
environment. Before performing the procedures in this section, be sure you have
completed the Spectrum installation on your initial Spectrum Application Server. For
more information, see Install Spectrum Application on Windows Server.

To install Loftware Spectrum on an additional server, perform the following steps as a

user with administrator privileges.

1. From the Loftware Spectrum installation package, copy the SpectrumWeb

executable file to the server where you are installing the Spectrum application and
service.

2. Navigate to the folder where you copied the SpectrumWeb file and double-click the
file. The progress of the installation file extraction is displayed. This may take
several minutes.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 100

 3. After preparation is complete, the Loftware Spectrum Installation window is
displayed. Select a language for the installer, and then click OK.

4. Review the Introduction dialog, and then click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 101

 5. In the Choose Install Folder dialog, enter a location to install Spectrum or click
Choose to select or create a folder location, and then click Next.

6. In the Installation Type dialog, select Additional and then click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 102

 7. In the Initial Server Connection dialog, do the following:

a. For FQDN, enter the fully qualified domain name of the initial server.

Example

myserver.mycompany.com

b. For Port, enter the HTTP or HTTPS port number for the initial server.

c. Select whether the protocol of the initial server uses HTTP (not secure) or
HTTPS (secure) to connect to Spectrum.

d. Under Spectrum Administration Credentials, enter the password for the

SuperAdmin user, or enter the username and password for a Spectrum user
with the ROLE_ADMINISTRATOR role.

e. Modify the JVM Server Name if desired. This will be the name of the JVM
Process in Spectrum.

f. Click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 103

 8. In the Spectrum Deployment Configuration dialog, do the following:

a. Accept the default port numbers or change them if necessary.

l JMX Port: The Java Management Extensions (JMX) port used to
monitor and manage your resources remotely.
l JMS Port: The Java Message Service (JMS) port used to communicate
with the server.
l Integration Port: The port used for JMS integrations.

b. Under Secure Integration, select whether the JMS integrations are secure
(Yes) or not secure (No).

c. Click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 104

 9. In the Tomcat Deployment Configuration dialog, do the following:

a. Modify the Service Name if desired.

b. Modify the number of minutes for a session Timeout if desired.

Important! Loftware recommends setting the session timeout to 30 minutes.

For the following reasons, disabling the session timeout is not
recommended:

l Security: A session that never times out can be accessed and used by
unintended users
l Efficiency: A session that never times out continues to use resources
until a sign out or Spectrum Application Server restart

c. Modify the HTTP Port or HTTPS Port numbers if needed.

d. For Protocol, select whether you are going to use HTTP (not secure) or
configure HTTPS (secure) to connect to Spectrum. If you are using HTTPS on
the initial Spectrum Application Server, you must also use HTTPS on all
additional servers.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 105

 e. For Shutdown Port, enter the port number for the Tomcat shutdown
command.

f. Click Next.

10. Review the Pre-Installation Summary dialog. If correct, click Install to proceed with
the installation, otherwise click Previous to return to a previous step and change
settings as needed.

After clicking Install, the installation begins. This may take several minutes.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 106

 11. After the Spectrum application is installed on the additional server, the Install
Complete dialog is displayed. Click Done to close the installer.

12. Verify that the Loftware Spectrum service was automatically started on the
additional server from the Services MMC console.

13. To test access to the additional Spectrum Application Server using HTTP, browse
to http://<AdditionalServer>:<port>/loftwarespectrum. If there is an issue, go over
each step again to ensure the installation was complete. If the problem still exists,
contact Loftware Technical Support for assistance.

Note: If you are using HTTPS, you must complete the installation of Spectrum on
the initial and all additional servers, then implement an SSL certificate configured
for your environment on all servers. For more information, see Next Steps.

14. Repeat all steps for each additional Spectrum Application Server.

Continue with Next Steps.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 107

Install Spectrum on an Additional Linux Server

This section describes how to install the Loftware Spectrum application on an additional
Linux server for use in a distributed services environment. Before performing the
procedures in this section, be sure you have completed the Spectrum installation on your
initial Spectrum Application Server. For more information, see Install Spectrum
Application on Linux.

Before you begin, note the following:

l The Linux Standard Base (lsb) package is required to install the Spectrum
application on Linux. Use the lsb_release -a command to check for this package. If
the lsb_release command is not found, download the latest lsb package.
l Create a new group named "loftware", and optionally a new loftware user to install
the Spectrum application. The new or existing loftware user must have "sudo"
access privileges.

Important! If the new or existing user is not set up for "automatic" sudo, a
password prompt dialog box may display behind the installation window.

l Create the install location for the Spectrum application, which should be owned by a
member of group "loftware".
l The following instructions require a Graphical User Interface (GUI) based desktop
environment.

To install Loftware Spectrum on an additional server, perform the following steps.

1. From the Loftware Spectrum installation package, copy the SpectrumWeb.bin file
to the server where you are installing the Spectrum application and service.

2. Log in to the server from the GUI desktop environment.

3. From the terminal session, navigate to the folder where you copied the file.

4. Run the SpectrumWeb.bin file. The progress of the installation file extraction is
displayed. This may take several minutes.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 108

 Important! If the new or existing user is not set up for "automatic" sudo, a
password prompt dialog box may display behind the installation window. The GUI
desktop environment cannot continue processing until you enter the password.

5. After preparation is complete, the Loftware Spectrum installation window is

displayed. Select a language for the installer, and then click OK.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 109

 6. Review the Introduction dialog, and then click Next.

7. In the Choose Install Folder dialog, enter a location to install Spectrum or click
Choose to select or create a folder location, and then click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 110

 8. In the Installation Type dialog, select Additional and then click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 111

 9. In the Initial Server Connection dialog, do the following:

a. For FQDN, enter the fully qualified domain name of the initial server.

Example

myserver.mycompany.com

b. For Port, enter the HTTP or HTTPS port number for the initial server.

c. Select whether the protocol of the initial server uses HTTP (not secure) or
HTTPS (secure) to connect to Spectrum.

d. Under Spectrum Administration Credentials, enter the password for the

SuperAdmin user, or enter the username and password for a Spectrum user
with the ROLE_ADMINISTRATOR role.

e. Modify the JVM Server Name if desired. This will be the name of the JVM
Process in Spectrum.

f. Click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 112

10. In the Spectrum Deployment Configuration dialog, do the following:

a. Accept the default port numbers or change them if necessary.

l JMX Port: The Java Management Extensions (JMX) port used to
monitor and manage your resources remotely.
l JMS Port: The Java Message Service (JMS) port used to communicate
with the server.
l Integration Port: The port used for JMS integrations.

b. Under Secure Integration, select whether the JMS integrations are secure
(Yes) or not secure (No).

c. Click Next.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 113

11. In the Tomcat Deployment Configuration dialog, do the following:

a. Modify the Service Name if desired.

b. Modify the number of minutes for a session Timeout if desired.

Important! Loftware recommends setting the session timeout to 30 minutes.

For the following reasons, disabling the session timeout is not
recommended:

l Security: A session that never times out can be accessed and used by
unintended users
l Efficiency: A session that never times out continues to use resources
until a sign out or Spectrum Application Server restart

c. Modify the HTTP Port or HTTPS Port numbers if needed.

d. For Protocol, select whether you are going to use HTTP (not secure) or
configure HTTPS (secure) to connect to Spectrum. If you are using HTTPS on
the initial Spectrum Application Server, you must also use HTTPS on all
additional servers.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 114

 e. For Shutdown Port, enter the port number for the Tomcat shutdown
command.

f. Click Next.

12. Review the Pre-Installation Summary dialog. If correct, click Install to proceed with
the installation, otherwise click Previous to return to a previous step and change
settings as needed.

After clicking Install, the installation begins. This may take several minutes.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 115

 13. After the Spectrum application is installed, the Install Complete dialog is displayed.
Click Done to close the installer.

14. Verify that the Loftware Spectrum service was automatically started on the
additional server with the command sudo service spectrum status. If you
need to start the Loftware Spectrum service manually, use the command sudo
service spectrum start.

15. To test access to the additional Spectrum Application Server using HTTP, browse
to http://<AdditionalServer>:<port>/loftwarespectrum. If there is an issue, go over
each step again to ensure the installation was complete. If the problem still exists,
contact Loftware Technical Support for assistance.

Note: If you are using HTTPS , you must complete the installation of Spectrum on
the initial and all additional servers, then implement an SSL certificate configured
for your environment on all servers. For more information, see Next Steps.

16. Repeat all steps for each additional Spectrum Application Server.

Continue with Next Steps.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 116

Next Steps

After you have completed installing Spectrum in a distributed services environment, do

one or more of the following tasks depending on your configuration:

l HTTPS: If you intend to use HTTPS for Spectrum, you must complete the
installation of Spectrum on the initial and all additional servers before configuring
HTTPS on any server. After installing Spectrum on all Spectrum Application
Servers in the distributed environment, you must implement an SSL certificate that
is configured for your environment. For more information, see Configuring HTTPS.
l LDAPS: If you intend to use LDAP over SSL (LDAPS), you must implement an SSL
certificate that is configured for your environment on all Spectrum Application
Servers in the distributed environment (LDAPS does not function with the Spectrum
self-signed certificate). For more information, see Set a Default LDAP Domain and
Add an LDAPS Certificate.
l Server names: Depending on how Spectrum is deployed on your network, you may
need to configure the IP Address, DNS Alias, or Public DNS Name of your
Spectrum servers in Access Control. For more information, see Set Server
Domain Names.
l Permissions: In Access Control, check and assign permissions to local users as
appropriate. For Spectrum in a distributed environment, local users must have read
and write permissions for that Spectrum Application Server.

When you have completed all applicable tasks, continue with Configuring Spectrum.
You can also manage the distributed environment in Spectrum from the Service
Management pane in System.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 117

Removing a Spectrum Application Server

In a Spectrum environment with distributed services, there is an initial Spectrum

Application Server as well as additional Spectrum Application Servers. All of these
Spectrum Application Servers are configured to interact as peers within the Spectrum
environment, all accessing the same Spectrum database.

If you are making major changes to your environment or if a catastrophic problem occurs
to a Spectrum Application Server, it may become necessary to remove a server from your
Spectrum environment.

To remove a Spectrum Application Server other than the initial server from an
environment that includes multiple Spectrum Application Servers, use one of the
following procedures. If you need to remove the initial Spectrum Application Server,
contact Loftware for assistance.

Remove the Spectrum Application from a Server Running Windows Server

To remove a Spectrum Application Server running a Windows Server operating system

from your Spectrum environment, use the following procedure.

1. On the Spectrum Application Server that you want to delete from the Spectrum
environment, view the following file:

<SPECTRUM_HOME>\product\conf\jdbc.properties

Note: If this file cannot be accessed, contact Loftware for assistance.

2. Scroll to the end of the file. In the Jvm Management Service Information section,
find the line that begins with jvm.management.process.id, and note the value
listed. The value is the Server ID for this Spectrum Application Server.

3. Stop the Loftware Spectrum service.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 118

 4. On the initial Spectrum Application Server, open a Command Prompt window and
navigate to the following folder:

<SPECTRUM_HOME>\bin

5. Run the following command, substituting the IP address of the initial Spectrum
Application Server for <InitialServer>, the Server ID of the Spectrum
Application Server to be deleted (noted in a previous step) for <ServerID>, and the
password for the SuperAdmin user in Spectrum for <SuperAdminPassword>:
sputils remove-app-server <SuperAdminPassword>
http://<InitialServer>:8080 <ServerID>

6. If you are signed in to Spectrum from the initial Spectrum Application Server, sign
out and then sign back in to Spectrum. The Spectrum Application Server that you
specified has been removed from the Spectrum environment and is no longer
displayed in Access Control.

7. On the Spectrum Application Server that you removed from the Spectrum
environment, perform the following tasks to remove the Spectrum application from
the server.

a. From a command prompt, run the following command to delete the service:
sc delete LoftwareSpectrum

b. Delete the Loftware folder.

c. Reboot the server.

Remove the Spectrum Application from a Server Running Linux

To remove a Spectrum Application Server running a Linux operating system from your
Spectrum environment, use the following procedure.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 119

 1. On the Spectrum Application Server that you want to delete from the Spectrum
environment, view the following file:

<SPECTRUM_HOME>/product/conf/jdbc.properties

Note: If this file cannot be accessed, contact Loftware for assistance.

2. Scroll to the end of the file. In the Jvm Management Service Information section,
find the line that begins with jvm.management.process.id, and note the value
listed. The value is the Server ID for this Spectrum Application Server.

3. Stop the Loftware Spectrum service.

4. On the initial Spectrum Application Server, open a Terminal and navigate to the
following folder:

<SPECTRUM_HOME>/bin

5. Run the following command, substituting the IP address of the initialSpectrum

Application Server for <InitialServer>, the Server ID of the Spectrum
Application Server to be deleted (noted in a previous step) for <ServerID>, and the
password for the SuperAdmin user in Spectrum for <SuperAdminPassword>:
sputils remove-app-server <SuperAdminPassword>
http://<InitialServer>:8080 <ServerID>

6. If you are signed in to Spectrum from the initial Spectrum Application Server, sign
out and then sign back in to Spectrum. The Spectrum Application Server that you
specified has been removed from the Spectrum environment and is no longer
displayed in Access Control.

7. On the Spectrum Application Server that you removed from the Spectrum
environment, perform the following tasks to remove the Spectrum application from
the server.

a. Remove the /opt/loftware folder.

b. Reboot the server.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 120

Installing a Multi-Site Deployment

With a multi-site deployment of Loftware Spectrum, a Spectrum instance at one site is

synchronized with Spectrum instances at other sites. A multi-site deployment has a
headquarters (HQ) that communicates with a facility or facilities, but the facilities are not
aware of each other. Objects such as label templates and devices can be configured at
the headquarters site and replicated to each facility site. Any job data generated at
facilities can be replicated to the headquarters. For more information, see the
Spectrum User Guide (Help).

Note: Facilities and other functionality related to multi-site deployment are available only
if your Spectrum license has the Multi-Site property enabled. Some options are
displayed only if you are signed in to the headquarters site.

Note: Installing a multi-site deployment of Loftware Spectrum Cloud requires

coordination between you and Loftware Cloud Operations.

Note: If you have upgraded from a version prior to Spectrum 4.1, are using the Loftware-
supplied embedded database, and need to add more facility sites, contact Loftware
Technical Support for assistance.

To install a multi-site deployment of Spectrum, use the following procedure.

1. Install the Spectrum database at the headquarters site. For more information, see
Installing the Spectrum Database.

2. Install the Spectrum application at the headquarters site. For more information, see
Installing the Spectrum Application.

3. Install the Spectrum database at each facility site. For more information, see Install
Spectrum Database at a Facility Site.

4. Install the Spectrum application at each facility site. For more information, see
Install Spectrum Application at a Facility Site.

5. License Spectrum at the headquarters site and at each facility site. For more
information, see License Spectrum and the Loftware Spectrum Licensing User
Guide.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 121

 6. Sign in to Spectrum at the headquarters site. For more information, see Sign in to
Spectrum.

7. Create the facility objects in Spectrum. For more information, see the
Spectrum User Guide (Help).

Install Spectrum Database at a Facility Site

The Spectrum database is a dedicated persistent data repository named LoftStore that
can be installed as a database for a facility in a multi-site deployment of Loftware
Spectrum. For more information, see Requirements for Loftware Spectrum Facility
Database Server in a Multi-Site Deployment in the Spectrum User Guide (Help).

Important! Unless you have upgraded from a version prior to Spectrum 4.1, Spectrum
Business Intelligence is not supported at facility sites.

Note: Installing a multi-site deployment of Loftware Spectrum Cloud requires

coordination between you and Loftware Cloud Operations.

Note: If you have upgraded from a version prior to Spectrum 4.1, are using the Loftware-
supplied embedded database, and need to add more facility sites, contact Loftware
Technical Support for assistance.

To install the Spectrum database at a facility site, use one of the following procedures on
the server that you want to act as the facility's Spectrum Database Server.

l Install Spectrum Database in PostgreSQL on Windows Server

l Install Spectrum Database in PostgreSQL on Linux

Important: The database name (usually "loftstore") and schema names must be the
same at headquarters and at each facility.

Install Spectrum Application at a Facility Site

To install the Spectrum application at a facility site, use one of the following procedures
for your operating system. Before performing the procedures in this section, be sure you
have completed Install Spectrum Database at a Facility Site.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 122

 l Install Spectrum Application on Windows Server
l Install Spectrum Application on Linux

Note: Installing a multi-site deployment of Loftware Spectrum Cloud requires

coordination between you and Loftware Cloud Operations.

Important: If you have configured your multi-site deployment of Spectrum for high
availability behind a load balancer and you are not using Amazon RDS, you must add
the following properties to the jdbc.properties file in <SPECTRUM_
HOME>/product/conf on the Spectrum Application Server at each facility site:

l security.amfsecure.protocol=any
l jdbc.pool.removeAbandoned=true
l jdbc.pool.removeAbandonedTimeout=60
l jdbc.driver.connectionProperties=oracle.jdbc.ReadTimeout=6000;
oracle.net.CONNECT_TIMEOUT=6000;loginTimeout=6000

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 123

Installing Loftware DaVinci

Loftware DaVinci is a web application used to compare images. You can use DaVinci
within Label Design to compare PNG format images of label templates or different
versions of the same label template.

Spectrum is delivered with a DaVinci package that can be deployed on your web server
alongside Spectrum. Configuration is required, and you will have to restart the Loftware
Spectrum service after making changes to configuration files.

The installation package is available from the downloads folder of your Spectrum
Application Server at the following URL:

http://[hostname]:[port]/downloads/DaVinciPackage.zip

Deploy and Configure the Loftware DaVinci Application

To use Loftware DaVinci within Label Design or in your own application, use this
procedure to install and configure the web application on the Spectrum application.

1. Download or copy the DaVinciPackage.zip installation package to the Spectrum

Application Server.

2. On the Spectrum Application Server, unzip the DaVinciPackage.zip installation

package. Recommended location: <SPECTRUM_HOME>\DaVinci

Note: <SPECTRUM_HOME> represents the folder on the Spectrum

Application Server in which the Spectrum application is installed. For example, in
Windows Server this might be C:\Loftware\Spectrum\Spectrum, and in Linux this
might be /opt/loftware/spectrum/Spectrum. Although procedures in this
documentation typically use backslashes in operating system paths, you should
use forward slashes if required by your operating system.

3. Navigate to the folder where you extracted the installation package.

Example

<SPECTRUM_HOME>\DaVinci

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 124

 4. Copy the davinciHtml5.war and dvserver.war files in the folder into the
<SPECTRUM_HOME>\product\webapps folder on the Spectrum Application
Server.

Note: This folder also contains loftwareserver.war and spectrum-server.war. A

davinciHtml5 and dvserver folder will be created under the webapps folder after
copying the files into the folder.

5. Navigate to the DaVinci folder and unzip the davinciConfig.zip package.

Example

<SPECTRUM_HOME>\DaVinci\davinciConfig

6. Navigate to location you extracted the davinciConfig package.

7. Copy all files in the folder into the <SPECTRUM_HOME>\product\conf folder on

the Spectrum Application Server. The folder contains the following files:
l database.properties
l dvConfig.properties
l dynamoDB.properties
l azure.properties
l standalone.properties
l configuration.xml

8. Create a DVStore location.

Example

C:\DVStore

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 125

 9. Create a slice store location in Tomcat’s
<SPECTRUM_HOME>\product\webapps\ROOT folder.

Example

C:\Loftware\Spectrum\Spectrum\product\webapps\ROOT\sliceStorage

Note: The slice storage location must be within Tomcat's ROOT folder.

10. Open the standalone.properties file in a text editor and modify the following
properties:
l isStandalone: Set to true

Important! Do not add anything else on the isStandalone line, including

comments.

l dvstore: The location you created for the DVStore location

Example

If your location is C:\DVStore, enter dvstore=C:\\DVStore.

l sliceProtocol: http
l slicePort: 8080 or the same as Tomcat
l sliceHost: The application server's IP address or hostname

Important! Do not use localhost or 127.0.0.1 for this setting.

l sliceFolder: The path to the slices from <SPECTRUM_

HOME>/product/webapps/ROOT. Default is “/sliceStorage”

11. Save the standalone.properties file.

12. Open the database.properties file in a text editor and uncomment either the Oracle
or PostgreSQL section, depending on where you installed LoftStore. Make sure all
properties in the other section are commented out.

13. Modify the following properties for your environment.

LoftStore in an Oracle database

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 126

 l database.type: PLSQL
l database.driverClassName: oracle.jdbc.driver.OracleDriver
l database.url: jdbc:oracle:thin:@[host]:[port]:[SID] or
jdbc:oracle:thin:@//[host]:[port]/[serviceName]
l database.username: LOFTDVUSER
l database.password: Set during the LoftStore installation
l database.schema: LOFTDV

LoftStore in a PostgreSQL database

l database.type: POSTGRES
l database.driverClassName: org.postgresql.Driver
l database.url: postgresql
l database.username: LOFTDVUSER
l database.password: Set during the LoftStore installation
l database.schema: LOFTDV

Note: Your database administrator can change the database password for
LOFTDVUSER if needed. After changing the password in the database, see
Managing the Loftware DaVinci Password for information on updating the
password on the Spectrum Application Server.

14. Comment out the lines in the section titled FOR MS SQL SERVER.

15. Save the database.properties file.

16. Open the configuration.xml file in the text editor, and change the “0.0.0.0” portion
of the URLs to the IP address or hostname of the DaVinci system in each location
within the file. Confirm the port matches the Tomcat port.

Important! Do not use localhost or 127.0.0.1 for this setting, even if using the local
server.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 127

 l dvServerURL
l dvServerIPURL
l dvCallClientUrl
l dvCallCompareUrl

17. Save the configuration.xml file.

18. Restart the Loftware Spectrum service.

Next Step

After deploying the Loftware DaVinci web application, you'll need to Configure Loftware
DaVinci in Label Design or see the Spectrum User Guide (Help) for information on how
to create a label comparison application.

Configure Loftware DaVinci in Label Design

The Compare feature in Label Design uses the DaVinci web application to open
comparison images of your label templates. See Installing Loftware DaVinci in the
Loftware Spectrum Installation and Configuration Guide for more information. If you
already use DaVinci, you can point Spectrum at that instance of the web application
instead.

Add the System Property

After installing the Loftware DaVinci web application, add the davinci.url system property.
To add a new system property value, use the following procedure.

Note: To perform this task, you must be signed in as the SuperAdmin user. For more
information, see the Spectrum User Guide (Help).

1. In System , click System Properties.

2. Click Add Property.

3. In the Add System Property dialog box, select systemManagement from the
Namespace drop-down list.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 128

 4. Enter "davinci.url" for Key.

5. Enter the URL of a Loftware DaVinci web application for Value.

For Example

http://localhost:8080

6. Click Save.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 129

Configuring HTTPS

HTTPS (Hypertext Transfer Protocol Secure) enables a secure communication between

a server and browser by encrypting data transmitted using Transport Layer Security
(TLS) or Secure Sockets Layer (SSL). A keystore file is a repository for the keys and
certificates used in this encryption.

Spectrum includes a keystore file in <SPECTRUM_HOME>\product\conf that contains

a self-signed certificate for use in testing environments. In production environments, it is
recommended that you use a Certified Authority (CA) signed certificate. The CA signed
certificate must contain the requisite Subject Alternative Names for security purposes.

To set up an HTTPS connection for Spectrum, use one of the following procedures:

l Using Your Own Certificate

l Using the Spectrum Self-Signed Certificate

To view certificate information in a keystore file, see Display the Contents of Keystore.

Using Your Own Certificate

To configure HTTPS for Spectrum using your own certificate, do the following tasks:

A. Implement an Existing Certificate 130

B. Configure SSL in Tomcat 132

C. Configure Servers in Spectrum 134

A. Implement an Existing Certificate

Before implementing existing certificates, note the following:

l All system names in the keystore file should be the fully qualified domain name
(FQDN) to avoid security risks.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 130

 l If you have installed Spectrum in a distributed services environment or have a multi-
site deployment of Spectrum, each individual Spectrum Application Server keystore
file must contain the respective host-level server specific SSL Certificate. This host-
level certificate must be a complete certificate that includes the complete certificate
chain back to the Root CA. This is a single certificate entry in the keystore.

Note: This keystore is valid for this Spectrum instance only and cannot be copied
to any other Spectrum instance.

l The individual Intermediate and Root Certificates referenced in the certificate chain
must be added to the <SPECTRUM_HOME>/product/conf/cacerts trust store.

To implement an existing certificate in Spectrum, you can either import the certificates
into the existing Spectrum keystore, or you can replace the Spectrum keystore.

1. Navigate to the <SPECTRUM_HOME>/product/conf folder.

2. Do one of the following:

l Import your Host Certificate, which includes the complete certificate chain of
Intermediate Certificates, back to the Root CA into the Spectrum keystore.
This is a single certificate entry in the keystore.

Note: This keystore is valid for this Spectrum instance only and cannot be
copied to any other Spectrum instance.

l Replace the default Spectrum keystore with a new keystore that contains only
the Host Certificate which includes the complete certificate chain of
Intermediate Certificates back to the Root CA.

Note: This keystore is valid for this Spectrum instance only and cannot be
copied to any other Spectrum instance.

3. Import each individual Intermediate Certificate and Root Certificate into the
<SPECTRUM_HOME>/product/conf/cacerts truststore. If the Intermediate
Certificates and Root Certificate are the same for all instances of Spectrum, an
updated version of the <SPECTRUM_HOME>/product/conf/cacerts truststore
can be copied and distributed to each Spectrum instance.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 131

B. Configure SSL in Tomcat

To configure SSL in Tomcat using your own certificate, perform the following steps:

1. Navigate to the <SPECTRUM_HOME>/product/conf folder.

2. Make a backup copy of the server.xml file.

3. Open the server.xml file and locate the following section:

<Connector port="8443"
...

4. Make the following modifications to the Connector element:

a. Modify the keystoreFile value to reference the fully qualified keystore file for
your Spectrum site.

Example
keystoreFile="path/to/keystore_name"

b. Modify the keystorePass value to reference your keystore password.

Example
keystorePass="keystore_password"

Important! There is a limitation in Tomcat where the password for the

keystore and the password for the key MUST be the same. If you use a file
that does not have the same password, you will get the following error:
java.io.IOException: Cannot recover key

c. Add the keyAlias for your keystore.

Example
keyAlias="keystore_alias"

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 132

 Your final Connector element should look similar to the following:

<!-- When using HTTPS, the web.xml needs the cookie-config in the session-config
setting uncommented to secure the cookie. -->
<Connector port="8443"
protocol="org.apache.coyote.http11.Http11Protocol"
SSLEnabled="true"
maxThreads="150" scheme="https" secure="true"
clientAuth="false" sslProtocol="TLS"
keystoreFile="path/to/keystore_name"
keystorePass="keystore_password"
keyAlias="keystore_alias"
ciphers="SSL_RSA_WITH_RC4_128_MD5, SSL_RSA_WITH_RC4_128_SHA,
TLS_RSA_WITH_AES_128_CBC_SHA,TLS_DHE_DSS_WITH_AES_128_CBC_SHA,
SSL_RSA_WITH_3DES_EDE_CBC_SHA,SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA"/>

5. Save the changes to server.xml.

6. Make a backup copy of the jdbc.properties file.

7. Open the jdbc.properties file and add the following:

security.federated.jks.store=keystore_name
security.federated.jks.pwd=keystore_password
security.federated.jks.key=keystore_alias

8. Save the changes to jdbc.properties.

9. Make a backup copy of the web.xml file.

10. Open the web.xml file and remove the comment brackets (<!-- , -->) that
surround the Security Constraint element.

<security-constraint>
<web-resource-collection>
<web-resource-name>HTTPSOnly</web-resource-name>
<url-pattern>/*</url-pattern>
</web-resource-collection>
<user-data-constraint>
<transport-guarantee>CONFIDENTIAL</transport-guarantee>
</user-data-constraint>
</security-constraint>

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 133

 11. To set the cookie-config setting to secure remove the comment brackets (<!-- ,
-->) that surround the cookie-config element.

<session-config>
<session-timeout>${TC_SESSION_TO}</session-timeout>
<!-- Uncomment this section when using HTTPS -->
<<cookie-config>
<http-only>true</http-only>
<secure>true</secure>
</cookie-config>
</session-config>

12. Save the changes to web.xml.

C. Configure Servers in Spectrum

With the system names being the fully qualified domain name (FQDN) in the keystore,
the configuration of the server or servers in Spectrum must be modified to also include
the FQDN.

1. Sign in to Spectrum.

2. In Access Control, select your server in the Access Control Tree and click Edit.

3. For DNS Alias, add the FQDN for the server, and then click Save.

4. If you have installed Spectrum in a distributed services environment, repeat the

steps for each Spectrum Application Server.

5. If you have a multi-site deployment of Spectrum, repeat the steps on the Spectrum
Application Server at each facility.

6. Restart the Loftware Spectrum service. In a multi-site deployment of Spectrum, this

includes all Spectrum Application Servers at the headquarters and at all facilities. If
the headquarters is configured as a distributed services environment, this includes
all Spectrum Application Servers.

Spectrum can now be accessed at the following URL where host.domain is the FQDN of
the server hosting the Spectrum headquarters for your organization and port is the port
number specified in the server.xml file:

https://host.domain:port/loftwarespectrum

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 134

Example

https://lam.example.com:8443/loftwarespectrum

Using the Spectrum Self-Signed Certificate

To configure HTTPS for Spectrum testing environments using the included self-signed
certificate, do the following.

Note: Using a self-signed certificate in Microsoft Edge will result in an error and
Spectrum will not display. To avoid this issue, use a Certified Authority (CA) signed
certificate or use a different Spectrum-supported browser. For more information, see
Requirements for Spectrum Client Computers.

1. Navigate to the <SPECTRUM_HOME>\product\conf folder.

2. Make a backup copy of the web.xml file.

3. Open the web.xml file and remove the comment brackets (<!-- , -->) that
surround the Security Constraint element.
<security-constraint>
<web-resource-collection>
<web-resource-name>HTTPSOnly</web-resource-name>
<url-pattern>/*</url-pattern>
</web-resource-collection>
<user-data-constraint>
<transport-guarantee>CONFIDENTIAL</transport-guarantee>
</user-data-constraint>
</security-constraint>

4. Save the changes to web.xml.

5. Restart the Loftware Spectrum service.

Spectrum can now be accessed at the following URL where host is the name of the
server hosting Spectrum headquarters for your organization and port is the port number
specified in the server.xml file:

https://host:port/loftwarespectrum

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 135

Example

https://example.com:8443/loftwarespectrum

Display the Contents of Keystore

If you need to see the contents of a keystore file, you can use the following command:

%JAVA_HOME%\bin\keytool -list -v -alias keystore_alias

-keystore path/to/keystore_name

Example
The following command displays the contents of a file called
customKeystore.keystore in the <SPECTRUM_HOME>\product\conf folder:
%JAVA_HOME%\bin\keytool -list -v -alias myCustomAlias -keystore
C:\Loftware\Spectrum\Spectrum\product\conf\customKeystore.keystore
Enter keystore password: <keystore password> (e.g., loftware)
Alias name: myCustomAlias
Creation date: Aug 14, 2018
Entry type: PrivateKeyEntry
Certificate chain length: 1
Certificate[1]:
Owner: CN=myAppServer, OU=loftware, O=loftware, L=portsmouth, ST=nh,
C=01
Issuer: CN=myAppServer, OU=loftware, O=loftware, L=portsmouth, ST=nh,
C=01
Serial number: 502a5b3a
Valid from: Tue Aug 14 10:05:46 EDT 2018 until: Mon Nov 12 09:05:46
EST 2018
Certificate fingerprints:
MD5: 42:47:51:C7:80:68:05:E9:7A:25:00:65:AB:27:3B:6C
SHA1: AE:5A:44:3A:FF:FC:6A:F8:F7:93:CF:43:0E:14:9D:B7:C8:5D:89:77
Signature algorithm name: SHA1withRSA
Version: 3

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 136

Installing the Command Line Interpreter (CLI)

If you intend to support SAP BC-XOM integrations, then you must install the Loftware
Spectrum Command Line Interpreter (CLI) on the SAP Application Server to prepare for
Loftware Spectrum® Integration for use with SAP® Applications.

The CLI is a utility that is run by the SAP Spooler when a print job is submitted from SAP
ERP. The CLI passes the request to the Loftware Spectrum® Integration for use with
SAP® Applications. Spectrum applies the appropriate label template, sends the job to the
printer, and then sends the status back to the SAP Spooler.

Note: These steps are required only if you intend to support SAP BC-XOM integrations.

Note: It is strongly recommended that each SAP Application Server be configured with
its own CLI and a uniquely named CLI log file.

The following steps should be performed by a SAP Basis Administrator on the SAP
Application Server. The configuration for the Loftware Spectrum CLI requires moving files
into a folder that the SAP Logical Output Management System (LOMS) instance can
access.

Install the Loftware Spectrum Command Line Interpreter

To install the CLI on the SAP Application Server, perform the following steps.

1. Download the file from the Spectrum Application Server, where spectrum-server is
the name of the server hosting Spectrum for your organization:
http://<spectrum-server>:<port>/downloads/sapClient-package.zip

2. Extract the contents of the sapClient-package.zip package to the desired folder on

the SAP Application Server.

Note: The CLI can be in any location, as long as the Output Management System
(OMS) definition in SAP Spool Administration (SPAD) has the appropriate path in
the OMS Submit Command.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 137

 3. Open a Command Prompt window or Terminal, navigate to the folder where you
unzipped the files to, and then run the install.cmd or install.sh command.

4. If your Spectrum Application Server is implemented with SSL, do the following to

ensure the SAP CLI can connect to Spectrum:

a. In your browser, navigate to the Spectrum sign in page.

b. Follow your browser's instructions to save the SSL certificate to a file.

c. On the SAP Application Server, navigate to <SAPCLI_HOME>/jre/bin.

d. Execute the following command:

keytool -importcert -alias myAlias
-file \path\to\file\saved\from\browser
-keystore <SAPCLI_HOME>\jre\lib\security\cacerts

e. At the prompt for the keystore password, enter changeit.

f. At the prompt for trusting the certificate, enter yes.

5. Edit the runcli file as described for your operating system.

Note: The script output must be only the single output line generated by the sapcli
request. This format is dictated by SAP and additional lines are not allowed. The
following is an example.
2.00 4 1 test Print\ request\ accepted\ by\ Loftware\
Spectrum

Windows Server Operating System

a. Open the runcli.cmd_EXAMPLE file in a text editor.

b. Change the SAPCLI_HOME value, C:\saptest, to the fully-qualified path to

the folder where the sapcli tool is installed.

c. Optional parameter: To change the request connection timeout setting, add a

space at the end of the last line and then add
CTO=<numeric value in milliseconds>

Example
CTO=20000

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 138

 d. Optional parameters: If you need to use a proxy server, add a space at the
end of the last line and then use the following options as needed.
PROXYHOST, PROXYPORT, PROXYUSER, PROXYPASSWORD

Example (enter the parameters on the same line)

PROXYHOST=172.17.2.83 PROXYPORT=8080 PROXYUSER=myuser
PROXYPASSWORD=mypassword

e. Save the file as runcli.cmd.

Linux Operating System

a. Open the runcli.sh_EXAMPLE file in a text editor.

b. Change the sapCli_home value, /opt/loftware, to the fully-qualified path to

the folder where the sapcli tool is installed.

c. Optional parameter: To change the request connection timeout setting, add a

space at the end of the last line and then add
CTO=<numeric value in milliseconds>

Example
CTO=20000

d. Optional parameters: If you need to use a proxy server, add a space at the
end of the last line and then use the following options as needed.
PROXYHOST, PROXYPORT, PROXYUSER, PROXYPASSWORD

Example (enter the parameters on the same line)

PROXYHOST=172.17.2.83 PROXYPORT=8080 PROXYUSER=myuser
PROXYPASSWORD=mypassword

e. Save the file as runcli.sh.

Important! The runcli.sh script must have execute permission set.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 139

 Linux Example

#!/bin/bash
# Change /opt/loftware to the fully-qualified path to the folder where the sapcli
tool is installed.
#
# To send secure requests to Spectrum:
# 1) Import the Spectrum certificate to the JRE keystore installed with this CLI
located at
# $JAVA_HOME/lib/security/cacerts
# 2) Add the following option to the last command line below, before -cp: -
Djavax.net.ssl.trustStorePassword=changeit
# Note: You may change the password to the keystore file.
#
# Optional Parameters:
#
# To add optional parameters, add a space at the end of the last line, then add
optional parameters as documented below.
# All optional parameters MUST be added to the END of the last line.
#
# CTO To change the request connection timeout setting, add CTO=<numeric value in
milliseconds>
# Example CTO=20000
# Proxy Settings
# If you need to use a proxy, use the following options as needed:
# PROXYHOST, PROXYPORT, PROXYUSER, PROXYPASSWORD
# Example: PROXYHOST=172.17.2.83 PROXYPORT=8080 PROXYUSER=myuser
PROXYPASSWORD=mypassword
#
export sapCli_home=/opt/loftware
export JAVA_HOME=${sapCli_home}/jre
$JAVA_HOME/bin/java -cp .:${sapCli_home}:${sapCli_home}/*
com.loftware.sapCliClient.SapCli SUBMIT $@

IBM AIX Operating System

a. Install Java 1.8 from IBM.

b. Open the runcli.sh_EXAMPLE file in a text editor.

c. Delete the first line (#!/bin/bash).

d. Change the sapCli_home value, /opt/loftware, to the fully-qualified path to

the folder where the sapcli tool is installed.

e. Optional parameter: To change the request connection timeout setting, add a

space at the end of the last line and then add
CTO=<numeric value in milliseconds>

Example
CTO=20000

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 140

 f. Optional parameters: If you need to use a proxy server, add a space at the
end of the last line and then use the following options as needed.
PROXYHOST, PROXYPORT, PROXYUSER, PROXYPASSWORD

Example (enter the parameters on the same line)

PROXYHOST=172.17.2.83 PROXYPORT=8080 PROXYUSER=myuser
PROXYPASSWORD=mypassword

g. Change the JAVA_HOME value to the fully-qualified path to the folder where
the Java 1.8 JRE or JDK is installed.

h. Save the file as runcli.sh.

SUSE Operating System

a. Open the runcli.sh_EXAMPLE file in a text editor.

b. Change the sapCli_home value, /opt/loftware, to the fully-qualified path to

the folder where the sapcli tool is installed.

c. Optional parameter: To change the request connection timeout setting, add a

space at the end of the last line and then add
CTO=<numeric value in milliseconds>

Example
CTO=20000

d. Optional parameters: If you need to use a proxy server, add a space at the
end of the last line and then use the following options as needed.
PROXYHOST, PROXYPORT, PROXYUSER, PROXYPASSWORD

Example (enter the parameters on the same line)

PROXYHOST=172.17.2.83 PROXYPORT=8080 PROXYUSER=myuser
PROXYPASSWORD=mypassword

e. Save the file as runcli.sh.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 141

 6. Optional: To use the encryptpw utility to encrypt the password parameter in the
runcli file, do the following.

a. Open the encryptpw.cmd_EXAMPLE (Windows Server) or encryptpw.sh_

EXAMPLE (Linux) file in a text editor.

b. Change C:\saptest\ (Windows Server) or /opt/loftware (Linux) to the

fully-qualified path to the folder where the sapcli tool is installed.

c. Replace the parameter -file with the case-sensitive name of the file for
which passwords need to be encrypted.

d. Replace the parameter -field with the case-sensitive name of the

password option to encrypt.

e. Save the file as encryptpw.cmd (Windows Server) or encryptpw.sh (Linux).

f. Run the script from the command line.

7. Open the log4j2.xml_EXAMPLE file in a text editor. Change the Property LOG_
DIR value C:/saptest to be the explicit directory where the sapcli tool is installed.
Save the file as log4j2.xml.

log4j2.xml_EXAMPLE File

<?xml version="1.0" encoding="UTF-8" ?>

<!--
Change the Property LOG_DIR value "C:/saptest" to be the explicit directory
where the sapcli tool is installed.
-->
<Configuration>
<!--
Properties
-->
<Properties>
<!-- http://logging.apache.org/log4j/2.x/manual/layouts.html#PatternLayout
-->
<Property name="PATTERN">[%d{yyyy/MM/dd HH:mm:ss.SSS}][%5p][%c](%t)
%m%n</Property>
<Property name="LOG_DIR">C:/saptest</Property>
</Properties>

<!--
Appenders
where log messages go to
-->
<Appenders>

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 142

 <RollingFile name="FILE" fileName="${LOG_DIR}/sapcli.log"
filePattern="${LOG_DIR}/sapcli.%d{yyyy-MM-dd}-%i.log.gz">
<PatternLayout pattern="${PATTERN}" charset="UTF-8" />
<!-- triggering policies -->
<Policies>
<!-- rollover once the file has reached the specified size -->
<SizeBasedTriggeringPolicy size="10000KB" />
</Policies>
<DefaultRolloverStrategy max="5"/>
</RollingFile>
</Appenders>

<!--
Loggers
-->
<Loggers>
<Logger name="com.loftware.sapCliClient" level="INFO"/>
<Root level="ERROR">
<AppenderRef ref="FILE"/>
</Root>
</Loggers>

</Configuration>

8. The CLI can be in any location, as long as the Output Management System (OMS)
definition in SAP Spool Administration (SPAD) has the appropriate path in the OMS
Submit Command. OMS commands should include the required quotation marks,
as shown in the following example. For the last parameter, enter RDI, XSF, XML, or
XFP as appropriate. For more information, see Configure for BC-XOM
Communication in the Spectrum User Guide (Help).

OMS Submit Example (Windows Server)

Path: C:\saptest\
Submit: runcli.cmd http://localhost:8080/spectrum-server/int/sbpj
"n=bcxom1" SapTest CIDSDEVLK "PDFDev1" ZZMEDRUCK.rdi
DEVPORTSAP01_IDS_03 RDI

Sending via SSL Example (Windows Server)

PATH: C:\saptest\
Submit: runcli.cmd https://localhost:8443/spectrum-
server/int/sbpj "n=bcxom1" SapTest CIDSDEVLK "PDFDev1"
ZZMEDRUCK.rdi DEVPORTSAP01_IDS_03 RDI

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 143

Configuring Spectrum

The Loftware Spectrum solution uses an application server in conjunction with an

external database. Based on a variety of factors, configuration of the solution is handled
from either within Spectrum, within configuration files, or with command-line utilities.

Note:<LOFTSTORE_HOME> refers to the folder in which the database configuration

files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore.
<SPECTRUM_HOME> refers to the folder on the Spectrum Application Server, such as
C:\Loftware\Spectrum\Spectrum or /opt/loftware/spectrum/Spectrum, in which the
Spectrum application is installed. Although procedures in this documentation typically
use backslashes in operating system paths, you should use forward slashes if required
by your operating system.

This section contains the following common configuration tasks:

Set the Browser Session Timeout 146

Set the Application Server Tomcat Java Memory Parameters 147

Setting the Memory Pool Parameters in Windows 147

Setting the Memory Pool Parameters in Linux 148

Change JMX Configuration 149

Disable JMX in Windows 149

Disable JMX in Linux 150

Configuring Spectrum for SNMP Support 151

Remove SNMP ACL File Security 155

Change the Archive Data Retention Time 155

Synchronize Application and Database Servers' Clocks 156

Set a Default LDAP Domain 157

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 144

 Add an LDAPS Certificate 158

Set Server Domain Names 159

Change Service Ports 159

Change the Source of Spectrum Help 161

Provide Static Help to Users 162

Provide Dynamic Help to Users (Recommended) 162

Spectrum LoftStore Utility 162

Usage 162

Available Commands [cmd] 163

Apply an SQL Script to the Spectrum Embedded Database 163

View Default Users and PDF Print Location 165

Turn Off the Default View Address 165

Optimizing Database Storage When Necessary 166

When to Apply the Optimization Setting 166

Guidelines for Applying the Optimization Setting 167

How to Change the Database Optimization Setting 168

Updating the LOFTUSER Password 169

Configure Lambda Function and Event Rules in AWS 172

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 145

Set the Browser Session Timeout

By default, Loftware Spectrum users are not signed out due to inactivity. If you want users
to be automatically signed out after being inactive for a specified period of time, you can
specify the timeout setting by editing the <session-timeout> value in a configuration file
on the Spectrum Application Server.

Note: You can also specify the timeout setting in System using the Force Inactivity
Logout property. If both the <session-timeout> and Force Inactivity Logout values are
specified, the lower timeout value takes precedence.

To set the browser session timeout setting, perform the following steps:

1. On the Spectrum Application Server, navigate to the <SPECTRUM_

HOME>\product\conf folder.

2. Open the web.xml file in a text editor.

3. Navigate to the Default Session Configuration section.

4. Change the <session-timeout> value to the number of minutes to timeout a browser

session. For example, a value of 30 results in the browser session expiring after 30
minutes.

web.xml

<!-- ============= Default Session Configuration ============ -->

<!-- You can set the default session timeout (in minutes) for all newly -->
<!-- created sessions by modifying the value below. -->
<session-config>
<session-timeout>30</session-timeout>
</session-config>

5. Restart the Spectrum service.

Important! For Spectrum in a distributed environment, you must set this value on each of
the Spectrum Application Servers. In a multi-site deployment of Spectrum, the <session-
timeout> value must be the same on each Spectrum Application Server.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 146

Set the Application Server Tomcat Java Memory Parameters

To set the Tomcat Java memory pool parameters, use the following procedure for your
operating system. For help determining what these parameters should be, contact
Loftware.

Setting the Memory Pool Parameters in Windows

To set the memory pool parameters in Windows, follow these steps:

1. Stop the Loftware Spectrum service.

2. On the Spectrum Application Server, navigate to the following folder:

<SPECTRUM_HOME>\product\bin

3. Using a text editor, open the javaoptsWin.properties file.

4. Under # Production Settings, locate the memory pool parameters, -Xms and
-Xmx.

# Production Settings
-Xms8192m
-Xmx8192m

5. Modify the memory pool parameters, -Xms8192m and -Xmx8192m, to the desired
values. The same value should be used for both settings.

Note: The same value should be used for both settings in order to force the JVM
into allocating from the operating system the maximum amount of memory needed
for the heap. With Xms (starting memory) not equal to Xmx (maximum memory),
the JVM must request memory blocks from the operating system as the memory
usage of the Spectrum Application Server increases over execution time resulting
in an inefficient use of resources.

6. Save the file.

7. Navigate to the following folder from a command prompt with administrator

privileges:
<SPECTRUM_HOME>\product\bin

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 147

 8. Run the following command to apply the settings:
service.bat update

9. Start the Spectrum service.

10. Sign in to Spectrum.

Setting the Memory Pool Parameters in Linux

To set the memory pool parameters in Linux, follow these steps:

1. Stop the Loftware Spectrum service.

2. Navigate to the following folder:

<SPECTRUM_HOME>/product/bin

3. Using a text editor, open the javaoptsLinux.properties file.

4. Under # Production Settings, locate the memory pool parameters, -Xms and
-Xmx.

# Production Settings
-Xms8192m
-Xmx8192m

5. Modify the memory pool parameters, -Xms8192m and -Xmx8192m, to the desired
values. The same value should be used for both settings.

Note: The same value should be used for both settings in order to force the JVM
into allocating from the operating system the maximum amount of memory needed
for the heap. With Xms (starting memory) not equal to Xmx (maximum memory),
the JVM must request memory blocks from the operating system as the memory
usage of the Spectrum Application Server increases over execution time resulting
in an inefficient use of resources.

6. Save the file.

7. Run the following command to start the Spectrum service:

sudo service spectrum start

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 148

Change JMX Configuration

Java Management Extensions (JMX) enables you to monitor and manage your resources
remotely. By default, JMX is enabled in the Java options properties. It is recommended to
leave JMX enabled, however, job processing may be 1% to 2% faster when JMX is
disabled.

If you need to disable JMX, use the following procedure for your operating system.

Disable JMX in Windows

1. Navigate to the following folder from a command prompt with administrator

privileges:
<SPECTRUM_HOME>\product\bin

2. Using a text editor, open the javaoptsWin.properties file.

3. Under # Production Settings, locate the # Start JMX configuration

options.

# Start JMX configuration, Enable JMX by default, to Disable comment out the next 4
lines
-Dcom.sun.management.jmxremote
-Dcom.sun.management.jmxremote.port=3833
-Dcom.sun.management.jmxremote.authenticate=false
-Dcom.sun.management.jmxremote.ssl=false
# End JMX configuration

4. To disable JMX, add # before each -Dcom line to comment out the line:

# Start JMX configuration, Enable JMX by default, to Disable comment out the next 4
lines
# -Dcom.sun.management.jmxremote
# -Dcom.sun.management.jmxremote.port=3833
# -Dcom.sun.management.jmxremote.authenticate=false
# -Dcom.sun.management.jmxremote.ssl=false
# End JMX configuration

5. Save the file.

6. In the <SPECTRUM_HOME>\product\bin folder, run the following command to

apply the settings:
service.bat update

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 149

 7. Start the Spectrum service.

8. Sign in to Spectrum.

Disable JMX in Linux

1. Navigate to the following folder:

<SPECTRUM_HOME>/product/bin

2. Using a text editor, open the javaoptsLinux.properties file.

3. Under # Production Settings, locate the # Start JMX configuration

options.

# Start JMX configuration, Enable JMX by default, to Disable comment out the next 4
lines
-Dcom.sun.management.jmxremote
-Dcom.sun.management.jmxremote.port=3833
-Dcom.sun.management.jmxremote.authenticate=false
-Dcom.sun.management.jmxremote.ssl=false
# End JMX configuration

4. To disable JMX, add # before each -Dcom line to comment out the line:

# Start JMX configuration, Enable JMX by default, to Disable comment out the next 4
lines
# -Dcom.sun.management.jmxremote
# -Dcom.sun.management.jmxremote.port=3833
# -Dcom.sun.management.jmxremote.authenticate=false
# -Dcom.sun.management.jmxremote.ssl=false
# End JMX configuration

5. Save the file.

6. Run the following command to start the Spectrum service:

sudo service spectrum start

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 150

Configuring Spectrum for SNMP Support

Simple Network Management Protocol (SNMP) can be used to monitor the Spectrum
Application Server memory usage, garbage collection, runtime thread usage, and other
system-level concepts within Java. Leverage any SNMP-capable network management
application to communicate with the Spectrum Application Server. For more information
on the available objects and notifications, see the JVM-MANAGEMENT-MIB file in the
Spectrum downloads folder (http://<InitialServer>:8080/downloads).

Note: It is recommended that SNMP be used to monitor your Spectrum Application

Server, however, Loftware has created an application that can be used from within the
Spectrum user interface in the event that the SNMP solution is not an option. For more
information, contact Loftware.

Configuring Spectrum for SNMP support involves creating the SNMP Access Control List
(ACL) file, editing the file to set access control, and adding security to the file. To
configure Spectrum for SNMP support, perform the following steps on the Spectrum
Application Server:

Note: <SPECTRUM_HOME> represents the folder on the Spectrum Application Server

in which the Spectrum application is installed. For example, in Windows Server this
might be C:\Loftware\Spectrum\Spectrum, and in Linux this might be
/opt/loftware/spectrum/Spectrum. Although procedures in this documentation typically
use backslashes in operating system paths, you should use forward slashes if required
by your operating system.

1. From a command prompt or Terminal, navigate to the following folder:

<SPECTRUM_HOME>/jre/lib/management

2. Run the following command to copy the file snmp.acl.template to the file snmp.acl:

Windows: copy snmp.acl.template snmp.acl

Linux: cp snmp.acl.template snmp.acl

3. Open the snmp.acl file in a text editor.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 151

 4. Using the samples in the file, add ACL groups appropriate for your configuration in
the following format:
acl = {
{
communities = community1, community2
# Enter communities for which the ACL applies.
access = access
# Enter read-only or read-write.
managers = manager
# Enter hosts (machine name, single IP address, or IP netmask) to
be granted access rights.
}
}

Example

The following is an example of an ACL group that allows for full access to
the SNMP server via two SNMP communities, public and private.

acl = {
{
communities = public, private
access = read-only
managers = 0.0.0.0/32
}
}

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 152

 5. Using the samples in the file, specify trap groups (events sent out by the server to
specific hosts) in the following format:
trap = {
{
trap-community = community1
# Enter a single SNMP community that will be included in the traps
sent to the hosts.
hosts = host1, host2
# Enter hosts (specific names or IP addresses) to which the SNMP
agent will send traps.
}

Example

The following is an example of two trap community definitions for multiple hosts:

trap = {
{
trap-community = public
hosts = hubble, snowbell
}
{
trap-community = private
hosts = telescope
}

6. Save and close the snmp.acl file.

7. From a command prompt or Terminal, run the following commands from the
<SPECTRUM_HOME>/jre/lib/management location to secure the ACL file:

Important! The snmp.acl file must be owned by the same user that is running
Spectrum, and the user running Spectrum can be the only user that has access to
the file. If you need to remove the security to make additional edits, see Remove
SNMP ACL File Security.

Windows:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 153

 - icacls snmp.acl /inheritance:r /grant:r SYSTEM:(OI)(CI)R
- icacls snmp.acl /setowner SYSTEM

Linux:

- sudo chown spectrum:spectrum snmp.acl

- sudo chmod 0400 snmp.acl

8. To update the Java options in Spectrum, navigate to the following location:

<SPECTRUM_HOME>/product/bin

9. Open the Java options properties file in a text editor.

Windows: javaoptsWin.properties

Linux: javaoptsLinux.properties

10. Add the following lines to the file. The first line specifies the port the system is
listening for SNMP requests on, and the second line allows the request to come
through any network card on the system.

Windows:

-Dcom.sun.management.snmp.port=161
-Dcom.sun.management.snmp.interface=0.0.0.0

Linux:

-Dcom.sun.management.snmp.port=1161
-Dcom.sun.management.snmp.interface=0.0.0.0

11. If you want to specify the remote port to which the server will send SNMP traps, add
the following line to the file.

Note: You may set the remote ports to any values, provided your SNMP client is
also aware of those port settings.

Windows: -Dcom.sun.management.snmp.trap=162

Linux: -Dcom.sun.management.snmp.trap=1162

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 154

 12. Save and close the Java options properties file.

Note: In a multi-site deployment of Spectrum or if you are configuring a distributed

Spectrum environment, the following steps much be repeated on each Spectrum
Application Server.

13. If you have a Windows Spectrum Application Server, you must do the following to
reinstall the Spectrum service:

a. Stop the Loftware Spectrum service.

b. From a command prompt with administrator privileges, navigate to the

following folder:
<SPECTRUM_HOME>/product/bin

c. Run the following command:

service.bat update

d. Start the Loftware Spectrum service.

Remove SNMP ACL File Security

During the configuration for SNMP support, security was added to the snmp.acl file. If
you need to remove the security to make additional edits, perform the following steps.

1. From a command prompt or Terminal, navigate to the following folder:

<SPECTRUM_HOME>/jre/lib/management

2. Run the following command to remove the security:

Windows: - icacls snmp.acl /inheritance:e

Linux: - sudo chmod 0666 snmp.acl

Change the Archive Data Retention Time

During the initial Spectrum database installation, you were prompted to enter a job
archive datafile location and a job archive retention value. If you need to change the job
archive retention time, perform the following steps on the Spectrum Database Server:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 155

 1. From a command prompt with administrator privileges, navigate to the following
folder:
<SPECTRUM_HOME>\bin

2. Run the following command, where nn equals the number of months you want to
retain the archive data:
sputils set-value archive_retention_in_months nn jobService

Example

The following command sets the retention value to 12 months:

sputils set-value archive_retention_in_months 12 jobService

The folder for the job archive files was set during your installation. The default location is
<LOFTSTORE_HOME>\exports\archive.

Synchronize Application and Database Servers' Clocks

Spectrum uses timestamps from both the Application and Database servers to record
events. To make sure that the performance reporting is accurate, you must synchronize
the Application and Database servers' clocks.

Note: Spectrum will add a log message to the Critical Event Log if the timing is off by
plus or minus 100 ms.

Since synchronization is a function of the operating platform, the links below provide the
information to synchronize your servers directly from the operating platform vendors:

For Windows servers:

https://technet.microsoft.com/en-us/library/cc773263(v=ws.10).aspx

For Linux servers:

http://www.brennan.id.au/09-Network_Time_Protocol.html

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 156

Set a Default LDAP Domain

Users signing in to Spectrum should enter their user name using the format
username@domain. To allow users to sign in without entering a domain, administrators
can set a default domain using the following steps.

Note: If a user enters their user name using the format username@domain, the default
domain is disregarded. To sign in as a local user when a default domain is configured,
use the format username@none.

1. From a Command Prompt window with administrator privileges, navigate to the

following folder:

<SPECTRUM_HOME>\bin

2. Run the following command:

sputils set-value default.ldap.domain <domain>

systemManagement

Example

The following command sets the default LDAP domain to loftwareinc.com:

sputils set-value default.ldap.domain loftwareinc.com
systemManagement

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 157

Add an LDAPS Certificate

By default, LDAP communication between a client application and a server application is

not encrypted. However, you can secure LDAP communication by using LDAP over SSL
(LDAPS). To use LDAPS with Spectrum, you must install a certificate that is configured
for your environment (LDAPS does not function with the Spectrum self-signed certificate).
After you have configured LDAP authentication in Spectrum and have assigned the
applicable domain to users, perform the following steps to add an LDAPS certificate.

Note: <SPECTRUM_HOME> represents the folder on the Spectrum Application Server

in which the Spectrum application is installed. For example, in Windows Server this
might be C:\Loftware\Spectrum\Spectrum, and in Linux this might be
/opt/loftware/spectrum/Spectrum. Although procedures in this documentation typically
use backslashes in operating system paths, you should use forward slashes if required
by your operating system.

1. Obtain a copy of your SSL certificate from your LDAP server and save the
certificate to the local drive on the Spectrum Application Server as ldapcert.txt.

2. Open a command prompt or terminal session and navigate to <SPECTRUM_

HOME>/jre/bin.

Example
cd C:\Loftware\Spectrum\Spectrum\jre\bin

3. Run the following command:

keytool -import -alias "openldap"
-file LOCAL_DRIVE:\ldapcert.txt
-keystore <SPECTRUM_HOME>\product\conf\keystore

Example
keytool -import -alias "openldap"
-file C:\ldapcert.txt
-keystore C:\Loftware\Spectrum\Spectrum\product\conf\keystore

4. When prompted, enter the keystore password.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 158

 5. When prompted to trust this certificate, answer Yes.

6. Restart the Loftware Spectrum service.

Set Server Domain Names

You may need to configure the IP Address, DNS Alias, or Public DNS Name of your
Spectrum servers in Access Control, depending on how Spectrum is deployed on your
network.

l IP Address is the expected IP address of the server.

l DNS Alias is a CNAME record for the Spectrum server entered in your DNS server.
l Public DNS Name is the address users will enter to access Spectrum if it is
deployed outside your network.

If you enter a value in all fields, the Public DNS Name will be checked first, and the DNS
Alias value will be checked next. If neither the Public DNS Name nor the DNS Alias
match or no value was entered, then the IP Address value will be checked.

Configuring these fields can be useful in a Spectrum environment configured to use

distributed services or for users who might access Spectrum through a VPN. Public DNS
Name is used when distributed services servers are deployed outside your network, such
as on Amazon Web Services (AWS).

Change Service Ports

Service port numbers for the Spectrum Application Server are configured during the
installation of the Spectrum application. If you need to change port numbers after
installation (for example, for SSL configuration), you can modify them in the JVM process
in Spectrum, as well as in the server.xml and javaoptsWin.properties or
javaoptsLinux.properties files on the Spectrum Application Server.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 159

Note: <SPECTRUM_HOME> represents the folder on the Spectrum Application Server
in which the Spectrum application is installed. For example, in Windows Server this
might be C:\Loftware\Spectrum\Spectrum, and in Linux this might be
/opt/loftware/spectrum/Spectrum. Although procedures in this documentation typically
use backslashes in operating system paths, you should use forward slashes if required
by your operating system.

1. Sign in to Loftware Spectrum.

2. In Access Control, select the JVM Process for the applicable server.

3. Click Edit and modify the following port numbers as needed for your environment.
l JVM Port
l Secure JVM Port
l JMS Port
l Integration Port

4. Click Save.

5. Sign out of Spectrum.

6. On the Spectrum Application Server, stop the Loftware Spectrum service or

Loftware Spectrum daemon.

7. Open a command prompt or terminal session and navigate to <SPECTRUM_

HOME>\product\conf.

8. Using a text editor, open the server.xml file.

9. Modify the following ports as needed for your environment:

l Server port
l Connector port
l redirectPort
l proxyPort

10. Save and close the file.

11. Navigate to <SPECTRUM_HOME>\product\bin.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 160

 12. Using a text editor, open the javaoptsWin.properties or javaoptsLinux.properties
file.

13. Modify the jmxremote.port number for your environment.

# Start JMX configuration, Enable JMX by default, to Disable
comment out the next 4 lines
-Dcom.sun.management.jmxremote
-Dcom.sun.management.jmxremote.port=3833
-Dcom.sun.management.jmxremote.authenticate=false
-Dcom.sun.management.jmxremote.ssl=false
# End JMX configuration

14. Save and close the file.

15. If you have a Windows Spectrum Application Server, run the following command in
the <SPECTRUM_HOME>\product\bin folder to apply the settings:
service.bat update

16. Start the Loftware Spectrum service or daemon.

Change the Source of Spectrum Help

By default, users who click help links in Spectrum are directed to a dynamic version of the
Spectrum User Guide that is hosted on Loftware's website. This option is recommended
because it provides users with the most current documentation for Spectrum. The
dynamic web-based help may change frequently because it may be updated when issues
are discovered or resolved, as well as when new functionality is added to Spectrum.

For Spectrum environments in which internet connectivity is unavailable, an administrator

can direct users to a static copy of the Spectrum User Guide that is installed on the
Spectrum Application Server.

Important! Configuring this option impacts all users of this Spectrum environment.

Note: To perform this task, you must be signed in as the SystemAdmin or SuperAdmin
user. For more information, see the Spectrum User Guide (Help).

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 161

Provide Static Help to Users

To configure a Spectrum environment to provide users with static help for Spectrum, use
the following procedure.

Note: This option is not recommended unless lack of internet connectivity or other
issues make it impractical to use dynamic help in your environment.

1. Sign in to Spectrum.

2. In System , click System Preferences.

3. In the Help Preferences panel, for Source Location select Local.

Provide Dynamic Help to Users (Recommended)

To configure a Spectrum environment to provide users with dynamic help for Spectrum,
use the following procedure.

Note: Dynamic help is the default configuration. The following procedure is necessary
only if the source of Spectrum Help has been changed to static help.

1. Sign in to Spectrum.

2. In System , click System Preferences.

3. In the Help Preferences panel, for Source Location select Remote.

Spectrum LoftStore Utility

There is a command line utility available for configuring and managing the Spectrum
database (LoftStore). You can use the Spectrum LoftStore Utility (ls_utils) in the
<LOFTSTORE_HOME>\bin folder to perform the actions described in the following
table.

Usage

ls_utils [cmd]

Example
C:\Loftware\Spectrum\LoftStore\bin>ls_utils -help

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 162

Available Commands [cmd]

Command Description

-help Get a list and description of the available commands.

start Start the LoftStore datastore.

startpfile Start the LoftStore datastore using a specified PFILE as full

path. If no PFILE is specified, the value will default to
<LOFTSTORE_
HOME>\product\database\initLOFTSTORE.ora

stop Stop the LoftStore datastore.

stop-now Stop the LoftStore datastore immediately.

export Export the LoftStore datastore to file.

import Import a file to the LoftStore datastore.

loftuser Unlock the LOFTUSER account and reset the password by

prompt.

postinstall Apply an SQL Script to the Spectrum Embedded Database

Note: SQL files must follow the naming convention:

POST*.sql
cleanuplicense Delete the license related information from the database.

cleanup_ Delete the cluster configuration information from the database.

cluster_config

recovery_file_ Set archive destination folder.

dest

Apply an SQL Script to the Spectrum Embedded Database

This procedure may be used by Loftware Professional Services or experienced Database

Administrators to apply configuration changes to the embedded Spectrum database
(LoftStore) after an installation.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 163

Note: The Loftware-supplied embedded database is supported only for customers who
have upgraded from a version prior to Loftware Spectrum 4.1.

Script templates may be provided and will follow the naming convention
POST%.sql.tmpl.

Use the following procedure to load the SQL script into the Spectrum database:

1. Place the template file in the <LOFTSTORE_HOME>\bin folder.

2. Open the configure.properties file in a text editor, and add the template name to
the file.

3. Open a Command Prompt window and navigate to the <LOFTSTORE_HOME>\bin

folder.

4. Run configure.

5. Run ls_utils postinstall to run the script.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 164

View Default Users and PDF Print Location

Using a browser, you can view the completed PDF print jobs by user outside of the
Spectrum application at the following address:

http://<spectrum-server>:8080/pdf

The default PDF location can be changed for privacy to prevent this observation, or it can
be turned off by editing the web.xml file.

Turn Off the Default View Address

1. On the Spectrum Application Server, navigate to the following folder:

<SPECTRUM_HOME>\product\conf

2. Open the web.xml file and find the default servlet section:

3. Under the param-name listings, change the true param-value to false.

4. Save and close the file.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 165

Optimizing Database Storage When Necessary

To minimize disk space usage on your database servers, especially if your labels use a
large number of images, you can run a command to change a database setting that
allows Loftstore image and label data to be stored using Oracle CLOBs (Character Large
Objects). A CLOB is a specific Oracle LOB (Large Object) data type.

Using this setting allows a document to be saved multiple times without duplicating the
storage space. The data is compressed and "deduplicated". With deduplication, after the
initial data is stored, a second, third, or any future update employs a hash code that refers
to the original data instead of duplicating the data by using additional storage.

This setting may dramatically reduce storage size of images and templates when
compression and deduplication are enabled and the same label is printed repeatedly.
The setting affects tables that have not been compressed in the archive and are older
than one month.

Note: This setting only works for the Spectrum database installed in an Oracle database
and not the Loftware-supplied database.

When to Apply the Optimization Setting

To determine when to use this optimization setting, consider the following:

l If your labels use a large number of images, you will get the most benefit from
database optimization, unless you have additional storage available.
l If your labels do not use a large number of images, the benefits to you are marginal.
l If your labels do not use images at all, this setting offers no benefit and is not
recommended.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 166

What to Consider

The value of using the database optimization setting, along with related
database.settings, such as table.extent.size, is highly dependent on the customer's
implementation and printing plans. Database Compression negatively affects
performance, but positively affects disk space.

If you are using larger images on your labels and have larger numbers of images in your
print streams, you will require additional storage, whether you get that from saving space
using optimization or simply extending your storage capacity.

However, for high speed printing it may be preferable to use the additional storage space
and maintain maximum performance.

In addition, the archive retention time (jobService, archive_retention_in_months) will also

impact the benefits of compression — longer retention times require more storage and
would benefit more from compression.

Guidelines for Applying the Optimization Setting

If you have a dedicated application server, the command should be run only by a
database administrator who is familiar with using Oracle LOBs to aide in storage
management.

Important! If you have an application server with an embedded database, you must
contact Loftware's Professional Services Group (PSG) for assistance. For an embedded
database, the command should only be run by Loftware personnel.

The following are required prerequisites before enabling data compression:

l An Oracle Advanced Compression license for LOB storage (customer provided).

l New tablespaces that are created and managed with Oracle Automatic Segment
Space Management (ASSM).

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 167

For more information about creating tables for LOB Storage, refer to the following topic in
the Oracle Database SecureFiles and Large Objects Developer's Guide:
http://docs.oracle.com/cd/E11882_01/appdev.112/e18294/adlob_
tables.htm#ADLOB45259

How to Change the Database Optimization Setting

Before changing the optimization setting, note the following:

l You must have already successfully completed the configure or dbupgrade scripts
on the newly created tablespaces.
l SYSTEM or SYS permissions are required to run this command.
l Loftware strongly recommends running the command with the database offline.

Use the following command at a Command Prompt to set database optimization in

LoftStore:

sputils set-value table.compress true database.settings

This command adds a new entry into the LoftStore system properties table that allows the
data to be stored using Oracle CLOBs.

To remove this setting and turn off optimization, use the following command:

sputils set-value table.compress false database.settings

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 168

Updating the LOFTUSER Password

Updating the LOFTUSER password involves changing the password on the Spectrum
Database Server and then on Spectrum Application Server or Servers.

Note: Updating and encrypting the LOFTUSER password is only supported on an

Oracle or PostgreSQL database and is not supported on the Loftware-supplied
database.

On the Spectrum Database

To change the LOFTUSER password in the Spectrum database (LOFTSTORE), run the
following SQL command:

ALTER USER LOFTUSER IDENTIFIED BY new_password

On the Spectrum Application Server

Perform the following steps on the initial Spectrum Application Server.

Note: <SPECTRUM_HOME> represents the folder on the Spectrum Application Server

in which the Spectrum application is installed. For example, in Windows Server this
might be C:\Loftware\Spectrum\Spectrum, and in Linux this might be
/opt/loftware/spectrum/Spectrum. Although procedures in this documentation typically
use backslashes in operating system paths, you should use forward slashes if required
by your operating system.

1. Stop the Loftware Spectrum service or daemon.

2. Navigate to <SPECTRUM_HOME>\product\conf and make a backup copy of the

jdbc.properties file.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 169

 3. Update the following passwords in the jdbc.properties file:
jdbc.password=new_password
jdbc.admin.password=new_password
jvm.management.password=loftware

If you are configuring a multi-site deployment, you must also update the following
password:

multisite.management.password=loftware

4. Locate the password.management property, and change "encrypt" to "clear."

password.management=clear

5. Save the changes.

6. Perform the following export:

Windows:

set SPECTRUM_HOME="path_to_spectrum_home"
set JAVA_HOME=%SPECTRUM_HOME%\jre

Linux:

export SPECTRUM_HOME="path_to_spectrum_home"
export JAVA_HOME=${SPECTRUM_HOME}/jre

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 170

 7. Execute the following command on one continuous line from <SPECTRUM_
HOME> to re-encrypt the jdbc.properties file.

Windows:

%JAVA_HOME%\bin\java
-cp "%SPECTRUM_HOME%/lib/*;%SPECTRUM_HOME%/product/endorsed/*;"
com.loftware.schema.LoftwareConfigurationTool
-passwordManagement encrypt -action updateprops -dbfile
%SPECTRUM_HOME%\product\conf\jdbc.properties

Linux:

${JAVA_HOME}/bin/java
–cp "${SPECTRUM_HOME}/lib/*:${SPECTRUM_HOME}/product/endorsed/*:"
com.loftware.schema.LoftwareConfigurationTool
-passwordManagement encrypt -action updateprops –dbfile
"${SPECTRUM_HOME}/product/conf/jdbc.properties"

8. Restart the Loftware Spectrum service or daemon and then test the Spectrum
Application Server.

Distributed Services Environments

If Spectrum is installed in a distributed services environment, the encrypted passwords

for jdbc.password and jdbc.admin.password must be copied to the jdbc.properties file
on all additional Spectrum Application Servers.

1. Copy the encrypted passwords from the initial Spectrum Application Server to the
additional Spectrum Application Servers.

2. Make sure password.management is set to "encrypt" in the updated

jdbc.properties files.

3. Restart each Spectrum Application Server.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 171

Configure Lambda Function and Event Rules in AWS

If your Spectrum database is using Amazon RDS for PostgreSQL, the implementation for
archiving in AWS is done with a combination of a Lambda script and a Cloud Event cron
task. A new Lambda jar is included in the setup directory of LoftstoreLoad-PSQL.zip. In
addition, the setup directory also contains the rds_archive_jobs.json, rds_manage_
archive_tables.json, and rds_refresh_mv.json files referenced in the following
instructions. These files are updated or generated after the initial PostgreSQL
configuration steps.

After completing the following instructions, there will be three Lambda Functions and
three EventBridge rules in matching pairs; there will be a Lambda Function and
EventBridge rule for the Archive Job task, a Lambda Function and EventBridge rule for
the Manage Archive Table task, and a Lambda Function and EventBridge rule for the
RDS Refresh MV task.

Configuring Lambda function and EventBridge rules in AWS involves the following tasks:

A. Creating IAM Access Keys

B. Modifying rds_archive_jobs.json
C. Modifying rds_manage_archive_tables.json
D. Modifying rds_refresh_mv.json
E. Adding Archive Job Lambda Function
F. Adding Managing Archive Tables Lambda Function
G. Adding Refresh MV Lambda Function
H. Adding CloudWatch Rules

A. Creating IAM Access Keys

The Manage Archive Tables Lambda Function will require an access key ID and a secret
access key. For more information, see the AWS Documentation, Managing access keys
for IAM users.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 172

B. Modifying rds_archive_jobs.json

1. In the setup folder, open the rds_archive_jobs.json file.

2. Confirm or update the URL string to reflect the correct database name, username,
and password in the connection string.

3. Update the stmptsql string value.

a. Locate the string FROM loftspec.job and update the table reference to
include the schema prefix.

C. Modifying rds_manage_archive_tables.json

1. In the setup folder, open the rds_manage_archive_tables.json file.

2. Confirm or update the URL string to reflect the correct database name, username,
and password in the connection string.

3. Ensure the loftarchschemaName reflects the schema_prefix.

4. Ensure the loftspecsscheaName reflects the schema_prefix.

5. Update the accessKey value with the appropriate access key value.

6. Update the secretKey value with the appropriate secret key value.

7. Update the region value accordingly.

8. Update the bucketName value accordingly.

9. Update the path value accordingly.

D. Modifying rds_refresh_mv.json

1. In the setup folder, open the rds_refresh_mv.json file.

2. Confirm or update the URL string to reflect the correct database name, username,
and password in the connection string.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 173

E. Adding Archive Job Lambda Function

1. Log in to the AWS Management Console and go to the Lambda Service page.

2. On the AWS Lambda page, click Create Function.

3. Select Author from scratch.

4. In the Function Name field, enter a meaningful customer specific function name.

Example

SomeCustomer_SpectrumArchiveJobsLambda

5. In the Runtime field, select a runtime of Java 8.

6. Expand Advanced settings and complete the VPC connection information as

necessary. This will allow the Security Groups to have access to the RDS instance
via the VPC.

7. Click Create Function.

8. Under Function Code, click Actions | Upload a .zip or .jar file.

a. Navigate to the loftware-aws-lambda-X.X.X.X.jar file (where X.X.X.X may

vary between versions of Spectrum) located in the setup directory from where
you executed the LoftStore installation.

9. In Runtime settings, click Edit.

a. In the Handler field, enter the following:

com.loftware.utilities.database.lambda.DatabaseLambda::handleRequest

b. In Basic settings, under Execution role select Use an Existing role.

c. Under Existing role, click View <rolename> role on the IAM console and
ensure the role has the AWSLambdaVPCAccessExecutionRole attached to
it. If not, click Attach polices, locate the policy, and add it.

Note: This may launch the IAM Console in a different tab.

d. Click Save.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 174

10. Do the following to create the test event for Archive Jobs:

a. In the menu options at the top of the Lambda Function view, click the Select a
test Event drop-down list and select Configure test event.

b. In the Event Template, select Amazon Cloudwatch. The Event Template

name should reflect cloudwatch-scheduled-event.

c. In the Event name field, enter a meaningful test event name.

Example

ArchiveJobTest

d. In the data entry field below the event name field, copy the JSON script from
the updated rds_archive_jobs.json file in the setup directory.

e. Click Create.

11. Do the following to execute tests:

a. Next to TEST, select ArchiveJobTest from the drop-down list.

b. Click TEST. This will execute the Lambda function on the target PostgreSQL
instance referenced in the JSON string associated with the selected test.

c. In the results view, confirm the function executes without errors.

d. Close the Execution results view.

12. Select Action|Publish to publish the active version of the function.

a. In the Publish new version dialog, enter a meaningful name for the version.

13. Do the following to set the concurrency parameter to 1 to prevent a negative impact
on the database in case of the Lambda Function failure:

a. On the Lambda Service page for the Function, click the Configuration tab.

b. In the menu on the left, click Concurrency.

c. Click Edit.

d. Select Reserve concurrency and enter 1.

e. Click Save.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 175

F. Adding Managing Archive Tables Lambda Function

1. Log in to the AWS Management Console and go to the Lambda Service page.

2. On the AWS Lambda page, click Create Function.

3. Choose Author from scratch.

4. In the Function Name field, enter a meaningful customer specific function name.

Example

SomeCustomer_SpectrumManageArchiveTablesLambda

5. In the Runtime field, select a runtime of Java 8.

6. Expand Advanced settings.

a. Complete the VPC connection information as necessary. This will allow the
Security Groups to have access to the RDS instance via the VPC.

7. Click Create Function.

8. Under Function Code, click Actions | Upload a .zip or .jar file.

a. Navigate to the loftware-aws-lambda-X.X.X.X.jar file (where X.X.X.X may

vary between versions of Spectrum) located in the setup directory from where
you executed the LoftStore installation.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 176

 9. In Runtime settings, click Edit.

a. In the Handler field, enter the following:

com.loftware.utilities.database.lambda.DatabaseLambdaCopyPGToS3::han
dleRequest

b. In Basic settings, under Execution role select Use an Existing role.

c. Under Existing role, click View <rolename> role on the IAM console and
ensure the role has the AWSLambdaVPCAccessExecutionRole attached to
it. If not, click Attach polices, locate the policy, and add it.

Note: This may launch the IAM Console in a different tab.

d. Click Save.

10. Do the following to create test events for Manage Archive Table:

a. In the menu options at the top of the Lambda Function view, click the Select a
test Event drop-down list and select Configure test event.

b. In the Event Template, select Amazon Cloudwatch. The Event Template

name should reflect cloudwatch-scheduled-event.

c. In the Event name field, enter a meaningful test event name.

Example

ManageArchiveTableTest

d. In the data entry field below the event name field, copy the JSON script from
the updated rds_manage_archive_tables.json file in the setup directory.

e. Click Create.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 177

11. Do the following to execute tests:

a. Next to TEST, select ManageArchiveTableTest from the drop-down list.

b. Click TEST. This will execute the Lambda function on the target PostgreSQL
instance referenced in the JSON string associated with the selected test.

c. In the results view, confirm the function executes without errors.

d. Close the Execution results view.

12. Select Action|Publish to publish the active version of the function.

a. In the Publish new version dialog, enter a meaningful name for the version.

13. Do the following to set the concurrency parameter to 1 to prevent a negative impact
on the database in case of the Lambda Function failure:

a. On the Lambda Service page for the Function, click the Configuration tab.

b. In the menu on the left, click Concurrency.

c. Click Edit.

d. Select Reserve concurrency and enter 1.

e. Click Save.

G. Adding Refresh MV Lambda Function

1. Log in to the AWS Management Console and go to the Lambda Service page.

2. On the AWS Lambda page, click Create Function.

3. Select Author from scratch.

4. In the Function Name field, enter a meaningful customer specific function name.

Example

SomeCustomer_RefreshMVLambda

5. In the Runtime field, select a runtime of Java 8.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 178

 6. Expand Advanced settings and complete the VPC connection information as
necessary. This will allow the Security Groups to have access to the RDS instance
via the VPC.

7. Click Create Function.

8. Under Function Code, click Actions | Upload a .zip or .jar file.

a. Navigate to the loftware-aws-lambda-X.X.X.X.jar file (where X.X.X.X may

vary between versions of Spectrum) located in the setup directory from where
you executed the LoftStore installation.

9. In Runtime settings, click Edit.

a. In the Handler field, enter the following:

com.loftware.utilities.database.lambda.DatabaseLambda::handleRequest

b. In Basic settings, under Execution role select Use an Existing role.

c. Under Existing role, click View <rolename> role on the IAM console and
ensure the role has the AWSLambdaVPCAccessExecutionRole attached to
it. If not, click Attach polices, locate the policy, and add it.

Note: This may launch the IAM Console in a different tab.

d. Click Save.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 179

10. Do the following to create the test event for Refresh Job:

a. In the menu options at the top of the Lambda Function view, click the Select a
test Event drop-down list and select Configure test event.

b. In the Event Template, select Amazon Cloudwatch. The Event Template

name should reflect cloudwatch-scheduled-event.

c. In the Event name field, enter a meaningful test event name.

Example

RefreshJobTest

d. In the data entry field below the event name field, copy the JSON script from
the updated rds_refresh_mv.json file in the setup directory.

e. Click Create.

11. Do the following to execute tests:

a. Next to TEST, select RefreshMVTest from the drop-down list.

b. Click TEST. This will execute the Lambda function on the target PostgreSQL
instance referenced in the JSON string associated with the selected test.

c. In the results view, confirm the function executes without errors.

d. Close the Execution results view.

12. Select Action|Publish to publish the active version of the function.

a. In the Publish new version dialog, enter a meaningful name for the version.

13. Do the following to set the concurrency parameter to 1 to prevent a negative impact
on the database in case of the Lambda Function failure:

a. On the Lambda Service page for the Function, click the Configuration tab.

b. In the menu on the left, click Concurrency.

c. Click Edit.

d. Select Reserve concurrency and enter 1.

e. Click Save.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 180

H. Adding CloudWatch Rules

You need to create three CloudWatch rules:

l A rule to archive the jobs, configured to run every minute.

l A rule to manage the archive tables, configured to run once a day (midnight).
l A rule to refresh the materialized views, configured to run once a day (midnight).

To create the CloudWatch rules, do the following.

1. Go to the CloudWatch Service page.

2. Do the following to create the rule to archive jobs:

a. Under Events, select Rules from the left side navigation.

b. Click Create Rule.

c. Under Event Source, select Schedule.

d. Select Fixed rate of and enter a value of 1. Ensure the interval is set to
Minutes.

e. Click Add target and select the Customer Specific Archive Jobs Lambda
function you previously created.

f. Under Configure Input select Constant. Copy the JSON from the modified
rds_archive_jobs.json file in the setup directory that you previously updated.

g. Click Configure Details.

h. In the name field, enter a descriptive name.

Example

SomeCustomer_ArchiveJobs

i. Fill in the description field appropriately.

j. Click Create Rule.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 181

 3. Do the following to create the rule to manage archive tables:

a. Under Events, select Rules from the left side navigation.

b. Click Create Rule.

c. Under Event Source, select Schedule.

d. Select Cron expression.

e. Enter the Cron expression 0 0 * * ? * to run the job every day at midnight.

f. Click Add target and select the Customer Specific Manage Archive Tables
Lambda function you previously created.

g. Under Configure Input choose Constant. Copy the JSON from the modified
rds_manage_archive_tables.json file in the setup directory that you
previously updated.

h. Click Configure Details.

i. In the name field, enter a descriptive name.

Example

SomeCustomer_ManageArchiveTables

j. Fill in the description field appropriately.

k. Click Create Rule.

4. Do the following to create the rule to refresh the materialized views:

a. Under Events, select Rules from the left side navigation.

b. Click Create Rule.

c. Under Event Source, select Schedule.

d. Select Cron expression.

e. Enter the Cron expression 0 0 * * ? * to run the job every day at midnight.

f. Click Add target and select the Customer Specific Refresh MV Lambda
function you previously created.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 182

 g. Under Configure Input choose Constant. Copy the JSON from the modified
rds_refresh_mv.json file in the setup directory that you previously updated.

h. Click Configure Details.

i. In the name field, enter a descriptive name.

Example

SomeCustomer_RefreshMV

j. Fill in the description field appropriately.

k. Click Create Rule.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 183

Upgrading Loftware Spectrum

In Loftware terminology, moving to a more current Spectrum release is an upgrade. With

an upgrade, you should be able to retain current data from your existing system. For
example, if you upgrade from Spectrum 3.0 to 4.0, all of your existing label templates are
still available and do not have to be recreated.

Note: Occasionally, Loftware releases a hotfix to address a specific issue. The

installation instructions for a hotfix are contained in the hotfix package.

Upgrading Spectrum involves the following tasks:

l Preparing to Upgrade
l Upgrading the Spectrum Database
l Upgrading the Spectrum Application

Then continue to the following tasks:

l After Upgrading Spectrum

l Oracle Integrations
l Upgrading the Command Line Interpreter (CLI)
l Upgrading Spectrum Remote Print
l Upgrading Spectrum for Distributed Services
l Starting Services for Multi-Site Deployment
l Managing the Loftware DaVinci Password
l Upgrading Spectrum with SSO

If an Upgrade Fails or Cancels

If you need to cancel an upgrade-in-progress, or if an upgrade fails for some reason,

Loftware recommends you perform the following steps:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 184

 1. Restore Spectrum from the backup version you created.

2. Fix the issue if known, otherwise call Loftware Technical Support for help.

3. Restart the upgrade process on the restored Spectrum database.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 185

Preparing to Upgrade

Before upgrading Spectrum, review and complete the tasks in this section.

Important: Be sure to review the Release Notes included in the release package for
additional information, such as known issues and workarounds related to installing,
upgrading, and using Spectrum.

Important: Loftware Spectrum 4.0 must be installed before upgrading to Spectrum 4.7.1.
If you are on a version prior to Loftware Spectrum 4.0, then you cannot upgrade to
Spectrum 4.7.1 directly — you must first upgrade to Spectrum 4.0. If you are upgrading
from a version prior to Spectrum 4.0, do the following:

1. Upgrade to Loftware Spectrum 4.0. For more information, see "Upgrading

Loftware Spectrum" in the 4.0 Loftware Spectrum Installation and Configuration
Guide.

2. Upgrade to Loftware Spectrum 4.7.1 following the instructions in this guide.

Determine the Existing Database Configuration 187

Check Technical Requirements 187

Create a Backup of your Existing Spectrum Database 187

Create a Backup of your Configuration Files 188

Third Party JDBC Drivers 188

Integration for Use with SAP® Applications 188

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 186

Determine the Existing Database Configuration

The instructions for upgrading Spectrum depend on your database configuration. To

determine whether you are using a Spectrum database on an Oracle database server or
the Loftware-supplied database, use the following procedure for your version of
Spectrum.

1. Sign in to Spectrum.

2. In System, click System Properties.

3. In the Key column filter, type isembedded.

4. If the system Value for isembedded is true, then you are using the Loftware-
supplied database. If the system Value is false, then you are using a Spectrum
database on an Oracle database or PostgreSQL server.

Check Technical Requirements

Check the latest Technical Requirements for Spectrum 4.7.1 to verify that your current
servers still meet or exceed the technical requirements for the new version of Spectrum.
You must verify that the server hardware, operating systems, third-party software, and
integrated software components are supported. For ALL Components listed in the
Technical Requirements, the Requirement listed alongside must be met or exceeded,
unless a specific version or value is indicated.

For customers with the Loftware-supplied database, review the Constraints section of the
Technical Requirements to verify that your use is within limits of the embedded solution.

Create a Backup of your Existing Spectrum Database

This backup is intended for use if there is an upgrade failure.

l If you are using the Spectrum database in Oracle, your site's database
administrator should create a backup using your company's standards and tools.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 187

 l If you are using the Spectrum database in PostgreSQL, refer to the backup and
restore documentation on the PostgreSQL website (https://www.postgresql.org).
l If you are using the Loftware-supplied database, you will create a backup as part of
the upgrade process. For more information, Upgrade Spectrum Embedded
Database on Windows Server

For additional information on backup and recovery, see Maintaining and Protecting
Spectrum .

Create a Backup of your Configuration Files

Depending on your implementation, you or Loftware Professional Services may have

made customizations to certain files or settings on the Spectrum Application Server. To
ensure that you retain any custom configurations in your environment, create a copy of
the <SPECTRUM_HOME>\product\conf folder before upgrading for comparing or
merging after upgrading. Make sure to move the files outside of the Spectrum folder
structure, as they may be overwritten during the upgrade.

Third Party JDBC Drivers

If you had previously added any third party JDBC drivers to your Spectrum system, copy
the drivers from <SPECTRUM_HOME>\product\lib to a temporary folder outside of the
Spectrum folder structure so that you can add them back after upgrading.

Integration for Use with SAP® Applications

If you previously added the third party SAP Java Connector (SAP JCo) library to your
Spectrum instance for use with Integration for use with SAP® Applications, check which
version of SAP JCo is currently supported in Spectrum (see Requirements for
Integration for use with SAP® Applications). If your existing version is supported, copy
the SAP JCo jar file in <SPECTRUM_HOME>\product\endorsed to a temporary folder
outside of the Spectrum folder structure. If your existing version is not supported,
download the supported SAP JCo version from SAP Support Portal. You will add the SAP
JCo back to the folder after upgrading.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 188

Upgrading the Spectrum Database

This section describes how to upgrade the Loftware Spectrum® database. Before
performing the procedures in this section, be sure you have completed the tasks in
Preparing to Upgrade.

To upgrade the Spectrum database, use the following procedure for your operating
system and database:

Upgrade Spectrum Database in Oracle on Windows Server 190

Upgrade Spectrum Database in Oracle on Linux 198

Upgrade Spectrum Database in PostgreSQL on Windows Server 205

Upgrade Spectrum Database in PostgreSQL on Linux 211

Upgrade Spectrum Embedded Database on Windows Server 216

Spectrum Application Backup 217

Spectrum Database Backup 217

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 189

Upgrade Spectrum Database in Oracle on Windows Server

This section describes upgrading the Loftware Spectrum database in Oracle on a server
running a Windows Server operating system. These instructions apply when you are
using a non-embedded database and not the Loftware-supplied database.

Important: Loftware Spectrum 4.0 must be installed before upgrading to Spectrum 4.7.1.
If you are on a version prior to Loftware Spectrum 4.0, then you cannot upgrade to
Spectrum 4.7.1 directly — you must first upgrade to Spectrum 4.0. If you are upgrading
from a version prior to Spectrum 4.0, do the following:

1. Upgrade to Loftware Spectrum 4.0. For more information, see "Upgrading

Loftware Spectrum" in the 4.0 Loftware Spectrum Installation and Configuration
Guide.

2. Upgrade to Loftware Spectrum 4.7.1 following the instructions in this guide.

Upgrading the Spectrum database in Oracle on Windows Server involves the following
tasks:

A. Stop the Spectrum Service

B. Download and Create Upgrade Folders

C. Upgrade the Spectrum Database (LoftStore)

The following references are used in this section:

l Spectrum Database Server refers to the LoftStore database host server.

l Client refers to computer on which you are running the Spectrum upgrade scripts.
This computer is running the Windows Server operating system.

A. Stop the Spectrum Service

Before proceeding with the upgrade, you need to stop the currently running Loftware
Spectrum service running on the Spectrum Application Server.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 190

If you are running a Distributed Service environment, the Loftware Spectrum service must
be stopped on all the Spectrum Application Servers.

If your license includes Spectrum Business Intelligence (BI), you must also stop the BI
services before upgrading. To stop the service, double-click the Stop JRS Service icon
on the desktop of the server where you installed Spectrum BI.

B. Download and Create Upgrade Folders

The upgrade can be run either directly from the database server or remotely from a client
computer. If running remotely from a client, the client computer should be run as an
Oracle user with privileges to run Oracle administrative tools on the client computer.

Note:<LOFTSTORE_HOME> refers to the folder in which the database configuration

files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore.
<SPECTRUM_HOME> refers to the folder on the Spectrum Application Server, such as
C:\Loftware\Spectrum\Spectrum or /opt/loftware/spectrum/Spectrum, in which the
Spectrum application is installed. Although procedures in this documentation typically
use backslashes in operating system paths, you should use forward slashes if required
by your operating system.

1. From the Loftware Spectrum installation package, copy the LoftstoreUpgrade-

win.zip file to a temporary folder on the machine where you are running the
installation.

2. Create a new upgrade folder to contain the required upgrade folders and files.

Recommended Location

<LOFTSTORE_HOME>\upgrade

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 191

 3. Extract the contents of LoftstoreUpgrade-win.zip package to the new upgrade
folder. The upgrade package contains the following:
l Folders from previous product version upgrades
l A folder for this current product release
l A datapump folder with upgrade support files
l A logs folder
l Java Runtime Environment (JRE) and Loftware Utility (lsutil) zip files
l A loftstore properties file
l The dbupgrade.cmd file and associated xml and configure.jar files.

4. Navigate to the upgrade\datapump folder and locate the .dmp files in the folder.

5. Copy the .dmp files into your job archive datafile location on the Spectrum
Database Server.

Note: The job archive datafile location was set during the initial installation of the
Spectrum database. The default location is <LOFTSTORE_
HOME>\exports\archive. After upgrading, you may delete the .dmp files from this
location if desired.

6. If you are upgrading from Spectrum 4.5 or later to Spectrum 4.7.1 and you opted to
use the Loftware-supplied tablespaces with default names during installation, skip
this step.
If you opted to use the Loftware-supplied tablespaces with custom names or to use
existing tablespaces with custom names, you must perform the following steps to
modify the tablespace names.

a. In your new upgrade folder, open the loftstore.properties.tmpl file in a text

editor.

b. Under the # Tablespace Names section, edit the following to be the custom
names of the tablespaces used during the Spectrum database installation.

Important! The custom tablespace names must use lowercase alphanumeric

characters only.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 192

 loftstore.tbsp.main=SPECTRUM_MAIN
loftstore.tbsp.audit=SPECTRUM_AUDIT
loftstore.tbsp.arch=SPECTRUM_ARCH
loftstore.tbsp.cust=SPECTRUM_CUST
loftstore.tbsp.davinci=SPECTRUM_DAVINCI

Example
loftstore.tbsp.main=mycustomname_spectrum_main
loftstore.tbsp.audit=mycustomname_spectrum_audit
loftstore.tbsp.arch=mycustomname_spectrum_arch
loftstore.tbsp.cust=mycustomname_spectrum_cust
loftstore.tbsp.davinci=mycustomname_spectrum_davinci

c. Save and close the loftstore.properties.tmpl file.

C. Upgrade the Spectrum Database (LoftStore)

This process describes upgrading the Spectrum database and should be run by an
Oracle user of the "oinstall" group (with administrative privileges) on the Client system.

1. Open a Command Prompt on the client computer and navigate to the upgrade
folder.

2. Run dbupgrade and respond to the following prompts:

Note: Loftware recommends you enter specific values for the dbupgrade prompts
that match your site's configuration. The default values shown on the dbupgrade
prompts should only be considered examples.

Tip: If the message No database upgrade required is displayed, the version of the
database you are installing is the same as your current database; therefore, you do
not need to upgrade the Spectrum database. Continue with Upgrading
the Spectrum Application.

Enter LOFTSTORE_HOME [default value]:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 193

 <LOFTSTORE_HOME> refers to the folder in which the database configuration
files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore. If you do not accept the default value, you can set
this location as a system variable for easier reference.

Upgrade the local embedded loftstore database? [N]:

Accept the default value N (no) and continue to the next prompt.

Enter ORACLE_HOME [default value]:

ORACLE_HOME defines the full folder path of the Oracle components on the client
computer running the install. The default value is imported from the system variable
of the same name. For example: C:\app\oracle\product\12.x.x\dbhome_
1. If you do not accept the default value, you can set this location as a system
variable for easier reference.

Important: ORACLE_HOME must contain sqlplus.exe in the following two

locations:

l ORACLE_HOME/sqlplus.exe
l ORACLE_HOME/bin/sqlplus.exe

If either is missing, copy sqlplus.exe to the missing location(s) and run the
dbupgrade script again.

Enter LoftStore database name without domain [default value]:

The LoftStore database name without domain uniquely identifies it from any other
databases.

Enter LoftStore database domain [default value]:

Database domain identifies the network domain for this database.

Enter LoftStore database hostname [default value]:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 194

 The hostname of the database identifies the server where the LoftStore database is
installed.

Enter LoftStore database port [default value]:

The port value on the database server for the LoftStore database, which identifies
the TCP/IP end point for a host connection.

Enter LoftStore database connection type (System Identifier (SID)

or Service Name (SN)) [default value]:

There are two connection types that you can use, but only one is required:
l The System Identifier (SID) identifies a specific instance of the database on
your server.
l The Service Name (SN) is a representative name for the database, which is
usually the Global database name, consisting of the database and domain
names.

Enter LoftStore database SID or SN [default value]:

Enter the SID or SN of your database. The SN needs to be the "fully qualified
service name" your site uses. For example: orcl.loftwareinc.com. Consult
your database administrator for your site's fully qualified naming convention.

Are Bigfile tablespaces in use? (Y|N) [N]:

Bigfile tablespaces is an Oracle feature. Consult your database administrator and

the Oracle documentation to see if your system is using this feature.

Disable MV statistics collection? (Y|N) [Y]:

Oracle Database collects and stores statistics about materialized view refresh
operations. If you are using Amazon RDS for Oracle Database, enter N (no).

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 195

 Enter the LoftStore database user name [sys]:

Enter the name of the database user with permissions to install the Spectrum
database.

Enter the LoftStore database user password:

Enter the password of the database user with permissions to install the Spectrum
database.

Confirm password:

Confirm the password of the Spectrum database user.

Is this user the sysdba of the LoftStore database? (Y|N) [Y]:

Indicate whether the database user is also the sysdba of the Spectrum database.

Are you accessing the LoftStore dump file from Loftware via Amazon
Web Services? (Y|N) [N]:

Indicate whether the LOFTSTORE.DMP file resides in Amazon Web Services.

Note: A number of dependency errors, with ORA IDs associated with them, may appear
when the upgrade process starts. These are expected and do not indicate a problem
with the upgrade.

The upgrade log files are available in the default location <LOFTSTORE_
HOME>/upgrade/logs. For an explanation of any messages, errors, or warnings that are
recorded in a log file, contact Loftware Technical Support.

Next Step

You have completed upgrading the Spectrum database.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 196

If your license includes Spectrum Business Intelligence (BI), you should restart the BI
services after upgrading. To start the service on a Windows Server operating system,
double-click the Start JRS Service icon on the desktop of the server where you installed
Spectrum BI. To start the service on a Linux operating system, run the
./ctlscript.sh start command from the location you chose for the installation
(default location is /opt/spectrumbi).

Continue with Upgrading the Spectrum Application.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 197

Upgrade Spectrum Database in Oracle on Linux

This section describes upgrading the Loftware Spectrum database in Oracle on a server
running a Linux operating system. These instructions apply when you are using a non-
embedded database and not the Loftware-supplied database.

Important: Loftware Spectrum 4.0 must be installed before upgrading to Spectrum 4.7.1.
If you are on a version prior to Loftware Spectrum 4.0, then you cannot upgrade to
Spectrum 4.7.1 directly — you must first upgrade to Spectrum 4.0. If you are upgrading
from a version prior to Spectrum 4.0, do the following:

1. Upgrade to Loftware Spectrum 4.0. For more information, see "Upgrading

Loftware Spectrum" in the 4.0 Loftware Spectrum Installation and Configuration
Guide.

2. Upgrade to Loftware Spectrum 4.7.1 following the instructions in this guide.

Upgrading the Spectrum database in Oracle on Linux involves the following tasks:

A. Stop the Spectrum Service

B. Download and Create Upgrade Folders

C. Upgrade the Spectrum Database (LoftStore)

The following references are used in this section:

l Spectrum Database Server refers to the LoftStore database host server.

l Client refers to the Linux computer where you are running the Spectrum upgrade
scripts.

A. Stop the Spectrum Service

Before proceeding with the upgrade, you need to stop the currently running Spectrum
services, running in all environments on the Spectrum Application Server.

To stop the service in Linux, execute the following command:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 198

sudo service spectrum stop

If your license includes Spectrum Business Intelligence (BI), you must also stop the BI
services before upgrading. To stop the service, run the following command from the
location you chose for the installation (default location is /opt/SpectrumBI):
./ctlscript.sh stop

B. Download and Create Upgrade Folders

The upgrade can be run either directly from the database server or remotely from a client
computer. If running remotely from a client computer, the client computer should be run
as an Oracle user with privileges to run Oracle administrative tools on the client
computer.

Note:<LOFTSTORE_HOME> refers to the folder in which the database configuration

files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore.
<SPECTRUM_HOME> refers to the folder on the Spectrum Application Server, such as
C:\Loftware\Spectrum\Spectrum or /opt/loftware/spectrum/Spectrum, in which the
Spectrum application is installed. Although procedures in this documentation typically
use backslashes in operating system paths, you should use forward slashes if required
by your operating system.

1. Copy the LoftstoreUpgrade-linux.zip file from the installation package to a

temporary folder on the computer where you are running the installation.

2. Create a new upgrade folder to contain the required upgrade folders and files.

Recommended Location

<LOFTSTORE_HOME>/upgrade

3. Extract the contents of LoftstoreUpgrade-linux.zip package to the new upgrade

folder. The upgrade package contains the following:
l Folders from previous product version upgrades
l A folder for this current product release
l A datapump folder with upgrade support files

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 199

 l A logs folder
l A tools folder for Java Runtime Environment (JRE)
l Loftware Utility (lsutil) zip files
l A loftstore properties file
l The dbupgrade.sh file and associated xml and configure.jar files.

4. Navigate to the upgrade/datapump folder and locate the .dmp files in the folder.

5. Copy the .dmp files into your job archive datafile location on the Spectrum
Database Server.

Note: The job archive datafile location was set during the initial installation of the
Spectrum database. The default location is <LOFTSTORE_
HOME>/exports/archive. After upgrading, you may delete the .dmp files from this
location if desired.

6. If you are upgrading from Spectrum 4.5 or later to Spectrum4.7.1 and you opted to
use the Loftware-supplied tablespaces with default names during installation, skip
this step.
If you opted to use the Loftware-supplied tablespaces with custom names or to use
existing tablespaces with custom names, you must perform the following steps to
modify the tablespace names.

a. In your new upgrade folder, open the loftstore.properties.tmpl file in a text

editor.

b. Under the # Tablespace Names section, edit the following to be the custom
names of the tablespaces used during the Spectrum database installation.

Important! The custom tablespace names must use lowercase alphanumeric

characters only.

loftstore.tbsp.main=SPECTRUM_MAIN
loftstore.tbsp.audit=SPECTRUM_AUDIT
loftstore.tbsp.arch=SPECTRUM_ARCH
loftstore.tbsp.cust=SPECTRUM_CUST
loftstore.tbsp.davinci=SPECTRUM_DAVINCI

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 200

 Example
loftstore.tbsp.main=mycustomname_spectrum_main
loftstore.tbsp.audit=mycustomname_spectrum_audit
loftstore.tbsp.arch=mycustomname_spectrum_arch
loftstore.tbsp.cust=mycustomname_spectrum_cust
loftstore.tbsp.davinci=mycustomname_spectrum_davinci

c. Save and close the loftstore.properties.tmpl file.

C. Upgrade the Spectrum Database (LoftStore)

This process describes upgrading the Spectrum database and should be run as an
Oracle user with privileges to run the Oracle administrative tools.

1. Open a Terminal on the client computer and navigate to the upgrade folder.

2. Run ./dbupgrade.sh and respond to the following prompts:

Note: For most upgrades, we recommend you specify values for the configure
prompts that match your site's configuration and NOT accept the default values,
since they only offer a limited local configuration.

Tip: If the message No database upgrade required is displayed, the version of the
database you are installing is the same as your current database; therefore, you do
not need to upgrade the Spectrum database. Continue with Upgrading
the Spectrum Application.

Enter LOFTSTORE_HOME: [default value]

<LOFTSTORE_HOME> refers to the folder in which the database configuration

files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore. If you do not accept the default value, you can set
this location as a system variable for easier reference.

Upgrade the local embedded loftstore database? [N]:

Accept the default value N (no) and continue to the next prompt.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 201

 Enter ORACLE_HOME [default value]:

ORACLE_HOME defines the full path of the Oracle components on the client
machine running the install. The default value is imported from the system variable
of the same name. For example: /app/oracle/product/12.x.x/dbhome_1.
If you do not accept the default value, you can set this location as a system variable
for easier reference.

Enter LoftStore database name without domain [default value]:

The LoftStore database name without domain uniquely identifies it from any other
databases.

Enter LoftStore database domain [default value]:

Database domain identifies the network domain for this database.

Enter LoftStore database hostname [default value]:

The hostname of the database identifies the server where the LoftStore database is
installed.

Enter LoftStore database port [default value]:

The port value on the database server for the LoftStore database, which identifies
the TCP/IP end point for a host connection.

Enter database connection type (System Identifier (SID) or Service

Name (SN)) [default value]:

There are two database connection types that you can use, but only one is required:

l The System Identifier (SID) identifies a specific instance of the database on

your server.
l The Service Name (SN) is a representative name for the database, which is
usually the Global database name, consisting of the database and domain
names.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 202

 Enter LoftStore database SID or SN [default value]:

Enter the SID or SN of your database. The SN needs to be the "fully qualified
service name" your site uses. For example: orcl.loftwareinc.com. Consult
your database administrator for your site's fully qualified naming convention.

Are Bigfile tablespaces in use? (Y|N) [N]:

Bigfile tablespaces is an Oracle feature. Consult your database administrator and

the Oracle documentation to see if your system is using this feature.

Disable MV statistics collection? (Y|N) [Y]:

Oracle Database collects and stores statistics about materialized view refresh
operations. If you are using Amazon RDS for Oracle Database, enter N (no).

Enter the LoftStore database user name [sys]:

Enter the name of the database user with permissions to install the Spectrum
database.

Enter the LoftStore database user password:

Enter the password of the database user with permissions to install the Spectrum
database.

Confirm password:

Confirm the password of the Spectrum database user.

Is this user the sysdba of the LoftStore database? (Y|N) [Y]:

Clarify if the database user is also the sysdba of the Spectrum database.

Are you accessing the LoftStore dump file from Loftware via Amazon
Web Services? (Y|N) [N]:

Indicate if the LOFTSTORE.DMP file resides in Amazon Web Services.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 203

 Note: A number of dependency errors, with ORA IDs associated with them, may
appear when the upgrade process starts. These are expected and do not indicate
a problem with the upgrade.

The upgrade log files are available in the default location <LOFTSTORE_
HOME>/upgrade/logs. For an explanation of any messages, errors, or warnings that are
recorded in a log file, contact Loftware Technical Support.

Next Step

You have completed upgrading the Spectrum database.

If your license includes Spectrum Business Intelligence (BI), you should restart the BI
services after upgrading. To start the service on a Windows Server operating system,
double-click the Start JRS Service icon on the desktop of the server where you installed
Spectrum BI. To start the service on a Linux operating system, run the
./ctlscript.sh start command from the location you chose for the installation
(default location is /opt/spectrumbi).

Continue with Upgrading the Spectrum Application.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 204

Upgrade Spectrum Database in PostgreSQL on Windows Server

This section describes upgrading the Loftware Spectrum database in PostgreSQL on a

server running a Windows Server operating system. These instructions apply when you
are using a non-embedded database and not the Loftware-supplied database.

Important: Loftware Spectrum 4.0 must be installed before upgrading to Spectrum 4.7.1.
If you are on a version prior to Loftware Spectrum 4.0, then you cannot upgrade to
Spectrum 4.7.1 directly — you must first upgrade to Spectrum 4.0. If you are upgrading
from a version prior to Spectrum 4.0, do the following:

1. Upgrade to Loftware Spectrum 4.0. For more information, see "Upgrading

Loftware Spectrum" in the 4.0 Loftware Spectrum Installation and Configuration
Guide.

2. Upgrade to Loftware Spectrum 4.7.1 following the instructions in this guide.

Upgrading the Spectrum database in PostgreSQL on Windows Server involves the

following tasks:

A. Stop the Spectrum Service

B. Download and Create Upgrade Folders

C. Upgrade the Spectrum Database (LoftStore)

The following reference is used in this section:

l Spectrum Database Server refers to the LoftStore/PostgreSQL host server.

A. Stop the Spectrum Service

Before proceeding with the upgrade, you need to stop the currently running Loftware
Spectrum service running on the Spectrum Application Server.

If you are running a Distributed Service environment, the Loftware Spectrum service must
be stopped on all the Spectrum Application Servers.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 205

If your license includes Spectrum Business Intelligence (BI), you must also stop the BI
services before upgrading. To stop the service, double-click the Stop JRS Service icon
on the desktop of the server where you installed Spectrum BI.

B. Download and Create Upgrade Folders

Perform the following steps on the Spectrum Database Server as an Administrator in

Windows Server.

Note:<LOFTSTORE_HOME> refers to the folder in which the database configuration

files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore.
<SPECTRUM_HOME> refers to the folder on the Spectrum Application Server, such as
C:\Loftware\Spectrum\Spectrum or /opt/loftware/spectrum/Spectrum, in which the
Spectrum application is installed. Although procedures in this documentation typically
use backslashes in operating system paths, you should use forward slashes if required
by your operating system.

1. From the Loftware Spectrum installation package, copy the LoftstoreUpgrade-

incrementalPSQL.zip file to a temporary folder on the machine where you are
running the installation.

2. Create a new upgrade folder in the <LOFTSTORE_HOME> folder to contain the

required upgrade folders and files.

Location

<LOFTSTORE_HOME>\upgrade

Important: The upgrade folder must be in the <LOFTSTORE_HOME> folder at the

same level as the setup folder.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 206

 3. Extract the contents of LoftstoreUpgrade-incrementalPSQL.zip package to the
new upgrade folder. The upgrade package contains the following:
l A templates folder
l Java Runtime Environment (JRE) and Loftware Utility (lsutil) zip files
l A loftstore properties file
l The dbupgrade.cmd file and associated xml and configure.jar files.

4. If you are upgrading from Spectrum 4.5 or later to Spectrum4.7.1 and you opted to
use the Loftware-supplied tablespaces with default names during installation, skip
this step.
If you opted to use the Loftware-supplied tablespaces with custom names or to use
existing tablespaces with custom names, you must perform the following steps to
modify the tablespace names.

a. In your new upgrade folder, open the loftstore.properties.tmpl file in a text

editor.

b. Under the # Tablespace Names section, edit the following to be the custom
names of the tablespaces used during the Spectrum database installation.

Important! The custom tablespace names must use lowercase alphanumeric

characters only.

loftstore.tbsp.main=SPECTRUM_MAIN
loftstore.tbsp.audit=SPECTRUM_AUDIT
loftstore.tbsp.arch=SPECTRUM_ARCH
loftstore.tbsp.cust=SPECTRUM_CUST
loftstore.tbsp.davinci=SPECTRUM_DAVINCI

Example

loftstore.tbsp.main=mycustomname_spectrum_main
loftstore.tbsp.audit=mycustomname_spectrum_audit
loftstore.tbsp.arch=mycustomname_spectrum_arch
loftstore.tbsp.cust=mycustomname_spectrum_cust

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 207

 loftstore.tbsp.davinci=mycustomname_spectrum_davinci

c. Save and close the loftstore.properties.tmpl file.

C. Upgrade the Spectrum Database (LoftStore)

Perform the following steps on the Spectrum Database Server as an Administrator in

Windows Server.

1. Open a Command Prompt on the client computer and navigate to the upgrade
folder.

2. Run dbupgrade and respond to the following prompts:

Note: Loftware recommends you enter specific values for the dbupgrade prompts
that match your site's configuration. The default values shown on the dbupgrade
prompts should only be considered examples.

Tip: If the message No database upgrade required is displayed, the version of the
database you are installing is the same as your current database; therefore, you do
not need to upgrade the Spectrum database. Continue with Upgrading
the Spectrum Application.

Enter LOFTSTORE_HOME [default value]:

<LOFTSTORE_HOME> refers to the folder in which the database configuration

files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore. If you do not accept the default value, you can set
this location as a system variable for easier reference.

Enter LoftStore database name without domain [default value]:

The Spectrum database name without domain distinguishes it from any other
databases on the server. Example: Postgres11 or loftstore

Enter LoftStore database hostname [default value]:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 208

 The hostname of the Spectrum database identifies the server where the database
is installed. Example: DBServer or localhost

Enter LoftStore database port [default value]:

The port value on the database server for the Spectrum database, which identifies
the TCP/IP end point for a host connection. Example: 5432

Enter the LoftStore database user name [postgres]:

Enter the name of the database user with permissions to install the Spectrum
database.

Enter the LoftStore database user password:

Enter the password of the database user with permissions to install the Spectrum
database.

Confirm password:

Confirm the password of the Spectrum database user.

3. Run the following command from the setup folder to start scheduled jobs:
schedule_jobs

The upgrade log files are available in the default location <LOFTSTORE_
HOME>/upgrade/logs. For an explanation of any messages, errors, or warnings that are
recorded in a log file, contact Loftware Technical Support.

Next Step

You have completed upgrading the Spectrum database.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 209

If your license includes Spectrum Business Intelligence (BI), you should restart the BI
services after upgrading. To start the service on a Windows Server operating system,
double-click the Start JRS Service icon on the desktop of the server where you installed
Spectrum BI. To start the service on a Linux operating system, run the
./ctlscript.sh start command from the location you chose for the installation
(default location is /opt/spectrumbi).

Continue with Upgrading the Spectrum Application.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 210

Upgrade Spectrum Database in PostgreSQL on Linux

This section describes upgrading the Loftware Spectrum database in PostgreSQL on a

server running a Linux operating system. These instructions apply when you are using a
non-embedded database and not the Loftware-supplied database.

Important: Loftware Spectrum 4.0 must be installed before upgrading to Spectrum 4.7.1.
If you are on a version prior to Loftware Spectrum 4.0, then you cannot upgrade to
Spectrum 4.7.1 directly — you must first upgrade to Spectrum 4.0. If you are upgrading
from a version prior to Spectrum 4.0, do the following:

1. Upgrade to Loftware Spectrum 4.0. For more information, see "Upgrading

Loftware Spectrum" in the 4.0 Loftware Spectrum Installation and Configuration
Guide.

2. Upgrade to Loftware Spectrum 4.7.1 following the instructions in this guide.

Upgrading the Spectrum database in PostgreSQL on Linux involves the following tasks:

A. Stop the Spectrum Service

B. Download and Create Upgrade Folders

C. Upgrade the Spectrum Database (LoftStore)

The following reference is used in this document:

l Spectrum Database Server refers to the LoftStore/PostgreSQL host server.

A. Stop the Spectrum Service

Before proceeding with the upgrade, you need to stop the currently running Spectrum
services, running in all environments on the Spectrum Application Server.

To stop the service in Linux, execute the following command:

sudo service spectrum stop

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 211

If your license includes Spectrum Business Intelligence (BI), you must also stop the BI
services before upgrading. To stop the service, run the following command from the
location you chose for the installation (default location is /opt/SpectrumBI):
./ctlscript.sh stop

B. Download and Create Upgrade Folders

Perform the following steps on the Spectrum Database Server as the Linux user that acts
as the PostgreSQL system user (the default system user is postgres).

Note:<LOFTSTORE_HOME> refers to the folder in which the database configuration

files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore.
<SPECTRUM_HOME> refers to the folder on the Spectrum Application Server, such as
C:\Loftware\Spectrum\Spectrum or /opt/loftware/spectrum/Spectrum, in which the
Spectrum application is installed. Although procedures in this documentation typically
use backslashes in operating system paths, you should use forward slashes if required
by your operating system.

1. Copy the LoftstoreUpgrade-incrementalPSQL.zip file from the installation

package to a temporary folder on the computer where you are running the
installation.

2. Create a new upgrade folder in the <LOFTSTORE_HOME> folder to contain the

required upgrade folders and files.

Location

<LOFTSTORE_HOME>/upgrade

Important: The upgrade folder must be in the <LOFTSTORE_HOME> folder at the

same level as the setup folder.

3. Extract the contents of LoftstoreUpgrade-incrementalPSQL.zip package to the

new upgrade folder. The upgrade package contains the following:
l A templates folder
l Java Runtime Environment (JRE) and Loftware Utility (lsutil) zip files

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 212

 l Loftware Utility (lsutil) zip files
l A loftstore properties file
l The dbupgrade.sh file and associated xml and configure.jar files.

4. If you are upgrading from Spectrum 4.5 or later to Spectrum4.7.1 and you opted to
use the Loftware-supplied tablespaces with default names during installation, skip
this step.
If you opted to use the Loftware-supplied tablespaces with custom names or to use
existing tablespaces with custom names, you must perform the following steps to
modify the tablespace names.

a. In your new upgrade folder, open the loftstore.properties.tmpl file in a text

editor.

b. Under the # Tablespace Names section, edit the following to be the custom
names of the tablespaces used during the Spectrum database installation.

Important! The custom tablespace names must use lowercase alphanumeric

characters only.

loftstore.tbsp.main=SPECTRUM_MAIN
loftstore.tbsp.audit=SPECTRUM_AUDIT
loftstore.tbsp.arch=SPECTRUM_ARCH
loftstore.tbsp.cust=SPECTRUM_CUST
loftstore.tbsp.davinci=SPECTRUM_DAVINCI

Example
loftstore.tbsp.main=mycustomname_spectrum_main
loftstore.tbsp.audit=mycustomname_spectrum_audit
loftstore.tbsp.arch=mycustomname_spectrum_arch
loftstore.tbsp.cust=mycustomname_spectrum_cust
loftstore.tbsp.davinci=mycustomname_spectrum_davinci

c. Save and close the loftstore.properties.tmpl file.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 213

C. Upgrade the Spectrum Database (LoftStore)

Perform the following steps on the Spectrum Database Server as the Linux user that acts
as the PostgreSQL system user (default is postgres).

1. Open a Terminal on the client computer and navigate to the upgrade folder.

2. Run ./dbupgrade.sh and respond to the following prompts:

Note: For most upgrades, we recommend you specify values for the configure
prompts that match your site's configuration and NOT accept the default values,
since they only offer a limited local configuration.

Tip: If the message No database upgrade required is displayed, the version of the
database you are installing is the same as your current database; therefore, you do
not need to upgrade the Spectrum database. Continue with Upgrading
the Spectrum Application.

Enter LOFTSTORE_HOME: [default value]

<LOFTSTORE_HOME> refers to the folder in which the database configuration

files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore. If you do not accept the default value, you can set
this location as a system variable for easier reference.

Enter LoftStore database name without domain [default value]:

The Spectrum database name without domain distinguishes it from any other
databases on the server. Example: postgres11 or loftstore

Enter LoftStore database hostname [default value]:

The hostname of the Spectrum database identifies the server where the database
is installed. Example: dbserver or localhost

Enter LoftStore database port [default value]:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 214

 The port value on the database server for the Spectrum database, which identifies
the TCP/IP end point for a host connection. Example: 5432

Enter the LoftStore database user name [sys]:

Enter the name of the database user with permissions to install the Spectrum
database.

Enter the LoftStore database user password:

Enter the password of the database user with permissions to install the Spectrum
database.

Confirm password:

Confirm the password of the Spectrum database user.

3. Run the following command from the setup folder to start scheduled jobs:
./schedule_jobs.sh postgres

The upgrade log files are available in the default location <LOFTSTORE_
HOME>/upgrade/logs. For an explanation of any messages, errors, or warnings that are
recorded in a log file, contact Loftware Technical Support.

Next Step

You have completed upgrading the Spectrum database.

If your license includes Spectrum Business Intelligence (BI), you should restart the BI
services after upgrading. To start the service on a Windows Server operating system,
double-click the Start JRS Service icon on the desktop of the server where you installed
Spectrum BI. To start the service on a Linux operating system, run the
./ctlscript.sh start command from the location you chose for the installation
(default location is /opt/spectrumbi).

Continue with Upgrading the Spectrum Application.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 215

Upgrade Spectrum Embedded Database on Windows Server

This section describes upgrading the Loftware Spectrum database. These instructions
apply if you are using the Loftware-supplied embedded database (LoftStore). The
embedded database connection is encrypted.

Important: Loftware Spectrum 4.0 must be installed before upgrading to Spectrum 4.7.1.
If you are on a version prior to Loftware Spectrum 4.0, then you cannot upgrade to
Spectrum 4.7.1 directly — you must first upgrade to Spectrum 4.0. If you are upgrading
from a version prior to Spectrum 4.0, do the following:

1. Upgrade to Loftware Spectrum 4.0. For more information, see "Upgrading

Loftware Spectrum" in the 4.0 Loftware Spectrum Installation and Configuration
Guide.

2. Upgrade to Loftware Spectrum 4.7.1 following the instructions in this guide.

Note: The Loftware-supplied embedded database is supported only for customers who
have upgraded from a version prior to Loftware Spectrum 4.1.

Upgrading the embedded database on a server running the Windows Server operating
system involves the following tasks.

A. Stop the Loftware Spectrum Service

B. Create a Backup of your Existing Spectrum Instance

C. Download and Create Upgrade Folders

D. Upgrade the Embedded Database

A. Stop the Loftware Spectrum Service

Before proceeding with the upgrade, stop the Loftware Spectrum service currently
running on the Spectrum Application Server.

To stop the Loftware Spectrum service, follow these steps:

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 216

 1. Open Windows Service Manager (Services) on the Spectrum Application Server.

2. Select the Loftware Spectrum service.

3. Right-click and select Stop to stop the service.

If your license includes Spectrum Business Intelligence (BI), you must also stop the BI
services before upgrading. To stop the service, double-click the Stop JRS Service icon
on the desktop of the server where you installed Spectrum BI.

B. Create a Backup of your Existing Spectrum Instance

This backup is intended for use if there is an installation failure that requires you to revert
to your previous version of Loftware Spectrum. Both the Spectrum application and the
Spectrum database should be backed up.

Note: Include any folders or files you have added to the Spectrum folder structure that
will need to be copied back into the new Spectrum version, such as printed PDF labels.

Spectrum Application Backup

To create a backup of the Spectrum application, perform the following steps.

1. Open a Command Prompt window on the Spectrum Application Server.

2. Copy the full folder hierarchy of <SPECTRUM_HOME> to another location.

Spectrum Database Backup

To create a backup of the Spectrum database, perform the following steps.

1. Open a Command Prompt window on the Spectrum Database Server.

2. Run ls_utils stop to stop LoftStore:

<LOFTSTORE_HOME>\bin>ls_utils stop

3. Copy the full folder hierarchy of <LOFTSTORE_HOME> to another location.

4. Run ls_utils start to restart LoftStore:

<LOFTSTORE_HOME>\bin>ls_utils start

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 217

C. Download and Create Upgrade Folders

To prepare for the upgrade, perform the following steps.

1. Copy the LoftstoreUpgrade-win.zip file from the installation package to a

temporary folder on the computer where you are running the installation.

2. Create an upgrade folder to contain the required upgrade folders and files.

Recommended Location

<LOFTSTORE_HOME>\upgrade

3. Extract the contents of LoftstoreUpgrade-win.zip package to the upgrade folder

you created. The upgrade package contains the following:
l Folders from previous product version upgrades
l A folder for this current product release
l A datapump folder with upgrade support files
l A log folder
l Java Runtime Environment (JRE) and Loftware Utility (lsutil) zip files
l A loftstore properties file
l The dbupgrade.cmd file and associated xml and configure.jar files

4. Navigate to the upgrade\datapump folder and copy the .dmp files in the folder.

5. Paste the .dmp files into your job archive datafile location on the Spectrum
Database Server.

Note: The job archive datafile location was set during the initial installation of the
Spectrum database. The default location is <LOFTSTORE_
HOME>\exports\archive. After upgrading, you may delete the .dmp files from this
location if desired.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 218

D. Upgrade the Embedded Database

This process describes upgrading the Loftware-supplied database and should be run by
a user with Administrative privileges.

1. Open a Command Prompt window on the client computer and navigate to the
upgrade folder.

2. Run dbupgrade and respond to the following prompts:

Important! For most upgrades, Loftware recommends you enter specific values for
the dbupgrade prompts that match your site's configuration. The default values
shown on the dbupgrade prompts should only be considered examples.

Tip: If the message No database upgrade required is displayed, the version of the
database you are installing is the same as your current database; therefore, you do
not need to upgrade the Spectrum database. Continue with Upgrading
the Spectrum Application.

Enter LOFTSTORE_HOME [default value]:

<LOFTSTORE_HOME> refers to the folder in which the database configuration

files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore. If you do not accept the default value, you can set
this location as a system variable for easier reference.

Upgrade the local embedded loftstore database? [default value]:

Enter Y (yes).

Note: A number of dependency errors, with ORA IDs associated with them, may
appear when the upgrade process starts. These are expected and do not indicate
a problem with the upgrade.

The upgrade log files are available in the default location <LOFTSTORE_
HOME>/upgrade/logs. For an explanation of any messages, errors, or warnings that are
recorded in a log file, contact Loftware Technical Support.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 219

Next Step

You have completed upgrading the Spectrum database.

If your license includes Spectrum Business Intelligence (BI), you should restart the BI
services after upgrading. To start the service on a Windows Server operating system,
double-click the Start JRS Service icon on the desktop of the server where you installed
Spectrum BI. To start the service on a Linux operating system, run the
./ctlscript.sh start command from the location you chose for the installation
(default location is /opt/SpectrumBI).

Continue with Upgrading the Spectrum Application.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 220

Upgrading the Spectrum Application

This section describes how to upgrade the Loftware Spectrum® application. Before
performing the procedures in this section, be sure you have completed Preparing
to Upgrade and Upgrading the Spectrum Database, and be sure to have the following
files from your previous installation available:

l log4j2.xml or custom_log4j2.xml (Spectrum 3.0 and later)

l jdbc.properties
l javaoptsWin.properties or javaoptsLinux.properties
l server.xml
l Any other custom files, such as keystore files
l Any third-party JDBC drivers

To upgrade the Spectrum application, use the following procedure for your operating
system:

Upgrade Spectrum Application on Windows Server 222

Upgrade Spectrum Application on Linux 226

Java Options 230

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 221

Upgrade Spectrum Application on Windows Server

This section describes how to upgrade the Loftware Spectrum application on a server
running the Windows Server operating system. Before performing the procedures in this
section, be sure you have completed Upgrading the Spectrum Database and Preparing
to Upgrade.

To upgrade the Spectrum application, perform the following steps as a user with
administrator privileges.

1. Stop the Loftware Spectrum service.

2. Copy the spectrum-upgrade.zip installation package to the Spectrum

Application Server.
Recommended location: <SPECTRUM_HOME>

Note: <SPECTRUM_HOME> represents the folder on the Spectrum

Application Server in which the Spectrum application is installed. For example, in
Windows Server this might be C:\Loftware\Spectrum\Spectrum, and in Linux this
might be /opt/loftware/spectrum/Spectrum. Although procedures in this
documentation typically use backslashes in operating system paths, you should
use forward slashes if required by your operating system.

3. On the Spectrum Application Server, unzip the spectrum-upgrade.zip installation

package. A new upgrade folder is created.

4. From a command prompt with administrator privileges, navigate to the upgrade

folder.

Example

<SPECTRUM_HOME>\spectrum-upgrade\upgrade

5. Run the following command:

upgrade

6. If you unzipped the upgrade file to a location other than the recommended location,
respond to the prompt for the location of Spectrum on your Spectrum

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 222

 Application Servers.
Please enter the location of the Spectrum installation [Default]:

Example

C:\Loftware\Spectrum\Spectrum

7. Respond to the prompt for the Tomcat Service name.

Please enter the name of the Tomcat Service for this Spectrum
installation [Default]:

Example

loftwarespectrum

8. Wait for the BUILD SUCCESSFUL message to display.

9. Look at the console output to see if another message is displayed about settings in
javaoptsWin.properties differing from the original settings. If the
javaoptsWin.properties message is displayed, perform the following steps. If the
javaoptsWin.properties message is not displayed, skip this step and proceed to the
next step.

a. Stop the Loftware Spectrum service.

b. Use the file path provided in the message to navigate to and open the
diffWinJavaOpts.log file, and then compare the javaoptsWin.properties
settings in your original Spectrum application to those in the upgraded
Spectrum application.

c. Evaluate and determine if your Tomcat Java memory settings are appropriate
for your Spectrum configuration. For additional information or assistance,
contact Loftware. If needed, note the recommended values provided by
Loftware.

d. Once you have determined the appropriate settings, navigate to the

<SPECTRUM_HOME>\product\bin folder.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 223

 e. Open the javaoptsWin.properties file in a text editor and modify the settings
as needed. For more information, see Java Options.

f. Save and close the file.

g. If you made changes to the settings in the steps above, run the following
command in the <SPECTRUM_HOME>\product\bin folder to apply the
settings:
service.bat update

10. Locate the backup copy of your <SPECTRUM_HOME>\product\conf folder you

made before upgrading.

11. To ensure that you retain any custom configurations in your environment, navigate
to the new <SPECTRUM_HOME>\product\conf folder and do the following:

a. Merge any custom properties, loggers, or appenders from your backup

log4j2.xml file into the new custom_log4j2.xml file.

b. Verify that your new jdbc.properties file contains any changes made in your
backup jdbc.properties file. Take special note of the external.jdbc.drivers
property.

c. Check the diffSERVER.log file in the <SPECTRUM_HOME>\logs folder for

differences in the new server.xml file, and if necessary, merge any custom
settings from your backup server.xml file into the new server.xml file.

d. Move any other custom files, such as keystore files, back to the
<SPECTRUM_HOME>\product folder.

12. If you use any third party JDBC drivers, use the copies you made before upgrading
to add the drivers back to the <SPECTRUM_HOME>\product\lib folder. For more
information, see "Add a JDBC Driver to Spectrum" in the Loftware Spectrum
User Guide (Help).

13. If you previously added the third party SAP JCo library to the Spectrum instance for
use with Integration for use with SAP® Applications, copy the supported SAP JCo
library back to the <SPECTRUM_HOME>\product\endorsed folder.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 224

 14. Restart the Loftware Spectrum service (the service was automatically started by the
upgrade script, but must be restarted to apply additional changes).

Note: If you are upgrading in a distributed services environment, do not restart the
Loftware Spectrum service until you have upgraded all additional Spectrum
Application Servers.

Continue to After Upgrading Spectrum.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 225

Upgrade Spectrum Application on Linux

This section describes how to upgrade the Loftware Spectrum® application on a Linux
server. Before performing the procedures in this section, be sure you have completed
Upgrading the Spectrum Database and Preparing to Upgrade.

To upgrade the Spectrum application, perform the following steps.

Note: The upgrade.sh file needs to be owned and run by the loftware user in group
loftware.

1. Stop the Loftware Spectrum service.

2. Copy the spectrum-upgrade.zip installation package to the Spectrum

Application Server.
Recommended location: <SPECTRUM_HOME>

Note: <SPECTRUM_HOME> represents the folder on the Spectrum

Application Server in which the Spectrum application is installed. For example, in
Windows Server this might be C:\Loftware\Spectrum\Spectrum, and in Linux this
might be /opt/loftware/spectrum/Spectrum. Although procedures in this
documentation typically use backslashes in operating system paths, you should
use forward slashes if required by your operating system.

3. On the Spectrum Application Server, unzip the spectrum-upgrade.zip installation

package. A new upgrade folder is created.

4. Open a Terminal and navigate to the upgrade folder.

Example

<SPECTRUM_HOME>/spectrum-upgrade/upgrade

5. Run the following command:

./upgrade.sh

6. If you unzipped the upgrade file to a location other than the recommended location,
respond to the prompt for the location of Spectrum on your Spectrum Application
Server.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 226

 Please enter the location of the Spectrum installation [Default]:

Example

/opt/loftware/spectrum/Spectrum

7. Respond to the prompt for the Tomcat Service name.

Please enter the name of the Tomcat Service for this Spectrum
installation [Default]:

Example

spectrum

8. Wait for the BUILD SUCCESSFUL message to display.

9. Look at the Terminal output to see if another message is displayed about settings in
javaoptsLinux.properties differing from the original settings. If the
javaoptsLinux.properties message is displayed, perform the following steps. If the
javaoptsLinux.properties message is not displayed, skip this step and proceed to
the next step.

a. Stop the Loftware Spectrum service.

b. Use the file path provided in the message to navigate to and open the
diffLinuxJavaOpts.log file, and then compare the javaoptsLinux.properties
settings in your original Spectrum application to those in the upgraded
Spectrum application.

c. Evaluate and determine if your Tomcat Java memory settings are appropriate
for your Spectrum configuration. For additional information or assistance,
contact Loftware. If needed, note the recommended values provided by
Loftware.

d. Once you have determined the appropriate settings, open a terminal window
as a user in the loftware group and navigate to the <SPECTRUM_
HOME>/product/bin folder.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 227

 e. Open the javaoptsLinux.properties file in a text editor and modify the settings
as needed. For more information, see Java Options.

f. Save and close the file.

10. Locate the backup copy of your <SPECTRUM_HOME>/product/conf folder you

made before upgrading.

11. To ensure that you retain any custom configurations in your environment, navigate
to the new <SPECTRUM_HOME>/product/conf folder and do the following:

a. Merge any custom properties, loggers, or appenders from your backup

log4j2.xml file into the new custom_log4j2.xml file.

b. Verify that your new jdbc.properties file contains any changes made in your
backup jdbc.properties file. Take special note of the external.jdbc.drivers
property.

c. Check the diffSERVER.log file in the <SPECTRUM_HOME>/logs folder for

differences in the new server.xml file, and if necessary, merge any custom
settings from your backup server.xml file into the new server.xml file.

d. Move any other custom files, such as keystore files, back to the
<SPECTRUM_HOME>/product folder.

12. If you use any third party JDBC drivers, use the copies you made before upgrading
to add the drivers back to the <SPECTRUM_HOME>/product/lib folder. For more
information, see "Add a JDBC Driver to Spectrum" in the Loftware Spectrum
User Guide (Help).

13. If you previously added the third party SAP JCo library to the Spectrum instance for
use with Integration for use with SAP® Applications, copy the supported SAP JCo
library back to the <SPECTRUM_HOME>/product/endorsed folder.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 228

 14. Restart the Loftware Spectrum service (the service was automatically started by the
upgrade script, but must be restarted to apply additional changes).
sudo service spectrum restart

Note: If you are upgrading in a distributed services environment, do not restart the
Loftware Spectrum service until you have upgraded all additional Spectrum
Application Servers.

Continue to After Upgrading Spectrum.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 229

Java Options

The following table provides Oracle's descriptions for the Java options in the
javaoptsWin.properties and javaoptsLinux.properties files and the Loftware-
recommended settings for these options for Spectrum.

Options and Descriptions Recommended Settings

-Xms Contact Loftware.
Sets the initial size (in bytes) of the heap.
-Xmx Contact Loftware.
Specifies the maximum size (in bytes) of
the memory allocation pool in bytes. For
server deployments, -Xms and -Xmx are
often set to the same value.
-XX:+UseConcMarkSweepGC On, in a non-production, low-memory
Enables the use of the concurrent mark- environment with Xmx less than 6144.
sweep (CMS) garbage collector for the old
generation.
-XX:CMSClassUnloadingEnabled On, in a non-production, low-memory
Enables class unloading when using the environment with Xmx less than 6144.
CMS garbage collector. This option is
enabled by default.
-Xnoclassgc On, in a non-production, low-memory
Disables garbage collection (GC) of environment with Xmx less than 6144.
classes. This can save some GC time,
which shortens interruptions during the
application run.
-XX:+ScavengeBeforeFullGC On, in a non-production, low-memory
Instructs garbage collector to collect young environment with Xmx less than 6144.
generation before doing Full GC.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 230

Options and Descriptions Recommended Settings
-XX:+CMSScavengeBeforeRemark On, in a non-production, low-memory
Enables scavenging attempts before the environment with Xmx less than 6144.
CMS remark step.
-XX:+UseG1GC On, in a production system with Xmx
Enables the use of the garbage-first (G1) greater than or equal to 6144 (6 GB or
garbage collector. It is a server-style more of RAM assigned to the Spectrum
garbage collector, targeted for service).
multiprocessor machines with a large
amount of RAM.
-XX:+UseStringDeduplication On, in a production system with Xmx
Enables string deduplication. To use this greater than or equal to 6144 (6 GB or
option, you must enable the G1 garbage more of RAM assigned to the Spectrum
collector. service).
-XX:+ NA. Dump files can be several
HeapDumpOnOutOfMemoryError gigabytes or more in size.
Dump heap to file when the
java.lang.OutOfMemoryError is thrown.
-XX:HeapDumpPath= <PATH_TO_WRITE_ Windows:
DUMP> !CATALINA_HOME!\logs
Sets the path and file name for writing the Linux:
heap dump provided by the heap profiler ${CATALINA_HOME}/logs
(HPROF) when the -
XX:+HeapDumpOnOutOfMemoryError
option is set.
-XX:+PrintGCDateStamps NA
Enables printing of a date stamp at every
GC.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 231

Options and Descriptions Recommended Settings
-XX:+PrintGCTimeStamps NA
Enables printing of time stamps at every
GC.
-XX:+PrintGC NA
Enables printing of messages at every GC.
-XX:-PrintGCDetails NA
Enables printing of detailed messages at
every GC.
-XX:+UseGCLogFileRotation NA
Enables GC log rotation (requires -Xloggc).

-XX:NumberOfGCLogFiles=<NUM_OF_ 4
FILES>

Set the number of files to use when

rotating logs.
-XX:GCLogFileSize= <FILE_SIZE> 512M
Sets the size of the log file at which point
the log will be rotated.
-Xloggc: <PATH_TO_WRITE_GC_LOG> Windows:
Sets the file to which verbose GC events !CATALINA_HOME!\
information should be redirected for logs\spectrum.gc.log
logging. Linux:
${CATALINA_HOME}/
logs/spectrum.gc.log

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 232

After Upgrading Spectrum

You have completed upgrading the Spectrum application. Depending on your

configuration of Spectrum, do one or more of the following:

l If you are using Oracle integrations, you must also update these integrations. For
more information, see Oracle Integrations.
l If you are using an SAP BC-XOM integration, you must install the updated Loftware
Spectrum Command Line Interpreter (CLI) on the SAP Application Server, as a new
CLI is packaged with every new version of Spectrum. For more information, see
Upgrading the Command Line Interpreter (CLI).
l If you use Spectrum Remote Print, see Upgrading Spectrum Remote Print.
l If you have a distributed Spectrum environment, see Upgrading Spectrum for
Distributed Services.
l If you have a multi-site deployment of Spectrum, see Starting Services for Multi-
Site Deployment.
l If you are using Loftware DaVinci, see Managing the Loftware DaVinci Password.
l If your license includes Spectrum Business Intelligence (BI), see the
Loftware Spectrum Business Intelligence Installation Guide for information about
installing and accessing Spectrum BI.
l If you use SSO with Spectrum, see Upgrading Spectrum with SSO.
l If you use HTTPS for Spectrum, see Configuring HTTPS.

Log files are available in <SPECTRUM_HOME>/logs in subfolders per version.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 233

Oracle Integrations

After you have successfully upgraded Spectrum, if your Spectrum environment contains
Oracle integrations then you must update them also.

To update your Oracle integrations, do the following:

1. Sign in to Spectrum.

2. In Integrations, open an Oracle integration and start the integration.

3. Follow the instructions on the page to update the integration.

4. Repeat this procedure for each Oracle integration.

For more information about Oracle integrations, see the Spectrum User Guide (online
Help).

Upgrading the Command Line Interpreter (CLI)

If you are using SAP BC-XOM integrations, then you must upgrade the Loftware
Spectrum Command Line Interpreter (CLI) on the SAP Application Server, as a new CLI
is packaged with every new version of Spectrum.

Important: Spectrum 4.7 uses a new communication method from the CLI to Spectrum
and a new URL in the SAP Logical Output Management System (LOMS) command. If
you are upgrading from Spectrum 4.6 or earlier versions, you must follow the steps to
upgrade the CLI and then change the SAP LOMS command configuration to use the
new URL.

The following steps should be performed by a SAP Basis Administrator on the SAP
Application Server. The configuration for the Loftware Spectrum CLI requires moving files
into a folder that the SAP Logical Output Management System (LOMS) instance can
access.

Tip: It is strongly recommended that each SAP Application Server be configured with its
own CLI and a uniquely named CLI log file.

To upgrade the CLI on the SAP Application Server, perform the following steps.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 234

Note: These steps are required only if you intend to support SAP BC-XOM integrations.

1. Navigate to your existing CLI directory and copy the contents to another directory to
create a backup of the contents.

2. After creating the backup, delete the contents of the existing CLI directory.

3. Perform the steps included in Installing the Command Line Interpreter (CLI).

4. If you are upgrading from Spectrum 4.6 or earlier versions, you must do the
following in SAP Spool Administration (SPAD) to update the SAP LOMS command
configuration to use the new URL.

Note: This procedure should be performed within the SAP Application Server by a
system administrator. You must use an SAP user account with administrative
access to SPAD and related transactions.

a. From the main SPAD page, click the Output management systems tab, and
then next to LOMS click Display. The list of LOMS is displayed.

b. From the LOMS display page, click the cascading paper icon to enter the
Commands page.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 235

 c. Under OMS commands, modify the Submit command to use the following
syntax:

Tip:
The new URL for Spectrum 4.7.1 is:
http(s)://<SpectrumServerIPAddress>:<port>/spectrum-server/int/sbpj
The URL for Spectrum 4.6 and earlier versions was:
http(s)://<SpectrumServerIPAddress>:<port>/spectrum-server/blazeDS/amf

runcli.cmd http
(s)://<SpectrumServerIPAddress>:<port>/spectrum-
server/int/sbpj "n=<IntegrationName>" "&EI" "&EG" "&P" "&F"
"&ES" <FileType>

Example
runcli.cmd http(s)://localhost:8080/spectrum-server/int/sbpj
"n=bcxom1" SapTest CIDSDEVLK "PDFDev1" ZZMEDRUCK.rdi
DEVPORTSAP01_IDS_03 RDI

d. Save and return to the SPAD screen.

Upgrading Spectrum Remote Print

Spectrum Remote Print deploys the Loftware Print Agent on a remote computer existing
outside of your LAN/WAN. When installed, the Loftware Print Agent allows the remote
computer to communicate directly with the Spectrum Application Server. On the
Spectrum Application Server, a Spectrum object called a Remote Site represents a
location where a Loftware Print Agent is installed and manages the configuration of the
Loftware Print Agent and associated devices.

In Spectrum 4.6, Loftware introduced a new method for installing, configuring, and using
remote printing capabilities, the Loftware Print Agent (LPA). The Loftware Print Agent
replaces the Remote Print Agent and offers simpler configuration and upgrading, as well
as improved monitoring and troubleshooting capabilities and general usability.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 236

Upgrading Remote Print from Spectrum 4.6 or Later Versions Using the Loftware
Print Agent

If you previously configured Spectrum Remote Print with the Loftware Print Agent in
Spectrum 4.6 or later versions, you should check the Release Notes for your new version
of Spectrum to see if you need to upgrade Spectrum Remote Print. If an upgrade is
required, perform the following steps after upgrading the Spectrum Application Server.

1. In Devices, open the Remote Site you want to upgrade.

2. Click Upgrade. When the process is complete, the installer automatically closes.

3. Confirm that the updated Remote Site is connected by clicking the Loftware

icon in the system tray.

4. Repeat the steps above for each Remote Site.

Upgrading Remote Print from Spectrum 4.5.x

If you previously configured Spectrum Remote Print with the Remote Print Agent in
Spectrum 4.5.x, you do not need to upgrade Spectrum Remote Print at this time.
However, upgrading the Remote Print Agent to the Loftware Print Agent is recommended
as it offers a redesigned remote print solution that includes performance improvements
with increased printer speeds, backwards compatibility, auto-upgrade capabilities for
future upgrades, and a secure LPA installer. To upgrade, perform the steps in Upgrade
the Remote Print Agent to the Loftware Print Agent.

Upgrading Remote Print from Spectrum 4.2.x and Earlier Versions

If you previously configured Spectrum Remote Print with the Remote Print Agent in
Spectrum 4.2.x or earlier versions, you must upgrade to the Loftware Print Agent for your
new version of Spectrum. To upgrade, perform the steps in Upgrade the Remote Print
Agent to the Loftware Print Agent.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 237

Upgrade the Remote Print Agent to the Loftware Print Agent

To upgrade to the Loftware Print Agent, an administrator of the remote computer should
use this procedure.

1. In Devices, open the Remote Site you want to upgrade.

2. Click Download to download the Loftware Print Agent Installer

(LoftwarePrintAgent.exe).

3. Transfer the Loftware Print Agent Installer to the Remote Site computer.

4. On the Remote Site computer, double-click the installer file and respond to the
following prompts.

a. Read the End User License Agreement, and then click Accept.

b. Wait while the Remote Print Agent is uninstalled and the Loftware Print Agent
is installed. When the process is complete, the installer automatically closes.

5. Confirm that the updated Remote Site is connected by clicking the Loftware

icon in the system tray.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 238

Upgrading Spectrum for Distributed Services

This section describes how to upgrade Spectrum in a distributed services environment.

The initial Spectrum Application Server must be upgraded before upgrading any
additional Spectrum Application Servers. After you have upgraded the initial Spectrum
Application Server, use the following procedure.

1. Stop the Loftware Spectrum service on the initial Spectrum Application Server and
on each additional Spectrum Application Server.

2. On each additional Spectrum Application Server, use the following procedure for
your operating system:

Important! All Spectrum Application Servers in a distributed environment must use

the same operating system family and brand.

l Upgrade Spectrum Application on Windows Server

l Upgrade Spectrum Application on Linux

3. Start or restart the Loftware Spectrum service on the initial Spectrum

Application Server and on all additional Spectrum Application Servers.

4. If your Spectrum environment uses an HTTP connection and is not configured to

use HTTPS, sign in to Spectrum as SuperAdmin and do the following for the initial
and all additional Spectrum Application Servers:

Note: If you completed this step during a previous Spectrum upgrade, you can skip
this step.

a. In Access Control, in the Access Control Tree, click the arrow next to the
Spectrum Application Server to display the JVM Process.

b. Select the JVM Process in the Access Control Tree, and then click Edit in the
ribbon.

c. In the Edit JVM Process dialog box, delete the port number in the Secure
JVM Port field and leave the field blank.

d. Click Save.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 239

 e. Sign out of Spectrum and restart the Loftware Spectrum service on the initial
Spectrum Application Server and on all additional Spectrum
Application Servers.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 240

Upgrading a Multi-Site Deployment

If you have configured a multi-site deployment of Loftware Spectrum, use the following
procedure to upgrade Spectrum.

1. Stop the Loftware Spectrum service at the headquarters and facility sites.

2. Upgrade the Spectrum database at the headquarters site. For more information,
see Upgrading the Spectrum Database.

3. Upgrade the Spectrum database at each facility site. If you are upgrading from a
version prior to Spectrum 4.1, see Upgrade Spectrum Embedded Database on
Windows Server. If you are upgrading from Spectrum 4.1 or later, see Upgrade
Spectrum Database in PostgreSQL on Windows Server.

4. Upgrade the Spectrum application at the headquarters site, but do not start the
Loftware Spectrum service. For more information, see Upgrading the Spectrum
Application.

Important! To prevent headquarters from communicating with a facility of a

different version, it is recommended that you do not start the Loftware Spectrum
service at headquarters until all facilities have been upgraded. If there is a need to
leave a facility on a previous version, ensure that communication between the
headquarters and that facility is blocked.

5. Upgrade the Spectrum application at each facility site. For more information, see
Upgrading the Spectrum Application.

6. Start the Loftware Spectrum service at the headquarters site.

7. Start the Loftware Spectrum service at each facility site.

8. Start the services required to support multi-site deployment. For more information,
see Starting Services for Multi-Site Deployment.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 241

Starting Services for Multi-Site Deployment

If you have configured a multi-site deployment of Spectrum, follow the procedure in

Upgrading a Multi-Site Deployment, and then perform the following steps to start the
services required for multi-site deployment.

Note: To perform this task, you must be signed in as the SystemAdmin or SuperAdmin
user. For more information, see the Spectrum User Guide (Help).

1. Sign in to Spectrum.

2. In System, click Service Management.

3. In the Core Services panel, start the following services:

l Multisite Management Service
l Object Sync Service
l Transaction Sync Service

Tip: For more information about configuring services for multi-site deployment, see the
Spectrum User Guide.

Managing the Loftware DaVinci Password

You must perform the steps in this section to update the password of the DaVinci
database user on the Spectrum Application Server if all of the following applies:

l You are upgrading to Spectrum 4.7.1.

l You are using a non-embedded database (and not the Loftware-supplied
database).
l You did not change the DaVinci database user password before upgrading to
Spectrum 4.7.1.

If you are not upgrading Spectrum, you can also use the following steps to update the
password on the Spectrum Application Server if you changed the Loftware DaVinci
database user password in the database after DaVinci was installed.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 242

 1. On the Spectrum Application Server, navigate to
<SPECTRUM_HOME>\product\conf.

2. Change the password of the Loftware DaVinci user in Oracle.

3. Open the jdbc.properties file in a text editor.

4. Comment out the encrypted password for the DaVinci user, and then save and
close the file.

Example

# This property sets the davinci user's password

# com.loftware.schema.davinci.user.password=123456789abcdefg

5. Open the database.properties file in a text editor.

6. Add the unencrypted DaVinci user password, and then save and close the file.

Note: When an unencrypted password is used, you may see the following
message in the spectrum.log file. This message can be ignored and will not affect
your Spectrum environment.
get error:
javax.crypto.BadPaddingException: Given final block not
properly padded.

Example

jdbc.url=
com.loftware.schema.davinci.user=
com.loftware.schema.davinci.user.password=MyPassword

7. Restart the Loftware Spectrum service.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 243

Upgrading Spectrum with SSO

Spectrum 4.7.1 includes an updated keystore file. If all of the following conditions apply to
your environment, you must perform the steps in this section to ensure users can
continue to sign in to Spectrum 4.7.1:

l You are upgrading from Spectrum 4.1 or earlier.

l You previously configured single sign-on (SSO) for Spectrum using SAML.
l You are using the keystore file included with Spectrum.

Note: If you are using your own keystore file, you do not need to perform these steps.
For more information, see Configuring HTTPS.

1. On the Spectrum Application Server, stop the Loftware Spectrum service.

2. Navigate to <SPECTRUM_HOME>\product\conf and rename the existing

local_sp_metadata.xml file.

3. Start the Loftware Spectrum service.

4. Go to http://spectrum-server:8080/spectrum-server/saml/metadata and save the

file to <SPECTRUM_HOME>\product\conf as local_sp_metadata.xml.

5. Go to your Identity provider (IdP) and upload the new local_sp_metadata.xml file.

6. Download the SAML metadata file from your IdP and save that file to
<SPECTRUM_HOME>\product\conf as saml2-metadata-idp.xml.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 244

Using the Driver Installer

The Driver Installer is a utility that allows you to use a supplied distribution package to
add new device drivers to a Spectrum Application Server or update existing drivers on a
Spectrum Application Server.

Driver Installer Basics

Information about the Driver Installer includes:

l The Driver Installer can only be used by an account with administrative privileges.
l Parameters specified on the command line override parameter values specified in
the DriverInstaller.properties file.
l Default URL and path locations are specified in the DriverInstaller.properties file.

Logging Features
l There are client and server logging components.
l The default log file location is <SPECTRUM_HOME>\utilities\driverInstaller.
l Client logging is recorded to the console and to a log file.
l Logging to the console defaults to the INFO level and contains basic
information.
l Logging to the log file defaults to the DEBUG level.
l Client logging is configured in the log4j2.xml file.
l Server logging is recorded to a log file.
l Server logging defaults to the INFO level.
l Server-side log is recorded in the spectrum-drv-install-svc.log file.

For information about the command syntax, refer to Driver Installer Syntax.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 245

DriverInstaller.properties File

The DriverInstaller.properties file contains parameter values that provide the default
values for the Driver Installer utility. This file can be edited at any time.

The DriverInstaller.properties file includes:

l Connection information for a Spectrum Application Server

Important! The default.server.port value in DriverInstaller.properties should be the

same as the non-SSL Connector port value in the server.xml file. For more
information, see Change Service Ports.

l User account
l Encrypted password
l Location and name of the driver package file
l Default timeout for loading a driver (240000 milliseconds)

The following is a sample template for the DriverInstaller.properties file.

##### Connection information

default.server.ip=localhost
default.server.port=8080
default.server.uri=/spectrum-server/blazeDS/amf

##### Authentication information

default.username=SuperAdmin
default.password=9bvi74wDFZEPZwxTXCrqjQ==

##### File information

default.path=C:\\transfer\\data
default.file=distribution.zip

##### Default variables

default.timeout=240000

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 246

Driver Installer Syntax

Use the following syntax when adding or updating device drivers into Spectrum. The
DriverInstaller.properties file contains many of the command line parameter default
values, but those values can be overridden on the command line. If a parameter value is
not specified on the command line, the default value in the properties file is assumed.

Basic Command Structure

DriverInstaller.cmd|driverInstaller.sh –action {create|update}
[-path {fully qualified|relative path to the folder containing
distribution file}]
[-file [driver package]]
[-host {hostname | ip address}]
[-port port number]
[-username administrator account]
[-password unencrypted password]
[-encryptpassword]
[-changepassword]
[-timeout]
[-force]

Where:

-action {create|update}

This is a required parameter using one of the following values:

l create – Add the driver to a Spectrum environment.

l update – Update an existing driver or distribute the driver package file to a Spectrum
environment that is using distributed services.

[-path {fully qualified path|relative path to the folder containing the distribution file}]

This is an optional parameter that specifies the path to the folder containing the driver
package file. The path can be fully qualified or relative. If not specified, the value in the
properties file is used.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 247

[-file [driver package name]]

This is an optional parameter that specifies the name of the driver package file. If not
specified, the value in the properties file is used.

[-host {hostname|IP address}]

This is an optional parameter that specifies either the hostname or IP address of the
Spectrum Application Server. If not specified, the value in the properties file is used.

[-port port number]

This is an optional parameter that specifies the port number to use when connecting to
the Spectrum Application Server. If not specified, the value in the properties file is used.

[-username administrator account]

This is an optional parameter that provides a user account with administrative privileges
to use when installing the driver. This should be SuperAdmin. If not specified, the value
in the properties file is used.

[-password unencrypted password]

This is an optional parameter that specifies the unencrypted password for the username.
If not specified, the value in the properties file is used.

[-encryptpassword]

This optional parameter allows you to encrypt the default password entered in the
DriverInstaller.properties file. The encrypted value overwrites the clear text value in the
properties file.

Note: This argument should not be used if the password is already encrypted.

Note: When used, this parameter can be the only parameter specified on the command
line.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 248

[-changepassword]

This optional parameter allows you to change the existing value for the default password
in the DriverInstaller.properties file. There will be a prompt to enter and then verify the
new password, which is then encrypted and becomes the current password value in the
properties file.

Note: When used, this parameter can be the only parameter specified on the command
line.

[-timeout]

This optional parameter sets a timeout value for establishing and maintaining a
connection to the Spectrum server. The default value is 240000 milliseconds.

[-force]

This optional parameter allows you to reinstall the same version or an older version of a
driver by bypassing the version check that would otherwise prevent installation.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 249

Uninstalling Spectrum

Uninstalling Loftware Spectrum means removing the Spectrum application and the
Spectrum database (LoftStore), as well as the Remote Print Agent if applicable. The
procedure should be done in the following order:

Uninstall the Spectrum Application and Service 250

Uninstall the Embedded Database 254

Uninstall the Remote Print Agent 258

Uninstall the Loftware Print Agent 259

Uninstall the Spectrum Application and Service

Loftware recommends the following procedure to uninstall the Spectrum application and
Loftware Spectrum service.

Warning: Uninstalling Spectrum deletes all of the log files in the <SPECTRUM_
HOME>/product/logs folder. If you want to retain these logs, copy this folder to another
location before uninstalling Spectrum.

Important! For Linux, the following steps must be performed by the same user who
installed Spectrum.

1. On the Spectrum Application Server, navigate to the following folder:

<SPECTRUM_HOME>\_Spectrum_installation

Example

Windows Server: C:\Loftware\Spectrum\_Spectrum_installation

Linux: /opt/loftware/spectrum/_spectrum_installation

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 250

 2. Double-click or run the uninstaller file. A dialog box opens and displays the
progress of the uninstaller preparation. This may take several minutes.

3. In the Maintenance Mode dialog, select Uninstall Product, and then click Next.

4. In the Uninstall Spectrum dialog, click Uninstall to confirm that you want to
continue this process.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 251

 The uninstall process begins. This may take several minutes.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 252

 5. After the Spectrum application is uninstalled, the Uninstall Complete dialog is
displayed. Click Done to close the uninstaller.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 253

Uninstall the Embedded Database

This section describes how to uninstall the Loftware Spectrum embedded database,
LoftStore. Before performing the procedures in this section, be sure you have completed
Uninstall the Spectrum Application and Service.

Important! LoftStore contains all the data used by Spectrum, and uninstalling LoftStore
deletes your Spectrum data.

To uninstall the LoftStore embedded database, perform the following steps:

1. Navigate to the <LOFTSTORE_HOME>\_Loftstore_installation folder.

Example

C:\Loftware\Spectrum\_Loftstore_installation

2. Double-click the uninstaller file.

3. Select a language for the uninstaller, and then click OK.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 254

 4. Select the instance to uninstall, and then click OK.

5. In the Maintenance Mode dialog, select Uninstall Product, and then click Next.

6. In the Uninstall Loftstore dialog, click Next to confirm that you want to continue this
process.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 255

 The uninstall process begins and the progress is displayed.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 256

 7. After LoftStore is uninstalled, the Uninstall Complete dialog is displayed. Click
Done to close the uninstaller. You may be prompted to restart your system, which is
recommended.

Note: If you had upgraded Spectrum from a version prior to Loftware Spectrum 4.1,
some LoftStore files may still remain on your system and can be deleted.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 257

Uninstall the Remote Print Agent

If a computer on which the Remote Print Agent has been installed is no longer be used as
a remote computer for Spectrum Remote Print, you should uninstall the Remote Print
Agent from the computer.

To uninstall the Remote Print Agent, perform the following steps.

1. Open a Command Prompt window as an Administrator.

2. Navigate to the directory where the Loftware Remote Print Agent is installed.

Example
cd C:\Loftware\RemotePrint\

3. Navigate to the remotePrintAgent folder in the directory where the Loftware

Remote Print Agent is installed.

Example
cd remotePrintAgent

4. Run the following command:

uninstaller

The Remote Print Agent, including the Loftware Spectrum Remote Print service, is
uninstalled from the remote computer.

Tip: If you plan to continue using Spectrum Remote Print capabilities by using another
computer, you must install the Remote Print Agent on that computer. You can associate
the existing Remote Site in Spectrum with the new computer, allowing devices already
configured to use that Remote Site to function with the new computer. For more
information, see "Remote Printing with Spectrum Remote Print" in the
Spectrum User Guide.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 258

Uninstall the Loftware Print Agent

If a computer on which the Loftware Print Agent has been installed is no longer be used
as a remote computer for Spectrum Remote Print, you should uninstall the Loftware Print
Agent from the computer.

To uninstall the Loftware Print Agent, perform the following steps.

1. Open the Windows Control Panel.

2. From the Control Panel, open Programs and Features.

3. Right-click the Loftware Print Agent, and then click Uninstall. The Loftware Print
Agent, including the Loftware Spectrum Remote Print service, is uninstalled from
the remote computer.

Tip: If you plan to continue using Spectrum Remote Print capabilities by using another
computer, you must install the Loftware Print Agent on that computer. You can associate
the existing Remote Site in Spectrum with the new computer, allowing devices already
configured to use that Remote Site to function with the new computer. For more
information, see "Remote Printing with Spectrum Remote Print" in the
Spectrum User Guide.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 259

Maintaining and Protecting Spectrum

You must understand the following concepts related to securing the data in your
Spectrum instance.

Managing the Loftware-Supplied Embedded Database 261

Backing Up the Full Spectrum Instance 264

Taking a Snapshot of a Spectrum Instance 268

Managing Offline Storage 271

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 260

Managing the Loftware-Supplied Embedded Database

The Spectrum database is a dedicated persistent data repository called LoftStore that
you may have installed as an internal embedded database for a facility in a multi-site
deployment of Loftware Spectrum 4.0 or earlier versions, or installed as an internal
embedded database for Loftware Spectrum 3.6 or earlier versions.

Automatic Backup and Recovery

The Loftware-supplied embedded database (LoftStore) is set to automatically create a

file recovery area and backup the data to that area. Full backups are created every
Sunday, and incremental backups occur after the initial configuration of the database.

The following backup settings are configured as part of the installation process:

l Location: This is the folder on your server that serves at the recovery storage area.
l Frequency: You can configure how frequently backups occur in days.

You create a full backup of the Spectrum database as part of the installation process.

Spectrum Database Recovery

If your data or control files in the Loftware-supplied embedded database become

corrupted, you can restore your database to a recent good state by restoring from the file
recovery area. To recover the Loftware-supplied embedded database to the most recent
backup, use the following procedure.

1. In Windows Server, open the Service Manager console and verify that the Loftware
Spectrum service is not running.

2. Open a command prompt window and navigate to the <LOFTSTORE_

HOME>\setup folder.

3. At a command prompt, enter the following command:

lsbackup restore

4. At a command prompt, enter the following command:

lsbackup resetlogs

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 261

 5. Restart the Loftware Spectrum service.

Change the Location of the Flash Recovery Area

To change the location of the database recovery area after Spectrum has been installed,
use the following procedure. This area should be configured when Spectrum is initially
installed through a setting in loftstore.properties.

1. Shut down the Loftware Spectrum service.

2. From a command prompt with administrator privileges, navigate to the following

folder:
<LOFTSTORE_HOME>\bin

3. Run the following command:

ls_utils recovery_file_dest

4. At the backup folder max size prompt, enter a value in gigabytes.

Example

100G

5. At the backup folder location prompt, enter the fully-qualified path for the new
location.

Example

D:\BACKUP

Change Database Backup Settings

Use the following procedures to change the backup settings of the Loftware-supplied
embedded database.

Update the Database Backup Duration

1. Change the loftstore.backup.duration setting in the loftstore.properties file.

2. Open a command prompt window, and navigate to the <LOFTSTORE_

HOME>\setup folder.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 262

 3. Enter the following command:
configureDBSetup

4. Enter the following command:

lsbackup init

Update the Database Backup Schedule

1. Change the loftstore.backup.hour and loftstore.backup.minute settings in the

loftstore.properties file.

2. Open a command prompt window, and navigate to the <LOFTSTORE_

HOME>\setup folder.

3. Enter the following command:

configureDBSetup

4. Enter the following command:

lsbackup reschedule

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 263

Backing Up the Full Spectrum Instance

This topic covers how to back up the full Spectrum instance (the Spectrum application
and the Spectrum database). Loftware recommends that you back up the entire
Spectrum folder structure on a regular basis using whatever backup tools you normally
use for server backup.

Spectrum Application Backup

On the Spectrum Application Server, copy the full folder hierarchy of <SPECTRUM_
HOME> to another location.

Spectrum Database Backup

To back up the Spectrum database, use the following steps for the appropriate server
configuration.

Loftware-Supplied Embedded Database

To back up the Loftware-supplied embedded database, do the following:

1. Open a Command Prompt window on the Spectrum Database Server.

2. Run ls_utils stop to stop LoftStore:

<LOFTSTORE_HOME>\bin>ls_utils stop

3. Follow the steps in Folders to Exclude from Backup.

4. Copy the full folder hierarchy of C:\Loftware to another location.

5. Run ls_utils start to restart LoftStore:

<LOFTSTORE_HOME>\bin>ls_utils start

Spectrum Database in PostgreSQL

To back up the Spectrum database in PostgreSQL, refer to the backup and restore
documentation on the PostgreSQL website (https://www.postgresql.org).

Spectrum Database in Oracle

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 264

If you are using the Spectrum database in Oracle, your site's database administrator
should create a backup using your company's standards and tools; however, some
folders may need to be excluded from the backup. For more information, see Folders to
Exclude from Backup. After excluding the folders, it is recommended that you copy the
full folder hierarchy of C:\Loftware or /opt/loftware to another location.

Folders to Exclude from Backup

If you are using the Spectrum database in Oracle or the Loftware-supplied embedded
database, there are folders that may need to be excluded from backups. Oracle requires
uninhibited access to all of its files on a near-constant basis. Backup tools typically lock
files while those files are being copied. If Oracle database files are locked while active,
there is a chance that Oracle will detect an error and shut down.

To work around the file-locking issue, the active Oracle database files must be omitted
from the backup. Because Spectrum automatically backs up these up to the recovery
folder, it is not necessary to back them up from the "live" data folders.

The following data folders described in the loftstore.properties file should be excluded
from your backup process, as well as any folders you added to this set.

l All the files (the entire folder) in the following locations:

# Control Files
loftstore.file.control.location.1=${loftstore.home}\\data\\${db.i
d}\\
# Redo Files
loftstore.file.redo.location.1=${loftstore.home}\\data\\${db.id}
# Data Files
loftstore.file.data.location.1=${loftstore.home}\\data\\${db.id}
# Temporary Files
loftstore.file.temp.location.1=${loftstore.home}\\data\\${db.id}
# System data files
loftstore.file.system.location=${loftstore.home}\\data\\${db.id}

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 265

 l The control00.ctl file in the following location:
#Fast Recovery
loftstore.file.recovery=${loftstore.home}\\recover\\control00.ctl

Restore the Spectrum Instance

To perform a restoration of a Spectrum instance lost to disaster, complete the following

procedure.

1. Restore the file system from your backup copy.

2. In the operating system, create a LOFTSTORE folder in the <LOFTSTORE_

HOME>\data folder.

Example

C:\Loftware\Spectrum\Loftstore\data\LOFTSTORE

3. At a command prompt, navigate to the <LOFTSTORE_HOME>\bin folder, and run

the following command.
ls_utils start

Important! This command does not completely start the database, but it does put
LoftStore into a mode that is necessary for the restoration process to work.

4. In Windows Server, open Service Manager.

a. If you are using the Spectrum database in Oracle, confirm that the following
services are running.
l OracleOraHome1TNSListener
l OracleServiceLOFTSTORE

b. Confirm that the Loftware Spectrum service is not running.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 266

 5. At a command prompt, navigate to <LOFTSTORE_HOME>\setup.

a. Run the following command:

lsbackup restore

b. Run the following command:

lsbackup resetlogs

6. In Windows Server, open Service Manager and start the Loftware Spectrum
service.

7. Open Spectrum from a web browser to test the restoration.

Example

http://spectrum-server:8080/loftwarespectrum

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 267

Taking a Snapshot of a Spectrum Instance

Taking a snapshot of a Spectrum instance is the process of exporting a copy of an entire

Spectrum database (LoftStore), and importing that data into a new or different Spectrum
instance that is running the same version of Spectrum.

Note: <LOFTSTORE_HOME> refers to the folder in which the database configuration

files are installed. For example, in Windows Server this might be
C:\Loftware\Spectrum\LoftStore, and in Linux this might be
/opt/loftware/spectrum/loftstore.

Export a Spectrum Instance Snapshot

Use this procedure to export a snapshot of an entire Spectrum instance.

Note: If you are using the Spectrum database in Oracle, these steps must be performed
by a user assigned to the ora_dba user group.

1. At a command prompt, navigate to the <LOFTSTORE_HOME>\bin folder, and run

the following command: ls_utils start

2. In Windows Server, open Service Manager.

a. If you are using the Spectrum database in Oracle, confirm that the following
services are running.
l OracleOraHome1TNSListener
l OracleServiceLOFTSTORE

b. Confirm that the Loftware Spectrum service is not running.

3. Open a command prompt, and navigate to the <LOFTSTORE_HOME>\bin folder.

4. Run the following command: ls_utils export

This places a DMP file in the <LOFTSTORE_HOME>\exports\ folder along with an

export log file. By default this file is named LOFTSTORE.DMP.

5. Restart the Loftware Spectrum service.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 268

Import a Spectrum Instance Snapshot

Use the following procedure to import an instance snapshot that you previously exported.

Note: If you are using the Spectrum database in Oracle, these steps must be performed
by a user assigned to the ora_dba user group.

1. Move the DMP file to the target server and place it in the <LOFTSTORE_
HOME>\exports\ folder.

Note: The versions of Spectrum should be the same.

2. Verify that the Spectrum instance you are importing to has been upgraded to the
same version.

3. Verify that the database instance, listener service, and database service are
running.

4. At a command prompt, navigate to the <LOFTSTORE_HOME>\setup folder, and

run the following command to remove any data in the internal/target database.
LoftwareSupportOnly

5. At a command prompt, navigate to the <LOFTSTORE_HOME>\bin folder, and run

the following command.
ls_utils start

6. In Windows Server, open Service Manager.

a. If you are using the Spectrum database in Oracle, confirm the following
services are running.
l OracleOraHome1TNSListener
l OracleServiceLOFTSTORE

b. Confirm that the Loftware Spectrum service is not running.

7. At a command prompt, and navigate to the <LOFTSTORE_HOME>\bin folder.

8. Run the following command.

ls_utils import

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 269

 9. Unless the servers have the same name, you must rename the server referenced in
the new loftstore database. Run the hostname command to get the name of the
new server.
hostname

10. Run ls_utils rename to change the server name on the new instance.
ls_utils rename

11. When prompted for the name of the old server, enter the old server name (for non-
distributed server environments, this field can be left blank).

Important! The server name is case sensitive.

Enter the old server name:

12. When prompted for the name of the new server, enter the new server name.

Important! The server name is case sensitive.

Enter the new server name:

13. Run the following command:

ls_utils cleanuplicense

14. Run the following command:

ls_utils cleanup_cluster_config

15. Obtain a new Spectrum license for this instance. For more information, see License
Spectrum.

16. Restart the Loftware Spectrum service.

Logging

A log file is added to <LOFTSTORE_HOME>\exports.

Note: The following entries are normal and not an indication that the import was not
successful.

ORA-31684: Object type USER:"LOFTUSER" already exists

ORA-31684: Object type USER:"LOFTSPEC" already exists
ORA-31684: Object type USER:"LOFTAUDIT" already exists

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 270

Managing Offline Storage

It is recommended that you create a plan and procedure for managing the offline storage
based on your business needs. When Spectrum is installed, the user is prompted to enter
a job archive datafile location and a job archive retention value. Spectrum creates a dump
file in the specified location every month once the retention time has been reached;
however Spectrum does not perform any management of the file after it is created. If the
archive files continue to accumulate without a management plan in place, they could fill
the drive and potentially cause adverse effects. These effects could be significant if the
archive files are stored on the database server, which is the location set by default during
installation (<LOFTSTORE_HOME>\exports\archive).

To avoid issues resulting from insufficient space, perform the following tasks:

A. Identify your current archive file location

B. Identify your current archive retention value

C. Develop a plan for managing the archive files

D. Create an automatic process of moving the archive files

A. Identify your current archive file location

To view your current archive file location, use the following steps for the appropriate
server configuration.

Loftware Spectrum with Embedded Database

1. Contact Loftware for the GetExportDirectory.zip file.

2. Download the GetExportDirectory.zip to the database server.

3. Extract the file contents in place.

4. From a command prompt with administrator privileges, navigate to the folder where
you extracted the contents of the file to.

5. Execute the GetExportDirectory.cmd file. Execution of this command will create a

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 271

 dump folder containing the loftarch_export_dir.txt file.

6. Open the loftarch_export_dir.txt file to view the archive file location.

Loftware Spectrum with Oracle Database Server

An Oracle user with privileges to run the Oracle administrative tools is required for this
process. From a command prompt with administrator privileges, run the following
command:

select system_value
from loftspec.system_properties
where system_key ='archive_retention_in_months'
and system_namespace='jobService';

B. Identify your current archive retention value

To view your current archive retention value, use the following steps for the appropriate
server configuration.

Loftware Spectrum with Embedded Database

1. Contact Loftware for the GetSystemProperty.zip file.

2. Download the GetSystemProperty.zip to the database server.

3. Extract the file contents in place.

4. From a command prompt with administrator privileges, navigate to the folder where
you extracted the contents of the file to.

5. Execute the GetSystemProperty.cmd file.

6. At the prompt, enter the following to retrieve the current value from the database:
archive_retention_in_months

Execution of this command will create a dump folder containing the

systemProperty.txt file.

7. Open the systemProperty.txt file to view the value.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 272

Loftware Spectrum with Oracle Database Server

An Oracle user with privileges to run the Oracle administrative tools is required for this
process.

1. From a command prompt with administrator privileges, run the following command:
select directory_path
from dba_directories
where directory_name = 'LOFTARCH_EXPORT_DIR';

C. Develop a plan for managing the archive files

Your offline storage management plan depends on your business needs, but you can
begin to create a plan with the following questions:

l How far back in time do you need to keep printing history records? Note that each
file represents one month.
l Does that need exceed the archive retention time set on the Spectrum
Application Server?

D. Create an automatic process of moving the archive files

Once you have determined your plan, it is recommended that you create an automatic
process of copying the archive files off the database server. Based on your archive rules,
the files might be moved to long-term storage, copied to an archive service, written to
offline media (tape), or simply deleted.

Disable Creation of Database Dump File

By default, Spectrum creates archive database dump files in the location you specified
during the database installation. If you do not want or need these dump files, you can
prevent the files from being automatically created to save space on your database server
by performing the following steps.

1. Sign in to Spectrum as an administrator.

2. Go to System and click System Properties.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 273

 3. Click Add Property.

4. In the Add System Property dialog box, enter the following:

l Namespace: jobService
l Key: export.job.history
l Value: false

5. Click Save.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 274

Logging

This section describes Spectrum logging in the following areas:

Spectrum Database Installation Logging 276

Windows Event Viewer 276

Loftware-Supplied Embedded Database Installation 277

Additional Logs 277

Backup and Recovery Logging 277

Spectrum Application Server Logging 278

Spectrum Application Activity Logs 278

Spectrum Application Server Logs 279

Event (Application) Logging 279

Log4j 2 Configuration File 280

Logging Levels 280

Configure Log Files 282

Adjust Rollover Triggers 282

Configure Appenders 283

Package-Level Loggers 283

Spectrum Log Files 283

System Log (spectrum.log) 284

UI to Server Message Log (spectrum-amf.log) 284

Critical Event Log (spectrum-critical.log) 284

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 275

 Data Map Log (spectrum-data.log) 284

Driver Install Log (spectrum-drv-install-svc.log) 284

Integration Event Log (spectrum-integration.log) 285

Printing Event Log (spectrum-print.log) 285

Security Event Log (spectrum-security.log) 285

SOAP Web Service Log (spectrum-soap.log) 286

Entity Sync Log (spectrum-sync-entity.log) 286

Transaction Sync Log (spectrum-sync-transaction.log) 286

User Event Log (user-rules.log) 286

Spectrum Database Installation Logging

The following log files are created when you install the Spectrum database (LoftStore).
These files are in the <LOFTSTORE_HOME>\setup\logs folder.

Examples

Windows Server – C:\Loftware\Spectrum\LoftStore\setup\logs

Linux – /opt/loftware/spectrum/loftstore/setup/logs

l loftstore.log – Contains the output (standard and error) from the installation of the
Spectrum database instance within the Oracle database.
l loftstore2.log – Lists the actions performed when configuring the Spectrum
database.

Windows Event Viewer

Other places to look for information about the installation and configuration of the
Spectrum database include using the Server Manager Event display.

Open the Server Manager and navigate to Local Server, then Events.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 276

Loftware-Supplied Embedded Database Installation

The following log files are created and used only when you install the Loftware-supplied
embedded database.

Note: The Loftware-supplied embedded database is supported only for customers who
have upgraded from a version prior to Loftware Spectrum 4.1.

l createDB.log – Contains the output (standard and error) from the installation of the
Spectrum database (LoftStore).
l postDBCreation.log – Lists the actions performed when configuring the Spectrum
database.

Additional Logs

As part of the Loftware-supplied database installation, trace and database logs are also
produced in the following folders:

l <LOFTSTORE_HOME>\cfgtoollogs\netca\
l <LOFTSTORE_HOME>\cfgtoollogs\dbca\
l <LOFTSTORE_HOME>\cfgtoollogs\catbundle\

Backup and Recovery Logging

The following log files are created by the various backup and recovery processes. These
files are in the <LOFTSTORE_HOME>\setup\logs folder.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 277

Examples

Windows Server: C:\Loftware\Spectrum\LoftStore\setup\logs

Linux: /opt/loftware/spectrum/loftstore/setup/logs

Note: These logs are incremental and will grow constantly.

l lsincback.log: Incremental nightly backup. Contains information on the LoftStore

automatic backup process.
l lsfullback.log: Running the initialization (init) and full backup (full) commands.
Contains information about the LoftStore Recovery Manager.
l lsrestore.log: Running the restore process.
l bkupconfig.log: Initial configuration of the backup utility.

Spectrum Application Server Logging

There are two log folder locations for the Spectrum Application Server. One folder for
Spectrum application activity and one for the Spectrum Application Server.

Spectrum Application Activity Logs

Spectrum application activity logs are located in <SPECTRUM_

HOME>\product\webapps\logs and can be accessed from a browser.

Some of the logs in this location include:

l spectrum.log
l spectrum-critical.log
l spectrum-data.log
l spectrum-drv-install-svc.log
l spectrum-integration.log
l spectrum-soap.log
l spectrum-security.log

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 278

 l spectrum-print.log
l user-rules.log

Spectrum Application Server Logs

Spectrum Application Server logs are available in <SPECTRUM_HOME>\product\logs.

Some of the logs in this location include:

l catalina.[yyyy-MM-dd].log
l commons-daemon.[yyyy-MM-dd].log
l host-manager.[yyyy-MM-dd].log
l localhost.[yyyy-MM-dd].log
l loftwarespectrum-stderr.[yyyy-MM-dd].log
l loftwarespectrum-stdout.[yyyy-MM-dd].log
l manager.[yyy-MM-dd].log

Note: For Linux users, the folder and files within <SPECTRUM_HOME>/product/logs
are owned by the Spectrum user that installed Spectrum.

Event (Application) Logging

Event logging is the recording of the actions performed by the Spectrum Application, at a
high level, in a set of text files. Event logs can be used by administrators and technical
support engineers to monitor system performance and diagnose potential problems.
Event logs also maintain a record of system activity for future reference.

Loftware Spectrum uses Apache log4j 2™ Logging Services for log message handling.
See Welcome to Log4j 2 (http://logging.apache.org/log4j/2.x/manual/index.html) on the
Apache Logging Services website for detailed information. This topic describes how the
Spectrum-specific event logging is configured, and where it can be customized.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 279

Loftware Spectrum logs information, error, and warning messages to a set of log files.
The log files that are created can be found in the Spectrum logs folder. Log files will "roll
over" at the interval configured in the log4j2.xml file. The previous file will be compressed
and renamed with a timestamp.

Log4j 2 Configuration File

Apache log4j 2 is configured with an XML file. The default log4j2.xml file can be found in
<SPECTRUM_HOME>\product\conf after Spectrum is installed.

Note: <SPECTRUM_HOME> represents the folder on the Spectrum Application Server

in which the Spectrum application is installed. For example, in Windows Server this
might be C:\Loftware\Spectrum\Spectrum, and in Linux this might be
/opt/loftware/spectrum/Spectrum. Although procedures in this documentation typically
use backslashes in operating system paths, you should use forward slashes if required
by your operating system.

Logging Levels

The following are the different types of messages that may be included in a log for
Loftware Spectrum:

l Fatal error messages: These messages indicate situations in which the application
must shut down or is unusable.
l Error messages: These messages indicate that the application is in an unexpected
and possibly compromised state. A user may have performed an action that
compromised the application.
l Warning messages: These messages indicate that something unintended and
notable occurred in the application, or may indicate an important application state
change. The application may have acted in a way that is a cause for concern, but
has not impacted the stability of the application. A user may have made a mistake,
but has not compromised the application.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 280

 l Informational messages: These messages indicate that something notable
occurred, such as the printing of a label and the startup or shutdown of Spectrum.
These messages may provide helpful information if a problem is occurring, but their
existence does not indicate a problem.
l Debugging messages: These messages provide debugging information that may
help a technical support engineer or a developer at Loftware diagnose a problem
with the application.

The following logging levels can be set in log4j2.xml. The logging level is set
independently for each log.

Level Description

OFF No messages are added to the log.

FATAL Only fatal error messages are included in the log.

ERROR Only fatal error messages and error messages are included in the
log.

WARN Only fatal error, error, and warning messages are included in the log.

INFO Fatal error, error, warning, and informational messages are included
in the log. For some environments, this level may be more verbose
than is desirable except when troubleshooting a problem.

DEBUG Fatal error, error, warning, informational, and debugging messages

are included in the log.

Note: This level should be used only when directed by Loftware

Technical Support.

TRACE Fatal error, error, warning, informational, and debugging messages

are included in the log, as well as tracing where defined.

Note: This level should be used only when directed by Loftware

Technical Support.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 281

Level Description

ALL Messages of all types are included in the log.

Note: This level should be used only when directed by Loftware

Technical Support.

Configure Log Files

You can adjust the information logged from Spectrum by editing the custom_log4j2.xml
file. To configure logging levels, begin by navigating to the custom_log4j2.xml file in the
following location after Spectrum is installed:

<SPECTRUM_HOME>\product\conf

Note: <SPECTRUM_HOME> represents the folder on the Spectrum Application Server

in which the Spectrum application is installed. For example, in Windows Server this
might be C:\Loftware\Spectrum\Spectrum, and in Linux this might be
/opt/loftware/spectrum/Spectrum. Although procedures in this documentation typically
use backslashes in operating system paths, you should use forward slashes if required
by your operating system.

Adjust Rollover Triggers

Rollover triggers are configured within the <RollingFile> element by setting the
<Policies> element. A rollover trigger can be size-based and time-based.

The following example defines two rollover triggers: when the log file size reaches 200
MB and when the current date no longer matches the log’s start date.

<RollingFile name="CRITICAL_MONTHLY_ROLL" fileName="${LOG_

DIR}/spectrum-critical.log"
filePattern="${LOG_DIR}/spectrum-critical.%d{yyyy-MM}-%i.log.gz">

<PatternLayout pattern="${PATTERN}" charset="UTF-8" />

<Policies>
<SizeBasedTriggeringPolicy size="200 MB" />
<TimeBasedTriggeringPolicy />
</Policies>
</RollingFile>
Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 282
Configure Appenders

The default appender is configured within the <Root> element by using the
<AppenderRef> element.

<Root level="warn">
<AppenderRef ref="DAILY_ROLL" />
</Root>

You can also configure the appender at the logger level.

<Logger name="critical.com.loftware.spectrum" level="INFO"

additivity="false">
<AppenderRef ref="CRITICAL_MONTHLY_ROLL" />
</Logger>

Package-Level Loggers

Package-level loggers, which are commented out by default, can be customized for
troubleshooting purposes. You can enable and configure logging for packages by
uncommenting the corresponding node and adjusting the level.

The following example in the <LOGGER Groupings> section defines the logging
configuration of the com.loftware.model.StartupInitializer package:

<!--
<Logger name="com.loftware.model.StartupInitializer"
level="DEBUG" />
-->

Spectrum Log Files

Loftware Spectrum logs information, error, and warning messages to a set of log files.
The log files that are created can be found in the Spectrum logs folder. Log files "roll over"
at the interval configured in the log4j2.xml file. The previous file is compressed and
renamed with a timestamp.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 283

Tip: For more information about logging levels and types of messages, see Logging
Levels.

System Log (spectrum.log)

The System Log is the default log for Spectrum. It provides a full, lifetime view of the
application. All messages are captured in this log, so the other logs can be reconciled
against this one to provide additional context if needed. The default logging level for this
log is WARN.

UI to Server Message Log (spectrum-amf.log)

Default log file object level request/response details pertaining to the messages sent
between the Spectrum UI and application server.

Critical Event Log (spectrum-critical.log)

The Critical Event Log includes messages about issues that are critical to the functioning
of Spectrum. The default logging level for this log is INFO. Depending on the logging level
configured, information such as the following may be included.

l Startup and shutdown information (if the logging level is INFO level or better).
l Licensing changes (if the logging level is INFO level or better).
l Fatal error messages (if the logging level is FATAL or better).
l Any appropriate error messages (if the logging level is ERROR or better).

Data Map Log (spectrum-data.log)

The data log captures the contents of the data map.

Driver Install Log (spectrum-drv-install-svc.log)

The Driver Install Log captures information about device driver service. The default
logging level is DEBUG.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 284

Integration Event Log (spectrum-integration.log)

The Integration Event Log captures information for Java Message Service (JMS)
integrations. Spectrum supports the Event JMS Consumer and the Event JMS Producer
integrations.

The default logging level for this log is INFO. Depending on the logging level configured,
information such as the following may be included.

l Messages sent between client computers.

l Custom user log messages, such as logs entered in the JavaScript for integrations.

Printing Event Log (spectrum-print.log)

The Printing Event Log captures every meaningful state transition in the lifetime of a job
and a print job detail as they progress through Spectrum, as well as any issues that
occur. Device connection information is included.

The default logging level for this log is INFO. Depending on the logging level configured,
information such as the following may be included.

l The beginning and end of each print job.

l The printing state for each job.
l The printing state for each print job detail.
l The destination (device) for each job.
l The label template and layout for each job.
l The requester of the print job.
l Any errors that occur during printing.

Security Event Log (spectrum-security.log)

The Security Event Log includes messages about actions–positive and negative–related
to security. The default logging level for this log is INFO. Depending on the logging level
configured, information such as the following may be included.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 285

 l User additions, modifications, or deletions (if the logging level is INFO level or
better). The user name is included.
l Security problems (if the logging level is WARN or better). For example, a user
without the necessary permissions attempting to perform an action, or an
administrator attempting to create an object without providing a required parameter.
In many cases, the Spectrum user interface will prevent these issues, but those not
prevented by the user interface are recorded in the Security Event Log.
l User sign ins and sign outs (if the logging level is INFO level or better). The user
name is included.

SOAP Web Service Log (spectrum-soap.log)

The SOAP Web Service log captures information about SOAP Web Service Data Service
requests. The default logging level is WARN.

Entity Sync Log (spectrum-sync-entity.log)

The Entity Sync Log includes information about objects replicated from headquarters to
facilities during synchronization in a multi-site deployment. The default logging level is
DEBUG.

Transaction Sync Log (spectrum-sync-transaction.log)

The Transaction Sync Log includes information about transactional data replicated from
facilities to headquarters during synchronization in a multi-site deployment. The default
logging level is DEBUG.

User Event Log (user-rules.log)

The User Event Log can be turned on to show user-defined log messages from business
rules. The default logging level for this log is INFO.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 286

Appendix A: Technical Requirements for Spectrum 4.7.1

The following are the hardware and software requirements for Loftware Spectrum® 4.7.1.
This includes the requirements for the Spectrum Application Server and the Spectrum
Database Server, as well as for client computers and mobile devices that connect to
Spectrum. Also, the requirements for devices that receive output from Spectrum, and
requirements for integrating with other applications.

Server Requirements

All enterprise environments are unique. The server requirements necessary to fulfill your
organization's needs can be affected by the number of unique labels to be printed, the
number of devices to which labels will be printed, the relationship between the number of
labels and the number of devices, the complexity of your label templates, and other
factors. Depending on your organization's needs, you may be able to use these
recommendations as base guidelines. Loftware's Professional Services Group can help
you determine the server requirements necessary to meet your exact business needs.

l Requirements for Loftware Spectrum Database Server

l Requirements for Loftware Spectrum Application Server
l Requirements for Multi-Site Deployment
l Requirements for Loftware Spectrum Business Intelligence Server
l Server Performance Tips

Client Computer Requirements

Client computers connect to the Spectrum Application Server.

l Requirements for Spectrum Client Computers

l Requirements for Mobile Devices
l Requirements for Spectrum Remote Print Client Computers

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 287

Device Requirements

Loftware Spectrum® supports printers from a variety of manufacturers. For supported

printer families and printers, in Devices, in the ribbon click > Device to open the

Device Model dialog box. For supported printer families, select Family Driver as the
Family, and then click Model to view the list of supported printer families and languages.
For supported models, select a Family, and then click Model to view the list of supported
models. The printer models supported may vary with the version of Spectrum.

If neither the family nor the model for your printer is listed, you can explore whether a
Driver Extension Framework solution exists that would enable your printer to work with
Spectrum. For more information, see Deploying a Driver Extension Framework Solution
in the Loftware Spectrum User Guide (Help).

Note: Loftware Spectrum® encodes print data using UTF-8. Ensure that your device
firmware supports UTF-8. Older devices may not support this encoding.

Other Application Requirements for Integration (Optional Features)

You can integrate Spectrum with Oracle, SAP ERP, or other applications, including
applications on a cloud services platform. By doing so, you can route print requests
initiated by users in other applications so that they are processed and printed using
Spectrum. In many cases, Spectrum can report the status back to the originating
application. You can configure as many integrations as your Spectrum license allows.

l Requirements for Cloud Applications Integration

l Requirements for Oracle Applications Integration
l Requirements for Integration for use with SAP® Applications

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 288

Server Requirements for Spectrum 4.7.1

The following are the hardware and software requirements for servers for Loftware
Spectrum 4.7.1.

Requirements for Loftware Spectrum Database Server

Loftware Spectrum uses a dedicated persistent data structure named LoftStore as the
Spectrum database. This can be installed into an existing Oracle database or
PostgreSQL database. Alternatively, you can use Amazon Relational Database Service
(Amazon RDS) for Oracle Database or for PostgreSQL.

Note: For information about the database server for a facility site in a multi-site
deployment of Spectrum, see Requirements for Multi-Site Deployment.

These are the database server requirements for Loftware Spectrum 4.7.1 when it is used
with a new or existing Oracle or PostgreSQL database server.

Important! The storage for the tablespace data must be on a fault-tolerant system, such
as SAN or NAS. The same is recommended for all drives that hold the Spectrum
applications and data.

Component Requirement

CPU 8 cores or more

Memory 32GB RAM or more

Available disk space 2TB or more. Multiple factors can affect the amount of space
for database required. Contact Loftware's Professional Services Group
(PSG) for assistance.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 289

Component Requirement

Database One of the following, as appropriate for the operating system:

l Oracle Database 19c
l Oracle Database 12c, version 12.2.0.1
l Oracle Database 12c, version 12.1.0.1 or later 12.1
versions
l Oracle Database 11g, version 11.2.0.4 or later
l PostgreSQL 11.2, 11.6, 11.13, 14.4, 14.5

Important: For the most recent list of supported PostgreSQL

database versions, see Requirements for Loftware Spectrum
Database Server in the Spectrum User Guide (Help).

Note: For required configuration details, see Installing

the Spectrum Database.

Amazon Relational Database Service (Amazon RDS) for

Oracle Database or for PostgreSQL can be used for the
Spectrum database.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 290

Requirements for Loftware Spectrum Application Server

A server that will act as a dedicated Spectrum Application Server has the following
requirements.

Important! If you are installing Spectrum into a network running as a Windows domain,
install the Spectrum application on a domain-member server. Production Spectrum
Application Servers running in a Windows domain are not supported unless they are part
of the domain.

Component Requirement

CPU 8 cores or better

Memory 32GB RAM or more

Available 250GB or more

disk space
Note: The Spectrum application requires approximately 10GB of
disk space upon installation. This includes space to retain Spectrum
Application Server log files which are archived and retained.

Operating One of the following 64-bit operating systems:

system l Windows Server 2019
l Windows Server 2016
l Windows Server 2012 R2
l Amazon Linux 2
l Oracle Linux "Unbreakable" 7.x
l Red Hat Enterprise Linux 7.x

Note: For Linux operating systems, the Spectrum installation

requires the latest lsb_release package as well as a graphical
interface.

Important! All Spectrum Application Servers in a distributed

environment must use the same operating system family and brand.

For an overview about whether to configure a distributed

environment, see Server Performance Tips.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 291

Port Requirements for Cloud-Based Services

When running a Spectrum Application Server with multiple services in a cloud-based

system such as Amazon Web Services (AWS), you must open ports on the firewall to
allow for communication between the Spectrum Application Servers and the Spectrum
Database Server.

The following ports need to be opened for UDP and TCP inbound and outbound.

Note: Although these are the default ports, your site may use different port assignments.

l 8080 l 61616
l 8443 l 16161
l 1521

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 292

Requirements for Multi-Site Deployment

In a multi-site deployment of Loftware Spectrum, a Spectrum instance at one site

(headquarters) is synchronized with Spectrum instances at other sites (facilities).

If you are configuring a multi-site deployment, the following are requirements for facility
sites.

l A Spectrum Database Server at a facility site has the usual requirements for a
Spectrum Database Server. For more information, see Requirements for Loftware
Spectrum Facility Database Server in a Multi-Site Deployment.
l A Spectrum Application Server at a facility site has the usual requirements for a
Spectrum Application Server. For more information, see Requirements for
Loftware Spectrum Application Server.
l The name of the root folder in Spectrum must be the same at the headquarters site
and at each facility site associated with that headquarters.
l The database name (usually "loftstore") and schema names must be the same at
headquarters and at each facility.
l The headquarters and facility sites must be able to communicate, but facilities are
not required to be able to communicate with each other.

Requirements for Loftware Spectrum Facility Database Server in a Multi-Site

Deployment

These are the server requirements for Loftware Spectrum® 4.7.1 facility sites in a multi-
site deployment.

Important! Unless you have upgraded from a version prior to Spectrum 4.1, Spectrum
Business Intelligence is not supported at facility sites.

Important! The storage for the tablespace data must be on a fault-tolerant system, such
as SAN or NAS. The same is recommended for all drives that hold the Spectrum
application and data.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 293

Component Requirement

CPU 4 cores or more

Memory 16GB RAM or more

Available disk 2TB or more. Multiple factors can affect the amount of space
space for required. Contact Loftware's Professional Services Group (PSG)
database for assistance.

Database One of the following, as appropriate for the operating system:

l PostgreSQL 11.2, 11.6, 11.13, 14.4, 14.5
Amazon Relational Database Service (Amazon RDS) for
PostgreSQL can be used for the Spectrum database.

Constraints If Upgrading an Embedded Database

If you have upgraded from a version prior to Spectrum 4.1 and are therefore using the
Loftware-supplied embedded database, additional constraints apply to facility database
servers and facility databases. For details, contact Loftware's Professional Services
Group (PSG).

Note: The Loftware-supplied embedded database is supported only for customers who
have upgraded from a version prior to Loftware Spectrum 4.1.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 294

Requirements for Loftware Spectrum Business Intelligence Server

If your license includes Spectrum Business Intelligence (BI), the following are the
requirements for the Spectrum Business Intelligence Server. This server must be
separate from the Spectrum Database Server and from the Spectrum Application Server.

Important: The Spectrum BI package included with Spectrum 4.7.1 is not compatible
with the Spectrum database in PostgreSQL 14 or later. If you have installed
the Spectrum database in PostgreSQL 14 or later and are using Spectrum BI, contact
Loftware Technical Support for more information.

Component Minimum Recommended

CPU 2 cores Multi-core Pentium, 2.5GHz or greater

Memory 4GB RAM 8GB RAM

Available disk space 10GB 40GB. Multiple factors can affect the amount of
space required. Contact Loftware's Professional
Services Group (PSG) for assistance.

Component Requirement

Installer operating One of the following 64-bit operating systems:

system
l Microsoft server operating systems
l Windows Server 2012 R2

l Red Hat operating systems

l Red Hat Enterprise Linux 7.1
l Red Hat Enterprise Linux 6.6
l Red Hat Enterprise Linux 6.4

Java Oracle Java must be installed on the server. You can

download the latest version from https://www.java.com/en/.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 295

Server Performance Tips

The following information may help you configure your Spectrum environment and your
servers to optimize their performance.

Configuring for High Availability with Distributed Services

If you are planning a Spectrum environment that will include more than one Spectrum
Application Server, it is recommended that you configure your environment to support
distributed services. In a Spectrum environment with distributed services, all Spectrum
Application Servers are configured to interact as peers within the Spectrum environment,
all accessing the same Spectrum database.

In such an environment, you use distributed services to manage which server or servers
are providing Spectrum functionality at any time. In Spectrum, you can configure
distributed services for high availability or for failover only. It is recommended that you
configure for high availability of distributed services in Spectrum. This approach involves
configuring Spectrum to load balance those services that support load balancing so that
they are run concurrently on multiple Spectrum Application Servers. Services that do not
support load balancing should be configured to fail over among Spectrum
Application Servers so that if one or more servers go offline, a standby server or servers
begin running the associated services to minimize any interruption for users.

For information about how to install Spectrum to support distributed services, see
Installing for Distributed Services. For information about configuring distributed
services, see the Loftware Spectrum User Guide.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 296

Optimizing Performance

The following tips may help you to optimize the performance of your Spectrum
configuration.

l Consult your database administrator for guidance about database tuning.

l The more memory that you have configured for the Spectrum Application Server,
the greater the number of devices, label templates, and users that it can support.
l Increasing the amount of memory available to the database server typically
improves performance. If you can make significantly more memory available, you
can dramatically increase performance because all or a significant portion of the
label and configuration data can be cached in memory.
l The amount of space on the database server required for recent history data is
typically greater and more variable than the space required for label and
configuration data. However, if you can make the amount of memory required for
recent history data available on the database server, you can dramatically increase
the performance of reporting.
l Sufficient network bandwidth must be available to support your expected printing
throughput.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 297

Client Computer Requirements for Spectrum 4.7.1

Client computers connect to the Spectrum Application Server and have the following
hardware and software requirements.

Requirements for Spectrum Client Computers

Each computer on which the Loftware Spectrum 4.7.1 client software will be run must be
able to connect to the Spectrum Application Server and has the following requirements.

Component Requirement

CPU 2.0GHz Dual Core or better

Memory One of the following

l 4GB RAM or more (64-bit operating system)

l 2GB RAM or more (32-bit operating system)

Operating system One of the following:

l Microsoft client computer operating systems

l Windows 10
l Windows 8.x
l Microsoft server operating systems
l Windows Server 2019
l Windows Server 2016
l Windows Server 2012 R2

l Oracle Linux "Unbreakable" 7.x

l Red Hat Enterprise Linux 7.x

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 298

Component Requirement

Browser One of the following:

l Mozilla Firefox 45.0 or later

l Google Chrome 50.0 or later
l Microsoft Edge (Chromium) 91.0 or later

Support for Optional. You can configure the client computer to allow
remote spooler Spectrum to print via remote spooler (LPR) connection (that
(LPR) connections is, to spool to a device queue that is directly connected to it by
a wired or wireless connection). If you plan to do so, you must
configure the computer as follows:

l Ensure that the computer is accessible via IP address

or DNS name.
l If Windows Server is installed, ensure that the Role
Services installed include Print Server and LPD
Service.
l If Windows is installed, ensure that the LPD Print
Service feature of Windows is turned on. (The LPR Port
Monitor feature is not required.)

It is not necessary to perform this configuration on other

computers that access this device connection via shared
network printing.

Note: For information about creating a remote spooler (LPR)

connection, see in the Loftware Spectrum User Guide.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 299

Requirements for Mobile Devices

Loftware Spectrum 4.7.1 supports using the Applications page from a mobile device with
the following requirements.

Component Requirement

Operating system l A phone or tablet with Android 7.0 or later

l An iPhone or iPad with iOS 12.0 or later

Browser l Google Chrome on Android (latest version)

l Apple Safari on iOS (latest version)

Requirements for Spectrum Remote Print Client Computers

Loftware Spectrum® 4.7.1 supports remote printing, the act of printing a label to a device
that would not normally be accessible to Spectrum by using your LAN or by using a direct
connection to Spectrum. For example, printing using a device that is physically
connected to a computer outside of your WAN. The Spectrum Remote Print solution
includes a Loftware Print Agent that is installed on a remote computer. Each Remote Site
computer on which Spectrum Remote Print will be run has the following requirements.

Component Requirement

CPU 2.0GHz Dual Core or better

Memory 4GB RAM or more

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 300

Component Requirement

Operating system One of the following 64-bit operating systems:

l Microsoft client computer operating systems

l Windows 10
l Windows 8.x
l Microsoft server operating systems
l Windows Server 2022 (Loftware Print Agent)
l Windows Server 2019
l Windows Server 2016
l Windows Server 2012 R2

Browser One of the following:

l Mozilla Firefox 45.0 or later

l Google Chrome 50.0 or later
l Microsoft Edge (Chromium) 91.0 or later

Other l Configure a single Remote Site per local network.

l Configure a maximum of 1000 Remote Sites per
Spectrum Application Server.
l Configure a maximum of 250 devices per Remote Site.
l Configure a maximum of 2000 devices across all
Remote Sites.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 301

Other Requirements for Integrations

You can integrate Spectrum with Oracle, SAP ERP, or other applications, including
applications on a cloud services platform. By doing so, you can route print requests
initiated by users in other applications so that they are processed and printed using
Spectrum. In many cases, Spectrum can report the status back to the originating
application. You can configure as many integrations as your Spectrum license allows.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 302

Requirements for Cloud Applications Integration

Cloud integration enables you to integrate Spectrum with Oracle Cloud applications so
that users can drive label printing from Oracle Cloud applications, such as the Oracle
Cloud Supply Chain Management (SCM) application. You can configure as many Cloud
integrations as your Spectrum license allows, and you must have a separate subscription
through Oracle Cloud with an Oracle Integration Cloud (OIC) instance to use the
Spectrum Cloud integration feature.

The Cloud integration feature is composed of the following components:

l A provisioned Spectrum Cloud Integration Agent that serves as a communication

vehicle between Spectrum and the Oracle Integration Cloud
l A configured Cloud integration in Spectrum
l A configured integration in the OIC that uses the Loftware Spectrum Adapter

If you are integrating Spectrum 4.7.1 with Oracle Cloud applications, you must meet the
following requirements.

Component Requirement

Loftware license Spectrum license that includes Spectrum Cloud integration

Oracle Cloud A separate subscription through Oracle Cloud with an Oracle

subscription Integration Cloud (OIC) instance to use the Spectrum Cloud
integration feature

Note: You must have SCM Cloud and an Oracle Integration

Cloud instance running.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 303

Component Requirement

Business events Identify which business events from SCM will drive label
printing.
Review data available with selected business events to
determine what data comes from SCM and what data must be
gathered from other sources for a complete label. The
Spectrum Cloud integration may be supplemented with
additional data sources configured in Spectrum, external to
the Oracle Cloud, for a complete label data set.

Requirements for Spectrum Cloud Integration Agent

The Spectrum Cloud Integration Agent serves as a communication vehicle between

Spectrum and the Oracle Integration Cloud. It can be installed on a cloud services
platform, separate from the Spectrum Application Server.

Component Requirement

Cloud services Any cloud services platform, such as the following, to which
platform you can deploy a supported system image:

l Oracle Cloud (recommended)

l Amazon Web Services (AWS)

System image to be The following must be installed on the server used to create
deployed to cloud the system image.
services platform
l Apache Tomcat 8.5 (separate from the Spectrum
Tomcat instance)
l Java 1.8
l Spectrum Cloud Integration Agent

For more information about Cloud applications integration, see the Spectrum User Guide
(Help).

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 304

Requirements for Oracle Applications Integration

Oracle integration extends the functionality of Oracle applications, incorporating

Loftware Spectrum® capabilities so that users can print labels and other Spectrum
documents from Oracle Warehouse Management Solution (WMS), Oracle Mobile Supply
Chain, and other Oracle applications. Print requests initiated by users in Oracle
applications can be processed and printed by Spectrum, and Spectrum reports the status
of each request to the originating application. You can configure as many Oracle
integrations as your Spectrum license allows. If you are integrating Spectrum 4.7.1 with
Oracle applications, you must meet the following requirements.

Component Requirement

Loftware license Spectrum license that includes Oracle Integration

Database software One of the following, including patches:

l Oracle Database 12c

l Oracle Database 11g

For more information about Oracle applications integration, see the Spectrum User Guide
(Help).

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 305

Requirements for Integration for use with SAP® Applications

Loftware Spectrum® Integration for use with SAP® Applications is an optional

component that extends the functionality of SAP applications, incorporating Loftware
Spectrum capabilities so that users can print labels from SAP applications. Print requests
initiated by users in SAP applications are processed and printed by Spectrum, and
Spectrum reports the status of each request to the originating application. You can
configure as many integrations as your Spectrum license allows. If you are integrating
Spectrum 4.7.1 with SAP, you must meet the following requirements.

Component Requirement

Loftware Spectrum license that includes Integration for use with SAP®
license Applications

SAP system l SAP S/4HANA On-Premise

l SAP ECC 6.0 or later with the latest enhancements

SAP JCo SAP JCo (sapjco3.jar) 3.1.7 or later, 64-bit version, must be deployed
to the Spectrum Application Server. SAP JCo can be obtained from
SAP Support Portal. If your Spectrum Application Server is running
Windows Server, JCo 3.1 requires the Visual Studio 2013 C/C++
runtime libraries to be installed on the system. The "Visual C++ 2013
Redistributable Package" can be downloaded from
https://support.microsoft.com/en-us/help/4032938.

Loftware To support SAP BC-XOM integrations, you must install the Loftware
Spectrum Spectrum Command Line Interpreter (CLI) on the SAP Application
CLI Server on one of the following operating systems:

l Windows Server
l Linux
l IBM AIX
l SUSE

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 306

Appendix B: Users and Privileges for the Spectrum
Database

This section provides information about the Spectrum database users and privileges
created during the Spectrum database installation. Your database administrator should
review this information so users and permissions are correctly recognized and added to
their standard role administration.

Note: If you are using Loftware Spectrum Cloud, Loftware Cloud Operations may assign
unique names for the Spectrum schemas and associated user names for each Spectrum
instance. Contact Loftware Cloud Operations for details.

Note: If you have upgraded from a version prior to Spectrum 4.1 and are using the
Loftware-supplied embedded database, then this section is not applicable.

Oracle Database Users 308

PostgreSQL Database Roles 317

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 307

Oracle Database Users

This section lists the Spectrum database users, along with their roles and privileges,
created during the Spectrum database installation in an Oracle Database.

LOFTADMIN

The LOFTADMIN user allows the installer or implementation team to address database
issues involving schemas, updated storage procedures, or other database-related issues
that may come up during the Spectrum database (LoftStore) installation and
configuration. This user is not required for Spectrum to function.

In addition to the following lists, LOFTADMIN privileges include:

l All actions on TABLES and VIEWS in LOFTARCH, LOFTSPEC, and

LOFTREPORTS (if present) schemas
l Indirect access to all objects in LOFTARCH, LOFTSPEC, and LOFTREPORTS
schemas via the executing owner's LOFTADMIN_EXEC_STMT procedure

System Privileges

l ALTER SESSION
l CREATE CLUSTER
l CREATE CUBE
l CREATE CUBE BUILD PROCESS
l CREATE CUBE DIMENSION
l CREATE JOB
l CREATE MATERIALIZED VIEW
l CREATE PROCEDURE
l CREATE SEQUENCE
l CREATE SESSION

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 308

 l CREATE SYNONYM
l CREATE TABLE
l CREATE TRIGGER
l CREATE TYPE
l CREATE VIEW
l RESUMABLE

Object Privileges

l READ, WRITE, EXECUTE on LOFTSTORE_EXPORT

l EXECUTE on DBMS_AQ
l EXECUTE on DBMS_AQADM

LOFTARCH

The default tablespace for this user is SPECTRUM_ARCH, which contains all the
archived Spectrum transactional data.

Granted Roles

l JAVAUSERPRIV
l RESOURCE

System Privileges

l ALTER SESSION
l CREATE CLUSTER
l CREATE CUBE
l CREATE CUBE BUILD PROCESS
l CREATE CUBE DIMENSION
l CREATE JOB

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 309

 l CREATE MATERIALIZED VIEW
l CREATE PROCEDURE
l CREATE SEQUENCE
l CREATE SYNONYM
l CREATE TABLE
l CREATE TRIGGER
l CREATE TYPE
l CREATE VIEW
l RESUMABLE

Object Privileges

l READ, WRITE on LOFTARCH_EXPORT_DIR

l READ, WRITE on LOFTARCH_LOFTSTORE_EXPORT
l EXECUTE on DBMS_SYSTEM
l EXECUTE on DBMS_AQ
l EXECUTE on DBMS_AQIN
l EXECUTE on DBMS_OUTPUT

LOFTAUDIT

The default tablespace for this user is SPECTRUM_AUDIT, which contains all Spectrum
audit data. Any change made to the LOFTSPEC schema is logged to the LOFTAUDIT
schema.

System Privileges

l ALTER SESSION
l CREATE CLUSTER
l CREATE CUBE

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 310

 l CREATE CUBE BUILD PROCESS
l CREATE CUBE DIMENSION
l CREATE JOB
l CREATE MATERIALIZED VIEW
l CREATE PROCEDURE
l CREATE SEQUENCE
l CREATE SYNONYM
l CREATE TABLE
l CREATE TRIGGER
l CREATE TYPE
l CREATE VIEW
l RESUMABLE

LOFTDV

The default tablespace for this user is SPECTRUM_DAVINCI, which contains all
Spectrum Loftware DaVinci data.

System Privileges

l ALTER SESSION
l CREATE CLUSTER
l CREATE CUBE
l CREATE CUBE BUILD PROCESS
l CREATE CUBE DIMENSION
l CREATE JOB
l CREATE MATERIALIZED VIEW
l CREATE PROCEDURE
l CREATE SEQUENCE

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 311

 l CREATE SYNONYM
l CREATE TABLE
l CREATE TRIGGER
l CREATE TYPE
l CREATE VIEW
l RESUMABLE

LOFTDVUSER

The default tablespace for this user is SPECTRUM_DAVINCI, which contains all
Spectrum Loftware DaVinci data.

Granted Roles

l CONNECT

System Privileges

l CREATE SESSION

LOFTREPORTS

This user owns a set of Views under the LOFTREPORTS schema that allow customer
reports to be generated. This is the recommended, and supported, interface for creating
reports on the LOFTSPEC and LOFTARCH schemas.

System Privileges

l ALTER SESSION
l CREATE CLUSTER
l CREATE CUBE
l CREATE CUBE BUILD PROCESS
l CREATE CUBE DIMENSION

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 312

 l CREATE JOB
l CREATE MATERIALIZED VIEW
l CREATE PROCEDURE
l CREATE SEQUENCE
l CREATE SYNONYM
l CREATE TABLE
l CREATE TRIGGER
l CREATE TYPE
l CREATE VIEW
l RESUMABLE

LOFTSPEC

The default tablespace for this user is SPECTRUM_MAIN, which contains all Spectrum
data.

Note: Writing queries against or directly altering this schema is not recommended. This
user should not be granted SESSION.

System Privileges

l ALTER SESSION
l CREATE CLUSTER
l CREATE CUBE
l CREATE CUBE BUILD PROCESS
l CREATE CUBE DIMENSION
l CREATE JOB
l CREATE MATERIALIZED VIEW
l CREATE PROCEDURE
l CREATE SEQUENCE

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 313

 l CREATE SYNONYM
l CREATE TABLE
l CREATE TRIGGER
l CREATE TYPE
l CREATE VIEW
l RESUMABLE

Object Privileges

l SELECT on DBA_TABLES
l EXECUTE on DBMS_CRYPTO
l EXECUTE on DBMS_SESSION
l EXECUTE on DBMS_LOCK
l EXECUTE on DBMS_AQ
l EXECUTE on DBMS_AQ_BQVIEW
l SELECT ON V_$PARAMETER

LOFTUSER

This is the connection user for the Loftware Spectrum service. No Spectrum data is
stored in this schema.

Granted Roles

l CONNECT

System Privileges

l ALTER SESSION
l CREATE CLUSTER
l CREATE CUBE

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 314

 l CREATE CUBE BUILD PROCESS
l CREATE CUBE DIMENSION
l CREATE JOB
l CREATE MATERIALIZED VIEW
l CREATE PROCEDURE
l CREATE SEQUENCE
l CREATE SYNONYM
l CREATE TABLE
l CREATE TRIGGER
l CREATE TYPE
l CREATE VIEW
l RESUMABLE

Object Privileges

l SELECT on V_$DATABASE
l EXECUTE on DBMS_SYSTEM
l EXECUTE on DBMS_OUTPUT
l EXECUTE on DBMS_AQ
l EXECUTE on DBMS_AQJMS
l EXECUTE on DBMS_SESSION
l EXECUTE on DBMS_AQIN

LOFTXREF

The default tablespace for this user is SPECTRUM_CUST, which contains all Cross
Reference Table data and audit data.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 315

Granted Roles

l CONNECT

System Privileges

l ALTER SESSION
l CREATE CLUSTER
l CREATE CUBE
l CREATE CUBE BUILD PROCESS
l CREATE CUBE DIMENSION
l CREATE JOB
l CREATE MATERIALIZED VIEW
l CREATE PROCEDURE
l CREATE SEQUENCE
l CREATE SYNONYM
l CREATE TABLE
l CREATE TRIGGER
l CREATE TYPE
l CREATE VIEW
l RESUMABLE

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 316

PostgreSQL Database Roles

This section lists the Spectrum database roles, along with their privileges, created during
the Spectrum database installation in a PostgreSQL database.

postgres

The PostgreSQL administrator login role (named postgres by default) allows the installer
or implementation team to address database issues involving schemas, updated storage
procedures, or other database-related issues that may come up during the Spectrum
database (LoftStore) installation and configuration. This user is not required for Spectrum
to function.

System Privileges

l Can login
l Superuser
l Create roles
l Create databases
l Update catalog
l Inherit rights from parent roles
l Can initiate streaming replication and backups

loftarch

The default tablespace for this role is spectrum_arch, which contains all the archived
Spectrum transactional data.

loftaudit

The default tablespace for this role is spectrum_audit, which contains all Spectrum audit
data. Any change made to the loftspec schema is logged to the loftaudit schema.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 317

loftdv

The default tablespace for this user is spectrum_davinci, which contains all
Spectrum Loftware DaVinci data.

loftdvuser

The default tablespace for this user is spectrum_davinci, which contains all
Spectrum Loftware DaVinci data.

System Privileges

l Can login

loftreports

This role owns a set of views under the loftreports schema that allow customer reports to
be generated. This is the recommended and supported interface for creating reports on
the loftspec and loftarch schemas.

loftspec

The default tablespace for this user is spectrum_main, which contains all Spectrum data.

Note: Writing queries against or directly altering this schema is not recommended.

loftuser

This is the connection user for the Loftware Spectrum service. No Spectrum data is
stored in this schema.

System Privileges

l Can login

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 318

loftxref

The default tablespace for this role is spectrum_cust, which contains all Cross Reference
Table data and audit data.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 319

Appendix C: About General Data Privacy Regulation
(GDPR)

The General Data Privacy Regulation (GDPR) is a data protection and privacy regulation
set in EU law. The GDPR is intended to unify regulations across the European Union.
The regulations define a set of rights for individuals and responsibilities for the controllers
and processors of personal information. These rights and responsibilities broadly include
the following:

l Right of Access
l Right of Erasure
l Data Portability
l Data Protection by Design and Default
l Records of Processing Activities

An important part for global companies is that GDPR extends the scope of the regulation
to foreign companies that control or process the data of EU residents. In the context of
GDPR, Loftware Spectrum (Loftware) is the data processor. You, as the Spectrum
customer, are the data controller. The personal data that may be stored in Spectrum
include names and email addresses.

Spectrum gives you the tools to help you comply with GDPR. When you enable GDPR
compliance, you can encrypt the database connections and personal data of users and
redact the information of deleted users.

Important! Enabling Spectrum's GDPR features is just a part of complying with these
regulations. It is your responsibility to research your company's responsibilities when it
comes to controlling personal data and complying with GDPR. Loftware cannot
guarantee you will be in complete compliance after enabling the GDPR features in
Spectrum.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 320

Electronic Record Processing

Many global businesses must comply with regulations other than GDPR regarding
electronic data. Businesses that produce food or medicine likely need to comply with the
United States' CFR 21 Part 11 rules. These rules may dictate how long you must hold
onto information, including eSignature. When you are configuring Spectrum for GDPR
compliance, you must understand all your business' responsibilities when it comes to
electronic data handling. Spectrum is flexible in that it allows you to set where to have the
personal information of deleted users redacted.

Best Practices in Protecting Your Spectrum Data

Even if you are not required to comply with GDPR or CFR 21 Part 11, there are some
common sense steps you can take to protect the data you store in Spectrum including the
personal data of your users.

l Change the default password of your SuperAdmin or ClientAdmin user. For more
information, see "Change a User's Password" in the Spectrum User Guide (Help).
l Back up your data at regular intervals.
l If you provide a default password to users, make sure they change the password
the first time they sign in.
l When configuring email devices, do not use personal email addresses. Configure
generic addresses that do not contain personal information as the From and To
addresses.
l When configuring integrations, do not use personal email addresses as Run As
users.
l When configuring Event Email Producers and Event Email Consumers, do not use
personal email addresses.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 321

Configuring Spectrum for GDPR Compliance

This section describes how to configure Spectrum for GDPR compliance. See About
General Data Privacy Regulation (GDPR) for more information on GDPR and its
potential impact on your business.

Before you Begin

If you are configuring GDPR on an existing system, back up your Spectrum instance. See
Backing Up the Full Spectrum Instance for more information about backing up a
Spectrum instance.

Create a Backup of your Existing Spectrum Instance

This backup is intended for use if there is an failure during GDPR configuration that
requires you to revert to your previous version of Loftware Spectrum. Both the Spectrum
application and the Spectrum database should be backed up.

Note: Include any folders or files you have added to the Spectrum folder structure that
will need to be copied back into the new Spectrum version, such as printed PDF labels.

Spectrum Application Backup

To back up your instance of the Spectrum application, perform the following steps.

1. Open a Command Prompt window on the Spectrum Application Server.

2. Copy the full folder hierarchy of <SPECTRUM_HOME> to another location.

Spectrum Database Backup

Unless you are using a Loftware-supplied database, your site's database administrator
should create the backup of your Spectrum database using your company's standards
and tools.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 322

Loftware-Supplied Database Backup

If you are using a Loftware-supplied database (LoftStore), perform the following steps to
back up your database.

1. Open a Command Prompt window on the Spectrum Database Server.

2. Run ls_utils stop to stop the Spectrum database:

<LOFTSTORE_HOME>\bin>ls_utils stop

3. Copy the full folder hierarchy of <LOFTSTORE_HOME> to another location.

4. Run ls_utils start to restart Spectrum database:

<LOFTSTORE_HOME>\bin>ls_utils start

Configure GDPR Compliance

Complete the following steps to configure Spectrum for GDPR compliance.

Note: Enabling GDPR Compliance may impact system performance.

1. Using Encrypted Connections

2. Edit GDPR System Property

3. Enable GDPR Compliance

4. Encrypt Cross Reference Table Columns

5. Clear Archive and Audit Tables

6. Configure Loftware Business Intelligence

Managing Authentication Rules

Manage Password Authentication Rules describes how to configure password length

and complexity rules that may help your secure your data.

Deleting and Redacting Personal Information

Encryption of Personal Information describes how Spectrum addresses the "Right to be

Forgotten" portion of GDPR.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 323

Downloading User Data

Downloading Personal Information provides instructions for how users download their
personal information. These instructions are also available in the Spectrum User Guide
(Help) for your users to access.

Using Encrypted Connections

If you are using an Oracle database, your DBA can configure your database to use
encrypted connections. If you are using a PostgreSQL database, refer to the SSL
documentation on the PostgreSQL website (https://www.postgresql.org). If you are using
the Loftware-supplied database, the database connection is encrypted by default.

Edit GDPR System Property

This procedure can only be performed by the SuperAdmin or SystemAdmin user. To

reveal the options that will allow you to enable GDPR compliance, you must set this
property value to true. By default, the GDPR system property value is set to false. To edit
the GDPR system property value, use the following procedure.

Important! Once the GDPR property is set to true, GDPR mode cannot be turned off.
Even if the property is set to false or removed from the System Properties table, your
Spectrum environment will continue to run in GDPR mode. Turning off the GDPR mode
system property only hides the related UI objects, including the GDPR pane in System
and the Download User Data option on the User Info tab.

1. In System, click System Properties.

2. In the Key column filter, type gdpr.mode.

3. Double-click the Value cell for the gdpr.mode key to edit the value, type true, and
press Enter.

4. Sign out of Spectrum, and then sign back in as an administrator. A GDPR tile now
appears in System.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 324

Enable GDPR Compliance

Use this procedure to configure Spectrum to be compliant with certain aspects of the
EU's GDPR regulations.

Important! Enabling Spectrum's GDPR features is just a part of complying with these
regulations. It is your responsibility to research your company's responsibilities when it
comes to controlling personal data and complying with GDPR. Loftware cannot
guarantee you will be in complete compliance after enabling the GDPR features in
Spectrum.

1. In System, click GDPR.

2. Select the GDPR Compliance check box.

3. Select an Encryption Algorithm from the drop-down list.

l None: No encryption of personal data
l AES-128: Personal data is encrypted in the database

4. If you want usernames redacted from your database after a user is deleted, select
Redact Username on Deletion.

5. If you want the e-signature table redacted after a user is deleted, select Redact
eSignature on Deletion.

6. If you want workflows redacted after a user is deleted, select Redact Workflow.

7. Click Apply. You will be asked to confirm your selection.

Important: Once GDPR compliance is turned on, it cannot be turned off. Review
this entire guide and your company's rules and guidance around personal
information privacy and security before making any choices. Even if the GDPR
Compliance option is cleared or the gdpr.mode system property is set to false, the
system will continue to respect the options originally applied and confirmed on the
GDPR Global Settings page.

8. Click Yes to confirm. You will be asked to confirm that you want to enable GDPR
compliance again.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 325

Configuring Cross Reference Table Encryption

If you use the cross reference table feature of Spectrum you may want to encrypt
personal data stored in the table. You may need to do this if you are required to comply
with GDPR. If GDPR mode is enabled in Spectrum, you can encrypt columns of data as
you are creating the table or after the fact.

Encrypt Cross Reference Table Columns

Follow this procedure to encrypt the data in existing cross reference table columns.

1. In Applications, open the XrefAdminApplication.

2. Go to the Edit Columns page and select a table from the drop-down list. The
columns in the table are displayed.

3. Under Edit Column, select a column from the drop-down list.

4. Click Encrypt. The new column data type is displayed.

Clear Archive and Audit Tables

These procedures remove all the data from archive and audit tables (LOFTARCH and
LOFTAUDIT). This step may be necessary when you are configuring Spectrum for GDPR
compliance. These tables may contain personal information that must be removed.

Note: If you are using Loftware Spectrum Cloud, Loftware Cloud Operations may assign
unique names for the Spectrum schemas and associated user names for each Spectrum
instance. Contact Loftware Cloud Operations for details.

1. In System, click GDPR.

2. To clear the archive tables, click Clear Archive in the Database Actions panel.

3. To clear the audit tables, click Clear Audit in the Database Actions panel.

Configure Loftware Business Intelligence

If you use Loftware Spectrum® Business Intelligence (BI), you will need to configure it to
work with Spectrum after enabling GDPR.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 326

 1. Download and install the JCE Unlimited Strength Jurisdiction Policy Files on the
Spectrum BI server. These files can be downloaded from
http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-
2133166.html.

2. Copy US_export_policy.jar and local_policy.jar to

C:\Loftware\SpectrumBI\java\lib\security

3. Restart the Spectrum BI Server.

4. In Spectrum BI, edit the LoftwareDefaultDataSource to append the URL field with
the following:
;{attribute('encrypted','Server')}

Example
URL (required):
;SID={attribute('defaultdbSID','Server')}
;{attribute('encrypted','Server')}

5. In Spectrum BI, select Manage, Server Settings, and select Server Attributes and
add a new attribute named "encrypted" with the following value:
EncryptionLevel=required;EncryptionTypes=AES256

Encryption of Personal Information

This topic describes the parts of Loftware Spectrum that provide encryption to protect
personal information.

Database Encryption

When you enable GDPR compliance, you are presented with the option of redacting user
information from the different locations it is stored within Spectrum. When you choose to
redact personal information, the data is completely removed where it can be. Where a
record cannot be completely removed, the username is converted to a redacted name (a
string that does not contain personal information), and it is encrypted.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 327

Example Redacted Name

!!DELETED-10000000-!!

Username

When Redact Username on Deletion is selected, user information is removed from the
database. The username is changed to the redacted name, and the value is encrypted.

eSignature

When Redact eSignature on Deletion is selected, the username is changed to the

redacted name wherever it appears in workflow tables, and the value is encrypted.

Workflow

When Redact Workflow is selected, the username is changed to the redacted name
wherever it appears in workflow assignment records, and the value is encrypted.

Redact Personal Information

Use this procedure to redact personal information from the Spectrum database.

1. In System, click GDPR.

2. Select Redact Username on Deletion to change the username and encrypt the
value.

3. Select Redact eSignature on Deletion to change the eSignature and encrypt the
value.

4. Select Redact Workflow to change the workflow assignments to remove personal

information and encrypt the value.

Configuring Password Rules

Loftware Spectrum allows you to configure password rules such as length, contents, and
number of entry attempts.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 328

Manage Password Authentication Rules

An administrator can create password rules to enhance security in Spectrum. You can
enter a regular expression to define the pattern and contents rules for passwords.

Important! Patterns for password patterns and contents are governed by the Java
syntax for regular expressions.
Escape sequences are required for the following characters. Precede the character with
a backslash.
<>()[]{}|^-=+*$!?.\
For more information about Java syntax for regular expressions, see "Scripting, Java,
and XML" in "External Links" in the Spectrum User Guide (Help).

Note: To perform this task, you must be signed in as the ClientAdmin, SystemAdmin, or
SuperAdmin user. For more information, see in the Spectrum User Guide (Help).

To configure rules for passwords in Spectrum, perform the following steps.

1. Sign in to Spectrum.

2. In System, click System Administration.

3. In the Authentication Rules panel, to define the minimum and maximum number of
characters allowed in a password, enter a regular expression for Password
Pattern. For more information, see Password Pattern Examples. A four character
minimum is used by default if you leave this field blank.

Example

The following sets an 8 character minimum and 50 character maximum:

.{8,50}

4. To define the characters required in a password, enter a regular expression for

Password Contents. For more information, see Password Contents Examples.

Example

The following requires passwords to contain at least one uppercase character and
at least one numeric character:
(?=.*[A-Z])(?=.*[0-9])

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 329

 5. For Custom Password Error Message, enter the message to display to users if
their new or changed password does not meet the criteria specified in
Password Pattern and Password Contents. This message should inform the user
what is required for a valid password.

Example

Password must be at least 8 characters and must contain at least 1 number.

6. For Maximum Login Attempts, enter the number of times a user is allowed to enter
an incorrect password before being locked out of Spectrum.

Tip: If a user exceeds the number of sign in attempts, that user is locked out. To
reactivate a user's access, select the user in Access Control, click Edit, select the
Active check box, and then click Save. The SuperAdmin user is locked out after
three failed sign in attempts. To reactivate SuperAdmin access, restart the
Spectrum Application Server.

7. Click Save.

Password Pattern Examples

Example Definition
.{8,50} 8 character minimum and a 50 character maximum.
.{8,} 8 or more characters.
.{8} Exactly 8 characters.

Password Contents Examples

You can use several strings in combination to create a stronger password requirement.

Example Definition
(?=.{8,50}) 8 character minimum and a 50
character maximum.
(?=.*[a-z]) At least one lowercase character.
(?=.*[A-Z]) At least one uppercase character.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 330

Example Definition
(?=.*[!@#$%&*\<\>\(\)\[\]\{\}\|\^\- At least one special character from
\=\+\*\$\!\?\.\\]) the list:
!@#$%&*`~|^<>()[]{}|^-=+*$!?.\
(?=.*[0-9]) At least one numeric character.
(?=.*[a-z].*[a-z]) At least two lowercase characters.

Downloading Personal Information

To comply with GDPR, users must be able to export the personal information being
controlled to a machine readable format. Spectrum provides two locations where
personal data can be downloaded — from User > Download User Data or from Access
Control if permissions allow.

Download Personal Information

If you have enabled GDPR compliance, you can download the information stored in
Spectrum for a specific user to a CSV file using this procedure. For more information, see
About General Data Privacy Regulation (GDPR).

Note: If you do not have access to Access Control, you can download your personal
information from User > Download User Data. For more information, see Download
Your Personal Data.

1. In Access Control, click an existing user.

2. In the ribbon, click Home > Edit.

3. Click Download User Data. The Save As dialog appears.

4. Select a location for the file and give it a name.

5. Click Save. A CSV file is saved in the following format.

[username],[first name],[last name],[email address]

Download Your Personal Data

You can download the personal information that is stored in Loftware Spectrum.

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 331

 1. Click User, and in the menu click Download User Data. The Save As dialog
appears.

2. Select a location for the file, and give it a name.

3. Click Save. A CSV file is saved in the following format.

[username],[first name],[last name],[email address]

Loftware Spectrum 4.7.1 Installation and Configuration Guide Rev B 332