Version 5
Intro
This document lists the steps required to upgrade Eftsure inside D365 FO successfully from V4 to V5.
The key user must run and understand these steps in sandbox before moving to live. Steps will require coordination with Eftsure support services.
Understanding these steps and their durations is critical to a successful upgrade in the live environment.
Please see our generic upgrade guide to assist during the upgrade.
For more information on the new/deprecated features, please see our release notes > Deprecated.
If you need assistance during this upgrade, please see your key user or consultants. Alternatively you can also request assistance from Eftsure D365 Professional Services who are available to answer any questions and assist during deployments.
Only new customers and preselected existing customers may upgrade to v5.
If you are not sure whether your organization has been elected for v5, stay on v4 and confirm with support before V5 deployment (we're still testing data migration path for existing customers and moving to V5 too early might result in unexpected/unsupported consequences).
Description
V5 introduces breaking changes that require manual configuration before the system can resume daily activities:
New GovCode table needs to be automatically migrated from existing data (no sharing involved)
API v1 with Basic Auth is no longer in use, API v2 with OAuth tokens need manual setup in each new environment.
API v2 needs to be enabled per environment by Eftsure API Services.
Coordination with Eftsure API Services is key for a successful upgrade to Live, please notify our services early before applying in live.
Upgrade
V5 packages are available in LCS alongside V4:
Perform standard code upgrade from V4 to V5, see deployment guide for more details.
Pause all Eftsure batches (they won't work until API v2 is configured successfully)
Cross company data sharing
If your organization uses Cross Company Data Sharing, please review either upgrade batch log or CCDS policies to add new table/fields as per CCDS recommendations.
There are new fields in this release and it's critical to share them alongside the rest of your configuration. These will raise a configuration warning in the upgrade batch log and during configuration checks.
For more information, please check Cross Company Data Sharing.
Upgrade batches
Monitor upgrade batches as per normal upgrades, pay attention to all new GovCode upgrade scripts and ensure completion without errors.
Depending on the volume of suppliers and the number of companies configured in cross company data sharing, these tasks may take some time, and you may need to plan the appropriate downtime during a weekend.
The performance of your sandbox environment is not necessarily related to the performance of your live environment and batch durations may be impacted.
Enable API v2
To create a client ID and secret, login to the customer portal, and click on the menu on the top right.
Click on the Partner API Credentials menu item.
This will bring up the Partner API Credentials page:
Click on the Generate Credentials button.
It will then open a new for API Credentials Generated:
Click on the 
buttons to copy the text to clipboard
Check the checkbox when you've copied and securely store the client secret. It will only be displayed once.
Finally, click on the Confirm and Close button. It will then display information about the app client credentials created:
Setup connections
Go back to Dynamics 365, head to Eftsure parameters and configure/check your connection(s).
If previously using API v1 (Basic Auth), create support ticket to move your sandbox/live environment to API v2 (Token Auth).
Get Eftsure API client Id and client Secret from Eftsure portal (previous step).
Configure client Id and secret into the appropriate connection.
Use the Ping and Login buttons to validate your connection.
Legal entities
Go to Eftsure parameters and ensure your legal entities are connected to the appropriate connection.
You may need to disable the legal entity and re-enable it afterwards to change the connection, which is totally fine during the downtime period.
Setup users
User setup is now the responsibility of the key/admin user, which needs to configure 2 types of users:
Generic API user, used for generic actions, configurable at the connection level.
End users, used for personal actions, configurable in the Eftsure parameters > Users > User list where each user needs to be configured per connection,
Each Eftsure user is now configured by the admin in the Eftsure parameters screen rather than by each individual user (V4). User passwords are no longer necessary, which greatly simplifies future upgrades as user management was one of the key friction issue for all stakeholders.
User names and settings should have been upgraded during upgrade scripts, please confirm your user configuration:
License
Refresh your license to the latest in Eftsure parameters.
Unlicensed items will now be disabled rather than hidden.
Configuration
Check opt-in / out new features using our Release Notes.
Some features may have their own supporting documentation.
For Comfort Pack licensed organizations and charities, see our API Keys guide to register for new GovCode services. This new release contains lookups and validations for EU, FR, HK, NZ, SG, UK, US.
Run a configuration check in Eftsure parameters and ensure all configuration issues are resolved.
Check batches to recreate/regenerate batches: This step is required to remove deprecated batches and create potential new batches depending on your configuration.
Status
Open the dashboard in Eftsure workspace > Dashboard > Status and ensure all webservices are performing nominally, check / fix any errors.
Testing
Follow our recommended test scripts available in Eftsure workspace > Help > Testing.
Each test contains a video recording and a task guide to replay the test in person, in the matching environment, at any moment.
End
Resume paused batches if any.
Monitor Eftsure batches for errors and assist users in change management.
Live
Repeat the same process in Live environment, allowing time to our API services to perform the switch from API v1 to v2 at the appropriate time.
Congratulations, you've been through our V4 to V5 upgrade.
Feedback
Hit the feedback button if you have comments or see potential for continuous improvements.
