workflows

Documentation

Index

• Constants
• func AcceptWorkflowID(email string) string
• func BackgroundCheckWorkflowID(email string) string
• func EmploymentVerificationWorkflowID(email string) string
• func SearchWorkflowID(email string, name string) string
• func TokenForWorkflow(ctx workflow.Context) string
• func WorkflowFromToken(token string) (string, string, error)
• type AcceptSubmission
• type AcceptSubmissionSignal
• type AcceptWorkflowInput
• type AcceptWorkflowResult
  • func Accept(ctx workflow.Context, input *AcceptWorkflowInput) (*AcceptWorkflowResult, error)
• type BackgroundCheckState
• type BackgroundCheckWorkflowInput
• type BackgroundCheckWorkflowResult
  • func BackgroundCheck(ctx workflow.Context, input *BackgroundCheckWorkflowInput) (*BackgroundCheckWorkflowResult, error)
• type CandidateDetails
• type EmploymentVerificationSubmission
• type EmploymentVerificationSubmissionSignal
• type EmploymentVerificationWorkflowInput
• type EmploymentVerificationWorkflowResult
  • func EmploymentVerification(ctx workflow.Context, input *EmploymentVerificationWorkflowInput) (*EmploymentVerificationWorkflowResult, error)
• type FederalCriminalSearchWorkflowInput
• type FederalCriminalSearchWorkflowResult
  • func FederalCriminalSearch(ctx workflow.Context, input *FederalCriminalSearchWorkflowInput) (*FederalCriminalSearchWorkflowResult, error)
• type KnownAddress
• type MotorVehicleIncidentSearchWorkflowInput
• type MotorVehicleIncidentSearchWorkflowResult
  • func MotorVehicleIncidentSearch(ctx workflow.Context, input *MotorVehicleIncidentSearchWorkflowInput) (*MotorVehicleIncidentSearchWorkflowResult, error)
• type SSNTraceWorkflowInput
• type SSNTraceWorkflowResult
  • func SSNTrace(ctx workflow.Context, input *SSNTraceWorkflowInput) (*SSNTraceWorkflowResult, error)
• type StateCriminalSearchWorkflowInput
• type StateCriminalSearchWorkflowResult
  • func StateCriminalSearch(ctx workflow.Context, input *StateCriminalSearchWorkflowInput) (*StateCriminalSearchWorkflowResult, error)

Constants

const (
	AcceptSubmissionSignalName = "accept-submission"
	AcceptGracePeriod          = time.Hour * 24 * 7
)

const (
	EmploymentVerificationDetailsQuery         = "employment-verification-details"
	EmploymentVerificationSubmissionSignalName = "employment-verification-submission"
	ResearchDeadline                           = time.Hour * 24 * 7
)

const (
	BackgroundCheckStatusQuery = "background-check-status"
)

Functions

func AcceptWorkflowID

func AcceptWorkflowID(email string) string

func BackgroundCheckWorkflowID

func BackgroundCheckWorkflowID(email string) string

func EmploymentVerificationWorkflowID

func EmploymentVerificationWorkflowID(email string) string

func SearchWorkflowID

func SearchWorkflowID(email string, name string) string

func TokenForWorkflow

func TokenForWorkflow(ctx workflow.Context) string

func WorkflowFromToken

func WorkflowFromToken(token string) (string, string, error)

Types

type AcceptSubmission

type AcceptSubmission struct {
	Accepted         bool
	CandidateDetails CandidateDetails
}

type AcceptSubmissionSignal

type AcceptSubmissionSignal struct {
	Accepted         bool
	CandidateDetails CandidateDetails
}

type AcceptWorkflowInput

type AcceptWorkflowInput struct {
	Email string
}

type AcceptWorkflowResult

type AcceptWorkflowResult struct {
	Accepted         bool
	CandidateDetails CandidateDetails
}

func Accept

func Accept(ctx workflow.Context, input *AcceptWorkflowInput) (*AcceptWorkflowResult, error)

@@@SNIPSTART background-checks-accept-workflow-definition

type BackgroundCheckState

type BackgroundCheckState struct {
	Email            string
	Tier             string
	Accepted         bool
	CandidateDetails CandidateDetails
	SSNTrace         *SSNTraceWorkflowResult
	SearchResults    map[string]interface{}
	SearchErrors     map[string]string
}

