You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit bec5b58
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/get-started/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ You define your integrations in XML configuration files. The framework loads the
31
31
</Adapter>
32
32
```
33
33
34
-
This creates an HTTP endpoint at `/api/hello` that responds with "Hello, World!".
34
+
This creates an HTTP endpoint at `/api/hello` that responds with "Hello, World!". See the [`FixedResultPipe` reference](https://reference.frankframework.org/#/Components/Pipes/FixedResultPipe) for all available attributes.
Copy file name to clipboardExpand all lines: docs/manual/configuration/basics.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,11 +75,11 @@ Each exit has a `name`, a `state` (SUCCESS or ERROR), and an HTTP response `code
75
75
76
76
## Pipes
77
77
78
-
Pipes are the processing units inside a pipeline. Each pipe has a `name` attribute and one or more `<Forward>` elements controlling flow.
78
+
Pipes are the processing units inside a pipeline. Each pipe has a `name` attribute and one or more `<Forward>` elements controlling flow. For a complete and up-to-date list of all available pipes and their attributes, see the [FF! Reference](https://reference.frankframework.org/#/components).
79
79
80
80
### EchoPipe
81
81
82
-
Returns its input unchanged, or a fixed value if `getInputFromFixedValue` is set.
82
+
Returns its input unchanged, or a fixed value if `getInputFromFixedValue` is set. See the [EchoPipe reference](https://reference.frankframework.org/#/Components/Pipes/EchoPipe) for all available attributes.
83
83
84
84
```xml
85
85
<EchoPipe
@@ -91,7 +91,7 @@ Returns its input unchanged, or a fixed value if `getInputFromFixedValue` is set
91
91
92
92
### XmlValidatorPipe
93
93
94
-
Validates the incoming XML message against an XSD schema.
94
+
Validates the incoming XML message against an XSD schema. See the [XmlValidatorPipe reference](https://reference.frankframework.org/#/Components/Pipes/XmlValidatorPipe) for all available attributes.
95
95
96
96
```xml
97
97
<XmlValidatorPipe
@@ -109,7 +109,7 @@ Validates the incoming XML message against an XSD schema.
109
109
110
110
### SenderPipe
111
111
112
-
Wraps a sender to communicate with external systems (databases, services, etc.).
112
+
Wraps a sender to communicate with external systems (databases, services, etc.). See the [SenderPipe reference](https://reference.frankframework.org/#/Components/Pipes/SenderPipe) for all available attributes.
113
113
114
114
```xml
115
115
<SenderPipename="insertBooking">
@@ -128,7 +128,7 @@ Wraps a sender to communicate with external systems (databases, services, etc.).
128
128
129
129
### XsltPipe
130
130
131
-
Applies an XSLT stylesheet to transform XML.
131
+
Applies an XSLT stylesheet to transform XML. See the [XsltPipe reference](https://reference.frankframework.org/#/Components/Pipes/XsltPipe) for all available attributes.
132
132
133
133
```xml
134
134
<XsltPipe
@@ -144,7 +144,7 @@ Applies an XSLT stylesheet to transform XML.
144
144
145
145
### ForEachChildElementPipe
146
146
147
-
Iterates over XML elements matching an XPath expression, applying a sender to each.
147
+
Iterates over XML elements matching an XPath expression, applying a sender to each. See the [ForEachChildElementPipe reference](https://reference.frankframework.org/#/Components/Pipes/ForEachChildElementPipe) for all available attributes.
Copy file name to clipboardExpand all lines: docs/manual/configuration/custom-code.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Custom Java code can extend the Frank!Framework when standard building blocks ar
6
6
7
7
## Extending FixedForwardPipe
8
8
9
-
Derive custom pipes from `org.frankframework.pipes.FixedForwardPipe` and implement:
9
+
Derive custom pipes from [`org.frankframework.pipes.FixedForwardPipe`](https://reference.frankframework.org/#/Components/Pipes/FixedForwardPipe) and implement:
Copy file name to clipboardExpand all lines: docs/manual/configuration/integration-patterns.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
The Frank!Framework connects applications from different vendors, transforming requests and responses between otherwise incompatible systems. This document covers patterns and features for protecting data integrity during integration.
4
4
5
+
For details on the pipes and senders used in these examples, see the [FF! Reference](https://reference.frankframework.org/#/components).
6
+
5
7
## Request/Reply
6
8
7
9
System A sends a request to system B. System B processes the request immediately and returns a response indicating success or failure. The sender waits for the response before proceeding.
Copy file name to clipboardExpand all lines: docs/manual/configuration/large-messages.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ This limitation applies equally to XPath expressions, which use XSLT processing
40
40
41
41
## ForEachChildElementPipe Streaming
42
42
43
-
`ForEachChildElementPipe` defaults to Xalan (`xsltVersion=1`) rather than Saxon. This exception exists because `ForEachChildElementPipe` is designed to iterate over large messages and requires streaming support.
43
+
[`ForEachChildElementPipe`](https://reference.frankframework.org/#/Components/Pipes/ForEachChildElementPipe) defaults to Xalan (`xsltVersion=1`) rather than Saxon. This exception exists because `ForEachChildElementPipe` is designed to iterate over large messages and requires streaming support.
44
44
45
45
Most other pipes and senders default to Saxon (XSLT 2.0+).
Copy file name to clipboardExpand all lines: docs/manual/configuration/properties.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Properties
2
2
3
-
Properties are name/value pairs that configure Frank!Framework behavior and allow Frank configurations to adapt to different deployment environments.
3
+
Properties are name/value pairs that configure Frank!Framework behavior and allow Frank configurations to adapt to different deployment environments. For a complete and up-to-date list of all available properties, see the [FF! Reference](https://reference.frankframework.org/#/properties).
Copy file name to clipboardExpand all lines: docs/manual/configuration/values.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Session keys act as variables that hold the same kind of data as the message flo
11
11
-`originalMessage` — the pipeline's input message
12
12
-`httpMethod` — the HTTP method (when using an `ApiListener`)
13
13
14
-
Custom session keys can be written with `PutInSessionPipe`:
14
+
Custom session keys can be written with [`PutInSessionPipe`](https://reference.frankframework.org/#/Components/Pipes/PutInSessionPipe):
15
15
16
16
```xml
17
17
<PutInSessionPipename="save"sessionKey="saved"/>
@@ -84,7 +84,7 @@ Only the `<Param>` element can obtain context key values. The parameter must the
84
84
85
85
## ReplacerPipe Pattern Substitution
86
86
87
-
`ReplacerPipe` substitutes both property references (`${...}`) and parameter references (`?{...}`) in its input. When the `find` attribute is omitted, no text replacement occurs — only property and parameter substitution.
87
+
[`ReplacerPipe`](https://reference.frankframework.org/#/Components/Pipes/ReplacerPipe) substitutes both property references (`${...}`) and parameter references (`?{...}`) in its input. When the `find` attribute is omitted, no text replacement occurs — only property and parameter substitution.
88
88
89
89
```xml
90
90
<ReplacerPipename="replace"getInputFromFixedValue="Property value ${my.property} and parameter value ?{my.param}">
@@ -96,7 +96,7 @@ Output: `Property value My property value and parameter value My parameter value
96
96
97
97
## EchoPipe Property Substitution
98
98
99
-
`EchoPipe` substitutes **properties only** (`${...}`). It does not substitute parameters (`?{...}`).
99
+
[`EchoPipe`](https://reference.frankframework.org/#/Components/Pipes/EchoPipe) substitutes **properties only** (`${...}`). It does not substitute parameters (`?{...}`).
Copy file name to clipboardExpand all lines: docs/manual/deployment/authorization.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,6 +32,8 @@ Authentication is configured via properties prefixed with:
32
32
-`application.security.console.authentication.` — for the Frank!Console and Ladybug.
33
33
-`application.security.http.authenticators.<name>.` — for HTTP interfaces.
34
34
35
+
For a complete and up-to-date list of all available servlet authenticators and their configuration options, see the [FF! Reference for servlet authenticators](https://reference.frankframework.org/#/servlet-authenticators).
36
+
35
37
| Type | Description | Properties |
36
38
|---|---|---|
37
39
|`NONE`| No authorization required | — |
@@ -134,7 +136,7 @@ Console and Ladybug authentication properties use the prefix `application.securi
134
136
135
137
## Credentials Management
136
138
137
-
Credentials keep secrets (usernames, passwords) out of Frank configurations and log files.
139
+
Credentials keep secrets (usernames, passwords) out of Frank configurations and log files. For a complete list of all available credential providers and their configuration options, see the [FF! Reference for credential providers](https://reference.frankframework.org/#/credential-providers).
Copy file name to clipboardExpand all lines: docs/manual/deployment/credentials.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Credentials Management
2
2
3
-
Credentials keep secrets (usernames, passwords) out of Frank configurations and log files. They are managed by credential factories and referenced by alias names.
3
+
Credentials keep secrets (usernames, passwords) out of Frank configurations and log files. They are managed by credential factories and referenced by alias names. For a complete list of all available credential providers and their configuration options, see the [FF! Reference for credential providers](https://reference.frankframework.org/#/credential-providers).
4
4
5
5
## Credential Factories
6
6
@@ -12,7 +12,7 @@ Credentials keep secrets (usernames, passwords) out of Frank configurations and
12
12
13
13
### PropertyFileCredentialFactory
14
14
15
-
Set in environment properties:
15
+
Set in environment properties. See the [PropertyFileCredentialFactory reference](https://reference.frankframework.org/#/credential-providers/PropertyFileCredentialFactory) for all configuration options:
@@ -32,11 +32,11 @@ Each alias is a named set of credentials. The alias name prefixes the `username`
32
32
33
33
### FileSystemCredentialFactory
34
34
35
-
Stores each username and password in a dedicated file. Default file paths per alias: `<alias>/username` and `<alias>/password`, relative to `credentialFactory.filesystem.root`.
35
+
Stores each username and password in a dedicated file. Default file paths per alias: `<alias>/username` and `<alias>/password`, relative to `credentialFactory.filesystem.root`. See the [FileSystemCredentialFactory reference](https://reference.frankframework.org/#/credential-providers/FileSystemCredentialFactory) for all configuration options.
36
36
37
37
### Ansible Vault
38
38
39
-
Credentials are stored in an Ansible Vault encrypted file. The vault password is read from a separate file specified by `credentialFactory.keyFile`.
39
+
Credentials are stored in an Ansible Vault encrypted file. The vault password is read from a separate file specified by `credentialFactory.keyFile`. See the [AnsibleVaultCredentialFactory reference](https://reference.frankframework.org/#/credential-providers/AnsibleVaultCredentialFactory) for all configuration options.
0 commit comments