Admin Console - IQSMS Interface
Discover how manage IQSMS data in the Admin Console.
Introduction
IQSMS serves as a specialized software solution tailored for conducting audits of documentation within the Aviation sector. Specifically designed by ASQS, it efficiently handles a spectrum of regulations pertinent to airline documentation, including a set of regulations (IOASA and EASA).
The interface between IQSMS and Yonder aims to facilitate customers of their documentation within Yonder with corresponding regulations stored within IQSMS. This integration provides notification and also automated change notifications regarding any alterations in these regulations.
The objective is to establish a bidirectional connection between both systems - IQSMS and Yonder:
Within IQSMS, auditors will prepare their audits, focusing on specific questions related to the location and manner in which airlines document required content. These rules are then linked to the actual content in Yonder directly from IQSMS. IQSMS therefore displays a clickable button directly opening the corresponding regulation in Yonder.
Within Yonder, users can identify on module level which modules refer respectively link to a regulation. By selecting such a link, users are directed to the regulation.
Consequently, customers gain the ability to promptly review and potentially revise their documentation to ensure compliance with the latest regulatory requirements, thereby streamlining the audit process and enhancing overall efficiency.
Thesarus
IQSMS | Yonder | Comment |
---|---|---|
Regulation | Document | A regulation is a set of amendments. A Yonder document contains one or more regulations. |
Amendment | Document version (Revision) | A version of a regulation |
Paragraph | Module | A single paragraph in an amendment |
Predecessor ID | - | ID of an earlier amendment version |
Import | dito | Import of IQSMS regulations into Yonder |
Export | dito | Exporting links between documents and regulations from Yonder to IQSMS (links are displayed within IQSMS to provide a quick access to relevant documentation for a particular compliance question). |
Interface Setup
Before IQSMS regulations can be imported, the connection must be configured. For this the customer needs the following information for the API from their ASQS contact: URL + Username + Password.
To access the IQSMS Settings screen and configure the integration in Yonder, the role iqsms_admin is required.
After the credentials have been entered, click Save and wait for the indicator label (Green, showing “Connected” in the screenshot above).
- issues are indicated with a red labe (e.g. problems with the credentials)
Notes:
- It might take a few seconds until the indicator label is updated properly.
- The URL is expected to be a complete HTTPS URL. Example: https://youraccount.asqs.net.
IQSMS General Screen
The IQSMS Importer tab shows all regulations that are imported via IQSMS. Please note that this functionality is only visible to subscribers of the IQSMS connector.
The overview page (list of IQSMS Documents) provides the following main functions / information.
- Regulation (name)
Shows the name of the regulation.
Remark: clicking on the + sign will open the list of the selected regulation, showing all its versions.
- Regulation ID
- Amendment ID
- Predecessor ID
- Effective
Shows the Effective From date of the regulation.
- Status
Shows the status of the regulation:
- Imported = The regulation has already been imported to Yonder
- Available = The regulation is ready to be imported
- Obsolete = A newer version has already been imported
- Action
Click on the download icon to import the regulation into Yonder.
Once the IQSMS document is imported into Yonder it will be shown in the “Documents” Window of the Admin Console.
The list of regulations can be sorted by clicking on the arrows in the “Regulation” column, as highlighted in the image above.
When clicking on the download icon (5) next to an available regulation in the “Actions” column, the import job will be started. This job will also be shown in the Admin Interface under “Jobs”.
Required Permissions
See overview here
General Functions
The interface to IQSMS is required which supports the following basic features:
- Import and display IQSMS regulations in Yonder
- Import updated IQSMS regulations
- Create a change request ()CR for linked targets in Yonder if an IQSMS regulation has changed
- Create export package for IQSMS which will allow the user (normally the customers quality manager or the auditor) within IQSMS to open linked content directly in Yonder
1 - Importing IQSMS Regulations
IQSMS regulations are imported via the tab IQSMS Importer in the Admin UI.
- The IQSMS API delivers all regulations for the respective customer
- Each regulation contains a set of amendments
- An amendment contains a set of standards
- The importer writes a document for each regulation in Yonder, containing these standards:
- the regulation will be stored as document in Yonder
- each standard will be stored within this document as a module
Initial Regulation Import
Any regulation version (amendment in IQSMS) can be imported as the initial version (typically start with the most recent / current regulation version).
The import is triggered by clicking the import button.
Regulation Update
Important: If a version (amendment) has been previously imported, only subsequent versions can be imported. Omitting any versions would compromise the ability to accurately detect changes.
When an import is started, a validation is initiated:
- if the validation is ok, a popup message is shown and the validation was successful and the import is started. This changes the status to Runnnig... .
- The import runs in the background.
- When the import is finished, the status will change to Imported:
Yonder's API is accessed by IQSMS nightly to retrieve data on all documents and modules in Yonder linked to IQSMS regulations.
IQSMS users can access relevant content in Yonder directly via a link in the IQSMS web application.
For this integration to function, ASQS requires credentials to access the API. Accounts need to be created in KeyCloak on Yonders' side and ASQS platforms. Please reach out to your key account manager at ASQS for assistance if needed.
Notes:
- Links do not appear immediately in IQSMS as the information is only loaded once every night.
- The Yonder API is documented here
2 - Creating links in Yonder Mind to IQSMS regulations
Within Yonder, the dedicated link-type ‘legal link’ is to be used for IQSMS links.
The user is required to create the link between the module in Yonder and the corresponding target in the IQSMS regulation, utilizing the specified legal link type mentioned above.
3 - Import updated IQSMS regulations
Updates run every 24h. During an update, it is verified, if the current regulation does have a new version (amendment).
It is checked:
- If the regulation does have a new version, (amendment) a new version is added to the corresponding document in Yonder.
- Within the regulations, updated standards can be found by matching the ‘predecessor’ ID. does have an ID stored.
- A new module version will be added in Yonder to the module with the corresponding ID.
The link manager assures, that an automated Change Request is generated for updated modules → in conequence the document owner will be notified about the new version.
4 - Export links to IQSMS
The Yonder API can be queried by IQSMS (normally every 24h).
The API returns all links having the corresponding link type.
Each link contains:
- the IQSMS regulation ID and version
- the IQSMS standard ID
- a deep link to the linked module in Yonder
Yonder always export the complete link list. IQSMS is taking care about changes in links on their side.
Interface Logic
General prerequisites
- Unique regulation ID's: each regulation ID is considered unique when delivered by IQSMS
- Unique amendment ID's: each amendment ID is considered unique when delivered by IQSMS
Amendment Grouping
Amendments are grouped based on the 'predecessor' field:
When an amendment introduces a new regulation ID, it is grouped by the predecessor ID (although having a different regulation ID).
- if no predecessor is delivered by the interface, Yonder treats the amendment as a new document
IQSMS - ISM
The IOSA Standards Manual (ISM) is delivered via IQSMS.
The ISM document can maintain multiple concurrent valid editions, each of which may undergo updates through new revisions of those editions.
This situation presents the following challenges:
- Updates do not occur in chronological order.
- Minor revisions can be made to an older edition of the ISM document.
- Users desire to work on new revisions while simultaneously updating the older version.
Implementation
Manage ISM Documents
The ISM documents are shown in a dedicated section.
Access the content: Yonder Admin Console > ISM Importer
- Each version of the ISM document is displayed as an individual document, and each can be updated independently.
- When a new edition of the ISM will automatically be added as a new document to the list of ISM documents when it is released.
In order to import every direct document succsessor in the import view, the import button in the “Actions” column is for every amendment which its predecessor has been already imported.
Example with the “IOSA Standarts Manual (ISM)” regulation:
- If we have imported amendmet “ISM 14. Edition, R1” then both “ISM 14. Edition, R1, Temporary Revision 1” and also “ISM 15. Edition” must show the import button.
Note: Once a "branch" of amendments is abandoned by IQSMS, there is no option to merge the versions back together.