Administrator Guide

This guide walks you through every feature available in the Creatiq Admin Panel. It is intended for users with the admin role.

Table of Contents

1. Getting Started
2. Curriculum Management
3. H5P Library Management
4. Tenant and Whitelabel Branding
5. Subscription Management
6. Feature Flags
7. Platform Info
8. API Keys for SDK and Integrations

1. Getting Started

Who Can Access the Admin Panel?

Only users with the admin role can open the Admin Panel. If you try to visit the panel with a different role, you will be redirected to the workspace.

Opening the Admin Panel

1. Log in to Creatiq with your admin account.
2. From the workspace, click the Admin link in the navigation menu (or go directly to /admin).
3. The Admin Panel loads with three main sections: Curriculum Management, H5P Library Management, and Platform Info.
4. To return to the workspace at any time, click the Back to Workspace arrow button in the top-left corner of the header.

2. Curriculum Management

The Curriculum Management section lets you synchronize curriculum frameworks from the EduAgentic Central Curriculum (ECC) service. These frameworks provide the grade levels, subjects, topics, and learning objectives that teachers can tag to their content.

Viewing Frameworks

When the Admin Panel opens, the platform automatically loads all curriculum frameworks that have been synced previously. Each framework card shows:

• Framework name (e.g., "Turkish National Curriculum")
• Country badge (e.g., TR, US, UK)
• Last sync date and time
• Number of grades available in the framework
• Number of subjects available in the framework

If no frameworks have been synced yet, you will see a message saying no frameworks are available.

Syncing All Frameworks

1. In the Curriculum Management card, click the Sync All button in the top-right corner.
2. The button changes to a spinning indicator and the label changes to "Syncing...".
3. Wait for the sync to complete. This may take a few seconds depending on how many frameworks are available from the central service.
4. When finished, a green success banner appears at the top of the page confirming the sync succeeded.
5. The framework list and sync history refresh automatically.

Syncing a Single Framework

1. Find the framework you want to update in the list.
2. Click the Sync button on that framework's row.
3. The button shows a spinning indicator while the sync is in progress.
4. A success or error message appears at the top of the page when the operation finishes.

Viewing Sync History

Below the framework list, the platform displays the most recent sync operations (up to 10 entries). Each entry shows:

• Status icon: a green checkmark for success, a red X for failed, or a spinner for in-progress
• Framework name that was synced
• Date and time the sync started

Use the sync history to verify that your latest sync completed successfully or to troubleshoot failed syncs.

3. H5P Library Management

H5P libraries are the building blocks that power interactive content types (quizzes, presentations, videos, and more). Before teachers can create content of a particular type, the corresponding library must be installed on your platform.

Understanding the Library Status

At the top of the H5P Library Management card, a progress bar shows how many essential libraries are installed out of the total available. For example, "12 of 48 essential libraries installed." This gives you a quick overview of your platform's readiness.

Installing Essential Libraries

Essential libraries are the core set of content types most commonly used by educators.

1. Click the Install Essentials button in the top-right area of the H5P Library Management card.
2. The button label changes to "Installing..." with a spinner.
3. When finished, a notification appears showing how many libraries were installed and how many failed (if any).
4. The library lists and status bar refresh automatically.

This is the recommended first step after setting up a new Creatiq instance.

Browsing Available Content Types

1. In the H5P Library Management card, click the Available Types tab.
2. A searchable grid of all content types from the H5P Hub appears.
3. Use the search box at the top to filter by name, machine name, or description.
4. Each card shows:
   • Icon (if available)
   • Title of the content type (e.g., "Interactive Video", "Course Presentation")
   • Short description of what it does
   • Machine name (the technical identifier, e.g., H5P.InteractiveVideo)
   • Installed badge (green) if the library is already installed
   • Install button if it is not yet installed

Installing a Single Library

1. Find the content type you want in the Available Types tab.
2. Click the Install button on its card.
3. The button changes to "Installing..." with a spinner.
4. A success or error notification appears when the operation finishes.
5. Once installed, the card shows a green "Installed" badge instead of the Install button.

Viewing Installed Libraries

1. Click the Installed Libraries tab.
2. A sorted list of all currently installed libraries appears.
3. Each row shows the machine name and the version number.

Use this tab to verify which libraries are available on your platform.

Refreshing the Content Type Cache

If the Available Types list seems outdated or you know new content types have been published to the H5P Hub:

1. Click the Refresh Cache button (next to the Install Essentials button).
2. Wait for the refresh to complete.
3. The available content types list reloads with the latest data from the H5P Hub.

4. Tenant and Whitelabel Branding

Whitelabel branding allows you to customize the look and feel of your Creatiq instance. This feature is available on the Premium plan only.

Branding Options

You can customize the following brand settings:

Updating Brand Settings

1. Navigate to the tenant branding settings (available from the admin area or via the API).
2. Enter the values you want to change. You do not need to fill in every field -- only the fields you provide will be updated.
3. Save the changes.
4. The platform applies the new branding immediately for all users in your tenant.

Setting Up a Custom Domain

With a Premium plan, you can serve Creatiq from your own domain name (e.g., learn.yourschool.edu).

1. Choose a subdomain or domain you own (e.g., content.myacademy.com).
2. In your DNS provider, create a CNAME record pointing your custom domain to the Creatiq platform address provided by your account manager.
3. Update the custom domain setting in the admin panel with your chosen domain.
4. Wait for DNS propagation (this can take up to 24 hours, but usually completes within minutes).
5. Once active, users can access your branded Creatiq instance at your custom domain.

