TIBCO Scribe® Online Connector For TIBCO Cloud™ Live Apps

TIBCO Cloud™ Live Apps is an application that allows you to build low code, smart applications. Using the Live Apps Connector, you can integrate your Live Apps applications with other company data systems.

Possible use cases for the Live Apps Connector include:

Find and retrieve Live Apps cases
Create Live Apps cases
Initiate actions on your Live Apps cases

Connector Specifications

	Supported
Agent Types
Connect on-premise	X
Connect cloud	X
Data Replication Apps
Source
Target
On Schedule Apps
Source	X
Target	X
On Event Apps
Source
Target
Flows
Integration	X
Request-Reply
Message

Note:

This Connector is available from the TIBCO Cloud™ Integration Marketplace. See Marketplace Connectors for more information.

Supported Entities

The Live Apps Connector supports the following entities and operations.

Note: Live Apps entity names are dynamic. The case types, creators, and actions that are available, depend on the names given in your Live Apps applications.

The Live Apps Connector displays all creators and actions that are available in your Live Apps subscription, even if you do not have permission to execute them. This means it is possible to attempt to execute a Live Apps action for which you do not have permission. In this case, the action fails with an appropriate run time error.

You cannot perform actions or create cases that require participant users or participant groups as input data.

Special Operations

Entity	Operations
Case type	-Query
Case creator	-Creator
Case action	-Action

Creator — This operation is based on the CreateWith container Block used with Hierarchical Data to add a parent record that contains one or more child records. This Block collects all of the data for a single record before writing the entire record to the target. See CreateWith Block.
Action — This operation is based on the UpdateWith container Block used with Hierarchical Data. Use this Block to update a parent record that contains one or more child records. This Block collects all of the data for a single parent record before writing the record to the target. See UpdateWith Block.
Add — Used for Hierarchical Data to add child records to the parent selected in a CreateWith or UpdateWith Block. See Add Block.

Setup Considerations

The Live Apps Connector supports the latest version of TIBCO Cloud™ Live Apps.

The Live Apps user name you provide must have permission to create cases and perform actions.

Requirements include:

Live Apps User Name
Live Apps Password
Live Apps region
The sandbox that you want connect to. If you are developing and testing your implementation you can connect to a Developer sandbox. Use a Production sandbox when you have finished testing your implementation and published your Live Apps application.
Organization. You can optionally enter an Organization name. This is only applicable if you belong to more than one subscription in the region you are connecting to.

Selecting An Agent Type For TIBCO Cloud™ Live Apps

Refer to TIBCO Cloud™ Integration - Connect Agents for information on available agent types and how to select the best agent for your app.

Connecting To TIBCO Cloud™ Live Apps

Note: Best practice is to create Connections with credentials that limit permissions in the target system, following the principle of least privilege. Using Administrator level credentials in a Connection provides Administrator level access to the target system for TIBCO Cloud™ Integration - Connect users. Depending on the entities supported, a TIBCO Cloud™ Integration - Connect user could alter user accounts in the target system.

Select Connections from the menu.
From the Connections page select Create to open the Create a connection dialog.
Select the Connector from the list to open the Connection dialog, and then enter the following information for this Connection:
- Name — This can be any meaningful name, up to 25 characters.
- Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
- Username — Enter your Live Apps username.
- Password — Enter your Live Apps password.
- Region — Select your Live Apps region.
- Sandbox Type — Select either your Production or Developer sandbox.
- Organization — Enter your Live Apps organization. This is only applicable if you belong to more than one subscription in the region you are connecting to.
Select Test to ensure that the agent can connect to your database. Be sure to test the Connection against all agents that use this Connection. See Testing Connections.
Select OK/Save to save the Connection.

Metadata Notes

You must manually reset the metadata whenever you create or publish new Live Apps applications or update any of your Live Apps applications. See Resetting Metadata.

Naming

Connection metadata must have unique entity, relationship, and field names. If your Connection metadata has duplicate names, review the source system to determine if the duplicates can be renamed.

DateTime

The Live Apps date and time types are strings, in the format:

Date - YYYY-MM-DD
Time – HH:MM

However, if you map a DateTime format into either a date type or time type, Live Apps automatically converts them to the correct format for Live Apps.

Pick Lists

Pick lists are not supported.

Booleans

Booleans are treated as strings and all common boolean values are supported, such as True/False or T/F.

Null Values

Null values are supported.

Relationships

Hierarchical relationships, such as grandparent, parent, grandchild relationships are supported. See Hierarchical Data for examples. Selecting the Block Properties Include tab displays the child, grandchild and further nested relationships.
Parent/Child relationships are not supported.

Retry Logic

If a request fails, the Connector does not retry.

Live Apps Connector As An App Source

Consider the following when using the Live Apps Connector as an app source.

Filtering

Using Net Change to filter for new and updated records is not supported.
Filtering is only supported at the top level of a complex data type.
Nested complex types cannot be filtered.
AND and OR are both supported, but can only be used one at a time.
All operators are supported. Entities at the top-level can be filtered.
If no filters are used, all cases are returned.
Most filters are case insensitive.

Live Apps Connector As An App Target

Consider the following when using the Live Apps Connector as an app target.

Batch Processing

Batch processing is not supported.

TIBCO Cloud™ Integration - Connect API Considerations

To create connections with the TIBCO Cloud™ Integration - Connect API, the Live Apps Connector requires the following information:

Connector Name	TIBCO® Live Apps
Connector ID	37DCDACD-BC25-308B-957B-A5CAC7C13915

TIBCO Cloud™ Integration - Connect Connection Properties

In addition, this Connector uses the Connection properties shown in the following table.

Note: Connection property names are case-sensitive.

Name	Data Type	Required	Secured	Usage
Username	string	Yes	No
Password	string	Yes	Yes
Region	string	Yes	No
Sandbox Type	string	Yes	No
Organization	string	No	No	Required only if your username is in multiple organizations in the same region.

License Agreement

The TIBCO End User License Agreement for the Live Apps Connector describes TIBCO and your legal obligations and requirements. TIBCO suggests that you read the End User License Agreement.

More Information

For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.