Migration from 4.3.5 to 5.0.9

[samir.ha...@gmail.com]

Hi all,

First of all, thanks for the awesome work.

I had an IZpack project in version 4.3.5 and we wanted to migrate to the latest version.

I will put here all my questions and remarks.

izpack-maven-plugin

1) I had a lot of trouble building the new izpack-maven-plugin. When I was doing a clean and build I always had "cannot find org.icepdf.os:icepdf-core jar.

From what I understood, IcePDF is used for the PDF license panel but apparently Icepdf doesn't publish its jar into the official repository. Thus the error. What don't you mention that in the migration page?
My solution was to add in my pom.xml, both in my plugin and dependencies below this :

<dependencies>
                    <dependency>
                        <groupId>org.codehaus.izpack</groupId>
                        <artifactId>izpack-panel</artifactId>
                        <version>${izpack.version}</version>
                        <exclusions>
                            <exclusion>
                                <groupId>org.icepdf.os</groupId>
                                <artifactId>icepdf-core</artifactId>
                            </exclusion>
                            <exclusion>
                                <groupId>org.icepdf.os</groupId>
                                <artifactId>icepdf-viewer</artifactId>
                            </exclusion>
                        </exclusions>
                    </dependency>
                </dependencies>

2) I looked over this page : https://izpack.atlassian.net/wiki/display/IZPACK/IzPack+Maven+Plugin+Reference
Where can I find the page for the 4.3.5 plugin? Because I have some configuration properties and I don't really know what is the new property.
For example I had :

<installerFile>${project.build.directory}/${project.build.finalName}-standard.jar</installerFile>

I now have (If I'm not mistaken) :

<finalName>${project.build.finalName}-standard.jar</finalName>
<outputDirectory>${project.build.directory}</outputDirectory>

But I also had :

<descriptorEncoding>UTF-8</descriptorEncoding>

And I cannot find any property corresponding to this one.. Normal?

Migration :
On the migration page : https://izpack.atlassian.net/wiki/display/IZPACK/Upgrading+Existing+Installers+from+IzPack+4.x+to+5.0

You are saying that
Specification of the schemas is currently optional
Well I tried to build without touching a thing and that didn't work so I have to replace my

<processing>

by

<izpack:processing version="5.0"
                   xmlns:izpack="http://izpack.org/schema/processing"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xsi:schemaLocation="http://izpack.org/schema/processing http://izpack.org/schema/5.0/izpack-processing-5.0.xsd">

Also note in that page, you wrote

<izpack:userInput

but I think it's wrong and it should be :
<izpack:userinput

because I have an error otherwise.

I also noted that one custom panel that has a directory chooser was optional and it isn't now. But I think I have to dig on my own and toggle a property somewhere.

Best regards,
Sam'

[René Krell]

Hi Sam,

Dne středa 13. července 2016 17:59:21 UTC+2 samir.hadzic.pro napsal(a):

This has been already discussed, for example in this thread and in JIRA issue IZPACK-1426.

The above one is the worse workaround. For now, the better solution is to add the mentioned repository http://anonsvn.icesoft.org/repo/maven2/releases/ to your local settings.

This time, I opened a thread in the IceSoft forum asking them to deploy their OSS release artifacts to Maven Central.

In IZPACK-1426 there is also mentioned the new version 6.1.2, which is already available in Maven Central. This is a task to be done, the PDFLicencePanel must be tested with this new version. Then we can increase it and get rid of this whole inconveniency.

 

2) I looked over this page : https://izpack.atlassian.net/wiki/display/IZPACK/IzPack+Maven+Plugin+Reference
Where can I find the page for the 4.3.5 plugin?

There is no Maven plugin in IzPack 4, there has been just the standalone compiler. The Maven plugin has been introduced in IzPack 5.0.

 

Because I have some configuration properties and I don't really know what is the new property.
For example I had :

<installerFile>${project.build.directory}/${project.build.finalName}-standard.jar</installerFile>

