When we reference customers, we're talking about your customers. Your organization creates integrations, and then deploys instances of your integrations to your customers. You can create users for your customers and assign them roles so that they can have insight into the instances that you deploy to them.
Like all Prismatic resources, customers can be managed via Prismatic's CLI tool, prism, or through the web app by clicking the Customers link on the left-hand sidebar.
Creating New Customers
- Web App
After clicking on the Customers link on the left-hand sidebar, click the + Customer button on the upper-right. Enter an appropriate name and description for your customer.
- Web App
After clicking the Customers link on the left-hand sidebar, you can enter a portion of a customer's name into the search bar to filter customers by name. To filter customers by description instead, click the Filters button to the right of the search bar.
After clicking the Customers link on the left-hand sidebar, you will be presented with a list of your customers.
Clicking the name of any customer will bring you to the customer's page. This page contains a menu with options to manage instances assigned to the customer, alert monitors, config variables, credentials, customer users, file attachments, and customer settings.
Editing Customer Name, Description and Logo
- Web App
From the customer's page select the Settings tab. You can modify the name or description of the customer, and can upload a logo to act as the customer's avatar. The logo will be resized and cropped to 500 x 500 pixels. Transparent PNG images tend to look the best.
Deploying Instances to a Customer
An instance of an integration is a versioned copy of an integration that is configured and deployed to a specific customer. Configuration variables and credentials that are unique to the customer can be applied to an instance.
For more information on attaching configuration variables and credentials, see the instances page.
- Web App
From the customer's page select the Instances tab. There, you will see any instances currently deployed to your customer, with information on when they were last run, what versions are deployed, etc.
To deploy a new instance, click the + Instance button on the top-right corner. Select the integration you wish to deploy, and give the instance an appropriate name and description.
Once the instance is created, you will be prompted to configure any config variables and credentials required by the integration.
Managing Alert Monitors
Alert monitors allow you to send alerts to your team when an alert trigger fires on an instance.
For example, you may want to your DevOps team to be alerted via text message when an instance fails to run, or you may want your project management team to be emailed when an instance is enabled.
- Web App
From the customer's page select the Monitors tab. There, you will see any monitors currently deployed to your customer, with information on if/when it was last triggered, which instance it is associated with, and what triggers the monitor.
To deploy a new monitor, click the + Monitor button on the top-right corner. Give the monitor a name and select the instance to attach to, and trigger that will activate this alert.
After creating the new monitor, select the Notifications tab within the monitor to choose users to alert or webhooks to invoke when the monitor is triggered.
For More Information: Alert Monitors
Accessing Customer Logs
At Prismatic we believe verbose and searchable logs are critical to any software ecosystem. Logs of all instance invocations are stored for all customers, and are searchable and filterable.
To access logs of instances for a specific customer, open the customer's page and select the Logs tab.
You can search log messages using the search bar on the top of the page.
Logs can be filtered by clicking the Filter button to the right of the search bar. You can filter logs by:
- Log Severity (Error, Warn, Info, or Debug)
- Date/time Range
- Integration Name
Clicking on a log line will open a pane with the full message of the log.
Managing Customer Config Variables
Customer config variables are key-value pairs that can be referenced by instances of integrations.
For example, a customer might have a UUID that you use internally to identify them.
If you create a customer config variable with key
customerUUID and value
286467A3-899F-443B-9220-ECF9A18B8799, you could reference
configVars.customerUUID within an integration.
- Web App
From the customer's page select the Config Variables tab. Enter key-value pairs in the fields provided.
To delete a configuration variable, click theicon next to the key-value pair.
To add a new configuration variable, click the +ADD CONFIG VARIABLE button.
If you have a more complex config variable value that you would like to enter, like a section of HTML, JSON object, or XML block, click theicon to the right of a config var to open a code editor.
For More Information: Configuration Variables
Managing Customer Credentials
Credentials store login information for the services your integrations interact with. For example, a customer might have Dropbox OAuth2 tokens or AWS access keys in their credential store.
- Web App
From the customer's page select the Credentials tab. You will see a list of credentials that are saved for that customer.
To add new credentials for a customer, click the + Credential button. Enter the authorization method appropriate for your use case.
After selecting the authorization method, and clicking add you will be prompted to enter username, password, or API key values, etc., depending on the authorization method you chose.
Credentials can be deleted by clicking the credential from the credentials tab, selecting the credential Settings tab, and clicking the Delete Credential button.
For More Information: Credentials
Managing Customer Users
Customer users are users at your customer locations who have access to instances deployed to them. Depending on the role you assign to the user, the user might have read or write access to their instances.
Customer users' accounts are limited in scope. They cannot view instances belonging to your other customers, nor see organization-level resources.
- Web App
Users for your customers are managed by opening a customer's page and selecting the Users tab.
New users can be added by clicking the +User button. Enter the user's name and email address and give the user an appropriate role. More information about customer user roles can be found on the users page.
When users are added, they receive an email confirmation that will prompt them to log in and set their password and optional phone number.
To delete a user, select the user from the Users tab, then open the Settings tab. Click the Delete Account on the bottom of the page.
For More Information: Users
Using Customer Attachments
Attachments are a place to store documents that both customers and your team members can reference. After opening a customer's page select the Attachments tab.
Documents can be added using the +ADD ATTACHMENT button, and deleted by clicking theicon.
Deleting a Customer is Permanent
When a customer is deleted, all associated users, configuration variables, credentials, and instances are also deleted. Use caution when deleting customers.
- Web App
After clicking on the Customers link on the left-hand sidebar, click the name of the customer you would like to delete, and then select the Settings tab.
Verify that the name shown matches the customer you wish to delete, and click the Delete Customer button. Confirm your choice by typing the customer name exactly, and then click REMOVE CUSTOMER.