Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Connector modules must be licensed in order to be used in Production. Customers can activate the Connector modules in non-Production environments in order to evaluate the APIs and prepare for deployment. Information about enabling additional Grand Avenue modules is at How do I activate (enable) or deactivate (disable) modules in my Grand Avenue Software configuration? To receive a quote for adding Connector Read and/or Connector Write to your configuration, please contact support@grandavenue.com.

Most of the APIs are read-only (i.e. Connector Read). Connector Write has a limited set of APIs for creating Parts, Suppliers, and Customers in a GAS instance. We have existing API endpoints for many process items in the system, including, but not limited to the following:

Resource Name

Description

Activated by Module

Read/Write

ActivityLogEntries

Activity Log Entries for CAPA Requests, Complaints and NCM Reports

CAPA, Complaint Handling, NCM

Read

AssessmentResults

Assessment Results for Training Records

Training Assessment

Read

AssociatedParts

Associated Parts for Issues and Complaints

Complaint Handling

Read

AuditReports

Audit Reports

Audit Management

Read

CapaActions

CAPA Actions

CAPA

Read

CapaCorrections

CAPA Corrections

CAPA

Read

CapaRequests

CAPA Requests

CAPA

Read

CapaRootCauses

CAPA Root Causes

CAPA

Read

ChangeRequests

Change Requests

Document Control

Read

Complaints

Complaints

Complaint Handling

Read

Customers

Customers

Complaint Handling

Read, Write

DesignProjects

Design Projects

Design Control

Read

DeviationRequests

Deviation Requests

Document Control

Read

Documents

Document Revisions

Document Control

Read

Equipment

Equipment

Equipment Management

Read

EquipmentActivityRecords

Activity Records for Equipment

Equipment Management

Read

Issues

Issues

Complaint Handling

Read

NcmReportEntries

Disposition entries for NCM Reports

NCM

Read

NcmReports

NCM Reports

NCM

Read

Parts

Parts

Complaint Handling, NCM, Supplier Management

Read, Write

ReportingZones

Reporting Zones for Complaints

Complaint Handling

Read

RiskAnalyses

Risk Analyses for Risk Files

Risk Management

Read

RiskAnalysisFailureModes

Failure Modes for Risk Analyses

Risk Management

Read

SupplierCorrectiveActionRequests

SCARs

Supplier Management

Read

SupplierEvaluations

Supplier Evaluations

Supplier Management

Read

Suppliers

Suppliers

Audit Management, CAPA, NCM, Supplier Management

Read, Write

TaskAssignments

Task Assignments. NOTE: This endpoint will return all task assignments, not just the task assignments associated with other exposed resources.

Read

TrainingRecords

Training Records

Training Management

Read

Connector Configuration

...

Step

Instructions

  1. Activate Connector Read and/or Connector Write

How do I activate (enable) or deactivate (disable) modules in my Grand Avenue Software configuration?

  1. Set up the connector Connector account

A reserved account with the User ID of "Connector" must be configured in Grand Avenue Software in order to invoke the Connector web services.

  • The "Connector" account cannot sign in interactively and cannot be assigned tasks or roles.

  • The "Connector" account's password does not expire.

  • Information about the "Connector" account can only be modified on this page. This account will not show up on the normal Define Users page.

  1. Click the Configure System link in the left-hand navigation menu

  2. Click the Configure Connector link

  3. Click the Configure Connector Account link

  4. Enable the account (Yes), assign a secure password, and click Save

image-20241029-172346.png

  1. Enable the OData API

The OData APIs are disabled by default and need to be turned on before they are accessible.

  1. Click the Configure System link in the left-hand navigation menu

  2. Click the Configure Connector link

  3. Click the Configure OData API link

  4. Enable the OData API (Yes) and click Save

image-20241029-173351.png

  1. Verify that the OData API is accessible via web browser

  1. Return to the Configure OData API page and click the OData Service Document URL for the latest version.

  2. Enter the username “Connector” and the password for the Connector account and click OK Sign in.

image-20241029-174521.pngImage Added
  1. Verify the result shows the accessible GAS items for your activated modules

CapaRequests
  1. (ActivityLogEntries,

Complaints
  1. CAPARequests, etc.).

...

Verify that OData is accessible via web browser

...

image-20241029-175415.pngImage Added

For examples showing use of the Connector modules with Excel and Power BI, please see the following articles:

...