1. To-Increase Dynamics 365 for Finance & Operations
  2. Connectivity studio
  3. Activities

Set up file action - SFTP
Application task

You can use the SFTP file action to exchange files with an SFTP server.
If the direction is:
  • Source, before the message is run, the file is downloaded from the SFTP server to the Working folder. By default, the original file is deleted from the SFTP server. You can disable the delete action of the original file.
  • Target, after the message is run, the file is uploaded from the Working folder to the SFTP server. The original file stays in the Working folder. If you want to zip the file before uploading it to the SFTP server, do a Zip file action previously to the SFTP file action. In this case the zipped file is uploaded to the SFTP server.


Standard procedure

1. Click Connectivity studio Integration Design.
2. Click the Connectors tab.
3. In the list, find and select the desired connector of type Azure file storage.
4. Click Edit.
5. You can export connectivity setup and import it in another D365 FO environment. For example, you first set up and test the connectivity setup in a development environment. When finished, you deploy the setup in your production environment.
To prevent messing up your production data, use different file locations for your development or testing environment and for your production environment.
To strictly distinguish between different environments, you can define unique file action properties for each of your environment types. So, each file action can have a different set of properties for each applicable environment type.
Which file action properties are applicable to the current environment is defined in the Environment type field on the Connectivity studio parameters. Example: If set to Development, the file action properties, as defined for environment type Development are applicable.
  In the Environment types field, select an option.
 

Note: For each file action, you can repeat the sub-tasks for each of your environment types. To set the environment-specific properties of a file action, only change the environment type, find the file action, and set the properties. So, do not create a new file action for each environment type.
6. Expand the File action section.
7. Sub-task: Set up an SFTP file action with direction Source.
  7.1 Click New.
  7.2 In the Name field, type a value.
  7.3 In the File action field, select 'SFTP'.
  7.4 Click Save.
  7.5 Define the name of the file to be downloaded from the SFTP server to the Working folder. You can use filtering symbols. Example: CustGroup*.txt.
  In the File name field, type a value.
  7.6 You can (temporarily) disable a file action.
Example: In a test setup, the setup to do the file action is not available. To prevent errors during test runs of the message, you disable the file action. In this way, you do not have to change or delete the file action.
  Select Yes in the Skip field.
  7.7 Define the SFTP server address.
  In the Server field, type a value.
  7.8 Define the SFTP port. Typically, this is port 22.
  In the Port field, enter a number.
  7.9 You can define from which folder on the SFTP server the files must be downloaded.
  In the Folder field, type a value.
  7.10 Define the username that is used to access the SFTP server.
  In the User name field, type a value.
  7.11 Define the password or password reference that is used to access the SFTP server.
Whether the password or password reference applies is defined by the Display secret field in the Connectivity studio parameters.
If the Display secret parameter is set to:
- Secret, fill in the Password field with the desired password. The password is specific for the current file action.
- Secret reference, fill in the Password reference field with the desired secret reference. The password reference refers to a centrally stored password which makes updating secrets easier.
- Both, fill in either the Password field or the Password reference field.
  In the Password field, or in the Password reference field, type a value.
  7.12 Upload the private key certificate for the SFTP server from a file or enter the private key reference that refers to the desired certificate.
Whether the private key or private key reference applies is defined by the Display secret field in the Connectivity studio parameters.
If the Display secret parameter is set to:
- Secret, upload the private key certificate. The private key is specific for the current file action.
- Secret reference, fill in the Private key reference field with the desired secret reference. The private key reference refers to a centrally stored private key certificate which makes updating secrets easier.
- Both, either upload the private key certificate or fill in the Private key reference field.
  Click Upload private key and browse for the file that contains the private key certificate. Or, in the private key reference field, type or select a value.
  7.13 Click OK.
  7.14 Define the applicable SFTP passphrase or passphrase reference.
