EXT: eGov API
Contents
1. 25 60 value htmlpagecss 60 wrap eCHapiFormat 70 TEXT 10 value utf 8 70 wrap amp eCHapiEncode 4 Configuration 4 1 plugin tx_egovapi_pil 4 2 plugin tx_egovapi_pil displayBlocks 4 3 plugin tx_egovapi_pil versions 4 4 plugin tx_egovapi_pil targets 4 5 plugin tx_egovapi_pil templates 4 6 plugin tx_egovapi_pi2 5 Tutorial This tutorial is best suited for day to day webmasters or editors having to integrate the eGov API within their website It assumes an administrator already properly installed this extension see chapter Administration It is targeted at users and as such section Plugin options of chapter User manual is part of the basic know how the webmaster or editor should have to be able to use this extension 5 1 Use case 5 1 1 Description You would like to show the list of service domains available for the audience Personne priv e 100 in some part of your website 5 1 2 Step by step explanation 1 Open Web gt Page module and navigate within your website to the page where you would like to add the eGov API plugin 2 Click on icon to add a content element to your page 3 Move to section Plugins and select the eGov API plugin inspiring people to share TYP03 Y 26 Tutorial 1 Select type of content element Please select which kind of page content you wish to create Typical page content Special elements Form elements Flexible content Plugins General2. GETvar gt tx_egovapi_pillaction mode gt array array GETvar gt tx_egovapi_piilmode Ja 3 2 TypoScript configuration In order for this extension to be usable make sure to include at least the static template settings from the eGov API extension To do that click on Web gt Template in the left frame and then select the root page of the website You template will show up Then click on link Edit the whole template record open tab Includes and add static template from extension egovapl You are presented with two items in the list of available items One is eGov API settings egovapi the other is eGov API CSS styles egovapi You should at least add the settings The CSS styles may serve as example for styling the extension s output and should even be omitted if you want to use your own CSS TYP03 ET op E v WEB Info Modify 3 LE Page View y formation bpmforyou ch Template tools v formation bpmforyou ch List Pe a Navigation principale Template information Info gt Lesa secondaire gt v Storage Folder in Main Template y Access R PES Functions 3 Configuration Title lin Template E TemplaVoil Main Template URL URL RealUrl Management A 2 Title Main Tompisis TF Recycler Sitetitle E Versioning y Description v FILE y Resources Filelist Constants edit to view 9 lines v USER TOOLS
3. D TO lastModificationDate integer timestamp views tx_egovapi domain model view 2 2 2 View tx_egovapi_domain_model_view name string domains tx_egovapi domain model domain audience tx egovapi domain model audience lastModificationDate integer timestamp Additional template values inspiring people to share TYPO3 Y 10 2 2 3 User manual hasParent boolean set to TRUE if parent view may be shown on same page otherwise FALSE Domain tx_egovapi_domain_model_domain d name community remark topics tx_egovapi_ domain model topic synonym tx egovapi domain model synonym view tx__egovapi domain model view Additional template values hasParent boolean set to TRUE if parent view may be shown on same page otherwise FALSE showLevelInformation boolean set to TRUE if level information block may be shown otherwise FALSE showGeneralInformation boolean set to TRUE if general information block may be shown otherwise FALSE showNews boolean set to TRUE if news block may be shown otherwise FALSE showSubdomains boolean set to TRUE if subdomains block may be shown otherwise FALSE showDescriptor boolean set to TRUE if descriptor block may be shown otherwise FALSE showSynonym boolean set to TRUE if synonym block may be shown otherwise FALSE TYPO3 Y 2 Domain Model 11 2 2 4 Topic tx_egovapi_domain_model_topic d name community remarks de
4. Plugin Select this element type to insert a plugin which cannot be found amongst the options below eGov API Adds a frontend plugin showing data from the eGov web service After having given a header to your content element as a best practice possibly set its rendering Type to hidden you should configure the eGov API plugin Ba BE EF BF ie ra er ned rah iii Edit Pagecontent Mod ov on page Liste Public cible General Plugin Access Plugin eGov API hd Plugin Options d General Audience Domain Topic Service Wersion Other Settings Authorized levels Selected Items Audience View Domain Topic Service Display Mode Defined by TypoScript Automatic Typoscript for this content element plugin egovapi_pil your TS 1 Move to the Plugin tab to access plugin s configuration options 2 Select General option tab 3 Authorize level Domain to be shown As this is the only selected level it will be used as entry point for the plugin and will not allow navigation to other levels If you need this you may either add other authorized levels after the entry point level or TYPO3 Y 21 configure redirect pages containing plugins for the other levels on Other Settings option tab Last step is to configure the plugin in order to only show the audience Personne priv e Edit Pagecontent Module eGov on page Liste Public cible General
5. Plugin Access Plugin eGov API hd Plugin Options q d General Audience View Domain Topic Service Wersion Other Settings Changes on this form will impact other configuration sheets Audiences to show LIST Authorized audiences SINGLE Selected Items loving on to next sheet eho aha 300 Autorit s 200 Entreprise 401 Owarna 100 Personne priv e 400 eCH 100 Personne priv e Override template to use for the list of audiences Override template to use for details of an audience 1 Select Audience option tab 2 Select audience Personne priv e That s it If you show your page you should have a list of domains related to the audience Personne priv e phy pg do ins e Vie privee details 6 Developer manual This chapter is really targeted at extension developers Most TYPO3 integrators should never have the need to go that deep in order for them to configure the eGov API extension to fit their integration needs If however you encounter some limitation you cannot solve using TypoScript configuration you may want to read the following sections to learn how to take more control inspiring people to share TYPO3 Y 28 Known problems 6 1 Hooks Some hooks have been integrated into the eGov API extension They are primarily targeted at letting you post process the subparts and markers prior to the actua
6. e g 99001 Swiss Confederation 00619 Oberdiessbach 02196 Fribourg a 02228 Enable features Enable debugging information plugin tx egovapi enableDebug Provide additional information with error messages 3rd party devLog extension may be required for full support 20 Use Fluid as rendering engine pluain t x egovapt useFluid eo 3 Ca There are many other options such as the language of the web service which should typically be related to the value of config language in your setup If you are running a recent version of TYPO3 4 5 0 you definitively should use Fluid as rendering engine This requires system extension fluid to be loaded Using Fluid will highly ease the way you prepare your templates and will let you have full control over the way web service data are rendered 3 3 Selector Form Plugin If you activated the selector form plugin within the Extension Manager you will see an additional plugin available in the new content element wizard inspiring people to share TYPO3 Y 24 Administration Please select which kind of page content you wish to create Typical page content Special elements Form elements Flexible content Plugins General Plugin Select this element type to insert a plugin which cannot be found amongst the options below eGov API Adds a frontend plugin showing data from the eGov web service eGov API Selector Form Adds a frontend plugin showing a selector form for the eGov web
7. 06 Logement et d m nagement a 100 10 001 009 Papiers et attestations z Blocks to show Selected Items Available Items Level information General information News Subtopics Descriptors Synonyms Ce a Ex e le Override template to use for the list of topics Override template to use for details of a topic inspiring people to share TYPO3 Y 2 1 7 Service User manual General Audience View Domain Services to show LIST Authorized services SINGLE Selected Items 01170 Attestation de residence tablissement et sej 01172 Commune de domicile annonce d arriv e Pi Topic Service Other Settings Version Available Items 01170 Attestation de r sidence tablissement et seji 01168 Changement d adresse l int rieur de la comn 01172 Commune de domicile annonce d arriv e Pe 02061 Commune de domicile annonce d arriv e pe 01173 Commune de domicile annonce de d part 01141 Documents d identit demande personnes i 01176 D claration de domicile 00204 Extrait du casier judiciaire 00204 Extrait du casier judiciaire Ce Ds Ge le Blocks to show Selected Items Available Items Level information General information Prerequisites Procedure Form s Required documentis Ce ba Es Le bd Service provided Fee Legal regulation 10 O
8. ERVICE CONTACT DEPARTMENT e SERVICE_CONTACT_ OFFICE e SERVICE CONTACT ADDRESS e SERVICE CONTACT POSTAL CASE e SERVICE CONTACT POSTAL CODE e SERVICE CONTACT MUNICIPALITY e SERVICE CONTACT PERSON e SERVICE CONTACT PHONEI inspirine people to share TYPO3 Y 18 Administration SERVICE CONTACT PHONE2 SERVICE CONTACT FAX SERVICE CONTACT EMAIL SERVICE CONTACT EMAIL LINK SERVICE CONTACT _ PUBLIC KEY SERVICE _ CONTACT LOGO SERVICE CONTACT BANNER SERVICE_CONTACT_OPENING_HOURS VCARD_URL Subparts SERVICE LINK DETAIL HAS PARENT SERVICE LINK TOPICS SERVICE LINK TOPIC SERVICE LINK SERVICES SHOW_LEVEL_INFORMATION SHOW_GENERAL_ INFORMATION SHOW_ PREREQUISITES SHOW_ PROCEDURE SHOW_FORMS SHOW_DOCUMENTS_ REQUIRED SHOW_ SERVICE PROVIDED SHOW FEE SHOW_LEGAL REGULATION SHOW_ DOCUMENTS OTHER SHOW_REMARKS SHOW_ APPROVAL SHOW_ CONTACT SHOW_BACK_ TO_ LIST 3 Administration This chapter describes how to manage the extension from a superuser point of view TYPO3 Y 3 Installing the extension 19 3 1 Installing the extension There are a few steps necessary to install the eGov API extension If you have installed other extensions in the past you will run into little new here 3 1 1 Install the extension from Extension Manager The eGov API extension can ben installed through the typical TYPO3 installation process using the Extension Manager During the installation process you may be invited to install additional
9. EXT eGov API Extension Key egovapi Language en de fr it Keywords e government switzerland administrative services cyberad ministration Author Causal Sarl lt xavier causal ch gt for SECO Date 2011 10 13 Revision 93022 Description This is the documentation for the TYPO3 extension egovapi Contents 1 Introduction 1 1 What does it do 1 2 Sponsorship 1 3 Screenshots 2 User manual 2 1 Plugin options 2 2 Domain Model mm 2 3 Available markers and subparts 3 Administration 3 1 Installing the extension s 3 2 TypoScript configuration 3 3 Selector Form Plugin Da 4 Configuration 4 1 plugin tx egovapi pil 4 2 plugin tx egovapi pil displayBlocks 1 Introduction 1 1 What does it do Nee M N O0 Co 1 17 18 20 22 24 24 24 4 3 plugin tx egovapi pil versions 4 4 plugin tx egovapi pil targets 4 5 plugin tx egovapi pil templates 4 6 plugin tx egovapi pi2 Tutorial Bl Use case 1 D 3 Le vus EG aS Developer manual 6 1 Hooks 6 2 API documentation 6 3 eGov web service Known problems To Do list ChangeLog 24 24 24 24 24 24 26 27 21 21 27 28 28 In the digital age enterprises and citizens should be able to ask for an administrative autho rization or an official register extract electron
10. PTOR SHOW_SYNONYM Topic Markers TOPIC_ID TOPIC_NAME TOPIC DESCRIPTION TOPIC_IS_ PARENT TOPIC_ VERSION ID inspiring people to share 15 TYP03 Y 16 TOPIC_ VERSION_ NAME TOPIC COMMUNITY ID TOPIC RELEASE TOPIC _REMARKS TOPIC_STATUS TOPIC AUTHOR TOPIC_CREATION_ DATE formatted as dd mm yyyy TOPIC_LAST MODIFICATION DATE formatted as dd mm yyyy TOPIC GENERAL INFORMATION TOPIC NEWS TOPIC SUBTOPICS TOPIC DESCRIPTOR TOPIC _ SYNONYM Subparts 2 3 5 TOPIC _ LINK SERVICES TOPIC LINK DETAIL HAS PARENT TOPIC _ LINK DOMAINS TOPIC _ LINK DOMAIN SHOW_LEVEL_ INFORMATION SHOW _GENERAL INFORMATION SHOW_ NEWS SHOW_ SUBTOPICS SHOW_ DESCRIPTOR SHOW_SYNONYM Service Markers SERVICE _ ID SERVICE NAME SERVICE DESCRIPTION SERVICE _ VERSION _ID TYPO3 Y User manual 2 Available markers and subparts 17 e SERVICE VERSION NAME e SERVICE COMMUNITY_ ID e SERVICE RELEASE e SERVICE COMMENTS e SERVICE PROVIDER e SERVICE_ CUSTOMER e SERVICE TYPE e SERVICE ACTION e SERVICE STATUS e SERVICE AUTHOR e SERVICE CREATION DATE formatted as dd mm yyyy e SERVICE LAST MODIFICATION DATE formatted as dd mm yyyy e SERVICE GENERAL INFORMATION e SERVICE PREREQUISITES e SERVICE PROCEDURE e SERVICE FORMS e SERVICE DOCUMENTS REQUIRED e SERVICE SERVICE PROVIDED e SERVICE FEE e SERVICE LEGAL REGULATION e SERVICE DOCUMENTS OTHER e SERVICE_REMARKS e SERVICE APPROVAL e SERVICE_CONTACT e S
11. RUE if general information block may be shown otherwise FALSE e showPrerequisites boolean set to TRUE if prerequisites block may be shown other wise FALSE e showProcedure boolean set to TRUE if procedure block may be shown otherwise FALSE TYPO3 Y 2 Available markers and subparts 13 showForms boolean set to TRUE if forms block may be shown otherwise FALSE showDocumentsRequired boolean set to TRUE if documents required block may be shown otherwise FALSE showServiceProvided boolean set to TRUE if service provided block may be shown otherwise FALSE showFee boolean set to TRUE if fee block may be shown otherwise FALSE showLegalRegulation boolean set to TRUE if legal regulation block may be shown otherwise FALSE showDocumentsOther boolean set to TRUE if documents other block may be shown otherwise FALSE showRemarks boolean set to TRUE if remarks block may be shown otherwise FALSE showApproval boolean set to TRUE if approval block may be shown otherwise FALSE showContact boolean set to TRUE if contact block may be shown otherwise FALSE showBackToList boolean set to TRUE if back to list block may be shown otherwise FALSE 2 2 6 Service tx_egovapi_domain_model_block_contact Property department office address string string postalCode municipality person string string logo string banner string openingHours 2 3 Available m
12. Setup edit to view 30 lines Task center y Edit the whole template record A Q E User settings a Workspace inspiring people to share TYPO3 Y 22 Administration General Options Includes Resources Access Include Static Templates After Basis Templates rh Include static from extensions Selected Items Available Items eGov API settings egovapi eGov API CSS styles egovapi CSS Styled Content TYPOS v3 8 css styl CSS Styled Content TYPOS v3 9 css style CSS Styled Content TYPOS w4 2 css_ style CSS Styled Content TYPOS v4 3 css style CSS Styled Content TYPOS w4 4 css style Clickenlarge Rendering rtehtmiarea Static Info tables static_info tables W eGov API settings egovapi eGov API CSS styles egovapi CS5 Styled Content css_styled_content i al x Save changes to your templates and close this form Then open the Constant Editor from the drop down menu and update global configuration to fit your needs TYPO3 Y 3 Selector Form Plugin 23 Constant Editor o Template tools Edit constants for template im NEW SITE Category PLUGIN TX_EGOVAPI 16 o o e API WSDL for the eGov API plugin tx egovapi wsdl URL of the eGov API web service inherits global setting if empty 2 Empty Service Community plugin tx_eqovapi ecCHcommunityID Canton Fribourg gt Organization ID plugin tx_egovapi organizationID Identifier of the organization
13. arkers and subparts string When using marker based templates domain model attributes are available as ENTITY ATTRIBUTE The full list of available markers is as follows inspiring people to share TYPO3 Y 14 User manual 2 3 1 Audience Markers e AUDIENCE_ID e AUDIENCE_NAME e AUDIENCE_AUTHOR e AUDIENCE_CREATION_ DATE formatted as dd mm yyyy e AUDIENCE LAST MODIFICATION_DATE formatted as dd mm yyyy Subparts e AUDIENCE LINK VIEWS e AUDIENCE LINK DETAIL 2 3 2 View Markers e VIEW_ID e VIEW_NAME e VIEW_AUTHOR e VIEW_CREATION_DATE formatted as dd mm yyyy e VIEW_LAST_MODIFICATION_DATE formatted as dd mm yyyy Subparts e VIEW_LINK_ DOMAINS e VIEW_LINK_ DETAIL e HAS PARENT e VIEW_LINK_AUDIENCES e VIEW_LINK AUDIENCE 2 3 3 Domain Markers e DOMAIN ID e DOMAIN NAME e DOMAIN DESCRIPTION e DOMAIN IS PARENT e DOMAIN VERSION ID e DOMAIN VERSION NAME TYPO3 Y 2 Available markers and subparts DOMAIN COMMUNITY ID DOMAIN RELEASE DOMAIN REMARKS DOMAIN STATUS DOMAIN AUTHOR DOMAIN CREATION DATE formatted as dd mm yyyy DOMAIN LAST MODIFICATION DATE formatted as dd mm yyyy DOMAIN GENERAL INFORMATION DOMAIN NEWS DOMAIN _ SUBDOMAINS DOMAIN_ DESCRIPTION DOMAIN SYNONYM Subparts 2 3 4 DOMAIN_LINK TOPICS DOMAIN_LINK_ DETAIL HAS _ PARENT DOMAIN_ LINK _ VIEWS DOMAIN LINK VIEW SHOW_LEVEL_ INFORMATION SHOW_GENERAL_ INFORMATION SHOW_NEWS SHOW_SUBDOMAINS SHOW_ DESCRI
14. e Finally a Version tab allows you to force a given version of a service to be used instead of the default one Other Settings provides a few additional configuration options we will describe later on 2 1 1 General Selected Plugin eGov API gt Plugin Options General Audience View Domain Topic Service Version Other Settings Authorized levels Selected Items Avallable Items Audience View Domain Topic Service gt Lea Es e Le Display Mode i T Defined by TypoScript Automatic Typoscript for this content element plugin egovapi_pil your TS The rules are as follows e Ifa field is left empty the corresponding TypoScript property is taken into account e Ifthe corresponding TypoScript property is empty there is no restriction In the screenshot above leaving Authorized levels empty will let you freely navigate from Audience to Service back and forth Backend administrators only Field myT S allows you to override the TypoScript con figuration after the merge of the FlexForm options This is really the last chance to update the rendering configuration Any configuration option may be overridden except the web service related properties WSDL cache lifetime language A business processing makes use of it before the rendering takes place We assume it is more than unlikely to be needed anyway 2 1 2 Level hierarchy Before actually describing the options of the le
15. e details Retour la liste Cat gories de services Etat civil details Logement el d m nagement details Papiers et attestabons details Sant el afaires sociales details our La liste Services Certhont de bonne et moeurs 011471 Certificat de vie 01143 Documents didentit demande personnes de nationalit suisse 01141 Extras du casir judiciaire 00204 L galisstion de Bgnature demande 019781 Retour La liste Cenifical de vie more UTA a ara de o e ram a bee pd el dre dd y parra de par al a ri SA ero ed repr de e ee core pr Li pe CEE AA ee Pa a LOS AAA A dou Ji gaara T arr da ke ee Conds poa Dirk de gua us aa degen ee oe eee dpe daras nu pee de eel PA J narra arar ae a paa a A A ATRAE e D a paa dor g Tegra ps rep o aid de ieee demas yee rra Contre dee aniani Persan 1 Coats de la pranbrion a de er rs is 5 AA A i e ce jee hu G met dear LA rl toe SN NON AL y 3 i ru Ea minj j amb h Om Laa fee CE ee la Po LE EE ee a ol ara i ja ad A pd de E Eee Pol DU Gone en err foe EEA ee ee A ala Les e Ha Biel ds TEA e AR ee Cep pos ee prep AS Pere g p crie Le EU ons inspiring people to share Cr Epo TYPO3 Y User manual 2 User manual 2 1 Plugin options The plugin is split among a general configuration tab and then a tab for each and every level of the eGov API Audience View Domain Topic Servic
16. ically Thanks to the eGov CH Reference project they can access any useful information online 24 7 and order via internet or mobile phone The administration better responds to current requirements and customer needs helping to reduce bureaucracy and increasing the attractiveness of the Swiss economy The eGov API extension aims at providing an easy way to swiss public authorities to show and grant access to the different administrative services they offer through their TYPO3 website inspiring people to share TYPO3 Y 2 Introduction 1 2 Sponsorship This extension is the official implementation of the swiss eGov Remote API for TYPO3 It has been sponsored by the State Secretariat for Economic Affairs SECO which is the Confederation s competence centre for all core issues relating to economic policy The SECO wanted to improve the online access to the administrative services they offer This project has been developed and is being maintained by Causal Sarl in Fribourg Further information e Website of the SECO http www seco admin ch e Reference eGov project s website http www cyberadmin ch e Causal Sarl http causal ch TYPO3 Y 1 Screenshots 1 3 Screenshots Publics cibles Autorit s details Entreprise details Dwarna details Personne priv s details CH details Vues Loe eo Par situation details 100 101 Par theme details Domaines Environnement el constructi details Vie pris
17. ing Since web service version 2 the eGov API extension can take advantage of an operation returning recently updated services This lets you configuring an unlimited cache lifetime see chapter Configuration and invalidate cache entry as they are updated This is done by regularly running e g every 1 2 days scheduler task Latest changes in eGov API for all communities you are retrieving data for 3 1 4 Configure RealURL If you are using RealURL the good news is that the eGov API extension comes with a config uration for RealURL If your configuration is automatically generated you havea typo3conf realurl_autoconf php file delete it It will be recreated by RealURL the next time you render your page and will integrate our post VarSets configuration If you manually tweaked the configuration you have a typo3conf realurl_conf php file here is the configuration we suggest gt postVarSets gt array DEFAULT gt array audience gt array array GETvar gt tx_egovapi_piilaudience J view gt array array GETvar gt tx_egovapi_pillview J Js domain gt array array GETvar gt tx_egovapi_piildomain Ja topic gt array array GETvar gt tx_egovapi_piiltopic TYPO3 Y 3 TypoScript configuration 21 service gt array array GETvar gt tx_egovapi_pillservice ys J action gt array array
18. is documented by the corresponding WSDL When accessing this WSDL endpoint XML schemas are defined as namespaces The under lying XSD files may be retrieved by prefixing the namespace by http ref cyberadmin ch WS20 ServiceContract E g the schema of dataCommonBlocks may be accessed with http ref cyberadmin ch WS20 Service Contract MessageContract DataContract CommonBlocks xsd 7 Known problems Please use the extension s bug tracker on Forge to report bugs http forge typo3 org projects extension egovapi issues TYPO3 Y 29 8 To Do list Please use the extension s bug tracker on Forge to propose new features http forge typo3 org projects extension egovapi issues 9 ChangeLog The following is a very high level overview of the changes in this extension For more details see the ChangeLog file included with the extension or read it online Added support for both the existing web service and its upcoming new version Tested with TYPO3 4 6 Added microformat markers hCard for the service s office Services are grouped by provider for the selector form plugin Selector form plugin added Completed German translation Stable release Updated documentation with additional screenshots Updated templates with additional CSS classes Further documentation First release on TER inspiring people to share TYP03 Y
19. l Audience View Domain Topic Service Version Other Settings Views to show LIST Authorized views SINGLE Selected Items Available Items 200 20 Par situation 100 20 Par situation 200 10 Par theme 100 10 Par theme 100 10 Par theme 200 20 Par situation x a GI Le Override template to use for the list of views Override template to use for details of a view F 2 1 5 Domain General Audience View Domain Topic Service Version Other Settings Domains to show LIST Authorized domains SINGLE Selected Items Available Items 100 10 001 Vie priv e Aman Blocks to show Selected Items Available Items Level information General information News Subdomains Descriptors Synonyms gt Lea LA Le Override template to use for the list of domains Override template to use for details of a domain TYPO3 Y 2 Plugin options 1 Blocks to show This section is used when showing the details of a single domain It allows us to trim down the amount of information or to split them among multiple copies of the plugin on a detail page 2 1 6 Topic General Audience View Domain Topic Service Version Other Settings hanges on this form will impact other configuration sheets Please save configuration before moving on to Topics to show LIST Authorized topics SINGLE Selected Items Available Items 100 10 001 0
20. l rendering process when using marker based templates or to post process the AJAX returned data Hooks have not been used for Fluid based templates as you may achieve the same goal with TypoScript configuration or use of ViewHelpers Following hooks are available e Final post processing GLOBALS TYPO3_CONF_VARS EXTCONF egovapi renderHook e Post processing of audience subparts and markers GLOBALS L TYPO3_CONF_VARS L EXTCONF egovapi L prepareAudienceHook Post processing of view subparts and markers GLOBALS L TYPO3_CONF_VARS EXTCONF egovapi L prepareViewHook Post processing of domain subparts and markers GLOBALS L TYPO3_CONF_VARS EXTCONF egovapi L prepareDomainHook Post processing of topic subparts and markers GLOBALS L TYPO3_CONF_VARS L EXTCONF egovapi L prepareTopicHook Post processing of service subparts and markers GLOBALS L TYPO3_CONF_VARS L EXTCONF egovapi L prepareServiceHook e Post processing of AJAX returned data GLOBALS TYPO3_CONF_VARS EXTCONF L egovapi ajaxHook 6 2 API documentation The latest API documentation may be manually generated using doxygen configuration file doc doxygen conf Alternatively you may access it from http api causal ch egovapi 6 3 eGov web service The eGov web service
21. scriptor tx egovapi domain model block descriptor synonym tx__egovapi_ domain model synonym generallnformation tx egovapi domain model block generallnformation services tx_egovapi domain model service 2 2 5 domain tx _egovapi domain model domain Additional template values hasParent boolean set to TRUE if parent view may be shown on same page otherwise FALSE showLevelInformation boolean set to TRUE if level information block may be shown otherwise FALSE showGeneralInformation boolean set to TRUE if general information block may be shown otherwise FALSE showNews boolean set to TRUE if news block may be shown otherwise FALSE showSubtopics boolean set to TRUE if subtopics block may be shown otherwise FALSE showDescriptor boolean set to TRUE if descriptor block may be shown otherwise FALSE showSynonym boolean set to TRUE if synonym block may be shown otherwise FALSE Service tx_egovapi_domain_model_service inspiring people to share TYP03 Y 12 User manual versionId integer tx__egovapi_domain _model_ block procedure tx egovapi_domain model block prerequisites tx egovapi domain model block forms Additional template values e hasParent boolean set to TRUE if parent view may be shown on same page otherwise FALSE e showLevelInformation boolean set to TRUE if level information block may be shown otherwise FALSE e showGeneralInformation boolean set to T
22. service The selector form plugin requires a dedicated static TypoScript the eGov API selector settings and possibly the default CSS styles as for the main plugin Make sure to properly configure constant plugin tx egovapi targets single service with the UID of the page containing the main plugin The plugin is shipped with a standard jQuery based javascript using AJAX queries to re fresh the form A custom demo version has been integrated on http fr causal ch realisations api e government demo Beware The main plugin should use settings eGov API selector settings too and not the default ones 3 3 1 Generating legacy parametrized URL You may want to use the selector form plugin to generate parametrized URL compatible with the legacy service handler on www cyberadmin ch Below is a configuration example for generating such URLs plugin tx_egovapi_pi2 parametrizedUrl TEXT plugin tx_egovapi_pi2 parametrizedUrl typolink parameter http www cyberadmin ch eGovApi parameter wrap cUbject COA parameter wrap cObject 1 TEXT 1 value 10 TEXT 10 data GP language 10 wrap eCHlanguageID 10 case upper 20 TEXT 20 data GP organization 20 wrap amp eCHmunicipalityID 30 TEXT 30 field id 30 wrap amp eCHservicelD 40 TEXT 40 field versionld 40 wrap amp eCHserviceVersionID 50 TEXT 50 data GP blocks 50 wrap amp eCHserviceBlock 60 TEXT TYPO3 Y
23. suggested extensions that interact with the eGov API extension These are alls imply suggestions and can safely be ignored if you choose Note If you plan to use Fluid as template engine then you must install that system extension before installing the eGov API extension The minimum required version of this system extension is 1 3 0 meaning it requires TYPO3 4 5 or above as Fluid template within the eGov API extension are using the FLUIDTEMPLATE content object which was introduced with TYPO3 4 5 If you use TYPO3 4 5 or below you have to create the two proposed caching tables T hese tables not needed anymore with TYPO3 4 6 and above are being used by the TYPO3 caching framework if you choose to use a database backend see below Since version 1 2 0 a selector plugin has been added allowing you to show a form aimed at dynamically generating parametrized URIs for non TYPO3 websites willing to integrate e government web service anyway It has to be activated in Extension Manager Category ADVANCED 1 un Enable features Enable selector plugins enableSelectorPiugins Provide a selector form plugin and its counterpart to show a service from URL parameters Ei Update 3 12 Configure data caching In order to prevent unnecessary traffic with the eGov servers hosting the web service data caching should be configured The extension makes use of TYPO3 caching framework If you are using TYPO3 prior to 4 6 you ha
24. ther document s 11 Remarks 12 Approval 13 Contact Override template to use for the list of services Override template to use for details of a service TYPO3 Y 2 Domain Model 9 2 1 8 Version Genera Audience View Domain Topic Service Version Other Settings Advanced configuration of service versions to be used Beware invalid configuration is likely to yield empty services Force service versions Service ID Default version Version to use Description 01170 13430 Attestation de r sidence tablissement et s jour 01172 13434 Commune de domicile annonce d arriv e Personnes de nationalit suisse 00204 11781 Extrait du casier judiciaire 2 2 Domain Model This section describes the eGov API domain model The domain model may be accessed directly when using Fluid based templates If instead you use marker based templates only partial access to the domain model will be possible and you probably will have to implement one of the available hooks see Hooks section in Developer manual for more complex scenarios We only describe domain model for the eGov API levels audience view domain topic service Attributes for the blocks of information which are typically used for the details view of an entity should be analyzed with Fluid template examples or by looking at the classes within directory Classes Domain Model Blocks e g using http api causal ch egovapi 2 2 1 Audience tx_egovapi_domain_model_audience
25. ve to activate the caching framework using either the Install Tool or by editing file typo3conf localconf php and adding following line TYPO3_CONF_VARS SYS L useCachingFramework 1 Activating caching framework will ensure that the same information is not retrieved twice during a single request However once the request is over the cache is flushed as it internally uses a Transient MemoryBackend In order to cache data for a longer period of time you should provide a caching configuration for the eGov API extension A typical configuration to cache data in the database is TYPO3_CONF_VARS SYS L caching cacheConfigurations egovapi array frontend gt t3lib cache frontend VariableFrontend inspiring people to share TYPO3 Y 20 Administration backend gt t3lib cache backend DbBackend options gt array gt cacheTable gt tx_egovapi_cache tagsTable gt tx_egovapi_cache_tags ye Important note The cacheTable and tagsTable parts are not relevant anymore if you use TYPO3 4 6 and above as the caching framework uses it own table structure creation of the corresponding tables when installing the eGov API extension is thus useless as well See the corresponding task on Forge if you want to learn more Please refer to the TYPO3 documentation for further configuration options 3 1 3 Configure advanced data cach
26. vel configuration tabs it may help giving us an overview of the level hierarchy within the eGov web service TYPO3 Y 2 Plugin options 5 audience Entreprise Changement d adresse 2 1 3 Audience General Audience View Domain Topic Service Version Other Settings Audiences to show LIST Authorized audiences SINGLE Selected Items Available Items 300 Autorit s 200 Entreprise 401 Owarna 100 Personne priv e 00 Entreprise 100 Personne priv e x Da Ge Pe e 400 eCH Override template to use for the list of audiences Override template to use for details of an audience k By selecting items you trim down the list of items being shown by the plugin and this additionally lets you manually order them Whenever you change the list of selected items in any of the Audience View Domain or Topic tab you should save your plugin configuration as the sublevel list of items in the next tab will be filtered accordingly E g in the screenshot above we selected Entreprise and Personne priv e as audiences to be shown and we ordered them to show Entreprise and then Personne priv e We should now save the plugin configuration before moving on to tab View where we inspiring people to share TYPO3 Y 6 User manual only will get views related either to Entreprise or to Personne priv e in the available items 2 1 4 View Genera
Download Pdf Manuals
Related Search