In this topic:

Creating Run Modes

Once you have set up the GL Rules and Rule Sets, you can proceed with creating run modes.

To create a General Ledger, you also need a run mode. It specifies your ledger configurations and parameters for processing GL Runs including the type of run and Cron (frequency) configurations.

One run mode can be shared between multiple ledgers. If the Cron settings are edited for the run mode, updates will be applied to all associated ledgers.

To configure the GL properly, we need to create two run modes—one for creating a ledger and one for Cron configurations.

Create a run mode for the ledger

To create a run mode for a ledger, use the following endpoint:

POST https://example.gotransverse.com/calypso/3/run-modes

Request

{  
  "description": "additional information on run mode",
  "name": "sample run mode",
  "run_type": "ACTUALS",
  "active": true
}

Response

{
  "id": 4,
  "description": "additional information on run mode",
  "name": "sample run mode",
  "cron": "",
  "cron_enabled": false,
  "active": true,
  "run_type": "ACTUALS",
  "ledgers": []
}

You can also update the run mode associated with the ledger using the following endpoint:

PUT https://example.gotransverse.com/calypso/3/run-modes/{run_mode_id}

Request

{
  "description": "Actuals Run Mode for on demand GL rules processing",
  "name": "Actuals-Yes",
  "cron": "0 0 5/12 * * *",
  "cron_enabled": true,
  "active": true,
  "run_type": "ACTUALS"
}

Response

{
  "id": 4,
  "description": "Actuals Run Mode for on demand GL rules processing",
  "name": "Actuals-Yes",
  "cron": "0 0 5/12 * * *",
  "cron_enabled": true,
  "active": true,
  "run_type": "ACTUALS",
  "ledgers": []
}

Create a run mode for Cron

Now, create a run mode for configuring the Cron job scheduler. Use the payload provided below as a sample for setting up your Cron.

Note: When we create a run mode with type COLLECTOR_AUTO, collector runs are created automatically. In the Collector runs section, you can find the details of how to create a collector run with the 'On demand' type.

POST https://example.gotransverse.com/calypso/3/run-modes

Request

{
  "name": "collector cron",
  "cron": "0 */2 * * * *",
  "cron_enabled": true,
  "active": true,
  "collector_operations": [
	"INSERT_ORDER_ITEM_INVOICE",
	"INSERT_ADJUSTMENT_INVOICE",
	"INSERT_ADJUSTMENT_APPLICATIONS",
	"INSERT_ORDER_ITEMS",
	"INSERT_INVOICE_ITEM_CHARGES",
	"INSERT_BILLING_ACCOUNT_BILLING_ADDRESS_STATE",
	"INSERT_PAYMENT_APPLICATION",
	"INSERT_BILLING_ACCOUNT_SERVICE_ADDRESS_STATE",
	"INSERT_PAYMENT",
	"INSERT_SERVICE_ADJUSTMENT",
	"INSERT_RECURRING_INVOICE",
	"INSERT_ADJUSTMENTS",
	"INSERT_SERVICES",
	"INSERT_INVOICE_PAID_UNPAID",
	"INSERT_RECURRING_DISCOUNT_INVOICE"
	],
  "run_type": "COLLECTOR_AUTO"
}

Response

{
  "id": 6,
  "name": "collector cron",
  "cron": "0 */2 * * * *",
  "cron_enabled": true,
  "active": true,
  "run_type": "COLLECTOR_AUTO",
  "collector_operations": [
	"INSERT_BILLING_ACCOUNT_SERVICE_ADDRESS_STATE",
	"INSERT_RECURRING_DISCOUNT_INVOICE",
	"INSERT_ADJUSTMENTS",
	"INSERT_BILLING_ACCOUNT_BILLING_ADDRESS_STATE",
	"INSERT_SERVICE_ADJUSTMENT",
	"INSERT_ADJUSTMENT_APPLICATIONS",
	"INSERT_RECURRING_INVOICE",
	"INSERT_INVOICE_PAID_UNPAID",
	"INSERT_PAYMENT",
	"INSERT_INVOICE_ITEM_CHARGES",
	"INSERT_PAYMENT_APPLICATION",
	"INSERT_ORDER_ITEM_INVOICE",
	"INSERT_ORDER_ITEMS",
	"INSERT_ADJUSTMENT_INVOICE",
	"INSERT_SERVICES"
	],
  "overlap_fetch_time": 86400
}

Now, proceed with creating your General Ledger.

Top