Whether the passphrase or passphrase reference applies is defined by the Display secret field in the Connectivity studio parameters.
If the Display secret parameter is set to:
- Secret, fill in the Passphrase field with the desired SFTP passphrase . The passphrase is specific for the current file action.
- Secret reference, fill in the Passphrase reference field with the desired secret reference. The passphrase reference refers to a centrally stored passphrase which makes updating secrets easier.
- Both, fill in either the Passphrase field or the Passphrase reference field.
  In the Passphrase field, or in the Passphrase reference field, type a value.
  7.15 By default, on download, the original file is deleted from the SFTP server. However, you can disable the delete action of the original file. So, the original file stays in the Working folder of the SFTP server.
  Select Yes in the Disable delete field.
8. Sub-task: Set up an SFTP file action with direction Target.
  8.1 Click New.
  8.2 In the Name field, type a value.
  8.3 In the File action field, select 'SFTP'.
  8.4 Click Save.
  8.5 In the Direction field, select 'Target'.
  8.6 Click Save.
  8.7 You can (temporarily) disable a flow action.
Example: In a test setup, the setup to do the file action is not available. To prevent errors during test runs of the message, you disable the file action. In this way, you do not have to change or delete the file action.
  Select Yes in the Skip field.
  8.8 Define the SFTP server address.
  In the Server field, type a value.
  8.9 Define the SFTP port. Typically, this is port 22.
  In the Port field, enter a number.
  8.10 You can define to which folder on the SFTP server the files must be uploaded.
  In the Folder field, type a value.
  8.11 Define the username that is used to access the SFTP server.
  In the User name field, type a value.
  8.12 Define the password or password reference that is used to access the SFTP server.
Whether the password or password reference applies is defined by the Display secret field in the Connectivity studio parameters.
If the Display secret parameter is set to:
- Secret, fill in the Password field with the desired password. The password is specific for the current file action.
- Secret reference, fill in the Password reference field with the desired secret reference. The password reference refers to a centrally stored password which makes updating secrets easier.
- Both, fill in either the Password field or the Password reference field.
  In the Password field, or in the Password reference field, type a value.
  8.13 Upload the private key certificate for the SFTP server from a file or enter the private key reference that refers to the desired certificate.
Whether the private key or private key reference applies is defined by the Display secret field in the Connectivity studio parameters.
If the Display secret parameter is set to:
- Secret, upload the private key certificate. The private key is specific for the current file action.
- Secret reference, fill in the Private key reference field with the desired secret reference. The private key reference refers to a centrally stored private key certificate which makes updating secrets easier.
- Both, either upload the private key certificate or fill in the Private key reference field.
  Click Upload private key and browse for the file that contains the private key certificate. Or, in the private key reference field, type or select a value.
  8.14 Click OK.
  8.15 Define the applicable SFTP passphrase or passphrase reference.
Whether the passphrase or passphrase reference applies is defined by the Display secret field in the Connectivity studio parameters.
If the Display secret parameter is set to:
- Secret, fill in the Passphrase field with the desired SFTP passphrase . The passphrase is specific for the current file action.
- Secret reference, fill in the Passphrase reference field with the desired secret reference. The passphrase reference refers to a centrally stored passphrase which makes updating secrets easier.
- Both, fill in either the Passphrase field or the Passphrase reference field.
  In the Passphrase field, or in the Passphrase reference field, type a value.
  8.16 Define the data type that is used by the SFTP server.
  In the Data type field, select an option.
  8.17 You can upload a file to the SFTP server with a specific file name or to a specific file, instead of using the original file name.
  In the Target file name field, type a value.
  8.18 Define the file open mode for uploading files to the SFTP server.
  In the File open mode field, select an option.
9. Close the page.

Notes

File actions of type FTP are no longer supported because of security reasons. Instead, use file actions of type SFTP.

Related to Notes

Set up file actions for Azure file storage connector

 		 

See also

Provide feedback