Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
indent20px

Device The device configuration is divided into four areas.

...

Options on the Actions tab define defines how the file is written (see image above). Use the following options to configure the device actions.

Write Operations: Choose how the file will be written. Synchronous writing means that messages in the channel can be blocked by the File Writer device and will not be written. In Asynchronous mode, message processing will never be blocked and the file will be saved when possible. Using Asychronous Asynchronous processing may provide better system performance and scaling, especially if you are writing large numbers of messages.

...

  • To copy the file, select the Copy File option. set the following:
    • Destination: The location to which the file should be copied, usually a network path. Connexion must have write permissions to the destination for the copy action to be successful. As part of the action, you can insert use variables into the name of the copied fileto determine the appropriate destination path, such as the date or a file counter. Variables are inserted between braces ({ }) in the destination path. Click on the blue information icon next to the Destination field to see a list of possible variables and how to use them.
    • Use Impersonation: Similar to the File Reader device, the Filter Writer device can use the credentials of a specific user or group to access the Destination path. Select the check box checkbox and then enter the username and password for the appropriate credentials.
  • To FTP the file, select the FTP File option and set the following:
    • Destination: The location to which the file should be sent via FTP. As part of the action, you can insert variables into the name of the copied file, such as the date or a file counter. Variables are inserted between braces ({ }) in the destination path. Click on the blue information icon next to the Destination field to see a list of possible variables and how to use them.
    • Username: The username for the FTP client. This should be a user that has permissions to use the FTP client.
    • Password: The password for the FTP client user specified above.
    • Use SSL: Select this box if the FTP client should use SSL encryption to transmit the file. Remember, without SSL encryption, user names, passwords and PHI are vulnerable to outside parties. Once you check the Use SSL option, complete the following fields:
      • SSL Port: the port that should be used for the SSL-protected FTP process.
      • Cert Path: the path to the location of the SSL certificate.

...

Set File Name: Check this option to set the name for the copied/FTP'd file. The field should only contain the file name, not the entire path. You can insert variables into the name of the copied file, such as the date or a file counter. Variables are inserted between braces ({ }). You can use custom variables you have defined with a Custom Code device in the destination pathfile names. Click on the blue information icon next to the Destination field to see a list of possible variables and how to use them. This field is required to enable Purging.

...

Multiple conditions are joined using the boolean OR operator. For example, you can set up conditions to the archive when the file size reaches 10240KB (10MB) OR when the number of messages in the file reaches 1000.

...

  • Start of Message Character: the  The character or character string that indicates the start of a message.
  • End of Message Character: the  The character or character string that indicates the end of a message.

...

  • The action must be Copy File (you cannot purge via FTP).
  • The first part of the destination directory cannot contain any user variables.
  • The file must have a valid file extension, such as *.txt (no user variables are allowed in the extension for purging purposes).

Once those conditions are met, you can enable file purging on the device. Choose your purge condition:

  • Remove files that are older than: purge files based on their age in days.
  • Remove the oldest log file when: purge files when the oldest log file exceeds the specified number of MB.

...