General Reference

GAA Wind Data Model

The following diagram shows the relationships between the families used in GAA Wind.

Note: In the diagram, boxes represent entity families and arrows that are labeled represent relationship families that are configured in the baseline database. Arrows that are not labeled represent foreign key relationships. You can determine the direction of each relationship from the direction of the arrow head: the box from which the arrow originates is the predecessor, and the box to which the arrow head points is the successor.

Additional GAA WindEntity Families

In addition to the entity families shown in the diagram, the following entity families are used in GAA Wind:
  • GAA Wind Import Details
  • GAA Wind Report Details
  • GAA Wind Bulk Report Details

GAA Wind Security Groups

The following table lists the baseline Security Groups available for users within this module, as well as the baseline Roles to which those Security Groups are assigned.

Important: Assigning a Security User to a Role grants that user the privileges associated with all of the Security Groups that are assigned to that Role. To avoid granting a Security User unintended privileges, before assigning a Security User to a Role, be sure to review all of the privileges associated with the Security Groups assigned to that Role. Also, be aware that additional Roles, as well as Security Groups assigned to existing Roles, can be added via Security Manager.
Security GroupRoles
GAA Wind
MI GAA Wind Super AdministratorMI GAA Wind Super Administrator
MI GAA Wind AdministratorMI GAA Wind Administrator
MI GAA Wind AnalystMI GAA Wind Analyst
MI GAA Wind OperatorMI GAA Wind Operator
GAA Wind with APM Connect
MI CMMS Interface Administrator

MI GAA Wind Super Administrator

MI GAA Wind Administrator

GAA Wind with Policy Designer
MI Policy Designer

MI GAA Wind Super Administrator

MI GAA Wind Administrator

MI Policy User

MI GAA Wind Analyst

MI GAA Wind Operator

The baseline family-level privileges that exist for these Security Groups are summarized in the following table.

FamilyMI GAA Wind Super AdministratorMI GAA Wind AdministratorMI GAA Wind AnalystMI GAA Wind Operator
Entity Family
GAA CompanyView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Bulk Report DetailsView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind ConnectionView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind EventView, Insert, Update, DeleteView, Insert, Update, DeleteView, Insert, Update, DeleteView
GAA Wind GroupView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind IEC And NERC MappingView, Insert, Update, DeleteViewViewView
GAA Wind IEC TypesView, Insert, Update, DeleteViewViewView
GAA Wind Import DetailsView, Insert, Update, DeleteView, Insert, Update, DeleteView, Insert, UpdateView
GAA Wind NERC TypesView, Insert, Update, DeleteViewViewView
GAA Wind PerformanceView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind PlantView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Report ConfigurationView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Report DetailsView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Scheduled JobView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Sub GroupView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Sub Group CapacityView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind UnitView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
Relationship Family
Functional Location Has GAA Wind GroupView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
Functional Location Has GAA Wind PlantView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
Functional Location Has GAA Wind Sub GroupView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
Functional Location Has Generation CompanyView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Company Has PlantView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Connection is associated with Sub GroupView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Group Has Sub GroupView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Plant Has GroupView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Schedule Job Has Company And SubgroupView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Sub Group Has ConfigurationView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Sub Group Has UnitView, Insert, Update, DeleteView, Insert, Update, DeleteViewView
GAA Wind Unit Has EquipmentView, Insert, Update, DeleteView, Insert, Update, DeleteViewView

GAA Wind URLs

The URL route that is associated with GAA Wind is gaa-wind. The following table describes the various paths that build on the route, and the elements that you can specify for each path.

