OBJECTIF LUNE PlanetPress Connect 2023.1 User manual



UserGuide

Version2023.1.0

LastRevision:5/15/2023

UplandObjectifLuneInc.

240946eAvenue

Lachine

QCH8T3C9

Canada

www.objectiflune.com



Alltrademarksdisplayedarethepropertyoftheirrespectiveowners.

©UplandObjectifLuneInc.1994-2023.Allrightsreserved.Nopartofthisdocumentationmayberepro-

duced,transmittedordistributedoutsideofUplandOLbyanymeanswhatsoeverwithouttheexpress

writtenpermissionofUplandOL.UplandOLdisclaimsresponsibilityforanyerrorsandomissionsin

thisdocumentationandacceptsnoresponsibilityfordamagesarisingfromsuchinconsistenciesor

theirfurtherconsequencesofanykind.UplandOLreservestherighttoaltertheinformationcontained

inthisdocumentationwithoutnotice.

Table of Contents

Welcome to PlanetPress Connect 2023.1 13

Setup And Configuration 13

Systemandhardwareconsiderations 13

AntivirusExclusions 14

DatabaseConsiderations 16

Environmentconsiderations 19

LanguageandEncodingConsiderations 21

NetworkConsiderations 21

Performanceconsiderations 23

Systemrequirements 25

InstallationandActivation 27

Wheretoobtaintheinstallers 28

Installationprerequisites 29

Useraccountsandsecurity 29

InstallingPlanetPressConnectonMachineswithoutInternetAccess 30

InstallationWizard 32

RunningConnectinstallerinSilentMode 43

ActivatingaLicense 50

Migratingtoanewworkstation 53

InformationaboutPlanetPressWorkflow 59

Upgrading 60

Serverconfigurationsettings 82

Connectionpreferences 84

Engineconfiguration 87

Languagepreferences 95

ParallelProcessingpreferences 95

KnownIssues 102

Uninstalling 112

General information 113

Connect:apeekunderthehood 114

TheWorkflowserver 114

TheConnectserver 115

TheConnectdatabase 116

TheFileStore 116

Theengines 117

TheRESTAPI 117

Logfiles 118

Location 118

Name 119

Format 119

Page 4

Connectfiletypes 119

OL Connect projects 120

AutomationwithWorkflow 121

UsingtheRESTAPI 121

Versioning 122

Versionedprojects 123

Creatingversionedprojects 124

Viewingprojecthistory 126

Viewingprojectcontent 127

Usingtags 128

Versionedprojectsinthecloud 129

Beforeyoustart 129

Creatingacloud-basedversionedproject 130

Keepingthelocalandonlineprojectsinsync 132

SampleProjects 134

SampleProject:BasicEmail 135

SampleProject:COTGTimesheets 141

SampleProject:PrintPromotionalJobs 148

SampleProject:PrintTransactionalJobs 154

SampleProject:SubmittingDatawithWebForms 160

SampleProject:ServingaWebPage 165

WorkflowprocessesinOLConnectprojects 169

AboutWorkflowprocesses 169

CommonOLConnectWorkflowprocesses 170

OLConnecttasks 170

EmailprocesseswithOLConnecttasks 172

PrintprocesseswithOLConnecttasks 173

WebprocesseswithOLConnecttasks 175

CaptureOnTheGoWorkflowprocesses 177

Batchingandcommingling 178

OL Connect automation with Node-RED 182

Installation 183

OLConnectnodes 183

ConnectionsettingsforOLConnectServer 184

OLConnectresourcesinNode-RED 184

FlowsinanOLConnectapplication 185

Node-RED:nodesandcommontechniques 185

NodesusedinOLConnectflows 186

ReadingaJSONfile 187

ParsingaJSONstring 187

Usingvariables 188

Page 5

Settingandmovingmsgproperties 189

Iteratingoveritemsinanarray 189

Concatenatingstrings 189

OLConnectStartupflow 190

Triggeringastartupflow 190

Initializingglobalvariables 190

DeployingOLConnectresources 191

AnOLConnectemailflowinNode-RED 191

