PosiEd Installation - PosiEd

PosiEd Installation - PosiEd

In this step, while logged in as an administrator, you’ll execute the PosiEd installation scripts. These scripts perform various configuration changes, install all required packages for PosiEd, and load required data records into your Salesforce org.

PosiEd has two versions, depending on whether your Salesforce environment uses Education Industry Cloud/Agentforce Education or not. The following package combinations explain what each option is for and which packages are included:

  • PosiEd with Agentforce Education: This option is for organisations using Salesforce Education Industry Cloud/Agentforce Education. It includes:

    • PosiEd

    • K-12

    • EDC AUS

  • PosiEd without Education Industry Cloud: This option is for organisations that are not using Salesforce Education Industry Cloud. It includes:

    • PosiEd

    • K-12

The required packages can be installed by applying the appropriate YML script using the instructions in the YML Set up Guide below.

If you wish to manually install and configure it instead of using the YML scripts, then click here: PosiEd Manual Installation for manual instructions.

If you are new to Salesforce development or need a refresher on setting up your environment, we recommend reviewing these Salesforce Trailhead guides before continuing with the installation:

YML Setup Guide

The YML Setup Guide outlines the available deployment options and the steps required to install and configure PosiEd using the provided YML scripts.

🚀 Prerequisites & Initialization

Before running any deployment scripts, follow these steps to initialize your local workspace and connect to your target Salesforce environment.

Software Prerequisites

The following software needs to be obtained and installed into your environment to enable you to complete the YML steps:

  • VS Code (development environment)

  • Git (provides the Git Bash terminal)

  • Salesforce CLI (command line interface for executing commands and scripts)

  • Salesforce Extension Pack (tools to link VS Code to Salesforce)

Step 1: Salesforce Project

