NOTE: Please check with our support team before following this process as you may not need to use this!
Cartridge Setup
Import Site Preferences
Edit Site Preferences
Job
Site URLs
Templates
Permissions
Video Tutorial
The integration is contained in the storefront cartridges “int_zmags” and the business manager extension cartridge “bm_zmags”. The storefront and business manager cartridges contain the following components:
Cartridge Setup:
Do the following to import the cartridge into Demandware Studio:
1) In Demandware Studio click 'File' > 'Import', 'General' > "Existing Projects into Workspace" then click 'next'.
2) In the next window ensure "Select archive file" is checked and click on the 'Browse' button on the right.
3) Select the archive file containing the integration, then click 'Open' > 'Finish'.
4) If you have an active Demandware server connection the Studio will ask you to link the cartridge to it. Click 'Yes'.
5) To manually assign and deploy the cartridge to a server connection, right-click on it and then 'Properties'. Select "Project References" and check the project containing the integration. The cartridge should be automatically uploaded.
To activate the integration in SiteGenesis, the cartridge has to be assigned to the site and Business Manager:
1) Login to Business Manager and click on 'Administration'.
2) Click on 'Sites' > "Manage Sites".
3) Click on the site name followed by the 'Settings' tab at the top.
4) In the 'Cartridges' text field, add the beginning of the pre-existing text “int_zmags:”.
5) Go back to "Manage Sites" and click on "Business Manager".
6) Click the 'Settings' tab at the top.
7) In the 'Cartridges' text field, add in the beginning of the pre-existing text “bm_zmags:”.
8) Repeat steps 3 and 4 for each "Instance Type" by selecting the appropriate type from the drop-down menu (Production, Staging, Sandbox / Development).
Import Site Preferences:
The Zmags integration uses custom site preferences for configuration purposes. Before changing the required values, the definitions of these preferences need to be imported into the Business Manager by following these steps:
1) Log in to the Business Manager and click on 'Administration'.
2) Click on "Site Development" and then "Import & Export".
3) Click on 'Upload' > 'Browse'.
4) Navigate to the 'configurations' folder and select the "zmags_metadata.xml" file. Click 'Open'.
5) Click 'Upload' and then "<< Back".
6) Click on "Meta Data - Import", select the "zmags_metadata.xml" file.
7) Click the "Next >>" button to validate the XML file.
8) After the file is validated click 'Import' to import the metadata.
Edit Site Preferences:
1) Login to Business Manager and select the 'Site' tab at the top.
2) Click on "Site Preferences".
3) Click on "Custom Preferences".
4) Click on "Zmags Preferences". There you can see this form:
5) The following text fields are mandatory:
- “The customer ID”,
- “API key”, *
- “Base service URL” and
- “The ID of Site”.
* To find your API key; (1) log into the Zmags Publicator, (2) click "Administration" in the bottom-left corner, (3) click "Account Settings".
Job:
To delete the custom objects of an expired catalog, a Job must be configured. The Job can be configured in the Business Manager by following these steps:
1) Log in to Business Manager and click on 'Administration'.
2) Click 'Operations' > "Job Schedules".
3) Click 'New'.
4) Fill out the fields as shown in the picture:
5) Click 'Apply'.
6) Click the 'Sites' tab at the top.
7) Select all Sites using the Zmags Catalogs and click 'Apply'.
8) Click the 'General' tab at the top to go back to the previous page.
9) Define an interval in which the job will be executed.
Site URLs:
To view the catalogs on the Storefront, a few things must be configured. This is done in the Business Manager by following these steps:
1) Login to Business Manager and select the 'Site' tab at the top.
2) Click on Site URLs and then 'Aliases'.
3) Insert the following text in the text field (change the URL to match your instance) and click 'Save':
{
"_version": "1",
"settings": {
"http-host": "zmags01.tech-prtnr-na03.dw.demandware.net",
"https-host": "zmags01.tech-prtnr-na03.dw.demandware.net"
}
}
4) Go back to Site URLs and click on "Dynamic Mapping".
5) Insert the following text in the text field (you can change “publication” to anything you like) and click 'Save':
/publication/* p,,,Zmags-RenderCatalog,,baseURL,{0}
6) Go back to Site URLs and click on "URL Rules".
7) Check "Enable Search Friendly URLs".
8) Now catalogs can be reached by the following URL (“publication” should be changed as to the same as in step 5):
<hostname>/publication/<base URL>
Templates:
The file zmags_library.xml contains an example render template.
By default this file will be imported into the current site’s private content library.
Make sure that this private content library is assigned to the current site:
Administration -> Sites -> Content Libraries
If you want to use a shared content library assigned to the site then you need to modify the import file:
Open zmags_library.xml in a text editor and change the 2nd line from
<library xmlns="http://www.demandware.com/xml/impex/library/2006-10-31">
to
<library xmlns="http://www.demandware.com/xml/impex/library/2006-10-31" library-id="SiteGenesisSharedLibrary">
Replace “SiteGenesisSharedLibrary” with the ID of the shared library you want to import the template into.
Importing the template:
1) Login to Business Manager and select your Site on the top tab menu.
2) Click on Content and then on Import & Export.
3) Click on the button Upload and in the next page click on the Browse button.
4) Navigate in the file system and select the zmags_library.xml file then click on Open.
5) Click on the Upload button and then on the << Back button.
6) Click on the Import button and then select the zmags_metadata.xml file.
7) Click on the Next >> button in order to validate the xml file.
8) After the file is validated click again to the Next >> button.
9) Select MERGE and click on Import.
Permissions:
1) Log in to Business Manager and click 'Administration'.
2) Click 'Organization' > "Roles & Permissions".
3) Click on the ID of the Role you want to give permission to access Zmags.
4) Click on the "Business Manager Modules" tab at the top.
5) Select your Site in the "Select Context" field and click 'Apply'.
6) Enable Zmags in the list, click 'Update'.
7) Repeat steps 3 to 7 for all roles you want to grant access.
Video Tutorial:
Comments
0 comments
Please sign in to leave a comment.