ACTIVITY_COLLECTOR

Overview
Activity collectors in BillingPlatform allow you to collect data in different forms, from different sources, that you can run on a scheulde or manually load. Activity collectors can be configured to process data from any delimited text file, which can be configured using the available fields. Collectors can also pull from manual uploads, FTP locations, as well as utilize web services. This section will describe the use of the Activity Collector object as well as the available fields.

System Entity Name
ACTIVITY_COLLECTOR

Allowed Functions

Create Update Retrieve Delete Upsert
YES YES YES YES YES


Fields

Field Data Type Properties Description
AccountId decimal    
ActivityCollectorName string  

Enter a unique descriptive name for you collector.

AfterProcessAction string    
AfterProcessDirectory string    
Delimiter string   Define the delimiter used in the type of file you will be loading into this collector.
EntityMethod string    
Entity_Id decimal    
ExternalEntityFieldId decimal    
FieldIncludedChar string   The character that will be used to encapsulate a field on the usage record that also contains the delimiter character.
FtpDirectory string   If you will be pulling usage files from an FTP location, then enter the directory you will find the files here.
FtpFilePattern string   If you will be pulling usage files from an FTP location, enter the format BillingPlatform should use when looking for the usage files.  Asterisks can be used as wildcard characters.
FtpLocationType string    
Hostname string   If you will be pulling usage files from an FTP location, enter the FTP host name.
LastRowId decimal    
LastRowIdChar string    
LastRuntime dateTime    
LoadOrder decimal    
Password string   If you will be pulling usage files from an FTP location, enter the password for the appropriate account you will be using to log on.
PrecollectorValidation string    
RateActivityFlag decimal   This flag controls whether or not the data collected will be rated by the application.
RecordFormat string  

Indicates the manner that fields and records are distinguished from each other in the collector data record. Similar to MS Excel, this can be one of the following:

  • Delimited - Fields are separated by a delimiter character (ie. comma).
  • Fixed - Fields are defined within a fixed number of characters.
RetrieveSql string    
RunIntervalMin decimal    
SkipRows decimal   Indicates the number of rows in the collector data record that will be skipped. This is typically set so that the collector will ignore header rows in the usage record file. 
Sproc string    
StartDate dateTime    
Status string  

Enter the status for the collector.  Valid entries include:

  • PRODUCTION
  • TEST
  • DEACTIVATED
  • DELETED
TimeZoneId decimal   Enter the time zone for this collector to run on.  Time zone IDs can be found in the time zone object.
Type string  

Enter the type of collection this collector will utilize.  This will define how the collector finds the usage data.  Valid entries include:

  • CUSTOM
  • MANUAL UPLOAD
  • FTP
  • WEBSERVICE
Username string   If you will be pulling usage files from an FTP location, enter the username for the appropriate account you will be using to log on.
VendorId decimal   ID of the vendor that will provide the usage data for the collector.



Sample Requests
Create

Request

 



Response

 




Update

Request

 



Response

 


Retrieve

Request

 



Response

 



Delete

Request

 



Response

 



Upsert

Request

 



Response

 
Have more questions? Submit a request

Comments

Powered by Zendesk