BrainGrid
Get started
Technical Specbydepartment-of-veterans-affairs

Implementation Steps

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:

Used in: 1 repos•Updated: recently

Implementation Steps

Below is a living document that will be updated with specifics as changes are made. There is also an ADR for this project.

  1. Create a DB table ivc_champva_forms with columns [UUID (auto-generated), email, first_name, last_name, form_number, file_name, form_uuid, s3_status, pega_status, created_at, updated_at] :white_check_mark:

  2. Create a model called IvcChampvaForm to handle communication between the controller and database :white_check_mark:

  3. Update the uploads_controller.rb to insert new rows when uploading to PEGA's S3 bucket, more if there are multiple files.

    • This action should happen after we hit S3 so we can properly record the S3 status
    • Example of INSERT:
    ::IvcChampvaForm.create!(
   form_uuid: @form_uuid,
   file_name: @file_name,
   s3_status: "[200]"
   status: "Processed"
   ... 
 )
    • Ticket: TBD
    • Code: TBD

  4. Add Swagger doc for DOCMP/PEGA

  5. Add post 'ivc_champva/v1/forms/status_updates', to: 'pega#update_status' to routes.rb and then send that endpoint to PEGA to add to their lambda.

  6. Create pega_controller.rb to handle the request from PEGA. We can also wrap anything we'd like it a DataDog trace.

    class PegaController < SignIn::ServiceAccountApplicationController
  def update_status
     begin
      # Parse the JSON data
      data = JSON.parse(json_data)
  
      # Validate JSON structure
      unless data.is_a?(Hash)
        return JSON.generate({ status: 500, error: 'Invalid JSON format: Expected a JSON object' })
      end
  
      # Your logic to determine the status code
      if some_condition(data)
        response = { status: 200 }
      else
        response = { status: 500 }
      end
  
      # Convert the response to JSON format
      json_response = JSON.generate(response)
  
      # Return the JSON response
      return json_response
    rescue JSON::ParserError => e
      # Handle JSON parsing error
      return JSON.generate({ status: 500, error: "JSON parsing error: #{e.message}" })
    end
  end
end

  7. After an update from PEGA we can check all the rows in the table for the UUID they sent us and if all the files related are "processed" we can trigger VANotify::EmailJob.perform_async() to send an email to the Veteran. We will need a new template created by person X (Ex: preneeds_burial_form_email: preneeds_burial_form_email_template_id) After we have the database updated by PEGA requests we can then start utilizing the data to actually notify the veteran using Sidekiq. We will want to create one or two Sidekiq jobs.

  8. Clean Up Job (Sidekiq) - We don't want the data rows to remain in the table for over 60 days after being processed due to VA data retention policies. In old_records_cleanup_job.rb, we use the updated_at column to distinguish what can be purged from the database. The sidekiq job is configured to run daily at 3AM and query the database for records more than 60 days old in batches and destroy them. The job is controlled both by Settings.ivc_forms.sidekiq.old_records_cleanup_job.enabled as well as Flipper.enabled?(:champva_old_records_cleanup_job) and will not execute until both are enabled. The Flipper toggle should be removed at a later date.

  9. Email - If we don't do inline VANotify email then we'll want to kick off a job instead that handles that process and can retry if there are errors.

#Creating Service Account

# Create Service Account Config for IVC_Champva
btsss = SignIn::ServiceAccountConfig.find_or_initialize_by(service_account_id: '6747fb5e6bdb18b2f6f0b890ff584b07')
btsss.update!(
  description: 'DOCMP/PEGA Access Token',
  scopes: ['http://localhost:3000/ivc_champva/v1/forms/status_updates'],
  access_token_audience: 'docmp-champva-forms-aws-lambda',
  access_token_user_attributes: [],
  access_token_duration: SignIn::Constants::ServiceAccountAccessToken::VALIDITY_LENGTH_LONG_MINUTES, # 30 minutes (only other option is 5 minutes)
  certificates: [File.read('spec/fixtures/sign_in/sts_client.crt')]
)

#Generating the bearer token

  1. Generate the jwt with this script. Will likely have to adjust scope when in higher environments
current_time = Time.now.to_i
never_expire_timestamp = current_time + (100 * 365 * 24 * 60 * 60)
token = {
  'iss' => 'docmp-champva-forms-aws-lambda',
  'sub' => 'AWS Lambda',
  'aud' => 'http://127.0.0.1:3000/v0/sign_in/token',
  'iat' => current_time,
  'exp' => never_expire_timestamp,
  'scopes' => ['http://localhost:3000/ivc_champva/v1/forms/status_updates'],
  'service_account_id' => '6747fb5e6bdb18b2f6f0b890ff584b07',
  'jti' => '2ed8a21d207adf50eb935e32d25a41ff'
}

private_key = OpenSSL::PKey::RSA.new(File.read('spec/fixtures/sign_in/sts_client.pem'))
jwt = JWT.encode(token, private_key, 'RS256')
  1. Copy the jwt and replace the XXXX it in the assertion below:

curl -X POST 'http://localhost:3000/v0/sign_in/token?grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&assertion=XXXX’

  1. Lastly you can test it against this if you don't use Postman:

curl -X POST 'http://localhost:3000/ivc_champva/v1/forms/status_updates' -H 'Authorization: Bearer '

#Private keys for use when generating the token

The PEGA application is issued unique private keys, one for lower environments and one for the production environment.

  • These keys are generated by the Identity Team
  • They are provided as a zip file named like pega-file-confirmation-oauth-lowers.zip
  • They are good for one year
  • The production key expires around September
  • The lower environment key expires around May

Quick Actions

View on GitHub

Details

Type
Technical Spec
Author
department-of-veterans-affairs
Slug
department-of-veterans-affairs/champva-implementation-steps

Used In

Related Requirements

Search

Browse all requirements →