RPC Methods

This module is not available in the current version. It will be available in a future version. Use this page for reference only.

RPC Methods defines remote procedure call (RPC) templates for each client type. Each template has a method name, a root node, and an XML payload.

Changes can affect remote operations and production behavior. Work in small steps and follow the safety flow: export, dry-run, import.

Where to find parameter descriptions: Open the create or edit dialog. The Method name, Root node, and Payload XML fields have a hint under the input. The details dialog shows the same hints.

When to use it

Use RPC Methods to do these tasks:

  • Review existing entries.

  • Search or filter to find an entry.

  • Export a snapshot as a backup before changes.

  • Import many changes from a prepared file. Dry-run is required.

  • Change single entries, if your role allows it.

  • Check what changed after an import or a change.

Before you start

  1. Open Angular Console → RPC Methods.

  2. If the page asks for a Client type, select it. Some deployments need this before data loads.

  3. Check the environment, the breadcrumbs, and the Client type before you change anything.

  4. Check your role.

Your role sets what you can do:

  • VIEWER: browse and export.

  • EDITOR and ADMIN: change and import.

If a requirement is missing, the module can show an empty page and disable the write actions.

Find an entry

  1. Open RPC Methods.

  2. If the page has filters or search, use them to narrow the list.

  3. Open an entry to read its details.

Expected result:

  • The page shows a list of entries.

  • The details view shows the fields of the entry.

  • A VIEWER sees the entry as read-only.

Export a snapshot

  1. Open RPC Methods.

  2. Click Export.

  3. Save the downloaded file as your backup.

For details, see Export a Snapshot.

Import with dry-run

Import is the safest way to apply many changes at once. Always follow this order: export, dry-run, apply.

  1. Export a snapshot first: Export a Snapshot.

  2. Click Import.

  3. If the page shows import modes, select MERGE or REPLACE.

  4. Upload the prepared file.

  5. Wait for the dry-run to finish.

  6. Review the plan (created, updated, deleted) and all warnings and errors.

  7. Confirm the import only if the plan matches your intent.

Import safety checklist

  1. Check the environment name.

  2. Check the selected client type. It must match the file.

  3. Export a snapshot before you change data.

  4. Run Dry-run and review:

    • the errors: you must fix them,

    • the warnings: you must understand them,

    • the create, update, and delete counts.

  5. If you use REPLACE, review the deletions in the dry-run plan. Continue only if you accept them.

  6. Apply the import.

  7. Refresh the page and open the changed entries to check them.

REPLACE can delete the entries missing from the imported file. If the delete count is large, stop. Check the file for missing entries. Check the selected client type.

Change an entry

You need the EDITOR or ADMIN role.

  1. Open the entry.

  2. Click Edit.

  3. Change the fields.

  4. Click Save.

  5. Refresh the page and open the entry again.

Expected result:

The entry shows the saved values.

Export a snapshot before large manual changes. The snapshot helps you check the changes and restore the old values.

Check the result

  1. Check the environment name.

  2. Check the selected Client type, if the page shows one.

  3. Click Refresh, or open the module again, to load the latest data.

  4. Open each changed entry and check the values.

  5. Check a few unchanged entries to find unwanted changes.

  6. After an import, compare the real changes with the dry-run plan.

  7. Optional: export a new snapshot for audit: Export a Snapshot.

Troubleshooting

The page shows no data

A requirement can be missing, for example the Client type selection. Select the Client type. Clear the filters and the search field.

You cannot change or import

You are probably signed in as VIEWER. Only EDITOR and ADMIN can change and import.

Dry-run shows errors

The file can have a wrong structure. Export a snapshot, apply your changes to it, and run the dry-run again.

Dry-run shows many deletions

You can have selected REPLACE, or the file is incomplete for the current client type. Check the selected client type and create the file again from a snapshot.

Save is disabled or blocked

The form shows validation errors. Fix them and click Save again.

Related pages

RPC Methods: main screen (placeholder)