Documentation · Admin Reference

System And Help Reference

This document is a reference for the System & Help screen of the ADP Car Market Hub plugin (Car Market Hub → System & Help). It explains the connectivity, background-task, server, log-file and image-queue panels surfaced by this health view.

When to use this document

Read this if you need to:

  • Confirm that the AutoScout24 API, the plugin's REST endpoint and the Market Hub API are reachable.
  • See whether scheduled tasks (cron jobs) are healthy and when they will next run.
  • Trigger an import, image-queue run or queue purge from a single place.
  • Check that the server meets the plugin's requirements (PHP version, memory, execution time).
  • Inspect the log file size and rotation state, and the image-import queue health.

Overview

The screen is a read-mostly health dashboard. A top action bar above the cards includes a Download Diagnostics button — labelled Download Diagnostics ZIP, or Download Diagnostics JSON when ZIP support is unavailable on the server — which downloads a diagnostics bundle you can attach to a support request.

The screen is divided into the following cards:

  • Connectivity & API — AutoScout24 API status, OAuth2 token state, plugin REST endpoint check and Market Hub API status.
  • Private Update Diagnostics — update and version diagnostics with a copyable JSON report.
  • Background Tasks — list of scheduled cron events with their schedule and next run time, plus action buttons.
  • Plugin Requirements — minimum versions and feature flags.
  • Server & Storage — PHP configuration, server environment and uploads-directory health.
  • Log File Status — current log file size, rotation state and path.
  • Image Queue Status — pending images, last worker run statistics.

Each row uses traffic-light badges (ok, warn, bad) with tooltips that explain the threshold or remediation step.

Requirements or prerequisites

  • A user with the plugin's management capability.
  • For the connectivity checks: outbound HTTPS access from the web server to the configured API endpoints.
  • For the REST API check: WordPress pretty permalinks enabled.
  • For the cron section: WordPress's built-in cron must be active, or a server-side scheduler must call wp-cron.php.

Step by step instructions

Verify connectivity

  1. Open Car Market Hub → System & Help.
  2. In Connectivity & API, check: - AS24 API Endpoint Status and AS24 API Reachability for the AutoScout24 base URL. - Token Status (Valid / Expires soon / Expired / No token). - REST API Status for the plugin's as24ci/v1/cron-import endpoint. - Market Hub Reachability for the Market Hub API.
  3. Hover any badge for the tooltip with the underlying detail (HTTP status, latency or error message).

Review update diagnostics

  1. Open the Private Update Diagnostics card in the right column.
  2. Read the rows to confirm the plugin's update channel is healthy: the installed version, whether update hooks are registered, the remote new version offered, transient (cached update data) consistency, the license status and the normalized domain.
  3. If you contact support about an update or licensing problem, use the copyable JSON report at the bottom of the card and paste it into your ticket.

This card is a quick way to confirm that the plugin can see and apply private updates without exposing any sensitive credentials.

Check scheduled tasks

  1. Scroll to Background Tasks.
  2. The card header shows a badge indicating whether scheduling runs through WP-Cron or a Server Cron, together with a heartbeat note such as Last import ran X ago or No recent import run detected.
  3. Review the table: each row shows the cron task, its schedule, the next run timestamp and a status badge. Tasks can include import, image-queue, analytics and Pricing Analysis jobs.
  4. Alongside the normal next-run state, a task may report Lock stuck, Handled by server cron or Not scheduled.
  5. If WordPress's built-in cron is disabled (DISABLE_WP_CRON), a warning is displayed; in that case, set up a server-side scheduler that calls wp-cron.php.
  6. Use the inline buttons to Run Import Now, Run Image Queue Now or Clear Image Queue when needed.

Verify server compatibility

  1. Read Plugin Requirements for the minimum versions and feature flags, including ZipArchive availability and the ionCube Loader status (with its Loader Version).
  2. Read Server & Storage for PHP configuration: - memory_limit, WP Memory Limit, max_execution_time, upload_max_filesize, post_max_size, max_input_vars. - PHP SAPI and Server OS. - Uploads directory state and free disk space.

Inspect the log file and image queue

  1. Log File Status shows whether the log file exists, its current size, the remaining headroom before rotation, the last rotation time and the file path.
  2. Image Queue Status shows pending image imports plus statistics from the last worker run (processed count, errors, remaining items).