To begin, you must first set up a local Salesforce project directory using the YML script.

  1. Download the YML Script folder from the Partner Resources.

  2. Extract the YML Script: Locate the YML script .zip file you downloaded from Partner Resources and extract its contents to a folder on your computer.

  3. Open the Folder: Open the extracted folder. This folder is your working directory.

  4. Open your terminal: Before running commands, you need to open a terminal. A terminal is a text-based tool where you can type commands to open folders, install packages, run setup steps, and start the project.
    For this guide, you should have VS Code installed on your computer because we use it to open the project folder, view and edit files, and run terminal commands in one place.
    VS Code (Visual Studio Code): A code editor used to open, view, and edit project files. It includes a built-in terminal so you can work on your code and run commands in the same window.

    • Open your VS Code

    • Go to File > Open Folder and select your extracted folder.

      image - 2026-08-05T105254.046.png

       

      image - 2026-08-05T104346.726.png
    • Then go to Terminal > New Terminal (or press Ctrl + `).

      image - 2026-08-05T105424.195.png
    • Click the arrow down button () and select Git Bash.

      image - 2026-08-05T113254.467.png
  5. Run the command:

Run this command to generate a clean project structure in your current directory:

sf project generate --name . --manifest --output-dir .
  • --name . — Uses the current directory as the project name.

  • --manifest — Generates a package.xml manifest file.

  • --output-dir . — Outputs the project structure directly into your current folder.

image - 2026-08-05T113555.402.png
  1. Wait for completion: You should see a success message and new files/folders generated (e.g., force-app/, manifest/package.xml, sfdx-project.json).

Step 2: Update Package Codes

  1. In VS Code under the YML Scripts folder open package-ids.env

  2. Copy the contents and email to Posimente Support with a request for them to populate it with the current package IDs.

  3. Paste the filled content into the file and Save changes.

Step 3: Reload VS Code

To ensure VS Code loads the new Salesforce project structure and activates the Salesforce Extension Pack correctly, reload your window:

  1. Open the Command Palette: Press Ctrl + Shift + P (or Cmd + Shift + P on macOS).

  2. Run the Reload Command: Type Developer: Reload Window and select it from the list.

  3. Verify: Once reloaded, you should see the Salesforce cloud icon in the left-hand sidebar, indicating the extensions are active.

Step 3: Authorize the Target Org

⚠️ Critical: You must authorize your target org before running any script.

image - 2026-08-05T134101.491.png
  1. Run the Login Command: In your terminal, copy and paste the following:

sf org login web --alias <your-org-alias> --set-default
image-20260805-054338.png
  1. Log In: A browser window will open automatically. Enter your Salesforce credentials for the target org and click Log In.

    image-20260805-054712.png
  2. Allow Access: If prompted, click Allow to grant the Salesforce CLI access to your org.

  3. Confirm: Once the browser says "Authentication Successful," you can close it and return to VS Code.

🛠️ Run a Deployment Script

Choose the option below that matches your target org's configuration. For each option, you can choose between Install and Deploy (or Master) and Deploy Only (which skips package installation if they are already present).

To deploy the scripts, follow the steps below:

  1. Identify the Script: In your working directory, locate the .sh file that corresponds to your installation requirements. These scripts must be run using the source command (e.g., source posied-base-and-k12-master.sh ...) rather than executed directly (e.g., ./posied-base-and-k12-master.sh). Also run them from inside this YML Scripts folder — don't cd into a subfolder first.

  2. Execute the command: Copy and paste the appropriate command for your selected option into your terminal. Make sure you use the source command. Please refer to the options below.

    1. PosiEd without Education Industry Cloud

    2. PosiEd with Agentforce Education

  1. Important Execution Rule: Always use the source command (e.g., source scriptname.sh) rather than ./scriptname.sh. This ensures that the script runs within your current shell session and correctly inherits all environment variables and Salesforce CLI authorizations.

  2. Monitor Progress: The script will now begin installing packages and loading data. This may take several minutes. Do not close the terminal until you see a final success message.

Option A: PosiEd — Base + K-12

The standard setup — every PosiEd client gets this combo.

Mode

Behavior

Mode

Behavior

Install and Deploy

Installs PosiEd Base and PosiEd K-12, then deploys and configures everything.

Deploy Only

Skips installations and only deploys and configures the settings.

# Option A1: Install and Deploy source PosiEd-Base-and-K-12.sh "PosiEd-Base-and-K12/postConfig" "Install and Deploy" "PosiEd-Base-and-K12" # Option A2: Deploy Only source PosiEd-Base-and-K-12.sh "PosiEd-Base-and-K12/postConfig" "Deploy Only" "PosiEd-Base-and-K12"

Before running, make sure PosiEd-Base-And-K12/postConfig/config-data/.env has been filled in for this client (copy it from .env.example in the same folder if it doesn't exist yet), and that PosiEd_Value_Mapping__c.json in that same folder has this client's real values.

Option B: PosiEd — With EDC-AUS

Adds EDC-AUS on top of the standard Base + K-12 setup.

Mode

Behavior

Mode

Behavior

Install and Deploy

Installs PosiEd Base, PosiEd K-12, OmniStudio, and PosiEd EDC-AUS, then deploys and configures everything.

Deploy Only

Skips installations and only deploys and configures the settings.

# Option B1: Install and Deploy source PosiEd-Base-and-K-12-with-EDC-AUS.sh "PosiEd-Base-and-K12-with-EDC-AUS/postConfig" "Install and Deploy" "PosiEd-Base-and-K12-with-EDC-AUS" # Option B2: Deploy Only source PosiEd-Base-and-K-12-with-EDC-AUS.sh "PosiEd-Base-and-K12-with-EDC-AUS/postConfig" "Deploy Only" "PosiEd-Base-and-K12-with-EDC-AUS"

Before running, make sure PosiEd-Base-and-K12-with-EDC-AUS/postConfig/config-data/.env has been filled in for this client (copy it from .env.example in the same folder if it doesn't exist yet), and that PosiEd_Value_Mapping__c.json in that same folder has this client's real values.

📝 Important Notes

Package Versions

To target specific package versions, update the package IDs inside your local environment configuration file:

  • 📁 package-ids.env

Command Execution Modes Breakdown

  • Install and Deploy: Installs the packages, then deploys/configures everything.

  • Deploy Only: Skips package installations entirely — use this when the packages are already present in the org.

Proceed to: Post Install Configuration - PosiEd