Dealer Branding Download

APIEngine periodically pulls dealer-logo images from FileServer and mirrors them to local folders. Reporting reads the mirror to render dealer logos on PDF reports; the SMSMedia.Directory folder is also the SMS/MMS media root.

Version differences

How it works

1. A cycle runs each time the interval in the table above has passed.
2. Each cycle calls DealerBrandModel.List("dealer_brand=dealer_brand", false), which goes through the standard FileServer pipeline (Sybase proc ba_file_server_geta filtered by the dealer_brand=dealer_brand tag).
3. For each returned file, the service compares filename / create_date / size against dealer_images_manifest.json in each mirror folder. If new, changed, or missing on disk, it downloads the bytes from FileServer.Path + guid, writes them with FileShare.None, and verifies length matches.
4. After processing, the manifest is rewritten and CleanUpFilesNotInManifest deletes any local file not in the new manifest, except files ending in manifest.json and default.png (case-insensitive), which are always preserved.

If SMSMedia.Directory is empty the service no-ops. If the mirror directory does not exist it is created via Ibs.Utils.PathManager.CreateDirectoryWithPermissions; if it already exists, the service grants Everyone : FullControl on it before writing.

Settings (apiengine.settings)

There is no separate DealerBranding config block - the same SMSMedia settings drive both SMS media and dealer-image mirroring (intentional: same on-disk directory).

Upload side

Operators upload dealer logos via POST /api/v1/dealerbrand/reportlogo/inject/{deal_id} (DealerBrandController.ReportLogoInject -> DealerBrandModel.DealerBrandInject_150_150).

• The user must pass a v_dealer access check for {deal_id}.
• Any existing report logo for that dealer is deleted (header + physical folder under FileServer.Path) before the new file is injected.
• The new file is stored with tags deal_id={deal_id}&dealer_brand=dealer_brand&dealer_brand_size=150_150, description Dealer Brand - 150x150, and a deterministic filename {deal_id}_dealer_brand_150_150{ext}.
• Note: the _150_150 is a tag/filename convention, not server-side image-dimension enforcement. The controller does not measure or resize the upload - callers are expected to send a 150x150 PNG.

Other endpoints on the same controller

The routes are the same in v95 and v96 and later. All of them require a token.

External consumer (non-APIEngine apps)

Ibs.DealerBrandingDownload (Ibs\Utils\ibsDealerBrandingDownload.cs) is a REST client that performs the same mirror logic from outside APIEngine - it authorizes against APIEngine, calls api/v1/dealerbrand/reportlogo/list, then downloads each file via api/v1/dealerbrand/reportlogo/retrieve/{guid}. It writes the same dealer_images_manifest.json and applies the same default.png / *manifest.json cleanup exclusions. Reporting (Crystal) and other external utilities use this wrapper rather than re-implementing the protocol.

Operational notes

• Manifest file: dealer_images_manifest.json in each mirror folder.
• default.png and any *manifest.json are never pruned even if absent from the manifest.
• If logos are missing on reports, check the manifest timestamp and ibs.log for Checking for new dealer images. / Dealer images found: N lines, then per file Downloading new or updated file: / Saved N bytes to <path> (v96 and later) or File <name> is new or updated, downloading to <path>. (v95 and earlier).
• AppPool identity needs Modify on the mirror directory (the service explicitly grants Everyone : FullControl on existing dirs as a safety net, but the directory must be reachable from the site root in v95 and earlier, or AppContext.BaseDirectory in v96 and later).

Propagation of Deleted Branding Images

Dealer Branding images deleted in program 1537 are removed from all propagated locations, including the report service and APIEngine media.