Contents

Installation Overview
Operating System and Database Requirements
Installation Guidelines
Required Products
Required TIBCO Products
Required Third-Party Products
JDK Environment Variables
Installing TIBCO Product and Service Inventory
Postinstallation Tasks
Postinstallation Task 1: Copying Dependencies
Postinstallation Task 2: Creating the Database
Creating a PostgreSQL Database for the Admin User
Creating an Oracle Database for the Admin User
Creating a PostgreSQL Database for the TIBCO PSI User
Creating an Oracle Database for the TIBCO PSI User
Postinstallation Task 3: Creating the TIBCO Enterprise Message Service Channel
Postinstallation Task 4: Configuring the Installation
Postinstallation Task 5: Creating an Admin User
Postinstallation Task 6: Uploading Seed Data
Postinstallation Task 7: Starting or Restarting the Services
Installing Helm Chart
TIBCO Product and Service Inventory as a Container on Kubernetes
TIBCO Product and Service Inventory Bulk Load
Bulk Load for Oracle Database
Configuring for the Bulk Load for Oracle Database
CSV File and JSON Config File Samples for Oracle Database
Mandatory and Optional Columns for Oracle Database
Bulk Load for PostgreSQL Database
Configuring for the Bulk Load for PostgreSQL Database
CSV File and JSON Config File Samples for PostgreSQL Database
Mandatory and Optional Columns for PostgreSQL Database
Triggering the Bulk Load
Bulk Load Logging for Oracle Database
Bulk Load Logging for PostgreSQL Database
Product and Service Inventory Overview
Uses of Product and Service Inventory
Data Managed by Inventory
Object Locking
Lock Requests
Lock Notifications
Lock Modes
Create With Lock
Prevent Concurrent Update
Delayed Locking
Admin Update When Not Lock Owner Permission
Use Cases for Lock Obtained Notification
Use Cases for Lock Removal Notification
Use Cases for Lock Expired Notification
Batch Functionality
Configuration Values
Oracle RAC Configuration
Product and Service Inventory User Interface
Multitenancy in Product and Service Inventory
Basic Access Controls of Product and Service Inventory
Logging in to Product and Service Inventory
Product and Service Inventory Main Page
Searching Items and Parties
Logging out of Product and Service Inventory
Items
Adding a New Item
Searching an Item
Updating an Item
Locking an Existing Item
Deleting the Lock of an Item
Deleting an Existing Item
Parties
Adding a New Party
Searching a Party
Updating a Party
Locking a Party
Deleting the Lock of a Party
Deleting a Party
Locks
Viewing Locked Items
Viewing Locked Parties
Bulk Load
Bulk Load Process
Oracle Bulk Load Setup
Bulk Load JSON Configuration
Bulk Load Log Files
Configurator UI
Configuration Service
Authorization Service
REST Services Overview
REST Service Methods
REST Service Endpoint
REST Service Resource
REST Service Parameters
REST Service Request Body
Response Codes and Descriptions
Swagger API Reference
Swagger UI
Invoking an Operation
Generating an authorization token
Bulk Order Services
Start Bulk Load Operation
View Current Bulk Load Operation
View all the Bulk Load Operations
Party Services
Create Party
Get parties by query
Get party by id
Update a Party
Delete a Party
Add the Characteristics to a Party
View all the Characteristics of a Party
View the Characteristics of a Party
Update the Characteristics of a Party
Delete the Characteristics of a Party
Add a Lock to a Party
View all the Locks of a Party
View the Lock of a Party
Delete all Locks of a Party
Delete the Lock of a Party
Item Services
Add an Item
View all the Items
View an Item
Update an Item
Delete an Item
Add the Characteristics to an Item
View all the Characteristics of an Item
View the Characteristics of an Item
Update the Characteristics of the Item
Delete the Characteristics of an Item
Add a Relationship to an Item
View all the Relationships of an Item
View a Relationship of an Item
Delete the Relationship of an Item
Add an Order to an Item
View all the Orders of an Item
View an Order of an Item
Update the Order of an Item
Delete the Order of an Item
Add a Lock to an Item
View all the Locks on an Item
View the Lock of an Item
Delete all Locks of an Item
Delete the Lock of an Item
Search Services
Search for a Party
Search for an Item
Batch Services
Start batch
Complete batch
Get batch
Purge Services
Purge item by Ids
Purge all items
Purge party by Ids
Purge all parties
Architecture
Services and Operations
Integration Channels
SOAP Over HTTP
SOAP Over JMS
HTTP Header
TIBCO Product and Service Inventory Services
Common Elements
Lock Notification
Start Batch
completeBatch
Create
Create Sub Elements
Delete
Purge
Get
Get Sub Elements
Update
Update Sub Elements
Query
Query Sub Elements
Response Codes and Messages
TIBCO Documentation and Support Services
Legal and Third-Party Notices