deutsch | english

Introduction

The management operations of the HOPE Channel website are done through the Backend Interface provided by the TYPO3 content management system. Therefore we will presume you are logged in with the user credential provided to you.

In order to login in the Backend Interface, you have to open in your browser the following link http://www.hopetv.org/typo3/ and type in your username and password.

Setting up the shop

Here's a list of steps to follow in order to initially set up the shop:

  1. Create product categories
  2. Create products and add them to categories
  3. Optionally add some advertisement banners

More detailed information on how to create categories, products and banners can be found in the following chapters.

Manage Categories

Create category

First of all upload the images for all your categories. Click on the File icon under the MEDIA section of the side navigation.

Upload your images to the folder images/categories. Make sure your file names have a meaningful name and that there are no special characters or whitespaces in it.
The minimun width of the image is 1024 pixel.
The allowed image formats ar .jpg, .png and .gif.

After uploading the images, edit the image and add a caption and alt text to it. This text will be displayed when a user moves the mouse over the image.

After uploading the images, you're ready to create the categories. Click on the List Element on the side navigation and select the Categories Folder.

Click on the Title icon to insert a new category.

Fill out the category form with the following fields.

  • Hide
    Check this if you want to hide the category from the shop.
  • Title
    Enter the title of the category.
  • Description
    Enter the description of the category.
  • Image
    Select a category image by clicking on the Folder icon. A new window will be opened containing two tabs. Select your previously uploaded category imageby clicking on the plus icon.
  • Picture credits
    The credits for the right of using the image described in the previous paragraph.

Click on the save  icon, on the upper left side of the page. Alternatively you may click on save and close  or save and create new .

Edit category

Click on the List Element on the side navigation and select the Categories Folder.

Click on the edit  icon of the category you would like to edit. After you are finished editing the category form, you can save it by clicking on the save icon. Alternatively you can click on save and close  or save and create new .

Delete category

Click on the List Element on the side navigation and select the Categories Folder.

Note: Make sure you only delete categories you won't use anymore. Furthermore, delete the products of the category before you delete the category itself.
If you want to remove the products from a category, you have two options: Either you delete the dependant products, or you assign them to another category.

Click on the delete  icon corresponding to the category you would like to delete.

Show or hide categories

Click on the List Element on the side navigation and select the Categories Folder.

Click on the hide or show icon of the category you would like to hide or show. The process of hiding a category is similar as deleting it, with the difference that it can be restored at any time by clicking on the show icon.

Note: By hiding a category, all contained products will not appear anymore in the shop.

Manage Products

Create product

First of all upload the images for all your products. Click on the File icon under the MEDIA section of the side navigation.

Upload your images to the folder images/products. Make sure your file names have a meaningful name and that there are no special characters or whitespaces in it.
The minimun width of the image is 1024 pixel.
The allowed image formats ar .jpg, .png and .gif.

After uploading the images, edit the image and add a caption and alt text to it. This text will be displayed when a user moves the mouse over the image.

After uploading the images, you're ready to create the products. Click on the List Element on the side navigation and select the Products Folder.

Click on the Title icon to insert a new product.

Fill out the product form with the following fields.

  • Hide
    Check this if you want to hide the product.
  • Start
    Set the date and time from when on the product will appear in the shop.
    If no start date is set, the product will be in the shop right away.
  • Stop
    Set the date and time when the product will be removed from the shop.
    If no end date is set, the product will be in the shop indefinitely.
  • Category
    Assign the product to a category.
  • Title
    Enter the title of the product.
  • Subtitle
    Enter the subtitle of the product.
  • Description
    Enter the description of the category.
  • Image
    Select a product image by clicking on the Folder icon. A new window will be opened containing two tabs. Select your previously uploaded product image by clicking the plus icon.
  • Notice
    Enter a optional notice of the product.
  • Tags
    Enter tags for the product. This tags are not displayed on the website. They are only for the article search in the TYPO3 backend.
  • Advertise start
    Set a start date if you want to advertise the product on the main shop page. You may also set the time.
  • Advertise end
    Set an end date if you want to advertise the product on the main shop page. You may also set the time.
  • Articles
    Add one or more articles to the product. Articles may be PDFs, Videos, Docs, ... There are no restrictions on the files that can be added to the product.

    Click on the Create new icon to insert a new article. You have to provide an article number, a name and a file you've previously uploaded to your File/products folder.

Click on the save  icon, on the upper left side of the page. Alternatively you may click on save and close  or save and create new .

