Quantcast
Channel: ProjectWise Design Integration Wiki
Viewing all articles
Browse latest Browse all 1890

Passing Log-In Credentials [TN]

$
0
0
Current Revision posted to Content Management - Wiki by Elisa Pry on 6/10/2013 4:05:14 PM

Passing Log-In Credentials [TN]

TechNotes,ProjectWiseSELECTsupport

  

DocumentInformation

DocumentType: TechNote

  

  
 AppliesTo 
  
 Product(s):ProjectWise Web Explorer Lite (WEL)
 Version(s):All
 Environment: N/A
 Area: N/A
 Subarea: N/A
 Original Author:Bentley Technical Support Group

LegacyDocumentNumber: 8360

  

 

 

 

 

 

 

 

 

Overview

ProjectWise Web Explorer Lite has added the ability to add logon credentials to any valid URL. This means that a customer can form a URL that will allow them to display folder contents, document properties or publish a file using Document Publisher or Bentley Publisher.

By default this feature is not enabled. To enable it, modify the web.xml file located in the <installdir>\projectwise\webserver\webapps\WEL\WEB-INF directory.

Change the Filter Mappings section

 

The user Id and Password are added to the URL or request package for a given document or folder action. In order to add some level of security to the process the password must be base64 encoded. This is the same password encryption that web browsers use for basic authentication. It is further recommend that the customer runs the server in SSL mode (HTTPS).

Forming the URL

A typical URL to view a document from Web Explorer Lite looks like:

http://servername/WEL/servlet/LiteServlet?REQUEST_TYPE=VIEW&DSId=datasourceName&VaultId=61&DocId=50

In order to login from another system 3 pieces of information must be added to the URL. The users login id, base64 encoded password and the server name of the server the datasource is published on.

Item RequiredURL VariableComment
Login IdPasswordDatasource Server Name
IdPwDSServer
Plain text user loginBase 64 encoded passwordHost name of the server in which the DSid datasource is running

 

ProjectWise Web Explorer Lite ships with 2 tools to make forming the URLs easier.

  1. A javascript file that can be used in the customers application to base64 encode the password for use in the URL. The javascript file is in:

    <installdir>\projectwise\webserver\webapps\WEL\gfx\styles\base64.js

  2. A sample HTML page that will assist in generating URLs. User is prompted for required information and URLs are generated for viewing a Document List, Document Properties and viewing a document.

    The URL page generation page is located in <installdir>\projectwise\webserver\webapps\WEL\ WELUrlGen.htm
    http://servername/WEL/ WELUrlGen.htm

Please note that the parameter names and values are case sensitive.

The following is a list of request type available.

Datasources

LiteServlet?REQUEST_TYPE=GetDSList

Input&Parameters=refresh
OutputRetrieve all registered datasources in the ProjectWise Web Application Server machine
Style SheetsDS.xsl
RemarksNone

 

LiteServlet?REQUEST_TYPE=LoginScreen

Input&DSId=<datasource_name>
&DSServer=<pw_app_server_hostname>
OutputShow ProjectWise login screen
Style SheetsLoginScreen.xsl
RemarksThis screen is not mandatory as users are prompted for login when LiteServlet requests occur without an opened session.

 

LiteServlet?REQUEST_TYPE=Logout

Input&DSId=<datasource_name>
OutputClose user session
Style SheetsLoggedOut.xsl
RemarksNone

 

Vaults

LiteServlet?REQUEST_TYPE=GetVaultList

Input&DSId=<datasource_name>
&VaultId=<vault_id>
OutputList sub-vaults for the selected vault
Style SheetsDS.xsl
Remarks&vaulted=0 would return all root vaults.

 

LiteServlet?REQUEST_TYPE=RemoveVaultList

Input&DSId=<datasource_name>
&VaultId=<vault_id>
OutputCollapse sub-vaults for the selected vault
Style SheetsDS.xsl
Remarks&vaulted=0 would collapse all root vaults.

 

LiteServlet?REQUEST_TYPE=GetDocList

Input&DSId=<datasource_name>
&VaultId=<vault_id>
OutputRetrieve all documents for the selected vault.
Style SheetsDocument.xsl
RemarksAccess control applies. Users would only see documents that they have access to.

 

Documents

LiteServlet?REQUEST_TYPE=Properties

Input&DSId=<datasource_name>
&VaultId=<vault_id>
&DocId=<document_id>
OutputReturn attributes in "General" sheet.
Style SheetsProperties.xsl
RemarksThis shows the "General" sheet in ProjectWise Explorer.

 

LiteServlet?REQUEST_TYPE=ShowGeneral

