PKG Plugin/Documentation

PKG Plugin User Guide

Created by sterling on 9/26/14.

360Works Plugin Setup Guides

See Plugins_101 for Error reporting, installation, registration, and more.

Function Summary

• PKGAddTask ( actualFinishDate ; actualStartDate ; iniId ; plannedFinishDate ; plannedStartDate ; resource ; taskStatus ; taskId ) — Adds task information to an initialized update request
• PKGInfoChangeAdd ( subId ; sortSeq ; artDsp ; artId ; dktDsp ; dktId ; mstId ; pkgDsp ; pkgId ; pkgType ; prtDsp ; prtId ; prtType ; vendInfo100 ; vendInfo110 ; username ; password ; endpointUrl ) — Creates package info
• PKGInfoChangeExecute —
• PKGInfoCreateAdd ( subId ; sortSeq ; artDsp ; artId ; dktDsp ; dktId ; mstId ; pkgDsp ; pkgId ; pkgType ; prtDsp ; prtId ; prtType ; vendInfo100 ; vendInfo110 ; username ; password ; endpointUrl ) — Creates package info
• PKGInfoCreateExecute —
• PKGInfoLastSubId — Gets the sub ID from the most recent request.
• PKGInfoNewRequest ( username ; password ; endpointUrl ) —
• PKGInfoNextMessage — Determines if there is a response message to read.
• PKGInfoNextMessageText — Gets the text of the current response message.
• PKGInfoNextMessageType — Gets the type of the current response message.
• PKGInitializeTask ( username ; password ; endpointUrl ) — Initializes the process of updating tasks
• PKGLastError — Returns the text of the last error triggered by a plugin function.
• PKGLastInitiativeId — Gets the initiative ID from the most recent request.
• PKGLastTaskId — Gets the task ID from the most recent request.
• PKGLicenseInfo — Returns information about the license used.
• PKGPerformTaskUpdate —
• PKGRegister ( licenseKey ; registeredTo ) — Registers the PKG Plugin.
• PKGSetErrorCapture ( errorCapture ) — Toggles error dialogs on or off.
• PKGTaskNextMessage — Determines if there is a response message to read.
• PKGTaskNextMessageText — Gets the text of the current response message.
• PKGTaskNextMessageType — Gets the type of the current response message.
• PKGVersion — Returns the version of the plugin that is installed.
• SAPGetApmUserId —
• SAPGetBrand —
• SAPGetCategoryManagerUserId —
• SAPGetCategoryManagerUserIdDis —
• SAPGetCountryOfOrigin —
• SAPGetDate —
• SAPGetDesignerUserId —
• SAPGetDirUserId —
• SAPGetEditorialUserId —
• SAPGetInitiativeId —
• SAPGetInitiativeName —
• SAPGetInitiativeType —
• SAPGetInMktDuration —
• SAPGetInStoreInstructions —
• SAPGetLaunchDate —
• SAPGetMarketingEvent —
• SAPGetMarketingPlatform —
• SAPGetMch —
• SAPGetMch1 —
• SAPGetMch2 —
• SAPGetMch3 —
• SAPGetMchName —
• SAPGetNextActualCost —
• SAPGetNextActualCostYTD —
• SAPGetNextBegdaFin —
• SAPGetNextBudgetAnnual —
• SAPGetNextBudgetIcon —
• SAPGetNextBudgetTotal —
• SAPGetNextCharInfoRecordAennr —
• SAPGetNextCharInfoRecordSortId —
• SAPGetNextCharInfoRecordSortSequenceClassAtBez —
• SAPGetNextCharInfoRecordSortSequenceClassAtNam —
• SAPGetNextCharInfoRecordSortSequenceClassAtWtb —
• SAPGetNextCharInfoRecordSortSequenceClassEstCat —
• SAPGetNextCharInfoRecordSortSequenceClassEstName —
• SAPGetNextCharInfoRecordSubId —
• SAPGetNextCostD —
• SAPGetNextCostL —
• SAPGetNextCurrency —
• SAPGetNextECV —
• SAPGetNextEnddaFin —
• SAPGetNextFrcstBgtAnnual —
• SAPGetNextFrcstBgtTotal —
• SAPGetNextFrcstCostTotal —
• SAPGetNextFrcstCostYTD —
• SAPGetNextIRR —
• SAPGetNextNPV —
• SAPGetNextPeriodType —
• SAPGetNextPlannedCost —
• SAPGetNextPlannedCostYTD —
• SAPGetNextPpmProjectPhaseId —
• SAPGetNextPpmProjectPhaseName —
• SAPGetNextPpmProjectPhaseStatus —
• SAPGetNextPpmProjectTaskDuration —
• SAPGetNextPpmProjectTaskId —
• SAPGetNextPpmProjectTaskName —
• SAPGetNextPpmProjectTaskPlannedEnd —
• SAPGetNextPpmProjectTaskPlannedStart —
• SAPGetNextPpmProjectTaskStatus —
• SAPGetNextROI —
• SAPGetNextSpecSubId —
• SAPGetNextZAnnualSalesTotal —
• SAPGetNextZAnnualVolume —
• SAPGetNextZCBNTGPNB —
• SAPGetNextZDIVISION —
• SAPGetNextZGroupNTGPPct —
• SAPGetNextZIncrementalNTGP —
• SAPGetNextZIncrNTGPVsKO —
• SAPGetNextZKOProductNTGP —
• SAPGetNextZKOProductNTGPPct —
• SAPGetNextZKOProductSize —
• SAPGetNextZLaunchVolume —
• SAPGetNextZMCSalesHurdle —
• SAPGetNextZMeetsHurdle2 —
• SAPGetNextZMeetsHurdle3 —
• SAPGetNextZNBProductCost —
• SAPGetNextZNBProductName —
• SAPGetNextZNBProductRetail —
• SAPGetNextZNBProductUPC —
• SAPGetNextZNOOFCONVPLGRMS —
• SAPGetNextZNOOFDISCPLGRMS —
• SAPGetNextZNTGP —
• SAPGetNextZNTGPPct —
• SAPGetNextZPennyProfit —
• SAPGetNextZPFITEMSTATUS —
• SAPGetNextZPRODUCTNAME —
• SAPGetNextZProductUOM —
• SAPGetNextZPRODUCTUPC —
• SAPGetNextZPromoPrice —
• SAPGetNextZRegularSales —
• SAPGetNextZRevisedCostOffsh —
• SAPGetNextZRevisedCostOffshPct —
• SAPGetNextZSales_Org —
• SAPGetNextZTargetCost —
• SAPGetNextZTargetRetail —
• SAPGetNextZZMeetsHurdle1 —
• SAPGetOffshore —
• SAPGetPdSideBarUserId —
• SAPGetPdUserId —
• SAPGetPlanogramReleaseDate —
• SAPGetPmUserId —
• SAPGetPpmProjectName —
• SAPGetPpmProjectStatus —
• SAPGetQaUserId —
• SAPGetRaUserId —
• SAPGetScopeBriefNo —
• SAPGetScopeBriefStatus —
• SAPHasNextCharInfoRecord —
• SAPHasNextCharInfoRecordSortSequence —
• SAPHasNextCharInfoRecordSortSequenceClass —
• SAPHasNextCharInfoRecordSortSequenceClassAtNam —
• SAPHasNextFinInfo —
• SAPHasNextPpmProjectPhase —
• SAPHasNextPpmProjectTask —
• SAPLoadXML ( xml ) —

Function Detail

PKGAddTask ( actualFinishDate ; actualStartDate ; iniId ; plannedFinishDate ; plannedStartDate ; resource ; taskStatus ; taskId )

Adds task information to an initialized update request

Parameters:

actualFinishDate

actualStartDate

iniId

plannedFinishDate

plannedStartDate

resource

taskStatus

taskId

Returns: 1 on success, or "ERROR" on failure.

PKGInfoChangeAdd ( subId ; sortSeq ; artDsp ; artId ; dktDsp ; dktId ; mstId ; pkgDsp ; pkgId ; pkgType ; prtDsp ; prtId ; prtType ; vendInfo100 ; vendInfo110 ; username ; password ; endpointUrl )

Creates package info

Parameters:

subId

artDsp

artId

dktDsp

dktId

mstId

pkgDsp

pkgId

pkgType

prtDsp

prtId

prtType

vendInfo100

vendInfo110

Returns: 1 on success, or "ERROR" on failure.

PKGInfoChangeExecute

Returns: 1 on success, or "ERROR" on failure.

PKGInfoCreateAdd ( subId ; sortSeq ; artDsp ; artId ; dktDsp ; dktId ; mstId ; pkgDsp ; pkgId ; pkgType ; prtDsp ; prtId ; prtType ; vendInfo100 ; vendInfo110 ; username ; password ; endpointUrl )

