...

Po tych zmiana funkcja w PWE widoczna jest w następujący sposób:

Polish

Table of Contents

outline	true
style	none

Excerpt
Opis tworzenia własnych funkcji do wykorzystania w parametrach komponentów.

Projekt stworzonej wtyczki jest dostępny w publicznym repozytorium http://192.168.1.61/developers/tutorials. Skompilowana wersja do pobrania tutaj:

View file

name	functions-example-1.0.0.jar
height	150

Tip

title	Przydatne linki

Info
Zakładamy, że projekt wtyczki mamy już utworzony. Opis tworzenia wtyczki systemowej podany jest wyżej.

Wstęp

Kurs opisuje krok po kroku jak zarejestrować i stworzyć własną funkcję która będzie mogła być wykorzystywana w innych komponentach.

Jako przykład posłużą nam następujące funkcje:

nettoToBrutto - konwersja wartości netto do wartości brutto
invoiceBruttoValue - sumuje pozycje z faktury i oblicza końcową wartość brutto na fakturze

Note
Przedstawione implementacje funkcji są tylko przykładowe. Kompletne implementacje powinny jeszcze brać pod uwagę zaokrąglanie kwot itp.

Deskryptor wtyczki wygląda następująco:

Code Block

language	xml
title	suncode-plugin.xml

 <?xml version="1.0" encoding="UTF-8"?>
<plugin key="${project.groupId}-${project.artifactId}" name="Functions Examples">
	<!-- Udostępnianie tłumaczeń -->
	<i18n key="i18n" />
	<!-- Udostępnianie funkcji -->
	<functions key="functions" />
</plugin>

Implementacja Java

Rozpocząć należy od przygotowania definicji funkcji i jej zarejestrowaniu. Funkcje definiujemy w klasie oznaczonej adnotacją

Javadoc

displayValue	@Functions
property	javadoc.plusworkflow
className	com.suncode.pwfl.core.function.annotation.Functions

. Dodatkowo musimy zdefiniować adnotację

Javadoc

displayValue	@FunctionsScript
property	javadoc.plusworkflow
className	com.suncode.pwfl.core.function.annotation.FunctionsScript

aby wskazać gdzie znajdować się będzie implementacja naszej funkcji w języku JavaScript.

Note
Parametry tablicowe przekazywane do funkcji muszą być obiektami (tj. Integer[], Long[]) - nie należy przekazywać prymitywów (tj. long[]. int[]) z uwagi na obsługę możliwej wartości null.

Code Block

language	java
title	InvoiceFunctions.java

package com.suncode.tutorial.fnexample;


import com.suncode.pwfl.core.function.annotation.Function;
import com.suncode.pwfl.core.function.annotation.Functions;
import com.suncode.pwfl.core.function.annotation.FunctionsScript;

/**
 * Invoice functions
 */
@Functions
@FunctionsScript( "/functions/invoice-functions.js" )
public class InvoiceFunctions
{
    @Function
    public double nettoToBrutto( Double netto, Integer vat )
    {
        return netto.doubleValue() * ( 1 + vat.intValue() / (double) 100 );
    }
    
	@Function
    public double invoiceBruttoValue( Double[] items, Integer[] vat )
    {
        double value = 0;
        for ( int i = 0; i < items.length; i++ )
        {
            value += nettoToBrutto( items[i], vat[i] );
        }
        return value;
    }
}

Każda z funkcji musi być oznaczona adnotacją

Javadoc

displayValue	@Function
property	javadoc.plusworkflow
className	com.suncode.pwfl.core.function.annotation.Function

. Nazwa funkcji domyślnie jest taka sama jak nazwa metody. Każda funkcja musi zwracać wynik typu podstawowego oraz parametry które również muszą być jednym z typów podstawowych.

Implementacja JavaScript

Aby funkcja mogła być również wykorzystywana np. do dynamicznych obliczeń na formularzu zadania konieczne jest dostarczenie implementacji takiej funkcji w języku JavaScript. Implementacja powinna znajdować się w pliku invoice-functions.js (w katalogu src/main/resources/functions/) tak jak wskazano w adnotacji @FunctionsScript:

Code Block

language	js
title	invoice-functions.js

 /**
 * Netto value to brutto with given VAT
 */
PW.Functions.register("nettoToBrutto", "float", ["float", "integer"], function(netto, vat){
	return nettoToBrutto(netto, vat);
});

/**
 * Sum of invoice items brutto value
 */
PW.Functions.register("invoiceBruttoValue", "float", ["float[]", "integer[]"], function(items, vat){
	
	var value = 0;
    for ( var i = 0; i < items.length; i++ )
    {
        value += nettoToBrutto( items[i], vat[i] );
    }
    return value;
});

function nettoToBrutto(netto, vat){
	return netto * ( 1 + vat / 100 );
}

Implementacja w JavaScript musi zachowywać taką samą logikę wykonania obliczeń.

Tłumaczenie funkcji

Funkcje stworzone dotychczas nie posiadają żadnych dodatkowych danych jak np. opis funkcji czy parametrów. Aby dostarczyć więcej informacji należy przygotować tłumaczenie funkcji.

Do tego momentu stworzona funkcja invoiceBruttoValue w edytorze procesów wyglądała by następująco:

Image Added

Opis funkcji i informacje o parametrach zostaną wyświetlone, jeżeli będzie istniał odpowiedni klucz wiadomości zgodnie z Internacjonalizacja (I18N). W tym celu musimy stworzyć plik messages.properties (dodatkowo możemy stworzyć pliki dla innych wspieranych języków). W pliku tym należy umieścić klucze budowane zgodnie z zasadami:

Tłumaczony element Szablon

Opis funkcji

function.<name>

gdzie

<name> - nazwa funkcji

Nazwa parametru

function.<name>.param.<paramName>.name

gdzie

<name> - nazwa funkcji
<paramName> nazwa parametru

Opis parametru

function.<name>.param.<paramName>.desc

gdzie

<name> - nazwa funkcji
<paramName> nazwa parametru

Stosując te zasady plik messages.properties będzie wyglądał na przykład tak:

Code Block

title	messages.properties

function.nettoToBrutto=Oblicze kwotę brutto z podanej kwoty netto i stawki VAT
function.nettoToBrutto.param.netto.name=Kwota netto
function.nettoToBrutto.param.vat.name=VAT
function.nettoToBrutto.param.vat.desc=Stawka vat np. 23 dla 23%
function.invoiceBruttoValue=Oblicze kwotę brutto na fakturze
function.invoiceBruttoValue.param.items.name=Kwoty netto
function.invoiceBruttoValue.param.items.desc=Tablica pozycji z kwotami netto
function.invoiceBruttoValue.param.vat.name=Stawki VAT
function.invoiceBruttoValue.param.vat.desc=Tablica stawek VAT np. [23,7] jeżeli pierwsza pozycja obarczona jest stawką 23% a druga 7%

Tip

Możliwe jest też dokładniejsze tłumaczenie konkretnych przeciążeń funkcji o tej samej nazwie. W tym celu do nazwy funkcji należy dodać typy prametrów oddzielone podkreślnikiem (_) np:

Code Block
function.nettoToBrutto=Kwota netto do brutto function.nettoToBrutto.param.netto.name=Kwota netto function.nettoToBrutto.param.vat.name=Stawka vat

może być zapisane w postaci function.nettoToBrutto_float_integer ponieważ funkcja nettoToBrutto ma parametry typów float i integer (nazwy typów z Wbudowane typy)

Code Block
function.nettoToBrutto_float_integer=Kwota netto do brutto function.nettoToBrutto_float_integer.param.netto.name=Kwota netto function.nettoToBrutto_float_integer.param.vat.name=Stawka vat

Po tych zmiana funkcja w PWE widoczna jest w następujący sposób:

Image Added

English

Table of Contents

outline	true
style	none

Excerpt
Opis tworzenia własnych funkcji do wykorzystania w parametrach komponentów.

Projekt stworzonej wtyczki jest dostępny w publicznym repozytorium http://192.168.1.61/developers/tutorials. Skompilowana wersja do pobrania tutaj:

View file

name	functions-example-1.0.0.jar
height	150

Tip

title	Przydatne linki

Info
Zakładamy, że projekt wtyczki mamy już utworzony. Opis tworzenia wtyczki systemowej podany jest wyżej.

Wstęp

Kurs opisuje krok po kroku jak zarejestrować i stworzyć własną funkcję która będzie mogła być wykorzystywana w innych komponentach.

Jako przykład posłużą nam następujące funkcje:

nettoToBrutto - konwersja wartości netto do wartości brutto
invoiceBruttoValue - sumuje pozycje z faktury i oblicza końcową wartość brutto na fakturze

Note
Przedstawione implementacje funkcji są tylko przykładowe. Kompletne implementacje powinny jeszcze brać pod uwagę zaokrąglanie kwot itp.

Deskryptor wtyczki wygląda następująco:

Code Block

language	xml
title	suncode-plugin.xml

 <?xml version="1.0" encoding="UTF-8"?>
<plugin key="${project.groupId}-${project.artifactId}" name="Functions Examples">
	<!-- Udostępnianie tłumaczeń -->
	<i18n key="i18n" />
	<!-- Udostępnianie funkcji -->
	<functions key="functions" />
</plugin>

Implementacja Java

Rozpocząć należy od przygotowania definicji funkcji i jej zarejestrowaniu. Funkcje definiujemy w klasie oznaczonej adnotacją

Javadoc

displayValue	@Functions
property	javadoc.plusworkflow
className	com.suncode.pwfl.core.function.annotation.Functions

. Dodatkowo musimy zdefiniować adnotację

Javadoc

displayValue	@FunctionsScript
property	javadoc.plusworkflow
className	com.suncode.pwfl.core.function.annotation.FunctionsScript

aby wskazać gdzie znajdować się będzie implementacja naszej funkcji w języku JavaScript.

Note
Parametry tablicowe przekazywane do funkcji muszą być obiektami (tj. Integer[], Long[]) - nie należy przekazywać prymitywów (tj. long[]. int[]) z uwagi na obsługę możliwej wartości null.

Code Block

language	java
title	InvoiceFunctions.java

package com.suncode.tutorial.fnexample;


import com.suncode.pwfl.core.function.annotation.Function;
import com.suncode.pwfl.core.function.annotation.Functions;
import com.suncode.pwfl.core.function.annotation.FunctionsScript;

/**
 * Invoice functions
 */
@Functions
@FunctionsScript( "/functions/invoice-functions.js" )
public class InvoiceFunctions
{
    @Function
    public double nettoToBrutto( Double netto, Integer vat )
    {
        return netto.doubleValue() * ( 1 + vat.intValue() / (double) 100 );
    }
    
	@Function
    public double invoiceBruttoValue( Double[] items, Integer[] vat )
    {
        double value = 0;
        for ( int i = 0; i < items.length; i++ )
        {
            value += nettoToBrutto( items[i], vat[i] );
        }
        return value;
    }
}

Każda z funkcji musi być oznaczona adnotacją

Javadoc

displayValue	@Function
property	javadoc.plusworkflow
className	com.suncode.pwfl.core.function.annotation.Function

. Nazwa funkcji domyślnie jest taka sama jak nazwa metody. Każda funkcja musi zwracać wynik typu podstawowego oraz parametry które również muszą być jednym z typów podstawowych.

Implementacja JavaScript

Aby funkcja mogła być również wykorzystywana np. do dynamicznych obliczeń na formularzu zadania konieczne jest dostarczenie implementacji takiej funkcji w języku JavaScript. Implementacja powinna znajdować się w pliku invoice-functions.js (w katalogu src/main/resources/functions/) tak jak wskazano w adnotacji @FunctionsScript:

Code Block

language	js
title	invoice-functions.js

 /**
 * Netto value to brutto with given VAT
 */
PW.Functions.register("nettoToBrutto", "float", ["float", "integer"], function(netto, vat){
	return nettoToBrutto(netto, vat);
});

/**
 * Sum of invoice items brutto value
 */
PW.Functions.register("invoiceBruttoValue", "float", ["float[]", "integer[]"], function(items, vat){
	
	var value = 0;
    for ( var i = 0; i < items.length; i++ )
    {
        value += nettoToBrutto( items[i], vat[i] );
    }
    return value;
});

function nettoToBrutto(netto, vat){
	return netto * ( 1 + vat / 100 );
}

Implementacja w JavaScript musi zachowywać taką samą logikę wykonania obliczeń.

Tłumaczenie funkcji

Funkcje stworzone dotychczas nie posiadają żadnych dodatkowych danych jak np. opis funkcji czy parametrów. Aby dostarczyć więcej informacji należy przygotować tłumaczenie funkcji.

Do tego momentu stworzona funkcja invoiceBruttoValue w edytorze procesów wyglądała by następująco:

Image Added

Opis funkcji i informacje o parametrach zostaną wyświetlone, jeżeli będzie istniał odpowiedni klucz wiadomości zgodnie z Internacjonalizacja (I18N). W tym celu musimy stworzyć plik messages.properties (dodatkowo możemy stworzyć pliki dla innych wspieranych języków). W pliku tym należy umieścić klucze budowane zgodnie z zasadami:

Tłumaczony element Szablon

Opis funkcji

function.<name>

gdzie

<name> - nazwa funkcji

Nazwa parametru

function.<name>.param.<paramName>.name

gdzie

<name> - nazwa funkcji
<paramName> nazwa parametru

Opis parametru

function.<name>.param.<paramName>.desc

gdzie

<name> - nazwa funkcji
<paramName> nazwa parametru

Stosując te zasady plik messages.properties będzie wyglądał na przykład tak:

Code Block

title	messages.properties

function.nettoToBrutto=Oblicze kwotę brutto z podanej kwoty netto i stawki VAT
function.nettoToBrutto.param.netto.name=Kwota netto
function.nettoToBrutto.param.vat.name=VAT
function.nettoToBrutto.param.vat.desc=Stawka vat np. 23 dla 23%
function.invoiceBruttoValue=Oblicze kwotę brutto na fakturze
function.invoiceBruttoValue.param.items.name=Kwoty netto
function.invoiceBruttoValue.param.items.desc=Tablica pozycji z kwotami netto
function.invoiceBruttoValue.param.vat.name=Stawki VAT
function.invoiceBruttoValue.param.vat.desc=Tablica stawek VAT np. [23,7] jeżeli pierwsza pozycja obarczona jest stawką 23% a druga 7%

Tip

Możliwe jest też dokładniejsze tłumaczenie konkretnych przeciążeń funkcji o tej samej nazwie. W tym celu do nazwy funkcji należy dodać typy prametrów oddzielone podkreślnikiem (_) np:

Code Block
function.nettoToBrutto=Kwota netto do brutto function.nettoToBrutto.param.netto.name=Kwota netto function.nettoToBrutto.param.vat.name=Stawka vat

może być zapisane w postaci function.nettoToBrutto_float_integer ponieważ funkcja nettoToBrutto ma parametry typów float i integer (nazwy typów z Wbudowane typy)

Code Block
function.nettoToBrutto_float_integer=Kwota netto do brutto function.nettoToBrutto_float_integer.param.netto.name=Kwota netto function.nettoToBrutto_float_integer.param.vat.name=Stawka vat

Po tych zmiana funkcja w PWE widoczna jest w następujący sposób:

Image Added

Versions Compared

Old Version 9

New Version 10

Key

Wstęp

Implementacja Java

Implementacja JavaScript

Tłumaczenie funkcji

Wstęp

Implementacja Java

Implementacja JavaScript

Tłumaczenie funkcji

Page History

Versions Compared

Old Version 9

New Version 10

Key

Wstęp

Implementacja Java

Implementacja JavaScript

Tłumaczenie funkcji

Wstęp

Implementacja Java

Implementacja JavaScript

Tłumaczenie funkcji