redis connector

Description - Publish channel message.
 
Runtime Class - com.ibi.agents.XDRedisPubSubPublish


 

Parameter Groups

  Parameter Type Description
* Channel: string name of the channel to publish.
* Message: string new message to be published.
* - denotes required
  Parameter Type Description
  Return: string Document to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

 

Output Events

 

Name Description
onFailConnect Could not connect to the external system.
fail_parse Could not parse a document.
fail_redis A fail Redis API
onFailOperation Could not perform the operation requested.
Description - Add the specified members to the set stored at key. Members that are already a member of this set are ignored. If key does not exist, a new set is created before adding the specified members.

Runtime Class - com.ibi.agents.XDRedisSetsSAdd



Parameter Groups

 ParameterTypeDescription
*Key:stringThe key associated with the set.
*Members:stringA set of values to be stored in the set.
*Delimiter:stringA delimeter character to detect members from one another.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Set key to hold the string value. If key already holds a value, it is overwritten, regardless of its type. Any previous time to live associated with the key is discarded on successful SET operation.

Runtime Class - com.ibi.agents.XDRedisStringSet



Parameter Groups

 ParameterTypeDescription
*Key:stringKey used to store the string
Value:stringThe value to store
Policy:stringPolicy which controls the set operation.

Select from one of the following options:
  • Set value when Key not Found {NX} - Only set the key if it does not already exist.
  • Set value when Key Found {XX} - Only set the key if it already exist.
* - denotes required
 ParameterTypeDescription
Time (secs):integerSets the specified expiration time, in seconds.
Time (msecs):integerSets the specified expiration time, in milliseconds.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Increments the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer.

Runtime Class - com.ibi.agents.XDRedisStringIncrement



Parameter Groups

 ParameterTypeDescription
*Key:stringThe key associated with the string.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Decrements the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer. This operation is limited to 64 bit signed integers.

Runtime Class - com.ibi.agents.XDRedisStringDecrement



Parameter Groups

 ParameterTypeDescription
*Key:stringThe key associated with the string.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - If key already exists and is a string, this command appends the value at the end of the string. If key does not exist it is created and set as an empty string, so APPEND will be similar to SET in this special case.

Runtime Class - com.ibi.agents.XDRedisStringAppend



Parameter Groups

 ParameterTypeDescription
*Key:stringThe key associated with the string.
*Append:stringThe value to append to the found string.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Removes the specified members from the sorted set stored at key. Non existing members are ignored.

Runtime Class - com.ibi.agents.XDRedisSortedSetsZRem



Parameter Groups

 ParameterTypeDescription
*Key:stringThe name of the key the set is stored at.
*Value:stringThe value whose element will be removed from the set.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Returns the specified range of elements in the sorted set stored at key. The elements are considered to be ordered from the lowest to the highest score.

Runtime Class - com.ibi.agents.XDRedisSortedSetsZRange



Parameter Groups

 ParameterTypeDescription
*Key:stringThe name of the key the set is stored at.
*Start:integerStart number of zero-based index elements.
*End:integerEnd number of zero-based index elements.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Adds all the specified members with the specified scores to the sorted set stored at key. It is possible to specify multiple score / member pairs. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.

Runtime Class - com.ibi.agents.XDRedisSortedSetsZAdd



Parameter Groups

 ParameterTypeDescription
*Key:stringThe key associated with the set.
*Member:stringA value to be stored in the set
*Score:stringA value associated with each member used to sort the set from smallest to greatest. While members are unique, scores may be repeated.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Remove the specified member from the set value stored at key.

Runtime Class - com.ibi.agents.XDRedisSetsSRem



Parameter Groups

 ParameterTypeDescription
*Key:stringThe name of the key the set is stored at.
*Value:stringThe value whose element will be removed from the set.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.