You are on page 1of 559

Cat Fleet

Administration & Configuration Manual Release 4.4.x


Copyright

Copyright Notices and Disclaimers


Cat® MineStar™ and related written manuals and documentation are ©Caterpillar 2001-2014. All rights
reserved. No portion of these works may be reproduced, in whole or in part, for any purpose, without the
express written permission of Caterpillar. CAT, CATERPILLAR, their respective logos, MineStar and “Cater-
pillar Yellow”, as well as corporate and product identity used herein, are trademarks of Caterpillar and may not
be used without permission.

Microsoft, Access, Windows, Internet Explorer, Word, Excel, Outlook and Exchange are registered trade-
marks or trademarks of Microsoft Corporation in the United States and other countries. BusinessObjects and
InfoView are trademarks of BusinessObjects. Other third party product names used herein may be the trade-
marks of their respective owners.

Cat MineStar and related written manuals and documentation contain copyrighted content owned by third
parties which has been used under license from those third parties. Use of Cat MineStar is subject to the
terms, conditions, limitations and disclaimers that apply to all third party content contained herein.

Information in this document is subject to change without notice. Companies, names and data used as
examples herein are fictitious unless otherwise noted.

Page: 2 / 559 © Caterpillar 2001-2016 Cat Fleet Administration & Configuration Manual


December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Contents
Copyright Notices and Disclaimers 2

Contents 3

Introduction 44

About this manual 45

Who should read this manual 45

Assumptions 45

What this manual does not cover 46

Initial Fleet configuration 48

Introduction 49

Chapter goals 49

Assumptions 49

Configuring operating system settings 51

Server 51

Client 51

Configuring the server environment 52

Networking requirements 52

Failover requirements 52

Configuring system options 53

Using Supervisor 53

Platform 53

System 53

General 54

Configuring the unit set 54

Release 4.4.x © Caterpillar 2001-2016 Page: 3 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Services 55

Regenerating the Windows Services configuration 57

Server 58

Database 58

Jetty 60

GIS 60

Reporting 60

Email 61

Advanced 61

System – Enterprise Extensions 61

System Monitoring 61

Failover 61

Enterprise Backup 61

Auditing 62

System – Environment and Events 62

System – Fault Monitoring, Logging and Report Cache 62

System – Workgroup Extensions 62

Support Uploads 62

Backup 62

Snapshots 63

File Archiving 63

Data Archiving 63

Rman Configuration 63

Purge Recycle Bin Configuration 63

Configuring Client options 63

Configuring system directories 64

Page: 4 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

System directories 64

Base directories 64

Local Base Directory 64

Central Base Directory 64

Advanced directories 65

General directories 65

Change management 65

Configuration directory {MSTAR_CONFIG} 65

Updates directory {MSTAR_UPDATES} 65

Standby Directory 66

Data management 66

Onboard files directory {MSTAR_ONBOARD} 66

Data exports directory {MSTAR_DATA} 66

DataBase system temp Directory {MSTAR_BASE_LOCAL}/data 67

Data backups directory {MSTAR_DATA_BACKUPS} 67

Vims Files Directory /VimsFiles 67

Fluid Analysis Files Directory /FluidImportFiles 67

Local directories 67

Logging and diagnostics 67

Process logs directory {MSTAR_LOGS} 67

Process tracing directory {MSTAR_TRACE} 68

General housekeeping 68

Temporary files directory {MSTAR_TEMP} 68

Admin files directory {MSTAR_ADMIN} 68

Shared directories 68

Central logging 68

Release 4.4.x © Caterpillar 2001-2016 Page: 5 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Additional logging directory {MSTAR_ADD_LOGS} 68

Communications logs directory {MSTAR_MESSAGES} 69

Support communications 69

Outgoing directory {MSTAR_OUTGOING} 69

Sent directory {MSTAR_SENT} 69

Web Sites 69

MineStar help 69

MineStar published reports 70

Restoration information 70

Miscellaneous shares 70

Disk monitoring 70

Specifying disk volumes to monitor 70

Disk space considerations 71

Using compressed drives 71

Creating the datastores 72

Database file sizes 72

Oracle home drive 72

Additional Data Drives 72

Configuring the Oracle Listener Service 73

The tnsnames.ora file 73

Setting up CyclesKpiSummaries 75

Configuring CyclesKpiSummaries 75

Create database objects for CyclesKpiSummaries 75

Site-specific configuration 76

Configuring Snapshots 77

Setting up scheduled tasks 79

Page: 6 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Types of scheduled tasks 79

Configuring Fleet clients 80

Using Windows Firewall 80

Client configuration options 80

Configuring global options 80

Configuring local options 81

Starting Fleet for the first time 82

Starting the system 82

Starting a Client 82

Configuring initial users 83

Building the mine model 84

Site travel network 85

Materials and grades 86

Machines and fleets 87

Machine states and job codes 88

Site personnel 89

Rosters and shifts 90

Safety items 91

Delay categories and types 92

How to configure custom delay categories 92

Message types 92

Mining blocks 92

Configuring Health 93

Updating VIMS definitions 94

Configuring data retention 95

Things to consider when setting data retention periods 95

Release 4.4.x © Caterpillar 2001-2016 Page: 7 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Health data retention periods 96

Health Data Deletion job 96

Recommended retention periods 96

Defining data retention periods 98

Data archiving - Health Events 98

Adding extra retention period options 99

Example .xml fileAdding 6-week and 8-week retention periods 100

Configuring machines 102

Machine setup 103

Setting the machine serial number 103

Configuring the on-board health platform 103

Defining interface addresses 104

FTP Server setup for VIMS report download 107

Configuration of Health jobs 108

Health Jobs 108

Configuring pollable channels 109

Polled Channel Config Setup Command (VIMS 3G and TPI only) 109

Updates to the VIMS Limits configurability 110

To modify and update the limits 110

Default directories for VIMS data 110

Using site limits in an xml file 111

Creating measure groups for a site 112

Configuring VIMS audible alarms 113

Advanced Fleet configuration 116

Introduction 117

Chapter goals 117

Page: 8 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Assumptions 117

Advanced server configuration 118

Using multiple Fleet systems 118

Introduction 118

Creating a new system 118

Configuring a new system 118

Running a new system 119

Using multiple servers 120

Setting up multiple server support 120

Advanced CyclesKpiSummaries configuration 121

How Fleet uses KpiSummaries 121

Standard and Custom definition files 122

Standard files 122

Custom files 122

Notes on customization 123

Merged File 124

Difference File 125

Generation of definition segments 125

Creating a Custom Time Usage Model (TUM) by modifying the KPI Summaries definition file 126

Suggested Steps: 132

Creating a Custom Time Usage Model (TUM) using the office software KPI configuration tool 132

Prerequisites 132

Delay Type and Category setup 133

Machine Activity setup 133

Creating a new time usage model 133

Organizing the hierarchy structure 136

Release 4.4.x © Caterpillar 2001-2016 Page: 9 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Embedded variable mapping 140

Generate the KPISummaries xml file 144

Reverse validation of the model 145

Export the xml to Microsoft Excel 146

Delay and Activity Modifications 146

Creating and Modifying KPISummaries.xml 148

Mining block hierarchy 148

Time breakdown 149

Materials and hierarchy 150

KpiSummaries definition 151

Description attributes 151

Reserved attribute 151

Header 151

context 152

sourceManager 152

tablePrefix 152

Dimension tables 152

date 152

entity 153

name 153

context 153

type 153

keyProperty 154

Dimension attributes 154

name 154

expr 154

Page: 10 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

type 154

Indexes 154

columns 154

Lookup tables 154

name 155

name 155

type 155

missingValue 155

Lookup updated 155

Fact tables 155

name 156

Dimension references 157

if 157

name 157

source 157

dimension 157

keyIfSourceMissing 157

Lookup references 158

if 158

name 158

lookup 158

expr 158

name 158

expr 159

Example 159

Details 160

Release 4.4.x © Caterpillar 2001-2016 Page: 11 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

if 160

name 160

expr 160

type 160

Measure categories 160

Measures 160

if 161

name 161

expr 161

unitType 161

User-preferred unit 161

Storage unit 161

category 161

Calculated members 161

name 162

expr 162

Summaries 162

name 162

fact 162

name 162

dimension 163

name 163

name 163

measure 163

stat 163

Realtime KPIs 163

Page: 12 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

if 164

name 164

machineType 164

fact 164

Timestamp 164

Dimensions 164

Measures 165

KPIs 165

KPI 165

name 166

if 166

stat 166

label 166

unitType 166

active 166

rolledupKpi 166

name 167

rollupOf 167

label 167

calculatedMember(s) 167

name 167

if 167

expr 168

label 168

unitType 168

Real-time KPI persistence 168

Release 4.4.x © Caterpillar 2001-2016 Page: 13 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Update KPI Summaries XML 168

Run makeDataStores 168

Review KPIGen.properties 169

Create Dashboards or Reports that access real-time KPIs 170

KPI display 170

Display of KPI values 170

Display of KPI labels 171

Expression definition 171

Terms 171

Special methods 172

Source entity terms 172

Shift wrapper 172

getYear() 172

getHalfYear() 173

getQuarter() 173

getMonth() 173

getWeek() 173

getDay() 173

getShiftName() 173

getShiftType() 173

getCrewId() 173

getShiftStartTime() 173

getShiftEndTime() 173

Dimension and fact row beans 173

getPeriodStartTime(String periodKey) 174

getPeriodEndTime(String periodKey) 174

Page: 14 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Collection wrappers 174

CycleActivityComponent(cycle.activities) 175

getDurationByActivity(String name) 175

getSmuDurationByActivity(String name) 175

getStartTimeByActivity(String name) 176

getEndTimeByActivity(String name) 176

CycleActivity wrapper: getSmuDurationByActivity(String activityName): Quantity 176

CycleDelay(cycle.allDelays) 177

getDurationByCategory(String name) 177

getSmuDurationByCategory(String name) 177

getCountByCategory(String name) 177

getDurationByClass(String name) 177

getSmuDurationByClass(String name) 177

getCountByClass(String name) 178

getIdleDuration(String name) 178

CycleDelay wrapper: getSmuDurationByCategory(String categoryName): Quantity 178

CycleDelay wrapper: getSmuDurationByClass(String className): Quantity 178

CycleRoadSegment(cycle.roads) 178

GradeInformation(cycle.sourceGradesMined, cycle.sinkGrades) 179

getGradeValueByName(String name) 179

getGradeFractionByName(String name) 179

haveGradeFractionByName(String name) 179

SMU Interpolation 179

kpy.lookupSmu(Machine machine, Date time): double 179

kpy.calcSmuDuration(Machine machine, Date startTime, Date endTime): double 179

Cycle splitting rules 180

Release 4.4.x © Caterpillar 2001-2016 Page: 15 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Working with KpiSummaries 181

recalcCyclesKpiSummaries 181

Recalculating Fact entries 181

chunk 181

wait 181

Recalculating Dimension entries 182

dimension 182

updateMode (optional) 182

updateTime (optional, valid only if updateMode=new) 182

Using CyclesKpiSummaries with reporting 183

Standard reports 183

Time breakdown tables 183

Reference Implementation time breakdown 185

Business Intelligence 188

Configuring production 189

Cycle configuration 189

Dual mode loading tools 189

Using LHD threshold levels 189

Configuring Service Meter Units (SMU) 191

Configuring backups 192

Backup locations and frequencies 192

Backup sizes 193

Excluding files to save space 193

Scheduling 194

Assumed backup types 194

Configuring tape backups 195

Page: 16 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Enabling BackupToTape 195

Disabling BackupToTape 195

EFH management 196

Configuring EFH 196

Road information recalculation 196

Recalculated Information 197

Factors triggering information recalculation 197

Using EFH Parameters 197

Advanced client configuration 198

Using custom roles 198

Creating custom roles 199

Using custom roles 199

VIMS XML file configuration 200

Using VIMS XML files with reporting 200

Configuring client memory settings 201

Fleet system administration 204

Introduction 205

Chapter goals 205

Security 206

Remote access 206

Fleet security 206

Expert mode 206

Permissions and roles 207

Global permissions and inheritance 207

Page-level permissions 208

Permission options 209

Release 4.4.x © Caterpillar 2001-2016 Page: 17 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Role options 209

Using automatic login 210

Configuring Automatic login in Supervisor 210

Using Automatic login from the command line 210

Using single-page clients 211

Configuring single-page clients 211

Creating the office software Explorer preferences file 211

Creating the single-page Explorer command 212

Further configuration of single-page clients 212

Database administration 214

Introduction 215

Chapter goals 215

Fleet datastores 216

Model datastore 216

Historical datastore 216

Summary datastore 216

Reporting datastore 216

Template datastore 217

Database monitoring 218

Taking a snapshot of your database 218

Snapshot contents 218

Database upgrades 219

Database configuration changes 219

Database failover & standby databases 219

Backing up your data 220

Daily Backup Process 220

Page: 18 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Configuring database backup system options 220

Running a manual database backup 221

Restoring data from backups 222

Guidelines 222

Archiving data 222

Transferring data to a FAT32 drive 223

Deleting Data 224

System monitoring 226

Introduction 227

Chapter goals 227

Fleet system monitoring 228

Types of snapshot 228

System Snapshot 228

Operating system Snapshot 228

Database Snapshot 228

System snapshots 228

User and System Snapshot Contents 229

Standby Snapshot Contents 229

Operating System Snapshots 229

Database Snapshots 230

Submitting snapshots for analysis 230

Deleting aged snapshots 230

Configuring deletion of aged snapshots 230

Troubleshooting failed snapshots 231

Incorrect snapshot contents 231

Snapshots fail to transfer to Fleet Customer Support 231

Release 4.4.x © Caterpillar 2001-2016 Page: 19 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Fleet performance monitoring 233

Windows Task Manager 233

Office process monitor 234

Auditing 236

Viewing audit files 237

CSV audit files 237

Server failover 238

Introduction 239

Chapter goals 239

Failover configuration requirements 240

Application server name 240

Database configuration 241

Exception to the rule 243

Command line utility 243

Standby Directory 243

Standby system update and Snapshot frequency 244

Server configuration summary 246

Preparation of Standby server 247

Uncontrolled and Controlled Oracle server failover step-by-step processes 248

Uncontrolled vs controlled failover 248

Uncontrolled Application server failover 248

Uncontrolled Database server failover 249

Uncontrolled system failover 249

Controlled failover common tasks 250

Controlled Application server failover 250

Controlled Database server failover 250

Page: 20 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Controlled system failover 251

Overview of Oracle failback 252

Oracle Server failback process 254

Switch back to production system after outage 254

On the standby server 254

On the production system 254

Troubleshooting 255

Configuration 255

Database Failover 255

Database Failback 256

SQL Server failover 258

Calendar administration 260

Introduction 261

Chapter goals 261

Assumptions 261

Understanding calendars 262

Defining calendars 262

Working with calendars 262

Defining periods 263

Defining shifts 263

Defining non-standard calendars 263

Building shifts and creating rosters 264

Oracle RMAN implementation 266

Introduction to this section 267

Scope 267

Audience 267

Release 4.4.x © Caterpillar 2001-2016 Page: 21 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Implementing Oracle RMAN 268

Disk size requirements 268

Creating a separate catalog database 268

Enabling archive logs in the application database 277

Configuring RMAN for Catalog and Target databases 280

Performance 284

Create directory structures to store the backups 285

Scripts used for RMAN implementation 287

RMAN configuration settings 291

Enabling RMAN 291

Configuring RMAN 292

Running RMAN jobs 292

Supervisor page reference 294

Introduction 295

Chapter goals 295

Diagnostics pages 296

Field Communications 296

Process charts 302

Common events that can impact the performance of the system 302

Process chart details 302

Toolbar buttons 302

Frames 304

System Log frame 305

Legend frame 305

Lines 305

Boxes 306

Page: 22 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Lag 307

What is ECF used for? 308

What is ECF Lag? 309

Events 309

Events in context 309

Keyboard shortcuts 309

Performance Test Bench (PTB) frame 310

Hibernate Collections 311

Hibernate Entities 311

Hibernate Queries 312

Notification 312

RPC (remote procedure call) Invocations 313

Caches 314

Log File frame 315

Graphs 316

Usage tips 316

Log file lines 317

Usage tips 317

System log 318

Diagnostics Tools 318

Management pages 318

Software updates 318

Permissions 320

Calendar defaults 321

Setup pages 323

System directories 323

Release 4.4.x © Caterpillar 2001-2016 Page: 23 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

System options 325

Assignment 326

Blending 326

Decision Support 327

Production Requirements 327

Shift Change 328

Travel Progress Monitor 332

Trucking Indicator 335

Trucking Information 336

Trucking Information GUI 337

Health 337

Channel Finder 337

Channel Monitor 338

Channel Monitor Chart 338

Event Report 339

Health Reporting 340

Telemetry 340

User Interface Health 341

VIMS Import 342

VIMS File Upload 343

VIMS Wireless Download 343

Machine Tracking 344

Audit 344

Destinations 345

Dynamic Mine Model 345

Efficiency Slider 353

Page: 24 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Fleet Update Assistant (FUA) 354

Final Roads 358

GIS Server 358

Graphical Display 359

Incident Service 362

Loadout Unit Integration 362

Machine Assistant 364

Machine Control 364

Machine Manager 365

Machine Nodes 366

Machine Services 367

Mine Boundaries 367

Mine Model Query 368

Operator 369

Roads 371

Scheduled Break Notification 374

Server Waypoint Defaults 374

Site Editor 376

Stopped Machine Detection 377

Surface Management 378

Material Tracking 379

Mining Block Management 379

TSS Color File 380

Pit Link 381

Comms Monitor 381

Comms Server 383

Release 4.4.x © Caterpillar 2001-2016 Page: 25 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Comms Services 386

External Reference 391

Field Message Generator 391

GPS Coordinate Transform 391

Incident FTP 392

Loading Tool Editors 392

Machine Broadcast 393

Nominal GPS Mode Accuracies 396

Machine Finder and Editors 396

Onboard Hardware 397

Outgoing Messages 401

Pit Model Service 402

Remote KPI Display 405

Site Awareness Monitor 405

Platform 407

System 407

Enterprise Extensions 416

Environment 417

Events 419

System - Fault Monitoring 420

Jobs 421

Logging 421

Report Cache 423

Workgroup Extensions 425

Platform - Clients 431

Explorer 431

Page: 26 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Explorer - Client 433

Explorer - Web Client 439

Supervisor Configuration Options 439

Explorer - Table Configuration 439

Formatting Styles 440

Production 444

Cycle Assistant Properties 444

Cycle Configuration 444

Cycle UI Configuration 455

Cycle Query Parameters 455

Cycle Tester Configuration 456

Delay Configuration 457

Fuel & SMU Assistant 458

Fuel Properties 459

KPI Limits 459

KpiSummaries Configuration 462

Mining Block Import 462

Mining Block Processing 469

Overmined 470

Undermined 470

ROM Loaders 471

Pre-processing Configuration 472

SMU Interpolator 473

TKPH Parameters 475

Assignment Options 476

Configuring the iAssignment VMs 476

Release 4.4.x © Caterpillar 2001-2016 Page: 27 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Assignment Planner Definition 476

Assignment Planner Improvements 477

Scheduled Assignment improvements 477

Station Capacity improvements 478

Assignment Context improvements 479

Deviation improvements 479

Production Goal improvements 480

Blend improvements 480

Delay improvements 481

TKPH Improvements 481

Improvements to Assignment Error Logging 481

Global Limit at Loading Tools and Processors 482

Queues 482

Loading tool rates for loading tools 482

Assignment Behavior tab 483

Policies tab 492

Policies tab options that directly affect scheduled assignments 497

What is the behavior of trucks not allowed to a delayed loading tool or processor 500

What is the behavior of trucks allowed to a delayed loading tool or processor 501

Example of trucks allowed to loading tools and processors on delay 502

Solvers tab 505

Troubleshooting the Assignment module 510

mstarrun command reference 512

Introduction 513

Chapter goals 513

Configuration and usage of mstarrun 514

Page: 28 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Configuring mstarrun 514

Basic mstarrun Usage 514

xoc files 515

py files 515

eep files 515

mscript files 515

sh files 515

bat files 515

Command Line Options 515

-b 515

-B 515

-c 515

-C 516

-d 516

-D 516

-e path 516

-j 516

-J 516

-pprogressFile 516

-PprofilerFile.jpl 516

-s system 516

-w 516

-W 516

Command Line Arguments 517

argcheck 517

args 517

Release 4.4.x © Caterpillar 2001-2016 Page: 29 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

argformats 517

argpaths 517

background 517

closeWindow 518

_COUNTRY 518

foreground 518

_LANGUAGE 518

newWindow 518

output 518

passBusUrl 518

_TIMEZONE 518

usage 518

Mstarrun and Java Programs 519

app.name 519

MSTAR_LOGS 519

MSTAR_TRACE 519

MSTAR_TEMP 519

MSTAR_HOME 519

MSTAR_CONFIG 519

MSTAR_ADMIN 519

MSTAR_XML 519

jdk.home 519

user.timezone 519

user.language 520

user.region 520

openorb.home 520

Page: 30 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

mstarrun Targets 521

Target Documentation 521

targetName 521

Usage 521

Description 521

Arguments 521

Options 521

Example 521

Notes 521

List of targets 521

applySystemOptions 522

Usage 522

Description 522

checkDataStores 522

Usage 522

Description 522

checkUpdates 522

Usage 522

Description 522

checkScheduler 522

Usage 522

Description 522

Notes 522

cleanExpiredData 523

Usage 523

Description 523

Release 4.4.x © Caterpillar 2001-2016 Page: 31 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Notes 523

cleanExpiredFiles 523

Usage 523

Description 523

Notes 523

createDataStores 523

Usage 523

Description 523

cycleRecalcUtility 524

Usage 524

Description 524

emptyDataStore 524

Usage 524

Description 524

Arguments 524

exportBIAR 524

Description 524

exportDataStores 525

Usage 525

Description 525

Options 525

-Z 525

-d 525

Arguments 525

Example 525

exportDataToXml 525

Page: 32 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Usage 525

Description 525

Options 525

-d 525

-a 526

-o 526

FieldStats 527

Usage 527

Description 527

Options 527

-l 527

-d 527

-r 527

-n 527

-s 527

-u 527

-N 527

-M 527

-L 528

-D 528

-H 528

-T 528

-W 528

-U 528

-a 528

-h 528

Release 4.4.x © Caterpillar 2001-2016 Page: 33 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

-b 528

-x 528

-y 528

FileConverter 529

Usage 529

Description 529

Options 529

-OutputFile 529

-outputFileName 529

grabOnboardDiagnostics 529

Usage 529

Description 529

grabState 529

Usage 529

Description 529

GwmExport 530

Usage 530

Description 530

Options 530

-c 530

-b 530

-o 530

import 530

Usage 530

Description 530

Arguments 531

Page: 34 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

ImportDataFromXml 531

Usage 531

Description 531

Options 531

-f 531

-e 531

-i 531

-d 531

-p 531

-k 532

importExportedData 532

Usage 532

Description 532

initialiseTpiMachines 532

Usage 532

Description 532

Options 532

initProdSystemFromSnapshot 532

Usage 532

Description 533

Options 533

-a 533

-d 533

-e 533

initStandbyDbFromSnapshot 533

Usage 533

Release 4.4.x © Caterpillar 2001-2016 Page: 35 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Description 533

Options 533

-a 533

Arguments 533

initSystemFromSnapshot 534

Usage 534

Description 534

Arguments 534

inspectModel 534

Usage 534

Description 534

listClients 534

Usage 534

Description 534

logConfigurationsEditor 534

Usage 534

Description 535

logspeedo 535

Usage 535

Description 535

Options 535

-png 535

-0 535

Notes 535

logspeedo2 535

Usage 535

Page: 36 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Description 536

logspeedo3 536

Usage 536

Description 536

makeCatalogs 536

Usage 536

Description 536

Options 536

-b 536

Arguments 537

Example 537

makeDataStores 537

Usage 537

Description 538

Options 538

-q 538

-db=<comma-separated db list excluding summary> all 538

-major or -m 538

-dropConstraints or -dc 538

-ConsistencyChecker 538

-verboseSchema 539

-riSchema 539

-verboseViews 539

-warnWhenShorteningViews 539

-skipViews 539

-skipHistoricalLookups 539

Release 4.4.x © Caterpillar 2001-2016 Page: 37 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

-skipUniverse 539

-skipReportingMetadata 539

-skipSummary 539

-numericsAsMeasures 539

-health 539

-legacyHealth 539

-Targets 540

Arguments 540

Example 540

Create/Update Usage 540

makeDataStores isRequired 542

Description 542

makeScheduledTasks 543

Usage 543

Description 543

Arguments 543

Options 543

Example 543

makeShortcuts 544

Usage 544

Description 544

makeSystem 544

Usage 544

Arguments 544

Options 544

-u 545

Page: 38 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

-k 545

-f 545

-v 545

--version 545

-h 545

migrateStandbyDataToProduction 545

Usage 545

Description 545

Option 545

-e 545

-n 545

printClassPath 546

Usage 546

Description 546

printPatches 546

Usage 546

Description 546

printSystemProperties 546

Usage 546

Description 546

profileTraceFiles 546

Usage 546

Description 546

Options 546

recentTravelTimes 547

Usage 547

Release 4.4.x © Caterpillar 2001-2016 Page: 39 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Description 547

Options 547

<Days> 547

refreshBuild 547

Usage 547

Description 547

replaceDataStoresWithModel 547

Usage 547

Description 547

Options 548

<modelDumpFile> 548

<pitmodelDumpFile> 548

replaceDataStoresWithXml 548

Usage 548

Description 548

Options 548

<filename> 548

runSQLTrace 548

Usage 548

Description 548

Options 548

dataStore 548

sendAllToSupport 549

Usage 549

Description 549

Options 549

Page: 40 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

FTP 549

MSG 549

ATT 549

Example 549

sendCommand 549

Usage 549

Description 549

Options 549

sendLogging 550

Usage 550

Description 550

Options 550

showDbConnections 550

Usage 550

Description 551

Arguments 551

Example 551

snapshotDb 551

Usage 551

Description 551

Options 551

Example 551

snapshotOs 552

Usage 552

Description 552

Options 552

Release 4.4.x © Caterpillar 2001-2016 Page: 41 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Contents

Example 552

snapshotSystem 552

Usage 552

Description 552

Options 553

Example 553

startScheduler 553

Usage 553

Description 553

Notes 553

switchActiveDatabase 553

Usage 553

Description 553

Notes 554

syncCycles 554

Usage 554

Description 554

Targets 554

syncStandbyInformation 555

Usage 555

Description 555

updateMaterialGroup 555

Usage 555

Description 555

Options 556

validateKpiSummaries 556

Page: 42 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Contents

Usage 556

Examples 556

uploadHistory 557

Usage 557

Description 557

Options 557

validateWaypoints 557

Usage 557

Description 557

Options 557

Release 4.4.x © Caterpillar 2001-2016 Page: 43 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Introduction
Cat Fleet Admin & Config Manual
Introduction

About this manual


The Administration & Configuration Manual is designed to provide the basic information required to get your
Fleet system running after a successful installation, and also detailed information on tuning, optimization,
maintenance and customization. You can use the information in this manual to extend the basic Fleet install-
ation to suit the requirements of your site, to ensure that administration tasks are configured and scheduled
correctly and to identify potential problems before they become an issue.

This manual also covers such topics as troubleshooting and failover and recovery, database backups and the
correct methods for deleting aged data. The final chapter is devoted to the command line tools available for
Fleet, how they apply to the office software and how you can extend these tools and even develop your own.

Who should read this manual


This manual is intended primarily for Fleet Consultants and Builders, who are responsible for the installation,
configuration and customization of the office software.

This manual also covers some topics of interest for on site system administration personnel, discussing secur-
ity, permissions, network issues and other aspects related to the everyday operation of the office software.

Assumptions
Throughout the manual, it is assumed that you have a detailed knowledge of the following:

l The Fleet system.


l Supervisor and command line interface configuration options.
l The general network topology, and the specific requirements of the site.
l Database administration and configuration.

Only Fleet Consultants, Builders, or other suitably qualified personnel should make changes
to the settings in Supervisor.

Some chapters may assume you have knowledge specific to that chapter. These assumptions are described
at the beginning of those chapters.

Page: 45 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Introduction

What this manual does not cover


While this manual covers a wide range of topics, including backup and recovery procedures and techniques, it
is not intended as a replacement or alternative to a sound backup and security system for an entire on-site
installation. Each site should have their own policies and procedures in place for ensuring that critical data is
backed up and moved to an appropriate and secure location at regular intervals.

In addition, each site is responsible for ensuring that adequate anti-virus measures are in place and updated
regularly. On-site information technology personnel should work with appropriate Fleet Consultants to ensure
that the selected anti-virus solution will not adversely affect the operation of the office software.

Any virus scanning and tape backup solution MUST exclude 'oradata' directories on the data-
base server.

Release 4.4.x © Caterpillar 2001-2016 Page: 46 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Initial Fleet configuration
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Introduction
Before you start Fleet for the first time, there are some essential configuration steps that you need to follow.
You need to specify the name of the Application and Database Servers and the default ports to use, create the
required database instances and specify the directories to use for configuration and temporary files. You also
need to specify how the Fleet Clients connect to the server.

Much of the default configuration information is suitable for a variety of sites and does not need to be changed.
If your installation is non-standard, however, there may be further changes required before you can start the
office software.

When the initial configuration is complete, you need to create the mine model. This includes adding all of the
site travel network information, such as waypoints, destinations, road segments, etc., the grade and material
information and the details of the field equipment that the office software needs to track.

This chapter describes the initial configuration steps and how to perform them, how to start the office software
Server and how to connect to the server with a client.

The process of creating the mine model is described only; the actual procedures involved are covered in the
Fleet User Manual.

Chapter goals
By the end of this chapter, you should:

l Understand the requirements for configuring a Fleet installation prior to startup


l Be able to configure all required aspects of a standard installation, including datastores, directories,
scheduled tasks and snapshots
l Be able to start an office software Server and connect to it with a Client
l Understand the process of creating the mine model

Assumptions
As well as the assumptions listed in the Introduction chapter, the instructions in this chapter assume a stand-
ard Fleet installation, and that all software installation steps described in the Fleet Install Manual were com-
pleted successfully.

Page: 49 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Because it is a distributed system, Fleet relies heavily on being able to pass traffic over the network. It is there-
fore assumed that the on-site LAN is effective and is not a limiting factor in deciding which files or directories
to share.

The instructions in this chapter also assume that the Application server has an \mstarFiles directory
which can be exposed as a network share.

Release 4.4.x © Caterpillar 2001-2016 Page: 50 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Configuring operating system settings


This section describes the operating system settings necessary for your system.

Server

The server should be configured with virtual memory (paging file) settings of 1.5 times the physical memory on
the server. The paging file should only be located on the C: drive.

Performance options should remain with the default settings, which allocate processor resources to back-
ground services.

The office software operates with Java 1.6, and will install a copy for its own use. If you are installing another
version of Java, it must be compatible with the office software requirements. Check the Java_Home directory
to see which version you are running.

The office software, as currently configured, does not support Java 1.7, and it should not be
installed, used or configured.

Client

The client should be configured with virtual memory (paging file) settings of 1.5 times the physical memory on
the client. The paging file should only be located on the C: drive.

Performance options should remain with the default settings, which allocate processor resources to Pro-
grams.

Page: 51 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Configuring the server environment


This section describes the networking and failover requirements necessary for your system.

Networking requirements
The Application and Standby servers should each be equipped with one Network Interface Controllers (NICs),
which handles all communications. If you are using two NICs, they should be connected to different net-
works, such as the Field and the Office.

Failover requirements
If failover to the Standby server is required, the following procedure should be followed.

1. Enable the Office NIC on the Application Server.


2. Disable the Field NIC on the Application Server (this may disconnect your RDP session).
3. Enable the Field NIC on the Standby Server.
4. Disable the Office NIC on the Standby Server (this may disconnect your RDP session).

If the servers are maintained and managed by your internal IT group, it is critical that this group be involved in
the failover planning, as they may be required to provide this IP address switching.

Release 4.4.x © Caterpillar 2001-2016 Page: 52 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Configuring system options


Using Supervisor

Only Fleet Consultants, Builders, or other suitably qualified personnel should make changes
to the settings in Supervisor.

Most of the procedures throughout this manual rely on the use of Supervisor. This is the standard interface for
most administration and configuration tasks within the office software. Unless otherwise specified, all pro-
cedures in this manual are performed using Supervisor.

To start Supervisor

Double-click the Supervisor icon on the desktop, or at a command prompt, type mstarrun supervisor.

This section describes the requirements and procedures for configuring the essential aspects of the Applic-
ation and Database Servers in order to achieve a viable environment. Depending on the requirements of your
site, further configuration may be necessary. See the Advanced Fleet Configuration chapter for further inform-
ation.

Platform

In Supervisor, click Options, then click System Options. From the Product List, select Platform.

You use the Platform option sets to specify the names of servers, the port numbers to use, database
instance and user names and other site-specific information. It is important that this information be correct or
the office software will not function correctly, or data may be displayed incorrectly. You also use these options
to specify logging, auditing and other options.

For full details of each of the tabs and fields in this option set, refer to the Supervisor Page Reference chapter.
Some initial configuration details are provided below.

System

From the Option Sets list, select System.

You use the System option set to specify the core configuration options for the office software, as described
below.

Page: 53 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

General

Use the General tab to specify general site identification details and location-specific information, such as the
unit set to use and the time zone you are in.

NOTE: The Time Zone field is an editable field. If the appropriate time zone does not appear in the
list, you can type it in directly.

Configuring the unit set

The office software has two default unit sets:

l miningSI
l miningImperial

To add miningSurveyFeet to the unit set

l Enter the following xml into the config/xml/units/units/xml file.

<?xml version="1.0" standalone="no"?>

<!DOCTYPE units SYSTEM "units.dtd">

<units>

<!-- miningImperial with length measured in survey feet. -->

<unitset name="miningSurveyFeet" parent="miningImperial">

<type name="length" unit="surfoot"/>

<type name="torque" unit="newton metre"/>

</unitset>

</units>

Once you have done this, the General tab in the System option set will have miningSurveyFeet in the Unit
Set drop-down list as per the screenshot below.

Release 4.4.x © Caterpillar 2001-2016 Page: 54 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Services

Services start as a Windows service by default.

You can use the Services tab to specify which server components to include and exclude during startup, and
the order in which they should start.

To configure services to run as a Windows service

1. Click Contents > Setup > System Options.


2. From the Product list box select Platform, then from the Options Sets list select System.
3. Click the Services tab.
4. Select the Run as Windows Services check box (as per the screenshot below) to install the Fleet ser-
vices as a Windows service. This is the default installation option.

Page: 55 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

5. Select the mode you wish to start the Windows services in, either Automatic or Manual (as per the
screenshot above).
6. If you wish to configure the timeout for each service, change the value in each of the timeout fields.

If you clear the Run as Windows Services check box and click Apply, the following message displays.

Release 4.4.x © Caterpillar 2001-2016 Page: 56 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

7. Click Yes to continue. You can go back into this tab, select the text box and click Apply and the ser-
vices will be reinstalled.

When the server components are installed to run as Window services, only the Start Services (main) icon and
Stop Services (main) icon are shown on the desktop. Starting and stopping the server components in the
required order is automatically controlled by Windows.
Starting and stopping the server components in the required order is automatically controlled by Windows.

Regenerating the Windows Services configuration

Windows Services are configured using files in the {MSTAR_TEMP} directory. These configuration files are
generated when the decision is made to use Windows Services. They are not regenerated each time the ser-
vice starts – unlike using the mstarrun targets where the configuration is generated on-the-fly as the target
starts.

To regenerate the Windows Services configuration files

1. If there is a need to regenerate the configuration files the Windows Services use, run the following two
mstarrun targets:
mstarrun windowsServices remove

mstarrun windowsServices install

2. Alternately, run Supervisor and navigate to the screen shown in the screenshot above.
3. Clear the Runs as Windows Services check box, click Apply, select the Run as Windows Ser-
vices check box, and click Apply again.

To start and stop individual services

1. Click Start > Control Panel > Administrative Tools > Services.
2. You will find Fleet services in the list, prefixed with M*, e.g. M*CycleGenerator.

Page: 57 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Server

Use the Server tab to specify the Application server, IP address, and middleware details.

Database

Use the Database tab to specify the database instance names and user names. You need to consider the
requirements of your site when specifying these options. This section describes a typical setup using two
database instances and the default user names.

To specify the instance and user names

1. Start Supervisor, and on the Contents menu, point to Setup and then click System Options.
2. From the Product list box, click Platform, then in the Option Sets list, select System.
3. Click the Database tab, and specify the Database Server name in the Database Server field.

NOTE: Refer to the Supervisor Page Reference chapter for full descriptions of field names on the
"Platform" on page 407 tab.

4. Specify the required database instance name for each of the Primary and Secondary instance fields
as shown in the screenshot below. The default selection is MINESTAR for all instances.

NOTE: You should not use the characters * . " / \ [ ] : ; | = , in your server names. A hyphen may be
acceptable depending on your platform.

Release 4.4.x © Caterpillar 2001-2016 Page: 58 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

5. Specify the name prefix for the user names and passwords which will be specified in the next step. If
the prefix is ms and the user name is model, then the real user name will be msmodel.
This does not apply to the Read Only user, or the optional Aquila and CAES databases.
6. Specify the user names and passwords for each of the datastores.
By default, the office software uses the naming scheme shown in the following table.

Datastore name Instance User name Password

Model Primary msmodel msmodel

Historical Primary mshist mshist

Summary Primary mssumm mssumm

Reporting Secondary msbor msbor

Template Primary mstmpl mstmpl

Page: 59 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Datastore name Instance User name Password

Aquila Secondary aquila aquila

CAES Secondary caes caes

You can change the names and passwords if required, but it is recommended that you keep the default val-
ues.

NOTE: The Model, Historical, Summaries, and Template databases only require a single instance.
You can still deploy the Reporting, CAES, and Aquila databases to a second instance if required. This
is the default configuration.

7. You can set a Read Only User by entering a read only user name and password in the relevant fields.
These fields default to msread.
Setting the read only username and password gives the user read only access to tables and views in
the Historical database.
8. Click Apply to save the configuration. This is the information that createDataStores uses when cre-
ating the datastores.

Jetty

Use the Jetty tab to specify the home location for Jetty.

GIS

Use the GIS tab to specify the home location for GeoServer.

Reporting

Use the Reporting tab to specify the reporting options used by the office software, such as the URL for the
reporting cache, the default display formats, etc.

Release 4.4.x © Caterpillar 2001-2016 Page: 60 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Email

Use the Email tab to configure the office software’s email capabilities. If supported by the site infrastructure,
the office software can send email internally and externally.

Advanced

Configuration options on this tab are used for development purposes only.

System – Enterprise Extensions

Use the Enterprise Extensions option set to specify system monitoring, failover, enterprise backup and
auditing options.

System Monitoring

The office software creates a range of snapshots to assist in system monitoring and problem diagnosis. Use
this tab to specify the retention periods for each of the snapshot types.

Failover

In order to support failover in case of disaster, the office software creates regular system snapshots and sys-
tem updates. Use this tab to specify

l Snapshot Frequency
Select from the list how often you wish to snapshot the live system. The default is every hour.
l Standby System Update Frequency
Select from the list how often you wish to update the standby system configuration with a copy from
the live system. The default is every 15 minutes

NOTE: If you make changes to either frequency, you need to run makeScheduledTasks before the
changes take effect. See Setting up scheduled tasks for more information.

Enterprise Backup

Some sites can support the integration of data exports with their local tape backup system. If your site sup-
ports this, select this check box to automatically back up the data exports to tape.

Page: 61 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Any virus scanning and tape backup solution MUST exclude 'oradata' directories on the data-
base server.

NOTE: This functionality is limited. See Configuring tape backups for more information.

Auditing

Use the Auditing tab to specify which topics you want to audit in the Client Interface. This is a troubleshoot-
ing feature only, and should be disabled under normal operating conditions.

System – Environment and Events

The configuration options in these option sets relate to low-level office software functions, and should only be
changed by Fleet Consultants, or on advice from Fleet Customer Support. You need to be in Expert Mode to
view this option.

System – Fault Monitoring, Logging and Report Cache

The configuration options in these option sets relate to low-level office software functions, and should only be
changed by Fleet Consultants, or on advice from Fleet Customer Support.

System – Workgroup Extensions

Use the Workgroup Extensions option set to specify options relating to backup frequency, which files to
include in backup sets, and how long to keep data files before they can be deleted.

For more information on configuring database backups, refer to the"Database administration" on


page 214chapter.

Support Uploads

Use the Support Upload tab to specify how and when the office software should send information to Fleet
Customer Support.

Backup

Use the Backup tab to specify the schedule and retention periods for Fleet backups. You should configure the
backups and other CPU and network-intensive tasks to occur throughout the day to avoid overloading the

Release 4.4.x © Caterpillar 2001-2016 Page: 62 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

system.

Snapshots

Use the Snapshots tab to specify the schedule and frequency of System and Operating System snapshots,
as well as the lookback hours for the different types of snapshot. This determines how far back in time the
office software searches for files to include in snapshots.You can also enable the Client-Initiated Server Snap-
shot functionality, "To configure Fleet and operating system snapshots" on page 77in the "Configuring Snap-
shots" on page 77"Configuring Snapshots" on page 77section.

File Archiving

Use the File Archiving tab to specify the archiving schedule and retention periods for generated files.

Data Archiving

Use the Data Archiving tab to specify the archiving schedule and retention periods for different types of data.
You can specify retention periods and the types of data to delete or for short, medium and long terms.

Rman Configuration

Use the Rman Configuration tab to specify the backup schedule times for Oracle Rman. The settings on this
tab should only be changed by an experienced database administrator.

Purge Recycle Bin Configuration

Use the Purge Recycle Bin Configuration tab to specify the frequency of the recycle bin purging. The settings
on this tab should only be changed by an experienced database administrator.

Configuring Client options


In Supervisor, point to Options, then click System Options. From the Product List, select Platform - Cli-
ents.

You use the Platform – Clients option sets to configure the behavior, appearance and other attributes of the
clients that connect to the office software. For full details of each of the tabs and fields in these option sets,
"Supervisor page reference" on page 294 Some initial configuration details are provided below.

Page: 63 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Configuring system directories


This section describes the requirements and procedures for setting up the office software and other directories
appropriate to your site’s configuration.

When configuring system directories using SQL Server, all folders that are being used to
export data must be shared with read and write access to the network users

System directories
To configure system directories

1. Start Supervisor on the machine where you want to configure the directories, for example the Applic-
ation server or the Database Server.
2. On the Options menu, click System Directories.
3. Enter the appropriate details as described in the following sections.

Base directories
The office software uses two Base Directories as the starting point to define the directories that it uses for con-
figuration, maintenance and support purposes. Unless otherwise specified, all directories used by the office
software are relative to one of these two directories.

Local Base Directory

This is a directory local to the current machine, and is the basis for all other directories that need to exist on
the local machine, such as log and trace directories.

The default path for this directory is:

d:\mstarFiles\systems\<systemName>

Central Base Directory

On the Application server, this is typically a local directory, which is shared for all other servers and clients to
use. The Central Base Directory on other servers and on the Mine Controller machines, for example, should
all be configured to use the Central Base Directory on the Application server.

Release 4.4.x © Caterpillar 2001-2016 Page: 64 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

The Backup Server should have a local Central Base Directory, and not share the one on the Application
server.

The default path for this directory on the Application server is:

d:\mstarFiles\systems\<systemName>

NOTE: The drive letter you use (e.g. D:) may be different depending on which drive you installed the
office software on.

Advanced directories
The office software uses a number of additional directories for general administrative and support purposes.
These are typically relative to either the Local Base Directory or the Central Base Directory, with one or
two exceptions.

General directories

Change management

The office software uses two specific directories to store information about changes made to the default con-
figurations settings, and about the patches and service packs that are available for the base installation. This
makes system-wide updates and configuration changes easier.

Configuration directory {MSTAR_CONFIG}

This is a shared directory on the Application server. The files in this directory contain customizations of the
default office software settings.

The default path for this directory is:

{MSTAR_BASE_CENTRAL}/config

Updates directory {MSTAR_UPDATES}

This is a shared directory on the Application server. This directory contains the patches and service packs
that are occasionally released to address issues with the base installation.

The default path for this directory is:

Page: 65 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

{MSTAR_BASE_CENTRAL}/updates

Standby Directory

If a standby application server is configured, a copy of all of the necessary application configuration data files
will be duplicated here so that a standby application server can be started.

Data management

In order to properly maintain and support your system, certain files are periodically sent to Fleet Customer Sup-
port for analysis. Further, periodic database exports are taken and stored in specified directories.

The existence of a patch in this directory does not enable the patch. You need to use the Software Updates
page in Supervisor to install and enable updates.

Each time mstarrun starts a Fleet program, it checks the updates directory and
MineStar.overrides, expands a local copy of the patch to {MSTAR_TEMP} and adjusts its internal
search paths to consider the enabled patches.

Onboard files directory {MSTAR_ONBOARD}

Part of the ongoing maintenance of your system is to send updated files to field equipment. These are created
in Fleet using the Data Transfer Assistant. The files created using this process are stored in the directory spe-
cified here. This can be a shared directory on any server.

The default path for this directory is:

{MSTAR_BASE_CENTRAL}/onboard

Data exports directory {MSTAR_DATA}

The office software periodically creates database exports as .dmp files. These are then zipped and stored in
this directory.

On the Application and Database Servers, this directory should be local. Client machines should share the
{MSTAR_DATA} path specified on the Application server so that all Fleet clients can access the same
TravelTimesData file generated by the recentTravelTimes task.

The default path for this directory is:

{MSTAR_BASE_CENTRAL}/data

Release 4.4.x © Caterpillar 2001-2016 Page: 66 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

DataBase system temp Directory {MSTAR_BASE_LOCAL}/data

The remote database directory to which the snapshot database will be exported to.

On systems deployed with MS SQL Server, this directory must reference a shared path
(\\MachineName\FolderName) with read and write access to the database service account and the office
software. This shared path will be used by the Database Sserver where database exports will be written
before they are copied across to the Application Server.

Data backups directory {MSTAR_DATA_BACKUPS}

As a further precaution, the database export zip files can be copied to a backup directory. The default con-
figuration is to not enable this feature. If this directory is configured, it should be on the Standby Server.
Standby snapshots and zipped copies of database exports are copied to this directory.

These processes should complement a site-defined backup plan.

Vims Files Directory /VimsFiles

Specifies the directory to which VIMS files are saved in subdirectories.

Fluid Analysis Files Directory /FluidImportFiles

Specifies the directory to which Fluid Analysis files are saved in subdirectories.

Local directories

Logging and diagnostics

In order to track system operation and to provide a history of operations should there be operational issues,
the office software keeps a number of log files in various directories.

Process logs directory {MSTAR_LOGS}

This is a local directory on each computer that runs either a Fleet system or a Client. Log files record sig-
nificant events in the operation of a deployed Fleet system.

The default path for this directory is:

{MSTAR_BASE_LOCAL}/logs

Page: 67 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Process tracing directory {MSTAR_TRACE}

This is a local directory on each computer that runs either an office software Server or Client. Trace files can
be created to varying depths of information, and contain information that are useful for debugging purposes.
These files are rarely of use to the system owner.

The default path for this directory is:

{MSTAR_BASE_LOCAL}/trace

General housekeeping

The office software uses a number of specific directories for temporary and administration files used during
everyday operation. Each computer must have their own local directories for these purposes; shared dir-
ectories cannot be used.

Temporary files directory {MSTAR_TEMP}

This is a local directory on each computer where you run either an office software Server application or a Cli-
ent.

The default path for this directory is:

{MSTAR_BASE_LOCAL}/tmp

Admin files directory {MSTAR_ADMIN}

This is a local directory on each computer where you run either an office software Server application or a Cli-
ent.

The default path for this directory is:

{MSTAR_BASE_LOCAL}/admin

Shared directories

Central logging

Additional logging directory {MSTAR_ADD_LOGS}

This directory is configured on all machines except the Application server. This is a shared directory on the
Application server, namely, the mstar_logs directory.

Release 4.4.x © Caterpillar 2001-2016 Page: 68 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

When a snapshot is initiated, the process captures logs from both the mstar_logs and mstar_add_logs
directories. This means that log files from both the server and the client where the snapshot was initiated are
included.

The default path for this directory is:

{MSTAR_BASE_CENTRAL}/logs

Communications logs directory {MSTAR_MESSAGES}

This is a shared directory on the Application server. The files in this directory contain actual user data which is
of value for diagnosis and monitoring of the system, and may be helpful in reconstructing a lost system state.

The default path for this directory is:

{MSTAR_BASE_CENTRAL}/messages

Support communications

Outgoing directory {MSTAR_OUTGOING}

This is a shared directory on the Application server. This directory contains the files that need to be sent to the
Fleet Customer Support.

The default path for this directory is:

{MSTAR_BASE_CENTRAL}/outgoing

Sent directory {MSTAR_SENT}

This is a shared directory on the Application server. This directory contains the files that have been suc-
cessfully sent to the Fleet Customer Support. It is assumed that the Application server has FTP capabilities.
If not, this directory should be on such a computer.

The default path for this directory is:

{MSTAR_BASE_CENTRAL}/sent

Web Sites

MineStar help

This is a shared directory on the Application server. This directory hosts the Fleet Help Website, providing
access to the pdf files that comprise the Fleet Documentation Set.

Page: 69 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

The default path for this directory is:

{MSTAR_BASE_CENTRAL}/help

MineStar published reports

This is a shared directory on the Application server. This directory hosts the Fleet Reporting Website, provid-
ing access to the published reports that comprise the Fleet Report Set.

The default path for this directory is:

{MSTAR_BASE_CENTRAL}/help

Restoration information

A network share is also needed on the Standby Server so that the Application server can periodically copy the
restore information to that location. This share should be called \MstarBackup or \Backup and be mapped to a
drive with sufficient spare disk capacity.

To maximize network performance you should use substituted drives rather than mapped drives wherever pos-
sible.

Miscellaneous shares

Other network locations may be necessary based on local site integration needs, e.g., a network share may
be exposed on the Application server so that more control applications can copy files to that location.

Disk monitoring
You can specify disk volumes to monitor to help ensure that the office software always has sufficient space
for optimal performance. Disk space is a major consideration and insufficient space is one of the primary
causes of reduced performance or even failure.

Specifying disk volumes to monitor

To specify which disk volumes to monitor for free space

1. Start Supervisor, and on the Options menu, click System Directories.


2. Click Disk Monitoring to display the Volumes to Monitor for Free Space field.
3. Click the ellipsis button (…) to display the Select dialog box.

Release 4.4.x © Caterpillar 2001-2016 Page: 70 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

4. Ensure that the volumes you want to monitor are listed in the Include list, and then click OK. For
example, on the Application server, this could be volumes C and D, while on a Database server it could
be volumes D, E and F.
5. Click Apply to apply the changes.

Disk space considerations

Databases are exported periodically according to the schedule established by the Windows Task Scheduler
on the Database server. Database exports are quite large, so the drive where these exports are stored should
have plenty of free space. For performance reasons, the directory where these files are stored {MSTAR_
DATA) should be local to the computer performing the export.

If these exports are configured on the Application server, the same space and directory considerations apply.
That is, the directory should be local and the drive should have sufficient space. This is in part because it is
used for Cycle Cache Recovery files, which are read when starting the office software. Performance could be
adversely affected if these files are not available locally.

Using compressed drives

The recommended policy is to disable this functionality on all directories.

Do not compress the Oracle data drive or directory. Directory compression can give a wrong
indication of available free space, it can cause CPU overheads and lead to serious disk frag-
mentation.

If free space becomes a concern for data storage then the site should immediately begin further capacity plan-
ning and upgrading to bigger drives.

Page: 71 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Creating the datastores


Before you start building the mine model, you need to prepare the required database instances and users.
These constitute the Fleet datastores. How you create these datastores depends on the requirements of the
mine and the configuration of the servers.

You need to run createDataStores on the Database Server, and this requires that Oracle be correctly installed
and configured. The installation of Oracle is covered in the Fleet Install Manual.

You also require administrator privileges to run createDataStores. Refer to the section on User Accounts
and Permissions in the Fleet Install Manual to ensure that the correct domain users and groups have been
established.

At least two arguments are required for createDataStores: the database file size, and the Oracle home drive.
A third argument, additional data drives, can be specified if the Oracle datafiles are to be split over multiple
drives.

Database file sizes

You can specify either LAPTOP or SERVER for the database file sizing. The LAPTOP specification creates
100Mb database files; the SERVER specification creates 1Gb database files.

Oracle home drive

The Oracle home drive is where the Oracle admin directories and system datafiles are created.

Additional Data Drives

These are optional, additional data drives for Oracle datafiles.

When you have determined the correct details for your particular installation, you can run the cre-
ateDataStores application. This is a command line application; there is no facility for running cre-
ateDataStores from within the office software GUI.

To create the datastores

l Open a command shell, and from your mstar\mstarHome\bus\bin directory enter the following
command:

mstarrun createDataStores <database filesize> <Oracle Admin Drive>


[<additional drives>]

Release 4.4.x © Caterpillar 2001-2016 Page: 72 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

For example, on a server machine where the Oracle admin drive is D: and where two additional drives are
required:

mstarrun createDataStores SERVER D EF

createDataStores performs the following functions, using the information specified in Supervisor and the argu-
ments entered at the command line:

i. Creates the Oracle instances if they do not already exist.


i. Creates the office software database users (these become the office software database schema own-
ers).
ii. Creates empty datastores, i.e., the tables, indexes, views, etc.
iii. Creates the Oracle Listener Service.

Configuring the Oracle Listener Service

When you have successfully created the datastores, you need to perform the following steps to complete the
Oracle and database configuration.

l Set the Oracle Listener Service to start automatically


l Copy the tnsnames.ora file to the appropriate servers and workstations

To set the Oracle Listener Service to start automatically

1. In Microsoft Windows, click Start, point to Settings and then click Control Panel.
2. Double-click Administrative Tools and then double-click Services.
3. Locate the Oracle Listener Service for your system, typically called OracleOraDb10g_
home1TNSListener and set it to Start Automatically.
4. Start the Oracle Listener Service.
5. The tnsnames.ora file

The tnsnames.ora file

The tnsnames.ora file defines the database instances that a client can communicate with in the database.
It works in concert with the listener.ora file that exists on the Database Server. The listener only defines the
service for a particular host, whereas the tnsnames.ora file exposes network services to clients for one or
more databases. The tnsnames.ora file is typically required for the Reporting Server and the Builder Work-
station. This provides Oracle with the details it needs for both the client and the database to which it connects.

To copy the tnsnames.ora file from the database

Page: 73 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

1. Ensure that Oracle is installed on the Reporting server and the Builder workstation.
2. On the Database Server, navigate to the directory where you installed Oracle.
The default directory is \mstarOracle
3. In the Oracle directory, navigate to \product\11.2.0\dbhome_1
4. Locate the tnsnames.ora file in {OracleHome}\Network\Admin and copy it.
5. Paste the tnsnames.ora file to Oracle directory on both the Reporting Server and the Builder Work-
station.
The default directory is \dbhome_1\network\admin

Release 4.4.x © Caterpillar 2001-2016 Page: 74 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Setting up CyclesKpiSummaries
CyclesKpiSummaries is a standard Fleet service which is the part of the Production sub-system that writes
records in the Fact and Dimension tables. Fleet ships with a standard library of Kpi definition files but you can
provide custom files that enable you to modify and supplement the standard definitions to suit your site's
requirements.

Before starting Fleet, in particular the CyclesKpiSummaries server, you must:

1. Configure CyclesKpiSummaries to specify which custom files you wish to use.


2. Create the database objects to be used for storing the KpiSummaries data.

Configuring CyclesKpiSummaries

This step can be omitted if you are going to use just the standard definition files or if you choose to postpone
creating your custom files and updating the configuration until later.

1. To configure CyclesKpiSummaries
2. Place your custom file(s) in the mstarFiles\systems\<systemName>\config\xml\cycles
directory.
3. Start Supervisor and, on the Options menu, click System Options.
4. In the Product list, choose Production, then click KpiSummaries Configuration.
5. On the Cycles Definition Files tab in the CustomDefinition File(s) text box, enter the names of your cus-
tom files, one per line.
6. Click Apply.

Create database objects for CyclesKpiSummaries

The makeDataStores utility uses the standard and custom definition files to generate the database schema
required and create the necessary database objects.

To create database objects for CyclesKpiSummaries

l In a command shell, run the following command:

mstarrun makeDataStores-db=summary all

If both steps execute without error and Fleet is started, CyclesKpiSummaries should start without error and
populate the Fact and Dimension tables as the system runs.

Page: 75 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

For detailed information about CyclesKpiSummaries, including how to create custom definition files to suit
your site's requirements and how to update the configuration, refer to Advanced Fleet Configuration.

Site-specific configuration
At this point you should perform any site-specific configuration tasks.

Release 4.4.x © Caterpillar 2001-2016 Page: 76 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Configuring Snapshots
Use Supervisor to configure snapshots. You can optimize your system’s performance by scheduling snap-
shots to run at the most appropriate time.

To configure Fleet and operating system snapshots

1. Start Supervisor, and on the Options menu, click System Options.


2. Click Platform in the Product list, and then click System Workgroup Extension in the Category list.
3. Click the Snapshots tab, specify the required times and other parameters for snapshots that suit your
system.

The Client-Initiated Server Snapshots check box is NOT selected by default, and should be
enabled by either your Fleet Customer Support team, or your site administrator.

Selecting this check box, and then initiating a User snapshot on the Client initiates a User snapshot
on the Server. A log message displays in MineTracking telling you this. If you do another snapshot
within five minutes, the Server outputs a message letting you know that the previous snapshot was
too recent. If MineTracking cannot be contacted, the attempt to invoke a Server snapshot is stopped
after 20 seconds, so that the Client snapshot does not become locked up.

This functionality is unused while the Client-Initiated Server Snapshots check box is not selected. If
you decide you want to use this option, you can enable the functionality in Supervisor without restart-
ing the MineStar services.

4. Click Apply.

To configure standby snapshots

1. Start Supervisor, and on the Options menu, click System Options.


2. Click Platform in the Product list, and then click System Enterprise Extensions in the Category
list.
3. Click the Failover tab, choose the required frequency in the Snapshot Frequency list, and then click
Apply.

To configure standby system update frequency

Page: 77 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

1. Start Supervisor, and on the Options menu, click System Options.


2. Click Platform in the Product list, and then click System Enterprise Extensions in the Category
list.
3. Click the Failover tab, choose the required frequency in the Standby System Update Frequency list,
and then click Apply.

Release 4.4.x © Caterpillar 2001-2016 Page: 78 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Setting up scheduled tasks


Different machines require different scheduled tasks, depending on their role. Scheduled tasks need to be con-
figured for each server and client that is running the office software.

The office software uses Windows Task Scheduler to schedule the tasks required for each machine. Refer to
the Windows Task Scheduler chapter in the Fleet Install manual for details.

Types of scheduled tasks


Application server

The office software creates the following scheduled tasks for an Application server:

l cleanExpiredFiles
l snapshotSystem
l snapshotOS
l snapshotSystemStandby

Database server

The office software creates the following scheduled tasks for a Database Server:

l exportDataStores
l snapshotSystem
l snapshotOs
l cleanExpiredFiles
l cleanExpiredData

The office software client

The office software creates the following scheduled tasks for a Client:

l snapshotSystem
l snapshotOs
l cleanExpiredFiles

These tasks are executed according to the preferences specified in Supervisor.

Page: 79 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Configuring Fleet clients


The Fleet Client is a graphical user interface that provides access to most of the functionality required by Mine
Controllers, Maintenance Engineers, Builders and other users. Before you can start a Client and connect to
the system, you need to specify certain connection and other parameters.

This section describes how to use Supervisor to configure Clients. The actual installation of the Fleet soft-
ware on the client machines is covered in the Fleet Install Manual, and is not addressed here.

Using Windows Firewall


If you have Windows Firewall switched on for your system, you may find that some of your Client functionality
is blocked, for example running certain Jobs and channel polling machines in Channel Finder.

To work around this, you need to add the Client application as an exception to your Windows Firewall applic-
ation.

To add Client as an exception to Windows Firewall

1. Click Start > Control Panel > Windows Firewall.


2. Click the Exceptions tab.
3. Click Add Program ...
4. Click Browse and navigate to \mstar\jdk\bin\ and double-click moclient.exe
5. Click OK.
6. Click OK to exit Windows Firewall.

Client configuration options


There are two aspects to configuring Clients: global configuration and local configuration. Global configuration
is performed on the Application server, and this is used by all clients that connect to it. Local configuration is
performed on the machine where the client is actually running, and can be used to override global con-
figurations. Only minimal local configuration is actually required; most clients will use the global configuration
from the server.

Configuring global options

To configure global options for a Client

1. On the Application server, start Supervisor.


2. On the Contents menu, point to Setup, then click System Options.

Release 4.4.x © Caterpillar 2001-2016 Page: 80 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

3. In the Product list, choose Platform – Clients, then in the Option Sets list click Explorer
4. Use the Taskbar, Appearance and Behavior tabs to specify the default behavior of all Clients, includ-
ing Supervisor.
5. In the Option Sets list, click Explorer – Client to specify the default behavior for clients.
6. If necessary, specify the default behavior for each of the other options, and then click Apply to save
the settings.

Configuring local options

The process for configuring local options is the same as for global options, but is carried out on the machine
where the client is going to run. The options that you specify here only affect clients on that machine; clients
on other machines use either the global options or any local options that have been configured.

Page: 81 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Starting Fleet for the first time


At this point you should be ready to start the Fleet system, connect to it with a Client and start building the
mine model.

Starting the system


To start the system

1. Ensure that both the Application and Database Servers have booted correctly, and that Oracle is avail-
able. To test that Oracle is available, run the following command from the Application server:
mstarrun checkDataStores
This checks that the database configuration is valid.
2. On the Application server, log in using the preferred administrative domain account.
3. Navigate to \systems\<systemName>\shortcuts\ServerDesktop in the \mstar\m-
starFiles directory.
This directory contains the required shortcuts for starting the system. If you have a standard con-
figuration, this directory should contain the following shortcuts:
l Start Services.
l Stop Services.

It is a good idea to make a copy of this directory on the desktop for ease of access.

4. Double-click the Start Services shortcut.


This component is all that is required to begin the process of building the mine model.

Starting a Client
When MineTracking has started successfully, you should test to make sure that you can connect suc-
cessfully with a client. You can do this from any machine that is required to run a Client.

To start a Client

1. Double-click the Client shortcut on the desktop. The Client Splash Screen and Login dialog box
appear.
2. Enter your username and password. If you do not know your username and password, contact your
Fleet site champion or consultant.
3. If necessary, enter the system that you want to connect to.
A properly configured client should display the correct details for the Application server.

Release 4.4.x © Caterpillar 2001-2016 Page: 82 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

4. In the Desktop field, choose the desktop that you want to use, or leave this field blank for a single
instance of the Client.
5. Click OK to log in and display the Client.

Configuring initial users


Before you can build your mine model, you need to set up users. Setting up and managing users is done using
Client. Refer to the Platform chapter in your Fleet User Manual for details on Managing Users. If you are run-
ning a typical Fleet Management system, you should initially define one Builder and one Controller. If you are
running a typical Health system, you should initially define one Maintenance Engineer and one Maintenance
Technician.

Page: 83 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Building the mine model

NOTE: The mine model may have been created before the implementation of your system.

The mine model is the office software’s view of your mine at a point in time. It includes all of the destinations,
equipment, personnel, materials, grades, etc., that make up your mine. In order to function correctly, the office
software needs an accurate picture of your mine, and so it is important that the mine model be correct. Before
you can use the office software for the first time, you need to provide an initial model to work with.

NOTE: The mine model should be built using either the Builder or Maintenance Engineer login.

The following sections describe the process of building the mine model. Only some of these processes are per-
formed in Supervisor. You should refer to the Fleet User Manual for the actual procedures and other inform-
ation for performing each step. A summary of the build process is illustrated below.

Create Machine
Create Site Travel Create Materials Create Machines
States and Job
Network and Grades and Fleets
Codes

Create Delay
Create Personnel Create Rosters Create Safety
Categories and
and Users and Shifts Items
Types

Create Message Validate Site Create or Import


Initialize Health
Types Travel Network Grade Blocks

Release 4.4.x © Caterpillar 2001-2016 Page: 84 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Site travel network


The site travel network consists of the waypoints, destinations and road segments that exist throughout the
mine and that are used for tracking the progress and state of all suitably-equipped machines.

A further component of the site travel network is the Global Positioning System (GPS), which provides the
absolute position of machines. The office software uses this information to determine the position of
machines in the mine, based on survey information.

Import a .dxf file into the site map to begin creating your mine model.

Page: 85 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Materials and grades


When you have created the required destinations in your mine model, you can add the required materials and
grades. The office software collects grade data when the material is excavated by a loading tool. This data
can be used for assignment, reporting and analysis. The following diagram illustrates this process.

Create Materials Create Grades

Release 4.4.x © Caterpillar 2001-2016 Page: 86 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Machines and fleets


You need to define all of the machines for which information is to be collected by the office software. This
includes information such as fuel types, machine classes, nominal payloads, service times, allowable des-
tinations, etc. The following flow diagram illustrates this process.

Create Fuel & Create Truck Create Shovel Create Processor


Lube Types Classes Classes Classes

Create Auxiliary
Create Trucks Create Shovels Create Processors
Equipment

Create Transport
Create Fleets
Vehicles

Page: 87 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Machine states and job codes


An important aspect of production data is cycles. Cycles include the following: machine states, activities and
job codes of each machine as they perform their individual tasks, such as loading tools loading trucks, trucks
traveling to and from loading tools, etc. The following flow diagram illustrates this process.

Create Machine
Create Activities Create Job Codes
States

Release 4.4.x © Caterpillar 2001-2016 Page: 88 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Site personnel
Site personnel are those people who operate and maintain the field equipment, users are those people who
use the office software and are involved in ensuring that the office software runs correctly, such as the office
software Builders. Part of creating the mine model is entering the details of each person, their role and other
details. The following flow diagram illustrates this process.

Create Licenses Create Crews Create Personnel Create Users

Page: 89 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Rosters and shifts


Mines generally operate on a 24-hour basis, with each day divided into shifts according to the default calendar.
A roster consists of a crew being assigned to a shift. Rosters, crews and shifts must be created before shift
allocation can be used.

Ensure Default
Calendars are Create Shifts Create Roster
Correct

Release 4.4.x © Caterpillar 2001-2016 Page: 90 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Safety items
Safety items are used to ensure that field equipment is safe to operate before it begins a shift. Different safety
items and their associated actions need to be created for different types of field equipment. Each time an oper-
ator logs on, the appropriate safety checklist appears for that equipment.

Safety items consist of the actual safety checklist and the required actions should any check fail. You can
also associate a delay type with safety items. This means that whenever a piece of equipment fails a safety
check, it is automatically put on delay using the specified delay type. You use Supervisor to specify the delay
type to use for failed safety checks.

NOTE: The same delay type is used for all failed safety checks.

1. Start Supervisor, and on the Contents menu, point to Setup and then click System Options.
2. In the Product list, click Production and then click the Delay Categories option set.
3. In the Safety Inspections Name field, type the name of the delay type that you want to associate with
safety items. If the required delay type does not exist, create it using the Client.

Page: 91 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Delay categories and types


All the office software delays are based on a Delay Category and a Delay Type, and these must be created as
part of the mine model before any field equipment, roads, etc., can be placed on delay.

Delay categories created by the office software can be renamed.

Delay types created by the office software can be moved to different categories.

Create Delay Create Delay


Categories Types

How to configure custom delay categories

You are able to configure site-specific delay categories, whether they are categories for English speaking or
non-English speaking sites. The example given uses configuring delay categories in Spanish, but the pro-
cedure is the same whatever the language.

You can configure delay categories using the Delay Category Finder. See your Fleet User Manual for more
information. The names of the delay categories can be changed, but if you do change any names you must
remember to use those same names in your kpisummaries.xml file.

Message types
You need to add the message types that you intend to use for your site. Message types need to be suitable for
office and field equipment messages.

Mining blocks
If your mine site uses mining blocks, you need to either create them manually or import them. This is the last
step in the creation of the mine model.

Release 4.4.x © Caterpillar 2001-2016 Page: 92 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Configuring Health
The steps for configuring Health are done in the following order.

Step Required for

Updating VIMS definitions All Health installs

Configure data retention All Health installs

Configure machines All Health installs

VIMS 3G and TPI devices


FTP Server setup for VIMS report download
only

Configuration of Health Jobs Health reporting

Update the VIMS limits confugurability All Health installs

Configure pollable channels Health realtime polling

Page: 93 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Updating VIMS definitions


VIMS definitions detail required metadata to make sense of data received from VIMS, such as event, channel
and trend names. Definition data changes on occasion when new machines or machine options are intro-
duced. Definition changes are distributed with the office software as part of the initial installation package or
through .zip upgrades to an existing install.

The office software updates VIMS definitions after the initial database creation.

NOTE: Earlier versions of the office software required


makeDataStores Health to be run separately. This is no longer required.

From time to time new VIMS definition data is available, usually as a result of new machinery or machine
options. This requires re-initialization of Health. The VIMS definition data is bundled in either an office soft-
ware .zip update or patch, and will include instructions on how to re-initialize Health. The are two approaches
that both produce the same result.

1. Run makeDataStores all. This can take a long time but ensures the entire database is consistent with
the requirements of the .zip upgrade or patch.
2. Run makeDataStores ReferenceData and
makeDataStores HealthViews. This takes a shorter amount of time by importing new VIMS definition
data and regenerating Health views.

See the post-installation instructions in the .zip upgrade or patch received for the recommended way to re-ini-
tialize Health.

Release 4.4.x © Caterpillar 2001-2016 Page: 94 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Configuring data retention


To retain optimal performance it is important to balance the need for operational data availability against com-
puting resources available. It is important to set regular data retention routines to keep data volumes within an
acceptable size for the computing resources available.

There are two routines available to assist in this goal

l Data Archiving of Health Events


l Health Data Deletion.

Things to consider when setting data retention periods

Before increasing data retention periods, a good profile of current database performance and
anticipated database performance should be known. Any anticipated performance problems
should be addressed with the database and computing resources available to the database
first. Increasing data retention periods can have a significant impact on database per-
formance, and can result in poor performance in other areas of the office software.

Any changes made to data retention periods should be made gradually, and should be mon-
itored.

For example, if you wish to increase the data retention period from two weeks to three months, it is recom-
mended that you increase it to one month, and monitor the system for a few months. If the system runs sat-
isfactorily, but your data is still not being retained for long enough, increase it to two months, and continue
monitoring.

If you increase data retention periods by a large amount there is a bigger risk that your system will be
impacted as described earlier.

To add a retention period that is not standard, see "Adding extra retention period options" in the Defining data
retention periods section.

Page: 95 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Health data retention periods


Health data retention periods are controlled by a Fleet job, Health Data Deletion, which is accessed via the
office software Jobs menu.

Health processes VIMS underscore files and stores the processed data in the historical database schema for
use by reporting. The volume of data stored is a function of:

l the number of unique pieces of equipment.


l the VIMS file types processed.
l the data retention period.

This section highlights items to check associated with data retention periods.

You need to set up and run the Health Data Deletion job to delete actual Health ’underscore file’ details.

Health Data Deletion job

Data retention periods for health data imported from VIMS report files, also known as underscore files, is con-
trolled by the Health Data Deletion job. The job can be scheduled or run as a one-off job by selecting the job
from the Jobs menu in the office software.

Health processes VIMS report files and stores the processed data in the historical database schema for use
by reporting. The volume of data stored is a function of

l the number of unique pieces of equipment.


l the VIMS file types processed.
l the data retention period.

This section highlights items to check associated with data retention periods.

You need to set up and run the Health Data Deletion job to balance ready access to data against system per-
formance.

Recommended retention periods

It is recommended that mine sites and/or Dealers maintain their own archive of VIMS files. In this case, the
maximum retention for any option would be one year.

To configure the health data deletion job, click Jobs > Health Data Deletion.

The following settings, on the Standard Options tab, are recommendations only.

Release 4.4.x © Caterpillar 2001-2016 Page: 96 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Recommended setting for Recommended setting for license free, Oracle


DataSet Type
licensed database Express Edition database

Trends and Histograms Three to 12 months Three months (Trends only)

Cumulatives Up to three years One year

Datalogs and Snapshots No longer than seven days No longer than shift

Continuous dataloggers Do not import Do not import

Page: 97 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Defining data retention periods


As mentioned earlier, Health data retention is controlled by the Health Data Deletion job in the office software.
Data retention is set on the Period Options tab.

To set Health data retention periods

1. Click Jobs > Health > Health Data Deletion.


2. On the Standard Options tab, select the file types you wish to delete. "Recommended retention peri-
ods" on page 96
3. On the Machine Options tab, select the machines from which data will be deleted. If you do not select
any machines, the data for all machines is deleted.
4. Click the Period Options tab.

Using this page you can tailor the length of time that heath data of various types will reside in the database
and therefore be available for reporting.

5. Make a selection from the Retention Period list. You can set a period either using calendar terms or
numbers of weeks. Once the jobs have been created and scheduled the jobs will be run in the Standard
Job Executor at the defined time.

Data archiving - Health Events

By default, the office software retains one year’s worth of health event data. This can be adjusted in Super-
visor with the following steps.

1. Open Supervisor.
2. Click Options > System Options.
3. From the Product drop-down list select Platform, then in the Option Sets list select System - Work-
group Extensions.
4. Select the Data Archiving tab.
5. Adjust the retention period for HealthEvent.

Release 4.4.x © Caterpillar 2001-2016 Page: 98 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Adding extra retention period options

The week-based retention period options as shipped in the product are limited to the last 1, 2, 3, 4, 12, 26, and
52 weeks, which in most cases will satisfy requirements.

When the defaults do not satisfy your needs it is possible to utilize the job configuration xml to make additional
periods available. This process is described in the following section.

Adding retention period options

1. Locate your Health Jobs .xml definition file, usually in \mstar\m-


starHome\ext\Health\Health_Management\xml
\catalogs\Jobs\Health.xml
2. Copy the file to \mstarFiles\systems\main\config\xml\catalogs\Jobs
3. Edit the contents of the copied file to contain the new periodOptions.
i. Locate the section <classdef name="Health Data Deletion">
ii. Locate the sub-section <propertygroup name="periodOptions">
iii. Add options in the following format "Last X":"Last X Weeks"
4. Save any changes you make.
5. Using Supervisor, click Tools > Toolkit ..., and from the Group list select Setup.
6. From the Tool list, select makeCatalogs, and select all of the Catalog options.
7. Click Run.

Page: 99 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

NOTE: If the Client is running you should close and restart it.

8. Start the Client, go back into the Health Data Deletion job, and ensure the options you created are avail-
able on the Period Options tab.
9. If possible run a trial job to ensure it operates correctly.

Example .xml file


Adding 6-week and 8-week retention periods

<propertygroup name="periodOptions">
<uigroupdef layout="vertical"
layoutInfo='{rowSpec="fill:default:grow"}'/>
<propertygroup name="retentionPeriod">
<uigroupdef mode="region"/>
<propertydef name="retainedPeriod" label="">
<typedef>
<type code="string" choices='{
"Year":"Year",
"Half":"Half",
"Quarter":"Quarter",
"Month":"Month",
"Week":"Week",
"Day":"Day",
"Shift":"Shift",
"Last 1":"Last Week",
"Last 2":"Last 2 Weeks",
"Last 3":"Last 3 Weeks",
"Last 4":"Last 4 Weeks",
"Last 6":"Last 6 Weeks",
"Last 8":"Last 8 Weeks",
"Last 12":"Last 3 Months",
"Last 26":"Last 6 Months",
"Last 52":"Last 12 Months"
}' />
</typedef>
<uidef widget="combo"/>
<description>
Retain data for this period. Earlier data will be deleted.
</description>

Release 4.4.x © Caterpillar 2001-2016 Page: 100 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration
</propertydef>
</propertygroup>
</propertygroup>

Page: 101 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Configuring machines
Health provides two broad categories of features; those that require interaction with Caterpillar VIMS or TPI
devices and those that are non-interactive and only require the VIMS report file. When configuring machines
for non-interactive features you can skip the steps for defining interface network addresses.

The following table illustrates the two categories, and how they relate to specific features.

Interactive Non-interactive

l Activate Snapshot
l VIMS File Import
l Activate Datalogger
l ASA Calculator
l VIMS File Download
l BusinessObjects Reports
l VIMS Clock Synchronization
l Oil Analysis Import
l Health Event Monitor

Release 4.4.x © Caterpillar 2001-2016 Page: 102 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Machine setup
Each machine that Health is to monitor, interact with or report on must be identified within the office software.
Each machine identified in the office software must have the correct machine serial number, on-board health
platform and on-board interfaces populated correctly.

Refer to the Machine Tracking chapter in the Fleet User Manual for information on using Machine Editor to cre-
ate a new machine.

Setting the machine serial number

The recorded machine serial number in machine editor must match the serial number configured onboard
VIMS which should match the actual serial number of the machine.

To check the serial number in the Machine Editor

1. Open the Machine Editor of the desired machine.


2. Ensure that the Serial No field has the correct machine serial number.

Configuring the on-board health platform

Setting the correct on-board platform determines the protocol the office software uses to communicate with
the device. This is important for channel polling and health log download features.

To check or change the on-board platform:

Page: 103 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

1. Open the Machine Editor of the desired machine.


2. Navigate to the Onboard tab.
3. Select the appropriate Onboard Health Platform from the drop-down list, depending on the installed
health monitoring devices on the machine.

Defining interface addresses

The Onboard tab on the Machine Editor page provides a section for configuring interfaces addresses for on-
board health.

NOTE: For VIMS 3G and Third Party Interface (TPI) devices, the default port of the Health interface
needs to be changed from 17000 to 51889 or the correct custom port defined by the device.

Third Party Interfaces are interfaces that are connected to a non-Caterpillar VIMS system, such as
Komatsu VHMS.

Release 4.4.x © Caterpillar 2001-2016 Page: 104 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

There are three primary on-board interfaces used for providing all office software functionality.

Required On-board inter-


On-board Health platform Point to Device
faces

HIM, TIM or RIM


Health
device

VIMS ABL with xIM HIM, TIM, or RIM


VimsWireless
device

VimsWirelessTransfer VIMS device

VIMS main A4:N4


device
VIMS 3G with xIM VimsWireless
or

VIMS A5: N2 device

Page: 105 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Required On-board inter-


On-board Health platform Point to Device
faces

VIMS main A4:N4


device
VIMS 3G with TPI VimsWireless
or

VIMS A5:N2 device

Release 4.4.x © Caterpillar 2001-2016 Page: 106 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

FTP Server setup for VIMS report download


Newer versions of VIMS, e.g. VIMS 3G, send files to an FTP Server rather than the office software retrieving
the files from an on-board FTP Server. For VIMS file downloads to function with these machines there must
be an FTP server configured on the office software server.

Windows Server 2008 R2 has a built-in FTP Server, and there are other third-party options which Caterpillar
may not necessarily support. Regardless of the choice, you must configure the FTP Server to accept con-
nections from VIMS machines and configure the VIMS machines to use the account set up on the FTP server.
VIMS will connect to the FTP server using the IP, Port, Path, Username and Password as configured through
the VIMS Communicator and upload files to the specified path. The FTP server should be configured to map
the path to the local directory where VIMS unprocessed files are processed from, typically
{MSTAR_DRIVE}\VimsFiles\unprocessed.

Page: 107 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Configuration of Health jobs


Health is kept aware of the historical health of a machine mostly through a continuous synchronization of data
received in VIMS reports, commonly referred to as VIMS files or VIMS underscore files. The synchronization
can be tailored to site, and this needs factoring in to considerations such as network load, server load, peak
and off-peak load, shift times and boundaries, data storage, database performance and historical reporting peri-
ods.

There many health jobs available for configuration and scheduling to achieve the desired outcome. These
must be configured as desired for each site. At a minimum it is suggested a regular schedule for Health Data
Deletion, VIMS File Download and VIMS Data Import should be scheduled in such a way to keep data con-
tained to a short period, say three months, while ensuring the data is less than 24 hours old.

Health Jobs

Job Name Job Description

Activates or deactivates a Datalogger on a VIMS ABL enabled


machine.

Data Logger Activate


NOTE: This job is also available for models of machines
carrying VIMS 3G devices running in either ABL or 3G
format.

Fluid Management Data Import Brings data into Health from other condition monitoring sources.

Health Data Deletion Deletes VIMS data from the office software database.

VIMS Data Import Imports VIMS files into the the office software database.

VIMS File Download Downloads VIMS data files from a VIMS ABL enabled machine.

Snapshot Activate Manually triggers a Snapshot on a VIMS ABL enabled machine.

For more information on these jobs, their templates and running the jobs, see the Concepts and Reference,
and Platform chapters in the Fleet User Manual.

Release 4.4.x © Caterpillar 2001-2016 Page: 108 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Configuring pollable channels


With VIMS 3G and TPI devices there are two approaches available to establish those channels available on
the device which are pollable.

If you use option 1 and it fails due to Fleet not supporting the file type, then use option 2.

1. Import a snapshot or datalogger that originated from the device, or


2. With the device on and in network contact execute the polled channel config setup command.

Polled Channel Config Setup Command (VIMS 3G and TPI only)


Execute the following command with the device on and within network contact (type it on one continuous
line):

mstarrun –b healthChannelSetup <MACHINE NAME #1> <MACHINE NAME #x>

When listing multiple machines, use a space between the machine names. For example,
mstarrun -b healthChannelSetup T01 T02

Machines must be powered on and in a good coverage area.

Page: 109 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Updates to the VIMS Limits configurability

NOTE: In previous versions of the office software, "Limits" were referred to as "Targets".

VIMS limits are specified in the targets.xml file. Limits configuration has been updated to include the fol-
lowing.

Type Field: This field is freehand, so you may specify any description up to 32 bytes, i.e. "Very High", "OK",
"Unacceptably Low", "very low".

However, in the web-based client only targets of type "upper", "lower" and "default" will be dis-
played.

Multi-Fleet Support: Previously the limits could only be configured for one fleet. The addition of a fleet field
allows identical trends to have different limits for different sites, i.e. Boost Pressure at Site A can be set at 120
max, Boost Pressure at Site B can be set at 130 max.

Updated for New VIMS Machines: The xml file has been updated to include most VIMS machines.

NOTE: It can be further customized to include other VIMS IDs as they become available

To modify and update the limits


1. Move the targets.xml file from mstar\mstarhome\xml\vims to
mstarfiles\systems\main\config\xml\vims (you may need to create a folder called "vims").
2. Update the required targets and run mstarrun makeDataStores ReferenceData.

Default directories for VIMS data


By default VIMS data is stored and processed in a set of directories in the root directory of the drive on which
the office software is installed. These directories need to be created manually.

\VIMSFiles\unprocessed

\VIMSFiles\processed

\VIMSFiles\badfiles

Release 4.4.x © Caterpillar 2001-2016 Page: 110 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

Files that are not set to be imported are left in the unprocessed folder. You need to ensure that you peri-
odically delete these files or move them to another folder so that issues with the system do not occur.

Using site limits in an xml file


You are able to provide your own site limits for use in an xml file. This allows you to develop new HE410
reports, in addition to those provided, by adding trend groups and trend limits into the XML files.

To do this, follow the procedure below.

1. Ensure that the latest machine trend files have been imported for the machine models that you are
defining limits for.
2. Run mstarrun makeDataStores ReferenceData. This generates the latest template xml file
in mstar\mstarFiles\systems\main\config\xml\vims.
3. Go to mstar\mstarFiles\systems\main\config\xml\vims and open site_tar-
gets.xml.template with Notepad or something similar.

The rest of these instructions are included as part of the site_targets.xml.template file -
starting at step 2 within the file.

4. Save the site_targets.xml.template file as site_targets.xml. Continue editing the


site_targets.xml file.
5. You will need the following information for editing the limits.
l The machine class the limit is for (the machine class must already exist in the office software,
otherwise the group will be ignored).
l For VIMS Trend, you will need the ID (e.g. Trend ’Lt Exh Temp (Maximum)’ has an ID of 7).
l For VIMS3/TPI trend, you will need the ID, SUB_ID (if applicable), method (MINIMUM /
AVERAGE / MAXIMUM) and condition name.
6. The examples provided in the file are commented out and will not be imported into the office software.
You need to use them as the starting point and fill in your own definitions.

The name attribute can be any arbitrary text - it is there for your reference only. The available limit types
are as follows.

Page: 111 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

l extreme lower.
l lower.
l default.
l upper.
l extreme upper.

You must enter a unit for each target value, and the unit must be compatible with the trend, e.g.
’kilopascal’ and ’pounds per inch’ are valid units for pressure trends.

7. Save the file.


8. After you have updated the file, run mstarrun makeDataStores ReferenceData again to import
the newly defined limits into the office software.

Creating measure groups for a site


You are able to provide your own measure groups for use in an xml file. This allows you to develop new HE410
reports, in addition to those provided, by adding trend groups and trend limits into the XML files.

To do this, follow the procedure below.

1. Ensure that the latest machine trend files have been imported for the machine models that you are
defining measure groups for.
2. Run mstarrun makeDataStores ReferenceData. This generates the latest template xml file
in mstar\mstarFiles\systems\main\config\xml\vims.
3. Go to mstar\mstarFiles\systems\main\config\xml\vims and open site_measure_
groups.xml.template with Notepad or something similar.

The rest of these instructions are included as part of the site_measure_groups.xm-


l.template file - starting at step 2 within the file.

4. Save the site_measure_groups.xml.template file as site_measure_groups.xml.


Continue editing the site_measure_groups.xml file.
5. You will need the following information for editing the measure groups.
l The machine class the measure group is for (the machine class must already exist in the office
software, otherwise the group will be ignored).

Release 4.4.x © Caterpillar 2001-2016 Page: 112 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Initial Fleet configuration

l For VIMS Trend, you will need the ID (e.g. Trend ’Lt Exh Temp (Maximum)’ has an ID of 7).
l For VIMS3/TPI trend, you will need the ID, SUB_ID (if applicable), method (MINIMUM /
AVERAGE / MAXIMUM) and condition name.
6. The examples provided in the file are commented out and will not be imported into the office software.
You need to use them as the starting point and fill in your own definitions.
7. Save the file.
8. After you have updated the file, run mstarrun makeDataStores ReferenceData again to import
the newly defined measure groups into the office software.

Configuring VIMS audible alarms


The office software includes an audible Client alert that can be configured to sound when a certain VIMS
Event occurs. By default, this alarm is set to be triggered when a TMAC VIMSActivate message indicating
that a level 3 event has occurred and was received in the office (eventnumber=3).

The alerts can be configured to

l include events from levels 1 or 2


l be turned off.

To add VIMS Level 1 or 2 Events

1. Go to mstar\mstarhome\xml\circuit and copy CommsAdaptor.xml.


2. Go to mstarfiles\systems\main\config\xml\circuit and paste the CommsAdaptor.xml
in this folder. (If this folder does not exist, then create it).
3. Open the xml file and navigate to the section of xml shown below:

<sink name="vimsEventNode" class="com.mincom.integ.field.nodes.VimsEventNode"


>

<var name="alarmType">VIMSEvent</var>

<var name="level">3</var>

<!-- optional -->

<!--var name="eventNumbers">[192,195]</var-->

<var name="priority">10</var>

<var name="severity">10</var>

</sink>

Page: 113 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Initial Fleet configuration

4. Modify the line in bold text (the 5th command) so that it matches the line below e.g. replace ][192,195]
with the event number that you wish to include.

<var name="eventNumbers">[888,3007]</var>

In the above example, events 888 (Engine Cool Lvl.) and 3007 (Abusive Shift) will now sound the alarm as
well as all Level 3 alarms.

5. Save the xml.


6. Restart CommsController and CommsServer.
7. Validate results by opening up the office software and waiting for these events to occur.

To Disable the Alarm

To prevent the office software sounding this audible alarm, repeat steps 1-3 above, but this time change the
level to 4 or higher. VIMS Levels are only 1,2,3 so by making the value > 3, the alarm will never sound.

For example: <var name="level">4</var>.

Release 4.4.x © Caterpillar 2001-2016 Page: 114 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Advanced Fleet configuration
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Introduction
There are numerous configuration options available that can help you to tune your office software to suit your
exact requirements. These options can affect performance, how you use the office software itself, how and
when you perform backups, etc. You do not need to configure these options to get your office software run-
ning, but you should investigate how these options can optimize your use of the software, and especially how
to best set up the backup parameters to guard against disaster or system failure.

Chapter goals
By the end of this chapter, you should be able to:

1. On an office software Server:


l Configure multiple Fleet systems based on a single installation
l Configure a client to connect to various servers
l Perform advanced configuration of CyclesKpiSummaries
l Configure the office software backup options suitable for your site
l Enable the Tape Backup interface as part of standard database exports, and verify the output
2. On a Client:
l Configure custom roles
l Configure single-page Clients

Assumptions
As well as the instructions listed in the Introduction chapter, this chapter also assumes that for some topics,
for example, KPISummaries configuration, you have a good understanding of the associated file formats and
how to work with XML and SQL.

Page: 117 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Advanced server configuration


Using multiple Fleet systems

Introduction
A standard Fleet installation consists of a single system (main) which is created as part of the installation pro-
cess. It is possible, however, to create multiple systems on a single server. These systems operate com-
pletely independently of each other and do not interfere with each other’s operation.

The files for each system are created in their own directories in the {MSTAR_HOME}/systems directory.

NOTE: Even though you can create multiple, independent systems on the same server, you can only
run one system at a time.

Creating a new system


To create a new system

1. Start Supervisor, and on the Contents menu, point to Setup and then click Setup Tools.
2. In the Setup group, select makeSystem.
3. Enter a system name and then click Run.

Configuring a new system


After a new system has been created, it must be configured before it can be used. This configuration is per-
formed using Supervisor in the same way that the original (main) system was configured. Each system has its
own configuration overrides, shortcuts, log, trace and temporary files.

To start Supervisor for a new system

1. Navigate to the system’s client shortcuts folder.


(\mstarFiles\systems\<systemName>\shortcuts\ClientDesktop)
2. Double-click the Supervisor shortcut.
You can now proceed to configure the new system.

Release 4.4.x © Caterpillar 2001-2016 Page: 118 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Running a new system


You can run a newly configured system in the same way that you run the standard system (main). The only dif-
ference is that you use the shortcuts created for the new system and not the standard system.

To start a Client against a new system

1. Navigate to the system’s client shortcuts folder.


(\mstarFiles\systems\<systemName>\shortcuts\ClientDesktop)
2. Double-click the Client shortcut and log in as usual.

Page: 119 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Using multiple servers


Typical mine sites often have a production system, which is used for the daily running of the mine, data acquis-
ition, reporting, etc., and also a test system, which is used to test new features, upgrades or patches. Rather
than reconfigure a client every time you need to change between these systems, you can set up your client to
run against whichever server you specify. This feature is also valuable if you travel between multiple sites and
need to connect to different systems.

Setting up multiple server support


To run a client against the various servers that you need to connect to, you need to run makeSystem on your
client while connected to the appropriate server, and specify a name for the system. This process creates a
pre-configured system and the appropriate shortcuts. Provided that you have the appropriate drive mappings,
you can run against any of the configured systems.

To set up multiple server support

1. Create a mapped drive to the server that you want to connect to, for example, map the P: drive to
\\<serverName>\mstarFiles.
2. Open a command shell and run the following command:
mstarrun makeSystem ABC P:\systems\main

This creates a system called ABC with the {CENTRAL_BASE_DIRECTORY} already configured. If the sys-
tem already exists, the process updates this directory.

This process also creates all the required shortcuts for the office software and Supervisor in the \sys-
tems\<systemName>\shortcuts directory. You can then copy this directory to the desktop so you can run
applications against the required system directly from desktop shortcuts.

NOTE: The \mstar\MineStar.ini file contains a reference to the build number used for each
local system.The current build for each server is stored in the MineStar.overrides file in the
shared configuration area.

Release 4.4.x © Caterpillar 2001-2016 Page: 120 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Advanced CyclesKpiSummaries configuration


KpiSummaries provides a flexible means of defining and capturing data for monitoring, summarizing and
reporting. A KpiSummaries server listens for source data of a particular type (for example, a cycle) being cre-
ated or updated. User-defined measures and dimensions are derived from this data, which can then be mon-
itored in real time through a KPI facility and stored in fact tables and dimension tables for subsequent
summarization and reporting or Business Intelligence analysis.

How Fleet uses KpiSummaries


Currently the only data accessible via KpiSummaries is production data from cycles. A CyclesKpiSummaries
server can be added as a service to a Fleet system, and the configuration of this service is defined in an XML
document.

The document consists of standard XML files shipped with Fleet and merged with custom XML files tailored to
suit your site’s particular requirements. The standard file cycleskpisummaries.xml contains the basic
structure of the definition, and all subsequent standard and custom files are merged into that base file. This is
done dynamically whenever the server CyclesKpiSummaries or the utility makeDataStores is started. The res-
ulting merged file is written to the system’s temp directory as the file mergedkpisummaries.xml.

The KpiSummaries definition consists of:

l Source data (currently cycles)


l Dimension tables and their dimension attributes
l Lookup tables and their columns
l Fact tables and their dimension references, lookup references, details and measures
l Calculated members for the definition of KPIs
l Summaries to provide aggregation
l Real-time KPIs

When the KpiSummaries definition is complete, the fact, dimension and lookup tables must be created and
the lookup tables loaded before a KpiSummaries server can be started.

The CyclesKpiSummaries server should be started before any cycle engine, for example, the CycleGen-
erator, so that it does not miss any cycles. When a cycle is created, the CyclesKpiSummaries server uses
the new cycle to locate any referenced dimensions (creating rows if necessary), look up entries in lookup
tables, create the details and measures and then write out a new row for each fact table. If a cycle is updated
after the cycle was created, for example by the arrival of a field message such as a Cycle Report, or by

Page: 121 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

someone editing a cycle using the Cycle Assistant, then the same process is repeated but the fact rows are
updated rather than created.

After the fact entries have been created or updated, they are passed to the RealtimeKpi engine for evaluation
of all the defined real-time KPIs. If this causes a KPI to change value, the KPIs are broadcast to the registered
listeners. Listeners include the Fleet Update Assistant, some Dynamic Mine Model Services and a real-time
KPI display page.

If the CyclesKpiSummaries server was not running while cycles were being created or updated, or if the defin-
itions need to be changed retrospectively, you can recalculate the fact table entries for those cycles by using
recalcCyclesKpiSummaries. See Working with KpiSummaries for details on working with this application.

Standard and Custom definition files


Fleet ships with a standard set of definition files, which are dynamically merged with your own custom defin-
ition files to produce the operational KpiSummaries definition. This section explains how the merging process
works and the tools available to help you create custom files that work well with the standard files provided.

Standard files

The Supervisor's KpiSummaries Configuration page shows you the list of standard files, which you cannot
change, as well as the list of custom files that you provide. The first file, cycleskpisummaries.xml, con-
tains the basic structure of the overall definition as described in the next section, KpiSummaries definition.
This base file also contains comments that allow you to better control where elements from subsequent files,
(standard and custom), are inserted into the merged document. A separate standard file contains a set of
standard realtimeKpis, and there are also separate standard files containing various system features, for
example, FuelMonitoringKpis.

Custom files

A custom file enables you to modify elements of previous files or to add new elements. It needs to have the
same basic structure as the base file, i.e. everything has to be contained in the root element
<kpiSummaries>, so that it is clear where the custom elements are to be inserted or where to find an ele-
ment to be modified. For example, if you wish to add a dimensionAttribute named newProperty to the
machine dimension, you would provide the following in a custom file:

<kpiSummaries>

...

Release 4.4.x © Caterpillar 2001-2016 Page: 122 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

<dimension name="machine">

<dimensionAttribute name="newProperty" expr="…/>

</dimension>

...

</kpiSummaries>

Note that you need to provide the name attribute of a structure element in case there are multiple elements of
that type, for example, name="machine" to identify which dimension you wish to add to. You may also
have to provide an "if" attribute as well.

When inserting a new element, you may need to include an extra attribute insert="comment" to cause
insertion to be just before the "comment" within the parent element. This is particularly the case when insert-
ing a measure, of which there are many. If you don't, the measure will be inserted before the "custom meas-
ure" comment, and sometimes you need a measure to be defined before a measure which references it.

For example, you might define a new "timeBucket" measure and want to refer to it in a modified "time"
measure. If you don't include an insert="custom timeBucket" in your new "timeBucket" measure,
it will be inserted at the end of the measures, whereas it has to be defined before being referenced in the "time"
measure.

You can also include a replace="true" attribute in a custom element if you wish the custom element to
replace the element as-is, rather than merging it. This is designed to enable realtimeKpis to be re-imple-
mented.

An element can be marked with the reserved attribute to prevent it from being modified. This has been
used to ensure that some elements required to support some system services are not accidentally modified.

Custom files must be located in the mstarFiles/system/main/config/xml/cycles directory and lis-


ted in Supervisor's KpiSummaries Configuration page. See the "Setting up CyclesKpiSummaries" section in
the "Initial Fleet configuration" on page 48

Notes on customization

1. Caterpillar does not support, and are not responsible, for any views, scripts, queries or customizations
created by customers over the "Standard" Historical database.
2. The success of the execution of the view script you create over the KPISummary depends on how the
script has been created.

Page: 123 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

3. Table additions need to be added to the xml and are not supported as script additions like additional
views. If you need to make changes to the KPI database, it is recommended that you update the
KpiSummaries.xml file so that the changes are saved after updating.
4. You should create a directory in which to store views, scripts, queries or customizations, for example
D:/mstarFiles/systems/main/config/<Site>SpecificConfigurations. This location is temporary, and all
updates should be done in consultation with Caterpillar, and should occur in the KPIsummaries.xml
file.

Merged File

It will now be obvious that you need to know what the base and other standard files look like in order to prop-
erly merge your custom files into them. So that you don't have to go searching for them and also that you can
see what happened in the merging process, the system writes out the resulting merged file whenever dynamic
merging occurs (i.e. whenever the CyclesKpiSummaries server or the makeDataStores utility starts). It is writ-
ten to the mstarFiles/system/main/tmp directory and is named mergedKpiSummaries.xml

The merged file is annotated with information showing you how each element was derived. This is done with:

1. a legend near the start of the file that lists all the files that took part in the merge and their positional
order.
2. special zzz attributes added to elements that were added or modified.

Here is an example of a legend:

<!-- zzz legend

0 = ...\xml\cycles\standard\cycleskpisummaries.xml

1 = ...\xml\cycles\standard\standardRealtimeKpis.xml

2 = ...\xml\cycles\standard\fuelMonitoringKpis.xml

3 = …\config\xml\cycles\xxxkpisummaries.xml

and here is an example of a zzz attribute:

<realtimeKpi name="trucksLoaded"… zzz="[+1,3]">

which means that the trucksLoaded realtimeKpi was added by standardRealtimeKpis.xml and mod-
ified by xxxkpisummaries.xml. If the realtimeKpi definition in xxxkpisummaries.xml was the same as
in standardRealtimeKpis.xml, the zzz attribute would have been zzz="[+1,=3]". Elements
unchanged from the base file or those that arise because of the insertion of an ancestor element, do not score
a zzz attribute.

Release 4.4.x © Caterpillar 2001-2016 Page: 124 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Difference File

To help upgrade an old KpiSummaries definition file to be a custom file suitable for use with the standard defin-
ition files, the system writes out a difference file that is the last custom file minus any elements that are the
same as in the previous files. All that remains to be done is to clean up the file, e.g. remove comments that are
no longer relevant), and you may add some insert attributes in order to fix up any badly positioned ele-
ments. The difference file is written to the mstarFiles/system/main/tmp directory and is named
diffKpiSummaries.xml.

This technique can also be used to factor out further common parts of custom files for different sites of the
same company, allowing a company-standard file to sit above each of the site-dependent files.

Generation of definition segments

An mstarrun target has been developed to generate some commonly used segments of KpiSummaries
definition files. This is most useful when developing the custom definition files for a new site. This process
should be undertaken after the system model has been set up, as should be clear from the following table,
which shows what can be generated and where the information came from.

Type What is generated Source of information

Dimension attributes in the block dimension


BlockHierarchy giving names of parts of the MiningBlock MiningBlockImporter configuration
hierarchy for mining blocks

Dimension attributes in the block dimension


StockpileHierarchy giving names of parts of the MiningBlock MiningBlockImporter configuration
hierarchy for stockpiles

TimeBucket measures derived from the


TimeBucket Delay categories
defined Delay Categories

TimeBucket measures derived from the


SmuTimeBucket defined Delay Categories using Smu dur- Delay categories
ations

Page: 125 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Type What is generated Source of information

Measures defining Grade Value, Grade


Grade Product and Parent Product for all the con- Continuous Grades
tinuous Grades

Duration measures for each of the activities


AuxActivity Auxiliary machine activities
defined for auxiliary machines

Duration measures for each of the activities


SmuActivity defined for auxiliary machines using SMU Auxiliary machine activities
durations

Since the generator gets some model information, (Grades and Machine activities), from the server,
MineTracking must be running to generate those types of entries. To run the generator, use the command:

mstarrun generateKpiSummaries <type>|all [Output file]

where <type> is any of the Types in the above table and all generates all types of entries.

The mstarrun generateKpiSummaries command generates a measure name from the category name. There is
no strict limit to the length of the delay category name, but there are practical limits - a practical restriction of
32 characters is advisable.

Creating a Custom Time Usage Model (TUM) by modifying the KPI Sum-
maries definition file
As there is no single Time Usage Model (TUM) that satisfies all business requirements, customised TUMs
can be created for each customer. This is done by creating custom measure definitions based on the client’s
own TUM, which provides a site specific KPI Summaries definition that satisfies the clients specific require-
ment.

The existing Fleet measure definitions (stored in the compulsory definition file) should be ignored when cre-
ating a customised TUM. If a measure name occurs in both the existing Fleet TUM and the client’s TUM, it is
advisable to redefine the measure in a custom definition, and including a replace element in the measure defin-
ition, for example:

Release 4.4.x © Caterpillar 2001-2016 Page: 126 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

<measure name="totalTime" expr="main.operatingTime + main.timeScheduled +


main.timeUnscheduled + main.timeStandby" replace="true" unitType="duration"
category="time"/>

The above example uses operatingTime, this term has an immutable definition within the Fleet system
and is also a name often used in alternate TUMs. It is important not to redefine operatingTime when a con-
flict arises. A possible solution is to include the same name but prefixed with a site or customer specific code.

The following extract identifies additional measures from the compulsory definition that rely on previously
defined measures.

<!-- Delay measures additional fields -->

<measure name="downStoppagesCount" expr="main.scheduledDownCount + main.un-


scheduledDownCount" unitType="unitless" category="delay"/>

<measure name="allStoppagesCount" expr="main.standbyCount + main.sched-


uledDownCount + main.unscheduledDownCount" unitType="unitless" cat-
egory="delay"/>

<!-- Time measures Level 3 -->

<measure name="delayTime" expr="main.operatingDelayTime + main.nonOper-


atingDelayTime" unitType="duration" category="delay"/>

<!-- Time measures Level 2.5 -->

<measure name="operHoursSeconds" expr="main.operatingTime + main.delayTime"


unitType="duration" category="time"/>

<!-- Time measures Level 2 -->

<measure name="availableTime" expr="main.operatingTime + main.standbyTime +


main.delayTime" unitType="duration" category="delay"/>

<measure name="downTime" expr="main.scheduledDownTime + main.un-


scheduledDownTime" unitType="duration" category="delay"/>

<!-- Time measures Level 1 -->

<measure name="totalTime" expr="main.availableTime + main.downTime" unitType-


e="duration" category="time"/>

Page: 127 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Problems may occur if the custom measure definitions contain expressions based on previously defined
measures (typically found in the Delay Measures Additional Fields and the Time Measures
Level xx.xx sections of the compulsory definition file), for example:

<!-- Delay measures additional fields -->

<measure name="downStoppagesCount" expr="main.scheduledDownCount + main.un-


scheduledDownCount" unitType="unitless" category="delay"/>

<measure name="allStoppagesCount" expr="main.standbyCount + main.sched-


uledDownCount + main.unscheduledDownCount" unitType="unitless" cat-
egory="delay"/>

<!-- Time measures Level 3 -->

<measure name="delayTime" expr="main.operatingDelayTime + main.nonOper-


atingDelayTime" unitType="duration" category="delay"/>

<!-- Time measures Level 2.5 -->

<measure name="operHoursSeconds" expr="main.operatingTime + main.delayTime"


unitType="duration" category="time"/>

<!-- Time measures Level 2 -->

<measure name="availableTime" expr="main.operatingTime + main.standbyTime +


main.delayTime" unitType="duration" category="delay"/>

<measure name="downTime" expr="main.scheduledDownTime + main.un-


scheduledDownTime" unitType="duration" category="delay"/>

<!-- Time measures Level 1 -->

<measure name="totalTime" expr="main.availableTime + main.downTime" unitType-


e="duration" category="time"/>

When adding additional measures it is important to make sure all measures have been defined before they are
referenced. For example, two measures that often require redefinition are availableTime and totalTime.
These measures appear in the Time measures Level 2.5 section of the compulsory definition. If they are
replaced in a custom definition, then any components of the expression must be inserted prior to the original
section, in this case in the custom timeBucket.The insert element is used to place a measure relative to a
comment in the compulsory file.

Release 4.4.x © Caterpillar 2001-2016 Page: 128 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

In general, time measure components that are going to be used in a replacement definition of a predefined time
measure should be inserted in the custom timeBucket section.

Look at the following generated segment:

<!-- Delay measures -->

<measure name="mantenimientoNoProgramadoTim" expr-


='cycle.allDelays.getDurationByCategory("Mantenimiento No Programado")'
unitType="duration" category="delay" insert="custom timeBucket"/>

<measure name="noProgramadaMantenimientoTim" expr-


='cycle.allDelays.getDurationByCategory("No Programada Mantenimiento")'
unitType="duration" category="delay" insert="custom timeBucket"/>

<measure name="programadaProcesoTime" expr-


='cycle.allDelays.getDurationByCategory("Programada Proceso")' unitType-
e="duration" category="delay" insert="custom timeBucket"/>

<measure name="programadaMantenimientoTime" expr-


='cycle.allDelays.getDurationByCategory("Programada Mantenimiento")' unitType-
e="duration" category="delay" insert="custom timeBucket"/>

<measure name="noProgramadaProcesoTime" expr-


='cycle.allDelays.getDurationByCategory("No Programada Proceso")' unitType-
e="duration" category="delay" insert="custom timeBucket"/>

<measure name="standbyTime" expr='cycle.allDelays.getDurationByCategory("Stand


By")' replace="true" unitType="duration" category="delay" insert="custom
timeBucket"/>

<measure name="timeScheduledMaintenance" expr-


='main.programadaMantenimientoTime' unitType="duration" category="time" inser-
t="custom timeBucket"/>

<measure name="timeScheduledProcess" expr='main.programadaProcesoTime'


unitType="duration" category="time" insert="custom timeBucket"/>

<measure name="timeStandby" expr='main.standbyTime' unitType="duration" cat-


egory="time" insert="custom timeBucket"/>

Page: 129 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

<measure name="timeUnscheduledMaintenance" expr-


='main.noProgramadaMantenimientoTim + main.mantenimientoNoProgramadoTim'
unitType="duration" category="time" insert="custom timeBucket"/>

<measure name="timeUnscheduledProcess" expr="main.noProgramadaProcesoTime"


unitType="duration" category="time" insert="custom timeBucket"/>

<measure name="timeScheduled" expr="main.timeScheduledMaintenance + main.-


timeScheduledProcess" unitType="duration" category="time" insert="custom
timeBucket"/>

<measure name="timeUnscheduled" expr="main.timeUnscheduledMaintenance + main.-


timeUnscheduledProcess" unitType="duration" category="time" insert="custom
timeBucket"/>

<measure name="timeProcess" expr="main.timeScheduledProcess + main.-


timeUnscheduledProcess" unitType="duration" category="time" insert="custom
timeBucket"/>

<measure name="timeMaintenance" expr="main.timeScheduledMaintenance + main.-


timeUnscheduledMaintenance" unitType="duration" category="time" insert="custom
timeBucket"/>

<measure name="mantenimientoNoProgramadoCou" expr-


='cycle.allDelays.getCountByCategory("Mantenimiento No Programado")' unitType-
e="unitless" category="delay" insert="custom timeBucket"/>

<measure name="noProgramadaMantenimientoCou" expr-


='cycle.allDelays.getCountByCategory("No Programada Mantenimiento")' unitType-
e="unitless" category="delay" insert="custom timeBucket"/>

<measure name="programadaProcesoCount" expr-


='cycle.allDelays.getCountByCategory("Programada Proceso")' unitType-
e="unitless" category="delay" insert="custom timeBucket"/>

<measure name="programadaMantenimientoCount" expr-


='cycle.allDelays.getCountByCategory("Programada Mantenimiento")' unitType-
e="unitless" category="delay" insert="custom timeBucket"/>

Release 4.4.x © Caterpillar 2001-2016 Page: 130 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

<measure name="noProgramadaProcesoCount" expr-


='cycle.allDelays.getCountByCategory("No Programada Proceso")' unitType-
e="unitless" category="delay" insert="custom timeBucket"/>

<measure name="standbyCount" expr='cycle.allDelays.getCountByCategory("Stand


By")' replace="true" unitType="unitless" category="delay" insert="custom
timeBucket"/>

<measure name="countMaintenanceDelays" expr="main.mantenimientoNoProgramadoCou


+ main.noProgramadaMantenimientoCou" unitType="unitless" category="delay"
insert="custom timeBucket"/>

The measure timeScheduledMaintenance in the example above will most likely to be a component of the
complex measure delayTime, this measure in turn is likely to be redefined in terms defined by the site TUM
in the custom definition:

<measure name="delayTime" expr="main.timeScheduled + main.timeUnscheduled +


main.standbyTime" replace="true" unitType="duration" category="delay"/>

The general rule to apply in this situation, is to only define additional measures needed to support expressions
required in the Summary Table definition. Complex measure definitions add to the complexity of the defin-
ition files and can be constructed in reports as required.

<!-- Summary Table -->

<summary name="calendarFigures" fact="main" desc="These numbers are summarised


to Calendar Periods.">

<measureRef name="payload" stat="sum" measure="payload"/>

<measureRef name="downTime" stat="sum"/>

<measureRef name="operatingTime" stat="sum"/>

<measureRef name="operHoursSeconds" stat="sum"/>

<measureRef name="unscheduledDownTime" stat="sum"/>

<measureRef name="scheduledDownTime" stat="sum"/>

</summary>

Page: 131 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Suggested Steps:

1. Use the supplied utility to generate definition segments for all available types.
2. Insert the generated segments into a blank custom definition file, excluding any time bucket measures.
3. Validate all measures and dimensions in the custom definition except for the time measures.
4. Use IPretend to test the custom definition.
5. Add the generated time measure segments to the custom definition file. Only include derived measures
to support entries in a summary definition.

Creating a Custom Time Usage Model (TUM) using the office software
KPI configuration tool

This feature is designed for creating a time usage model for NEW sites, not for updating the
model at existing sites. As this feature has a direct impact on production recording it should
be configured by MineStar deployment or support personnel only.

From release 4.0, you are able to use the Time Usage Model page in the office software to build the model
graphically and then export the model as a generated piece of XML. This can then be incorporated into and
used by the CyclesKpiSummaries engine.

Prerequisites

Before creating a new model you need to define the name of the XML file that will hold the XML representation
of the Time Usage Model to be built using the Time Usage Model Editor, set up delay categories, and set up
all machine activities.

Defining the XML file name

1. Stop the MineStar Services.


2. Open Supervisor.
3. Click Options > System Options.
4. From the Product drop-down list select Production, and from the Option Sets list select KpiSum-
maries Configuration.
5. Clear the timeBreakdown.xml check box as you will generate this content rather than using the stand-
ard XML.

Release 4.4.x © Caterpillar 2001-2016 Page: 132 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

6. In the Custom Definition Files text box type the name of the XML file you will be exporting the model
into.
7. Click Apply to apply and save your changes.
8. Start the MineStar Services.

Delay Type and Category setup

You must ensure all delay types and categories are configured properly with their associated delay types
using the Delay Category Editor and the Delay Type Editor. See your Fleet User Manual for information on
these pages.

Machine Activity setup

You must ensure that all machine activities, (machine states), are configured properly using the Machine
State Finder and Machine State Editor, including all Auxiliary machine states. See your Fleet User Manual for
information on these pages.

Creating a new time usage model

Time usage models are created using the client office software. The Time Usage Model Finder is an Expert
Mode page, and can be found by clicking Contents > Platform > Time Usage Model Finder.

When you have created some time usage models, they will display on the Time Usage Model Finder page.

You can click Apply to save you changes and continue, or Save to save your changes and exit the Time
Usage Model Editor at any time.

Creating a time usage model

1. Open Time Usage Model Finder.


2. Click New.

Time Usage Model Editor opens, displaying the following panels.

l The top left panel is the Model Hierarchy Editor, which shows the model as a tree view.
l The top right panel is the Model Attributes Editor.
l The bottom panel shows a graphical representation of the structure of the time usage model. This only
updates when a node in the tree is selected.

When you expand the New Model icon in the Model Hierarchy Editor panel, the default structure displays as
shown below.

Page: 133 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

A description of each node follows.

1. A single Grouping node called Total Time.


2. A group of Composition nodes, one for each Delay Category defined in the system. A Delay Com-
position is represented by the red icon with the white cross. Each Delay Composition has all of the
Delay Types represented as a node beneath it. Delays display in the bottom panel in the colors con-
figured in the Delay Category Finder.
3. An empty KPI Entries node with no sub-nodes.
4. An empty KPI Custom Measures node with no sub-nodes.
5. An empty Category Names node with no sub-nodes.

Once a node in the tree is selected, the visual representation of the model is displayed in the bottom panel.

Adding a new category

Elements of the model can be allocated a category within the model.

1. In the node tree, right-click Category Names, then click Add Category.
2. Enter the Name of the category. The new category displays in the tree.

Release 4.4.x © Caterpillar 2001-2016 Page: 134 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Any node in the tree that has a ’category’ attribute now shows this category in the drop-down list. New cat-
egories are represented by .

NOTE: Categories are not stored in the database on their own, but as part of the element they are
attached to, so unless the category is selected on a grouping or composition node it will be lost after
closing the model.

Adding a new grouping

New groupings, represented by , can only be added either to the model (root node) or to other grouping

nodes. The default model only has a single grouping.

1. Right-click on either the model or a sub-grouping node and click Add Grouping.

A new node is created in the model directly under the node you selected. The attributes for the node are dis-
played in the right panel. Double-clicking an attribute allows you to edit the value.

2. The unitType defaults to duration, but you can click in the Attribute Value cell and on the drop-down
list select either unitless or volume.
3. Click the categoryName attribute value field and select a value from the drop-down list to attach the
Group node to the relevant category.
4. Change the description to be something meaningful, as this is displayed in the model representation
in the bottom panel.
5. Change the name of the grouping to something meaningful.
l Prefix the name with at least two uppercase letters. It is a good idea to use the customer / mine
site code.
l If you are generating SMU times the grouping name cannot be greater than 23 characters.
l If you are not generating SMU times the grouping name cannot be greater than 25 characters.
These restrictions are because the names will be suffixed with Count or Smu Time.

The new grouping may cause the model display in the bottom panel to render incorrectly. This is because the
model must fulfill the following criteria.

l Each grouping must have more than one sub-grouping beneath it or a sub-composition.
l Each composition must have at least one measure (delay or activity type) beneath it.

Adding a new composition

Page: 135 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration
Compositions can be either Delay compositions or Activity compositions . Delay compositions are

implicitly added to the model and cannot be deleted. Only Activity compositions can be added.

1. Right-click on a Grouping node and select Add Composition.

The composition displays as selected in the tree and its attributes display in the top right panel. Double-click-
ing an attribute allows you to edit the value.

2. The unitType defaults to duration, but you can click in the Attribute Value cell and on the drop-down
list select either unitless or volume.
3. Click the categoryName attribute value field and select a value from the drop-down list to attach the
Group node to the relevant category.
4. Change the description to be something meaningful, as this is displayed in the model representation
in the bottom panel.
5. Change the name of the grouping to something meaningful.
l Prefix the name with at least two uppercase letters. It is a good idea to use the customer / mine
site code.
l If you are generating SMU times the grouping name cannot be greater than 23 characters.
l If you are not generating SMU times the grouping name cannot be greater than 25 characters.
These restrictions are because the names will be suffixed with Count or Smu Time.

Adding a new activity measure

1. Activity measures, represented by , correspond to the activities or machine states in the system.

You can add Activity measures to either Delay or Activity compositions.


2. Right-click on a Composition and select Add Activity Measure.
3. Set the activityType attribute in the right panel. The name attribute will automatically be set when you
move off the node.
4. Select the check boxes for the equipment type this activity relates to. This determines the "if" state-
ment in the generated xml, i.e. if="truck".

Organizing the hierarchy structure

As you build up the model with new Groupings and Compositions, the nodes can be dragged and dropped onto
each other to build up the hierarchy with the following restrictions.

l Grouping nodes, , can be dropped onto other Grouping nodes or the root model node, but not onto

other Composition or nodes.

Release 4.4.x © Caterpillar 2001-2016 Page: 136 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

l Composition nodes can be dropped onto other Grouping nodes,i.e. moved from one Grouping node to
another.

An example hierarchy is described below.

The screenshot below shows three Grouping nodes at the same level, and all Composition nodes under the
’ABC_Total’ node.

By dragging the Composition nodes and dropping them onto either the ABC_Available or ABC_Down nodes
you can begin to build the structure to resemble the following.

Page: 137 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

To modify the ABC_Total grouping so that it is composed of ABC_Available and ABC_Down times, drag and
drop ABC_Available on to ABC_Total. Then drag and drop ABC_Down onto ABC_Total. The structure should
now resemble the following.

Release 4.4.x © Caterpillar 2001-2016 Page: 138 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Note that the hierarchy displays in the bottom panel and reflects the changes you make. Colors have been
added to the Groupings for clarity.

When the KPI Summaries XML is generated this structure now indicates the following.

l ABC_Total = ABC_Available + ABC_Down


l ABC_Available = ABC_Productive + ABC_Standby
l ABC_Down = ABC_Automatic_Delay + ABC_Accident + ABC_Site_Awareness + ABC_
Production_Delay + ABC_No_Sched_Prod +ABC_Prev_Maint + ABC_Breakdown

This hierarchy can be subdivided down to a level of one Activity Composition per Activity + one Delay Com-
position per Delay Category if necessary to allow for quite fine-grained time data capture.

Page: 139 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Embedded variable mapping

Within CyclesKpiSummaries there are certain embedded variables that need to be present so that the system
can function correctly. This includes the embedded dashboard displays. These embedded variables must
have values assigned to them from the custom time usage model so that the system functions correctly. This
is effectively just mapping the custom model across to the embedded model. This is done simply by dragging
and dropping Grouping , Delay Composition Activity Composition or Activity Measures

onto the nodes under 'Embedded Variable Mappings' to create a pointer to the original element of the hier-
archy. e.g. ABC_Total is obviously equivalent to 'totalTime' so if you drop ABC_Total onto totalTime you get
the following.

Likewise, ABC_Available is equivalent to availableTime to give the following.

Release 4.4.x © Caterpillar 2001-2016 Page: 140 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Adding a KPI entry

KPI entries are additional entries that can be calculated entries based on other parts of the time usage model
hierarchy.

1. Right-click on the KPI Entries node and select Add KPI Entry.
2. Change the name to be something meaningful.
3. Change the description to be something meaningful.
4. Add a categoryName if necessary.

To build the expression for the KPI entry

The following process gives an example of building an expression for the KPI entry.

1. Double-click the Attribute Value cell beside the expression field in the right pane to display the
expression builder.

The expression builder lists all of the Functions, Internal Variables, Groups, Activities, KPIs and Custom
Measures that are currently available to the model.

Page: 141 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

2. When building a function, drag a function from the left pane to the Expression pane. The expression
will expand to a Jython template as in the following when the 'if' function is dragged across

Each $ prefixed variable is a place holder for a variable. In the screenshot above, if $var1 is greater than $val1
then the result is the calculation represented by $calc.

3. Highlight the $var1 text and delete it.


4. Select the Groups option to display the list of Groupings and Compositions in the hierarchy.

Release 4.4.x © Caterpillar 2001-2016 Page: 142 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

5. Select a Grouping (in this case ABC_Total) and drag it across to the Expression pane. Drop it just
after the if leaving a space. The ABC_Total grouping expands to its expression name of main.ABC_
Total, as shown below.

6. Highlight the $val1 text and replace it with the value 0 (zero).
7. Highlight the $calc text and delete it.
8. Select another grouping (in this case) ABC_Available Grouping and drag it to the Expression pane.
Drop it just after the = leaving a space as shown below.

9. If you wish to divide the Available time by the Total time, add a / just after ABC_Available then select
and drag the ABC_Total Grouping to the right pane and drop it just after the / as shown below.

Page: 143 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

10. Click OK. The expression displays in the expression cell of the attributes pane. These expressions will
be added to the expr attribute within the XML.

To add a KPI measure

KPI Custom Measures are additional entries that can be calculated entries based on other parts of the time
usage model hierarchy.

1. Right-click on the KPI Custom Measrues node and select Add KPI Custom Measure.
2. Change the name to be something meaningful.
3. Change the description to be something meaningful.
4. Add a categoryName if necessary.

The expression can be built in the same was as described for KPI entries.

Generate the KPISummaries xml file

The KPI summaries xml that is generated is a subset of the KPI Summaries xml. This xml is merged with the
other standard KPI .xml files to produce a single definition that is loaded when CyclesKPISummaries is star-
ted. When the xml is generated from the model, the validateKpiSummaries script is invoked which merges the
files and displays any validation warnings on the merged content.

To generate the KPISummaries.xml

1. Click the Export and Validate button.

Release 4.4.x © Caterpillar 2001-2016 Page: 144 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

You are asked for the file name to export to. This must be the name of the file you specified
earlier in Supervisor, otherwise you will receive a warning message and validation will not
occur.

When the export is complete, a screen similar to the one below displays.

l The left pane displays the Generated xml that corresponds to your model definition.
l The middle pane displays the Merged xml.
l The right pane displays any Validation messages that have occurred as a result of running val-
idateKpiSummaries.

You must correct all error messages so that the right pane displays 0 errors.

Reverse validation of the model

The Reverse Validate button allows for the reverse validation of the stored generated XML against the current
state of the Time Usage Model. This is to highlight any problems where the XML may have been inadvertently
modified directly rather than modifying the model and regenerating the XML.

Never modify the generated XML directly.

Page: 145 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

To perform a Reverse Validation

1. Click the Reverse Validate button.


2. When prompted, select the previously generated XML file and click Import Model XML.One of the fol-
lowing messages displays.

3. Click OK to close the message.

Export the xml to Microsoft Excel

Ensure you have defined the xml file name as described in the Prerequisites section, "Defin-
ing the XML file name" on page 132 procedure before exporting to Excel.

1. Click the Export to Excel button.


2. Select the location of where you wish to save the file.
3. Click Save.

Delay and Activity Modifications

Since the Time Usage Model is reliant on the definitions of Delay Categories and Machine Activities it is
necessary, when modifying these entities in the system, to revisit the Time Usage Model and possibly regen-
erate the KPISummaries.xml along with running mstarrun makeDataStores.

When deleting a Delay Category or Activity, references to these entities in the Time Usage Model will also be
removed and you are warned that the Time Usage Model must be revisited.

Release 4.4.x © Caterpillar 2001-2016 Page: 146 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

If new Delay Categories are added to the system, the next time the model is opened the new Delay Com-
position will appear in the model in its default position under the root Grouping. This can then be placed in the
correct position within the hierarchy and you can regenerate KPISummaries.xml and re-run mstarrun
makeDataStores.

If the name of the Delay Category is changed it will automatically be reflected in the Time Usage Model but
this will not be the case for CyclesKpiSummaries until the XML has been regenerated from the model and an
you run mstarrun makeDataStores.

Page: 147 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Creating and Modifying KPISummaries.xml


When deploying a new instance of Fleet for a new customer, it is necessary to create a custom KPI Sum-
maries xml document for that site. This xml file is used to create the data structure for reporting KPI Sum-
maries, and ensures that this is customized and specific to that particular site.

The custom xml file is based off the reference implementation tcmkpisummaries.xml file and XML fragments
for editing can be generated from the following mstarrun target:

mstarrun generateKPISummaries

This file needs modifying to reflect customer requirements in the following areas:

l Mining block hierarchy


l Time breakdown
l Materials and material hierarchy

These are covered in separate sections below.

Mining block hierarchy

The mining block hierarchy can contain between one and four levels of hierarchy within Fleet.

The system-generated fragment for this contains three levels of hierarchy as shown in the table below, the low-
est (child) level of hierarchy being first in the xml block (line 2) and its parents following on subsequent lines.

NOTE: Line numbers (left column) have been included for reference only.

Line XML

1 <dimension name="block" context="b">

dimensionAttribute name="bench" expr='{if len


2 (b.hierarchy.split(":")) >
0:\n _res=b.hierarchy.split(":")[-1]}'/>

Release 4.4.x © Caterpillar 2001-2016 Page: 148 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Line XML

<dimensionAttribute name="cut" expr='{if len


3 (b.hierarchy.split(":")) >
1:\n _res=b.hierarchy.split(":")[-2]}'/>

<dimensionAttribute name="pit" expr='{if len


4 (b.hierarchy.split(":")) >
2:\n _res=b.hierarchy.split(":")[-3]}'/>

5 </dimension>

In order to edit the mining block hierarchy, the user must first define the number of levels of hierarchy used for
that mine. Based on the levels of hierarchy that exist in the mine, the following edits should be made to the
file:

Hierarchy
Modification required
Levels

1 Delete lines 3 and 4.

2 Delete line 4.

3 No change.

Add a line after line 4 as follows:

<dimensionAttribute name="name" expr='{if


4
len(b.hierarchy.split(":")) >
3:\n _res=b.hierarchy.split(":")[-4]}'/>

Once the fragment has been edited to reflect the correct number of hierarchy levels, the
dimensionAttribute name for each level in the hierarchy should be edited to reflect that particular site.

The mining block hierarchy fragment has now been successfully edited.

Time breakdown

The reference implementation fragment for time breakdown contains a number of definitions, which are
required by the system. These should not be deleted, however if they are not to be used by the customer, they
should be bundled together in an area within the file which is highlighted by appropriate comments. The

Page: 149 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

reference implementation fragment also contains the base level definitions so that all other levels of the time
breakdown hierarchy can be aggregated from these.

The syntax for a time breakdown is as follows:

<measure name="delayTime"
expr="main.scheduledOperationsTime + main.unscheduledOperationsTime"
unitType="duration" category="delay" insert="custom timeBucket"/>

The unitType can be defined as "duration" for a time duration or "unitless" for a count of events of that
nature. The category can also be used to group categories together. Any levels of time breakdown hierarchy
should be made clear within the system by appropriate use of comments.

Materials and hierarchy

Materials and material hierarchy should also be defined within the custom KPISummaries.xml file for the cus-
tomer. These include the following:

l Grade Values
A grade value that is associated with the Mining Block being extracted and is then associated with the
truck cycle, e.g. 1.5 grammes of gold per tonne.
l Grade Products
The Grade Value multiplied by the Payload.
l Parent Product
If Grade Value is populated then this equals the payload, else if Grade Value is not populated then this
value is zero.

These elements are to be defined within the XML file as follows.

<!-- Grade Values -->

<measure if="truck" name="gradeValueCU" expr='cycle.sourceGradesMined.getGradeValueByName


("CU")' unitType="ratio" unit="percent" category="grade" insert="custom grade"/>

<measure if="truck" name="gradeValueMB" expr='cycle.sourceGradesMined.getGradeValueByName


("MB")' unitType="ratio" unit="relative" category="grade" insert="custom grade"/>

<!-- Grade Products -->

<measure if="truck" name="gradeProductCU" expr-


='cycle.sourceGradesMined.getGradeFractionByName("CU") * main.payload'
unitType="mass" category="grade" insert="custom grade"/>

Release 4.4.x © Caterpillar 2001-2016 Page: 150 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

<measure if="truck" name="gradeProductMB" expr-


='cycle.sourceGradesMined.getGradeFractionByName("MB") * main.payload'
unitType="mass" category="grade" insert="custom grade"/>

<!-- Parent Product -->

<measure if="truck" name="parentProductCU" expr-


='cycle.sourceGradesMined.haveGradeFractionByName("CU") * main.payload'
unitType="mass" category="grade" insert="custom grade"/>

<measure if="truck" name="parentProductMB" expr-


='cycle.sourceGradesMined.haveGradeFractionByName("MB") * main.payload'
unitType="mass" category="grade" insert="custom grade"/>

KpiSummaries definition
KpiSummaries are defined in an XML file, which defines the data source, the various tables (dimension, fact
and lookup tables), calculated members, summaries and real-time KPIs. The definition file used is the result
of dynamically merging a set of standard definition files and custom definition files, as described in the pre-
vious section.

The KpiSummaries definition file is located in the following directory:

\mstarFiles\systems\<systemName>\config\xml\cycles

This section describes the structure of the merged file.

Description attributes

The XML definition allows the use of the descr attribute in each element, to enable an optional description of
that element to be provided.

Reserved attribute

An element containing the reserved="true" attribute cannot be modified or replaced by a custom element.

Header

The kpiSummaries element defines the data source and some of its characteristics.

<kpiSummaries context="cycle" sourceManager="CycleManager"


tablePrefix="CYCLE_">

Page: 151 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

where:

context

Specifies the prefix to use in a fact table expression when referring to a source item. For example, cycle.pay-
load refers to the payload field of the source cycle.

sourceManager

Specifies the name of the manager that creates the source entities. The CyclesKpiSummaries engine listens
to this manager for creation and change events.

tablePrefix

Specifies the prefix to use when creating database table and view names. For example, the tables are named
CYCLE_DIM_<name>, CYCLE_FACT_<name> and CYCLE_LOOKUP_<name>.

The sourceClass element defines names for different classes of source entity. These names are used in if
attributes (see below in Fact Tables).

<sourceClass name="prod" classDef="Entity.Cycle.ProductionCycle" />

<sourceClass name="loader" classDef="Entity.Cycle.ProductionCycle.LoaderCycle" />

<sourceClass name="truck" classDef="Entity.Cycle.ProductionCycle.TruckCycle" />

<sourceClass name="selfloader" classDef="Entity.Cycle.ProductionCycle.LoaderCycle.


SelfLoaderCycle inherit=false" />

The inherit=false attribute means that the if attribute only fires for cycles that match the full classDef.
For example, with the above definition of SelfLoader, a SelfLoader cycle will trigger
if="selfLoader" elements but not if="loader" or if=prod" elements.

Dimension tables

A dimension element defines a dimension table that is linked to the fact tables via its OID column. There are
two types of dimension tables defined:

date

Based on the Shift table and has two base attributes defined internally – startShiftTime and endShiftTime.

Release 4.4.x © Caterpillar 2001-2016 Page: 152 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

entity

Based on any Fleet Entity and has one base attribute defined internally – sourceEntity (the universalOID of
the base entity).

A row in a dimension table is created when a dimensionRef element of a fact table is evaluated (see below)
and the referenced dimension row does not exist.

A row is also created when it is detected that a base attribute of the source entity has changed value, thereby
causing the expression for a dimensionAttribute to change value. The new row has the new values of any
changed attributes and a special value (epoch) in an internal updated column. The old row has the current
timestamp written to the updated column, so that a recalc of any cycles completed up to that time can refer to
the old row.

Each dimension table contains a special row called the NULL (0) row that contains the special value NULL for
its sourceEntity column and "unknown" for each of its columns of type String. This row is used as a target
for fact table dimension references that evaluate to null.

<dimension name="calendar" context="d" type="date">

<dimension name="block" context="b">

where:

name

Used to form the name of the dimension table (e.g., CYCLE_DIM_CALENDAR). It can also be used as a pre-
fix in a dimensionAttribute expression, to refer to a previously defined dimensionAttribute of that dimen-
sion (provided the name of the dimension is different from the name of the context).

context

Specifies the prefix to use in a dimensionAttribute expression when referring to an item in the dimension’s
sourceEntity (or the DateEvaluationBean that wraps the Shift bean for a date dimension). For example,
given the above definition of a block dimension, b.hierarchy refers to the hierarchy field of a miningBlock.

type

Either date or entity. The default value is entity.

Page: 153 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration
keyProperty

Used with the keyIfSourceMissing feature of the dimensionRef element (see below). The default value is
name.

Dimension attributes

A Dimension can contain a number of dimensionAttributes which define the columns of the dimension table.

<dimensionAttribute name="cut" expr="b.hierarchy.split(':')[-2]"/>

where:

name

Specifies the name of the column in the dimension table. It can also be used in the expression of a sub-
sequent attribute, with a prefix of the dimension name, to refer to the attribute’s value; for example, block.cut.

expr

Specifies the expression to evaluate when a dimension row is being created. See Expression definition.

type

The attribute’s Java data type. The default value is java.lang.String.

Indexes

An index element can be specified in the definition of a lookup or fact table to cause the creation of an index in
that table.

<indexname="EM" columns="endtime, primaryMachine"/>

where:

columns

Specifies a comma-separated list of table columns to include in the index. For a fact table, a column can be a
dimension reference, a detail or a measure.

Lookup tables

A lookup table is defined in the XML file, created by the KpiSummaries system but loaded externally, for
example by sqlldr.

<lookup name="loadFactor">

Release 4.4.x © Caterpillar 2001-2016 Page: 154 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

where:

name

Determines the name of the lookup table in the database; in this case, CYCLE_LOOKUP_LOADFACTOR.

The lookup element can contain a number of column elements. There are usually one or more “lookup”
columns, whose values are supplied when a lookup is performed, and one or more “output” columns, whose
values can be referenced in subsequent expressions. Refer to the section "Lookup references" on page 158

<column name="factor" type="java.lang.Float" missingValue="1" />

where

name

Specifies the name of the column in the lookup table.

type

The attribute’s Java data type. The default value is java.lang.String.

missingValue

(Optional) Designed for an “output” column, the value provided for this column if the lookup fails.

Lookup updated

Every lookup table has an internal updated column that behaves like the updated column in a dimension
table. A row with NULL in the updated column contains the current value of the output columns. If you want to
store different output values that apply only from a specific shift forward, create a new row with the new output
values, the same lookup values and a NULL in the updated column. Then set the updated column in the old
row to the start time of the last shift for which the old values are valid.

Fact tables

A fact element defines a fact table. A row in a fact table is created or updated whenever a source entity (e.g., a
cycle) is created or updated respectively. For cycles, if the cycle spans a shift boundary, there is a row cre-
ated in each fact table for each shift that the cycle is in. Refer to the section "Cycle splitting rules" on
page 180 for details on how the cycle is split into shift segments.

<fact name="main">

where:

Page: 155 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration
name

Determines the name of the fact table in the database; in this case CYCLE_FACT_MAIN. It can also be used
as a prefix in a detail or measure expression, to refer to a previously defined detail or measure, in either this or
a previously defined fact table.

A fact element can contain, in this order, a number of:

l Indexes
l Dimension references
l Lookup references
l Details
l Measure Categories
l Measures

Each reference (dimension or lookup) adds the referenced row to the evaluation context, allowing following
expressions to refer to their columns using the reference name as a prefix. A dimension reference also defines
a column in the fact table that contains the OID of the dimension row as a foreign key.

Details are usually non-numeric; their default type is String.

Measures are usually summable; their type is Float and their unit type must be specified.

An if attribute can optionally be used in each of these four types of fact table content. When specified, the
value of this attribute must be a name of a sourceClass (see above). If the current source entity is not of the
specified class, no action is taken for this element. If it is of the specified class, the element is processed as
normal.

This behavior of the if attribute means that multiple elements can have the same name provided they have if
attributes. This allows different expressions to be used for different classes of entities when defining the same
column. For example,

<measure if="truck" name="operatingTime"


expr="main.loadingDuration + main.travellingEmptyDuration +
main.queuingAtSourceDuration + main.spottingAtSourceDuration +
main.travellingFullDuration + main.queuingAtSinkDuration +
main.spottingAtSinkDuration + main.dumpingDuration" unitType="duration" />

<measure if="loader" name="operatingTime" expr="main.loadingDuration +


main.hangTimeDuration" unitType="duration" />

Release 4.4.x © Caterpillar 2001-2016 Page: 156 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

<measure if="auxmobile" name="operatingTime" expr="main.bladingDuration +


main.rippingDuration + main.refillingDuration + main.travellingDuration +
main.wateringDuration" unitType="duration" />

Measure categories allow grouping of associated measures that are assigned to these categories. These are
used in the generated reporting universe.

Dimension references

A dimensionRef element defines a column in the fact table that links to a row in a dimension table. If the ref-
erenced dimension row is null, the column value points to the NULL row of the dimension table.

<dimensionRef if="prod" name="sourceDestination" source="sourceLocation" dimen-


sion="destination" keyIfSourceMissing="sourceLocationName" />

where

if

Causes the behavior as explained above. If the current source cycle is not of the specified class, the column
value is set to point to the NULL row of the dimension table.

name

Specifies the name of the column in the fact table. It can also be used as a prefix in a following expression to
get the value of a column in the referenced dimension.

source

(Optional) Specifies the field of the source entity that points to an entity of the type the referenced dimension
is based on. This defaults to the value of the name attribute. For example, if in the above dimensionRef ele-
ment, the name had been sourceLocation, there would have been no need for the source attribute.

dimension

Specifies which dimension is being referenced.

keyIfSourceMissing

(Optional) Used only when the referenced source is null, in which case the value of the specified field is used
to locate a row in the dimension table with a matching value for its keyProperty. For example, in this case,
when cycle.sourceLocation is null, the destination dimension table is searched for a row with a keyProperty
value of cycle.sourceLocationName. If it is not found, a dummy row is created with that keyProperty value.

Page: 157 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Lookup references

A lookupRef element causes a lookup table to be searched and a row to be returned with specified values in
certain columns. This row can be referenced in following expressions details and measures using the name of
the lookupRef as a prefix. If the lookup fails, a row is constructed where a column has either a null value or
the missingValue if specified in the column’s definition.

<lookupRef if="prod" name="loadFactor" lookup="megaLoadFactor" expr="where pit=? and cut=? and


materialGroup=?">

where

if

(Optional) Specifies whether the lookup is performed for the current source entity class, as explained above. If
it is not performed, no row is added to the evaluation context. This means that any following expressions that
refer to the lookup row should have the same (or more restrictive) if attribute.

name

Specifies the name of the lookup row that is added to the evaluation context, so that following expressions
can use it as a prefix to refer to columns of the lookup table.

lookup

Specifies the name of the lookup element that defines the lookup table.

expr

Specifies the where clause to be used to search the lookup table. The ‘?’s in the expression correspond to fol-
lowing parameter element expression values.

The lookupRef element contains parameter elements that provide the values of the bind variables specified
by ‘?’s in the where clause.

<parameter name="pit" expr="sourceBlock.pit" />

<parameter name="cut" expr="sourceBlock.cut" />

<parameter name="materialGroup" expr="loaderMaterial.groupLevel2" />

where:

name

Currently not used.

Release 4.4.x © Caterpillar 2001-2016 Page: 158 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration
expr

Is evaluated in the usual way (see Expression definition) and the resulting value is used as the value of the cor-
responding bind variable of the lookup table query.

Example

"What is the complete list of values that can be used for lookupRef in KPIs? What is allowable in the ’ where’
clause?"

You can use whatever columns are defined in the lookup table. A column is of type String by default, oth-
erwise Float, Double or Boolean.

Here is an example:

Suppose you have a LoadFactor table defined by:

<lookup name="loadFactorTable">

<index columns="rehandle, pit, material"/>

<column name="rehandle" type="java.lang.Boolean"/>

<column name="pit"/>

<column name="material"/>

<column name="factor" type="java.lang.Float" missingValue="1"/>

</lookup>

Here rehandle, pit and material are the input columns and factor is the output column.

In this case, a lookupRef can refer to any of the input columns in its "where" expression and parameters.

For example:
<lookupRef name="loadFactor" lookup="loadFactorTable" expr="where rehandle=?
and pit=? and material=?">
<parameter name="rehandle" expr="cycle.rehandle"/>
<parameter name="pit" expr="sourceBlock.pit"/>
<parameter name="material" expr="loaderMaterial.groupLevel1"/>
</lookupRef>

Here, the parameters correspond to the '?' in the "where" expression, in the same order (the binding is by pos-
ition, not name).

Page: 159 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

The "where" expression can be any valid SQL (or Hibernate Query Language (HQL)) "where" clause.

The lookupRef causes a record called "loadFactor" to be defined, so subsequent expressions can refer to
"loadFactor.factor" to pickup the output column value.

You are able to refer to any cycle attribute or dimension attribute in the lookupRef parameter value expres-
sions. Rehandle (Boolean variable) is included in the above example.

Details

A detail element defines a column in the fact table that is usually non-numeric.

<detail if="truck" name="previousSinkDestination" expr="cycle.previousCycle.endSinkLocation.name" />

where

if

Causes the behavior as explained above.

name

Specifies the name of the column in the fact table. It can also be used in following expressions, with a prefix of
the fact name, to refer to the detail’s value; for example, main.previousSinkDestination.

expr

Specifies the expression to evaluate to obtain the value of the column. See"Expression definition" on
page 171.

type

The detail’s Java data type. The default value is java.lang.String.

Measure categories

A measureCategory element defines a group of associated measures.

<measureCategory name="activity" desc="Measures relating to cycle


activities"/>

Measures

A measure element defines a column in the fact table that is numeric and usually summable.

Release 4.4.x © Caterpillar 2001-2016 Page: 160 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

<measure if="prod" name="payloadDry" expr='main.payload * loadFactor.factor'


unitType="mass" category="payload"/>

where:

if

Causes the behavior as explained above.

name

Specifies the name of the column in the fact table. It can also be used in following expressions, with a prefix of
the fact name, to refer to the measure’s value; for example, main.payloadDry.

expr

Specifies the expression to evaluate to obtain the value of the column. See "Expression definition" on
page 171.

unitType

The the office software unit type of this measure. The unit type determines two units that are used for the
value for the measure:

User-preferred unit

Used when the value of a measure is used in a following expression, since every term in an expression must
be in user-preferred units.

Storage unit

Used when the value of the measure is written to the database.

category

Specifies the measureCategory this measure belongs to.

Calculated members

A calculatedMember element is used to define a KPI as an expression of aggregated measures. These are
not yet completely supported, but the intention is to export them into the reporting universe, Business Intel-
ligence and other supported presentation/query or analysis tools.

<calculatedMember name="useOfAvailability" expr="operHoursSeconds / avail-


ableTime"/>

Page: 161 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

where:

name

Identifies the calculated member.

expr

Is an arithmetical expression in terms of aggregations of measures. The exact syntax has yet to be finalized.

Summaries

A summary element defines a view over a fact table and dimension tables, and enables measures to be
aggregated over the selected dimensions.

<summary name="truckCycleTimeLocMat" fact="main" desc="truck Cycle Time by


SourceDestination and MaterialType">

where:

name

Defines the name of the view (e.g., CYCLE_S_TRUCKCYCLETIMELOCMAT).

fact

Specifies which fact table to use.

A summary element can contain one or more dimensionRef elements and one or more measureRef ele-
ments, all of which refer to elements of the specified fact.

The dimensionRef elements specify the dimensions to aggregate over. The generated view for this summary
will contain a “group by” clause with these dimensionRef columns.

<dimensionRef name="sourceDestination" dimension="destination">


<dimensionAttributeRef name="name"/>
</dimensionRef>

where

name

Is the dimensionRef element name, which must match the name of a dimensionRef element defined in the
fact table being used for the summary.

Release 4.4.x © Caterpillar 2001-2016 Page: 162 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration
dimension

Specifies which dimension table to use.

Any number of dimensionAttributeRef elements may be included.

name

Is the name of the dimensionAttributeRef element, and specifies a dimensionAttribute to include in the
select-list of the generated view. It must match the name of a dimensionAttribute of the referenced dimen-
sion. The name of the column to be included in the generated view will be the dimensionRef name con-
catenated with the dimensionAttribute name.

The measureRef elements specify the measures to aggregate and the aggregation functions to use.

<measureRef name="payloadNominalDryAverage" measure="payloadNominalDry"


stat="average"/>

where:

name

Specifies the name of the column to be included in the select list of the generated view.

measure

Specifies which measure of the fact table to aggregate. It is optional and defaults to the name of the meas-
ureRef.

stat

Specifies which aggregation function to use. The following values are supported:

l sum (default)
l count
l average

Realtime KPIs

A realtimeKpi element defines a real-time KPI that a client can register to receive notifications of changed KPI
values.

<realtimeKpi if="loader" name="loadingToolDigRate" machineType="loadingTool" fact="main" desc="Rate


that a loading tool digs at">

where:

Page: 163 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration
if

(Optional) Causes the behavior as explained above. If the current source cycle is not of the specified class,
this realtimeKpi is skipped.

name

Specifies the name of this realtimeKpi. This name is used when registering as a listener.

machineType

(Optional) Specifies that any KPIs defined with a dimension of machine name will be passed to the FUA. The
allowable values are: "truck", "loadingTool", "aux" and "processor", corresponding to the FUA tabs.

fact

(Optional) Name of the fact table that measureRefs refer to. Defaults to the first fact table (conventionally
"main").

A realtimeKpi can contain, in this order:

timestamp - used to determine whether these measures should enter a time-constrained population asso-
ciated with a KPI (for example, a shift-based or period-based KPI).

dimensions (optional) - KPIs are calculated for each set of dimension values.

measures - specifies the measures that the KPIs are based on.

kpis - specifies the KPIs that are defined within this realtimeKpi.

calculatedMembers - a calculated member is defined as an expression in terms of KPIs.

Timestamp

<timestamp>

<detailRef name="endTime"/>

</timestamp>

In this case, the time stamp is the cycle's endTime – this is the most common case.

Dimensions

<dimensions>

<dimensionRef name="primaryMachine" dimension="machine">

Release 4.4.x © Caterpillar 2001-2016 Page: 164 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

<dimensionAttributeRef name="name"/>

</dimensionRef>

</dimensions>

In this case, the one dimension is primaryMachine.name. More than one dimensionAttributeRef may be spe-
cified for the one dimensionRef.

A detailRef can also be used to specify a dimension.

Measures

<measures>

<measureRef name="payloadNominalDry"/>

<measureRef name="loadingDuration"/>

</measures>

In this case, two measures are used by the KPIs.

KPIs

<kpis>

<kpi . . .

</kpi>

<rolledupKpi . . . />

...

</kpis>

Either kpis or rolledupKpis can be defined. Each has a name, which has to be unique within the realtimeKpi.
The fully qualified name, <realtimeKpi name>.<kpi name>, is unique within the XML file. If the name starts
with an underscore character (_), the KPI is hidden from the Fleet Update Assistant.

KPI

<kpi name="_tonsMinedByLoadingToolForPeriod" stat="sum" unitType="mass" active="true">

<parameter name="period" value="120" unit="minute" unitType="duration"/>

<parameter name="measure" valueRef="payloadNominalDry"/>

Page: 165 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

</kpi>

where:

name

Specifies the name of the KPI.

if

(Optional) If specified, a boolean expression that, if it evaluates to false, causes the KPI to be skipped.

stat

Specifies which statistic this KPI is based on. Currently supported statistics are:

weighted - if n weights are specified, the KPI is the weighted average of the last n measures

sum - sum of the measures in the population

mean - mean (average) of the measures in the population

rate - sum of the measures in the population / some time duration

count - count of the measures in the population that are non-zero

countRate - count / some time duration

A stat may require a particular parameter to be specified.

label

Specifies the column label used if this KPI is displayed in the Fleet Update Assistant.

unitType

Specifies the unit type of the KPI.

active

(Optional - defaults to "true") If specified as false, this KPI is skipped.

rolledupKpi

A rolledupKpi is a convenient way of rolling up over a dimension. It inherits all the attributes of the KPI it rolls
up, except for the dimensions, where it loses the last dimension. For example, the following rolls up the
primaryMachine.name dimension so is left with no dimension.

Release 4.4.x © Caterpillar 2001-2016 Page: 166 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

<rolledupKpi name="tonsMinedForPeriod" rollupOf="_ton-


sMinedByLoadingToolForPeriod" />

where

name

Specifies the name of the rolledupKpi.

rollupOf

Specifies the KPI (or rolledupKpi) that this rolls up over the last dimension.

label

Specifies the column label used if this KPI is displayed in the Fleet Update Assistant.

calculatedMember(s)

calculatedMembers allow the definition of a KPI in terms of previously defined KPIs (or rolledupKpis). Extern-
ally, a calculatedMember behaves just like a KPI (although they are listed separately in the Real-
timeKpiMetadata).

<calculatedMembers>

<calculatedMember name="byLoadingToolForPeriod"

if="kpi._loadingDurationByLoadingToolForPeriod > 0"

expr="kpi._tonsMinedByLoadingToolForPeriod * 3600 /

kpi._loadingDurationByLoadingToolForPeriod"

unitType = "rate"/>

</calculatedMembers>

where

name

Specifies the name of the calculated member.

if

(Optional) If specified, it is a boolean expression that, if it evaluates to false, causes the calculated member to
be skipped.

Page: 167 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration
expr

Is an expression for the value of the calculated member. Its terms will usually include a prefix "kpi" to refer to a
KPI (or rolledupKpi) previously defined in this realtimeKpi.

label

Specifies the column label used if this KPI is displayed in the Fleet Update Assistant.

unitType

Specifies the unit type of the calculated member.

Real-time KPI persistence


You are now able to store real-time KPIs appropriately identified and created in KPI Summaries. These KPIs
are written to the database on a periodic basis established by a parameter configured in Supervisor. The data
is presented through a view, and available to third party software such as BusinessObjects Dashboards. In
future versions, this will be used within the office software user interface.

Update KPI Summaries XML

There is a new option available in the KPI Summaries.xml file for persisting KPIs. Below is an example of a
real-time KPI in the KPI Summaries.xml file that has been configured for storage in the database.

relatimeKpi if ="truck" name="truckCycleInfo" fact="main" machineType="truck"


persisted="true" desc-"Truck cycle info"

Run makeDataStores

makeDataStores must be run after inserting or modifying KPISummaries.xml with the new KPI Summaries
entries. Running makeDataStores creates the necessary database tables and views to allow third party soft-
ware to access real-time KPI's. Below is an example of a view that will allow access to the real-time KPI's.

SQL> desc cycle_k_truckcycleinfo;

Name Null? Type


NOT
PRIMARYMACHINEOID NUMBER
NULL

PRIMARYMACHINENAME VARCHAR2(1020)

HOLESBYDRILLFORSHIFT NUMBER

Release 4.4.x © Caterpillar 2001-2016 Page: 168 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Name Null? Type


HOLESBYDRILLFORSHIFT_Q NUMBER

HOLESBYDRILLFORSHIFT_U VARCHAR2(4000)

HOLESPERHOURBYDRILLFORPERIOD NUMBER

HOLESPERHOURBYDRILLFORPERIOD_Q NUMBER

HOLESPERHOURBYDRILLFORPERIOD_U VARCHAR2(4000)

FEETBYDRILLFORSHIFT NUMBER

FEETBYDRILLFORSHIFT_Q NUMBER

FEETBYDRILLFORSHIFT_U VARCHAR2(4000)

FEETPERHOURBYDRILLFORPERIOD NUMBER

FEETPERHOURBYDRILLFORPERIOD_Q NUMBER

FEETPERHOURBYDRILLFORPERIOD_U VARCHAR2(4000)

Review KPIGen.properties

After makeDataStores is run, the KPIGen.properties file contains entries that can be used to update the KPI
Summaries universe at the customer site to expose real-time KPI's for use in reports and dashboards. Below
is an example of realtime KPI's shown in the KPIGen.properties file.

Below is an example of DrillKpi's shown in the Universe.

Below is an example of the view structure that is shown in the universe.

Page: 169 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Create Dashboards or Reports that access real-time KPIs

After the KPI Summaries universe has been updated, reports and dashboards can now be implemented that
expose the Realtime KPI's.

KPI display

Display of KPI values

KPIs are displayed in the Fleet Update Assistant.

1. The Statistics Bar in the Fleet Update Assistant can display a small number of KPIs - the current
default is to show the tons mined (prime and rehandle) since the start of the current shift.
2. The Fleet Update Assistant tabs can show KPIs per machine - these KPIs appear in the list of columns
that can be shown in each tab.

You use Supervisor to specify which KPIs appear in the Statistics Bar. You use the Client to specify which
KPIs are displayed in the columns in the Fleet Update Assistant.

To specify which KPIs appear in the Statistics Bar

1. Start Supervisor, and on the Options menu, click System Options.


2. In the Product list, click Machine Tracking, and then click FUA (Fleet Update Assistant) in the
Option Sets list.
3. On the KPIs tab, specify the KPIs to monitor and to display.
4. Click Apply, and restart the Client to effect the changes.

Refer to Fleet Update Assistant (FUA) in the User Manual for more information about these settings.

Refer to the Fleet User Manual for information on how to configure the display of columns in the Fleet Update
Assistant.

Release 4.4.x © Caterpillar 2001-2016 Page: 170 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Also refer to the Fleet User Manual for information on how to configure KPI push.

Display of KPI labels

The labels used for displaying either type of KPI and calculated Members are specified by the label attribute.

Expression definition
Expressions are used to define the values of dimension attributes, lookup parameters, details and measures.
The syntax is the usual arithmetic grammar of terms and the standard operators ‘+’, ‘-‘, ‘*’, ‘/’.

If an expression is enclosed in braces ({}), it is understood as Jython code that must return a value in a special
variable _res. To help with Jython’s use of indentation, the text can include the two-character sequence "\n",
which is replaced with a newline character.

Terms

A term starts with a prefix that identifies the term’s context. The prefix is followed by a period (.) and then
either a field name or a special method call; what is valid is dependent on the context.

The following contexts are available.

Dimension attribute contexts

Context Referenced Object

Dimension context Dimension source entity

Dimension name Current dimension row

Fact table expression contexts

Context Referenced Object

KpiSummaries context Source entity (e.g., cycle)

Name of a previoiusly
defined dimension ref- Referenced dimension row
erence

Name of this or pre-


Current fact row
viously defined fact

Page: 171 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Context Referenced Object

kpi KPIs defined within current real-time KPI.

KpiSummaries functions defined in Python


kpy
(mstar\create\bus\jython\kpy.py)

Special methods

The following special (static) methods are available in any context:

duration(Date startTime, Date endTime)

Returns the duration of the specified time interval in user-preferred units.

isZero(Number measure)

Returns true if measure is null or zero.

test(Boolean cond, Number trueValue, Number falseValue)

Returns trueValue if cond is true, otherwise falseValue.

Source entity terms

When the context refers to a source entity (e.g., cycle or a dimension entity) and a field name is used, the
value is one of the following:

l primitive value – that’s the end of the term


l Entity – continue with a period (.) and proceed recursively
l mapped property set – continue with a period (.) and apply a method from a collection wrapper depend-
ing on the type of set

Shift wrapper

The DateEvaluationBean wrapper that is defined over the Shift table provides the following methods to the
expressions in a date type dimension attribute:

getYear()

Returns the name of the year

Release 4.4.x © Caterpillar 2001-2016 Page: 172 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

getHalfYear()

Returns the name of the half year

getQuarter()

Returns the name of the quarter

getMonth()

Returns the name of the month

getWeek()

Returns the name of the week

getDay()

Returns the name of the day

getShiftName()

Returns the name of the shift

getShiftType()

Returns the type of the shift

getCrewId()

Returns the id of the crew working this shift

getShiftStartTime()

Returns the start time of the shift as a Date

getShiftEndTime()

Returns the end time of the shift as a Date

Dimension and fact row beans

When the context refers to a dimension or fact row, the field name must be the name of a dimen-
sionAttribute, a detail or a measure. There are, however, additional methods provided in a date dimension
bean that add extra time points for the shift.

Page: 173 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration
getPeriodStartTime(String periodKey)

Returns the start time of the period specified by the periodKey, as a Date.

getPeriodEndTime(String periodKey)

Returns the end time of the period specified by the periodKey, as a Date.

The following cases are provided for convenience:

l getYearStartTime()
l getYearEndTime()
l getHalfStartTime()
l getHalfEndTime()
l getQuarterStartTime()
l getQuarterEndTime()
l getMonthStartTime()
l getMonthEndTime()
l getWeekStartTime()
l getWeekEndTime()
l getDayStartTime()
l getDayEndTime()

Collection wrappers

Separate collection wrappers are provided for the various mapped property sets of interest; you use Super-
visor to enable alternative wrappers.

To enable alternative wrappers

1. Start Supervisor, on the Contents menu, point to Setup and then click System Options.
2. Choose Production in the Product list and then click KpiSummaries Plugin Wrappers in the Cat-
egory list.
3. For each available Entity Class, specify the appropriate Wrapper Implementation Class, and then click
Apply.

Release 4.4.x © Caterpillar 2001-2016 Page: 174 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

CycleActivityComponent(cycle.activities)

NOTE: A no-argument getter method can be invoked more conveniently as a field access; for
example, cycle.activities.travellingEmptyDuration instead of cycle.activ-
ities.getTravellingEmptyDuration().

getDurationByActivity(String name)

Returns the total duration (in user-preferred units) of activities with the specified name.

The following cases are provided for convenience:

l Travelling.Empty: getTravellingEmptyDuration()
l Travelling.Full: getTravellingFullDuration()
l Spotting.At.Source: getSpottingAtSourceDuration()
l Spotting.At.Sink: getSpottingAtSinkDuration()
l Queuing.At.Source: getQueuingAtSourceDuration()
l Queuing.At.Sink: getQueuingAtSinkDuration()
l Loading: getLoadingDuration()
l Dumping: getDumpingDuration()
l Hang.Time: getHangTimeDuration()

getSmuDurationByActivity(String name)

Returns the total SMU duration (in user-preferred units) of activities with the specified name.

The following cases are provided for convenience:

l Travelling.Empty: getTravellingEmptyDuration()
l Travelling.Full: getTravellingFullDuration()
l Spotting.At.Source: getSpottingAtSourceDuration()
l Spotting.At.Sink: getSpottingAtSinkDuration()
l Queuing.At.Source: getQueuingAtSourceDuration()
l Queuing.At.Sink: getQueuingAtSinkDuration()
l Loading: getLoadingDuration()
l Dumping: getDumpingDuration()
l Hang.Time: getHangTimeDuration()

Page: 175 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration
getStartTimeByActivity(String name)

Returns the start time (as a Date) of the first activity with the specified name.

The following cases are provided for convenience:

l Travelling.Full: getTravellingFullStartTime()
l Spotting.At.Source: getSpottingAtSourceStartTime()
l Spotting.At.Sink: getSpottingAtSinkStartTime()
l Queuing.At.Source: getQueuingAtSourceStartTime()
l Queuing.At.Sink: getQueuingAtSinkStartTime()
l Loading: getLoadingStartTime()
l Dumping: getDumpingStartTime()
l Hang.Time: getHangTimeStartTime()

getEndTimeByActivity(String name)

Returns the end time (as a Date) of the last activity with the specified name.

The following cases are provided for convenience:

l Travelling.Full: getTravellingFullEndTime()
l Spotting.At.Source: getSpottingAtSourceEndTime()
l Spotting.At.Sink: getSpottingAtSinkEndTime()
l Queuing.At.Source: getQueuingAtSourceEndTime()
l Queuing.At.Sink: getQueuingAtSinkEndTime()
l Loading: getLoadingEndTime()
l Dumping: getDumpingEndTime()
l Hang.Time: getHangTimeEndTime()
l getWorkingDuration()
l getIdleDuration()

CycleActivity wrapper: getSmuDurationByActivity(String activityName): Quantity

Returns in seconds the sum of the SMU duration of all the cycle's activities with the given name.

For example:
<measure if="loader" name="hangTimeSmuDuration" expr-
='cycle.activities.getSmuDurationByActivity("Hang.Time")' unitType="duration"
category="activity" desc='The smu duration of the "Hang.Time" activity for
loader cycles'/>

Release 4.4.x © Caterpillar 2001-2016 Page: 176 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

The following predefined CycleActivity wrappers:

l getTravellingEmptySmuDuration
l getTravellingFullSmuDuration
l getSpottingAtSourceSmuDuration
l getSpottingAtSinkSmuDuration
l getQueuingAtSourceSmuDuration
l getQueuingAtSinkSmuDuration
l getLoadingSmuDuration
l getDumpingSmuDuration
l getHangTimeSmuDuration

CycleDelay(cycle.allDelays)

getDurationByCategory(String name)

Returns the total duration (in user-preferred units) of activities that are marked as Working or Idle in the activ-
ity definition.

getSmuDurationByCategory(String name)

Returns the total SMU duration (in user-preferred units) of activities that are marked as Working or Idle in the
activity definition.

getCountByCategory(String name)

Returns the total number of delays of the specified category. If a delay spans a shift boundary, only the pro-
portion of the delay that lies within the shift is included in the count. This makes the count summable over
shifts.

getDurationByClass(String name)

Returns the total duration (in user-preferred units) of delays of the specified class. If a delay spans a shift
boundary, only that part of the delay that lies within the shift is included in the total.

getSmuDurationByClass(String name)

Returns the total SMU duration (in user-preferred units) of delays of the specified class. If a delay spans a
shift boundary, only that part of the delay that lies within the shift is included in the total.

Page: 177 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration
getCountByClass(String name)

Returns the total number of delays of the specified class. If a delay spans a shift boundary, only the proportion
of the delay that lies within the shift is included in the count. This makes the count summable over shifts.

getIdleDuration(String name)

Returns the total duration (in user-preferred units) of delays that are not marked as Engine Stopped in the
delay type definition.

CycleDelay wrapper: getSmuDurationByCategory(String categoryName): Quantity

Returns in seconds the sum of the SMU duration of all the cycle's delays with the given category name.

For example:
<measure name="standbySmuTime" expr='cycle.allDelays.getSmuDurationByCategory
("Standby")' unitType="duration" category="delay" desc='The smu duration of
the "StandBy" delays'/>

CycleDelay wrapper: getSmuDurationByClass(String className): Quantity

Returns in seconds the sum of the SMU duration of all the cycle's delays with the given class name

CycleRoadSegment(cycle.roads)

Each of the following methods returns the total of the specified measure (in user-preferred units) over all road
segments where the traversal start time lies in the shift.

l getEmptyRiseHeight()
l getEmptySlopeLength()
l getEmptyPlanLength()
l getEmptyEfhLength()
l getEmptyExpectedTravelDuration()
l getEmptyTargetTravelDuration()
l getEmptyTravelTime()
l getEmptyTravelTimeWithoutDelay()
l getFullRiseHeight()
l getFullSlopeLength()
l getFullPlanLength()
l getFullEfhLength()
l getFullExpectedTravelDuration()

Release 4.4.x © Caterpillar 2001-2016 Page: 178 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

l getFullTargetTravelDuration()
l getFullTravelTime()
l getFullTravelTimeWithoutDelays()
l getTravelTime()
l getTravelTimeWithoutDelay()

GradeInformation(cycle.sourceGradesMined, cycle.sinkGrades)

getGradeValueByName(String name)

Returns the grade value (in user-preferred units) for the specified grade name.

getGradeFractionByName(String name)

Returns the grade fraction (in the range [0,1]) for the specified grade name.

haveGradeFractionByName(String name)

Returns 1 if the grade information has an entry for the specified grade name. Returns 0 otherwise.

SMU Interpolation
The following API calls are available for use in expressions defining the values of measures or details.

kpy.lookupSmu(Machine machine, Date time): double

Returns in seconds the interpolated SMU for a machine and a time. For example:
<detail name="cycleSmuStart" expr="kpy.lookupSmu(cycle.primaryMachine.entity,
main.startTime)" type="java.lang.Double" desc="The service meter reading at
the start of the cycle."/>

kpy.calcSmuDuration(Machine machine, Date startTime, Date endTime): double

Returns in seconds the SMU duration calculated as lookupSmu(machine, endTime) - lookupSmu


(machine, startTime)

For example:
<measure name="cycleSmuDuration" expr="kpy.calcSmuDuration
(cycle.primaryMachine.entity, main.startTime, main.endTime)" unitType-
e="duration" category="time" desc="The smu duration of the cycle."/>

Page: 179 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Cycle splitting rules


The rules used for splitting cycles into shift segments are as follows:

1. Non-numeric and non-summable simple properties are copied to all segments.


2. Mapped property sets that are keyed on Date are split by using the key to determine which shift seg-
ment the element is put into. If an element spans a shift boundary, it is handled as follows:
i. A CycleActivity is split at the shift boundary into two CycleActivities, each being inserted into
the appropriate segment.
ii. A CycleDelay is split at the shift boundary into two SplitCycleDelays, each being inserted into
the appropriate segment. (SplitCycleDelays are CycleDelays that have count fields that add to
1.) Each points to the same Delay entity.
iii. A CycleRoadSegment is simply left in the segment of the shift its traversal started in.
3. All the summary road segment properties are recalculated for each shift segment.
4. The segment that is to contain payload-related information is determined as:
i. For truck cycles, the segment that contains the end of the (last) dumping activity, or the end of
the cycle
ii. For loader cycles, the segment that contains the end of the (last) loading activity, or the end of
the cycle
5. The properties related to payload that are copied to the payload segment are:
l nominalPayload
l payload
l dipperCount
l loadReportCount
l calcDippers
l minedDippers
l sourceGradesCalced
l sourceGradesMined
l sinkGrades
l discreteGrades
6. The following summable properties are copied to the last segment:
l vimsLoadedSlopeDistance
l vimsEmptySlopeDistance
l fuelUsed
l estimatedFuelUsed
l transmissionShifts

Release 4.4.x © Caterpillar 2001-2016 Page: 180 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Working with KpiSummaries


Fleet provides two applications to help you work with KpiSummaries: maintainKpiSummaries and recal-
cCyclesKpiSummaries. These are command line applications; there is currently no facility for using these
applications from the office software GUI.

recalcCyclesKpiSummaries

This application has two functions:

1. To recalculate fact entries from a set of existing cycles.


2. To recalculate dimension entries from updated model entities.

Recalculating Fact entries

An alternative to running this command is to use a feature of the Bulk Cycle Update page, which is to - in the
Update Mode panel, select Recalc Reporting Data and click Run.

The syntax of the recalcCyclesKpiSummaries command is as follows:

mstarrun recalcCyclesKpiSummaries from [to [chunk [wait]]]

where:

from and to

l Specify which cycles to process; if the to arguments is not supplied, the current time is used. A cycle
is included if from <= cycle.endtime < to.

The from and to arguments are numeric strings in the format yyyymmddhhmmss where hhmmss is padded
out with 0s if not fully specified.

chunk

Specifies the size of the query chunk in hours (the default is 12 hours).

wait

Specifies the number of seconds to wait between each cycle (the default is zero (0) seconds. This can be
used to decrease the load that recalc puts on the CyclesKpiSummaries server.

If no arguments are given, a usage description is returned.

Page: 181 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Recalculating Dimension entries

Dimension entries need to change when:

1. An underlying model entity is changed so that the value of a dimension attribute will change.
2. The expression defining the value of a dimension attribute is changed.

In the first case, the CyclesKpiSummaries server will normally be notified of the change and the relevant
dimension row is automatically recalculated.

In the second case, the CyclesKpiSummaries server will have to be restarted for the expression change to be
seen and normally all dimension rows are recalculated on a restart.

This means that normally this command does not have to be used, but it can be useful in exceptional cir-
cumstances. It does provide the ability to choose the update mode:

1. New, the default, means that a new dimension row is created with the new values of the attributes but
the row with the old values is marked with the datetime up to which it is valid, i.e. the new values apply
only to cycles created after that datetime.
2. Replace means that the new values are written into the current dimension row, so they apply ret-
rospectively.

The syntax of the recalcCyclesKpiSummaries command for dimension entries is as follows:

mstarrun recalcCyclesKpiSummaries dimension [updateMode [updateTime]]

where:

dimension

can be the name of a dimension, e.g. block,


or, a comma-separated list of dimension names e.g. block, material,

or, all.

updateMode (optional)

can be new, which is the default, or replace.

updateTime (optional, valid only if updateMode=new)

the datetime from which the change is effective, in the format yyyymmddhhmmss, where hhmmss is padded
out with 0s if not fully specified.

Release 4.4.x © Caterpillar 2001-2016 Page: 182 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

If you do specify an updateTime in the past, you may have to do a recalc of fact entries created since that dat-
etime, to make sure that the fact entries are pointing to the correct version of the dimension rows.

If no arguments are given, a usage description is given.

Using CyclesKpiSummaries with reporting


Earlier versions of the office software provided one method of accessing data stored by the application.
Object Model-based reporting was able to access all data stored by the office software application, but the
application’s data storage was not tuned to the requirements of reporting and could not be easily modified or
configured to meet the needs of reporting.

The introduction of KpiSummaries now enables consultants and customers to define how data can be stored
for use by reporting. Earlier sections of this document describe the configuration of KpiSummaries XML, and
this XML configuration is used to create the database views, for access to information, and tables for the stor-
age of the information.

There is an association between the definition of the XML, the database tables for information storage, the
database views for access to the information by external applications and the design of the Business Objects
Universe for reporting of information.

Information on the above topics can be found in the Using BusinessObjects with Cat MineStar manual.

Standard reports

There are no standard reports related to the KpiSummaries functionality.

Custom reports can be built on KpiSummaries views and tables, although this can only be done after a cus-
tom universe has been created. As with Fleet’s Object Model-based universe, the intention is for the KpiSum-
maries universe to be automatically generated. Refer to the Using BusinessObjects with Cat MineStar
manual for information about the creation of a KpiSummaries-based universe and the rules used to create
such a universe.

Time breakdown tables


The table below shows the Standard Time Breakdown definitions.

Page: 183 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Total Time

Available time Down time

Delay time

Operating Scheduled down Unscheduled


Non-oper- Standby time
time Operating time down time
ating delay
delay time
time

"Operating "Non-oper- "Unscheduled


(Activity) "Standby" "Scheduled down"
delay" ating delay" down"

The time the


equipment is
The time
not operating
the equip- The time the
The time the equip- because of
ment is run- The time the equipment is run- equipment is
ment is not operating any failure,
ning and ning but not doing productive available for oper-
because of sched- unscheduled
doing pro- work ation but not run-
uled maintenance maintenance,
ductive ning
or scheduled
work
maintenance
overrun.

The table on the following pages shows the Reference Implementation Time Breakdown definitions, as used
in Reference Implementation reports.

Release 4.4.x © Caterpillar 2001-2016 Page: 184 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Reference Implementation time breakdown

Total time

Available time Down Time

Delay time Standby time Scheduled down time Unscheduled down time
Operating
time
Operating delay time Non-operating delay time

Activity "Operating delay" "Non-operating delay" "Standby" "Scheduled down" "Unscheduled down"

A SHIM CHANGE General Non-Oper Delay General Standby General Sch. Down General UnSch. Down
BIT CHANGE EQUIPMENT MOVE HOLIDAY PREVENTIVE MAINTENANCE FAILED SAFETY INSPECTION
BLAST FUEL AND LUBE RELEASED FROM MAINTENANCE S-AIR COMPRESSOR SYSTEM U-ACCIDENT DAMAGE
CABLE MOVE MEETINGS STANDBY WITH NO OPERATOR S-AIR CONDITIONING U-AIR COMPRESSOR SYSTEMS
CLEANUP BED CLEANING STANDBY WITH OPERATOR S-AUTOLUBE U-AIR CONDITIONING
CRUSHER CLOSED GEO TECH DEL-EQUIPMENT NOT REQUIRED S-BRAKE & FRONT SPINDLE U-AUTOLUBE SYSTEMS
DRILL CHANGE TOOL INCLEMENT WEATHER DEL-INCLEMENT WEATHER S-DRILL WATER INJECTION U-BRAKES & FRONT SPINDLE
EMERGENCY SAFETY OBSERVATION DEL-NO CRUSHERS AVAILABLE S-ELECTRICAL SYSTEM U-DRILL WATER INJECTION
EQUIPMENT INSPECTION TAKING ON WATER DEL-NO DUMPS AVAILABLE S-FIRE SUPPORESSION SYSTEM U-ELECTRICAL SYSTEM
EQUIPMENT STUCK TRACK CLEANING DEL-NO EXCAVATORS AVAILABLE S-FRAME & BODY/BED SYSTEM U-ENGINE SYSTEMS
DEL-NO TRUCKS AVAILABLE S-HYDRAULIC SYSTEM U-FIRE SUPPRESSION SYSTEM
DEL-RELEASED FROM ELECT.MAINT. S-IMPLEMENT SYSTEMS (GET) U-FRAME & BODY/BED SYSTEM

Page: 185 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Total time

Available time Down Time

Delay time Standby time Scheduled down time Unscheduled down time
Operating
time
Operating delay time Non-operating delay time

Activity "Operating delay" "Non-operating delay" "Standby" "Scheduled down" "Unscheduled down"

TIRE COOLDOWN TRAINING DEL-RELEASED FROM FIELD MAINT. S-MAST & DRILL STEEL SYSTEM U-HYDRAULIC SYSTEMS
TRAMMING LONG DEL-CLEANUP DEL-RELEASED FROM SHOVEL PM S-MINESTAR U-IMPLEMENT SYSTEMS
TRAMMING SHORT DEL-DRILL PIPE FALLEN OUT DEL-RELEASED FROM SHOVEL/DRILL M S-PM INSPECTION U-MAST & DRILL STEEL SYSTEM
WAIT ON PATTERN/SURVEY DEL-ELECTRICAL SHUT DOWN DEL-RELEASED FROM TIRE SHOP S-RADIO MAINTENANCE U-MINESTAR
WAITING FOR SHOVEL DEL-FUELING DEL-SHOVEL OUT OF MATERIAL S-ROTARY HEAD SYSTEM U-OUT OF FUEL
WAITING FOR WATER DEL-MINESTAR S-STEERING SYSTEMS U-RADIO MAINTENANCE
TRUCK DEL-OFFSHIFT TIEDOWN S-SUSPENSION SYSTEMS U-ROTARY HEAD SYSTEM
Operating Delay DEL-OILER SERVICING DRILL S-TIRES RIMS & LOCKRINGS U-STERRING SSTEMS
DEL-OPERATOR DELAY S-TPMS & VIMS U-SUSPENSION SYSTEM
DEL-OVERLOADED TRUCK S-TRACKS & UNDERCARRIAGE U-TIRES RIMS & LOCKRINGS
DEL-PLUGGED BIT S-TRANS & TRANSFER CASE U-TPMS & VIMS
U-TRACKS & UNDERCARRIAGE
U-TRANS & TRANSFER CASE

Total time

Page: 186 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Total time

Available time Down Time

Delay time Standby time Scheduled down time Unscheduled down time
Operating
time
Operating delay time Non-operating delay time

Activity "Operating delay" "Non-operating delay" "Standby" "Scheduled down" "Unscheduled down"

DEL-ROAD BLOCK S-WELL CABLE U-WELL CABLE


U-WELL MOTOR
DEL-STUCK TOOLS S-WELL MOTOR
U-WELL PIPE
DEL-TOOLING UP S-WELL PIPE
U-WELL PUMP
DEL-TRAM FOR MAINTENANCE S-WELL PUMP U=WELL STARTER
DEL-WAITING FOR CRUSHER S-WELL STARTER U-WHEELGROUPS & DIFFS

DEL-WAITING FOR TAGS S-WHEELGROUPS & DIFF DEL-U-TORQUE CONVERTER

DEL-P-BACKLOG & REPAIRS

Page: 187 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Business Intelligence
Business Intelligence cubes can be built on KpiSummaries views and tables. Refer to the Fleet Information
Access User Manual for more information on this topic.

Release 4.4.x © Caterpillar 2001-2016 Page: 188 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Configuring production
Cycle configuration

Dual mode loading tools

To ensure that cycle data is correctly recorded against loading tools that work in multiple modes, you can spe-
cify the actual operating mode for a loading tool at any given time. For example, a loading tool working in LHD
mode in a stockpile has different cycle recording and assignment requirements than when it is loading trucks
in Production mode.

NOTE: Loading tools operating in LHD mode cannot be assigned to load trucks.

Using LHD threshold levels

In order to track the different ways that these loading tools operate, you can specify an LHD threshold level,
which applies to loading tools operating in LHD mode. This threshold level specifies the number of Begin.Load-
ing messages received before a loading tool automatically changes back to Production mode. This ensures
that a minimal number of production cycles are lost when an LHD starts working in Production mode without
the operator notifying the Mine Controller.

The default threshold level is specified in Supervisor, and is set to four (4).

You set the LHD Threshold Level in Supervisor by doing the following.

1. Click Options > System Options, then from the Product drop-down list select Production.
2. In the Option Sets list, click Cycle Configuration, and then click the Loading Tool Loading tab.
3. In the LHD threshold level field enter 4.
4. Click Apply.

This means that when the fourth Begin.Loading message arrives in the office, the office software auto-
matically changes the loading tool to Production mode.

The residual data effect is that:

l The three truck cycles created while the loading tool was still set to LHD mode will not have had their
loading activities reconciled, possibly causing a slight overlap of loading activities.

Page: 189 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

l The loading tool will be short three cycles.

You can disable this functionality by specifying an LHD Threshold Level of zero (0).

Release 4.4.x © Caterpillar 2001-2016 Page: 190 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Configuring Service Meter Units (SMU)


SMUs are polled from the on-board hardware in a period of between 30 seconds and five minutes. The shorter
the polling period, the more accurate the results, but the greater the overhead on the on-board system. The
office software is made aware of this polling period by a Supervisor configuration parameter, which you set up
in: System Options > Production > SMU Interpolator > Onboard. Enter an Onboard Polling Period, where
the default value is 60 seconds.

When the on-board hardware includes the current SMU value in messages, the values will be the same until
the next hardware polling operation takes place, so a graph of SMU values (for a particular machine) observed
in the office looks like steps (with a width of the polling period) rather than a smooth incline.

Since real SMUs accrue at the same rate as clock time or not at all, a graph of real SMU values against time
always has a gradient of 1 or 0. This fact, and the knowledge of the on-board polling period are used by the
code which extracts SMU values from messages and writes entries in the ServiceMeterReading table, essen-
tially calculating and storing just the points of the graph where the gradient changes. This code runs in the
MineTracking server and you need to enable the Supervisor configuration option by going to System Options
> Production > SMU Interpolator > General and select the Smu Enabled check box.

To improve the performance of the SMU interpolator, an in-memory cache has been implemented. You can
configure the cache in Supervisor by going to System Options > Production > SMU Interpolator > Inter-
polator. It is not expected that these values will need to be changed.

Page: 191 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Configuring backups
To ensure that production data, system configuration and other information can be retrieved in the event of dis-
aster, it is important that a sound backup policy be developed and implemented according to the needs of
each site. The following sections describe the types of backups, their frequencies and suggested locations for
a typical Fleet installation. These may need to be modified to suit site requirements.

Backup locations and frequencies


The following table describes the recommended backup locations and frequencies for various Fleet com-
ponents.

Host Drive Objects to Back Up Frequency Priority

Operating system and


installed 3rd party soft-
ware. Should include
C: Monthly Desirable
recovery information.
All office software
(Raid configurations,
Servers
registry, etc.)

\mstar Weekly Desirable


D:
\mstarFiles Daily Mandatory

D: \DBExport Daily Mandatory

Database Servers (In E:


Oracle Datastores <- DO
addition to above)
F: NOT BACKUP any N/A N/A
\mstarData directories
G:

Release 4.4.x © Caterpillar 2001-2016 Page: 192 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Host Drive Objects to Back Up Frequency Priority

Operating system and


installed 3rd party soft-
C: ware. Should include Monthly Desirable
recovery information.
All Client PCs
(registry, etc.)

\mstar Weekly Desirable


C:
\mstarFiles Daily Desirable

Reporting Server D: \MineStarReportCache Weekly Desirable

Backup sizes
The following table details the typical sizes of the various backups.

Host Directory Typical Size

Any \mstar 0.5GB

Application server \mstarFiles 10GB

Standby server \mstarFiles 10GB

Database server \DBExports 5GB – 20GB

Other computers \mstarFiles 0.5GB

Excluding files to save space

If your backup software supports it, you can exclude the \mstarFiles\sys-
tems\<systemName>\trace directories from the backup procedure. This can save up to 3–4GB. The fig-
ures quoted above reflect the fact that the Standby Server also functions as a Test Server, and so the typical
size might be much less.

Page: 193 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Scheduling
Database direct exports are scheduled for 1:45am. Tape backups should begin at 4am.

Assumed backup types


The table below explains the assumed backup types.

Type Description Retention Media Aging

All data that has changed since the last


weekly backup. Normally run every even- Tapes should be removed from
Daily ing except for the night that the weekly 14 days cycle after approx 1 year. Can
backup runs. be promoted to weekly tapes.

Implies Weekly.

All data backed up. Normally run on Tapes retired from cycle as their
Weekly Saturday evening. 5 weeks turn to be the monthly backup

Implies Monthly. comes around.

The weekly back up that runs on the first


Tapes retired from cycle as their
weekend of the month should be denoted
Monthly 13 months turn to be the yearly backup
a monthly backup.
comes around.
Implies Yearly

The monthly backup that runs at the start


Immediately retired after one
Yearly of a designated financial year should be Forever
verified backup.
denoted a yearly backup.

Archive backups performed on an as


required basis normally triggered by Immediately retired after one
Archive Forever
same major change in the system. Com- verified backup.
monly done to CD if data size allows.

Release 4.4.x © Caterpillar 2001-2016 Page: 194 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Configuring tape backups


BackupToTape is included as a standard feature of the system. It is designed to be configured using different
enterprise tape backup solutions.

The BackupToTape features relies on application calls which are hard-coded into the database export
scripts. If changes are made to the local storage management software configuration, you should advise Fleet
Customer Support.

Enabling BackupToTape
To enable BackupToTape

1. On the Contents menu, point to Setup and then click System Options.
2. In the Product list, choose Platform and then click System – Enterprise Extensions in the Option
Sets list.
3. Display the Enterprise Backup tab. Select Integrate Data Exports with Tape Backups and then
click Apply.

Disabling BackupToTape
To disable BackupToTape

l Follow the same procedure as above, but ensure that Integrate Data Exports with Tape Backups is
not selected, and then click Apply.

Page: 195 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

EFH management
You can use the office software to manage Effective Flat Haul (EFH) curves. This allows for the recalculation
of the EFH distances and factors whenever a road segment is updated.

This feature is not enabled by default. This gives the local builder the chance to set up the EFH curves within
the office software and time to observe the changes that would be made before enabling the feature.

Updates can be selectively enabled for both recalculation of EFH factor and EFH distance, although normally
these would be enabled together. Similarly, updates can be selectively enabled for final road segments and
haulage roads. Distance is specified in meters.

You can also specify that updates only occur if the changes exceed a nominated threshold.

Configuring EFH
Use Supervisor to specify the various EFH options which control how road segment information is updated.
This includes enabling automatic update of EFH factors and distance, and also specifying the thresholds
below which changes are ignored.

To configure EFH options in Supervisor

NOTE: You need to restart the system for these changes to take effect.

1. On the Options menu, click System Options.


2. In the Product list, choose Machine Tracking, and then click Roads in the Option Sets list.
3. Click the Road Management Settings tab, and specify the required update options and change
thresholds.
4. Click Apply.
The changes will take effect the next time you restart the system.

Road information recalculation


When the spatial attributes of a road change, certain road information attributes are recalculated based on the
tolerances configured in Supervisor.

Release 4.4.x © Caterpillar 2001-2016 Page: 196 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Recalculated Information

The following information is recalculated whenever the spatial attributes of a road change:

l Plan Length
l Slope Length
l Rise Height
l Fall Height
l Travel Information
l EFH Factor (Optional)
l EFH Distance (Optional)
l Design Travel Times (Optional)
l Dynamic Travel Time (Optional. Only changed if the Design Time changes)

Factors triggering information recalculation

The attribute changes potentially triggering this recalculation are:

l Waypoints
l Route point
l Road Segments
l Start Waypoint
l End Waypoint
l Interim vertices being added, moved or deleted
l Rolling Resistance
l Road Speed Limit
l Travel Information
l Truck Classes
l Average Speed Unloaded at Destination
l Average Speed Loaded at Destination
l EFH Specification
l Max Speed Loaded
l Max Speed Unloaded

Using EFH Parameters


EFH data is included in both the Truck Class Editor and the Road Segment Editor. Refer to the Fleet User
Manual for more information.

Page: 197 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Advanced client configuration


Using custom roles
Fleet currently provides five pre-configured roles to use with the office software. A sixth role, ANYONE, is
used as part of the permissions configuration, but is not actually a usable role. That is, you cannot log in as
"ANYONE".

The five pre-configured roles are as follows:

l Member
l Controller
l Builder
l Maintenance Engineer
l Maintenance Technician

You can also create custom roles, and assign your own permission preferences to each. When these custom
roles and permissions are in place, you can assign users to these roles in the same way that you assign users
to the pre-configured roles. This is especially useful for large sites, or sites with special requirements, where
the pre-configured roles are insufficient.

Release 4.4.x © Caterpillar 2001-2016 Page: 198 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Creating custom roles


To create a custom role, you need to specify the name of the role in the appropriate configuration file, and
assign permissions to the role in Supervisor. When this stage is complete, you need to restart the system so
that it is aware of the new roles.

To create a custom role

1. Ensure that the following directory exists:


\mstarFiles\systems\<systemName>\config\catalogs
2. Create the following file in the directory described in Step 1.
ChoiceLists.properties
3. Edit this file to include the custom roles that you want to create.
This file uses standard Java name/value pair syntax. For example, to create the custom roles Ore Con-
troller and HR Admin, include the following line:
userRole = ["Ore Controller","HR Admin"]
4. The new roles appear on the Permissions page the next time you start Supervisor. You can now assign
permissions to these roles as required. Refer to"Permissions and roles" on page 207 for information on
assigning permissions.

Using custom roles


Before you can use any custom roles, you need to restart the system so that it can load the newly created
choices. After the system has been restarted, you can assign users to the new roles.

You use a Client to assign roles to users. Refer to the Fleet User Manual for further information.

Page: 199 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

VIMS XML file configuration


The VIMS channel, event and prognostic (trend, cumulative and histogram) definitions are derived from the
VIMS Access databases shipped with VIMS PC. These describe all the data potentially available from VIMS
equipped machinery. The default directory for these files is <MSTAR_HOME>\xml\vims.

The files fall into two broad categories:

l Definition Files (*_def.xml) – contain general information about the data.


l Configuration Files (*_config.xml) – contain limited definitions of which data types are available on
each model of machine. These configurations are representative only and are not generally complete.
They are used only to prime the system. Actual channels configured on the machines are determined
at runtime as data is imported.

The type of data described in the files varies from datatype to datatype, but generally includes an ID number, a
name for each data type, units and scaling information.

The contents of the files are immediately available to application components, but must be imported into the
database using
makeDataStores Health to be available for reporting. This is described in more detail below.

Using VIMS XML files with reporting


Some of the VIMS XML files are used to specify various parameters used by Reporting. These files contain
target definitions, and different report types require different target definition files.

The target definition files may require customization to suit the requirements of the mine. This is performed
when the office software is first installed, and again whenever new equipment models are added to the site or
when changes to reporting parameters are required.

The target definition files are customized by the Builder or other suitably qualified personnel.

Trend and histogram targets are defined in the following file:

\mstar\mstarHome\xml\vims\targets.xml

The default trend and histogram settings reflect the VIMS Data Application Guide ver. 1.06. These settings
should be reviewed according to your site’s operating conditions and modified accordingly (see below).

The following reports currently use this file:

Release 4.4.x © Caterpillar 2001-2016 Page: 200 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

l HE420d-VIMS PM Planner
l HE020d-Transmission-By Class, Truck, Date Range-Detail

Payload histograms are defined in the following file:

\mstar\mstarHome\xml\vims\payload_histograms.xml

The default histograms provided are 5, 10 and 20 tons/tonnes, but these can modified as required.

The following reports currently use this file:

l VC520d-10-10-20 Exceptions+Histograms

Configuring client memory settings


Individual client memory settings can be applied to different client machines through a shared copy of the tar-
gets_client.properties file. This file needs to be created in the following folder.

MSTAR_BASE_CENTRAL\config\catalogs\

Application properties can be specified as any combination of the following.

appName.propertyKey = valueForAnyHost
appName.propertyKey@hostName1 = valueForSpecificHost1
appName.propertyKey@hostName2 = valueForSpecificHost2

...etc

The first of the three lines above specifies a value that applies to any host.

The second and third only apply to the host with name hostName1 and hostName2 respectively.

Therefore, if you are running mstarrun on the machine hostName1, then valueForSpecificHost1 will be
used; if you are running on hostName2, then valueForSpecificHost2 will be used; and if you are running on
any other machine, valueForAnyHost will be used. For example,

# MineStar Client

client.filename=client.eep

client.JAVA_MEM64=-Xms50M -Xmx768M -XX:MaxPermSize=256m

client.JAVA_MEM64@MN26C001162330=-Xms50M -Xmx1024M -XX:MaxPermSize=256m

client.JAVA_MEM64@MN26C001162331=-Xms50M -Xmx1024M -XX:MaxPermSize=256m

... etc

Page: 201 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Advanced Fleet configuration

Here, if the client is running on MN26C001162330 or MN26C001162331, then max mem is set to 1024M. For
any client running on any other machine, max memory is 768M.

Release 4.4.x © Caterpillar 2001-2016 Page: 202 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Fleet system administration
Cat Fleet Admin & Config Manual
Fleet system administration

Introduction
Fleet system administration involves keeping your system safe and secure.

This chapter describes ways in which you can ensure your system is kept safe and secure, providing inform-
ation on using remote access, assigning permissions and roles and using Expert Mode.

Chapter goals
By the end of this chapter, you should:

l Have an in-depth understanding of the security and related requirements of a Fleet installation
l Be able to set up appropriate security, authorization and authentication for your Fleet installation

Page: 205 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Fleet system administration

Security
Remote access
Fleet relies on remote access to perform administration and support tasks, which necessitates the installation
of the appropriate software on site computers. For support and remote monitoring purposes, either a Windows
Terminal Services Client (Windows 2000) or Remote Desktop Connection (Windows XP) will be used to con-
nect to the appropriate server.

This assumes the "remote desktop" option is enabled and that the office software user is part of the allowed
list of administrators for remote desktop.

Fleet security
Fleet security refers to the assigning of permissions to roles, so that anyone who has a particular role can per-
form the tasks associated with that role. In addition to roles, the office software uses Expert Mode to expose
further controls and functionality. Expert Mode is available in both the office software Client and Supervisor.

Using a combination of role permissions and Expert Mode, you can tightly control which functionality is avail-
able to which the office software users.

Expert mode
You use Expert mode to expose functionality in the office software Client and Supervisor that is not typically
needed on a day-to-day basis. Expert Mode is password protected, and this password should only be granted
to authorized or qualified personnel so that they can perform certain lower-level functions. A typical office soft-
ware user, for example, does not have the ability to delete entities, but in Expert Mode this and other func-
tionality becomes available.

NOTE: Expert Mode functionality is displayed in red in the office software menus.

To enable Expert Mode

1. On the View menu, click Expert Mode. The Expert Mode Password Prompt dialog box displays.
2. Enter the appropriate password, and then click OK. A plus (+) symbol in the Status Bar indicates that
you are now in Expert Mode.

Release 4.4.x © Caterpillar 2001-2016 Page: 206 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Fleet system administration

To change the password for Expert Mode

1. Start Supervisor, and on the Contents menu, point to Setup and then click System Options.
2. Select Platform – Clients in the Product list and then click the type of client whose password you
want to change, for example Explorer – Client or Explorer – Supervisor.
3. On the General tab, enter the required password in the Expert Mode Password field, and then click
Apply.
You need to restart the Client or Supervisor for your change to take effect.

Permissions and roles


Use Supervisor to configure the permissions for each role in the office software. Permissions are granted
firstly according to the global permissions, and then on a page-by-page basis for each defined role. Per-
missions are defined for each of the actions and fields on the page.

Global permissions and inheritance

To simplify the application of permissions, you can specify global permissions to grant or deny access to
pages, jobs and tools and also for many page actions for each of the defined office software roles. You can
then elect to inherit the global permissions for any page action, rather then specifying permissions for each
role at the page level.

For example, the Edit action is typically only available to Mine Controllers and Builders, and this is specified
in the global permissions. When you specify the permissions for a page that has an Edit action, you can
choose Inherit as the permission level, and Mine Controllers and Builders are automatically granted that per-
mission.

To specify global permissions

1. Start Supervisor, and on the Contents menu, point to Management and then click Permissions.
2. In the Product list, choose Global to display the global action permissions page.
3. For each of the permissions tabs, specify the required permissions for each role, and then click Apply.

Table of global permissions options

Permission Type Description

Specifies which user roles can access each of the


Page Access
pages in the office software.

Page: 207 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Fleet system administration

Permission Type Description

Specifies which user roles can access and use the vari-
Job Access ous jobs in the office software, such as activating data
loggers and importing VIMS data.

Specifies which user roles can access and use the vari-
Tool Access ous tools in the office software, such as importing per-
sonnel data and validating roads or waypoints.

Specifies which user roles can access each of the page


Page Actions
actions in the office software.

Specifies which user roles can access and use actions


Client Actions in the office software such as save-desktop, toggle-
expert-mode.

Page-level permissions

Page-level permissions provide more granular control over the permissions of each role. You can override the
permissions specified at the global level by adding or removing roles and permissions. There is a permissions
entry for each page.

Page-level permissions also provide access to the permissions of each action and field on individual pages.
Due to the diverse nature of the office software pages, only a subset of the actions and fields are available for
global configuration; the remainder must be specified at the page level.

NOTE: In the Global Category, there is a Road Segment Editor permission, and a Road Segments
Editor position.
The Road Segment Editor is the Editor permission for a single road. It allows you to open the Road
Segment Assistant, Site Monitor or Site Editor, select a single road, and click Open.

Release 4.4.x © Caterpillar 2001-2016 Page: 208 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Fleet system administration

The Road Segments Editor permission is the Editor permission for multiple roads. It allows you to
open the Site Monitor or Site Editor, select multiple roads, and click Open.

NOTE: In the Global Category, there is a Display Monitor permission. This allows the user to view the
KPI pages in both the MineStar client and web client.

To specify permissions for a role

1. Start Supervisor, and on the Contents menu, point to Management and then click Permissions.
2. Use the Product and Category lists to find the page whose permissions you want to change.
3. Select or clear the check boxes for each action and field for the required role, then click Apply.

Permission options

The permission options vary according to the actions and fields on each page. Some pages have very few
options, such as view and edit, while others have multiple actions and fields, such as activate, delete, open,
rename, etc.

Role options

You can specify permissions for each of the defined roles in the office software, such as Mine Controller,
Builder, etc. Use this method of assigning permissions if the higher level methods (Anyone and Inherit)
provide insufficient control.

For any action or field, you can specify that permissions be inherited from global settings. If you select Inherit
for an action or field, then the permissions defined in the global settings apply. You can extend the global per-
missions by selecting further roles as required. If you clear the Inherit check box, the global settings are
ignored.

Some pages, such as certain monitors, finders, etc., should be accessible by anyone. In these cases, use a
permissions setting of Anyone.

NOTE: For security purposes, you should limit the use of the Anyone permission.

Page: 209 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Fleet system administration

Using automatic login


You can configure certain clients to bypass the standard login process, and automatically connect to a running
system. This can be useful in a testing or other tightly controlled environment, but generally should not be
used on a production system.

There are several ways of using automatic login:

l Setting the appropriate options in Supervisor


l From the command line
l Creating single-page clients with the login details preconfigured. The use of single-page clients is dis-
cussed in a separate section.

Configuring Automatic login in Supervisor

You can include all the required login details in Supervisor so that the office software Clients start auto-
matically. This is the easiest way to set up automatic login but also the most insecure, since it provides
access to the system for anyone who has access to the computer. It is recommended that this procedure not
be used on a production system.

1. To configure automatic login in Supervisor


2. On the Contents menu, point to Setup and then click System Options.
3. In the Product list, choose Platform – Clients, and then click the option set for the client, Explorer –
Client.
4. On the Login Dialog tab, choose Always skip login dialog on start-up in the Automatic Login
list.
5. In the User and Password fields, enter the appropriate details for the login account that you want to
use, and then click Apply.

Using Automatic login from the command line

You can start the office software Client from the command line and specify login details and other options to
suit your immediate needs. This bypasses the security risk of having a user name and password pre-
configured in Supervisor, and avoids the extra time required to create configuration files for single-page cli-
ents.

To use automatic login from the command line

l Open a command shell, and run the following command:


mstarrun client -ptryAutoLogin:true -puser:<userName>

Release 4.4.x © Caterpillar 2001-2016 Page: 210 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Fleet system administration

where:
<userName> and <password> are required for a valid office software user account.

You can add further options to the command line as required, for example, the office software page to open
and the page configuration to use. To open the Cycle Assistant using the Drill Cycle configuration, enter the
following command:
mstarrun client -ptryAutoLogin:true -puser:<userName>

-ppasswd:<password> -phome:Cycle Assistant,

-ppageConfiguration:Drill

Refer to the mstarrun Command Reference chapter for more information on the available command line
options for mstarrun.

Using single-page clients


You can configure your office software Client to open only a single page, and to remove the default navigation
tools, etc. This is useful if you want to make the office software available to different people but to tightly con-
trol the access that they have. For example, you can specify that only the Delay Monitor be visible so that a
user can track delays in the office software, but they can’t interact with the system.

You can also specify any login parameters, the default system, etc., so that the user does not need to know
specific details about the system. This is useful for casual users of the system who may not have regular
login accounts or who have other specific requirements.

Configuring single-page clients

Two steps are required to configure a single page client: creating the office software Explorer preferences file
(eep file); and creating the appropriate command to start the office software Client using that file.

Creating the office software Explorer preferences file

We have used the Delay Monitor in this example.

To create an Explorer preferences file

1. Navigate to the following directory:


\mstarFiles\systems\<systemName>\config\explorer\
2. Create a subdirectory called bin.
This is where you will save your Explorer Preferences files, to ensure that they are retained whenever
you upgrade the office software.

Page: 211 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Fleet system administration

3. Create a text file called <requiredPage>.eep in this directory.


For example, if you want to open only the Delay Monitor, you should create a file called DelayMon-
itor.eep.
4. Add the following line to the preferences file:
home = <requiredPage>
In this example, this line would be:
home = Delay Monitor
5. Save and close the file.
6. To test the new page configuration, enter the following at the command line:
mstarrun client SinglePage.eep DelayMonitor.eep

The office software Explorer should start and display the Delay Monitor with the Contents menu disabled.

Creating the single-page Explorer command

The easiest way to make use of the single-page preferences file is to create a desktop shortcut. We have
used Delay Monitor in this example.

To create a desktop shortcut for a single-page client

1. Make a copy of an existing office software Client desktop shortcut.


2. Edit the properties of the shortcut so that the target reads as follows:
d:\mstar\mstarHome\bus\bin\mstarrun.bat client SinglePage.eep
DelayMonitor.eep
3. Rename the shortcut to Delay Monitor.

Further configuration of single-page clients


There are numerous options that you can use to configure the office software. You can set the initial window
size, specify the login name to use or whether to skip the login process completely. You can specify whether
to display various window decorations, etc.

For examples of the types of configurations that you can create, refer to the ExamplePage.eep file in the fol-
lowing directory:

\mstar\mstarHome\explorer\bin

Release 4.4.x © Caterpillar 2001-2016 Page: 212 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Database administration
Cat Fleet Admin & Config Manual
Database administration

Introduction
The Fleet databases are an essential and integral part of the office software system, and require regular mon-
itoring and periodic maintenance to ensure optimum performance of the system as a whole.

This chapter describes and details the various databases involved and how to perform them essential mon-
itoring and administration tasks.

Chapter goals
By the end of this chapter, you should:

l Understand the requirements for maintaining the office software database


l Be able to perform essential database administration and configuration tasks
l Understand the backup and recovery procedures for the office software database

Page: 215 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Database administration

Fleet datastores
During the course of its normal operation, reporting and maintenance procedures, Fleet uses the following
datastores, named as follows:

l Model
l Historical
l Summary
l Reporting
l Template

The default configuration creates all datastores in a single database instance (MINESTAR). Although you can
change this to use up to three database instances (MODEL, MINESTAR and SUMMARY), it is not recom-
mended, and you should follow your site support procedures first for consulting Fleet Customer Support.

Model datastore
The Model datastore stores information about the Mine Model. It defines all static entities, such as fixed and
mobile equipment, fleets, operators and crews, waypoints, roads, calendars, shifts, etc.

Historical datastore
The Historical datastore records all information generated by the office software. This includes all field net-
work events that are sent to and from machines, field equipment cycles and their components, such as activ-
ities, road segments traveled and any delays that occurred during the cycle. Certain types of historical entities
have an associated retention period, which specifies how long the entities should be maintained in the data-
store before being archived.

Summary datastore
The Summary datastore records KPI information that is calculated by the KPI Summaries component of
MineStar. This information is used mainly for reporting purposes.

Reporting datastore
The Reporting datastore contains the Business Objects Reporting repository, which defines all standard
reports that are available in the office software. These reports are run against either the Historical or Summary
datastore connection.

Release 4.4.x © Caterpillar 2001-2016 Page: 216 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Database administration

Template datastore
The Template datastore is an empty data schema that defines the physical structures of database objects,
such as tables and indexes, as defined in the office software metadata.

Page: 217 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Database administration

Database monitoring
Monitoring your databases is an essential part of ensuring that your office software system continues to per-
form correctly and efficiently. The office software provides several tools to help perform these monitoring
tasks.

Taking a snapshot of your database


Use the snapshotDb utility to collect information about the office software datastores. This is executed as
part of the regular Scheduled Tasks activities, which are created during the initial Fleet configuration steps.
(See "Setting up scheduled tasks" on page 79.) The resulting database snapshot report is written to a file
which is included in a system Snapshot for that server. This file is named using the following convention:

snapshotDB_<COMPUTER>_H_<HHMM>.txt

Snapshot contents
The database snapshot reports a number of vital statistics to the Fleet DBA:

l Oracle Home and Version of Oracle RDBMS software


l Disk space situation of Oracle data file volumes
l Oracle Tablespace statistics
l Top 10 storage segments by size
l Schema statistics of all users in the database instance
l Historical Datastore Entity counts
l Current connections (at the time of the snapshot)

The database administrator can monitor these statistics and estimate the growth of the database. This
provides opportunity to identify any potential storage or security issues and to schedule database reor-
ganization procedures (see following sections).

Release 4.4.x © Caterpillar 2001-2016 Page: 218 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Database administration

Database upgrades
Database upgrades are performed as part of an application upgrade. Use the makeDataStores utility to per-
form this upgrade. This utility is the only mechanism available for making changes to the database structures.

Database configuration changes


Even though it is possible to change the database configuration settings of an existing system, it is recom-
mended that all changes from the default settings be performed during the installation and initial configuration
of the office software. See Configuring system options for further information.

NOTE: You should discuss any proposed database configuration changes with Fleet Customer Sup-
port.

Changes to the database settings of an existing system require the migration of the following datastore entit-
ies to a new datastore:

l Model – This is to preserve the correct mine model configuration of the installation.
l Historical – This is to preserve the production data and associated information.

Database failover & standby databases


In certain situations it is necessary to change the database server or Oracle database instance which hosts
the office software datastores. In the event of a Database Server failure, refer to "Controlled Database server
failover" on page 250 in the chapter.

In situations other than a failure (e.g., a hardware or software upgrade) it may be necessary to switch the
office software to run on Standby databases. This should always be planned well ahead of time and the Data-
base Administrator contacted for assistance.

Page: 219 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Database administration

Backing up your data


Database backups are a critical part of administering the office software, and as such, it is important that they
be performed regularly. Backups can be performed either:

l As part of the office software administration tasks that are automatically run on a daily basis. These
tasks can also be run manually if desired.
l By running export Datastores.

Regardless of the method used to back up the database, backup options are configured using Supervisor.

Daily Backup Process


The exportDataStores application performs daily scheduled backups. This application is executed auto-
matically by a scheduled task, but you can also run it manually from Supervisor.

To run exportDataStores manually from Supervisor

1. On the Contents menu, point to Management and then click Admin Tools.
2. In the Tool list, click exportDataStores.
3. If you want to select all databases, select Database Name.
4. If you do not want all databases, select the check box for each of the databases that you want to
export.
5. If you do not want to zip the exports, select Leave Exports Unzipped. The default action is to zip the
export and then delete the .dmp file.
6. Specify the required output directory, and then click Run. The default output directory is
{MSTAR_BASE_LOCAL}\data.

NOTE: If you are storing your backup files on a remote, or different, server you can add the location to
the Temp DB Output Directory field and move the files at a later time to another location.

Configuring database backup system options


The standard installation of the office software provides default values for most of the database backup sys-
tem options. You can change these values to suit the requirements of your site. Use the Systems – Work-
group Extensions page in Supervisor to change the database backup options.

Release 4.4.x © Caterpillar 2001-2016 Page: 220 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Database administration

To configure database backup options

1. Start Supervisor, and on the Contents menu, point to Setup and then click System Options.
2. In the Product list, select Platform, and then click System – Workgroup Extensions.
3. Use the various tabs to specify the backup options for your database.

See "Archiving data" on the facing page for more information.

Running a manual database backup


If necessary, you can perform a manual database backup using mstarrun on the command line.

To perform a manual database export

l Open a command shell and type the following:


mstarrun exportData <dbName>
where <dbName> is the name of the database to be backed up, e.g., _MODELDB.

Page: 221 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Database administration

Restoring data from backups


There is no single process for restoring lost office software data. This is because each situation in which data
is lost is unique in its own way, and a single process cannot cover every eventuality.

The following guidelines provide a general outline of what to do in the case of a disaster.

Guidelines

l Contact Fleet Customer Support as soon as a problem is noticed. You should not attempt to restore
lost data until you have spoken with Fleet Customer Support personnel.
l If the recommended backup procedures have been followed, data can usually be restored at least up
until the time of the last backup, and frequently beyond this point by using gateway and other saved
files. How much data can be recovered varies on a case-by-case basis.
l Data restoration should only be attempted by a qualified database administrator under close super-
vision from Fleet Customer Support. Upon notification of a problem, a Fleet database administrator will
contact the site and begin the process of recovery.

Archiving data
Archiving data is important for the continued good health of the office software. Disks can fill up over time if
data is not archived correctly and regularly. Archival of data is handled by the cleanExpiredData script.

The archiving process deletes the archived data from the database, and stores it in zip files in the event that it
is ever needed.

One of the scheduled tasks that are generated as part of a standard installation and configuration includes the
cleanExpiredData script, which performs data deletion and archival actions for historical entities as specified
in Supervisor.

To configure data archiving options

1. Start Supervisor, and on the Contents menu, point to Setup and then click System Options.
2. In the Product list, select Platform, and then click System – Workgroup Extensions.
3. Click the Data Archiving tab, and use the various fields to specify the data archival options for your
system.
4. In the Data Retention Policy table, click on the rows in the Retention Policy and Retention Period
columns to change the policy and period.

Release 4.4.x © Caterpillar 2001-2016 Page: 222 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Database administration

NOTE: The default retention is Delete, as using archive requires you to manually maintain files, and
archived files require a lot of disk space.

The defaults set on the Data Archiving tab are shown in the screenshot above.

Transferring data to a FAT32 drive


When you have run a data export, whether automatically or manually, you will not be able to transfer the file to
a FAT32 drive if the file size is greater than 4GB. You will need to convert the drive to NTFS.

To do this, do the following.

1. Open a command prompt window.


2. Identify the drive that you want to transfer the data to (i.e. where your external drive is connected).
3. In the command prompt window type
convert drive_letter : /fs:ntfs

Page: 223 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Database administration

Deleting Data
Data should only ever be deleted via the data archiving process as documented in "Archiving data" on
page 222.

Data should only be manually deleted in extenuating circumstances, and then only under the close super-
vision of a Fleet database administrator.

Release 4.4.x © Caterpillar 2001-2016 Page: 224 / 559


December 2016 Cat Fleet Administration & Configuration Manual
System monitoring
Cat Fleet Admin & Config Manual
System monitoring

Introduction
This chapter describes some of the tools and processes that you can use to monitor the operational efficiency
of the office software, and to ensure that issues are diagnosed quickly. It also covers the auditing capabilities
of the office software, and how it can be used to track changes to the mine model.

Chapter goals
By the end of this chapter, you should:

l Understand the different types of snapshot, and be able to submit a snapshot for analysis.
l Understand and be able to configure auditing of the office software.
l Monitor the performance of your system.

Page: 227 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
System monitoring

Fleet system monitoring


Fleet generates several different types of snapshot, each of which provides different information about the sys-
tem as a whole. These snapshots are used for problem analysis and diagnosis, for performance monitoring
and also to provide suitable failover files in case of disaster.

Types of snapshot
Fleet generates the following types of snapshots:

System Snapshot

Captures the state of the system to a zip file.

There are three types of system snapshot: User, System, and Standby.

When running Snapshot System from the Tools menu, you have the option to also include DXF files and
include Onboard files in the snapshot.

You can also set a temp directory for the System Snapshot.

Operating system Snapshot

Captures the state of the Operating System to a log file.

There are two types of Operating System snapshot: User and System.

Database Snapshot

Captures the state of the specified database.

There are two types of Database snapshot: User and System.

System snapshots
System snapshots capture the current state of the office software and the collected files as a compressed zip
file. The contents of System snapshots and User snapshots are the same, however System snapshots are ini-
tiated automatically by the System Scheduler, while User snapshots are initiated manually. The age of the
files collected for System snapshots versus User snapshots is defined by the Lookback Hours value spe-
cified in Supervisor.

Release 4.4.x © Caterpillar 2001-2016 Page: 228 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
System monitoring

Standby snapshots are also initiated automatically by the System Scheduler, and contain a different data set,
as their purpose is to provide enough information to quickly bring up a standby system in case of failure.

System snapshots are saved to the directories specified in Supervisor. See Configuring system directories for
more information on setting up directories.

User and System Snapshot Contents

User and System snapshots contain the following data:

l MSTAR_CONFIG and its subdirectories


l MSTAR_LOGS
l MSTAR_MESSAGES
l MSTAR_SYSTEM and its subdirectories
l MSTAR_TRACE
l MSTAR_TMP

Standby Snapshot Contents

Standby snapshots contain the following data:

l MSTAR_CONFIG and its subdirectories


l MSTAR_DATA
l MSTAR_SYSTEM and its subdirectories
l Shortcut directories

Operating System Snapshots

Operating System snapshots contain the list of Operating System processes that were running when the snap-
shot was initiated, and a list of statistics about any additional volumes that the office software monitors for
available space.

The contents of the System snapshots and the User snapshots are the same, however System snapshots
are initiated automatically by the System Scheduler, while User Snapshots are initiated manually.

Operating System snapshots are saved to the Process Logs Directory specified in Supervisor. "Configuring
system directories" on page 64for more information on setting up directories.

Page: 229 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
System monitoring

Database Snapshots

Database snapshots contain an export of the specified database, and a log file which provides details of the
export.

The contents of the System snapshots and the User snapshots are the same, however System snapshots
are initiated automatically by the System Scheduler, while User Snapshots are initiated manually.

Submitting snapshots for analysis


System and User snapshots are automatically copied the Outgoing Directory. A separate process controls
the transfer of the snapshots to Fleet Customer Support. When the snapshot has been successfully trans-
ferred, the snapshot file is moved to the MSTAR_SENT directory, where it is kept until its retention period has
expired.

Deleting aged snapshots


Aged snapshots are deleted as part of the standard office software housekeeping processes. A scheduled
task inspects the age of each appropriate file type, and these files are marked as ready for deletion according
to the settings in Supervisor. The next time this scheduled task executes, those files are deleted.

Configuring deletion of aged snapshots

Use Supervisor to configure the retention period of snapshots and other files. Two values are specified: the
time before marking any files (indicates that the files are ready to be deleted); and the time before actually
deleting any files.

This configuration applies to numerous file types, not only snapshots. Ensure that the values specified here
are suitable for all file types that are affected. This configuration affects the following file types:

Extension Description

log Log files from snapshots and other processes.

Temporary files generated by various office software


tmp
operations.

txt Text files.

xml Assignment configuration files, etc.

Release 4.4.x © Caterpillar 2001-2016 Page: 230 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
System monitoring

Extension Description

ser Java serialized object files.

dmp Database export files.

zip Compressed.

bat Windows batch files.

properties Fleet configuration files.

To configure the deletion of aged snapshots

1. Start Supervisor, and on the Contents menu, point to Setup and then click System Options.
2. In the Product list, choose Platform and then click System Workgroup Extensions.
3. Click the File Archiving tab, and specify the required periods in the Old Generated Files field.
4. Click Apply to apply the changes.

Troubleshooting failed snapshots


Various aspects of snapshots can fail. This can include the wrong directories or files being added to snap-
shots, snapshots may not be deleted as expected or there may be failures trying to send the snapshots to
Fleet Customer Support.

Incorrect snapshot contents

The main cause of incomplete snapshots is incorrect configuration. You should check the settings in Super-
visor to ensure that all directories are correctly specified for the type of server where the snapshot is being
executed, for example, a Database Server, Application Server or client.

Snapshots fail to transfer to Fleet Customer Support

If snapshots are not being sent to Fleet Customer Support, there may be a problem with the connectivity con-
figuration or with the scheduled task that triggers the transfer of the snapshots. There may also be a problem
with the creation of the snapshots; if snapshots are not created correctly then they are not copied to the appro-
priate directory ready for transfer to Fleet Customer Support.

To check the connectivity configuration

Page: 231 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
System monitoring

1. Start Supervisor, and on the Contents menu, point to Setup and then click System Options.
2. In the Product list, choose Platform and then click System Workgroup Extensions in the Category
list.
3. On the Connectivity tab, ensure that the correct values are specified.

To check the SendToSupport scheduled task

1. Ensure that the appropriate Microsoft Windows Scheduled Task has been created and is enabled.
2. Ensure that the Splinterware System Scheduled is running, and that the appropriate events have been
created. There should be an event with the title sendAllToSupport.

Release 4.4.x © Caterpillar 2001-2016 Page: 232 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
System monitoring

Fleet performance monitoring


A variety of tools are available to monitor the performance of all aspects of your system. This includes the
servers and clients at the operating system level, and also all aspects of the office software and the sup-
porting databases and server applications. Some of these tools are useful to Mine Controllers and General
Users who want to keep an eye on everyday performance, while others are of more use to Builders or System
Administrators as troubleshooting tools.

Windows Task Manager


The Windows Task Manager is a Microsoft Windows utility, and is a useful tool for monitoring various aspects
of both the operating system itself and the various processes and applications that are running.

To start the Windows Task Manager

l Right-click the Windows Task Bar and then click Task Manager.

Page: 233 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
System monitoring

The example screenshot above shows Windows Task Manager displaying various performance data

For information and help on how to use the Windows Task Manager to monitor performance and other aspects
of your system, refer to the Microsoft Windows Task Manager Help.

Office process monitor


The Office Process Monitor is part of the office software client and provides an in-depth view of the many pro-
cesses that occur during the normal operation of the office software system. In some ways it is similar to the
Windows Task Manager, but it only provides information on Fleet processes, and in more detail.

To start the Office Process Monitor

l On the Contents menu, click Diagnostics Pages, and then click Office Processes in the Platform
group.

Release 4.4.x © Caterpillar 2001-2016 Page: 234 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
System monitoring

The example screenshot above shows Office Process Monitor displaying the server processes and a client
connection

Page: 235 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
System monitoring

Auditing
The office software includes an auditing function that keeps track of changes to the mine plan for troubleshoot-
ing and security purposes. Audit files can be viewed in any standard text editor, and include a rolling cryp-
tographic hash which detects or changes deletions.

By default, audit files are written to

/mstarFiles/systems/main/logs/audit/audit_YY_MM_DD_HHMMSS_mmm.log

New files are generated whenever the file size reaches 15 MB, or after 24 hours, whichever is sooner. These
settings can be configured in Supervisor. Refer to the Supervisor Page Reference chapter for details.

Release 4.4.x © Caterpillar 2001-2016 Page: 236 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
System monitoring

Viewing audit files


The office software includes a utility to view and verify audit logs.

To open the audit file viewer

1. Open a command window as an Administrator.


2. Type D:\mstar\mstarHome\bus\bin\mstarrun AuditClient D where D: is the drive where
MineStar is installed.
3. Click Load Audit File (the folder icon on the toolbar).
4. Select a file.
5. Click Open.

The Audit File viewer displays a list of the actions in the log file on the left side of the screen. Select an entry
to view the details on the right of the screen.

CSV audit files


Simplified versions of the audit logs can also be viewed in CSV format. By default, CSV audit files are written
to /mstarFiles/systems/main/logs/audit-csv. These files can be viewed in any application that
supports the CSV format.

Page: 237 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Server failover
Cat Fleet Admin & Config Manual
Server failover

Introduction
This chapter describes the Oracle failover and failback process, types of failover, and the tools used by the
failover process. It also covers the processes for configuring the office software for failover and failback, and
various processes for performing controlled and uncontrolled failovers on various servers.

Fleet uses an N+1 failover architecture, whereby a single failover server is used as the standby server for all
running application servers. The two major sub-systems which may need to be transitioned to the failover
server are the application services and the database.

Chapter goals
By the end of this chapter, you should:

l Understand the failover process.


l Be able to perform both controlled and uncontrolled failovers, and failbacks.

Page: 239 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Server failover

Failover configuration requirements


Application server name

When you start the office software services, the application server name is determined, and shown as a read-
only field in Supervisor on the Server tab, as shown in the screenshot below. This setting is then used by other
processes when they need to determine which machine the office software is running on.

To ensure that the office software is only started on approved servers, and to allow features like snapshots to
determine which machines are valid servers (and so contain the proper information), you can enter all of the
valid server names, (for application, database, standby, and test roles), in the Allowed Server Names field.
If you do not enter any server names, the office software will run on any server.

Release 4.4.x © Caterpillar 2001-2016 Page: 240 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Server failover

NOTE: Some roles may be shared (e.g. standby and test may be the same server). It is only neces-
sary to enter the distinct physical server names which will be used. The screenshot in "Failover con-
figuration requirements" on the previous page shows the Server tab in Supervisor:

Database configuration

The office software database configuration reflects the logical role of the given instance, i.e. PRODUCTION,
STANDBY, TEST.

l The Production server is your main server, and is where your production database is stored.
l The Standby server is the server you will use should your production database fail.
l The Test server is the server you will use for testing data, e.g. before a software upgrade, so that you
do not affect your production database.

When configuring the office software's database settings in Supervisor, you need to define server names for
each of the roles which are to be used for that installation (there is one "Exception to the rule" on page 243
which is described later in this section). Which database server the office software actually uses is determ-
ined by which role is marked as active. The screenshot below shows the database configuration tab in Super-
visor.

Page: 241 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Server failover

To define server names for roles, do the following.

l Beside each Database Role, double-click the Server column, and enter the server name.
l Once you have defined your database servers, you can select the Active Database Role from the
drop-down list.

NOTE: You should only change the Active Database Role if you want to failover to the Standby
server.

Each role with a defined (non-empty) server is included in the Oracle tnsnames.ora file, which is generated
whenever these settings change. In addition, a MINESTAR_REPORTING entry is generated and is set to the
server defined by the currently active role. This allows the Business Objects universes to be configured to use
an Oracle TNS name which remains constant regardless of which database is being used.

Release 4.4.x © Caterpillar 2001-2016 Page: 242 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Server failover

The Oracle tnsnames.ora file is generated on the application server. You must copy the file to
the database server to enable the office software to function correctly.

Exception to the rule

l In some cases, the same database server is used for both standby and testing. In this case, you only
need to define one role-server entry. To ensure the office software uses the required database, you
need to keep the currently defined active role setting the same, but alter the user name for the four
Oracle instances.
l To make this easier, there is a username prefix setting you can use. The default is ms, as shown in the
Name Prefix field in "Failover configuration requirements" on page 240. This prefix is prepended to
each defined username and password to form the actual values used. Thus only the prefix needs to be
changed in order to use a completely different database. For example, where the standby and test
instances are hosted on the standby server, the active role would remain as STANDBY and the name
prefix changed to either std for standby or tst for test to switch between the two databases.

Command line utility

You can use the command line utility, mstarrun switchActiveDatabase, to change the database settings out-
lined above quickly without the need to start Supervisor. The general syntax is
mstarrun switchActiveDatabase [-r role] [-p prefix].

One or both of the -r and -p options needs to be specified. The role will be one of PRODUCTION, STANDBY,
or TEST.

Standby Directory

You set up the Standby Directory on the System Directories page in Supervisor as shown in the screenshot
below.

Page: 243 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Server failover

l Configure the Standby Directory to point to the Systems directory on the standby server. This is done
using a share set up specifically for that purpose.

Both the standby and production systems must use the same drive letter to map the standby
directory share. The production system points to the standby system and the standby system
points to the production system. This ensures that when running the standby application
server, the production server mirrors the standby application server. Therefore, any con-
figuration changes made, and failback, is simplified.

Standby system update and Snapshot frequency

The Standby system update frequency sets the frequency of when the standby system configuration is
updated with a copy of the configuration information, as well as cycle and delay information, from the live sys-
tem.

Set the standby system update frequency on the Failover tab in Supervisor, as shown in "Failover con-
figuration requirements" on page 240 by

Release 4.4.x © Caterpillar 2001-2016 Page: 244 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Server failover

1. Point to Options > System Options, and from the Product list select Platform.
2. From the Option Sets list, select System - Enterprise Extensions.
3. Click the Failover tab, and select the frequency for the standby server synchronization from the
Standby System Update Frequency list. The default is to update the standby system configuration
every 15 minutes.

Setting the Snapshot Frequency generates a standby snapshot file, which is saved and copied to the
standby server. It then unpacks the model database, cycle and delay information, as well as the configuration
information. The snapshot generates everything that the standby system update generates, as well as refresh-
ing the model database with a copy from production, and refreshes the kpisummaries dimension tables.

Set the Snapshot frequency on the Failover tab by

Selecting the Snapshot frequency for the live system from the Snapshot Frequency list. The default is to run
a snapshot every hour.

Page: 245 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Server failover

Server configuration summary


The following table summarizes the key server configuration requirements.

Server Configuration Setting Explanation

Maps to the \mstarFiles\systems directory on the


standby server. This directory needs to be shared on
the standby server in the same way that the cor-
responding share is set up on the production server.
APPLICATION Standby Directory
Used when ensuring standby server settings are in
sync with application server and also to define the
top level folder where the standby snapshot is
copied.

Define servers used to host the PRODUCTION,


APPLICATION Database servers
STANDBY and TEST database instances.

APPLICATION Active database role Defines which database instance is active.

Defines the name of machines which are allowed to


APPLICATION Allowed servers
run the office software.

How often to copy production system configuration


settings to standby server (default every 15 minutes).
Standby System Update Fre-
APPLICATION This scheduled copying is in addition to the rep-
quency
lication which occurs when Supervisor is used to
change some settings etc.

Release 4.4.x © Caterpillar 2001-2016 Page: 246 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Server failover

Server Configuration Setting Explanation

How often to take a standby snapshot of the pro-


duction system. This snapshot includes application
data and is copied to the standby server. Once the
APPLICATION
Snapshot Frequency snapshot is taken, a task runs which extracts the
and STANDBY
application data (model, cycles, delays, kpi sum-
maries dimensions) and ensures the standby data-
base is up-to-date.

Preparation of Standby server


The standby server needs to be installed and configured similarly to the way the production server has been
set up. If a brand-new standby server is being commissioned, the general steps are as follows.

1. Install Fleet, Oracle and share the mstarFiles\systems directory.


2. Duplicate the production server settings on the standby server.
Take a standby snapshot from the correctly configured production system and run
mstarrun initSystemFromSnapshot.
3. Ensure the tnsnames.ora file from the production server is copied across to the standby server.
4. Ensure that the standby database will be used for the next step by running
mstarrun switchActiveDatabase -r STANDBY on the standby server.
5. Create a standby database using the command
mstarrun createDataStores SERVER <drives> where <drives> = the relevant drives on
your system.
6. Create scheduled tasks using the command mstarrun makeScheduledTasks all.

Page: 247 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Server failover

Uncontrolled and Controlled Oracle server failover


step-by-step processes
Uncontrolled vs controlled failover
An uncontrolled failover is when something goes wrong with your system and there is no opportunity for any
planning, or snapshots of the data.

A controlled failover is when the process is controlled, there is the opportunity to create a standby snapshot at
the point of cutover to ensure that the latest production information can be copied to the standby server. In this
case, the creation of the snapshot and its unpacking on the standby system is performed manually rather than
via scheduled tasks. This process is also to be used for system upgrades.

NOTE: Some of the following procedures contain the


mstarrun switchActiveDatabase command. This command should be run on the server
which will be used as the application server to run the office software. The server on which you should
run the command is identified in bold text.

Uncontrolled Application server failover

The application server is where the office software is running. If the server fails, you need to do an application
server failover.

The process for an uncontrolled application server failover is

1. If the office software is still running, shut down the office software on the production server.
2. Disable the field comms network interface on the production server, and start the field comms network
interface on the standby server.
3. On the production server, stop the system scheduler and disable the Windows scheduled task which
restarts the system scheduler if it is not running.
4. Start the office software on the standby server, and run
mstarrun makeScheduledTasks AppServer.
5. Start the office software on the standby server.

Release 4.4.x © Caterpillar 2001-2016 Page: 248 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Server failover

Uncontrolled Database server failover

The database server holds the office software database. If the database server, or the database disk drive or
other database failure occurs, you need to do a database server failover.

The process for an uncontrolled database server failover is

1. Shut down the office software on the production server.


2. Switch the active database role using the command
mstarrun switchActiveDatabase -r STANDBY on the production server.
3. Start the office software again on the production server.
4. On the standby server run mstarrun makeScheduledTasks DbServer.

Uncontrolled system failover

If both the application and the database servers fail, or both are on a single server that fails, you need to do a
system failover.

The process for an uncontrolled system failover is

1. If the office software is still running, shut down the office software on the production server.
2. Disable the field comms network interface on the on production server, and start the field comms net-
work interface on the standby server.
3. On the production server, stop the system scheduler and disable the Windows scheduled task which
restarts the system scheduler if it is not running.
4. Switch the active database role using the command
mstarrun switchActiveDatabase -r STANDBY on the standby server.
5. Start the office software again on the standby server.
6. On the standby server run mstarrun makeScheduledTasks AppServer DbServer.

The main difference between the uncontrolled and controlled failover is that during a controlled failover you
have the opportunity to take a standby snapshot after the office software has been stopped. The sequences
for controlled failovers follow.

Page: 249 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Server failover

Controlled failover common tasks

The scheduled failover and failback jobs SyncStandbyInformation and snap-


shotSystem STANDBY should not overlap, and should not be run at the same time.
This causes a lock error.

1. If the office software is still running, shut down the office software on the production server.
2. Run a standby snapshot using the command
mstarrun snapshotSystem STANDBY on the Production server.

If the standby directory has been correctly configured, and the failover database is running, the standby
system will be fully updated with the latest information from the production system. At this point, the
procedure is identical to that for an uncontrolled failover.

3. If you are performing a controlled application server failover, continue to "Controlled Applic-
ation server failover" below. If you are performing a controlled database server failover, go to
"Controlled Database server failover" below. If you are performing a controlled system failover,
go to "Controlled system failover" on the next page.

Controlled Application server failover

4. Disable the field comms network interface on the on production server, and start the field
comms network interface on the standby server.
5. On the production server, stop the system scheduler and disable the Windows scheduled task
which restarts the system scheduler if it is not running.
6. Start the office software on the standby server, and run mstarrun makeScheduledTasks
AppServer.

Controlled Database server failover


4. Switch the active database role using the command
mstarrun switchActiveDatabase -r STANDBY on the production server.

Start the office software again on the production server.

On the standby server run mstarrun makeScheduledTasks DbServer.

Release 4.4.x © Caterpillar 2001-2016 Page: 250 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Server failover

Controlled system failover

The process for a controlled system failover is

4. Disable the field comms network interface on the on production server, and start the field
comms network interface on the standby server.
5. On the production server, stop the system scheduler and disable the Windows scheduled task
which restarts the system scheduler if it is not running.
6. Switch the active database role using the command
mstarrun switchActiveDatabase -r STANDBY on the standby server.
7. Start the office software again on the standby server.
8. On the standby server run mstarrun makeScheduledTasks AppServer DbServer.

Page: 251 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Server failover

Overview of Oracle failback


The failback process is similar to a failover process in the other direction.

When carrying out a failback, the mstarrun initProdSystemFromSnapshot task is used.

1. For application server failback, it extracts configuration information from the standby snapshot and
applies it to the office software on the production system.
2. For database server failback, it
l replaces the current model database with the one from the snapshot on the standby system.
l merges historical and summaries data from the standby system back into the production data-
base using the mstarrun migrateStandbyDataToProduction task.

NOTE: For Advanced Users Only


The default behavior of the historical merge operation is to copy all standby historical data back to pro-
duction. Normally, the standby system will only be used for a short time (either during an upgrade or to
perform server maintenance, etc) so the volume of data to migrate should be manageable. If the
standby historical data is of a significant size, (say, more than a week’s worth), it is possible to initially
migrate just the essential historical data (cycles, delays etc), running the
mstarrun initProdSystemFromSnapshot -e command line option.
Once the office software has been restarted, the remaining historical data can be merged across using
the mstarrun migrateStandbyDataToProduction -n command. This is shown in the illustration
below.

Release 4.4.x © Caterpillar 2001-2016 Page: 252 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Server failover

Page: 253 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Server failover

Oracle Server failback process


Switch back to production system after outage
The failback process for switching back to the production system after an outage is described below.

On the standby server

1. Shutdown the office software and create a standby snapshot on the standby server. The snapshot file
(.zip file) is put into \mstarFiles\systems\main\admin.
2. Copy the snapshot (.zip) file from the standby server to the production server.
3. Disable the field comms network interface on the standby server.
4. On the standby server, stop the system scheduler and disable the Windows scheduled task which
restarts the system scheduler if it is not running.

On the production system

1. Start the field comms network interface on the production server.

NOTE: You should also now start the comms server process on the production server in order to avoid
the field network being flooded by retry messages.

2. On the production server run


mstarrun initProdSystemFromSnapshot [-a|-d] [-e] <snapshotfile>.
l use -a for application server failback, -d for database server failback. The default is both.
l You can also use the -e option to migrate just the essential historical data (cycles, delays etc).
3. Start the remaining components of the office software on the production server in the correct order.
4. If the -e option was used in step 2, run
mstarrun migrateStandbyDataToProduction -n.
5. Start the system scheduler and enable the Windows scheduled task which restarts the system sched-
uler if it is not running.

Release 4.4.x © Caterpillar 2001-2016 Page: 254 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Server failover

Troubleshooting
This section explains the procedure you must follow before calling Fleet Customer Support.

Configuration
The following checks must be made during the configuration of the Failover STANDBY database envir-
onment:

l The tnsnames.ora file must have correctly defined service names for MINESTAR_PRODUCTION
and MINESTAR_STANDBY on both database servers and these must be identical to each other.

NOTE: A problem can occur when using text editors other than Notepad.Exe to manually change the
contents (e.g. Emacs will replace <end-of-line> with another <ctrl> character and this renders the file
useless to the Sql*Net client and/or the Oracle server.

Database Failover
The following checks should be made when validating the operation of the snapshotSystem STANDBY task:

1. Connect to the STANDBY Model using Sql*Plus and execute the following:

SQL> purge user_recyclebin;

SQL> alter session set nls_date_format = 'DD-MON-RR HH24:MI:SS';

SQL> select object_type, min(created), max(created) from user_objects

2 group by object_type;

This should result in something similar to:

OBJECT_TYPE MIN(CREATED) MAX(CREATED)

------------------- -------------- ------------------

PROCEDURE 30-JAN-09 09:43:21 30-JAN-09 09:43:22

DATABASE LINK 28-JAN-09 11:07:09 28-JAN-09 11:07:09

PACKAGE 30-JAN-09 09:43:22 30-JAN-09 09:43:22

PACKAGE BODY 30-JAN-09 09:43:22 30-JAN-09 09:43:22

Page: 255 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Server failover

LOB 30-JAN-09 09:43:10 30-JAN-09 09:43:13

TABLE 30-JAN-09 09:42:48 30-JAN-09 09:43:21

INDEX 30-JAN-09 09:42:48 30-JAN-09 09:43:21

where the times indicated are those of when the 'snapshotSystem STANDBY' was run.

2. Obtain the number and latest endtime for a CYCLE, which should be close to the time the 'snap-
shotSystem STANDBY' was run:

SQL> select count(*) from cycle;

COUNT(*)

----------

57

SQL> select max(endtime) from cycle;

MAX(ENDTIME)

------------------

30-JAN-09 09:41:36

3. Obtain the number and latest starttime for a DELAY which should be close to the time the 'snap-
shotSystem STANDBY' was run:

SQL> select count(*) from DELAY;

COUNT(*)

----------

80

SQL> select max(start1) from delay;

MAX(START1)

------------------

30-JAN-09 09:36:50

Database Failback
The following checks should be made when validating the database failback operation:

Release 4.4.x © Caterpillar 2001-2016 Page: 256 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Server failover

1. After running mstarrun initProdSystemFromSnapshot -d -e connect to the PRODUCTION


Model and check the latest table creation date:
SQL> select object_type, min(created), max(created) from user_objects
2 group by object_type;
These should reflect the time the process was run.
2. Connect to the STANDBY Historical database and run the following SQL to verify that Cycles and
Delays have been migrated from the STANDBY database to the PRODUCTION database. First
determine how many Cycles exist in the STANDBY Historical database in total, then check against
the PRODUCTION database:

SQL> select count(*) from CYCLE;

COUNT(*)

----------

77

SQL> select count(*) from CYCLE where CYCLE_OID in


2 (select cycle_oid from CYCLE@PJV30HIST_MINESTAR_PRODUCTION);

COUNT(*)

----------

77

3. Repeat the above for Delays.

Page: 257 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Server failover

SQL Server failover


For failover/failback setup on SQL Server, both the Production and Standby servers should be linked. To do
this you need to open the MSTDC connection on both servers.

Perform the following steps.

1. Click Start, and in the Search Programs and Files box, enter dcomcnfg.

2. Select dcomcnfg.exe. This opens the Component Service Window.

Release 4.4.x © Caterpillar 2001-2016 Page: 258 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Server failover

3. Expand the Console Root folder, and then the Component Services > Computers > My Computer
> Distributed Transaction Coordinator folders to display Local DTC as shown in the screenshot
above.
4. Right-click Local DTC and click Properties.
5. Click the Security tab.
6. Select all check boxes, as shown in the screenshot below.

7. Click OK and close all open windows.

Page: 259 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Calendar administration
Cat Fleet Admin & Config Manual
Calendar administration

Introduction
Fleet uses calendars to divide time into periods, which are further divided into shifts. Different mines might
use different start times for different periods, and different numbers of shifts for each period. You can also com-
bine 8-hour shifts and 12-hour shifts in the same period.

The periods and shifts that comprise Calendars are used to create rosters, and the various crews defined in
the office software are then assigned to these rosters.

Chapter goals
By the end of this chapter, you should:

l Understand what a Calendar is and how it is used


l Know how to configure default values for Calendars
l Know how to format the display of periods and shifts

Assumptions
This chapter assumes that you know and understand what the site requirements are for configuring periods
and shifts.

Page: 261 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Calendar administration

Understanding calendars
Calendars are comprised of periods, which are further divided into shifts. Calendars have the following char-
acteristics:

l Each calendar can define only one type of time period, but you can define any number of calendars
l Each time period has only one start and one end, with no gaps between these times
l Time periods are defined with millisecond precision; the display precision depends on the specified
format
l Time periods in any single calendar can not overlap

Defining calendars
To define a Calendar you need to define the time periods that comprise that calendar. To do this, you specify
the start time for each of the required periods, and from them derive the end times. From an operational point
of view, this can be extended to creating the shifts and then the rosters that are used by the office software in
everyday operation.

The process for setting up calendars and reporting periods in the office software can be summarized as fol-
lows:

1. Specify the default number of shifts per day and the names for those shifts
2. Specify the start parameters for periods and the names for those periods
3. Specify a range of dates for which to create shifts
4. Create rosters for the shifts

The first two steps are performed in Supervisor and are described below. Steps 3 and 4 are performed in the
office software. Refer to the Fleet User Manual for instructions on specify date ranges and creating rosters.

Working with calendars


You use Supervisor to specify the default reporting periods and shifts which comprise Calendars. Changes to
these default values only affect newly created shifts; existing shifts are not affected.

Release 4.4.x © Caterpillar 2001-2016 Page: 262 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Calendar administration

Defining periods
The office software provides default values for all period properties, but you should check that these default
values are suitable for your mine site, and update them as necessary.

To specify default calendar periods

1. Start Supervisor, and on the Contents menu, point to Management and then click Calendar
Defaults.
2. Display the Periods tab, and specify the various period values to suit your mine.
3. Click Period Naming and specify the required format for each of the periods, and then click Apply.

Defining shifts
The office software uses 12-hour shifts by default when creating calendars, but you can also create 8-hour
shifts for any number of days of the week. For example, you can create 12-hour shifts for Monday to Friday
and 8-hour shifts for the weekend.

To specify default shift values

1. Start Supervisor, and on the Contents menu, point to Management and then click Calendar Defaults.
2. Display the Shifts tab, and specify the various shift values to suit your mine.
3. Select the minimum amount of months ahead the shift will be scheduled for.
4. Click Shift Naming and specify the required format for each of the shifts, and then click Apply.

Defining non-standard calendars


If you have a non-standard calendar month, for example the month on site starts three days before the start of
the month on the calendar, you can edit the MineStar.overrides file. In the
MineStar.overrides file add the lines

com.mincom.util.calendar.Config.Default_Months.offset=-3 days
com.mincom.util.calendar.Config.Default_Months.name=Month {1, date,MMM yyyy}

The change is that the default is 0 where there is a 1 above.

You can use the following numbers and change the format to extract the relevant parts of the date for forming
the name of the time period.

0 - start time

Page: 263 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Calendar administration

1 - finish time

2 - 1 millisecond after the finish time (in case the shift ends at midnight)

3 - halfway through the time period

4 - 24 hours after the start time

5 - 24 hours before the finish time

6 - 7 days after the start time

7 - 7 days before the finish time

Edit the CONTENTS line as follows.

CONTENTS=/explorer/bin/client.eep,minestar.pitlink.service.awareness.Config,
/explorer/bin/supervisor.eep,
com.mincom.util.calendar.Config,
com.mincom.works.cc.cycle.test.Config,com.mincom.integ.cat.equip.Config,
/MineStar.properties, /Versions.properties

NOTE: You must have com.mincom.util.calendar.Config,there by default. If it is not there


all the other lines will be removed.

Building shifts and creating rosters


For information on building shifts and creating rosters, refer to the Fleet User Manual.

Release 4.4.x © Caterpillar 2001-2016 Page: 264 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Oracle RMAN implementation
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

Introduction to this section

This section is not required for a successful install of MineStar or Oracle. Please contact
your Caterpillar Support team for more information and assistance with installing this
product.

Scope
This section contains information and instructions for implementing Oracle RMAN.

Audience
This section is for the following:

l Database, Reporting and Application


l Builder.

Page: 267 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

Implementing Oracle RMAN


Oracle RMAN allows you to backup and recover your Oracle databases, and has the ability to:

l perform incremental backups


l back up the control file and the SPFILE
l enforce the retention policy for archive redo log files
l report the files needed for the backup
l restart the failed backup from the point of failure, without starting from the beginning. This is much
faster, when compared with other traditional backup strategies.

Disk size requirements


It is recommended that you have a 200GB separate disk kept for RMAN.

This is based on the 21 days backup retention policy and 150GB DB size, with the archive log enabled for the
database. Having this much disk size may be change depending on your database size.

Creating a separate catalog database


To create a separate catalog database

1. Click Start > All Programs > Oracle - OraDb11g_home1 > Configuration and Migration Tools >
Database Configuration Assistant. The Welcome screen displays.
2. Click Next.

The Operations screen displays.

Release 4.4.x © Caterpillar 2001-2016 Page: 268 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

3. Select Create a Database, and click Next.

The Database Templates screen displays.

4. Select Custom Database, and click Next.

The Database Identification screen displays.

Page: 269 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

5. In the Global Database Name enter RMAN. The SID field is dynamically filled.
6. Click Next.

The Management Options screen displays.

7. Clear the Configure Enterprise Manager check box.


8. Click Next.

Release 4.4.x © Caterpillar 2001-2016 Page: 270 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

The Database Credentials screen displays.

9. Select Use the Same Administrative Password for All Accounts.


10. In the Password field enter mine1star, and enter the same password in the Confirm Password field.

A dialog will display, as shown below, indicating that the password does not satisfy Oracle
recommended password complexity. You can ignore this message and click Yes.

The Database File Locations screen displays.

Page: 271 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

11. Select Use Common Location for al Database Files.


12. Click the Browse button beside the Databases File Location field and locate the directory
\mstar\Data\oradata\RMAN.
13. Click Next.

The Recovery Configuration screen displays.

14. In the Flash Recovery Area field, enter or browse to the path for the flash back recovery area.
15. In the Flash Recovery Area Size field enter 3696 and ensure M Bytes is selected.

Release 4.4.x © Caterpillar 2001-2016 Page: 272 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

16. Click Next.

The Database Content screen displays.

17. Ensure the Oracle Text check box is cleared, and the Enterprise Manager Repository check box is
selected.
18. Click Standard Database Components.

The Standard Database Components screen displays.

Page: 273 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

19. Ensure only the Oracle JVM and Oracle XML DB check boxes are selected. Clear the other check
boxes.
20. Click OK to close the dialog.
21. Click Next.

The Initialization Parameters screen displays.

22. On the Memory tab, ensure Typical is selected.


23. In the Memory Size (SGA and PGA) field, enter 1024.
24. Ensure Use Automatic Memory Management is selected.
25. Click Next.

The Database Storage screen displays.

Release 4.4.x © Caterpillar 2001-2016 Page: 274 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

This screen is for informational purposes only. You do not need to do anything on this screen.

26. Click Next.

The Creation Options screen displays.

27. Ensure Create Database is selected.


28. Ensure Generate Database Creation Scripts is selected.
29. Click Finish.

The Database Configuration Assistant screen displays, showing the creation progress.

Page: 275 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

Once the database has been created the following screen displays. Note that this screen is an example only.
You will have a different Database Control URL.

30. Click Exit.

Release 4.4.x © Caterpillar 2001-2016 Page: 276 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

Enabling archive logs in the application database

NOTE: Archiving the REDO logs should only be enabled once an Oracle backup solution has been
installed and configured. It is the customer’s responsibility to configure and administer this
backup.

Set db SID

DOS>SET ORACLE_SID=MINESTAR

DOS>sqlplus sys/userid/password as sysdba

Check the current log mode

Check the current log mode is either "Archivelog" or "Noarchivelog":

DOS> sqlplus userid/password@Instance_name as sysdba

SQL> ARCHIVE LOG LIST;

Database log mode No Archive Mode

Automatic archival Disabled

Archive destination USE_DB_RECOVERY_FILE_DEST

NOTE: This is the Default path before enabling the archive log. You need to change to the path where
you want to store the archive logs.

Oldest online log sequence 2296

Next log sequence to archive 2299

Current log sequence 2299

OR

Page: 277 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

SQL> SELECT LOG_MODE FROM V$DATABASE;

LOG_MODE

------------

NOARCHIVELOG

Check no other connections to MineStar instances exist.

SQL> SELECT USERNAME/PROGRAM FROM V$SESSION

Change the database into archive log mode

Now that you have checked that the database is in "NOARCHIVE LOG" mode, enter the commands below to
change the database into ARCHIVE LOG mode and set the location for saving the archive logs.

SQL> SHUTDOWN IMMEDIATE;

Database closed.

Database dismounted.

ORACLE instance shut down.

SQL> STARTUP MOUNT;

ORACLE instance started.

Total System Global Area 535662592 bytes

Fixed Size 1375792 bytes

Variable Size 385876432 bytes

Database Buffers 142606336 bytes

Redo Buffers 5804032 bytes

Database mounted.

SQL> ALTER SYSTEM SET LOG_ARCHIVE_DEST_1='D:\mstarData\admin\MINESTAR\archive'


SCOPE=SPFILE;

System altered.

Release 4.4.x © Caterpillar 2001-2016 Page: 278 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

NOTE: This path can be changed according to where you wish to store your archived log. Ensure that
you have created this directory before you run the alter statement above.

When entering the alter statement the folder path should not contain any spaces, otherwise
when you shutdown you will get the following error.

"Thread: ORA-16024: parameter LOG_ARCHIVE_DEST_1 cannot be parsed"

The statement below changes the database to archivelog.

SQL> ALTER DATABASE ARCHIVELOG;

SQL> CREAT PFILE FROM SPFILE;

Connect to your Oracle home path, for example D:\oracle\product\11.2.0\dbhome_1\database.

Check whether or not the INIT<dbname>.ORA file has been created. Open this file using notepad and
check it contains the entry

*.log_archive_dest_1='LOCATION= <the path entered when setting the archive log


backup.>

Database altered.

SQL> ALTER DATABASE OPEN;

Database altered.

SQL> SELECT LOG_MODE FROM V$DATABASE;

LOG_MODE

------------

ARCHIVELOG

OR

Page: 279 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

SQL> ARCHIVE LOG LIST;

Database log mode Archive Mode

Automatic archival Enabled

Archive destination D;\oracle\product\11.2.0\Rman_Backup_Files\Enabled_


Archive_Files

Oldest online log sequence 2296

Next log sequence to archive 2299

Current log sequence 2299

Configuring RMAN for Catalog and Target databases


Catalog database name = RMANDB

Target database name = MINESTAR

Create the RMAN repository in the Catalog (RMANDB) and register the target database (MINESTAR)
in the repository

Log in to the RMAN database and follow the steps below to configure the database.

1. Create tablespace for the RMAN user in the catalog database (RMAN).
SQL> CREATE TABLESPACE RMANTS
DATAFILE 'D:mstarData\oradata\RMAN\RMAN01.DBR'SIZE 200m REUSE AUTOEXTEND ON
EXTENT MANAGEMENT LOCAL

SEGMENT SPACE MANAGEMENT AUTO;

Tablespace created.

2. Create repository schema.


SQL> CREATE USER RMAN IDENTIFIED BY rman
DEFAULT TABLESPACE RMANTS
QUOTA UNLIMITED ON RMANTS;

User created.

3. Assign privileges to RMAN user.


SQL> GRANT RECOVERY_CATALOG_OWNER,CONNECT,RESOURCE TO RMAN;

Release 4.4.x © Caterpillar 2001-2016 Page: 280 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

Grant succeeded.

4. Connect the catalog database using the RMAN user created above.

SQL> CONNECT RMAN/rman@RMAN

SQL> SELECT SEGMENT_NAME, FROM USER_SEGMENTS WHERE TABLESPACE_NAME = 'RMAN01’;

SQL> exit

No rows selected.

NOTE: "No rows selected" is correct because you have not created a catalog yet.

5. Connect the catalog database using the RMAN user created above
D:\> RMAN CATALOG RMAN/RMAN@rmandb---Password is case sensitive

Recovery Manager: Release 11.2.0.1.0 - Production on Mon Aug 27 13:04:07 2012


Copyright (c) 1982, 2009, Oracle and/or its affiliates All rights reserved.

Connected to recovery catalog database

6. Create the recovery catalog.


RMAN> CREATE CATALOG;

Note that it takes some time to create the catalog.

Recovery catalog created

RMAN> Exit

Recovery Manager complete

7. Connect the RMAN user.


SQL>sqlplus RMAN/RMAN@rmandb
SQL> SELECT * FROM RC_DATABASE;

no rows selected.

Page: 281 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

NOTE: "No rows selected" is correct because the minestar database is not yet registered in the
rmandb catalog database.

8. Set up the target database (Registered Database).

Each database to be backed up by RMAN must be registered.

Open a command prompt and run

DOS> RMAN TARGET=sys/mine1star@minestar CATALOG=RMAN/RMAN@rmandb;

Recovery Manager: Release 11.2.0.1.0 - Production on Mon Aug 27 13:28:47 2012


Copyright (c) 1982, 2009, Oracle and/or its affiliates All rights reserved.
connected to target database: MINESTAR (DBID=3372424511)
connected to recovery catalog database
9. Register the database.
RMAN> REGISTER DATABASE;

Database registered in recovery catalog


Starting full resync of recovery catalog

Full resync complete

NOTE: You must change to dedicated servers.

10. Run the same query as you ran in step 9, e.g.


RMAN> REGISTER DATABASE;

Wait for output

The output should be something similar to that shown below.

DB_KEY DBINC_KEY DBID NAME RESETLOGS_CHANGE# RESETLOGS


1 2 3372424511 MINESTAR 8192079 24-AUG-12

Release 4.4.x © Caterpillar 2001-2016 Page: 282 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

11. Set the catalog database to keep information

SQL> ALTER SYSTEM SET CONTROL_FILE_RECORD_KEEP_TIME=21;

System altered.

SQL> SHOW PARAMETER CONTROL_FILE_RECORD_KEEP_TIME

NAME TYPE VALUE

12. Execute report schema

RMAN> report schema

13. List the RMAN default configurations


RMAN> SHOW ALL;

RMAN configuration parameters for database with db_unique_name MINESTAR are:


CONFIGURE RETENTION POLICY TO REDUNDANCY 2;
CONFIGURE BACKUP OPTIMIZATION ON;
CONFIGURE DEFAULT DEVICE TYPE TO DISK;
CONFIGURE CONTROLFILE AUTOBACKUP ON;
CONFIGURE CONTROLFILE AUTOBACKUP FORMAT FOR DEVICE TYPE DISK TO '%F'; #
default
CONFIGURE DEVICE TYPE DISK PARALLELISM 1 BACKUP TYPE TO BACKUPSET; # default
CONFIGURE DATAFILE BACKUP COPIES FOR DEVICE TYPE DISK TO 1; # default
CONFIGURE ARCHIVELOG BACKUP COPIES FOR DEVICE TYPE DISK TO 1; # default
CONFIGURE MAXSETSIZE TO UNLIMITED; # default
CONFIGURE ENCRYPTION FOR DATABASE OFF; # default
CONFIGURE ENCRYPTION ALGORITHM 'AES128'; # default
CONFIGURE COMPRESSION ALGORITHM 'BASIC' AS OF RELEASE 'DEFAULT' OPTIMIZE FOR
LOAD TRUE ; # default
CONFIGURE ARCHIVELOG DELETION POLICY TO NONE; # default
CONFIGURE SNAPSHOT CONTROLFILE NAME TO 'D:\ORACLE\PRODUCT\11.2.0\DBHOME_
1\DATABASE\SNCFMINESTAR.ORA'; # default.

Change the configuration below

Page: 283 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

CONFIGURE RETENTION POLICY TO REDUNDANCY 7;

CONFIGURE CONTROLFILE AUTOBACKUP ON;

CONFIGURE CONTROLFILE AUTOBACKUP ON;

CONFIGURE SNAPSHOT CONTROLFILE NAME TO 'path'

NOTE: Ensure that the path D:\oracle\product\11.2.0\dbhome_1\database is available


before updating.

List the available backups available to restore

RMAN>LIST BACKUP

This command provides output only when you have done a backup.

Performance
In the Oracle System Global Area (SGA), the "large_pool_size" should be kept high for optimum performance
of the RMAN backup. Since RMAN runs on multiple executions of parallel processes, the large pool allocation
heap is used in shared server systems for session memory, by parallel execution for message buffers, and by
backup processes for disk I/O buffers.

The following processes are ways in which you can improve the RMAN backup process.

Modify the pool size

You can modify the large_pool_size by entering the following commands if you have not already set the pool
size.

Sql>create pfile from spfile;

Sql> shutdown immediate;

Open the initSID.ora file and modify the large_pool_size to what you require, and save the file. It is recom-
mended that you set the large_pool_size to half of what your physical RAM is (up to a maximum of 8-12Gb).

Enter:

Sql>create spfile from pfile;

Sql>startup;

Release 4.4.x © Caterpillar 2001-2016 Page: 284 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

Enable block change tracking

NOTE: This command is only available if you are using Oracle Enterprise Edition.

Enter

SQL> alter database enable block change tracking

using file
D:\oracle\product\11.2.0\dbhome_1\oradata\minestar\minestarrman_change_
track.f' reuse;

Enable parallelism

If you are using Oracle Enterprise edition you are able to add multiple channels to complete the backup pro-
cess as quickly as possible.

Create directory structures to store the backups


All of the directory structures listed below are required to store the RMAN scripts, database backup files,
backups of archive logs files and logs for RMAN job executions.

D:\oracle\product\11.2.0\admin\MINESTAR\rman\ stores RMAN scripts for full database


backups, (Level0), incremental backups (Level1) and archive log backup scripts. All the scripts mentioned
below are stored here.

a. SessionVariables.bat
b. Run_Full_Weekly.cmd
c. Run_INCR_Daily.cmd
d. Run_Archive_Backup.cmd
e. Run_FULL_RMAN_Weekly.bat
f. Run_INCR_RMAN_Daily.bat
g. Run_Archive_RMAN_Backup_Every04Hrs.bat

D:\oracle\product\11.2.0\admin\MINESTAR\rman\Full_RmanWeekly
_Log\

Stores the logs generated for Run_FULL_RMAN_Weekly.bat job execution.

Page: 285 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

D:\oracle\product\11.2.0\admin\MINESTAR\rman\Incr_RmanDaily_Log\

Stores the logs generated for Run_INCR_RMAN_Daily.bat job execution

D:\oracle\product\11.2.0\admin\MINESTAR\rman\Archive_Log_Every4hours\ Stores the logs generated


for Run_Archive_RMAN_Backup_Every04Hrs.bat job execution.

D:\oracle\product\11.2.0\Rman_Backup_Files\FULLDB_with_Archivelog_Backup\

Stores full database backup files.

D:\oracle\product\11.2.0\Rman_Backup_Files\Control_File_During_FullDB_Backup\

Stores the control file backup which is taken during a full database backup.

D:\oracle\product\11.2.0\Rman_Backup_Files\IncrimentalDB_With_Archivelog_Backup\

This is to store the incremental backup files.

D:\oracle\product\11.2.0\Rman_Backup_Files\Control_File_During_IncrDB_Backup\

Stores the control file which is taken during an incremental backup.

D:\oracle\product\11.2.0\Rman_Backup_Files\Only_ArchiveLog_Backup\ Stores the archive log backup


files.

D:\oracle\product\11.2.0\Rman_Backup_Files\Controle_File_During_Archivelog_backup\

Stores the control file.

D:\oracle\product\11.2.0\admin\MINESTAR\rman\SnapShot_ControlFIle\ Stores the snapshot of the cur-


rent control file, which is taken when RMAN backup starts for the first time.

Release 4.4.x © Caterpillar 2001-2016 Page: 286 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

D:\oracle\product\11.2.0\Rman_Backup_Files\Enabled_Archive_Files\

Store all the archived generated files.

Scripts used for RMAN implementation


Session Variable.bat

REM MINESTAR DB information

ECHO OFF

REM ********************************************************REM * Procedure:


SessionVariables

REM * Author: Doej

REM * Created: 08/13/2012

REM * Comments: This Batch file sets required variables.

REM /********************************************

REM

REM

REM * Modifications Log:

REM *

REM * Date By Project Description

REM * --------- --------- ----------- ---------

REM * 08/13/2012 Caterpillar MineStar 4.0 initial version

REM *

REM ********************************************************

REM Create a timestamp

for /f "tokens=1,2" %%u in ('date /t') do set d=%%v

for /f "tokens=1" %%u in ('echo %time%') do set t=%%u

if "%t:~1,1%"==":" set t=0%t%

SET timestr=%d:~6,4%%d:~3,2%%d:~0,2%%t:~0,2%%t:~3,2%

SET timestr2=%d:~6,4%%d:~3,2%%d:~0,2%%t:~0,2%%t:~3,2%%t:~6,2%

Page: 287 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

SET datestamp=%d:~3,2%%d:~0,2%%d:~6,4%

REM /********************************************

REM Target DB Information

SET ORACLE_SID=MINESTAR

SET TARGET_UID=sys

SET TARGET_PWD=mine1star

SET EXEDIR=D:\oracle\product\11.2.0\admin\MINESTAR\rman\Run_Full_Weekly.cmd

SET RMANLOG=D:\oracle\product\11.2.0\admin\MINESTAR\rman\Full_RmanWeekly_
Log\FullWeekly_Bkp_%ORACLE_SID%_%timestr2%.log

SET EXEDIR_INCR=D:\oracle\product\11.2.0\admin\MINESTAR\rman\Run_INCR_
Daily.cmd

SET INCRRMANLOG=D:\oracle\product\11.2.0\dmin\MINESTAR\rman\Incr_RmanDaily_
Log\IncrDaily_Bkp_%ORACLE_SID%_%timestr2%.log

set EXEDIR_ARCHIVE=D:\oracle\product\11.2.0\admin\MINESTAR\rman\Run_Archive_
Backup.cmd

set ARCHIVELOG=D:\oracle\product\11.2.0\admin\MINESTAR\rman\Archive_Log_
Every4hours\ArchiveLog_Bkp_%ORACLE_SID%_%timestr2%.log

REM RMAN Catalog DB Information

SET RMAN_CATALOG_DB=rmandb

SET RMAN_UID=RMAN

SET RMAN_PWD=RMAN

SET CATALOG="catalog %RMAN_UID%/%RMAN_PWD%@%RMAN_CATALOG_DB%"

SET TARGET="target %TARGET_UID%/%TARGET_PWD%@%ORACLE_SID%"

Script for Full DB backup (Level0)

RUN_Full_Weekly.cmd

Release 4.4.x © Caterpillar 2001-2016 Page: 288 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

run {

sql "alter system archive log current";

set command id to 'datafile_backup';

Allocate channel ch1 type disk format 'D:\oracle\product\11.2.0\Rman_Backup_


Files\FULLDB_with_Archivelog_Backup\Production_full_lv0_%d_t%t_s%s%';

backup as compressed backupset incremental level 0 database plus archivelog


tag 'ProdFull_ARCH_Bkp';

Release channel ch1;

Allocate channel t1 type disk format 'D:\oracle\product\11.2.0\Rman_Backup_


Files\Control_File_During_FullDB_Backup\ctl_file_%d_%U';

Backup current controlfile;

Release channel t1;

restore database validate;

crosscheck backup;

delete force noprompt Archivelog All;

report obsolete;

delete force noprompt obsolete;

delete force noprompt expired backup;

delete force noprompt expired backupset;

Run_FULL_RMAN_Weekly.bat

REM Oracle RMAN Weekly FULL Backup Started,review backup log after successful
completion.

CALL SessionVariables.bat

rman %CATALOG% %TARGET% cmdfile=%EXEDIR% log=%RMANLOG%

Page: 289 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

Script for Incremental (Level1) backup

Run_INCR_Daily.cmd

run {

sql "alter system archive log current";

configure default device type to disk;

Allocate channel ch1 type disk format 'D:\oracle\product\11.2.0\Rman_Backup_


Files\IncrimentalDB_With_Archivelog_Backup\INcr_DB_%d_DB_%U_%S_%P';

backup as compressed backupset incremental level 1 database plus archivelog


tag 'Incr_with_archivelog';

Release channel ch1;

Allocate channel t1 type disk format 'D:\oracle\product\11.2.0\Rman_Backup_


Files\Control_File_During_IncrDB_Backup\ctl_file_%d_%U';

Backup current controlfile;

Release channel t1;

report obsolete;

delete force noprompt obsolete;

delete force noprompt expired backupset;

Run_INCR_RMAN_Daily.bat

REM Incr back up started, Review the logs once after backup get completed

call SessionVariables.bat

rman %CATALOG% %TARGET% cmdfile=%EXEDIR_INCR% log=%INCRRMANLOG%

Script for archive log backup

Archive_Backup.cmd

run{

Release 4.4.x © Caterpillar 2001-2016 Page: 290 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

Crosscheck Archivelog All;

Sql "alter system archive log current";

Allocate channel t1 device type disk;

Backup Format 'D:\oracle\product\11.2.0\Rman_Backup_Files\Only_ArchiveLog_


Backup\ARCH_%d_%U_%T' Archivelog All delete input;

Release Channel t1;

Allocate channel ch1 type disk format 'D:\oracle\product\11.2.0\Rman_Backup_


Files\Controle_File_During_Archivelog_backup\controlefile_%d_ctrl_%U';

Backup current controlfile;

Release channel ch1;

Archive_RMAN_Backup.bat

REM Oracle RMAN Every 04hrs Archive Log Backup Started,review backup log after
Successful completion.

CALL SessionVariables.bat

rman %CATALOG% %TARGET% cmdfile=%EXEDIR_ARCHIVE% log=%ARCHIVELOG%

RMAN configuration settings

Enabling RMAN
To enable RMAN functionality on your system, do the following.

1. Open Supervisor.
2. Click Options > System Options.
3. From the Product drop-down list select Platform.
4. From the Option Sets list select System - Workgroup Extensions.
5. Click the RMAN Configuration tab.
6. Select the Enable RMAN on this System check box.
7. Click Apply.

Page: 291 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

Configuring RMAN
Configuring RMAN directories, backup type and schedule settings, is done in Supervisor.

To configure RMAN directories

1. Click Options > System Options.


2. From the Product drop-down list select Platform.
3. From the Option Sets list select System - Workgroup Extensions.
4. Click the RMAN Configuration tab.
5. Enter the RMAN Base Directory path.
6. Enter the Archive Log Destination path.
This defaults to <drive>:\mstarDate\admin\MINESTAR\archhive.
7. Click Apply.

Running RMAN jobs


You are able to set RMAN to be scheduled as part of makeScheduledTasks, by going into Supervisor and
doing the following.

1. Click Options > System Options, from the Product drop-down list select Plaftorm, and in the Option
Sets list select System - Workgroup Extensions.
2. Select the RMAN to be scheduled as part of makeScheduledTasks check box.
3. Click Apply.

The following is a recommended schedule for running RMAN jobs.

Level 0 (Full Database backup)

Scheduled on Every Sunday, once in a Week at 05PM Local Time

Level 1 (Incremental Backup)

Scheduled on Every Alternative days, Tuesday, Thursday, Saturday at 05PM Local Time,

Archive Log backup.

Scheduled at every 6hours from Monday 12.01AM Local time to Sunday 01PM Local Time

To configure RMAN backup schedule settings

1. Click Options > System Options, and from the Product list select Platform.
2. Click System - Workgroup Extensions.
3. Click the Rman Configuration tab.

Release 4.4.x © Caterpillar 2001-2016 Page: 292 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Oracle RMAN implementation

4. In the RMAN Full DB Backup Schedule Time field, enter the time you wish the full backup to occur.
5. From the RMAN Full DB Backup Schedule Frequency drop-down list select whether you wish to do
the full backup weekly or fortnightly.
6. In the RMAN Incremental DB Backup Schedule Time field, enter the time you wish the incremental
backup to occur.
7. From the RMAN Incremental DB Backup Schedule Frequency drop-down list select how often you
wish the incremental backup to occur.
8. In the RMAN Full Archivable Backup Schedule Time field, enter the time you wish the archive
backup to occur.
9. From the RMAN Archivable DB Backup Schedule Frequency drop-down list select how often you
wish the archive backup to occur.
10. Click Apply.

To configure RMAN backup type

NOTE: This is only available in Expert Mode.

1. Click Tools > Toolkit, and from the Group list select All.
2. From the Tool list, select rmanTools.
3. Select the Rman backup type.
4. If you want to have the files copied to another location, click the ellipses button beside the RMAN
Base Directory field, select the location and click Open. The files are copied here as an additional pre-
caution.
5. Click Run.

Page: 293 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Supervisor page reference
Cat Fleet Admin & Config Manual
Supervisor page reference

Introduction
This chapter describes the Supervisor pages and the various configuration options available. Because Super-
visor does not run against a system bus, most configuration changes require a restart of the office software
before any changes take effect. This means that you can make numerous configuration changes without
affecting the system that is currently running. Some configuration options require additional changes or pro-
cesses before they take effect, such as updating datastores or recreating on-board machine files. These addi-
tional processes are discussed as part of the configuration options that require them.

Chapter goals
This chapter aims to provide a reference for the pages and configuration options in Supervisor, examples and
default values where applicable, and basic usage information.

Only Fleet Consultants, Builders, or other suitably qualified personnel should make changes
to the settings in Supervisor.

Page: 295 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Diagnostics pages
The Diagnostics Pages of Supervisor provide various monitoring and troubleshooting tools to help in the ana-
lysis of any problems that may arise with the office software.

Field Communications
Use the Field Communications Monitor to monitor all inbound and outbound field communications. This is a
useful tool for analyzing field communications problems.

To open the Field Communications Monitor

l In Supervisor, on the Contents menu, point to Diagnostics, and then click Field Comms.

The following table describes the information displayed on the Field Communications Monitor.

Release 4.4.x © Caterpillar 2001-2016 Page: 296 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Action Item Description

Pauses the scrolling of field communications information. The


Pause monitoring of field communications continues, but the latest
events are not automatically displayed in the table.

Resume Resumes the scrolling of field communications.

Opens a gateway file for replay. Used mainly for troubleshooting


Open
and testing.

Connects to a specified gateway. This is typically the Application


Connect
server, where the Field Communications Server is running.

Disconnect Disconnects from the current gateway.

Actions Menu
Toggle Machine Switches between displaying the name and the IP address of the
Some of these Address machines displayed.
actions are also
Replays the current gateway file. Used mainly for troubleshooting
available on the Replay
and testing.
toolbar.

Displays the Set Time Zone dialog box. Used to specify the time
Locale zone of the gateway files being used in Replay mode. Used
mainly for troubleshooting and testing.

Save messages Saves the selected communications messages to an XML file for
to an XML File analysis. Used mainly for troubleshooting and testing.

By default, the feature is turned off so that no unnecessary load is


placed on the system by the process of accumulating the stat-

Include statistics istics.

Selecting Include statistics displays a tree of check boxes that


allow individual statistics to be gathered as described below.

Page: 297 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Action Item Description

The percentage of duplicate messages sent from the field. Duplic-


ates are sent because the onbord system has not received an
Duplicates acknowledgment message from the office. This can be becuase
(% total) of a failed receiver on an individual machine, an area of poor cov-
erage in a particular location of the mine, a failed access point
transmitter, or interference.

Release 4.4.x © Caterpillar 2001-2016 Page: 298 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Action Item Description

The amount of time taken for an inbound message to travel from


the field to the office. The timer starts when the message is first
generated onboard. Long latencies can be associated with net-
work congestion, failing mobile transmitters, failing access point
receivers, poor coverage or causes similar to those causing
duplicates.

The office time clock MUST be synchronized with a reliable GPS


source, otherwise you cannot rely on time information.
Latency
(seconds) Latency is indicated at the bottom of the statistics window, with
the coloured numbers indicating as follows:

Grey - the data has been received and the time received in is
good.

Blue - the data has been received and the time received in is a bit
out of spec, but fine.

Red - the data has not been received. This could mean that the
office time and the field times are NOT synchronized.

The number of bytes in each message. For some message types


Message Size
this is affected by things such the length of names associated
(bytes)
with entities such as waypoints.

The percentage of messages sent from the office to the field for
No Response
which no response was received. This can indicate areas of poor
(% total)
coverage or failing radios.

The round trip time for messages sent from the office and acknow-
ledged by the field. This can help understand coverage and con-

RTT (seconds) gestion issues with the network as a whole or identify individual
machines with communications issues.

Round trip times do not have GPS timestamps.

Page: 299 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Action Item Description

The number of GPS satellites visible from a machine in the field.


Satellites This can affect accuracy of positional information available to the
office software.

Speed The speed of the machine as reported by the GPS receiver.

To help identify and diagnose problems with communications, these statistics can be aggregated by a num-
ber of factors, including those described below.

Allows accumulation of statistics by machine so that problems


Machine
with individual machines can be highlighted.

Identifies problems with particular message types that may indic-


Message Type
ate a configuration or logic problem with the system.

Accumulates statistics by the hour of the day. Multiple days are


Time of Day averaged over 24 one-hour bins. This allows identification of
diurnal variations in system performance.

Include
Display will show responses given to filtered messages.
responses

Specifies the machines for which field communications should be


Machine
displayed.

Specifies the message types for which field communications


Toolbar Message
should be displayed.

Page Con-
Displays the currently selected page configuration.
figuration

Release 4.4.x © Caterpillar 2001-2016 Page: 300 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Action Item Description

Direction Indicates whether messages are inbound or outbound.

Indicates the message protocol. This is typically TMAC. Other


Protocol protocols may be used depending on the requirements and con-
figuration of the site.

Indicates the type of message sent or received, such as


Type
MESSAGE,RESPONSE or REQUEST.

Machine Indicates the machine that sent or received the message.

Field Comms Indicates the time that the message passed through the gateway,
Arrival Time
tab either inbound or outbound.

The time that the message was generated, either onboard the
Timestamp
machine or in the office.

Displays the time difference, in seconds, between the time the


Delta
message was generated and the time it arrived at the gateway.

Message ID Displays the message ID number.

Sequence # Displays the message sequence number.

Data Size The size of message in bytes.

Page: 301 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Process charts

NOTE: The Process Charts page is intended as a diagnostic tool for Level 2 and 3 support staff.

Use the Process Charts page to display the various charts that are produced by the office software. These dis-
play performance and other aspects of the office software over time. This data comes from log files, so the log
files you keep dictate what can be displayed. You can open specific records for the various office software
components or all of the available graphs for the current day. These graphs are useful analysis tools when per-
forming general system troubleshooting.

To open the Process Charts page

l Start Supervisor, and on the Contents menu, point to Diagnostics and then click Process Charts.

Common events that can impact the performance of the system

l A standard report run at a time of peak resource usage by the system, such as at shift change.
l A custom report run at any time that does not take advantage of appropriate indexes.

Process chart details


You can display a number of attributes for each of the charts to better focus system analysis activities. For
example, on one chart you can display system restarts, each instance of a page being opened and the amount
of memory being used, while on a separate chart you could display buffered events, lags and slow publishes.

Toolbar buttons

The following table describes the buttons displayed on the Process Charts toolbar.

Item Description

Opens a dialog box from which you can open a spe-


cific log file into an internal frame on the page. You are

Open able to open log files, xml files produced by the Per-
formance Test Bench (PTB), and system log files.

Release 4.4.x © Caterpillar 2001-2016 Page: 302 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Item Description

Tiles the charts within the current window if multiple


charts are displayed. If the tiling is not the way you
Tile
want it, you can click this button repeatedly until you
get the formation you want.

Merges the display of files from common processes


into a combined frame. For example, if you are view-
Merge
ing Mine Tracking logs from three consecutive days,
you can merge them to form one graph.

Open graphs for Opens and displays all log files for the current day.
today

Open graphs for Opens and displays all log files for MineTracking
MineTracking and merges them.

Open All Opens all of the syslog files. These are files which
record every command that has been run. More
detail is given in "System Log frame" on page 305.

Lock Locks the navigation of all internal windows.

Screenshot Saves a screen dump of the current contents of the


page. This is useful to be able to show what inform-
ation you have about an issue.

Trend Lines Select to make used trend line smoother or less


smooth.

Page: 303 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Item Description

Legend This opens a new internal frame (dialog box), with


various legend for the log file graphs.

Select to view extra information on an event when hov-


Beginner mode
ering with the mouse, such as the name of the page
tooltips
being opened or closed, an error, warning or other
event.

When not enabled, the tooltip information shows the


"quantity' of the measurement type selected (e.g.
page open quantity, max cpu etc at the point in time
represented by the x coordinate (left to right).

Close all Closes all open dialogs.

NOTE: When you initially open a log file, if the directory that Supervisor was started in is called "logs",
the system will look there. If not, it will go to a directory where log files are being written by the current
system. However, once you have a log file open, opening further log files will default to that directory.
This facilitates its use as a diagnosis tool "after the fact".

If you open a .zip file, and that .zip file is a system snapshot, the page will extract the logs directory
and show the MineTracking log. Further opening of files will then work against the temporary dir-
ectory that the log files were extracted to.

Frames

This section describes the frames, or windows, that you can display on your screen. Some of them have been
basically described in the "Toolbar buttons" on page 302 section.

Release 4.4.x © Caterpillar 2001-2016 Page: 304 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

System Log frame

Click the Open All (system log) button on the toolbar. The system log frame shows the lines from the system
log files. You can use the time synchronization features across frames to see what behavior in MineTracking
for example, corresponded to which particular command, such as for example, cycle recalc.

The check boxes on the left of the frame allow you to turn on and off the particular things you want to display.

Legend frame

Click the legend button on the toolbar. The legend frame has the following tabs at the time of writing.

l Lines
l Boxes
l Lag
l Events

Items on each of these tabs are described in the tables below.

Lines

Type Description

Gold. The number of events buffered in the process.


High numbers indicated slow processing and will
eventually cause garbage collection and memory
shortages.

Pink. CPU usage - values higher than 100% indic-


ate the machine has multiple CPUs.

Salmon. Event rate. This metric is not well-defined,


but higher values mean the system is doing more
things. Extremely low values can indicate that the
feed from the field network is broken.

Dark red. The maximum heap size set for the pro-
cess. This is approximately the highest value total
memory can go to.

Page: 305 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Type Description

Green. The number of threads in use by the pro-


cess. Sustained increases will cause stability prob-
lems.

Red. The total memory allocated to the Java heap -


must be higher than used memory.

Gray. The number of database connections the pro-


cess has open.

Blue. The amount of memory used by the Java


heap.

Gray. The number of database connections the pro-


cess has in use.

Light blue. A running average of used memory.

Boxes

Type Description

Pink. These boxes mark points in time when a BUG


message has been logged. This indicates that the office
software has encountered a situation which should def-
initely not happen.

Red. These boxes mark points in time when an ERROR


message has been logged. These usually indicate an
unexpected input.

Release 4.4.x © Caterpillar 2001-2016 Page: 306 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Type Description

Light blue. These boxes mark points in time when


PERFORMANCE messages have been logged. These
messages may indicate poor performance, or may
simply be data logging used by monitoring applications
such as this page.

Yellow. These boxes mark points in time when a


WARNING message has been logged. This indicates
that the office software has encountered a situation
which is probably erroneous and should be corrected.

Lag

Type Description

Olive. The Enterprise Component Framework (ECF)


subsystem has noticed that an update was not received
within three seconds of being sent. The process's view
of the data in the database will be out of date. These
updates are sent across pubsub. Slowness is usually
due to load on the server.

More information on ECF follows this table.

Purple. An event is a timestamped event-driven pub-


lication on the server bus. Event lag occurs when the
pubsub subsystem has noticed that an update was not
received within three seconds of being sent. Reactions
to events are delayed in other parts of the system. Slow-
ness is usually due to load on the server. This is a java
event - event-driven puublication on the RMI or intern-
ally, of physical changes in the mine model.

Page: 307 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Type Description

Dark gold.The notification subsystem has noticed that


delivery of notifications is falling behind. This is usually
due to slowness in the receiving process.

Light green. A database operation executed by the


Hibernate subsystem took more than two seconds. This
may be due to disk contention on the database system,
schema design floaws, network contention, or lack of
CPU on the application server or database server.

Light blue. A query executed by the O/R mapping sub-


system took more than two seconds. This may be due
to disk contention on the database system, schema
design floaws, network contention, or lack of CPU on
the application server or database server.

Brown. A remote procedure call took more than three


seconds, or more than 0.5 seconds in the event thread.
This is usually due to slowness in the called process.

An SQL query executed by JDBC took more than 1.5


seconds. This may be due to disk contention on the data-
base system, schema design flaws, network con-
tention, or lack of CPU on the application server or
database server.

Gray. An incoming remote procedure call handled by


this process took more than three seconds. This can be
a problem if it happens many times. This is often due to
slow database operations or lack of CPU available to
the server process.

What is ECF used for?

ECF is used mostly to cache Machine and Person entities of the mine model in the system.

Release 4.4.x © Caterpillar 2001-2016 Page: 308 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

What is ECF Lag?

ECF lag most commonly occurs when an ECF object is saved or read from the database server. ECF lag
occurs less commonly (very infrequently) when there is lag within the ECF system itself, between the primary
cahe in MineTracking and secondary caches associated with other services, or clients, accessed over the
server-side bus. ECF lag is almost always indicative of lag/latency occurring at the Database layer, or a delay
occurring in the RMI Bus.

Events

Type Description

A purple line indicates that a page was opened. These


events are logged in the client process in which the page
was opened, and on the server, as some pages can
affect performance of the server.

A black line indicates that this process was restarted.

Events in context

Events can be coupled together and cascade into each other.

There an be a slowServer event, for example, from the JobService talking to MineTracking , which triggers a
Hibernate Event in MineTracking. If the Database server is slow, this causes a slowHibernate event, and as
the response from MineTracking back to the job service event is slow, this will also show as a slowServer
event.

Keyboard shortcuts

The following table describes the keyboard shortcuts available in the Legend frame.

Item Description

c Complete logs for this process.

Page: 309 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Item Description

e Go to the next error.

m Maximize or minimize this internal frame.

t Tile the internal frames.

w Go to the previous error.

z Zoom in on the selected area.

Move to previous occurrence of second search


4
term.

6 Move to next occurrence of second search term.

7 Move to previous occurrence of first search term.

9 Move to next occurrence of first search term.

Performance Test Bench (PTB) frame

The PTB logs are used to try to locate performance problems in the system.

NOTE: You can only be look at PTB files if you have actually had the Performance Test Bench run-
ning in the past.

When you open a PTB log, the window has the following tabs.

l Hibernate Collections
l Hibernate Entities
l Hibernate Queries
l Notification
l RPC (Remote Procedure Call) Invocations
l Caches

These are described further in the sections below.

Release 4.4.x © Caterpillar 2001-2016 Page: 310 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Hibernate Collections

The lines on this tab show variances in the number of objects used to represent various properties of domain
objects. When a line goes suddenly above then suddenly below, that means the value increased then
decreased. Being continuously above the baseline is a sign of an increasing collection. As the variations can
be extremely large, there is a dampening factor which can be set with the Zoom In and Zoom Out buttons – a
higher number means the lines have less variation (are less "wiggly"). This is so you can make graph read-
able.

Tooltips on the row headers tell you exactly what number that row represents, as the short headers can be
ambiguous.

Example of the Hibernate Collections tab

Hibernate Entities

This tab is representative of domain objects. The graph on this tab shows how many domains we are working
with in a time period, big circles represent more memory. Time is increasing towards the right. Each circle has
a tooltip giving the exact numbers and time.

Example of the Hibernate Entities tab

Page: 311 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Hibernate Queries

This tab is a summary of queries which were made to Hibernate across the entire PTB monitoring period. The
histogram represents the total time taken for that sort of query, and a vertical tick across the bar, usually at the
very left side of the bar, shows the average. A tooltip on the histogram gives the summarized details.

Example of the Hibernate Queries tab

Notification

The notification system queues items for delivery in various buffers. These graphs show the size of those
queues. They are almost always empty, which is why you will not see much on your screen. Sustained
queues of any type are a problem.

Example of the Notification tab

Release 4.4.x © Caterpillar 2001-2016 Page: 312 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

RPC (remote procedure call) Invocations

MineTracking exposes various services. The PTB monitors how long those services take, how much data
they return, and how much time was spent in the database.

Each RPC has three graphs. The name of the RPC is in bold under the triplet. Each graph is a histogram of
good numbers (green, at the top) to bad numbers (red, down the bottom).

Red result size values suggest the RPC might be returning more information than it needs to, red call dur-
ation and JDBC duration values suggest the RPC is taking a long time because it is monitoring a lot of ser-
vices in the database.

Tooltips on the histograms give summaries, including average, minimum and maximum values.

Example of the RPC Invocations tab

Page: 313 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Caches

The office software has many caches which are managed by Hibernate. These vary in size greatly, so they
are hard to graph.

The names down the left are the names of the caches. The three towers next to the name represent the min-
imum, median and maximum sizes of the cache in memory on a log scale, so a slightly taller tower indicates a
lot bigger cache in memory. When the numbers get very big the tower goes red at the top. Tooltips on the
name and towers tell indicate the exact minimum, median, and maximum values.

To the right of the towers are icons representing the number of accesses to the cache for each of the sample
periods, with the height of the icon representing the number of accesses on a log scale. The icon is colored red
and green in proportion to the number of hits and misses on the cache – so a large icon that is all green means
a lot of "things" are being looked up, and they are always there.

A small icon that is all red means that not many "things" are being looked up, and they are never there. A gray
block means the cache was not used.

Example of the Caches tab

Release 4.4.x © Caterpillar 2001-2016 Page: 314 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Log File frame

The log file frame has two interrelated parts - the "Graphs" on the facing page and the "Log file lines" on
page 317. The splitter bar between them is one-touch collapsible. The option sets (check boxes) on the left
control which graph components are drawn, and which log file lines are displayed respectively.

Example of a log file frame

Page: 315 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Graphs

The graphs consist of a horizontal axis (time), vertical axis (scale) and a lot of colored information in the
middle.

The vertical scale of maxmem, used and total are all set to the same value so that you can compare them
meaningfully. Otherwise, the vertical scale is set to that of the line whose check box is selected on the left.
This must be a tag which is drawn as a line (see the "Lines" on page 305 table to see which ones they are).

Usage tips

l Left-clicking on a tag turns it on or off, but if you right-click on a tag, you can set it as the scale without
changing whether it is on or off.
l The line for which the vertical scale is set is the one for which tooltips will show the current value when
you hover the mouse over the graph. To make sure you know what you're looking at, a pink dot (oth-
erwise known as the sparkle) displays on that line in the position of the value being displayed.
l Hovering over the horizontal axis, displays a tooltip showing you the time that position corresponds to.
This helps you place the mouse when the X axis divisions are not detailed enough.
l A single click on the graph selects that time in the log file display. Double-clicking sets all log file
frames in the window to that time. Triple-clicking looks in the log directory and opens all files which
have anything for that time, and then sets them to that time.
l You can drag on the graph to select a period of time. This area will have a gray background.
l If you right-click on the graph displays a context menu with the following options.
l Show log file for this date. This is the same as simply clicking on the graph except it will not
have any effect on any selection you have made.

Release 4.4.x © Caterpillar 2001-2016 Page: 316 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

l Export selected lines. If there is a selected area, export those lines to a file.
l Copy selected lines. If there is a selected area, copy those lines to the clipboard.
l Go to next error. This is the same as if you clicked on the next error dot chronologically.
l All charts show this date. All open log file frames select this date on the graph and in the log
file.
l Open all log files for this date. Looks in the logs directory, finds all logs which include this
date, opens the file and displays all the logs as at this date.
l Complete logs for this process. Opens all other log files for this process and merges them
with this graph.
l Zoom on selection. Changes the graph so that only the selected portion of the graph is shown.
The scroll bar below the graph enables you to to move along the graph. When you are zoomed
in, clicking on a log file line outside the zoomed area will move the zoom to that area.
l Zoom out. If you are zoomed in, zooms back out to see the whole graph.

Log file lines

The log files display shows every line from the loaded log files.You may find that there are files too big to be
loaded. If you have difficulty fitting files into memory, close down all the internal windows and load the big
ones first.

Usage tips

l Clicking on a line in the log file selects it and shows the location of that line on the graph above.
l You can use shift-click to select a range of lines. The first selected line will be indicated on the graph.
l Hovering over the log file lines displays a (potentially multi-line) tooltip with the full content of the line.
l Right-clicking on the lines displays a context menu with the following options.
l Go to next error. Moves you to the next error. You can also just press e on your keyboard.
l Export all lines to file. If this graph came from multiple files, and you want to make a single
physical file for this process, you can save all lines to a file using this command.
l Export displayed lines to file. Exports only the selected lines to a file.
l All charts show this date. All charts will show the date of the first selected line.
l Open all log files for this date. Opens all files whose timespan crosses the date of the first
selected line and sets them to that date.
l Complete logs for this process. The same as typing c on your keyboard.
l All files to beginning of lag. If this line represents a lag, (see the legend, or "Lag" on
page 307, for which ones they are. They will mostly be ones that say “took 3,214 millis to...”),
then all open graphs are set to the timestamp when the lag started. This is useful because

Page: 317 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

although you can see when a lag ends and what the consequences were in the middle, it is more
difficult to see exactly what was happening at the start.

System log
The System Log page displays a log of recent office software activities, such as when a page was opened,
when an upgrade was performed or when various mstarrun targets were executed, etc. The log displays
details for the current month.

To open the System Log page

l Start Supervisor, and on the Contents menu, point to Diagnostics and then click System Log.

Diagnostics Tools
The Diagnostics Tools page provides access to a number of mstarrun targets that are useful for performing
system diagnostics. Refer to the "" on page 512 chapter for details and usage of these targets.

Management pages
The Management Pages of Supervisor provide various tools for setting up default values for the system, and
for performing routine maintenance tasks.

Software updates
Use the Software Updates page to activate software builds and updates.

To open the Software Updates page

l Start Supervisor, and on the Contents menu, point to Management and then click Software
Updates.

The following table describes the information displayed on the Software Updates page.

Release 4.4.x © Caterpillar 2001-2016 Page: 318 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Specifies the build number when performing an office software


Builds Current Build
upgrade.

Lists the service packs available for the install build of the office
Service Packs
software.

Lists the installed updates that are available for the office soft-
ware which are not included in the currently selected service
Updates
pack. Details of each update, including whether or not they have
been applied, are listed below the Updates table.

Specifies whether or not the update is turned on, and a descrip-


General tab
tion of the update.
Updates
Specifies who to contact about the update, what the update
Details tab affects, if there are any updates obsoleted by the one selected,
and any related updates.

Specifies any risks of installing the update, the process for


Installation tab installing the update, what needs to be restarted, and how you
can tell if the update worked or not.

Source Details Specifies the file the update comes from, the machine the update
tab was built on, the time of the build and who built the update.

Lists the office software extensions that are available in the cur-
Extension Selec-
Extensions rent system. Only those extensions that are listed in the Include
tion Panel
panel are actually started when the system starts.

Opens a Browse dialog box so that you can install further service
Install Update Button
packs or updates to the system.

Page: 319 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Opens the Fleet Update Builder. Only used by Fleet developers or


Package Update Button
Fleet Consultants to create updates.

Rebuilds the system. This may be required after an installation of


Make System Button
a service pack or update.

Permissions
Use the Permissions page to assign different permissions to different roles.

To open the Permissions page

l Start Supervisor, and on the Contents menu, point to Management and then click Permissions.

The following table describes the information on the Permissions page.

Tab Item Description

A list of all available products for which page permissions can be


Product list
specified.

A list of all available pages in the selected Product for which page
Category list
permissions can be specified.

Specifies which roles can access the various pages within the
Page Access
office software.

Specifies which roles can run various jobs within the office soft-
Job Access
warethe office software.

Specifies which roles can run various tools within the office soft-
Tool Access
ware.

Release 4.4.x © Caterpillar 2001-2016 Page: 320 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Specifies which roles can perform various actions in the office


software pages.

Permissions on Specifies permissions available to perform different tasks on the


Page Actions
Page entities displayed on a particular page.

Specifies which roles have permission to change different fields


Fields on Page
on a particular page.

Specifies which roles can perform various actions in the office


software.

Permissions on Specifies permissions available to perform save and expert mode


Client Actions Page tasks in the office software.

Specifies which roles have permission to save configurations,


Actions on Page consoles and desktops, and to toggle expert mode in the office
software.

Calendar defaults
Use the Calendar Defaults page to specify how the office software should split time into periods which are rel-
evant to the operation of the mine.

To open the Calendar Defaults page

l Start Supervisor, and on the Contents menu, point to Management and then click Calendar
Defaults.

The following table describes the information displayed on the Calendar Defaults page.

Page: 321 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Click this check box to change the default shift setting to 8 hours,

Days With 8 then select the check boxes next to the individual days to change

Hour Shifts their default setting.

The default = 12 hour shifts.

Specifies how many months ahead the shift will be scheduled.


Minimum Shift
This ensures a shift exists when the office software is initiated.
Months
Shifts Default = 12 months.

Specifies the naming format for specific shifts. The default is 0,


date, dd MMM yyyy. Valid shift types are:

l 12 Hour Day Shift


Shift Naming l 12 Hour Night Shift.
l 8 hour First Shift.
l 8 hour Second Shift.
l 8 Hour Third Shift.

Days

Weeks

Years Specifies the various start parameters of the required periods.


Periods
Halves & Quar-
ters

Period Naming Specifies the names and date formats of the various periods.

Output formats
tab and Input Do not edit fields on either of these tabs.
formats tab

Release 4.4.x © Caterpillar 2001-2016 Page: 322 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Setup pages
The Setup Pages of Supervisor provide various tools for configuring the system and for specifying various dir-
ectories.

System directories
Use the System Directories page to set up base directories and directories for configuration and data files.

To open the System Directories page

l Start Supervisor, and on the Options menu, click System Directories.

The following table describes the information displayed on the System Directories page.

Tab Item Description

Local Base Directory The local the office software base directory.
Base Dir-
ectories The network drive path to the base directory on a
Central Base Directory
shared server.

Page: 323 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Configuration Directory – The directory where cus-


tom configuration settings are stored.

Updates Directory – The directory where product


packs, services packs and updates are stored.

Standby Directory – The directory where a copy of all


necessary application configuration and data files will
be duplicated so that the standby application server can
be started.

Onboard Files Directory – The directory where


General
onboard files are generated.

Data Exports Directory – The directory to which data-


bases are exported.

Data Backups Directory – The directory to which


Advanced Dir-
zipped exports are copied.
ectories
VIMS Files Directory – The directory to which all
VIMS files are saved.

Fluid Analysis Files Directory – The directory to


which all Fluid Analysis Files are saved.

Process Logs Directory – The directory where pro-


cess log files are stored.

Process Tracing Directory – The directory where pro-


cess trace files are stored.
Recommended Local
Temporary Files Directory – The directory where tem-
porary files are stored.

Admin Files Directory – The directory used by vari-


ous housekeeping tools, such as snapshotSystem.

Release 4.4.x © Caterpillar 2001-2016 Page: 324 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Additional Logging Directory – The directory where


extra configuration log files are stored.

Communications Logs Directory – The directory


where communication log files are stored.

Outgoing Directory – The directory where files to be


transferred to support are stored.

Sent Directory – The directory where files suc-


cessfully transferred to support are stored.

Advanced Dir- MineStar Help – The directory to which the Help web
ectories (con- Recommended Shared site is deployed.
tinued)
MineStar Published Reports – The directory to which
the Published Reports web site is deployed.

Templates – The base directory for template files used


by BORefresh IniParser to generate the properties files
used by BORefresh or refreshReportCache.

Properties – The base directory holding property files


used by BORefresh or refreshReportCache to generate
reports.

Output – The base directory holding generated reports.

Disk Mon- Volumes to Monitor for


Drives that are monitored for free space.
itoring Free Space

System options
Use the System Options pages to specify the various configuration options for the office software.

To open the System Options page

l Start Supervisor, and on the Options menu, click System Options.

Page: 325 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

The following tables describe the various system options that are available. The options are described by
Product in the order that they appear in the Option Set list. The Products and Option Sets are shown in the
left-side panel on the screen.

If you select All from the Product list, all of the options are listed in alphabetical order, not in product order.

Assignment

Blending

Tab Item Description

Specifies the tolerance to be allowed for blending targets. The

Blending Target target may go out of range by the percentage specified before

Tolerance (%) it is considered to be an error.

Default = 10%.

Specifies the colors for the targets that are within the range

In Range Colour specified in the blend, < =10%.

Default = Green.
Blending
Specifies the colors for the targets that are outside the range
specified, but the control quantities have not yet been
Warning Colour
reached, >10% and < =20%.

Default = Amber.

Specifies the colors for the targets that are outside the range
and over the control quantity, or the range is not achievable
Error Colour
over the control quantity >20%.

Default = Red.

NOTE: You are able to change the colors to whatever suits your site warning system standards.

Release 4.4.x © Caterpillar 2001-2016 Page: 326 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Decision Support

Tab Item Description

Specifies the color in which to display the background of the


Decision Support pages so that they are clearly dis-
tinguishable from the live production system.
Background
Decision Support
color
You are able to change the background color to
whatever suits your site.

Production Requirements

Tab Item Description

Reset require-
Production Select this check box if you want the production requirements
ments on shift
Requirements to be reset at every shift change.
change

Page: 327 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Shift Change

Tab Item Description

Displays the Processor tab on the Shift Change


Show Processors
Editor page.

Exclude Delayed Specifies that machines on delay at the start of the


Machines shift will be excluded from shift change allocation.

This list contains options for where the loading tools

General should tie down. Valid options are:


Loading Tools Tie
Tie down at destination.
Down Default
Tie down at loading tool.

Use default tie down.

Enable Shift Change Select this check box if you want to enable shift
Groups change groups.

Schedule

Release 4.4.x © Caterpillar 2001-2016 Page: 328 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Automatic Tie Down Select this check box if you want to enable auto-
Assignments matic assignments for tie down.

The tie down load state. One of Full or Empty, Full,


Load State
or Empty.

Assignment Delay
The default delay type for the lineup.
Type

Arrival Delay Type The name of the default delay type for arrival.

The earliest permitted arrive time at the lineup loc-


Automatic Tie Down
ation for automatic tie down assignments relative to
Assignments Arrive After
the shift end.

Default = –30 minutes.

The preferred arrive time at the lineup location for


automatic tie down assignments relative to the shift
Arrive At
end.

Default = –15 minutes.

The latest permitted arrive time at the lineup location


for automatic tie down assignments relative to shift
Arrive Before
end.

Default = –5min.

Page: 329 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Select this check box to enable automatic logout of


Automatic Logout
machines that have no on-board hardware.

The time relative the shift end at which to do the auto-

Logged At matic logout.

Default = –5min.

Logout Delay Type The default delay type for the logout.

Automatic Logout and Select this check box to enable automatic login of
Automatic Login
Login machines that have no onboard hardware.

The time to perform the automatic login. This value


is in minutes relative to the end of the shift.

Default = 5.
Login At
Avoid overlapping the logout and login time, as it res-
ults in the incoming operators being logged on to the
machines before the outgoing operators have logged
out.

Release 4.4.x © Caterpillar 2001-2016 Page: 330 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

The time that the end of shift actions can begin, rel-

Early End Of Shift ative to the normal shift end.

Default = –60 minutes.

The time that the end of shift actions must complete,


Late End Of Shift
relative to the normal shift end.
Slider Options
The time that the start of shift actions can begin, rel-
Early Start Of Shift
ative to the normal shift start.

The time that the start of shift actions must com-

Late Start Of Shift plete, relative to the normal shift start.

Default = 60 minutes.

The time to clean up any obsolete scheduled assign-

Assignments Cleanup ments. This value is in minutes from the start of the

Time shift.

Default = 30.
Other
The amount of time to store who is actually logged in

Store Actual Login for each machine. This value is in minutes before the

Duration start of the shift.

Default = 60.

Include Transport Select this check box to include transport vehicles in


Report
Vehicles the operator allocation report page.

Page: 331 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Travel Progress Monitor

Tab Item Description

The time to keep unused line graphs, in seconds.


Layout Update Interval
Default = 60.

The number of seconds between view updates.


View Update Interval
Default = 10.

The number of seconds that define a truck as arriving

Soon Interval soon.

Default = 30.

General
Indicates the grouping of traveling trucks. Valid options

Traveling Trucks Dis- are:

play l Group by Remaining Distance.


l Group by Arrival Time.

This list contains options for fleet filtering. Valid options


are:
Default Fleet Filterings l Both trucks and servers
l Servers
l Trucks

Empty Trucks Panel


Layout Loaded Trucks Panel Specifies the items to display in each panel.
Station Trucks Panel

Empty Trucks Panel

Annotations Loaded Trucks Panel Specifies the annotations to display in each panel.

Station Trucks Panel

Release 4.4.x © Caterpillar 2001-2016 Page: 332 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Specifies the colors to use for each of the available truck


Truck States
states.

Legend Specifies the items to display in the legend.

Empty Trucks Panel


Colors
Loaded Trucks Panel
Station Trucks Specifies the colors to use for various aspects of these
Delayed Trucks panels, such as the background, foreground, etc.
Ignored Trucks
Not Assigned Trucks

Page: 333 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Specifies the width of the icons.


Width
Default = 16 pixels.

Specifies the height of the icons.


Height
Default = 16 pixels.

Specifies the width of the left-side column where


machines are coming from the server.
From Server Width
Default width= 40 pixels.

Maximum width default = 200 pixels.

Specifies the width of the right-side column where


machines are going to the server.
Sizing
To Server Width
Default width = 80 pixels.

Maximum width default = 200 pixels.

Specifies the width of the waiting column to the left of the


arrive/service column, where machines have arrived and
are waiting to be serviced.
Arrived/Serviced Width
Default = 240 pixels.

Maximum width default = 400 pixels.

Specifies the number of right-hand columns where


Arrived/Service
machines have come from the server.
Column Count
Default = 2 pixels.

Release 4.4.x © Caterpillar 2001-2016 Page: 334 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Trucking Indicator

Tab Item Description

Specifies the color-combination to use in the Trucking


Over-Trucked Colors
Status Indicator when the mine is over trucked.

Just Over-Trucked Col- Specifies the color-combination to use in the Trucking


ors Status Indicator when the mine is just over trucked.

Correctly Trucked Col- Specifies the color-combination to use in the Trucking


ors Status Indicator when the mine is correctly trucked.

Just Under-Trucked Specifies the color-combination to use in the Trucking


Trucking Indic- Colors Status Indicator when the mine is under trucked.
ator Values
Specifies the color-combination to use in the Trucking
Under-Trucked Colors
Status Indicator when the mine is under trucked.

Specifies the color-combination to use in the Trucking


Trucking not yet
Status Indicator when the trucking status of the mine has
determined Colors
yet to be determined.

Specifies the values to use when determining the trucking


No LP Solver Truck-
status of the mine when advanced production requirements
ing Indicator Values
are not in use.

Page: 335 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Trucking Information

Tab Item Description

The maximum period between refreshes of the Truck-


ing Indicator page, which is in the office software.

Default = 1s.
Refresh Period
It is recommended that if you have a lare mine site that
you change the refresh rate to between 30 and 60
seconds.

Specifies the color in which to display loading tools that


Over Trucked
are over-trucked.
Trucking Information
Specifies the color in which to display loading tools that
Under Trucked
are under-trucked.

Specifies the color in which to display loading tools that


Correctly Trucked
are correctly-trucked.

Minimum Correctly The minimum truck coverage for a loading tool to be


Trucked Coverage considered correctly trucked.

Maximum Correctly The maximum truck coverage for a loading tool to be


Trucked Coverage considered correctly trucked.

Release 4.4.x © Caterpillar 2001-2016 Page: 336 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Trucking Information GUI

Tab Item Description

Text color for detail


Specifies the color in which to display text in table rows.
row information

Text color for load- Specifies the color in which to display text for loading

Trucking Information ing tools with no tools that have not had any trucks allocated to them by

GUI Control allocated trucks Assignment.

Time between Enter the length of time between refreshes of Trucking

refreshes of Truck- indicator.

ing Indicator Default = 60 seconds

Health

Channel Finder

Tab Item Description

Specifies that the finder tree expand by default when the


Channel Finder
Expand Channel Tree Channel Finder is opened.
Tree
Do not edit any other fields.

Page: 337 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Channel Monitor

Tab Item Description

Specifies the default period of time, in minutes, for


which polling will occur.
Poll Duration Time
Default = 30.

Maximum = 1,400 (1 day).

Specifies the minimum period of time, in seconds,


Durations
Min Poll Rate Time between readings polled from VIMS.

Default = 10.

Specifies the default period of time, in seconds,

Poll Rate Time between readings polled from VIMS

Default = 30.

Specifies that channel readings be randomly gen-


erated by the office software. If cleared, channel
Advanced Use Random Data
readings are received from VIMS.

Default = cleared.

Channel Monitor Chart

Item Description

The amount of time, in milliseconds, that a label stays vsible when it is

Label Visible Time displayed on the chart.

Default = 5000 milliseconds (5 seconds).

Release 4.4.x © Caterpillar 2001-2016 Page: 338 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Item Description

Select this check box if the left and right mouse buttons should be
reversed when using the chart. If you select this check box, the right
Reverse Mouse Buttons
mouse button will display a chart label, and the left mouse button will
enable panning.

Plot Area Background Color Default = 0,0,0.

Chart Grid Color Default = 192,192,192,192.

Chart Border Color Default = 58, 110, 165

Axis Label Color Default = 255, 255, 255

Label Foreground Default = 255, 255, 128

Label Background Default = 92, 92, 92.

Connector Color Default = 128,128,128.

Icon Exclusive View


Do not edit either of these fields.
Icon View

Event Report

Tab Item Description

The logo image to display in the top right corner of


Report Logo Image each report. This needs to be either a gif or a jpg
image file.

Page: 339 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Health Reporting

Tab Item Description

Select this check box to use VIMS Object ID


instead of Name for view and view column names.
If this check box is selected, the new Health nam-
ing pattern is used rather than the legacy naming of
Health Consolidated Use VIMS Object ID for views and columns of views.
Views naming

The Business Objects Universe must


match the view naming pattern.

Telemetry

Tab Item Description

Telemetry General The maximimum size of the thread pool allowed


Thread pool size
to process the telemetry requests.

Machine Open Channel The maximum number of channels per machine


Max (VIMS) that the system can request data for.

Release 4.4.x © Caterpillar 2001-2016 Page: 340 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Machine Open Channel The maximum number of channels per machine


Max (VIMS3) that the system can request data for, for VIMS3.

System Open Channel The upper limit of channels open across all
Max macines for the system.

Additional Logging Select to perform additional logging.

The interval the machines will be polled for new


Refresh interval data. The default is five minutes, however you
User can refresh polling up to every 30 seconds.
Polling
The maximum duration that polling can execute
Polling Enquiry
for.

Sysetm Refresh Intreval The interval refesh time, in seconds.

Polling
Disable Select to disable System Polling/

User Interface Health

Item Description

Specifies the maximum number of real-time health data streaming


Maximum Streaming
channels available.

Specifies the maximum age of the favorite measure cache.


Favorite Measure Cache Age
Default = 3600 seconds

Specifies the maximum age of the telemetry request cache.


Telemetry Request Cache Age
Default = 3600 seconds

Page: 341 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

VIMS Import

Tab Item Description

The number of hours in the future that it is per-


missible for VIMS files to be timestamped if they
are to be considered valid. This is required to sup-
Maximum timezone off-
port sites in different time zones. Files containing
set in hours
data in excess of this many hours in the future will
be rejected.

Default = 2 hours.

The minimum valid fuel used in a cycle. This is


used to guard against invalid reported values in
Minimum Fuel
VIMS Cycle reports.
Vims Import Para- Default = 0.1 liters.
meters
The maximum fuel used in a cycle. This is used to
guard against invalid reported values in VIMS
Maximum Fuel
Cycle reports.

Default = 200 liters.

Select this check box to backup files to the tar-


geted location. This check box is disabled by

Backup files prior to default.

file import Selecting this check box also selects the same
option in the office software when running the
VIMS Data Import job.

Release 4.4.x © Caterpillar 2001-2016 Page: 342 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

VIMS File Upload

Tab Description

Purge old upload


Purges VIMS files downloaded more than 30 days ago from the backup folder.
data by default

Data retention Number of days to retain files.

period in days Default = 30 days.

VIMS Wireless Download

Item Description

Set Clock Specifies that the VIMS clock be set from the the office software server at each download.

Page: 343 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Machine Tracking

Audit

Tab Item Description

Enter the

l location of the XML audit file.


XML Audit Con-
l maximum size of the audit file.
figuration
l length of time the audit file will exist before mandatory
rolling occurs.

Enter the
General CSV Audit Con-
l rollover strategy for the CSV file.
figuration
l location of the CSV audit file.

Select whether or not to audit database changes.

Database Audit Enter the


Configuration
l Database Audit File rollover strategy.
l the location of the database audit file.

Select whether or not to capture the audit log of user cycle edits
Cycle audit log
and splits.
Services
Machine audit Select whether or not to capture the audit log of user machine
log edits.

Release 4.4.x © Caterpillar 2001-2016 Page: 344 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Destinations

Item Description

Specifies that a destination will be colored blue in the Destination Chooser on


Machine Assistant pages when it is closer than this distance to the loading tool or pro-
Near Radius
cessor.

Default = 500m.

Dynamic Mine Model

This option is available in both Supervisor and the office software. Changes made in one application are reflec-
ted in the other, although changes made in Supervisor do not take effect until next time you start the office soft-
ware application. Changes made in the office software take effect immediately.

Page: 345 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Select this check box if you want to use dynamic travel


Updates Enabled
times to update the mine models.

Select this check box if you want alarms to be raised if


Alarms Enabled the observed dynamic travel times are outside the spe-
cified limits.

Specifies how often to update the mine model with new


travel times, in minutes.
Dynamic
Travel Times New travel times are written to a buffer and when the
update frequency value is reached, new travel times are
written to the database and made available to Assign-
Update Frequency ment, after which the buffer is emptied.

Updates are only written if the new values are within the
Nominal Time and Current Time thresholds (see below).

0 = update as soon as changes are detected

Default = 10 minutes.

Release 4.4.x © Caterpillar 2001-2016 Page: 346 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

The multiplier to apply to the nominal time to get the min-


imum allowable dynamic time.
Nominal Threshold Times
— Minimum Allowable 0 = ignore.

Default = 0.5.

The multiplier to apply to the nominal time to get the


Nominal Threshold Times
maximum allowable dynamic time.
— Maximum Allowable
0 = ignore.

The multiplier to apply to the current dynamic time to


determine the minimum allowable dynamic time.
Current Threshold Times
— Minimum Allowable 0 = ignore.

Default = 1.5.

The multiplier to apply to the current dynamic time to


determine the maximum allowable dynamic time.
Current Threshold Times
— Maximum Allowable 0 = ignore.

Default = 1.5.

The percentage of change required before a travel time


Current Threshold Times is updated.
— Minimum Significant
0 = ignore.
Change
Default = 10%.

The minimum absolute allowable dynamic time, in


seconds.
Absolute Threshold Times
— Minimum cutoff 0 = ignore.

Default = 10 seconds.

Page: 347 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

The maximum absolute allowable dynamic time, in


Absolute Threshold Times
minutes.
— Maximum cutoff
0 = ignore.

Select this check box if you want to use dynamic load-


Updates Enabled
ing tool efficiencies to update the mine models.
Dynamic Load-
Specifies how often to update the model with new effi-
ing Tool Effi-
ciencies, in minutes.
ciency
Update Frequency
0 = update as soon as changes are detected.

Default = 5 minutes.

Release 4.4.x © Caterpillar 2001-2016 Page: 348 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Specifies the multiplier to apply to the expected time to


Current Efficiency get the minimum allowable efficiency.
Thresholds — Minimum
0 = ignore.
Allowable
Default = 0.5.

Specifies the multiplier to apply to the expected time to


Current Efficiency get the maximum allowable efficiency.
Thresholds — Maximum
0 = ignore.
Allowable
Default = 1.5.

Specifies the percentage of change required before a


Current Efficiency time is updated.
Thresholds — Minimum
0 = ignore.
Significant Change
Default = 10%.

Specifies the minimum absolute allowable dynamic effi-


Absolute Efficiency ciency.
Thresholds — Minimum
0 = ignore.
cutoff
Default = 50%.

Specifies the maximum absolute allowable dynamic effi-


Absolute Efficiency ciency.
Thresholds — Maximum
0 = ignore.
cutoff
Default = 50%.

Page: 349 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

This setting is a precautionary measure.

It resets the fuel level to 0 when Fleet is restarted and


fuel has not been entered on-board or though the Fuel
System in the set time (set to 12 hours).

Default = 12 hours.

NOTE: The setting can be increased to some-


thing like 28 or 36 hours, however it is depend-
Fuel Reset Duration
ant on the size of your fleet.

The disadvantage of disabling this field, or


Dynamic Fuel
extending the time, is that it will increase
Monitoring
the chances that the office software will
overestimate the amount of fuel remaining
and allow a truck to run out of fuel.

Select this check box if you want to use the estimated

Estimated Fuel Con- fuel consumption to update the machine fuel levels.

sumptiton VIMS values will always be used.

Default = selected.

Select this check box if you want to use the fuel burn

Burn Rate Updates rate to update the machine fuel burn rate.

Default = selected.

Release 4.4.x © Caterpillar 2001-2016 Page: 350 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Select this check box if you want alarms to be raised if


the observed dynamic fuel consumption amounts are
Alarms Enabled
outside the specified limits.

Default = selected.

Page: 351 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

The multiplier to apply to the burn rate to get the min-


Relative Burn Rate imum allowable rate.
Thresholds
0 = ignore.
— Minimum Allowable
Default = 0.8.

The multiplier to apply to the burn rate to get the min-


Relative Burn Rate imum allowable rate.
Thresholds
0 = ignore.
— Maximum Allowable
Default = 1.2.

Relative Burn Rate


The percentage of change required before a burn rate
Thresholds
will be updated.
Dynamic Fuel
— Minimum Significant
Monitoring con- Default = 0 ignore.
Change
tinued
Absolute Burn Rate The absolute minimum allowable working burn rate in 

Thresholds l/hr.

— Minimum cutoff Default = 0 = ignore.

Absolute Burn Rate The absolute maximum allowable working burn rate in

Thresholds l/hr.

— Maximum cutoff Default =0 = ignore.

Select if fuel consumption estimates (average burn vs


Relative Fuel Con-
activity/efh based) are to be compared against each
sumption Thresholds
other to validate estimate accuracy.
— Use Estimate Check
Default = Not selected.

Release 4.4.x © Caterpillar 2001-2016 Page: 352 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

This field is only editable if Use Estimate Check is


selected.
Relative Fuel Con-
Enter the multiplier to apply to the working/idle based
sumption Thresholds
fuel estimate to get the minimum allowable fuel estim-
— Minimum allowable
ate.

Default = 0.5. 0 = ignore.

This field is only editable if Use Estimate Check is


selected.
Relative Fuel Con-
Enter the multiplier to apply to the working/idle based
sumption Thresholds
fuel estimate to get the maximum allowable fuel estim-
— Maximum allowable
ate.

Default = 1.5. 0 = ignore.

Enter the tolerance (%) to be applied to the fuel usage

Fuel Usage Monitoring estimates. When the machine refuels, if the estimated

— Refuel Estimate Tol- amount of fuel required differs from the actual amount

erance by more than the percentage entered, an alarm is raised.

Default = 0.25 (25%).

Efficiency Slider

Item Description

Slider minimum Specifies the minimum value for the slider.

percentage Default = 50.

Slider maximum Specifies the maximum value for the slider.

percentage Default = 150.

Page: 353 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Item Description

Specifies the major tick spacing for the slider. The number represents the distance
between each major tick mark. For example, if you have a slider range of 0 to 50 and
Slider major spa-
the major tick spacing is set to 10, you will get major ticks next to the following val-
cing
ues: 0, 10, 20, 30, 40, 50.

Default = 25.

Specifies the minor tick spacing for the slider. The number represents the distance
between each minor tick mark. For example, if you have a slider range of 0 to 50 and
Slider minor spa-
the minor tick spacing is set to 10, you will get minor ticks next to the following val-
cing
ues: 0, 10, 20, 30, 40, 50.

Default = 25.

Slider “snap to Select this check box if you want the slider to snap to the tick mark closest to where
ticks” you have positioned the slider.

Fleet Update Assistant (FUA)

Tab Item Description

Update Inter- Specifies the time interval, in seconds, to gather change events and
val update them in a single batch.

Maximum
Specifies the maximum time between updates, in minutes. You
Time
General should set this field to 0 if you do not want to use time-based updat-
Between
ing.
Updates

Show Last Select this check box to have the last update time shown in the status
Update Time bar.

Release 4.4.x © Caterpillar 2001-2016 Page: 354 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

A comma-separated list of KPIs that the office software monitors. A


Update List change to any of these KPIs effects an update to the KPI Statistics
Display List.
KPIs

A comma-separated list of KPIs that the office software displays in


Display List
the Fleet Update Assistant.

Event Table Siz- Event Table


Specifies the maximum number of events to show in an event table.
ing Size

Allow Quick
Select this check box to allow editing of the Truck Loading Tool and
Truck Table Truck Lock
processor Locks.
Changes

Page: 355 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

NOTE: To monitor fuel in the office software you must open Fleet Update
Assistant, click Configure Properties on the toolbar, and on the Pages tab
include Fuel. Restart the office software after making any changes in Super-
visor.

If the fuel level falls below the percentage entered, the value is dis-
played in the FUA in the selected Warning color. Values greater than
Warning %
the number entered are displayed in the selected "Ok" color.

Default = 40%.

If the fuel levels fall below the percentage entered, the value is dis-

Critical % played in the FUA in the selected Critical color.

Fuel Monitoring Default = 20%.

Fuel Ok Select a display color for "Ok" fuel percentages.

Fuel Warn-
Select a display color for Warning fuel percentages.
ing

Fuel Critical Select a display color for Critical fuel percentages.

Show only Select this check box to flter the machines on the fuel tab to only
VIMS 3G those with a VIMS 3G onboard platform. If this check box is not selec-
enabled ted, the FUA fuel tab displays fuel information for all machines, includ-
machines ing estimated values.

Allow user Select this check box allows you to hide zero percent entries. A
to hide 0% check box displays on the FUA in the office software. Clearing this
entries check box removes the option from the FUA.

Release 4.4.x © Caterpillar 2001-2016 Page: 356 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Exception SMU Excep- Displays the age of SMU records in hours. This will display in colored
Rendering tion cells in the Fleet Update Assistant. Colors are set in Options > Sys-
tem Options > Graphical Display > Exception Rendering.

l Error >= 168 hours


l Warning >= 24 hours
l Information >= 12 hours

Note:The colors set apply to many exception rendered


screens throughout MineStar, not just SMU.

TKPH Displays the percentage level of the TKPH the tire can handle before
Percent overheating. This will display in colored cells in the Fleet Update
Exception Assistant. Colors are set in Options > System Options > Graphical
Display > Exception Rendering.

l Error >= 60%


l Warning >= 40%
l Information >= 10%

Note:The colors set apply to many exception rendered


screens throughout MineStar, not just TKPH.

Page: 357 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Final Roads

Item Description

Time between Specifies the time, in milliseconds, to wait before deleting final road segments. This

road removals value should be approximately twice the cycles cache time-out value.

(Milliseconds) Default = 14400000 (4 hours).

Specifies the default EFH for final road segments, and is used for all final road seg-
EFH value for
ments.
FINAL roads
Default = 1.0.

Maximum Geo- Specifies the maximum grade, as a percentage, that is allowed for final road seg-

metric Grade for ments. This maximum gradient percentage applies to all final roads.

FINAL roads Default = 10.

GIS Server

This menu item allows you to specify the location, URLs and other information for the GIS server.

Release 4.4.x © Caterpillar 2001-2016 Page: 358 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Graphical Display

Page: 359 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Road Display Displays the Width of roads. If the value is 0 the roads will dis-
Width play as a single line.

Truck Length Displays the length and width of a typical truck


and Width

GPS X and Y Display the GPS X and Y locations on a typical truck.

Exclude From Enter layers to exclude from a search in Site Monitor or Site
Search Editor to improve performance.

Use Z Values When the surface definition is not maintained, clear this check
from Surface box to interpolate the Z values from the currently loaded DXF
file. When the check box is cleared, and no DXF is loaded,
moving an entity will not change the Z value.
General
Edit Box Size Select the size of the radius of the box when selecting a point
to edit in graphical editors.

Box sizes are as follows.

l Expert - 6 pixels
l Normal - 8 pixels
l Large - 10 pixels
l Huge - 12 pixels

Show Truck Select to display icons for situations such as loss of com-
Overlay Icons munication or stopped.

Show Speed Select to display the speed of the machine in graphical dis-
plays such as Truck Assistant and Site Monitor. The speed will
display for all machines traveling over 3kph (1.8mph).

Release 4.4.x © Caterpillar 2001-2016 Page: 360 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Enable Select various boundary visualization options.


Enhanced
Boundary Visu-
alization

Zoom Level Enter the zoom levels for Icon and Text display size.
Switches

Exception Ren- Severity Colors The color to display for Errors, Warnings, and Information noti-
dering fications. Colors are used on various pages, e.g. Road Seg-
ment Assistant, Waypoint Assistant, Fleet Update Assistant.
Standard colors set are Red for Error, Orange for Warning, and
Yellow for information. Click the ellipses to select different col-
ors.

Maximum Road Specifies the maximum gradient for roads. If a created road
Gradient exceeds this gradient on any part of the road, a warning is
shown when the road is created.

Slow Speed Enter the speed limit that will trigger the error, warning or inform-
Limit ation severity coloring.

Missed Way- Enter the surface distance that will trigger the error, warning or
points information severity coloring.

Surface Distance Enter the surface distance that will trigger the error, warning or
information severity coloring.

Lane Distance Enter the lane distance that will trigger the error or warning
(relative to truck severity coloring.
width)

Page: 361 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Incident Service

Item Description

Lists the incident report message types to capture. These message types are saved
Message Filter for all machines as long as the messages are in the incident event time range and con-
tain location information.

Specifies the duration of when to search for related incident events within the same

Related Event event handler when building an incident report. The search looks for events within this

Duration duration either side of each selected incident event.

Default = 10 minutes.

Server Yield dur- Specifies the yield minimum, increment, maximum, reset and threshold values.
ing Capture

Loadout Unit Integration

Item Item Description

Loadout Specifies the load limits for the loadout units.

Thresholds Defaults = 140, 190, 240.


Loadout
Thresholds
Allowable Over- The amount, in tonnes, that a loadout unit may be overloaded.

load Default = 10.

Release 4.4.x © Caterpillar 2001-2016 Page: 362 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Item Item Description

Specifies the maximum lag time, in seconds, for messages. If


Max field mes-
the message is too old, it will be rejected.
sage lag time
Default = 30.

Specifies the maximum response time, in seconds, for the

Max loadout loadout unit. If there is no response from the loadout unit within
Communications
response time this time, an error will be logged.
Parameters
Default = 10.

The number of times to retry sending a loadout remote exec


Retry Count
command if there has been no response from the loadout unit.

Retry Wait Time The time, in seconds to wait between retries.

Request Com- Specifies the command to use to request a load.

mand Default = RequestLoad.

Specifies the command to use to automatically load from the


Auto Load Com-
loadout unit.
mand
Default = Load.

Script Settings
Specifies the command to use to manually load from the loadout
Manual Load
unit.
Command
Default = ManualLoad.

Specifies the command to use to stop loading from the loadout

Stop Command unit.

Default = StopLoad.

Page: 363 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Machine Assistant

Tab Item Description

Use Last Win- Select this check box to have the Machine Assistant windows
dow Size open at the same size as when they were last opened.

Connection Pro- Settings File Specifies the file name for the defined connection programs to be
grams Name stored in the Client LOGS directory.

Enter the name and location of the VNC Program and associated
VNC
arguments.

Cat Remote Enter the name and location of the Cat Remote Program and
Program associated arguments. The location field now allows spaces in
the path text.
Cat Remote
Arguments The -h argumentindicates the Device IP Address which will be
used by Remote Tools to connect automatically. Note that you
can also see this in the various Machine Assistant's Configure
Display Properties screen.

Enter the name and location of the Phindows Programe and asso-
Phindows
ciated arguments.

Machine Control

Item Description

Selecting this check box causes additional information to be sent with every assign-
Send Arrival
ment to the trucks, providing arrival times for the truck at each waypoint. It also
Time Info
provides information to

Release 4.4.x © Caterpillar 2001-2016 Page: 364 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Item Description

Cancel Assign- Enter the ID of the waypoint to give to a truck when the truck cannot be assigned. The
ment Waypiont value you enter should match the ID of a waypoint wth a name such as "Unas-
ID signed". Entering 0 disables the feature.

Send Destination Select this check box to have the name of the assigned server sent to the truck and
Server Name displayed as the destination rather than using the last waypoint name.

Max Loaders Per Enter the maximum number of loaders to be sent the assignment message.
Message

Send Destination Select this check box to have the description of the destination server’s waypoint
Description sent to the truck and displayed as the destination, rather than using the name of the
assigned server or the last waypoint name.

When selecting this check box you must also have the Send Destination Server
Name check box selected.

Leaving Loaded As a truck leaves a loading tool loaded and starts traveling loaded, this duration in
Leeway seconds is the leeway allowed before the truck is shown as not having received an
assignment in the Travel Progress Monitor.

As a truck leaves a processor and starts traveling empty, this duration in seconds is
Leaving Empty
the leeway allowed before the truck is shown as not having received an assignment in
Leeway
the Travel Progress Monitor.

Machine Manager

Item Description

Time Before Specifies the length of time the system should wait for a reply to a message that it
Resend has sent to a machine. The time is specified in milliseconds.

Number of Specifies the number of times the system should try to resend a message if the oper-
Retries ator has not replied to it within the time specified by the Time Before Resend field.

Page: 365 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Machine Nodes

Tab Item Description

Specifies the period, in milliseconds, after which a machine is


Communications
assumed to have stopped communicating.
Time-out
Monitor Default = 120000.
Communica-
tions Activity Specifies how often, in milliseconds, you want to update a
Communications
Node machine’s status after assuming that the machine is not com-
Monitoring
municating. The value should be set to 30 seconds or greater.
Responsiveness
Default = 30000.

Maximum Num- Specifies the number of waypoints missed. A value less than 1

ber of Missed means that the largest possible count will be kept.

Waypoints Default = 1000000.


Path Monitor
Node Raise Alarm Specifies the value which, when exceeded, raises an alarm. If the

When Missed value is more than the maximum value of the missed count, alarms

Waypoints will never be raised.

Exceeds Default = 25.

Release 4.4.x © Caterpillar 2001-2016 Page: 366 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Machine Services

Tab Item Description

Cause Onboard to
If selected, the on-board hardware beeps every time an assign-
Beep for Every Assign-
ment is sent.
ment

If selected, the office software sends waypoint information for


Assignment
Update all Loading all loading tools in the mine to the truck as part of its assign-

Tool Positions on ment message. Otherwise, only waypoint information for load-

Assignment ing tools related to the truck’s current assignment is sent.

Default = Selected.

Mine Boundaries

Maximum and Minimum Boundary


Specify the minimum and maximum boundary values.
X, Y and Z Values

Page: 367 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Mine Model Query

Tab Item Description

Specifies the age, in milliseconds, a query can be before it is

Query Expiry Time considered to have expired.

Default = 350000 ms (5 minutes).

Specify the colors used to highlight an expired query. You can


enter this as either:

Expired Query Color A value such as Black, Green.

Foreground and Back- A hexadecimal number representing the RGB color value, for

ground example, Aqua = #00FFFF.


Mine Model
Query Default = #FFAF00.

You can enter a foreground color and/or a background color.

Specifies the color used to highlight warnings. You can enter


this as either:

A value such as Black, Green.


Warning Color
A hexadecimal number representing the RGB color value, for
example, Aqua = #00FFFF.

Default = #FFAF00.

Release 4.4.x © Caterpillar 2001-2016 Page: 368 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Operator

Tab Item Description

If selected, the office software checks that the


Check For Allocated Machin machine allocated at shift-change is actually
being used.

When selected, the office software forces the


Urgent Safety Checklist alarm priority to Urgent for a failed safety check-
list item.
Operator Login
Indicates which message to send to the Oper-
ator when an off-course event is received. If no
Off Course Message ID
off-course messages are to be sent, this field
should be left blank.

Check to send a random safety Select to allow a random safety message to be


message when a delay ends sent when a machine ends any delay.

Page: 369 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

The normal maximum lifetime of the license.

It is added to the Date Acquired in the office


Machine License Duration software to give the Expired Date. Entering a
value of zero means the license will never
expire, and the Expired Date field will be blank.

The number of days that a license does not


need to be used. This field applies to licenses
that need to be used frequently to be valid.

It is added to the Last Use Date in the office


Unused License Duration
software to give the Unused Expire Date.
Operator Licens- Enter a value of zero for a license that does not
ing need to be used frequently to be valid. The
Unused Expire Date field will be blank.

Used to highlight the licenses that are soon to


expire if they are not used. This will color the
operators in the office software operator
chooser when selecting an operator for a
Unused License Expiry Warning
machine, and also in the Shift Change Editor
Period
page in the office software when assigning an
operator to a machine.

Enter a value of zero to disable the coloring for a


license that will expire if it is not used soon.

Note: You need to be in Expert Mode to


view this option.
Crews

Select the check box to allow an operator to be


a part of multiple crews.

Release 4.4.x © Caterpillar 2001-2016 Page: 370 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Roads

Tab Item Description

Haulage Roads

Final Roads

Untravelable Roads Specifies the color in which to display the various road
types.
Partially Travelable
Roads

Archived Roads

Enter the speed limit for the road.


Speed Limit
Default = 15 m/s.

Width Enter the width of the road.

Properties
Enter the tax class for the road.
Tax Class
Default = In_Pit.

Condition Enter the conditiion of the road.

Enter the Rolling Resistance of the road.


Rolling Resistance
Default = 2%.

Use Dynamic Travel Select to use Dynamic Travel Times.

Times Default = Selected.

Select to allow passing on the roads.


Passing Allowed
Default = Selected.

Page: 371 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Specifies the delay, in milliseconds, before processing


events that update road attributes. A longer delay reduces
Batch Processing
CPU usage but also reduces the currency of road inform-
Delay
ation.

Default = 5000.

Options for specifying how EFH factors should be updated

Road Man- for haulage and final roads.

agement Set- Automatically Update Haulage Roads – EFH factor is


tings automatically updated for haulage roads according to the spe-
cified change thresholds.
Effective Flat Haul
Automatically Update Final roads

Minimum Amount Change – the absolute change in the


EFH factor below which no updates are calculated.

Minimum % Change – the percentage change in the EFH


factor below which no updates are calculated.

Release 4.4.x © Caterpillar 2001-2016 Page: 372 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Options for specifying how EFH distance should be updated


for haulage and final roads.

Automatically Update Haulage Roads – EFH distance is


automatically updated for haulage roads according to the spe-
cified change thresholds.
Effective Flat Haul
Automatically Update Final roads
Distance
Minimum Amount Change – the absolute change in
meters in the EFH distance below which no updates are cal-
culated.

Minimum % Change – the percentage change in the EFH


distance below which no updates are calculated.

Options for specifying how design travel times should be


updated for haulage roads.

Automatically Update Haulage Roads – design travel


times are automatically updated for haulage roads according
to the specified change thresholds.
Design Travel Times
Minimum Amount Change – the absolute change in
seconds in the design travel times below which no updates
are calculated.

Minimum % Change – the percentage change in the design


travel times below which no updates are calculated.

Specifies the position accuracy for manually moved infra-


Manual Move Accuracy
structure.

Page: 373 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Scheduled Break Notification

Tab Item Description

Specifies the number of messages per group when sending

Number of Messages messages to machines. A value of 0 or 1 will send each mes-

per Group sage as a group of its own.


Message Default = 2.
Control
Specifies the time to pause, in milliseconds, between each
Time Between Message
group of messages. When the value is 0, there is no delay.
Groups
Default = 5000 ms (5 seconds).

Server Waypoint Defaults

Tab Item Description

Set the naming convention for waypoints. Use {x} to select


the last digits of the x coordinate, {y} for the last digits of the
y coordinate, and {z} for the last digits of the z coordinate.

Naming Con- Use {n} to indicate a counter.


General
vention If you do not provide a counter, one may be automatically
added at the end of the name. All other characters are
treated as part of the name, e.g. WP{n}_x{xxx}_y{yyy} could
become WP1234_x1233_y123.

Release 4.4.x © Caterpillar 2001-2016 Page: 374 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Initial Type Code Specifies the initial type code for the waypoint.

Valid Type Codes Specifies the valid type codes for the waypoint.

Specifies the waypoint extension if a waypoint already


exists with this name. For example:

_E = Loading Tool.
Name Extension
Shovel, Loader, _L = Loadout Unit.
Loadout Unit, Pro-
_P = Processor.
cessor & Surface
Not available for shovels or loaders.
Miner Waypoints
tabs
Color Code Specifies the color code to use for the waypoint.

Description A description of the initial waypoint type.

Radius Specifies the radius of the waypoint.

Points Specifies the number of points on the waypoint polygon.

Flags A list of the attributes that can be enabled for the waypoint.

Other Waypoints:
Initial Type Code Specifies the initial type code for the waypoint.
Destination

Truck
Valid Type Codes Specifies the valid type codes for the waypoint.
Auxiliary

Page: 375 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Site Editor

Tab Item Description

Specifies the width of the lane if the lane has been created
General Lane Width
automatically.

Crosshair size (in Sets the diameter of the crosshair tool used in Site Editor for
Cross Hair pixels) editing objects.
Settings
Reticule size (in pixels) Sets the area covered by the reticule of the crosshair tool.

Sets the amount of data returned in a single call. The smaller

Maximum Individual the number, the smaller and faster the queries will be, but there

Result Size will be more of them.

Default = 512.

Trying to load more position reports than the default number

Maximum Total Result results in the time period being halved to reduce the total

Position Size amount of data to display.

Plotting Set- Default = 100000.


tings
The length of time, in minutes, it should take for position

Maximum Query Run reports to load. If the time taken is too long, the process will

Time stop prematurely.

Default = 3 minutes.

Activate Events Select this check box to show Activated Events by default.

Deactivate Events Select this check box to show Deactivated Events by default.

Release 4.4.x © Caterpillar 2001-2016 Page: 376 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Stopped Machine Detection

Tab Item Description

Activate Stopped
Stopped Machine Select this check box if you want the office software to look
Machine
Node for stopped machines, and try to put them on delay.
Determination

Only consider Select this check box if you want trucks to be considered
travelling trucks stopped when they should be traveling.

Specifies how long, in minutes, a machine should be stopped


Minimum delay
before the delay is put on.
duration
Default = 10 minutes.

Specifies the smallest time interval to consider position


Minimum time
reports for machines when attempting to determine if the
between position
machine has stopped.
reports
Default = 10 seconds.

Maximum speed Specifies the fastest allowed speed of a truck still considered

that is still stopped.

stopped Default = 2 kph.

Maximum dis- Specifies the largest distance a truck can move and still be

tance moved that considered stopped.

is still stopped Default = 15 m.

Page: 377 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Surface Management

Tab Item Description

Elevation Enter the value, in centimeters, at when the system should


Surface Management change ignore changes less than this value, when a portion of the sur-
threshold face has changeed.

Age raster
The size of the tiles, in meters, which the age raster covers.
resolution

Release 4.4.x © Caterpillar 2001-2016 Page: 378 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Material Tracking

Mining Block Management

Tab Item Description

Note: You need to be in Expert Mode to view this

Mining Show Open for Dump- option.

Block Editor ing and Loading

Select this check box to allow stockpiles to be available for


dumping and loading when resetting a stockpile in the client.

Specifies the number of mining blocks that can be sent per


message. Mining blocks should have 5 characters or less in
Max Grade Blocks Per
their name. If mining blocks have more than 5-character
Message
names the maximum should be decreased appropriately.

Default = 20.

Specifies the maximum number of loaders that can be sent a


single message. If more loaders are required, a second or third

Max Loaders Per Mes- message will be sent. The setting in this field depends on how

sage many mining blocks are likely to be active for each loader, and
Settings
therefore sent out with the messages.

Default = 3.

Specifies the maximum number of times a message will try to

Max Num Retries be sent before it gives up.

Default = 5.

Specifies how long the system will wait for a response before

Resend Timeout trying to resend the message.

Default = 180000 milliseconds.

Page: 379 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

TSS Color File

Note: The asterisk beside the fields means that this setting can be changed in a live system and the
change takes effect immediately without having to restart the system.

Item Description

Disable TSS Color File Select this check box to disable the generation of a new TSS Color File when a
generation material changes.

TSS Color File Destin-


Indicates the location of the TSS Color File destination.
ation

Indicates the recommended default extended text to retain backwards com-


Recommended Default
patibility to extract grade block information with Terrain for grading and loading
Extended Text Format
5.2 and below.

Enter any additional details to be added to the extended text beyond recom-
Custom extended text
mended and required text.

Release 4.4.x © Caterpillar 2001-2016 Page: 380 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Pit Link

Comms Monitor

Tab Item Description

Specifies the date format to be used, in the following format:

l dd MM HH:mm:ss a z.

where:

l dd = date in month.
Date Format l MM = month as a number or text.
l HH = hour in 24-hour time.
l mm = minute.
l ss = second.
l a = am or pm.
l z = time zone.
General
Select this check box to have responses to messages dis-
Include Responses In
played on the Field Communications Monitor when using fil-
Filters
ters.

Specifies the maximum number of rows before being dis-


Max Rows
carded. This field is used to limit memory usage.

Max Delta Specifies the maximum latency before being rendered in blue.

Specifies the number of messages to seek either side of the


Compressed Message
selected message when trying to identify members of a com-
seek Range
pressed message set.

Page: 381 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Speed

Satellites

Message Size Colors representing each statistic listed in the item column
Statistics
Duplicate Count Minimum = BLUE
Rendering
No Response Maximum = RED

Round Trip Time

Latency

Release 4.4.x © Caterpillar 2001-2016 Page: 382 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Comms Server

Page: 383 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Item Item Description

Select the services you wish to set. This enables more


options as described below.
Services
If you are using Site Awareness you should select the log-
ging, tmac and multicast check boxes.

Leave the logging class and directory as the default.

Default = {MSTAR_MESSAGES}.
Logging
If you set an alternate directory, it will not be cleaned up
by the scheduled clean-up task. You will have to set up
manual cleanup procedures for the directory.

Enter the TMAC port.


Active Services
Default = 16020.

Select the appropriate TMAC MTU packet size, either


Small or Large.
TMAC Set-
Small (TC900, 500 bytes) - Select this setting for TC900
tings
networks. They will fail, possibly completely, if larger
packets are sent.

Large (Broadband, 1466 bytes) - Select this setting when


running Fleet with Terrain to enable normal functioning of
office to on-board communications.

Do not bind to Select this check box if you do not want to bind these set-
Field NIC tings to the field NIC.

Release 4.4.x © Caterpillar 2001-2016 Page: 384 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Item Item Description

TMAC Multicast TTL (Time to live)

This field displays when you select multicast under Act-


ive Services. This field determines how many routers
TMAC Mult-
the multicast messages can pass through before they are
icast
discarded, which stops messages spreading too widely
in your network.

Default = 4.

Enter the maximum time in milliseconds to allow for


packet to be forwarded to Adaptor/Monitor before closing
Adaptor Settings
the connection because it is inactive.

Default = 30000.

Enter the port on which to accept queries for Comms

Statistics Settings Server statistics.

Default = 2001.

Page: 385 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Comms Services

Release 4.4.x © Caterpillar 2001-2016 Page: 386 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Enable Waypoint Select this check box to start the Waypoint Update Server
Update when the office software is started.

Enable Mining Block Select this check box to start the Mining Block Update when
Update the office software is started.

Select this check box to send mining block updates to loading


tools. This option is only available if Enable Mining Block
Update is selected.

The mining block updates send order (active blocks message)


has been prioritized as follows.

Send Mining Block First machine to receive the message is the loading tool the

Updates to Loaders block is activated for.

Additional Second machines to receive the message are the trucks cur-
Comms Ser- rently assigned to the loader.
vices
Third machines to receive the message are all of the trucks in
the assignment group.

Then the message is sent to the rest of the trucks if required.

Select this check box to send mining block updates to trucks.


Allow Sending Mining This option is only available if Enable Mining Block Update
Block Updates to is selected. When this check box is selected, an extra field is
Trucks added to the Machine Class in the office software. Clearing
this option lets you filter Block Update Messages by class.

Specifies the minimum period, in milliseconds, between


updates when the whole fleet is being updated. This option is
Wait Period
only available if Enable Mining Block Update is selected.

Default = 2000.

Page: 387 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Enable Automatic Select this check box to automatically downloads the TMAC
Download of TMAC Message Logs on receipt of a File Status message indicating
Message Logs the availability of a log file.

Internationalize Field Select this check box if you want the field names to display in
Names another language.

Release 4.4.x © Caterpillar 2001-2016 Page: 388 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Specifies the name of the host where Comms Server is run-


Host
ning.

Port Specifies the port number used to connect to Comms Server.

Allows I/O to be buffered or not buffered.


Use Buffered I/O
Default = Not buffered.

Specifies the maximum number of incoming messages per

Maximum number of second, per messgae type, before messages are discarded.

messages per second This is used to protect MineStar from message spikes.

Advanced Default = 100.

button
Specifies the minimum time, in nanoseconds, over which the

Maximim Time message rate is calculated.

Default = 5.

Select to use a sliding window to control congestion when


Verbose
sending bulk messages to the field.

Specifies the number of unacknowledged messages that can


Window Size
be on the wire at the same time.

Specifies the time in milliseconds to pause between each mes-


Window Timeout
sage sent.

Page: 389 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Select this check box to have messages sent to machines


even if they are not logged on.

Force Sends
Note: If machines are not Cat Fleet enabled you must
select this option to support MineStar communication
with the machines.

Enable SMU Gadget


Select this check box to start the SMU Gadget service.
Utility

Enter the length of time, in minutes, that the SMU Gadget will
poll. This option is only available if Enable SMU Gadget Util-
SMU Poll Period
ity is selected.

Default = 60.

Enter the length of time, in seconds, of the delay between


SMU Delay Between
polls.
Polls
Default = 1.

Machine Filter Expres-


Enter the expression for machine filtering.
sion

Display Waypoint
Description Instead of If selected, waypoint descriptions, rather than waypoint

Onboard Set- Name on Onboard Dis- names, are displayed on the onboard hardware.

tings tab plays

Cause TOPE to beep If selected, the on-board hardware will beep whenever it
when message receives receives a mesage.

Release 4.4.x © Caterpillar 2001-2016 Page: 390 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

External Reference

Tab Item Description

Show External Select to display the External Reference field in Delay Type
Ref Editor.

If the check box is selected you can not save a stockpile and a

Unique External delay type with the same external reference.

Ref If the check box is cleared, you are able to save a stockpile
and delay type with the same external reference.

Field Message Generator

Tab Item Description

Display Set-
Blocks to Display The number of blocks to display for each repeating group.
tings

GPS Coordinate Transform

Tab Item Description

Allows you to add a new coordinate system, and enables the


Add Button
Unit Set and EPSG Code fields.

Unit Set Click this cell and select the unit set.

Click this cell to enter the EPSG code. If you are using a cus-
EPSG Code tom EPSG code you must run the
publishCoordinateSystem tool first.

Page: 391 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Incident FTP

Tab Item Description

FTP Job FTP user name The user name to use when connecting to field equipment
when using FTP.

Default = aquila.

FTP password The password to use when connecting to field equipment


when using FTP.

Default = cold.

Onboard download dir- The download directory onboard the machine where you can
ectory retrieve incident files from.equipment when using FTP.

Default = mir_out.

Loading Tool Editors

Item Description

The maximum number of characters in a Loading Tool name. You can increase
the name lenghth to up to 16 characters.

Default = 7.
Name Length

Loading Tool names should not be extended at Fleet sites where


the extended names may cause on-board issues.

Clear this check box to remove the display of the mining block selector from

Show Spatial Model the Loader Editor page.

Default = Selected.

Release 4.4.x © Caterpillar 2001-2016 Page: 392 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Machine Broadcast

Item Description

Enable Machine Broad- If selected, enables the machine broadcast features.

cast Default = Selected.

If selected, machine positions will be sent to the field using multicast mes-
Enable Multicast Deliv-
saging.
ery
Default = Selected.

Enter the multicast url in the format tmac://xxx.xxx.xxx.xxx:ppp where


Multicast URL
xxx.xxx.xxx.xxx is an IPv4 multicast address, and ppp is a valid port number.

If selected, machine positions will be sent to the field using unicast messaging
(possibly in addition to multicast messaging). Only machines withan explicit
Enable Unicast Deliv-
’Machine Broadcast URL’ defined, and that have sent a PositionReport2 meas-
ery
sage to the office are sent updates using unicast delivery.

Default = Not Selected.

Raise alarms when


If selected, Alarms are raised when machines lose radio contact.
radio contact is lost
Default = Not Selected.
with machines

If selected, Alarms are raised when an unconfigured or misconfigured machine


Raise alarms for mis-
is detected.
configured machines
Default = Not Selected.

Raise alarms for time If selected, Alarms are raised when a time synchronization issue is detected.

synchronization issues Default = Selected.

Page: 393 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Item Description

Enter the length of time for which the system will not retrigger time syn-
Non-retrigger (Time
chronization.
Sync)
Default = 300s.

Put Loaders and If selected, Loaders and Shovels are put on delay when they lose radio con-

Shovels on delay when tact.

radio contact is lost Default = Not Selected.

Enter the time between broadcast position updates.


Update Period
Default = 0.5s.

Enter the time between position updates published to the bus.


Publication Period
Default = 0.5s.

Maximum time between The maximum time a non-autonomous machine can be out of contact.

updates Default = 300s.

The time to allow a machine to determine a fix after startup, before marking it

Startup GPS Timeout as having bad GPS.

Default = 300s.

Enter the accuracy to be used when determining if a machine is out of contact.


Clock Accuracy
Default = 1s.

Machines shut down for the specified length of time will be included in machine
Machine Off inclusion
broadcast messages.
period
Default = 60s.

Release 4.4.x © Caterpillar 2001-2016 Page: 394 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Item Description

Enter the length of time that the office software will broadcast an All Machine
Position (AMP) message, on receipt of an AllMachinePositionRequest mes-
Full AMP inclusion sage. This can be used to limit the amount of network traffic when a machine
period that has been out of comms for more than 60 seconds returns to the network,
or when a machine that has been shutdown is switched back on, and requests
an AMP mwaaFW.

Enables compression of AMP messages.


Compress AMP
Default = Not Selected.

Allow Position Report


If you are have machines that do not support PR2 messages select this check
1 (PR1) for Site Aware-
box to allow PR 1 messages to be sent.
ness

If you are using Position Awareness, you must set the following fields.

If you are running Terrain with Fleet, the following key needs to be changed in the MCU for the Ter-
rain on-board systems to match. $ Seconds to Request AllMachinePositions

After the entered number of seconds has elapsed since the last PR2 was sent,
Period of time between
a new PR2 is sent.
PR2s
Default = 5s.

After the vehicle has moved the entered number of centimeters since the last

Distance between PR2s PR2 was sent, a new PR2 is sent.

Default = 500cm.

Min period of time The minimum number of seconds between PR2s, (i.e. PR2s are not to be sent
between PR2s faster than this frequency).

Page: 395 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Nominal GPS Mode Accuracies

This tab allows GPS solution types to be mapped to nominal GPS Accuracies. All new equipment should
report GPS accuracy in meters. Old equipment can report GPS accuracy as one of a number of Solution
Types. The office software must always report GPS accuracy of machines in meters. As a consequence, the
office software needs to be configured to convert old-style Solution Types to meters. The fields on this tab
allow the mapping between Solution Types and meters.

Machine Finder and Editors

Item Description

Show External Ref If selected, the External Reference field is displayed in machine editors.

If selected, the Machine Finder page in the office software automatically


Auto Expand
expands to show all machines.

Release 4.4.x © Caterpillar 2001-2016 Page: 396 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Onboard Hardware

Tab Item Description

Specifies the time, in seconds, to wait between

Script Delay sending individual scripts.

Default = 5.

Specifies the maximum number of sim-


Max Simultaneous Transfers
ultaneous file transfers to field equipment.
File Transfer Set-
tings The default local path for the office software
files. This is relative to the Onboard Files Dir-
Default Local Path
ectory. Refer to "System directories" on
page 323

Synchronize MineStar files on Select this check box to have the latest
machine startup MineStar files FTP’d to machines on startup.

Select this check box to enable or disable


ACTIVE mode FTP.

Default = Not selected - Passive (PASV) mode.


Enable ACTIVE mode FTP Modern on-board systems now support PASV
mode FTP. We no longer directly access VIMS
ABL boxes via TC900 radios, so there is no
need to support ACTIVE mode.

Page: 397 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

If selected, personnel IDs are used as pass-


Use Personnel ID As Password words. Otherwise, a separate machine pass-
word is required.

If selected, all personnel are included in the


onboard operator file which is generated and
sent to trucks (rather than just maintenance
users). You can then configure the on-board
Onboard Login Using Names
hardware to present a list or tree of people to
choose from when logging in. Otherwise, a sep-
arate machine password is required.

Default = not selected.

Onboard Files
Allows you to override the value specified in the
standard Platforms.xml file. The default is to
Machines Using Mining Block allow mining block files to be sent to loaders
Files only. It is also possible to configure the office
software to send mining block files to both
trucks and loaders as required.

Allows you to override the value specified in the


standard Platforms.xml file. The default is to
Machines Using Mining Block allow mining block files to be sent to loaders
Files only. It is also possible to configure the office
software to send mining block files to both
trucks and loaders as required.

Release 4.4.x © Caterpillar 2001-2016 Page: 398 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Allows you to override the value specified in the


standard Platforms.xml file. The default is to
Machines Using Mining Block allow mining block files to be sent to loaders
Files only. It is also possible to configure the office
software to send mining block files to both
trucks and loaders as required.

Select this check box to specify whether or not


an MD5 checksum is used when sending and/or
receiving FileAction2 messages. The MD5
checksum is a method of creating a signature

Use MD5 Checksum for File for the file. When the file is received, the check-

Activation sum of the received file is checked against the


checksum of the original file. If the two do not
match, an upddate request is sent to get the cor-
rect version of the file.

Default = selected.

Page: 399 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Specifies the level at which delays begin to be


added to the hierarchy. For example:

1 – Include all delays using the full hierarchy.

2 – Include all delays from level 2 and below


using the full hierarchy.

-1 – Include all delays but do not use a hier-


archy.
Include Delays From Level

NOTE: You need to restart the office


software, recreate the onboard machine
files and send them to the appropriate
machines before this setting takes
effect.

Select DXF File to source the TOPE backdrop


Background
from a DXF file.

The background image is sourced from a DXF


file from previous versions of the office soft-
ware. DXF images are always sourced from the
Dxf File Name
directory {MSTAR_CONFIG}/explorer/dxf

All files loaded into Site Monitor or Site Editor


are automatically copied into this directory.

Select the color that will be used to draw dxf


Color
polygons on TOPE.

Select this check box to have all hazards


Hazards Auto Convert Hazards to Zones
received converted to zones.

Release 4.4.x © Caterpillar 2001-2016 Page: 400 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

TOPE Con-
Refer to your TOPE Configuration Manual for information on these settings.
figuration

Specifiees the number of times the office software should try to send a message if the
Machine Type
machine operator has not replied in the time specified in the Time Before Resend field.
Configuration
Default = 5 seconds.

Outgoing Messages

Item Description

Specifies how long the office software should wait for a reply from a machine it

Tme Before Resend has sent a message to.

Default = 10000 ms (10 seconds).

Specifies the number of times the office software should try to send a mes-
sage if the machine operator has not replied in the time specified in the Time
Number of Retries
Before Resend field.

Default = 5 seconds.

Page: 401 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Pit Model Service

Tab Item Description

Ignore Zero Pos-


Specifies that position reports of 0,0,0 be ignored.
ition Reports

Specifies that position reports of 0,0 be ignored. This is almost the


Ignore XY Zero
same as Ignore Zero Position Reports except that the Z value is
Position Reports
not considered.
Position
Tracking Specifies the time, in milliseconds, since a machine last sent a pos-
ition report from a waypoint that the office software considers the
machine to be still at that waypoint.
Waypoint Still Cur-
rent Duration When the Machine Manager starts, it positions the machine at that
waypoint if this time has not been reached.

Default = 604800000 ms (1 week).

If selected, the office software ignores dipper records.


Ignore Dippers
Default = Not selected.

Assignment
If selected, the office software uses the material in the dipper
Use Dipper Mater-
record when determining assignments.
ial
Default = Not selected.

Publish Unknown
If selected, the office software publishes assignment events about
Truck In Load
load reports for unknown trucks.
Reports

Enter the distance between the loading tool and the truck at which
Ignore Load Report
spurious load reports are ignored and not processed.
Distance
Default = 100m.

Release 4.4.x © Caterpillar 2001-2016 Page: 402 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Specifies the tolerance, as a percentage, to be applied to the late


Next Waypoint
arrival of a truck at a waypoint.
Overdue Tolerance
Default = 50%.

Specifies the amount by which a truck should be considered over-


Arrival Time Overdue Cor-
due, as a percentage of the time late value.
Monitoring rection
Default = 40%.

Specifies the time, in milliseconds, that a truck may exceed its spe-
Maximum Overdue
cified overdue duration before it is classifed as "Stopped".
Duration
Default = 120000 ms (2 minutes).

Specifies the minimum position change for which a loader is con-


Loader
sidered to have moved.

Specifies the minimum position change for which a loadout unit is


Loadout Unit
considered to have moved.

Specifies the minimum position change for which a shovel is con-


Shovel
sidered to have moved.
Server Pos-
itions
Specifies the minimum position change for which a surface miner is
Surface Miner
considered to have moved.

Specifies the minimum position change for which a processor is


Processor
considered to have moved.

Specifies the minimum position change for which a fuel bay is con-
Fuel Bay
sidered to have moved.

Page: 403 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Specifies the minimum position change for which a loader waypoint


Loader
is considered to have moved.

Specifies the minimum position change for which a loadout unit


Loadout Unit
waypoint is considered to have moved.
Server Way-
Specifies the minimum position change for which a shovel way-
point Pos- Shovel
point is considered to have moved.
itions
Specifies the minimum position change for which a surface miner
Surface Miner
waypoint is considered to have moved.

Specifies the minimum position change for which a processor way-


Processor
point is considered to have moved.

Remembers the values of updated machine properties even after a


system crash or restart, but will reset the properties to their default
Persistence Property Lifetimes
values if they have exceeded their useful lifetime when the office
software is rebooted.

Release 4.4.x © Caterpillar 2001-2016 Page: 404 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Remote KPI Display

Tab Item Description

The time, in minutes, after changes to KPIs have occurred that the
KPI Forward
changes are sent to mobile terminals. Note that Mobile Terminal is
Refresh Interval
not for general customer use.

KPI Forward Retry The number of times to try to send data to remote terminals should
Remote KPI Count a failure occur.
Update Set-
tings The time, in milliseconds, to wait for a response from mobile ter-
KPI Forward time-
minals before trying to re-send. Note that Mobile Terminal is not for
out value
general customer use.

KPI Values per


The number of KPI values to include in a single field message.
field message

Site Awareness Monitor

Item Description

This is plotted as blue on the heat map.


Minimum Latency
Default = 0.

This is plotted as red on the heat map.


Maximum Latency
Default = 1.

The rate at which the map converges to a solution. Must be a num-

Learning Rate ber between 0 and 1.

Default = 0.1.

Page: 405 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Item Description

The rate at which the displayed value tracks changes. Must be a

Averaging Coefficient number between 0 and 1.

Default = 0.3.

The points located within the specified number of cells are updated

Radius to reflect the new information.

Default = 10.

Release 4.4.x © Caterpillar 2001-2016 Page: 406 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Platform

System

Tab Item Description

The name of your mine site. This can be any text string, but it
General Site name
should be relatively short and meaningful.

A code supplied by Caterpillar to identify the system dealer. If


you do not know this code, you can use the default (XXX). To
Customer Code
obtain a Dealer code for your site, contact your Fleet Imple-
mentation team.

A code supplied by Caterpillar to identify the system. If you


do not know this code, you can use the default (XXX). To
Dealer Code
obtain a customization code for your site, contact your Fleet
Implementation team.

Use the fields in the Localization group to specify site-spe-


cific information such as time zone, language and required
unit set for data display. You can override the settings in this
Localization
group at the client level. This means that users can configure
their clients to display data in their preferred formats and
units.

The unit set in which to display quantities throughout the


Unit Set
office software.

The language in which to display the office software user inter-


Language
face.

The country and associated regional preferences in which to


Country display the office software user interface. This can affect the
display format of time, date, currency and other quantities.

Page: 407 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

The time zone in which the office software system is oper-


ating. When setting a time zone which has daylight savings,
colored boxes display beside any time fields, e.g. on Delay
Assistant, Cycle Assistant, to indicate that the time is dis-

Time Zone playing in Daylight Savings Time.

The server components to include and exclude during startup,


and the order in which they should start.

Services
Note: If you are a Health-only site, ensure that you
Exclude GeoServer and GeoDatabase . Move them
from Include to Exclude if necessary.

Current Application The name or IP address of the Application server. This field is
Server
server filled by default.

The names of possible machines that may act as servers


(e.g. Application, Database, Standby). Entering names in this
Allowed Server Names
field prevents the office software from being started on non-
approved servers.

Field IP Office The IP address used by the field equipment to communicate


Address with the office.

Release 4.4.x © Caterpillar 2001-2016 Page: 408 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Port Number The TCP/IP port number used by the Bus.


Port Number The TCP/IP port number used by the MineStar Notification
service.

Enter the path to the configuration directory for the MineStar


FSB Config Directory
Front-Side Bus.

JMS Host Name Enter the TCP/IP host name used by the Front-Side bus.

The TCP/IP port number used by the RMI Service, which is


JMS Port Number
used to create and manage scheduled jobs.

Select the logging level within FsbServer to debug and trace.


The default level is info. To debug, change the level to
debug.

Log Level

Setting the log level to debug produces log of at


least 10 MB/hour.

Load Haul Dump Terrain Select this check box to have MineStar services propagate
Synchronise information to Terrain for mining block and bench changes.

Terrain RMI host name The TCP/IP host used by the Terrain RMI.

Terrain RMI Port Num- The TCP/IP port used by the Terrain RMI.
ber
Default = 14009.

Terrain GIS host name The TCP/IP host used by the Terrain GIS.

Terrain GIS Port Num- The TCP/IP port used by the Terrain GIS.
ber
Default = 7070.

Page: 409 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Select from the list which server the office software will use
as a Database server. In the Server column in the table, enter
the Production, Standby, and Test server names beside their
corresponding roles.

Database Active Database Role


NOTE: You should not use the characters * . " / \ [ ] : ;
| = , in your server names. A hyphen may be accept-
able depending on your platform.

Default = Production.

Select the database you are using, either Oracle or MS SQL


Database
Server.

Instances

l Primary The database instance names for your system.

l Secondary

Enter a prefix for all usernames and passwords. The prefix


you enter applies to all usernames and passwords specified
Instance Templates
in the fields in the row below. For example, if you enter the pre-
Name Prefix
fix ms, and the username is model, then the real name will be
msmodel.

Release 4.4.x © Caterpillar 2001-2016 Page: 410 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Instance Templates

l Operational
Model
l Operational His-
torical
l Operational Sum- Specifies the usernames and passwords for each of the data-

mary base instances.

l Reporting
l Repository
l Schema Tem-
plate
l GIS Data

Setting the read only username and password gives the user
Read Only User Name
read only access to tables and views in the Historical data-
Read Only Password
base.

Select this check box if an Aquila database is configured for


Aquila Instance Used
your site.

Aquila The datastore definition of the Aquila database.

Select this check box if a CAES database is configured for


CAES Instance Used
your site.

CAES The datastore definition of the CAES database.

Advanced Settings Some office software features, including some database

l Oracle Instance scripts, etc., require authentication. These features read this

Authentication field in order to function correctly.

Page: 411 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Some office software features, such as snapshotOS and


snapshotDB, can use alternative data sources to persist
data. A data source must be named to be active.

l Name – The name of the data source


l Connection – The connection definition for the data
Alternative Data source
Sources l Username – The username for the data source con-
nection
l Password – The password for the data source con-
nection
l Database Type – The database type used by the data
source

Jetty Jetty Home The home location for Jetty.

GIS Settings for GeoServer and PostGIS.

Note: If you are a Health-only site you must ensure


that the Synchronize with GeoServer check box is not
selected.

Reporting Reporting Server The server on which BusinessObjects resides.

Web Reporting The URL to the Report cache.

Reporting Locale:
The language and country to use when generating descrip-
Language tions for reporting. You can set this independently of the
server locale.
Country

BO Version The version of BusinessObjects installed.

Release 4.4.x © Caterpillar 2001-2016 Page: 412 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Default Report Service The default report service being used.

BO Installation Dir- The directory where Business Objects is installed, typically


ectory D:\BusinessObjects.

The name of the BIAR export file and the locations where you
BIAR Export File want it to be saved. It should be saved to a location off the
server.

The administrator user name and password for the Busi-


nessObjects CMS. Verify these by logging onto the Central
BO User Name Management Console, and entering the suspected user name

BO Password and password (Start > Program Files > Business Objects [ver-
sion]> Central Management Console on the Reporting
Server.

The name of the CMS. Typically the host name of the Busi-
CMS
nessObjects server. Verify by logging on to the CMS.

The queries that the exportBIAR engine will carry out. Typ-
ically would be reports, categories, users, universe(s) and
any dashboards exported to the repository. Queries are sep-
arated by semicolons, e.g

. select * from ci_Infoobjects where si_kind in ('FullCli-


Queries
ent','Webi','Folder','Category',’Xcelcius’); select * from ci_
Systemobjects where si_kind in ('user','UserGroup'); select *
from ci_Appobjects

Refer to the SAP official documentation for more advanced


queries.

Page: 413 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Select this check box to export "objects" with their asso-


ciated dependencies, e.g. a Webi report is considered an
"object", any scheduled instances of that report is considered
Export Dependencies
a dependency. Always export a BIAR file with dependencies,
especially if deploying on another system where critical
dependencies may be unknown.

MineStar can send If selected, allows the office software to send email internally
Email email internally at the at the site. Such emails are limited to the same domain as the
site default sender.

MineStar can send


If selected, allows the office software to send email externally
email externally from
from the site.
the site

The type of email server. The office software currently only


Email Server Type
supports SMTP.

Email Server Name The name of the local email server.

Email Port The port on which email is received.

Address of Default The default sender address for emails sent from the office
Sender software.

The default recipient address for emails sent from the office
Address of Default
software. You are able to send emails to more than one
Recipient for e-mails
address by separating the addresses with commas.

The user name for Default Email Sender. Not used for non-
Email-User
authenticated servers.

The password for Email User. Not used for non-authenticated


Email-Password
servers.

Release 4.4.x © Caterpillar 2001-2016 Page: 414 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Configuration options on this tab are used for development


Advanced
Classes purposes only.
The path to development class files.

Select the most appropriate Heap space size for the mine
site.

THIS SETTING SHOULD ONLY BE CHANGED


BY FLEET IMPLEMENTATION AND
DEPLOYMENT STAFF

Heap Size Templates


l Small - Only suitable for demonstration/test systems,
not for production.
l Medium - requires a machine with a minimum of 16GB
memory, and may be a suitable initial configuration for
a small to medium mine site.
l Large - requires a machine with a minimum of 24G
memory, and may be a suitable initial configuration for
a medium to large mine site.

Select any or all of the following check boxes to enable the


testing options:

l Why restart gadget. Selected by default.


l Enable warn on RPC in AWT thread.
l Enable SQL performance monitoring (requires EB Dia-

Testing gnostic Driver to be enabled).

Select any or all of the following check boxes to enable the


Oracle tracing options:

l Model.
l Historical.
l Summary.

Page: 415 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Enterprise Extensions

Tab Item Description

Days to Retain The period, in days, to retain hourly snapshots.

Hourly Snapshots Default = 7.

Days to Retain Daily The period, in days, to retain daily snapshots.

Snapshots Default = 31.


System Mon-
itoring
Days to Retain The period, in days, to retain weekly snapshots.

Weekly Snapshots Default = 366.

Days to Retain User The period, in days, to retain user snapshots.

Snapshots Default = 366.

The frequency at which you wish to create a snapshot of the


Snapshot Frequency
live system.
Failover
Standby System The frequency at which you wish to update the standby sys-
Update Frequency tem configuration with a copy from the liive system.

Enables database export scripts which integrate with tape


backup systems.

Integrate Data
Enterprise
Exports with Tape
Backup NOTE: This functionality is limited. Refer to "Con-
Backups
figuring tape backups" on page 195 for more inform-
ation.

Release 4.4.x © Caterpillar 2001-2016 Page: 416 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

This feature should not be used without con-


tacting Fleet Customer Support.

Auditing Topics
Specifies the topics for which auditing is enabled.

This is a troubleshooting feature and should be disabled under


normal operating conditions.

Environment

The configuration options in this option set relate to low-level office software functions, and should only be
changed by Fleet Consultants, or on advice from Fleet Customer Support. You need to be in Expert Mode to
view this option.

Page: 417 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

If selected, the office software collects information on


the rate of events passing through pubsub. This is only
used if the system is not performing as expected and

Allow Polling of Statistics in more advanced diagnostic information is required.

Administration

NOTE: Using this feature significantly


increases memory usage.

Enable Java Performance If selected, the office software collects information on


Agent Java memory usage and garbage collection.

If selected, the office software records SQL statements


as trace messages.
Server Record SQL Statements
Frameworks Executed as Trace Messages
NOTE: Using this feature can impact system
performance and disk space usage.

Select this check box to use bind variables for date vari-
ables when building SQL statements. If not selected, lit-
Use bind variables for dates
eral values will be used for dates. This can impact
performance with different versions of Oracle.

The maximum period, in seconds, between diagnostic


Seconds Between Dia-
messages.
gnostics Messages
Default = 60.

Maximum Events in the The maximum number of events in the incoming queue.

Incoming Queue Default = 10000.

Release 4.4.x © Caterpillar 2001-2016 Page: 418 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Maximum Events in the The maximum number of events in the queue for fil-

Queue for Filtering, per Con- tering, per consumer.

sumer Default = 10000.

Maximum Events in the The maximum number of events in the queue for deliv-

Queue for Delivery to the ery to the subscription, per consumer.

Subscription, per Consumer Default = 10000.

Events

The configuration options in this option set relate to low-level office software functions, and should only be
changed by Fleet Consultants, or on advice from Fleet Customer Support. You need to be in Expert Mode to
view this option.

Page: 419 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

The maximum allowable arrival lag, in seconds, for event


node processing.

A warning is logged if an EventNode processes an event

Max Arrival Lag Secs where:

Current Time - Event Arrival Time > Max


Arrival Lag

Default = 15.

The maximum allowable creation lag, in seconds, for


event node processing.

A warning is logged if an EventNode processes an event


Performance
Max Create Lag Secs where:
Warnings
Current Time - Event Time Stamp > Max
Create Lag

Default = 30.

The maximum allowable publication lag, in seconds, for


event node processing.

A warning is logged if an EventNode processes an event

Max Publish Lag Secs where:

Current Time - Event Publish Time > Max


Publish Lag

Default = 3.

System - Fault Monitoring

The configuration options in this section should only be modified by experienced Fleet personnel.

Release 4.4.x © Caterpillar 2001-2016 Page: 420 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Recipients Enter the receipients of the fault email.

Alarm Subject Enter the office software component that has the fault.

Email Fault Message Enter a description of the fault.

Reset Subject Enter the name of the component to be reset.

Fault Reset Message Enter a message describing shich fault has been reset.

Jobs

Logging

The configuration options in this section should only be modified by experienced Fleet personnel.

Page: 421 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

If selected, file logging is enabled and uses the defined


Enable File Logging formats and specifications. Otherwise, no files are
logged

Log File Specification Specifies the format for log files.

This option should be left selected. If you are using Win-


dows Services, Wrapper Logging should also be enabled
Enable Console Logging
so that the Console Logging messages display in the
Wrapper Log File.
General
Enable Wrapper Logging It is recommended that you leave this option selected.

If selected, file tracing is enabled and uses the defined


Enable Tracing
formats and specifications.

If you are using Windows Services, this option should be


Enable Tracing to the Con-
turned off, otherwise trace messages will increase the
sole
size of the Windows Services log files.

Select this check box if you want to put a timestamp on


Timestamp Trace Messages
trace files.

Specifies the format for various error, warning and other


Message
messages. Where no format is specified, the Log Mes-
Formats
sage Format is used.

Packages
Specifies the format for packages to trace.
to Trace

Release 4.4.x © Caterpillar 2001-2016 Page: 422 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Report Cache

Tab Item Description

The format the report is to be saved in.


Save Type
Default = pdf.

Zip Output Select to have the report output zipped.

Select to have the time added to the report file name.


Add Time Stamp
Default = selected.

Output The format of the timestamp.


Timestamp Format
Default = MMM dd HH mm ss yyyy.

Select to have the timestamp as a suffix or a prefix.


Timestamp Position
Default = Suffix.

Enter the default printer. If this field is left blank, the


Default Printer for Reports printer set by the operating system default on the com-
puter running the software will be used.

Enter the SMTP host in the first line, the sender of the
Recipients email in the second line, and all other recipients the mail
is being sent to in remaining lines.
Email
Enter the subject.
Normal Pro- Subject
cessing; Default = Report server name and the report title.

Enter the body of the email.


Body
Default = Attached.

Page: 423 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Enter the SMTP host in the first line, the sender of the
Recipients email in the second line, and all other recipients the mail
is being sent to in remaining lines.

Enter the subject.

Subject Default = WARNING: Report server name and the report


Email
title.
Alternative
Processing: Enter the body of the email.
Body
Default = Empty result processing report.

Specifies the string which will trigger the alternative pro-


Report Variable Triggering
cesing email to be sent.
Alternative Processing
Default = _NoRows.

Specifies the name of the central management system


Central Management System
server. Leave this field blank if it is the same as the
Server
reporting server.

User Specifies the Business Objects user name.

Business Password Specifies the Business Objects password.


Objects
Specifies the authentication method.
Authentication
Default = Enterprise.

Specfies the folder for the reports.


Folder
Default = Document.

Release 4.4.x © Caterpillar 2001-2016 Page: 424 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Workgroup Extensions

Tab Item Description

The time, in minutes, past the hour that the office soft-
Scheduled Minutes To
ware runs sendAllToSupport. Depending on the con-
Run Each Hour
figuration, this can be via FTP or e-mail.

Site can send to If selected, the office software uses FTP to transfer
MineStar’s FTP server files to Fleet Customer Support.

Support The name of the server that will be used to transfer files
Uploads FTP Enabled Computer between the customer site and Fleet Customer Sup-
port.

FTP Site URL of the FTP site.

FTP User The user name to use when logging in to the FTP site.

FTP Password The password associated with FTP User.

Scheduled Time To Run


The time the backup should run each day.
Each Day

Specifies the number of days files will exist before they


Days Until Mark for Dele-
are marked for deletion.
Backup tion
Default = 5.

Specifies the number of days files will exist before they

Days Until Delete are deleted.

Default = 10.

Page: 425 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Scheduled Time To Run The time that a system snapshot should be taken each
Each Day day.

The time, in minutes, past the hour that the office soft-
Scheduled Minutes to
ware takes an Operating System Snapshot.
Run Each Hour
Default = 5.

The number of hours to look back to retrieve relevant

Snapshots files for inclusion in User Snapshots.


User Snapshot Lookback
Hours Default = 12.

0 = Include all files.

The number of hours to look back to retrieve relevant


files for inclusion in Automatic Snapshots.
Automatic Snapshot
Lookback Hours Default = 30.

0 = Include all files.

Scheduled Time To Run


File Archiving The time that file archiving occurs each day.
Each Day

The number of days generated files will exist before


Days before marking gen-
being marked for deletion.
erated files
Default = 5.

The number of days generated files will exist before


Days before deleting gen-
they are deleted.
erated files
Default = 7.

Days to retain message The number of days message files will be retained.

files Default = 7.

Release 4.4.x © Caterpillar 2001-2016 Page: 426 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

The number of days zipped message files will be


Days to retain zipped
retained.
message files
Default = 14.

The number of days before any Comms Server files are


Days before deleting any-
deleted.
thing
Default = 15.

The number of days trace files will exist before being


Days before marking
marked for deletion.
trace files
Default = 2.

The number of days trace files will exist before being


Days before deleting
deleted.
trace files
Default = 2.

The number of days on-board files will exist before


Days before marking
being marked for deletion.
onboard files
Default = 90.

The number of days on-board files will exist before


Days before deleting
being deleted.
onboard files
Default = 90.

The minimum number of files to be retained for each


type of .mwf file during cleanExpiredFiles in the
Mimimum number of files
Onboard/Minestar folder.
to be retained
Default = 2. That is, the most recent file and the newest
file.

Page: 427 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Scheduled Time To Run


The time that data archiving occurs each day.
Each Day

The number of days to retain short, medium, and long


term data. Default values are as follows:

Short term = 7.

Medium term = 62.


Retention Periods Long term = 366.

Data Archiving NOTE: It is recommended that you keep the


ShiftChange Retention Period as Medium.

Retention Policy Whether the data set should be archived or deleted.

Whether the period to retain the data set is short term,


Retention period
medium term, or long term as defined earlier..

Specifies the maximum number of entities to delete at

Maximum Number of once. A large number is faster, but it may exceed the

Entities to Delete at Once databases’s rollback segment.

Default = 50000.

Release 4.4.x © Caterpillar 2001-2016 Page: 428 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Enable RMAN on this


Select to enable the RMAN functionality.
System

RMAN Base Directory Enter the Base Directory for RMAN.

Enter the directory for the RMAN archive logs. The


RMAN Archive Log
default directory is set to <Drive>:\m-
Destination
starData\admin\MINESTAR\archive.

Select this check box to have RMAN scheduled as part


RMAN job
of Windows Task Scheduler.

RMAN Full DB Backup


Enter the time you wish the full backup to occur.
Schedule Time

Select whether you wish to do the full backup weekly or


RMAN Con- RMAN Full DB Backup
fortnightly.
figuration Schedule Frequency
Default = 2 weeks.

RMAN Incremental DB Enter the time you wish the incremental backup to
Backup Schedule Time occur.

RMAN Incremental DB Select how often you wish the incremental backup to

Backup Schedule Fre- occur.

quency Default = 2 days.

RMAN Archivable DB
Enter the time you wish the archive backup to occur.
Backup Schedule Time

RMAN Archivable DB
Select how often you wish the archive backup to occur.
Backup Schedule Fre-
Default = 2 hours.
quency

Page: 429 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Enter how often you wish to purge the recycle bin.


Purge Recycle Purge Recycle Bin Fre-
Default = 1 mont.
Bin Con- quency (in Months)

figuration
Purge Recycle Bin TIME Enter the time of day to purge the recycle bin.

Release 4.4.x © Caterpillar 2001-2016 Page: 430 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Platform - Clients

NOTE: If you change the "Look and Feel" setting on any of the Platform options you may experience
slight differences in the GUI than if you were looking at the Custom or Platform setting.

Explorer

Tab Item Description

If selected, the office software allows space for the


Task Bar Visible On
Windows Task Bar when displaying pages, dialog
Screen
boxes, etc.

The location of the Windows Task Bar on the


screen. the office software arranges its pages and
Task Bar Orientation
dialog boxes according to the location and size of
the Windows Task Bar.

The size, in pixels, of the Windows Task Bar on

Taskbar the screen. the office software arranges its pages

Task Bar Size In Pixels and dialog boxes according to the location and size
of the Windows Task Bar.

Default = 26.

If selected, the office software allows for a Win-


Stretched Across Screens dows Task Bar that stretches across two mon-
itors.

The screen (monitor) where the Windows Task


Screen Location
Bar is displayed.

Page: 431 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

If selected, enables the Custom Look And Feel


Use Custom Look And
list. You can use this to override the server-side
Feel
settings for clients.

The look and feel to apply to the office software


user interface.
Custom Look And Feel
Only available if Use Custom Look And Feel is
selected.

Appearance
If selected, the Fast Open/Close buttons are dis-
Display fast open/close
played on the splitter for the Navigator in the office
buttons on the navigator
software user interface.

Color of Validation Error The color of validation error messages.

Messages Default = Red.

The color of validation hints.


Color of Validation Hints
Default = Blue.

The duration, in seconds, that a tooltip will show on

Tooltip Duration the screen.

Default = 30.
Behavior
Specifies whether opening a page should always
Open Page Policy create a new instance, or open an existing
instance if possible.

Release 4.4.x © Caterpillar 2001-2016 Page: 432 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Explorer - Client

Tab Item Description

Specifies the Unit Set, Language and Country preferences


Localization
to use for the office software.

Play Sound for If selected, the office software attempts to play a sound
General
Urgent Alarm when urgent alarms are raised.

Expert Mode Pass-


The expert mode password for the office software.
word

The look and feel to apply to the office software user inter-
Look And Feel
face.

The definitions of the menus and labels to use in the office


software User Interface.

Use Short Labels in Tree Menus – If selected, the office


Catalog Navigation
software uses abbreviated names in the menu system,
rather than the complete, longer names.
Appearance Default = Cleared.

Specifies the initial width and height of the office software


Initial Sizing
user interface.

Specifies the size of the icons to use on tabs and panels in


Icons
the office software user interface.

Specifies the various font attributes used to display text in


Fonts
the office software user interface.

Page: 433 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Specifies the various panels to display in the office soft-


Panels
ware user interface.

Specifies the tab location and format when the Page Bar
Page Bar
is displayed.
Appearance con-
Specifies various advanced options for the office software
tinued
user interface.

Advanced Show Splash Window.

Show Menu Bar.

Remove all window decorations.

Release 4.4.x © Caterpillar 2001-2016 Page: 434 / 559


December 2016 Cat Fleet Administration & Configuration Manual
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

Ask Desktop on If selected, enables the user to specify a desktop to load


Login when starting the office software.

The desktop to use by default. This is used if no desktop


Default Desktop
has been selected from the Login dialog box.

The page to open when no specific desktop has been spe-


cified.

Home Page
Desktop Man- NOTE: If you want to use a Welcome Page Con-

agement figuration (see below), enter "Welcome" in this


field.

If selected, the office software saves the last desktop


Save Last Desktop
used when the user logs out.
On Exit
Default = Selected.

Show Save If selected, a dialog box displays when the user logs out of
Desktop Dialog On the office software, asking to save the current desktop
Exit configuration.

Page: 435 / 559 Cat Fleet Administration & Configuration Manual


© Caterpillar 2001-2016
December 2016 Release 4.4.x
Cat Fleet Admin & Config Manual
Supervisor page reference

Tab Item Description

The default configuration for the Welcome page. This


determines which pages open when you log into the office
software.

Welcome Page
Configuration
NOTE: This requires that the Home Page field be