ThestructureofanOLConnectemailflow 191

FilesusedinanOLConnectemailflow 192

AnOLConnectprintflowinNode-RED 192

Thestructureofaprintflow 193

Filesusedinaprintflow 194

AnOLConnectpreviewPDFflowinNode-RED 195

ThestructureofapreviewPDFflow 195

FilesusedinapreviewPDFflow 196

AnOLConnectwebflowinNode-RED 196

ThestructureofanOLConnectwebflow 196

FilesusedinanOLConnectwebflow 197

CaptureOnTheGoflowsinNode-RED 198

MakingaformavailabletoCOTGappusers 198

Servingtheform 199

Processingreceiveddata 199

The DataMapper 199

DataMapperbasics 200

Datamappingconfigurations 200

Creatinganewdatamappingconfiguration 201

Openingadatamappingconfiguration 205

Savingadatamappingconfiguration 205

Down-savingadatamappingconfiguration 205

UsingthewizardforCSVandExcelfiles 206

Usingthewizardfordatabases 207

UsingthewizardforJSONfiles 210

UsingthewizardforPDF/VTorAFPfiles 211

UsingthewizardforXMLfiles 213

ProvidingmissingfontsforPDF 214

AdvancedPCLtoPDFoptions 216

Datamappingworkflow 223

Creatingadatamappingworkflow 224

Testingtheextractionworkflow 225

Datasourcesettings 225

Propertiesandruntimeparameters 229

Extractingdata 231

Steps 250

Page 6

TheDataModel 262

Aboutrecords 263

CreatingaDataModel 263

EditingtheDataModel 264

UsingtheDataModelintemplates 265

Fields 266

Detailtables 271

Datatypes 278

DataModelfilestructure 287

DataMapperUserInterface 288

Keyboardshortcuts 289

Menus 293

Panes 296

Toolbar 361

WelcomeScreen 362

DataMapperScriptsAPI 364

UsingscriptsintheDataMapper 366

SettingboundariesusingJavaScript 368

Objects 373

Functions 408

The Designer 416

Designerbasics 417

Features 418

Templates 418

Contexts 435

Sections 436

Print 440

CreatingaPrinttemplatewithaWizard 442

Printcontext 447

Printsections 451

Pages 461

MasterPages 468

Media 471

Email 477

Emailtemplate 477

Sendingemail 478

DesigninganEmailtemplate 478

CreatinganEmailtemplatewithaWizard 481

Emailcontext 484

Emailtemplates 486

Emailheadersettings 489

Emailattachments 495

Web 498

CreatingaWebtemplatewithaWizard 499

Page 7

WebContext 502

Webpages 504

Forms 508

UsingFormelements 513

UsingJavaScript 518

CaptureOnTheGo 522

COTGForms 522

CreatingaCOTGForm 522

FillingaCOTGtemplate 523

SendingthetemplatetotheWorkflowtool 525

ReceivingandextractingdatafromaCOTGForm 525

UsingCOTGdatainatemplate 525

DesigningaCOTGTemplate 528

CaptureOnTheGotemplatewizards 531

UsingFoundation 534

COTGElements 537

UsingCOTGElements 542

TestingaCaptureOnTheGoTemplate 547

UsingtheCOTGplugin 551

DynamicallyaddingCOTGwidgets 554

Savingandrestoringcustomdataandwidgets 557

UsingsubmittedCOTGdatainatemplate 560

CaptureOnTheGoAPI 563

Contentelements 572

Elementtypes 572

EditingHTML 574

Attributes 574

Insertinganelement 575

Selectinganelement 576

Deletinganelement 577

Stylingandformattinganelement 577

Barcode 578

Boxes 630

Businessgraphics 633

COTGElements 641

Date 646

Forms 647

FormElements 652

Hyperlinkandmailtolink 655

Images 656

Table 664

Textandspecialcharacters 668

Snippets 669

AddingasnippettotheResources 670

Creatingasnippet 671

Addingasnippettoasection 671

Page 8

Editingasnippet 671

Renamingasnippet 671

Translatingasnippet 671

HTMLsnippets 672

JSONsnippets 673

Handlebarstemplates 674

Partials 679

Stylingandformatting 681

Localformattingversusstylesheets 681

Layoutproperties 681

StylingtemplateswithCSSfiles 682

Stylingtextandparagraphs 692

Howtopositionelements 695

Rotatingelements 698

Stylingatable 699

Stylinganimage 702

Backgroundcolorand/orimage 705

Border 706

Colors 709

Fonts 712

Locale 716

Spacing 717

Personalizingcontent 718

Variabledatainthetext 718

Conditionalcontent 718

DynamicimagesandPrintsectionbackgrounds 719

Dynamictables 719

Snippets 719

Scripts 719

Loadingdata 720

Variabledataintext:expressions 732

Variabledataintext:scriptsandplaceholders 736

Formattingvariabledata 742

Showingcontentconditionally 744

ConditionalPrintsections 748

Dynamicimages 750

DynamicTable 752

DynamicPrintsectionbackgrounds 770

PersonalizedURL 772

HandlebarsinOLConnect 774

Variabledataintext:expressions 775

Handlebarsexpressions 779

Usingfunctionsinexpressions:Helpers 782

FormatHelpers 786

CreatingcustomHelpers 788

Handlebarstemplates 791

Page 9

Partials 796

HandlebarsAPI 798

Preferences 801

Generalpreferences 801

Clean-upServicepreferences 801

DataMapperpreferences 805

DatabaseConnectionpreferences 806

Editingpreferences 808

Emailpreferences 812

Emmetpreferences 813

Enginespreferences 816

HardwareforDigitalSigningpreferences 816

Languagepreferences 817

Loggingpreferences 818

ParallelProcessingpreferences 820

Printpreferences 820

SampleProjectspreferences 821

Savepreferences 821

Scriptingpreferences 822

Serverspreferences 822

Versioningpreferences 825

Webpreferences 825

Writingyourownscripts 827

Scripttypes 827

CreatinganewStandardScript 829

Writingascript 830

Settingthescopeofascript 832

Managingscripts 833

Testingscripts 835

Optimizingscripts 839

Thescriptflow:whenscriptsrun 843

SelectorsinOLConnect 844

Loadingasnippetviaascript 849

Loadingcontentusingaserver'sAPI 851

UsingscriptsinDynamicTables 853

ControlScripts 856

PostPaginationScripts 869

Translatingtemplates 874

Translatingatemplate 875

Taggingelementsfortranslation 876

Pluralization 879

Exportingandimportingtranslationfiles 880

DesignerUserInterface 882

Dialogs 883

Keyboardshortcuts 971

Menus 976

Page 10

Panes 988

Toolbars 1009

WelcomeScreen 1015

Printoptions 1017

JobPreset 1089

OutputPresets 1103

AdvancedPrintWizardnavigationoptions 1121

DesignerScriptAPI 1188

StandardScriptAPI 1189

ControlScriptAPI 1291

PostPaginationScriptAPI 1317

Generating output 1334

Printoutput 1335

Faxoutput 1335

Emailoutput 1335

Weboutput 1336

GeneratingPrintoutput 1336

GeneratingPrintoutputfromtheDesigner 1337

GeneratingPrintoutputfromWorkflow 1338

Printsettingsinatemplate 1339

Abortingcontentcreation 1339

Printusingstandardprintoutputsettings 1340

PrintPresets 1341

PrintusingAdvancedPrinterWizard 1347

AddingprintoutputModelstothePrintWizard 1348

Splittingprintingintomorethanonefile 1349

Printoutputvariables 1351

GeneratingFaxoutput 1357

GeneratingTagsforImageoutput 1359

GeneratingEmailoutput 1360

BeforegeneratingEmailoutput 1361

GeneratingEmailoutputfromConnectDesigner 1362

GeneratingEmailoutputfromWorkflow 1363

TestingEmailoutputfordifferentemailclients 1363

Abortingcontentcreation 1364

UsinganESPwithPlanetPressConnect 1364

GeneratingWeboutput 1368

WeboutputsettingsintheWebcontextandsections 1369

AttachingWeboutputtoanEmailtemplate 1369

GeneratingWeboutputfromWorkflow 1370

Abortingcontentcreation 1370

Optimizingatemplate 1371

Scripts 1371

Images 1372

Page 11

Runtimeparameters 1373

PlanetPress Connect Release Notes 1373

OLPlanetPressConnectReleaseNotes2023.1 1374

LicenseUpdateRequiredforUpgradetoOLConnect2023.x 1374

BackupbeforeUpgrading 1374

Overview 1374

OLConnect2023.1Improvements 1376

OLConnect2023.1DesignerImprovements 1378

OLConnect2023.1DataMapperImprovements 1384

OLConnect2023.1OutputImprovements 1386

Workflow2023.1Improvements 1388

KnownIssues 1391

PreviousReleases 1391

OLPlanetPressConnectReleaseNotes2022.2.3 1391

OLPlanetPressConnectReleaseNotes2022.1.5 1404

OLPlanetPressConnectReleaseNotes2021.2.1 1421

OLPlanetPressConnectReleaseNotes2021.1 1430

OLPlanetPressConnectReleaseNotes2020.2.1 1438

OLPlanetPressConnectReleaseNotes2020.1 1449

OLPlanetPressConnectReleaseNotes2019.2 1460

OLPlanetPressConnectReleaseNotes2019.1 1472

PlanetPressConnectReleaseNotes2018.2.1 1484

PlanetPressConnectReleaseNotes2018.1.6 1502

PlanetPressConnectReleaseNotes1.8 1518

PlanetPressConnectReleaseNotes1.7.1 1534

PlanetPressConnectReleaseNotes1.6.1 1554

PlanetPressConnectReleaseNotes1.5 1565

PlanetPressConnectReleaseNotes1.4.2 1575

Knowledge Base 1583

Legal Notices and Acknowledgments 1583

CopyrightInformation 1592

Page 12

Welcome to PlanetPress Connect 2023.1

PlanetPressConnectisaseriesoftoolsdesignedtooptimizeandautomatecustomercommunications

management.Theyworktogethertoimprovethecreation,distribution,interactionandmaintenanceof

yourcommunications.

ThePlanetPressConnectDatamapperandDesigneraredesignedtocreateoutputforprint,email

andthewebwithinasingletemplateandfromanydatatype,includingformattedprintstreams.Output

presetsappliedoutsidethedesignphasemaketemplatesprintingdeviceindependent.

TheDesignerhasaneasy-to-useinterfacethatmakesitpossibleforalmostanyonetocreatemulti-

channeloutput.MoreadvancedusersmayusenativeHTML,CSSandJavaScript.

PlanetPressConnectalsoincludesaprocessautomationserver,calledWorkflow.Itiscapableofser-

vicingresponseformwebpagesandemailtoprovideinteractivebusinesscommunications.Forthe

userguideofWorkflow,seeWorkflow'sOnlineHelp.

PlanetPressConnectcancreatedocumentsfortabletsandmobiledevicesthatrunafreeCapture

OnTheGoApp.UserswithaCaptureOnTheGosubscriptioncanthendownloaddocumentstotheir

owndevices,interactwiththemandsendthecaptureddatabacktoPlanetPressforconversioninto

additionaldocumentsorworkflows.

Formoreinformationabouttheapplicationrefertothesewebsites:CaptureOnTheGoandCapture

OnTheGointheResourceCenter.

ThisonlinedocumentationcoversPlanetPress Connectversion2023.1.

Note: Sincewearealwayslookingfornewwaystomakeyourlifeeasier,wewelcomeyourques-

tionsandcommentsaboutourproductsanddocumentation.Shootusanemailatdoc@ca.ob-

jectiflune.com.

Setup And Configuration

ThischapterdescribesthePlanetPressConnectinstallationandthedifferentconsiderationsthatare

importantinregardstotheinstallationanduseofPlanetPressConnect.

l"Systemandhardwareconsiderations"below

l"InstallationandActivation"onpage27

l"KnownIssues"onpage102

l"Serverconfigurationsettings"onpage82

l"Uninstalling"onpage112

System and hardware considerations

Thereareavarietyofconsiderationstobeawareof.Thesearedocumentedinthefollowingpages:

Page 13

l"Systemrequirements"onpage25

l"DatabaseConsiderations"onpage16

l"Environmentconsiderations"onpage19

l"KnownIssues"onpage102

l"LanguageandEncodingConsiderations"onpage21

l"AntivirusExclusions"below

l"Performanceconsiderations"onpage23

Antivirus Exclusions

TheinformationonthispageisdesignedtoassistITmanagersandITprofessionalsdecidewhatanti-

virusstrategytofollowwithconsiderationtoPlanetPressandtheirinternalrequirementsandneeds.

ThispagedescribesthemodeofoperationandthefilesandfoldersusedbyPlanetPressaswellasthe

files,foldersandexecutablesthatarerecommendedtobeignoredforbestpossibleperformanceand

toavoidissuescausedbyantivirusfilelocks.

ITmanagersandITprofessionalsthenmaydecidetheanti-virusstrategytofollowfortheirinternal

requirementsandneedsdependingonthestatementsoutlinedherein.

Directoriesandfolders

AllConnectapplicationsareinstalledunderanarbitrarilyselectablemainfolder.Ifthedefaultinstall-

ationfolderoptionswereused,thisinstallationfolderwouldbe%PROGRAMFILES%\Objectif Lun-

e\OL Connect.

Theinstallationfolderwillholdalltheexecutablefilesandotherfilesandfoldersrequiredfortheoper-

ationofthewholeproductsuite.Allthesefilesandfoldersremainstaticafterinstallation.Itdepends

uponthecompanyvirusprotectionstrategy,ifsuchfilesandfolderswillbemonitoredornot.

Wedo,however,recommendthatthefollowingfileorfoldersbeexcludedfromantivirusprotection.

Connect Service

TheConnectServiceisrunviatheexecutablefileServerService.exe.Thisfilehasbeenreportedas

causingissueswithsomeantiviruspackages,sowerecommendaddingthisfiletotheantivirusexclu-

sionlist,ifpossible.

Theexecutablewillbeinstalledtotheinstallationtarget"Connect Server"sub-folder.Thefullinstall-

ationfoldercanbefoundbyentering%PROGRAMFILES%\Objectif Lune\OL Connect\Connect

ServerinWindowsExplorer.

Page 14

AFPInput

PerformanceissueshavebeenreportedwiththeAFP InputoptionunderWindowsServerversions

fromWindowsServer2012onwards.TheissueshavebeenspecificallyassociatedwithWindowsServ-

ersrunningWindowsDefender,buttheperformancedegradationmightalsobeencounteredwhen

usingotherAntivirusapplications.

Consequently,werecommendthatanexclusionbemadefortheafp2pdf.exeexecutablefileinyour

Antivirusapplication.

Theafp2pdf.exefileisstoredinasubfolderundertheinstallationfolder.Iftheexactinstallationfolder

nameisrequired,enterthestandardizedsystemvariable%PROGRAMFILES%inWindowsExplorerand

thensearchforafp2pdf.exe.

Working folders

WorkingfoldersforConnectarecreatedandusedonaper-user-basisundertherespectiveuser'spro-

filefolder,accessibleonWindowswiththestandardizedsystemvariable%USERPROFILE%inthesub-

folder"Connect".Workingfoldersare:

l%USERPROFILE%\Connect\filestore:Thisfolderwillholdnon-intermediatefilesforthe

operationofConnect.Filesinthisfolderwillbeusedfrequently,butnotwithahighfrequency.

Supervisingthisfolderwithavirusprotectionsystemshouldnothavetoomuchofanimpacton

thespeedofthewholeConnectsuite.

l%USERPROFILE%\Connect\logs:Asthenameimplies,logfilesarecreatedandupdatedhere.

Theselogfilesareplaintextfiles.Virusprotectionmayhaveanimpactonthespeedofthewhole

Connectsuite.

l%USERPROFILE%\Connect\temp:Storagefolderfortemporarydata,usuallyintermittentfiles

