ASSAI is a document repository, for which we have an interface created in IMS.
Requests for Assai interface should initially go through the Account Manager.
Requirements
For Cenosco to be able to provide the User with a working interface the following must be provided by the Client:
InstanceUrl (eg., https://*.assaicloud.com/)
Username
Password
Instance
ProjectCode
Important
It is very important that the provided User is a valid and Active one.
The User can be provided and checked with the dedicated Assai Agent
Setting up the interface
To do an Assai configuration:
Go to Maintenance → Configuration → Application Settings.
Search for “Assai”.
Open the JSON editor.
Here the interface can be configured.
Tip
As the editor itself is pretty clunky JSON can be copy pasted in Notepad ++ and edited there.
Note that you can use the Plugins → JSTool →JSON sort can help you edit the JSON code in a tidier way.
The below data is defined by the User and it has to be correctly set up:
User needs to be Valid and Active for the drawings to be visible from the IMS side. This part is set by the Client wit their dedicated Assai agent.
When none of the Assai drawings are visible, in most cases the reason for this is an obsolete User.
Drawings in Assai are stored under the Project Code and this needs to be correct, so the drawings would be visible to the end user.
The Project Code needs to be assigned to the User from the Assai/Client side.
Below you can see what the generic JSON for the interface looks like:
"InstanceUrl": "",
"Username": "",
"Instance": "",
"Password": "",
"ProjectCode": "",
"EnableFlocSearch": true,
"EnableEqSearch": true,
"DocumentsApi": "/api/views/dbi_document_urls",
"DocumentsQuery": "project_code={Project}&document_nr={Document}&page=0&size=100&response_type=json",
"Fields": {
"Project": "project_code",
"Document": "document_nr",
"Revision": "revision_code",
"Source": "source_file_url",
"Publish": "publish_file_url"
},
"DownloadApi": "/api/fils/download_document",
"DownloadQuery": "?project_code={Project}&document_nr={Document}&revision={Revision}",
"DownloadType": "&filetype=source|&filetype=publish",
"FlocSearchApi": "api/views/dbi_asset_item_docs_proj?document_nr={Document}&project_code={Project}&asset_item_code={Asset}&asset_type=FLOC",
"FlocFields": {
"Document": "document_nr"
},
"EqSapSearchApi": "api/views/dbi_asset_item_docs_proj?document_nr={Document}&project_code={Project}&asset_item_code={Asset}&asset_type=EQPM",
"EqSapFields": {
"Document": "document_nr"