This method is used to add a Domain to a Scenario. The following actions will also be implemented on the creation of a new Domain:

  • Automatically set the Required Domain parameters
    • = domainName
    • domain.loop = 1
    • domain.order = domains.count()
  • Automatically add an 'id' Attribute to the new Domain.
  • Automatically set Attribute parameters
    • name = 'id'
    • originalName = 'id'
    • visible = true
    • primaryAttribute = true
    • attributeOrder = 0
    • nodeState = NodeState.Good
  • Automatically add a RangeGen Generator to the Id Attribute
  • Automatically set the RangeGen Generator required parameters
    • startRange = 1
    • jumpAmount = 1
    • waitAmount = 1 


The following GenRocket exceptions may be thrown by this method:  

  • If the runtime instance is currently running another Scenario.
  • If a duplicate Domain name is detected.

Runtime Method Signature

Use this method signature when directly accessing the GenRocket binary runtime. The Boolean field 'primary' defines whether the added Domain is primary or not. Data is being generated for Primary Domain only within a Scenario.

public void domainAdd(String domainName, Boolean primary)

REST/Socket Payload Request

Use this API JSON request payload when making an API call to the GenRocket REST or Socket Engine.

  "interfaceType": "Manual",
  "methodName": "domainAdd",
  "parameters": {
    "domainName": "",
    "primary": true,

REST/Socket Payload Successful Payload Response

The API JSON response payload for this method will be empty.

  "responseType": "OK",
  "data": ""