inmultiplefolders.Virusprotectiononthisfolderanditssubfoldersmayhaveaseriousimpacton

theperformanceofConnect.

l%USERPROFILE%\Connect\workspace:Usuallycontainingsettingsandhelperfilesand

folders.Supervisingthisfolderwithavirusprotectionsystemshouldnothavetoomuchofan

impactonthespeedofthewholeConnectsuite.

Database 1

Dependingonthecomponentsinstalled,adatabaseinstanceiscreatedinafoldercalled"con-

nect.database"undertheWindowssystemtempfolder.Thisfolderisaccessibleviathestandardized

systemvariable%TMP%.Usually,foldersholdingsuchtemporaryfilesandfoldersshouldbeexcluded

fromavirusprotection,becausethisinfluencestheoverallperformanceofthewholesystematall.

Page 15

Howevertheresponsiblepersonforthecomputerprotectionhastodecideaboutthemonitoringofsuch

temporaryfoldersfollowingthecompanyguidelines.

Database 2

AnotherdatabaseinstanceforConnectwillbeholdandusedunderthefolder,whichisintendedtohold

data,accessiblebyandforallusers.Thepathtothisfolderisstoredinthestandardizedsystemvari-

able%PROGRAMDATA%.TheConnectdatabaseinstanceislocatedinthesubfolder"Objectif Lune\OL

Connect\MariaDB".

Asthisdatabasewillbeinextremelystrongusage,virusprotectiononthisfolderanditssub-folders

mayhaveaseriousimpactontheperformanceofConnect.



Database Considerations

Thispagedescribesthedifferentconsiderationsandpre-requisitesforthedatabaseback-endusedby

PlanetPressConnect,whetherusingtheMariaDBinstanceprovidedbytheinstaller,orpre-existing

(external)instance.

UsingtheMariaDBInstancefromtheInstaller

TheMariaDBInstanceprovidedinthe"InstallationWizard"onpage32isalreadypre-configuredwith

optionstoprovidethemoststableback-endsetup.

InstallingConnectusinganexistingMySQLinstance

IfMySQLServerisalreadypresentandyouwishtouseit,thefollowingshouldbetakenintocon-

sideration:

lTheminimumsupportedMySQLversionisMySQL5.6.

lTheMySQLaccountmusthaveaccesstoallpermissionsusingtheGRANTCommand,including

creatingdatabases.

lThedatabaseconfigurationmustincludethefollowingoptions:

lmax_connections = 200:PlanetPressConnectusesa lotofdatabaseconnections.This

numberensuresthateveninhighvolumeenvironments,enoughconnectionswillbeavail-

able.

lmax_allowed_packet = 500M:Insomeimplementations,especiallywhenusingCapture

OnTheGo,largepacketsizesarerequiredtoallowtransferringbinaryfiles.Thissubstantial

packetsizemaximumsettingensuresthatthedatareceivedbyPlanetPressConnectwill

beabletobestoredwithinthedatabase.

Page 16

lcharacter-set-server = utf8 , collation-server = utf8_unicode_ci , default-character-

set=utf8:TheseindicatedatabasesupportforUTF-8/Unicode.

lThedatabaseconfigurationmustallowtheuseofmixedcasetablenames.

ThisisparticularlyanissueonLinuxMySQLinstallations.

lTheSQLinstancemustbeopentoaccessfromothercomputers.Thismeansthebind-address

optionshouldnotbesetto127.0.0.1orlocalhost.

Caution: IfyouchosenottoinstallthesuppliedMariaDBdatabase,andinsteadoptforusinga

pre-existing(External)databasethenyouyourselfmustensurethattheExternaldatabaseis

accessibletoConnect.

UplandObjectifLunewilltakenoresponsibilityforsettingupdatabaseconnectionstoanybutthe

suppliedMariaDBdatabase.

See"DatabaseConsiderations"onthepreviouspageformoreinformationaboutsettingup

externaldatabases.

Options available within the installer:

lTheConfigurationpageforthelocalMySQLisdisplayed.

lMySQLsettingsarepre-filledwithdefaultvaluesifnoexistingMySQLdatabaseconfigurationis