Creates package info

Parameters:

subId

artDsp

artId

dktDsp

dktId

mstId

pkgDsp

pkgId

pkgType

prtDsp

prtId

prtType

vendInfo100

vendInfo110

Returns: 1 on success, or "ERROR" on failure.

PKGInfoCreateExecute

Returns: 1 on success, or "ERROR" on failure.

PKGInfoLastSubId

Gets the sub ID from the most recent request.

Returns: the last submission ID on success, or "ERROR" on failure.

PKGInfoNewRequest ( username ; password ; endpointUrl )

Parameters:

username

password

endpointUrl

Returns: 1 on success, or "ERROR" on failure.

PKGInfoNextMessage

Determines if there is a response message to read.

Returns: 1 if there is a response message available, 0 if not

PKGInfoNextMessageText

Gets the text of the current response message.

Returns: message text on success, or "ERROR" on failure.

PKGInfoNextMessageType

Gets the type of the current response message.

Returns: a type code on success, or "ERROR" on failure.

PKGInitializeTask ( username ; password ; endpointUrl )

Initializes the process of updating tasks

Parameters:

username

password

endpointUrl

Returns: 1 on success, or "ERROR" on failure.

PKGLastError

Returns the text of the last error triggered by a plugin function. This should be called immediately after a plugin function returns "ERROR" to get a description of the error.

Returns: Error text, or "" if there was no error.

PKGLastInitiativeId

Gets the initiative ID from the most recent request.

Returns: the last initiative ID on success, or "ERROR" on failure.

PKGLastTaskId

Gets the task ID from the most recent request.

Returns: the last task ID on success, or "ERROR" on failure.

PKGLicenseInfo

Returns information about the license used.

Returns: The type of license the plugin is registered under.

PKGPerformTaskUpdate

Returns: 1 on success, or "ERROR" on failure.

PKGRegister ( licenseKey ; registeredTo )

Registers the PKG Plugin.

Parameters:

licenseKey

a valid license key string, or the literal string "DEMO" to run in demo mode.

registeredTo

the company name for the license key used.

Returns: 1 on success, or "ERROR" on failure.

PKGSetErrorCapture ( errorCapture )

Toggles error dialogs on or off. When something unexpected happens, the plug-in will pop up a dialog displaying the error message. This makes it easy to see what went wrong. However, in some cases, you (the developer) may prefer to show your own message to the user, or possibly not show a message at all. In that case, you can call EmailSetErrorCapture with a parameter of true. That will suppress the error dialog from appearing to the user.

Parameters:

errorCapture

set to true to suppress the default popups.

PKGTaskNextMessage

Determines if there is a response message to read.

Returns: 1 if there is a response message available, 0 if not

PKGTaskNextMessageText

Gets the text of the current response message.

Returns: message text on success, or "ERROR" on failure.

PKGTaskNextMessageType

Gets the type of the current response message.

Returns: a type code on success, or "ERROR" on failure.

PKGVersion

Returns the version of the plugin that is installed.

Returns: a decimal version number.

SAPLoadXML ( xml )

Parameters: