frankframework icon indicating copy to clipboard operation
frankframework copied to clipboard

Document filenames

Open mhdirkse opened this issue 3 years ago • 1 comments

❗ please do not add sensitive information in issues, you can provide extra information via email using issue number as reference ❗

Describe the issue Today I wanted to use the filename attribute of the <FixedResultPipe>. It took me quite some time to discover that this attribute references the classpath by default, not the file system of the host. You may change this using a property classloader.allowed.protocols. This stuff needs to be documented somewhere. It may be common to every attribute setter that references a file.

We may introduce a data type in the Frank!Doc for files. Then we can add information about class loaders and protocols to a new page about file datatypes. We can add a refence to this page at every attribute setter of type file.

Alternatively, we can document this stuff in the manual and reference that separately for every attribute setter that references a file.

Reporter Please state your name. If we don't know who is reporting, a solution of the issue might be delayed.

To Reproduce Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Screenshots If applicable, add screenshots to help explain your problem.

Configuration

Please provide the configuration of the Pipe or Receiver with the problem.

Input

Please provide an example of the input message. 
Alternatively, provide a Ladybug report.

Environment

Please go to the console of your Frank, click on 'Information' and copy-paste the results here. 

Additional Environment

  • DBMS: [e.g. Oracle, MSSQL, MariaDB, MySql, PostgreSQL]
  • Browser: [e.g. Chrome, Safari, Edge, Firefox]

Additional Context Add any other context about the problem here. (f.e. ladybug report / test adapter with larva test)

mhdirkse avatar May 06 '22 14:05 mhdirkse

I think you should document the classloader.allowed.protocols property in the manual. We do not need to reference this everywhere. It is an exceptional property, normal (system) file retrieval should always use the classpath.

The LocalFileSystemPipe should be used for normal filesystem operations.

nielsm5 avatar May 06 '22 16:05 nielsm5