Subscribe Extract Export

Subscribe Extract Export is used to integrate the Subscribe and Circulation applications. The Subscribe application uses the Circulation APIs to create transactions like new subscriptions, payments, or billing changes. The data from these transactions is stored in the Circulation databases. The Subscribe Extracts are used to import this data into the Subscribe databases.

The files associated with Subscribe Extract Export are mentioned below.

File Name	Description
address_demo.txt	This file displays all demographics with the DemographicType "Address."
address_master.txt	This file exports all of the address IDs available in the Circulation database.
auto_renew.txt	This file displays details of all the active auto-renewal subscriptions.
autorenew_ccexpire.txt	This file provides information on AutoRenew Subscriptions that started with a Promo Rate Code and will expire in the next 14 days, after which the rate will be increased.
autorenew_ccstart.txt	This file contains information on the AutoRenew Subscriptions that started today on AutoPay Type "Credit Card" and on Promo RateCode.
bill_change.txt	This file contains information on all "BillingChg" Transactions. BillingChange includes changes to billing method and address, switching from autopay to non-autopay and vice versa, rate changes, and so on.
campaign_extractMG2.txt	This file sends information on the campaigns and offers available in the NCS Circ, such as the Campaign ID, start and end dates, and other details.
campaign_PropertiesExtractsMG2.txt	This file displays Campaign properties like CampaignPropertyID and CampaignPropertyValue.
campaign_ZipExtractsMG2.txt	This file includes information on which Campaign IDs apply to particular Zip Codes.
carrier.txt	This file contains information on the carriers that were modified or created after the export start date.
carrier_distribpoint.txt	This file displays the details of Routes/DistribPoints of all the carriers
complaints.txt	This file contains information on the complaints.
deadlines.txt	This file exports information on paper delivery deadlines and redelivery cutoff times for products on the associated routes.
delsched.txt	This file contains all the Delivery Schedule (DelivSched) Transactions.
demographics_subscribe.txt	This file contains all of the Subscription demographics intended for Subscribe (DemoGraphic.AudienceCategory - "Subscribe").
endgrace_date.txt	This file displays information about subscriptions that are in the grace period.
expire_date.txt	This file contains information about subscriptions that are due to expire within the export date range.
future_trans.txt	This file extracts vacation details for all future vacations (Temp Stops) and vacations that have already started (the vacation's end date has not yet been reached).
future_trans_full.txt	This file contains the Transactions that will become effective in the future. Transactions included are: 1stInvoice, 1stRenewal, 2ndInvoice, 2ndRenewal, 3rdInvoice, 3rdRenewal, 4thRenewal, AutoRenew, BillingChg, DelivSched, EndGrace, EndGraceChg, Expire, ExpireChnge, GraceAccrual, GraceEnd, GraceExport, GraceOwed, GracePaid, GraceWOff, MoveIn, MoveOut, Note, ReBill, Refund, RefundXfr, Renewal, Reroute, Restart, Start, Stop, TempAddrEnd, TempAddress, TransferIn, TransferOut
mailsubscription.txt	This file displays all the subscriptions that are mail-delivered.
merchandise.txt	This file extracts information on merchandise (items such as books and mugs) associated with three transaction types: DelivSched, BillingChg, and Start.
non_subs.txt	This file sends information on occupants who are present in the system but have not subscribed or whose subscriptions are no longer active.
notes.txt	This file contains all the Note Transactions.
occupant_demo.txt	This file displays all demographics with the DemographicType "Occupant."
occupant_email.txt	This file exports the email addresses of all the occupants. It displays data such as OccupantID, Email Address, Start Date, End Date, Primary (Yes/No), etc.
occupant_name.txt	This file exports the Occupant Names such as First Name, Last Name, Middle Names of the occupants.
occupant_phone.txt	This file exports the Phone Numbers of all the occupants. It displays data such as OccupantID, Phone Numbers, Phone Type, Create Date, Create Time, Primary (Yes/No), etc.
occupantsolicitation.txt	This file contains all of the Occupant Solicitations. Occupants may request not to be solicited by phone, mail, or other methods.
payments.txt	This file extracts information for transactions with a transaction type of "Payment" or "AutoRenew."
pymtdecline.txt	This file contains information on payments that have been declined or failed.
rate_codes.txt	This file gives the details of all active rate codes, their rate terms and lengths, start and end dates, etc.
renewals.txt	This file displays the subscriptions that are due for renewal.
restarts.txt	This file sends information about subscriptions that have been restarted after a temporary stop or vacation.
route_draw.txt	This file contains the number of copies/draws delivered on a certain route.
route_subscription.txt	This file contains Route and Distribution Point information for all carriers.
router.txt	This file contains information on all Routes and their related RouteIDs. In NCS, a Route is a collection of address ranges. A default route exists for each address range.
starts.txt	This file contains information about newly started subscriptions.
stops.txt	This file contains information on subscriptions that have been stopped (either temporarily or permanently).
submaster.txt	This file displays the details of all the subscriptions. Note: Trial details of a subscription (Trial_Term, Trial_Length, Trial_StartDate, and Trial_EndDate) are included in the Sub_master.txt file.
subscription_demo.txt	This file displays all demographics with the DemographicType "Subscription."
version.txt	This file contains meta data about the Extract run, such as the database name, export version, release version, number of export files created, etc.

File Name

Description

address_demo.txt

This file displays all demographics with the DemographicType "Address."

address_master.txt

This file exports all of the address IDs available in the Circulation database.

auto_renew.txt

This file displays details of all the active auto-renewal subscriptions.

autorenew_ccexpire.txt

This file provides information on AutoRenew Subscriptions that started with a Promo Rate Code and will expire in the next 14 days, after which the rate will be increased.

autorenew_ccstart.txt

This file contains information on the AutoRenew Subscriptions that started today on AutoPay Type "Credit Card" and on Promo RateCode.

bill_change.txt

This file contains information on all "BillingChg" Transactions. BillingChange includes changes to billing method and address, switching from autopay to non-autopay and vice versa, rate changes, and so on.

campaign_extractMG2.txt

This file sends information on the campaigns and offers available in the NCS Circ, such as the Campaign ID, start and end dates, and other details.

campaign_PropertiesExtractsMG2.txt

This file displays Campaign properties like CampaignPropertyID and CampaignPropertyValue.

campaign_ZipExtractsMG2.txt

This file includes information on which Campaign IDs apply to particular Zip Codes.

carrier.txt

This file contains information on the carriers that were modified or created after the export start date.

carrier_distribpoint.txt

This file displays the details of Routes/DistribPoints of all the carriers

complaints.txt

This file contains information on the complaints.

deadlines.txt

This file exports information on paper delivery deadlines and redelivery cutoff times for products on the associated routes.

delsched.txt

This file contains all the Delivery Schedule (DelivSched) Transactions.

demographics_subscribe.txt

This file contains all of the Subscription demographics intended for Subscribe (DemoGraphic.AudienceCategory - "Subscribe").

endgrace_date.txt

This file displays information about subscriptions that are in the grace period.

expire_date.txt

This file contains information about subscriptions that are due to expire within the export date range.

future_trans.txt

This file extracts vacation details for all future vacations (Temp Stops) and vacations that have already started (the vacation's end date has not yet been reached).

future_trans_full.txt

This file contains the Transactions that will become effective in the future. Transactions included are: 1stInvoice, 1stRenewal, 2ndInvoice, 2ndRenewal, 3rdInvoice, 3rdRenewal, 4thRenewal, AutoRenew, BillingChg, DelivSched, EndGrace, EndGraceChg, Expire, ExpireChnge, GraceAccrual, GraceEnd, GraceExport, GraceOwed, GracePaid, GraceWOff, MoveIn, MoveOut, Note, ReBill, Refund, RefundXfr, Renewal, Reroute, Restart, Start, Stop, TempAddrEnd, TempAddress, TransferIn, TransferOut

mailsubscription.txt

This file displays all the subscriptions that are mail-delivered.

merchandise.txt

This file extracts information on merchandise (items such as books and mugs) associated with three transaction types: DelivSched, BillingChg, and Start.

non_subs.txt

This file sends information on occupants who are present in the system but have not subscribed or whose subscriptions are no longer active.

notes.txt

This file contains all the Note Transactions.

occupant_demo.txt

This file displays all demographics with the DemographicType "Occupant."

occupant_email.txt

This file exports the email addresses of all the occupants. It displays data such as OccupantID, Email Address, Start Date, End Date, Primary (Yes/No), etc.

occupant_name.txt

This file exports the Occupant Names such as First Name, Last Name, Middle Names of the occupants.

occupant_phone.txt

This file exports the Phone Numbers of all the occupants. It displays data such as OccupantID, Phone Numbers, Phone Type, Create Date, Create Time, Primary (Yes/No), etc.

occupantsolicitation.txt

This file contains all of the Occupant Solicitations. Occupants may request not to be solicited by phone, mail, or other methods.

payments.txt

This file extracts information for transactions with a transaction type of "Payment" or "AutoRenew."

pymtdecline.txt

This file contains information on payments that have been declined or failed.

rate_codes.txt

This file gives the details of all active rate codes, their rate terms and lengths, start and end dates, etc.

renewals.txt

This file displays the subscriptions that are due for renewal.

restarts.txt

This file sends information about subscriptions that have been restarted after a temporary stop or vacation.

route_draw.txt

This file contains the number of copies/draws delivered on a certain route.

route_subscription.txt

This file contains Route and Distribution Point information for all carriers.

router.txt

This file contains information on all Routes and their related RouteIDs. In NCS, a Route is a collection of address ranges. A default route exists for each address range.

starts.txt

This file contains information about newly started subscriptions.

stops.txt

This file contains information on subscriptions that have been stopped (either temporarily or permanently).

submaster.txt

This file displays the details of all the subscriptions. Note: Trial details of a subscription (Trial_Term, Trial_Length, Trial_StartDate, and Trial_EndDate) are included in the Sub_master.txt file.

subscription_demo.txt

This file displays all demographics with the DemographicType "Subscription."

version.txt

This file contains meta data about the Extract run, such as the database name, export version, release version, number of export files created, etc.

Select Utilities | Export | Subscribe Extract to display the Subscribe Extract Export screen.

Select Add and complete the following fields.

Field	Type	What to enter
EXPORT PATH	predefined	Enter the full path for the file to be exported.
EXPORT START DATE	date	Enter the start date for which you want to export information.
EXPORT VERSION	predefined	Enter the export version, e.g., 01, 02, etc.
RUN SUBCON FILES	yes/no	Enter "Yes" to export the SubCon extracts or "No" to exclude the SubCon extracts.
RUN DISCOVERY FILES	yes/no	Enter "Yes" to export the Discovery extracts or "No" to exclude the Discovery extracts.
PUBLICATION	setup	Enter the publication or publications for which the subscribe extract is to be exported.
DATABASE NAME	setup	Enter the circulation database from which the subscribe extract is to be exported.

Field

Type

What to enter

EXPORT PATH

predefined

Enter the full path for the file to be exported.

EXPORT START DATE

date

Enter the start date for which you want to export information.

EXPORT VERSION

predefined

Enter the export version, e.g., 01, 02, etc.

RUN SUBCON FILES

yes/no

Enter "Yes" to export the SubCon extracts or "No" to exclude the SubCon extracts.

RUN DISCOVERY FILES

yes/no

Enter "Yes" to export the Discovery extracts or "No" to exclude the Discovery extracts.

PUBLICATION

setup

Enter the publication or publications for which the subscribe extract is to be exported.

DATABASE NAME

setup

Enter the circulation database from which the subscribe extract is to be exported.

Select Continue to export the information.

PreviousAddresses NextImport Menu

Last updated 1 year ago

Subscribe Extract Report Files

To run the Subscribe Extract Export: