HTML5cn163

MapleNetServicesGuideCopyrightMaplesoft,adivisionofWaterlooMapleInc.
2019MapleNetServicesGuideCopyrightMaplesoft,MapleNet,andMaplearealltrademarksofWaterlooMapleInc.
Maplesoft,adivisionofWaterlooMapleInc.
2019.
Allrightsreserved.
Nopartofthisbookmaybereproduced,storedinaretrievalsystem,ortranscribed,inanyformorbyanymeans—electronic,mechanical,photocopying,recording,orotherwise.
Informationinthisdocumentissubjecttochangewithoutnoticeanddoesnotrepresentacommitmentonthepartofthevendor.
Thesoftwaredescribedinthisdocumentisfurnishedunderalicenseagreementandmaybeusedorcopiedonlyinaccordancewiththeagreement.
Itisagainstthelawtocopythesoftwareonanymediumexceptasspecificallyallowedintheagreement.
Oracle,JavaandallJava-basedmarksaretrademarksorregisteredtrademarksofOracleand/oritsaffiliates.
DockerisaregisteredtrademarkofDocker,Inc.
Allothertrademarksarethepropertyoftheirrespectiveowners.
ThisdocumentwasproducedusingMapleandDocBook.
ContentsOverviewv1MapleNetServices11.
1AboutMapleNetServices11.
2Documents1DownloadingMapleDocuments2UploadingMapleDocuments21.
3Compute21.
4AdditionalFeatures3HealthCheck3Help3Monitoring4Index5iiiivContentsOverviewAboutMapleNetUseMapleNettoshareyourMapledocuments,calculators,andtechnicalapplications.
Mapleprovidesthemostintuitiveinterfaceavailableforcreatingwebapplicationsthatrelyonmathematicalcomputa-tions.
Yousimplydragbuttons,sliders,mathinputregions,andotherinteractivecomponentsintoyourMapledocumenttocreatetheinterface,andaddthefunctionalitybehindthosecomponentsusingMaple'shigh-level,mathematicallysophisticatedprogramminglanguage.
Oncecompleted,yousimplysavetheMapledocumentontheMapleNetservertomakeyourapplicationavailableonlineMapleNetResourcesDescriptionResourceSystemrequirementsandinstallationinstructionsforMapleNet.
TheMapleNetInstallationGuideisavailableintheInstall.
htmlfilelocatedeitheronyourMapleNetinstallationDVDorthefolderwhereyouinstalledMapleNet.
MapleNetServerInstallationGuideInstructionsforusingenvironmentvariablestoconfiguretheMapleNetserver.
Securityissuesarealsodiscussed.
MapleNetAdministratorGuideOutlineofMapleNetservices.
InformationonlimitationsofservicesprovidedaswellasasummaryofMapleNetAPIendpoints.
MapleNetServicesGuideAdetaileddescriptionoftheMapleNetAPIwithexamples.
MapleNetAPIProgrammingGuideForadditionalresources,visithttp://www.
maplesoft.
com/site_resources.
GettingHelpTorequestcustomersupportortechnicalsupport,visithttp://www.
maplesoft.
com/support.
CustomerFeedbackMaplesoftwelcomesyourfeedback.
ForcommentsrelatedtotheMapleNetproductdocumentation,contactdoc@maplesoft.
com.
vviOverview1MapleNetServices1.
1AboutMapleNetServicesMapleNetprovidestwoprimaryservicesforclients,HTML5versionsofMapledocumentsandaMaplecomputein-terface.
InadditionMapleNetprovidesinterfacesforhostingMaplehelpdatabasesonline,monitoringMapleNetstatusandhealthchecking.
1.
2DocumentsMapleNethostsMapleworksheets(.
mwfiles)andworkbooks(.
maplefiles)andallowsthemtobeviewedinawebbrowser.
Inaddition,embeddedcomponentsinthosedocumentareinteractive,allowingthehosteddocumentstobeusedasapplications.
ThissectiondocumentsthelevelofsupportofMapledocumentfeaturesinMapleNet.
Textandmathcontent(both1-Dand2-D)shouldrendersimilarlyinabrowserandinMaple.
Startupcodewillbeexecuted,howeverautoexecuteregionswillnot.
Mostembeddedcomponentsaresupported,althoughsomepropertiesarenot.
Thefollowingtablesummarizestheembeddedcomponentsupport.
LimitationsSupportedComponentfontcolorisnotsupported.
YesButtonfontcolorandfillcolorarenotsupported.
YesCheckBoxfontcolorisnotsupported.
YesComboBoxNoDataTableYesDialfontcolorandfillcolorarenotsupported.
YesLabelfontcolorandfillcolorarenotsupported.
YesListBoxfillcolorarenotsupported.
YesMathExpressionYesMeterNoMicrophonefillcolorandmouseModearenotsupported.
YesPlotfillcolorandfontcolorarenotsupported.
YesRadioButtonYesRotaryGaugeYesShortcutfontcolorandfillcolorarenotsupported.
YesSliderNoSpeakerfontcolorandfillcolorarenotsupported.
YesTextAreaYesToggleButtonNoVideoYesVolumeGaugeTheuseof"this"torefertothecurrentembeddedcomponentisnotsupportedinMapleNet.
MostplotswillberenderednativelyinHTML5.
HTML5plotsareinteractive,allowingpanning,scalingandzooming.
Inaddition,HTML53-Dplotscanberotated.
SomeplottypesandoptionsarenotsupportedbyHTML5plots.
Fortheseplotseitheranimagewillberenderedortheplotwillberenderedwithoutthemissingfeature.
Thefollowingtablesummarizestheunsupportedforplotsfeatures.
1LimitationsOptionRenderedasanimagePolarPlotRenderedasanimageLogarithmicAxisRenderedasanimageDualAxisUnsupported2-DGridPlotRenderedasanimage2-DMeshPlotRenderedasanimageBackgroundimageforaplotIfanHTML5plotcontainstransparencydata,thetransparencyvaluesareignored.
transparencyUsesonecolorfromtheschemefortheplot2-DcolorschemeUnsupportedArrayPlotsUnsupportedsmartplotDownloadingMapleDocumentsMapleNetcanbeconfiguredtoallowMapledocumentstobedownloadedaswellasdisplayed.
SettingtheMAPLEN-ET_WEBSERVER_ENDPOINTS_DOWNLOADconfigurationvariabletotrue,instructsMapleNettoallowdocu-mentstobedownloadedbyaddingthedownloadurlparametertoadocument'surl.
Forexampleifadocumentcouldbedisplayedbyaccessinghttp://$HOSTNAME/document.
mwThenaddingthedownloadparamterasfollowshttp://$HOSTNAME/document.
mwdownloadcausesthedocumenttobedownloadedinsteadofdisplayed.
UploadingMapleDocumentshttp://$HOSTNAME/mapleonline/upload/upload.
htmlThispageallowsuserstoselectMapledocumentsfromtheirwebbrowserforuploadingtoMapleNet.
Alluploadedfilesareplacedintoanuploaddirectory.
Toenableuploading,theMAPLENET_WEBSERVER_ENDPOINTS_UPLOADconfigurationvariablemustbesettotrue.
TheuploadpagewilldisplaythecontentsoftheuploaddirectoryiftheMAPLENET_WEBSERVER_EN-ABLEDIRECTORYLISTINGconfigurationvariableissettotrue.
AnexampleofthisconfigurationcanbefoundintheExamplessection.
Theuploaddirectoryis/webroot/worksheet/uploadwhich,bydefault,existswithinthedockercontainer.
Thereforeanyuploadeddocumentswillbelostwhenthecontainerisrestarted.
IfyouwantuploadstopersistbetweenMapleNetrestartsyoushouldmountahostdirectoryontopoftheuploaddirectory.
AnexampleofthisconfigurationcanalsobefoundintheExamplessection.
TheAPIoftheuploadendpointitselfisnotdocumentedasitsinterfaceisnotconsideredstable.
ApplicationsthatattempttousetheuploadendpointdirectlywillbebrokenbyfutureversionsofMapleNet.
1.
3ComputeTheMapleNetComputeServiceallowsforapplicationstosendaMaplecomputationtoMapleNetandreceivetheresultofexecutingthatcomputation.
Thisserviceisanapplicationprogramminginterface,notanenduserinterface.
FormoredetailsabouttheComputeService,seetheMapleNetApplicationProgrammingInterfacedocument.
21MapleNetServices1.
4AdditionalFeaturesMapleNetprovidessomesecondaryfeaturesandservermonitoringtools.
Thesearedescribedbelow.
ThetermendpointreferstoaURLthatMapleNetprovidesthatcanbeaccessedusingstandardHTTPrequests.
WhentheseendpointsareaccessedMapleNetreplieswithanHTTPresponsecontainingtherequestedinformation.
Thereisnofileontheservercorrespondingtothesereplies,theyaregeneratedbyMapleNetitself.
HealthCheckTheHealthCheckendpointis/healthcheck/.
WhenanHTTPGETaccessesthisendpointMapleNetwillreplywithanHTTPresponsewithastatuscodeof200andwithnocontent.
ThisisintendedtobeusedbymonitoringservicestoverifythatMapleNetisavailable.
AsuccessfulreplyfromthehealthcheckendpointverifiesthatMapleNetisabletoacceptnewconnections,butitdoesnotverifythatMapleNetisabletoexecutecommandsoropenanewdocument.
HelpThehelpendpointsallowaccesstoMaplehelppageshostedbyMapleNet.
BydefaultMapleNetdoesnothaveanyhelpdatabasesinstalled.
InstructionsforaddinghelpdatabasescanbefoundintheExamplessectionoftheAdminis-trator'sGuide.
Thefollowingendpointsallowaccesstothecontentsofthehelpdatabases.
TableofContents:HTTPGETto/help/tocDisplaytheTableofContents[TOC]forthehelpdatabasesasanHTMLpage.
ThedisplayedTOCwilllinktothehelppagesfordisplayinMapleNet.
ThehelppageslinkedtobytheTOCcanbefilteredusingthelanguage,productandcategoryurlparameters.
TheseparameterscorrespondtotheoptionsofthesamenameusedwhenconstructingtheTOCforthehelpdatabases.
ForexampletodisplayEnglishhelppagesforMaple,youwouldaccess/help/toc/language=en&product=Maple.
Parametersmayalsobegivenmorethanoncetoincreasethematches(multipleparametersactasan"OR"),so/help/toc/language=en&product=Maple&product=MapleSimwouldshowallEnglishhelppagesfromMapleorMapleSim.
Bydefaulthelppagelinksarerelativelinkstothe/help/display/endpointofthecurrentMapleNet.
Tochangethis,theMAPLENET_WEBCLIENT_HELPURLconfigurationvariablecanbeused.
Topicdisplay:HTTPGETto/help/display/TOPICDisplaythehelppagecorrespondingtoTOPIC.
Forexample,/help/display/intorhelp/display/convert,rational.
Iftherearemultiplehelppagesmatchingthegiventopic,thepagewiththehigherpriority(asdefinedinthehelpdatabase)willbedisplayed.
Youcanfilterbylanguage,productandcategory,aswiththeTableofContents,howeverinthecaseofdisplayingahelppagethefilteringbehavesdifferently.
Thedisplayedpagemustmatchonevalueforeachgivenparameter,withprioritygiventothevalueappearingearlierintheurl.
Forexample/help/display/intlan-guage=ja&product=MaplewoulddisplayMaple'sinthelppageinJapaneseifitexistedora404errorifitdidnot.
Howeverusing/help/display/intlanguage=ja&language=en&product=Maple,woulddisplaytheJapanesepageifitexistedortheEnglishpageifitdidnot(andreturna404ifnetheraJapaneseorEnglishhelppageexisted).
Downloadhelppage:HTTPGETto/help/download/TOPICDownloadthehelppagecorrespondingtoTOPIC.
Thisendpointisidenticalthethedisplayendpoint,exceptthatinsteadofopeningthepageinMapleNetthehelppageisdownloaded.
1.
4AdditionalFeatures3MonitoringThemonitoringendpointis/monitoring/.
WhenanHTTPGETaccessesthisendpoint,asnapshotoftheinternalstateofMapleNetasastringofJSONisreturned.
Theinformationdisplayedcanbedividedintotwotypes,staticvaluesanddynamicvalues.
ThestaticvaluesarevaluesdefinedatMapleNetstartuptime,forexampleconfigurationvaluesandversioninformation.
DynamicvaluesarevaluesthatchangeasclientsconnecttoMapleNet,forexampleconnectedclientsandopendocuments.
Ifyouwanttoviewthemonitoringdatainawebbrowser,pluginsareavailableforprettyprintingJSON.
Thismakesthemonitoringoutputmorehumanreadable.
DefinitionValueThelimiterdescribesthenumberofrunningMapleengines.
ArunningMapleenginecorrespondstotherestrictionsimposedbyLimiterthelicense.
AwaitingEngineisanenginethatcan'trunbecausethemaximumnumberofrunningengineshasbeenreached.
TheengineManagerprovidesadetailedbreakdownoftheMapleenginesinusebyMapleNet.
DocumentenginesareenginesengineManagerconnectionstoopendocuments.
Computeenginesareusedforthecomputeendpoint.
Ascomputeenginesarepooledandreused,thereislistofpooledcomputeengines.
ThedocumentManagersectiondescribesthedocumentscurrentlyopenedbyclients.
Eachopendocumentliststhefollowingfields:documentManageridauniqueidassignedtothatcopyoftheopendocument,thenameofthedocument,theworkingdirectoryofthedocumentandthesourceofthedocument.
Theworkingdirectoryiswherethecontentcreatedfordisplayingthedocumentiskept.
TheclientssectiondescribesthedocumentclientscurrentlyconnectedtoMapleNetServer.
EachclientliststheIPaddressclientsfromwhichtheyareconnectedandtheidofthedocumentthattheyhaveopened.
ThehelpDatabasessectiondescribesthehelpdatabasefoundforusewiththehelpendpoints.
helpDatabasesTheVersionsectiondescribestheversionsofthevariouspiecesusedbyMapleNet.
ThisincludetheMapleNetandMaplebuildVersiondates,releaseidsandbuildids.
ThesevaluesareusefulwhenreportingbugsorcontactingMaplesoftSupport.
Thelicensesectiondescribesthelicensebeingused.
licenseTheStartUpConfigurationsectiondescribesthevaluesappliedbytheMapleNetconfiguration.
Thiscombinestheoptionssetwithconfigurationvariablesanddefaultvalues.
StartUpConfigurationTheLoggingsectiondescribesthecurrentloggingsettings,thelevelandwhetherAutoFlushorSynchronousoptionsareenabled.
Logging41MapleNetServicesIndexAAboutMapleNetServices,1AdditionalFeatures,3HealthCheck,3Monitoring,4AdditionalFeaturesHelp,3CComputeServices,2EEmbeddedComponentSupport,1HHostingMapleDocumentsFeatureSupport,1Overview,1PPlotOptionSupport,156Index