eMagiz SFTP Connection guide
In this microlearning, we will provide short guide that will help eMagiz users how to connect to the eMagiz SFTP service. Although this is a regular SFTP service, there are some specific steps involved to allow an optimal configuration of the integration.
Should you have any questions, please contact academy@emagiz.com.
1. Prerequisites
- Basic knowledge of the eMagiz platform
- Understanding of the way in which an SFTP file pickup or drop is configured in eMagiz
- Reviewed microlearning : eMagiz SFTP Connectivity
2. Key concepts
By the eMagiz SFTP, we mean: A specific SFTP offered by the eMagiz platform on which you can securely store and read messages. Considerations when connecting to the eMagiz SFTP
- Did you read the connect guide and made sure that all requirements are met?
- Did you use the store component made available in the eMagiz store to set up the connection?
- Did you verify that the indicator for temporary file name is set to false?
3. eMagiz SFTP Connection guide
3.1 Obtain an SFTP User account
Make sure to get the access credentials from eMagiz Support. Ensure to obtain access credentials for all connected systems/applications that need to send or received files from the SFTP service. Every application team will get a specific user, and the eMagiz model will get its own user. In this way, the data is securely provided to the ecosystem of the eMagiz model. For instance, in case there are 4 applications involved that need to get or send data to the SFTP service there will be 5 SFTP service users
3.2 Create (agreed) folder structure
Once the integration is realized in eMagiz, the user will have chosen the folder structure for each receiving or sending user. On the SFTP folder structure there will be test, accp and prod folder as well. That folder structure can be set by the eMagiz user as desired but needs to be known by eMagiz. Please see the next point
3.3 Create script
For most implementations, external users or applications will send and receive files via their own SFTP user. Each eMagiz integration model will have its own SFTP user. To some use cases, files put on the eMagiz integration model SFTP user need to be synchronized with the external application SFTP user. On that case, a script needs to be provided to eMagiz Support. Please consult eMagiz Support to get help in case needed - samples are available.
3.4 Optimize SFTP user settings
Once the folder structure is fixed across test, accp and prod folders, a signal needs to be send to eMagiz Support. The eMagiz SFTP settings will be optimized accordingly using Event Notifications in AWS. Please ensure to transmit this signal as soon as possible to avoid misconfigured eMagiz SFTP settings for users. Send a notification to productmanagement@emagiz.com.
4. Key takeaways
- The eMagiz SFTP Service requires use of a specific Store component
- Please contact eMagiz Support to ensure the right configuration is created including the proper file paths inside the SFTP user folder
- Ensure to update eMagiz Support whenever the file path changes
5. Suggested Additional Readings
None available