Release 3.5 Notes
Release Date: 15/1/2024
Release 3.0 introduces a powerful new templating feature, enhanced entity mapping pages, and support for three new connectors. This release focuses on improving usability, expanding functionality, and increasing stability.
New Features
New SDK Framework: Connector Framework
Introduction to Connector Framework
- Empowering Custom Development: SyncNow introduces a powerful SDK framework for connectors, enabling customers to develop their own connectors with ease and flexibility.
- Custom Integration: With this framework, organizations can tailor SyncNow to integrate with their unique systems, expanding the potential for seamless synchronization and workflow automation.
Developing a Custom Connector
- Implementation in C#: To develop a custom connector, customers are required to implement a DLL (Dynamic Link Library) in C#. This DLL must conform to a given interface provided by SyncNow.
- Interface Compliance: The interface ensures that the custom connector can communicate effectively with SyncNow, supporting synchronization and other features.
Deployment and Registration
- Storage Location: Once developed, the custom connector DLL must be stored in the
extensionsfolder located in the root directory of SyncNow. - Registration Process: After placing the DLL in the correct folder, customers can register the new connector via the Systems page in the Settings section of SyncNow. This process integrates the custom connector into the SyncNow ecosystem, making it available for use.
Supported Features
- Synchronization: The custom connectors developed using this framework support the full range of SyncNow's synchronization capabilities, allowing for data integration across diverse systems.
- DevOps Gate: In addition to synchronization, custom connectors can also leverage the DevOps Gate feature. This enhances security and authentication for systems that lack native webhook authentication by adding a user-related token.
Benefits of the Connector Framework
- Flexibility and Customization: The SDK framework provides a high degree of flexibility, allowing customers to address specific integration needs that may not be covered by out-of-the-box connectors.
- Scalability: As organizations grow and their integration needs evolve, the ability to develop and register custom connectors ensures that SyncNow remains a scalable solution.
- Innovation and Control: By developing their own connectors, customers can innovate and maintain control over how data is synchronized and managed within their unique environments.
New Capability: User API Tokens
Introduction to User API Tokens
- Enhanced Security: SyncNow now supports user-initiated API tokens for secure authentication of systems webhooks and interactions with SyncNow.
- User-Specific Tokens: Each token is tied to a specific user, ensuring precise control over access and permissions.
Creating a User API Token
- Navigation: To create an API token, navigate to the User Management section in SyncNow.
- Token Generation: Select the user for whom the token is to be created and generate a new API token.
- Secure Storage: Ensure that the token is securely stored, as it will be used for authenticating requests to SyncNow.
Usage of API Tokens
- Webhook Authentication: Systems webhooks can use the generated API token to authenticate their requests to SyncNow, enhancing the security and reliability of webhook communications.
- Generic Connector Integration: The API token can also be utilized by the generic connector to report through the SyncNow DevOps Gate endpoint, facilitating seamless and secure data synchronization.
Benefits of User API Tokens
- Improved Security: By using user-specific tokens, SyncNow ensures that only authorized requests are processed, reducing the risk of unauthorized access.
- Enhanced Control: Administrators can manage and revoke tokens as needed, providing granular control over who can access and interact with SyncNow.
- Simplified Integration: The use of API tokens simplifies the integration process for systems and connectors, making it easier to authenticate and communicate with SyncNow.
Example: Creating and Using an API Token
-
Create Token:
- Navigate to the User Management section.
- Select the user and generate a new API token.
- Copy and securely store the token.
-
Authenticate Webhook:
- Use the API token in the authorization header of the webhook request to SyncNow.
- Example:
Authorization: Bearer YOUR_API_TOKEN
-
Integrate with Generic Connector:
- Configure the generic connector to use the API token when reporting to the SyncNow DevOps Gate endpoint.
- This ensures secure and authenticated data reporting and synchronization.
-
OpenText:
- Added support for timezone in the connector settings.
Support for New Work Systems
- New Connectors: Added support for the following work systems:
- Salesforce
Bug Fixes
Key Bug Fixes in v3.5
Comments – ‘Created By’ Incorrect in Defect – OpenText
- Issue: ‘Created By’ was set incorrectly for comments in defects from OpenText.
- Resolution: Fixed the ‘Created By’ attribute for comments.
Invalid Column ID on Entities Page
- Issue: Navigating to the entities page resulted in an invalid column ID error.
- Resolution: Fixed the column ID error on the entities page.