I now have (If I'm not mistaken) :

<finalName>${project.build.finalName}-standard.jar</finalName>
<outputDirectory>${project.build.directory}</outputDirectory>

Right. 

 

But I also had :

<descriptorEncoding>UTF-8</descriptorEncoding>

And I cannot find any property corresponding to this one.. Normal?

This setting has been removed, UTF-8 is expected as the default encoding, if not defined otherwise in the XML header line. No need to have an additional setting/override for this. The XML parser does handle it on its own.

 

Migration :
On the migration page : https://izpack.atlassian.net/wiki/display/IZPACK/Upgrading+Existing+Installers+from+IzPack+4.x+to+5.0

You are saying that
Specification of the schemas is currently optional
Well I tried to build without touching a thing and that didn't work so I have to replace my

<processing>

by

<izpack:processing version="5.0"
                   xmlns:izpack="http://izpack.org/schema/processing"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xsi:schemaLocation="http://izpack.org/schema/processing http://izpack.org/schema/5.0/izpack-processing-5.0.xsd">

Also note in that page, you wrote

<izpack:userInput

but I think it's wrong and it should be :
<izpack:userinput

because I have an error otherwise.

You are true with this, has to be fixed in the documentation.

In particular, this has become relevant with IzPack 5.0.7, when there was introduced validating all XML descriptors the compiler knows against built-in XSDs. Before that, these elements could be called <blahblah> :-)

 

I also noted that one custom panel that has a directory chooser was optional and it isn't now. But I think I have to dig on my own and toggle a property somewhere.

This is the only point I don't have an answer to. No idea, what this meant.

 

Best regards,
Sam'

Good luck,

René

 

[samir.ha...@gmail.com]

Hi René,

Thank you very much for your quick response and for the clarification.