Edit product

Click on the List Element on the side navigation and select the Products Folder.

Click on the edit  icon of the product you would like to edit. After you are finished editing the product form, you can save it by clicking on the save icon. Alternatively you can click on save and close  or save and create new .

Delete product

Click on the List Element on the side navigation and select the Products Folder.

Note: If you delete a product from the list, associated orders will get lost. If you just want to remove a product from the shop, hide the product instead of deleting it.

Click on the delete  icon corresponding to the product you would like to delete.

Show or hide products

Click on the List Element on the side navigation and select the Products Folder.

Click on the hide or show icon of the product you would like to hide or show. The process of hiding a product is similar as deleting it, with the difference that it can be restored at any time by clicking on the show icon.

Manage Advertisements

Advertisement positions

You have to possibilities where the advertisements can be positioned on the shop:

Create advertisement

First of all upload the images for all your banners. Click on the File icon under the MEDIA section of the side navigation.

Upload your images to the folder images/advertisements. Make sure your file names have a meaningful name and that there are no special characters or whitespaces in it.
The minimun width of the horizontal banner is 1024 pixel.
The minimun width of the vertical banner is 600 pixel.
The allowed image formats ar .jpg, .png and .gif.

After uploading the images, edit the image and add a caption and alt text to it. This text will be displayed when a user moves the mouse over the banner.

After uploading the images, you're ready to create the advertisement. Click on the List Element on the side navigation and select the Advertisements Folder.

Click on the Title icon to insert a new advertisement.

Fill out the advertisement form with the following fields.

  • Hide
    Check this if you want to hide the advertisement.
  • Title
    Enter the title of the advertisment.
  • View area
    Choose where your advertisement will appear.
    Horizontal: below the category list
    Vertical: skyscraper or box on the right side of the categories
  • Image
    Select an adverisement image by clicking on the Folder icon. A new window will be opened containing two tabs. Select your previously uploaded advertisement image by clicking the plus icon.
  • Link
    Link your banner to a page within your site, an external link, a file, ....
  • Product
    Link your banner to a product of your shop. You have two possibilities to find an existing product:
    a) Click on the Folder icon and find the product in the Folder tree. Click on the plus icon to select a product.
    b) Use the search field to find a product. By now you can search only by the product title.

Click on the save  icon, on the upper left side of the page. Alternatively you may click on save and close  or save and create new .

Edit advertisement

Click on the List Element on the side navigation and select the Advertisements Folder.

Click on the edit  icon of the advertisement you would like to edit. After you are finished editing the advertisement form, you can save it by clicking on the save icon. Alternatively you can click on save and close  or save and create new .

Delete advertisement

Click on the List Element on the side navigation and select the Advertisements Folder.

Click on the delete  icon corresponding to the advertisement you would like to delete.

Show or hide advertisements

Click on the List Element on the side navigation and select the Advertisements Folder.

Click on the hide or show icon of the advertisement you would like to hide or show. The process of hiding an advertisement is similar as deleting it, with the difference that it can be restored at any time by clicking on the show icon.

Manage Order Methods

You can define the methods how products are ordered. A product can either be ordered from the online shop, by calling the customer service, by AIM, etc.

Click on the List Element on the side navigation and select the Order methods Folder.

Click on the Title icon to insert a new order method. All you need to specify is the title of the new order method.

You can also

  • edit an order method by clicking the edit  icon
  • delete an order method by clicking the delete  icon
  • show or hide an order method by clicking he hide or show icon

Click on the save  icon, on the upper left side of the page. Alternatively you may click on save and close  or save and create new .

Manage Types

You can define the types for artiles. The type is an attribut of an article.

Click on the List Element on the side navigation and select the Types Folder.

Click on the Title icon to insert a new type. All you need to specify is the title of the new type. It is not allowed to insert a type with an existing title. The title must be unique.

You can also

  • edit a type by clicking the edit  icon
  • delete a type by clicking the delete  icon
  • show or hide a type by clicking he hide or show icon

Click on the save  icon, on the upper left side of the page. Alternatively you may click on save and close  or save and create new .

Manage Orders

A list of all articles that have been ordered can be seen in the Shop Administration. The customer service has also the possibility to create an order manually.

Overview on all orders

Click on the List element on the side navigation and select the Orders Folder.

On this page, you can

  • edit an order method by clicking the edit  icon
  • delete an order method by clicking the delete  icon
  • show or hide an order method by clicking he hide or show icon

