Jump to content

  • Track and Trace Accelerator Getting Started

     Share

    Pre-Requisites

    This Accelerator is fully TIBCO Cloud native, so you will require access to a TIBCO Cloud account with the following subscriptions enabled.

    • TIBCO Cloud Data Streams (with either User or Administrator privileges)
    • TIBCO Cloud Events
    • TIBCO Cloud Integration
    • TIBCO Cloud Messaging
    • TIBCO Cloud Spotfire®

    At the moment only installations in the EU or US regions are supported. All subscriptions must be enabled in the same region.

    Data Streams Notes

    1. You must have either User or Administrator privileges for your Data Streams subscription in order to be able to create streams. If you do not have these privileges then the automated provisioning will fail.
    2. Most Data Streams subscriptions have a limit to the number of simultaneous running streams. For example, 5 streams is a common configuration. if you have running streams in your subscription, ensure you have at least 2 available streams to start for the Accelerator. If there are not 2 available streams then the automated provisioning will fail.

    Download Accelerator Distribution

    The Accelerator is distributed as two packages:

    • Distribution -- distribution for building the application
    • Source -- to view and make changes to the source

    Download the distribution package to your local machine and extract the ZIP into a temporary directory.

    1.png.8372db3f2878992a5bbe4fcf1487bd1a.png

    Once extracted you will have a directory called TrackTrace containing two files, manifest.json and track-webapp.zip. 

    Deploy Accelerator Webapp

    To deploy the Accelerator webapp you will need to login to your TIBCO Cloud Integration account. Click here for EU region and here for US region. You may be prompted to login using your TIBCO Cloud credentials.

    Click the Create/Import button, and then choose a Node.js application under the Develop section.

    2.thumb.png.3f9801015c6d39f91a347b2b0dbf7d59.png

    Click the Next button. Drag and drop both the manifest.json and track-webapp.zip into the displayed dialog, then click Import App. The Creating a new application.. message will display for some time while the app is created.

    Once the app is successfully created, the following page will be displayed.

    3.thumb.png.9e4087979a963b0134e13edd42343862.png

    By default the app will be created with a name like New_Node_App_0. It is recommended to rename this to TrackTraceWebapp by clicking the name and entering the new value.

    To start the app, hover over the 0 next to Instances and click the up arrow to increment the value to 1. Then click the Scale button. The status will go to Scaling and it will take some time for the app to start.

    If all goes well the status will eventually go to Running. At this point the application is ready to be accessed. If the app doesn't start, review the logs for error messages. If this still doesn't help then please open a Support request.

    Login to Accelerator

    To get the URL to connect to the web UI, click the Copy URL button in the middle of the application page to copy the value to the clipboard. 

    Paste this into a new browser tab or window and append /app/tracking/index.html at the end of it. For example:

    • eu-west-1.integration.cloud.tibcoapps.com/abc123/app/tracking/index.html

    It is recommended to bookmark this page.

    The browser will display the Login page for the Accelerator.

    4.thumb.png.044ccacd2baf83b160c6a36e68342c22.png

    The credentials to login is an OAuth token generated from your TIBCO Cloud account. Click here for EU region and here for US region to display the tokens page. Click the Generate Token button and given the token a name. Select a validity period. Beware that once the token expires you will need to generate another one in order to access the Accelerator. You must select the following domains:

    • Connected Intelligence Cloud
    • Spotfire®
    • Data Streams
    • Events
    • Integration
    • Messaging

    5.png.918e45a2e7aaaf8686942e3c6273d698.png

    Click the Generate button to generate the token. Note the confirmation dialog and then click the Copy to clipboard button to copy the token value.

    6.png.1e6de7fbd7f548330e5b1a6299e99a7b.png

    Back on the Accelerator Login page paste the token value in the OAuth Token box and select the correct Region where your subscriptions are provisioned, then click Login.

    If the credentials are valid then the Welcome page will be displayed. Both the OAuth token and Region will be stored in your browser local storage so will be saved for the next login. If you are using an incognito window or clear the browser cache the values will be lost, so it is worthwhile making a note of your OAuth token for future use.

    Generate Messaging Key

    TIBCO Cloud Messaging comes preconfigured with a default authentication key, so this step is optional. If you would like to make a specific key for the Accelerator click here for EU region and here for US region. Enter a value for Label and click the Create key button. You do not need to note the key details as you will choose this later using a drop down.

    Configure Accelerator

    The Welcome Page will be displayed on first load of the Accelerator and will walk you through the process of finalizing the provisioning of components.

    The first page will present some application options, adjust these as required.

    • Hide Welcome page -- tick this box to hide the Welcome page on next login
    • Restrict UI -- select the desired option for restricting access to the user interface. Note that your group will be different than the group Accelerators show in the screenshot.

    Click the Save button to save any changes, and Skip to move to the next page without saving.

    7.thumb.png.ef111ca2e4d1425aa251d48024740612.png

    The next page will present some TIBCO Cloud Messaging options. The OAuth Token will be preconfigured based on the one used to login. Select a TIBCO Cloud Messaging Channel from the drop down. This channel will be used for all Accelerator component communications. All your configured channels will be displayed, choose the desired option, if in doubt, select default. Click the Save button.

    8.thumb.png.52f834c5f8013cfc535bc2d62abbba78.png

    The next page presents component provisioning options. The TIBCO Cloud Messaging Channel will be displayed, as well as the OAuth Token used during login. You have the option of which components to provision. Select both TIBCO Cloud Events and TIBCO Cloud Data Streams. When you select TIBCO Cloud Events an additional drop down is presented with a list of TIBCO Cloud Events Sandboxes. Select a sandbox to deploy your application into. If in doubt, select the My Default Sandbox option. Once everything is configured, click the Provision button. It will take some time for the provisioning to complete.

    9.thumb.png.fa4fa1f1a9b87ed127e4d09a951cb2bb.png

    Once the provisioning has completed you can verify the TIBCO Cloud Events application has been deployed by clicking here for EU region and here for US region and check that you have a track-eventmanager application and it is either Scaling or Running. Likewise you can verify TIBCO Cloud Data Streams by clicking here for EU region and here for US region. You should have two streams called Track_Parcel and Track_Route. It will take several minutes for these to start so they may be in Building and Starting status for some time.

    When everything has started correctly, back in the Welcome page you can click the Next button to continue.

    The next page will display Spotfire® configuration options. Unfortunately it is not possible to automatically provision a Spotfire® DXP, so this will have to be done manually. The OAuth Token will be preconfigured based on the one used to login. Click the Download DXP button to dowload a file called tracking.dxp to your local machine that has been pre-configured to connect to the two data streams previously provisioned.

    Navigate to your TIBCO Cloud Spotfire® subscription by clicking here for EU region and here for US region. Click the Browse local file... option and navigate to the tracking.dxp that you downloaded. Once loaded, the DXP should connect to your running streams showing an analytics dashboard. Everything will be empty for now though.

    On the right hand side of the menu bar, where it says Viewing, change this to Editing. Then select the File > Save As > Library Item... menu option. Choose a location to save the analysis and then click the Save button.

    Once it's saved you will need to extract the path to the analysis. This can be done using the Library Manager. Click the File > View Library menu option. Navigate to the analysis you just saved, right-click on it and select Properties. Copy the value under the Path. 

    10.png.a934661e9ee1fa6b4635e6de833c4f02.png

    Back in the Accelerator Welcome page you can paste this in the Analysis Path box. The Web Player Server will be pre-populated based on the region that you logged in as, but please verify that it is correct by checking the URL of the Spotfire® page where you uploaded the DXP to ensure they match. Click the Save button once completed.

    11.thumb.png.475ad80f873240c94698c927a4097197.png

    The Welcome page settings are now completed so you can click Close to go to the main dashboard.

    Access Main Dashboard

    The first time the Main Dashboard is accessed the UI will attempt to load the configured Spotfire® analysis. Note that third-party cookies must be enabled, so if you are using Incognito mode then this will need to be enabled by clicking the icon on the address bar, then Site Not Working and then Allow Cookies. You may need to manually refresh the page.

    12.png.0f8ba5923e6405cab1d704fe1f894b5e.png

    If you have not logged in to a TIBCO Cloud service in the current browser session, then dashboard will display a message prompting you to login to Spotfire®. Click the Log in button and complete the login process.

    13.thumb.png.b743ae275e8a7438a73676f3aac5e8a6.png

    If you have previously logged in to a TIBCO Cloud service in the current browser session then the login step should be skipped and the dashboard will be displayed. It will be empty for now.

    14.thumb.png.cc6894ab55dd6f6f610beecd2d67e1c3.png

    Run a Simulation

    Select the Simulator menu option. Choose a value for Select a testcase from the list of options. The testcase name and a brief description are displayed. Adjust the Message delay to control the delay between each message sent as part of the simulation. Then click the Start Test Case button.

    15.thumb.png.4380e9bc1691188789457f0a9c80424c.png

    The UI will change back to the dashboard view. A parcel will appear in the list on the left. Click on it mark the row and the remaining visualizations will be populated with relevant information.

    16.thumb.png.ce3d06326d278d7aab990e32d8701569.png

    Adjust Settings

    Select the Settings menu item to adjust any of the configurations defined during the Welcome page process. Note that components should not be re-provisioned without manually deleting any existing events applications or data streams. If data streams are re-provisioned then the Spotfire® DXP will require updating to point at the new streams.

    17.thumb.png.f8f3d21f1be772e91221047904b0f6ff.png

    Shutting Down

    There is a cost associated with running Data Streams, Events, and Integration services. So it is recommended to stop these services manually when not in use.

    1. Open TIBCO Cloud Data Streams by clicking here for EU region and here for US region then click on Track_Parcel and then click the Stop button. Do the same for the Track_Route stream. This will take a few minutes to stop.
    2. Open TIBCO Cloud Events by clicking here for EU region and here for US region then hover over the number of instances and click the down arrow to zero, then click Scale.
    3. Open TIBCO Cloud Integration by clicking here for EU region and here for US region then then clicking the Stop button for the TrackTraceWebapp application
     Share
    Go to articles

    User Feedback

    Recommended Comments

    There are no comments to display.


×
×
  • Create New...