Advanced Setup and Configuration
      Back to home
      1. Help Center
      2. Veonics® Portal Users Manual
      3. Advanced Setup and Configuration

      Overview of Veonics® Portal Structure and Features

      Summary: Technical overview of the Veonics® Portal’s data model, core/support elements, workflows, security/visibility, integrations, and deployment options.

      Audience: Admins, integrators, power users
      Prerequisites: Veonics® Portal admin access; familiarity with Record Properties/Record Setup and Template Designer

      🖥️ What is the Veonics® Portal (at a glance)

      • Cloud web app built in PHP with a MySQL database; photos stored via a service provider (secured filesystem or AWS S3).

      • Manages identities, photos, templates, printing, and vID rendering with granular roles/permissions and org hierarchy.

      🏗️ Architecture

      • Application: PHP services with admin and end-user UI

      • Database: MySQL (identity records & metadata)

      • Image storage: Service provider: Secured filesystem or AWS S3

      • Companion apps: VCDB, vPQM, vID (mobile app; uses shared APIs)

      🗂️ Core Elements

      🪪 Card Record

      Primary identity object with lifecycle states (e.g., New → Approved → Printed → Inactive). Each card has a unique ID, system fields, optional vID link (policy-controlled), and org/field-level access constraints.

      📸 Photo

      First-class object with an independent lifecycle and photo standard validation. Originals are preserved; edits create new versions with lineage and a cryptographic stamp for authenticity checks. Upload via bulk import, CELLfie™, or other flows.

      🧩 Record Properties (Group)

      Defines shared characteristics for a set of Card Records: Photo Standard, vID design/policy, and Record Setup used by the group. Supports Family membership to allow controlled moves between groups.

      ⚙️ Record Setup

      Field schema for a Card Record design (flat model). Activation generates system scaffolding used by the Portal to support the structure.

      🔑 Field Properties (highlights)

      Field type, Caption (UI label), Alias (system name), Order (display), Visibility (Public/Normal/MT1/MT2/Private), Critical Identifier, List/Search, Catalog binding, and Generated values.

      🔍 Critical Identifiers (de-duplication & sync)

      Define up to 10 identifiers (each can be multi-field). On import/sync, the system updates a matching record (all fields in an identifier must match) or creates a new one if no identifier matches. Enables flexible merges across disparate sources.

      🎨 Template Designer (Badge/vID)

      Graphical layout engine for badge/vID designs: conditional elements, computed fields, barcodes/QR, magstripe (RFID/chip future-ready). Designs render in real time to reflect card status and can drive visual conditions (e.g., expired/stolen).

      🏢 Organization & User

      Organization: Strict hierarchy (Root → Partner → Company → Division) scopes data and sharing.
      User: Assigned to an org with roles/permissions; UI exposes only permitted actions.

      🛠️ Support Elements

      • Standard: Photo quality/ratio/resolution rules and validation.

      • Catalog: Code/description lists bound to fields for dropdowns.

      • Queue: Print orchestration via vPQM (supports proofing queues).

      • Token: For CELLfie™, vID policy links, and short-lived API access.

      • Station: Authorized system identity for service calls.

      • Import/Export Definitions: Mapping templates for Excel/CSV/XML.

      • Notification: Event-driven email with org-level overrides/variables.

      • Learn more:
        • What is the Data Management section of the Veonics Portal?
        • How do you set up the Veonics® Print Queue Manager?

      🔄 Workflows (Lifecycles)

      • Card: New → Approved → (Enqueued) → Printed → (Shipped/Lost/Stolen/Reissue) → Inactive; exceptional transitions (reopen, reprint) are permission-gated.

      • Photo: Missing → Pending Validation → Accepted/Unacceptable.

      • Record Properties: New/Ready → Locked (config frozen while cards remain valid).

      • Record Setup & Templates: New/Active/Inactive; special actions carefully controlled.

      🔐 Security & Visibility

      • Permissions: 200+ granular permissions, with meta-permissions to protect permission changes.

      • Visibility: Hierarchy-driven reuse of definitions (Standards/Setups/Templates/Notifications) without exposing underlying data.

      🌐 Integration Mechanisms

      • VCDB APIs: JSON REST for Portal services

      • VCDB SFTP: Managed bulk data exchange

      • No unsolicited push to external systems (enable SFTP when needed)

      ☁️ Deployment Options

      • Shared Instance, Shared DB (current production; recommended)

      • Shared Instance, Dedicated Storage (large projects)

      • Dedicated Cloud Instance (large projects)

      • On-Premises (special cases; higher cost/overhead)

      🌍 Internationalization

      Framework supports multiple Western languages (~60% coverage prioritized by usage). Default fallback is American English (en_US).

      📚 Related Articles

      Last updated: August 19, 2025