Creating your own FME Connectors.pdf
0 likes565 views
The document provides an overview of creating custom FME connectors presented at the FME User Conference 2022, covering topics such as custom transformers, web services, and API interactions. It discusses various formats supported, best practices for development and troubleshooting, and introduces the FME Hub for sharing resources. The presentation emphasizes the importance of documentation, parameter management, and utilizing existing templates for efficient web service integration.
![20
22
FME
User
Conference
Creating a Token Web Service
Parameters: Allows user to enter in required
information to be used by the web service in order
to authenticate (i.e. API token, URL, username,
password, etc.)
Request URL/Data: uses the provided login
credentials to issue an access request to a server
or protected resource.
• Input parameters are used in Request Data
by wrapping the [keyname] in square
brackets
Access Token Response: The token will remain
active until the user logs out or closes the server.](https://image.slidesharecdn.com/creatingyourownfmeconnectors-220906205055-6c986fbd/85/Creating-your-own-FME-Connectors-pdf-14-320.jpg)
Creating your own FME Connectors.pdf
- 1. Creating your Own FME Connectors
- 2. FME User Conference 20 22 Christian Berger Customer Solutions Specialist Sienna Emery Customer Solutions Specialist
- 3. 20 22 FME User Conference Agenda • A Brief History of Custom Transformers • Creating a Web Service • Working with Data for/from an API • Managing Parameters • Best Practices & Troubleshooting Tips
- 4. 20 22 FME User Conference A Brief History of Custom Transformers
- 5. 20 22 FME User Conference Native Format Support ● 363 Spatial ● 59 Non-Spatial ● 32 Packages ○ FME packages are a fully portable mechanism for distributing post-install FME Engine components, including transformers, readers, writers, and web connections. Packages contain all dependencies that are required to run. 244 (57%) of FME formats are bi-directional, 154 (36%) read only, 32 (7%) write only
- 6. 20 22 FME User Conference Extending FME’s Reach Write to one of the supported formats Develop a Custom Reader/Writer Format or Transformer with the plugin-SDK Not realistic for most organization ● Can be developed in Python, C++ or in Java ● Time consuming & more complicated
- 7. 20 22 FME User Conference Extending FME’s Reach… Easier Select transformers enable support for additional Systems/Services/formats (i.e. HTTPCaller, PythonCaller, & SQLCreator) ● REST API ● SOAP API ● Python API ● JDBC/ODBC Database formats ○ 14 Tested by Safe Software
- 8. 20 22 FME User Conference What are Custom Transformers? A group of FME transformers nested in a single, organized container: • Parameters • Loops • Shareable • Linked • Embedded
- 9. 20 22 FME User Conference FME Hub A community platform where users can access and share pre-built, customized FME tools like transformers, readers, writers, templates, and web connections. No signup required. • 783 Transformers • 16 Custom Formats • 232 Templates • 35 Web Connections • 32 Packages • 7 Projects
- 10. 20 22 FME User Conference Creating a Web Service
- 11. 20 22 FME User Conference Creating a Web Service Definition Web Services: the standard for means of communication and grant access to functionality between applications that would otherwise be disconnected. FME technology can be leveraged to use existing web services, create new web services, and implement web service standards. Web Connection: A convenient and secure way to store and reuse connection parameters to various web services. Tip: Work from an existing template!
- 12. 20 22 FME User Conference OAuth 2.0: An open-standard protocol where an application can authenticate a user and access their information through a third-party application without the userʼs credentials. Token: An alpha-numeric string used to authenticate and identify an application to an API as opposed to defining a user. HTTP Authentication Services: • Basic: Username/password (Base64) • Digest: Username/password (MD5) • NTLM: Windows NT LAN Manager (SSO) • Dynamic: session tokens Authentication Types
- 13. 20 22 FME User Conference Creating an OAuth 2.0 Web Service Authorization: redirects the user to the login and authorization prompt. • Auth code granted & verified with client ID and secret to get token Retrieve Token: used to inform an API that the bearer of the token has been authorized to access the API and perform a predetermined set of actions (specified by the scopes granted). Refresh Token: A token used to obtain a renewed access token without having to re-authenticate the user. (optional)
- 14. 20 22 FME User Conference Creating a Token Web Service Parameters: Allows user to enter in required information to be used by the web service in order to authenticate (i.e. API token, URL, username, password, etc.) Request URL/Data: uses the provided login credentials to issue an access request to a server or protected resource. • Input parameters are used in Request Data by wrapping the [keyname] in square brackets Access Token Response: The token will remain active until the user logs out or closes the server.
- 16. 20 22 FME User Conference Working with Data for/from an API
- 17. 20 22 FME User Conference Fragment: Extract portions of formatted text into features. Handling a Response
- 18. 20 22 FME User Conference Fragment: Extract portions of formatted text into features. Flatten: Extract the object keys and values into attributes. Handling a Response
- 19. 20 22 FME User Conference Fragment: Extract portions of formatted text into features. Flatten: Extracts the object keys and values into attributes. Extract: Extract portions of formatted text into attributes. JSON/XML transformers available Handling a Response
- 21. 20 22 FME User Conference Preparing an Upload Body File/Folder FeatureWriter: Use a FeatureWriter before the HTTPCaller to let the writer handle all of the formatting, etc. and pass the file in from the Summary Feature • Write to a temp location using the TempPathnameCreator so files are automatically cleaned up Attribute Basic: concatenate attributes into formatted text (either in the Upload Body parameter or an AttributeManager) Advanced: Writing with a Templater transformer (i.e. JSON/XML)
- 22. 20 22 FME User Conference Preparing an Upload Body File/Folder FeatureWriter: Use a FeatureWriter before the HTTPCaller to let the writer handle all of the formatting, etc. and pass the file in from the Summary Feature Attribute Basic: concatenate attributes into JSON formatted text (either in the Upload Body parameter or an AttributeManager) Advanced: Writing with a Templater transformer (i.e. JSON/XML)
- 25. 20 22 FME User Conference Parameter Groups Types: • Choice • Import Values to save time • Required/Optional • Datetime* • Needs to match API spec • Web Connection Managing Parameters
- 26. 20 22 FME User Conference Best Practices & Troubleshooting
- 27. 20 22 FME User Conference Include Web Service Setup Instructions!! Document Everything
- 28. 20 22 FME User Conference Include Web Service Setup Instructions!! When exporting as a custom transformer use linked by default where possible • Ensures updates are pushed out Document Everything
- 29. 20 22 FME User Conference Include Web Service Setup Instructions!! When exporting as a custom transformer use linked by default where possible • Ensures updates are pushed out Add a description and history to the Transformer parameters so you know what it is doing and what was last updated • Use markdown formatting Annotate the transformers and add bookmarks, future you will thank you when it comes time to update something Document Everything
- 31. 20 22 FME User Conference RTFM - API documentation can be dry but it is extremely helpful Postman is a very helpful tool for troubleshooting Rejected Feature Error message is informative Turn Debug mode on Troubleshooting
- 33. Thank you for joining us today! Contact: solutions@safe.com Questions?