API to connect to Sage Desktop Products
-
Follow these steps to ensure your changes are applied correctly:
-
Make changes in the
fyle-integrations-db-migrations
repository. -
Update the submodule in the Sage300 API:
git submodule init git submodule update
-
Enter the Sage300 API container:
enter sage-desktop-api
-
Generate a migration file using the provided convenient command:
python3 manage.py create_sql_migration <file-path1>
- Replace
<file-path1>
with the relative path to your SQL file from the fyle-integrations-db-migrations folder. - The migration will always be created in the
internal
app.
Example:
python3 manage.py create_sql_migration fyle-integrations-db-migrations/sage300/functions/delete_workspace.sql
- Replace
-
Review the newly generated migration file: Navigate to the
apps/internal/migrations/
directory and ensure the migration file content is as expected. -
Restart the Sage300 API service and apply the migration:
restart sage-desktop-api logs sage-desktop-api
Confirm in the logs that the migration has been applied successfully.
-