API Name: TX_CUST_LOGIN
Overview:
This API is designed to allow a preferred account customer the
ability to access information relative to his/her business with
your firm. Prior to accessing any of the available on-line
features, the customer must login using this API.
If you wish to use the SRM web designing tool you can do so by entering ‘webadmin’ into the customer number field. The password needs to be set within SRM or TSI software in Presentation Themes. When logged in as ‘webadmin’ you will have access to a set number of API's for use in designing the web page. Only one concurrent ‘webadmin’ login can be used at a time.
INPUT PARAMETERS:
Parameter Default Value Comment
T_CUST_N User to enter customer number as setup in CUSTOMER INFORMATION
FILE, or webadmin.
T_PASSWORD default Customer password setup in CUSTOMER INFORMATION.
Webadmin password setup in Presentation Themes
SETTINGS.
T_USERID ADMINISTRATOR Multiple users can be setup for any 1 customer with
controlled access. See Maintain Users API.
T_ENCRYPTED N Enter Y to encrypt password, using RentOnTheDot.
OUTPUT PARAMETERS:
Parameter Comment
T_ERROR Returns a non-blank value if login unsuccessful.
T_WEB_ID The unique Web Identification value required during session.
T_NAME Name of the customer who successfully logged in.
T_CART_OPTIONS This value determines if the user has any/partial/full access to the
shopping cart. D = Shopping Cart is disabled, R = User can add rental
items to Shopping Cart, S = User can add sales items to Shopping Cart,
B = User has full access to Shopping Cart.
T_USERID The user who successfully logged in.
T_INDEX_HEADING The text to be used as the heading of the web index.
T_IMAGE_PATH Relative path under ROTD context on the web server that contains all of
the images to be displayed.
T_LOGO_IMAGE The name (if any) of the logo to be displayed.
T_LOGO_ALIGNMENT The alignment of the logo in reference to the web index.
L = Left, R = Right, C = Center.
T_LOGO_SCALABLE This determines if the logo image is to be scalable with the web index.
Y = Scalable, N = Not scalable.
T_FONT The font to be used for the web pages.
T_FOREGROUND_COLOR The color to be used for the text within the web page headings.
T_BACKGROUND_COLOR The color to be used for the background of web page headings.
T_RENTAL_COLOR The color to be used for the rental tab of the Shopping Cart.
T_SALE_COLOR The color to be used for the sale tab of the Shopping Cart.
T_CART_COLOR The color to be used for the View Cart tab of the Shopping Cart.
T_CART_HEADER_COLOR The color to be used for the text within the Shopping Cart tabs.
T_PAGE_COLOR The color to be used as the background color of the web pages.
T_PAGE_IMAGE The image to be used as the background image of the web pages.
This takes precedence over T_PAGE_COLOR if both have values.
T_INDEX_BACKGROUND_COLOR The color to be used as the background color of the web index.
T_INDEX_TEXT_COLOR The color to be used within the web index.
T_LINK_COLOR The color to be used for hyperlinks on the web page.
T_SHOPPING_CART_RATE When in the Shopping Cart only 1 rate displays.
This value is the rate that is to be shown. 1 - 5 are only valid.
T_LEFT_FRAME_SIZE The size of the web index in pixels or as a percentage of the browser’s
current size. If this value is to be handled as a percentage, it will
end with a percentage symbol. ie. '25%'
T_WELCOME_WORDS The welcoming words to be displayed once the customer logs in.
T_HINT_SETUP This value will be returned as 'Y' if this customer still is required
to setup a password question/answer for the Maintain Password Question API.
This is currently used to prompt the user for his/her password
question/answer after a successful login.
T_DESC_ALL Wording to use for 'All' as setup in Presentation Themes
SETTINGS.
T_DESC_YES Wording to use for 'Yes' as setup in Presentation Themes
SETTINGS.
T_DESC_NO Wording to use for 'No' as setup in Presentation Themes
SETTINGS.
T_CUSTOM_INDEX Y = Web Index By Customer is enabled.
N = Web Index By Customer is disabled.
This only applies if logging in as the webadmin user.
RECORD SETS:
Record Set: API_INDEX
Column Names Comment
Index ID Unique ID that links this API call to a specific set of input and
output parameters.
API Name of the API to be called when the user clicks on the description.
Desc Description to be displayed on the web.
When the user clicks on this description the API stated above should
be called.
JSP If no API is specified this link (if any) will need to be used.
Display This is to determine if this option is to be shown as available
on the web. Y= Display, N = Hide.
Order The order in which to display within the web index.
This is a numerical value.
Number Of Indents The numerical value of indents to be applied to this API within
the web index.
Record Set: ROTD_COMMENTS
Column Names Comment
Comments Comment lines to be displayed after a successful login.
This can be used to post greetings or bulletins to your customers to alert
them about recent happenings in your company or new sales features, etc.
| Converted from CHM to HTML with chm2web Pro 2.85 (unicode) |