Skip to content

Commit bec5b58

Browse files
Copilotphilipsens
andauthored
Fix FF! Reference URLs for components listing page (#4)
Co-authored-by: philipsens <12416423+philipsens@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
1 parent 3cf432e commit bec5b58

12 files changed

Lines changed: 28 additions & 24 deletions

File tree

‎docs/get-started/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ You define your integrations in XML configuration files. The framework loads the
3131
</Adapter>
3232
```
3333

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.
3535

3636
## Choose Your Setup
3737

‎docs/manual/configuration/basics.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,11 @@ Each exit has a `name`, a `state` (SUCCESS or ERROR), and an HTTP response `code
7575

7676
## Pipes
7777

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).
7979

8080
### EchoPipe
8181

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.
8383

8484
```xml
8585
<EchoPipe
@@ -91,7 +91,7 @@ Returns its input unchanged, or a fixed value if `getInputFromFixedValue` is set
9191

9292
### XmlValidatorPipe
9393

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.
9595

9696
```xml
9797
<XmlValidatorPipe
@@ -109,7 +109,7 @@ Validates the incoming XML message against an XSD schema.
109109

110110
### SenderPipe
111111

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.
113113

114114
```xml
115115
<SenderPipe name="insertBooking">
@@ -128,7 +128,7 @@ Wraps a sender to communicate with external systems (databases, services, etc.).
128128

129129
### XsltPipe
130130

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.
132132

133133
```xml
134134
<XsltPipe
@@ -144,7 +144,7 @@ Applies an XSLT stylesheet to transform XML.
144144

145145
### ForEachChildElementPipe
146146

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.
148148

149149
```xml
150150
<ForEachChildElementPipe

‎docs/manual/configuration/custom-code.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Custom Java code can extend the Frank!Framework when standard building blocks ar
66

77
## Extending FixedForwardPipe
88

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:
1010

1111
```java
1212
public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException

‎docs/manual/configuration/integration-patterns.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
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.
44

5+
For details on the pipes and senders used in these examples, see the [FF! Reference](https://reference.frankframework.org/#/components).
6+
57
## Request/Reply
68

79
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.

‎docs/manual/configuration/large-messages.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This limitation applies equally to XPath expressions, which use XSLT processing
4040

4141
## ForEachChildElementPipe Streaming
4242

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.
4444

4545
Most other pipes and senders default to Saxon (XSLT 2.0+).
4646

‎docs/manual/configuration/properties.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Properties
22

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).
44

55
## Property Syntax and Referencing
66

‎docs/manual/configuration/values.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Session keys act as variables that hold the same kind of data as the message flo
1111
- `originalMessage` — the pipeline's input message
1212
- `httpMethod` — the HTTP method (when using an `ApiListener`)
1313

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):
1515

1616
```xml
1717
<PutInSessionPipe name="save" sessionKey="saved"/>
@@ -84,7 +84,7 @@ Only the `<Param>` element can obtain context key values. The parameter must the
8484

8585
## ReplacerPipe Pattern Substitution
8686

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.
8888

8989
```xml
9090
<ReplacerPipe name="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
9696

9797
## EchoPipe Property Substitution
9898

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 (`?{...}`).
100100

101101
## Complete Example
102102

‎docs/manual/deployment/authorization.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ Authentication is configured via properties prefixed with:
3232
- `application.security.console.authentication.` — for the Frank!Console and Ladybug.
3333
- `application.security.http.authenticators.<name>.` — for HTTP interfaces.
3434

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+
3537
| Type | Description | Properties |
3638
|---|---|---|
3739
| `NONE` | No authorization required | — |
@@ -134,7 +136,7 @@ Console and Ladybug authentication properties use the prefix `application.securi
134136

135137
## Credentials Management
136138

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).
138140

139141
### Credential Factories
140142

‎docs/manual/deployment/credentials.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Credentials Management
22

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).
44

55
## Credential Factories
66

@@ -12,7 +12,7 @@ Credentials keep secrets (usernames, passwords) out of Frank configurations and
1212

1313
### PropertyFileCredentialFactory
1414

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:
1616

1717
```properties
1818
credentialFactory.class=org.frankframework.credentialprovider.PropertyFileCredentialFactory
@@ -32,11 +32,11 @@ Each alias is a named set of credentials. The alias name prefixes the `username`
3232
3333
### FileSystemCredentialFactory
3434

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.
3636

3737
### Ansible Vault
3838

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.
4040

4141
## Using Credentials in Configurations
4242

‎docs/manual/operations/monitoring.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The sender receives a message when the monitor is raised. This can trigger anoth
5353

5454
Monitors defined in the UI must be exported and added to `Configuration.xml` to persist across restarts. Use the "XML" button in the UI to export.
5555

56-
Full configuration example:
56+
Full configuration example (see the [FF! Reference](https://reference.frankframework.org/#/components) for pipe details):
5757

5858
```xml
5959
<Configuration

0 commit comments

Comments
 (0)