Differences

This shows you the differences between two versions of the page.

--- dynamiczip:integration_points:dynamiczip_call_external_procedure [2015/08/04 18:09] – [Build 74 and later] chuck
+++ dynamiczip:integration_points:dynamiczip_call_external_procedure [2016/09/21 22:35] (current) – conni
@@ Line 1: / Line 1: @@
 ====== Calling DynamicZip from another 3rd party product ======
-===== Procedure DynamicZipCall_External =====
-This procedure has been designed to make it possible to call the DynamicZip [[dynamiczip:features:zip_addressing|Zip Addressing]] and [[dynamiczip:features:schedule_assignment:tax_schedule_selection|Tax Schedule Selection]] from another 3rd Party Integrating Dictionary.
+===== Procedure DynamicZipCall_External =====
+This procedure has been designed to make it possible to call the DynamicZip [[dynamiczip:features:zip_addressing|ZipAddressing]] and [[dynamiczip:features:schedule_assignment:tax_schedule_selection|Tax Schedule Selection]] from another 3rd Party Integrating Dictionary.
+This procedure can be called using the Dexterity statement:
+<code>
+call with name "DynamicZipCall_External" in dictionary 581 {, parameter, parameter,...}
+</code>
+Be sure to include all parameters. The optional parameters can be included simply as a comma with no associated value.
 ==== Build 74 and later ====
 === Parameters ===
@@ Line 15: / Line 20: @@
   * inout Zip ioShipToZip;
   * inout 'Country Code' ioShipToCountry;
-  * in boolean iCorrectAddress;	{Run Zip Addressing}
+  * in boolean iCorrectAddress;	{Run ZipAddressing}
   * inout 'Tax Schedule ID' ioDocTaxScheduleId;	{Customer's tax schedule id for this doc or line-item}
   * in boolean iAssignTaxSchedule;	{Run tax schedule selection}
@@ Line 21: / Line 26: @@
   * in 'Shipping Method' iShippingMethod;
   * in 'Item Number' iItemNumber;
-  * optional inout string ioItemCategory;	{used only if non-blank value sent and item number is blank}
+  * optional inout string [[dynamiczip:glossary:item_category|ioItemCategory]];((If iItemNumber is not blank, ioItemCategory should be left blank and the setting from TBIC setup will be used. Alternately leave iItemNumber blank and specify the desired ioItemCategory.))
-  * inout 'Tax Options' ioItemTaxOption;
+  * inout 'Tax Options' [[dynamiczip:glossary:tax_option|ioItemTaxOption]];((Leave blank to use setting from the Item Maintenance window.))
-  * inout 'Tax Schedule ID' ioItemTaxScheduleId;	{Item's tax schedule id used if item's tax option is 'Taxable'}
+  * inout 'Tax Schedule ID' ioItemTaxScheduleId;((Leave blank to use setting from the Item Maintenance window.))
-  * inout KDGeoCode [[dynamiczip:glossary:geocode|ioShipToGeocode]];((If provided the geocode will override the ship-to address. This should normally be left blank.))
+  * inout KDGeoCode [[dynamiczip:glossary:geocode|ioShipToGeocode]];((If provided, the geocode will override the ship-to address. ioShipToGeocode should normally be left blank.))
   * optional inout boolean ioOutsideCityLimits = false; ((This parameter changed as of Build 74.))
   * optional in boolean iUnsued1 = false;  ((This parameter changed as of Build 74.))
   * optional in boolean iUnused2; ((This parameter changed as of Build 74.))
   * optional in boolean iUnused3; ((This parameter changed as of Build 74.))
-  * optional in boolean [[dynamiczip:glossary:select_default|iSelectDefaultSchedule]];
+  * optional in boolean [[dynamiczip:glossary:select_default|iSelectDefaultSchedule]];((If not provided, the setting in the DynamicZip Setup window is used.))
-  * optional in boolean iTaxByItemCatagory;
+  * optional in boolean iTaxByItemCatagory;((If not provided, the setting in the DynamicZip Setup window is used.))
-  * optional in boolean iUseUspsCity;
+  * optional in boolean iUseUspsCity;((If not provided, the setting in the DynamicZip Setup window is used.))
-  * optional in integer iWindowCalledFrom;
+  * optional in integer iWindowCalledFrom;((This is used when automatically opening the address or tax schedule lookup window. This should normally not be used by another 3rd party product.))
-  * out string oMessage;
+  * out string oMessage;((This will be blank unless an address or tax schedule could not be selected.))
-  * out integer oAddressStatus;
+  * out integer [[dynamiczip:features:addressing:zip_addressing_status|oAddressStatus]];
   * out integer [[dynamiczip:features:schedule_assignment:tax_schedule_selection_status|oScheduleStatus]];
   * optional out KDTaxStatus [[dynamiczip:glossary:taxable_status|oCustomerTaxableStatus]];