Air Maestro - Web Manual Integration

To establish the Air Maestro (AM) - Web Manual (WM) integration, Avinet support team needs the

1. Web Manual Domain (Web Manual URL)

2. API Key.

Users can get the API key by following below steps (You need to be an WM Administrator to get the API key)

a. Login to WM as an admin

b. Go to ‘System’ → Partner Integrations → Click ‘Configure’ under Air Maestro box.

Open

c. Go to the bottom of the newly opened window and click on the icon shown in below image and paste it in an email and send to the help@airmaestro.net email address with other details.

Open

Support team will login to your Air Maestro domain and configure the link.

• Creation of a category (folder)
  
  In WM folders are referred as a ‘Category’. Once a category is created in WM, the WM administrator needs to give ‘view’ access to that category to view in AM document library. Please follow below steps to create a new category in WM and provide view access to that category (Note: You need to have admin access to create a category in WM).
  
  

  • Go to ‘Document’ → Click on ‘Add Category’ → Name the ‘Category’ → Click ‘Save’.
    (You will see already created categories like in below screenshot)

  • Now you need to provide ‘View’ permission to the newly created category.
    Go to ‘Users’ → Permissions → Click on the 'intersection of Air Maestro API and new category name cage’ until you get the ‘V' [background striped purple colour]. (Refer number 3 in below images) → Click on ‘Update’ (Striped Purple background will turn into solid Purple background).

     

     

  • Once view permission is given to the category(ies), you can see the folder structure in Air Maestro Document Library. The categories will be listed under a new folder called ‘Web Manuals Documents’.

    
    Note: The contents of this will mirror the Web Manuals Documents and will be synchronised every five minutes.
    
    

• Publish Document
  
  Go to the ‘Documents' and click on the relevant category where you like to publish the document. This will open a sub-window, click on the ‘Add Document’ → File Document → Fill the mandatory fields and tick ‘Publish’ → Click ‘Save’.

• View Documents in Air Maestro.
  
  Right click on the document in Air Maestro and select ‘View in Web Manuals’, if you want to view it in Web Manual interface.
  If you want to view it in Air Maestro, double click on the document and it will get downloaded.

• Send Manual Alerts
  
  As you would with any other document.

• Delete Documents in Web Manuals
  
  Web Manual documents cannot directly delete from Air Maestro document library. Once you ‘Achieve’ a document in Web Manual, it will be deleted in Air Maestro in the next immediate synchronization (within 5 minutes).
  
  

• Revise a Web Manual Document.
  
  Once you upload a revision for an existing document in Web Manual, in the next immediate synchronization the old document will be replaced by the new revised document. Follow the steps to upload a new revision.
  
  Select the document that need to revise → Click ‘Create New Revision’ → Fill the details and upload the revision file → Click ‘Save’.

  
  In the next window, click the ‘Accept’ button three-times to accept it (Note that the Black Outline should be moved from Yellow circle till Green circle). After, click 'Publish.

  
  In the ‘Publish Revision’ window, click ‘Publish’ button to publish the document.