Skip to content

Commit

Permalink
produkt setup and descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
ivy-bb committed Aug 23, 2024
1 parent 6031cff commit 25452fa
Show file tree
Hide file tree
Showing 129 changed files with 2,901 additions and 46 deletions.
17 changes: 17 additions & 0 deletions .project
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>jsf-form-archive-util-modules</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>org.eclipse.m2e.core.maven2Builder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.eclipse.m2e.core.maven2Nature</nature>
</natures>
</projectDescription>
4 changes: 4 additions & 0 deletions .settings/org.eclipse.m2e.core.prefs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
activeProfiles=
eclipse.preferences.version=1
resolveWorkspaceProjects=true
version=1
32 changes: 0 additions & 32 deletions MY-PRODUCT-NAME-product/README.md

This file was deleted.

8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# MY-PRODUCT-NAME
# JSF Form Archive Utility

[![CI Build](https://github.com/axonivy-market/REPO-NAME/actions/workflows/ci.yml/badge.svg)](https://github.com/axonivy-market/REPO-NAME/actions/workflows/ci.yml)
[![CI Build](https://github.com/axonivy-market/jsf-formarchive-util/actions/workflows/ci.yml/badge.svg)](https://github.com/axonivy-market/jsf-formarchive-util/actions/workflows/ci.yml)

"YOUR SHORT DESCRIPTION GOES HERE"
This utility adds a snapshot of submitted jsf dialogs to case documents.

Read our [documentation](MY-PRODUCT-NAME-product/README.md).
Read our [documentation](jsf-form-archive-util-product/README.md).
30 changes: 30 additions & 0 deletions jsf-form-archive-util-product/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!--
Dear developer!
When you create your very valuable documentation, please be aware that this Readme.md is not only published on github. This documentation is also processed automatically and published on our website. For this to work, the two headings "Demo" and "Setup" must not be changed
-->

# JSF Form Archive Utility

This utility adds a snapshot of submitted jsf dialog froms to case documents.



## Demo

Just submit the form and you will find a snapshot of the form in the case documents on the case detail page.



## Setup

To make use of this utility you have to adapt the "submit" commandButton in the dialogs in your process that you want to have archived.
Change the default commandButton, that may look like
```
<p:commandButton actionListener="#{logic.close}" value="Proceed" update="form" icon="pi pi-check" />
```
to
```
<p:commandButton oncomplete="if(!args.validationFailed){saveCanvas()}" value="Proceed" />
<ui:include src="/includes/save-canvas.xhtml" />
```
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.axonivy.market</groupId>
<artifactId>MY-PRODUCT-NAME-product</artifactId>
<groupId>com.axonivy.utils.jsfformarchive</groupId>
<artifactId>jsf-form-archive-util-product</artifactId>
<version>10.0.0-SNAPSHOT</version>
<packaging>pom</packaging>

<properties>
<variables.yaml.file>../MY-PRODUCT-NAME/config/variables.yaml</variables.yaml.file>
<variables.yaml.file>../jsf-form-archive-util/config/variables.yaml</variables.yaml.file>
</properties>

<build>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"data": {
"projects": [
{
"groupId": "MY-GROUP-ID",
"artifactId": "MY-PRODUCT-NAME-demo",
"groupId": "com.axonivy.utils.jsfformarchive",
"artifactId": "jsf-form-archive-util-demo",
"version": "${version}",
"type": "iar"
}
Expand All @@ -28,8 +28,8 @@
"data": {
"dependencies": [
{
"groupId": "MY-GROUP-ID",
"artifactId": "MY-PRODUCT-NAME",
"groupId": "com.axonivy.utils.jsfformarchive",
"artifactId": "jsf-form-archive-util",
"version": "${version}",
"type": "iar"
}
Expand All @@ -50,8 +50,8 @@
"data": {
"dependencies": [
{
"groupId": "MY-GROUP-ID",
"artifactId": "MY-PRODUCT-NAME",
"groupId": "com.axonivy.utils.jsfformarchive",
"artifactId": "jsf-form-archive-uti",
"version": "${version}"
}
],
Expand Down
File renamed without changes.
40 changes: 40 additions & 0 deletions jsf-form-archive-util-test/.classpath
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
<classpathentry kind="src" path="src">
<attributes>
<attribute name="optional" value="true"/>
</attributes>
</classpathentry>
<classpathentry excluding="**/*.ivyClass|**/*.p.json|**/*.rddescriptor|**/*.xhtml" kind="src" path="src_hd">
<attributes>
<attribute name="optional" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="src" path="src_wsproc">
<attributes>
<attribute name="optional" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="src" path="src_dataClasses">
<attributes>
<attribute name="optional" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
<attributes>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
<classpathentry exported="true" kind="con" path="IVY_CONTAINER"/>
<classpathentry kind="con" path="WEBAPP_CONTAINER"/>
<classpathentry kind="con" path="org.eclipse.jst.j2ee.internal.web.container"/>
<classpathentry kind="src" output="target/test-classes" path="src_test">
<attributes>
<attribute name="optional" value="true"/>
<attribute name="maven.pomderived" value="true"/>
<attribute name="test" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="output" path="target/classes"/>
</classpath>
19 changes: 19 additions & 0 deletions jsf-form-archive-util-test/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# general
Thumbs.db
.DS_Store
*~
*.log

# java
*.class
hs_err_pid*

# maven
target/
lib/mvn-deps/

# ivy
classes/
src_dataClasses/
src_wsproc/
logs/
49 changes: 49 additions & 0 deletions jsf-form-archive-util-test/.project
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>jsf-form-archive-util-test</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>ch.ivyteam.ivy.designer.dataClasses.ui.ivyDataClassBuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>ch.ivyteam.ivy.designer.process.ui.ivyWebServiceProcessClassBuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.jdt.core.javabuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.wst.common.project.facet.core.builder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>ch.ivyteam.ivy.designer.ide.ivyModelValidationBuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.m2e.core.maven2Builder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>ch.ivyteam.ivy.project.IvyProjectNature</nature>
<nature>org.eclipse.wst.common.modulecore.ModuleCoreNature</nature>
<nature>org.eclipse.jem.workbench.JavaEMFNature</nature>
<nature>org.eclipse.jdt.core.javanature</nature>
<nature>org.eclipse.m2e.core.maven2Nature</nature>
<nature>org.eclipse.jem.beaninfo.BeanInfoNature</nature>
<nature>org.eclipse.wst.common.project.facet.core.nature</nature>
<nature>org.eclipse.wst.jsdt.core.jsNature</nature>
</natures>
</projectDescription>
12 changes: 12 additions & 0 deletions jsf-form-archive-util-test/.settings/.jsdtscope
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
<classpathentry excluding="**/bower_components/*|**/node_modules/*|**/*.min.js" kind="src" path="webContent"/>
<classpathentry kind="con" path="org.eclipse.wst.jsdt.launching.JRE_CONTAINER"/>
<classpathentry kind="con" path="org.eclipse.wst.jsdt.launching.WebProject">
<attributes>
<attribute name="hide" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="con" path="org.eclipse.wst.jsdt.launching.baseBrowserLibrary"/>
<classpathentry kind="output" path=""/>
</classpath>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
ch.ivyteam.ivy.designer.preferences.DataClassPreferencePage\:DEFAULT_DATA_CLASS=jsf.form.archive.util.test.Data
ch.ivyteam.ivy.designer.preferences.DataClassPreferencePage\:DEFAULT_NAMESPACE=jsf.form.archive.util.test
ch.ivyteam.ivy.project.preferences\:PRIMEFACES_VERSION=11
ch.ivyteam.ivy.project.preferences\:PROJECT_VERSION=100000
eclipse.preferences.version=1
10 changes: 10 additions & 0 deletions jsf-form-archive-util-test/.settings/org.eclipse.jdt.core.prefs
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
eclipse.preferences.version=1
org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
org.eclipse.jdt.core.compiler.codegen.targetPlatform=17
org.eclipse.jdt.core.compiler.compliance=17
org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled
org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=warning
org.eclipse.jdt.core.compiler.release=enabled
org.eclipse.jdt.core.compiler.source=17
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?><project-modules id="moduleCoreId" project-version="1.5.0">

<wb-module deploy-name="jsf-form-archive-util-test">

<wb-resource deploy-path="/" source-path="/webContent" tag="defaultRootSource"/>

<wb-resource deploy-path="/WEB-INF/classes" source-path="/src"/>

<wb-resource deploy-path="/WEB-INF/classes" source-path="/src_hd"/>

<wb-resource deploy-path="/WEB-INF/classes" source-path="/src_wsproc"/>

<wb-resource deploy-path="/WEB-INF/classes" source-path="/src_dataClasses"/>

<wb-resource deploy-path="/WEB-INF/classes" source-path="/src_test"/>

<property name="java-output-path" value="/jsf-form-archive-util-test/target/classes"/>
<property name="context-root" value="jsf-form-archive-util-test"/>

</wb-module>

</project-modules>
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<root>
<facet id="jst.jsf">
<node name="libprov">
<attribute name="provider-id" value="jsf-user-library-provider"/>
</node>
</facet>
</root>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<faceted-project>
<fixed facet="wst.jsdt.web"/>
<installed facet="java" version="17"/>
<installed facet="jst.web" version="3.0"/>
<installed facet="wst.jsdt.web" version="1.0"/>
<installed facet="jst.jsf" version="2.1"/>
</faceted-project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
css-profile/<project>=org.eclipse.wst.css.core.cssprofile.css3
eclipse.preferences.version=1
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
org.eclipse.wst.jsdt.launching.baseBrowserLibrary
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Window
20 changes: 20 additions & 0 deletions jsf-form-archive-util-test/config/custom-fields.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# == Custom Fields Information ==
#
# You can define here your project custom fields.
# Have a look at our documentation for more information.
#
CustomFields:
# Tasks:
# MyTaskCustomField:
# Label: My task custom field
# Description: This new task custom field can be used to ...
# Type: STRING
# Cases:
# MyCaseCustomField:
# Label: My case custom field
# Description: This new case custom field can be used to ...
# Type: STRING
# Starts:
# MyStartCustomField:
# Label: My start custom field
# Description: This new start custom field can be used to ...
1 change: 1 addition & 0 deletions jsf-form-archive-util-test/config/databases.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Databases:
1 change: 1 addition & 0 deletions jsf-form-archive-util-test/config/overrides.any
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*
2 changes: 2 additions & 0 deletions jsf-form-archive-util-test/config/persistence.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<persistence xmlns="http://xmlns.jcp.org/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.2" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/persistence http://xmlns.jcp.org/xml/ns/persistence/persistence_2_2.xsd"/>
1 change: 1 addition & 0 deletions jsf-form-archive-util-test/config/rest-clients.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
RestClients:
4 changes: 4 additions & 0 deletions jsf-form-archive-util-test/config/roles.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<role>
<identifier>Everybody</identifier>
</role>
2 changes: 2 additions & 0 deletions jsf-form-archive-util-test/config/users.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<userConfig/>
9 changes: 9 additions & 0 deletions jsf-form-archive-util-test/config/variables.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# == Variables ==
#
# You can define here your project Variables.
# If you want to define/override a Variable for a specific Environment,
# add an additional ‘variables.yaml’ file in a subdirectory in the ‘Config’ folder:
# '<project>/Config/_<environment>/variables.yaml
#
Variables:
# myVariable: value
1 change: 1 addition & 0 deletions jsf-form-archive-util-test/config/webservice-clients.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
WebServiceClients:
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Data #class
jsf.form.archive.util.test #namespace
items String #field
items PERSISTENT #fieldModifier
amount Number #field
amount PERSISTENT #fieldModifier
Loading

0 comments on commit 25452fa

Please sign in to comment.