Table Of Contents

Open Configuration (API Key) (G Dataflow)

Version:
    Last Modified: August 7, 2018

    Establishes a connection to the SystemLink Cloud server using HTTPS. The node authenticates the connection with an API key obtained from SystemLink Cloud.

    Programming Patterns
    connector_pane_image
    datatype_icon

    server url

    URL of the server where this node sends the web request.

    URL Syntax

    Part Definition Example
    Scheme Protocol the web service uses. http://
    Host Domain name or IP address of the service. localhost
    Port HTTP port of the web service. If you don't specify a port, the web service uses the default port. 80

    Use the following syntax to prompt a connection to the SystemLink Server: https://host:<port>.

    Use the following syntax to prompt a connection to the SystemLink Cloud server: https://api.systemlinkcloud.com.

    To host a web application on a SystemLink Server, leave the server url input empty.

    Default: http://localhost:80

    datatype_icon

    api key

    Unique passcode the node uses to authenticate communication between the application and SystemLink Cloud server.

    To connect to SystemLink Cloud from LabVIEW NXG Web Module, obtain an API key.

    datatype_icon

    error in

    Error conditions that occur before this node runs.

    The node responds to this input according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Default: No error

    datatype_icon

    configuration

    Connection established with the server.

    datatype_icon

    error out

    Error information.

    The node produces this output according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Node Configuration for Hosting Your Web Application on SystemLink Cloud

    When you host your web application on SystemLink Cloud, leave the server url and api key inputs of the Open Configuration (API Key) node empty. To minimize security vulnerabilities, SystemLink Cloud will use your NI user credentials for authentication.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: Not supported

    Web Server: Supported in VIs that run in a web application


    Recently Viewed Topics