LaunchURLWithDynamicArgs - SmartPlant Foundation - IM Update 48 - Help - Hexagon

Like the LaunchURL API, the LaunchURLWithDynamicArgs client API also has two arguments. However, the first argument for this API can use properties from the context object, the related object, or from a set of environment type variables as constants in the URL string. These constants are substituted at runtime for actual values. This can be used to launch a URL, such as from a menu to an external or internal specific software system, a document, or a website.

1. URL - This argument can be the path name of a page or the full URL. For example:

   http://hexagonppm.com/products/information-management-product-family?user=~ENV.Username~&area=~OLaunchURLbj->TagArea_12.Name~

   The URL supports any valid protocol prefix, such as http, https, ftp, and mailto. However, if you wish to use relative URLs that launch pages in the SmartPlant Foundation site, you must prefix the Arg1 value with the Env.ServerURL variable.

   Valid constants that can be appended to the argument of the method include the properties in the following syntax:

   • Obj.[any property on the object.]

   • Obj->[PathDefn.Property] – PathDefn can be an edge definition or a relationship definition. For example,

     Obj->SPFItemOwningGroup_12.Name or Obj->EDG_EdgeName.Name.

     For more information on condition syntax, see Condition syntax.

   • Additionally, the argument can use the following ENV. constants:

     • .SESSIONID

     • .CONFIGOBID

     • .USER, .USERNAME

     • .USERSACTUALNAME

     • .SERVERURL

     • .HOSTNAME

     • .VIRTUALDIRECTORY

     • .CONFIGCREATE

     • .CALLEDFROMDIALOG

     • .CONFIGLEVEL

     • .QUERYCONFIGLEVEL

     • .QUERYCONFIGUIDS

     • .CREATECONFIGUID

     • .QUERYCONFIGSTRINGS

     • .CREATECONFIGSTRING

     • .CURRCONFIGLEVELNAME

     • EFFECTIVITYDATE

     • USERORGANIZATIONNAME

     • USERDEFAULTCREATECONFIG

     • USERUSERTYPE

     • USERUSERGROUPS

     • CONFIG1 to CONFIG5

     • QUERYCONFIG1 to QUERYCONFIG5

     • OWNINGGROUPSFORCREATECONFIG

     • OWNINGGROUPSFORQUERYCONFIG

     • OWNINGGROUPSFORUSERINCREATECONFIG

     • OWNINGGROUPSFORUSERINQUERYCONFIG

     • ACCESSGROUPSFORUSERINCREATECONFIG

     • ACCESSGROUPSFORUSERINQUERYCONFIG

     • ALLDOMAINSFORUSER

   Ensure a tilde character is used before and after the constant, so it is correctly recognized.

2. Display mode - This argument sets how the URL displays.

   OPEN - the URL opens in a separate window.

   FRAME - the URL opens in a client internal frame.