Skip to main content

Workspaces

Retrohook workspace environments are dedicated instances in your infrastructure where your healthcare data integrations—also known as workflows—run. By setting up an environment, you ensure that your data is processed and managed securely and efficiently. This guide walks you through creating a new environment within your Retrohook workspace.

Prerequisites​

Before you begin, ensure that you have administrative access to your AWS account, as you will need to perform actions in AWS Identity and Access Management (IAM) and CloudFormation.

Step-by-Step Guide​

Accessing Workspace Environments​

On your Retrohook dashboard, locate and select the ‘hamburger’ button in the top right hand corner of the screen and select Workspace. From there, click the Environments button to manage your environments.

Naming Your Environment​

Name: Enter a name for your new environment that reflects its purpose, such as "Development", "Staging", or "Production".

Downloading the Role Template​

Click the 'Download' button to obtain Retrohook's AWS Role Template. This template will create the necessary roles and permissions in AWS CloudFormation, allowing Retrohook to interact with your AWS resources securely.

Running the Role Template in AWS CloudFormation​

  • Log into your AWS Management Console and navigate to the CloudFormation service.
  • Choose 'Create Stack' and upload the Role Template file you downloaded from Retrohook.
  • Follow the prompts to create the stack, which will automatically set up the required roles in your AWS account.

Generating AWS Credentials​

  • Once the stack is created, go to the IAM section in the AWS Management Console.
  • Follow the instructions to create a new user or use an existing service account. Make sure to generate and securely store the credentials—Client ID and Client Secret.

Entering AWS Details​

  • AWS Account ID: Enter your AWS Account ID where the environment will be hosted.
  • AWS Client ID: Input the Client ID generated from IAM.
  • AWS Client Secret: Input the Client Secret generated from IAM.

Selecting AWS Region​

Choose the AWS Region from the dropdown menu where your environment should be deployed. It's often best to select the region closest to your users for performance reasons.

Creating the Environment​

Click 'Create Environment' to initiate the setup. Retrohook will use the provided information to configure and create a dedicated environment in your AWS infrastructure.

Finalizing Your Environment Setup​

Once the environment is created, you will see it listed in your Workspace Environments. You may now use this environment to deploy and run your workflows securely.

Tips for a Smooth Configuration​

  • Double-check all entered information for accuracy to avoid any connection issues.
  • Keep your AWS credentials secure and do not share them unnecessarily.
  • Ensure you follow AWS best practices for security and permissions when creating IAM users and roles.
Support and Troubleshooting

If you face any issues or have questions during the environment setup, consult our documentation or reach out to Retrohook support for hands-on assistance.