Changelog SiteKit BOL-Formulare: Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
(Die Seite wurde neu angelegt: „==Changelog== ===1.0 (03.06.2019)=== {| | style="vertical-align:top;" | {{add}} || Initiale Version |}“)
 
 
(11 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
 +
<div class="noautonum">__TOC__</div>
 +
==WICHTIG für ein Update auf die Version 2==
 +
<div class="note">
 +
'''Anpassung der Anker:'''<br>
 +
NUR für den Fall, dass der Import bereits über die in dem sitekit-bol-form Modul integrierte XLS-Transformationsdatei erfolgt, müssen die folgenden Anpassungen durchgeführt werden. Das wäre der Fall, wenn in der Import-XML der Pfad zur XSLT-Datei auf die Datei in dem BOL-Modul verweist (zB: <code><xslt>${sitepark.home}/ies/modules/sitekit-bol-form.war/import/bolImport.xsl</xslt></code> )
 +
 +
Direkt NACH dem Update auf die Version 2 ist es nötig die Anker der importierten BOL-Formulare auf dem jeweiligen System zu korrigieren.<br />
 +
Grund: Das bis dato genutzte BOL-Attribut 'id' ist nicht eindeutig. Diese Eigenschaft besitzt aber das Attribute 'shortname'.
 +
 +
Die Korrektur der Anker kann direkt in die Datenbank eingespielt werden. Die nötigen SQL-Anweisungen können mit Hilfe der Import-Konfiguration generiert werden:
 +
<source lang="bash">
 +
iesxip  [BOL_IMPORT_CONFIG.xml] --dumpXml --xslt [SITEPARK_HOME]/ies/modules/sitekit-bol-form.war/import/convertAnchor.xsl
 +
# direkt in eine Datei
 +
iesxip  [BOL_IMPORT_CONFIG.xml] --dumpXml --xslt [SITEPARK_HOME]/ies/modules/sitekit-bol-form.war/import/convertAnchor.xsl > bolAnchorReplace.sql
 +
# Einspielen der anpassungen:
 +
mysql -u [DB-USER] -p[DB-PASSWORD] -h [DB-HOST]  [CLIENT]  <  bolAnchorReplace.sql
 +
</source>
 +
Anschließend muss das Repository des Mandanten über die IES-Admin Oberfläche neu geladen werden.
 +
</div>
 +
 +
==Einrichtung des Imports==
 +
<div class="notice">
 +
Die Einrichtung erfolgt entsprechend der IES-XIP Importdefinition. Hier ein Beispiel für die XML-Konfiguration. Beispiel:
 +
/srv/sitepark/bin/iesxip  /srv/sitepark/imports/bolImport/bolImport.xml
 +
Die Import Konfiguration <code>bolImport.xml</code> kann wie folgt aussehen:
 +
<source lang="xml">
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<import id="bol.form.import" name="BOL Formular-Import">
 +
    <!-- Angaben zum logging -->
 +
    <logging>
 +
        <appender name="FILE" class="org.apache.log4j.RollingFileAppender">
 +
            <layout class="org.apache.log4j.PatternLayout">
 +
                <param name="ConversionPattern" value="%d %-5p %m%n"/>
 +
            </layout>
 +
            <param name="File" value="${sitepark.home}/imports/bolImport/bolImport.log"/>
 +
            <param name="MaxFileSize" value="10MB"/>
 +
            <param name="MaxBackupIndex" value="1"/>
 +
        </appender>
 +
        <logger name="com.sitepark.ies" additivity="false">
 +
            <appender-ref ref="FILE"/>
 +
            <priority value="INFO"/>
 +
        </logger>
 +
    </logging>
 +
    <!-- IES-USER, mit dem die Daten importiert werden -->
 +
    <ies-connection login="[IMPORT-USER]" password="[IMPORT-USER-PASSWD]" client="[IMPORT-CLIENT]" module="sitekit-bol-form"/>
 +
    <options>
 +
        <!-- Konvertierung -->
 +
        <xslt>${sitepark.home}/ies/modules/sitekit-bol-form.war/import/bolImport.xsl</xslt>
 +
        <!-- Syncronisation -->
 +
        <syncFile>${sitepark.home}/imports/bolImport/bolImport.sync</syncFile>
 +
        <!-- Import-Attribute-->
 +
        <attributes>
 +
            <!-- Anker des Pools (hier für Modul-Inhalte), in dem die Daten eingespielt werden sollen -->
 +
            <attribute name="moduleContentPoolAnchor">internetwebsite.modulecontent</attribute>
 +
            <!-- Prefix für die Pool-Anker der Formular-Gruppen-->
 +
            <attribute name="formPoolAnchorPrefix">import.bol.forms</attribute>
 +
            <!-- Prefix für die Anker der Formulare -->
 +
            <attribute name="formAnchorPrefix">import.bol.form</attribute>
 +
            <!-- Publikationsbereiche, in denen die Formulare publiziert werden sollen -->
 +
            <attribute name="publisher">www,preview</attribute>
 +
            <!-- [treu], wenn NUR neue Formulare publiziert werden sollen. Bei Updates bleibt der Publikations-Status unverändert. -->
 +
            <attribute name="publishOnlyNew"></attribute>
 +
        </attributes>
 +
    </options>
 +
    <source type="http" url="https://[BOL-FORMULAR-SERVER]/jfs/getdocumentlistxml" method="get"/>
 +
</import>
 +
</source>
 +
</div>
 +
 +
 
==Changelog==
 
==Changelog==
 +
===2.2.0 (27.11.2023)===
 +
{|
 +
| style="vertical-align:top;" | {{fix}} || Ladereihenfolge macht Probleme
 +
|}
 +
===2.1 (26.11.2019)===
 +
{|
 +
| style="vertical-align:top;" | {{add}} || Die weitere Felder &#039;agentName&#039; und &#039;articleUrl&#039; zum Anhängen an den BOL-Formular-Aufrufen ergänzt.
 +
|}
 +
===2.0.2 (17.10.2019)===
 +
{|
 +
| style="vertical-align:top;" | {{fix}} || Die Formulare werden auf eine Fehlerseite weitergleitet.
 +
|}
 +
===2.0.1 (23.09.2019)===
 +
{|
 +
| style="vertical-align:top;" | {{add}} || NUR Formulare, die NEU importiert werden sollen direkt frei gegeben werden.
 +
|}
 +
===2.0 (23.09.2019)===
 +
{|
 +
| style="vertical-align:top;" | {{update}} || Anpassung des eineindeutigen Import-Identifier von dem BOL-Attribut &#039;id&#039; auf das laut BOL eineindeutige Attribut &#039;shortname&#039;
 +
|}
 +
===1.4 (08.08.2019)===
 +
{|
 +
| style="vertical-align:top;" | {{update}} || Anpassungen für SiteKit-Kompabilität
 +
|}
 +
===1.3 (26.07.2019)===
 +
{|
 +
| style="vertical-align:top;" | {{add}} || UrlWriter-Funktion für BolForm-Redirect-Plugin
 +
|-
 +
| style="vertical-align:top;" | {{add}} || Formulare als Link-Dialog-Root
 +
|}
 +
===1.2 (13.06.2019)===
 +
{|
 +
| style="vertical-align:top;" | {{update}} || Parameter und Hook nur bei Verknüpfungen auf ein Formular anzeigen
 +
|}
 +
===1.1 (07.06.2019)===
 +
{|
 +
| style="vertical-align:top;" | {{fix}} || Links auf BOL-Formulare werden nicht als externe Links dargestellt
 +
|}
 
===1.0 (03.06.2019)===
 
===1.0 (03.06.2019)===
 
{|
 
{|
 
| style="vertical-align:top;" | {{add}} || Initiale Version
 
| style="vertical-align:top;" | {{add}} || Initiale Version
 
|}
 
|}

Aktuelle Version vom 27. November 2023, 14:56 Uhr

WICHTIG für ein Update auf die Version 2

Anpassung der Anker:
NUR für den Fall, dass der Import bereits über die in dem sitekit-bol-form Modul integrierte XLS-Transformationsdatei erfolgt, müssen die folgenden Anpassungen durchgeführt werden. Das wäre der Fall, wenn in der Import-XML der Pfad zur XSLT-Datei auf die Datei in dem BOL-Modul verweist (zB: <xslt>${sitepark.home}/ies/modules/sitekit-bol-form.war/import/bolImport.xsl</xslt> )

Direkt NACH dem Update auf die Version 2 ist es nötig die Anker der importierten BOL-Formulare auf dem jeweiligen System zu korrigieren.
Grund: Das bis dato genutzte BOL-Attribut 'id' ist nicht eindeutig. Diese Eigenschaft besitzt aber das Attribute 'shortname'.

Die Korrektur der Anker kann direkt in die Datenbank eingespielt werden. Die nötigen SQL-Anweisungen können mit Hilfe der Import-Konfiguration generiert werden:

iesxip  [BOL_IMPORT_CONFIG.xml] --dumpXml --xslt [SITEPARK_HOME]/ies/modules/sitekit-bol-form.war/import/convertAnchor.xsl
# direkt in eine Datei
iesxip  [BOL_IMPORT_CONFIG.xml] --dumpXml --xslt [SITEPARK_HOME]/ies/modules/sitekit-bol-form.war/import/convertAnchor.xsl > bolAnchorReplace.sql
# Einspielen der anpassungen:
mysql -u [DB-USER] -p[DB-PASSWORD] -h [DB-HOST]  [CLIENT]  <  bolAnchorReplace.sql

Anschließend muss das Repository des Mandanten über die IES-Admin Oberfläche neu geladen werden.

Einrichtung des Imports

Die Einrichtung erfolgt entsprechend der IES-XIP Importdefinition. Hier ein Beispiel für die XML-Konfiguration. Beispiel:

/srv/sitepark/bin/iesxip  /srv/sitepark/imports/bolImport/bolImport.xml

Die Import Konfiguration bolImport.xml kann wie folgt aussehen:

<?xml version="1.0" encoding="UTF-8"?>
<import id="bol.form.import" name="BOL Formular-Import">
    <!-- Angaben zum logging -->
    <logging>
        <appender name="FILE" class="org.apache.log4j.RollingFileAppender">
            <layout class="org.apache.log4j.PatternLayout">
                <param name="ConversionPattern" value="%d %-5p %m%n"/>
            </layout>
            <param name="File" value="${sitepark.home}/imports/bolImport/bolImport.log"/>
            <param name="MaxFileSize" value="10MB"/>
            <param name="MaxBackupIndex" value="1"/>
        </appender>
        <logger name="com.sitepark.ies" additivity="false">
            <appender-ref ref="FILE"/>
            <priority value="INFO"/>
        </logger>
    </logging>
    <!-- IES-USER, mit dem die Daten importiert werden -->
    <ies-connection login="[IMPORT-USER]" password="[IMPORT-USER-PASSWD]" client="[IMPORT-CLIENT]" module="sitekit-bol-form"/>
    <options>
        <!-- Konvertierung -->
        <xslt>${sitepark.home}/ies/modules/sitekit-bol-form.war/import/bolImport.xsl</xslt>
        <!-- Syncronisation -->
        <syncFile>${sitepark.home}/imports/bolImport/bolImport.sync</syncFile>
        <!-- Import-Attribute-->
        <attributes>
            <!-- Anker des Pools (hier für Modul-Inhalte), in dem die Daten eingespielt werden sollen -->
            <attribute name="moduleContentPoolAnchor">internetwebsite.modulecontent</attribute>
            <!-- Prefix für die Pool-Anker der Formular-Gruppen-->
            <attribute name="formPoolAnchorPrefix">import.bol.forms</attribute>
            <!-- Prefix für die Anker der Formulare -->
            <attribute name="formAnchorPrefix">import.bol.form</attribute>
            <!-- Publikationsbereiche, in denen die Formulare publiziert werden sollen -->
            <attribute name="publisher">www,preview</attribute>
            <!-- [treu], wenn NUR neue Formulare publiziert werden sollen. Bei Updates bleibt der Publikations-Status unverändert. -->
            <attribute name="publishOnlyNew"></attribute>
        </attributes>
    </options>
    <source type="http" url="https://[BOL-FORMULAR-SERVER]/jfs/getdocumentlistxml" method="get"/>
</import>


Changelog

2.2.0 (27.11.2023)

Korrgierter Fehler Ladereihenfolge macht Probleme

2.1 (26.11.2019)

Neue Funktion / Neues Feature Die weitere Felder 'agentName' und 'articleUrl' zum Anhängen an den BOL-Formular-Aufrufen ergänzt.

2.0.2 (17.10.2019)

Korrgierter Fehler Die Formulare werden auf eine Fehlerseite weitergleitet.

2.0.1 (23.09.2019)

Neue Funktion / Neues Feature NUR Formulare, die NEU importiert werden sollen direkt frei gegeben werden.

2.0 (23.09.2019)

Geänderte Funktion / Geändertes Feature Anpassung des eineindeutigen Import-Identifier von dem BOL-Attribut 'id' auf das laut BOL eineindeutige Attribut 'shortname'

1.4 (08.08.2019)

Geänderte Funktion / Geändertes Feature Anpassungen für SiteKit-Kompabilität

1.3 (26.07.2019)

Neue Funktion / Neues Feature UrlWriter-Funktion für BolForm-Redirect-Plugin
Neue Funktion / Neues Feature Formulare als Link-Dialog-Root

1.2 (13.06.2019)

Geänderte Funktion / Geändertes Feature Parameter und Hook nur bei Verknüpfungen auf ein Formular anzeigen

1.1 (07.06.2019)

Korrgierter Fehler Links auf BOL-Formulare werden nicht als externe Links dargestellt

1.0 (03.06.2019)

Neue Funktion / Neues Feature Initiale Version