| Section |
|---|
| HTML Comment |
|---|
| REMEMBER! A template can not currently be reapplied. If you want to start over, you'll need to create a new page. Not everything in this template will be used for every API page, it's meant to be a quick format setup. Content can be added and removed as needed after filling out what you want of the form and clicking 'Next', which takes you to the editor. Be aware of where you are putting the page! If you put it in the wrong place, you can go to http://www.profoundlogic.com/docs/pages/listpages-dirview.action?key=PUI and drag'n'drop it at the proper place in the tree. Some of the columns have odd widths, widths are just suggestions in confluence for some reason. If two columns have the same width, they will take up equal-ish space. Any questions on how to use a template, feel free to ask Megan. All HTML notes can be deleted or changed as needed. Everything can be copied and pasted as needed. EXAMPLE OF FINISHED PAGE: pjs.query() |
| Column |
|---|
| About this error messageUsers will encounter this error message when attempting to use a feature of Profound.js that connects to an IBM i or external database, but have not first logged into a valid IBM i session. To correct this issue, make sure a valid IBM i connection is created prior to using the Profound.js feature that connects to the IBM i or external database. There are 2 common scenarios where users will encounter this error message: a module is configured as a web service but no connection details were provided (connectorURL, connectorCredentials, etc.), or the Profound.js server is hosted on a non IBM i platform, like a Windows PC, and the instance was not configured to connect to an instance hosted on an IBM i. |
How to create a valid connection.| Section |
|---|
Log in when running an initial module.When an initial module is started by a user visiting a URL alias, under the default settings, the user will be prompted to enter their IBM i credentials to log into the server. Upon the user entering valid credentials, connection will be created to the IBM i system for this user's session. |
| Section |
|---|
Contents| Info |
|---|
| | Table of Contents |
|---|
| maxLevel | 6 |
|---|
| minLevel | 2 |
|---|
| indent | 15px |
|---|
| style | none |
|---|
| separator | braces |
|---|
|
|
|
|
| Section |
|---|
| | HTML Comment |
|---|
| This column is for a table of contents or notice. If neither are needed, delete this column. If only one is needed, delete the other. If more are needed, you can add what you like, remember to check how long it becomes by clicking "Preview" in the bottom right corner. While preview, the page should be checked at half page and maximize to check that the formatting is not distorted. You may need to make some adjustments to compensate. An example of good Table of Contents usage is the pjs.query page. |
|
|
| HTML Comment |
|---|
|
The following warning message is for Requirements and Important warnings. |
| Section |
|---|
How to correct this error and create a valid connection.The actual solution you will want to implement will depend upon how you want to configure your server, but here are some solutions you can implement so that the Profound.js instance has a valid connection to an IBM i. | Section |
|---|
Solution 1: Create connector credentials.For applications that will not prompt the user to log in, like for web-services, a set of default credentials can be specified in the Profound.js server's configuration file, and a valid session will attempt to be created from these stored credentials. To specify these credentials you must first use the the store_credentials command line utility to create the encrypted credential file. Then you can use the connectorCredentials configuration setting to specify the location of the encrypted credential file. | Note |
|---|
| title | Note for Instances of Profound.js installed on a non IBM i platform. |
|---|
| You must use another configuration setting in conjunction with the connector credentials configuration setting to specify a connection to an instance of Profound.js that is installed on an IBM i platform. You can find a tutorial for setting up this connection here. |
|
| Section |
|---|
Solution 2: Pass 'authauthenticate' token from another valid session.When calling Profound.js applications from another application that is already connected to a valid session, you can use the authentication token from the calling application to create a valid connection for your new application. When calling the Profound.js application from Genie or a Rich Display File application, this 'authauthenticate' token is automatically added included in the call to the Profound.js application. Here is an example of how to add this authentication token when calling a web service. |
|
Consuming a Profound.js Web Service in a Profound UI Rich Display File Session
When a Profound UI screen requests data from a web service to populate a widget (Grid, Auto-Complete, List, Chart, etc.), a URL parameter, AUTH, is added to the request data. The value of the "AUTH" parameter corresponds to a session ID for the Profound UI session for the user in one instance of Profound UI. When Profound.js sees the AUTH data in the request, an attempt is made to read from a Profound UI session database. The default Profound UI instance/library is "PROFOUNDUI", but the library can be changed via the profounduiLibrary config property. Thus, if the user is connected to a Profound UI instance that is not named "PROFOUNDUI", then the Profound.js instance must use the "profounduiLibrary" setting in its config.js file.