Instalation Guide

You must follow the next steps:

Donwload the project sources: git clone http://gitlab.amplia.es/opengate-ux/opengate-javascript-api.git
Donwload dependencies: npm install
Run web to localhost: gulp

You could be installed some packages before run gulp command.

You will execute the next commands to install the minimal add-ons:

npm install -g gulp-cli

The node version what we are using is: v4.4.7 The npm version what we are using is: 3.10.3

We hope that you will enjoy our opengateJS api.

Development Guide

Gulp tasks available

clean: Remove dist folder
clean-doc: Remove documentation folder
generate-doc: Generate javascript documentation by esdoc plugin
npm: Invoke clean task and after that compile sources as nodejs dependency
bower:Invoke clean task and after that compile sources as browser dependency
bower:min:Invoke clean task and after that compile and minimize sources as browser dependency
compile: Invoke clean task and after that compile sources as nodejs and browser dependency
build: Invoke compile and generate-doc tasks.
default: Invoke watch-src
watch-src: Listen to any src/ and execute compile** task
watch-test-client: Listen to any test/client/ and execute test-client** task
test-client: Execute any client test defined into test/client by mocha and phantomJS plugin
cucumber: Execute any server test defined into features/*.feature by cucumber plugin

Examples about how to use our OpengateJS

Search into entities data

Search provision devices info

The first that you need obtain is a new Builder instance:

    ogapi.
    devicesSearchBuilder()

If you need information about collected data:

    ogapi.
    devicesSearchBuilder().
    onCollected().....

Or you need information about provisioned data:

    ogapi.
    devicesSearchBuilder().
    onProvisioned().....

Uhmm, If you need all information, provisioned and collected, because you want to be enlightened:

    ogapi.
    devicesSearchBuilder().
    onProvisioned().
    onCollected()....

Well, Now you only want summary information:

// Collected Data
    ogapi.
    devicesSearchBuilder().
    onProvisioned().
    summary()....
// Provisioned Data
    ogapi.
    devicesSearchBuilder().
    onProvisioned().
    summary()....
// Provisioned and Collected Data
    ogapi.
    devicesSearchBuilder().
    onProvisioned().
    summary()....

Now, we can only make the invoke to build method and catch the response

    var builder = 
    ogapi.
    devicesSearchBuilder().
    onProvisioned();
    var search;
    try{
        search = builder.build();
    }catch(builderError){
        console.log(builderError);
    }
    search.
    execute().
    then(function(response,statusCode){
        //Here you could search all you want into response object
    }).
    catch(function(error){
        alert(error);
    })

Search provision subscribers info

Is the same that device info, You only change this:

    ogapi.
    devicesSearchBuilder().

To this:

    ogapi.
    subscribersSearchBuilder().

Search provision subscriptions info

Is the same that device info, You only change this:

    ogapi.
    devicesSearchBuilder().

To this:

    ogapi.
    subscriptionsSearchBuilder().

Search into executions data of a operation

The first that you need obtain is a new Builder instance:

    ogapi.
    executionsSearchBuilder()

If you need select the source about executions data of a operation :

    ogapi.
    executionsSearchBuilder().
    onDevices().....
    // Or
    ogapi.
    executionsSearchBuilder().
    onSubscribers().....
    // Or
    ogapi.
    executionsSearchBuilder().
    onSubscriptions().....
    // Or
    ogapi.
    executionsSearchBuilder().
    onCommunicationsModules().....

Important, You only can select one of this resources. If you select more than one, a exception will be thrown when you invoke build method.

If you need summary information:

    ogapi.
    executionsSearchBuilder().
    onCommunicationsModules().
    summary()...

Now, we can only make the invoke to build method and catch the response

    var builder = 
    ogapi.
    executionsSearchBuilder().
    onCommunicationsModules();
    var search;
    try{
        search = builder.build();
    }catch(builderError){
        console.log(builderError);
    }
    search.
    execute().
    then(function(response,statusCode){
        //Here you could search all you want into response object
    }).
    catch(function(error){
        alert(error);
    })

Search into alarms data

Is the same that execution info of a operation, You only change this:

    ogapi.
    executionsSearchBuilder().

To this:

    ogapi.
    alarmsSearchBuilder().

Search into iot data

Search into datastreams and profiles collections

The first that you need obtain is a new Builder instance:

    var builder = ogapi.
    datastreamsSearchBuilder()

    var builder = ogapi.
    profilesSearchBuilder()

If you want you can create a filter to restrict the response much as you want.

    builder.filter(ogapi.newFilterBuilder().and(ogapi.EX.eq('myparam','myvalue')))

Now, we can only make the invoke to build method and catch the response

    var builder = 
    ogapi.
    profilesSearchBuilder().
    .filter(ogapi.newFilterBuilder().and(ogapi.EX.eq('myparam','myvalue')))
    var search;
    try{
        search = builder.build();
    }catch(builderError){
        console.log(builderError);
    }
    search.
    execute().
    then(function(response,statusCode){
        //Here you could search all you want into response object
    }).
    catch(function(error){
        alert(error);
    })

Search into datapoints collections

The first that you need obtain is a new Builder instance:

    var builder = ogapi.
    datapointsSearchBuilder()

If you want you can create a filter to restrict the response much as you want.

    builder.filter(ogapi.newFilterBuilder().and(ogapi.EX.eq('myparam','myvalue')))

or you can use the way filter fluent to make a filter more straightforward

    builder.betweenDates(new Date(),new Date()).withFeed('myFeed').withDeviceId('myDevice')....

Now, we can only make the invoke to build method and catch the response

    var builder = 
    ogapi.
    datapointsSearchBuilder().
    .betweenDates(new Date(),new Date()).withFeed('myFeed').withDeviceId('myDevice');
    var search;
    try{
        search = builder.build();
    }catch(builderError){
        console.log(builderError);
    }
    search.
    execute().
    then(function(response,statusCode){
        //Here you could search all you want into response object
    }).
    catch(function(error){
        alert(error);
    })

Setting timeout in all searches

We can configure the request timeout in all request. How can i do it ?

It is very simple, we must only invoke a withTimeout method. Here there is a example:

    ogapi.
    devicesSearchBuilder().
    withTimeout(2000).....

Then, if timeout is exceeded. The promise throw an exception with a message like this: "Timeout exceeded"

Execute an operation

Here ogapi.operations is where you can find all you need to execute an operation.

At this point ogapi.operations, you have access to:

builderByOperationName(operation_name) -> It will return a promise and into then callback you will have the builder as a function argument but if anything gone wrong the catch callback would tell you what happens by error
getOperationList() -> It will return an array with available operations

OK I have an operation builder but now. What could i do ?

Might be two kinds of builder:

Attend or close alarms
Operations defined into user catalog

It is a builder factory, Here will have all operations that the user have available

Examples:

ogapi.operations.builderByOperationName('ALARM_CLOSE')
ogapi.operations.builderByOperationName('ADMINISTRATIVE_STATUS_CHANGE')

Methods available to attend or close alarms:

withNotes()
addAlarmId()
build()

Methods available to others operations:

withNotes()
withCallback()
withAckTimeout()
withDelayedStop()
withDelayedStart()
withScatteringMaxSpread()
withScatteringStrategy()
executeImmediately()
executeIDLE()
executeLater()
withTimeout()
withRetriesDelay()
withRetries()
appendEntitiesBy.filter(newFilterBuilder().build())
appendEntitiesBy.list()
appendEntitiesBy.tag()

How can i add a specific parameter ?

Access:

            var builder = ogapi.operations.builderFactory.newSetClockEquipmentBuilder();
            //Acceso a los parámetros de esta operación
            builder.paramBuilderFactory

The paramBuilderFactory element will have an catalog and it will have inside a list about allowed parameters.
This parameters can be as a simple type, array type, array of simple type, a complex type, etc. Every parameter will have their own builder.

Examples:

Simple type with default value builder.paramBuilderFactory.newAdministrativeStatusParamBuilder().buildAndAppend()
This parameter have defined an enumeration with allowed values builder.paramBuilderFactory.newChannelParamBuilder().withChannel('channelName'). If channelName is not defined into enumeration, the builder throw an error
Array of complex object builder.paramBuilderFactory.newVariableListParamBuilder().addVariableList({'variableName':'nombre','variableValue':'valor'}).addVariableList({'variableName':'nombre','variableValue':'valor'})
String array builder.paramBuilderFactory.newApnParamBuilder().addApn('apn1').addApn('apn2').buildAndAppend()

Execute actions on the executions

When you create an operation, it creates a "run" that groups each of the operations per entity that are generated. ogapi.newExecutionActions(execution_id) offers a series of actions to activate, paused and cancel these executions:

Active

ogapi.newExecutionActions(execution_id).active();

We can activate a execution that is in the IDLE or PAUSED state. Once the execution is activated it will go to one of the following states:

SCHEDULE if the previous state was IDLE
IN_PROGRESS if the previous state was PAUSED or IDLE (if the timing forces the start)

Pause

ogapi.newExecutionActions(execution_id).pause();

We can pause an execution. Once the execution is paused it will go to one of the following states:

IDLE if the previous state was SCHEDULE
PAUSED if the previous state was IN_PROGRESS

Cancel

ogapi.newExecutionActions(execution_id).cancel();

We can cancel an execution at any time. The status of execution passes through two states: CANCELLING and CANCELLED

Interactive examples

Searchs:

Operations:

Finder

Execute actions on the executions

References

Class Summary

Static Public Class Summary
public	AdministrativeStateSearchBuilder Defined a search over operational status catalogs
public	AlarmActionBuilder Defines the builder to execute alarm actions
public	AlarmActions This class contains all alarms actions builders
public	AlarmAttendBuilder Defines the builder to execute alarm attend operation
public	AlarmCloseBuilder Defines the builder to execute alarm close operation
public	AlarmsSearchBuilder Defined a search over Alarms
public	AllowedResourceTypeSearchBuilder Defined a search over mobile phone provider catalog
public	AppendEntitiesBy Util used into BaseOperationBuilder to append entities the three different ways.
public	AreaFinder This class allow make get request to area resource into Opengate North API.
public	Areas This is a base object that contains all you can do about Areas.
public	AreasSearchBuilder Defined a search over Areas
public	AssetBuilder Subscription builder.
public	AssetSearch This extends Search and allow make request to any available resource into Opengate North API.
public	AssetsSearchBuilder Defined a search over Assets
public	BaseOperationBuilder Defines the builder to execute an operation that is into catalog
public	BaseParameterBuilderWithParent This class generate a builder by a dynamic content about specific parameter to an operation.
public	BaseProvision This is an abstract class, it must be extended to another class that defines the different actions of a specific provision.
public	BaseSearch This is a abstract class, it must be extended to another class that defined the specific search.
public	BasicTypesSearchBuilder This is a abstract class, it must be extended to another class that defined the specific search.
public	BulkBuilder This class allow set simple values.
public	BulkExecutionBuilder This builder give you the necessary tools to create a bulk executions using our OpenGate REST
public	BulkExecutionFinder This class allow make get request to bulk executions resource into Opengate North API.
public	BulkExecutionSearchBuilder Searching over all the created bulk process, which are already done or still in progress.
public	BulkFinder This class allow make get request to bulk resource into Opengate North API.
public	BulkSearchBuilder Defined a search over bulk entities operations
public	BundleFinder This class allow make get request to certificate resource into Opengate North API.
public	Bundles This is a base object that contains all you can do about Bundles.
public	BundlesSearchBuilder Defined a search over Bundles
public	ByGeneric
public	ByMonth
public	ByWeek
public	ByYear
public	Category Defines the builder to configure a category of a datamodel.
public	CertificateFinder This class allow make get request to certificate resource into Opengate North API.
public	Certificates This is a base object that contains all you can do about Certificates.
public	CertificatesSearchBuilder Defined a search over Bundles
public	ChannelFinder This class allow make get request to channel resource into Opengate North API.
public	Channels This is a base object that contains all you can do about Bundles.
public	ChannelsSearchBuilder Defined a search over Channels
public	CommsModuleMessage This is a base object that allows the user to create a CommsModule.
public	CommunicationsModuleTypeSearchBuilder Defined a search over operational status catalogs
public	ComplexBuilder This class extends SimpleBuilder to allow set complex values.
public	ConnectorFunctions This is a base object than contains all you can about connector functions catalog
public	ConnectorFunctions This is a base object that contains all you can do about ConnectorFunctions.
public	ConnectorFunctionsCatalog This class allow make get request to connector functions catalog resource into Opengate North API.
public	ConnectorFunctionsCatalogFinder This class allow make get request to a connector functions catalog resource into Opengate North API.
public	ConnectorFunctionsFinder This class allow make get request to ConnectorFunctions resource into Opengate North API.
public	ConnectorFunctionsHelper This class allow make get request to RuleConfigurationsHelper resource into Opengate North API.
public	CountriesCatalog This class allow make get request to countries catalog resource into Opengate North API.
public	CountryCodesSearchBuilder Defined a search over operational status catalogs
public	CsvBulkBuilder Csv builder.
public	Datamodels This is a base object for create a IoT Datamodel
public	DatamodelsFinder This class allow make get request to organization resource into Opengate North API.
public	DatamodelsHelper This is a base object for update and delete a IoT Datamodel
public	DatamodelsSearchBuilder Defined a search over Datamodels
public	Datapoint This is a base object that allows the user to create a Datapoint.
public	DatapointsSearchBuilder Defined a search over Datastreams
public	DatasetEntitiesSearchBuilder Defined a search over Executions
public	DatasetSearchBuilder Defined a search over Executions
public	Datasets This is a base object that contains all you can do about Datasets.
public	DatasetsCatalogSearchBuilder Defined a search over Areas
public	Datastream This is a base object that allows the user to create a Datastream.
public	Datastream Defines the builder to configure a datastream of IoT datamodel.
public	DatastreamsSearchBuilder Defined a search over Datastreams
public	DeploymentElement This is a base object that contains all you can do about Deployment Element.
public	DeviceBuilder Device builder.
public	DeviceFinder This class allow make get request to device provisioned resource into Opengate North API.
public	DeviceMessage This is a base object contains methods to send unstructured IoT information to be processed & collected by the platform.
public	DeviceSearch This extends Search and allow make request to any available resource into Opengate North API.
public	DevicesPlansSearchBuilder Defined a search over DevicePlansSearchBuilder
public	DevicesSearchBuilder Defined a search over Devices
public	DomainFinder This class allow make get request to certificate resource into Opengate North API.
public	Domains This is a base object that contains all you can do about Bundles.
public	DomainsSearchBuilder Defined a search over Domains
public	EntitiesSearchBuilder Defined a search over Executions
public	EntityBuilder This is a base object that contains all you can do about Devices.
public	EntityFinder This class allow make get request to entity provisioned resource into Opengate North API.
public	EntitySearch This extends Search and it allow make request to any available resource into /entities resource at Opengate North API
public	Event This is a base object that allows the user to create a Event.
public	ExecuteEachBuilder Defines the builder to configure a period of operation.
public	ExecuteEveryBuilder Defines the builder to configure a period of operation.
public	ExecutionsHistorySearchBuilder Defined a search over Executions
public	ExecutionsSearchBuilder Defined a search over Executions
public	Expression
public	FeedsSearchBuilder Defined a search over Feeds
public	FieldsDefinitionSearchBuilder Defined a search over operational status catalogs
public	FilterBuilder
public	FlattenedSearchBuilder This is a abstract class.
public	GenericFinder This class allow make get request to user resource into Opengate North API.
public	Geocluster This is a base object that contains all you can do about geocluster.
public	GeoclusterFinder This class allow make get request to user resource into Opengate North API.
public	Hardware This is a base object that allows the user to create a Datapoint.
public	HistoryFinder This class allow make get request to planner resource into Opengate North API.
public	ImageExecution This is a base object that contains all you can do about Bundles.
public	ImageExecutionFinder This class allow make get request to planner resource into Opengate North API.
public	InternalOpenGateAPI This is a abstract class, it must be extended to another class that defined the backend, it will be used on request to Opengate North API by browser or nodejs server
public	IoTDatastreamAccessSearchBuilder Defined a search over mobile phone provider catalog
public	IoTDatastreamPeriodSearchBuilder Defined a search over mobile phone provider catalog
public	IoTDatastreamStoragePeriodSearchBuilder Defined a search over mobile phone provider catalog
public	JsonBulkBuilder Json builder.
public	JsonFlattenedBulkBuilder Json builder.
public	Location This is a base object that allows the user to create a Datapoint.
public	ManufacturerFinder This class allow make get request to hardware manufacturers resource into Opengate North API.
public	ManufacturerFinder This class allow make get request to hardware manufacturers resource into Opengate North API.
public	ManufacturerMedia This is a base object that contains all you can do about ManufacturerMedia.
public	Manufacturers This is a base object that contains all you can do about Manufacturers.
public	Manufacturers This is a base object that contains all you can do about Manufacturers.
public	Mobile This is a base object that allows the user to create a Datapoint.
public	MobilePhoneProviderSearchBuilder Defined a search over mobile phone provider catalog
public	ModelFinder This class allow make get request to hardware models resource into Opengate North API.
public	ModelFinder This class allow make get request to hardware models resource into Opengate North API.
public	ModelMedia This is a base object that contains all you can do about ModelMedia.
public	Models This is a base object that contains all you can do about Models.
public	Models This is a base object that contains all you can do about Models.
public	NorthAmpliaREST This is a wrapper of a Rest api javascript
public	NotebookFinder This class allow make get request to planner resource into Opengate North API.
public	NotebookLauncher This is a base object that contains all you can do about Bundles.
public	NotebookScheduler This is a base object that contains all you can do about Bundles.
public	Operation This is a abstract class, it must be extended to another class that defined the specific search.
public	Operation This is a abstract class, it must be extended to another class that defined the specific search.
public	OperationActions
public	OperationFinder This class allow make get request to operation resource into Opengate North API.
public	OperationType This is a base object that contains all you can do about OperationType.
public	OperationTypeFinder This class allow make get request to OperationType resource into Opengate North API.
public	OperationTypesBuilder Defined a search over operationTypes
public	OperationTypesCatalog This class allow make get request to OperationType resource into Opengate North API.
public	OperationalStatusSearchBuilder Defined a search over operational status catalogs
public	Operations This class generates all operations builders by a response to search into catalog/operations
public	OperationsSearchBuilder Defined a search over executions´s opreations
public	OrganizationFinder This class allow make get request to organization resource into Opengate North API.
public	Organizations This is a base object that contains all you can do about Organizations.
public	OrganizationsSearchBuilder Defined a search over organizations
public	ParameterBuilderFactory This class generates all operation parameters builders by "parameters" attribute that there is into config operation json
public	PeriodicityActions
public	PeriodicityUpdateBuilder
public	Pipeline This is a base object that contains all you can do about Bundles.
public	PipelineFinder This class allow make get request to planner resource into Opengate North API.
public	PlansSearchBuilder Defined a search over PlansSearchBuilder
public	PowerSupply This is a base object that allows the user to create a Datapoint.
public	PreFilteredSearchBuilder This is a abstract class.
public	ProvisionGenericFinder This class allow make get request to user resource into Opengate North API.
public	ProvisionProcessors This is a base object that contains all you can do about Provision Processors.
public	Qrating Defines the builder to configure a qurating of datastream of IoT datamodel.
public	RawSearchBuilder Defined a search over custom resource and custom filter
public	ResourceTypeSearchBuilder Defined a search over mobile phone provider catalog
public	RestRequest This is a base object that contains all you can do about Bundles.
public	RestRequestFinder This class allow make get request to planner resource into Opengate North API.
public	RuleConfigurationSeveritySearchBuilder Defined a search over ruleConfigurationSeverity catalog
public	RuleConfigurations This is a base object that contains all you can do about RulesConfigurations.
public	RuleConfigurationsActions
public	RuleConfigurationsCatalog This class allow make get request to RuleConfigurations resource into Opengate North API.
public	RuleConfigurationsFinder This class allow make get request to RuleConfigurations resource into Opengate North API.
public	RuleConfigurationsHelper This class allow make get request to RuleConfigurationsHelper resource into Opengate North API.
public	RuleModeSearchBuilder Defined a search over ruleMode catalog
public	RuleTypeSearchBuilder Defined a search over ruleType catalog
public	RulesSearchBuilder Defined a search over Rulse
public	ScheduleHistoryFinder This class allow make get request to planner resource into Opengate North API.
public	SchedulerFinder This class allow make get request to planner resource into Opengate North API.
public	Search This extends BaseSearch and allow make request to any available resource into Opengate North API.
public	SearchBuilder This is a abstract class.
public	SearchBuilderError This defined a specific Error that it will be thrown on build method at SearchBuilders
public	SearchWithSummaryBuilder This is a abstract class.
public	SearchWithoutLimit This extends BaseSearch and allow make request to any available resource into Opengate North API.
public	Security This extends BaseProvision and contains all you can do about Security.
public	SelectBuilder
public	SelectElement
public	ServiceGroupSearchBuilder Defined a search over service group catalogs
public	SimpleBuilder This class allow set simple values.
public	Software This is a base object that allows the user to create a Datapoint.
public	SoftwareFinder This class allow make get request to hardware softwares resource into Opengate North API.
public	Softwares This is a base object that contains all you can do about Softwares.
public	SoftwaresSearchBuilder Defined a search over Datastreams
public	SouthAmpliaREST
public	StaticSearch This extends Search and it allow make request to any available resource into static resources for Opengate North API
public	Storage This is a base object that allows the user to create a Datapoint.
public	Subscriber This is a base object that allows the user to create a Subscription.
public	SubscriberBuilder Subscriber builder.
public	SubscribersFinder This class allow make get request to subscribers provisioned resource into Opengate North API.
public	SubscribersSearchBuilder Defined a search over Subscribers
public	Subscription This is a base object that allows the user to create a Subscription.
public	SubscriptionBuilder Subscription builder.
public	SubscriptionsFinder This class allow make get request to subscription provisioned resource into Opengate North API.
public	SubscriptionsSearchBuilder Defined a search over Subscriptions
public	TasksSearchBuilder Defined a search over periodic executions´s operations
public	Temperature This is a base object that allows the user to create a Datapoint.
public	TicketBuilder Subscription builder.
public	TicketFinder This class allow make get request to ticket provisioned resource into Opengate North API.
public	TicketPrioritySearchBuilder Defined a search over ticket priority catalog
public	TicketSeveritySearchBuilder Defined a search over ticket severity catalog
public	TicketStatusSearchBuilder Defined a search over ticket status catalog
public	TicketsSearchBuilder Defined a search over Devices
public	TimeserieDatasetBuilder Defined a search over timeseries
public	TimeserieDownsamplerBuilder Defined a search over timeseries
public	TimeserieSearchBuilder Defined a search over timeseries
public	Timeseries This is a base object that contains all you can do about Timeseries.
public	TimeseriesFinder This class allow make get request to TimeseriesFinder resource into Opengate North API.
public	TimeseriesFunction This is a base object that contains all you can do about TimeseriesFunction.
public	TimeseriesFunctionFinder This class allow make get request to TimeseriesFunction resource into Opengate North API.
public	TimeseriesFunctionsHelper This class allow make get request to newTimeseriesFunctionsHelper resource into Opengate North API.
public	TimezoneSearchBuilder Defined a search over operational status catalogs
public	Usage This is a base object that allows the user to create a Datapoint.
public	User This class allow make get request to user resource into Opengate North API.
public	UserFinder This class allow make get request to user resource into Opengate North API.
public	UserLanguagesSearchBuilder Defined a search over operational status catalogs
public	UserProfilesSearchBuilder Defined a search over operational status catalogs
public	UsersSearchBuilder Defined a search over Users
public	WPSearch This extends BaseSearch and allow make request to any available resource into Opengate North API.
public	WorkgroupFinder This class allow make get request to workgroup resource into Opengate North API.
public	WorkgroupRelations This is a base object that contains all you can do about workgroups.
public	WorkgroupRelationsFinder This class allow make get request to workgroup relation resource into Opengate North API.
public	Workgroups This is a base object that contains all you can do about workgroups.
public	WorkgroupsSearchBuilder Defined a search over Workgroups
public	provisionProcessorsFinder This class allow make get request to ProvisionProcessors Finder resource into Opengate North API.

Variable Summary

Static Public Variable Summary
public	ACTION_ENUM: string[] ACTION values allowed
public	ADDRESS_TYPE_ENUM: string[] ADDRESS_TYPE_ENUM values allowed
public	ADMINISTRATIVE_STATE_ENUM: string[] ADMINISTRATIVE_STATE_ENUM values allowed
public	ANTENNA_STATUS_ENUM: string[] ANTENNA_STATUS_ENUM values allowed
public	AssetID: string
public	BASE_URL: string
public	BASE_URL: string
public	BASE_URL: string
public	BASE_URL: string
public	BATTERY_CHARGE_LEVEL_STATUS_ENUM: string[] BATTERY_CHARGE_LEVEL_STATUS_ENUM values allowed
public	BATTERY_CHARGE_STATUS_ENUM: string[] BATTERY_CHARGE_STATUS_ENUM values allowed
public	CONNECTOR_FUNCTION_OPERATIONAL_STATUS: string[] CONNECTOR_FUNCTION_OPERATIONAL_STATUS values allowed
public	CONNECTOR_FUNCTION_PAYLOAD_TYPES: string[] CONNECTOR_FUNCTION_PAYLOAD_TYPES values allowed
public	CONNECTOR_FUNCTION_SOUTH_PROTOCOLS: string[] CONNECTOR_FUNCTION_SOUTH_PROTOCOLS values allowed
public	CONNECTOR_FUNCTION_TYPES: string[] CONNECTOR_FUNCTION_TYPES values allowed
public	DATAMODELS_RESOURCE: string
public	DATAMODEL_RESOURCE: string
public	DATE_FORMAT: string Global date format.
public	DAYS_ENUM: string[] Days values allowed
public	GENERATED_FIELDS: {"ENTITY_OPERATION_HISTORY": , "ENTITY_OPERATION": , "MODEL": , "JOB": , "SOFTWARE_VERSION": , "UPDATE_BUNDLE_VERSION": , "CERTIFICATE": *}
public	IOT_FIELDS: {"DATAPOINTS": , "DATAMODELS": , "DATASTREAMS": , "DEVICE_PART_DEVICE": , "USER": , "DOMAIN": , "AREAS": , "TASKS": , "LEGACY_BULK": , "BULK": , "RULE": , "ENTITY_ALARM": , "GENERAL": , "EMPTY": , "OPERATORS": , "PLANS": }
public	LEVEL_TREND_ENUM: string[] LEVEL_TREND_ENUM values allowed
public	MANUFACTURERS_RESOURCE: string
public	MANUFACTURERS_RESOURCE: string
public	MIME_TYPES_ENUM: string[]
public	MIME_TYPES_ENUM: string[] MIME_TYPES values allowed
public	MODELS_RESOURCE: string
public	MODELS_RESOURCE: string
public	MODE_VALIDATORS_ENUM: string[] MODE_VALIDATORS values allowed.
public	MONTHS_ENUM: string[] Months values allowed
public	OPERATION_ENUM: string[] OPERATION values allowed
public	OPTION_ENUM: string[] OPTION values allowed
public	POST_RESOURCE: string
public	POWER_SUPPLY_SOURCE_ENUM: string[] POWER_SUPPLY_SOURCE_ENUM values allowed
public	PRE_RESOURCE: string
public	PRE_RESOURCE: string
public	PRE_RESOURCE: string
public	PRE_RESOURCE: string
public	PRE_RESOURCE: string
public	SOFTWARES_RESOURCE: string
public	SOFTWARE_TYPES_ENUM: string[]
public	SOFTWARE_TYPES_ENUM: string[] SOFTWARE_TYPES_ENUM values allowed
public	SOFTWARE_TYPE_ENUM: string[] SOFTWARE_TYPE_ENUM values allowed
public	SubscriberID: string
public	SubscriptionID: string
public	TEMPERATURE_STATUS_ENUM: string[] TEMPERATURE_STATUS values allowed
public	TIME_FORMAT: string Global time format.
public	TOKEN_URL: string
public	TOKEN_URL: string
public	TOKEN_URL: string
public	TOKEN_URL: string
public	TYPES: {"xls": string, "xlsx": string}
public	TYPE_ENUM: string[] TYPE values allowed
public	TYPE_ENUM: string[] TYPE values allowed
public	TYPE_VALIDATORS_ENUM: string[] TYPE_VALIDATORS values allowed
public	TicketID: string
public	URL: string
public	URL: string
public	USAGES_ENUM: string[] USAGES_ENUM values allowed
public	VALUE_TYPES_ENUM: string[] TYPES_ENUM values allowed
public	aggregationTypes: string[]
public	aggregationTypes: string[]
public	interpolationTypes: string[]

Instalation Guide

Instalation Guide

Development Guide

Gulp tasks available

Examples about how to use our OpengateJS

Examples about how to use our OpengateJS

Search into entities data

Search provision devices info

Search provision subscribers info

Search provision subscriptions info

Search into executions data of a operation

Search into alarms data

Search into iot data

Search into datastreams and profiles collections

Search into datapoints collections

Setting timeout in all searches

Execute an operation

OK I have an operation builder but now. What could i do ?

How can i add a specific parameter ?

Execute actions on the executions

Active

Pause

Cancel

Interactive examples

Interactive examples

Searchs:

Operations:

Finder

An User

An Organization

An Certificate

Execute actions on the executions

References

References

Class Summary

Variable Summary