Ad Hoc Admin Query

The Ad Hoc Query Admin frame helps facilitate synchronizing data between M5 and the Izenda configuration database.

When Ad Hoc is initially installed or setup, an ad hoc admin user should navigate here and select the buttons in the order they are on the frame (top to bottom). If the client is
multi-company, this will need to be done for each company.

When a user navigates to the Ad Hoc Query frame, the tenant, data sources, roles (for that user only), and user information (for that user only) are synchronized if they haven’t already been synchronized. Because the Data Source synchronization can take several minutes, it is best for an Ad hoc Admin to synchronize from the Ad hoc Query Admin screen before any users navigate to the Ad Hoc Query frame.

Each button calls a custom web service endpoint:

Sync Tenant: Creates or updates a tenant in the Izenda Database. The tenant is used for the same purpose as M5 uses company. The tenant name/id is equal to the M5 company code. This typically only needs to be done when Ad Hoc is initially installed/setup. Running it more than once won’t hurt but is not necessary. There is an M5 Param called: M5_PARAM ‘ADHOCBI_TENANT_ID’. The default value for this parameter is the company code.
Sync Data Sources: Creates or updates the connection string to the M5 database, the M5 database schema, the M5 views that can be used in a report.

This should be done when Ad Hoc is initially installed/setup. It should also be done anytime an M5 patch is installed (to ensure any changes to the M5 database schema are reflected in the Izenda database) or anytime a new object is added to the Ad Hoc Objects frame (so that object will be marked as usable on a report).
This can take several minutes. For best results, an admin should run it here on this screen rather than let the token web service endpoint create the data source.

Sync All Roles: Creates or updates all roles in Izenda as defined on the M5 Ad Hoc Group Maintenance frame. Can be optionally run to create Roles in Izenda based on Ad Hoc Groups. Three Roles will be created in Izenda per Ad Hoc Group. One starting with A-, one starting with C-, one starting with R-.

Ex: C-All. This should be run anytime Ad Hoc Objects are added to or removed from an Ad Hoc Group. The A-, C-, R- equate to the Ad Hoc access granted to a user on the Application User screen. It determines whether a user can create a report, or only view a report (A- = Report Admin, C- = Create Reports, R- = Run Reports).
If this is not run, the Roles that are assigned to a user will be synchronized the first time they navigate to the Ad Hoc Query screen. Is this why we see the gears running every time we enter this frame? The user can also re-synchronize their roles by clicking the ‘ReSync Roles’ button on that frame.

Sync All Users: Creates or updates all users in Izenda as defined on the M5 Application User Maintenance frame. The user’s information will be synchronized when they visit the Ad Hoc Query frame. An Admin may want to run this button when there are users that have been disabled. Those users will not be able to log in because they are disabled, but another user may be able to see the disabled user in the Ad hoc UI when doing things such as sharing a report with another user.

Ad Hoc Admin Query

See also: