Links to Application Builder pages from external
applications can be created by defining a directed search result link.
There are multiple types of Application Builder pages. The
following list describes how to connect to these pages from external applications:
- Home Page
- The Application Builder homepage is
the default page of the application and can therefore be linked to by using the default application
URL. For example: http://localhost:8080/AppBuilder/
Note: This link will go
directly to the search page if the homepage is disabled.
- Search Page
- Application Builder search
results can be accessed by adding
search?q=query (where
query is the query that you want to display results for) to the
default application URL. For example:
http://localhost:8080/AppBuilder/search?q=test
- Entity List Page
- Entity list pages can be accessed directly by adding the entity type name
(un-pluralized) to the default application URL. For example:
http://localhost:8080/AppBuilder/customer
- Entity Detail Page
- Entity instance detail page URLs are generated by using the MD5-hash of the
vse-key attribute of the associated Watson Explorer Engine document.
This ensures that each entity instance detail page has a unique URL. A direct link to an instance
detail page would be similar to the following example:
http://localhost:8080/AppBuilder/customer/416b99d226b11ed12d61805e6f99a45a
- . The previous link will always link to the same entity page, but it is obviously
cumbersome and doesn't use any information that might be meaningful in a context outside
of Application Builder. This issue is resolved by creating
redirect links to entity instance pages.
A redirect link takes known information about
an expected entity page and directs the user to first matching entity instance page.
Redirect links are formed by adding /redirect? with attributes to the
base URL of your application. The following redirect attribute combinations are
supported:
entity_type=entity - this redirect links to the first entity
instance detail page of the type entity. For example,
http://localhost:8080/AppBuilder/redirect?entity_type=customerentity_type=entity&field_value=content - this redirect links to
the first entity instance page of the type entity that contains the value of
content in any of its fields. For example,
http://localhost:8080/AppBuilder/redirect?entity_type=customer&field_value=Agent-196entity_type=entity&field_name=field&field_value=content -
this redirect links to the first entity instance page of the type entity that
contains the value of content in the field named field. This can
be very useful if you have fields with unique contents. For example,
http://localhost:8080/AppBuilder/redirect?entity_type=customer&field_name=name&field_value='Brandon
Hatcher'
Note: The user is redirected to the application home page if the redirect cannot be
resolved to an entity instance detail page.