Skip to main content
Parsium Documentation

Setup & Installation

How to get Parsium into your Salesforce org and complete the initial setup. Most of this is handled by the Twilon team during onboarding, but you can follow these steps to do it yourself.

Deploy the Package

  1. Install Parsium from the Salesforce AppExchange listing or deploy the package URL provided by your administrator.
  2. Select Install for All Users (recommended) or choose specific profiles.
  3. Wait for the installation email from Salesforce confirming the package is ready.
  4. Verify installation by navigating to Setup > Installed Packages and confirming Parsium appears in the list.

Named Credential Setup

~10 minutes

Parsium connects to AI models through OpenRouter. To make this connection secure, Salesforce uses a Named Credential to store and manage the API key. Follow these five steps carefully.

Step 1: Create External Credential

An External Credential is where Salesforce stores your API key securely. Think of it as a locked vault for sensitive information.

  1. Navigate to Setup > Named Credentials > External Credentials
  2. Click New
  3. Fill in these fields exactly:
    • Label: Parsium Auth
    • Name: Parsium_Auth (auto-fills after typing the label)
    • Authentication Protocol: Custom
  4. Click Save

The Name field must be exactly Parsium_Auth. If you use a different name, you will need to update the Authorization header value in Step 4 to match.

Step 2: Add Principal with API Key

A Principal holds the actual API key value. You are registering your OpenRouter credentials here.

  1. On the External Credential you just created, scroll to the Principals section
  2. Create a new Principal:
    • Parameter Name: Parsium_Principal
    • Sequence Number: 1
    • Identity Type: Named Principal
  3. Add Authentication Parameter:
    • Name: apiKey (case-sensitive, must be lowercase)
    • Value: Your OpenRouter API key (starts with sk-or-v1-)

Don't have an API key yet? Create a free account at openrouter.ai/keys and generate one. You will need to add credits before making API calls.

Step 3: Create Named Credential

The Named Credential is the actual connection endpoint that Parsium uses to call the OpenRouter API.

  1. Navigate to Setup > Named Credentials
  2. Click New
  3. Fill in these fields exactly:
    • Label: Parsium OpenRouter
    • Name: Parsium_OpenRouter
    • URL: https://openrouter.ai/api/v1
    • External Credential: Parsium_Auth (the one you created in Step 1)

Step 4: Configure Authorization Header

This header tells OpenRouter who you are on every API call. It automatically inserts your API key from the External Credential.

  1. On the Named Credential, scroll to Custom Headers
  2. Add a new header:
    • Name: Authorization
    • Value: Bearer {!$Credential.Parsium_Auth.apiKey}

Copy the value exactly as shown. The Parsium_Auth part must match the Name of your External Credential from Step 1. If you used a different name, replace it here.

Step 5: Grant Permission Set Access

Without this step, users will not be able to use the API connection even if they have the Parsium permission set.

  1. Navigate to Setup > Permission Sets
  2. Open Parsium_Admin (repeat for Parsium_User if end users will run extractions)
  3. Click External Credential Principal Access
  4. Add Parsium_Auth - Parsium_Principal to the Enabled list
  5. Click Save

Setup complete. Open the Parsium Settings tab in your org and go to the Credentials tab to test your connection. You should see a green "Connected" badge.

Permission Sets

Parsium ships with two permission sets that control who can do what. Assign them in Setup > Permission Sets.

Parsium_AdminFull Access

For Salesforce administrators who need to configure Parsium settings, manage field mappings, and run extractions.

  • Full read/write access to Parsium Settings (custom hierarchy setting)
  • Full CRUD on Field Mapping records
  • Full CRUD on Usage Log records
  • Access to the Parsium Settings tab (model selection, privacy, credentials)
  • Access to the Extraction Wizard
  • Access to all Apex controllers and LWC components
Parsium_UserStandard User

For end users who only need to run the extraction wizard on their records. They cannot change settings or modify field mappings.

  • Read-only access to Parsium Settings
  • Read access to Field Mapping records (to know which fields are mapped)
  • Create and Read access to Usage Log records (their own extractions are logged)
  • Access to the Extraction Wizard only

Users with this permission set cannot open the Settings tab, change the AI model, or modify field mappings. They can only run extractions using the configuration set by an admin.