Introduction
In Nexus, an environment is setup with a so called Tenant, which defines the organization and the environment.
The configuration for all Nexus services will be defined for such a Tenant. This configuration is stored in a database on a customer's server.
Nexus needs to access this database to get the configuration for all services that have their configuration in that database. That will always be the case for the Nexus Link services, such as Business Events and Value Translator, but can also be used for the customer's Business API and adapters (replacing app settings in Web.config).
New organization
STEP 1
To setup your organization, ask a Nexus administrator to create an Organization for you. You will get an identifier and a password in return, which you use to add and remove environments and clients in your organization.
Authentication
When accesing the endpoints described later in this document, Basic Authentication will be used to access them.
- With the password of the Organization, you can access endpoints starting with
api/v2/Organizations/{organization}
- With the password for a tenant, you can access most endpoints starting with
api/v2/Organizations/{organization}/Environments/{environment}
New Tenant (a new environment in your organization)
STEP 2
STEP 3
Create an empty configurations
database.
STEP 4
Now you can access the endpoint for setting the connection string to your configurations database, and also credentials for the Azure AD to access the Key Vault (if you use encrypted databases).
Update Tenant configuration: PRDSIM, PRD
After this, your configurations database will have the correct schema.
STEP 5
Now, create configuration for the Logging service:
{
"Version": "1",
"LoggerConnectionString": "$(StorageConnectionString)",
"QueueName": "$(LoggerQueueName)"
}
STEP 6
Create a SystemUser
for accessing the Nexus Link Services.
For testing purposes, you can manually create an access token:
Update tenant password
To change the password, use