Inparametrar för http-anrop
(tänk på att stora och små bokstäver har betydelse i de flesta applikationsservrar)
standalone=1 | Startar kalkylen i standalone-läge. |
CX.ACTIONURL | URL för omskrivning av de URLer som skickas ut i HTML-koden från boendekalkylen. |
CX.AJAXPROXY | URL för omskrivning av anrop som inte får omgärdas av HTML och som kan ha godtycklig content-type. |
CX.CONTEXTPREFIX | Om integrationssidan behöver skicka med egna parametrar som sedan ska kunna hämtas från plugin. Ange här ett prefix som ska användas för alla sådana parametrar. (se exempel i stycket om plugins). Kan skickas med som soap-header till webservice. De egna parametrarna kan också skickas med som soap-headers. |
CX.GROUP | Vilken inställningsfil som ska användas, se stycket om inställningsfiler. Kan skickas med som soap-header till webservice. |
CX.execute | Används för att styra applikationens gränssnitt för att tex direkt öppna en tidigare gjord boendekalkyl för en viss person när gränssnittet startas upp. |
CX.killsession=1 | Tar bort den aktuella sessionen från servern. |
CX.sessionid | Sätt denna till en boendekalkyls sessionsid. Då öppnas boendekalkylens gränssnittet för den redan existerande sessionen som har detta id. Denna funktion används i kombination med webservicen "metaservice". I en oskyddad miljö så bör denna möjlighet stängas av med inställningen capitex_boendekalkyl_disablemetaservice=true |
CX.WSDL=1 | Visar WSDL för de funktioner som kan anropas med soap-kod som postdata i inparametern CX.SOAP |
CX.SOAP | I denna parameter kan ett komplett soap-envlope skickas med för att anropa en funktion i boendekalkylen i samband med ett anrop. Kan tex användas för att från ett helt vanligt html-formulär posta in data till boendekalkylen utan att behöva anropa webservice-funktionerna i Metaservice. (dvs detta är ett alternativ till Metaserivce). Vilken som passar bäst att använda beror på situationen. Denna metod kan tex användas för att från javascript direkt föda kalkylen med data genom att javascriptet skriver ner soap-anropet till en hidden-variabel på en html-sida, sedan så postar man html-formuläret till boendekalkylen. |
CX.lasterror=1 | Visar detaljerad information om det senaste felmeddelandet. |
CX.DEBUG=1 | Aktiverar menyvalet debug. Debug-dialogen innehåller matnyttiga funktioner för utvecklare men innehåller inga skadliga funktioner. |
CX.DEBUG=0 | Döljer menyvalet debug. |
CX.ACTIONURL
Används för omskrivning av URL’er i den HTML-kod som returneras från boendekalkylen. Om CX.AJAXPROXY inte skickas in så påverkar denna inparameter alla URLer i hela boendekalkylen. Om CX.AJAXPROXY också skickas in så påverkas enbart form-taggen.
Exempel
CX.ACTIONURL=http://test/integration.aspx
Ger bla följande påverkan på den returnerade HTML-koden:
<
form
method
=
"POST"
action
=
"http://test/integration.aspx"
>
<
script
src
=
"http://test/integration.aspx?CX._action=Prototype"
mce_src
=
"http://test/integration.aspx?CX._action=Prototype"
></
script
>
<
script
src
=
"http://test/integration.aspx?CX._action=Format"
mce_src
=
"http://test/integration.aspx?CX._action=Format"
></
script
>
<
link
rel
=
"stylesheet"
href
=
"http://test/integration.aspx?CX._action=Css"
mce_href
=
"http://test/integration.aspx?CX._action=Css"
type
=
"text/css"
/>
CX.AJAXPROXY
Används för omskrivning av URL’er vars utdata inte ska omgärdas av html-kod i integrationssidan. Tex när delar av html-sidan efterfrågas direkt från webbläsaren för att uppdatera enbart en specifik div-tag tex, eller när dynamiskt genererade css och JavaScript efterfrågas via script och link-taggar från webbläsaren.
Exempel
CX.ACTIONURL=http:
//test/integration.aspx
CX.AJAXPROXY=http:
//test/ajaxproxy.ashx
Ger bla följande påverkan på den returnerade HTML-koden:
<
form
method
=
"POST"
action
=
"http://test/integration.aspx"
>
<
script
src
=
" http://test/ajaxproxy.ashx?CX._action=Prototype"
mce_src
=
" http://test/ajaxproxy.ashx?CX._action=Prototype"
></
script
>
<
script
src
=
"http://test/ajaxproxy.ashx?CX._action=Format"
mce_src
=
"http://test/ajaxproxy.ashx?CX._action=Format"
></
script
>
<
link
rel
=
"stylesheet"
href
=
"http://test/ajaxproxy.ashx?CX._action=Css"
mce_href
=
"http://test/ajaxproxy.ashx?CX._action=Css"
type
=
"text/css"
/>
I JavaScript-koden som returneras från …CX._action=Prototype:
var
au =
new
Ajax.Updater(containerID,
'http://test/ajaxproxy.ashx?CX._partialrender='
+ containerID,
''
);
CX.EXECUTE
Parametern CX.execute kan antingen skickas med som del av query-strängen i get-anrop eller som post-parameter i post-anrop. Används långa funkstions-script så bör de skickas som post-data.
I parametern CX.execute så kan man skicka in kommandon, enligt följande syntax:
Kommando:parameter;Kommando:parameter;
Ett kommando måste alltid efterföljas av :
En parameter måste alltid efterföljas av ;
Alla funktioner tar exakt en parameter som indata
Funktioner utförs i den ordningen de anges i CX.execute
Funktionen för "fjärrstyrning" kan påverka en redan pågående session, dvs skickas URLen till ett redan öppet fönster som har en pågående session mot boendekalkylen så fjärrstyrs just den sessionen.
Funktioner för CX.EXECUTE
listakalkyler_oeppna
Öppnar dialogrutan listakalkyler
Beroenden: Har andra kommandon utförts innan så måste kommandot föregås av kommandot uppdatera
listakalkyler_listaellerhaemta:personnummer
Om det finns exakt en kalkyl gjord för denna person öppnas kalkylen, annars så sker enbart en sökning i dialogrutan listakalkyler. Finns det inte exakt en kalkyl så rensas alla efterkommande kommandon i scriptet.
Beroenden: Funktionen måste föregås av funktionen listakalkyler_oeppna
uppdatera
Applikationen returneras till webbläsaren. Webbläsaren gör sedan direkt ett anrop tillbaka till servern. Detta leder till omladdningar på klienten och rent visuellt så ser användaren då allt som händer, dialogrutor som öppnas och stängs mm, detta tar en hel del kraft… Det går att anropa uppdatera-funktionen efter varje kommando, men det är inte effektivt. Vissa kommandon kräver att anrop till uppdatera gjorts innan, vissa kommandon kräver det inte.
utskrift_oeppna
Öppnar dialogrutan utskrift
Beroenden: Har andra kommandon utförts innan så måste kommandot föregås av kommandot uppdatera
utskrift_granska
Öppnar dialogrutan förhandsgranska
Beroenden: Måste föregås av kommandot utskrift_oeppna. Efter anrop till granska måste funktionen uppdatera anropas.
Exempel med CX.EXECUTE
Förutsättningar
I databasen finns en kalkyl gjord för personen med personnummer 197712121212
I databasen finns minst två kalkyler gjorda för personen med personnummer 197409092918
Exempel 1:
Öppnar direkt kalkylen för kunden med personnummer 197712121212. Den öppnas direkt eftersom det bara finns en gjord kalkyl för denna person
http://testserver/boendekalkyl/BoKalkGraenssnitt?standalone=1&CX.execute=listakalkyler_oeppna:1;listakalkyler_listaellerhaemta:197112121212;
Exempel 2:
Finns det flera kalkyler så stannar Boendekalkylen i dialogrutan som listar alla kalkyler för personen ifråga:
http://testserver/boendekalkyl/BoKalkGraenssnitt?standalone=1
&CX.execute=listakalkyler_oeppna:1;
listakalkyler_listaellerhaemta:197409092918;
Exempel 3:
Det går att direkt komma till utskriftsfönstret om så önskas:
http://testserver/boendekalkyl/BoKalkGraenssnitt?standalone=1
&CX.execute=listakalkyler_oeppna:1;
listakalkyler_listaellerhaemta:197112121212;
uppdatera:1;
utskrift_oeppna:1;
Exempel 4:
Det går att direkt komma till förhandsgranskningen av utskriften om så önskas:
http://testserver/boendekalkyl/BoKalkGraenssnitt?standalone=1
&CX.execute=listakalkyler_oeppna:1;
listakalkyler_listaellerhaemta:197112121212;
uppdatera:1;
utskrift_oeppna:1;
utskrift_granska:1;
uppdatera:1;
Exempel 5:
Försöker man köra exempel 3 och 4 för en person som har mer än en kalkyl så stannar den vid hämta-dialogen:
http://testserver/boendekalkyl/BoKalkGraenssnitt?standalone=1
&CX.execute=listakalkyler_oeppna:1;
listakalkyler_listaellerhaemta:197409092918;
uppdatera:1;
utskrift_oeppna:1;
utskrift_granska:1;
uppdatera:1;