...

...

Datashed Use-Case Scenarios

...

Datashed is able to run a Report Designer report. This is particularly useful when scheduling a report to be emailed to a distribution list. When running a Report Designer report, the parameters of the datashed call will override any settings stored in the report definition. This includes overriding details such as which ouptut directory to use and which email address to send to.

^datashed.exe

...

^{--rvTitle="Report}

...

^Title"

...

^{--outputPath="C:\temp"}

Breakdown of this command:

Running a Large Report Designer Report

For larger reports, data can be read from the database in chunks of records (default = 5000) to prevent out-of-memory exceptions that might occur from loading all the data at once.

^datashed.exe

...

^--rvTitle

...

^{"report_name_2"}

...

^--stream

^datashed.exe

...

^--rvTitle

...

^{"report_name"}

...

^--stream

...

^{--streamBatchSize}

...

¹⁰⁰⁰⁰

Exporting a Voyage Pnl Snapshot XML

Datashed can export a Voyage Pnl Snapshot XML based on recalculation or a snapshot. The snapshot XML will include every Pnl line item detail and is specifically dependent upon the vnccmd pnlXml.

• Examples:

  • ^datashed.exe

    ^{--rvForm Voyage} 

    ^--rvFilter

    ^{"VesselCode==""XXXX""AND}

    ^{VoyageNo==XXXX"}

    ^--action

    ^{"vnccmd:pnlXml?vslCode=XXXX&voyNo=XXXX&snapshotType=daily&dataSource=EAP&voypnlNotificationXml=true&outputFolder=C:\temp"}

    ^{--multithread}

  • ^datashed.exe

    ^{--rvForm Voyage} 

    ^--rvFilter

    ^{"VesselCode==""XXXX""AND}

    ^{VoyageNo==XXXX" --action}

    ^{"vnccmd:pnlXml?vslCode=XXXX&voyNo=XXXX&snapshotType=current&dataSource=snapshot:EAP&voypnlNotificationXml=true&outputFolder=C:\temp"}

    ^{--multithread}

    • This method is best used with snapshot types like current, for which only one of each A, E, P can exist.

Breakdown of this command:

Bulk Saving Voyages to Update the "Current" Snapshot or Prompt Voyage XML Files

You may come across the following two scenarios that datashed.exe could help with:

1. If you enable configuration flag CFGCacheVoyPnl and require all voyages to be "bulk" saved.

2. If you have a Vessel Data Integration and require all vessel XML files to be bulk sent to their new system (requires Message Handler setup).

The command below can be set up as a one-time scheduled task.
Note: It is highly encouraged to test this in a database backup with one vessel first.

^datashed.exe

...

^{--rvForm=Voyage}

...

^{--rvFilter="VoyageStatusCode!=""Closed"""}

...

^--action

...

^{"vnccmd:saveVoyage?vslCode={VesselCode}&voyNo={VoyageNo}"}

Bulk Saving Cargoes

If you want all cargoes to be saved, the command below can be set up as a one-time scheduled task.
Note: It is highly encouraged to test this in a database backup with one cargo first.

^{datashed.exe  --rvForm=Cargo}

...

^{--rvFilter="CargoID!=0"}

...

^--action

...

^{"vnccmd:saveCargo?cargoId={CargoID}"}

Running the Trading Module Historical VaR

Datashed can run the Trading module Historical VaR report. This report is specifically dependent upon the vnccmd runHistoricalVarReport. The following is an example:

^datashed.exe

...

^--action

...

^{"vnccmd:runHistoricalVarReport?numberOfSteps=30&snapshotType=Ad-hoc&snapshotRef=Daily&step=1&stepUnit=Day&filter=CARGO&outputFile=C:\temp\VarReport.xml"}

This example leverages the --action parameter of datashed to execute a runHistoricalVarReport command. For further information on the runHistoricalVarReport command, see below.

vnccmd:pnlXml

vnccmd is an internal utility for calling specific actions in IMOS from the command line. It is common to use one specific action, pnlXml, when working with datashed. Here is a list of the pnlXml action arguments.

Anchor
runHistoricalVarReport runHistoricalVarReport

vnccmd:runHistoricalVarReport

vnccmd is also able to run the Trading Module Historical VaR Report. This allows you to schedule the Historical VaR report for regular output, and even automatically email it to certain recipients. Like the pnlXml command above, the runHistoricalVarReport has its own set of commands that are build into a datashed action argument.

vcncmd:saveCargo

Saves cargo with a specified cargoID argument.

vnccmd:deleteCargo

Deletes cargo with the specified cargoID argument.

Sending Emails

Datashed is able to send emails either through the command line parameters, or by running a report with an email distribution list configured. When sending an email, Datashed will use a Messaging Service Outgoing Message Location. This Outgoing Location must be an SMTP server with the Name default.