You already know how to build SAP integrations. This guide does not teach CPI or ABAP. It shows you how to prepare your computer and how to start a development with the TSP Framework.
VS Code is your workspace. All project files are here.
Codex is the AI agent that works with you inside VS Code.
GitHub keeps your project safe, in the TSP-LAC-HR-DEVELOPMENTS organization.
The TSP Framework guides every development, step by step.
You stay responsible for the technical decisions and the approvals. Codex helps you analyse, design, build, test and document. You do not need experience with VS Code, Git or GitHub. This guide starts from zero.
The tools work together, and you direct them. Every development follows the same simple cycle.
You
Tell Codex what you want. At the start: Start a new project. When you are not sure: What should I do next?
Codex
Reads the Framework rules and your project files. The rules are already inside your project (the file AGENTS.md). You do not need to open them.
TSP Framework
Knows where the project is and what the next step is. You never need to work this out yourself.
Codex
Does that step: asks questions, proposes a design, writes files and code, runs checks. When it needs more access, it asks you first.
You
Review what Codex brings you: a question, a missing requirement, a technical proposal or an approval request. If you do not agree, say so and ask why.
You
Answer, decide or approve, with your SAP knowledge and the exact words the Framework shows you.
TSP Framework
Records the decision and the evidence in your project. GitHub keeps the full history.
The cycle repeats until the Framework shows that the development is complete.
SAP Integration Suite stays in your browser, as today. You build and deploy iFlows there. Codex helps you design, write Groovy scripts and mappings, and document them.
GitHub stores your project files and their history. It does not replace SAP transports or CPI packages.
No real employee data. Never paste production HR or payroll data into Codex. Use test or fictional data.
03
Install your tools
WHAT YOU DO
Install five things on your computer, add the Framework's Python packages, and check your GitHub access.
WHY
All your Framework work happens inside VS Code, on your computer.
Show instructions for
A
VS Code
Your workspace: project files, terminal and Codex in one window.
Expected result The last line says Successfully installed … or Requirement already satisfied.
If it does not work
"No module named pip": your Python installation is not complete. Install Python again from python.org.
"externally-managed-environment": this Python came from Homebrew. Install Python from python.org and use that one.
D
Codex
The AI agent you work with inside VS Code. It is the official AI for the TSP Framework.
Open the Extensions view (Ctrl+Shift+XCmd+Shift+X), search Codex and install Codex – OpenAI's coding agent by OpenAI. Check the publisher: it must be OpenAI.
Click the Codex icon in the left bar to open the Codex panel. If you do not see it, open Command Palette and run Codex: Open Codex Sidebar.
Click Sign in with ChatGPT and finish the sign-in in your browser. Use the Codex account that TSP provides to you. You do not need to buy one.
Below the message box, check the mode. Use Agent. In Agent mode Codex can read and change files inside your project, and it asks you before it does more. Do not use "Agent (full access)".
Expected result A chat panel with a message box. Type hello and Codex answers.
If it does not work
No Codex icon after install: Command Palette → Developer: Reload Window.
Sign-in fails or says you have no access: check that you use the account TSP provided. If you do not have one yet, contact Guido Reboredo (HR Technology Director).
Codex cannot run commands on Windows: update VS Code and the Codex extension to the latest version, then reload the window. If it still fails, contact Guido Reboredo (HR Technology Director).
E
GitHub access
Your projects live in the TSP-LAC-HR-DEVELOPMENTS GitHub organization.
Sign in to github.com ↗. If you do not have an account, create one with your TSP email.
Send your GitHub username to Guido Reboredo (HR Technology Director) and ask to join the organization. Accept the invitation email.
Expected result You see the template and a green Use this template button. If GitHub shows "404", you do not have access yet. Check that you accepted the invitation.
04
Your computer is ready
Tick everything that is true. If something is not ticked, finish it first, or contact Guido Reboredo (HR Technology Director).
TSP-LAC-HR-DEVELOPMENTS (not your personal account)
Repository name
Your repository name from step 05
Visibility
Private
Click Create repository.
Clone it and open it in VS Code
Clone means: make a copy of the repository on your computer.
In VS Code, open Command Palette → Git: Clone → Clone from GitHub. Sign in to GitHub if VS Code asks. Choose your new repository, choose a folder on your computer (for example Documents/TSP-Projects) and click Open.
VS Code asks if you trust the authors of the folder. Choose Yes, I trust the authors.
Prefer the terminal?
On GitHub, click Code and copy the HTTPS address. Then run:
git clone <your-repository-address>
cd <your-repository-name>
code .
Expected result On the left, VS Code shows your project files, including START-HERE.md and AGENTS.md.
VS Code asks: "This folder has tasks that run automatically. Do you allow them?" Choose Allow. This task opens the Framework status page in your browser (see step 07).
Cannot clone or sign in to GitHub?
Your repository is not in the list: check that you created it under TSP-LAC-HR-DEVELOPMENTS, and that you are signed in with the right GitHub account.
The sign-in window keeps coming back: the Git sign-in helper opens a browser window. Finish the sign-in there.
Sign-in fails in Terminal: use Git: Clone → Clone from GitHub in VS Code. It signs you in through the browser.
07
Start the Framework
In the VS Code window with your project, open the Codex panel. Check that the mode is Agent.
Send Codex only this message:
Start a new project.
From here, the Framework guides you. You do not need to know which step comes next, which files to open or what to edit.
When you are not sure what to do, ask Codex:
What should I do next?
SEE YOUR PROJECT STATUS
The Framework has a status page: FRAMEWORK-STATUS.html, in the main folder of your project. It shows the project stage, the approvals and your next action. It updates by itself while you work.
It opens alone in your browser when you open the project in VS Code, if you allowed automatic tasks.
Open it yourself: Command Palette → Tasks: Run Task → Framework: Live Dashboard.
Or in the VS Code file list, right-click FRAMEWORK-STATUS.html → Reveal in File ExplorerReveal in Finder, then double-click the file.
Keep it open in a browser tab. You can also open START-HERE.md in VS Code: the section Your Next Action shows the same next step.
HAVE THIS INFORMATION READY
Codex will ask a few questions to set up the project. Prepare the answers before you start.
Client
The short code from step 05
Solution ID
Exactly as in your repository name
Solution name
The short solution name from step 05
Project roles
Who is the Functional Owner and who is the Technical Lead
SAP systems
Which SAP and Integration Suite tenants the solution uses (development, QA, production)
Functional Specification
The document from the functional consultant. Codex will ask you for it.
08
Work with Codex
Codex does not replace your engineering judgment.
Codexproposes · investigates · executes
Youreview · decide · approve
You will see four kinds of moments:
A · CODEX ASKS FOR INFORMATION
“Who is the Technical Lead?”
Answer what you know. If you do not know, say so. Do not guess.
B · CODEX FINDS A FUNCTIONAL GAP
“The specification does not define … Please confirm.”
This is a business question. Take it to the Functional Owner. Give Codex the answer you receive.
C · A TECHNICAL DECISION
“I recommend an iFlow with … because …”
Use your SAP integration experience. Read the proposal, ask why, compare other options. Do not accept it without thinking.
If Codex asks you a technical question as if it was a business requirement, you can reply:
This is a technical design decision. Please evaluate it through the framework and recommend the appropriate solution.
D · CODEX ASKS FOR APPROVAL
“If this is correct, reply: …”
Read exactly what you approve. Approve only if you agree. Use the exact words the Framework shows you.
PERMISSIONS AND SAFETY
Use Agent mode. Codex can change files in your project. It asks you before it uses the internet or works outside the project folder. Read each request. Allow it only when it makes sense.
Do not use "Agent (full access)". It removes these questions.
Never paste passwords, keys or real employee data into Codex or into project files. Keep credentials in SAP Integration Suite security material.
Make changes in SAP only when the Framework says implementation is approved.
Three rules
01
Follow the Framework.
Do not open or edit Framework files by hand (.framework folder, START-HERE.md).
02
Ask before you guess.
Not sure what comes next? Ask Codex:
What should I do next?
03
One project, one chat topic.
Use Codex in the VS Code window of the project you work on. For a new solution, create a new repository.
Useful messages
Where are we in the project?
Explain this step in simple words.
Generate the customer workbook.
You can also write to Codex in Spanish or Portuguese. Codex understands. Approval phrases must use the exact words the Framework shows.
09
Save your work to GitHub
Your files are on your computer. To keep them safe and share them with the team, send them to GitHub. Do this at the end of each work session.
Open Source Control
Click the Source Control icon in the left bar (three circles joined by lines), or press Ctrl+Shift+GCtrl+Shift+G. You see the list of changed files.
Commit
A commit is a saved version with a short message. Type a message that says what you did, for example Technical design approved, and click Commit.
If VS Code asks to stage all changes, choose Yes.
Push
Push sends your commits to GitHub. Click Sync Changes.
Expected result On github.com, your repository shows your latest message next to the files.
You can also ask Codex:
Commit and push my changes with a clear message.
Codex shows you what it will send. Check that there are no passwords or real data in the list.
A–Z
Words to know
Repository (repo)
A project folder on GitHub, with the full history of its files.
Template
A ready-made repository. You copy it to start a new project with the Framework inside.
Organization
A shared space on GitHub for a team. Ours is TSP-LAC-HR-DEVELOPMENTS.
Clone
Make a copy of a repository on your computer.
Commit
Save a version of your changes, with a short message.
Push / Sync
Send your commits from your computer to GitHub.
Pull
Get the latest changes from GitHub to your computer.
Terminal
A text window where you type commands. In VS Code: Terminal → New Terminal.
Extension
An add-on for VS Code, for example Codex or Python.
Command Palette
The VS Code search box for commands.
Prompt / message
What you write to Codex in the chat.
AGENTS.md
The file with the Framework rules for Codex. Codex reads it alone. You do not edit it.
START-HERE.md
The project status page. It always shows your next action.
Approval / gate
A point where a person must confirm before the project moves on.
?
Troubleshooting
FRAMEWORK OR PROCESS QUESTION
Ask Codex: What should I do next?
INSTALLATION OR ACCESS PROBLEM
Contact Guido Reboredo (HR Technology Director).
VS CODEI cannot find a command or extension
Type the command name in Command Palette exactly as shown. If nothing appears, install the extension and run Developer: Reload Window.
CODEXNot signed in, or no answer
Open the Codex panel and sign in again. Check your internet connection. Start a new chat with the + button.
CODEXCodex does not follow the Framework
Check that VS Code shows your project folder (with AGENTS.md), not a parent folder. Then ask What should I do next?
PYTHON"No module named yaml" or similar
Run the package install command from step 03 again.
GIT / GITHUBCannot clone, push or sign in
Use Git: Clone → Clone from GitHub in VS Code to sign in through the browser. If you see "404" or "permission denied", ask for access to the organization.
FRAMEWORKI do not see the status page
Command Palette → Tasks: Run Task → Framework: Live Dashboard. If it fails, check that the Python extension is installed and the Python packages from step 03 are installed. See step 07.
FRAMEWORKCodex runs, but I do not know what to do
Open START-HERE.md and read Your Next Action, or ask Codex What should I do next? Do not edit Framework files by hand.