found.

lMySQLsettingsarepre-filledwithexistingdatabaseconfigurationsettings,iftheypointtoa

MySQLdatabasetype.

InstallingConnectusinganexistingMicrosoftSQLServerinstance

IfMicrosoftSQLServerisalreadypresentandyouwishtouseit,thefollowingshouldbetakenintocon-

sideration:

Caution: IfyouchosenottoinstallthesuppliedMariaDBdatabase,andinsteadoptforusinga

pre-existing(External)databasethenyouyourselfmustensurethattheExternaldatabaseis

accessibletoConnect.

UplandObjectifLunewilltakenoresponsibilityforsettingupdatabaseconnectionstoanybutthe

suppliedMariaDBdatabase.

See"DatabaseConsiderations"onthepreviouspageformoreinformationaboutsettingup

externaldatabases.

Page 17

Note: SincePlanetPressConnectversion1.6theminimumrequiredversionoftheMSSQL

ServerisSQL Server 2012.

lWhenMSSQLisselected,thedefaultvaluesforrootuseraresaand1433fortheport.

lIfdatabasesettingsfromapreviousOLConnectinstallationarefound,thepre-exisingsettings

willbedisplayedforthematchingdatabasetype.ForMSSQLsettings,thiswillonlyworkifthey

werecreatedwithServerConfigTool1.5.0orlater,ortheInstallerforOLConnect1.6.0orlater.

IfthedatabasetypeischangedintheInstallerconfigurationpage,thedefaultvaluesforthisdata-

basetypewillbedisplayed.

Ifthepre-existingdatabasesettingsaresettoHsqldb,thedefaultdatabasetypeselectionwillbe

MySQL.

lSelecteddatabasesettingsarestoredinthepreferences,andcanbefoundinthisfile:

C:\ProgramData\Objectif Lune\OL Con-

nect\.settings\ConnectHostScope\com.objectiflune.repository.eclipselink.generic.prefs

WhenmodifyingConnect

lIfthelocalMariaDBisremovedfromaninstallation,theDatabaseConfigurationpagewilloffer

additionallytheMicrosoft SQL Serverdatabasetypewithrespectivedefaultvalues.

lIflocalMariaDBisaddedtoaninstallation,theusualMariaDBConfigurationpagewithdefault

valueswillbedisplayed.

IftheuserhasinstalledtheInstallerSuppliedMySQL(2021.2orearlier)orMariaDB(2022.1andlater)

andthenswitchestoanexternalMicrosoftSQLbyusingtheServerConfigurationTool,thesupplied

localdatabasecannotbeswitchedoff.BydesigntheinstalleraddsaservicedependencybetweenCon-

nectServerandthesuppliedMariaDB\MySQLservice.

To remove this dependency the user needs to do the following

1. HaveaforeignMicrosoftSQLrunning,readyforusewithConnectServer.

2. UsetheServer Configuration Tool"DatabaseConnectionpreferences"onpage806toswitch

thedatabasetoMicrosoftSQL.

3. Re-starttheConnectServerService,sothatthemodificationsbecomeactive.

4. CountercheckthateverythingisworkingproperlywithMicrosoftSQL.

5. Openacommand-linepromptwithfulladministrationrights.

6. Enterthecommandsc config OLConnect_Server depend= /.Thisremovesthedepend-

ency.

Page 18

Please be aware:Thekeyworddependmustbefollowedimmediatelybytheequalsign,but

betweentheequalsignandtheforwardslashtheremustbeaspace.

Additional information can be found here:http://serverfault.com/questions/24821.

7. Afterthedependencyhasbeenremoved,itispossibletostopthesuppliedMariaDB\MySQLser-

vice(OLConnect_MySQL).

Environment considerations

TerminalServer/ServiceSupport

PlanetPressConnectdoesnotsupportTerminalServer(orTerminalService)environmentaspossible

underWindows2000,2003and2008.Thisistosay,ifTerminalServiceisinstalledontheserverwhere

PlanetPressConnectislocated,unexpectedbehavioursmayoccurandwillnotbesupportedby

