Launch URL examples - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

You can use the following syntax examples to compose a URL to launch your specified objects directly in different areas of the Web Client. You launch a URL using the launch path created with your parameters. You combine the various parameters depending on the view being launched and the object(s) being identified. The key parameters you can use to compose the URL are:

  • config - the UID of the Plant or Project in which the requested object exists

  • methodName - the name of the method that the URL will invoke, such as ViewNavigateFiles

  • objectName - the name of the requested object

  • objectObid - the OBID of the requested object

  • objectUid - the UID of the requested object

  • setName - the set name derived from the appropriate API entry point

    SHARED Tip The setName parameter can be found in the Set Name column of an API entry point displayed in a results grid.

  • data - an optional parameter to expand a method

  • The setName parameter is required if you use the objectName parameter instead of the objectObid parameter.

  • Parameters that contain special characters must be encoded before being added to the URL, such as # must be encoded to %23. This is because some characters are used in URL routing, and if put in the name, they will break the URL. For more information on encoding, see https://www.tutorialspoint.com/html/html_url_encoding.htm.

  • If any parameter contains the %, *, or ? special characters, they act as wildcards and must be escaped before being encoded and added to the URL. For example, % must be escaped to \%. This is then encoded to %5C%25. However, encoding being escaped is not always guaranteed to work.

The following syntax are examples only and show how you can compose a URL to return the specified objects:

Using objectName to launch a document in the results grid

Where the syntax uses the results, config, setName, and objectName.

https://[localhost]/[webclient]/#/launch/results;config=[UID];setName=[setname];objectName=[objectname]

Using objectName to launch a document in the Info Map

Where the syntax uses infomap, config, objectName, and setName..

https://[localhost]/[webclient]/#/launch/infomap;config=[UID];objectName=[objectname];setName=[setname]

Using objectName to launch an object details

Where the syntax uses details, config, objectName, and setName.

https://[localhost]/[webclient]/#/launch/details;config=[UID];objectName=[objectname];setName=[setname]

Using objectObid to launch a document in results grid

Where the syntax uses results, config, and objectObid.

https://[localhost]/[webclient]/#/launch/results;config=[UID];setName=[setname];objectObid=[objectOBID]

Using objectObid to launch an object in the Info Map

Where the syntax uses infomap, config, and objectObid.

https://[localhost]/[webclient]/#/launch/infomap;config=[UID];objectObid=[objectOBID]

Using objectObid to launch an object details

Where the syntax uses details, config, and objectObid.

https://[localhost]/[webclient]/#/launch/details;config=[UID];objectObid=[objectOBID]

Using objectUid to launch a document in the results grid

The objectUid must be combined with the setName parameter in order to work in the results grid. This is the same as the objectName URLs.

Where the syntax uses results, config, setName, and objectUid.

https://[localhost]/[webclient]/#/launch/results;config=[UID];setName=[setname];objectUid=[objectUID]

UIDs that contain special characters must be encoded before being put in the URL, such as # must be encoded to %23. This is because some characters are used in URL routing and will break the URL if put in UID or name.

Using methodName to launch a document

There may be times when you need to launch a view controlled by a method to invoke the URL path. When launching a method, you combine the use of launch with the run parameter.

When the method needs to point to an object context, such as DocumentCopy, it must be provided using the following arguments:

  • config - the UID of the Plant or Project in which the requested object exists

  • methodName - the name of the method that the URL will invoke, for example, ViewNavigateFiles

  • objectName, objectUid, objectObid - the object can be identified by its Name or UID if the OBID is not known

  • setName - needed to ensure data of the correct type is retrieved when identifying by Name or UID

For example:

When launching a method to view a file on a document, you can combine the use of launch and run parameters to invoke the path along with the config, methodName, objectName, and SetName arguments:

https://[localhost]/[webclient]/#/launch/run;config=[UID];methodName=[methodname];objectName=[objectname];setName=[setname]

For example:

