Accounts

Accounts facilitate the interaction and data exchange between actors. By using accounts, you can monitor and control the state and state changes of individual actors, as well as track and manage the interaction of multiple actors in processes and systems represented in Simulator.Company graphs. Accounts operate with currencies, and each actor can have multiple accounts, while each account can be associated with multiple currencies.

The Accounts section of the workspace menu allows you to:

• create new accounts and currencies;
• manage and view existing accounts;
• make new transactions against accounts;
• manage and view existing transactions.

Account Types

Accounts have the following general types:

• Numeric - this type allows to use Number, Percent, Currency, Date and Time, Seconds currency types with the account. You can make numeric transactions using this account type;
• String - this type allows you to make string (text) transactions against the account. You can select this account type when adding a new account in the Actor's panel, on the Accounts tab;
• Actor ID - this type allows you to make actor transactions against the account. For example, you can add or subtract single or multiple actors to or from the account actor (refer to Creating an Account from the Actor's Panel for details). You can select this account type when adding a new account in the Actor's panel, on the Accounts tab.

Debit, Credit and Total & Fee

Each account in the system consists of two parts: Debit and Credit. The Debit part stores transactions that decrease the account balance (debit transactions), while the Credit part stores transactions that increase the account balance. The Total represents the overall account balance, which is the sum of the Debit and Credit amounts.

The Total value is positive if the sum of credit transactions made against the account is greater than the sum of the debit transactions. Conversely, if the sum of debit transactions is greater than the sum of credit transactions, the Total value is negative. When the sums of debit and credit transactions are equal, the Total value is zero.

In the Transactions and Transfers lists, total values for accounts are displayed in the Total & Fee column and Total & Fee field in the account details menu. These values represent the current account totals, including any associated fees if applicable.

You can view the debit, credit, and total values of an account in the actor properties. To do this, double-click an actor (or single-click an actor in the list to open the actor details panel) that has the account linked in the Simulator->Actors Bag list, navigate to Accounts tab, and click the arrow symbol:

All accounts linked to an actor are grouped in folders according to their tags. All untagged accounts are displayed in the Untagged folder.
Clicking the arrow symbol in the folder line opens the drop-down menu in which you can see the list of accounts withthe same tag (or no tag for the Untagged folder). When you click the arrow symbol in an account line, the list with the account total, credit, and debit values opens.

Main Accounts menu

In the accounts table, the following info is available:

• Name - shows the account name;
• Opened accounts - shows the number of actors in the workspace that use the selected account;
• Owner - shows the account owner name;
• Created - shows the account creation date and time.
• Create - opens the Account-Currency pair creation window.

For each account in the list, the main account menu is also available by clicking the menu icon to the right. The following main account menu items are available depending on your permissions:

• Copy ID - allows copying the account ID;
• Edit - allows editing the account name;
• Remove - allows deleting the selected account.

Creating an Account on the Accounts page

Each account is linked to one or multiple currencies, which serve as the measurement unit for the account balance and transactions. When you add a new account to an actor, you can either create a new account with a new currency or select an existing account/currency combination.

To create an Account-Currency pair from the Accounts section, click the Create button in the upper right corner (you can also create an account with a preselected currency from the Currency menu).
This will open the account creation window in the Details tab, where you need to fill out the following fields:

• Account (required) - allows you to enter a new account name or select an existing account name from the list;
• Currency (required) - allows you to enter a new currency name or select an existing currency for the new account from the list;

After configuring the account and currency parameters you can click Save to save the new account or proceed to configuring Tags and Triggers optional parameters.

• Tags - allows you to select an existing or create a new tag for the new account. In the Accounts list, the accounts that have the same tag are grouped together.
  To create a new tag, enter a name for the new tag and click Create in the Tags field:

• Triggers - allows you to select an existing or create a new trigger for the new Account-Currency pair. Triggers enable receiving signals (on API key webhook) of an account reaching a target balance or transaction count value.

Creating an Account from the Actor's Panel

You can create a new account of the Numeric, String, or Actor ID type from the Actor's panel. To do that, follow these steps:

1. Open Actors bag and select the actor to which you want to add a new account from the actors list. To add an account to an actor on a layer in a graph, right-click on the actor to open the actor menu.

2. Open the actor's panel with a single click. For an actor on a layer, select Open actors panel in the actor menu.

3. Navigate to the Accounts tab.

4. Click the "+" icon to open the Create new account menu:

You can also open the Create New Account menu by double-clicking the actor in the list, then navigating to the Accounts tab, and clicking the "+" icon.

In the Create New Account menu, the following settings are available:

1. Details, Access, and Advanced Options tabs: the Details tab provides the account settings, the Access tab allows sharing the account with selected users and configuring access rights. For the Numeric account type, the Advanced Options tab is available, where you can configure the following settings for the account:

1. Set minimum and maximum values for the account
2. Enable using this account in tree calculations
3. Enable transactions search for the account
4. Create the Plan account for the new account.

2. Type: allows you to select Numeric, String, or Actor ID account type. With the String type selected, you can make string transactions against the account.
3. Contains value: allows you to select Single (single string or Actor ID value) or Multiple (multiple string or Actor ID values) for the new account to contain. This setting is available only for String and Actor ID account types.
4. Account: allows you to enter the account name.
5. Currency: allows you to select an existing currency or create a new one for the account.
6. Tags: allows you to add tags to the account.
7. Triggers: allows you to add triggers to the account.

Currency Menu

Clicking on an account in the list will display the linked currencies for that account. In this list, you can view information about the account currencies such as name, symbol, total amount, number of opened accounts with the currency, account tags, triggers, owner, and creation date and time. You can also create a new currency, search through the currencies list, and access the currency menu for additional actions.

Creating an Account with a preselected currency. Currency types

Clicking the Create button in the upper right corner opens the Account-Currency pair creation window. In this window, the current account is preselected, and you can choose or create currencies, tags, and triggers to add to the account:

The currency menu is available on clicking on the menu symbol to the right of each currency:

Depending on access settings, the following menu items are available:

• Copy ID - allows copying the currency ID;
• Edit - allows editing the following currency parameters
  • Name - allows editing the currency name;
  • Currency symbol - allows editing the currency symbol which can be a sequence of alphanumeric characters including special characters of any length. In the currencies list, only the first 10 characters are displayed in the Symbol column;
  • Type - allows selecting one of the following measuring unit types for the currency:
    • Number;
    • Percent;
    • Currency;
    • Date and time;
    • Seconds;
  • Precision - allows setting the precision for the currency unit counting in the range from integers to one tenthousandth decimal fractions (1.0000);
• Share - allows setting access permissions for the currency and sharing it with the selected workspace users;
• Manage Tags & Triggers - allows creating and adding new tags and triggers, and removing the existing ones for the currency;

• Show transactions - shows transactions against the account for the specified period;
• Remove - allows deleting the selected account.

Currency Submenu

Clicking on a currency in the list opens the window in which you can do the following:

• view the accounts opened with the currency together with the following info on the account;
  • Total - account total amount;
  • Debit - account debit amount;
  • Credit - account credit amount;
  • Owner - account owner name;
  • Created - account creation date and time.
• open the menu for operations against the account:

The currency submenu provides the following operations:

• Create transaction - opens the transaction creation window;
• Show transactions - opens the window in which you can view transactions with the selected currency against the selected account;
• Show dashboard - opens the Line type dashboard with the Settings menu for the account;
• Show details - shows details for transactions against the account;
• Show account tree - shows an account tree: a graph which contains all actors that have the selected account;
• Block account - blocks operations on current account and transactions against it.
  To enable making transactions and all operations on the account again, click on Unlock account in the menu;

• Transfer accounts - opens the window for transferring the selected account to another actor;
• Edit account - create, add and remove tags and triggers for the Account-Currency pair;
• Add connector - opens the window of adding a connector to the account;
• Add formulas - opens the formula adding window;

• Remove - opens the account permanent deletion window.

To add the selected Account-Currency pair to an actor, click the Create button in the right upper corner. This will open the window, in which you can select an actor you want to add the pair to:

After selecting the actor, you can configure tags and triggers for the pair (optional) and click Save to save the changes. The Account-Currency pair will be added to the selected actor. You can view and configure the added pair in the actor's parameters in the Simulator->Actors bag menu.

Fact and Plan

To make account balance prediction and evaluation easier, each Account-currency pair provides Fact and Plan values. The Fact value reflects the actual balance amount, while the Plan value is used to store the planned amount. This allows for easy comparison between the two amounts. The Fact and Plan amounts are independent of each other, and transactions can be made separately against the same Account-Currency pair for both Fact and Plan.

You can view the Fact and Plan amounts for an Account-Currency pair by clicking on an account currency in the list:

Sharing an Account and Currency

You can set up access settings for an Account-Currency pair when creating a new account. After entering the account and currency names in the Details tab of the account creation window, you can open the Access tab. In this tab, you can select users with whom you want to share the account by clicking on the user selection field, and assign their access rights by checking the corresponding boxes:

You can also configure access settings for multiple accounts simultaneously by selecting the desired accounts in the accounts list and clicking on the share menu symbol located at the top of the first column: