Neolane - JavaScript API - v6.1.0

Unknown
delivery
This schema represents a delivery action or template.

A template is a delivery template including all the necessary parameters. A delivery template can be executed manually from the client console, or executed when an event occurs (started from the scheduler, or programmatically from a SOAP call).

Methods
AppendDeliveryPartAdd a part to a delivery being prepared.
BuildForwardBuilds the HTML page.
BuildMirrorBuild the HTML mirror page.
BuildMirrorExBuild the HTML mirror page.
BuildPreviewBuilt the preview of a content to delivery or of a line of the output file (in external mode).
BuildPreviewFromIdBuilt the preview of a content to delivery or of a line of the output file (in external mode).
CleanupDeliveriesSpecifies that the mid-sourcing server should delete certain deliveries.
CollectLogsCreates a table with all the delivery log messages for a list of deliveries
CreateFromModelCreation of a delivery from a template (from its internal name).
DeployTriggerMessageSinglePublish the transactional message on execution instances. Returns true if the publication is successful and false if not.
DeployTriggerMessagesPublish the selected transactional messages on the execution instances
DispatchImagesTells the application server to send the images to the mid-sourcing server.
ExecCommandExecute a command on a delivery
ExecuteJobExecutes a synchronous process on a delivery
FinalizeMidPreparationFinalize the analysis of a delivery in mid-sourcing mode.
GetDlStatusAndLogsRetrieve the last logs from the journal and the state of the delivery.
GetFilesToDownloadReturns the list of files found on the server associated with the delivery.
GetMidBroadLogsRetrieve the delivery logs modified last in mid-sourcing-mode.
GetMidDeliveriesRetrieve the status of the deliveries modified last in mid-sourcing-mode.
GetMidXtkKeyReturns the Xtk key of the mid server
GetMirrorURLObtains the URL of an HTML mirror page.
HtmlToTextConverts HTML content into plain text
ImagePublishingPerforms the post-processing : moving the image to a specified folder and making it available online
InstallTransactionalMessageInstall a transactional message template on the execution instance
InvalidateDeliveryCacheMust be called at the end of message preparation except for mid-sourcing (private method).
LaunchFCPStarts a Proof copy for a delivery
LoadExpandedContentsLoad a list of components for preprocessing with dependencies (personalization blocks, options, additional script objects, etc.).
PauseSuspend a delivery.
PlayStart a delivery.
PrepareDelivery analysis: Targeting and personalization
PrepareAndStartAnalyzes the delivery and executes it straightaway if no errors are encountered
PrepareFromIdAnalyse a delivery.
PrepareMessageMessage personalization
PrepareMessageImplMessage personalization
PrepareMultipartRelatedSave the images to include in the email in the database
PrepareNotificationAnalyze a notification being added to an existing delivery action
PrepareProofDelivery analysis in view of generating a proof
PrepareTargetDelivery target count and arbitration
PrepareTargetImplDelivery target count and arbitration
PreviewExtractionPreview of the extraction file
PrioritizeLogsPrioritize the delivery log for a list of deliveries
PrioritizeTargetDelivery target arbitration
QueueNotificationRequest to queue a notification referencing a delivery template.
RecomputeStatsRecompute delivery and tracking statistics for a delivery action.
SaveUrlInfoSave URLs of this delivery as URL templates.
StopStop a delivery in progress.
StoreMirrorPageInfoAdds information to generate mirror pages for a set of delivery parts.
StoreMirrorPageInfoExAdds information to generate mirror pages for a set of delivery parts.
SubmitDeliveryCreation and submission of a delivery from a scenario (from its internal name).
SubmitDeliveryByIdCreate and submit a delivery from a scenario (identified by it's internal name).
SubmitJobSubmits a job for a delivery for asynchronous processing
SubmitMidSourcingSubmit a delivery in mid-sourcing mode
SubmitNotificationCreate and submit a notification from a scenario.
UpdateBroadLogsUpdate the status of the delivery logs, perform error handling and update the delivery counters.
UpdateCachedDeliveryMust be called everytime the delivery is been modified in the memory so that other threads have access to an up to date version (private method).
UpdateImageConfigModifies the imageConfig node to take into account the images already on the server.
ValidateWavesDefinitionCheck the consistency of information used in the definition of the waves.
Generic Methods
create Creates a new entity corresponding to a given schema.
load Loads and returns an entity corresponding to a given schema and key.
save Saves an entity in the database.

jsapi-en

previous page start next page