type BackgroundCheckWorkflowInput

type BackgroundCheckWorkflowInput struct {
	Email string
	Tier  string
}

type BackgroundCheckWorkflowResult

type BackgroundCheckWorkflowResult = BackgroundCheckState

func BackgroundCheck

func BackgroundCheck(ctx workflow.Context, input *BackgroundCheckWorkflowInput) (*BackgroundCheckWorkflowResult, error)

BackgroundCheck is a Workflow Definition that calls for the execution of a variable set of Activities and Child Workflows. This is the main entry point of the application. It accepts an email address as the input. All other personal information for the Candidate is provided when they accept the Background Check.

type CandidateDetails

type CandidateDetails struct {
	FullName string
	Address  string
	SSN      string
	DOB      string
	Employer string
}

type EmploymentVerificationSubmission

type EmploymentVerificationSubmission struct {
	EmploymentVerificationComplete bool
	EmployerVerified               bool
}

type EmploymentVerificationSubmissionSignal

type EmploymentVerificationSubmissionSignal struct {
	EmploymentVerificationComplete bool
	EmployerVerified               bool
}

type EmploymentVerificationWorkflowInput

type EmploymentVerificationWorkflowInput struct {
	CandidateDetails CandidateDetails
}

type EmploymentVerificationWorkflowResult

type EmploymentVerificationWorkflowResult struct {
	EmploymentVerificationComplete bool
	EmployerVerified               bool
}

func EmploymentVerification

func EmploymentVerification(ctx workflow.Context, input *EmploymentVerificationWorkflowInput) (*EmploymentVerificationWorkflowResult, error)

EmploymentVerification is a Workflow Definition that calls for the execution of a Side Effect, and an Activity, but then waits on and handles a Signal. It is also capable of handling a Query to get Candidate Details. This is executed as a Child Workflow by the main Background Check.

type FederalCriminalSearchWorkflowInput

type FederalCriminalSearchWorkflowInput struct {
	FullName       string
	KnownAddresses []string
}

type FederalCriminalSearchWorkflowResult

type FederalCriminalSearchWorkflowResult struct {
	Crimes []string
}

func FederalCriminalSearch

func FederalCriminalSearch(ctx workflow.Context, input *FederalCriminalSearchWorkflowInput) (*FederalCriminalSearchWorkflowResult, error)

@@@SNIPSTART background-checks-federal-criminal-workflow-definition

type KnownAddress

type KnownAddress struct {
	Address string
	City    string
	State   string
	ZipCode string
}

type MotorVehicleIncidentSearchWorkflowInput

type MotorVehicleIncidentSearchWorkflowInput struct {
	FullName string
	Address  string
}

type MotorVehicleIncidentSearchWorkflowResult

type MotorVehicleIncidentSearchWorkflowResult struct {
	LicenseValid          bool
	MotorVehicleIncidents []string
}

func MotorVehicleIncidentSearch

func MotorVehicleIncidentSearch(ctx workflow.Context, input *MotorVehicleIncidentSearchWorkflowInput) (*MotorVehicleIncidentSearchWorkflowResult, error)

@@@SNIPSTART background-checks-motor-vehicle-workflow-definition

type SSNTraceWorkflowInput

type SSNTraceWorkflowInput struct {
	FullName string
	SSN      string
}

type SSNTraceWorkflowResult

type SSNTraceWorkflowResult struct {
	SSNIsValid     bool
	KnownAddresses []string
}

func SSNTrace

func SSNTrace(ctx workflow.Context, input *SSNTraceWorkflowInput) (*SSNTraceWorkflowResult, error)

SSNTrace is a Workflow Definition that calls for the execution of a single Activity. This is executed as a Child Workflow by the main Background Check.

type StateCriminalSearchWorkflowInput

type StateCriminalSearchWorkflowInput struct {
	FullName       string
	KnownAddresses []string
}

type StateCriminalSearchWorkflowResult

type StateCriminalSearchWorkflowResult struct {
	Crimes []string
}

func StateCriminalSearch

func StateCriminalSearch(ctx workflow.Context, input *StateCriminalSearchWorkflowInput) (*StateCriminalSearchWorkflowResult, error)

StateCriminalSearch is a Workflow Definition that calls for the execution an Activity for each address associated with the Candidate. This is executed as a Child Workflow by the main Background Check.