Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
appRules offers a next-generation, no-code development environment that can be utilized by business and technical users to tackle data migration, data integration, business rules, and automation projects. appRules projects are developed using your preferred web browser and a drag and drop designer with activity modules that can be associated to compose simple or complex business processes, linked to a large choice of data sources.
Data Migration, Replication, and Synchronization
Data Integration and Data Cleansing
Business Rules Engine
Process Automation
Machine Learning
Hundreds of connectors including CRM, ERP, Big Data, No-SQL, Analytics, and more
Dynamics 365, Salesforce, SAP, SharePoint, etc.
appRules is a popular choice when choosing a Business Rules, Data Migration, Data Integration and Process Automation software and has many advantages:
The appRules Platform powers our best-in-class product family and white label offerings by our platinum partners:
On-Premise and Cloud
User-friendly; drag-and-drop workflow designer
Data Source Browser
Data Migration Engine offering migration, replication and synchronization
Business Rules Engine offering decision tables, rulesets and more.
Web API Service
Scheduler Service
Powerful and configurable Conditions
Powerful and configurable Actions
Powerful and configurable Workflow Activities
To deliver a code-free environment where projects can be created and deployed quickly, appRules employs āSourced Valuesā. In simple terms, a Sourced Value allows you to quickly select a source for a value and an identifier for it. To specify a sourced value, you select the Source and then specify a value identifier (Source Value Identifier). Below are some examples of the many sourced values used in appRules:
String
The String source allows you to enter any value in the value identifier.
Example:
String:John Smith
DataFieldValue
The DataFieldValue source gets a value from a record that exists in a specific Source or Target in the project.
Example:
DataFieldValue:Employees.LastName
Gets the value of the LastName column in the Employees record.
DateTime
The DateTime sourced value points to a date/time related value. They can also be used to specify other date/time related data. Example:
DateTime:DateTimeNow
Generates the current date/time.
ActionField
The ActionField source allows you to select an action that you have defined using the Action Editor to get a value.
The above examples give you an idea of how Sourced Values are defined and used in appRules. They can be used to get and set data anywhere in your projects.
By providing a rich set of editors to manage Sourced Values, appRules is able to provide a very powerful and flexible combination that gives users the fastest and most compact environment for configuring workflow activities, actions, conditions, and orchestrating processes.
Below is an example of Sourced Values used for configuring a query:
The example below shows Sourced Values in use for mapping.
The appRules Platform is a powerful and configurable engine that powers the appStrategy product suite.
At its core, the platform utilizes metadata, sourced values, actions and conditions to deliver the most robust and configurable environment on the market today.
appRules offers purpose-built engines for business rules, data migration, integration, automation, and machine learning.
The appRules Platform offers unmatched scalability. You can run on a single desktop or on a multi-server configuration.
Deploy on-premise, in the cloud and on the web.
DataRobot
CloseSource
Closes the specified source connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
Fetches a specific record from a source connection
SFEinsteinAnalytics
CloseSource
Closes the specified source connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
Fetches a specific record from a source connection
Splunk
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Before jumping in to start composing and orchestrating your projects with appRules, it is recommended that you review this section to get a basic idea of the concepts that drive appRules.
The concepts are not discussed in detail here but are rather presented in a concise manner to help you hit the ground running. In addition to understanding the concepts and features, this section will also introduce you to the most frequently used terms in appRules.
While appRules features so many options, only the key common features are included in this section.
appRules is a no-code environment that includes thousands of configurable options for performing all design and runtime tasks for data migration, data integration, business rules and process automation.
Simple and complex conditions to be evaluated by the system can be defined and maintained without writing code.
Simple and complex actions to be performed by the system during processing can be defined and maintained without writing code.
The actual work performed by appRules projects are done through the execution of one or more workflow activities. Workflow activities in appRules are actually actions and conditions participating in orchestration.
A workflow activity takes input and gives output and contains user-configurable variables and properties. appRules workflow activities are grouped into modules that can be configured to complete a process. appRules activities are able to move and share data between modules and also with external systems.
Each module is specific to the features of the application that it supports -- including files, databases, SaaS etc.
The process of composing your projects (workflows), involves dragging activities on to the designer, configuring the associated properties, and associating them in a logical sequence order.
appRules is based on appStrategyās appConnector technology. appConnector technology delivers software libraries that connect a wide variety of applications and data sources.
appConnector functionality is based on workflow activities that are packaged in modules related to the job they perform as a group.
To use a module, refer to its documentation in the Data Sources section.
The appRules Data Migration Engine is a powerful engine based on the appRules platform that supports several data migration options include replication and synchronization. appRules Data Migration engine works with hundreds of data sources. It is sold as a separate appRules platform product.
The appRules Integration & Automation Engine is a powerful engine based on the appRules platform that supports integration, automation, and business rules processes. Decision Tables, Rule Sets and other features are included in the appRules Integration & Automation Engine. It is sold as a separate appRules platform product.
appRules Enterprise 360 is the enterprise suite that includes the appRules Data Migration Engine and the appRules Integration & Automation Engine - the All-In-One package.
In appRules, projects are composed and orchestrated as opposed to being programmed or developed. Using appConnector modules with powerful activities featuring easy-to-use and reusable editors makes this possible.
To compose projects in appRules, you simply drag and drop activities from the toolbox onto the designer and associate them in sequence using control flow activities (while, if, sequence ā¦):
appRules includes a Microsoft SQL Server compatible embedded database that you can use to host your small and mid-size projects. No installation or configuration is required for the appRules Embedded Database - it is automatically installed and configured.
appRules stores projects in project databases. Your project database can contain a few, or unlimited number of projects. You can also maintain several project databases and synchronize data between project databases. This feature makes it easy for you to maintain separate environments for Development, Test and Production.
Project databases are not just used for storing your job definitions. They also store other data including data source definitions, lists, settings and logs. appRules currently supports the appRules Embedded Database and Microsoft SQL Server as project databases. The appRules Embedded database is used mostly for development and for small and medium deployments. It requires little or no resources to create and maintain. The samples supplied with appRules are in the appRules Embedded database.
appRules includes utilities (CheckIn/CheckOut) that allow you to move your project database from one format to another.
A project database named Samples is installed along with your edition of the appRules software product.
The Samples database contains several examples that show you how to hit the ground running with appRules.
In addition, a database named Northwind containing test data is also automatically installed on your computer.
Most software projects consume a lot of time at runtime (configuring registry settings, checking activations, connection strings, file locations, location specific defaults, etc.). To alleviate these problems, appRules includes Environment Settings that you can use to define how your projects will be deployed -- even before the projects are composed. For example, you can create environment settings for Development, Test and Production. You can also create environment settings for departments, teams and locations. There is no limit to the number of environment settings that you can define. Environment Settings are linked to users running the projects.
appRules relies on data source metadata for all processing. Metadata is generated from the data sources and stored in the project database.
When creating a data source, appRules gathers not only information related to entities or table metadata, but also any additional information included in the database of applications including pick lists and data mapping information.
The same data source can use different connections depending if you run in Development or Production environment. Also a workflow activity can be executed using several connections in the same environment (a Bulk activity can use several workers, each of them associated to a different connection to the same data source).
To deliver a code-free environment where projects can be created and deployed quickly, appRules employs āSourced Valuesā. In simple terms, a Sourced Value allows you to quickly select a source for a value and an identifier for it. To specify a sourced value, you select the Source and then specify a value identifier (Source Value Identifier). Below are some examples of the many sourced values used in appRules:
Source
Value Identifier
String
The String source allows you to enter any value in the value identifier. Example: āConstant:John Smithā
DataFieldValue
The DataFieldValue source gets a value from a record that exists in a specific Source or Target in the project. Example: āEmployees.LastNameā gets the value of the LastName column in the Employees record.
DateTime
The DateTime sourced value points to a date/time related value. They can also be used to specify other date/time related data. Example: āDateTime.DateTimeNowā generates the current date/time.
ActionField
The ActionField source allows you to select results of specific actions
The above examples give you an idea of how Sourced Values are defined and used in appRules. There are over one hundred Sourced Values and associated types that you can use to specify data anywhere in your projects.
By providing a rich set of editors and controls to manage Sourced Values, appRules is able to provide a very powerful and flexible combination that gives users the fastest and most compact environment for configuring actions, conditions, activities and orchestrating processes.
Sourced Values in Property Grid
Below are examples of Sourced Value controls on the property grid at design time:
Data Managers are a special set of workflow activities that can be initialized as Sources or Targets in the appRules project. Source Data Managers retrieve data records from a data source and make the records and values in them available for other modules in the project. Target Data Managers are used for saving records to a specific data source. The properties, connectors configuration options, and execution context of Data Managers is based on the parent module of the Data Manager.
appRules projects can support an unlimited number of Source and Target Data Managers in the same project. And you can define configuration values using values from unrelated Sources/Targets and even dynamic values. A standard Source can be initialized using an InitializeSource activity and a standard Target activity can be initialized using an InitializeTarget activity.
In addition to standard Data Managers (Source & Target), appRules also supports derived Data Managers such as Lists, Lookups, PreloadedRecords, PickLists, etc.
appRules persists the values of the current records of Data Managers so they can be utilized by other activities using the DataFieldValue Sourced Value. Some appConnector modules provide additional Data Managers that are specific to the data source.
You can configure your appRules project to log as much information as possible regarding the process. Several selections are included for viewing logs and other project runtime data. After running the job or while it is still running, you can view all details related to the job, including Condition, Action and Activity statistics, Source and Target statistics, performance logs and error logs.
Below is the full list of Sourced Values:
ActionField
Argument
Get/Set value using an argument passed to the project. Use button to select or define arguments.
CalendarYear
Concatenation
Get/Set value by concatenating multiple values including text, Data Fields, etc.
ConditionResult
Get/Set result of executing a Condition
ConnectionString
Get/Set value by configuring a connection string.
DataFieldValue
Get/Set value using the current value of a field in the current record of a Source or Target activity in the project.
Date
Get/Set value using a Date. Use editor button to enter a Date, select Date function, add TimeSpan etc.
DateTime
Get/Set value using a DateTime. Use button to enter a DateTime, select DateTime function, add TimeSpan, etc.
Decimal
Get/Set value using a Decimal value.
RuntimeSettingField
Get/Set value from a pre-defined runtime setting field. Use editor button to select or define Runtime Setting Fields.
Double
Get/Set a value using a Double data type.
DynamicValue
Get/Set value using an appRules dynamic value. You can use one of the predefined values or enter a unique name.
Expression
Get/Set value from the result of executing an expression (JavaScript). Use editor button to enter Expression.
FilePath
Get/Set value as file path in file system
FiscalYear
Guid
Html
Single
Get/Set value as Single data type.
SourceDataFieldValue
Gets a data field value in the current Source.
String
Get/Set value as String data type.
TargetDataFieldValue
Gets a data field value in the current Target.
System
Get/Set a System value
TimeSpan
Get/Set value as TimeSpan
Variable
Get/Set value using a pre-defined Variable. Use button to select or define Variables
Get/Set value using an ActionField defined in Actions.
Get/Set value as calendar year. Enter calendar year or select:
.
Get/Set value as Fiscal Year. Enter fiscal year or select from list
Get/Set value from a Guid. Enter the Guid or select "New Guid".
Get/Set value using Html.
.
GetNextRecord
The GetNextAdobeAnalyticsRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
The LookupAdobeAnalyticsRecord activity fetches a specific record from a source connection
AzureAnalysisServices
CloseSource
The CloseSource activity closes the specified source connection
GetNextRecord
The GetNextRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
The LookupRecord activity fetches a specific record from a source connection
GoogleAnalytics
CloseSource
The CloseGoogleAnalyticsSource activity closes the specified source connection
GetNextRecord
The GetNextGoogleAnalyticsRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
The LookupGoogleAnalyticsRecord activity fetches a specific record from a source connection
SAS
CloseSource
Closes the specified source connection
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
Loads a specific record from a source connection
YouTubeAnalytics
CloseSource
The CloseYouTubeAnalyticsSource activity closes the specified source connection
GetNextRecord
The GetNextYouTubeAnalyticsRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
The LookupYouTubeAnalyticsRecord activity fetches a specific record from a source connection
appRules Actions deliver a centralized and consistent approach for performing actions in all operations. The Actions Editor is shown below:
To select an Action type, simply navigate the action tree and configure the properties for the selected type. Once an action is created, it can be executed at any point in the running project by using the PerformAction activity in the BaseActivities module or through other built-in access points in appRules (SetValues, MapRecordfields...).
GoogleCalendar
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
GoogleContacts
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
ExactOnline
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
FinancialEdgeNXT
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
FreshBooks
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
QuickBooks
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
QuickBooksOnline
CloseSource
The CloseQuickBooksOnlineSource activity closes the specified source connection
CloseTarget
The CloseQuickBooksOnlineTarget activity closes the specified target connection
DeleteRecord
The DeleteQuickBooksOnlineRecord activity deletes the specified target record
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
The InitializeQuickBooksOnlineTarget is used for initializing a connection where output records will be saved. Multiple InitializeQuickBooksOnlineTarget activites can be included in the workflow.
LookupRecord
The LookupQuickBooksOnlineRecord activity fetches a specific record from a source connection
MapRecordFields
The MapAndSetQuickBooksOnlineFields activity is used for setting the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
QuickBooksPOS
CloseSource
The CloseQuickBooksPOSSource activity closes the specified source connection
CloseTarget
The CloseQuickBooksPOSTarget activity closes the specified target connection
DeleteRecord
The DeleteQuickBooksPOSRecord activity deletes the specified target record
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
The InitializeQuickBooksPOSTarget is used for initializing a connection where output records will be saved. Multiple InitializeQuickBooksPOSTarget activites can be included in the workflow.
LookupRecord
The LookupQuickBooksPOSRecord activity fetches a specific record from a source connection
MapRecordFields
The MapAndSetQuickBooksPOSFields activity is used for setting the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Reckon
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Sage50UK
CloseSource
The CloseSage50UKSource activity closes the specified source connection
CloseTarget
The CloseSage50UKTarget activity closes the specified target connection
DeleteRecord
The DeleteSage50UKRecord activity deletes the specified target record
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
The InitializeSage50UKTarget is used for initializing a connection where output records will be saved. Multiple InitializeSage50UKTarget activites can be included in the workflow.
LookupRecord
The LookupSage50UKRecord activity fetches a specific record from a source connection
MapRecordFields
The MapAndSetSage50UKFields activity is used for setting the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
SageIntacct
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Xero
CloseSource
The CloseXeroSource activity closes the specified source connection
CloseTarget
The CloseXeroTarget activity closes the specified target connection
DeleteRecord
The DeleteXeroRecord activity deletes the specified target record
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
The InitializeXeroTarget is used for initializing a connection where output records will be saved. Multiple InitializeXeroTarget activites can be included in the workflow.
LookupRecord
The LookupXeroRecord activity fetches a specific record from a source connection
MapRecordFields
The MapAndSetXeroFields activity is used for setting the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
ApacheHBase
CloseSource
Closes the specified source connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a source for reading data records
LookupRecord
Fetches a specific record from a source connection
ApacheHive
CloseSource
Closes the specified source connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a source for reading data records
LookupRecord
Fetches a specific record from a source connection
Greenplum
CloseSource
The CloseSource activity closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
The GetNextRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
The LookupGreenplumRecord activity fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
HPCC
CloseSource
The CloseSource activity closes the specified source connection
GetNextRecord
The GetNextRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
The LookupHPCCRecord activity fetches a specific record from a source connection
SparkSQL
CloseSource
The CloseSource activity closes the specified source connection
GetNextRecord
The GetNextRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
The LookupSparkSQLRecord activity fetches a specific record from a source connection
Alfresco
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Kintone
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
QuickBase
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
AmazonS3
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
CopyObject
Copies an object from one bucket to another
DownloadObjects
Downloads objects
DownloadObjectTorrent
Uses the BitTorrent protocol to retrieve any publicly-accessible objects
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
UploadObject
Uploads objects in a single operation
AzureTables
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
CreateEntityWithTypes
Creates a new record with the given data types. If a column is not found on an existing entity, you will need to use this procedure to set the type of the property to something other than string.
CreateSchema
Creates a schema file for the specified table or view
CreateTable
Creates a new table in the Azure system
DropTable
Drops an existing table in the Azure system
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
IBMCloudObjectStorage
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
CopyObject
Copies an object from one bucket to another
DeleteRecord
Deletes the specified target record
DownloadObject
Downloads and object
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
UploadObject
Uploads an object
Wasabi
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
CopyObject
Copies an object from one bucket to another
DownloadObjects
Downloads objects
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
UploadMultipleObjects
Uploads a single object as a set of parts
UploadObject
Uploads objects in a single operation
Asana
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Box
AddMetadataTemplatestoFile
Applies an instance of a metadata template to a file.
CloseSource
Closes the specified source
CloseTarget
Closes the specified target
CopyFile
Copy a File
CopyFolder
Copy a Folder
DeleteRecord
Deletes the specified target record
DownloadFile
Downloads a File
EmptyTrash
Clear the recycle bin/trash.
GetNextRecord
Fetches the next record from the specified source
InitializeSource
Initializes a source for reading data records
InitializeTarget
Initializes a target for writing records
LockFile
Lock a file
LookupRecord
Fetches a specific record from a source
MapRecordFields
Sets the values of the specified DataFields in a target
SaveRecord
Saves the specified target record
ShareAnItem
Shares a File, Folder or Bookmark.
UnlockFile
Unlock a file.
UploadFile
Uploads a File.
UploadFileVersion
Uploads a new version of an existing File.
Dropbox
CheckJobStatus
Check the status of an asynchronous job. Requires the sharing.write scope.
CloseSource
Closes the specified source
CloseTarget
Closes the specified target
DeletePermanently
Delete a folder or file permanently. Requires the files.permanent_delete scope.
DeleteRecord
Deletes the specified target record
DownloadFile
Downloads a File. Requires the files.content.read scope.
GetNextRecord
Fetches the next record from the specified source
GetSpaceUsage
Check the memory space management of your Dropbox account. Requires the account_info.read scope.
InitializeSource
Initializes a source for reading data records
InitializeTarget
Initializes a target for writing records
LookupRecord
Fetches a specific record from a source
MapRecordFields
Sets the values of the specified DataFields in a target
SaveRecord
Saves the specified target record
ShareFolder
Shares a folder. Requires the sharing.write scope.
UnshareFolder
Unshares a folder. Requires the sharing.write scope.
UploadFile
Uploads a File. Requires the files.content.read scope.
Exchange
CloseSource
The CloseExchangeSource activity closes the specified source connection
CloseTarget
The CloseExchangeTarget activity closes the specified target connection
DeleteRecord
The DeleteExchangeRecord activity deletes the specified target record
GetNextRecord
The GetNextExchangeRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
The InitializeExchangeTarget is used for initializing a connection where output records will be saved. Multiple InitializeExchangeTarget activites can be included in the workflow.
LookupRecord
The LookupExchangeRecord activity fetches a specific record from a source connection
MapRecordFields
The MapAndSetExchangeFields activity is used for setting the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
GoogleDrive
CloseSource
Closes the specified source
CloseTarget
Closes the specified target
DeleteRecord
Deletes the specified target record
GetNextRecord
Fetches the next record from the specified source
InitializeSource
Initializes a source for reading data records
InitializeTarget
Initializes a target for writing records
LookupRecord
Fetches a specific record from a source
MapRecordFields
Sets the values of the specified DataFields in a target
SaveRecord
Saves the specified target record
MSTeams
CloseSource
The CloseMSTeamsSource activity closes the specified source connection
CloseTarget
The CloseMSTeamsTarget activity closes the specified target connection
DeleteRecord
The DeleteMSTeamsRecord activity deletes the specified target record
GetNextRecord
The GetNextMSTeamsRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
The InitializeMSTeamsTarget is used for initializing a connection where output records will be saved. Multiple InitializeMSTeamsTarget activites can be included in the workflow.
LookupRecord
The LookupMSTeamsRecord activity fetches a specific record from a source connection
MapRecordFields
The MapAndSetMSTeamsFields activity is used for setting the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Office365
CloseSource
The CloseOffice365Source activity closes the specified source connection
CloseTarget
The CloseOffice365Target activity closes the specified target connection
DeleteRecord
The DeleteOffice365Record activity deletes the specified target record
GetNextRecord
The GetNextOffice365Record activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
The InitializeOffice365Target is used for initializing a connection where output records will be saved. Multiple InitializeOffice365Target activites can be included in the workflow.
LookupRecord
The LookupOffice365Record activity fetches a specific record from a source connection
MapRecordFields
The MapAndSetOffice365Fields activity is used for setting the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
OneDrive
CloseSource
Closes the specified source
CloseTarget
Closes the specified target
CopyResource
Copy a resource from one directory in your drive to another.
CreateFolder
Create a new folder in your drive
DeleteRecord
Deletes the specified target record
DeleteResource
Delete a resource from your drive.
DownloadFile
Download an existing file from your drive.
GetNextRecord
Fetches the next record from the specified source
InitializeSource
Initializes a source for reading data records
InitializeTarget
Initializes a target for writing records
LookupRecord
Fetches a specific record from a source
MapRecordFields
Sets the values of the specified DataFields in a target
MoveResource
Move a resource from one directory in your drive to another.
SaveRecord
Saves the specified target record
UploadFile
Upload a new file or update content to an existing file.
OneNote
CloseSource
The CloseOneNoteSource activity closes the specified source connection
CloseTarget
The CloseOneNoteTarget activity closes the specified target connection
DeleteRecord
The DeleteOneNoteRecord activity deletes the specified target record
GetNextRecord
The GetNextOneNoteRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
The InitializeOneNoteTarget is used for initializing a connection where output records will be saved. Multiple InitializeOneNoteTarget activites can be included in the workflow.
LookupRecord
The LookupOneNoteRecord activity fetches a specific record from a source connection
MapRecordFields
The MapAndSetOneNoteFields activity is used for setting the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
SharePoint
AddAttachment
Add an attachment to a SharePoint list item
CheckInDocument
Checks in a document to SharePoint and releases the lock on the document
CheckOutDocument
Checks out a document from SharePoint
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
CopyDocument
Copies a document from the SharePoint library
CreateFolder
Creates a folder to a document library on a SharePoint site
DeleteAttachment
Delete an attachment from a SharePoint list item
DeleteDocument
Delete a document on the SharePoint library.
DeleteRecord
Deletes the specified target record
DiscardCheckOutDocument
Discards a check out on a document in SharePoint. This does not check a new file into SharePoint, it just releases the lock on the document
DownloadDocument
Download a document from a SharePoint library
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
UploadDocument
Upload a document to a SharePoint library
Slack
CloseSource
Closes the specified source
CloseTarget
Closes the specified target
DeleteRecord
Deletes the specified target record
GetNextRecord
Fetches the next record from the specified source
InitializeSource
Initializes a source for reading data records
InitializeTarget
Initializes a target for writing records
LookupRecord
Fetches a specific record from a source
MapRecordFields
Sets the values of the specified DataFields in a target
SaveRecord
Saves the specified target record
Smartsheet
CloseSource
Closes the specified source
CloseTarget
Closes the specified target
DeleteRecord
Deletes the specified target record
GetNextRecord
Fetches the next record from the specified source
InitializeSource
Initializes a source for reading data records
InitializeTarget
Initializes a target for writing records
LookupRecord
Fetches a specific record from a source
MapRecordFields
Sets the values of the specified DataFields in a target
SaveRecord
Saves the specified target record
Access
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Btrieve
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
DB2
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a Source for reading data records
InitializeTarget
Initializes a Target for saving data records
LookupRecord
Fetches a specific record from a Source
MapRecordFields
Setting the values of the specified DataFields in a target
SaveRecord
Saves the specified target record
EmbeddedDB
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Maps values to specified DataFields in a target connection
SaveRecord
Saves the specified target record
Firebird
CloseSource
The CloseFirebirdSource activity closes the specified source connection
CloseTarget
The CloseFirebirdTarget activity closes the specified target connection
DeleteRecord
The DeleteFirebirdRecord activity deletes the specified target record
ExecuteStatements
The ExecuteFirebirdStatement activity is used to execute a custom sql statement on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
The GetNextFirebirdRecord activity fetches the next record from the specified source connection
InitializeSource
The InitializeFirebirdSource activity initializes a connection for reading data records at run time. Multiple InitializeFirebirdSource activites can be included in the workflow.
InitializeTarget
The InitializeFirebirdTarget is used for initializing a connection where output records will be saved. Multiple InitializeFirebirdTarget activites can be included in the workflow.
LookupRecord
The LookupFirebirdRecord activity fetches a specific record from a source connection
MapRecordFields
The MapAndSetFirebirdFields activity is used for setting the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Informix
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
MariaDB
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
MySQL
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Odbc
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Loads a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
OleDb
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
Loads a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Oracle
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
PostgreSQL
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
SqlAzure
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Loads a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
SqlServer
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteSQLScript
Executes a SQL Server Script file
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
RunSSISPackage
Runs a SSIS package
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
SqlServerCe
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
The ExecuteSqlServerCeStatement activity is used to execute a custom sql statement on a connection
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a source for reading records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
Sybase
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Teradata
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Vertica
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
xBase
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
ADLSGen1
AppendToFile
Appends content or a file to a file
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
Concat
Concatenate a group of files to another file
DeletePath
Delete a file or a directory.
DownloadFile
Downloads a file
GetContentSummary
Get the content summary of a file/folder.
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MakeDirectory
Create a directory in the specified path
RenamePath
Rename a file or a directory.
SetPathOwner
Set owner and group of a path.
SetPermission
Set permission of a path
UploadFile
Uploads a File
ADLSGen2
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
CreateFile
Create a file.
CreateFolder
Create a folder
DeleteObject
Delete a file or directory
DownloadFile
Download a file
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
RenameObject
Rename a file or a directory
UploadFile
Uploads a file
AzureSynapse
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
Databricks
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
GoogleBigQuery
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Redshift
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
Snowflake
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
JIRA
CloseSource
Closes the specified source connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time
LookupRecord
Fetches a specific record from a source connection
ServiceNow
CloseSource
Closes the specified source connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time
LookupRecord
Fetches a specific record from a source connection
Zendesk
CloseSource
Closes the specified source connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time
LookupRecord
Fetches a specific record from a source connection
AmazonMarketplace
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Magento
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Shopify
CloseSource
Closes the specified source connection
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
Fetches a specific record from a source connection
WooCommerce
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Gmail
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializing a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
ActCRM
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
BullhornCRM
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
Dynamics365
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
CreateAssociation
Creates an association between two entities based on a navigation property. Set the IncludeNavigationProperties connection property to true in order to use this activity.
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeAssociationsSource
Lists associations for a given table and navigation property into a Source. Set the IncludeNavigationProperties connection property to true in order to use this workflow activity.
InitializeNavigationPropertiesSource
Lists navigation properties for a given table and the tables they are associated with into a Source. Navigation properties are used by the Association stored procedures. Set the IncludeNavigationProperties connection property to true in order to use this workflow activity.
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
DynamicsCRM
Assign
Assigns a target record to a user or team
AssociateRequest
Adds link between two entity instances in a many to many relationship
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
DisassociateRequest
Removes a link between two entity instances in a many to many relationship
ExecuteStatements
Executes custom SQL statements on a data source
ExecuteWorkflow
Executes a Dynamics CRM workflow request
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
SetState
Sets the state and the status of an entity instance
Highrise
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
OracleSalesCloud
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
Salesforce
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
ConvertLead
Converts a Lead into an Account, Contact, or (optionally) an Opportunity.
DeleteRecord
Deletes the specified target record
DownloadAttachment
Downloads the attachment or attachments associated with a specific object
DownloadDocument
Downloads the selected document or documents
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
GetUserInformation
Retrieves personal information for the user associated with the current session.
InitializeDeletedSource
Initializes a source of deleted records within the given timespan for the specified object. Records can be iterated using the GetNextRecord activity.
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
InitializeUpdatedSource
Initializes a source of updated records within the given timespan for the specified object. Records can be iterated using the GetNextRecord activity.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
Merge
Combines up to 3 records of the same type into 1 record.
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
Undelete
Restores a deleted record from the RecycleBin
UploadAttachment
Uploads an attachment and associates it with an object in Salesforce
UploadDocument
Uploads a document in Salesforce
SAPHybrisC4C
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
SugarCRM
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
SuiteCRM
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
VeevaCRM
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
ConvertLead
Converts a Lead into an Account, Contact, or (optionally) an Opportunity.
DeleteRecord
Deletes the specified target record
DownloadAttachment
Downloads the attachment or attachments associated with a specific object
DownloadDocument
Downloads the selected document or documents
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
GetUserInformation
Retrieves personal information for the user associated with the current session.
InitializeDeletedSource
Initializes a source of deleted records within the given timespan for the specified object. Records can be iterated using the GetNextRecord activity.
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
InitializeUpdatedSource
Initializes a source of updated records within the given timespan for the specified object. Records can be iterated using the GetNextRecord activity.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
Merge
Combines up to 3 records of the same type into 1 record.
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
Undelete
Restores a deleted record from the RecycleBin
UploadAttachment
Uploads an attachment and associates it with an object in Salesforce
UploadDocument
Uploads a document in Salesforce
ZohoCRM
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
Acumatica
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
D365BusinessCentral
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
Dynamics365
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
DynamicsGP
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
LookupRecord
Gets a specific record from a data source
DynamicsNAV
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
NetSuite_SuiteQL
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
NetSuite_SuiteTalk
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
Odoo
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
SAPBusinessOne
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
SAPERP
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
LookupRecord
Gets a specific record from a data source
Workday
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
CSVDatabase
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
DelimitedFile
AppendFile
Appends the contents of one file to another
CloseSourceFile
Closes the specified Source data source
CloseTargetFile
Closes the specified target delimited file
CopyFileRecords
Copies specific records from one file to another
CreateFileFromSource
Creates a delimited file from a Source
DeleteFile
Deletes the specified file
GetNextFileRecord
Fetches the next record from the specified delimited Source file
InitializeSourceFile
Initializes a Source for reading data records from a delimited file
InitializeTargetFile
Initializes a Target for writing data records to a delimited file
MapRecordFields
Sets the values of the specified DataFields in a target delimited file
SaveValueInNewFile
Saves a field value to a file
SplitFile
Splits a large delimited file into multiple files
WriteTargetFileRecord
Inserts a record into the specified delimited file
FileSystem
DirACLAddEntry
The DirectoryAddACLEntry activity adds an Access Control List (ACL) entry to a directory
DirACLRemoveEntry
The DirectoryACLRemoveEntry activity removes an Access Control List (ACL) entry from a directory
DirCloseDirInfoSource
The DirectoryCloseDirectoryInfoSource activity closes the Directoryinfo source and frees up resources
DirCloseFileInfoSource
The CloseSourceFileFile activity closes the DirectoryFileInfo source and frees up resources
DirectoryCreate
The DirectoryCreate activity creates all the directories and subdirectories in the specified path
DirectoryDelete
The DirectoryDelete activity deletes a directory and its subdirectories if specified
DirectoryMove
The DirectoryMove activity moves a directory from a source to a destination
DirectoryZip
The DirectoryZip activity zips a directory
DirGetNextDirInfoRecord
The DirGetNextDirInfoRecord activity loads the next record from the specified list of selected Directoryinfo
DirGetNextFileInfoRecord
The DirectoryGetNextFileInfoRecord activity loads the next record from the specified list of selected fileinfo
DirInitializeDirInfoSource
The DirectoryInitializeDirectoryInfoSource activity initializes a list of directory information that can be accessed sequentially using the GetNextDirectoryInfoRecord
DirInitializeFileInfoSource
The DirectoryInitializeFileInfoSource activity initializes a list of file information that can be accessed sequentially using the GetNextFileInfoRecord
FileACLAddEntry
The FileACLAddEntry activity adds an Access Control List (ACL) entry to a file
FileACLRemoveEntry
The FileACLRemoveEntry activity removes Access Control List (ACL) entry from a file
FileCopy
Copies files from one location to another
FileDelete
The FileDelete activity deletes a file
FileFTPDownload
The FileFTPDownload activity downloads a file from an ftp site
FileFTPUpload
The FileFTPUpload activity uploads a file from an ftp site
FileMove
Moves a file from a source to a destination
FileUnzip
The FileZip activity unzips a file
FileZip
The FileZip activity zips a file
SaveValueInNewFile
The SaveValueInNewFile activity is used for saving field values to a file
FixedLengthFile
AppendFile
Appends the contents of one file to another
CloseSourceFile
Closes the specified Source file data source
CloseTargetFile
Closes the specified target file
CopyFileRecords
Copies specific records from one file to another
DeleteFile
Deletes the specified file
GetNextFileRecord
Fetches the next record from the specified Source file data source
InitializeSourceFile
Initializes a Source for reading data records from a fixed length file
InitializeTargetFile
Initializes a Target for writing data records to a fixed length text file
MapRecordFields
Sets the values of the specified DataFields in a Target data source
SaveValueInNewFile
The SaveValueInNewFile activity is used for saving a field value to a file
SplitFile
Splits a large delimited file into multiple files
WriteTargetFileRecord
Inserts a record into the specified text file
OFX
CloseSource
Closes the specified source connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
Fetches a specific record from a source connection
Quandl
CloseSource
Closes the specified source connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
Gets a specific record from a data source
SAPConcur
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a source for reading data records
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
BingAds
CloseSource
Closes the specified source connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
Fetches a specific record from a source connection
GoogleAds
CloseSource
Closes the specified source connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
Fetches a specific record from a source connection
HubSpot
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
MailChimp
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Marketo
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
OracleEloqua
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
SurveyMonkey
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
YouTube
CloseSource
The CloseYouTubeSource activity closes the specified source connection
GetNextRecord
The GetNextYouTubeRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
The LookupYouTubeRecord activity fetches a specific record from a source connection
DynamicDataSource
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a source for reading records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record
Basecamp
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
MicrosoftProject
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Propel
CloseSource
Optional activity to close a specified source connection. Note: All connections are automatically closed at the end of the job run
CloseTarget
Optional activity to close a specified target connection. Note: All connections are automatically closed at the end of the job run
ConvertLead
Converts a Lead into an Account, Contact, or (optionally) an Opportunity.
DeleteRecord
Deletes the specified target record
DownloadAttachment
Downloads the attachment or attachments associated with a specific object
DownloadDocument
Downloads the selected document or documents
ExecuteStatements
Executes custom SQL statements on a data source
GetNextRecord
Gets the next record from the specified source connection
GetUserInformation
Retrieves personal information for the user associated with the current session.
InitializeDeletedSource
Initializes a source of deleted records within the given timespan for the specified object. Records can be iterated using the GetNextRecord activity.
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
InitializeUpdatedSource
Initializes a source of updated records within the given timespan for the specified object. Records can be iterated using the GetNextRecord activity.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
Merge
Combines up to 3 records of the same type into 1 record.
SaveRecord
Saves the specified target record - (Insert, Update, Upsert, Skipsert)
Undelete
Restores a deleted record from the RecycleBin
UploadAttachment
Uploads an attachment and associates it with an object in Propel
UploadDocument
Uploads a document in Propel
AuthorizeNet
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
PayPal
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
Square
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Stripe
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
AmazonDynamoDB
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Cassandra
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Cloudant
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
CosmosDB
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Couchbase
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
MongoDB
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Redis
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
SimpleDB
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
ActiveDirectory
CloseSource
The CloseSource activity closes the specified source connection
CloseTarget
The CloseTarget activity closes the specified target connection
DeleteRecord
The DeleteRecord activity deletes the specified target record
ExecuteStatements
The ExecuteActiveDirectoryStatement activity is used to execute a custom sql statement on a connection
GetNextRecord
The GetNextRecord activity fetches the next record from the specified source connection
InitializeSource
The InitializeSource activity initializes a connection for reading data records at run time. Multiple InitializeActiveDirectorySource activites can be included in the workflow.
InitializeTarget
The InitializeTarget is used for initializing a connection where output records will be saved. Multiple InitializeActiveDirectoryTarget activites can be included in the workflow.
LookupRecord
The LookupRecord activity fetches a specific record from a source connection
MapRecordFields
The MapRecordFields activity is used for setting the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
JSON
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
LDAP
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
MicrosoftDataverse
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
OData
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Execute a custom sql statement on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
REST
CloseSource
The CloseSource activity closes the specified source connection
GetNextRecord
The GetNextRecord activity fetches the next record from the specified source connection
InitializeSource
The InitializeSource activity initializes a connection for reading data records at run time. Multiple InitializeRESTSource activites can be included in the workflow.
LookupRecord
The LookupRecord activity fetches a specific record from a source connection
RSS
CloseSource
Closes the specified source connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
Fetches a specific record from a source connection
XML
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
Bing
CloseSource
The CloseSource activity closes the specified source connection
GetNextRecord
The GetNextRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
The LookupBingRecord activity fetches a specific record from a source connection
Elasticsearch
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a source for reading data records
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
GoogleSearch
CloseSource
The CloseSource activity closes the specified source connection
GetNextRecord
The GetNextRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
The LookupGoogleSearchRecord activity fetches a specific record from a source connection
FedEx
CloseSource
The CloseFedExSource activity closes the specified source connection
GetNextRecord
The GetNextFedExRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
The LookupFedExRecord activity fetches a specific record from a source connection
UPS
CloseSource
The CloseSource activity closes the specified source connection
GetNextRecord
The GetNextRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
The LookupUPSRecord activity fetches a specific record from a source connection
USPS
CloseSource
The CloseUSPSSource activity closes the specified source connection
GetNextRecord
The GetNextUSPSRecord activity fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
The LookupUSPSRecord activity fetches a specific record from a source connection
The Actions-Fields-Library-Math module contains the following types:
Abs
Returns the absolute value of a specified number.
Acos
Returns the angle whose cosine is the specified number.
Asin
Returns the angle whose sine is the specified number.
Atan
Returns the angle whose tangent is the specified number.
Atan2
Returns the angle whose tangent is the quotient of two specified numbers.
Cos
Returns the cosine of the specified angle.
Cosh
Returns the hyperbolic cosine of the specified angle.
DivideInt32GetQuotient
Calculates the quotient of two 32-bit signed integers
DivideInt32GetRemainder
Calculates the remainder of dividing two 32-bit signed integers
DivideInt64GetQuotient
Calculates the quotient of two 64-bit signed integers
DivideInt64GetRemainder
Calculates the remainder of dividing two 64-bit signed integers
E
Returns constant e - Euler's number
Exp
Returns e raised to the specified power
Log
Returns the natural (base e) logarithm of a specified number.
Log10
Returns the base 10 logarithm of a specified number.
Max
Returns the maximum number from a list of numbers.
Min
Returns the minimum number from a list of numbers.
Pi
Returns the value of mathematical constant pi.
Pow
Returns a double of a specified number raised to the specified power
Sin
Returns the sine of the specified angle.
Sinh
Returns the hyperbolic sine of the specified angle.
Sqrt
Returns the square root of a specified number.
Tan
Returns the tangent specified angle.
Tanh
Returns the hyperbolic tangent specified angle.
TruncateDecimal
Calculates the integral part of a specified decimal number.
TruncateDouble
Calculates the integral part of a specified double number.
The Actions-Fields-Library-Financial module which is filled with Microsoft Excel compatible functions contains the following types:
ACCRINT
Returns the accrued interest for a security that pays periodic interest
ACCRINTM
Returns the accrued interest for a security that pays interest at maturity
AMORDEGRC
Returns the depreciation for each accounting period. This function is provided for the French accounting system. If an asset is purchased in the middle of the accounting period, the prorated depreciation is taken into account. The function is similar to AMORLINC, except that a depreciation coefficient is applied in the calculation depending on the life of the assets.
AMORLINC
Returns the depreciation for each accounting period. This function is provided for the French accounting system. If an asset is purchased in the middle of the accounting period, the prorated depreciation is taken into account.
COUPDAYS
Returns the number of days in the coupon period that contains the settlement date.
COUPDAYSBS
Calculates the number of days from the beginning of a coupon's period to the settlement date.
COUPDAYSNC
Returns the number of days from the settlement date to the next coupon date.
COUPNCD
Returns a number that represents the next coupon date after the settlement date.
COUPNUM
Returns the number of coupons payable between the settlement date and maturity date, rounded up to the nearest whole coupon.
COUPPCD
Returns a number that represents the previous coupon date before the settlement date.
CUMIPMT
Returns the cumulative interest paid on a loan between start_period and end_period.
CUMPRINC
Returns the cumulative principal paid on a loan between start_period and end_period.
DB
Returns the depreciation of an asset for a specified period using the fixed-declining balance method.
DDB
Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify.
DISC
Returns the discount rate for a security.
DOLLARDE
Excel DOLLARDE Function
DOLLARFR
Excel DOLLARFR Function
DURATION
Excel DURATION Function
EFFECT
Excel EFFECT Function
FV
Calculates the future value of an investment based on a constant interest rate.
FVSCHEDULE
Returns the future value of an initial principal after applying a series of compound interest rates.
INTRATE
Returns the interest rate for a fully invested security.
IPMT
Returns the interest payment for a given period for an investment based on periodic, constant payments and a constant interest rate.
IRR
Returns the internal rate of return for a series of cash flows represented by the numbers in values.
ISPMT
Calculates the interest paid (or received) for the specified period of a loan (or investment) with even principal payments.
MDURATION
Returns the modified Macauley duration for a security with an assumed par value of $100.
MIRR
Returns the modified internal rate of return for a series of periodic cash flows. MIRR considers both the cost of the investment and the interest received on reinvestment of cash.
NOMINAL
Returns the nominal annual interest rate, given the effective rate and the number of compounding periods per year.
NPER
Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate.
NPV
Calculates the net present value of an investment by using a discount rate and a series of future payments(negative values) and income(positive values).
ODDFPRICE
Returns the price per $100 face value of a security having an odd (short or long) first period.
ODDFYIELD
Returns the yield of a security that has an odd (short or long) first period.
ODDLPRICE
Returns the price per $100 face value of a security having an odd (short or long) last coupon period.
ODDLYIELD
Returns the yield of a security that has an odd (short or long) last period.
PDURATION
Returns the number of periods required by an investment to reach a specified value.
PMT
Calculates the payment for a loan based on constant payments and a constant interest rate.
PPMT
Returns the payment on the principal for a given period for an investment based on periodic, constant payments and a constant interest rate.
PRICE
Returns the price per $100 face value of a security that pays periodic interest.
PRICEALLOWNEGATIVEYIELD
Returns the price per $100 face value of a security that pays periodic interest.
PRICEDISC
Returns the price per $100 face value of a discounted security.
PRICEMAT
Returns the price per $100 face value of a security that pays interest at maturity
PV
Calculates the present value of a loan or an investment, based on a constant interest rate.
RATE
Returns the interest rate per period of an annuity.
RECEIVED
Returns the amount received at maturity for a fully invested security.
RRI
Returns an equivalent interest rate for the growth of an investment.
SLN
Returns the straight-line depreciation of an asset for one period.
SYD
Returns the sum-of-years' digits depreciation of an asset for a specified period.
TBILLEQ
Returns the bond-equivalent yield for a Treasury bill.
TBILLPRICE
Returns the price per $100 face value for a Treasury bill.
TBILLYIELD
Returns the yield for a Treasury bill.
VDB
Returns the depreciation of an asset for any period you specify, including partial periods, using the double-declining balance method or some other method you specify. VDB stands for variable declining balance.
XIRR
Returns the internal rate of return for a schedule of cash flows that is not necessarily periodic. To calculate the internal rate of return for a series of periodic cash flows, use the IRR function
XNPV
Returns the net present value for a schedule of cash flows that is not necessarily periodic. To calculate the net present value for a series of cash flows that is periodic, use the NPV function.
YEARFRAC
Calculates the fraction of the year represented by the number of whole days between two dates (the start_date and the end_date).
YIELD
Returns the yield on a security that pays periodic interest. Use YIELD to calculate bond yield.
YIELDDISC
Returns the annual yield for a discounted security.
YIELDMAT
Returns the annual yield of a security that pays interest at maturity.
Excel
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records. Records can be iterated using the GetNextRecord activity.
InitializeTarget
Initializes a connection for saving output data records.
LookupRecord
Gets a specific record from a data source
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
ExcelOnline
CloseSource
The CloseExcelOnlineSource activity closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
ExcelServices
CloseSource
The CloseExcelServicesSource activity closes the specified source connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
LookupRecord
Fetches a specific record from a source connection
GoogleSheets
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
DeleteRecord
Deletes the specified target record
ExecuteStatements
Executes custom SQL statements on a connection
GetNextRecord
Fetches the next record from the specified source connection
InitializeSource
Initializes a connection for reading data records at run time.
InitializeTarget
Initializes a connection where output records will be saved.
LookupRecord
Fetches a specific record from a source connection
MapRecordFields
Sets the values of the specified DataFields in a target connection
SaveRecord
Saves the specified target record
The Execution action category contains the following actions in the modules shown below:
Base
CallWebService
The CallWebService activity calls a web service
CloseActivity
Closes the specified activity (including any open connections)
Delay
The Delay activity delays the execution of a workflow for a specified amount of time.
EndWorkflow
The EndWorkflow activity ends the current workflow
EvaluateCondition
Evaluates a condition and returns True or False
ExecuteConnectorActivity
Executes a special activity in a connector (not a basic activity contained in BaseData)
ExecuteWorkflow
Executes a workflow and optionally passes the required parameters to it.
ExecuteWorkflowActivity
The ExecuteWorkflowActivity action executes a workflow activity
PerformAction
Performs an action
ResetActivityResult
Resets the execution result of an activity
ResetLastResult
Resets the last execution result
SendEmail
Sends an emal
SetValues
The SetValues activity is used for setting values in the workflow
UpdateWorkflowState
This activity updates the State of the currently running instance of the workflow
WriteAuditLogsEntry
This activity is used for writing entries to the audit logs detail table. The Description and/or Message property is required
WriteLogEntry
This activity is used for writing entries to the log. Log entries can include Source and Target records/statistics, messages, errors, warnings, etc.
BaseData
ClearRecord
This activity clears the values in a specific record in memory. It does not clear the record from the data source.
CloseSource
Closes the specified source connection
CloseTarget
Closes the specified target connection
CommitTransaction
Optional action to Commit a transaction on the Target and start a new transaction
DeleteRecord
Deletes the specified target record
ExecuteSQLScript
Executes a SQL Script on a data source (Dynamics365, Salesforce, MySQL, Oracle, etc.)
ExecuteStatements
Executes custom SQL statements on a connection
ExecuteStoredProcedure
Executes a stored procedure on a data source. To utilize a stored procedure as a multi-record source, use the InitializeSource activity
GetNextRecord
The GetNextRecord activity loads the next record from the specified Source
InitializeSource
Initializes a connection for reading data records at run time.
InitializeSourceFile
Initializes a Source for reading data records from a file
InitializeSourceList
Initializes a Source for reading data records from a file
InitializeTarget
Initializes a connection for saving output records.
InitializeTargetFile
Initializes a Target for writing data records to a file
LookupRecord
Loads a specific record from a source
MapAndSaveRecords
Maps and saves values to specified DataFields in a target connection
MapRecordFields
Maps values to specified DataFields in a target connection
RestartSource
Restarts a source by re-executing the query and re-reading the records using the GetNextRecord activity
RollbackTransaction
Optional action to Rollback a transaction on the Target and start a new transaction
SaveRecord
Saves the specified target record
BusinessRules
EvaluateConditions
Executes a group of conditions
EvaluateDecisionTable
Defines and executes a decision table
ExecuteRuleSet
Initializes and executes a rule set
PerformActions
Executes a group of actions
Cache
LoadSourceRecordsIntoCache
The LoadSourceRecordsIntoCache action loads source records into the cache. They can be retrieved using the LookupCachedRecord action
LookupCachedRecord
Loads a record from the cache
SaveCustomValueInCache
Saves a custom value in the cache
SaveKeyValueInCache
DataSource entity record keys are automatically saved in cache when that option is set. This action allows you to save a key in cache at any time and to retrieve it using the LookupCachedKeyValue action
SaveRecordInCache
Saves a record in cache
Custom
Composite
Executes selected defined or pre-defined actions in sequence
Expression
The Expression action executes a simple expression (javascript). The expression does NOT return a value
Function
Executes a .Net custom function and does NOT returns a value.
Script
The Script field action executes a script (javascript). The script does not return a value.
DataMigration
MigrateData
Migrates, replicates or synchronizes data from one or more source data sources to one or more target data sources
Dialogs
DisplayMessage
Displays a message
EditRecord
Displays data records for viewing and editing
EditWorkflowValues
The ViewRuntimeValues activity is used for viewing selected values at run time.
PromptForValue
Prompts the user for a value
ViewRuntimeRecords
Displays data records at runtime
ViewRuntimeStatistics
The ViewRuntimeStatistics activity is used for viewing DataManager statistics at run time
ViewRuntimeValues
The ViewRuntimeValues activity is used for viewing selected values at run time.
The Fields-Field actions are grouped in the modules shown below:
The Utility-Automation actions category includes the following modules and types:
Cache
LookupCachedCustomValue
Returns a custom value saved in the cache
LookupCachedKeyValue
Returns a table key value that has been saved in the cache
Counters
GetCurrentCounterValue
Returns the specified counter value
IncrementCounter
Initializes, Increments the value of a specified counter and returns it
Custom
Composite
Executes selected defined or pre-defined actions in sequence and returns the result of executing the last action in the list.
Expression
The Expression action executes a simple expression (javascript). The expression must return a value
Function
Executes a .Net custom function and returns a value
Script
The Script field action executes a script (javascript). The script must return a value.
DateTime
AddDaysToDate
Adds (or subtracts) the specified number of days to a date
AddMonthsToDate
Adds (or subtracts) the specified number of months to a date
AddTimeSpanToDateTime
Adds (or subtracts) the specified TimeSpan (00:00:00:00) to a datetime. To subtract place - in front of TimeSpan value.
AddYearsToDate
Adds (or subtracts) the specified number of years to a date
GetDateDay
Gets the Day (integer) from the date
GetDateMonth
Gets the Month (integer) from the date
GetDateThisDayLastMonth
Gets this day last month (date)
GetDateThisDayLastWeek
Gets this day last week
GetDateThisDayLastYear
Gets this day last year (date)
GetDateThisDayNextMonth
Gets this day next month (date)
GetDateThisDayNextWeek
Gets this day next week
GetDateThisDayNextYear
Gets this day next year (date)
GetDateThisMonthEnd
Gets this month's end date
GetDateThisMonthStart
Gets this month's start date
GetDateThisYearEnd
Gets this year's end date
GetDateThisYearStart
Gets this year's start date
GetDateTimeNow
Gets the current date/time
GetDateToday
Gets today's date
GetDateTomorrow
Gets tomorrow's date
GetDateYear
Gets the Year (integer) from the date
GetDateYesterday
Gets yesterday's date
GetElapsedTimeDays
Returns the integer number of days between two dates
GetElapsedTimeHours
Returns the integer number of hours between two datetimes
GetElapsedTimeMilliseconds
Returns the integer number of milliseconds between two datetimes
GetElapsedTimeMinutes
Returns the integer number of minutes between two datetimes
GetElapsedTimeMonths
Returns the integer number of years between two dates
GetElapsedTimeSeconds
Returns the integer number of seconds between two datetimes
GetElapsedTimeWeeks
Returns the integer number of weeks between two dates
GetElapsedTimeYears
Returns the integer number of years between two dates
GetYearWeekNumber
Gets the number of the week in the year
SetTime
Sets the time for a date/time
File
GetFileContentsAsBytes
Gets the contents of a file as a string
GetFileContentsAsString
Gets the contents of a file as a string
GetFileRecordSubstring
Gets a substring from a fixed length file record
Lookup
LookupBulkLoadRecordId
Gets a record Id retrieved from a bulk load on a parent target
LookupDataFieldValue
Loads a record and returns a specific data field
LookupMappedFieldValue
The LookupMappedFieldValue initializes a table to be used for replacing an input value with a defined output value. Useful for mapping picklist or option set values.
LookupPickListValue
Gets the key or description for a picklist
LookupRetrievedIdFromAuditLog
Returns a table key value that has been saved in the audit logs table
LookupRoundRobinValue
Supports the lookup of values in a round-robin fashion. This can be used for lead distribution, record assignment, etc.
Numeric
CalculateRunningTotal
Adds a value to a running total
FormatNumber
Returns the string representation of an integer, adding extra 0's to the right if the string is smaller than the specified number of characters.
GetCurrentCounterValue
Returns the current value of a counter.
GetNextCounterValue
Increments a counter and returns the new value.
GetRunningTotal
Gets a running total
GetRunningTotalAverage
Gets the average value in a running total
GetRunningTotalCount
Gets the count of number of entries in a running total
GetRunningTotalMaximum
Gets the maximum value in running total
GetRunningTotalMinimum
Gets the minimum value in running total
InitializeCounter
Initializes a counter of integer values. At any time, executing this action returns the current value of the counter. Use GetNextCounterValue to increment and get next counter value.
InitializeRunningTotal
Initializes a running total. At any time, executing this action returns the current value of the counter. Use GetNextCounterValue to increment and get next counter value.
String
AlternateCases
Returns a string with alternated letter casing(upper/lower). First character of the string stays the same
Base64Decode
Decodes a Base64 string
Base64Encode
Encodes a Base64 string
Capitalize
Capitalizes the first character in a string
CharMid
Returns the character at a position given by the startingIndex plus the given count.
CharRight
Returns the character in a string at a given index counting from the right.
Concatenate
Concatenates values into a string
ConcatenateHtml
Inserts values into Html using the Html editor
ConvertHtmlToPlainText
Converts a string from Html to plain text
ConvertRtfToString
Converts Rtf to a string
ConvertStringToRtf
Converts a string to Rtf
Format
Returns a string formatted to match the format string
FormatDataType
Returns a formatted datetime, decimal, double, integer or single value using .Net formatting
GetEmptyString
Returns an empty string value
GetHashCodePolynomial
Returns the hash code of a string based on a polynomial function with a specified factor.
GetInitials
Returns the initials of each word in a string. Words are separated according to the sepecified string sequence.
GetKeyFromGuid
Gets a Guid key
GetKeyFromRandomNumber
Returns a key based on randomly generated number
GetKeyFromTimestamp
Gets a Timestamp key
GetLength
Returns the length of a string.
GetNullString
Returns a null string value
GetTitle
Returns the initials of each word in a string. Words are separated according to the sepecified string sequence.
IndentLines
Returns a string with the given number of spaces prepended to the beginning of each line.
InsertSeparator
Returns a string with a given seperator inserted after a specified interval of characters.
InsertString
Inserts a string at a specified index position in the source string (0 origin)
KeepAlphaNumeric
Returns a string with only alpha-numeric characters preserved.
KeepVowels
Returns a string with only the vowel characters.
PadLeft
Pads a string on the left with a specified character
PadRight
Pads a string on the right with a specified character
PrependLinesWithCharacter
Returns a string with the given number of a specific character prepended to the beginning of each line.
RegexReplace
Within the source input string, replaces strings that match a regular expression pattern with a specified replacement string.
RemoveCharacter
Removes a specified character from a string
RemoveCharacters
Deletes a specified numer of characters in a string starting an index position (0 origin)
RemoveLetters
Returns a string with any letter characters removed.
RemoveNumeric
Returns a string with any numeric characters removed.
RemoveRepeats
Returns a string with all characters repeated in a row removed.
RemoveSegment
Returns a string with the first occurence of the specified string segment removed.
RemoveVowels
Returns a string with any vowel character removed.
ReplaceFirstOccurence
Returns a string with the first occurence of the specified value replaced with a new value.
ReplaceLastOccurence
Returns a string with the last occurence of the specified value replaced with a new value.
ReplaceLeadingCharacters
Returns a string with the first given number of characters replaced with a new character.
ReplaceString
Replaces all occurences of an old string value with new string value
ReplaceTrailingCharacters
Returns a string with the last given number of characters replaced with a new character.
ReplaceWithEmptyString
Replaces all occurences of an old string value with an empty string value
ReverseCharacters
Returns a string with characters in reverse order.
Split
Gets a string by spliting a string and selecting from an index position (0 origin)
SplitWithCharacterLimit
Splits a string into an array each no longer than the given character limit and selecting from an index position in the result (0 origin).
Substring
Gets a substring from a string starting at an index position (0 origin)
SubstringOfLength
Gets a substring of a specified length from a string starting at an index position (0 origin)
SubstringOfRange
Returns a segment of a string, marked by the start and end index (exclusive).
SwapCases
Returns a string with the opposite letter casing for each character.
SwapCharacters
Returns a string the swapped characters at specified indices.
ToLowercase
Converts a string to lowercase
ToUppercase
Converts a string to UPPERCASE
TrimAll
Removes all whitespace from a string
TrimLeadingCharacters
Removes all leading occurences of a specified character from a string
TrimTrailingCharacters
Removes all trailing occurences of a specified character from a string
UrlDecode
Decodes a Url
UrlEncode
Encodes a Url
WordWrap
Returns a string that is no longer than the maximum width given in pixels. Excess words are moved to a new line.
Maintenance
PurgeLogEntries
The PurgeLogEntries activity is used for purging log entries from the project database
RefreshDataSource
This activity refreshes the metadata for a data source
RemoveDataSource
This activity removes the metadata for a data source
UnlockProjectRecords
This activity unlocks project records
Services
RunPowerShellScript
The RunPowerShellScript activity runs a PowerShell script
RunSSISPackage
The RunSSISPackage activity runs an SSIS package
StartService
The StartService activity starts a service on a server
StopService
The StopService activity stops a service running on a server
The Utility-FileSystem actions category includes the following modules and types:
Files
FileACLAddEntry
The FileACLAddEntry activity adds an Access Control List (ACL) entry to a file
FileACLRemoveEntry
The FileACLRemoveEntry activity removes Access Control List (ACL) entry from a file
FileCopy
Copies files from one location to another
FileDelete
The FileDelete activity deletes a file
FileFTPDownload
The FileFTPDownload activity downloads a file from an ftp site
FileFTPUpload
The FileFTPUpload activity uploads a file from an ftp site
FileMove
Moves a file from a source to a destination
FileUnzip
The FileZip activity unzips a file
FileZip
The FileZip activity zips a file
SaveValueInNewFile
The SaveValueInNewFile activity is used for saving field values to a file
Folders
DirACLAddEntry
The DirectoryAddACLEntry activity adds an Access Control List (ACL) entry to a directory
DirACLRemoveEntry
The DirectoryACLRemoveEntry activity removes an Access Control List (ACL) entry from a directory
DirCloseDirInfoSource
The DirectoryCloseDirectoryInfoSource activity closes the Directoryinfo source and frees up resources
DirCloseFileInfoSource
The CloseSourceFileFile activity closes the DirectoryFileInfo source and frees up resources
DirectoryCreate
The DirectoryCreate activity creates all the directories and subdirectories in the specified path
DirectoryDelete
The DirectoryDelete activity deletes a directory and its subdirectories if specified
DirectoryGetNextFileInfoRecord
The DirectoryACLRemoveEntry activity removes an Access Control List (ACL) entry from a directory
DirectoryInitializeDirectoryInfoSource
The DirectoryACLRemoveEntry activity removes an Access Control List (ACL) entry from a directory
DirectoryInitializeFileInfoSource
The DirectoryACLRemoveEntry activity removes an Access Control List (ACL) entry from a directory
DirectoryMove
The DirectoryMove activity moves a directory from a source to a destination
DirectoryZip
The DirectoryZip activity zips a directory
DirGetNextDirInfoRecord
The DirGetNextDirInfoRecord activity loads the next record from the specified list of selected Directoryinfo
The Cache condition category contains the following conditions:
Cache
IsCustomValueInCache
Evaluates if a specific custom value is in the cache
IsRecordInCache
Evaluates if a specific record exists in the cache
IsRecordKeyInCache
Evaluates if a specific Source record key is in the cache
appRules Conditions deliver a centralized and consistent approach for evaluating simple and complex conditions in all operations. The Conditions Editor is shown below:
To select a Condition type, simply navigate the condition tree and configure the properties for the selected type. Once a condition is created, it can be evaluated at any point in the running project by using the EvaluateCondition activity in the BaseActivities module or through other built-in access points in appRules.
The Results condition category contains the following conditions categorized as follows:
Action
ActionExecutionResult
The ActionExecutionResult condition is used for evaluating the result of the last execution of a specific action.
ActionResultInList
The ActionResultInList condition is used for evaluating whether the current result of executing a specific action is in a list.
IsActionExecutionErrorCountComparisonTrue
The IsActionExecutionErrorCountComparisonTrue condition is evaluated using the count of the number of errors that have occurred on the executions of a specific action.
IsActionExecutionSuccessCountComparisonTrue
The IsActionExecutionSuccessCountComparisonTrue condition is evaluated using the count of the number of successful executions of a selected action
IsActionExecutionTotalCountComparisonTrue
The IsActionExecutionTotalCountComparisonTrue condition is evaluated using the count of the total number of executions of a selected action
Activity
ActivityExecutionResult
The ActivityExecutionResult condition is used for evaluating the result of the last execution of a specific activity. This is typically used when looping through a list of records using the While activity.
ActivityExecutionResultInList
The ActivityResultInList condition is used for evaluating whether the current result of executing a specific activity is in a list.
IsActivityExecutionErrorCountComparisonTrue
The IsActivityExecutionErrorCountComparisonTrue condition is evaluated using the count of the number of errors that have occurred on the executions of a specific workflow activity.
IsActivityExecutionSuccessCountComparisonTrue
The IsActivityExecutionSuccessCountComparisonTrue condition is evaluated using the count of the number of successful results that have occurred on the executions of a specific workflow activity.
IsActivityExecutionTotalCountComparisonTrue
The IsActivityExecutionTotalCountComparisonTrue condition is evaluated using the count of the total executions of a specific workflow activity.
IsTargetRecordErrorCountComparisonTrue
The IsTargetRecordErrorCountComparisonTrue condition is evaluated using the count of the total number of errors that have occurred during record operations (insert, update, delete) on the target.
Condition
ConditionExecutionResult
The ConditionExecutionResult condition is used for evaluating the result of the last execution of a specific condition.
ConditionResultInList
The ConditionResultInList condition is used for evaluating whether the current result of executing a specific condition is in a list.
IsConditionExecutionErrorCountComparisonTrue
The IsConditionExecutionErrorCountComparisonTrue condition is evaluated using the count of the number of errors that have occurred on the executions of a specific condition.
IsConditionExecutionSuccessCountComparisonTrue
The IsConditionExecutionSuccessCountComparisonTrue condition is evaluated using the count of the number of successful executions of a selected condition
IsConditionExecutionTotalCountComparisonTrue
The IsConditionExecutionTotalCountComparisonTrue condition is evaluated using the count of the total number of executions of a selected condition
LastResult
LastExecutionResult
The LastExecutionResult condition is used for evaluating the last activity result. This is typically used when looping through a list of records using the While activity.
LastRecordAction
The LastRecordAction condition is used for evaluating the last executed record action. The action can be checked to see if it is Delete, Insert, Update or Undefined.
LastResultInList
The LastResultInList condition is used for evaluating whether the last activity execution is in a list.
The Custom condition category contains the following conditions:
Custom
Composite
Definition of conditions to be executed in sequence
Expression
The Expression action executes a simple expression (javascript). The expression must return a boolean
Function
Executes a .Net custom function and returns a boolean result
Script
The Script field action executes a script (javascript). The script must return a boolean.
appConnector Base Activities are made up the most commonly used activity modules in the appRules product suite.
appConnector Base Activities
The Control Flow activities module provides activities for controlling flow of execution within your project.
Control Flow Activities
Note that while activities such as the Parallel and schedule multiple child activities for execution simultaneously, only a single thread is used for a workflow. Each child activity of these activities executes sequentially and successive activities do not execute until previous activities either complete or go idle. As a result, these activities are most useful for applications in which several potentially blocking activities must execute in an interleaved fashion. If none of the child activities of these activities go idle, a Parallel activity executes just like a Sequence activity.
The table below shows the activities in the Control Flow activities module and their key properties.
Activity
Description
FlowDecision
If
Parallel
Sequence
While
Switch
The appRules Base activities module includes activities that are used for initializing your project, closing the project, executing functions, calling other projects and more.
The table below shows the activities in the appRules Base module including their key properties.
Activity
Description
CallWebService
This activity is used to make a webservice call.
Delay
This activity is used to delay the workflow execution.
ExecuteCustomCode
Executes a custom function, expression or script
ExecuteConditionCode
Executes a condition function, a condition expression or a condition script.
ExecuteWorkflow
This activity executes a workflow WorkflowName The name of the project to execute Parameters Parameters to pass to the workflow. Parameters must match the workflow arguments. SaveResultIn If the job returns a value, this specifies where to save the returned value.
MapAndSaveRecords
Most appConnector activity modules contain a mapping activity. For example, the MapAndSetFields in the File module maps file fields to be saved to file. The MapAndSaveRecords activity is a generic mapping activity for bulk-loading of records since it automatically inserts all Source records into the Target. The āSQL -- Batch Export to Fileā project in the Samples database demonstrates the use of this activity
SendEmail
This activity is used for sending an email to one or more recipients. You can also use this activity to send bulk emails. FromEmail The Email address that will be used for sending the email FromName Optionally, the name to use for sending the email ReplyTo The ReplyTo email address Subject The subject of the email To Recipients of the email BCC The blind carbon copy recipients of the email CC The carbon copy recipients of the email. Body The body of the email. This can be defined using Text or Html.
SetValues
TransformValues
UpdateWorkflowState
This is an optional activity for updating the current state of a running job -- normally this is done automatically.
WriteLogEntry
This is an optional activity for logging entries in the project database: LogEntryType The type of entry to be logged DataSourceRecord, DataSourceStatistics, Error, Message, Warning, or SelectedValues LogText The message to display if LogEntryType is Message DataManager Specifies the Source or Target if LogEntryType is DataSourceRecord, DataSourceStatistics or SelectedValues. SelectedValues Values to log if LogEntryType is SelectedValues
The appConnector Dialogs activities module contains activities for entering or viewing values during runtime or test runs of your project.
The table below shows the activities in the Dialogs module. The activities display the values when the project is run. Viewers activities are displayed when the workflow is run in debug mode.
Activity
Description
EditRecord
Edit the content of a source or target record (et with a InitializeSource a LookupRecord or a InitializeTarget activity)
EditWorkflowValues
Edit preselected workflow values (Arguments, Variables, Datafields (from source or target)
MessageBox
Shows a Message Box that can display workflow values or constants If Cancel clicked = ends execution, if Yes or OK Clicked returns Valid, If No Clicked returns Invalid
ShowDialog
Calls an external assembly that displays the dialog
ViewRuntimeArguments
Displays the workflow arguments values.
ViewRuntimeValues
Displays a selected set of values (can be datafields, arguments, variablesā¦)
ViewRuntimeStatistics
Displays the Source and Target stats (Read, Update. Insert, Delete)
The appConnector Record activities module contains activities for managing the data field values of active records of Source and Target activities in your project. The module also contains the generic GetNextPreloadedRecord activity which can be used to get the next record from a preloaded list of records.
The table below shows the activities in the appConnector Record module including their key properties.
Activity
Description
ClearRecord
Removes the field values of the active record of a Source or Target.
CopyRecord
Copy a record from one Source or Target to another.
FormatFields
This activity formats the field values of a Source or Target record.
GetNextPreloadedRecord
Gets the next record from a preloaded list of records in a Source activity.
InitializeRecordFromCustomValues
Initialize a target record with preset values
InitializeRecordFromDelimitedString
Initialize target records from file records
InitializeRecordFromFunction
Initialize target records with a custom function
UnformatFields
This activity removes all formatting from the field values of a Source or Target record.
ValidateRecord
This activity validates the fields in a Source or Target record.
The appConnector List activities module contains activities for creating ad-hoc lists that can be used in the project. This module also contains activities for managing pick lists that are created in the metadata for systems such as Dynamic CRM, Salesforce.com and others.
The table below shows the activities in the appConnector List module including their key properties.
Activity
Description
InitializeList
This activity used for defining the list (table). A list can be typed directly or can be loaded from a CSV file (see below) FieldNames Used for specifying the column names of the list Each list contains a uniquekey field and n columns (indicated in the NumberOfFields property) ListEntries Click to display the List creation/update window LoadFirstListItem Check this option in order to preload the first record of the list InitializeFromCsvFile Use this option to load the list from a CSV file.
InitializeListFromCustomValues
Initializes a list from custom values.
InitializeListFromDelimitedString
Initializes a list from a delimited string.
InitializeListFromFunction
Initializes a list from a custom function. The function must return list values in List<string>
CloseList
Closes an open list defined by an InitializeList activity
LookupList
To Lookup a list record List The InitializeList source to lookup ListFilters Collection of filters to query the list records to load ValueNotFoundAction Specifies the action to perform if no record is found ContinueWorkflow: Continues running the process LogNotFoundError: Logs a āRecordNotFoundā error ExecuteFunction: Executes an extension function ValueNotFoundFunction Specifies the function to execute if the List item is not found
GetNextListItem
Gets the next List item as a record that can be used in the project
IsPickListValueValid
Checks to see if a PickList Value is valid
LookupPickListRecord
Looks up a picklist record
GetNextListItem
Gets the next list item as a record when iterating a list
IsPickListValueValid
Validates if a picklist value is valid
IsValueInCustomValuesList
Checks to see if a value is in a custom values list
IsValueInDelimitedStringList
Checks to see if a value is in a delimited string list
IsValueInFunctionList
Checks to see if a value is in a function list
LookupPickListRecord
Looks up a picklist as a record
The Records condition contains the following conditions categorized as follows:
The Fields condition category contains the following conditions categorized as follows:
FlowChart Activity with Yes/No branches based on a Condition
Condition Activity which models an If-Then-Else action
Executes all child activities simultaneously and asynchronously.
Executes a set of child activities according to a single, defined ordering.
Executes a contained set of workflow elements while a condition evaluates to true.
Executes a contained set of activities depending on a value (can be a datafield read in a source, a variable, a parameter value)
This activity sets selected values (source datafields, variablesā¦) in the project to new values. The window below shows the properties of the collection items:
This activity transforms the values specified in a collection using the available transformation options (using preset transformations for strings, dates, numeric values or custom functions).
AuditLog
IsRetrievedRecordIdInAuditLog
Evaluates if a retrieved source record Id is in the AuditLogs table
Source
IsPreloadedRecordsCountComparisonTrue
Executes a condition based on the number of records in a preloaded records activity. Note: The number can fluctuate based on the actions performed on the list
IsQueryCountComparisonTrue
The IsQueryCountComparisonTrue condition is executed by comparing the number of records in a SQL select count statement to a specific numeric value using operators including EqualTo, NotEqualTo, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, etc. Note: You can use SQL Select statement for all supported data sources.
IsRecordsSelectedCountComparisonTrue
IsRecordsSelectedCountComparisonTrue
SourceRecordExists
The SourceRecordExists condition evaluates if a specific data record exists. The supported record types include data source, preloaded, list and picklist records.
SourceRecordRead
The SourceRecordReadCondition condition is used for evaluating whether a record was successfully read from a Source.
Target
IsRecordsDeletedCountComparisonTrue
Executes a condition based on the number of records that have been deleted by a Target activity.
IsRecordsInsertedCountComparisonTrue
IsRecordsInsertedCountComparisonTrue
IsRecordsSkippedCountComparisonTrue
IsRecordsSkippedCountComparisonTrue
IsRecordsUpdatedCountComparisonTrue
IsRecordsUpdatedCountComparisonTrue
TargetLastRecordAction
The LastRecordActionCondition condition is used for evaluating the last record action of a specific Target activity. The action can be checked to see if it is Delete, Insert, Update or Undefined.
TargetRecordSaved
The TargetRecordSavedCondition condition is used for evaluating whether a record was successfully saved to a Target.
Boolean
BooleanValueHasData
Evaluates if a boolean value contains data.
IsBooleanComparisonTrue
The IsBooleanComparisonTrue condition compares two boolean field values using operators including EqualTo and NotEqualTo.
IsBooleanValueTrue
The IsBooleanValueTrue condition checks if a boolean value evaluates to true.
IsValidBoolean
The IsValidBoolean condition checks if a field is a valid boolean.
DateTime
DateTimeValueHasData
Verifies if a datetime field (string, datafieldvalue, argument, etc.) contains data.
IsDateBirthdayOrRenewalDate
Indicates whether a date is a birthday or annual renewal date
IsDateFirstDayOfCalendarYear
Evaluates if a date is the first day of a calendar year
IsDateFirstDayOfFiscalYear
Evaluates if a date is the first day of a fiscal year
IsDateFirstDayOfFiscalYearQuarter
Evaluates if a date is the first day of a fiscal year quarter
IsDateFirstDayOfMonth
Evaluates if a date is the first day of a month
IsDateInCalendarYear
Evaluates if a date value is in a specific calendar year
IsDateInFiscalYear
Evaluates if a date value is in a fiscal year
IsDateInFiscalYearQuarter
Evaluates if a date is in a fiscal year quarter
IsDateInLeapYear
Evaluates if a date is in a leap year
IsDateLastDayOfCalendarYear
Evaluates if a date value is last day of a calendar year
IsDateLastDayOfFiscalYear
Evaluates if a date is the last day of a fiscal year
IsDateLastDayOfFiscalYearQuarter
Evaluates if a date value is the last day of a fiscal year quarter
IsDateLastDayOfMonth
Evaluates if a date value is the last day month
IsDateOverdueForAging
Evaluates if a date is overdue for 30-60-90-120 day aging.
IsDateTimeComparisonTrue
The DateTimeComparison condition is executed by comparing a date/time value to another using operators including EqualTo, NotEqualTo, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, etc.
IsDateWeekDay
Evaluates if a date falls on a week day.
IsDateWeekEndDay
Evaluates if a date falls on a weekend.
IsNumberOfDaysComparisonTrue
Evaluates if the number of days in a starting and ending datetime periods meets a specified condition.
IsNumberOfHoursComparisonTrue
Evaluates if the number of hours in a starting and ending datetime periods meets a specified condition.
IsNumberOfMinutesComparisonTrue
Evaluates if the number of minutes in a starting and ending datetime periods meets a specified condition.
IsNumberOfSecondsComparisonTrue
Evaluates if the number of seconds in a starting and ending datetime periods meets a specified condition.
IsNumberOfYearsComparisonTrue
Evaluates if the number of years in a starting and ending datetime periods meets a specified condition.
IsValidDateTime
Evaluates if a value is a valid datetime
IsValidUnixTime
Evaluates if a value is a valid Unix time
Numeric
IsCounterInRange
Evaluates whether a counter is in range - (between the starting and ending values defined in the InitializeCounter action)
IsCounterValueComparisonTrue
Evaluates whether a the current value of a counter meets a specified condition
IsNumericComparisonTrue
IsNumericComparisonTrue
IsRunningTotalComparisonTrue
Evaluates whether a the current value of a runnint total meets a specified condition
IsValidNumericValue
Tests if a numeric value is valid
NumericValueHasData
The NumericValueHasData condition evaluates if a numeric field contains data.
String
Contains
The Contains condition checks to see if a string is contained in another.
EndsWith
The EndsWith condition checks to see if an input string value ends with a specific string value.
EqualTo
The EqualTo condition checks to see if a string is equal to another string.
HasDuplicateCharacters
Indicates whether a string contains at least two of any character
HasNumeric
Indicates whether a string contains any numeric characters
HasRepeats
Indicates whether a string contains any character repeated in a row more than once
HasVowels
Indicates whether a string contains any vowel letters
IsAlphaNumeric
Indicates whether a string is composed of only letter and number characters.
IsAlternateCases
Indicates whether the letter casing in a string is alternating
IsCapitalized
Indicates whether the first character in a string is upper case
IsComparisonTrue
The IsComparisonTrue condition is executed by comparing a string to another using operators including Contains, EndsWith, EqualTo, StartsWith, etc.
IsEmailAddress
Indicates whether a string is in a valid email address format
IsInDelimitedString
The IsInDelimitedString condition is evaluated by checking to see if a string value exists in a delimiter-separated list
IsInPickList
The IsInPickList condition is evaluated by checking to see if a string value exists in a PickList or OptionSet
IsLengthComparisonTrue
The IsLengthComparisonTrue condition is executed by comparing the length of a string to another using operators including EqualTo, NotEqualTo, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo
IsLetters
Indicates whether a string is composed of all letter characters.
IsLowerCase
Indicates whether a string is in all lower case
IsMultiline
Indicates whether a string contains multiple lines
IsNullOrEmpty
Indicates whether a string value is null or empty
IsNumeric
Indicates whether a string is composed of only numeric characters.
IsPalindrome
Indicates whether a string is a palindrome.
IsRegexMatch
The IsRegexMatch condition is executed by matching a specified string value against a text pattern defined with a regular expression (regex).
IsRepeatedChar
Indicates whether a string is composed of only a single character value
IsSpaces
Indicates whether a string is all spaces
IsStringCountComparisonTrue
Condition is executed by comparing the total number of times a given sequence appears in a string using operators including EqualTo, NotEqualTo, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo
IsTitle
Indicates whether a string is formatted like a title, ie the first chracter of each word is capitalized. Words must be separated by spaces
IsUpperCase
Indicates whether a string is in all upper case
IsUrl
Indicates whether a string is a valid Url
StartsWith
The StartsWith condition checks to see if an input string value starts with a specific string value.
The Workflow condition category contains the following conditions categorized as follows:
Instance
IsCurrentInstanceElapsedTimeComparisonTrue
Evaluates if the number of seconds in the elapsed time of the current workflow instance meets a specified condition.
WorkflowInstanceState
The WorkflowInstanceState condition is used for evaluating the state of an instance of a specific project job.
Services
IsCpuUtilizationComparisonTrue
The IsCpuUtilizationComparisonTrue condition is used for evaluating the CPU utilization percent of a machine.
IsDiskUtilizationComparisonTrue
The IsDiskUtilizationComparisonTrue is used for evaluating the disk utilization percent of a machine.
IsHostAvailable
The IsHostAvailable condition evaluates host availability by pinging the host with an ICMP message to see if it is available.
IsRemoteProcessRunning
The IsRemoteProcessRunning condition evaluates whether a process is running on a remote machine
IsServiceRunning
The IsServiceRunning condition evaluates whether a service is running
IsUrlAvailable
The IsUrlAvailable condition evaluates whether a Url is available
The FileSystem condition contains the following conditions categorized as follows:
Files
FileExists
The FileExists condition evaluates if a specific file exists.
FileNameHasExtension
The HasExtension condition evaluates if a specific path includes a file name extension
IsFileCountComparisonTrue
The IsFileCountComparisonTrue condition evaluates the number of files in a folder. Operators include EqualTo, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, etc.
IsFileDateTimeComparisonTrue
The IsFileDateTimeComparisonTrue condition is executed by comparing a file's datetime value to a specific date using operators including EqualTo, NotEqualTo, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, etc.
IsFileExtensionComparisonTrue
The IsFileExtensionComparisonTrue condition is executed by comparing a the file extension component of a file path to a string using operators including Contains, EndsWith, EqualTo, StartsWith, etc.
IsFileExtensionRegexMatch
The IsFileExtensionRegexMatch condition is executed by matching the file extension against a text pattern defined with a regular expression (regex).
IsFileNameComparisonTrue
The IsFileNameComparisonTrue condition is executed by comparing a the file name component of a file path to a string using operators including Contains, EndsWith, EqualTo, StartsWith, etc.
IsFileNameRegexMatch
The IsFileNameRegexMatch condition is executed by matching the file name against a text pattern defined with a regular expression (regex).
IsFileReadOnly
The IsFileReadOnly condition evaluates if a file is read only
IsFileSizeComparisonTrue
The IsFileSizeComparisonTrue condition is executed by comparing a file's size value to a specific value using operators including EqualTo, NotEqualTo, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, etc.
Folders
FolderExists
The FolderExists condition evaluates if a specific folder exists.
IsFolderCountComparisonTrue
The IsFolderCountComparisonTrue condition evaluates the number of folders in a folder. Operators include EqualTo, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, etc.
IsFolderDateTimeComparisonTrue
The IsFileDateTimeComparisonTrue condition is executed by comparing a file's access datetime value to a specific date using operators including EqualTo, NotEqualTo, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, etc.
IsFolderNameComparisonTrue
The IsFolderNameComparisonTrue condition is executed by comparing a the folder name component of a path to a string using operators including Contains, EndsWith, EqualTo, StartsWith, etc.
IsFolderNameRegexMatch
The IsFolderNameRegexMatch condition is executed by matching the folder name against a text pattern defined with a regular expression (regex).
IsFolderSizeComparisonTrue
The IsFolderSizeComparisonTrue condition is executed by comparing a folder's size value to a specific value using operators including EqualTo, NotEqualTo, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo, etc.
The appRules Base activities module includes activities that are used for initializing your project, closing the project, executing functions, calling other projects and more.
The table below shows the activities in the appRules Base module including their key properties.
Activity
Description
CallWebService
This activity is used to make a webservice call.
Delay
This activity is used to delay the workflow execution.
EvaluateCondition
Evaluates a Condition
PerformAction
Perform a specific action
ExecuteWorkflow
This activity executes a workflow WorkflowName The name of the project to execute Parameters Parameters to pass to the workflow. Parameters must match the workflow arguments. SaveResultIn If the job returns a value, this specifies where to save the returned value.
SendEmail
This activity is used for sending an email to one or more recipients. You can also use this activity to send bulk emails. FromEmail The Email address that will be used for sending the email FromName Optionally, the name to use for sending the email ReplyTo The ReplyTo email address Subject The subject of the email To Recipients of the email BCC The blind carbon copy recipients of the email CC The carbon copy recipients of the email. Body The body of the email. This can be defined using Text or Html.
SetValues
UpdateWorkflowState
This is an optional activity for updating the current state of a running job -- normally this is done automatically.
WriteLogEntry
This is an optional activity for logging entries in the project database: LogEntryType The type of entry to be logged DataSourceRecord, DataSourceStatistics, Error, Message, Warning, or SelectedValues LogText The message to display if LogEntryType is Message DataManager Specifies the Source or Target if LogEntryType is DataSourceRecord, DataSourceStatistics or SelectedValues. SelectedValues Values to log if LogEntryType is SelectedValues
WriteAuditLogsEntry
This activity logs an entry in the AuditLogs table
appConnector Base Activities are made up the most commonly used activity modules in the appRules product suite.
appConnector Base Activities
The Base Data activities module provides activities for generalized data access in your project.
Base Data Activities
The table below shows the activities in the Base Data Activities module and their key properties. The Base Data activities can be applied to all data sources defined in the current project.
ClearRecord
This activity clear the current record content of a selected source or target
CloseSource
This activity closes a selected source
CloseTarget
This activity closes a selected target
CopyRecord
This activity copies the record content from the specified source to the specified target (source and target must have the same data definition)
DeleteRecord
This activity deletes a target record(s) based on a filter defined
ExecuteSQLScript
Execute a SQL script on a specific target
ExecuteStatements
Execute a SQL statement on a specific datasource
ExecuteStoredProcedure
Execute a storedprocedure of a specific datasource
InitializeSource
Initialize a datasource table/entity for reading
InitializeTarget
Initialize a datasource table/entity for Insert/Update/Delete
GetNextRecord
Read the next record of an InitializeSource loading multiple records.
InitializeSourceList
Creates and read an organized list of values (can be set from a csv file or adhoc (activity preset))
InitializeTargetFile
Initialize a text/csv file target
LookupRecord
This activity is used to lookup a record based on filters (example: loads the company record from a company table based on the contact table companyid field)
MapAndSaveRecords
Maps and Save multiple records in a target based on the source content.
MapRecordsFields
Maps the target fields from multiple sources (records, variables, transformedfields etc)
PerformRecordListAction
Perform a specific action on a preloaded list of records
SaveRecord
Save a specific target record (Insert,Update,Upsert,Skipsert)
appConnector Base Activities are made up the most commonly used activity modules in the appRules product suite.
appConnector Base Activities
The Control Flow activities module provides activities for controlling flow of execution within your project.
Note that while activities such as the Parallel and Sequence schedule multiple child activities for execution simultaneously, only a single thread is used for a workflow. Each child activity of these activities executes sequentially and successive activities do not execute until previous activities either complete or go idle. As a result, these activities are most useful for applications in which several potentially blocking activities must execute in an interleaved fashion. If none of the child activities of these activities go idle, a Parallel activity executes just like a Sequence activity.
The table below shows the activities in the Control Flow activities module and their key properties.
Activity
Description
FlowDecision
If
Parallel
Sequence
While
Switch
Start
Optional activity to set the starting point of the workflow. If not used, the staring point is the first activity of the workflow.
Redirect
Redirect the flow to a specific activity of the workflow (optionnally based on a condition)
The appConnector Dialogs activities module contains activities for entering or viewing values during runtime or test runs of your project.
The table below shows the activities in the Dialogs module. The activities display the values when the project is run. Viewers activities are displayed when the workflow is run in debug mode.
Activity
Description
EditRecord
Edit the content of a source or target record (et with a InitializeSource a LookupRecord or a InitializeTarget activity)
EditWorkflowValues
Edit preselected workflow values (Arguments, Variables, Datafields (from source or target)
DisplayMessageBox
Shows a Message Box that can display workflow values or constants If Cancel clicked = ends execution, if Yes or OK Clicked returns Valid, If No Clicked returns Invalid
PromptForValue
Prompt the user for a value
ViewRuntimeRecords
Displays the current record (from all the sources and targets or from a selected one)
ViewRuntimeValues
Displays a selected set of values (can be datafields, arguments, variablesā¦) and a selected record (source or target)
ViewRuntimeStatistics
Displays the Source and Target stats (Read, Update. Insert, Delete)
This activity sets selected values (source datafields, variablesā¦) in the project to new values. The window below shows the properties of the collection items:
FlowChart Activity with Yes/No branches based on a Condition
Condition Activity which models an If-Then-Else action
Executes all child activities simultaneously and asynchronously.
Executes a set of child activities according to a single, defined ordering.
Executes a contained set of workflow elements while a condition evaluates to true.
Executes a contained set of activities depending on a value (can be a datafield read in a source, a variable, a parameter value)
The creator of an appRules project database (Admin) is given full access to the project database. All other users must be added to the user list.
To add, change, or delete users from your project database list, select Users from the appRules Home Page:
You can add and change users as required. Once added, users can also change their Startup Project and Designer Settings.
appRules utilizes data source metadata extensively. This metadata is generated and maintained in Data Source settings which is accessible from the Settings menu of the appRules home page.
The following are the toolbar buttons available for the currently selected data source:
The following are the tab pages available for the currently selected data source:
NB: a user is associated to a specific value that determines the environment in which the projects will be run (example: Test, Production, PreProd....)
New
Adds a new data source.
Copy
Adds a new data source by copying it from this or a different project database.
Browse
Browse data sources.
Test
Test the connection of the selected data source.
Settings
View and edit default data source connection settings
Refresh Metadata
Connect to data source to regenerate the data source metadata.
Secure
Secure the data source settings with a password.
Remove
Removes the selected data source settings
Logs/Stats
View Logs and Statistics for all run instances of the project.
Reset
Resets archive records and status flags for the selected project
Description
Basic description of the data source settings
Entities
View and edit entities of the selected data source including primary keys, foreign keys, pick lists, etc.
Runtime Settings
View and edit connection settings for specific runtime settings.
Pick Lists
View and edit picklists for the selected data source settings.
Before using a data source, the connection to it must be configured by creating a connection string. To create the connection string for the data source which can then be used as a Source or Target, follow the instruction below:
Select Connections from the Settings menu.
Click the New toolbar button to select a connector and enter a name for the data source.
Configure the properties of the connection string by entering values when prompted and selecting available options.
Test the connection.
Use the Save toolbar button to save the connection definition.
The following toolbar buttons are available on the property grid for completing tasks:
Collapse
Collapse all categories in the property grid
Expand
Expands all categories in the property grid
Defaults
Returns to default category settings
Clear
Clears the properties and returns to default settings
Copy
Copies the connection settings from a different data source of the same type
Settings & Parameters
Displays the Settings & Parameters dialog for configuring additional data source options and defining and executing OAuth setup procedures.
Test Connection
Tests the connection and displays a message indicating the result.
Help
Displays help information
Runtime Settings associated to the user running the appRules project,
Runtime Settings are used throughout the system to determine the behavior of system operations at design time and also at runtime. This is a powerful feature that allows you to pre-configure the environments for running the projects that you will be composing and orchestrating.
To view, add, update, and delete Runtime Settings, select it from the Settings menu of the appRules HomePage.
When a new project database is created, the system automatically adds the following Runtime Settings into your project database as a starting point:
Runtime Setting
Description/Usage
Default
This is the default Runtime Setting that is assigned when you do not choose a specific one. You can also use this as your main runtime setting if you are working on a small or medium sized project where the same computer will be used for development, testing and deployment. The Default runtime setting is required by the system.
Development
If your organization follows the normal Development, Test, Production cycle, you can use Development when you are developing your projects. In this case you will set your connection strings, web service login credentials etc. to your development computer/environment.
Test
If you will be using a Test bed you can use this runtime setting for testing.
Production
This is the out-of-the-box Runtime Setting for your production environment. You can add to it or you can create a brand new one to suit your needs.
To Add a RunTimeSetting, click the āNewā button; enter the field values and click the āSaveā button to add the new record to the project database.
To Change or Update a RuntimeSetting, select the specific entry in the Setting Name list, make changes to the field values and click the āSaveā button to update the values.
To Delete a RuntimeSetting select the specific entry and click the āRemoveā button to remove the record from the project database.
Default Culture
Determine the culture that will be used when running the workflows or validating data (when the user running the workflow is associated to this RuntimeSettings) . For example, if the en-US culture is selected, the dates handled will be in US format (Date in MM/DD/YY). When using Dynamics CRM datasource for example, the option set names displayed when querying the data will be the US ones.
If the Default Culture is set to 'Default', System culture will be used.
Caching Option
Specify the cache engine used when running in the specified environment (Redis or Internal, if Redis specify the connection string (installed by default by the appRules Setup))
Optional Runtime Fields
Define optional runtime variables and values associated to the current RunTimeSetting. For example, the default file path for all files used in a project can have different values when a project is launched in a Production or Test environment.
Before using a data source in appRules, the metadata must be generated. Metadata is created when you add a new data source and select the connection associated or when you specifically 'Regenerate Metadata' on the toolbar.
A Datasource can have different connection associated for each environment (Test, Production...) but the Metadata is unique. If your environnements metadata models are different, define several datasources.
To generate metadata, first configure the and click the 'Create Metadata button' or Refresh metadata (when the datasource already exists) to continue.
The environments are defined in the section.
How to set a proper datasource connection string to authenticate and connect (choose your connector category and type below)
QuickBooks Online uses the OAuth authentication standard. You can use the Embedded Credentials (see below) to connect without setting any connection properties. When you connect, the provider opens the OAuth endpoint in your default browser. Simply log in and grant permissions to the application. The provider then completes the OAuth process.
Alternatively, you can create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.
To obtain the access token, set the following connection properties:
CompanyId: The unique identifier of a given company in QuickBooks Online.
OAuthClientId: The consumer key in your app settings.
OAuthClientSecret: The consumer secret in your app settings.
CallbackURL: The Launch URL in your app settings.
You can connect without setting any connection properties for your user credentials. After setting InitiateOAuth to GETANDREFRESH, you are ready to connect.
When you connect, the provider then completes the OAuth process.
Extracts the access token from the callback URL and authenticates requests.
Obtains a new access token when the old one expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
The provider makes requests to QuickBooks through the Remote Connector. The Remote Connector runs on the same machine as QuickBooks and accepts connections through a lightweight, embedded Web server. The server supports SSL/TLS, enabling users to connect securely from remote machines. The first time you connect, you will need to authorize the provider with QuickBooks.
The Remote Connector can be used to read and write to QuickBooks in situations where direct COM access to QuickBooks is not available (e.g., ASP.NET, Java, or QuickBooks on a remote machine). Follow the procedure below to connect to QuickBooks for the first time through the Remote Connector:
If you have not already done so, download the Remote Connector from remoteconnector.com and install the Remote Connector on the machine where QuickBooks is installed.
Open the company file you want to connect to in QuickBooks using an administrator account in single-user mode.
Open the Remote Connector from the system tray and add a user on the Users tab. Enter a User and Password and select the level of access in the Data Access menu.
Note: The Remote Connector does not use the User and Password properties to access QuickBooks; the User and Password properties authenticate the user to the Remote Connector. Authentication to QuickBooks is handled based on the ApplicationName property.
When you first connect, a dialog will appear in QuickBooks prompting you to authorize the application. After authorizing the application, you can then execute commands to QuickBooks. Specify the URL of the Remote Connector and the User and Password. By default, the Remote Connector connects to the currently open company file.
If you want to access QuickBooks when QuickBooks is not running, save the company file information for the user. The Remote Connector will then automatically open QuickBooks in the background with the company file for that user.
Note that if the QuickBooks UI is open, you can only connect to that company file. Additionally, note that the user permissions you run the Remote Connector under must match the user permissions you run QuickBooks under. The Remote Connector installation process installs the Remote Connector as a service under the current user account.
You can enable SSL/TLS on the Advanced tab.
You will also need to send your public key certificate to the provider. You can do so by setting the SSLServerCert property.
Follow the steps below to authorize with QuickBooks and connect to a company file when both QuickBooks and the provider are running on your local machine.
Open QuickBooks as an administrator and open the company file you want to connect to.
Connect to QuickBooks. A dialog will appear in QuickBooks prompting you to authorize the provider. After granting access to the provider, you can now execute commands to QuickBooks.
If you want to connect to the company file when QuickBooks is closed, set the CompanyFile connection option when you execute commands. QuickBooks will open automatically in the background with the file specified.
Note that if QuickBooks is open through the application UI, only that CompanyFile can be used.
To obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret, follow the steps below:
If you have not already done so, create an Exact Online developer account.
Log into the App Center and click Manage Apps -> Add a New Application.
Enter the app name to be displayed to users when they are prompted to grant permissions to your app.
Set the Redirect URI to a page you would like the user to be returned to after they have granted your application permissions.
Click the Edit button for your app. The client credentials, the client Id and client secret, are displayed.
Set these OAuth credentials in the datasource definition, in addition to Division and Region.
To obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret, follow the steps below:
If you have not already done so, create an Exact Online developer account.
Log into the App Center and click Manage Apps -> Add a New Application.
Enter the app name to be displayed to users when they are prompted to grant permissions to your app.
Set the Redirect URI to a page you would like the user to be returned to after they have granted your application permissions.
Click the Edit button for your app. The client credentials, the client Id and client secret, are displayed.
Set these OAuth credentials in the datasource definition, in addition to Division and Region.
The provider supports the following Xero APIs:
Accounting API: Set the Schema connection property to ACCOUNTING
Australian Payroll API: Set the Schema connection property to PAYROLLAUS
Files API: Set the Schema connection property to FILES
Fixed Assets API: Set the Schema connection property to ASSETS
Projects API: Set the Schema connection property to PROJECTS
By default the provider authenticates to Xero using OAUTH2
You will need to create an OAuth application and set InitiateOAuth to GETANDREFRESH to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
Follow the steps below to register a public application and obtain the OAuthClientId and OAuthClientSecret.
Log in to the Xero developer portal.
Click My Apps -> Add Application. Choose the Auth Code application type.
Enter a name for your application and the URL of your company. This information is displayed to users when they connect.
Set the Redirect URI to the full redirect or callback URL, where the user returns with the token that verifies that they have granted your app access.
When connecting using OAUTH2, Xero grants the provider access to all of the organizations that the user has authorized. By default the provider will connect using the first available organization. Since this default changes as you authorize new organizations, it is recommended that you set the Tenant connection property to ensure future connections always use the same organization.
The Tenant property can be set to either the name or ID of a Xero organization.
The Xero API has usage limitations that may be encountered while using the Provider for Xero.
There is a daily limit of 5000 API calls against a single Xero organization in a rolling 24-hour period.
In addition to the daily limit, a single access token can only be used up to 60 times in a rolling 60-second period.
If you encounter a rate limit, the Xero API will return an HTTP 503 (Service Unavailable) error, with the following message: "oauth_problem=rate limit exceeded".
Note: If you encounter a rate limit, do not continue to make requests, as this may continue to add to your limitation. If necessary, you may need to queue requests.
When working with the provider, some operations may result in multiple requests to the API. For example, updating an existing record will result in two requests: one to get the current record, and one to submit changes.
The provider makes requests to QuickBooks POS through the QuickBooks Gateway. The QuickBooks Gateway runs on the same machine as QuickBooks POS and accepts connections through a lightweight, embedded Web server. The server supports SSL/TLS, enabling users to connect securely from remote machines. The first time you connect, you will need to authorize the provider with QuickBooks POS. For more information, refer to our Using the QuickBooks Gateway section below.
To work with your data in practice mode, set QBPOSPractice. Additionally, set QBPOSVersion.
Follow the steps below to authorize with QuickBooks POS and connect to a company file when both QuickBooks POS and the provider are running on your local machine.
Open QuickBooks POS as an administrator and open the company file you want to connect to.
Connect to QuickBooks POS. A dialog will appear in QuickBooks POS prompting you to authorize the provider. After granting access to the provider, you can now execute commands to QuickBooks POS.
If you want to connect to the company file when QuickBooks POS is closed, set the CompanyFile connection option when you execute commands. QuickBooks POS will open automatically in the background with the file specified.
Note that if QuickBooks POS is open through the application UI, only that CompanyFile can be used.
If you receive a connection error (such as "Internal error 160002") you may need to switch QuickBooks POS to multiuser mode. This is done by selecting the "Switch Company File to Multi User Mode" option in the File Menu. You should then be able to connect to the company file.
If a CompanyFile is not specified in the connection string, QuickBooks POS may present an "Enter Company Name" window the first time you connect. In this window, you must specify the company file and the computer name where the company file is located.
The QuickBooks Desktop Gateway can be used to read and write to QuickBooks POS in situations where direct COM access to QuickBooks POS is not available (e.g., ASP.NET, Java, or QuickBooks POS on a remote machine). Follow the procedure below to connect to QuickBooks POS for the first time through the Desktop Gateway:
Open the company file you want to connect to in QuickBooks POS using an administrator account in single-user mode.
Open the QuickBooks Desktop Gateway from the system tray and add a user on the Users tab. Enter a User and Password and select the level of access in the Data Access menu.
Note: The QuickBooks Desktop Gateway does not use the User and Password properties to access QuickBooks POS; the User and Password properties authenticate the user. Authentication to QuickBooks POS is handled by the ApplicationName property.
When you first connect, a dialog appears in QuickBooks POS prompting you to authorize the application. After authorizing, you can execute commands to QuickBooks POS. Specify the URL of the Desktop Gateway and the User and Password. By default, the Gateway connects to the currently open company file.
If you want to access QuickBooks POS when QuickBooks POS is not running, save the company file information for the user. The Desktop Gateway automatically opens QuickBooks POS in the background with the company file for that user.
NOTE: that if the QuickBooks POS UI is open, you can only connect to that company file. Additionally, the user permissions you specify for the Desktop Gateway must match the user permissions you used for QuickBooks POS. The Desktop Gateway installs as a service in the current user account.
You can enable SSL/TLS on the Advanced tab.
You will also need to send your public key certificate to the provider. You can do so by setting the SSLServerCert property.
If you have not already done so, download the QuickBooks Desktop Gateway from and install it.
FreshBooks uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.
See below
There are two methods you can use to connect to the FreshBooks Classic API, the authentication token specific to your login or OAuth 1.0. The authentication token method is deprecated and will not be supported by FreshBooks in the future.
To connect to FreshBooks using an authentication token, specify the CompanyName and Token connection properties. The token can be found by logging in to FreshBooks and navigating to My Account > FreshBooks API.
OAuth requires the authenticating user to interact with FreshBooks using the browser. The provider facilitates this in various ways as described in the following sections.
To obtain the OAuth client credentials:
Request Developer Access through FreshBooks, if you have not already done so.
Select My Account > FreshBooks API.
Select the Use OAuth option and enter the application details. The details are displayed to users when they log in to grant permissions to the application. The OAuth consumer secret is displayed.
Note: It may take some time for FreshBooks to approve your registration.
After setting the following connection properties, you are ready to connect:
OAuthClientId: Set this to the name of the company you are connecting to. Note that you can also use the CompanyName.
OAuthClientSecret: Set this to the consumer secret in your app settings.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the access token in the connection string.
When you connect, the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the following OAuth process:
Retrieves the OAuthAccessToken and OAuthAccessTokenSecret and authenticates requests.
Refreshes the OAuthAccessToken when it expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
To obtain the access token, set the following connection properties and follow the steps below:
OAuthClientId: Set this to the name of the company you are connecting to. Note that you can also use the CompanyName property.
OAuthClientSecret: Set this to the consumer secret in your app settings.
To connect to data, set the following connection properties:
CompanyName
OAuthClientSecret
OAuthAccessToken
OAuthAccessTokenSecret
To automatically refresh the access token when it expires, set InitiateOAuth to REFRESH and set OAuthRefreshToken.
Use the OAuth 2.0 authentication standard to authenticate to the FreshBooks Alpha APIs.
OAuth requires the authenticating user to interact with FreshBooks using the browser. The provider facilitates this in various ways as described in the following sections.
To obtain the OAuth client credentials:
Log into the FreshBooks developers site at https://my.freshbooks.com/#/developer and click Create an App.
Enter information to be displayed to your users when they are prompted to grant permissions to your app.
Specify a redirect URI.
Set the redirect URI to https://localhost:33333/, or some other similar https url.
If you are making a Web application, set the Callback URL to a page on your Web app you would like the user to be returned to after they have authorized your application.
To obtain the access token, set the following connection properties:
OAuthClientId: Set this to the name of the company you are connecting to. Note that you can also use the CompanyName property.
OAuthClientSecret: Set this to the consumer secret in your app settings.
To connect to data, set the following connection properties:
AccountId
OAuthClientSecret
OAuthAccessToken
OAuthAccessTokenSecret
To automatically refresh the access token when it expires, set InitiateOAuth to REFRESH and set OAuthRefreshToken.
To connect to Web Services, you will first need to enable the Web Services subscription. Navigate to Company > Admin Tab > Subscriptions and enable Web Services.
Intacct also recommends creating a Web Services-only user, which can be done by navigating to Company > Admin Tab, and clicking on the + sign beside Web Services users.
You can establish a connection to Sage Intacct with your own credentials.
To authenticate, set CompanyID and set User and Password to the credentials you use to log on to Sage Intacct. In addition, you will need to either set your own SenderID and SenderPassword.
You can use your own Web Services credentials to write data to Intacct. Set the following to connect to data:
SenderID: Set this to the Web Services Sender ID assigned to you by Sage Intacct.
SenderPassword: Set this to your registered Web Services password.
Set the AuthScheme to Okta. The following connection properties are used to connect to Okta:
User: Set this to the Okta user.
Password: Set this to Okta password for the user.
SSOLoginURL: Set this to the login url used by the SSO provider.
The following SSOProperties are needed to authenticate to Okta:
IntacctUserID: Set this value to the Intacct User ID that is mapped to the Okta user you set in the User connection property.
APIToken (optional): Set this to the API Token that the customer created from the Okta org. It should be used when authenticating a user via a trusted application or proxy that overrides Okta client request context.
The following is an example connection string: AuthScheme=Okta; SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46'; User=oktaUserName; Password=oktaPassword; SSOProperties='IntacctUserID=intacct_user';
Sage Business Cloud Accounting uses the OAuth standard to authenticate users.
OAuth requires the authenticating user to interact with Sage Business Cloud Accounting using the browser. The provider facilitates this in various ways as described below.
Note: The driver makes use of the Sage Business Cloud Accounting API (v3.1) to connect. The supported countries for this API version are:
Canada
Germany
Spain
France
United Kingdom
Ireland
United States
You can connect without setting any connection properties for your user credentials. Set InitiateOAuth to GETANDREFRESH to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
Extracts the access token from the callback URL and authenticates requests.
Obtains a new access token when the old one expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Log into Sage accounting Developer Account.
Create a new app. Set the CallbackUrl to http://localhost:3333, or some other similar http url.
The OAuthClientId is the Client Id displayed. The OAuthClientSecret is the Client Secret.
The first time you connect, you will need to authorize the provider with Reckon. The provider makes requests to Reckon through the Remote Connector. The Remote Connector runs on the same machine as Reckon and accepts connections through a lightweight, embedded Web server. The server supports SSL/TLS, enabling users to connect securely from remote machines.
Follow the steps below to authorize with Reckon and connect to a company file when both Reckon and the provider are running on your local machine.
Open Reckon as an administrator and open the company file you want to connect to.
Connect to Reckon. A dialog will appear in Reckon prompting you to authorize the provider. After granting access to the provider, you can now execute commands to Reckon.
If you want to connect to the company file when Reckon is closed, set the CompanyFile connection option when you execute commands. Reckon will open automatically in the background with the file specified.
Note that if Reckon is open through the application UI, only that CompanyFile can be used.
The Remote Connector can be used to read and write to Reckon in situations where direct COM access to Reckon is not available (e.g., ASP.NET, Java, or Reckon on a remote machine). Follow the procedure below to connect to Reckon for the first time through the Remote Connector:
If you have not already done so, download the Remote Connector from remoteconnector.com and install the Remote Connector on the machine where Reckon is installed.
Open the company file you want to connect to in Reckon using an administrator account in single-user mode.
Open the Remote Connector from the system tray and add a user on the Users tab. Enter a User and Password and select the level of access in the Data Access menu.
Note: The Remote Connector does not use the User and Password properties to access Reckon; the User and Password properties authenticate the user to the Remote Connector. Authentication to Reckon is handled based on the ApplicationName property.
When you first connect, a dialog will appear in Reckon prompting you to authorize the application. After authorizing the application, you can then execute commands to Reckon. Specify the URL of the Remote Connector and the User and Password. By default, the Remote Connector connects to the currently open company file.
If you want to access Reckon when Reckon is not running, save the company file information for the user. The Remote Connector will then automatically open Reckon in the background with the company file for that user.
Note that if the Reckon UI is open, you can only connect to that company file. Additionally, note that the user permissions you run the Remote Connector under must match the user permissions you run Reckon under. The Remote Connector installation process installs the Remote Connector as a service under the current user account.
You can enable SSL/TLS on the Advanced tab.
You will also need to send your public key certificate to the provider. You can do so by setting the SSLServerCert property.
In addition to the authentication values, set the following parameters to connect to and retrieve data from Kintone:
Url: The URL of your account.
GuestSpaceId: Optional. Set this when using a guest space.
Kintone supports the following authentication methods.
You must set the following to authenticate to Kintone:
User: The username of your account.
Password: The password of your account.
AuthScheme: Set AuthScheme to Password.
You must set the following to authenticate to Kintone:
APIToken: The API Token.
To generate an API token access the specific app and click on the cog wheel. Proceed to App Settings tab > API Token. Click on the Generate button, an API token will be generated.
AppId: The Application Ids.
The AppId is the number of that specific app in the sequence under Apps in Kintone UI dashboard.
AuthScheme: Set AuthScheme to APIToken.
In addition to the mentioned authentication schemese, Kintone offers additional security in the form of both an additional Basic Auth header, and an SSL Certificate.
In addition to your authentication information, Kintone may be configured to require an SSL certificate to accept requests. To do so, set the following:
SSLClientCert: The file containing the certificate of the SSL Cert. Or alternatively, the name of the certificate store for the client certificate.
SSLClientCertType: The type of certificate.
SSLClientCertSubject: (Optional) If searching for a certificate in the certificate store, the store is searched for subjects containing the value of the property.
SSLClientCertPassword: If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.
Kintone environments using basic authentication will need to pass additional basic credentials. To do so, specify the following:
BasicAuthUser: The basic login name.
BasicAuthPassword: The basic password.
To connect to Alfresco, the following connection properties must be supplied: User, Password, and InstanceURL. User and Password should correspond to the login credentials that you use to access Alfresco in a web browser. InstanceURL corresponds to the Alfresco instance you will be querying. For instance, if you expect your queries to hit https://search-demo.dev.alfresco.me/alfresco/api/-default-/public/search/versions/1/sql, you should supply search-demo.dev.alfresco.me for InstanceURL.
Set the AuthScheme to Basic to authenticate with this method.
To authenthenticate with user credentials, specify the following connection properties:
Set the Quickbase User and Password.
If your application requires an ApplicationToken, you must provide it otherwise an error will be thrown. You can find the ApplicationToken under MyAppName > Settings > App properties > Advanced settings > Security options > Require Application Tokens > Manage Application Token.
Set the AuthScheme to Token to authenticate with this method.
To authenthenticate with a user token, specify the following connection properties:
Set UserToken and you are ready to connect. You can find the UserToken under Quick Base > My Preferences > My User Information > Manage User Tokens.
In order to connect to your Veeva Vault account, you will first need to specify the Url connection property to the host you see in the address bar after logging in to your account, ex. https://myvault.veevavault.com.
OpenID Connect with Azure AD is a connection type that goes through OAuth. Set the AuthScheme to AzureADOpenID and the OpenIDConnectProfileID connection property to the Id of your Open ID Connect profile, which can be found by navigating to Admin > Settings > OAuth 2.0 / OpenID Connect Profiles and expanding the details of your OpenID Connect Profile.
There are two authentication methods available for connecting to your Veeva Vault data source, Basic and OAuth 2.0 / OpenID Connect with the Azure AD Authentication Provider.
Set the AuthScheme to Basic and set the User and Password to your user login credentials.
OpenID Connect with Azure AD is a connection type that goes through OAuth. Set the AuthScheme to AzureADOpenID. The following sections assume that you have done so.
You are ready to connect after setting one of the below connection properties groups depending on the authentication type.
Authenticating using a Client Secret
OAuthClientId: Set this to the Client Id in your app settings.
OAuthClientSecret: Set this to the Client Secret in your app settings.
CallbackURL: Set this to the Redirect URL in your app settings.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken. .
Optionally, depending on the required claims to complete the authentication with the Veeva Vault data source, you may need to set additional scopes via the Scope property. For example, to get the user name and email claims from the UserInfo endpoint, you will need to set the scope value to: 'openid profile email offline_access'.
Authenticating using a Certificate
OAuthClientId: Set this to the Client Id in your app settings.
OAuthJWTCert: Set this to the JWT Certificate store.
OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.
CallbackURL: Set this to the Redirect URL in your app settings.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken. .
Optionally, depending on the required claims to complete the authentication with the Veeva Vault data source, you may need to set additional scopes via the Scope property. For example, to get the user name and email claims from the UserInfo endpoint, you will need to set the scope value to: 'openid profile email offline_access'.
When you connect the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the OAuth process:
Extracts the access token from the callback URL and authenticates requests.
Obtains a new access token when the old one expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Follow the steps below to authenticate with the credentials for a custom OAuth app. See . Get an OAuth Access Token
The provider connects to Sage 50 UK data through the SData REST API included in the Sage 50 UK installation. SData allows access to local company datasets as well as datasets on network drives.
After Configuring the Sage SData Service, connect with the below steps, the URL property should be set to the address of the company dataset desired. To obtain the address, do the following:
If you have not already done so, open the Sage 50 UK software.
Select Tools > Internet Options .
Select the Sdatasettings tab.
Click Details next to the Sage 50 software application you want to connect to. A window opens containing a list of company names along with the addresses to their corresponding datasets.
Set the URL property to the value in the address field next to the company desired.
The User and Password properties must be set to valid Sage 50 UK user credentials. These values are the same values used to log in to the Sage 50 UK software. To authenticate with HTTP digest to the SData service, set AuthScheme to Digest. Otherwise, Basic AuthScheme will be used.
Note: If the dataset you want to connect to is not displayed, the permissions on the Sage 50 UK folder location may not be correct. If you are connecting to a dataset on a networked drive, ensure:
You are using UNC paths to the folder on the machine you are using as your SData provider.
You set the SData service login rights to a user who has full rights over the network share or map drive.
The Provider for Sage 50 UK connects to Sage 50 UK via the Sage SData service (which is Sage's Web toolkit for connecting to Sage instances) that is built into the Sage 50 UK software. SData allows for remote access to Sage software applications. By default, Sage UK 2015 instances will have SData turned on and ready for use.
You can follow the steps below to verify that the SData service is started.
If you have not already done so, open Sage 50.
Navigate to Tools > Internet Options. The Internet Options window is displayed.
Select the Sdatasettings tab. A list is displayed of Sage software applications that are currently available.
To turn the SData service on for the application, select the On option.
If the SData Service Status does not read "SData is currently running", click the Advanced button.
In the dialog that is displayed, specify the Port Number desired when making the connection and click the Restart button.
If the Windows Firewall button is enabled, click this button to unblock the port. If you have any additional firewalls on the machine, ensure that they are configured to allow connections to be made on the specified port number.
Once you apply any changes, you can then establish a connection to your Sage 50 UK software.
The Sage SData service provides secure and encrypted connections via HTTPS. Data confidentiality and the authenticity of the server are provided by digital certificates. If you do not have a certificate, use IIS to generate a self-signed certificate.
You can follow the steps below to configure the SData service to use a certificate; the provider will validate this certificate against the system trust store by default. If you generated a self-signed certificate, you can add the certificate to this certificate store or set SSLServerCert.
The certificate has the following requirements:
The certificate must have a full valid trust chain.
The common name (CN) for the certificate must match the machine/domain name where the SData service is running. To ensure that the CN is correct, generate the self-signed certificate on the machine where Sage 50 SData is running.
The certificate must be added to the personal My certificate store for the Local Machine account.
You can then configure the SData service to use the certificate:
Navigate to C:\Program Files (x86)\Common Files\Sage SData and open Sage.SData.Service.Config.UI.exe.
Click the Advanced button. The SData Configuration window is displayed.
Select the Enable HTTPS Access option and select the port desired.
If you have any firewalls on your machine, make sure the ports specified are not blocked.
Click the button next to the Certificate box.
In the resulting dialog, select the certificate.
If you select a certificate and do not see the certificate name populated in the Certificate textbox, this is most likely due to missing extended properties within the certificate. The extended properties include thumbprint, thumbprint algorithm, key usage, and enhanced key usage.
Use IIS to avoid this issue: IIS automatically populates these fields when generating a self-signed certificate.
Click OK to restart the server.
Verify that the Enable HTTPS option is selected in the SData configuration window.
If the SData configuration window is closed and reopened but the Enable HTTPS option is not enabled, this is most likely caused by the Sage.SData.Service.exe.config file not being updated properly. Follow the steps below to use the alternate configuration file below.
You will need the certificate thumbprint. Note that the thumbprint data includes spaces. The thumbprint data can be obtained using Windows services. You can also access the thumbprint in the SData configuration window:
If you have not already done so, open the Sage.SData.Service.Config.UI.exe application and open the advanced settings.
Click the button next to the Certificate box.
In the Windows security dialog, click "Click here to view certificate properties". The Certificate Details window is displayed.
On the Details tab, copy the value in the Thumbprint field.
Use this value in the CertificateLookupValue setting in the configuration file. For example:
<?xml version="1.0" encoding="utf-8" ?><configuration><configSections><sectionGroup name="applicationSettings" type="System.Configuration.ApplicationSettingsGroup, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" ><section name="Sage.SData.Service.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" /><section name="Sage.Integration.Server.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" /><section name="Sage.Common.Syndication.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" /></sectionGroup></configSections><applicationSettings><Sage.SData.Service.Properties.Settings><setting name="DigestTimeout" serializeAs="String"><value>12000000000</value></setting><setting name="EnableBasicAuthentication" serializeAs="String"><value>True</value></setting><setting name="WebAppPath" serializeAs="String"><value /></setting><setting name="EnableSSL" serializeAs="String"><value>True</value></setting><setting name="Port" serializeAs="String"><value>443</value></setting></Sage.SData.Service.Properties.Settings><Sage.Integration.Server.Properties.Settings><setting name="EnableBroadcast" serializeAs="String"><value>False</value></setting></Sage.Integration.Server.Properties.Settings><Sage.Common.Syndication.Properties.Settings><setting name="IPAddress" serializeAs="String"><value /></setting><setting name="Server" serializeAs="String"><value>sdata</value></setting><setting name="EnableSSLPort" serializeAs="String"><value>True</value></setting><setting name="Port" serializeAs="String"><value>5493</value></setting><setting name="SettingsProviderType" serializeAs="String"><value>Sage.Common.Syndication.ConfigurationSyndicationSettings, Sage.Common.Syndication</value></setting><setting name="PathPrefix" serializeAs="String"><value /></setting><setting name="DoNotUseRegistry" serializeAs="String"><value>False</value></setting><setting name="EnableStandardPort" serializeAs="String"><value>True</value></setting><setting name="SSLPort" serializeAs="String"><value>5494</value></setting><setting name="CertificateLookupValue" serializeAs="String"><value>ENTER YOUR CERTIFICATE THUMBPRINT HERE</value></setting><setting name="CertificateLookupType" serializeAs="String"><value>Thumbprint</value></setting></Sage.Common.Syndication.Properties.Settings></applicationSettings></configuration>
Salesforce Einstein Analytics uses the OAuth 2 authentication standard. You will need to obtain the OAuthClientId and OAuthClientSecret by registering an app with Salesforce Einstein Analytics.
OAuth requires the authenticating user to interact with Salesforce Einstein Analytics using the browser. The provider facilitates this in various ways as described in the following sections.
You can follow the procedure below to obtain the OAuth client credentials, the consumer key and consumer secret:
If your organization uses the Salesforce Lightning Experience UI, from Setup enter App in the Quick Find box, select App Manager (not Manage Connected Apps), and click New Connected App.
If your organization uses the Salesforce Classic UI, from Setup enter Apps in the Quick Find box and then select Apps, under Build or Create. Under Connected Apps, click New.
Enter a name to be displayed to users when they log in to grant permissions to your app, along with a contact email address.
Click Enable OAuth Settings and enter a value in the Callback URL box.
If you are making a desktop application, set the Callback URL to http://localhost:33333 or a different port number of your choice.
If you are making a Web application, set the Callback URL to a page on your Web app you would like the user to be returned to after they have authorized your application.
Select the following OAuth scopes:
Access and manage your wave data (wave_api)
Access and manage your data (api)
Perform requests on your behalf at any time (refresh_token, offline_token)
Once you have created the app, click your app name to open a page with information about your app. The OAuth client credentials, the consumer key and consumer secret, are displayed.
After setting the following connection properties, you are ready to connect:
OAuthClientId: Set this to the consumer key in your app settings.
OAuthClientSecret: Set this to the consumer secret in your app settings.
CallbackURL: Set this to the callback URL in your app settings.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
When you connect the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the OAuth process:
Gets the callback URL and sets the access token to authenticate requests.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Exchanges the returned refresh token for a new, valid access token.
Various login credentials must be supplied to connect to the standard API and Prediction API of DataRobot.
Set the User and Password to your login credentials, and specify PredictionInstance. Additionally, set the APIKey connection property to your API Token, if you have obtained one already. If you are using a Cloud Prediction instance for DataRobot, you will need to supply DataRobotKey as well. To obtain the APIKey, follow the steps below:
Login to the DataRobot UI, and click the person icon in the top right corner of the UI.
From the drop down menu, select "Profile".
Profile information will appear, including your "API Token".
To obtain the DataRobotKey, do the following:
Login to the DataRobot UI, and click "Deployments" in the top-most toolbar.
Open a deployment.
In the deployment's menu, select the "Integrations" tab.
Your DataRobotKey is the second entry in the headers JSON object.
You must specify the URL to a valid Splunk server. By default the provider makes requests on port 8089.
By default, the provider attempts to negotiate TLS/SSL with the server.
Login with Splunk credentials is the only available authentication method for connecting to Splunk.
To authenticate with Splunk credentials, set the AuthScheme to Basic and set the User and Password to your login credentials.
Use the OAuth authentication standard to connect to Google Analytics. You can authenticate with a user account or with a service account. A service account is required to grant organization-wide access scopes to the provider. The provider facilitates these authentication flows as described below.
Instead of connecting with the provider's embedded credentials, you can register an app to obtain the OAuthClientId and OAuthClientSecret.
Follow the procedure below to register an app and obtain the OAuthClientId and OAuthClientSecret.
Log into the Google API Console and open a project. Select the API Manager from the main menu.
In the user consent flow, click Credentials -> Create Credentials -> OAuth Client Id. Click Other. After creating the app, the OAuthClientId and OAuthClientSecret are displayed.
Click Library -> Analytics API -> Enable API.
After setting the following, you are ready to connect:
OAuthClientId: Set this to the client Id assigned when you registered your app.
OAuthClientSecret: Set this to the client secret assigned when you registered your app.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
Profile: Set this to the Google Analytics profile or view you want to connect to. This value can be retrieved from the Profiles table. If this is not specified, the first Profile returned will be used.
When you connect the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the OAuth process:
Extracts the access token from the callback URL and authenticates requests.
Refreshes the access token when it expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Follow the steps below to create an OAuth application and generate a private key. You will then authorize the service account.
Log into the Google API Console and open a project. Select the API Manager from the main menu.
Click Create Credentials -> Service Account Key.
In the Service Account menu, select New Service Account or select an existing service account.
If you are creating a new service account, additionally select one or more roles. You can assign primitive roles at the project level in the IAM and Admin section; other roles enable you to further customize access to Google APIs.
In the Key Type section, select the P12 key type.
Create the app to download the key pair. The private key's password is displayed: Set this in OAuthJWTCertPassword.
In the service accounts section, click Manage Service Accounts and set OAuthJWTIssuer to the email address displayed in the service account Id field.
Click Library -> Analytics API -> Enable API.
Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the provider.
You can then connect to Google Analytics data that the service account has permission to access.
After setting the following connection properties, you are ready to connect:
InitiateOAuth: Set this to GETANDREFRESH.
OAuthJWTCertType: Set this to "PFXFile".
OAuthJWTCert: Set this to the path to the .p12 file you generated.
OAuthJWTCertPassword: Set this to the password of the .pem file.
OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
OAuthJWTSubject (optional): Set this to the email address of the user for whom the application is requesting delegate access. Note that delegate access must be granted by an administrator.
Profile: Set this to the Google Analytics profile or view you want to connect to. This value can be retrieved from the Profiles table. If this is not specified, the first Profile returned will be used.
When you connect the provider completes the OAuth flow for a service account.
Creates and signs the JWT with the claim set required by the provider.
Exchanges the JWT for the access token.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Submits the JWT for a new access token when the token expires.
In order to connect to Adobe Analytics, the GlobalCompanyId and RSID need to be identified. By default, the provider attempts to automatically identify your company and report suite. Alternatively, you can identify the company and report suite explicitly:
GlobalCompanyId is an optional connection property. If left empty, the provider tries to automatically detect the Global Company ID. To find the Global Company ID:
Expand the users endpoint and then click the GET users/me button.
Click the Try it out > Execute buttons.
Set the GlobalCompanyId connection property to the Global Company ID shown in the Request URL immediately preceding the users/me endpoint.
RSID is an optional connection property. If not set, the driver tries to automatically detect it. To get a full list of your report suites along with their identifiers next to the name, navigate to Admin > Report Suites.
Adobe Analytics uses the OAuth authentication standard. You can authenticate with OAuth integration or Service Account integration.
AuthScheme must be set to OAuth in all user account flows.
You must create a custom OAuth app to connect to the Adobe Analytics.
Follow the steps below to create a custom app and obtain the connection properties in a specific OAuth authentication flow.
Click the Create new project button.
Select the Add API option.
Select Adobe Analytics, click Next, and then select OAuth and then click Next again.
Select the Web option and fill out the redirect URIs. For a desktop application, you can use a localhost URL such as https://localhost:33333. For a web application, supply the URL of the page to redirect to on your website.
Click Save configured API.
Your client is now created. Notice your client has an Client ID (API Key) and a Client Secret. These will be needed to get your auth code and to generate access tokens.
Follow the steps below to create a custom app and obtain the connection properties in a specific Service Account authentication flow.
Click the Create new project button.
Select the Add API option.
Select Adobe Analytics, click Next, and then select Service Account (JWT) and then click Next again.
Choose either to Generate a key pair or Upload your public key. If you choose to Generate a key pair, save the config.zip file locally as this contains the certificate you'll need to complete the connection. Click Next after the key is created or uploaded.
Creating Your Own Public Key Certificate
MacOS and Linux Open a terminal and execute the following command: openssl req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout private.key -out certificate_pub.crt
Windows Download an OpenSSL client such as OpenSSL Light to generate public certificates. The following steps will be for OpenSSL Light Open a command line window and execute the following commands: 1) cd "C:\Program Files\OpenSSL-Win64\bin" 2) .\openssl.exe req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout private.key -out certificate_pub.crt
Select one or more product profiles (in product profiles you can set permissions of the app.) and then click Save configured API.
Your client is now created. Notice your client has Client ID (API Key), Client Secret, Organization ID and Technical account ID. These will be needed to get JWT token and to generate access tokens.
Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
OAuthClientId (custom applications only): Set this to the client Id assigned when you registered your app.
OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your app.
CallbackURL (custom application only): Set this to the redirect URI defined when you registered your app. For example: https://localhost:3333
When you connect, the provider opens Adobe Analytics's OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the OAuth process:
The provider obtains an access token from Adobe Analytics and uses it to request data.
The OAuth values are saved in the path specified in OAuthSettingsLocation, to be persisted across connections.
The provider refreshes the access token automatically when it expires.
Set the AuthScheme to OAuthJWT to authenticate with this method.
After setting the following connection properties, you are ready to connect:
InitiateOAuth: Set to GETANDREFRESH.
OAuthClientId: Set to the client Id in your app settings.
OAuthClientSecret: Set to the client secret in your app settings.
OAuthJWTCertType: Set to "PUBLIC_KEY_FILE".
OAuthJWTCert: Set to the path to the .key file you generated.
OAuthJWTCertPassword: Set to the password of the .key file.
OAuthJWTSubject: The subject, your Technical Account ID from the Adobe I/O Console integration, in the format: id@techacct.adobe.com.
OAuthJWTIssuer: The issuer, your Organization ID from the Adobe I/O Console integration, in the format org_ident@AdobeOrg. Identifies your organization that has been configured for access to the Adobe I/O API.
When you connect the provider completes the OAuth flow for a service account.
Creates and signs the JWT with the claim set required by the provider.
Exchanges the JWT for the access token.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Submits the JWT for a new access token when the token expires.
Find it in the request URL for the users/me endpoint on the .
Navigate to the following URL: .
Navigate to the following URL: .
Service accounts have silent authentication, which does not require user authentication in the browser. You need to create an application in this flow. See to create and authorize an app. You can then connect to Adobe Analytics data that the service account has permission to access.
Follow the steps below to create a custom app and obtain the connection properties in a specific OAuth authentication flow.
Click the Create new project button.
Select the Add API option.
Select Adobe Analytics, click Next, and then select OAuth and then click Next again.
Select the Web option and fill out the redirect URIs. For a desktop application, you can use a localhost URL such as https://localhost:33333. For a web application, supply the URL of the page to redirect to on your website.
Click Save configured API.
Your client is now created. Notice your client has an Client ID (API Key) and a Client Secret. These will be needed to get your auth code and to generate access tokens.
Follow the steps below to create a custom app and obtain the connection properties in a specific Service Account authentication flow.
Click the Create new project button.
Select the Add API option.
Select Adobe Analytics, click Next, and then select Service Account (JWT) and then click Next again.
Choose either to Generate a key pair or Upload your public key. If you choose to Generate a key pair, save the config.zip file locally as this contains the certificate you'll need to complete the connection. Click Next after the key is created or uploaded.
Creating Your Own Public Key Certificate
Download an OpenSSL client such as OpenSSL Light to generate public certificates. The following steps will be for OpenSSL Light Open a command line window and execute the following commands: 1) cd "C:\Program Files\OpenSSL-Win64\bin" 2) .\openssl.exe req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout private.key -out certificate_pub.crt
Select one or more product profiles (in product profiles you can set permissions of the app.) and then click Save configured API.
Your client is now created. Notice your client has Client ID (API Key), Client Secret, Organization ID and Technical account ID. These will be needed to get JWT token and to generate access tokens.
Navigate to the following URL: .
Navigate to the following URL: .
To connect, set the Url property to a valid Azure Analysis Services server, for instance, asazure://southcentralus.asazure.windows.net/server, in addition to authenticating.
Optionally, set Database to distinguish which Azure database on the server to connect to.
Azure AD is a connection type that leverages OAuth to authenticate. OAuth requires the authenticating user to interact with Azure Analysis Services using an internet browser. The provider facilitates this in several ways as described below. Set your AuthScheme to AzureAD. All AzureAD flows assume that you have done so.
Azure Service Principal is a connection type that goes through OAuth. Set your AuthScheme to AzureServicePrincipal. The authentication as an Azure Service Principal is handled via the OAuth Client Credentials flow, and it does not involve direct user authentication. Instead, credentials are created for just the app itself. All tasks taken by the app are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.
Note: You must create a custom application prior to assigning a role. See Creating a Custom AzureAD App below for more information.
When authenticating using an Azure Service Principal, you must register an application with an Azure AD tenant. Follow the steps below to create a new service principal that can be used with the role-based access control.
Assign a role to the application
To access resources in your subscription, you must assign a role to the application.
Open the Subscriptions page by searching and selecting the Subscriptions service from the search bar.
Select the particular subscription to assign the application to.
Open the Access control (IAM) and select Add > Add role assignment to open the Add role assignment page.
Select Owner as the role to assign to your created Azure AD app.
Complete the Authentication
You are ready to connect after setting one of the below connection properties groups, depending on the configured app authentication (client secret or certificate).
In both methods
Before choosing client secret or certicate authentication, follow these steps then continue to the relevant section below:
AuthScheme: Set this to the AzureServicePrincipal in your app settings.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
AzureTenant: Set this to the tenant you wish to connect to.
OAuthClientId: Set this to the client Id in your app settings.
Authenticating using a Client Secret
Continue with the following:
OAuthClientId: Set this to the client Id in your app settings.
OAuthClientSecret: Set this to the client secret in your app settings.
Authenticating using a Certificate
Continue with the following:
OAuthJWTCert: Set this to the JWT Certificate store.
OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.
To connect using your Azure credentials directly, specify the following connection properties:
AuthScheme: Set this to AzurePassword.
User: Set this to your user account you use to connect to Azure.
Password: Set this to the password you use to connect to Azure.
AzureTenant: Set this to the Directory (tenant) ID, found on the Overview page of the OAuth app used to authenticate to Azure Analysis Services on Azure.
If you are running Azure Analysis Services on an Azure VM, you can leverage Managed Service Identity (MSI) credentials to connect:
AuthScheme: Set this to AzureMSI.
The MSI credentials are automatically obtained for authentication.
Create a Custom AzureAD App
Follow the steps below to obtain the AzureAD values for your application, the OAuthClientId and OAuthClientSecret.
In the left-hand navigation pane, select Azure Active Directory, then applicationRegistrations, and click New registration.
Enter an application name and select the desired tenant setup. When creating a custom AzureAD application in Azure Active Directory, you can define whether the application is single- or multi-tenant. If you select the default option, "Accounts in this organizational directory only", you must set the AzureTenant connection property to the Id of the Azure AD Tenant when establishing a connection with the CData ADO.NET Provider for Azure Analysis Services. Otherwise, the authentication attempt fails with an error. If your application is for private use only, "Accounts in this organization directory only" should be sufficient. Otherwise, if you want to distribute your application, choose one of the multi-tenant options.
Set the redirect url to http://localhost:33333, the provider's default. Or, specify a different port and set CallbackURL to the exact reply URL you defined.
Click Register to register the new application. This opens an application management screen. Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
Navigate to the "Certificates & Secrets" and define the application authentication type. There are two types of authentication available: using a client secret or a certificate. The recommended authentication method is using a certificate.
Option 1: Upload a certificate: In "Certificates & Secrets", select Upload certificate and the certificate to upload from your local machine.
Option 2: Create a new application secret: In "Certificates & Secrets", select New Client Secret for the application and specify its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once. You will need it as the OAuthClientSecret.
Select API Permissions > Add.
Save your changes.
If you have selected to use permissions that require admin consent, you can grant them from the current tenant on the API Permissions page.
When authenticating using an Azure Service Principal, you must create both a custom AzureAD application and a service principal that can access the necessary resources. Follow the steps below to create a custom AzureAD application and obtain the connection properties for Azure Service Principal authentication.
Create a Custom AzureAD App with an Azure Service Principal
Follow the steps below to obtain the AzureAD values for your application.
In the left-hand navigation pane, select Azure Active Directory then App Registrations and click New registration.
Enter an app name and select Any Azure AD Directory - Multi Tenant. Then set the redirect url to http://localhost:33333, the provider's default.
After creating the application, copy the Application (client) Id value displayed in the "Overview" section. This value is used as the OAuthClientId
Define the app authentication type by going to the "Certificates & Secrets" section. There are two types of authentication available: using a client secret and using a certificate. The recommended authentication method is via a certificate.
Option 1 - Upload a certificate: In "Certificates & Secrets", select Upload certificate and the certificate to upload from your local machine.
Option 2 - Create a new application secret: In "Certificates & Secrets", select New Client Secret for the application and specify its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once. You will use it as the OAuthClientSecret.
On the Authentication tab, make sure to select Access tokens (used for implicit flows).
Log in to .
Log in to .
Use the OAuth authentication standard to connect to YouTube Analytics. You can authenticate with a user account or with a service account. A service account is required to grant organization-wide access scopes to the provider. The provider facilitates these authentication flows as described below.
Log into the Google API Console and open a project. Select the API Manager from the main menu.
In the user consent flow, click Credentials -> Create Credentials -> OAuth Client Id. Click Other. After creating the app, the OAuthClientId and OAuthClientSecret are displayed.
Click Library -> YouTube Analytics API -> Enable API.
Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the provider.
Follow the steps below to create an OAuth application and generate a private key. You will then authorize the service account.
Log into the Google API Console and open a project. Select the API Manager from the main menu.
Click Create Credentials -> Service Account Key.
In the Service Account menu, select New Service Account or select an existing service account.
If you are creating a new service account, additionally select one or more roles. You can assign primitive roles at the project level in the IAM and Admin section; other roles enable you to further customize access to Google APIs.
In the Key Type section, select the P12 key type.
Create the app to download the key pair. The private key's password is displayed: Set this in OAuthJWTCertPassword.
In the service accounts section, click Manage Service Accounts and set OAuthJWTIssuer to the email address displayed in the service account Id field.
Click Library -> YouTube Analytics API -> Enable API
After setting the following connection properties, you are ready to connect:
InitiateOAuth: Set to GETANDREFRESH.
OAuthClientId: Set to the Client Id in your app settings.
OAuthClientSecret: Set to the Client Secret in your app settings.
OAuthJWTCertType: Set to "PEMKEY_FILE".
OAuthJWTCert: Set to the path to the .pem file you generated.
OAuthJWTCertPassword: Set to the password of the .pem file.
OAuthJWTCertSubject: Set to "*" to pick the first certificate in the certificate store.
OAuthJWTSubject: Set to the email address of the user for whom the application is requesting delegate access. Note that delegate access must be granted by an administrator.
ChannelId: Set to the Id of a YouTube channel. If not specified, data is returned for the authenticated user's channel.
ContentOwnerId: Set if you want to generate content owner reports.
When you connect the provider completes the OAuth flow for a service account.
Creates and signs the JWT with the claim set required by the provider.
Exchanges the JWT for the access token.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Submits the JWT for a new access token when the token expires.
The Provider for SAS Data Sets allows connecting to local and remote SAS resources. Set the URI property to the SAS resource location, in addition to any other properties necessary to connect to your data source.
Set the ConnectionType to Local. Local files support SELECT\INSERT\DELETE.
Set the URI to a folder containing SAS files: C:\folder1.
While the provider is capable of pulling data from SAS Data Sets files hosted on a variety of cloud data stores, INSERT, UPDATE, and DELETE are not supported outside of local files in this provider.
If you need INSERT/UPDATE/DELETE cloud files, you can use the corresponding connector for that cloud host (supported via stored procedures), make changes with the local file's corresponding provider, then upload the file using the cloud source's stored procedures.
As an example, if you wanted to update a file stored on SharePoint, you could use the appRules SharePoint DownloadDocument activity to download the SAS Data Sets file, update the local SAS Data Sets file with the appRules SAS Data Sets connector, then use the SharePoint UploadDocument activity to upload the changed file to SharePoint.
A unique prefix at the beginning of the URI connection property is used to identify the cloud data store being targed by the provider and the remainder of the path is a relative path to the desired folder (one table per file) or single file (a single table).
Set the following to identify your SAS Data Sets resources stored on Amazon S3:
ConnectionType: Set the ConnectionType to Amazon S3.
URI: Set this to the bucket and folder: s3://bucket1/folder1.
Set the following to identify your SAS Data Sets resources stored on Azure Blob Storage:
ConnectionType: Set this to Azure Blob Storage.
URI: Set this to the name of your container and the name of the blob. For example: azureblob://mycontainer/myblob.
Set the following to identify your SAS Data Sets resources stored on Azure Data Lake Storage:
ConnectionType: Set this to Azure Data Lake Storage Gen1, Azure Data Lake Storage Gen2, or Azure Data Lake Storage Gen2 SSL.
URI: Set this to the name of the file system and the name of the folder which contains your SAS Data Sets files. For example:
Gen 1: adl://myfilesystem/folder1
Gen 2: abfs://myfilesystem/folder1
Gen 2 SSL: abfss://myfilesystem/folder1
Set the following properties to connect:
ConnectionType: Set this to Azure Files.
URI: Set this the name of your azure file share and the name of the resource. For example: azurefile://fileShare/remotePath.
AzureStorageAccount (Required): Set this to the account associated with the Azure file.
You can authenticate either an Azure access key or an Azure shared access signature. Set one of the following:
AzureAccessKey: Set this to the access key associated with the Azure file.
AzureSharedAccessSignature: Set this to the shared access signature associated with the Azure file.
Set the following to identify your SAS Data Sets resources stored on Box:
ConnectionType: Set this to Box.
URI: Set this the name of the file system and the name of the folder which contains your SAS Data Sets files. For example: box://folder1.
Set the following to identify your SAS Data Sets resources stored on Dropbox:
ConnectionType: Set this to Dropbox.
URI: Set this to the path to a folder containing SAS files. For example: dropbox://folder1.
The provider supports both plaintext and SSL/TLS connections to FTP servers.
Set the following connection properties to connect:
ConnectionType: Set this to either FTP or FTPS.
URI: Set this to the address of the server followed by the path to the folder to be used as the root folder. For example: ftp://localhost:990/folder1 or ftps://localhost:990/folder1.
User: Set this to your username on the FTP(S) server you want to connect to.
Password: Set this to your password on the FTP(S) server you want to connect to.
Set the following to identify your SAS Data Sets resources stored on Google Cloud Storage:
ConnectionType: Set this to Google Cloud Storage.
URI: Set this to the path to the name of the file system and the name of the folder which contains your SAS Data Sets files. For example: gs://bucket/remotePath.
Set the following to identify your SAS Data Sets resources stored on Google Drive:
ConnectionType: Set this to Google Drive.
URI: Set to the path to the name of the file system and the name of the folder which contains your SAS Data Sets files. For example: gdrive://folder1.
Set the following to identify your SAS Data Sets resources stored on HDFS:
ConnectionType: Set this to HDFS or HDFS Secure.
URI: Set this to the path to a folder containing SAS files. For example:
HDFS: webhdfs://host:port/remotePath
HDFS Secure: webhdfss://host:port/remotePath
There are two authentication methods available for connecting to HDFS data source, Anonymous Authentication and Negotiate (Kerberos) Authentication.
Anonymous Authentication
In some situations, you can connect to HDFS without any authentication connection properties. To do so, set the AuthScheme property to None (default).
Authenticate using Kerberos
When authentication credentials are required, you can use Kerberos for authentication.
Set the following to identify your SAS Data Sets resources stored on HTTP streams:
ConnectionType: Set this to HTTP or HTTPS.
URI: Set this to the URI of your HTTP(S) stream. For example:
HTTP: http://remoteStream
HTTPS: https://remoteStream
Set the following to identify your SAS Data Sets resources stored on IBM Cloud Object Storage:
ConnectionType: Set this to IBM Object Storage Source.
URI: Set this to the bucket and folder. For example: ibmobjectstorage://bucket1/remotePath.
Set the following to identify your SAS Data Sets resources stored on OneDrive:
ConnectionType: Set this to OneDrive.
URI: Set this to the path to a folder containing SAS files. For example: onedrive://remotePath.
Set the following properties to authenticate with HMAC:
ConnectionType: Set the ConnectionType to Oracle Cloud Storage.
URI: Set this to the bucket and folder: os://bucket/remotePath.
AccessKey: Set this to an Oracle Cloud Access Key.
SecretKey: Set this to an Oracle Cloud Secret Key.
OracleNamespace: Set this to an Oracle cloud namespace.
Region (optional): Set this to the hosting region for your S3-like Web Services.
Set the following to identify your SAS Data Sets resources stored on SFTP:
ConnectionType: Set this to SFTP.
URI: Set this to the address of the server followed by the path to the folder to be used as the root folder. For example: sftp://server:port/remotePath.
Set the following to identify your SAS Data Sets resources stored on SharePoint Online:
ConnectionType: Set this to SharePoint REST or SharePoint SOAP.
URI: Set this to a document library containing SAS files. For example:
SharePoint Online REST: sprest://remotePath
SharePoint Online SOAP: sp://remotePath
By default, the provider attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.
The connector for Apache HBase connects to Apache HBase via the HBase REST (Stargate) server.
Set the Port and Server properties to connect to Apache HBase.
The Server property will typically be the host name or IP address of the server hosting Apache HBase. If there are multiple nodes, you will use the host name or IP address of the machine running the REST (Stargate) server.
Different Hadoop distributions contain different interfaces and means of starting and stopping the HBase REST server, along with different default port settings.
In most distributions, the HBase REST server can be started in the foreground by running the following command: "hbase rest start -p <port>". Please consult your Hadoop distribution's documentation for further information regarding the HBase REST server.
The connector for Apache HBase supports authentication over Basic and Negotiate.
By default, no authentication (or anonymous auth) is used. Set AuthScheme to None to explicitly enforce no authentication.
Basic authentication may be used by setting AuthScheme to Basic. In addition, set the following:
User: The Apache HBase user;
Password: The Apache HBase password;
To authenticate with Kerberos, set AuthScheme to NEGOTIATE and set the User and Password.
To authenticate to Apache HBase using Kerberos, set the following properties:
AuthScheme: Set this to KERBEROS
KerberosKDC: Set this to the host name or IP Address of your Kerberos KDC machine.
KerberosSPN: Set this to the service and host of the Apache HBase Kerberos Principal. This will be the value prior to the '@' symbol (for instance, hbase/MyHost) of the hbase.regionserver.kerberos.principal of the hbase-site.xml file (for instance, hbase/MyHost@EXAMPLE.COM).
1.2.3.1 Retrieve the Kerberos Ticket
You can use one of the following options to retrieve the required Kerberos ticket.
1.2.3.2 MIT Kerberos Credential Cache File
This option enables you to use the MIT Kerberos Ticket Manager or kinit command to get tickets. Note that you won't need to set the User or Password connection properties with this option.
Ensure that you have an environment variable created called KRB5CCNAME.
Set the KRB5CCNAME environment variable to a path pointing to your credential cache file (for instance, C:\krb_cache\krb5cc_0 or /tmp/krb5cc_0). This file will be created when generating your ticket with MIT Kerberos Ticket Manager.
To obtain a ticket, open the MIT Kerberos Ticket Manager application, click Get Ticket, enter your principal name and password, then click OK. If successful, ticket information will appear in Kerberos Ticket Manager and will now be stored in the credential cache file.
Now that the credential cache file has been created, the provider will use the cache file to obtain the kerberos ticket to connect to Apache HBase.
As an alternative to setting the KRB5CCNAME environment variable, you can directly set the file path using the KerberosTicketCache property. When set, the provider will use the specified cache file to obtain the kerberos ticket to connect to Apache HBase.
1.2.3.3 Keytab File
If the KRB5CCNAME environment variable has not been set, you can retrieve a Kerberos ticket using a Keytab File. To do this, set the User property to the desired username and set the KerberosKeytabFile property to a file path pointing to the keytab file associated with the user.
1.2.3.4 User and Password
If both the KRB5CCNAME environment variable and the KerberosKeytabFile property have not been set, you can retrieve a ticket using a User and Password combination. To do this, set the User and Password properties to the user/password combo that you use to authenticate with Apache HBase.
1.2.3.5 Cross-Realm Authentication
More complex Kerberos environments may require cross-realm authentication where multiple realms and KDC servers are used (e.g. where one realm/KDC is used for user authentication and another realm/KDC used for obtaining the service ticket).
In such an environment, the KerberosRealm and KerberosKDC properties can be set to the values required for user authentication. The KerberosServiceRealm and KerberosServiceKDC properties can be set to the values required to obtain the service ticket.
The following are the connection properties for Apache HBase. Not all properties are required. Enter only property values pertaining to your installation. Several properties will be automatically initialized with the appRules defaults.
Property
Description
Authentication
AuthScheme
The scheme used for authentication. Accepted entries are NONE, BASIC, and NEGOTIATE (Kerberos). NONE is the default.
PageSize
The number of results to return per page from Apache HBase.
Password
The password used to authenticate to Apache HBase.
Port
The port for the Apache HBase REST server.
Server
The host name or IP address of the Apache HBase REST server.
User
The user who is authenticating to Apache HBase.
Firewall
FirewallPassword
A password used to authenticate to a proxy-based firewall.
FirewallPort
The TCP port for a proxy-based firewall.
FirewallServer
The name or IP address of a proxy-based firewall.
FirewallType
The protocol used by a proxy-based firewall.
FirewallUser
The user name to use to authenticate with a proxy-based firewall.
Kerberos
KerberosKDC
The Kerberos Key Distribution Center (KDC) service used to authenticate the user.
KerberosKeytabFile
The Keytab file containing your pairs of Kerberos principals and encrypted keys.
KerberosRealm
The Kerberos Realm used to authenticate the user with.
KerberosSPN
The service principal name (SPN) for the Kerberos Domain Controller.
Logging
Logfile
A path to the log file.
MaxLogFileCount
A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
MaxLogFileSize
A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Verbosity
The verbosity level that determines the amount of detail included in the log file.
Misc
ConnectionLifeTime
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectionString
***
DatetimeFormat
The format used when inserting datetime values into the database.
MaxRows
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other
These hidden properties are used only in specific use cases.
PoolIdleTimeout
The allowed idle time for a connection before it is closed.
PoolMaxSize
The maximum connections in the pool.
PoolMinSize
The minimum number of connections in the pool.
PoolWaitTime
The max seconds to wait for an available connection.
PseudoColumns
This property indicates whether or not to include pseudo columns as columns to the table.
Readonly
You can use this property to enforce read-only access to Apache HBase from the provider.
RetrieveSelectedColumnsOnly
Specifies whether to retrieve selected columns only when executing a SELECT statement.
RowScanDepth
The number of rows to scan to determine columns for the table.
SSLServerCert
The certificate to be accepted from the server when connecting using TLS/SSL.
SupportEnhancedSQL
This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionScheme
Determines how to determine the data type of columns.
UseConnectionPooling
This property enables connection pooling.
Proxy
ProxyAuthScheme
The authentication type to use to authenticate to the ProxyServer proxy.
ProxyAutoDetect
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyExceptions
A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer .
ProxyPassword
A password to be used to authenticate to the ProxyServer proxy.
ProxyPort
The TCP port the ProxyServer proxy is running on.
ProxyServer
The hostname or IP address of a proxy to route HTTP traffic through.
ProxySSLType
The SSL type to use when connecting to the ProxyServer proxy.
ProxyUser
A user name to be used to authenticate to the ProxyServer proxy.
