Versions Compared

Old Version 3

changes.mady.by.user Jessica Tomkins

Saved on

compared with

New Version Current

changes.mady.by.user Jessica Tomkins

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.




Note
titleContent Freeze

As of July 25th, 2023, there is a content freeze on this page.

Sectionsection


HTML Comment
hiddentrue

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
width60%

About this error message

Users 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.


Column
width40%

Contents

Info
iconfalse
Table of Contents
maxLevel6
minLevel2
indent15px
stylenone
separatorbraces


HTML Comment
hiddentrue

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
hiddentrue

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
titleNote 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 'authenticate' 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 'authenticate' token is automatically 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.


...