Methods, apparatuses, and computer program products for enabling dynamic external access to a process simulation service
Methods, apparatuses, and computer program products for enabling dynamic external access to a process simulation service are provided. For example, a computer-implemented method may include establishing, by a process simulation service, a communication endpoint to access one or more API calls that define one or more procedures corresponding to a process simulation model associated with one or more assets of an industrial environment, the one or more procedures determined based at least in part on the one or more assets; receiving, by the process simulation service and via the communication endpoint from an external control service, a request to initiate a particular API call of the one or more API calls, wherein the particular API call initiates an interaction with the process simulation model; and executing, by the process simulation service, the interaction with the process simulation model in response to the request.
1 . A computer-implemented method for enabling dynamic external access to a process simulation service, the method comprising:
establishing, by a process simulation service, a communication endpoint to access one or more API calls that define one or more procedures corresponding to a process simulation model associated with one or more assets of an industrial environment, the one or more procedures determined based at least in part on the one or more assets;
receiving, by the process simulation service and via the communication endpoint from an external control service, a request to initiate a particular API call of the one or more API calls, wherein the particular API call initiates an interaction with the process simulation model; and
executing, by the process simulation service, the interaction with the process simulation model in response to the request;
wherein the one or more API calls comprise a load simulation call specifying a representation of the assets of the industrial environment to run a simulation on to generate the process simulation model;
wherein the one or more API calls comprise a change attribute value call; and wherein the method further comprises, in response to a change attribute value call, changing an attribute value to a specified value; and
wherein the one or more API calls comprise a get flowsheet objects call; and wherein the method further comprises, in response to a get flowsheet objects call, sending a listing of the one or more assets and connections between the one or more assets.
2 . The method of claim 1 , wherein the one or more API calls comprise a request attribute value call; and wherein the method further comprises, in response to a request attribute value call, sending a current value of a requested attribute.
3 . The method of claim 1 , wherein the one or more API calls comprise a request asset properties call; and wherein the method further comprises, in response to a request asset properties call, sending a listing of properties for at least one of the one or more assets.
4 . The method of claim 1 , further comprising registering an event notification trigger with the process simulation service, the event notification trigger associated with completion of at least the interaction with the process simulation model.
5 . An apparatus for enabling dynamic external access to a process simulation service, the apparatus comprising at least one processor and at least one non-transitory memory comprising program code, wherein the at least one non-transitory memory and the program code are configured to, with the at least one processor, cause the apparatus to at least:
establish, by a process simulation service, a communication endpoint to access one or more API calls that define one or more procedures corresponding to a process simulation model associated with one or more assets of an industrial environment, the one or more procedures determined based at least in part on the one or more assets;
receive, by the process simulation service and via the communication endpoint from an external control service, a request to initiate a particular API call of the one or more API calls, wherein the particular API call initiates an interaction with the process simulation model; and
execute, by the process simulation service, the interaction with the process simulation model in response to the request;
wherein the one or more API calls comprise a load simulation call specifying a representation of the assets of the industrial environment to run a simulation on to generate the process simulation model;
wherein the one or more API calls comprise a change attribute value call; and wherein the at least one non-transitory memory and the program code are further configured to, with the at least one processor, in response to a change attribute value call, cause the apparatus to change an attribute value to a specified value; wherein the one or more API calls comprise a get flowsheet objects call; and
wherein the at least one non-transitory memory and the program code are further configured to, with the at least one processor, in response to a get flowsheet objects call, cause the apparatus to send a listing of the one or more assets and connections between the one or more assets.
6 . The apparatus of claim 5 , wherein the one or more API calls comprise a request attribute value call; and wherein the at least one non-transitory memory and the program code are further configured to, with the at least one processor, in response to a request attribute value call, cause the apparatus to send a current value of a requested attribute.
7 . The apparatus of claim 5 , wherein the one or more API calls comprise a request asset properties call; and wherein the at least one non-transitory memory and the program code are further configured to, with the at least one processor, in response to a request asset properties call, cause the apparatus to send a listing of properties for at least one of the one or more assets.
8 . The apparatus of claim 5 , wherein the at least one non-transitory memory and the program code are further configured to, with the at least one processor, cause the apparatus to register an event notification trigger with the process simulation service, the event notification trigger associated with completion of at least the interaction with the process simulation model.
9 . A computer program product for enabling dynamic external access to a process simulation service, the computer program product comprising at least one non-transitory computer-readable storage medium having computer-readable program code portions stored therein, the computer-readable program code portions comprising an executable portion configured to:
establish, by a process simulation service, a communication endpoint to access one or more API calls that define one or more procedures corresponding to a process simulation model associated with one or more assets of an industrial environment, the one or more procedures determined based at least in part on the one or more assets;
receive, by the process simulation service and via the communication endpoint from an external control service, a request to initiate a particular API call of the one or more API calls, wherein the particular API call initiates an interaction with the process simulation model; and
execute, by the process simulation service, the interaction with the process simulation model in response to the request;
wherein the one or more API calls comprise a load simulation call specifying a representation of the assets of the industrial environment to run a simulation on to generate the process simulation model;
wherein the one or more API calls comprise a change attribute value call;
wherein the computer-readable program code portions further comprise an executable portion configured to, in response to a change attribute value call, change an attribute value to a specified value;
wherein the one or more API calls comprise a get flowsheet objects call; and
wherein the computer-readable program code portions further comprise an executable portion configured to, in response to a get flowsheet objects call, send a listing of the one or more assets and connections between the one or more assets.
10 . The computer program product of claim 9 , wherein the one or more API calls comprise a request attribute value call; and wherein the computer-readable program code portions further comprise an executable portion configured to, in response to a request attribute value call, send a current value of a requested attribute.
11 . The computer program product of claim 9 , wherein the one or more API calls comprise a request asset properties call; and
wherein the computer-readable program code portions further comprise an executable portion configured to, in response to a request asset properties call, send a listing of properties for at least one of the one or more assets.