OBJECTIF LUNE PlanetPress Connect 2022.2 User manual

  • Hello! I've reviewed the PlanetPress Connect User Guide and am ready to assist you. This document explains how to use PlanetPress Connect, which is a software tool designed to automate and optimize communication processes. It covers areas such as data mapping, template design for print, email and web, and process automation through Workflow. I can answer questions about settings, features, and many other things discussed in this guide.
  • What is PlanetPress Connect designed for?
    What types of output can PlanetPress Connect create?
    What is the Workflow server in PlanetPress Connect?
    Does PlanetPress Connect support mobile devices?
UserGuide
Version2022.2.3
LastRevision:2/16/2023
UplandObjectifLuneInc.
240946eAvenue
Lachine
QCH8T3C9
Canada
www.objectiflune.com
Alltrademarksdisplayedarethepropertyoftheirrespectiveowners.
©UplandObjectifLuneInc.1994-2023.Allrightsreserved.Nopartofthisdocumentationmayberepro-
duced,transmittedordistributedoutsideofUplandOLbyanymeanswhatsoeverwithouttheexpress
writtenpermissionofUplandOL.UplandOLdisclaimsresponsibilityforanyerrorsandomissionsin
thisdocumentationandacceptsnoresponsibilityfordamagesarisingfromsuchinconsistenciesor
theirfurtherconsequencesofanykind.UplandOLreservestherighttoaltertheinformationcontained
inthisdocumentationwithoutnotice.
Table of Contents
Welcome to PlanetPress Connect 2022.2 13
Setup And Configuration 13
SystemandHardwareConsiderations 13
AntivirusExclusions 14
DatabaseConsiderations 16
Environmentconsiderations 19
LanguageandEncodingConsiderations 21
NetworkConsiderations 21
Performanceconsiderations 23
Systemrequirements 25
InstallationandActivation 27
Wheretoobtaintheinstallers 28
Installationprerequisites 29
Useraccountsandsecurity 29
InstallingPlanetPressConnectonMachineswithoutInternetAccess 30
InstallationWizard 32
RunningConnectinstallerinSilentMode 43
ActivatingaLicense 50
Migratingtoanewworkstation 53
InformationaboutPlanetPressWorkflow 59
Upgrading 60
ServerConfigurationSettings 82
Connectionpreferences 84
Engineconfiguration 87
Languagepreferences 95
ParallelProcessingpreferences 95
KnownIssues 102
Uninstalling 112
General information 113
Connect:apeekunderthehood 114
TheWorkflowserver 114
TheConnectserver 115
TheConnectdatabase 116
TheFileStore 116
Theengines 117
TheRESTAPI 117
Logfiles 118
Location 118
Name 119
Format 119
Page 4
Connectfiletypes 119
OL Connect projects 120
AutomationwithWorkflow 121
UsingtheRESTAPI 121
Versioning 122
Versionedprojects 123
Creatingversionedprojects 124
Viewingprojecthistory 126
Viewingprojectcontent 127
Usingtags 128
Versionedprojectsinthecloud 129
Beforeyoustart 129
Creatingacloud-basedversionedproject 130
Keepingthelocalandonlineprojectsinsync 132
SampleProjects 134
SampleProject:BasicEmail 135
SampleProject:COTGTimesheets 141
SampleProject:PrintPromotionalJobs 148
SampleProject:PrintTransactionalJobs 153
SampleProject:SubmittingDatawithWebForms 159
SampleProject:ServingaWebPage 164
WorkflowprocessesinOLConnectprojects 168
AboutWorkflowprocesses 168
CommonOLConnectWorkflowprocesses 169
OLConnecttasks 169
EmailprocesseswithOLConnecttasks 171
PrintprocesseswithOLConnecttasks 172
WebprocesseswithOLConnecttasks 174
CaptureOnTheGoWorkflowprocesses 176
Batchingandcommingling 177
OL Connect automation with Node-RED 181
Installation 182
OLConnectnodes 182
ConnectionsettingsforOLConnectServer 183
OLConnectresourcesinNode-RED 183
FlowsinanOLConnectapplication 184
Node-RED:nodesandcommontechniques 184
NodesusedinOLConnectflows 185
ReadingaJSONfile 186
ParsingaJSONstring 186
Usingvariables 187
Page 5
Settingandmovingmsgproperties 188
Iteratingoveritemsinanarray 188
Concatenatingstrings 188
OLConnectStartupflow 189
Triggeringastartupflow 189
Initializingglobalvariables 189
DeployingOLConnectresources 190
AnOLConnectemailflowinNode-RED 190
ThestructureofanOLConnectemailflow 190
FilesusedinanOLConnectemailflow 191
AnOLConnectprintflowinNode-RED 191
Thestructureofaprintflow 192
Filesusedinaprintflow 193
AnOLConnectpreviewPDFflowinNode-RED 194
ThestructureofapreviewPDFflow 194
FilesusedinapreviewPDFflow 195
AnOLConnectwebflowinNode-RED 195
ThestructureofanOLConnectwebflow 195
FilesusedinanOLConnectwebflow 196
CaptureOnTheGoflowsinNode-RED 197
MakingaformavailabletoCOTGappusers 197
Servingtheform 198
Processingreceiveddata 198
The DataMapper 198
DataMapperbasics 199
Datamappingconfigurations 199
Creatinganewdatamappingconfiguration 200
Openingadatamappingconfiguration 204
Savingadatamappingconfiguration 204
Down-savingadatamappingconfiguration 204
UsingthewizardforCSVandExcelfiles 205
Usingthewizardfordatabases 207
UsingthewizardforJSONfiles 210
UsingthewizardforPDF/VTorAFPfiles 211
UsingthewizardforXMLfiles 213
AdvancedPCLtoPDFoptions 214
Datamappingworkflow 221
Creatingadatamappingworkflow 222
Testingtheextractionworkflow 223
Datasourcesettings 223
Propertiesandruntimeparameters 227
Extractingdata 229
Steps 248
TheDataModel 260
Page 6
Aboutrecords 261
CreatingaDataModel 261
EditingtheDataModel 262
UsingtheDataModelintemplates 263
Fields 264
Detailtables 269
Datatypes 275
DataModelfilestructure 284
DataMapperUserInterface 285
Keyboardshortcuts 286
Menus 290
Panes 293
Toolbar 357
WelcomeScreen 359
DataMapperScriptsAPI 360
UsingscriptsintheDataMapper 362
SettingboundariesusingJavaScript 364
Objects 369
Functions 404
The Designer 412
Designerbasics 413
Features 414
Templates 414
Contexts 431
Sections 432
Print 436
CreatingaPrinttemplatewithaWizard 437
Printcontext 443
Printsections 447
Pages 455
MasterPages 462
Media 465
Email 471
Emailtemplate 471
Sendingemail 471
DesigninganEmailtemplate 472
CreatinganEmailtemplatewithaWizard 475
Emailcontext 478
Emailtemplates 480
Emailheadersettings 483
Emailattachments 489
Web 492
CreatingaWebtemplatewithaWizard 493
WebContext 496
Page 7
Webpages 498
Forms 502
UsingFormelements 507
UsingJavaScript 512
CaptureOnTheGo 516
COTGForms 516
CreatingaCOTGForm 516
FillingaCOTGtemplate 517
SendingthetemplatetotheWorkflowtool 519
ReceivingandextractingdatafromaCOTGForm 519
UsingCOTGdatainatemplate 519
DesigningaCOTGTemplate 522
CaptureOnTheGotemplatewizards 525
UsingFoundation 528
COTGElements 531
UsingCOTGElements 536
TestingaCaptureOnTheGoTemplate 541
UsingtheCOTGplugin 545
DynamicallyaddingCOTGwidgets 548
Savingandrestoringcustomdataandwidgets 551
UsingsubmittedCOTGdatainatemplate 554
CaptureOnTheGoAPI 557
Contentelements 566
Elementtypes 566
EditingHTML 568
Attributes 568
Insertinganelement 569
Selectinganelement 570
Deletinganelement 571
Stylingandformattinganelement 571
Barcode 572
Boxes 623
Businessgraphics 626
COTGElements 633
Date 639
Forms 640
FormElements 644
Hyperlinkandmailtolink 647
Images 649
Table 655
Textandspecialcharacters 659
Snippets 661
AddingasnippettotheResources 661
Creatingasnippet 662
Addingasnippettoasection 663
Editingasnippet 663
Page 8
Renamingasnippet 663
Translatingasnippet 663
HTMLsnippets 663
JSONsnippets 665
Handlebarstemplates 665
Partials 669
Stylingandformatting 671
Localformattingversusstylesheets 671
Layoutproperties 672
StylingtemplateswithCSSfiles 672
Stylingtextandparagraphs 682
Howtopositionelements 686
Rotatingelements 688
Stylingatable 689
Stylinganimage 693
Backgroundcolorand/orimage 695
Border 697
Colors 699
Fonts 703
Locale 706
Spacing 707
Personalizingcontent 708
Variabledatainthetext 708
Conditionalcontent 709
DynamicimagesandPrintsectionbackgrounds 709
Dynamictables 709
Snippets 709
Scripts 710
Loadingdata 710
Variabledataintext:expressions 722
Variabledataintext:scriptsandplaceholders 726
Formattingvariabledata 732
Showingcontentconditionally 734
ConditionalPrintsections 738
Dynamicimages 741
DynamicTable 742
DynamicPrintsectionbackgrounds 759
PersonalizedURL 761
HandlebarsinOLConnect 763
Handlebarsexpressions 763
Usingfunctionsinexpressions:Helpers 766
FormatHelpers 769
CreatingcustomHelpers 771
Handlebarstemplates 774
Partials 777
HandlebarsAPI 780
Page 9
Preferences 782
Generalpreferences 783
Clean-upServicepreferences 783
DataMapperpreferences 786
DatabaseConnectionpreferences 787
Editingpreferences 790
Emailpreferences 793
Emmetpreferences 794
Enginespreferences 797
HardwareforDigitalSigningpreferences 797
Languagepreferences 798
Loggingpreferences 799
ParallelProcessingpreferences 801
Printpreferences 801
SampleProjectspreferences 802
Savepreferences 802
Scriptingpreferences 803
Serverspreferences 804
Versioningpreferences 806
Webpreferences 807
Writingyourownscripts 808
Scripttypes 808
CreatinganewStandardScript 810
Writingascript 812
Settingthescopeofascript 813
Managingscripts 814
Testingscripts 816
Optimizingscripts 820
Thescriptflow:whenscriptsrun 824
SelectorsinOLConnect 825
Loadingasnippetviaascript 831
Loadingcontentusingaserver'sAPI 833
UsingscriptsinDynamicTables 835
ControlScripts 838
PostPaginationScripts 850
Translatingtemplates 856
Translatingatemplate 857
Taggingelementsfortranslation 857
Pluralization 860
Exportingandimportingtranslationfiles 861
DesignerUserInterface 863
Dialogs 864
Keyboardshortcuts 953
Menus 958
Panes 969
Toolbars 990
Page 10
WelcomeScreen 996
Printoptions 997
JobCreationPresetsWizard 1069
OutputCreationPresetsWizard 1084
AdvancedPrintWizardnavigationoptions 1102
DesignerScriptAPI 1168
StandardScriptAPI 1169
ControlScriptAPI 1271
PostPaginationScriptAPI 1297
Generating output 1314
Printoutput 1315
Faxoutput 1315
Emailoutput 1315
Weboutput 1316
GeneratingPrintoutput 1316
GeneratingPrintoutputfromtheDesigner 1317
GeneratingPrintoutputfromWorkflow 1318
Printsettingsinatemplate 1319
Abortingcontentcreation 1319
Printusingstandardprintoutputsettings 1320
PrintPresets 1321
PrintusingAdvancedPrinterWizard 1327
AddingprintoutputModelstothePrintWizard 1327
Splittingprintingintomorethanonefile 1329
Printoutputvariables 1330
GeneratingFaxoutput 1337
GeneratingTagsforImageoutput 1338
GeneratingEmailoutput 1340
BeforegeneratingEmailoutput 1340
GeneratingEmailoutputfromConnectDesigner 1342
GeneratingEmailoutputfromWorkflow 1343
TestingEmailoutputfordifferentemailclients 1343
Abortingcontentcreation 1343
UsinganESPwithPlanetPressConnect 1343
GeneratingWeboutput 1348
WeboutputsettingsintheWebcontextandsections 1349
AttachingWeboutputtoanEmailtemplate 1349
GeneratingWeboutputfromWorkflow 1350
Abortingcontentcreation 1350
Optimizingatemplate 1351
Scripts 1351
Images 1351
Runtimeparameters 1352
Page 11
PlanetPress Connect Release Notes 1353
OLPlanetPressConnectReleaseNotes2022.2.3 1353
LicenseUpdateRequiredforUpgradetoOLConnect2022.x 1354
BackupbeforeUpgrading 1354
Overview 1355
OLConnect2022.2.3Fixes 1356
OLConnect2022.2.1Fixes 1356
OLConnect2022.2Improvements 1357
OLConnect2022.2DesignerImprovements 1360
OLConnect2022.2DataMapperImprovements 1363
OLConnect2022.2OutputImprovements 1364
Workflow2022.2Improvements 1365
KnownIssues 1367
PreviousReleases 1367
OLPlanetPressConnectReleaseNotes2022.1.5 1367
OLPlanetPressConnectReleaseNotes2021.2.1 1384
OLPlanetPressConnectReleaseNotes2021.1 1398
OLPlanetPressConnectReleaseNotes2020.2.1 1406
OLPlanetPressConnectReleaseNotes2020.1 1417
OLPlanetPressConnectReleaseNotes2019.2 1428
OLPlanetPressConnectReleaseNotes2019.1 1440
PlanetPressConnectReleaseNotes2018.2.1 1452
PlanetPressConnectReleaseNotes2018.1.6 1470
PlanetPressConnectReleaseNotes1.8 1486
PlanetPressConnectReleaseNotes1.7.1 1502
PlanetPressConnectReleaseNotes1.6.1 1522
PlanetPressConnectReleaseNotes1.5 1533
PlanetPressConnectReleaseNotes1.4.2 1543
Knowledge Base 1551
Legal Notices and Acknowledgements 1551
CopyrightInformation 1560
Page 12
Welcome to PlanetPress Connect 2022.2
PlanetPressConnectisaseriesoftoolsdesignedtooptimizeandautomatecustomercommunications
management.Theyworktogethertoimprovethecreation,distribution,interactionandmaintenanceof
yourcommunications.
ThePlanetPressConnectDatamapperandDesigneraredesignedtocreateoutputforprint,email
andthewebwithinasingletemplateandfromanydatatype,includingformattedprintstreams.Output
presetsappliedoutsidethedesignphasemaketemplatesprintingdeviceindependent.
TheDesignerhasaneasy-to-useinterfacethatmakesitpossibleforalmostanyonetocreatemulti-
channeloutput.MoreadvancedusersmayusenativeHTML,CSSandJavaScript.
PlanetPressConnectalsoincludesaprocessautomationserver,calledWorkflow.Itiscapableofser-
vicingresponseformwebpagesandemailtoprovideinteractivebusinesscommunications.Forthe
userguideofWorkflow,seeWorkflow'sOnlineHelp.
PlanetPressConnectcancreatedocumentsfortabletsandmobiledevicesthatrunafreeCapture
OnTheGoApp.UserswithaCaptureOnTheGosubscriptioncanthendownloaddocumentstotheir
owndevices,interactwiththemandsendthecaptureddatabacktoPlanetPressforconversioninto
additionaldocumentsorworkflows.
Formoreinformationabouttheapplicationrefertothesewebsites:CaptureOnTheGoandCapture
OnTheGointheResourceCenter.
ThisonlinedocumentationcoversPlanetPress Connectversion2022.2.
Note: Sincewearealwayslookingfornewwaystomakeyourlifeeasier,wewelcomeyourques-
tionsandcommentsaboutourproductsanddocumentation.Shootusanemailatdoc@ca.ob-
jectiflune.com.
Setup And Configuration
ThischapterdescribesthePlanetPressConnectinstallationandthedifferentconsiderationsthatare
importantinregardstotheinstallationanduseofPlanetPressConnect.
l"SystemandHardwareConsiderations"below
l"InstallationandActivation"onpage27
l"KnownIssues"onpage102
l"ServerConfigurationSettings"onpage82
l"Uninstalling"onpage112
System and Hardware Considerations
Thereareavarietyofconsiderationstobeawareof.Thesearedocumentedinthefollowingpages:
Page 13
l"Systemrequirements"onpage25
l"DatabaseConsiderations"onpage16
l"Environmentconsiderations"onpage19
l"KnownIssues"onpage102
l"LanguageandEncodingConsiderations"onpage21
l"AntivirusExclusions"below
l"Performanceconsiderations"onpage23
Antivirus Exclusions
TheinformationonthispageisdesignedtoassistITmanagersandITprofessionalsdecidewhatanti-
virusstrategytofollowwithconsiderationtoPlanetPressandtheirinternalrequirementsandneeds.
ThispagedescribesthemodeofoperationandthefilesandfoldersusedbyPlanetPressaswellasthe
files,foldersandexecutablesthatarerecommendedtobeignoredforbestpossibleperformanceand
toavoidissuescausedbyantivirusfilelocks.
ITmanagersandITprofessionalsthenmaydecidetheanti-virusstrategytofollowfortheirinternal
requirementsandneedsdependingonthestatementsoutlinedherein.
Directoriesandfolders
AllConnectapplicationsareinstalledunderanarbitrarilyselectablemainfolder.Ifthedefaultinstall-
ationfolderoptionswereused,thisinstallationfolderwouldbe%PROGRAMFILES%\Objectif Lun-
e\OL Connect.
Theinstallationfolderwillholdalltheexecutablefilesandotherfilesandfoldersrequiredfortheoper-
ationofthewholeproductsuite.Allthesefilesandfoldersremainstaticafterinstallation.Itdepends
uponthecompanyvirusprotectionstrategy,ifsuchfilesandfolderswillbemonitoredornot.
Wedo,however,recommendthatthefollowingfileorfoldersbeexcludedfromantivirusprotection.
Connect Service
TheConnectServiceisrunviatheexecutablefileServerService.exe.Thisfilehasbeenreportedas
causingissueswithsomeantiviruspackages,sowerecommendaddingthisfiletotheantivirusexclu-
sionlist,ifpossible.
Theexecutablewillbeinstalledtotheinstallationtarget"Connect Server"sub-folder.Thefullinstall-
ationfoldercanbefoundbyentering%PROGRAMFILES%\Objectif Lune\OL Connect\Connect
ServerinWindowsExplorer.
Page 14
AFPInput
PerformanceissueshavebeenreportedwiththeAFP InputoptionunderWindowsServerversions
fromWindowsServer2012onwards.TheissueshavebeenspecificallyassociatedwithWindowsServ-
ersrunningWindowsDefender,buttheperformancedegradationmightalsobeencounteredwhen
usingotherAntivirusapplications.
Consequently,werecommendthatanexclusionbemadefortheafp2pdf.exeexecutablefileinyour
Antivirusapplication.
Theafp2pdf.exefileisstoredinasubfolderundertheinstallationfolder.Iftheexactinstallationfolder
nameisrequired,enterthestandardizedsystemvariable%PROGRAMFILES%inWindowsExplorerand
thensearchforafp2pdf.exe.
Working folders
WorkingfoldersforConnectarecreatedandusedonaper-user-basisundertherespectiveuser'spro-
filefolder,accessibleonWindowswiththestandardizedsystemvariable%USERPROFILE%inthesub-
folder"Connect".Workingfoldersare:
l%USERPROFILE%\Connect\filestore:Thisfolderwillholdnon-intermediatefilesforthe
operationofConnect.Filesinthisfolderwillbeusedfrequently,butnotwithahighfrequency.
Supervisingthisfolderwithavirusprotectionsystemshouldnothavetoomuchofanimpacton
thespeedofthewholeConnectsuite.
l%USERPROFILE%\Connect\logs:Asthenameimplies,logfilesarecreatedandupdatedhere.
Theselogfilesareplaintextfiles.Virusprotectionmayhaveanimpactonthespeedofthewhole
Connectsuite.
l%USERPROFILE%\Connect\temp:Storagefolderfortemporarydata,usuallyintermittentfiles
inmultiplefolders.Virusprotectiononthisfolderanditssubfoldersmayhaveaseriousimpacton
theperformanceofConnect.
l%USERPROFILE%\Connect\workspace:Usuallycontainingsettingsandhelperfilesand
folders.Supervisingthisfolderwithavirusprotectionsystemshouldnothavetoomuchofan
impactonthespeedofthewholeConnectsuite.
Database 1
Dependingonthecomponentsinstalled,adatabaseinstanceiscreatedinafoldercalled"con-
nect.database"undertheWindowssystemtempfolder.Thisfolderisaccessibleviathestandardized
systemvariable%TMP%.Usually,foldersholdingsuchtemporaryfilesandfoldersshouldbeexcluded
fromavirusprotection,becausethisinfluencestheoverallperformanceofthewholesystematall.
Page 15
Howevertheresponsiblepersonforthecomputerprotectionhastodecideaboutthemonitoringofsuch
temporaryfoldersfollowingthecompanyguidelines.
Database 2
AnotherdatabaseinstanceforConnectwillbeholdandusedunderthefolder,whichisintendedtohold
data,accessiblebyandforallusers.Thepathtothisfolderisstoredinthestandardizedsystemvari-
able%PROGRAMDATA%.TheConnectdatabaseinstanceislocatedinthesubfolder"Objectif Lune\OL
Connect\MariaDB".
Asthisdatabasewillbeinextremelystrongusage,virusprotectiononthisfolderanditssub-folders
mayhaveaseriousimpactontheperformanceofConnect.
Database Considerations
Thispagedescribesthedifferentconsiderationsandpre-requisitesforthedatabaseback-endusedby
PlanetPressConnect,whetherusingtheMariaDBinstanceprovidedbytheinstaller,orpre-existing
(external)instance.
UsingtheMariaDBInstancefromtheInstaller
TheMariaDBInstanceprovidedinthe"InstallationWizard"onpage32isalreadypre-configuredwith
optionstoprovidethemoststableback-endsetup.
InstallingConnectusinganexistingMySQLinstance
IfMySQLServerisalreadypresentandyouwishtouseit,thefollowingshouldbetakenintocon-
sideration:
lTheminimumsupportedMySQLversionisMySQL5.6.
lTheMySQLaccountmusthaveaccesstoallpermissionsusingtheGRANTCommand,including
creatingdatabases.
lThedatabaseconfigurationmustincludethefollowingoptions:
lmax_connections = 200:PlanetPressConnectusesa lotofdatabaseconnections.This
numberensuresthateveninhighvolumeenvironments,enoughconnectionswillbeavail-
able.
lmax_allowed_packet = 500M:Insomeimplementations,especiallywhenusingCapture
OnTheGo,largepacketsizesarerequiredtoallowtransferringbinaryfiles.Thissubstantial
packetsizemaximumsettingensuresthatthedatareceivedbyPlanetPressConnectwill
beabletobestoredwithinthedatabase.
Page 16
lcharacter-set-server = utf8 , collation-server = utf8_unicode_ci , default-character-
set=utf8:TheseindicatedatabasesupportforUTF-8/Unicode.
lThedatabaseconfigurationmustallowtheuseofmixedcasetablenames.
ThisisparticularlyanissueonLinuxMySQLinstallations.
lTheSQLinstancemustbeopentoaccessfromothercomputers.Thismeansthebind-address
optionshouldnotbesetto127.0.0.1orlocalhost.
Caution: IfyouchosenottoinstallthesuppliedMariaDBdatabase,andinsteadoptforusinga
pre-existing(External)databasethenyouyourselfmustensurethattheExternaldatabaseis
accessibletoConnect.
UplandObjectifLunewilltakenoresponsibilityforsettingupdatabaseconnectionstoanybutthe
suppliedMariaDBdatabase.
See"DatabaseConsiderations"onthepreviouspageformoreinformationaboutsettingup
externaldatabases.
Options available within the installer:
lTheConfigurationpageforthelocalMySQLisdisplayed.
lMySQLsettingsarepre-filledwithdefaultvaluesifnoexistingMySQLdatabaseconfigurationis
found.
lMySQLsettingsarepre-filledwithexistingdatabaseconfigurationsettings,iftheypointtoa
MySQLdatabasetype.
InstallingConnectusinganexistingMicrosoftSQLServerinstance
IfMicrosoftSQLServerisalreadypresentandyouwishtouseit,thefollowingshouldbetakenintocon-
sideration:
Caution: IfyouchosenottoinstallthesuppliedMariaDBdatabase,andinsteadoptforusinga
pre-existing(External)databasethenyouyourselfmustensurethattheExternaldatabaseis
accessibletoConnect.
UplandObjectifLunewilltakenoresponsibilityforsettingupdatabaseconnectionstoanybutthe
suppliedMariaDBdatabase.
See"DatabaseConsiderations"onthepreviouspageformoreinformationaboutsettingup
externaldatabases.
Page 17
Note: SincePlanetPressConnectversion1.6theminimumrequiredversionoftheMSSQL
ServerisSQL Server 2012.
lWhenMSSQLisselected,thedefaultvaluesforrootuseraresaand1433fortheport.
lIfdatabasesettingsfromapreviousOLConnectinstallationarefound,thepre-exisingsettings
willbedisplayedforthematchingdatabasetype.ForMSSQLsettings,thiswillonlyworkifthey
werecreatedwithServerConfigTool1.5.0orlater,ortheInstallerforOLConnect1.6.0orlater.
IfthedatabasetypeischangedintheInstallerconfigurationpage,thedefaultvaluesforthisdata-
basetypewillbedisplayed.
Ifthepre-existingdatabasesettingsaresettoHsqldb,thedefaultdatabasetypeselectionwillbe
MySQL.
lSelecteddatabasesettingsarestoredinthepreferences,andcanbefoundinthisfile:
C:\ProgramData\Objectif Lune\OL Con-
nect\.settings\ConnectHostScope\com.objectiflune.repository.eclipselink.generic.prefs
WhenmodifyingConnect
lIfthelocalMariaDBisremovedfromaninstallation,theDatabaseConfigurationpagewilloffer
additionallytheMicrosoft SQL Serverdatabasetypewithrespectivedefaultvalues.
lIflocalMariaDBisaddedtoaninstallation,theusualMariaDBConfigurationpagewithdefault
valueswillbedisplayed.
IftheuserhasinstalledtheInstallerSuppliedMySQL(2021.2orearlier)orMariaDB(2022.1andlater)
andthenswitchestoanexternalMicrosoftSQLbyusingtheServerConfigurationTool,thesupplied
localdatabasecannotbeswitchedoff.BydesigntheinstalleraddsaservicedependencybetweenCon-
nectServerandthesuppliedMariaDB\MySQLservice.
To remove this dependency the user needs to do the following
1. HaveaforeignMicrosoftSQLrunning,readyforusewithConnectServer.
2. UsetheServer Configuration Tool"DatabaseConnectionpreferences"onpage787toswitch
thedatabasetoMicrosoftSQL.
3. Re-starttheConnectServerService,sothatthemodificationsbecomeactive.
4. CountercheckthateverythingisworkingproperlywithMicrosoftSQL.
5. Openacommand-linepromptwithfulladministrationrights.
6. Enterthecommandsc config OLConnect_Server depend= /.Thisremovesthedepend-
ency.
Page 18
Please be aware:Thekeyworddependmustbefollowedimmediatelybytheequalsign,but
betweentheequalsignandtheforwardslashtheremustbeaspace.
Additional information can be found here:http://serverfault.com/questions/24821.
7. Afterthedependencyhasbeenremoved,itispossibletostopthesuppliedMariaDB\MySQLser-
vice(OLConnect_MySQL).
Environment considerations
TerminalServer/ServiceSupport
PlanetPressConnectdoesnotsupportTerminalServer(orTerminalService)environmentaspossible
underWindows2000,2003and2008.Thisistosay,ifTerminalServiceisinstalledontheserverwhere
PlanetPressConnectislocated,unexpectedbehavioursmayoccurandwillnotbesupportedby
UplandObjectifLune.Furthermore,usingPlanetPressConnectinaTerminalServiceenvironmentis
aninfringementofourEnd-UserLicenseAgreement.
VirtualMachineSupport
PlanetPressConnectsupportsthefollowingvirtualenvironments:
lVMWareEnvironments.ThisincludesVMWarePlayer,VMWareWorkstationaswellasVMWare
ESXServer.
lVMWareVMotion.ThismeansthevirtualmachinehostingPlanetPressConnectcanbeauto-
maticallymovedfromoneESXservertoanotherinaclusteredinstallation.
NotethatifallserversinaVMotionclusterarenotstrictlyidentical,youwillhavetoprovidethe
ObjectifLuneActivationsteamwithallpossiblemagicnumberssotheycangeneratealicense
thatworksonallservers.Obtainingthemagicnumbersissimplyaquestionofmanuallymoving
theVMonwhichConnectisinstalledtoeachserver,andrecordingthemagicnumberforeachof
them.
lMicrosoftHyper-V/Azureinfrastructureenvironments.
PlanetPressConnectisnotofficiallysupportedonanyothervirtualmachinessuchasVirtualPC,Par-
allels,Bochs,Xen,etc.
Caution: Copying(duplicating)aVirtualMachinewithConnectinstalledandusingbothimages
simultaneouslyconstitutesaninfringementofourEnd-UserLicenseAgreement.
Note: Whilesomevirtualmachineenvironments(fromVMWareandMicrosoft)aresupported,
othervirtualenvironments(suchasParallels,Xenandothers)arenotsupportedatthistime.
Page 19
RemoteDesktopSupport
TestshavedemonstratedthatPlanetPressConnectcanbeusedthroughRemoteDesktop.Itishow-
everpossiblethatcertaincombinationofOScouldcauseissues.Ifproblemsareencountered,please
contactOLSupportandwewillinvestigate.
PlanetPressConnect1.3andlaterhavebeencertifiedunderRemoteDesktop.
32-bitor64-bitOperatingSystems?
PlanetPressConnectisa64-bitsoftwareandcanonlybeinstalledon64-bitoperatingsystems.
AntivirusConsiderations
lAntivirussoftwaremayslowdownprocessingorcauseissuesiftheyarescanningintemporary
foldersorthoseusedbyPlanetPressConnect.Pleasesee"AntivirusExclusions"onpage14for
moreinformation.
lAntivirussoftwaremightinterferewithinstallationscripts,notablyaVBSscripttoinstallfonts.
McAfee,inparticular,shouldbedisabledtemporarilyduringinstallationinorderforMICRfontsto
installandtheinstallationtocompletesuccessfully.
WindowsSearchIndexingService
TestshaveconcludedthattheWindowsSearchservice,usedtoprovideindexingforWindowsSearch,
caninterferewithConnectwheninstallingonavirtualmachine.Iftheinstallationhangsduringthelast
steps,itisnecessarytocompletelydisablethisserviceduringinstallation.
lClickonStart,Run.
lTypeinservices.mscandclickOK.
lLocatetheWindows Searchserviceanddouble-clickonit.
lChangetheStartup TypetoDisable,andclickStoptostoptheservice.
lTrytheinstallationagain.
lOncecomplete,youmayre-enabletheserviceandstartit.
Commandlineswitchesand.inientries
PlanetPressConnectisintendedtoworkstablyandreliably,basedonJavaandtheEclipseframework.
Toensurethisreliabilityandrobustness,manyJavaandEclipseparametershavebeentestedand
tuned,whichisreflectedintherespective.inientriesandtheusedcommandlineswitches.Acollection
ofvaluablesettingshasbeenelaboratedandfounditsentryinPlanetPressConnect“goodswitches
list”(calledthe“whitelist”).
Theprotectionoftheenduser’ssystemisoneofourmaingoalsandthereforewehaveimplementeda
verystrictverificationmechanism,whichensures,thatonlythesewhitelistedinientriesandcommand-
Page 20
/