Create new order

Click on the icon to insert a new order. When you create a new order, you'll have to fill out data on 4 different tabs:

1. Basic data

This tab contains the basic data of the order.

  • Hide
    Check this if you want to hide the order.
  • Order number
    Randomly generated order number (cannot be edited)
  • Order method
    Choose the order method. For more order methods, see the chapter Manage Order Methods.
  • Confirmation sent
    This checkbox will be checked by the system as soon as the order was saved and an email was sent successfully to the addressee.

2. Billing address

  • Title
    Enter the title of the billing address.
  • First name (*)
    Enter the first name.
  • Middle name
    Enter the middle name.
  • Last name (*)
    Enter the last name.
  • Suffix
    Enter a suffix.
  • Street (*)
    Enter the street.
  • ZIP (*)
    Enter the ZIP code. (*)
  • City (*)
    Enter the city.
  • State
    Select the state by typing minimum 3 letters in the search field beside the state field.
  • Country (*)
    Select the country by typing minimum 3 letters in the search field beside the country field.
  • Phone
    Enter the phone number.
  • Email
    Enter the email address.
  • Religious affiliation (*)
    Enter the religious affiliation.

Mandatory fields are marked with a star (*).

3. Shipping address

This tab is only interesting if the order should be sent by letter post.

  • Post delivery
    Check this field if the article should be sent by letter post.

4. Order items

Click on the Create new icon to add a new item. At least one item needs to be added.

  • Article
    The article you want to send. You have two options for selecting the articles:
    a) Search the article by article number, article name, type title, product title, product subtitle, product description, product notice, product tags or category title. You can type in more than one word to search for every word to reduce the results. If you want to search for a phrase, use the double quotes (e.g. "Higher Ground").
    b) Search by clicking on the Folder icon and by selecting any article from the Products folder.
        Select a product by clicking the plus icon.
  • Quantity
    The quantity of items you want to order

Saving the order

Click on the save  icon, on the upper left side of the page. Alternatively you may click on save and close  or save and create new .

When saving the order, one of following scenarios will occur:

  1. No email address was provided:
    The order will be saved. No further actions from here.

  2. A valid email address was provided:
    - An email with download links to the article(s) will be sent to the addressee
    - The field Confirmation sent on the Basic data tab will be checked by the system.

  3. An invalid email address was provided:
    - The order will be saved, but no email will be sent.
    - The field Confirmation sent on the Basic data tab will NOT be checked.

Resending an email

If you want to resend an email, uncheck the field Confirmation sent on the Basic data tab and save the order by click on the save  icon. The email will be sent again.

Export Orders

Click on the Shop element on the side navigation and select the Orders Folder.

You have two options:

  1. Export all orders defining the start and end date.
    You can specify the date and time and the delivery.

  2. Export the latest orders, i.e. all orders that haven't been exported yet.
    You can specify the delivery.

On the top of the page, you can see how many objects haven't been exported.

RSS feed

All articles with product and category data can be find in the following RSS feed.

http://www.hopetv.org/shop/rss/rss.xml

JSON API

The JSON API provides a list of all articles, a single article and all articles for a specific type. To get the JSON data, you need a the api key.

To get all articles, use the following URL:
http://www.hopetv.org/free-offers/json/data.json
  ?tx_amsshop_pi1[apiKey]=YOUR_API_KEY

To get a single article, use the following URL:
http://www.hopetv.org/free-offers/json/data.json
  ?tx_amsshop_pi1[apiKey]=YOUR_API_KEY
  &tx_amsshop_pi1[articleNumber]=YOUR_ARTICLE_NUMBER

Please note that YOUR_ARTICLE_NUMBER must be URL encoded.

To get all articles for a specific type, use the following URL:
http://www.hopetv.org/free-offers/json/data.json
  ?tx_amsshop_pi1[apiKey]=YOUR_API_KEY
  &tx_amsshop_pi1[type]=YOUR_TYPE

You can enter for YOUR_TYPE the type uid, the type title or 0 for all articles without a type. Please note that YOUR_TYPE must be URL encoded.

To get all articles for a specific category, use the following URL:
http://www.hopetv.org/free-offers/json/data.json
  ?tx_amsshop_pi1[apiKey]=YOUR_API_KEY
  &tx_amsshop_pi1[category]=YOUR_CATEGORY

You can enter for YOUR_CATEGORY the category uid or the category title. Please note that YOUR_CATEGORY must be URL encoded.

You can use the type and category parameter together.