Tip: For more information, refer to the URLs section of the documentation.
ElementDescriptionAccepted Value(s)Notes
gaa-wind/dashboard/<EntityKey>: Displays the GAA Wind Overview page for a particular asset.
<EntityKey>Represents the Entity Key of the asset for which you want to access the GAA Wind Overview page.Numeric Entity Key that corresponds to an asset.If <EntityKey> is 0, the GAA Wind Overview page appears for all assets, unless you have already selected an asset in the Asset Hierarchy. If <EntityKey> is other than 0, the GAA Wind Overview page appears for a specific asset.
eventimport: Displays the GAA Wind Event Import page.
gaa-wind/<EntityKey>/<StartDate>T<StartTime>.000%20/%20<EndDate>T<EndTime>.000/<EditedStatus>/eventlists: Displays the Events workspace in the Sub Group Summary page.
<EntityKey>Represents the Entity Key of the Sub Group that is associated with the Events that you want to access.Numeric Entity Key that corresponds to a Sub Group.None.
<StartDate>Represents the start date based on which the Events are filtered.Date in the following format: yyyy-mm-dd.None.
<StartTime>Represents the start time based on which the Events are filtered.Time in the following format: hh:mm:ss.None.
<EndDate>Represents the end date based on which the Events are filtered.Date in the following format: yyyy-mm-dd.None.
<EndTime>Represents the end time based on which the Events are filtered.Time in the following format: hh:mm:ss.None.
<EditedStatus>Indicates if the Events have been edited (that is, if the value in the NERC Type field of the Events is different from that in the Mapped NERC Type field).One of the following values:
  • false: If you want to access Events that have not been edited.
  • true: If you want to access Events that have been edited.
None.
gaa-wind/<EntityKey>/performance: Displays the Performance workspace in the Sub Group Summary page.
<EntityKey>Represents the Entity Key of the Sub Group that is associated with the Performance Records that you want to access.Numeric Entity Key that corresponds to a Sub Group.None.
windperformance/<EntityKey1>/<EntityKey2>/<ReportingMonth>/<ReportingYear>/<EntityKey3>: Displays the Performance Record.
<EntityKey1>Represents the Entity Key of the Sub Group that is associated with the Performance Record that you want to access or create.Numeric Entity Key that corresponds to a Sub Group.None.
<EntityKey2>Represents the Entity Key of the Performance Record that you want to access.Numeric Entity Key that corresponds to a Performance Record.To create a Performance Record, enter the value 0.
<ReportingMonth>Represents the month associated with the Performance Record that you want to access or create.Month in the following format: mm.None.
<ReportingYear>Represents the year associated with the Performance Record that you want to access or create.Year in the following format: yyyy.None.
<EntityKey3>Represents the Entity Key of the Report Configuration record associated with the Sub Group for which you want to access or create a Performance Record.Numeric Entity Key that corresponds to a Report Configuration record.None.
gaa-wind/<EntityKey>/reports: Displays the Reports workspace in the Sub Group Summary page.
<EntityKey>Represents the Entity Key of the Sub Group that is associated with the Performance or Sub Group Reports that you want to access.Numeric Entity Key that corresponds to a Sub Group.None.
gaa-wind/admin/settings: Displays the GAA Wind Administrator page.
gaa-wind/admin/company/<EntityKey>: Displays the Company.
<EntityKey>Represents the Entity Key of the Company that you want to access.Numeric Entity Key that corresponds to a Company.None.
gaa-wind/admin/plant/<EntityKey>: Displays the Plant.
<EntityKey>Represents the Entity Key of the Plant that you want to access.Numeric Entity Key that corresponds to a Plant.None.
gaa-wind/admin/group/<EntityKey>: Displays the Group.
<EntityKey>Represents the Entity Key of the Group that you want to access.Numeric Entity Key that corresponds to a Group.None.
gaa-wind/admin/subgroup/<EntityKey>: Displays the Sub Group.
<EntityKey>Represents the Entity Key of the Sub Group that you want to access.Numeric Entity Key that corresponds to a Sub Group.None.
gaa-wind/admin/unit/<EntityKey>: Displays the Unit.
<EntityKey>Represents the Entity Key of the Unit that you want to access.Numeric Entity Key that corresponds to a Unit.None.

URLs