UplandObjectifLune.Furthermore,usingPlanetPressConnectinaTerminalServiceenvironmentis

aninfringementofourEnd-UserLicenseAgreement.

VirtualMachineSupport

PlanetPressConnectsupportsthefollowingvirtualenvironments:

lVMWareEnvironments.ThisincludesVMWarePlayer,VMWareWorkstationaswellasVMWare

ESXServer.

lVMWareVMotion.ThismeansthevirtualmachinehostingPlanetPressConnectcanbeauto-

maticallymovedfromoneESXservertoanotherinaclusteredinstallation.

NotethatifallserversinaVMotionclusterarenotstrictlyidentical,youwillhavetoprovidethe

ObjectifLuneActivationsteamwithallpossiblemagicnumberssotheycangeneratealicense

thatworksonallservers.Obtainingthemagicnumbersissimplyaquestionofmanuallymoving

theVMonwhichConnectisinstalledtoeachserver,andrecordingthemagicnumberforeachof

them.

lMicrosoftHyper-V/Azureinfrastructureenvironments.

PlanetPressConnectisnotofficiallysupportedonanyothervirtualmachinessuchasVirtualPC,Par-

allels,Bochs,Xen,etc.

Caution: Copying(duplicating)aVirtualMachinewithConnectinstalledandusingbothimages

simultaneouslyconstitutesaninfringementofourEnd-UserLicenseAgreement.

Note: Whilesomevirtualmachineenvironments(fromVMWareandMicrosoft)aresupported,

othervirtualenvironments(suchasParallels,Xenandothers)arenotsupportedatthistime.

Page 19

RemoteDesktopSupport

TestshavedemonstratedthatPlanetPressConnectcanbeusedthroughRemoteDesktop.Itishow-

everpossiblethatcertaincombinationofOScouldcauseissues.Ifproblemsareencountered,please

contactOLSupportandwewillinvestigate.

PlanetPressConnect1.3andlaterhavebeencertifiedunderRemoteDesktop.

32-bitor64-bitOperatingSystems?

PlanetPressConnectisa64-bitsoftwareandcanonlybeinstalledon64-bitoperatingsystems.

AntivirusConsiderations

lAntivirussoftwaremayslowdownprocessingorcauseissuesiftheyarescanningintemporary

foldersorthoseusedbyPlanetPressConnect.Pleasesee"AntivirusExclusions"onpage14for

moreinformation.

lAntivirussoftwaremightinterferewithinstallationscripts,notablyaVBSscripttoinstallfonts.

McAfee,inparticular,shouldbedisabledtemporarilyduringinstallationinorderforMICRfontsto

installandtheinstallationtocompletesuccessfully.

WindowsSearchIndexingService

TestshaveconcludedthattheWindowsSearchservice,usedtoprovideindexingforWindowsSearch,

caninterferewithConnectwheninstallingonavirtualmachine.Iftheinstallationhangsduringthelast

steps,itisnecessarytocompletelydisablethisserviceduringinstallation.

lClickonStart,Run.

lTypeinservices.mscandclickOK.

lLocatetheWindows Searchserviceanddouble-clickonit.

lChangetheStartup TypetoDisable,andclickStoptostoptheservice.

lTrytheinstallationagain.

lOncecomplete,youmayre-enabletheserviceandstartit.

Commandlineswitchesand.inientries

PlanetPressConnectisintendedtoworkstablyandreliably,basedonJavaandtheEclipseframework.

Toensurethisreliabilityandrobustness,manyJavaandEclipseparametershavebeentestedand

tuned,whichisreflectedintherespective.inientriesandtheusedcommandlineswitches.Acollection

ofvaluablesettingshasbeenelaboratedandfounditsentryinPlanetPressConnect“goodswitches

list”(calledthe“whitelist”).

Theprotectionoftheenduser’ssystemisoneofourmaingoalsandthereforewehaveimplementeda

verystrictverificationmechanism,whichensures,thatonlythesewhitelistedinientriesandcommand-

Page 20

OBJECTIF LUNE PlanetPress Connect 2023.1 User manual

Related papers

Other documents