Input&DSId=<datasource_name>
&VaultId=<vault_id>
&DocId=<document_id>
OutputReturn attributes in "General" sheet.
Style SheetsProperties_General.xsl
RemarksIf LiteServlet?REQUEST_TYPE=Properties is called, you can switch between property page without the above parameters.

 

LiteServlet?REQUEST_TYPE=ShowAttributes

Input&DSId=<datasource_name>
&VaultId=<vault_id>
&DocId=<document_id>
OutputReturn attributes in "Attribute" sheet.
Style SheetsProperties_Attributes.xsl
RemarksIf LiteServlet?REQUEST_TYPE=Properties is called, you can switch between property page without the above parameters.

 

LiteServlet?REQUEST_TYPE=ShowMoreAttributes

Input&DSId=<datasource_name>
&VaultId=<vault_id>
&DocId=<document_id>
OutputReturn attributes in "More Attributes" sheet.
Style SheetsProperties_MoreAttributes.xsl
RemarksIf LiteServlet?REQUEST_TYPE=Properties is called, you can switch between property page without the above parameters.

 

LiteServlet?REQUEST_TYPE=ReferenceFiles

Input&DSId=<datasource_name>
&Set=<set_id>
OutputReturn a document list show all the reference files for the selected file.
Style SheetsDocument.xsl
RemarksLiteServlet?REQUEST_TYPE=ReferenceFiles is also applicable to flatset.

 

LiteServlet?REQUEST_TYPE=View

Input&DSId=<datasource_name>
&VaultId=<vault_id>
&DocId=<document_id>
OutputView the select file using an appropriate viewer defined in global.viewers.properties.
Style Sheetsvpr.xsl Bentley Publisher ActiveX viewer
Publish.xsl Bentley Publisher Java viewer
TextPage.xsl Document Publisher viewer
RemarksIf no viewer is associated to the select file type, WEL would perform the action defined in "noviewer.action" in "PWLiteServlet.properties". Default is "copyout".

 

LiteServlet?REQUEST_TYPE=CopyOut

Input&DSId=<datasource_name>
&VaultId=<vault_id>
&DocId=<document_id>
OutputCopy ouy the select file.
Style SheetsDownload.xsl
RemarksIf no viewer is associated to the select file type, WEL would perform the action defined in "noviewer.action" in "PWLiteServlet.properties". Default is "copyout".

 

Queries

LiteServlet?REQUEST_TYPE=OpenSearches

Input&DSId=<datasource_name>
&QueryId=<query_id>
OutputExpand "Searches" list in WEL.
Style SheetsDS.xsl
RemarksUse &QueryId=0 for root.

 

LiteServlet?REQUEST_TYPE=QueryByForm

Input&DSId=<datasource_name>
&Environment=<environment_id>
OutputDisplay ProjectWise default search form for the selected environment.
Style SheetsQueryForm.xsl
RemarksNone

 

Examples for the various Request Types

http://KMBPWWEB/WEL/servlet/LiteServlet?REQUEST_TYPE=Login&DSId=Kevin_Oracle9i&DSServer=matrix&Id=admin&Pw=YmVudGxleQ==

http://KMBPWWEB/WEL/servlet/LiteServlet?REQUEST_TYPE=View&DSId=Kevin_Oracle9i&DSServer=matrix&Id=admin&Pw=YmVudGxleQ==&VaultId=137&DocId=1

http:// KMBPWWEB\WEL/servlet/LiteServlet?REQUEST_TYPE=Properties&DSId=Kevin_Oracle9i&DSServer=matrix&Id=admin&Pw=YmVudGxleQ==&VaultId=137&DocId=1

http://KMBPWWEB/WEL/servlet/LiteServlet?REQUEST_TYPE=ShowAttributes&DSId=Kevin_Oracle9i&DSServer=matrix&Id=admin&Pw=YmVudGxleQ==&VaultId=137&DocId=1

http://KMBPWWEB/WEL/servlet/LiteServlet?REQUEST_TYPE=CopyOut&DSId=Kevin_Oracle9i&DSServer=matrix&Id=admin&Pw=YmVudGxleQ==&VaultId=137&DocId=1

http://KMBPWWEB/WEL/servlet/LiteServlet?REQUEST_TYPE=OpenSearches&DSId=Kevin_Oracle9i&DSServer=matrix&Id=admin&Pw=YmVudGxleQ==&QueryId=0

 

See Also

Product TechNotes and FAQs

ProjectWise TechNotes And FAQs

External Links

Bentley Technical Support KnowledgeBase

Bentley LEARN Server

Comments or Corrections?

Bentley's Technical Support Group requests that you please confine any comments you have on this Wiki entry to this "Comments or Corrections?" section. THANK YOU!

 

   


Viewing all articles
Browse latest Browse all 1890

Trending Articles



<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>