Using Oracle Intelligent Track and Trace
Using Oracle Intelligent Track and Trace
24.1.3
Oracle Cloud
Using Oracle Intelligent Track and Trace
24.1.3
E98674-41
Contents
2 Get Started 3
Get Started with Oracle Intelligent Track and Trace ............................................................................................................... 3
Get Help
There are a number of ways to learn more about your product and interact with Oracle and other users.
Get Support
You can get support at My Oracle Support. For accessible support, visit Oracle Accessibility Learning and Support.
Get Training
Increase your knowledge of Oracle Cloud by taking courses at Oracle University.
i
Oracle Cloud Get Help
Using Oracle Intelligent Track and Trace
ii
Oracle Cloud Chapter 2
Using Oracle Intelligent Track and Trace Get Started
2 Get Started
This application harnesses the power of distributed ledgers and immutable data stores to remove the need for
intermediaries. You no longer require trusted third parties to verify, record, and coordinate transactions. Instead, you
determine who participates in the monitoring and verification process of any document exchanged. Get started with
Intelligent Track and Trace and learn how to access the cloud service.
Topics
• Before You Begin
• How to Access Intelligent Track and Trace
• Language Support
• How to Get Support
• Make sure you have link to access Oracle Intelligent Track and Trace and a user account. Typically these are
included in your subscription email, if you haven’t received this email, contact the system administrator. See
How to Access Intelligent Track and Trace.
You can find the name of your host in the email you received when you subscribed to the service.
2. Enter your user name and password.
3. Click Sign In.
3
Oracle Cloud Chapter 2
Using Oracle Intelligent Track and Trace Get Started
Language Support
The language settings in your web browser are used to determine which language the Sign In page and user interface is
displayed.
The following languages are supported for Intelligent Track and Trace.
• Arabic
• Chinese (Simplified)
• Dutch
• French (European)
• German
• Italian
• Japanese
• Korean
• Norwegian
• Portuguese (Brazilian)
• Russian
• Spanish
• Swedish
• Thai
• Turkish
• Vietnamese
4
Oracle Cloud Chapter 3
Using Oracle Intelligent Track and Trace Get to Know Oracle Intelligent Track and Trace Cloud
Service
Intelligent Track and Trace takes advantage of the power of Oracle Blockchain Platform. Transaction documents
exchanged between supply chain participants are securely and permanently recorded in an immutable ledger. Highest
level of encryption and data protection policy is used to share sensitive data with all stakeholders. Data sharing
increases transparency and product traceability.
Blockchain technology enables the network of business partners to agree upon key pieces of information which can be
shared across organization boundaries. This fosters a trust relationship between supply chain participants, ensuring
smooth movement of non-repudiable information.
Intelligent Track and Trace builds on the Oracle Blockchain Platform to enable end-to-end traceability of assets,
products, and transaction documents in supply chains to reduce delays and automate record keeping. This business-
ready blockchain application provides a digital ledger of products, documents, and movement of all these assets in your
business network. You can now track and manage each of your transaction data and assets in real time, define policy
and exceptions, resolve disputes, improve regulatory compliance, and gain business insights using advanced analytics.
Business Benefits
• Product Tracking: Intelligent Track and Trace enables you to track all the activities in a typical supply chain.
It also provides the tracking of lot-controlled and serial-controlled items and packages and can track events
across sourcing, manufacturing, storage, sale, shipment, or returns. This capability to track events affecting
serial or lot-controlled items enables Intelligent Track and Trace to support comprehensive backward or forward
trace for any given product. You can scroll through complete history of all related transaction documents
and environmental (IoT) data in a complex supply chain spanning multiple organizations. For example, a
pharmaceutical company manufacturing vaccines can track raw material, such as vials, arrivals from suppliers.
It can track current location of the raw material, shipping details, quality and condition (temperature/humidity
etc.) of the raw material delivered.
• Dispute Resolution: Using Intelligent Track and Trace you can setup rules and policies in the form of complex
smart contracts and can track compliance and exceptions. In case of any dispute, you can track and trace back
to the root cause. For example, a doctor in hospital determines that the consistency of vaccine is unusual. As
a pharmaceutical company manufacturing vaccines, you can trace through the supply chain to find what went
wrong.
• Business Insights and Analytics: Intelligent Track and Trace offers cross-organization business insights
at various level of details, starting from the bird's eye view of the business network, to full visibility of
5
Oracle Cloud Chapter 3
Using Oracle Intelligent Track and Trace Get to Know Oracle Intelligent Track and Trace Cloud
Service
all transaction documents. The application also provides the ability to drill down to specific transaction
documents, such as those with failed smart contract business rules. You can view issues with smart contracts
in any part of the supply chain to downstream organizations, calculate statistics based on end-to-end view, and
predict delays or yield issues.
• Trading Partners
• Documents
• Business Flows
Organizations
Trading partners are entities that do business together. In a supply chain network, trading partner participates in
transactions such as creating purchase orders, processing sales order, tracking shipments etc. These are key personas
in Intelligent Track and Trace that forms the business network and exchange transaction documents.
In Intelligent Track and Trace, trading partners are digital placeholders of your business partners. Based on the role
trading partners plays your network, they are classified into three types.
Founder is the owner of the business network. They create the network and invite the other organizations (endorsing
and participating partners) to join the network. Founder on-boards the partners of different types, and manages access.
Being the owner of the network, founder has its own dedicated ledger, can define own set of rules and policies, manage
6
Oracle Cloud Chapter 3
Using Oracle Intelligent Track and Trace Get to Know Oracle Intelligent Track and Trace Cloud
Service
and validate all transaction documents written to the ledger, and has visibility across all the documents exchanged in
the supply chain.
Endorsing Trading Partners are participants along with founder in the business network. Each transaction may have
one or more organizations as the participants. Like Founder, they can have their own dedicated ledgers, maintain their
own set of rules and policies, validate the transaction documents they own, and manage what is written to their ledger.
Participating Trading Partners are the lightweight organizations that do not have dedicated ledgers. They submit
documents for the business steps they are identified as submitter by the founder. They have limited visibility to the
network and business processes, and cannot perform any validations.
Documents
Any transaction carried out in a supply chain always has an associated document which is used to record the transaction
data. It also captures all the relevant information related to the transaction which can be later used for tracking and
tracing.
Supply chain operations comprise of complex logistical exercises involving multiple agencies including buyers, sellers,
transporters, shipping lines, customs departments etc. This supply chain network may extend beyond domestic and
global boundaries of all countries. The movement of assets from the origin to it's destination requires engagement and
interaction with all of the business network partners who have a stake in a transaction. Partners actively engage, and
have visibility to information and documentation involved at each step of the supply chain. Therefore, maintenance of
standardized documentation becomes an integral part of any supply chain transaction.
Exchange of information in the form of standardized documents not only facilitates in building trust relationships
between multiple partners, it also ensures traceability of assets and associated information which may be required for
complex decision making, such as dispute resolution etc.
Intelligent Track and Trace application ingests and processes these standardized documents received during the various
business flow steps. It produces a generic document which capture all key attributes of the input business document
including any relationships that the input document may have. This transformation of the standard document to a
generic one, depends on the document type and mapping that you provide when defining the steps of a business flow.
You can learn more about document types and mappings supported by Intelligent Track and Trace in Define Document
Types.
Business Flows
A Business Flow represents a set of steps involved in the core business processes of a supply chain, such as
procurement, manufacturing, distribution, sales etc.
A typical business flow in Intelligent Track and Trace is a logical grouping of business process steps that describe a
interaction between two or more trading partners. Each step of a business flow has an associated document which is
submitted by the identified trading partner. The submitted document is processed by the Intelligent Track and Trace
and is recorded securely in appropriate distributed ledgers along with extracted key attributes.
Intelligent Track and Trace keeps track of all processed documents and correlates each document to appropriate
business flow. For more information on business flows, see Configure Business Flows
7
Oracle Cloud Chapter 3
Using Oracle Intelligent Track and Trace Get to Know Oracle Intelligent Track and Trace Cloud
Service
The image represents the workflow for implementing Intelligent Track and Trace.
Invite Endorsing Trading Partners Send invites to the endorsing trading partners Invite an Endorsing Trading Partner
in your network to join Intelligent Track and
Trace .
Invite Participating Trading Partners Send invites to the participating trading Invite a Participating Trading Partner
partners in your network to join Intelligent
Track and Trace .
8
Oracle Cloud Chapter 3
Using Oracle Intelligent Track and Trace Get to Know Oracle Intelligent Track and Trace Cloud
Service
Complete Registration As a participating or endorsing trading partner, Join Founder's Network - Endorsing Trading
complete the registration process and setup Partner
Intelligent Track and Trace .
Join Founder's Network - Participating Trading
Partner
(Optional) Define Package Types As a founder admin, define different package Add and Manage Package Types
types or containers if required.
Define Item Types As a founder admin, define the item types that Add and Manage Item Types
map to the lot-controlled or serial-controlled
products in your supply chain.
(Optional) Add Item Type Code As an endorsing or participating trading Add Item Type Code
partner, for an existing item type, specify an
item type code that you use for referencing
them in your documents.
Define Document Types Add new document types to associate them Create a New Document Type
to business flow steps. For each document
type added, you have to upload JSON schema,
define mapping template, schema and
simulator template.
Define Business Flow Templates Create templates which define the steps Create a Business flow Template
involved in supply chain business flows in your
organization. These templates will then be used
to create business flow instances for products
with specific trading partners.
Define Business Flows Create business flows from business templates. Create a New Business Flow Instance
You can setup the visibility of trading partners
at step level. Business flows enable you to track
your assets involving specific trading partners
and vendors.
Update Viewers As an endorsing trading partner, add the Configure Business Flow Steps
viewers for the business flow steps for which
you have been identified as the document
submitter.
Validate and Activate Business Flow Activate the business flows by enabling Activate a Business Flow
document submission.
Once you have completed configuring Intelligent Track and Trace , the application starts ingesting documents received
for the defined business flows. Depending upon your role in the network, you can monitor and manage your assets,
serial or lot-controlled products, and documents. For more information, see Track Your Assets and Documents.
9
Oracle Cloud Chapter 3
Using Oracle Intelligent Track and Trace Get to Know Oracle Intelligent Track and Trace Cloud
Service
10
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
User Management
Topics
• Configure Trading Partner
• Manage Users
• Fine-grained Access Control
Topics:
• Understand Roles and Users
• Understand User Quota
11
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Topics
• Invite an Endorsing Trading Partner
• Invite a Participating Trading Partner
• View Trading Partner Details
• Edit Trading Partner Details
• Add Trading Partner Location
Topics
• Endorsing Trading Partner Tasks
• Participating Trading Partner Tasks
Intelligent Track and Trace supports three types of organizations in the business network— founder, endorsing trading
partner, and participating trading partner. Founder is the owner of the Intelligent Track and Trace instance, and is
responsible for inviting the trading partners to join and register with the application. Apart from organization's role,
founder and each of the trading partners are also responsible for creating appropriate user roles. The visibility of the
application's features and functionality depends on the user role granted to you. For each organization type, Intelligent
Track and Trace has a predefined set of user groups:
• Founder
◦ Administrator: The application administrator configures and maintains the application. Users with this
role have super-user privileges. An administrator can create, modify, delete and maintain all the entities
in the business network. It has visibility to track and trace all the business assets, and view end-to-end
matrices, analytics and business insights collected and calculated by Intelligent Track and Trace.
◦ Integration User Group: The application user can only post transaction documents using the published
REST API. As an integration user, you cannot login to the application, or perform any operation.
◦ Web Application User Group: All users in the founder organization assigned this role.
◦ Administrator: The application administrator can do everything with the domain of the endorsing
trading partner.
◦ Integration User Group: The application user can only post transaction documents using REST APIs,
within the domain of the endorsing trading partner. As an integration user, you cannot login to the
application, or perform any operation.
◦ Web Application User Group: Users with this role are basic users of endorsing trading partner
organization.
• Participating Trading Partners
◦ Administrator: The application administrator can do everything with the domain of the participating
trading partner.
12
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
◦ Integration User Group : The application user can only post transaction documents using REST API,
within the domain of the participating trading partner.
◦ Web Application Group: Users belong to this group are basic users of participating trading partner
organization
Functionality Web Integration Admin Web Integration Admin Web Integration Admin
Application Users Application Users Application Users
Users Users Users
Simulation No No Yes No No No No No No
Trading No No Yes No No No No No No
Partner
Management
Post Yes* Yes* Yes* Yes* Yes* Yes* Yes* Yes* Yes*
Documents
Yes* – These operations are permitted but only for their own organization. For example, Endorsing Trading Partner
Admins can modify the configuration for business flow steps for which their organization is assigned as submitter.
Universal Users
Total number of universal users refers to the total individual users allocated to the founder during subscription.
Universal users can be founder users, or endorsing trading partner users. The division of the allocated user quota
amongst the trading partners is the responsibility of the founder. As part of inviting endorsing trading partner, founder
can allocate a certain number of users from this universal user pool. That trading partners can create only the number
of users that founder has allocated.
Once the founder allocates the users to the trading partners, the universal quota count includes these allocated users,
irrespective of whether the trading partners have used their allocated quota or not. In case the number of users have
increased, founder can also buy more universal users.
13
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
When a user quota (universal and participating partner users) is assigned to the founder, the founder has the flexibility
to divide the quota among the trading partners, and reserve a few for himself. The trading partner in turn has the
responsibility of creating it's own users. The users created can have the role of – application user, admin, or user.
For example, a founder is assigned a quota of 20 universal users, and 10 participating users. The founder allocates 4
participating users each to two different participant trading partners. Now, the total number of available participant
users are 2, and available universal users are 20. If the founder allocates additional 5 users to participating trading
partners, then the total number of available participating users is 0 and available universal users is 17 (3 of these are
used as participating partner users).
The division of user quota is driven by the needs of the founder's business network. Intelligent Track and Trace provides
full flexibility to the founder on how the quota is divided.
As a founder, you on-board other peer organizations by sending them invites to join and register to Intelligent Track and
Trace.
1.
Click Menu ( ) and then click Configurations.
2.
Click Users Management ( ).
3. Under Trading Partners tab, click Invite.
4. In the Invite Trading Partner drawer, under Details, specify trading partner name, type, and business roles to be
assigned.
5. Under Primary User, specify the trading partner user details who will be granted the administrative privileges.
The email address is where Intelligent Track and Trace will send a welcome email. The admin user of the endorsing
trading partner will follow the instructions mentioned in the welcome email to join the founder network.
6. Under Users, specify the number of users you want to allocate to this endorsing trading partner.
7. Under Primary Address, enter the trading partner address, if the entry matches the exact address, the GPS
coordinates appears for your confirmation. If coordinates do not match, use location map to select the trading
partner location, that includes, trading partner address and the GPS coordinates.
Note: If no GPS coordinates are found, then Address not found message appears.
If the selected location does not match any specific address, then the closest location details, such as area/region,
state, country, and GPS coordinates will be used.
Use the location card to edit trading partner address. In this case, the GPS coordinates and location PIN details will
not change.
On the location map, you can drag the PIN to a different location and the corresponding address based on new pin
location, will be updated.
8. Click Invite.
Results:
An invitation email is sent to the endorsing trading partner at the email address provided under Primary User area.
The primary user is the admin user which has permission to perform all operations in the trading partner domain. The
admin user should follow the instructions provided in the email and register with Intelligent Track and Trace to join the
founder network.
14
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
1.
Click Menu ( ) and then click Configurations.
2.
Click Users Management ( ).
3. Under Trading Partners tab, click Invite.
4. In the Invite Trading Partner drawer, under Details, specify trading partner name, type, and business roles to be
assigned.
5. Under Primary User, specify the trading partner user details who will be granted the administrative privileges.
The email address is where Intelligent Track and Trace will send a welcome email. The admin user of the endorsing
trading partner will follow the instructions mentioned in the welcome email to join the founder network.
6. Under Users, specify the number of users you want to allocate to this endorsing trading partner.
7. Under Primary Address, user location map to select the trading partner location, that includes, trading partner
address and the GPS coordinates.
Note: If no GPS coordinates are found, then Address not found message appears.
If the selected location does not match any specific address, then the closest location details, such as area/region,
state, country, and GPS coordinates will be used.
Use the location card to edit trading partner address. In this case, the GPS coordinates and location PIN details will
not change.
On the location map, you can drag the PIN to a different location and the corresponding address based on new pin
location, will be updated.
8. Click Invite.
Results:
An invitation email is sent to the participating trading partner at the email address provided under Primary User area.
The primary user should follow the instructions provided in the email and register with Intelligent Track and Trace to
join the founder network.
1.
Click Menu ( ) and then click Configurations.
2.
Click Users Management ( ).
The Trading Partners tab under Configurations : User Management shows the list of Trading Partners along with
all the relevent information:
15
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
3. Select the any Trading Partner from the trading partner list or click Show Details under Actions to view the complete
information of the selected trading partner.
◦ Status: Indicates the status of the trading partner. Status can be any one of the following values - Invited,
Activated, or Registered.
◦ Type: Indicates the trading partner category.
◦ Users: The value is displayed in the format—Total users allocated/Users currently configured.
◦ Roles: Specifies the role of the trading partner. The value of this field is customer defined, and is populated
when you add the trading partner to the network.
◦ Primary User: Email and contact details of the admin user.
◦ Primary Address: Specifies the primary or secondary location of the trading partner.
Note: The location card allows you to edit the primary or secondary trading partner location. The delete option is
available only for the secondary location.
Note: Users with Trading Partner View - Provides read-only access to Trading Partners Configuration page
will only have viewing access to the trading partners details page. In this case, the Edit details and Add Location
options are not available.
1.
Click Menu ( ) and then click Configurations.
2.
Click Users Management ( ).
3. On the Trading Partners dashboard:
◦ Click trading partner name and then from the trading partner details page, click Add Location.
◦ Click Add Location under Actions.
4.
Click the Delete icon against the location you want to remove.
5. Provide trading partner Name, location, and Location ID details.
Use edit address icon from the location card to make necessary changes, if required.
To define a custom business ID type, see Define Business ID Types.
16
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
6. Click Save and wait until the Save successful message is displayed.
7. Click Cancel to return to the trading partner details page.
8. Click User Management to return to the Trading Partners dashboard.
Manage Users
You can create new users and can also add an existing Oracle Identity Cloud Service user to the application.
When creating users you should bear in mind that universal user quota is sum of—number of endorsing trading
partners, number of users allocated to the trading partner, number of founder users, and spill over participating user
quota (if any). The participating user quota spills into the universal quota in case it exceeds the participating users
purchased by the founder. You can also purchase additional user quota if you think current quota does not meet the
needs of your business networks.
Topics:
• Add a New User
• Edit a User
• Dissociate a User
• Reset Password for a User
• View Users
• Add an Existing Oracle IDCS User
• Generate an Application Token
• Delete an Application Token
1.
Click Menu ( ) and then click Configurations.
2.
Click Users Management ( ).
3. Under Users tab, click Add User.
4. Complete these fields under Personal area:
◦ First Name: Enter the name of the user
◦ Last Name: Enter the surname
◦ Assign Group: Select one or more groups from the drop-down list:
The default groups are:
- ADMIN
- APP_USER
- USER
For more information on user groups, see Permission Groups.
5. Complete these fields under Login area:
◦ Email: Enter the user email address
17
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Edit a User
1.
Click Menu ( ) and then click Configurations.
2.
Click Configurations : User Management ( ).
3.
Select the user you want to edit and click Edit User ( ).
4. Complete required changes under Personal area:
◦ First Name: Enter the name of the user
◦ Last Name: Enter the surname
◦ Assign Group: Select one or multiple groups from the drop-down list:
18
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Dissociate a User
Every user in the application is an Oracle Identity Cloud Service (idcs) user. When you need to remove a user from the
application, you can dissociate the user, which will not delete the user from IDCS.
1.
Click Menu ( ) and then click Configurations.
2.
Click User Management ( ).
3. Under Users tab, select the user you want to delete from the list of users displayed.
4.
Click Dissociate User ( ) next to the user you want to disassociate.
5. On the Confirm Disassociate page, click Dissociate.
View Users
1.
Click Menu ( ) and then click Configurations.
2.
Click User Management ( ).
3. Under Configurations : User Management dashboard, you can see the list of configured users displayed with
Name, Username, Groups, Phone. The Name column displays the full name including the name and surname of
the user. The user list includes:
◦ Admin users of trading partners
◦ All the users in the founder organization
The User Menu ( ) on the bottom right corner, displays your username, the name of your organization, and also
allows you to sign out from the instance.
1.
Click Menu ( ) and then click Configurations.
2.
Click User Management ( ).
3. Click Filter and from the drop-down list select Show Users.
4. Click the adjacent drop-down list and select IDCS Users.
5.
From the list of users, identify the IDCS user that you need to add to the application, and click Edit ( ).
19
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Application tokens are used by external applications or an Intelligent Track and Trace OIC (Oracle Integration Cloud)
adapter to connect securely with Intelligent Track and Trace. This method replaces the use of Oracle Identity Cloud
Service (IDCS) credentials for authentication of external applications or adapters. When an integration is configured
between the OIC adapter and Intelligent Track and Trace, a user can generate an application token which can then be
used by the integration adapter to generate the access token.
1. Sign in to Oracle Intelligent Track and Trace using your credentials.
2.
Click User Menu ( ) and select Application Tokens.
The Application Tokens page displays the list of application tokens that the logged-in user has generated.
20
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
3.
Click Generate Application Token ( ).
The Generate Application Token page displays the new application token and the Token Description field displays
the date and time of the generation.
21
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
22
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
4. Click Copy Application Token to copy the token to your system's clipboard, which you can paste on the integration
configuration screen.
5. If you have signed in as an administrator of a trading partner, then complete these steps to generate an application
token for any user of the trading partner:
a.
Click Menu ( ) and then click Configuration.
b.
Click User Management ( ).
c. On the Users page, identify the user for which you need to generate an application token and click
As a user of a trading partner you should have generated application tokens or as an administrator of a trading partner,
you should have generated application tokens for one or more users of the trading partner.
1. Sign in to Intelligent Track and Trace using your credentials.
2.
Click User Menu ( ) and select Application Tokens.
The Application Tokens page displays the list of application tokens that the logged-in user has generated.
3. Identify the token to delete from its description that displays the date and time of its generation. Click Revoke Token
( ) for that token.
A deleted successfully message is displayed along with the token description.
4. If you have signed in as an administrator of a trading partner, then complete these steps to delete an application
token for any user of the trading partner:
a.
Click Menu ( ) and then click Configuration.
b.
Click User Management ( ).
c. On the Users page, identify the user for which you need to delete an application token and click Generate
Access Control
Fine-grained access control is a function-specific permission model to control access to various application functions
within Intelligent Track and Trace application.
23
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
As an administrator, you define different access configurations based on the user groups and associated permissions
assigned to those groups. This enables various users in your organization to access specific components as a member
of the group.
Topic
• User Permissions
• Permission Groups
User Permissions
Permissions are authorizations to allow access to each application component. You must have required permissions to
perform a specific action or a series of actions associated with a task.
Permission Types
Permissions define the level of access rights available to you. These are:
• Administrative permissions: Administrative permissions are mapped to administrator functions. For example,
an admin user may have full configuration access or limited configuration access within Intelligent Track and
Trace application.
• Non-Administrative permissions: Non-Administrative permissions can be function specific as per business
requirement. For example, a non-admin user may have read-only permissions to selective functions.
Transitive permissions
Some permissions depend on other permissions to also be granted. As a user, instead of selecting all the dependent
permissions manually, the application determines the dependencies and automatically grants these permissions. This
piggy-backing approach further enhances the fine-grained access control capabilities with additional permissions
assigned implicitly along-with main permissions.
For example, for a user to invite new trading partners via configurations page, the user must have the trading partner
read permission. Here, TRADING PARTNER READ permission is a transitive (add-on) permission with TRADING PARTNER WRITE
permission.
Permission Definitions
To control access to various functions, you create permission groups and then assign users to the groups. The
permissions that you assign vary depending on the type of function you need to access.
24
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
The following table shows the permission mapping to ADMIN, APP_USER, and USER groups: For more information on
user groups, see Permission Groups.
Configuration TRADING_PARTNER_READ No Yes Yes No USER_READ, GLOBAL_APP_ Read-only access to Trading Partners
SETTINGS_RE AD Configuration page
SMART_CONTRACT_READ Yes Yes Yes No FLOW_DEFINIT ION_READ, EVENT_ Read-only access to Smart Contracts
ACTIO N_READ, UOM_READ Configuration page
DOCUMENT_INTEGRATI ON_ Yes Yes Yes No FLOW_DEFINIT ION_READ Read-only access to Document Integration
ENDPOINT_READ Endpoints page
DOCUMENT_INTEGRATI ON_ Yes Yes No No DOCUMENT_IN TEGRATION_E Read-write access to Document Integration
ENDPOINT_WRITE NDPOINT_READ Endpoints page
DOCUMENT_INTEGRATI ON_ Yes Yes No No FLOW_DEFINIT ION_READ Read-only access to Document Integrations
DEFINITION_READ and Activity Log page
DOCUMENT_INTEGRATI ON_ Yes Yes No No DOCUMENT_IN TEGRATION_D Read-write access to Document Integrations
DEFINITION_WRITE EFINITION_READ and Activity Log page
DOCUMENT_IN TEGRATION_E
NDPOINT_WRI TE
OUTBOUND_CONNECTIO N_WRITE Yes Yes No No OUTBOUND_C ONNECTION_R EAD Read-write access to Connections page
EVENT_ACTION_READ Yes Yes Yes No DOCUMENT_T YPE_READ, Read-only access to Event Actions page
OUTBOUND_C ONNECTION_R EAD
EVENT_ACTION_WRITE Yes Yes No No EVENT_ACTIO N_READ Read-write access to Event Actions page
ITEM_TYPE_WRITE Yes Yes No No ITEM_TYPE_C ODE_WRITE Read-write access to Item Types page
PACKAGE_TYPE_WRITE Yes Yes No No PACKAGE_TYP E_READ Read-write access to Package Types page
25
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
REPORT_TEMPLATES_D Yes Yes No No REPORT_TEMP LATES_DEFINI Read-write access to Report Templates page
EFINITION_WRITE TION_READ
USER_GROUP_WRITE Yes Yes No No USER_GROUP_ READ Read-write access to Groups page / tab
GLOBAL_APP_SETTINGS _WRITE Yes Yes No No GLOBAL_APP_ SETTINGS_RE AD Read-write access to Settings page
SMART_CONTRACT_PRO POSAL_ Yes Yes Yes No UOM_READ Access to Smart Contract Proposal page
READ
SIMULATION Yes Yes No No FLOW_DEFINIT ION_READ, UOM_ Covers simulation definition and running of
READ simulations
Operations DASHBOARD_READ No Yes Yes No FLOW_DEFINIT ION_READ, UOM_ Read-only access to Dashboards and
READ Trading Partner operations pages
DOCUMENT_TRACE No Yes Yes No DOCUMENT_T YPE_READ, UOM_ Access to operations pages Business Flows
READ and Documents
DOCUMENT_SUBMIT No Yes Yes Yes UOM_READ Access to Document Receiver REST API and
Document Endpoints page
All permissions are constrained by trading partner type. For example, FLOW_DEFINITION_WRITE grants founder users full
access to flow configuration screens, whereas endorser users can access and modify only certain entities. For example,
modify viewers of a flow/step where the trading partner is a submitter.
The following table shows the permission mapping based on current trading partner type:
26
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
27
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
28
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
29
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
30
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
31
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Permission Groups
A group is a set of permissions that defines the type of access associated to each component within Intelligent Track
and Trace.
32
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
As a user, you may be assigned to one or more permission groups. If you are a member of more than one group, you
will have the combined access and functionality of all the assigned groups.
Notifications
Product Tracking
• Predefined groups
Predefined groups are the preconfigured groups. Each group is created with a predefined user type role in your
environment. You cannot create, edit, or delete predefined groups. These are:
◦ ADMIN
◦ USER
◦ APP_USER
33
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
• Custom groups
Custom permission groups define access control based on a user type in your business environment. You
can add or modify custom permission groups, add users to these groups, or delete the groups if no users are
assigned to it. The two categories are:
◦ Administrative User Group
◦ Non-Administrative User Group
Topics
• Create Administrative Group with Full Admin Privileges
• Create Administrative Group with Restricted Admin Privileges
Topic
• Create Non-Administrative Group with Selective Privileges
Manage Groups
You can create new groups, add permissions to the groups, and can add new users or add an existing Oracle Identity
Cloud Service users to these groups.
Topics
• Create a Group
• Assign Users to Groups
• Edit a Group
• Delete a Group
Create a Group
Only founder administrator can create and manage groups. A group is a set of permissions and users must be assigned
to one or more groups based on the level of access needed.
You create groups with administrative permissions or non-administrative permissions. For more information on groups,
see Permission Groups.
To create a permissions group:
1.
Click Menu ( ) and then click Configurations.
34
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
2.
Click Configurations : User Management ( ).
3. Under Groups tab, click Create Group.
4. Complete these fields under Details area:
◦ Group Name: Enter the name of the group
◦ Description: Enter the short description about the purpose of the group.
◦ Group Type: Select any one of the group type as:
- Administrative
- Non-Administrative
5. Under Assign Permissions area, select the required permissions that you want to grant to the users of your
organization.
Note: A group must have at least one admin or non-admin permission. The transitive permissions are
automatically assigned with the main permissions. For more information on transitive permissions, see User
Permissions.
Note: You must assign at least one administrative permission to the group.
35
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
36
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
You need to configure document integrations only. With restricted admin access, you may only have permissions to
define document integrations.
Note: You must assign at least one administrative permission to the group.
Based on your business requirement, as a participating trading partner user, you need to complete the following
actions:
37
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
3. Under Assign Permissions area, assign permissions specific to the example use case requirement.
The following image shows the assigned permissions.
The transitive permissions associated with main permissions will be automatically assigned.
For list of available permissions, see User Permissions.
38
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
39
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
40
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Under Operations module, you can track items and packages and also submit documents. Whereas, under
Configurations module, you only have read-only access to the available functions.
Based on your business requirement, some endorsing trading partner users in your organization only need to
submit documents for a business flow step.
5. Under Assign Permissions area, assign permissions specific to the example use case requirement. For list of
available permissions, see User Permissions.
The following image shows the assigned permission(s).
The transitive permissions associated with main permissions will be automatically assigned.
41
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
42
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
43
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Under Operations module, Document Submission is available. Whereas, under Configurations module, you only
have read-only access to Units Of Measure.
Edit a Group
You can modify the set of permissions assigned to a custom group.
You can edit both Administrative and Non-Administrative permission groups. Predefined permission groups are
immutable and cannot be edited. To modify a custom group:
1.
Click Menu ( ) and then click Configurations.
2.
Click Configurations : User Management ( ).
3. Select the custom group you want to edit and click Group Details ( ).
4. Assign or un-assign permissions based on the user access requirements.
5. Click Save and wait until the Save Successful message appears.
6. Click Close to return to the User Management dashboard.
Delete a Group
You can delete administrative or non-administrative custom groups if they are no longer needed. You cannot delete a
predefined group.
Note:
44
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Oracle Intelligent Track and Trace users can be filtered based on their username, the group they are assigned to, and
other miscellaneous details. The groups data can be filtered based on the group type and based on a predefined
classification of group category, such as Administrative or Non-Administrative.
1. Select either the Users or the Groups tab to apply required filters.
2. Click the Filter bar and select single or multiple field name(s) from the list.
3. From the selected column attribute drop-down, select the required operator.
The following operators are available based on the selected attribute type:
4. In the Search Filter Criteria field, enter the filter criteria and then click outside the filter box.
Results:
The following image illustrates the filtered data based on the given criteria.
45
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Topics:
• About Document Type Structure
• Create a New Document Type
• Edit a Document Type
• Delete a Document Type
As a founder, you can either use pre-seeded document types in the Intelligent Track and Trace, or can define your
own customized document types. Each document type consists of five essential parts, which are document schema,
metadata template, metadata schema, simulator template, and presentation template. You can provide multiple
definitions or variants for a single document type where each definition or variant will have the five essential parts. The
five essential parts are described as follows:
• Document Schema: Defines the structure of the document in the standard JSON format. Intelligent Track and
Trace is currently complaint with JSON Schema Draft 5. Intelligent Track and Trace provides JSON schema for
the preseeded document types. For more information, see Define Document Schema JSON. However, as a
founder, you can upload your own raw JSON schema if the preseeded document types does not suit the needs
of your supply chain network. Intelligent Track and Trace validates the syntax of the uploaded JSON schema
and throws exception in case of any error.
• Metadata Template: Defines the type mapping which enables the Intelligent Track and Trace application to
process the incoming documents and extract key pieces of information. Metadata template is essentially a set
of key value pairs, which maps the JSON schema to the application schema. This mapping is important for
Intelligent Track and Trace to understand the structure of the document described in the JSON schema, and
ingest information which is then written to the ledger. This extracted data is used for tracking, tracing, and
calculating analytics and insights. For the preseeded document types, out-of-the-box mapping is provided.
For customized document types, founder decides which key pieces of information are important, and provides
the mapping. Only mapped information extracted from the document is written to the ledger, and the
document is stored in Oracle Storage Cloud in encrypted form. The document in Storage Cloud is linked to the
corresponding entry in the ledger by adding the location and the hash of the document to the ledger entry. For
more details, see Define Metadata Template.
• Metadata Schema:
Defines user-definable attributes that extends the system-defined normalized data structure. You may have
a requirement to track attributes in addition to the ones already mapped. These attributes can be added as a
list of key value pairs under the Metedata Template section. For Intelligent Track and Trace to understand the
document data, the user needs to define the data type of each of the field specified. For example, if the user
46
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
has defined a field named "buyername" in the Metadata Template, then in Metadata Schema tab you have to
define the data type of "buyername", it can be a String, an array of Strings, measure type etc. For more details,
see Define Metadata Schema.
• Simulator Template: are used for generating synthetic transactions during simulation. Simulations is one of
the key functionality which lets you test the multiple what-if scenarios in your business network. For testing
these scenarios you need data which is part of the flow which you want to test. Simulator template defines how
you can simulate a document (such as purchase order), and the attributes in the document which will be used
for the simulation. In the template you provide either constant values or value generating expressions such as
random number, random strings and references to other documents in the flow. This template is then used
by the simulator to generate transactions for testing various business scenarios. For more details, see Define
Simulator Template.
• Presentation Template: The incoming source document, ingested by Intelligent Track and Trace, is received in
raw JSON format as defined in the document schema. This source document may be difficult to interpret by the
end user due to the complex JSON schema structure. Intelligent Track and Trace enables you to define a HTML
presentation template, which is used to display the incoming source document in a human readable rich text
format. The pre-seeded document types already have pre-defined presentation templates. For more details,
see Define Presentation Template. For any new documents types defined, you as a founder should also define a
presentation template.
After the document structure is defined, document ingestion process begins and the document type schema is used for
incoming document processing.
47
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
For a detailed information on how to define a document type JSON, metadata template, metadata schema and
simulator template, see Define Document Schema and Templates.
Topics:
• Create a New Document Type from Scratch
• Create a New Document Type by Duplicating an Existing Document Type
• Create a New Variant for an Existing Document Type
To create a document type from scratch, you must upload the raw JSON schema, define metadata mappings and
schema, create simulator template, and define the presentation template. The procedure provides the basic steps
of creating a new document type. You can refer to the Define Document Schema and Templates to understand how
to create a JSON schema for a document type, and how to define mappings, schema, simulator templates and
presentation templates.
1.
Click Menu ( ) and then click Configurations.
2.
Click Document Types ( ).
3.
Under Configurations : Document Types dashboard, click Create New Document Types ( ).
4. In the Create: Document Type, enter the Name of the document type, and select a color for the document from
Document Color drop-down menu.
5. Enter the attributes in the Metadata Schema area. This is common across all variants and should be defined only in
one location.
6. Click Save and wait until the Save successful message is displayed.
7. Click Cancel to return to the Configurations : Document Types dashboard.
Your document type is displayed and the Default variant in the new document type is created.
8.
To complete the Default variant, click Edit ( ) adjacent to the name of the variant.
The four parts of the Default variant document type are displayed.
9. If required, rename the name of the variant.
10. Click Document Schema tab. Open the raw JSON schema of the document type. You can directly copy paste the
JSON schema in the text area tab.
11. Click Metadata Template tab. Enter the type mapping for the document.
12. Click Simulator Template tab. Enter the simulator template details for the document.
13. Click Presentation Template tab. Enter the presentation template details for the document.
14.Click Save and wait until the Save successful message is displayed.
48
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
In a scenario, where an existing document type is similar to the new document type with few variations, you can
duplicate the existing type and make modification on top of it. This saves time and effort involved in creating JSON
schema and other mappings from scratch.
1.
Click Menu ( ) and then click Configurations.
2.
Click Document Types ( ).
3. Select the document type that you want to duplicate from the list of Document Types in the left pane.
4.
Click Duplicate Document Type ( ) on the right side of the Document Type name.
5. In the Duplicate Document Type, enter the Name of the document type, and click Duplicate.
The duplicate document type is displayed on the Configurations : Document Types dashboard.
To edit the duplicate document type or its variants see Edit a Document Type.
You should have an existing document type for which you want to create a new definition or variant.
Note: You can neither delete system-defined document types nor modify their document schema . Other
components of a system-defined document type can be changed but will require manual updates or upgrades to new
versions. It is recommended to create a new variant for a system-defined document type if there is a need to modify
the structure or one ore more of the type definitions
1.
Click Menu ( ) and then click Configurations.
2.
Click Document Types ( ).
3. On the Configurations : Document Types dashboard, from the left bar, click the document type for which you need
to add a new definition or variant. Note that the document types that display a ( ) beside its name are system-
defined.
4.
For the selected document type, adjacent to its Variants label, click Add Variant ( ).
The Create: Document Types window is displayed.
49
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
5. In the Create: Document Type, enter the Name of the variant for the document type, and select a color for the
document from Document Type Color drop-down list.
6. Click the Document Schema tab. Upload the raw JSON schema of the document type. You can directly copy paste
the JSON schema in the text area tab.
7. Click Metadata Template tab. Enter the type mapping for the document.
8. Click Simulator Template tab. Enter the simulator template details for the document.
9. Click Presentation Template tab. Enter the presentation template details for the document.
10. Click Save and wait until the Save successful message is displayed.
11. Click Cancel to return to the Configurations : Document Types dashboard.
Results:
The new document type variant is added under in the VARIANTS list.
To modify the template schema, which is common for all the variants, you'll need to edit the document type. See Edit a
Document Type.
1.
Click Menu ( ) and then click Configurations.
2.
Click Document Types ( ).
3. Under Configurations : Document Types dashboard, select the document that you want to edit from the list of
documents in the left pane.
4.
On the right hand pane, next to the name of document, click Edit ( ).
5. Make the necessary changes in the Name, Document Type Color.
6. If required, modify the Metadata Schema, which is common across all the variants of the document type.
7. Click Save and wait until the Save successful message is displayed.
8. Click Close to return to the Configurations : Document Types dashboard.
9.
To modify a variant of this document type, select the variant name and click Edit ( ) adjacent to the variant
name.
10. Modify the document structure definition under Document Schema, Metadata Template, Simulator Template, or
Presentation Template tabs.
11. Click Save and wait until the Save successful message is displayed.
12. Click Cancel to return to the Configurations : Document Types dashboard.
50
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
2.
Click Document Type ( ).
3. Select the Document Type that you want to delete from the list of document types in the left pane.
4.
On the right hand pane, next to the name of the document type, click Delete ( ).
Topics:
• About Business Flow Templates
• Create a Business flow Template
• Duplicate a Business flow Template
• Edit a Business Flow Template
• Delete a Business Flow Template
A business flow consists of a series of steps, where each step represents exchange of transaction documents
between the trading partners. For an organization, the steps in a business flow for common supply chain operations
(procurement, manufacturing etc) remain the same.
Here, the steps when buying material A and material B will remain same. The only difference would be the item being
purchased, and the trading partners involved. Even the document types associated for each step remains the same,
they will differ only with respect to their contents and values.
Intelligent Track and Trace enables you to define business flow templates, which are then used to create business flow
instances. Using the graphical interface you can:
• Define the business steps for a template, where each business step represents a transaction.
• Identify the associated document type. The document types are the same that you have defined in Create a
New Document Type
• Define the placeholders for the trading partners involved, and the role of each trading partner ( for example,
buyer, seller etc)
51
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
• Specify who would be the business document submitters for each step. There can be multiple submitters in a
step.
• Logically sequence the business steps in the order of their occurrence. Note that the sequence is not enforced
at runtime. Documents can arrive into the network in any order and the application orders them correctly
according to the sequence defined in the flow template.
For a procurement flow example, here is a sample procurement template created in Intelligent Track and Trace:
You can now use this template to create individual business flow instances for procuring Material A, Material B and
Material C.
In Intelligent Track and Trace, business template is the starting point of creating any business flow instance.
1.
Click Menu ( ) and then click Configurations.
2.
Click Business Flow Templates ( ).
3.
Under Configurations : Business Flow Templates dashboard, click Create New Business Flow Template ( ).
4. In the New : Business Flow Templates area, enter the Name of the business template.
52
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
5.
Click Add Business Step ( ).
53
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
You can use duplication functionality when there are minor differences between business flow templates.
1.
Click Menu ( ) and then click Configurations.
2.
Click Business Flow Templates ( ).
3. Under Configurations : Business Flow Templates dashboard, select the business flow template that you want to
duplicate from the list of templates in the left pane.
4.
Click Duplicate ( ) next to the name of the business flow template in the right pane.
5. In the Duplicate : Business Flow Templates area, enter the Name of the business template.
6.
Click Add Business Step ( ) if you want to add new business step to the existing template flow. For each new
business step enter:
◦ Step Name: Specify the name of the step.
◦ Document Type: Select the document associated with the step from the drop-down. The drop-down lists
all the document types that you had defined as part of Create a New Document Type.
◦ Submitter Role: Select the role of the trading partners who will be submitting the document for this step.
The drop-down lists all the roles that you have defined as part of Invite an Endorsing Trading Partner and
Participating Trading Partner Tasks. You can select multiple submitter roles.
7.
Click Edit ( ) if you want to modify any of the existing business steps.
8. Click Save to close the Edit Template Step dialog box.
9. Repeat step 5 and 6, for all the steps that you want to add to this business flow template.
10.
If there is any error while adding steps, you will see a Warning Sign ( ) on top of that step. Click on the Warning
Sign and fix the error.
11. Click Save and wait until the Save successful message is displayed.
12. Click Cancel to return to the Configurations : Business Flow Templates dashboard.
1.
Click Menu ( ) and then click Configurations.
2.
Click Business Flow Template ( ).
3. Under Configurations : Business Flow Templates dashboard, select the template that you want to edit from the list
of templates in the left pane.
54
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
4.
On the right hand pane, next to the name of template, click Edit ( ).
5. Edit the Name, if required.
6. To edit a business flow template:
◦ Identify the business step that you need to modify or delete.
◦ Click the business step and make the required changes.
◦ To delete the step, click Delete Template Step
◦ Click Save.
7.
To add a new business step, identify the position of the new step in the flow, and then click ( ). In the dialog box,
enter the required details and click Save.
8. Repeat Steps 6 and 7 for modifying or deleting any step and adding steps at any position in the flow respectively.
9. Click Save and wait until the Save successful message is displayed.
10. Click Cancel to return to the Configurations : Business Flow Templates dashboard.
Packages are boxes or containers that are used to encase items for shipping. Only the founder admin of a business
network can create package types. The endorsing and participating trading partners of a business network cannot
create package types.
Topics
• Create a Package Type
• Edit a Package Type
• Duplicate a Package Type
• Delete a Package Type
55
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
As a founder admin, you should have the details, such as the name, description, one or more image files, attributes of a
package that needs to be tracked in the business network by the application
1.
Click Menu ( ) and then click Configurations.
2.
Click Package Types ( ).
3.
On the Configurations : Package Types dashboard, click Create New Package Type ( ).
4. On the New: Package Types drawer, enter or select values for the following fields:
◦ Name: Enter the name of the item type
◦ (Optional) Description: Enter a description of the item type.
◦ (Optional) Package Image: Click Choose Image, browse to the location where you have saved the item's
image file, select it, and then click Open. Repeat the step, if you have more image files to upload for this
item type.
◦ Attributes: Click Add Attribute. Enter a name value pair in the text boxes. Click Add Attribute to add
another attribute. To remove an attribute, click Delete ( ) beside the added attribute.
5. Click Save and wait until the Save successful message is displayed.
6. Click Close to return to the Configurations : Package Types dashboard.
Results:
Verify that your package type is listed on the left navigation bar and its details are displayed on the central frame.
To edit a package type, you should know the name of the item type that you have created and needs to be edited.
1.
Click Menu ( ) and then click Configurations.
2.
Click Package Types ( ).
The list of package types that you've created in the application are displayed.
3. On the Configurations : Package Types dashboard, from the left navigation bar, click the item type that you need to
edit.
4.
On the details section of the item type, click Edit ( ).
5. On the Edit : Package Types drawer, modify the value of the fields as required.
6. Click Save and wait until the Save successful message is displayed.
7. Click Cancel to return to the Configurations : Package Types dashboard.
56
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Results:
Verify that your item type is listed on the left navigation bar and its updated details are displayed on the central frame.
To duplicate a package type, you should know the name of the package type that you have created and needs to be
cloned.
1.
Click Menu ( ) and then click Configurations.
2.
Click Package Types ( ).
The list of package types that you've created in the application are displayed.
3. On the Configurations : Package Types dashboard, from the left navigation bar, click the package type that you
need to edit.
4.
Om the details section of the package type, click Duplicate ( ).
5. On the Duplicate : Package Types drawer, modify the value of the fields as required.
6. Click Save and wait until the Save successful message is displayed.
7. Click Cancel to return to the Configurations : Package Types dashboard.
Results:
Verify that your package type is listed on the left navigation bar and its updated details are displayed on the central
frame.
To duplicate a package type, you should know the name of the item type that you have created and needs to be cloned.
1.
Click Menu ( ) and then click Configurations.
2.
Click Package Types ( ).
The list of item types that you've created in the application are displayed.
3. On the Configurations : Package Types dashboard, from the left navigation bar, click the item type that you need to
edit.
4.
Om the details section of the item type, click Delete ( ).
5. On the Confirm Delete dialog box, click Delete.
Results:
Verify that your package type is not listed on the left navigation.
57
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Topics:
• About Business Flows
• Create a New Business Flow Instance
• Edit a Business Flow
• Activate a Business Flow
Intelligent Track and Trace lets you define a business flow which is based on a business flow template. When you
configure a business flow, you can specify:
• The trading partners responsible for submitting the document and the trading partner who would receive the
document.
• The viewers that are one or more trading partners who can view the document submitted for a step. Intelligent
Track and Trace provides step level control to the founder or a document submitter to constrain the visibility of
the document that is submitted in a business step.
• A document timeout value in minutes, hours, or days. When a business flow is activated and if a business step
does not receive its associated document within a time interval after a specified document has arrived, then the
document timeout event is generated. In response to this event, the event handler processes an action, which
can be configured by you as an in-app notification, an email message, or an HTTP API call out.
Once the business flow has been activated, Intelligent Track and Trace receives documents for each of the business step
involved in the flow. For more information on activation of a business flow, see Activate a Business Flow.
58
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
In Intelligent Track and Trace, a business flow template is the starting point of creating any business flow instance. You
should have completed the steps in Create a Business flow Template before you can create a business flow.
1.
Click Menu ( ) and then click Configurations.
2.
Click Business Flows ( ).
3.
Under Configurations : Business Flows dashboard, click Create New Business Flow ( ).
4. In the New Business Flow dialog box, enter a name in the Name field and select the Template from which you
need to create a business flow.
5. Click Create.
The business flow instance based on the selected template opens in an edit mode.
6.
Click Edit ( ).
The Edit : Business Flows > [Flow Name] page is displayed.
59
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
7.
Open each step of the business flow by clicking the flow step header ( ) icon and provide the following
information:
◦ Submitters with role "BUYER": Select the trading partners who will be the document submitter for this
step. You can select multiple submitters in a step. The drop-down lists all the trading partners with the user
role specified in the template for the submitter of this step. For example, if you have selected "buyer" for
this field in the template, then all the trading partners with the "buyer" role are listed in the drop-down.
◦ Viewers: Select Business Roles or Trading Partners or both to set step viewers. The document submitter
and the founder can setup zero or more viewers for the business step.
- Business Roles: Select viewers based on the assigned roles. All tradings partnters with the assigned
roles will be grouped and become viewers of that step.
- Trading Partners: Select specific trading partners who can view this business step and all the
documents associated with it. The drop-down lists all the trading partners in the network.
◦ Enable Document Versioning: (Optional) This option enables you to submit multiple versions of a
transaction document for a flow step of a business flow instance. For more details, see Access Document
Versions.
8. Click Save to close the Business Flow Step Editor drawer.
9. Repeat Step 7, for all the steps in a business flow.
10.
If there is any error while adding steps or the configuration is incomplete, you see a Warning ( ) icon on top of
Note: If you've successfully completed the required configurations for all the steps of the new business flow, then:
• The Finish Editing button is enabled.
• Click Finish Editing to change the state to Disabled.
• You cannot delete the business flow after you have clicked Finished Editing.
• When the business flow is ready to receive documents, use the Document Submission slide bar to enable it.
The business flow gets activated in the Enabled state.
60
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
If you have signed in as a founder, you can view and edit all the business flows of the network. For an endorsing trading
partner, only those business flows are displayed for editing, in which the trading partner is a submitter in one or more
business steps.
1.
Click Menu ( ) and then click Configurations.
2.
Click Business Flows ( ).
3. On the Configurations : Business Flows dashboard, select the Business Flow that you want to edit from the list of
business flows in the left navigation pane.
4.
On the right hand pane, next to the name of the business flow, click Edit ( ).
The steps of the business flow are displayed.
5.
On the Edit: Business Flows > <Business Flow Name> page, identify the step you need to edit. Click Edit ( ) and
provide the following information:
◦ Submitters: Select the trading partners who will be the document submitter for this step. You can select
multiple submitters in a step. The drop-down lists all the trading partners with the user role specified in
the template for the submitter of this step. For example, if you have selected "buyer" for this field in the
template, then all the trading partners with the "buyer" role are listed in the drop-down.
◦ Viewers: Select Business Roles or Trading Partners or both to set step viewers. The document submitter
and the founder can setup zero or more viewers for the business step.
- Business Roles: Select viewers based on the assigned roles. All tradings partnters with the assigned
roles will be grouped and become viewers of that step.
- Trading Partners: Select specific trading partners who can view this business step and all the
documents associated with it. The drop-down lists all the trading partners in the network.
As a founder, you can remove one or more existing viewers from the step even for an active business flow.
6. Click Save to close the edit pane.
7. Repeat Step 5 for all the steps in the business flow.
8.
If there is any error while adding steps or the configuration is incomplete, you see a Warning ( ) icon on top of
61
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Note: As a founder, If you as have successfully completed the required configurations for all the steps of the new
business flow, then:
• The Finish Editing button is enabled.
• Click Finish Editing to change the state to Disabled.
• You cannot delete the business flow after you have clicked Finished Editing.
• When the business flow is ready to receive documents, use the Document Submission slide bar to enable it.
The business flow gets activated in the Enabled state.
Before you can activate a business flow, it should be in disabled state, which you can achieve by clicking Finish Editing
for the business flow.
1.
Click Menu ( ) and then click Configurations.
2.
Click Business Flows ( ).
3. On the Configurations : Business Flows dashboard, from the left navigation bar, select the Business Flow that you
want to activate.
4. Ensure that the state of the business flow is Disabled. Otherwise, in the State section of the business flow, click
Finish Editing.
Note: After you click Finish Editing, you cannot delete a business flow.
5. To enable the business flow, in the State section, slide the Document Submission slide bar.
The state of the business flow changes to Enabled, which means trading partners can submit documents for the
steps of this business flow.
An Item Type in Oracle Intelligent Track and Trace is a unique product, raw material, or a semi-finished product, and may
be identified by stock keeping units (SKU)s, global trade item number (GTIN) or any other unique identifier.
62
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
The endorsing and participating trading partners of a business network cannot create items types. They can Add Item
Type Code to an existing item type created by the founder.
Topics
• Create an Item Type
• Edit an Item Type
• Duplicate an Item Type
• Delete an Item Type
• Upload Item Types from a CSV File
As a founder admin, you should have the details, such as the code, description, one or more image files, attributes of an
item that needs to be tracked in the business network by the application.
1.
Click Menu ( ) and then click Configurations.
2.
Click Item Types ( ).
3.
On the Configurations : Item Types dashboard, click Create New Item Type ( ).
4. On the New : Item Types drawer, enter or select values for the following fields:
◦ Name: Enter the name of the item type.
◦ Item Type Code: Enter the id of the item type.
Note: For a founder, each item type code needs to be unique and the founder can use unique identifiers,
such as, SKU, product codes, GTIN and so on. If trading partners use a different identifier to refer to this
item, they need to add their identifier to this item in the application. See Add Item Type Code.
another attribute. To remove an attribute, click Delete ( ) beside the added attribute.
Note: Attributes can be any name-value pair that provide additional information about the item. For
example, a list of ingredients in the product that this item represents.
5. Click Save and wait until the Save successful message is displayed.
6. Click Close to return to the Configurations : Item Types dashboard.
Results:
63
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Verify that your item type is listed on the left navigation bar and its details are displayed on the central frame.
To edit an item type, you should know the name of the item type that you have created and needs to be edited.
1.
Click Menu ( ) and then click Configurations.
2.
Click Item Types ( ).
The list of item types that you've created in the application are displayed.
3. On the Configurations : Item Types dashboard, from the left navigation bar, click the item type that you need to
edit.
4.
On the details section of the item type, click Edit ( ).
5. On the Edit : Item Types drawer, modify the value of the fields as required.
6. Click Save and wait until the Save successful message is displayed.
7. Click Close to return to the Configurations : Item Types dashboard.
Results:
Verify that your item type is listed on the left navigation bar and its updated details are displayed on the central frame.
To clone an item type, you should know the name of the item type that you have created and needs to be cloned.
1.
Click Menu ( ) and then click Configurations.
2.
Click Item Types ( ).
The list of item types that you've created in the application are displayed.
3. On the Configurations : Item Types dashboard, from the left navigation bar, click the item type that you need to
edit.
4.
64
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
To delete an item type, you should know the name of the item type that you have created and needs to be deleted.
1.
Click Menu ( ) and then click Configurations.
2.
Click Item Types ( ).
The list of item types that you've created in the application are displayed.
3. On the Configurations : Item Types dashboard, from the left navigation bar, click the item type that you need to
delete.
4.
On the details section of the item type, click Delete ( ).
5. On the Confirm Delete dialog box, click Delete.
Results:
Verify that your item type is not listed on the left navigation.
To upload item types, as a founder admin, first download the CSV file template, add item types inventory details, such as
item name, type code, UOM code, and item type image, and attributes, and then upload the file in a zip format to .
1.
Click Menu ( ) and then click Configurations.
2.
Click Item Types ( ).
3. On the Configurations : Item Types dashboard, you can either select Create new Item Type or Upload Item Types.
4. Click Upload Item Types.
A drawer will slide open from the right side of the Configurations : Item Types dashboard.
5. Click Download CSV template.
A CSV file template is downloaded on your computer.
6. In a CSV file, add the item types details as per the instructions given in the template file.
The following sample CSV file provides the structure of adding new item types.
7. (Optional) You can retain the default filename or rename as per your choice.
65
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Note: Create a zip file directly by selecting CSV file and the referenced image files added in the CSV file, without
adding them in to a folder.
66
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
9. Go to Upload Item Types drawer, select the zip file from your computer, drag and drop it over the Drag and Drop
area.
You can view the upload status under the Upload Details area.
The upload status may vary based on the correctness of the zipped CSV file.
67
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
68
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
◦ Completed With Errors: When the zipped CSV file data is populated correctly but the required reference
file is not part of the zip bundle. For example, an image name is added in the CSV file but the image file is
missing in the zip bundle.
69
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
70
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
You can also download the error report by clicking the Download Error Report.
10. The overall upload activity status and error report information can be viewed by selecting one of the following
options:
◦ Use the Upload Activity Logs link to view the upload status and error report.
◦
Click the Activity Log ( ) icon to view the upload status.
Configure Integrations
Intelligent Track and Trace supports integration with other Oracle applications for tracking transaction documents. It
also enables you to integrate custom applications built in Oracle Visual Builder Studio to be viewed within Track and
Trace UI.
Topics
• Configure Document Integrations
71
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Topics
• Integrate with Oracle Cloud Messaging Framework
• Integrate with Oracle Transportation Management
• Integrate with Oracle Manufacturing Cloud
• Integrate with Oracle Procurement
• Integrate with Oracle Inventory Management
• Integrate with Oracle Order Management
• Integrate with Oracle IoT Fleet Monitoring
• About Oracle Integration Cloud Adapter
• Integrate with Oracle Warehouse Management
https://otmgtm-a577982-
dev1.otm.us6.oraclecloud.com/
logisticsRestApi/
resources-int/v2
72
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
https://fuscdrmsmc240-
fa-ext.us.oracle.com/
fscmRestApi/
resources/11.13.18.05
https://fuscdrmsmc240-
fa-ext.us.oracle.com/
fscmRestApi/
resources/11.13.18.05
73
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
https://fuscdrmsmc240-
fa-ext.us.oracle.com/
fscmRestApi/
resources/11.13.18.05
Oracle Transportation Management (OTM) is used by shippers and logistic providers for its transportation planning
and execution capabilities. OTM integrates transportation planning, execution, freight payment, and business process
automation in a single application across all modes of transportation.
Integrating with OTM, Oracle Intelligent Track and Trace provides the following advantages:
• Ability to track the state of a business process during its shipment phase when moving from order to
fulfillment.
• Complete visibility and traceability to the shipment life-cycle.
The XML documents that are sent as messages from or to OTM are also known as the Transmission.
Transaction interface are definitions related to high level business object interfaces including orders,shipments,
invoices. The Transmission primary document will contain one or more Transaction interface elements.
74
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Create and configure the following entities in Oracle Transportation Management to enable integration with Oracle
Intelligent Track and Trace:
• External System: Contains the endpoint and authentication details of Oracle Intelligent Track and Trace. The
endpoint is
/bca/api/tntIntegrations/v1/networks/local/otm
• Agent: Configured with properties, qualifiers and triggers that are applied on the transactions. You configure
the agent to send only the transaction envelope that contains the (ShipmentGUID) to the external system. The
external system retrieves the relevant sub-component (Interface) of the referenced shipment by invoking the
REST API.
1.
Click Menu ( ) and then click Configurations.
2.
Click Integrations ( ).
3. Under Configurations : Integrations dashboard, select Document Integrations tab and then click Create New
Document Integration ( ).
4. Enter the following values:
◦ Name: Specifies the integration name
◦ Oracle Cloud Applications: Select Logistics.
◦ Interface: Select Shipments (OTM).
5. Enter the following in the Test Instance and Production Instance sections:
◦ Document Retrieval URL: Specifies the endpoint that will be used by the application for periodic polling
and retrieval of shipment documents from Oracle Transportation Management Cloud.
◦ Username : Specifies the Oracle Transportation Management Cloud username to be used for
authenticating requests.
◦ Password: Specifies the Oracle Transportation Management Cloud password for authentication.
75
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
76
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
6. Click Verify Test Connectivity to test the connection between Intelligent Track and Trace test instance and the
Oracle Transportation Management test instance.
7. Click Verify Production Connectivity to test the connection between Intelligent Track and Trace production
instance and the Oracle Transportation Management production instance.
77
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
8. Click Save and wait until the Save successful message is displayed. You can see the OTM document integration
configuration displayed on the dashboard.
78
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
79
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Before you can configure an integration endpoint, the concerned step of the business flow must use the Shipment
document type.
1.
Click Menu ( ) and then click Configurations.
2.
Click Document Integration Endpoints ( ).
80
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
3. Under Configurations : Document Integration Endpoints dashboard, select the business step for which you want
to add document integration.
The right hand pane displays the REST endpoint URL for selected business step, along with an option to configure
document integration.
Note: Configure button will only appear for the business steps which have been defined using the pre-seeded
document types.
81
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
82
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
5. Click Save and wait until the Save successful message is displayed.
6. Click Cancel to return to the Configurations : Document Integration Endpoints dashboard.
83
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Oracle Manufacturing provides a supply chain solution for discrete manufacturing companies complementing other
Oracle Supply Chain Management and Manufacturing Cloud applications. It lets you to set up, manage, execute, and
cost your production operations.
In Oracle Manufacturing, a work order refers to a document that conveys the authority for the production of a specific
product. It contains information about what, how, how many, and when to manufacture a product. The product item,
work definition details, operations, resources, components, quantities, and dates are specified in the work order.
After you enable the Oracle Manufacturing integration, Intelligent Track and Trace will periodically poll for new or
updated work orders. It filters the work orders, fetches and feeds them to the application. The work orders supported in
Intelligent Track and Trace are:
• Discrete work orders
• Process work orders
Your Intelligent Track and Trace instance is pre-seeded with the discrete work order and process work order document
types. As a founder or a trading partner, to integrate your application instance with Oracle Manufacturing, you must use
these pre-seeded document types when defining your business flows.
To configure the out-of-the-box integration, you need to complete the following steps:
1. Configure Oracle Manufacturing.
2. Establish a communication channel between Intelligent Track and Trace and Oracle Manufacturing.
3. Associate integration endpoints and configure filters based on available keys in Intelligent Track and Trace.
It is assumed that you have already completed Step 1 and performed the procedures to create work orders in Oracle
Manufacturing.
As a trading partner administrator, you must complete Steps 2 and 3 to establish an integration channel between
Intelligent Track and Trace and Oracle Manufacturing.
• Create Document Integration
• Configure Integration Endpoint
Oracle Order Management provides a supply chain solution to improve order fulfillment for your business processes.
It allows organizations to configure fulfillment monitoring, global availability, and enterprise-wide policies to increase
customer satisfaction and profitability.
After you enable the Oracle Order Management integration, Intelligent Track and Trace will periodically poll for new
or updated sales orders. It filters the sales orders, fetches the sales orders via REST API to retrieve the documents by
initiating StatusCode='OPEN' query, and then feeds them to the application. The document supported in Intelligent Track
and Trace is Sales Orders.
84
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Your Intelligent Track and Trace instance is pre-seeded with the sales order document types. As a founder or a trading
partner, to integrate your application instance with Oracle Order Management, you MUST use the pre-seeded document
types when defining your business flows.
To configure the out-of-the-box integration, you need to complete the following steps:
As a trading partner administrator, you must complete Steps 2 and 3 to establish an integration channel between
Intelligent Track and Trace and Oracle Order Management.
Oracle Procurement delivers comprehensive direct and in-direct sourcing, purchasing, and supplier management across
any modern supply chain management system. By integrating with Oracle Procurement, Intelligent Track and Trace can
provide complete visibility and traceability of purchase orders that appear in its business flows.
In Oracle Procurement, a purchase order refers to a document that is a formal authorization to purchase goods or
services. It contains details of the goods or services that you require, estimated costs, quantities, delivery schedules,
and accounting distributions.
After you enable the Oracle Procurement integration, Intelligent Track and Trace will periodically poll for new or updated
purchase orders. It filters the purchase orders, fetches and feeds them to the application.
Your Track and Trace instance is pre-seeded with the purchase order document types. As a founder or a trading partner,
to integrate your application instance with Oracle Procurement you MUST use this pre-seeded document type when
defining your business flows.
To configure the out-of-the-box integration, you need to complete the following steps:
As a trading partner administrator, you must complete Steps 2 and 3 to establish an integration channel between
Intelligent Track and Trace and Oracle Procurement.
85
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Oracle Inventory Management allows organizations to consolidate their inventory tracking and control systems into a
single, global inventory management solution for materials in every stage of the product or production life-cycle across
different business types.
In Oracle Inventory Management, the details of a completed transaction includes location details, transaction type,
transaction date, transaction source, shipment details, purchase order, receipts, any user-defined fields and many more.
After you enable the Oracle Inventory Management integration, Intelligent Track and Trace will periodically poll for any
updates on completed transactions. It filters the transactions, retrieves and feeds them to the application.
To configure the out-of-the-box integration, you need to complete the following steps:
1. Configure Oracle Inventory Management.
2. Establish a communication channel between Intelligent Track and Trace and Oracle Inventory Management.
3. Associate integration endpoints and configure filters based on available keys in Intelligent Track and Trace.
It is assumed that you have already completed Step 1 and are familiar with the procedures to review completed
transactions in Oracle Inventory Management.
As a trading partner administrator, you must complete Steps 2 and 3 to establish an integration channel between
Intelligent Track and Trace and Oracle Inventory Management.
• Create Document Integration
• Configure Integration Endpoint
The integration supports the concerned documents and you need to create a document integration for each type of
document that you submit for one or more business flow steps.
1.
Click Menu ( ) and then click Configurations.
2.
Click Integrations ( ).
86
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
3. Under Configurations : Integrations dashboard, select Document Integrations tab and then click Create New
Document Integration ( ).
4. Enter the following values:
◦ Name: Specifies the integration name.
◦ Oracle Cloud Applications: Select the cloud application for which you are configuring the integration.
◦ Interface: For Oracle Manufacturing, select the appropriate type of work order used in your business flows.
Notice that the associated document types are displayed under Supported Documents.
87
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
5. Enter the following in the Test Instance and Production Instance sections:
◦ Document Retrieval URL: Specifies the endpoint that will be used by the application for periodic polling
and retrieval of relevant documents from the specific Oracle Fusion Cloud application.
◦ Username: Specifies the particular Oracle Cloud application's username to be used for authenticating
requests.
◦ Password: Specifies the password for authentication.
88
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
89
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
6. Click Verify Test Connectivity to test the connection between Track and Trace test instance and the specific Oracle
Fusion Cloud application's test instance.
7. Click Verify Production Connectivity to test the connection between Track and Trace production instance and the
specific Oracle Fusion Cloud application's production instance.
8. Enter the OrganizationId of the test and production instance.
9. Click Save and wait until the Save successful message is displayed.
10. Click Cancel to return to the Configurations : Integrations dashboard. You can see the document integration
configuration displayed on the dashboard.
11.
To edit the configuration, click Edit ( ), modify the values, click Save, and then click Close.
12.
To delete the configuration, click Delete ( ) and confirm.
Before you can configure an integration endpoint, the concerned step of the business flow must use the specific pre-
seeded document type.
1.
Click Menu ( ) and then click Configurations.
2.
Click Document Integration Endpoints ( ).
90
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
3. Under Configurations : Document Integration Endpoints dashboard, select the business step for which you want
to add document integration.
The right hand pane displays the REST endpoint URL for the selected business step, along with a button to configure
the document integration.
Note: Configure button will only appear for the business steps which have been defined using the pre-seeded
document types.
91
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
92
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
5. Click Save and wait until the Save successful message is displayed.
6. Click Cancel to return to the Configurations : Document Integration Endpoints dashboard.
Oracle IoT Fleet Monitoring offers real-time monitoring of vehicles, drivers, shipments, and trips by providing real-time
visibility of vehicle location, cost of operation, vehicle usage, and driving behavior.
93
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
After you configure and enable the integration in Oracle IoT Fleet Monitoring, it pushes periodic updates of shipment
data, that contains geolocation, vehicle's sensor attributes, and date/time of events.
On configuring and enabling the integration in Intelligent Track and Trace, it will receive shipment data periodically. It
filters the shipment documents, fetches and feeds them to the application.
Your Track and Trace instance is pre-seeded with the shipment document type. As a founder or a trading partner, to
integrate your application instance with Oracle IoT Fleet Monitoring, you MUST use these pre-seeded document types
when defining your business flows.
To configure the out-of-the-box integration, you need to complete the following steps:
1. Establish a communication channel between Intelligent Track and Trace and Oracle IoT Fleet Monitoring.
2. Configure Oracle Fleet Monitoring.
3. Associate integration endpoints and configure filters based on available keys in Intelligent Track and Trace
application.
As a trading partner administrator, you must complete these steps to establish an integration channel between
Intelligent Track and Trace and Oracle Fleet Monitoring.
To configure the integration in Oracle Fleet Monitoring, see Integrate with Oracle Intelligent Track and Trace.
Oracle Warehouse Management Cloud supports inventory management from the manufacturing source to the end user
and can push inventory history transaction data of their managed facilities to Intelligent Track and Trace, which is used
by Intelligent Track and Trace for tracking its business flows.
On configuring and enabling the Oracle Warehouse Management integration in Intelligent Track and Trace, you
can obtain a specific endpoint URL You use the URL to configure and enable the integration in Oracle Warehouse
Management, which then pushes periodic updates of inventory history transaction data to Intelligent Track and Trace.
Intelligent Track and Trace receives inventory data as XML documents, filters and feeds them to the application.
Your Track and Trace instance supports 18 documents types of inventory history transactions and these document
types are pre-seeded into your instance. As a founder or a trading partner, to integrate your application instance with
Oracle Warehouse Management and receive the inventory data, you MUST use these pre-seeded document types when
defining your business flows.
To configure the out-of-the-box integration, as a trading partner administrator, you need to complete the following
steps:
1. Establish a communication channel between Intelligent Track and Trace and Oracle Warehouse Management.
See Configure a Document Integration.
2. Associate integration endpoints and configure filters based on available keys in Intelligent Track and Trace. See
Configure Integration Endpoint.
3. Configure Oracle Warehouse Management to schedule jobs that send data in XML format to your Track and
Trace instance. See Configure Oracle Warehouse Management
94
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Complete the following steps to configure a document integration for Oracle Fusion Cloud applications, such as Oracle
Warehouse Management or Oracle Fleet Monitoring, that push data to Intelligent Track and Trace.
1.
Click Menu ( ) and then click Configurations.
2.
Click Integrations ( ).
3. On the Configurations : Document Integrations dashboard, select Document Integrations tab and then click
Note the URL that is displayed, which is needed to configure the Oracle Fusion Cloud application that will integrate
and push data to your Track and Trace instance.
Before you can configure an integration endpoint, the concerned step of the business flow must use the specific pre-
seeded document type.
1.
Click Menu ( ) and then click Configurations.
2.
Click Document Integration Endpoints ( ).
3. Under Configurations : Document Integration Endpoints dashboard, select the business step for which you want
to add document integration.
95
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
The right hand pane displays the REST endpoint URL for the selected business step, along with a button to configure
the document integration.
Note: Configure button will only appear for the business steps which have been defined using the pre-seeded
document types.
96
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
97
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
5. Click Save and wait until the Save successful message is displayed.
6. Click Cancel to return to the Configurations : Document Integration Endpoints dashboard.
You should have noted the Track and Trace instance endpoint URL that you obtained in the Configure a Document
Integration task. View About Inventory History Transaction Codes to know the 18 inventory history transaction (IHT)
codes of Oracle Warehouse Management that are accepted by the Track and Trace instance.
98
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
You can create one job for all the 18 inventory history transactions or create multiple jobs with each job scheduled
for a group of operations or transactions. For example, activity codes generated during work order processing could
be grouped together under one scheduled job and activity codes generated during QC process could be grouped
under another scheduled job. Alternatively, you can create a single scheduled job for all the activity codes. Alerts are
automatically sent when the scheduled jobs are invoked.
Sign in to Oracle Warehouse Management as an administrator and perform the following steps to schedule a job for all
the IHT codes, configure the output interface, and set the output interface target.
Note: When you set the flags, Oracle Warehouse Management prompts for the administrator password.
3. When the scheduled job is executed, it sends an alert by using the Output Interface setup. Click Output Interface
Configuration. For Inventory History Export, set the Interface Format field to XML.
4. To open the Output Interface Target page, click the Details icon.
5.
To create a target for Inventory History Target, click Add ( ) and enter or select the following values:
◦ URL: Enter Intelligent Track and Trace endpoint URL that you obtained when you configured the
integration in Intelligent Track and Trace. For example: https://<instance name>/oraclecloud.com/bca/api/
tntIntegrations/v1/networks/local/transaction/wms/1
Note: If the user credentials change in Intelligent Track and Trace, ensure that you update these fields.
Results:
When the scheduled job is executed, you can verify the outbound messages in the Output Interface page.
99
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
For a Failed status, to obtain the details about the transmission of that message and reason for failure, select the
message and click Interface Logs.
Oracle Intelligent Track and Trace supports 18 IHT codes of Oracle Warehouse Management Cloud and provides
corresponding document type that maps to each IHT code.
This table provides the list of IHT codes and their mapping transactions that are supported and accepted by Oracle
Intelligent Track and Trace.
IHT - 73 QC Accepted
100
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
IHT - 74 QC Rejected
Oracle Intelligent Track and Trace provides different end points for trading partners to submit business transaction
documents such as purchase orders, sales orders, or work orders, which are tracked in its business flows. Trading
partners can use the Oracle Intelligent Track and Trace OIC adapter to post these transactions documents from various
business applications into Oracle Intelligent Track and Trace.
Benefits of Using the Oracle Intelligent Track and Trace OIC adapter
The Oracle Intelligent Track and Trace OIC adapter is one of the many predefined adapters included with Oracle
Integration Cloud. The benefits of using this adapter are:
• The OIC mapping mechanism enables automated integration between Oracle Intelligent Track and Trace
instances and different data sources.
• The adapter enables authorized users to push a variety of data to Oracle Intelligent Track and Trace document
ingestion endpoint.
• The adapter can be configured as an invoke based connection when creating an integration in Oracle
Integration Cloud.
Note: When you create a new business flow and want to use it in OIC adapter, you must refresh the metadata for the
corresponding connection. In connection metadata, all entity references are stored that you can integrate with.
To configure an integration by using the Oracle Intelligent Track and Trace OIC adapter, see Understand Oracle
Intelligent Track and Trace Adapter.
101
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
As a founder admin, you configure Custom Views by registering custom application URL that you want to embed into
Track and Trace application UI.
Access to Custom Views require appropriate permissions. As a founder admin, you define access rights to users
(participating or endorsing Trading Partners) to configure and/or view Custom Views.
The tasks that you can execute to configure Custom Views are:
Topics
• Create a Custom View
• View Custom Views
• Edit Custom Views
• Delete Custom Views
When you create a new custom views, you can integrate a non-contextual custom views or contextual, customized
views built as an extension to Document types or Item types.
Before you start
You should have required permissions to create Custom Views.
Custom UI Views
To create non-contextual custom views:
Here's what to do
1.
Click Menu ( ) and then click Configurations.
2.
Click Integrations ( ).
102
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
3. Under Configurations : Integrations dashboard, select Custom Views tab and then click Create Custom View.
103
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
104
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
105
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
b. From the Document Types drop-down list, select one or more document types to which you want to link
the associated custom views.
106
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
The URL Preview displays the key-value mapping of the selected documents for which the custom view
pages will be linked and appear on the Documents dashboard.
107
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
108
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
b. Select one or more item types for which you want to link the customized views.
109
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
The URL Preview displays the key-value mapping of the lot-controlled or serial-controlled item types that
you select, for which the custom view pages will be linked and appear on the Items dashboard.
7. Click Save and wait until the Save Successful message appears.
8. Click Cancel to return to the Configurations : Integrations dashboard.
Custom UI Views that are not specific to Documents or Item types can be viewed from the Custom Views dashboard.
Before you start
You should have required permissions to access Custom Views dashboard.
Custom UI Views
To view all custom UI views:
Here's what to do
1.
Click Menu ( ) and then click Operations.
2. Click Custom Views .
All the non-contextual custom views appear in the Custom Views dashboard.
Note: The contextual custom views are not listed under the Custom Views dashboard.
3.
Click View ( ).
The custom view appears in an iFrame view.
1. Contextual Custom Views
Custom Views associated to Document and Item types can be accessed from the Documents and Items
dashboard.
110
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
111
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Note: By default, Open Custom View icon is disabled. To enable it, set the Status attribute to Enabled when you
create a custom view.
An embedded custom view for the given URL is displayed in an IFrame view.
112
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
113
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
The following image illustrates a Purchase Order document with multiple custom views.
A drop-down icon next to the Open Custom View shows two different custom views associated to a single Purchase
Order document.
Here's what to do
1.
Click Menu ( ) and then click Configurations.
2.
Click Integrations ( ).
3. Under Configurations : Integrations dashboard, select Custom Views.
4.
Select the Custom View and click Edit ( ).
5. On the Edit Custom Views page, enter the values as required.
114
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
6. Click Save and wait until the Save successful message is displayed.
7. Click Cancel to return to the Configurations : Integrations dashboard.
Topics:
• About Report Templates
• Create a new Report Template
• Edit a Report Template
• Clone a Report Template
• Delete a Report Template
Report Template is a structure defined for generating trace reports for the selected items.
115
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
1.
Click Menu ( ) and then click Configurations.
2.
Click Report Templates ( ).
3.
On the Configurations : Report Templates dashboard, click Create New Report Template ( ).
4. In the New : Report Templates area, enter values for the following fields:
◦ Name: Enter the name of the report template.
◦ (Optional) Description: Enter a description of the report template.
◦ Template: Enter the attributes in the Template metadata area.
5. Click Save and wait until the Save successful message is displayed.
6. Click Cancel to return to the Configurations : Report Templates dashboard.
Results:
Verify that a report template is listed on the left navigation bar and its details are displayed on the central frame.
To edit a report template, you should know the name of the report template that you have created and needs to be
edited.
1.
Click Menu ( ) and then click Configurations.
2.
Click Report Templates ( ).
The list of report templates that you've created in the application are displayed.
3. On the Configurations : Report Templates dashboard, from the left navigation bar, select the report template that
you need to edit.
4.
On the details section of the report template, click Edit ( ).
5. On the Edit : Report Templates page, modify the value of the fields as required.
6. Click Save and wait until the Save successful message is displayed.
7. Click Cancel to return to the Configurations : Report Templates dashboard.
Results:
Verify that your report template is listed on the left navigation bar and its updated details are displayed on the central
frame.
To duplicate an report template, you should know the name of the report template that you have created and needs to
be cloned.
116
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
1.
Click Menu ( ) and then click Configurations.
2.
Click Report Templates ( ).
The list of report templates that you've created are displayed.
3. On the Configurations : Report Templates dashboard, from the left navigation bar, select the report template that
you need to clone.
4.
To delete a report template, you should know the name of the report template that you have created and needs to be
deleted.
1.
Click Menu ( and then click Configurations.
2.
Click Report Templates ( ).
The list of report templates that you've created in the application are displayed.
3. On the Configuration : Report Templates dashboard, from the left navigation bar, click the report template that you
need to delete.
4.
On the details section of the item type, click Delete ( ).
5. On the Confirm Delete dialog box, click Delete.
Results:
Verify that your report template is not listed on the left navigation.
Configure Settings
Oracle Intelligent Track and Trace lets you integrate with third-party map providers. As a founder, you can customize
the application to use the maps and search facility included by your map provider. When you select a third-party map
provider, the built-in maps get replaced with the maps provided by your map provider.
117
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Topics:
• Add Third Party Map Providers
• Customize Application Appearance
• Configure Security Settings
• Define Business ID Types
Note: You configure HERE maps using OAuth mechanism. Instead of using HERE maps login credentials, such as
Application ID and Application Code, generate an access token for authenticating to HERE maps. To generate the
access token, you must first generate OAuth credentials (access key ID and access key secret) as described in the
HERE Developer portal at https://developer.here.com.
◦ Access Key ID: This is the access key credential used for authenticating to HERE maps using OAuth
mechanism. Generate and enter the access key from the https://developer.here.com website.
◦ Access Key Secret: This is the secret credential used for authenticating to HERE maps using OAuth
mechanism. Generate and enter the access key secret from the https://developer.here.com website.
7. Click Validate. After you receive a success message, click OK and close the window to return to the Settings page.
8. Click Save and wait until the Save successful message is displayed.
9. Click Cancel to return to the Configurations : Settings dashboard.
Results:
The Map page now starts using maps from your specified map provider in place of the built-in maps. With HERE Maps,
you can choose to display the satellite or terrain view as well. Choose from amongst the following options on the map:
• Classic
• Satellite
• Terrain
The option to see points of interest is also available in all the HERE Maps layers.
118
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
If you wish to revert to using the built-in Oracle maps, you can choose Oracle Maps from the Configurations : Settings
page.
To configure appearance:
1.
Click Menu ( ) and then click Configurations.
2.
Click Settings ( ).
3.
Under Configurations : Settings dashboard, click Edit ( ).
4. Under APPEARANCE, specify the following:.
◦ Application Name: Name of the application which you want to be displayed in the title bar. By default
Oracle Intelligent Track and Trace is displayed.
◦ App Logo: Application logo to be displayed on the title bar of the UI console. By default Oracle logo is
displayed. Select Custom if you want to display a customized logo.
◦ Choose Image File: Upload a custom image which will be displayed in the title bar of the UI console. This
option is enabled only when you select Custom in App Logo. Ensure that the image uploaded has a white
119
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
background, and image height is not more than 22 pixels. Images with height more than 22 pixels are
scaled to fit and may appear distorted.
◦ Show Application Name: Select this option if you want to display application name in the title bar. Note
that the name displayed is the same that you have specified in field Application Name.
◦ Show Logo: Select this option if you want to display the application logo in the title bar of the UI console.
Note the logo displayed is the same that you have specified in App Logo field.
5. Click Save and wait until the Save successful message is displayed.
6. Click Cancel to return to the Configurations : Settings dashboard.
As a founder admin you can restrict access to the application instance by specifying domains that can access the
application. Complete the following steps to set this security setting:
1.
Click Menu ( ) and then click Configurations.
2.
Click Settings ( ).
3.
Under Configurations : Settings dashboard, click Edit ( ).
4.
In the Security section, next to the text box, click Edit ( ).
120
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
5. On the Security dialog box, in the Allow Access From Domain text box, enter the address of the domain that can
access your application and click OK.
The Allow Access From Domain functionality also supports Cross-Origin Resource Sharing (CORS), which allows
you to add multiple domains that allow users of external applications, such as Visual Builder Studio etc., to access
Track and Trace application APIs.
Note: The users of external applications must be a valid Track and Trace users.
6. Click Save and wait until the Save successful message is displayed.
7. Click Cancel to return to the Configurations : Settings dashboard.
As a founder admin, complete the following steps to add new or modify the existing business identifier types:
1.
Click Menu ( ) and then click Configurations.
2.
Click Settings ( ).
3. On the Configurations : Settings dashboard, scroll within the BUSINESS IDENTIFIER TYPES section, and then click
Edit ( ).
4.
On the Business Identifier Types page, click Add ( ).
At the bottom of the existing list of business identifier types, two text boxes appear.
5. Under Type, in the new text box, enter the business ID type, and in the text box under Description, enter the
information that describes the business ID type.
6.
To delete any exiting business ID type, next to its description, click Delete ( ) and then click Confirm to complete
the deletion.
If required, you can modify the value of the existing business identifier types and their descriptions.
7. Click Save and wait until the Save successful message is displayed.
8. Click Cancel to return to the Configurations : Settings dashboard.
Topics:
• About User Define UOM Code
121
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
As a founder administrator, use the following properties to define a UOM code of your choice:
• Code: A string that uniquely identifies the UOM code. For example, BAG.
• Label: A string describing the UOM code, such as sack, bag and so on.
• Description: A statement describing the UOM code.
• Conversion Factor: A constant value by which the unit of measure is multiplied and converted to a base unit.
Scenario
Let us assume that the items shipped are packed in a carton and each carton contains 24 bottles. In this case, you can
configure the user defined UOM code as:
The following table is an example of the category to which the code belongs and its corresponding base unit of
measure.
Unit of Measure Class Unit of Measure Base Unit of Measure Conversion Factor
1.
Click Menu ( ) and then click Configurations.
2.
Click Units Of Measure ( ).
122
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
3.
On the Configurations : Units Of Measure dashboard, click Create New Unit Of Measure ( ).
4. In the New : Units Of Measure area, enter values for the following fields:
◦ Code: Enter the name of the UOM code.
Note: UOM code string is case-sensitive.
1.
Click Menu ( ) and then click Configurations.
2.
Click Units Of Measure ( ).
The list of UOM codes that you've created in the application are displayed.
3. On the Configurations : Units Of Measure dashboard, from the left navigation bar, select the UOM code that you
need to edit.
4.
On the details section of the Units of Measure, click Edit ( ).
5. On the Edit : Units Of Measure page, modify the value of the fields as required.
Note: After a UOM code is created, the UOM class property cannot be modified.
6. Click Save and wait until the Save successful message is displayed.
7. Click Cancel to return to the Configurations : Units Of Measure dashboard.
Results:
Verify that your UOM code is listed on the left navigation bar and its updated details are displayed on the central frame..
123
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
To duplicate UOM code, you should know the name of the UOM code that you have created and needs to be cloned.
1.
Click Menu ( ) and then click Configurations.
2.
Click Units Of Measure ( ).
The list of UOM codes that you've created are displayed.
3. On the Configurations : Units Of Measure dashboard, from the left navigation bar, select the UOM code that you
need to duplicate.
4.
Topics:
• Join Founder's Network
• Configure Business Flow Steps
• Submit Documents
• Manage Users for Endorsing Trading Partners
• Add Item Type Code
• View Package Types
124
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
The first email contains instructions to activate your account with Oracle Intelligent Track and Trace and setup your
password. Follow the instructions provided in the email to setup and register your account. Here is the screenshot of a
sample activation email:
The second email provides the steps to access Oracle Intelligent Track and Trace application. Here is a screenshot of the
sample access email:
125
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
An endorsing trading partner, as a document submitter can specify the viewers for a business step and configure the
document timeout event.
Note: As a founder, you can modify the endorsing trading partner configuration to allow or restrict them to specify
viewers for a business step. See Modify a Trading Partner.
A viewer has a read-only permission for all the transaction documents associated with the business step.
You can optionally configure the document timeout event that lets you select a time and a document. When the
business flow is enabled for document submission and if the specified document does not arrive within the specified
time limit, the document time-out event gets generated.
1.
Click Menu ( ) and then click Configurations.
2.
Click Business Flows ( ).
3. On the Configurations : Business Flows dashboard, from the left navigation bar, select the business flow for which
you need to add viewers.
126
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
4.
Click Edit ( ) next to the name of the flow.
The steps of the business flow are displayed.
icon.
5.
Identify the step in which you need to add viewers, click the step's Document ( ) icon, and provide the following
information:
◦ Viewers: Select the trading partners who can view this business step and all the documents associated with
it. The drop-down lists all the trading partners in the network. The document submitter and the founder
can setup zero or more viewers for the business step.
- Business Roles: Select viewers based on the assigned roles. All tradings partnters with the assigned
roles will be grouped and become viewers of that step.
- Trading Partners: Select specific trading partners who can view this business step and all the
documents associated with it. The drop-down lists all the trading partners in the network.
6. Click Save to close the step window.
7. Repeat Step 5 and 6 for all the steps in the business flow that you need to edit.
8.
If there is any error while adding steps, you will see a Warning Sign ( ) on top of that step. Click on the Warning
Sign and fix the error.
9. Click Save.
10.
If there is any error while configuring steps or the configuration is incomplete, you see a Warning ( ) icon on top
of that step. Click Warning and fix the error.
11. Click Save and wait until the Save successful message is displayed.
12. Click Cancel to return to the Configurations : Business Flows dashboard.
127
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Submit Documents
Oracle Intelligent Track and Trace provides an application UI based and REST API based mechanism to the trading
partners to submit documents into the network.
When a business flow is activated, Oracle Intelligent Track and Trace generates a REST endpoint for each of the business
steps. You can integrate these REST endpoints with your REST clients or integration tools to post documents. You
can only submit documents for the business steps for which you have been identified as a submitter. As a submitter,
you can optionally attach files such as, image files, pdf files, or audio files, when submitting the documents using the
Submit document REST API. Alternatively the submitter can login to the application and upload documents for the
relevant business steps. The documents should follow a Oracle Intelligent Track and Trace defined JSON schema or CSV
template, which are available for download. To submit a document, complete one of the following methods.
Oracle Intelligent Track and Trace has three types of user roles defined for the trading partners—administrator, web
application user, and integration user. You can read more about these roles and their access permissions in Understand
Roles and Users.
To manage users in your Oracle Intelligent Track and Trace instance, see Manage Users
To add a code to an existing item type, as a trading partner admin, you should know the name of the item type to which
you will associate a new code..
1.
Click Menu ( ) and then click Configurations.
2.
Click Item Types ( ).
The list of item types in the application are displayed.
3. On the Configurations : Item Types dashboard, from the left navigation bar, click the item type for which you need
to add an item code.
4. On the details section of the item type, click Add Item Type Code and enter your code and click Save.
Results:
128
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Oracle Intelligent Track and Trace will create and association between the founder's item type code and the trading
partner's item type code for the item type.
As a trading partner admin, you can view the package types that the founder has created in the application.
1.
Click Menu ( ) and then click Configurations.
2.
Click Package Types ( ).
The list of package types in the application are displayed.
3. On the Configurations : Package Types dashboard, from the left navigation bar, click the package type to view its
details in read-only mode.
Results:
The details of the package type is displayed on the central frame.
Topics:
• Join Founder's Network
• Submit Documents
• Manage Users for Participating Trading Partners
• Add Item Type Code
• View Package Types
The first email contains instructions to activate your account with Oracle Intelligent Track and Trace and setup your
password. Follow the instructions provided in the email to setup and register your account.
129
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
The second email provides the steps to access Oracle Intelligent Track and Trace application. Here is a screenshot of the
sample access email:
Submit Documents
Oracle Intelligent Track and Trace provides an application UI based and REST API based mechanism to the trading
partners to submit documents into the network.
When a business flow is activated, Oracle Intelligent Track and Trace generates a REST endpoint for each of the business
steps. You can integrate these REST endpoints with your REST clients or integration tools to post documents. You
can only submit documents for the business steps for which you have been identified as a submitter. As a submitter,
you can optionally attach files such as, image files, pdf files, or audio files, when submitting the documents using the
Submit document REST API. Alternatively the submitter can login to the application and upload documents for the
relevant business steps. The documents should follow a Oracle Intelligent Track and Trace defined JSON schema or CSV
template, which are available for download. To submit a document, complete one of the following methods.
130
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Oracle Intelligent Track and Trace has three types of user roles defined for the trading partners—admin, application
user, user. You can read more about these roles and their access permissions in Understand Roles and Users.
To manage users in your Oracle Intelligent Track and Trace instance, see Manage Users
To add a code to an existing item type, as a trading partner admin, you should know the name of the item type to which
you will associate a new code..
1.
Click Menu ( ) and then click Configurations.
2.
Click Item Types ( ).
The list of item types in the application are displayed.
3. On the Configurations : Item Types dashboard, from the left navigation bar, click the item type for which you need
to add an item code.
4. On the details section of the item type, click Add Item Type Code and enter your code and click Save.
Results:
Oracle Intelligent Track and Trace will create and association between the founder's item type code and the trading
partner's item type code for the item type.
As a trading partner admin, you can view the package types that the founder has created in the application.
1.
Click Menu ( ) and then click Configurations.
2.
Click Package Types ( ).
The list of package types in the application are displayed.
3. On the Configurations : Package Types dashboard, from the left navigation bar, click the package type to view its
details in read-only mode.
131
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Results:
The details of the package type is displayed on the central frame.
Visual Studio Code (VSCode), a free and an open source Integrated Development Environment (IDE), is a powerful
tool to create and edit Oracle Intelligent Track and Trace artifacts locally without connected to the Track and Trace
application.
Topics:
• About VS Code Extension
• Download and Install Oracle Intelligent Track and Trace Extension
• Configure Oracle Intelligent Track and Trace Extension for VS Code Editor
• Download Oracle Intelligent Track and Trace Artifacts
• Create Oracle Intelligent Track and Trace Artifacts
• Edit Oracle Intelligent Track and Trace Artifacts
Use the VSCode Extension to work with Oracle Intelligent Track and Trace artifacts in an offline mode, without
connecting to the Oracle Intelligent Track and Trace instance.
The current version of the VSCode extension offers the following features:
• Download all or selected documents from Oracle Intelligent Track and Trace and edit them offline.
• Upload all or selected document to Oracle Intelligent Track and Trace.
• Create new document types offline and add them to the Oracle Intelligent Track and Trace documents list.
• In-place syntax validation by highlighting the errors, problem reporting, auto-completion for document
definitions.
• Preview mode for metadata using test data generated from examples attributes in associated JSON schema.
• Preview mode for presentation templates using test data generated from examples attributes in associated
JSON schema.
• Real-time previews while editing handlebar templates.
• Snippets for easy schema authoring.
• Snippets for Oracle Intelligent Track and Trace helpers in Handlebars templates.
• Code completion in Handlebars templates.
132
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
The following image represents the workflow for implementing VSCode extension for Oracle Intelligent Track and Trace
application.
133
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
1.
Click User Menu ( ) and then click Visual Studio Code Extension.
The Visual Studio Code Extension installation information is displayed.
134
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
135
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
2. Click Install the latest Visual Studio Code, download the editor to your local system and install it.
3. Download the latest Oracle Intelligent Track and Trace extension for VSCode Editor and click OK to close the window.
For example, oittwbr-latest.vsix file.
4.
In the VSCode Editor, click Extensions ( ).
5.
In the top right corner of the Extensions panel, click Views and More Actions... ( ) and select Install from
VSIX....
6. Select the VSCode Extension file downloaded in Step 3 and click Install.
The Oracle Intelligent Track and Trace VSCode extension is installed.
Results:
The Oracle Intelligent Track and Trace VSCode extension ( ) icon appears in the VSCode Editor navigation bar.
The following animation shows how to download and install the OITT extension:
136
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
137
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
For Oracle Intelligent Track and Trace extension to work, setup the following in your Visual Studio Code editor:
• Create Workspace for Oracle Intelligent Track and Trace extension
• Setup the Workbench for Oracle Intelligent Track and Trace extension
• Setup the connection with Oracle Intelligent Track and Trace instance
Oracle Intelligent Track and Trace extension uses workspace to setup the workbench.
1.
In the Visual Studio Code editor activity panel, click Explorer ( ).
2. In the File menu, click Save Workspace As....
The Save Workspace dialog box opens.
3. Create a new folder in the location of your choice and save the workspace file in it.
The new folder and workspace appears in the Explorer pane.
2. Setup the Workbench for Oracle Intelligent Track and Trace extension
4.
In the Visual Studio Code editor activity panel, click ( ) to activate the workspace.
The Oracle Intelligent Track and Trace extension will search for any existing workbench. Select the workbench to
proceed.
5. If no existing workbench is found, click Create new Workbench Definition and enter a name for the Workbench in
the text field.
The Workbench for the Oracle Intelligent Track and Trace artifacts is created.
For example, in the DOCUMENT TYPES panel, the system defined and user defined categories are created.
3. Setup the connection with Oracle Intelligent Track and Trace instance
138
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
6. In the INSTANCE panel, click Click to Setup and then click Connection Details.
The Connection Configuration page is displayed.
7. To setup the connection with Oracle Intelligent Track and Trace instance, enter the following.
◦ Name: Enter the name for the connection.
◦ Instance URL: Enter your Oracle Intelligent Track and Trace URL.
◦ Application Token: Generate the authentication key from your Oracle Intelligent Track and Trace instance
and enter in the text field.
◦ Network ID: Keep it as default value.
8. Click Save to save the connection settings.
9. In the INSTANCE panel, click connection name you have entered and then click OITT: Test Connection.
A Connection to the Oracle Intelligent Track and Trace is successful notification appears in the bottom right side of
the configuration page.
Results:
The following animation shows how to configure Oracle Intelligent Track and Trace extension in VSCode Editor:
139
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
140
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
1.
In the Navigation panel, click Oracle Intelligent Track and Trace extension ( ).
2.
In the DOCUMENT TYPES section, click OITT: Download All Document Types ( ).
A Downloading document types... message appears on the notification area and wait until all the documents
available on the server are downloaded.
Results:
The following animation shows the steps to download Document Type definitions:
141
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
142
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Topics:
• Create a New Document Type
• Create a New Variant for an Existing Document Type
• Create a New Document Type by Cloning an Existing Document Type
1.
In the DOCUMENT TYPES panel, click OITT: Add New Document Type ( ).
2. Enter the unique New Document Type name and ID, and then press ENTER.
A new document type created message is displayed in the notification area.
143
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
144
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
145
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
1. In the DOCUMENT TYPES panel, select the document type, right-click and select OITT: Add New Document Type
Variant.
2. Select Don't Clone to create empty variant, enter a unique name and ID and then press Enter.
Oracle Intelligent Track and Trace creates a new document type variant with all the template files.
3. For the new empty document type variant:
◦ Define JSON Schema from scratch or copy and paste from an existing document type.
◦ Modify Metadata Template mappings or type {{#md:metadataDocument}} and press Enter. A template is
added in to the editor pane. You can modify the template based on your requirement.
◦ Either modify the existing Simulation Templates or right-click Simulation Template and then click
Generate.
An empty simulation template will be generated with all the details that you can modify as per requirement.
◦ Modify or create a new Presentation Template.
4. After you define the structure, right-click and select OITT: Upload Document Type Variant to upload it to the Oracle
Intelligent Track and Trace instance.
5. Select Keep if the document is new or you do not want to overwrite an existing document.
6. Select Overwrite to save changes over existing document.
7. To verify if the new variant is successfully added to the selected document type, you can:
◦ Login to the Oracle Intelligent Track and Trace instance.
◦
Click Menu ( ) and then click Configuration.
◦
Click Document Types ( ).
◦ On the Configuration : Document Types dashboard, from the left panel, select the document type to view
the uploaded variant.
◦ You can also modify the document definitions on the server and download the updated version. Right-click
the newly added variant and select OITT: Download Document Type Variant.
8. Right-click the newly added document type variant and select OITT: Remove Document Type Variant to delete it
from the document list.
9. Click Yes and then Confirm to delete the selected document type.
146
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Results:
The following animation shows steps to create a new document variant from an existing document type:
147
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
148
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
In situations, where the requirement to create a new document type almost similar to the existing document type, clone
the new document type from an existing document type and do the necessary modifications on top of it to save time
and effort to define the document structure from scratch, such as JSON schema and other template mappings.
1. In the DOCUMENT TYPES panel, right-click the document type you want to clone.
2. Click OITT: Add Document Type Variant from the context menu.
The Don't Clone option will create a new variant with empty schema and metadata templates.
3. Select the existing definition or variant that you want to clone.
149
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
9. To verify if the new variant is successfully added for the selected document type, you can:
◦ Login to the Oracle Intelligent Track and Trace instance.
◦
Click Menu ( ) and then click Configuration.
◦
Click Document Types ( ).
◦ On the Configuration : Document Types dashboard, from the left panel, select the document type to view
the cloned variant.
◦ You can also modify the document definitions on the server and download the updated version. Right-click
the newly added variant and select OITT: Download Document Type Variant.
◦ Use one of the following options to download document types:
- Keep variant definitions: Download only the new or updates document types.
- Overwrite variant definitions: Download all the document types.
10. Right-click the newly add variant and select OITT: Remove Document Type Variant to delete it from the document
list.
11. Click Yes and then Confirm to delete the selected document type.
Results:
150
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
151
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Topics:
• Edit and Validate Document Type Definitions
1. JSON Schema
1. In the DOCUMENT TYPES panel, select the document type and click the JSON Schema definition you want to edit.
152
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
2. Select the required attribute from the auto-complete list to modify the JSON schema.
153
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Edit the JSON schema of a sepcific document type in VSCode editor by using Oracle Intelligent Track and Trace
extension.
154
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
3. Hover-over the error or click PROBLEMS tab in the lower half of the editor pane to identify and fix the syntax errors.
2. Metadata Template
155
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
4. In the DOCUMENT TYPES panel, select the document type and click the Metadata Template definition you want to
edit.
Edit the metadata template of a specific document type in VSCode editor by using Oracle Intelligent Track and Trace
extension.
156
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
157
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
For example, you might want to extend the existing Document View to show more contextual information from another
external application.
All this is possible with help of Visual Builder Studio (VB Studio) application.
Topics:
• What is Oracle Visual Builder Studio?
• What Can You Do with Oracle Visual Builder Studio?
• Set Up Intelligent Track and Trace Support in VBCS
A rich browser-based visual designer tool that provides an out-of-the box functionality for you to effectively plan
and manage customizations to create your own application UIs either by enhancing the existing UI components or by
adding new ones to display and deliver information specific to the business needs of your organization and as desired
by the end customer.
158
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
Based on customer requirement, you might want to enhance the existing UI pages, such as displaying custom fields,
create dynamic layouts or embedding custom content in a dynamic container in a page.
A simple use case where as a textile industry, your customer wants to know if the silk or cotton balls used in the
processed yarn are procured from a licensed plantations or would like to view the quality analysis report of the raw
material to ensure that the procurement of raw material does not violate any legal or licensing obligations laid out by the
government or regulatory body.
To fulfill such specific requirements, you might want to enhance the existing UI to provide licensing and QA information
alongside what is currently provided for a given transaction flow. For such specific requirements, VB Studio gives you
a freedom and control to access Intelligent Trace and Trace REST APIs with all the required tools to make necessary
modifications of a document view to provide an end-to-end tracking of an entire procurement process followed by your
organization.
To access the REST APIs, you create service connection from an endpoint by using the base URL of your Track and Trace
instance alongwith necessary authentication details.
Topic:
• Set Up a Service Connection in VBCS
159
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
To create a service connection from an endpoint URL, you must select an appropriate authentication method and
connection type to validate the logged in users. There are two ways to set up a authentication for service connections:
• Identity Propagation Authentication
• Fixed credentials Authentication:
When you use identity propagation, the following authentication mechanisms are available:
Oracle Cloud Account In this case, for authentication, it uses Intelligent Track and Trace server URL as a default scope. For
example, if the service's URL is https://ab.oraclecloud.com/myservice, the token will be
created with the same base URL as https://ab.oraclecloud.com/oauth2/v1/token
OAuth 2.0 User Assertion Requires user to sign in with a valid Oracle Identity Cloud Service user account. Here you can specify
your own scope rather than using Intelligent Track and Trace URL as scope.
OAuth 2.0 Resource Owner Password Use this option when you need a specific user's credentials to connect to Intelligent Track and Trace
Credentials application. The authentication requires IDCS Client ID, Client Secret, and token URL.
Topics:
• Connect to Intelligent Track and Trace APIs Using Identity Propagation
• Connect to Intelligent Track and Trace APIs Using Fixed Credentials
To connect endpoint URLs by using Oracle Cloud Account or by using OAuth 2.0 User Assertion (Single Sign-On)
authentication:
1. Create a Service Connection in VBCS
1. Sign in to the Visual Builder Studio from the Oracle Cloud home page.
2. From the Navigator bar, click Services ( ).
160
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
If you know what type of action you want to perform, select it in the Action Hint drop-down list. For example, if you
select a GET method, you can choose Get Many to retrieve multiple records.
6. Click Next.
7. In the Overview tab, provide the Service Name, Title, and Version. Optionally, enter a description.
8. Click Service tab and provide the following Authentication details:
a. From the Authentication drop-down, select Oracle Cloud Account or OAuth 2.0 User Assertion.
b. Under Scope, enter the resource URL of the Intelligent Track and Trace API.
For example, https://<OITT-Instance.oraclecloud.com>/bca/api
c. From the Connection Type drop-down, select Dynamic , the service supports CORS.
The Cross-Origin Resource Sharing (CORS) support allows VBCS users from the different identity domains
to access the Intelligent Track and Trace REST services. This implements a Single Sign-On authentication
instead of passing IDCS client IDs, client secrets, token URLs to authenticate VBCS users separately.
9. In the Headers section, click Add Header and enter the Tanent ID name and its corresponding value.
161
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
If you choose OAuth 2.0 Resource Owner Password Credentials authentication, then to register REST APIs in VBCS, you
have to perform the following tasks:
Topics:
162
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
To access Oracle Identity Cloud Service from the Oracle Cloud Infrastructure Console, see Access Oracle Identity Cloud
Service.
You can use IDCS confidential application to obtain Client ID and Client Secret.
Before you start
To set up a custom application in IDCS, you must have the Identity Domain Administrator role.
Here's what to do
1. In the IDCS console, expand the Navigation Drawer, and then click Applications.
2. Click Add.
3. In the Add Application page, click Confidential Application.
4. On the Add Confidential Application wizard's Details page, under App Details section, provide a name for the
application and then click Next.
a. Select Configure this application as a client now to configure authorization information for your
application.
b. Under Authorization, select Resource Owner, Client Credentials, JWT Assertion, and Refresh Token as
Allowed Grant Types.
c. Under Token Issuance Policy, keep the default Authorized resources.
d. Under Resources, click Add Scopes. Search for an appropriate resource for VBCS application to access APIs
from Intelligent Track and Trace and then click Add.
5. On the Add Confidential Application wizard's Resource page:
a. To specify that no resources of your confidential application will be protected by OAuth 2.0, or to protect
them at a later time, click Skip for later.
a. Click Next.
6. On the Add Confidential Application wizard’s Web Tier Policy page, click Next.
7. On the Add Confidential Application wizard’s Authorization page:
a. Select the Enforce Grants as Authorization if you want Oracle Identity Cloud Service to control access to
the application based on grants to users and groups.
b. Click Finish.
The client application is added in a deactivated state.
8. Make a note of the Client ID and Client Secret and click Close
To integrate with your confidential application, use this ID and secret as part of your connection settings. The Client
ID and Client Secret are equivalent to a credential (for example, an ID and password) that your application uses to
communicate with Oracle Identity Cloud Service.
9. Click Activate.
10. Click OK in the confirmation dialog to activate the application..
163
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
1. Sign in to the Visual Builder Studio from the Oracle Cloud home page.
2. From the Navigator bar, click Services ( ).
3. In the Services pane, click ( ) and then click Service Connection.
4. Click Define by Endpoint as a service connection source.
5. Enter the endpoint URL of the Intelligent Track and Trace API.
To get response from the Trading Partners API, use the endpoint URL of your Intelligent Track and Trace instance
URL. For example, https://<OITT-Instance>/bca/api/businessNetworks/v2/networks/local/tradingPartners
If you know what type of action you want to perform, select it in the Action Hint drop-down list. For example, if you
select a GET method, you can choose Get Many to retrieve multiple records.
6. Click Next.
7. In the Overview tab, provide the Service Name, Title, and Version. Optionally, enter a description.
8. Click Service tab and provide the following Authentication details:
a. From the Authentication section, from the drop-down, select OAuth 2.0 Resource Owner Password
Credentials as an authentication option for logged-in users.
b.
Click Enter Username and Password ( ) to enter user login credentials.
c.
Click Enter Client ID and Client Secret ( ) to enter the Client ID and Client Secret created using IDCS
confidential application.
d. Under Scope, enter the resource URL of the Intelligent Track and Trace API.
For example,https://<OITT-Instance>/bca/api
e. Under Token URL, enter the access token URL of the endpoint from your IDCS client application.
For example, https://<IDCS-Service-Instance>.identity.oraclecloud.com/oauth2/v1/token
9. From the Connection Type drop-down, select Dynamic, the service does not support CORS and then click Create.
164
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
You can experiment with the different request parameters until you achieve the response you want. If your response
returns an error, you will need to check the details of your connection, for example, ensure that you're using the
correct credentials or Client ID and Client Secret.
165
Oracle Cloud Chapter 4
Using Oracle Intelligent Track and Trace Configure Oracle Intelligent Track and Trace
166
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
As a founder, when you subscribe to Oracle Intelligent Track and Trace, you receive two instance URLs—Test Service
instance and Production Service instance. Production Service instance refers to the real-world business instance which
is used by trading partners to submit and query transaction documents. Test Service instance refers to an instance
which enables you to submit mock transaction documents and queries which simulate the real-world scenarios.
When you configure various business flows for your supply chain, you may want to simulate them to identify any
potentials issues that may occur in production. The Test Service instance enables you to closely simulate the production
environment by providing the Simulator functionality. For more information on Simulator, see Simulate a Business
Flow.
In a test instance after creating the entities, activating the business flows, and verifying the network, you can migrate
their configurations to the production instance by promoting the business flows.
Rest of the functionality between the production and test environment remains the same. You can switch between
these two instances to access the test and production environments.
Topics:
• Switch From Test Service to Production Service Instance
• Switch From Production Service to Test Service Instance
• Promote Configurations from Test to Production Environment
167
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
2.
Click User Menu ( ) and select Switch to Test Service.
3. Under the Switch Service dialog box, click OK.
168
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
When you promote a business flow from a test instance to a production instance, the following entities associated with
the business flow also get promoted:
• Trading partner, locations and location business identifiers
• Flow templates
• Business rules
• Document type definitions
• Integrations
Note: When you promote a business flows from a Test to a Production instance, you must ensure that all of the
business flows in the list with its associated entities are promotable. If any of the business flow entities are not
promotable, the Promote button will be disabled until all the business flow entities are fixed for promotion.
169
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
The following image is an example of multiple business flows where if one of the business flow is not promotable, the
Promote button is disabled. In this case, none of the business flow entities in the list can be promoted until the non-
promotable business flow is fixed.
An existing entity in the production instance is overwritten during a promotion. In the test instance, when you initiate
to promote a business flow, a list of its associated entities that would be overwritten is displayed, which you need to
confirm before the promotion.
In a production instance, you need to explicitly activate a business flow that was promoted even if it was active in the
test instance.
Before you can migrate a business flow and its associated entities from a test service instance, a production service
instance and a founder should already be provisioned.
1.
On the test service instance, click Menu ( ) and then click Configurations.
170
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
2.
Click Business Flows ( ).
3. On the Configurations : Business Flows page, from the left navigation bar, select the business flow that you need to
promote.
171
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
4. Click Promote.
172
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
173
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
5. Select the Click to Confirm check-box and then click Promote and wait for the evaluation and promotion process.
174
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
6. On the Last Promoted page, examine the success or error notifications about the promoted artifacts and click OK.
You can fix the errors and repeat the promotion.
175
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
176
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Topics:
• Trading Partners Dashboard
• Monitor Business Flows
• Monitor Flow Instances
• Trace Your Items and Packages
• Monitor Documents
• Trace Your Items and Packages
Note: If you log in to Oracle Intelligent Track and Trace as a Trading Partner, then the Trading Partner Dashboard
shows the business network associations between the logged in trading partner and its associated Trading Partners
only, configured either as submitters or receivers, in a business flow.
Topics:
• View Trading Partner Dashboard
1.
Click Menu ( ) and then click Operations.
177
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
2.
Click Users Management ( ).
178
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
179
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
The upper pane gives a summary of all the trading partners in the business network.
The lower pane displays a graphical representation of trading partners and their association with each other.
3. Click the Trading Partner icon for which you want to view details.
Field Description
Business Flows Number of business flows the trading partner is associated with.
180
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Field Description
4.
Click the Map ( ) icon to view the location of the trading partners on the map.
181
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
As a founder, you can monitor all the business flows by tracking multiple metrics:
As a founder, you can view the data and metrics for all the business flows and transaction documents.
As a trading partner, your visibility to the data is limited by your organization type in the founder's network—Endorsing
trading partner, or participating trading partner. The visibility is further constrained by the user role assigned to you—
web application user, integration user, or admin, See Understand Roles and Users.
All the dashboards are maintained in real time. As the transaction documents come in, the dashboards are updated with
the relevant data.
Topics:
• View Business Flow Dashboard
1.
Click Menu ( ) and then click Operations.
182
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
2.
Click Business Flows ( ).
The business flow dashboard is displayed.
183
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
184
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Business flow dashboard displays multiple types of metrics and statistics which provide you with the summary for all
the business flows active in the application.
Metric Description
Flow Graphical representation of the active business flows along with their individual steps.
Flow Instances Displays the progress of the flow instances associated with each business flow:
◦ Completed
◦ In Progress
Each document received by the Oracle Intelligent Track and Trace corresponds to a specific business step of an instance.
The transaction documents received may or may not be in the order in which the steps are defined for a business flow.
Oracle Intelligent Track and Trace maps the transaction to the business step, and performs the necessary processing for
ingesting the document and other data received as part of the transaction.
As a founder, you can monitor all the business flow instances individually. Oracle Intelligent Track and Trace provides a
number of step-level statistics:
As a trading partner, your visibility to the data is limited by your organization type in the founder's network—endorsing
trading partner, or participating trading partner. The visibility is further constrained by the user role assigned to you—
admin, integration user, or web application user, See Understand Roles and Users.
Topics:
• View Flow Instances Dashboard
• Trace a Flow Instance
185
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
1.
Click Menu ( ) and then click Operations.
2.
Click Business Flows ( ).
The Business Flow dashboard is displayed.
186
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
187
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
188
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Flow Instance dashboard displays a number of statistics which provide you with the summary for all the business
flows active in the application.
Metric Description
Flow Instance Summary Displays the a summary of all the flow instances in the system:
◦ Trading partner summary—For how many instances the trading partner is a document submitter.
◦ Business flow summary—For each business flow, how many instances are active in the system.
Status Displays the status of each flow instance whether in progress or completed.
Last Updated Displays when was the business flow instance last updated.
Progress Displays the progress of each instance in the format <Number of steps completed>/<Total Number
of steps>.
Trading Partner Trading partner submitting the 1st document to the flow.
First Document Displays the document details of the first step in the business flow.
Value Displays the value of the order from the first document.
Flow Instance Detail Displays the flow instance details of selected business flow.
4.
Click Business Flow Instance Detail ( ) to view the flow instance details of the selected business flow.
5.
Click Trace ( ) to view the trace details. See Trace a Flow Instance.
1.
Click Menu ( ) and then click Operations.
2.
Click Business Flows ( ).
189
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
3.
Click Trace ( ) icon against the business flow instance that you want to trace.
Three types of view are supported:
◦ Flow Relations: Shows the relationship of the selected business flow instance with other flow instances.
Click each step to view its transaction details. The grayed-out boxes represents the pending steps, if any.
◦ Chronological Trace: Chronological display of all the steps for the selected flow instance and steps from
related flow instances. As you scroll down the business steps, you can view the flow of documents between
the submitter and receiver in the map. This view also displays any IoT event captured along the time-
line. For example, if the geo-location information for the goods is available, the application shows the
movement of goods from one location to another. If any corresponding metrics are available, they are
shown as line charts in the Details panel.
The geo-location and any corresponding metric should be mapped to trackingData in the metadata
template of the corresponding document type, for it to be displayed correctly and to have the metrics show
up as a chart in the Details panel.
◦ Visibility Grid: Displays a swim-lane view of the flow instance showing those trading partners that have
access to the submitted documents. The highlighted boxes represent the transactions which are submitted
by the trading partner. The grayed-out boxes represent the transactions that the logged in trading partner
has view access.
190
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
4. Click Chronological Trace on the upper right corner for the time-line view of the flow instance.
191
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
192
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
5. Click Visibility Grid on the upper right corner for the grid view of the flow instance.
193
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
194
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
6. Click Document on the upper right corner for the associated document details of the flow instance.
195
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
196
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
As a founder, you can keep track of all the lot-controlled or serial-controlled items in your supply chain and reference
the transaction data for tracing it to the document, trading partner, or business flow instance.
Topics:
• View Items Details
• Generate Items Trace Reports
• View the Packages Dashboard
• Export Items/Packages Data in CSV/Excel File
1.
Click Menu ( ) and then click Operations.
2.
Click Items ( ).
A snapshot view and list view of all the serial-controlled, lot-controlled, and batch-controlled items are displayed.
197
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
3.
On the Items dashboard, to view the details of an item, click ( ) for a specific item.
The lot, serial, or batch details, item details, shipping history details, and its transaction details are displayed.
198
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
199
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
1. Click the Filter bar and select single or multiple field name(s) from the list.
2. From the selected column attribute drop-down, select the required operator.
The following operators are available based on the selected attribute type:
3. In the Search Filter Criteria field, enter the filter criteria and then click outside the filter box.
Results:
The following image illustrates the filtered items based on the given criteria.
200
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
1.
Click Menu ( ) and then click Operations.
2.
Click Items ( ).
A snapshot view and list view of all the serial-controlled, lot-controlled, and batch-controlled items are displayed.
201
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
3.
On the Items dashboard, to generate trace reports of an item, click ( ) for a specific item.
The Generate Report for the selected item is displayed.
202
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
4. On the Generate Report page, enter the values for the following fields:
◦ From the Template drop-down list, select the template to use to generate the report. See About Report
Templates
◦ From the Include drop-down list, select the trace details you wish to include in the report, such as
BACKWARD, FORWARD, ALL, or NONE.
◦ (Optional) From the Expire In date-time editor, update the date and time duration for the report to be
retained in the system.
◦ In the Memo text field, enter the memo details of the selected item.
5. Click Generate Report.
A lot-controlled or serial-controlled trace report is generated based on the selected template type and appears under
Generated Reports area.
6.
Click View ( ) to view the generated report.
7.
Click Download ( ) to download the report in your local system.
The item trace report will be downloaded in a PDF format.
8.
Click Delete ( ) to delete the generated report.
9. Click Cancel to close the Generate Report page.
1.
Click Menu ( ) and then click Operations.
2.
Click Packages ( ).
A snapshot view and list view of all the packages are displayed
203
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
3.
On the Packages dashboard, to view the details of a package, click Show Details ( ) for a specific package.
The package details, shipping history details, and the items in the package are displayed.
204
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
205
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
4. Scroll down to the Items in this Package pane and view all the items in the package.
For each Item Type column, to view the item details associated with the package, you can click Show Details ( ).
See how to view details of an item from View Items Details
5. Use the breadcrumb information at the top to go back to the Packages dashboard.
6.
On the Packages dashboard, to display or hide certain columns, click ( ) showHideColumns and select or
deselect the fields.
Monitor Documents
Every transaction document is associated with a business step in a flow instance. You can monitor the documents
received by the Oracle Intelligent Track and Trace by keeping track of various parameters, such as document time
stamp, document type, document variant, submitter and so on. If a submitter attaches additional files to a document
when submitting the document using a REST API, then you can view the attached files and download them from the
documents dashboard.
Topics:
• View Document Summary
• Export Document Data in a CSV/Excel File
206
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
2.
Click Documents ( ).
Note: Some documents may have multiple versions associated to them, if a document has versions, a version
badge is shown next to the document number. No version badge is shown if the document does not have any
associated version.
For example, Purchase Order document has multiple versions with a version badge showing the most recent version
number.
207
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
1. Click the Filter bar and select single or multiple field name(s) from the list.
2. From the selected column attribute drop-down, select the required operator.
The following operators are available based on the selected attribute type:
3. In the Search Filter Criteria field, enter the filter criteria and then click outside the filter box.
Results:
The following image illustrates the list of documents based on the given criteria.
208
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
View Attachments
As a Founder or Trading Partner admins and users, view a list of attachments for each document submitted for a
business flow step directly on the Documents dashboard page.
For such scenarios, Intelligent Track and Trace provides instant access to a list of attachments available for quick
preview or download from Documents dashboard view.
Alternatively, attachments can also be viewed and downloaded from Documents summary details page or from
Documents trace view.
The Attachments drawer provides the following information associated with each document and the attached files.
Document Name Specifies the name of the document submitted for a business flow step.
Attachments Specifies the number of attachments uploaded during document submission. The snapshot view
provides the following details:
• Icon indicating file type
• Filename with file type extension
•
Preview attachment
•
Download individual attachments
Supported files Thumbnail image of a supported file type, such as, PDF, PNG, TXT and so on. See Supported File Types.
N/A if the attachment belongs to an unsupported file type. See Unsupported File Types.
Unsupported files
Media Format
Application PDF
209
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Media Format
Text TXT
Media Format
Images BMP
Archive ZIP
Binary DAT
Note: In case of document versioning, attachments are tightly coupled with document versions. For example, let us
assume that for a business flow you attached a few attachments with Purchase Order document, later you revised
the Purchase Order document and submitted as version 2 without any attachments. In this case, you can only view
attachments with Purchase Order document version 1 submitted previously and not with version 2 of the document.
Topics
The following views helps you view or download the attachments:
Note: Attachment preview is available only for certain file types. On the preview page, you can see the first
page of a PDF document or a larger version of an image file. For information on file types, see Access Document
Attachments.
4.
Click Preview ( ) to open attachment in a file viewer.
210
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
5.
Click Download ( ) to download each attachment separately.
Optionally, you can Download and/or Print attachments from the file viewer.
• The folder structure of the ZIP file and the naming conventions used are as follows:
211
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
◦ The default name of the exported archive is the normalized ledgerKey name, that is <normalized-ledger-
key>-<num-suffix>.zip. For example, PurchaseOrder:PPE-22-456012-SS-01.zip. You can rename the default
normalized export file to the name of your choice.
◦ The default top level folder name uses the default normalized ledgerKey name of the selected document.
For example, PurchaseOrder:PPE-22-456012-SS-01.
◦ The second level folder(s) is a folder dedicated to each version of the document. For example, first level
folder in a zip file is the default normalized name of the selected PurchaseOrder:PPE-22-456012-SS-01
document and the second level folder might be the multiple versions of the same document, such as V1,
V2 and so on.
212
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
213
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
214
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
6. Choose any one of the following options to view exported archive status and download the attachments:
◦ Click Check Status link from the export status message to directly jump to the Activity Log - Attachments
Export page.
◦ Go to Monitoring -> Activity Log, and then click Attachment Exports.
In this example, the export is triggered for the most recent version of the Purchase Order document. The export
includes a zip file and a csv file ready for download.
215
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
7. To export all attachments specific to a business flow, navigate to the business flow page by using one of the
following choices:
◦ Click the document number from the Documents column and then click Business Flow from the document
summary page.
◦ Click icon and select View Business Flow.
8. Repeat Step 4 to Step 9 to view the export status and download the zip archive to your local system.
In a business flow, a document may go through various states, such as New, Open, Closed etc. If its important to record
the document in all these states, versioning is needed as the same document will need to be recorded multiple times.
For such use cases, Intelligent Track and Trace provides document versioning feature with the following capabilities:
• Efficient Tracking: Provides the most recent version of the document to ensure accurate and up-to-date
information about the transaction data. This improves efficiency and transparency of business flows in your
supply chain network.
• Better visibility: A version history is maintained that provides increased visibility to track end-to-end
information of a specific transaction submitted for a business flow.
• Improved customer experience: Provides access to the most recent transaction data available for all the
stakeholders in your supply chain network for better decision making and tracking.
• Access Control: Provides permission based access to allow or restrict users from viewing document versions
based on their organizational roles.
When you submit a new version of a document, Intelligent Track and Trace verifies the ledgerKey and its
documentTimestamp attribute values. If the ledgerkey and the documentTimestamp attribute value of a new version is same
as the previously submitted document, the application rejects the incoming document, marks it as duplicate, and list it
under Document Diagnostics.
If the document ledgerKey attribute value of the two documents is same but the documentTimestamp attribute value is
different, the application creates a new version and adds version number label adjacent to the document name.
216
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
The following image shows a sample business flow instance with Document Versioning status as Enabled.
For more details on how to enable/disable document versioning, see Create a New Business Flow Instance.
As founder, Trading Partner admin or user, you must have appropriate permissions to view latest or all the versions of a
document. For information on access permissions, see Fine-grained Access Control.
For example, the following image shows the Purchase Order document with a version number badge alongside
document number.
217
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Here, Purchase Order document has three different versions shown in version badge as v.3. The most recent version of a
document shows a version badge as <version number>(latest version). In this example, if version 3 is the most recent
version of the Purchase Order document, the version badge shows v.3(latest version) in document details page
You can view and track different versions of a document from Documents summary dashboard. Intelligent Track and
Trace implements document versioning at the following component levels:
• Document Details Page
• Business Flow view
• Document Trace view
Topics:
• View Document Versions on the Document Details Page
• Track Document Versions in Business Flows
• Track Document Versions from Trace View
218
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
2.
Click Documents ( ).
Document summary dashboard opens.
3. Click document number with a version badge attached to it.
The selected document opens with Document Details drawer.
219
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
5. Click the version card to load document details in the content panel.
Note:
◦ You do not require any access permission to view the latest version of a document.
◦ To select a version card of the previous versions and view them in the content panel, you must have
valid access permissions.
220
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
2.
Click Documents ( ).
Document summary dashboard opens.
3. Click document number with a version badge attached to it.
The selected document opens with Document Details drawer.
4. Click Business Flow tab and select one of the business flow steps.
A drawer appears showing transaction data.
The Document Cross Reference lists all the submitted versions of a transaction document for a selected flow step.
To view any specific version, the following criteria should be met.
◦ If you have permissions to view document versions, each document version appears as an active link. The
version badge in gray box indicates the version number.
◦ If you do not have permissions to view document versions, the document name and badge do no provide
an active link and a tooltip is shown with a message You do not have permission to view this version.
◦ To view latest version, click Go to <latest version> available under each version.
5. Click Cancel to close the drawer.
221
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
222
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
6. From the Trace timeline, click any version card to view the transaction details submitted for a flow step.
The following image shows the multiple versions of the Purchase Order document.
223
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Note: If you do not have the required permissions to access document versions, you can only view the latest
version of the document.
When you apply filters, you generate focused results to optimize your search. Filter based search helps you retrieve
various combinations of data by adding predefined filters. It reduces the effort to retrieve specific set of records related
to various items, packages, and transaction documents. You can then export the search results as a CSV or Excel file
which save the effort to first download the entire summary and then apply filters to narrow down what is needed.
You can provide values for the attributes that you want to filter on and the operator to use for filtering. The available
operators depends on the attribute's data type. For example, operators for filtering text values are different than the
operators for filtering date ranges. Filters are combined together using and logic, which means only those records that
meet all filter criteria are displayed.
• starts with
• match phrase
• does not match
• is/is not
• Before/After
224
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
• Search complete words - If you're searching an item with multiple words in the name, enter any of the words.
For example, a search keyword as N95 Respirator and Surgical Mask would retrieve all the items where the type
matches the given keyword.
• Search exact phases - Use Match Phrase to search data by entering a sub-string within a given value that
exactly matches the attribute value. For example, a search sub-string 002 from a document number would
retrieve all the documents that contains 002 in it regardless of their document types.
• Filter by Dates - Use calender controls to query the list based on date fields. For example, filter the list of
documents that are submitted before or after a specified date and time.
Currently, the filter based search is available on the following component dashboards:
Operations Documents
Items/Packages
Oracle Intelligent Track and Trace depends on the trading partners to send transaction documents to the founder's
network in a specific document format. Each of the trading partner must setup and configure an appropriate integration
process to extract the documents from their enterprise applications, transform them to the document format defined by
the business network, and transmit it to the founder's network in a reliable and secure manner.
It is therefore a little challenging for you to test these business flows which span across multiple trading partners. Oracle
Intelligent Track and Trace provides a simulator tool which generates mock transaction documents from the trading
partners which help you to:
225
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Note: Simulator functionality is available only in the Test Service instance. For more information, see Production and
Test Environment
Topics:
• Create a Simulation
• Edit a Simulation
• Clone a Simulation
• Run Simulations
Create a Simulation
Create a simulation to test out the business flows and identify any potential issues or errors.
When you define a business flow, all the flow steps have an associated document type. The document type specifies the
document structure in which data will be received for that step. Each document type defined also contains a simulator
template. This template is used to create data for the simulated transaction documents.
1.
Click Menu ( ) and then click Monitoring.
2.
Under Monitoring : Simulations dashboard, click Create New Simulations ( ).
226
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
If the value for Maximum Number of Runs is higher than 1, then specify the following:
- Repetition Interval: Enter the frequency at which the simulation should run.
- Repetition Interval Unit: Enter the unit of frequency at which the simulation should run.
◦ Business Flows: Select the business flows that you want to simulate as part of this simulation. For each
flow selected, application displays:
227
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
228
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
4. Select the Business Step from the business flow chart in the bottom pane, to modify the simulation template
attributes. All the attributes are populated with the default values defined in the template.
5.
Click the text box next to the Search ( ) icon and select the attributes from the list, which you need to modify.
6.
To modify an attribute, click Edit ( ) next to the attribute.
7. On the Choose Simulation dialog box, click the Simulation Type drop-down and select one of the following:
◦ Constant Value: Select this option to generate constant values.
◦ Random from list: Select this option to provide a list from which random values need to be generated.
◦ Random String: Select this option to provide random string values that follow a pattern.
◦ Trading Partner: Select this option to provide a specific trading partner name.
◦ Trading Partner's Location: Select this option to provide a specific location.
◦ Index Based Template String: Select this option if the attribute is part of a repeating element. You can use
either the index as a string value for the attribute or the index in a template string.
◦ Sequence From List: Select this option to generate a sequence of a specific type from a list that you need
to provide.
8. Make the required changes to the other relevant field values, and click OK. Repeat Steps 6 through 8 for all the
attributes that you want to modify for the selected Business Step.
9. Repeat Steps 4 through 9 for all the business steps of the selected business flow.
10. Click Save and wait until the Save successful message is displayed.
11. Click Cancel to return to the Monitoring : Simulations dashboard. You should see the new simulation that you have
added in the simulation list.
12. Click Stop All if you wish to stop all the simulations in running state.
Results:
You can also create simulation for an end-to-end workflow involving multiple business flows. Apart from customizing
the business step attributes for all the business flows, you can define the relationships between the various business
flows including their dependencies. Ensure that the relationships between the business flows that you define in the
simulator should be same as the ones you have defined when creating the document types.
Edit a simulation
Edit an existing simulation.
1.
Click Menu ( ) and then click Monitoring.
2.
Under the Monitoring : Simulations dashboard, click Edit ( ) against the name of the simulation you want to
modify.
3. Make the necessary changes and click Save. Wait until the Save successful message is displayed.
4. Click Cancel to return to the Monitoring : Simulations dashboard.
229
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Clone a Simulation
You can clone an existing simulation to create a new one.
1.
Click Menu ( ) and then click Monitoring.
2.
Under the Monitoring : Simulations dashboard, click Clone ( ) against the name of the simulation you want
to clone.
3. In the Clone : <Simulation Name> page, enter the value for these fields:
◦ Name: Enter the name of the simulation.
◦ Document Generation Interval: Enter the frequency at which the document is generated. For example, if
the frequency is specified as 30 minutes, a document is generated every 30 min.
◦ Business Flows: Select the business flows that you want to simulate as part of this simulation. For each
flow selected, application displays:
Run a Simulation
Run a simulation to test the business flows.
1.
Click Menu ( ) and then click Simulations.
2.
Delete a Simulation
Delete an existing simulation.
1.
Click Menu ( ) and then click Monitoring.
2.
Under Monitoring : Simulations dashboard, click Delete ( ) on the right of the simulation that you want to delete.
230
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Submit Documents
Oracle Intelligent Track and Trace provides a REST API based mechanism and a application based user interface to the
trading partners to submit documents for a step, into the network.
When a business flow is activated, Oracle Intelligent Track and Trace generates a REST endpoint for each of the business
steps. Trading partners integrate these REST endpoints with their REST clients or integration tools to post documents.
Trading partners can submit documents only for the business steps for which they have been identified as a submitter.
A submitter can optionally attach files such as, image files, pdf files, or audio files, when submitting the documents
using the Submit document REST API. Alternatively, the submitter can login to the application and upload documents
for the relevant business steps. The documents should follow a Oracle Intelligent Track and Trace defined JSON schema
or CSV template, which are available for download.
In addition to REST and CSV/JSON file uploads, you also have the option of manually entering the data for document to
be submitted using the auto-generated forms.
The HTML form is dynamically generated based on the JSON schema of all the pre-seeded document types and
variants or custom document types and variants. See Upload Documents as JSON Form.
For more information on how to use REST APIs, see REST API for Oracle Intelligent Track and Trace
Before you upload a transaction document for a step of a business flow, you can download its CSV template or JSON
schema, and use it to create the transaction document
1. Sign in to your Oracle Intelligent Track and Trace instance as a trading partner or the founder.
2.
Click Menu ( ) and then click Operations.
3.
On the bottom navigation bar, click Document Submission ( ).
The Document Submission dashboard shows the business flows, its business steps, and the corresponding
document type names for which you are a submitter.
4. Identify the business flow and its step for which you need its CSV template or its JSON schema. Hover your mouse
231
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
5. To download the pre-defined JSON schema, on the Post Document page, from the Post as drop-down list, select
JSON , and then click the Download ( ). Browse to the desired location, and save the schema file for later
use.
6. To download the pre-defined CSV template, on the Post Document page, from the Post as drop-down list, select
CSV, and then click the Download ( ). Browse to the desired location, and save the template file for later use.
See About the CSV Data Format.
7. Click Close to return to the Document Submission dashboard, click.
If you are not familiar with JSON schema, you can use a pre-defined csv template to create and upload a csv transaction
document for a step of a business flow. The CSV file can either be a comma separated file, which supports the US and
UK format or a semi-colon separated file, which supports the European format specifically Germany, France, Italy, and
Czech Republic.
Apply the following rules and format when you create a document in CSV format:
Rows
• The first row, header row, is mandatory and must be always present in the CSV file. It lists (in a flattened format)
all possible fields from the document schema.
• The second row, hint row, is optional. It doesn't need to be necessarily present in the uploaded CSV file. This
row is only for informational purpose for the user to define what data type is expected.
232
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Columns
• The first column is a special column, containing record identifier(s). The Document can span over multiple
CSV rows, that is necessary for arrays. Number of rows over which the document spans is dictated by this
column. Value of cells in this column have no restrictions. Parser reads the CSV file row by row. If it encounters
an unique record identifier, all rows, which have the same (or none) record identifier, belong to the currently
processed document.
• All other columns correspond to properties from document type schema.
Header Row
• The first column is called record identifier
• Remaining columns are generated using the following algorithm:
◦ If the field type is an object, all inner properties are flattened using / (forward slash).
◦ If the field type is an array of primitive types, the field name is used, which can be nested in an object.
◦ If the field type is array of objects, <arrayFieldName>/<innerObjectName> notation is used, objects having
nested properties are supported and follow the generic rule for objects.
◦ For all other field types, the field name is used.
Hint Row
The cells represent the <dataType>. If the data type is an array of primitives, list[<primitive Type>] is used. If it's an
array of simple objects, list[object(<fieldFromObject>)] is used. If the hint row is present, the first column, which is a
record identifier for a row, must be empty.
Data Validation
Users will represent null values by leaving the corresponding cells empty.
Note: Document type variants that violate one or more of the rules cannot support CSV data upload and therefore
the UI will not show an option to upload in CSV format.
• allOf
• anyOf
• oneOf
• not
• if
• then
• else
• array in type field (allowed only single nullable types), e.g. type: ["string", "integer"] is forbidden
• arrays inside arrays
233
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Processing of the uploaded CSV file is not transactional. If one of the records in the uploaded CSV file is incorrect due to
the record rows not being converted to JSON or the JSON validation fails, the processing of the remaining records won't
be affected.
The sample CSV files get translated to the following JSON documents:
JSON Document 1
{
"result": {
"orderNumber": "X118566",
"orderDate": 1614955385,
"currencyCode": "GBP",
"orderLine": [
{
"itemNumber": 1,
"quantity": 5,
"itemDescription": "LAPTOP"
},
{
"itemNumber": 2,
"quantity": 3,
"itemDescription": "MOUSE"
}
]
}
}
JSON Document 2
{
"result": {
"orderNumber": "X118566",
"orderDate": 1614955385,
"currencyCode": "GBP",
"orderLine": [
{
"itemNumber": 1,
"quantity": 5,
"itemDescription": "LAPTOP"
},
{
"itemNumber": 2,
"quantity": 3,
"itemDescription": "MOUSE"
}
]
}
}
234
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Upload Documents
A submitter of a step in a business flow can submit documents by uploading the transaction document either in JSON
format, in CSV format, or as an HTML form. You can download and use the sample schema or template for both the
formats.
Topics
• Upload Documents as JSON or CSV file
• Upload Documents as JSON Form
Your document can be a JSON or CSV file that follows the predefined schema provided by Oracle Intelligent Track and
Trace. To download the predefined format, see Download a CSV Template or a JSON Schema.
1. Sign in to your Oracle Intelligent Track and Trace instance as a trading partner or the founder.
2.
Click Menu ( ) and then click Operations.
3.
On the bottom navigation bar, click Document Submission ( ).
The Document Submission dashboard displays the business flows, its business steps, and the corresponding
document type names for which you are a submitter.
4. Identify the business flow and its step for which you'll upload a document. Hover your mouse over the record and
click Post ( ).
The Post Document page is displayed.
5. On the Post Document page, select or click the following:
◦ Variant: Click the drop-down list and select the name of the document type definition.
◦ Post as: Select JSON or CSV depending on the format of your document. Ensure that the JSON file follows
the JSON schema or the CSV file follows the CSV template provided by Oracle Intelligent Track and Trace.
Know about the CSV template from About the CSV Data Format.
Note: Document type variants that violate one or more of the rules cannot support CSV data upload and
therefore the UI will not show an option to upload CSV.
235
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
The form is an HTML representation of the predefined schema definition used for a specific document type provided by
Oracle Intelligent Track and Trace.
1. Sign in to your Oracle Intelligent Track and Trace instance as a trading partner or the founder.
2.
Click Menu ( ) and then click Operations.
3.
On the bottom navigation bar, click Document Submission ( ).
The Document Submission dashboard displays the business flows, its business steps, and the corresponding
document type names for which you are a submitter.
4. Identify the business flow and its step for which you'll upload a document. Hover your mouse over the record and
click Post ( ).
The Post Document page is displayed.
236
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
237
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
238
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Ensure that JSON Form follows the JSON schema provided by Oracle Intelligent Track and Trace. The following JSON
constructs are not supported in the JSON schema definition.
Unsupported JSON schema constructs
◦ null
◦ union
◦ anyOf
◦ oneOf
◦ allOf
◦ not
◦ media types
For example, line 39 to 47 in the sample DEMO PURCHASE ORDER document schema definition shows unsupported
schema constructs.
1 {
2 "$schema": "http://json-schema.org/draft-07/schema",
3 "$id": "http://oitt-ns.oracle.com/demos/fr/demo_purchase_order",
4 "definitions": {
5 "Address": {
6 "title": "Address",
7 "type": "object",
8 "properties": {
9 "addressLine1": {
10 "title": "addressLine1",
11 "type": "string"
12 },
13 "addressLine2": {
14 "title": "addressLine2",
15 "type": "string"
16 },
17 "city": {
18 "title": "city",
19 "type": "string"
20 },
21 "state": {
22 "title": "state",
23 "type": "string"
24 },
25 "country": {
26 "title": "country",
27 "type": "string"
28 },
29 "postalCode": {
30 "title": "postalCode",
31 "type": "string"
32 },
33 "FileContents": {
34 "format": "binary",
35 "type": "string",
36 "description": "Contents of the attachment file.",
37 "title": "File Contents"
38 },
39 "termsAndConditions": {
40 "anyOf": [
41 {
42 "type": "string"
43 },
44 {
239
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
45 "type": "array",
46 "items": {
47 "type": "integer"
48 }
49 }
50 ]
51 }
52 },
In this case, the DEMO PURCHASE ORDER FORM will not be generated and the following error will be displayed.
Note: Here, the PURCHASE ORDER FORM is the name of the document for which the schema document restrictions are
being violated.
Additionally, in a document schema, if an object type property is defined as optional but one or more of its property
node objects is defined as required, then the whole property is considered as a required field.
For example, in the following sample JSON schema, the totalOrderAmount object type property is not defined
as required, but the currencyCode and Amount sub-fields for moneyType property is defined as required, hence the
totalOrderAmount object type property is considered as a required property.
"definitions": {
"moneyType": {
"title": "moneyType",
"type": "object",
"properties": {
"currencyCode": {
"title": "currencyCode",
"type": "string"
},
"amount": {
"title": "amount",
240
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
"type": "number"
}
},
"required": [
"currencyCode",
"amount"
],
"additionalProperties": false
},
"link": {
"properties": {
"href": {
"type": "string",
"description": "The URI to the related resource.",
"title": "hyperlink reference"
},
"rel": {
"type": "string",
"description": "The name of the relation to the resource instance. Example: self.",
"title": "relation"
}
},
"type": "object",
"additionalProperties": false
}
},
"properties": {
"totalOrderAmount": {
"$ref": "#/definitions/moneyType"
},
6.
Optionally, you can add or remove multiple LineItems by clicking the ( ) or ( ) icons.
7. Before you upload the document, click Validate to verify the entered data.
The document type data entered is validated against the document schema definitions and all the wrong entries
must be fixed before the final upload.
8. Optionally, you can add attachments to the documents. To add attachments, see Add Attachments.
9. Click Post and wait until the Save successful message is displayed.
10. Click Close to return to the Document Submission dashboard.
Results:
Verify that submitted document appears in the Documents dashboard.
Add Attachments
As a submitter of a step in a business flow, add additional documents as attachments.
Note: The file size of the attachments including root files (JSON or CSV) must not exceed 500 MB in total.
241
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
2. (Optional) From the Number of attachments bar, click Upload, browse to the location, and select your document.
242
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
243
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
3.
Click Delete ( ) to remove any file from the attachment list.
4. Click Post and wait until the Save successful message is displayed..
5. Click Close to return to the Document Submission dashboard.
1. Add attachments for documents in CSV format
244
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
6. To upload the document in CSV format, follow step 1 to step 5 given in the Upload Documents as JSON or CSV file.
245
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
After you upload the root CSV file, an Attachments table with three Entry Identifier panels is displayed.
246
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
For each Entry Identifier, you can upload either single or multiple files.
7. (Optional) Click Upload, browse to the location, and select your document.
The file(s) gets added under Entry Identifier list.
8.
Click Delete ( ) to remove any file from the attachment list.
2. Add attachments for documents created using JSON form
9. To create and upload document using JSON Form, see Upload Documents as JSON Form.
After you add document data in the form, Attachments section appears underneath the JSON form.
10. Click Upload, browse to the location, and select your document.
The file(s) gets added under Number of attachments list.
11.
Click Delete ( ) to remove any file from the attachment list.
12. Click Post and wait until the Save successful message is displayed.
13. Click Close to return to the Document Submission dashboard.
Activity Log
Activity Log displays the status of activities that occur while executing a specific task and provides required information
to troubleshoot errors and failures.
Oracle Intelligent Track and Trace supports the following two activity logs:
• Built-In Integrations Activity Log
• Upload Activity Log
• Attachments Exports
247
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Topics
• View Activity Log for Built-In Integrations
• View Upload Activity Log
• View Attachments Export Status
As a founder or trading partner admin user, the activity log helps you view:
• Data sent from the built-in integrations, such as destination application/system, document type, timestamp,
transmission status, and document contents.
• Data received by Oracle Intelligent Track and Trace, such as sending application, document types, timestamp,
status, receiving errors if any, and document contents.
1.
Click Menu ( ) and then click Monitoring.
248
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
2.
Click Activity Log ( ).
The details of all the activities for built-in integrations are listed under the Integrations tab.
249
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
3. Errors related to connection, processing, or submission activities are displayed under Errors column. Click the error
type link to view additional details.
For example:
Processing error is reported when the document is successfully received but Oracle Intelligent Track and Trace
application fails to process the document.
A Submission error is reported when Oracle Intelligent Track and Trace application processes the document
successfully but fails to route the processed document to a specific flow step.
4.
To download the error report, click Download ( ).
The file can be downloaded in JSON or XML format.
5. To search for specific integration log details, click Filter ( ) and use the Select Filter and Select Filter Criteria
drop-downs to provide a search criteria on the various fields appearing on the list, such as status, integration name,
document type, and business flow step etc.
For more information about filters, see Use Filters to search data.
6. Sort the log entries as per timestamp, Integration Name, Status, and Document Type to view required data.
250
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
1.
Click Menu ( ) and then click Monitoring.
2.
Click Activity Log ( ).
3. On the Activity Log page, click Uploads tab.
The details of uploaded CSV file activities are listed under the Uploads tab.
4.
To download the error report, click Download ( ).
The file is downloaded in a CSV format.
251
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Navigate to the Attachments Exports tab to view the archive status and download the zip and csv file containing all
attachments and archive summary.
1.
Click Menu ( ) and then click Monitoring.
2.
Click Activity Log ( ).
3. On the Activity Log page, click Attachments Exports tab and download the files in your local system.
The list of exported archives are available for download.
4. Click Delete to remove downloaded files and to de-clutter the log view.
252
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Topics:
• View Document Processing Diagnostics
• Troubleshoot Common Error Scenarios
Documents submitted to Oracle Intelligent Track and Trace can fail due to multiple reasons, such as document
processing failure, blockchain processing failure, simulator processing failure, or business flow processing failure. As a
document submitter, you should be able to identify the reason of failure, and retry submitting the document once the
error is fixed. Diagnostic functionality enables you to identify the submitted transaction documents that have not been
successfully processed and recorded. You can also view the processing stage at which the error occurred, along with the
various generated artifacts to help you diagnose the error.
As a founder, you can see all the transaction documents submitted by you and all trading partners. However, once the
error is fixed, you can re-submit only those documents for which you are the submitter.
As a trading partner, you can view, retry, or discard document submission for which you are the submitter.
1.
Click Menu ( ) and then click Monitoring.
253
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
2.
Click Document Processing Diagnostics ( ).
The Document Processing Diagnostics dashboard is displayed.
Document Processing Diagnostic dashboard provides a birds-eye-view of all the failed document submissions in
the application.
254
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
Metric Description
Document Processing Specifies the number of documents failed during document processing.
Business Flow Processing Specifies the number of documents failed during business flow processing.
Blockchain Processing Specifies the number of documents failed during recording data on blockchain.
Document Type Metrics Specifies the number of documents failed for each document type configured in the application.
Integration Processing Specifies the number of documents failed during integration processing.
Simulator Processing Specifies the number of documents failed during simulator processing. This error is recorded when
simulator fails to generate document or if the generated document fails validation.
A detailed list of all failed event types is displayed which enables you to diagnose the error and retry the document
submission once the error is resolved.
Field Description
Timestamp Specifies the date and time when the failure is observed.
Event Type Specifies the event during which the Document failure was observed—Document Processing,
Business Flow Processing, Simulator Processing or Blockchain Processing.
Document Variant Specifies the definition variant name of the document type.
Business Flow Specifies the name of the business flow in which the failure occurred.
Last Replayed Specifies the date and time when the document is submitted again after fixing the error.
3.
Click Document ( ) icon to download and view the document in which the error is observed.
4.
Click Show Diagnostic Details ( ) to view the details about the error occurred.
5.
Click Replay document ( ) to retry submitting the document once the error is resolved.
6.
Click Discard error ( ) to discard failed document.
7. Click Refresh to retry all Documents.
8. To replay submission of selective documents, click the Selected check boxes for the specific failure records, and click
Replay Selected Documents.
9. To delete a few failure records, click the Selected check boxes for the specific failure records, and click Discard
Selected Errors.
255
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
In addition to the existing filters, a new Submitter filter has been added for you to narrow down the diagnostic data list
to view the failed document submissions by submitter. To apply this filter:
1. Click the Filter bar and select Submitter.
2. From the Submitter drop-down list, select the required operator, such as starts with, matches, or does not match.
3. In the Type Filter Criteria field, enter the filter criteria. For example, submitter name.
Results:
The following image shows the filtered diagnostic data where submitter name starts with Vision Pharma.
Document Processing Submitted document not complaint with schema This error may be caused due to any of the 1.
following two reasons:
256
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
1. Invalid Schema 2.
Document Processing Error storing transaction in document store. This error is observed when the document Resu
with the specified key already exists. key.
Duplicate ingestion of the same document Defi
is not supported.
Document Processing Unexpected error while processing event Unexpected error happened with the Con
system.
Business Flow Processing Error receiving document from object storage The application is unable to fetch the Con
document from OCI object storage, possibly
due to network issue during connectivity.
Business Flow Processing Invalid hash of Object store document Invalid document fetched from OCI Con
document storage, possibly due to
corrupted document.
Business Flow Processing Invalid JSON produced for metadata Application of Handlebars template on the Verif
document produced invalid JSON. This been
could possibly be due to an issue with the also
metadata template. valid
Edit
erro
subm
Business Flow Processing Unexpected error while processing the document metadata. This error is observed when there is a Con
connectivity Issue with the infrastructure.
java.net.SocketException: Network is unreachable
Blockchain Processing Error invoking BCS transaction proxy Incorrect BCS configuration. Corr
subm
Unauthorized OBCS admin [email protected]
This is not an exception event Documents show up in separate flow instances This is a potential error which may be Verif
caused due to incorrect document cross- subm
reference mapping in the metadata matc
template.
You
inco
succ
this
bloc
257
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
This is not an exception event Flow instance view shows incorrect flow relationships This is a potential error which may be Verif
caused due to incorrect cross references insta
between the documents. in th
sche
You
inco
succ
this
bloc
Topics:
View Oracle Intelligent Track and Trace Version
258
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
2.
On the bottom right corner of the navigation bar, click About ( ).
The Oracle Intelligent Track and Trace version window is displayed.
3. Click Details to view the versions of all the microservices running in the backend.
4.
Click Close ( ) to return to the Oracle Intelligent Track and Trace application.
259
Oracle Cloud Chapter 5
Using Oracle Intelligent Track and Trace Use Oracle Intelligent Track and Trace
260
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
As part of configuring the Oracle Intelligent Track and Trace, founder defines a set of document types which are then
used to define business flows. A document received in any business transaction belongs to one of these document
types.
Each document type consists of multiple data structures which help the application to process and ingest the document
received in a transaction. As a founder, you must accurately define these document types and provide association
between them in case they have any dependency.
Oracle Intelligent Track and Trace provides pre-seeded document types which can be used directly to define business
flow steps. You can also define your own customized document types in case the pre-seeded types do not fulfill your
business requirements.
This chapter provides the instructions on how to define your own customized document type.
• Define Document Schema JSON
• Define Metadata Template
• Define Metadata Schema
• Define Simulator Template
• Define Presentation Template
JSON is a data-interchanged language which is relatively easy for humans to read and write, and easy for software to
parse and generate. It is often used for serializing structured data and exchanging it over a network, typically between a
server and web applications.
Oracle Intelligent Track and Trace currently supports JSON Schema Draft 7 specification for parsing and validating the
incoming transaction documents. As a founder, when you define your own document type structure, it must be JSON
Schema draft 7 compliant. You can read more about the JSON and the current specifications at http://www.json.org/
and http://json-schema.org/specification-links.html.
Once you have defined your document schema, you can upload it to Oracle Intelligent Track and Trace by following the
instructions provided in Create a New Document Type.
Usage Example
This is an example of a JSON schema for document type Shipping.
{
"$schema": "http://json-schema.org/draft-07/schema#",
261
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"type": "object",
"$id": "urn:GetAdvancedShipmentNoticeDataResponse",
"properties": {
"result": {
"type": "object",
"$id": "urn:ASNShipmentResult",
"properties": {
"message": {
"type": "array",
"items": {
"type": "object",
"$id": "urn:ServiceMessage",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"detail": {
"type": "array",
"items": {
"type": "object"
}
}
},
"additionalProperties": false
}
},
"value": {
"type": "object",
"$id": "urn:ASNShipment",
"required": [
"deliveryId",
"billOfLadingNumber"
],
"properties": {
"deliveryId": {
"type": "integer"
},
"deliveryName": {
"type": "string"
},
"initialPickupDate": {
"type": "integer",
"format": "utc-millisec"
},
"initialPickupLocationId": {
"type": "integer"
},
"shipFromAddress1": {
"type": "string"
},
"shipFromAddress2": {
"type": "string"
},
"shipFromAddress3": {
"type": "string"
},
"shipFromAddress4": {
"type": "string"
},
"shipFromCity": {
262
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"type": "string"
},
"shipFromCountry": {
"type": "string"
},
"shipFromCountryName": {
"type": "string"
},
"shipFromCountryDescription": {
"type": "string"
},
"shipFromCounty": {
"type": "string"
},
"shipFromPostalCode": {
"type": "string"
},
"shipFromState": {
"type": "string"
},
"ultimateDropoffLocationId": {
"type": "integer"
},
"shipToAddress1": {
"type": "string"
},
"shipToAddress2": {
"type": "string"
},
"shipToAddress3": {
"type": "string"
},
"shipToAddress4": {
"type": "string"
},
"shipToCity": {
"type": "string"
},
"shipToCountry": {
"type": "string"
},
"shipToCountryName": {
"type": "string"
},
"shipToCountryDescription": {
"type": "string"
},
"shipToCounty": {
"type": "string"
},
"shipToPostalCode": {
"type": "string"
},
"shipToState": {
"type": "string"
},
"ultimateDropoffDate": {
"type": "integer",
"format": "utc-millisec"
},
"actualShipDate": {
"type": "integer",
"format": "utc-millisec"
},
"freightTermsCode": {
"type": "string"
263
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
},
"freightTermsName": {
"type": "string"
},
"fobCode": {
"type": "string"
},
"fobName": {
"type": "string"
},
"waybill": {
"type": "string"
},
"grossWeight": {
"type": "number"
},
"netWeight": {
"type": "number"
},
"weightUOMCode": {
"type": "string"
},
"weightUOMName": {
"type": "string"
},
"volume": {
"type": "number"
},
"volumeUOMCode": {
"type": "string"
},
"volumeUOMName": {
"type": "string"
},
"dockCode": {
"type": "string"
},
"shippingMethodName": {
"type": "string"
},
"carrierId": {
"type": "integer"
},
"carrierName": {
"type": "string"
},
"carrierNumber": {
"type": "string"
},
"organizationId": {
"type": "integer"
},
"organizationCode": {
"type": "string"
},
"organizationName": {
"type": "string"
},
"loadingSequence": {
"type": "number"
},
"loadingOrderType": {
"type": "string"
},
"loadingOrderTypeName": {
"type": "string"
264
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
},
"numberOfLPN": {
"type": "number"
},
"serviceLevel": {
"type": "string"
},
"serviceLevelName": {
"type": "string"
},
"modeOfTransport": {
"type": "string"
},
"modeOfTransportName": {
"type": "string"
},
"earliestPickupDate": {
"type": "integer",
"format": "utc-millisec"
},
"latestPickupDate": {
"type": "integer",
"format": "utc-millisec"
},
"earliestDropoffDate": {
"type": "integer",
"format": "utc-millisec"
},
"latestDropoffDate": {
"type": "integer",
"format": "utc-millisec"
},
"shipToPartyId": {
"type": "integer"
},
"shipToPartyName": {
"type": "string"
},
"shipToPartyNumber": {
"type": "string"
},
"soldToPartyId": {
"type": "integer"
},
"soldToPartyName": {
"type": "string"
},
"soldToPartyNumber": {
"type": "string"
},
"outsourcerPartyId": {
"type": "integer"
},
"outsourcerPartyName": {
"type": "string"
},
"outsourcerPartyNumber": {
"type": "string"
},
"billOfLadingNumber": {
"type": "string"
},
"packingSlipNumber": {
"type": "string"
},
"tareWeight": {
265
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"type": "number"
},
"transportationReason": {
"type": "string"
},
"rcvShipmentNumber": {
"type": "string"
},
"shipToPartySiteId": {
"type": "integer"
},
"asnOuterPackingUnit": {
"type": "array",
"items": {
"type": "object",
"$id": "urn:ASNPackingUnit",
"properties": {
"lpnId": {
"type": "integer"
},
"licensePlateNumber": {
"type": "string"
},
"deliveryId": {
"type": "integer"
},
"inventoryItemId": {
"type": "integer"
},
"itemNumber": {
"type": "string"
},
"itemDescription": {
"type": "string"
},
"parentLPNId": {
"type": "integer"
},
"parentLicensePlateNumber": {
"type": "string"
},
"outermostLPNId": {
"type": "integer"
},
"outermostLicensePlateNumber": {
"type": "string"
},
"grossWeightUOMCode": {
"type": "string"
},
"grossWeightUOMName": {
"type": "string"
},
"grossWeight": {
"type": "number"
},
"containerVolumeUOMCode": {
"type": "string"
},
"containerVolumeUOMName": {
"type": "string"
},
"containerVolume": {
"type": "number"
},
"tareWeightUOMCode": {
266
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"type": "string"
},
"tareWeightUOMName": {
"type": "string"
},
"tareWeight": {
"type": "number"
},
"packingInstructions": {
"type": "string"
},
"containerTypeCode": {
"type": "string"
},
"containerTypeName": {
"type": "string"
},
"sealCode": {
"type": "string"
},
"unitHeight": {
"type": "number"
},
"unitLength": {
"type": "number"
},
"unitWidth": {
"type": "number"
},
"dimensionUOMCode": {
"type": "string"
},
"dimensionUOMName": {
"type": "string"
},
"netWeightUOMCode": {
"type": "string"
},
"netWeightUOMName": {
"type": "string"
},
"netWeight": {
"type": "number"
},
"asnShippingCost": {
"type": "array",
"items": {
"type": "object",
"$id": "urn:ASNShippingCost",
"properties": {
"freightCostId": {
"type": "integer"
},
"freightCostTypeCode": {
"type": "string"
},
"freightCostTypeName": {
"type": "string"
},
"amount": {
"type": "object",
"$id": "urn:AmountType",
"properties": {
"value": {
"type": "number"
},
267
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"currencyCode": {
"type": "string"
}
},
"additionalProperties": false
},
"currencyCode": {
"type": "string"
},
"currencyName": {
"type": "string"
},
"conversionTypeCode": {
"type": "string"
},
"conversionTypeName": {
"type": "string"
},
"conversionDate": {
"type": "integer",
"format": "utc-millisec"
},
"conversionRate": {
"type": "number"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"asnInnerPackingUnit": {
"type": "array",
"items": {
"type": "object"
}
},
"asnShipmentItem": {
"type": "array",
"items": {
"type": "object",
"$id": "urn:ASNShipmentItem",
"anyOf": [
{
"required": [
"itemNumber"
]
},
{
"required": [
"inventoryItemId"
]
}
],
"required": [
"itemDescription",
"requestedQuantity",
"salesOrderNumber"
],
"properties": {
"deliveryDetailId": {
"type": "integer"
},
"deliveryId": {
268
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"type": "integer"
},
"sourceHeaderId": {
"type": "integer"
},
"sourceLineId": {
"type": "integer"
},
"sourceHeaderNumber": {
"type": "string"
},
"customerPONumber": {
"type": "string"
},
"inventoryItemId": {
"type": "integer"
},
"itemNumber": {
"type": "string"
},
"itemDescription": {
"type": "string"
},
"requestedQuantity": {
"type": "object",
"$id": "urn:MeasureType",
"required": [
"value"
],
"properties": {
"value": {
"type": "number"
},
"unitCode": {
"type": "string",
"enum": [
"ANN",
"BOX",
"BX5",
"Box",
"C",
"CEL",
"CFT_I",
"CIN_I",
"CM",
"cm",
"CM2",
"CM3",
"CMQ",
"CMT",
"CYD_I",
"D",
"DAY",
"DEGF",
"DZ",
"EA",
"Ea",
"F",
"FOT",
"FT",
"ft",
"FT2",
"FT3",
"FT_I",
"G",
"GAL",
269
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"GR",
"HR",
"IN",
"in",
"IN2",
"IN3",
"INH",
"IN_I",
"K",
"KG",
"KM",
"km",
"KM2",
"KTM",
"L",
"LB",
"LB_AV",
"Lbs",
"M",
"m",
"M2",
"M3",
"MG",
"MI",
"MI2",
"MI_I",
"miles",
"ML",
"MM",
"mm",
"MM2",
"MMT",
"MO",
"MON",
"MTK",
"MTN",
"MTR",
"OZ",
"OZ_AV",
"PT",
"QT",
"QTR",
"S",
"SEC",
"SF",
"SFT_I",
"SI",
"SIN_I",
"SY",
"SYD_I",
"TNE",
"TON",
"YD",
"YD2",
"YD3",
"YD_I",
"YR",
"YRD"
]
}
},
"additionalProperties": false
},
"requestedQuantityUOM": {
"type": "string"
},
270
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"requestedQuantityUOMName": {
"type": "string"
},
"shippedQuantity": {
"type": "object",
"$id": "urn:MeasureType",
"properties": {
"value": {
"type": "number"
},
"unitCode": {
"type": "string"
}
},
"additionalProperties": false
},
"subinventory": {
"type": "string"
},
"revision": {
"type": "string"
},
"lotNumber": {
"type": "string"
},
"dateRequested": {
"type": "integer",
"format": "utc-millisec"
},
"requestDateTypeCode": {
"type": "string"
},
"requestDateTypeName": {
"type": "string"
},
"dateScheduled": {
"type": "integer",
"format": "utc-millisec"
},
"loadSequenceNumber": {
"type": "number"
},
"shipmentPriorityCode": {
"type": "string"
},
"shipmentPriorityName": {
"type": "string"
},
"customerItemId": {
"type": "integer"
},
"customerItemNumber": {
"type": "string"
},
"customerItemDescription": {
"type": "string"
},
"netWeight": {
"type": "number"
},
"weightUOMCode": {
"type": "string"
},
"weightUOMName": {
"type": "string"
},
271
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"volume": {
"type": "number"
},
"volumeUOMCode": {
"type": "string"
},
"volumeUOMName": {
"type": "string"
},
"shippingInstructions": {
"type": "string"
},
"packingInstructions": {
"type": "string"
},
"parentLPNId": {
"type": "integer"
},
"parentLPNName": {
"type": "string"
},
"sourceLineNumber": {
"type": "string"
},
"grossWeight": {
"type": "number"
},
"preferredGrade": {
"type": "string"
},
"earliestPickupDate": {
"type": "integer",
"format": "utc-millisec"
},
"latestPickupDate": {
"type": "integer",
"format": "utc-millisec"
},
"earliestDropoffDate": {
"type": "integer",
"format": "utc-millisec"
},
"latestDropoffDate": {
"type": "integer",
"format": "utc-millisec"
},
"salesOrderLineNumber": {
"type": "string"
},
"salesOrderNumber": {
"type": "string"
},
"salesOrderShipmentNumber": {
"type": "string"
},
"sourceLineType": {
"type": "string"
},
"sourceLineTypeName": {
"type": "string"
},
"shipToContactPartyId": {
"type": "integer"
},
"shipToContactPartyName": {
"type": "string"
272
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
},
"shipToContactPartyNumber": {
"type": "string"
},
"shipToContactPhoneNumber": {
"type": "string"
},
"shipToContactEmailAddress": {
"type": "string"
},
"soldToContactPartyId": {
"type": "integer"
},
"soldToContactPartyName": {
"type": "string"
},
"soldToContactPartyNumber": {
"type": "string"
},
"soldToContactPhoneNumber": {
"type": "string"
},
"soldToContactEmailAddress": {
"type": "string"
},
"tareWeight": {
"type": "number"
},
"asnShippingCost": {
"type": "array",
"items": {
"type": "object"
}
},
"asnProratedShippingCost": {
"type": "array",
"items": {
"type": "object",
"$id": "urn:ASNProratedShippingCost",
"properties": {
"proratedFreightCostId": {
"type": "integer"
},
"freightCostTypeCode": {
"type": "string"
},
"freightCostTypeName": {
"type": "string"
},
"proratedAmount": {
"type": "object"
},
"currencyCode": {
"type": "string"
},
"currencyName": {
"type": "string"
}
},
"additionalProperties": false
}
},
"asnSerialNumber": {
"type": "array",
"items": {
"type": "object",
273
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"$id": "urn:ASNSerialNumber",
"properties": {
"fromSerialNumber": {
"type": "string"
},
"toSerialNumber": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"asnShippingCost": {
"type": "array",
"items": {
"type": "object"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
A metadata template extracts key pieces of information from the received document and maps this information
to a normalized schema. This enables the Oracle Intelligent Track and Trace application to process and ingest
this information which is then written to the ledger. This extracted data is used for defining tracking, tracing, and
determining data insights.
Topics:
• About Handlebar Helpers
• Sample Structures of Item Tracking Metadata Helper Functions
Use the Handlebar helpers and application specific helper functions in the template for generating the metadata
document. For each attribute in the JSON schema for the metadata, there is an associated helper function.
274
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
Using these helper functions significantly eases the creation of metadata templates as you don't need to know JSON
syntax. This approach is backward compatible.
• You can use all native Handlebar helpers, such as {{#if}}, {{#each}}, {{#with}} for iterations and conditions.
• Use utility helpers, such as concat, toTimestamp, etc. for string concatenation, data conversion, lookups, etc.
• Each helper function that is associated with an attribute of the metadata's JSON schema, has the same name
as the attribute and is prefixed by md:. For example, the helper function for the documentNumber attribute is
md:documentNumber.
275
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
276
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
md:documentNumber Has a single parameter with a value To uniquely identify the document. Yes
Example:
{{md:documentNumber
document.OrderNumber}}
md:ledgerKey Has a single parameter with a value Unique value that acts as a key Yes
for a document in the distributed
ledger.
Example:
{{md:ledgerKey
(concat "purchase_
order:"document.OrderNumber)}}
md:documentTypeId Has a single parameter with a value Determines the chronological Yes
order of a document in a trace.
Document issue date, document
creation date, and so on are typical
attributes that may provide the
value for this helper.
If this helper is not used in the
template, then the value defaults
to the time, the document was
received by Oracle Intelligent Track
and Trace. Number to identify the
type of document.
Example:
{{md:documentTypeId
"purchase_order"}}
md:documentTimestamp Has a single parameter with a value Transaction date whose value Yes
determines the chronological order
of the document in a trace.
Example:
{{md:documentTimestamp
(orDefault
document.result.orderDate
document.result.creationDate)}}
md:transactionValue Has a single parameter with a value Captures the value of the Yes
transaction, such as total order
value or total invoice amount. Set
277
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
{{#md:transactionValue}}
{{md:currencyCode
(orDefault
document.declaredValue.currencyCode
"USD")}} {{md:amount
(orDefault
document.declaredValue.amount
0)}} {{/
md:transactionValue}}
{{md:documentCrossRef
documentNumber=document.result.vendorOrderNum
documentTypeId="SalesOrder"
ledgerKey=(concat
"SalesOrder:"
document.result.vendorOrderNum)}}
{{md:receiver
document.result.value.shipToPartyName
by="name"}}
md:documentData Has a single parameter with a This helps to specify field names No
value. and their values. This helper
is used to copy arbitrary data
from the source document to the
normalized documents.
278
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
Example:
{{md:documentData
"billOfLadingNumber"
document.result.value.billOfLadingNumber}}
md:reference Has a single parameter with a value Enables you to create a reference No
key if it has not been created in the
system before or if a key with the
same value already exists in the
system then this document will be
linked to that key.
Example:
279
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
• #md:trackingData
• md:geolocation
• #md:metric
md:trackingdata An object with several nested Used for tracking IoT data. No
objects as seen in this structure If trackingData is used,
geoLocation must be specified.
The metrics array is a list of
280
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
md:itemTrackingData No arguments but either of these The content of this item tracking No
qualifiers: lotControlled, block helper function depends
serialControlled, on the qualifier used in this
unassignedControlled block. View a typical structure in
Sample Structures of Item Tracking
Metadata Helper Functions.
281
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
md:itemTypeId a single value that is typically Declares the ID of the item type Yes
retrieved by using a nested helper that needs to be tracked. An item
mapItemType referenced in a document needs
to mapped to the appropriate item
type registered in the application.
This mapping is done by the look-
up helper function mapItemType.
Example:
{{md:itemTypeId
(mapItemType
item.itemNumber
(lookupSubmitter))}}
md:itemEventType Values from: CREATED, USING, This line helper function defines Yes
ORDERED, RECEIVED, the value of the event type.
SHIPPED, MOVED, RETURNED Example:
{{md:itemEventType
"SHIPPED"}}
md:description A string value that describes the This line helper function defines No
item. the description of the item.
Example:
{{md:description
item.itemDescription}}
{{md:serialNumber
itemSerial.fromSerialNumber}}
{{#md:currentCustody}}
{{md:custodyChangeReason
"UNASSIGNED |
TRANSFERRED | SOLD |
RETURNED | SHIPPED"}}
{{#md:tradingPartner}}
282
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
{{md:tradingPartnerId ""}}
{{/md:tradingPartner}}
{{#md:tradingPartner}}
{{md:tradingPartnerName
""}} {{/
md:tradingPartner}}
{{#md:location}}
{{md:locationId ""}}
{{/md:location}}
{{#md:location}}
{{md:locationAddress
""}} {{/md:location}} {{/
md:currentCustody}}
md:custodyChangeReason A single value Defines the reason for which the Yes
custody of the item changed.
Example:
{{md:custodyChangeReason
"UNASSIGNED | TRANSFERRED
| SOLD | RETURNED |
SHIPPED"}}
{{#md:tradingPartner}}
{{md:tradingPartnerId ""}}
{{/md:tradingPartner}}
Example
{{md:location
locationId=(lookupTradingPartner
"DC-ID"
document.ShipToOrganizationCode
by="location"
output="locId"
whenMissing="fail") "id":
"12", "tradingPartnerId":
"12", "locationId":
"44",locations "id": "12",
"name": "Delta Glass",
283
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"address": "Phoenix, E
Euclid Ave, AZ, 85042,
US", "coordinates":
{ "latitude": 47.98889,
"longitude": 8.79116 }}}
{{md:lotNumber
item.lotNumber}}
{{#md:quantity}}
{{md:unitCode (orDefault
item.shippedQuantity.unitCode
"Ea")}} {{md:value
(orDefault
item.shippedQuantity.value
0)}} {{/md:quantity}}
{{md:unitCode (orDefault
item.shippedQuantity.unitCode
"Ea")}}
284
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
{{md:value (orDefault
item.shippedQuantity.value
0)}}
mapItemType Have two arguments. The first This helper function is used Yes
parameter is a string value to lookup the internal ID for
representing the item code. The the item type referenced in the
second parameter is a string value source document. An item type
of the internal id of the trading can be looked up either in the
partner, which typically retrieved master catalog (founder's item
by using another helper function. types list) or in the submitting
trading partner's list. Based
on where you need to lookup,
use lookupFounder or
lookupSubmitter appropriately.
Examples:
{{mapItemType
ItemTypeCode=shipmentLine.ItemNumber
tpId=(lookupFounder)}}
{{mapItemType
ItemTypeCode=shipmentLine.ItemNumber
tpId=(lookupSubmitter) )}}
{{mapItemType
ItemTypeCode-
shipmentLine.ItemNumber
"something"}}
Example:
{{mapItemType
ItemTypeCode=shipmentLine.ItemNumber
tpId=(lookupSubmitter)
whenMissing='ignore' {{mapItemType
ItemTypeCode=shipmentLine.ItemNumber
tpId=(lookupFounder)}}
md:packageTypeId A single parameter string value This nested helper function Yes
that is retrieved from another represents an internal id of the
helper mapPackageType.. package type that is retrieved from
another helper mapPackageType.
Example:
{{md:packageTypeId
(mapPackageType "box")}}
285
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
mapPackageType A single parameter with a value. This line helper function returns a yes
string that represents the internal
id of a package type and it accepts
the name of the package type
created by a founder.
Example:
{{mapPackageType
PackageType=packingUnit.PackingType}}
{{md:packageEventType
"SHIPPED"}}
md:referencedItem Depends on the context of its This helper allows capture of No. For batch controlled metadata,
usage parent/child relationships of it is mandatory.
items. It should be used to capture
ingredient or component usage
to produce or manufacture semi-
finished or finished products.
Example:
{{#md:referencedItem:lotControlled}}
{{md:itemTypeId
(mapItemType
shipmentLine.Item
(lookupFounder))}}
{{md:lotNumber
shipmentLine.LotNumber}}
{{md:quantity (orDefault
shipmentLine.RequestedQuantityUOMCode
"EA") (orDefault
shipmentLine.ShippedQuantity
0)}} {{/
md:referencedItem:lotControlled}}
• toTimestamp
• Sum
• Find
• split
• regexpFind
• String helpers
• Condition helpers
286
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
jsonItem Has a single parameter with a value Prints json without quotes. No
For more information, see
https://github.com/jknack/
handlebars.java#jackson-2x
sum Has multiple parameters with Sum all arguments in the format No
values
{{sum a.value b.value
c.value}}
find Has a single parameter with a value Finds an element with the property No
set to a particular value.
287
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
• whenMissing (optional)
- Specifies the behavior
when index or delimiter is
incorrect. The default value is
'fail'.
See Examples of Utility Helper
Functions
• whenMissing (optional)
- Specifies the behavior
when index or delimiter is
incorrect. The default value is
'fail'.
See Examples of Utility Helper
Functions
String helpers Have single or multiple parameters String helper functions publicly No
available at https://github.com/
288
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
jknack/handlebars.java#string-
helpers
Common Helpers
These helper functions are used across all helpers including item tracking helper functions, as sub helpers.
• md:name
• md:label
• #md:quantity
• md:unitCode
• md:value
• md:comments
{{#md:quantity}}
{{md:unitCode (orDefault
item.shippedQuantity.unitCode
"Ea")}} {{md:value
(orDefault
item.shippedQuantity.value
0)}} {{/md:quantity}}
{{md:unitCode (orDefault
item.shippedQuantity.unitCode
"Ea")}}
289
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
{{md:value (orDefault
item.shippedQuantity.value
0)}}
md:documentNumber Has a single parameter with a value Number to identify the document. Yes
Example:
{{md:documentNumber
document.OrderNumber}}
md:DocumentTypeId Has a single parameter with a value Number to identify the type of Yes
document.
Example:
{{md:documentTypeId
"purchase_order"}}
md:ledgerKey Has a single parameter with a value Unique value that acts as a key Yes
for a document in the distributed
ledger.
Example:
{{md:ledgerKey
(concat "purchase_
order:"document.OrderNumber)}}
290
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
{{md:documentCrossRef
document.SupplierOrderNumber
(concat "sales_
order:"document.SupplierOrderNumber)
"sales_order"}}
Example of named parameters
{{md:documentCrossRef
documentNumber=document.SupplierOrderNumber
documentTypeId=(concat
"sales_
order:"document.SupplierOrderNumber)
ledgerKey="sales_order"}}
Note: For the descriptions of the helper functions, review the following table and for their examples, view Usage
Examples
291
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
{{/each}}
{{#md:attributes}}
{{md:classification document.ClassificationCode}}
{{/md:attributes}}
{{/md:itemTrackingData:lotControlled}}
Example
##Example JSON:
{
“Attr1”: “some value”,
“Qty1": 10,
“Qty2”: 200,
“anArray”: [
{
“name”: “Temperature”,
“value”: 40
},
{
“name”: “Pressure”,
“value": 14
},
{
“name”: “Humidity”,
“value”: 45
}]
}
##Example of sum and find:
{
“total”: {{sum document.Qty1 document.Qt2}},
{{find document.anArray “name” “Pressure" as |reading| }}
“pressureReading”:reading.value
{{/find}}
}
##Example Result:
{
“total”: 120,
“pressureReading”: 14
}
Example
{{#find some.array "x" "yy" as |o i| }}{{o.n }} {{i}} {{@key}} {{@index}}
{{else}}na{{/find}}
Find object in an array (or object) with field "x": "yy". Inside the block, o is referencing the object found, i is the index of
the object. Both can be named differently. Also, special keys are available inside the block, with self-explanatory names:
@key, @index, where key has the same value as index in arrays. It is modeled in the similar fashion as handlebars "each"
helper, including the "else" block. Most of these parameters are optional, the minimal find helper is {{find arr "x"
"yy"}} prints the object with "x":"yy" field.
292
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
{{split 'a b' index=1}} // resolved as 'b'
{{split 'a b' index=-1}} // resolved as 'b'
{{split '/shipment/shipmentID' delimiter='/' index=3 whenMissing='fail'}} // fails with error: Invalid index
parameter: '3'
{{split '/shipment/shipmentID' delimiter='/' index=3 whenMissing='ignore'}} // resolved as '' (empty string)
Example
## Sample Document
{
"Name" : {
"firstName" : "Testabcd",
"lastName" : "Helperefgh"
},
"uri": "shipment/shipmentId",
"BillOfLadingNumber": "80000000099",
"CarrierName": "Zeta Carrier",
"Consignment": [
{
"PONumber": "GHPO-21029000123",
"LPN": "ZXR40034501",
"ContainerType": "CONTAINER-8",
"PackageCount": 1,
"Weight": {
"unitCode": "KG",
"value": 980
}
}
],
In the document schema, uri is set to "uri": "/shipment/shipmentId" and you want to extract the last sub-string of the
uri text.
In a metadata document, the split helper function helps you extract a sub-string from the given text.
{{md:documentData "uri-last" (split document.uri delimiter='/' index=-1 whenMissing='ignore' )}}
{{regexpFind '/a1/b2/C3/d4' '[a-z0-9]+'}} // result: [a1, b2, 3, d4] (all segments matching the pattern)
{{regexpFind '/a1/b2/C3/d4' '[a-z0-9]+' index=0}} // result: 'a1' (first segment matching the pattern)
{{regexpFind '/a1/b2/C3/d4' '[a-z0-9]+' index=-1}} // result: 'd4' (last segment matching the pattern)
{{regexpFind '/a1/b2/C3/d4' '[a-z0-9]+' index=2}} // result: '3' (third segment matching the pattern)
{{regexpFind '/a1/b2/C3/d4' '(?i)[a-z0-9]+' index=2}} // result: 'C3' (case insensitive pattern is used)
{{regexpFind '/a1/b2/C3/d4' '[a-z0-9]+' index=-1 group=0}} // result: 'd4' (last segment matching the
pattern)
293
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
{{regexpFind '/a1/b2/C3/d4' '[a-z0-9]+' index=-1 group=1}} // fails with error: Invalid group parameter: '1'
{{regexpFind '/a1/b2/C3/d4' '[a-z0-9]+' index=-1 group=1 whenMissing='ignore'}} // result: '' (empty string)
For example, you can use regexpFind helper function to extract the firstname and the lastname from "Name".
#with (regexpFind document.Name.firstName '[a-zA-Z][a-z]?') as |segments|
md:documentData "nickName" (concat segments.0 segments.1)"
md:documentData "nickName2" (concat segments.0 ' ')"
md:documentData "nickName3" (concat segments.1 ' ')"
md:documentData "nickName4" (concat segments.2 ' ')"
md:documentData "nickName5" (concat segments.3 ' ')"
/with
"Name" :
Usage Example
Let us take a metadata document sample of a Shipping document type that is used to inspect quality report of the
shipped goods. The important attributes captured are:
For a submitted Shipping document, the following is the generated metadata JSON schema:
{
"documentTypeId": "shipping",
"documentVariantId": "demo_asn",
"ledgerKey": "shipping:DMSN-113512",
"documentNumber": "DMSN-113512",
"originalDocumentRef": {
"location": {
"bucket": "requests_ascus_test",
"object": "39_43_d0ba0327-0f95-4896-8e2d-af2d62c73d2e/document"
},
"documentHash":
"81b7c39fcee7302868c2771fe029b3beb70fb4f47bb27e0188795c08688ead7f736ccf994f83b05a5a2cb0e6b70a5430a8a77e196522f0f65f
294
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
},
"requestBodyRef": {
"location": {
"bucket": "requests_ascus_test",
"object": "39_43_d0ba0327-0f95-4896-8e2d-af2d62c73d2e/document"
},
"documentHash":
"81b7c39fcee7302868c2771fe029b3beb70fb4f47bb27e0188795c08688ead7f736ccf994f83b05a5a2cb0e6b70a5430a8a77e196522f0f65f
},
"attachmentsRefs": [],
"receivedTimestamp": 1639390270482,
"documentTimestamp": 1620436086047,
"submitter": {
"tradingPartnerId": "21"
},
"receiver": {
"tradingPartnerId": "29",
"locationId": "32"
},
"itemTrackingData": [
{
"itemTypeId": "Eftw5QPDFrBVgaxxH1B7Rw",
"lotNumber": "OAT-4001-1231",
"quantity": {
"unitCode": "KG",
"value": 400,
"normalized": {
"unitCode": "kg",
"value": 400,
"class": "MASS"
}
},
"itemEventType": "SHIPPED",
"controlType": "LOT_CONTROLLED"
}
],
"packageTrackingData": [
{
"controlType": "PACKAGE_CONTROLLED",
"packageNumber": "DM-P-3512-4001",
"packageTypeId": "predefined_package",
"packageEventType": "SHIPPED",
"referencedItems": [
{
"itemTypeId": "Eftw5QPDFrBVgaxxH1B7Rw",
"lotNumber": "OAT-4001-1231",
"quantity": {
"unitCode": "KG",
"value": 400,
"normalized": {
"unitCode": "kg",
"value": 400,
"class": "MASS"
}
},
"controlType": "LOT_CONTROLLED"
}
]
},
{
"controlType": "PACKAGE_CONTROLLED",
"packageNumber": "DM-P-3512-4000",
"packageTypeId": "predefined_pallet",
"packageEventType": "SHIPPED",
"referencedItems": [
{
295
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"packageTypeId": "predefined_package",
"packageNumber": "DM-P-3512-4001",
"controlType": "PACKAGE_CONTROLLED"
}
]
}
],
"transactionValue": {
"currencyCode": "USD",
"amount": 0
},
"documentData": {},
"documentCrossRefs": [
{
"documentNumber": "DMSO-32512",
"ledgerKey": "sales_order:DMSO-32512",
"documentTypeId": "sales_order"
},
{
"documentNumber": "NFPO-71512",
"ledgerKey": "purchase_order:NFPO-71512",
"documentTypeId": "purchase_order"
}
]
}
296
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
{{/metadataDocument}}
The following is an example of the generated metadata JSON schema for a submitted Work process product
completion document.
{
"documentTypeId": "work_process_product_completion",
"ledgerKey": "WorkProcessProductCompletion:90002001801",
"documentNumber": "90002001801",
"originalDocumentRef": {
"location": {
"bucket": "documents_demovac1_test",
"object": "42_45_d5d68001-b426-491e-a3a0-6a463bd375d5/document"
},
"documentHash":
"6b34d8d9e26ef5a6cd8ea7ec8f145743f69ac1dee284306c87f77c11673536f0460379c8cf2ed93f5d347c8c1cfcfae39ae1e58102b22ece24
},
"attachmentsRefs": [],
"receivedTimestamp": 1616613435457,
"documentTimestamp": 1608804600000,
"submitter": {
"tradingPartnerId": "98"
},
"receiver": {
"tradingPartnerId": "98"
},
"itemTrackingData": [
{
"itemTypeId": "63gCmnAXAGoKCSWtyppx2K",
"description": "10-Dose Flu Vaccine",
"lotNumber": "FL-VAC-20210106-12012",
"quantity": {
"unitCode": "EA",
"value": 3000
},
"itemEventType": "CREATED",
"controlType": "LOT_CONTROLLED"
}
],
"transactionValue": {
"currencyCode": "USD",
"amount": 0
},
"documentData": {
"TransactionSourceType": "PROCESS WORK ORDER",
"TransactionAction": "WORK ORDER COMPLETION"
},
"documentCrossRefs": [
{
"documentNumber": "WO-3400122",
"documentTypeId": "process_work_order",
"ledgerKey": "ProcessWorkOrder:WO-3400122"
}
]
}
297
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
In the following sample metadata Test document, the references field at line number 29 to line number 31 defines cross-
references to the sample document A and document B.
1 {
2 "documentTypeId": "test",
3 "documentVariantId": "default",
4 "ledgerKey": "Shipping:Test doc",
5 "documentNumber": "Test doc",
6 "originalDocumentRef": {
7 "location": {
8 "bucket": "requests_xyz_test",
9 "object": "6_8_46072df1-f9d2-4a87-a00f-bc9d52060358/document"
10 },
11 "documentHash":
"f3ef1009f7dbc45ee9b40d446b3290d85b299735477a0cc753125196ea26ba3c25c15d232972fc3a60973c22ce4372d10f2a81e9b86aad35e9
12 },
13 "requestBodyRef": {
14 "location": {
15 "bucket": "requests_xyz_test",
16 "object": "6_8_46072df1-f9d2-4a87-a00f-bc9d52060358/document"
17 },
18 "documentHash":
"f3ef1009f7dbc45ee9b40d446b3290d85b299735477a0cc753125196ea26ba3c25c15d232972fc3a60973c22ce4372d10f2a81e9b86aad35e9
19 },
20 "attachmentsRefs": [],
21 "receivedTimestamp": 1682579505251,
22 "documentTimestamp": 1682579505251,
23 "submitter": {
24 "tradingPartnerId": "xyz_test"
25 },
26 "receiver": {
27 "tradingPartnerId": "xyz_test"
28 },
29 "references": [
30 "A",
31 "B"
32 ],
33 "transactionValue": {
34 "currencyCode": "USD",
35 "amount": 0
36 },
37 "documentData": {}
38}
In the following sample metadata, document B defines a cross-reference to sample document C and also creates a
recursive cross-reference back to itself as shown line number 30.
1 {
2 "documentTypeId": "test",
298
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
3 "documentVariantId": "default",
4 "ledgerKey": "Shipping:Test doc B",
5 "documentNumber": "Test doc B",
6 "originalDocumentRef": {
7 "location": {
8 "bucket": "requests_xyz_test",
9 "object": "6_8_cd9e9d30-d440-4471-8fbf-13c47064c40a/document"
10 },
11 "documentHash":
"afd9c9a32c16c87decf1ab39393fa0353021c48576c18c5285be5215092ff9c43c2ff02818fa822344913cf8b71b80e74fcfc1db4e47652ca0
12 },
13 "requestBodyRef": {
14 "location": {
15 "bucket": "requests_xyz_test",
16 "object": "6_8_cd9e9d30-d440-4471-8fbf-13c47064c40a/document"
17 },
18 "documentHash":
"afd9c9a32c16c87decf1ab39393fa0353021c48576c18c5285be5215092ff9c43c2ff02818fa822344913cf8b71b80e74fcfc1db4e47652ca0
19 },
20 "attachmentsRefs": [],
21 "receivedTimestamp": 1682579594052,
22 "documentTimestamp": 1682579594052,
23 "submitter": {
24 "tradingPartnerId": "xyz_test"
25 },
26 "receiver": {
27 "tradingPartnerId": "xyz_test"
28 },
29 "references": [
30 "B",
31 "C"
32 ],
33 "transactionValue": {
34 "currencyCode": "USD",
35 "amount": 0
36 },
37 "documentData": {}
38}
For large number of documents ingested into Oracle Intelligent Track and Trace, bi-directional correlations adds higher
complexity due to recursive correlations. For better flexibility, you can now add unidirectional cross-references that
enables you to define one-way correlations between transaction documents.
• referenceKeys: An array of strings that contains the reference keys that other documents can use to reference
the document.
299
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
• documentCrossRefs: The documentCrossRefs object definition uses the following two modes:
◦ ledgerKey: The primary key of the document to be referenced.
◦ referenceKey: Reference Key defined in another document to reference.
In this sample metadata document, line number 8 shows the documentCrossRef object definition having referenceKey
field to create unidirectional reference.
1 {{#metadataDocument}}
2 {{md:documentNumber document.InvoiceNumber}}
3 {{md:ledgerKey (concat "invoice:" document.InvoiceNumber)}}
4 {{md:documentTimestamp (toTimestamp (concat document.InvoiceDate "T00:00:00Z"))}}
5 {{md:transactionValue currencyCode=document.CurrencyCode amount=document.Amount}}
6 {{md:receiver document.Customer by="name"}}
7 {{md:documentData "Customer" document.Customer}}
8 {{md:documentCrossRef referenceKey = (concat "LOTNUMBER:" lot.LotNumber)}}
9
10 ...
11{{/metadataDocument}}
In this sample metadata document, line number 5 shows the referenceKey definition that other documents can use to
reference this document.
## Document to be referenced from another document
1 {{#metadataDocument}}
2 {{md:documentNumber (concat "QA-" document.Id)}}
3 {{md:ledgerKey (concat "QA-" document.Id )}}
4 {{!-- Reference Keys --}}
5 {{md:documentCrossRef referenceKey = (concat "woodmove:" document.Centro ":" (split document.DataFimLote
delimiter="T" index=0))}}
6 {{md:referenceKey (concat "LOTNUMBER:" LotNumber)}}
7 ...
8{{/metadataDocument}}
Note: The existing references field will be only be available in the older metadata documents and cannot be migrated
to the latest metadata template using unidirectional references.All bi-directional references using the references
field will be removed and replaced by the unidirectional references that are defined using the referencesKeys and
documentCrossRef fields.
Usage Examples
For practical understanding and implementation of unidirectional correlations, let us consider transaction document QA
and transaction document CI as two sample documents in a same business flow.
1. In the sample metadata of the QA document, line number 35 shows the reference key definition of a sample
document QA-020. This reference key is used by the CI document to create unidirectional cross-reference.
1 {
2 "documentTypeId": "QA",
3 "documentVariantId": "default",
4 "ledgerKey": "QA-120457611717-v1",
5 "documentNumber": "QA-120457611717",
6 "originalDocumentRef": {
300
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
7 "location": {
8 "bucket": "requests_test01",
9 "object": "61_63_bed15e8a-061b-4231-8feb-d9b72208e3c5/document"
10 },
11 "documentHash":
"3183f0382ede82b0b64d44202d5501ea692f8f208aded107adaa7ea764824f33b4a35f82a4d308a4c65b16d5dbd4d0f2ec904672bfb457a
12 },
13 "requestBodyRef": {
14 "location": {
15 "bucket": "requests_test01",
16 "object": "61_63_bed15e8a-061b-4231-8feb-d9b72208e3c5/document"
17 },
18 "documentHash":
"3183f0382ede82b0b64d44202d5501ea692f8f208aded107adaa7ea764824f33b4a35f82a4d308a4c65b16d5dbd4d0f2ec904672bfb457a
19 },
20 "attachmentsRefs": [],
21 "receivedTimestamp": 1684256302360,
22 "documentTimestamp": 1656719643000,
23 "submitter": {
24 "tradingPartnerId": "test01"
25 },
26 "receiver": {
27 "tradingPartnerId": "test01"
28 },
29 "documentCrossRefs": [
30 {
31 "referenceKey": "WM-011"
32 }
33 ],
34 {{!-- Reference Keys --}}
35 "referenceKeys": [
36 "QA-020"
37 ],
38
39 ...
40
41 }
42}
2. In this sample metadata of the CI document, line number 29 to line number 39 shows a unidirectional
references defined for documents QA-001, QA-020, and QA-032.
301
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
20 "attachmentsRefs": [],
21 "receivedTimestamp": 1684256587845,
22 "documentTimestamp": 1656979200000,
23 "submitter": {
24 "tradingPartnerId": "test01"
25 },
26 "receiver": {
27 "tradingPartnerId": "25"
28 },
29 "documentCrossRefs": [
30 {
31 "referenceKey": "QA-001"
32 },
33 {
34 "referenceKey": "QA-020"
35 },
36 {
37 "referenceKey": "QA-032"
38 }
39
40 ],
41
42 ...
43
44 }
45}
In this case, the cross-reference defined in line number 34 forms a direct reference to the sample document QA-020.
Various combinations of helper functions are used based on the value of the qualifier used in the parent helper
function.
302
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
{{#md:referencedItem:unassignedControlled}}
{{md:itemTypeId “”}}
{{/md:referencedItem:unassignedControlled}}
{{#md:referencedItem:serialControlled}}
{{md:itemTypeId “”}}
{{md:serialNumber “”}}
{{/md:referencedItem:serialControlled}}
{{#md:referencedItem:lotControlled}}
{{md:itemTypeId “”}}
{{md:lotNumber “”}}
{{#md:quantity}}
{{md:unitCode “”}}
{{md:value 0}}
{{/md:quantity}}
{{/md:referencedItem:lotControlled}}
{{md:comments “”}}
{{/md:itemTrackingData:serialControlled}}
303
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
304
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
{{md:value 0}}
{{/md:quantity}}
{{/md:referencedItem:lotControlled}}
{{#md:referencedItem:batchControlled}}
{{md:itemTypeId “”}}
{{md:batchNumber “”}}
{{/md:referencedItem:batchControlled}}
{{#md:referencedItem:packageControlled}}
{{md:packageTypeId “”}}
{{md:packageNumber “”}}
{{/md:referencedItem:packageControlled}}
{{#md:currentCustody}}
{{md:custodyChangeReason “”}}
{{#md:tradingPartner}}
{{md:tradingPartnerId “”}}
{{/md:tradingPartner}}
{{#md:tradingPartner}}
{{md:tradingPartnerName “”}}
{{/md:tradingPartner}}
{{#md:location}}
{{md:locationId “”}}
{{/md:location}}
{{#md:location}}
{{md:locationAddress “”}}
{{/md:location}}
{{/md:currentCustody}}
{{/md:packageTrackingData}}
Metadata schema is a set of user-defined attributes that extend the system-defined normalized data. The normalized
data is generated from the source document by applying the metadata template. If the metadata template declares any
documentData attributes, then these attributes and their type must be defined in the Metadata Schema.
Note: Currently Oracle Intelligent Track and Trace supports only the following data types for the attributes in the
Metadata Schema—string, integer, and object. Arrays are not currently supported.
Once you have defined the metadata schema, you can upload it to Oracle Intelligent Track and Trace by following the
instructions provided in Create a New Document Type.
Usage Example:
This example shows the definition of all the documentData attributes defined for document type QA Inspection.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://itt-ns.oracle.com/qa-inspection-md",
"type": "object""properties": {
"InspectionType": {
"type": "string"
},
"SamplingQty": {
"type": "number"
},
"QtyInspected": {
305
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"type": "number"
},
"QtyReject": {
"type": "number"
},
"InspectionDate": {
"type": "string",
"format": "date-time"
}
}
}
Oracle Intelligent Track and Trace enables this simulation functionality by providing you a mechanism to define a
simulator template for each document type in your business flow. In a simulator template, you specify a list of values for
the JSON schema attributes, using which the application generates mock documents. You can specify values for all the
JSON schema attributes, or can choose a few important ones which are essential for metadata template and schema
generation.
To facilitate the generation of mock data, Oracle Intelligent Track and Trace provides a list of attribute types which you
can use to assign random values to the JSON attributes in the simulator template.
Note: All the parameters specified in the column Type Definition/Syntax are mandatory unless specified explicitly.
Constant {
"type" : "CONSTANT", "#/properties/OrderHeader/properties/
"name" : "<propery name"> , ProcurementBusinessUnit" :
"label" : "<string>", {
"value" : "<string>" "type" : "CONSTANT",
} "name" : "#/properties/OrderHeader/
properties/ProcurementBusinessUnit",
"label" : "Creator_Org",
"value" : "Alpha Chemicals"
}
To support "CONSTANT_DATE",
specify "values" : "<YYYY-MM-
DD>T<HH:MM:SS>. For example:
"values":2018-06-20T21:42:02.0Z
306
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
307
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
308
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
Usage Example
This is an example of the simulator template for document type QA Inspection:
{
"attributes": [
{
"field": "#/properties/IpEventId",
"label": "IpEventId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/weightInKilograms" : {
"label": "weightInKilograms",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 72,
"highLimit": 80.5,
"decimals": 3
}
},
{
"field": "#/properties/EventType",
"label": "EventType",
"modelDefault": {
"type": "RANDOM_FROM_LIST",
"values": [
"MANUFACTURING",
"RECEIVING",
"STANDALONE"
]
}
},
{
"field": "#/properties/InspectionPlanId",
"label": "InspectionPlanId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/InspectionLevelId",
"label": "InspectionLevelId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
309
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"highLimit": 100000
}
},
{
"field": "#/properties/IpCriteriaId",
"label": "IpCriteriaId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/SourceLineQty",
"label": "SourceLineQty",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/UomCode",
"label": "UomCode",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/QtyRequested",
"label": "QtyRequested",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/SamplingQty",
"label": "SamplingQty",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/QtyInspected",
"label": "QtyInspected",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/QtyAccepted",
"label": "QtyAccepted",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
310
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"highLimit": 100000
}
},
{
"field": "#/properties/QtyRejected",
"label": "QtyRejected",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/OriginalDisposition",
"label": "OriginalDisposition",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/InspectionStatus",
"label": "InspectionStatus",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/InlineFlag",
"label": "InlineFlag",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/DraftFlag",
"label": "DraftFlag",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/InspectedBy",
"label": "InspectedBy",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
311
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/InspectionDate",
"label": "InspectionDate",
"modelDefault": {
"type": "RANDOM_DATE",
"value": "PAST"
}
},
{
"field": "#/properties/DispositionDate",
"label": "DispositionDate",
"modelDefault": {
"type": "RANDOM_DATE",
"value": "PAST"
}
},
{
"field": "#/properties/InventoryItemId",
"label": "InventoryItemId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/OrganizationId",
"label": "OrganizationId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/RevisionId",
"label": "RevisionId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/ItemRevision",
"label": "ItemRevision",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/CategorySetId",
"label": "CategorySetId",
"modelDefault": {
"type": "RANDOM_NUMBER",
312
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/CategoryId",
"label": "CategoryId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/WorkOrderId",
"label": "WorkOrderId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/WoOperationId",
"label": "WoOperationId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/OperationSeqNumber",
"label": "OperationSeqNumber",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/DispatchStatus",
"label": "DispatchStatus",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/WorkCenterId",
"label": "WorkCenterId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/WorkAreaId",
"label": "WorkAreaId",
"modelDefault": {
"type": "RANDOM_NUMBER",
313
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/ResourceId",
"label": "ResourceId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/SubinventoryCode",
"label": "SubinventoryCode",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/LocatorId",
"label": "LocatorId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/LotNumber",
"label": "LotNumber",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/TransactionType",
"label": "TransactionType",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/SourceOrgId",
"label": "SourceOrgId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
314
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
},
{
"field": "#/properties/SupplierId",
"label": "SupplierId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/SupplierSiteId",
"label": "SupplierSiteId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/CustomerId",
"label": "CustomerId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/DocType",
"label": "DocType",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/DocNumber",
"label": "DocNumber",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/DocLineNumber",
"label": "DocLineNumber",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/DocScheduleNumber",
"label": "DocScheduleNumber",
"modelDefault": {
"type": "RANDOM_STRING",
315
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/ReceiptNum",
"label": "ReceiptNum",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/ShipmentHeaderId",
"label": "ShipmentHeaderId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/ShipmentLineId",
"label": "ShipmentLineId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/SupplierLotNum",
"label": "SupplierLotNum",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/InterfaceTransactionId",
"label": "InterfaceTransactionId",
"modelDefault": {
"type": "RANDOM_NUMBER",
"lowLimit": 10,
"highLimit": 100000
}
},
{
"field": "#/properties/CreatedBy",
"label": "CreatedBy",
"modelDefault": {
"type": "RANDOM_STRING",
"minLength": 10,
"maxLength": 20,
"numeric": false,
316
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
"prefix": null,
"suffix": null
}
},
{
"field": "#/properties/CreationDate",
"label": "CreationDate",
"modelDefault": {
"type": "RANDOM_DATE",
"value": "PAST"
}
}
],
"fixedValues": []
}
A presentation template defines the rich text view structure of the document using HTML tags. This template is then
applied to every incoming document to generate a rich text view as defined in the HTML structure.
All the preseeded document types have a predefined presentation template. For any new document types, you should
provide a presentation template definition to generate a rich text view of the source document.
To define a presentation template, you must have a basic understanding of HyperText Markup Language (HTML) and
how to construct a basic HTML document using supported elements and attributes.
Note: When you define a presentation template you must only use the HTML elements and attributes listed the
following table.
Tag Description
Block Elements
317
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
Tag Description
Inline Elements
<a> Defines a hyperlink in a text or image format to link one page to another
Formatting Elements
<u> Defines text that should be stylistically different from normal text
Table Elements
318
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
Tag Description
<col> Specifies column properties for each column within a <colgroup> element
Flex layout Provides complete control over the alignment, direction, order, and size of content.
Alongside the HTML tags, you can also use helper functions About Handlebar Helpers to define the presentation
template.
Once the presentation template is defined, you can upload it to Intelligent Track and Trace by following the instructions
provided in Create a New Document Type.
Usage Example
The following is a sample presentation template for a pre-seeded document type PO ACK. If you define a presentation
template for your custom document types, you can refer to the presentation templates of any of the pre-seeded
documents.
<!DOCTYPE html>
{{#*inline "bodyStyle"}}
background-color: rgba(255, 255, 255, 0.877);
padding: 5px;
{{/inline}}
{{#*inline "tdStyle"}}
color: rgb(61,53,177);
font-size: 12px;
font-weight: bold;
padding-left: 10px;
{{/inline}}
{{#*inline "thStyle"}}
color: rgb(8, 8, 8);
background-color: rgb(199, 199, 199);
text-align: left;
padding: 10px;
{{/inline}}
{{#*inline "numberValueStyle"}}
padding-right: 10px;
{{/inline}}
{{#*inline "valueStyle"}}
color: rgb(61,53,177);
font-size: 12px;
font-weight: bold;
319
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
padding-left: 5px;
font-family: monospace;
{{/inline}}
{{#*inline "labelStyle"}}
color: rgb(6, 2, 17);
font-size: 14px;
padding: 5px;
{{/inline}}
320
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
</div>
321
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
<div style="flex: 0 0 200px; border-top: 1px solid rgb(5, 2, 44); border-left: 1px solid rgb(5, 2, 44);
justify-content:center;">
<div style="display: flex; align-content: space-between;">
<div style="{{>labelStyle}}flex: 1 0 50px; align-self: center;">Total</div>
<div style="{{>valueStyle}}flex: 1 0 auto; text-align: right; margin-right: 10px; align-self:
center;">{{{document.result.ordered}}}</div>
</div>
<div style="display: flex;{{>valueStyle}}"></div>
</div>
</div>
</div>
</div>
</div>
The rich text view of the transaction source document supports easy navigation to various data elements, such as
serial-controlled, lot-controlled, or unassigned items, packages, and any other document associated to the business
flow.
itemUrl Has two parameters with a value. Navigate to any specific item type Yes
lotNumber/serialNumber (lot-controlled or serial-controlled).
itemTypeUrl Has two parameters with a value. Navigate to any specific item type. Yes
itemTypeCode, tpId
packageUrl Has three parameters with a value. Navigate to a specific package. Yes
packageType,
packageNumber, tpId
Note: If the item type code is not found in the submitter trading partner's list, the whenMissing attribute enables
to reference the item type code of the founder's list.For example: {{itemTypeUrl ItemTypeCode=shipmentLine.Item
(lookupSubmitter)) whenMissing='ignore' {{itemTypeUrl ItemTypeCode=shipmentLine.ItemNumber
tpId=(lookupFounder)}}
Usage Example
In the following sample, line numbers 155 to 158 shows the helper functions used to generate the hyperlinks to the
items, packages, and document for a custom document type Outbound Shipment.
1 {{#*inline "bodyStyle"}}
2 background-color: rgba(255, 255, 255, 0.877);
3 padding: 5px;
4 {{/inline}}
322
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
5
6 {{#*inline "tdStyle"}}
7 color: rgb(65,61,61);
8 font-size: 12px;
9 font-weight: bold;
10 padding-left: 10px;
11 {{/inline}}
12
13 {{#*inline "thStyle"}}
14 color: rgb(8, 8, 8);
15 background-color: rgb(199, 199, 199);
16 text-align: left;
17 padding: 10px;
18 {{/inline}}
19
20 {{#*inline "numberValueStyle"}}
21 padding-right: 10px;
22 {{/inline}}
23
24 {{#*inline "valueStyle"}}
25 color: rgb(44,43,43);
26 font-size: 12px;
27 font-weight: bold;
28 padding-left: 5px;
29 font-family: monospace;
30 {{/inline}}
31
32 {{#*inline "labelStyle"}}
33 color: rgb(6, 2, 17);
34 font-size: 14px;
35 padding: 5px;
36 {{/inline}}
37
38
39
40 <!-- Main container -->
41 <div style="{{>bodyStyle}}">
42 <!-- Outermost container -->
43 <div style="display: flex; flex-direction: column;">
44 <!-- Titles container -->
45 <div style="display: flex; flex-direction: row;">
46 <div style="flex-grow: 3;"><span style="color: red; font-size: 20px;">Oracle</span></div>
47 <div style="flex-grow: 1; text-align: right;">
48 <span style="color: rgb(43, 43, 46); font-size: 24px">Outbound Shipment</span>
49 </div>
50 </div>
51
52 <div style="display: flex; flex-direction: row; justify-content: space-between; margin-top: 10px;">
53 <!-- Ship To -->
54 <div style="display: flex; flex-direction: row; justify-content: right;">
55 <div
56 style="min-height: 200px; border: 1px solid; border-radius: 10px; border-color:rgb(5, 2, 44); justify-
content:center; width: 400px;"
57 >
58 <div style="display: flex;">
59 <div style="flex: 0 0 200px; {{>labelStyle}}">Shipment Number</div>
60 <div style="flex: 0 0 200px; {{>valueStyle}}">{{{document.Shipment}}}</div>
61 </div>
62 <div style="display: flex;">
63 <div style="flex: 0 0 200px; {{>labelStyle}}">Ship by</div>
64 <div style="flex: 0 0 200px; {{>valueStyle}}">{{{document.LatestPickupDate}}}</div>
65 </div>
66 <div style="display: flex;">
67 <div style="flex: 0 0 200px; {{>labelStyle}}">Shipping Type</div>
68 <div style="flex: 0 0 200px; {{>valueStyle}}">{{{document.ShippingMethod}}}</div>
69 </div>
323
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
70
71 <div style="display: flex; {{>labelStyle}}">
72 <div style="flex: 0 0 400px;">Shipped From</div>
73 </div>
74 <div style="display: flex; {{>valueStyle}}">
75 <div style="flex: 0 0 400px;">{{{document.ShipFromAddress1}}}</div>
76 </div>
77 <div style="display: flex; {{>valueStyle}}">
78 <div style="flex: 0 0 400px;">{{{document.ShipFromAddress2}}}</div>
79 </div>
80 <div style="display: flex; {{>valueStyle}}">
81 <div style="flex: 0 0 400px;">{{{document.ShipFromAddress3}}}</div>
82 </div>
83 <div style="display: flex; {{>valueStyle}}">
84 <div style="flex: 0 0 400px;">{{{document.ShipFromAddress4}}}</div>
85 </div>
86 <div style="display: flex; {{>valueStyle}}">
87 <div style="flex: 0 0 400px;">{{{document.ShipFromCity}}} {{{document.ShipFromState}}}
{{{document.ShipFromPostalCode}}}</div>
88 </div>
89 </div>
90 </div>
91
92 <!-- Document number and date -->
93 <div style="display: flex; flex-direction: row; justify-content: right;">
94 <div
95 style="border: 1px solid; border-radius: 10px; border-color:rgb(5, 2, 44); justify-content:center; width:
400px;"
96 >
97 <div style="display: flex;">
98 <div style="flex: 0 0 200px; {{>labelStyle}}">Ship Date</div>
99 <div style="flex: 0 0 200px; {{>valueStyle}}">{{{document.ActualShipDate}}}</div>
100 </div>
101 <div style="display: flex;">
102 <div style="flex: 0 0 200px; {{>labelStyle}}">Ship Mode</div>
103 <div style="flex: 0 0 200px; {{>valueStyle}}">{{{document.ModeOfTransport}}}</div>
104 </div>
105 <div style="display: flex; {{>labelStyle}}">
106 <div style="flex: 0 0 400px;">Shipped To</div>
107 </div>
108 <div style="display: flex; {{>valueStyle}}">
109 <div style="flex: 0 0 400px;">{{{document.ShipToAddress1}}}</div>
110 </div>
111 <div style="display: flex; {{>valueStyle}}">
112 <div style="flex: 0 0 400px;">{{{document.ShipToAddress2}}}</div>
113 </div>
114 <div style="display: flex; {{>valueStyle}}">
115 <div style="flex: 0 0 400px;">{{{document.ShipToAddress3}}}</div>
116 </div>
117 <div style="display: flex; {{>valueStyle}}">
118 <div style="flex: 0 0 400px;">{{{document.ShipToAddress4}}}</div>
119 </div>
120 <div style="display: flex; {{>valueStyle}}">
121 <div style="flex: 0 0 400px;">{{{document.ShipToCity}}} {{{document.ShipToState}}}
{{{document.ShipToPostalCode}}}</div>
122 </div>
123 </div>
124 </div>
125 </div>
126
127 <!-- Header Container -->
128 <div
129 style="display: flex; flex-direction:column; border: 1px solid; border-radius: 0px; border-color:rgb(5,
2, 44); min-height: 90px; margin-top: 10px;"
130 >
131
324
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
132 <!-- Items container -->
133 <div
134 style="display: flex; flex-direction:column; min-height: 90px;"
135 >
136 <table style="border-collapse: collapse;">
137 <thead>
138 <tr>
139 <th style="{{>thStyle}}">Line</th>
140 <th style="{{>thStyle}}">Order Number</th>
141 <th style="{{>thStyle}}">Item Number</th>
142 <th style="{{>thStyle}}">Item Description</th>
143 <th style="{{>thStyle}}">Lot</th>
144 <th style="{{>thStyle}}">Package</th>
145 <th style="{{>thStyle}} text-align:right; padding-right: 10px;">Shipped Quantity</th>
146 <th style="{{>thStyle}}">UOM</th>
147 </tr>
148 </thead>
149 <tbody>
150 {{#each document.outerPackingUnits as |outerPackingUnit n1|}}
151 {{#each outerPackingUnit.innerPackingUnits as |innerPackingUnit|}}
152 {{#each innerPackingUnit.shipmentLines as |shipmentLine n|}}
153 <tr>
154 <td style="{{>tdStyle}}">{{{shipmentLine.ShipmentLine}}}</td>
155 <td style="{{>tdStyle}}"><a href={{documentUrl ledgerKey=(concat "PurchaseOrder:"
shipmentLine.PONumber)}}>{{{shipmentLine.PONumber}}}</a></td>
156 <td style="{{>tdStyle}}"><a href={{itemTypeUrl itemTypeCode=shipmentLine.Item
tpId=(lookupFounder)}}>{{{shipmentLine.Item}}}</a></td>
157 <td style="{{>tdStyle}}"><a href={{itemUrl lotNumber=shipmentLine.LotNumber control="LOT"
tpId=(lookupFounder)}}>{{{shipmentLine.LotNumber}}}</a></td>
158 <td style="{{>tdStyle}}"><a href={{packageUrl packageType=innerPackingUnit.ContainerItem
packageNumber=innerPackingUnit.LicensePlateNumber
tpId=(lookupFounder)}}>{{{innerPackingUnit.LicensePlateNumber}}}</a></td>
159 <td style="{{>tdStyle}}">{{{shipmentLine.ItemDescription}}}</td>
160 <td style="text-align:right; padding-right: 10px; {{>tdStyle}}
{{>numberValueStyle}}">{{shipmentLine.ShippedQuantity}}</td>
161 <td style="{{>tdStyle}}">{{{shipmentLine.RequestedQuantityUOMCode}}}</td>
162 </tr>
163 {{/each}}
164 {{/each}}
165
166 {{/each}}
167 </tbody>
168 </table>
169 </div>
170 </div>
171</div>
Usage Example
The handlebar attributes from line 182 to line 207 in the following Purchase Order Fusion sample document are used to
retrieve the current user data.
325
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
In line 208, the conditional statement checks the current user type, such as founder or trading partner user.
40 <html>
41 <title>Purchase Order</title>
42
43 <body>
44 <!-- Main container -->
45 <div style="{{>bodyStyle}}">
46 <!-- Outermost container -->
47 <div style="display: flex; flex-direction: column;">
48 <!-- Titles container -->
49 <div style="display: flex; flex-direction: row;">
50 <div style="flex-grow: 3;"><span style="color: red; font-size: 20px;">Oracle</span></div>
51 <div style="flex-grow: 1; text-align: right;">
52 <span style="color: rgb(43, 43, 46); font-size: 24px">Purchase Order</span>
53 </div>
54 </div>
55
56 <!-- Document number and date -->
57 <div style="display: flex; flex-direction: row; justify-content: right; margin-top: 50px;">
58 <div style="flex: 1 0 auto;"></div>
59 <div
60 style="flex: 0 0 420px; border: 1px solid; border-radius: 10px; border-color:rgb(5, 2, 44); justify-
content:center;"
61 >
62 <div style="display: flex; {{> labelStyle}}">
63 <div style="flex: 0 0 200px;">Order Number</div>
64 <div style="flex: 0 0 200px;">Order Date</div>
65 </div>
66 <div style="display: flex; {{>valueStyle}}">
67 <div style="flex: 0 0 200px;">{{{document.result.poHeaderId}}}</div>
68 <div style="flex: 0 0 200px;">{{{document.result.orderDateDisplay}}}</div>
69 </div>
70 </div>
71 </div>
72
73 <!-- Vendor, Ship To -->
74 <div style="display: flex; flex-direction: row; justify-content: right; margin-top: 5px;">
75 <div style="flex: 1 0 auto;">
76 <span style="{{> labelStyle}}">Vendor</span>
77 <div style="{{>valueStyle}}">{{{document.result.supplierPartyDisplayedName}}}</div>
78 <div style="{{>valueStyle}}">{{{document.result.supplierSiteAddress1}}}</div>
79 <div style="{{>valueStyle}}">{{{document.result.supplierSiteAddress2}}}</div>
80 <div style="{{>valueStyle}}">{{{document.result.supplierSiteCity}}}</div>
81 <div style="{{>valueStyle}}">{{{document.result.supplierSiteState}}}
{{{document.result.supplierSitePostalCode}}}</div>
82 <div style="{{>valueStyle}}">{{{document.result.supplierSiteCountry}}}</div>
83 </div>
84 <div
85 style="flex: 0 0 420px; min-height: 100px; border: 1px solid; border-radius: 10px; border-color:rgb(5, 2,
44); justify-content:center;"
86 >
87 <div style="display: flex; {{> labelStyle}}">
88 <div style="flex: 0 0 400px;">Ship To</div>
89 </div>
90 <div style="display: flex; {{>valueStyle}}">
91 <div style="flex: 0 0 400px;">{{{document.result.shipToLocationName}}}</div>
92 </div>
93 <div style="display: flex; {{>valueStyle}}">
94 <div style="flex: 0 0 400px;">{{{document.result.soldToLeAddressLine1}}}</div>
95 </div>
96 <div style="display: flex; {{>valueStyle}}">
97 <div style="flex: 0 0 400px;">{{{document.result.soldToLeTownOrCity}}}
{{{document.result.soldToLeStateProvn}}} {{{document.result.soldToLePostalCode}}}</div>
326
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
98 </div>
99 </div>
100 </div>
101
102 <!-- Bill To -->
103 <div style="display: flex; flex-direction: row; justify-content: right; margin-top: 5px;">
104 <div style="flex: 1 0 auto;"></div>
105 <div
106 style="flex: 0 0 420px; min-height: 100px; border: 1px solid; border-radius: 10px; border-color:rgb(5,
2, 44); justify-content:center;"
107 >
108 <div style="display: flex; {{> labelStyle}}" ;>
109 <div style="flex: 0 0 400px;">Bill To</div></div>
110 <div style="display: flex;{{>valueStyle}}" ;>
111 <div style="flex: 0 0 400px;">{{{document.result.billToBuName}}}</div>
112 </div>
113 <div style="display: flex; {{>valueStyle}}">
114 <div style="flex: 0 0 400px;">{{{document.result.billToLocAddressLine1}}}</div>
115 </div>
116 <div style="display: flex; {{>valueStyle}}">
117 <div style="flex: 0 0 400px;">{{{document.result.billToLocTownOrCity}}}
{{{document.result.billToLocStateProvn}}} {{{document.result.billToLocPostalCode}}}</div>
118 </div>
119 </div>
120 </div>
121
122 <!-- Header Container -->
123 <div
124 style="display: flex; flex-direction:column; border: 1px solid; border-radius: 10px; border-color:rgb(5,
2, 44); min-height: 90px; margin-top: 5px;"
125 >
126 <!-- First row -->
127 <div style="display: flex; flex-direction: row; min-height: 30px;">
128 <div
129 style="flex-direction: column; border-bottom: 1px solid; border-right: 1px solid; border-color:rgb(5, 2,
44); flex: 1 0 200px;"
130 >
131 <div style="flex: 1 0 auto;"><span style="{{> labelStyle}}">Procurement BusinessUnit</span></div>
132 <div style="flex: 1 0 auto;"><span style="{{>valueStyle}}">{{{document.result.procurementBuName}}}</
span></div>
133 </div>
134 <div
135 style="flex-direction: column; border-bottom: 1px solid; border-right: 1px solid; border-color:rgb(5, 2,
44); flex: 1 0 200px;"
136 >
137 <div style="flex: 1 0 auto;"><span style="{{> labelStyle}}">BusinessUnit</span></div>
138 <div style="flex: 1 0 auto;"><span style="{{>valueStyle}}">{{{document.result.billToBuName}}}</span></
div>
139 </div>
140 <div style="flex-direction: column; border-bottom: 1px solid; border-color:rgb(5, 2, 44); flex: 1 0
200px;">
141 <div style="flex: 1 0 auto;"><span style="{{> labelStyle}}">Order Type</span></div>
142 <div style="flex: 1 0 auto;"><span style="{{>valueStyle}}">{{{document.result.typeLookupCode}}}</span></
div>
143 </div>
144 </div>
145 <!-- second row -->
146 <div style="display: flex; flex-direction: row; min-height: 30px;">
147 <div
148 style="flex-direction: column; border-right: 1px solid; border-bottom: 1px solid; border-color:rgb(5, 2,
44); flex: 1 0 200px;"
149 >
150 <div style="flex: 1 0 auto;"><span style="{{> labelStyle}}">FOB</span></div>
151 <div style="flex: 1 0 auto;"><span style="{{>valueStyle}}">{{{document.result.fobDescription}}}</span></
div>
152 </div>
327
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
153 <div
154 style="flex-direction: column; border-bottom: 1px solid; border-right: 1px solid; border-color:rgb(5, 2,
44); flex: 1 0 200px;"
155 >
156 <div style="flex: 1 0 auto;"><span style="{{> labelStyle}}">Freight Terms</span></div>
157 <div style="flex: 1 0 auto;"><span
style="{{>valueStyle}}">{{{document.result.freightTermsDescription}}}</span></div>
158 </div>
159 <div style="flex-direction: column; border-bottom: 1px solid; border-color:rgb(5, 2, 44); flex: 1 0
200px;">
160 <div style="flex: 1 0 auto;"><span style="{{> labelStyle}}">Carrier</span></div>
161 <div style="flex: 1 0 auto;"><span
style="{{>valueStyle}}">{{{document.result.carrierPartyDisplayedName}}}</span></div>
162 </div>
163 </div>
164 <!-- third row -->
165 <div style="display: flex; flex-direction: row; min-height: 30px;">
166 <div style="flex-direction: column; border-right: 1px solid; border-color:rgb(5, 2, 44); flex: 1 0
200px;">
167 <div style="flex: 1 0 auto;"><span style="{{> labelStyle}}">Payment Terms</span></div>
168 <div style="flex: 1 0 auto;"><span
style="{{>valueStyle}}">{{{document.result.paymentTermsDescription}}}</span></div>
169 </div>
170
171 <div style="flex-direction: column; border-right: 1px solid; border-color:rgb(5, 2, 44); flex: 1 0
200px;">
172 <div style="flex: 1 0 auto;"><span style="{{> labelStyle}}">Reference #</span></div>
173 <div style="flex: 1 0 auto;"><span style="{{>valueStyle}}">{{{document.result.referenceNum}}}</span></
div>
174 </div>
175
176 <div style="flex-direction: column; flex: 1 0 200px;">
177 <div style="flex: 1 0 auto;"><span style="{{> labelStyle}}">Currency</span></div>
178 <div style="flex: 1 0 auto;"><span style="{{>valueStyle}}">{{{document.result.currencyName}}}</span></
div>
179 </div>
180 </div>
181 </div>
182 <div
183 style="display: flex; flex-direction:column; border: 1px solid; border-radius: 10px; border-color:rgb(5,
2, 44); min-height: 90px; margin-top: 5px;"
184 >
185 <table>
186 <thead>
187 <tr>
188 <th style="{{>thStyle}}">User Property</th>
189 <th style="{{>thStyle}}">Value</th>
190 </tr>
191 </thead>
192 <tbody>
193 <tr>
194 <td style="{{>tdStyle}}">user.name</td>
195 <td style="{{>tdStyle}}">{{user.name}}</td>
196 </tr>
197 <tr>
198 <td style="{{>tdStyle}}">user.tradingPartner.name</td>
199 <td style="{{>tdStyle}}">{{user.tradingPartner.name}}</td>
200 </tr>
201 <tr>
202 <td style="{{>tdStyle}}">user.tradingPartner.type</td>
203 <td style="{{>tdStyle}}">{{user.tradingPartner.type}}</td>
204 </tr>
205 </tbody>
206 </table>
207 </div>
208{{#if (eq user.tradingPartner.type "FOUNDER")}}
328
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
209 <!-- Items container -->
210 <div
211 style="display: flex; flex-direction:column; border: 1px solid; border-radius: 10px; border-color:rgb(5,
2, 44); min-height: 90px; margin-top: 5px;"
212 >
213 <table>
214 <thead>
215 <tr>
216 <th style="{{>thStyle}}">Item</th>
217 <th style="{{>thStyle}}">Description</th>
218 <th style="{{>thStyle}} {{> numberValueStyle}}">Quantity</th>
219 <th style="{{>thStyle}}">Unit</th>
220 <th style="{{>thStyle}} {{> numberValueStyle}}">Price</th>
221 </tr>
222 </thead>
223 <tbody>
224 {{#each document.result.pdfDraftPurchaseOrderLine as |item n|}}
225 <tr>
226 <td style="{{>tdStyle}}">{{{item.itemNumber}}}</td>
227 <td style="{{>tdStyle}}">{{{item.itemDescription}}}</td>
228 <td style="{{>tdStyle}} {{>numberValueStyle}}">{{{item.quantity}}}</td>
229 <td style="{{>tdStyle}}">{{{item.uomCode}}}</td>
230 <td style="{{>tdStyle}} {{>numberValueStyle}}">{{{item.unitPrice}}}</td>
231 </tr>
232 {{/each}}
233 </tbody>
234 </table>
235 </div>
236{{/if}}
237 <!-- Total line -->
238 <div style="display: flex; flex-direction: row; justify-content: right; margin-top: 5px;">
239 <div style="flex: 1 0 auto;"></div>
240 <div
241 style="flex: 0 0 200px; border: 1px solid; border-radius: 10px; border-color:rgb(5, 2, 44); justify-
content:center;"
242 >
243 <div style="display: flex; align-content:space-between;">
244 <div style="{{> labelStyle}}flex: 1 0 50px; align-self: center;">Total</div>
245 <div style="{{>valueStyle}}flex: 1 0 auto; text-align: right; margin-right: 10px; align-self:
center;">{{{document.result.ordered}}}</div>
246 </div>
247 <div style="display: flex;{{>valueStyle}}">
248
249 </div>
250 </div>
251 </div>
252 </div>
253
254 </div>
255 </body>
256</html>
In the following image, the user.tradingPartner.type attribute value is FOUNDER , so all the transaction attributes are
viewable to the founder user.
329
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
In following image, the user.tradingPartner.type attribute value is ENDORSER, so no transaction attributes are available
for viewing for the endorser.
330
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
331
Oracle Cloud Chapter 6
Using Oracle Intelligent Track and Trace Define Document Schemas, Mappings and Simulator
Templates
332