When launching a method that does not need object context, such as Create or To Do List, you combine the use of launch and run parameters to invoke the path along with the config and methodName arguments. Therefore, to launch a method to the To Do List:

https://[localhost]/[webclient]/#/launch/run;config=[UID];methodName=WFInBox

Using data to view one or more objects in a document or file

When you need to view one or more objects in a model or drawing using the ViewNavigateFiles or FileViewNavigate methods, you must provide one of the following arguments:

  • ITEMSBYUID - the UID of the object

    For example:

    https://[localhost]/[webclient]/#/launch/run;config=[UID];objectObid=[objectOBID];methodName=[methodname];data={"ITEMSBYUID":["UID1", "UID2"]}

  • ITEMSBYOBID - the OBID of the object

    For example:

    https://[localhost]/[webclient]/#/launch/run;config=[UID];objectObid=[objectOBID];methodName=[methodname];data={"ITEMSBYOBID":["OBID1", "OBID2"]}

  • ITEMSBYNAME - the name of the object

    For example:

    https://[localhost]/[webclient]/#/launch/run;config=[UID];objectObid=[objectOBID];methodName=[methodname];data={"ITEMSBYNAME":["Name1", "N1*"]}

  • Use a comma separated list for multiple values. Brackets are used to enclose multiple items to view one or more objects in a model or drawing.

  • You can use wildcard characters for the ITEMSBYNAME argument. The % wildcard character must be encoded as %25.

  • You must use JSON escape characters when using special characters for the ITEMSBYNAME argument.

  • The launch URL functionality is available only for data shared with SDx using Integration or data-capture and requires both tags and representation object relationships for the model or drawing.

Using data to launch a visual intelligence report

When you need to launch a specified visual intelligence report using the ViewNavigateFiles method, you must provide the following arguments:

  • config - the UID of the Plant or Project in which the requested object exists

  • methodName - the name of the method that the URL will invoke, such as ViewNavigateFiles

  • objectName, objectUid, or objectObid - the object can be identified by its Name or UID if the OBID is not known

  • setName - needed to ensure data of the correct type is retrieved when identifying by Name or UID

  • data - the JSON parameters used to execute a Visual Intelligence report (VIR)

For example:

https://[localhost]/[webclient]/#/launch/run;config=[UID];objectName=[name];setName=[setname]
;methodName=ViewNavigateFiles;data="VIR":["OBID"]

For example:

https://[localhost]/[webclient]/#/launch/run;config=[UID];objectName=[name];setName=[setname]
;methodName=ViewNavigateFiles;data={"VIR":["OBID"]}

For example:

https://[localhost]/[webclient]/#/launch/run;config=[UID];objectName=[name];setName=[setname]
;methodName=ViewNavigateFiles;data=%7B%22VIR%22:[%22OBID%22]%7D

Using data to launch a visual intelligence search

When you need to launch a specified visual intelligence search using the ViewNavigateFiles method, you must provide the following arguments:

  • config - the UID of the Plant or Project in which the requested object exists

  • objectName, objectUid, or objectObid - the object can be identified by its Name or UID if the OBID is not known

  • setName - needed to ensure data of the correct type is retrieved when identifying by Name or UID

  • methodName - the name of the method that the URL will invoke

  • data - the JSON parameters used to execute a Visual Intelligence search (VIS)

For example:

https://[localhost]/[webclient]/#/launch/run;config=[UID];objectName=[name]
;setName=[setname];methodName=ViewNavigateFiles;data="VIS":["searchterm1","searchterm2","searchterm3"]

For example:

https://[localhost]/[webclient]/#/launch/run;config=[UID];objectName=[name]
;setName=[setname];methodName=ViewNavigateFiles;data={"VIS":["searchterm1","searchterm2","searchterm3"]}

For example:

https://[localhost]/[webclient]/#/launch/run;config=[UID];objectName=[name]
;setName=[setname];methodName=ViewNavigateFiles;data=%7B%22VIS%22:[%22searchterm1%22,%22searchterm2%22,%22searchterm3%22]%7D

The % wildcard character must be encoded as %25.