GetInterlink

Syntax

GetInterlink(Interlink.name)

Description

Use the GetInterlink function to instantiate a Business Interlink definition object based on a Business Interlink definition created in Application Designer. The Business Interlink object can provide a gateway for PeopleSoft applications to the services of any external system.

After you use this function, you may want to refresh your page. The Refresh rowset class reloads the rowset (scroll) using the current page keys. This causes the page to be redrawn. GetLevel0().Refresh() refreshes the entire page. If you only want a particular scroll to be redrawn, you can refresh just that part.

Generally, do not use the GetInterlink function in a program you create from scratch. If you drag a Business Interlink definition from the project workspace (in Application Designer) to an open PeopleCode editor window, a "template" is created, with values filled in based on the Business Interlink definition you dragged in.

The following is the template created from dragging the Business Interlink definition LDAP_SEARCHBIND to an open PeopleCode editor window.

/* ===> 
   This is a dynamically generated PeopleCode template to be used only as a helper
 to the application developer.  You need to replace all references to '<*>' OR
 default values with  references to PeopleCode variables and/or a Rec.Fields.*/ 
 
/* ===> Declare and instantiate: */ 
Local Interlink &LDAP_SEARCHBI_1; 
Local BIDocs &inDoc; 
Local BIDocs &outDoc; 
Local Boolean &RSLT; 
Local number  &EXECRSLT; 
&LDAP_SEARCHBI_1 =  GetInterlink(INTERLINK.LDAP_SEARCHBIND); 
 
/* ===> You can use the following assignments to set the configuration parameters. 
*/ 
 
&LDAP_SEARCHBI_1.Server = "jtsay111198.peoplesoft.com"; 
&LDAP_SEARCHBI_1.Port = 389; 
&LDAP_SEARCHBI_1.User_DN = "cn=Admin,o=PeopleSoft"; 
&LDAP_SEARCHBI_1.Password = &password; 
&LDAP_SEARCHBI_1.UserID_Attribute_Name = "uid"; 
&LDAP_SEARCHBI_1.URL = "///file:C:/User/Documentum/XML%20Applications/proddoc/
peoplebook_upc/peoplebook_
upc.dtd"; 
&LDAP_SEARCHBI_1.BIDocValidating = "Off"; 
 
 
/* ===> You might want to call the following statement in a loop if there is more⇒
 than one row of data to be added.  */ 
 
/* ===> Add inputs: */ 
&inDoc = &LDAP_SEARCHBI_1.GetInputDocs(""); 
&ret = &inDoc.AddValue("User_ID", <*>); 
&ret = &inDoc.AddValue("User_Password", <*>); 
&ret = &inDoc.AddValue("Connect_DN", <*>); 
&ret = &inDoc.AddValue("Connect_Password", <*>); 
&Directory_Search_ParmsDoc = &inDoc.AddDoc("Directory_Search_Parms"); 
&ret = &Directory_Search_ParmsDoc.AddValue("Host", <*>); 
&ret = &Directory_Search_ParmsDoc.AddValue("Port", <*>); 
&ret = &Directory_Search_ParmsDoc.AddValue("Base", <*>); 
&ret = &Directory_Search_ParmsDoc.AddValue("Scope", <*>); 
&ret = &Directory_Search_ParmsDoc.AddValue("Filter", <*>); 
 
 
/* ===> The following statement executes this instance: */ 
&EXECRSLT = &LDAP_SEARCHBI_1.Execute(); 
If ( &EXECRSLT <> 1 ) Then 
   /* The instance failed to execute */ 
Else 
&outDoc = &LDAP_SEARCHBI_1.GetOutputDocs(""); 
&ret = &outDoc.GetValue("Distinguished_Name", <*>); 
&ret = &outDoc.GetValue("return_status", <*>); 
&ret = &outDoc.GetValue("return_status_msg", <*>); 

End-If; /* If NOT &RSLT ...  */

Parameters

Returns

A Business Interlink object.