Resolution:
Description:
============
Correct way to seamlessly integrate an external web-page in with the CIM application for Record Add / Record View / Record Modify.

Environment:
===========
TIBCO Collaborative Information Manager, (CIM) 8.2.1, all versions

Symptoms:
========
When following the CIM documentation on redirection, the URLs provided are found to be incomplete and so the redirection fails.


Cause:
=====
The CIM 8.2.1 Customization Guide >> Chapter 2 >> Redirecting from a Custom Page to the Application >> Table 8 is inaccurate.

For Record Add the table states that the following URL be used :

http://&ltserver>:&ltport>/eml/AddProduct?htmlaction=add&init=true&hiddenWFCheck=default&initrecordbundle=true&retURL=BrowseRepository?&hiddenCriteriaPaneShown=true&hiddenViewAllClicked=true&currentPageNum=1&pageSize=50&goToPageNum=1&pageRequest=0&Direction=NEXT&popup=y

For Record View the table states that the following URL be used :

http://&ltserver>:&ltport>/eml/RecordMaster?initrecordbundle=true&htmlaction=view&init=true&hiddenWFCheck=Y&hasOpenWI=N&can_edit_in_wf=Y&canedit=Y&popup=y

For Record Modify the table states that the following URL be used :

http://&ltserver>:&ltport>/eml/RecordMaster?initrecordbundle=true&htmlaction=modify&init=true&hiddenWFCheck=Y&hasOpenWI=N&can_edit_in_wf=Y&canedit=Y&can_save_with_errors=Y&popup=y

In fact, if the user session has timed out or the CIM user has not logged in, these will all fail.  They also lack information as to what URL to return to once one of Validate, Save, Save & Process, Cancel or OK buttons have been clicked.

If fact, instead of a simple URL pattern such as those given above, a URL pattern of:

http://&ltserver>:&ltport>/eml/Login? ... &redirect=RecordMaster? ... &retURL=RecordModify ... &retURL1=BrowseRepository? ...

is required.

Resolution:
==========
In order to redirect in a browser from a custom page to a Record Add, View or Modify page in the CIM application,a URL pattern of:

http://&ltserver>:&ltport>/eml/Login? ... &redirect=RecordMaster? ... &retURL=RecordModify ... &retURL1=BrowseRepository? ...

is required.  Unfortunately, the CIM documentation on redirection is incomplete.  Looking at Record Add, Record View and Record Modify in table 8 of the CIM 8.2.1 Customization Guide (Chapter 2: Redirecting from a Custom Page to the Application) :

the URL for Record Add should read :

http://&ltserver>:&ltport>/eml/Login?loginname=&ltloginname>&enterprisename=&ltenterprisename>&passwd=&ltpassword>&action=validate&redirect=AddProduct?initrecordbundle=true&htmlaction=modify&init=true&hiddenWFCheck=Y&hasOpenWI=N&can_edit_in_wf=Y&canedit=Y&can_save_with_errors=Y&retURL=RecordModify&URLCtr=1&mastercatalogname=&ltmastercatalogname>&retURL1=BrowseRepository?&action=&repoId=&ltrepositoryID>&hiddenCriteriaPaneShown=true&hiddenViewAllClicked=true&hiddenclsfnClicked=&hiddenSearchClicked=&hiddenSelectedCodeId=&hiddenSelectedSchemeId=&hiddenSelectedCodeName=&hiddenClsfnBreadcrumb=&hiddenCriteria=&hiddenFEDFilter=&currentPageNum=1&pageSize=50&goToPageNum=1&pageRequest=0

the URL for Record View should read :

http://&ltserver>:&ltport>/eml/Login?loginname=&ltloginname>&enterprisename=&ltenterprisename>&passwd=&ltpassword>&action=validate&redirect=RecordMaster?initrecordbundle=true&htmlaction=view&init=true&hiddenWFCheck=Y&hasOpenWI=N&can_edit_in_wf=Y&canedit=Y&can_save_with_errors=Y&retURL=RecordModify&URLCtr=1&mastercatalogname=&ltmastercatalogname>&productID=&ltproductID>&productExt=&ltproductIDExt>&retURL1=BrowseRepository?&action=&repoId=&ltrepositoryID>&hiddenCriteriaPaneShown=true&hiddenViewAllClicked=true&hiddenclsfnClicked=&hiddenSearchClicked=&hiddenSelectedCodeId=&hiddenSelectedSchemeId=&hiddenSelectedCodeName=&hiddenClsfnBreadcrumb=&hiddenCriteria=&hiddenFEDFilter=&currentPageNum=1&pageSize=50&goToPageNum=1&pageRequest=0

and the URL for Record Modify should read :

http://&ltserver>:&ltport>/eml/Login?loginname=&ltloginname>&enterprisename=&ltenterprisename>&passwd=&ltpassword>&action=validate&redirect=RecordMaster?initrecorbundle=true&htmlaction=modify&init=true&hiddenWFCheck=Y&hasOpenWI=N&can_edit_in_wf=Y&canedit=Y&can_save_with_errors=Y&retURL=RecordModify&URLCtr=1&mastercatalogname=&ltmastercatalogname>&productID=&ltproductID>&productExt=&ltproductIDExt>&retURL1=BrowseRepository?&action=&repoId=&ltrepositoryID>&hiddenCriteriaPaneShown=true&hiddenViewAllClicked=true&hiddenclsfnClicked=&hiddenSearchClicked=&hiddenSelectedCodeId=&hiddenSelectedSchemeId=&hiddenSelectedCodeName=&hiddenClsfnBreadcrumb=&hiddenCriteria=&hiddenFEDFilter=&currentPageNum=1&pageSize=50&goToPageNum=1&pageRequest=0

where, for each of the above:

&ltenterprisename> is the name of the enterprise containing the repository record to be added / viewed / modified
&ltloginname> is the login name for the user for the enterprise containing the repository record to be added / viewed / modified
&ltpassword> is the password for the user for the enterprise containing the repository record to be added / viewed / modified
&ltmastercatalogname> is the name of the master catalog repository containing the repository record to be added / viewed / modified
&ltrepositoryID> is the ID of the master catalog repository containing the repository record to be added / viewed / modified
&ltproductID> is the ID of the repository record to be added / viewed / modified
&ltproductIDExt> is the IDEXT of the repository record to be added / viewed / modified

These URLs work and allow an external web-page to integrate seamlessly in with the CIM application.

References
==========
CIM 8.2.1 Customization Guide >> Chapter 2 >> Redirecting from a Custom Page to the Application >> Table 8.
SR_Id:1-EDLWXN: CIM:8.2.1:Link to MDM not showing menus and failing to link custom pages in correctly with CIM GUI application pages.