Skip to main content

Getting Started with AcuOps

This guide walks through setting up AcuOps for a new Acumatica environment.

Prerequisites​

  • Acumatica Cloud or on-premise instance (version 24.1+)
  • GitHub organization or repository access
  • API user account in Acumatica with admin role
  • Railway account (for hosted monitoring)

Step 1: Create an API User​

In Acumatica, navigate to SM201010 (Users) and create a dedicated API user:

  • Login: api-bot (or your preferred name)
  • Roles: Assign roles with read access to all entities you want to monitor
  • Important: Use a strong password — this account authenticates all API operations
caution

Acumatica licenses limit concurrent API sessions (~2-3). AcuOps uses a Redis session gate to coordinate access across services.

Step 2: Set Up the CI/CD Repository​

Clone the template repository:

gh repo create your-org/acumatica-ci-cd --template studio-b-ai/acumatica-ci-cd --private

Configure GitHub Secrets​

SecretValue
ACUMATICA_PROD_URLhttps://your-instance.acumatica.com
ACUMATICA_PROD_USERNAMEAPI user login
ACUMATICA_PROD_PASSWORDAPI user password
ACUMATICA_PROD_TENANTTenant name

Configure GitHub Variables​

VariableValue
CUSTOMIZATION_PROJECT_NAMEYour main project name
ALSO_PUBLISH_PROJECTSComma-separated list of ALL active projects

Step 3: Export Your Customization Project​

  1. Open Acumatica → SM204505 (Customization Projects)
  2. Select your project
  3. Source Control → Save Project to Folder
  4. Commit the exported files to Customization/_project/ in your CI/CD repo

Step 4: Deploy​

Push to main to trigger the deploy pipeline:

git add Customization/_project/
git commit -m "Initial customization project export"
git push origin main

The pipeline will:

  1. Validate the project XML
  2. Package into a .zip
  3. Import via the Customization API
  4. Publish (co-publishing with all listed projects)
  5. Report results

Step 5: Set Up Monitoring​

Deploy the test suite for ongoing validation:

gh repo create your-org/acumatica-tests --template studio-b-ai/ui-test-suite --private

Configure the same Acumatica secrets plus:

SecretValue
SLACK_WEBHOOK_URLIncoming webhook for notifications

The test suite runs daily at 6am UTC and after every deploy.

Next Steps​