Domain format requirements: The domain must contain only lowercase letters, numbers, dots, and hyphens. It must start and end with a letter or number.

5. Subscription Management

Creatiq offers three subscription plans. Your current plan determines which features are available and what usage limits apply.

Plan Overview

Upgrading Your Plan

1. From the workspace or the pricing page, select the plan you want to upgrade to.
2. Click the upgrade button for your chosen plan.
3. You will be redirected to a secure Stripe checkout page.
4. Enter your payment details and confirm.
5. Once payment is processed, your plan is upgraded immediately and the new limits take effect.

Managing Your Billing

If you are already on a paid plan (Pro or Premium), you can manage your subscription through the Stripe billing portal:

1. Access the billing portal from your account settings.
2. You will be redirected to a secure Stripe portal where you can:
   • View your current subscription and billing cycle
   • Update your payment method
   • Download past invoices
   • Cancel or change your subscription
3. Changes made in the billing portal take effect immediately.

6. Feature Flags

Different features are available depending on your subscription plan. The table below shows which features are included in each plan.

Free Plan Features

The Free plan includes basic content creation and viewing. No advanced features are included.

Pro Plan Features

Everything in Free, plus:

• PDF to H5P -- Convert PDF documents into interactive H5P content
• Image Hotspot -- Create interactive images with clickable regions
• URL to H5P -- Generate H5P content from a web page URL
• Bloom's Critique -- AI-powered analysis of content against Bloom's taxonomy
• Differentiation -- AI-powered content differentiation for diverse learners
• Bulk Generation -- Create multiple content items in a single operation
• Analytics Dashboard -- View usage and engagement analytics
• Content Remixer -- Remix and adapt existing content
• cmi5 Launch -- Launch content using the cmi5 standard
• SCORM Export -- Export content in SCORM format for LMS compatibility

Premium Plan Features

Everything in Pro, plus:

• Video to H5P -- Convert video files into interactive H5P content
• Lesson Bundle -- Package multiple content items into a structured lesson
• Branching Scenario -- Create adaptive learning paths with branching logic
• AI Recommendation -- Get AI-powered content suggestions
• LTI Integration -- Connect with learning management systems via LTI 1.3
• LTI AGS -- Assignment and Grade Services for LTI grade passback
• LTI NRPS -- Names and Role Provisioning Services for LTI roster sync
• Whitelabel -- Custom branding, logo, colors, and custom domain

Checking Feature Availability

When you attempt to use a feature that is not included in your current plan, the platform displays a message indicating the minimum plan required. Upgrade your plan to unlock the feature.

7. Platform Info

The Platform Info card at the bottom of the Admin Panel displays a quick summary of your account:

• Role -- Your current role in the platform (e.g., admin).
• Plan -- Your current subscription plan (Free, Pro, or Premium).
• Email -- The email address associated with your account.

This section is read-only and is provided for quick reference. To change your plan, see the Subscription Management section.

8. API Keys for SDK and Integrations

API keys allow external applications to embed Creatiq features using the UI SDK. Each API key is scoped to a tenant and includes origin restrictions for security.

What Is an API Key?

An API key is a secret string that identifies your tenant when an external application connects to Creatiq. It is used in the SDK token exchange flow:

1. Your application sends the API key along with user information to the Creatiq API.
2. Creatiq verifies the key, provisions the user if needed, and returns a scoped JWT token.
3. Your application uses this token to initialize the Creatiq UI SDK.

API Key Properties

Best Practices for API Keys

1. Never expose API keys in client-side code. The token exchange should happen on your server, not in the browser.
2. Restrict allowed origins. Only add the specific domains that need access.
3. Use separate keys for different environments. Create one key for development, one for staging, and one for production.
4. Deactivate unused keys. If an integration is retired, deactivate its API key promptly.
5. Rotate keys periodically. Create a new key, update your integration, then deactivate the old key.

Token Exchange Flow

For developers integrating Creatiq into an external application:

1. Your server sends a POST /api/sdk/token request with the API key and user details:
   • apiKey -- your SDK API key
   • user.externalId -- the user's ID in your system
   • user.email -- the user's email address
   • user.name -- the user's display name (optional)
   • user.role -- the user's role (optional)
2. Creatiq validates the API key and origin, provisions or finds the user, and returns a JWT token along with user and tenant information.
3. Pass this token to the Creatiq UI SDK to initialize the embedded experience.

For full technical details, refer to the SDK and Embedding Reference.

Frequently Asked Questions

Q: I cannot access the Admin Panel. What should I do? A: Ensure you are logged in with an account that has the admin role. Non-admin users are automatically redirected to the workspace.

Q: A curriculum sync failed. How do I retry? A: Click the Sync button again for the specific framework, or use Sync All. Check the sync history to confirm the new attempt succeeded.

Q: The Install Essentials button shows some failures. Is that a problem? A: Some libraries may fail due to temporary network issues with the H5P Hub. Try clicking Install Essentials again. If failures persist, contact your system administrator.

Q: I changed the branding but users do not see the update. A: Ask users to refresh their browser. The new branding applies on the next page load. If you are using a CDN, cached assets may take a few minutes to update.

Q: How do I know which plan I am on? A: Check the Platform Info card at the bottom of the Admin Panel. Your current plan is displayed there.

Q: Can I downgrade from Premium to Pro? A: Yes. Use the Stripe billing portal to change your subscription. Features exclusive to the Premium plan will become unavailable after the current billing period ends.