Configuration reference

The System & Help screen does not store its own settings. It reads from current WordPress configuration, plugin options and runtime status.

Connectivity & API badges

RowPossible states
AS24 API Endpoint Statusok (configured and reachable), bad (no base URL or unreachable).
AS24 API ReachabilityLatency-style result with ok / warn / bad; labels such as Connection active, Host reachable, API endpoint not verified, or Server error (HTTP n). Cached for 60 seconds.
Token StatusValid, Valid — expires <time>, Expires soon (less than 5 minutes), Expired, No token.
REST API StatusEndpoint reachable, e.g. Active, token protection works (the endpoint rejects an invalid health-check token with HTTP 403); REST endpoint not found (HTTP 404); or unreachable.
Market Hub ReachabilitySimilar pattern to the AS24 API check.

Exact label wording can differ slightly between plugin versions; rely on the badge colour and the tooltip detail rather than the precise text.

The REST API row is only fully checked when a cron token has been generated in Import And Limits. Otherwise it shows Not checked — no cron token configured.

Private Update Diagnostics

This card surfaces the plugin's update and licensing health. Its rows typically include the installed version, whether update hooks are registered, the remote new version offered, transient (cached update data) consistency, the license status and the normalized domain. A copyable JSON report at the bottom packages these values for support.

Server thresholds

Settingokwarnbad
memory_limit≥ 256 MB or unlimited128–255 MB< 128 MB
max_execution_time> 60 s or unlimited30–60 s< 30 s

The other PHP values (upload_max_filesize, post_max_size, max_input_vars, uploads directory writability, free disk space) are presented with their current values and a contextual badge.

Background-task actions

ButtonEffect
Run Import NowTriggers the regular import once, immediately.
Run Image Queue NowProcesses the next batch from the image queue.
Clear Image QueueEmpties the pending image queue. Destructive.

Operational notes

  • Connectivity checks use a short timeout and a custom user agent and cache their result for about one minute to avoid hammering the upstream services. They do not all use the same HTTP method: the AutoScout24 check issues a HEAD request, while the plugin REST self-check and the Market Hub health probe use GET (the Market Hub probe targets a /v1/health endpoint).
  • The Download Diagnostics button in the top action bar produces a diagnostics bundle (a ZIP where supported, otherwise a JSON file) for attaching to a support request.
  • The token expiry tooltip uses the WordPress site time zone for display, but the cached value is stored as a UNIX timestamp.
  • The REST API check intentionally uses an invalid token — a healthy installation responds with HTTP 403. HTTP 404 indicates the endpoint is not reachable (typically a permalinks or rewrite issue).
  • If DISABLE_WP_CRON is active, scheduled tasks will not run unless the host is configured to call wp-cron.php on its own. Imports and image processing will appear stuck without it.
  • The image-queue warn badge appears when the queue size exceeds the plugin's internal threshold (currently 1,000 pending items).
  • Free disk space is reported as best-effort. Some hosts hide this; in that case the badge shows Unable to determine.

Troubleshooting

  • AS24 API Reachability is bad. The Base URL in Settings is missing, malformed or the upstream is down. Check the tooltip for the underlying error.
  • Token Status is No token. Save valid Client ID and Secret in Settings, then run Test Connection on Tools.
  • REST API Status reports the endpoint was not found (HTTP 404). Pretty permalinks are off, or another plugin is overriding REST routing. Re-save permalinks under Settings → Permalinks.
  • REST API row says "Not checked — no cron token configured." Open Import And Limits and generate a cron token.
  • Background tasks have a stale "Next Run". WordPress cron is disabled or no traffic is hitting the site. Use the Run Import Now button to confirm the task itself runs, then schedule a server-side trigger.
  • memory_limit flagged bad. Increase memory_limit in php.ini or wp-config.php (define('WP_MEMORY_LIMIT', '256M');) — required for large imports.
  • Image queue keeps growing. Click Run Image Queue Now to process a batch. If the count keeps rising, reduce the number of imported images per vehicle in Settings or increase the worker run frequency in Import And Limits.
  • Log file flagged bad or No log file yet. Confirm the log directory is writable. Verify in the current plugin version before publishing.