Invoking specific NexJ CRM workspaces
When launching NexJ CRM from another application, you can specify which workspace to display. Optionally, when opening the Contact workspace, you can also specify which contact's information to display. Launch NexJ CRM by using a URI (Uniform Resource Identifier) that specifies the workspace to open. You can use the URI to launch NexJ CRM from or within another application. You can also use it to, for example, share a link to a particular contact's profile. The URI must be specified in the following format:
For information about invoking workspaces for the classic UI, see Invoking specific NexJ CRM workspaces that is available with the 8.9 documentation.
http://<serverName>:<port>/nexj/ui/portal#<workspaceName>/<portletReference>;ctxname1=ctxval1,…,ctxnameN=ctxvalN;argname1=argval1,…,argnameM=argvalM
To invoke the Contacts workspace for a specific contact, determine that contact's internal entity identifier. Then specify the URI, for example:
http://localhost:7080/nexj/ui/portal#Contacts/refPersonBio;EntityId=100BAC9B1B6CEB4C79B7B5207F571ED8CF,ObjectId=100BAC9B1B6CEB4C79B7B5207F571ED8CF;r=
Parameters
The following parameters can be used:
workspaceName
- Where <workspaceName> is the name of the workspace as specified in NexJ Studio, in the Workspaces tab in the Presentation layer.
- null can be used to trigger the navigation handler, without navigating anywhere.
portletReference
- An optional URI parameter specifying the reference name of a specific portlet on a workspace to launch on application load. For example, if portletReference equals refPersonBio on the Contacts workspace then the tab containing the EntityBio portlet will become visible on load.
ctxname1,...,ctxnameN
- An optional URI parameter specifying the name of a context variable name and its value as a key-value pairing (for example, EntityId=100BAC9B1B6CEB4C79B7B5207F571ED8CF). The value will be processed during application load, as long as a workspace is specified.
argval1,…,argnameM=argvalM
- An optional URI parameter specifying the name of a variable name and its value as a key-value pairing (for example, StartDate=22072019). The value will be processed during application load, as long as a workspace is specified.
r
- An optional URI parameter associated with a random number. This parameter is required for use cases where repeated access of the same URI should always trigger navigation. The value should be blank and the framework will automatically populate the random number (for example, r=).
URI navigation is handled in the following ways:
If any dialog is open, the client framework will attempt to close it. If any dialog has unsaved changes, the user will be prompted if they want to discard the changes they have made in the dialog. If an open dialog does not have any controller, then the framework will prompt the user for confirmation. If the user decides to remain on any dialog, the navigation will be cancelled and will not proceed further.
- Trigger a sysExternalContext UI event to the ContactBroker portlet.
- If not previously handled, trigger a sysExternalContext UI event for each sidebar portlet.
- If not previously handled, navigate to the target workspace determined by the workspaceName parameter.
- Trigger a sysExternalContext UI event for the navigator portlet of the target workspace.
- If not previously handled, navigate to the target portlet.