Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To enable dynamic linking to a form, edit the Value of its configuration flag:

FormConfiguration Flag

Value

Cargo COA or VC In COADataForm.COA.Links

Enclosed in <Link> </Link> tags, description of link location followed by = followed by path to COA link location in double quotes. These links appear in the Attachments section of the COA.

  • Within the path, {CoaNo} and {ReferenceNo} may be used, for example <Link>COA Docs="C:\My Documents\COA\{CoaNo}"</Link>.
  • Multiple locations may be entered, each in its own set of <Link> </Link> tags.
  • Links to applications may also be created using this syntax, and parameters can be added within the <Link> tag, for example <Link params="-COA:{CoaNo}">Program Name="C:\Program Files\OutsideApp.exe"</Link>.
  • The size limit for for each link (everything after the '=' in a single <Link>) is 512 characters. Any links that are not complete within this limit will be ignored. The same limit applies separately to the 'params' attribute. Special characters (such as &, %, $) must be escaped.
Cargo or VC InDataForm.Cargo.Links

Enclosed in <Link> </Link> tags, description of link location followed by = followed by path to Cargo link location in double quotes. These links appear in the Attachments section of the Cargo form and the Voyage Manager.

  • Within the path, {CargoID}, {ExternalRef}, {VesselName}, and {VoyageNo} may be used, for example <Link>Cargo Docs="C:\My Documents\Cargo\{CargoID}"</Link>.
  • Multiple locations may be entered, each in its own set of <Link> </Link> tags.
  • Links to applications may also be created using this syntax, and parameters can be added within the <Link> tag, for example <Link params="-cargo:{CargoID}">Program Name="C:\Program Files\OutsideApp.exe"</Link>.
  • The size limit for for each link (everything after the '=' in a single <Link>) is 512 characters. Any links that are not complete within this limit will be ignored. The same limit applies separately to the 'params' attribute. Special characters (such as &, %, $) must be escaped.
Voyage FixtureDataForm.Fixture.Links

Enclosed in <Link> </Link> tags, description of link location followed by = followed by path to Fixture link location in double quotes. These links appear in the Attachments section of the Voyage Fixture and the Voyage Manager.

  • Within the path, {FixtureNo} and {VesselCode} may be used, for example <Link>Fixture Docs="C:\My Documents\Fixture\{VesselCode}\{FixtureNo}"</Link>.
  • Multiple locations may be entered, each in its own set of <Link> </Link> tags.
  • Links to applications may also be created using this syntax, and parameters can be added within the <Link> tag, for example <Link params="-vessel:{VesselCode} -fixture:{FixtureNo}">Program Name="C:\Program Files\OutsideApp.exe"</Link>.
  • The size limit for for each link (everything after the '=' in a single <Link>) is 512 characters. Any links that are not complete within this limit will be ignored. The same limit applies separately to the 'params' attribute. Special characters (such as &, %, $) must be escaped.
Time Charter In or Time Charter OutDataForm.TimeCharter.Links

Enclosed in <Link> </Link> tags, description of link location followed by = followed by path to Time Charter link location in double quotes. These links appear in the Attachments section of the Time Charter.

  • Within the path, {TcCode}, {ExternalRef}, and {VesselName} may be used, for example <Link>TC Docs="C:\My Documents\Time Charter\{TcCode}"</Link>.
  • Multiple locations may be entered, each in its own set of <Link> </Link> tags.
  • Links to applications may also be created using this syntax, and parameters can be added within the <Link> tag, for example <Link params="-TimeCharter:{TcCode}">Program Name="C:\Program Files\OutsideApp.exe"</Link>.
  • The size limit for for each link (everything after the '=' in a single <Link>) is 512 characters. Any links that are not complete within this limit will be ignored. The same limit applies separately to the 'params' attribute. Special characters (such as &, %, $) must be escaped.
Voyage ManagerDataForm.Voyage.Links

Enclosed in <Link> </Link> tags, description of link location followed by = followed by path to voyage link location in double quotes. These links appear in the Attachments section of the Voyage Manager.

  • Within the path, {VoyageNo}, {VesselCode}, {VesselTypeCode}, {VesselName}, and {VoyageReference} may be used, for example <Link>Voyage Docs="C:\My Documents\Voyage\{VesselCode}\{VoyageNo}"</Link>.
  • Multiple locations may be entered, each in its own set of <Link> </Link> tags.
  • Links to applications may also be created using this syntax, and parameters can be added within the <Link> tag, for example <Link params="-vessel:{VesselCode} -voyage:{VoyageNo}">Program Name="C:\Program Files\OutsideApp.exe"</Link>.
  • The size limit for for each link (everything after the '=' in a single <Link>) is 512 characters. Any links that are not complete within this limit will be ignored. The same limit applies separately to the 'params' attribute. Special characters (such as &, %, $) must be escaped.
AddressDataForm.AddressBook.LinksEnclosed in <Link> </Link> tags, description of link location followed by = followed by path to Address Book link location in double quotes. Within the path, {ShortName} and {RefNo} may be used, for example <Link>Address Book Docs="C:\My Documents\Address Book\{ShortName}"</Link>. Multiple locations may be entered, each in its own set of <Link> </Link> tags. Links to applications may also be created using this syntax, and parameters can be added within the <Link> tag, for example <Link params="-AddressBook:{ShortName}">Program Name="C:\Program Files\OutsideApp.exe"</Link>. These links appear in the Attachments section of the Address Book. The size limit for for each link (everything after the '=' in a single <Link>) is 512 characters. Any links that are not complete within this limit will be ignored. The same limit applies separately to the 'params' attribute.
VesselDataForm.Vessel.Links

Enclosed in <Link> </Link> tags, description of link location followed by = followed by path to Vessel link location in double quotes. These links appear in the Attachments section of the Vessel form.

  • Within the path, {VesselCode}, {VesselName}, and {RefNo} may be used, for example <Link>Vessel Docs="C:\My Documents\Vessel\{VesselCode}"</Link>.
  • Multiple locations may be entered, each in its own set of <Link> </Link> tags.
  • Links to applications may also be created using this syntax, and parameters can be added within the <Link> tag, for example <Link params="-vessel:{VesselCode}">Program Name="C:\Program Files\OutsideApp.exe"</Link>.
  • The size limit for for each link (everything after the '=' in a single <Link>) is 512 characters. Any links that are not complete within this limit will be ignored. The same limit applies separately to the 'params' attribute. Special characters (such as &, %, $) must be escaped.