URLDestination
gaa-wind/1234567/2019-01-13T00:00:00.000%20/%202019-01-19T00:00:00.000/false/eventlistsThe Events workspace for the Sub Group whose Entity Key is 1234567, displaying Events that have not been edited and whose start time stamp and end time stamp together are within January 13, 2019, 00:00:00, and January 19, 2019, 00:00:00.
gaa-wind/1234567/performanceThe Performance workspace for the Sub Group whose Entity Key is 1234567.
windperformance/1234567/2345678/01/2019/3456789Performance Record whose Entity Key is 2345678, for January 2019, for the Sub Group whose Entity Key is 1234567, and for the Report Configuration record whose Entity Key is 3456789.
gaa-wind/1234567/reportsThe Reports workspace for the Sub Group whose Entity Key is 1234567.
gaa-wind/admin/company/4567891Company whose Entity Key is 4567891.
gaa-wind/admin/plant/5678912Plant whose Entity Key is 5678912.
gaa-wind/admin/group/6789123Group whose Entity Key is 6789123.
gaa-wind/admin/subgroup/7891234Sub Group whose Entity Key is 7891234.
gaa-wind/admin/unit/8912345Unit whose Entity Key is 8912345.

GAA Wind System Code Tables

The following table provides a list of System Code Tables that are used by GAA Wind.
Table IDTable DescriptionFunction
MI_GAA_WIND_MONTH_LISTGAA Wind MonthPopulates the Month field in the GAA Wind Sub Group Capacity record.
MI_GAA_WIND_STATESGAA Wind StatePopulates the State field in the GAA Wind Plant and GAA Wind Sub Group records.
MI_GAA_WIND_COUNTRY GAA Wind CountryPopulates the Country field in the GAA Wind Plant and GAA Wind Sub Group records.
MI_GAA_WIND_REGIMES GAA Wind RegimePopulates the Wind Regime field in the GAA Wind Sub Group record.
MI_GAA_WIND_REPORT_TYPESGAA Wind Report TypePopulates the Report Type field in the GAA Wind Report Configuration record.
MI_GAA_WIND_SCADA_MANUFACTURERSGAA Wind SCADA ManufacturerPopulates the SCADA Manufacturer field in the GAA Wind Sub Group record.
MI_GAA_WIND_SHEAR GAA Wind ShearPopulates the Wind Shear field in the GAA Wind Sub Group record.
MI_GAA_WIND_SUBGROUP_OWNERSHIP_STATUS GAA Wind Sub Group Ownership StatusPopulates the Sub Group Ownership Status field in the GAA Wind Sub Group record.
MI_GAA_WIND_SUBGROUP_STATUS GAA Wind Sub Group StatusPopulates the Sub Group Status field in the GAA Wind Sub Group record.
MI_GAA_WIND_TURBINE_MANUFACTURERSGAA Wind Turbine ManufacturerPopulates the Turbine Manufacturer field in the GAA Wind Sub Group record.
MI_GAA_WIND_TURBULENCE GAA Wind TurbulencePopulates the Turbulence Intensity field in the GAA Wind Sub Group record.
MI_GAA_WIND_NERC_REGIONS GAA Wind NERC RegionPopulates the Region field in the GAA Wind Plant and GAA Wind Sub Group records.
MI_GAA_WIND_IEC_TYPES_LEVELS GAA Wind IEC Type LevelPopulates the Level field in the GAA Wind IEC Types record.

GAA Wind Site Filtering

The GAA Wind families use the Site Filtering feature of APM. You can access or modify only global records and records that are associated with sites to which you are assigned.

The following GAA Wind families are not enabled for site filtering and are considered global records:
  • IEC and NERC Mapping
  • IEC Types
  • NERC Types
  • Report Configuration
Tip: For more information, refer to the Site Filtering section of the documentation.

Consider an organization that has three sites: Site X, Site Y, and Site Z.

Scenario 1: User assigned to only Site X

This user can access or modify only the global records and records that are associated with Site X.

Scenario 2: User assigned to only Site X and Site Y

This user can access or modify only the global records and records that are associated with Site X and Site Y.

Scenario 3: Super User

This user can access or modify the global records and records that are associated with Site X, Site Y, and Site Z.

GAA Wind State Management

GAA Wind uses the standard State Management functionality to manage GAA Wind Performance Records. The following baseline states are configured for records in the GAA Wind Performance family:
  • In Progress: State of a Performance Record that is new, rejected, or reopened.
  • Pending Approval: State of a Performance Record that is submitted for review or resubmitted for review.
  • Approved: State of a Performance Record that is approved. You cannot modify such a Performance Record.
Important:
  • A user who is assigned to the following Security Roles can change the state of a Performance Record from In Progress to Pending Approval:
    • MI GAA Wind Super Administrator
    • MI GAA Wind Administrator
  • A user who is assigned to the following Security Roles can change the state of a Performance Record from Pending Approval to Approved or In Progress:
    • MI GAA Wind Super Administrator
    • MI GAA Wind Administrator
  • A user who is assigned to the following Security Roles can change the state of a Performance Record from Approved to In Progress:
    • MI GAA Wind Super Administrator
    • MI GAA Wind Administrator
The following diagram shows the workflow of the baseline GAA Wind State Management process for the GAA Wind Performance family.

Events Data

When you export an event, an Excel work book containing the Events data is downloaded.

Note:
  • The Excel work book will have the same order of columns as the grid on the Events workspace and the data will always be in logged in user time zone. Few other columns are also exported which will be required when importing the same data back into APM.
  • The first row in the Excel work book will have the field IDs from GAA Wind Event family which identifies the data in each column.
  • The event data in Excel work book cannot be loaded back to APM using GAA Wind Events data loader work book, if grouping is done on event data in Events workspace before exporting the data.
  • The gap records if any, present in the Events workspace will not be exported.
  • Individual Event records cannot be exported using this feature.
  • All the Excel work book standards and limitations are applicable.

The following table lists all the columns that appear in the downloaded file unless the user has made some modifications on the visibility and order of the columns on the Events workspace.

Table 1.
Field IDData Type (Length)Comments
MI_GAA_WIND_EVEN_ASSE_ID_CCharacterIdentifies the Unit for which the Event is reported. Corresponds to the Unit Name field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
MI_GAA_WIN_EVE_IEC_EVE_TYP_C CharacterIdentifies the type of the Event. Corresponds to the IEC Type field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
MI_GAA_WIND_EVEN_STAR_DATE_D DateIdentifies the start date of the Event. Corresponds to the Start Date field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
MI_GAA_WIND_EVEN_END_DATE_D DateIdentifies the end date of the Event. Corresponds to the End Date field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
MI_GAA_WIND_EVEN_EVEN_DURA_N NumericIdentifies the difference between the values in the End Date field and the Start Date field. Corresponds to the Duration field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
MI_GAA_WIND_EVEN_DESC_C TextIdentifies the description of the Event. Corresponds to the Description field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
MI_GAA_WIND_EVE_NER_TYP_C CharacterIdentifies the NERC equivalent of the IEC type. Corresponds to the NERC Type field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
MI_GAA_WIND_EVEN_ERRO_CODE_C CharacterIdentifies the validation error. Corresponds to the Error Code field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
MI_GAA_WIND_EVE_ACT_PRO_N NumericIdentifies the actual production of the Unit in megawatt hours.
MI_GAA_WIND_EVEN_EVEN_ID_C CharacterIdentifies the Event.Corresponds to the Event ID field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
MI_GAA_WIND_EVEN_SUBG_KEY_N NumericIdentifies the key of the Sub Group for which the Event is reported.Corresponds to the Sub Group Key field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
MI_GAA_WIND_EVEN_ASSE_KEY_N NumericIdentifies the key of the Unit for which the Event is reported.Corresponds to the Unit Key field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
MI_SITE_NAME CharacterIdentifies the name of the site that is assigned to the Event record.Corresponds to the Site Reference Name field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
MI_GAA_WIND_EVEN_STAR_DATE_D|TZ CharacterIdentifies the name of the time zone for the Start Date field.Corresponds to the Start Date Timezone field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
Note: The value in this field will always be logged in User time zone.
MI_GAA_WIND_EVEN_END_DATE_D|TZ CharacterIdentifies the name of the time zone for the End Date field.Corresponds to the End Date Timezone field in IEC Events worksheet in GAA Wind Events Dataloader workbook.
Note: The value in this field will always be logged in User time zone.