Backup & Restoration of Delphi Service Desk Configurations

This guide covers the backup and restoration of the key configurations for Delphi Service Desk, ensuring you can restore functionality seamlessly in case of updates or migrations.

Backup Steps

1. Authorization Settings:

   • Navigate to: Custom Metadata → Olympus-Grid: Plugin → Manage Olympus-Grid: Plugins.

   • Locate and select "portal_auth".

   • Backup the value in the "Configuration" field. Example configuration:

     jsonCopyEdit{
       "auth": {
         "microsoft": {
           "status": true,
           "clientId": "0aa9ec56-0591-4aba-9019-xxxxxxxxx",
           "authorityUrl": "https://login.microsoftonline.com/9ce5d13b-f77e-4fad-ab05-xxxxxxxx"
         },
         "google": {
           "status": false,
           "clientId": "your-google-client-id",
           "tbd": "tbd"
         },
         "link": {
           "status": false
         },
         "salesforce": {
           "status": false
         }
       }
     }

   • Save this JSON configuration in a secure file, preferably naming it with a timestamp (e.g., portal_auth_backup_YYYY-MM-DD.json).

2. Layout Settings:

   • Navigate to: Olympus-Grid: Dynamic Object Types → Case.

   • Copy the value in the "Layout" field, which typically contains a long JSON string representing the layout structure. Example layout:

     {}
     }

   • Save this JSON layout configuration in a secure file with a timestamp (e.g., case_layout_backup_YYYY-MM-DD.json).

---

Restoration Steps

1. Restore Authorization Settings:

   • Navigate to: Custom Metadata → Olympus-Grid: Plugin → Manage Olympus-Grid: Plugins.

   • Open "portal_auth".

   • Paste the backed-up JSON configuration into the "Configuration" field.

   • Save your changes and verify functionality by testing authorization workflows for Microsoft, Google, or other platforms.

2. Restore Layout Settings:

   • Navigate to: Olympus-Grid: Dynamic Object Types → Case.

   • Paste the backed-up JSON string into the "Layout" field.

   • Save your changes and validate the layout by creating or opening a case in Delphi Service Desk.

---

End-to-End Verification

After restoring the configurations:

• Test the authorization workflows to confirm that users can authenticate using Microsoft, Google, or other configured platforms.

• Validate the case layout by creating and editing test cases to ensure all fields and sections are displayed as expected.

---

Recommendations

• Automation: Use scripts or tools to automate the backup and restoration process.

• Versioning: Maintain version control for backup files, including timestamps or version tags (e.g., v1.0, v2.0).

• Storage: Save backups securely, such as in a versioned cloud storage solution or a secure repository.

• Documentation: Keep a log of all backups and restorations, including the date, version, and any observed issues during restoration.

• API Security: You may want to backup all of the custom permissions for your API handlers, such as v1/servicedesk