Sorry for my last point which was not clear. I had a Directory chooser field which was optional before and it was not now. But I looked over the documentation here (https://izpack.atlassian.net/wiki/display/IZPACK/Directory+Chooser+Field) and added the allowEmptyValue attribute in the spec tag, and now everything works fine :)

I'll keep you posted if I have some other trouble.
Regards,
Sam'

[René Krell]

Dne pátek 15. července 2016 11:09:49 UTC+2 samir.hadzic.pro napsal(a):

Hi René,

Thank you very much for your quick response and for the clarification.

Sorry for my last point which was not clear. I had a Directory chooser field which was optional before and it was not now. But I looked over the documentation here (https://izpack.atlassian.net/wiki/display/IZPACK/Directory+Chooser+Field) and added the allowEmptyValue attribute in the spec tag, and now everything works fine :)

I'll keep you posted if I have some other trouble.
Regards,
Sam'

I see.

You may improve the migration guide if you want, according to your experience. It is a wiki.

Feel free to grab a Confluence account and add your notes.

René

[samir.ha...@gmail.com]

Hi,

Few notes :
In Maven plugin, I used finalName tag like that :

 <finalName>${project.build.finalName}-standard.jar</finalName>

Apparently now, the ".jar" extension is added automatically right?

In Install.xml :
I copied a whole directory with subdirectories with the file tag :

<file override="true" src="./clients" targetdir="$INSTALL_PATH/" />

Apparently this is not working anymore, I had to use the fileset tag :

<fileset override="true" dir="./clients" targetdir="$INSTALL_PATH/clients" />

Do you agree with that? If so, I can add them in the Confluence migration page so that people won't be stuck a few hours like me ;)

Regards,
Sam'

[samir.ha...@gmail.com]

Also, I looked over the FileField documentation : https://izpack.atlassian.net/wiki/display/IZPACK/File+Chooser+Field

I tried to use the element "fileext" in order to restrict the possibility to ".lic" file (for license) but it's not working, do you know what I'm doing wrong?

<field type="file" align="left" variable="LICENSE_FILE">
            <spec txt="" size="25" set="" fileext=".lic"/>
        </field>

Regards,
Sam'

[René Krell]

Dne úterý 19. července 2016 16:04:08 UTC+2 samir.hadzic.pro napsal(a): 

 

... In Maven plugin, I used finalName tag like that:

 <finalName>${project.build.finalName}-standard.jar</finalName>

Apparently now, the ".jar" extension is added automatically right?

This is a subject to the Maven documentation itself.

The .jar extension shouldn't be used in the <finalname> tag, it is added automatically by Maven.

 

In Install.xml :
I copied a whole directory with subdirectories with the file tag :

<file override="true" src="./clients" targetdir="$INSTALL_PATH/" />

Apparently this is not working anymore, I had to use the fileset tag :

<fileset override="true" dir="./clients" targetdir="$INSTALL_PATH/clients" />

Do you agree with that? If so, I can add them in the Confluence migration page so that people won't be stuck a few hours like me ;)

 

I can't remember the <file> tag copied a whole directory, but in IzPack 5 it copies just a single file, see Adding or unpacking a single file to a target directory.

Maybe this has been true for some legacy version.

Otherwise you have to use filesets, right.

[René Krell]

Dne úterý 19. července 2016 16:26:03 UTC+2 samir.hadzic.pro napsal(a):

Also, I looked over the FileField documentation : https://izpack.atlassian.net/wiki/display/IZPACK/File+Chooser+Field

I tried to use the element "fileext" in order to restrict the possibility to ".lic" file (for license) but it's not working, do you know what I'm doing wrong?

<field type="file" align="left" variable="LICENSE_FILE">
            <spec txt="" size="25" set="" fileext=".lic"/>
        </field>

You must set both attributes, fileext and fileextdesc, to make this working for the file and directory chooser fields.

I will add an according note to the documentation.

Can you giv it a try?

[samir.ha...@gmail.com]

Hi René,

Thank you very much for your response.

Yes it did worked when I added the fileextdesc parameter together with the fileext parameter. Super!

I have another question for you, we use everyday the console installation process, and apparently (https://izpack.atlassian.net/projects/IZPACK/issues/IZPACK-841), the automatic installation process at the end in console mode cannot be generated. Do you know if it still the case in 5.X.X version of IzPack since this issue was supposed to be resolved in 4.3.5?

Regards,
Sam'

[René Krell]

Dne úterý 16. srpna 2016 11:43:01 UTC+2 samir.hadzic.pro napsal(a):

I have another question for you, we use everyday the console installation process, and apparently (https://izpack.atlassian.net/projects/IZPACK/issues/IZPACK-841), the automatic installation process at the end in console mode cannot be generated. Do you know if it still the case in 5.X.X version of IzPack since this issue was supposed to be resolved in 4.3.5?

This has been already solved in 5.0.x for more than 3 years beginning with version 5.0.0 RC1.

Just use FinishPanel and give it a try.

[samir.ha...@gmail.com]

Hi René,

I used the FinishPanel and it did offer me the possibility to download an automatic installation script. However, if I do the exact same thing in console mode, and in graphical mode, the "auto-install.xml" files generated at the end are not identical.

The one generated by the graphical interface has all the information given in it, for example :

<com.izforge.izpack.panels.userinput.UserInputPanel id="user0">
<entry key="LICENSE_FILE" value="C:\Users\samir.hadzic\Desktop\Shuttle-Install\license.lic"/>
</com.izforge.izpack.panels.userinput.UserInputPanel>

But the one generated in console mode has nothing regarding my inputs :

<com.izforge.izpack.panels.userinput.UserInputPanel id="user0"/>

Do I need to activate something in order to save the input in Console mode?

Also I noticed that I have a weird count during the installation :

[ Starting processing ]
Starting process Encode passwords (1/6)
Starting process Password encoding (2/6)
Starting process Encode passwords (3/6)
Starting process Password encoding (4/6)
Starting process Modify Setup FX (5/6)
Starting process ModifySetupFX (6/6)
Starting process Generate SHA Addin 32 (7/6)
Starting process SHA Generator (8/6)
Starting process Generate SHA Addin 64 (9/6)
Starting process SHA Generator (10/6)
Starting process Generate SHA FX (11/6)
Starting process SHA Generator (12/6)

Do I need to be careful in the naming in processPanelSpec.xml ? For example I have a password encoding job:

<job name="Encode passwords">
        <executeclass name="com.nellarmonia.installer.PasswordEncoding">
            <arg>${INSTALL_PATH}/config/config-template.xml</arg>
            <arg>${INSTALL_PATH}/config/config.xml</arg>
        </executeclass>
    </job>

And inside this java class I do :

public void run(AbstractUIProcessHandler handler, String[] args) {
        handler.startProcess("Password encoding");

Maybe I should not do this "startProcess"? Or do it but with the same name as the job?

Thank you again for your quick and precise replies!
Regards,
Sam'

[René Krell]

Dne úterý 16. srpna 2016 14:48:26 UTC+2 samir.hadzic.pro napsal(a):

I used the FinishPanel and it did offer me the possibility to download an automatic installation script. However, if I do the exact same thing in console mode, and in graphical mode, the "auto-install.xml" files generated at the end are not identical.

The one generated by the graphical interface has all the information given in it, for example :

<com.izforge.izpack.panels.userinput.UserInputPanel id="user0">
<entry key="LICENSE_FILE" value="C:\Users\samir.hadzic\Desktop\Shuttle-Install\license.lic"/>
</com.izforge.izpack.panels.userinput.UserInputPanel>

But the one generated in console mode has nothing regarding my inputs :

<com.izforge.izpack.panels.userinput.UserInputPanel id="user0"/>

Do I need to activate something in order to save the input in Console mode?

Typically not.

This will need more details. Is just this single user input field affected or are there more differences?

Is this reproducable in a short example, are there certain conditions bound to that field?

I would say you shouldn't call this method, because it is called by IzPack internally. To be honest it is not obvious to me why the method startProcess is public at all at the moment. There has been maybe a historical reason in some legacy version.

The name shown is normally the one specified in <job name="..." />.

[samir.ha...@gmail.com]

Hi,

I thought the startProcess was redundant so I removed it, I will test, I think it will do the job fine.

Regarding the auto-install.xml, all the fields are impacted. Basically, nothing that I have given in input is retained in the file. Except for the TargetPanel. In fact I have the feeling that everything given in UserInputPanel are not retained.
Here is a short example of my userInputSpec :

izpack:userinput version="5.0"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xmlns:izpack="http://izpack.org/schema/userinput"
                  xsi:schemaLocation="http://izpack.org/schema/userinput http://izpack.org/schema/5.0/izpack-userinput-5.0.xsd">
    <panel id="user0">
        <field type="title" txt="" bold="true" size="1" />
        <field type="divider" align="top"/>
        <field type="staticText" align="left" txt="License to import:"/>

        <field type="file" align="left" variable="LICENSE_FILE">

            <spec txt="" size="25" set="" fileext=".lic" fileextdesc=".lic"/>
        </field>
    </panel>
    <panel id="user1">
        <field type="title" txt="" bold="true" size="1" />
        <field type="divider" align="top"/>
        <!--    Tomcat Directory Selection  -->
        <field type="staticText" align="left" txt="Select Tomcat Directory:"/>
        <field type="dir" align="left" variable="TOMCAT_PATH">
            <spec txt="" size="25" set="" />
        </field>
    </panel>
    <panel id="user2">
        <field type="title" txt="" bold="true" size="1" />
        <field type="divider" align="top"/>
        <field type="staticText" align="left" txt="Name of the Web Application"/>
        <field type="text" variable="webapp.path">
            <spec txt="Path:" id="" size="50" set="${webapp.default.path}"/>
        </field>
        <field type="staticText" align="left" txt="Name of the Client Updater Web Application"/>
        <field type="text" variable="webapp.updater.path">
            <spec txt="Path:" id="" size="50" set="${webapp.updater.default.path}"/>
        </field>
    </panel>

I will try to reduce the code to the bare minimum and send that to you in order to help you reproduce the issue.

Regards,

[René Krell]

I'm afraid this is a bug. I can't see wrong definitions in the above snippet.

I'll try to reproduce this later.

 

Le mercredi 17 août 2016 09:20:06 UTC+2, René Krell a écrit :

Dne úterý 16. srpna 2016 14:48:26 UTC+2 samir.hadzic.pro napsal(a):

I used the FinishPanel and it did offer me the possibility to download an automatic installation script. However, if I do the exact same thing in console mode, and in graphical mode, the "auto-install.xml" files generated at the end are not identical.

The one generated by the graphical interface has all the information given in it, for example :

<com.izforge.izpack.panels.userinput.UserInputPanel id="user0">
<entry key="LICENSE_FILE" value="C:\Users\samir.hadzic\Desktop\Shuttle-Install\license.lic"/>
</com.izforge.izpack.panels.userinput.UserInputPanel>

But the one generated in console mode has nothing regarding my inputs :

<com.izforge.izpack.panels.userinput.UserInputPanel id="user0"/>

Do I need to activate something in order to save the input in Console mode?

Typically not.

This will need more details. Is just this single user input field affected or are there more differences?

Is this reproducable in a short example, are there certain conditions bound to that field?

 

...

[samir.ha...@gmail.com]

Hi,

Also I have another issue in console mode, I have the feeling that password must have a value in order to go to next panel. But it's not the case in graphical mode.
I've read the documentation on password and text for example :
https://izpack.atlassian.net/wiki/display/IZPACK/Password+Input+Field
https://izpack.atlassian.net/wiki/display/IZPACK/Text+Input+Field

If I defined a panel like that :

<panel id="user3">
        <field type="text" variable="REPOSITORY_USER">
            <spec txt="Database user name:" id="" size="50" set="" />
        </field>
        <field type="password" variable="REPOSITORY_PASSWORD">
            <spec>
                <pwd txt="Database password:" size="25" set=""/>
                <pwd txt="Retype password:" size="25" set=""/>
            </spec>
        </field>
    </panel>

If I do not type any username and I type only a password, I can go to next step. But the reverse is false.

Do you have any ideas on how to do that? Because I want to let the possibility to have a proxy, with a login/password. But if the user doesn't want a proxy at all, I don't want the password to be mandatory.

Also, on a side note, is it possible to have dynamic variable within the same panel? For example, the user change a value in a ComboBox or a Radio buttons, and the textField underneath changes? I know it's possible when from one panel to another but when everything is inside I don't think..

Regards,
Sam'

[René Krell]

Dne čtvrtek 18. srpna 2016 13:52:58 UTC+2 samir.hadzic.pro napsal(a):

Hi,

Also I have another issue in console mode, I have the feeling that password must have a value in order to go to next panel. But it's not the case in graphical mode.
I've read the documentation on password and text for example :
https://izpack.atlassian.net/wiki/display/IZPACK/Password+Input+Field
https://izpack.atlassian.net/wiki/display/IZPACK/Text+Input+Field

If I defined a panel like that :

<panel id="user3">
        <field type="text" variable="REPOSITORY_USER">
            <spec txt="Database user name:" id="" size="50" set="" />
        </field>
        <field type="password" variable="REPOSITORY_PASSWORD">
            <spec>
                <pwd txt="Database password:" size="25" set=""/>
                <pwd txt="Retype password:" size="25" set=""/>
            </spec>
        </field>
    </panel>

If I do not type any username and I type only a password, I can go to next step. But the reverse is false.

Do you have any ideas on how to do that? Because I want to let the possibility to have a proxy, with a login/password. But if the user doesn't want a proxy at all, I don't want the password to be mandatory.

Also, on a side note, is it possible to have dynamic variable within the same panel? For example, the user change a value in a ComboBox or a Radio buttons, and the textField underneath changes? I know it's possible when from one panel to another but when everything is inside I don't think..

Do you have a dedicated panel validator bound to that panel in the <panels> section in install.xml?

Does this behavior differ for the GUI and console mode, did I get this right?

What is the error shown if you can't continue?

[René Krell]

Dne čtvrtek 18. srpna 2016 18:00:33 UTC+2 René Krell napsal(a):

Dne čtvrtek 18. srpna 2016 13:52:58 UTC+2 samir.hadzic.pro napsal(a):

Also, on a side note, is it possible to have dynamic variable within the same panel? For example, the user change a value in a ComboBox or a Radio buttons, and the textField underneath changes? I know it's possible when from one panel to another but when everything is inside I don't think..

My previous answer was mentioned to be against the problem with the password field.

You can define a dynamic variable just globally. Assuming you mean the UserInputPanel, as soon as there is assigned a variable with the same name like a global variable to an user input field and the panel containing this field is reached during the installer execution while the field is not conditionally invisible, this global variable is blocked for any other change (refresh) as long as you don't press Previous at this panel and get back to its predecessor.

What you want to do is different and, good news, it is easily possible.

Just bind a condition to the value of your combo, radio, checkbox or whatever type of field. You can use this condition as field condition and the panel refreshes automatically in GUI mode depending on this setting. This way you can make a field conditionally visible/invisible, or just read-only. There is a couple of possibilities, see for example how to display panels and fields read-only, or use just the conditionid attribute of a field to control its visibility.

This is also implemented for the console installation mode. Due to the output of fields line by line there is no toggling of fields visible directly, though.

[René Krell]

Dne čtvrtek 18. srpna 2016 18:14:13 UTC+2 René Krell napsal(a):

This is the 3rd one to your last mail:

Now I saw, that you don't want to control the visibility, but the value of field.

This cannot be done within one and the same panel. The reason for this is blocking of variables from changing in background to prefer the values the user entered.

You can just affect dynamic variables in a predecessor of the panel using them, in whatever combination of conditions and dynamic variable definitions.

This is probably the complete and correct answer to your question.

[samir.ha...@gmail.com]

Hi,

Regarding the password field, I don't have a dedicated panel validator in my install.xml :

<panels>
        <panel classname="HTMLInfoPanel" id="info"/>
        <panel classname="TargetPanel"/>
        <panel classname="UserInputPanel" id="user0"/>
        <panel classname="UserInputPanel" id="user1"/>
        <panel classname="UserInputPanel" id="user2"/>
        <panel classname="UserInputPanel" id="user3"/>
        <panel classname="UserInputPanel" id="user4"/>
        <panel classname="UserInputPanel" id="user5"/>
        <panel classname="UserInputPanel" id="user6"/>
        <panel classname="UserInputPanel" id="user7"/>
        <panel classname="PacksPanel"/>
        <panel classname="InstallPanel"/>
        <panel classname="ProcessPanel"/>
        <panel classname="FinishPanel"/>
    </panels>

Yes the behavior differs from the GUI and the console mode. Basically, my userInputPanel looks like that :

 <panel id="user3">

        <field type="title" txt="" bold="true" size="1" />
        <field type="divider" align="top"/>

        <field type="text" variable="REPOSITORY_NAME">
            <spec txt="Repository name:" id="" size="50" set="default" />
        </field>
        <field type="text" variable="REPOSITORY_URL">
            <spec txt="Database URL:" id="" size="50" set="jdbc:mysql://localhost:3306/storage" />
        </field>

        <field type="text" variable="REPOSITORY_USER">
            <spec txt="Database user name:" id="" size="50" set="" />
        </field>
        <field type="password" variable="REPOSITORY_PASSWORD">
            <spec>
                <pwd txt="Database password:" size="25" set=""/>
                <pwd txt="Retype password:" size="25" set=""/>
            </spec>
        </field>
    </panel>

 
And it gives that in GUI :

http://imgur.com/Il3rjUs

Note that I can click on "next" without typing anything in GUI.

In console, I have that  picture if I press enter everytime (aka not typing anything like in GUI), but you can see that I do not have the option to go to next panel :
http://imgur.com/S53e9gK

So we have a different behavior for the same input.

Thanks for the explanation of dynamic variable. That's what I thought, I will try to implement what I want with that. It should work fine.

Regards,

[samir.ha...@gmail.com]

Hi René,

Did you had some time to look over the issue in Console mode? Regarding the install.xml generated at the end without the input and the password field blocking the workflow?

Regards,

[René Krell]

Dne středa 14. září 2016 14:50:30 UTC+2 samir.ha...@gmail.com napsal(a):

Hi René,

Did you had some time to look over the issue in Console mode? Regarding the install.xml generated at the end without the input and the password field blocking the workflow?

Regards,

To be honest, not.

I checked your example and can confirm this misbehavior in the console mode even in 5.0.10.

This is a clear bug, from my point of view.

Can you please raise a JIRA issue about this?

[samir.ha...@gmail.com]

Allright ,

I have created two distinct issues :
https://izpack.atlassian.net/browse/IZPACK-1447
https://izpack.atlassian.net/browse/IZPACK-1446

Regards,