ISF Getting Started. Table of Contents

Transcription

1 ISF Getting Started Table of Contents Overview of Getting Started... 2 ISF Application Conventions & Navigation... 3 How to Log In... 9 How to Log Out User Profile Page Overview of ISF Security Administration Subscriber Tab Page Importers/Send-To Tab Page User Tab Page Subscriber Preferences Tab Page Preference Keys to Generate XML s/send_data User Preferences Tab Page Security Preferences Tab Page Security Preferences: How to Set Up Reports Enabling the CSV Download for Internet Explorer ISF-1

2 Kewill ISF > Overview of Getting Started Overview of Getting Started Overview Before accessing the Importer Security Filing web application your account must be set up by Kewill. Kewill will provide you with the URL, Subscriber account, and login username and password. You will then set up your Subscriber and User sub-accounts with the security levels you deem appropriate for each. Tip: If you are currently a Kewill Customs, Alliance or CargoPoint customer, Kewill can provide you with upload capabilities in order to build your maintenance tables of Importer, Manufacturers, Consignees, Deliver-To accounts, and Parts information. The Getting Started section includes the following: ISF Application Conventions & Navigation How to Log In How to Log Out How to Use the User Profile Security Administration Overview o o o o o o Subscriber Importers/Send-To User Subscriber Preferences User Preferences Security Preferences List of Security Properties Enabling the CSV Download for Internet Explorer ISF-2

3 Kewill ISF > Overview of Getting Started > Conventions & Navigation ISF Application Conventions & Navigation ISF Conventions & Navigation Overview of Application Conventions The application does not require you to enter field data in any particular order; you may mouse click on any field to enter the necessary codes or data required. Quick on-screen help tips are available by hovering the mouse over an icon to display a short icon label or description. Most of the application icons are duplicated in the drop-down toolbar menu and can be run either by clicking on the icon or by selecting the item from the menu. The question mark Info icon is used where codes are applicable and ISF-3

4 allow you to do a look-up to the table database. To move between pages, Page Tabs are available at the bottom of the screen (after at least the Header page data has been entered and an ISF number has been assigned to the ISF transaction). Click on the tab to select a page: When a button is clicked throughout the application, it will change color, as noted below: Find button before being clicked displays as a solid blue: Find button after being clicked displays in a lighter color: Navigation Conventions From the opening page, the ISF application can be accessed by using the drop-down menus from the Toolbar at the top of the page or by clicking on one of the icons. Icon Toolbar: Menu Toolbar: For a description of each icon and menu, see the following sections: Opening Page Icons Warning/Status Icons Opening Page Drop-down Menus Opening Page Icons Opening Page Icons Icon Name Description Previous page This icon becomes activated (darkens to yellow) when you have gone beyond the Header page on a new transaction. It allows you to return to the previous page. ISF-4

5 Note: Rather than clicking the icon, you have the option of using the keyboard shortcut of <Ctrl+Left>. Next page This icon becomes activated (darkens to yellow) when you open a new transaction. It allows you to move on to the next page. Note: Rather than clicking the icon, you have the option of using the keyboard shortcut of <Ctrl+Right>. Refresh Save ISF Delete ISF Click on the Refresh icon to reload the page. Once a transaction is open, click on this icon to save the transaction data. Once you find the transaction you would like to delete and display it, click on this icon to delete the transaction. A confirmation pop-up will display to reconfirm that you want to delete it. When you click on OK, the transaction will be deleted. Note: You may do a Find ISF on Deleted transaction types to view the ISF transactions that have been deleted. New ISF Find ISF Click this icon to open a new transaction Header page. Click on this icon to open the Find ISF page to locate an existing transaction. ISF-5

6 Warning/Status Icons Status/Warning icons Name Red X Description The Red-X icon indicates an error. If you get this icon, you cannot save the transaction until it is fixed. Example: Importer Account code required warning Yellow Triangle Tip: Hover the cursor over the icon to get a text message about the error. The Yellow Triangle indicates a warning. Although the error may need to be fixed, you can save the transaction data. Tip: Hover the cursor over the icon to get a text message about the warning. ISF-6

7 Opening Page Drop-Down Menus Opening Page Menus Menu Name Description File Menu Maintenance Menu From the File Menu, you can do the following: Create a New Transaction Find a Transaction Check on EDI Status Save a Transaction Delete a Transaction User Profile Logout From the Maintenance Menu, you can do the following: Access the maintenance tables these are listed alphabetically. Select the letter and the corresponding table titles will display to be selected. Example of P Maintenance tables: Security Administration Bonds Menu From the Security Administration Menu, you can access the Security Administration screens. Unless you have admin privileges, you will not be able to make any changes to the security information. From the Bonds Menu, you can select one of the following: Importer Bonds accesses the View Importer Bond page to show the bond data in the Importer ISF-7

8 Bond table. Importer Bond Query lets you send an Importer Bond query to CBP. Tools Menu From the Help Menu, you can do the following: Configure Reports Admin Utility View Reports Help Menu From the Help Menu, you can do the following: Access Help Contents (e.g., Training Guides, FAQ s and user documentation) Release Notes Shortcut link to the Kewill website About ISF Software ISF-8

9 Kewill ISF > Overview of Getting Started > Logging In How to Log In Overview To access the ISF application you must log in with a valid username and password. Usernames and encrypted passwords are set up in User Maintenance. Procedures The table below describes how to log into the ISF application. Step Action Comment 1 Open the ISF URL in your Internet browser: or The ISF splash screen will display as the application loads. Next, the welcome to ISF login window will display. Welcome to Importer Security Filing Login pop-up window: Login window The Subscriber, Username and Password entered on this page must be valid. Click on the Remember me box if you would like the application to remember ISF-9

10 and default your subscriber ID, username and password when you open the application. Step Action Comment 2 Enter your Subscriber ID, Username and your Password. The subscriber ID, username and password must be valid. Note: The Subscriber ID and Username are NOT case sensitive; however, the Password IS case sensitive if it is set up in all caps, it must be entered in all caps. 3 Click on the OK enter the application. button to If the Subscriber, Username, and Password are correct, the opening page will display. Opening Page: ISF-10

11 Step Action Comment 4 From the opening page you can create a new ISF transaction by clicking on the New ISF icon or find an existing ISF transaction by clicking on the Find ISF icon. For more information, see the detailed documentation: Overview of ISF Navigation Entering a New Transaction Finding an Existing Transaction ISF-11

12 Kewill ISF > Overview of Getting Started > Logging Out How to Log Out Overview Logging out is a two-step process if you have an open transaction. First save and close the transaction, and then log out of the application. Procedures The table below describes how to log out of the ISF application. Step Action Comment 1 To exit, select Logout from the Transaction Menu at the top of the page 2 If a transaction is open and you have not saved it, a dialog box will display asking if you would like to save your work. If no transaction is open, or if the transaction has already been saved, the application will close. ISF-12

13 Kewill ISF > Getting Started > User Profile User Profile Page User Profile Page Overview The User Profile page is accessed from the File menu. It allows the user to make changes to their own information (contact info) and to periodically change their password for security purposes. ISF-13

14 Procedures The table below describes the fields on the User page. Field Name Data Entry Comment Username Enter the username. This username will be used when logging into the application. Change Password Enter the password. This is the password that will be used when logging into the application. Confirm Password Name & Address Contacts Re-enter the password. Enter the name and address of the User. Enter the contact information for the User. Note: The Password is case sensitive. This field is to confirm the password. The name and address includes: Name Address (2 lines) City Postal Code Country Code Subentity (e.g., State, Province) Phone Number, and extension Alt. Phone Number, and extension Fax No. address Time Zone Local area uses Daylight Savings Time checkbox The Contact Information includes: Primary Contact Name Primary s Phone Number, and extension Primary s Alt Phone Number, and extension Primary s address Secondary Contact Name Secondary s Phone Number, and extension ISF-14

15 Field Name Data Entry Comment Secondary s Alt Phone Number, and extension Secondary s address User Preferences tab page: Overview If your user account is set up (in Security Administration) to allow you to add to or make changes to your user preferences, you can click on the User Preferences tab to access this page. Additions are made by clicking on the Add icon. Then click on the Info icon next to the Property field to select a preference property from the master list. In the Value field, enter the property value or default value. To delete a preference, highlight the preference on the grid and click on the Delete icon. To look up a preference property, click on the Info icon. ISF-15

16 Kewill ISF > Getting Started > ISF Security Administration Overview of ISF Security Administration Overview There are three levels of security configuration: 1. Company/Kewill Customer Generally, the Company/Kewill Customer is a Customs Broker. Kewill will set up this Kewill Customer account. The Subscriber/Username/Password configuration assigned to the Kewill Customer will have Admin-type access, e.g., this level can add/delete/update Subscribers and Users (i.e., their customers and/or trading partners), providing access to the web application. 2. Subscribers The Subscribers may be the Importers of Record and other trading partners, such as Freight Forwarders/Consolidators, or Suppliers. These Subscribers are set up by the Kewill Customer and assigned an account code, username and password. The Subscriber will be given the level of access the Kewill Customer deems necessary (adding, deleting, or marking Users as inactive and so on). 3. Users Are given the scope and limits of their capabilities by the Kewill Customer and/or Subscriber. Security Administration The Security Administration section includes the following: Subscriber Page Importers/Send-To Page User Page Subscriber Preferences Page User Preferences Page Security Preferences Page ISF-16

17 Kewill ISF > Getting Started > Security Administration > Subscriber Subscriber Tab Page Subscriber Tab Page Overview The Subscriber tab page sets up of the details for each Subscriber. In order to set up the Subscriber, you will need the following information: Subscriber ID Name & Address Contact Info (Primary & Secondary Names, Phone Numbers and addresses) Business Type (Is the Subscriber a Freight Forwarder, Customs Broker, or Importer). Note: When an importer is created (or uploaded from Alliance/Kewill Customs/CargoPoint), the importer is assigned to the Company-level Subscriber. In order for a lower level Subscriber to have access to the Importer, the Importer must be included in the Importer List for that Subscriber. ISF-17

18 Procedures The table below describes how the fields on the Subscriber page. Field Name Data Entry Comment ID Enter the Subscriber ID. This code will be entered when the Subscriber and all of the Subscriber s Users log in to the application. Active Party Type Name & Address Contacts Click the Active box to indicate the Subscriber is live and enabled. Select the Party Type code from the drop-down list. Enter the name and address of the Subscriber. Enter the contact information for the Subscriber. If the Active box is not checked, the Subscriber and all the Subscriber s Users will NOT be allowed to log into the application. The party type indicates the type of subscriber this is. For instance, BRK (broker), IOR (Importer of Record), and so on. The name and address includes: Name Address (2 lines) City Postal Code Country Code Subentity (e.g., State, Province) Phone Number Alt. Phone Number Fax No. The Contact Information includes: Primary Contact Name Primary s Phone Number Primary s Alt Phone Number Primary s address Secondary Contact Name Secondary s Phone Number Secondary s Alt Phone Number Secondary s address Created/Modified No data entry allowed. These fields will be updated by the ISF-18

19 Field Name Data Entry Comment system and allow you to see who the last changes were made by. ISF-19

20 Kewill ISF > Getting Started > Security Administration > Importers/Send-To Tab Importers/Send-To Tab Page Importers/Send To Tab Page Overview The Importers/Send To tab page sets up of the list of Importers and Send-To Subscribers. The Send-To Subscriber is the Subscriber account that a particular Subscriber s Users can forward the transaction to once the Users have completed their part. This happens when the Users do not have the authority to send the transaction to Customs and must alert someone else that they are done. Procedures The table below describes how to add or delete an Importers/Send To record. ISF-20

21 To Add or Delete an Importer and/or Send To Record: Importers/Send To Tab page: Step Action Comment 1 If you would like to add an Importer of Record, click the Add button. Note: To delete an Importer of Record, highlight the record on the grid and click You have the option of adding or deleting an Importer of Record. When you click the Add button, a new line displays on the grid and the ISF Importer field is activated. the Delete button. 2 In the ISF Import field, click on the Info icon to bring up the master list of Importers of Record. When you click the Info icon, the Select an Importer pop-up containing the list of available Importers of Record will display. ISF-21

22 Select an Importer pop-up: Step Action Comment 3 Highlight the selected Importer record, and click the OK button. When you click the OK button, the selected Importer record will be brought back to the previous page. Note: The Importers listed are the ones set up as available to this Subscriber and/or User. ISF-22

23 Importers/Send To Tab page: Step Action Comment 4 If you would like to add a Send To Subscriber record, click the Add button below the Send To Subscribers grid. Note: To delete a record, highlight the record on the grid and click the Delete button. 5 In the Subscriber field, click on the Info icon to bring up the master list of Subscribers. You have the option of adding or deleting a Send To Subscriber. When you click the Add button, a new line displays on the grid and the Subscriber field is activated. Note: The Send-To Subscriber is the Subscriber account that a particular Subscriber s Users can forward the transaction to once the Users have completed their part. This happens when the Users do not have the authority to send the transaction to Customs and must alert someone else that they are done. When you click the Info icon, the Select a Subscriber pop-up containing the list of available Subscribers will display. ISF-23

24 Select a Subscriber pop-up: Step Action Comment 6 Highlight the selected Subscriber record, and click the OK button. When you click the OK button, the selected record will be brought back to the Importer/Send To page. ISF-24

25 Kewill ISF > Getting Started > Security Administration > User Tab User Tab Page User Tab Page Overview The User tab page sets up the details for each User. In order to set up the User, you will need the following information: Subscriber that the User belongs to. (Required) User ID and Password (Required) Contact Info (Primary & Secondary Names, Phone Numbers and addresses) Authority to submit ISF to Customs or the Customs Broker Access Role (for security purposes e.g., Company, Subscriber, or User) For each address in the Contact area, indicate whether an alert should be issued when the ISF Response is received from Customs. ISF-25

26 Note: For users who do not have access to the Security Administration option, their own user information is accessible via the User Profile selection from the File drop-down menu. Procedures The table below describes the fields on the User page. Field Name Data Entry Comment Username Enter the username. This username will be used when logging into the application. Change Password Enter the password. This is the password that will be used when logging into the application. Confirm Password Created By Created Modified By Last Modified Active Name & Address Re-enter the password. No data entry allowed. Click on this checkbox to indicate the user account is an active account. Enter the name and address of the User. ISF-26 Note: The Password is case sensitive. This field is to confirm the password. These fields will be updated by the system. Only Active accounts can log into the ISF system. The name and address includes: Name Address (2 lines) City Postal Code Country Code Subentity (e.g., State, Province) Phone Number, with Ext. Alt. Phone Number, with Ext. Fax No. address Time Zone Local area uses Daylight Savings

27 Field Name Data Entry Comment Time (checkbox) Contacts Enter the contact information for the User. The Contact Information includes: Primary Contact Name Primary s Phone Number, with Ext. Primary s Alt Phone Number, with Ext. Primary s address Secondary Contact Name Secondary s Phone Number, with Ext. Secondary s Alt Phone Number, with Ext. Secondary s address ISF-27

28 Kewill ISF > Getting Started > Security Administration > Subscriber Preferences Tab Subscriber Preferences Tab Page Subscriber Preferences Tab Page Overview The Subscriber Preferences tab page sets up of configuration and default information at the Subscriber level. Procedures The table below describes how to use the Subscriber Preferences page. ISF-28

29 To Add or Delete a Subscriber Preference Record: Subscriber Preference Tab page: Step Action Comment 1 If you would like to add Subscriber Preference record, click the Add button below the grid. Note: To delete a record, highlight the record on the grid and click the Delete You have the option of adding or deleting a Subscriber Preference record. When you click the Add button, a new line displays on the grid and the Property fields are activated. button. 2 In the Property field, click on the Info icon to bring up the master list of Properties. When you click the Info icon, the Select a Security Property pop-up containing the list of available properties will display. ISF-29

30 Select a Security Property pop-up: Step Action Comment 3 Highlight the selected property record, and click the OK button. When you click the OK button, the selected property record will be brought back to the previous page. ISF-30

31 Subscriber Preferences page: Step Action Comment 4 In the Value field, enter the default value for the Property. The Value entered will display on the grid. 5 In the Access field, click in one the boxes to indicate the level of security: Company, Subscriber or the User. ISF-31

32 Kewill ISF > Getting Started > Security Administration > Preference Keys > Generate XML s/send- DATA Preference Keys to Generate XML s/send_data Preference Keys Generate XML s/send_data Overview There are four Generate XML s/send_data preference keys: SEND_DATA_ACCEPT SEND_DATA_REJECT SEND_DATA_STATUS_ADVISORY SEND_DATA_VALIDATION_ERROR These preference keys are used to generate XML s of an ISF at four distinct times: (1) When the ISF is accepted by Customs When the ISF is accepted, ISF-32

33 an XML of the ISF is created and sent to the Importer. (2) When the ISF is rejected by Customs If an ISF is rejected by Customs, an XML of the ISF is created and sent to the Importer. (3) When a Status Advisory has been received from Customs After the first Customs Status Advisory has been received on an ISF (e.g., from the receipt of the second and all future advisories), an XML of the ISF is created and sent to the Importer. (4) When a fatal Customs validation error has occurred When a fatal Customs validation error has been received from Customs, an XML of the ISF is created and sent to the Importer. How to Set Up these Preferences Setting Up These Preference Keys must be set up first at the Company level and then at the individual Importer Subscriber level. 1. At the company level, go to the Subscriber Preference tab of Security Administration and set the preference for each key to N. 2. At the importer subscriber level, go to the Importer Preference page of Importer Maintenance and set the preference for each key to Y. ISF-33

34 Company Level Subscriber Preferences Tab page: Importer Level Importer Preferences Tab page: ISF-34

35 Kewill ISF > Getting Started > Security Administration > User Preferences Tab User Preferences Tab Page User Preferences Tab Page Overview The User Preferences tab page sets up of configuration and default information at the User level. Procedures The table below describes how to use the User Preferences page. ISF-35

36 To Add or Delete a User Preference Record: User Preference Tab page: Step Action Comment 1 If you would like to add User Preference record, click the Add the grid. button below Note: To delete a record, highlight the record on the grid and click the Delete You have the option of adding or deleting a User Preference record. When you click the Add button, a new line displays on the grid and the Property fields are activated. button. 2 In the Property field, click on the Info icon to bring up the master list of Properties. When you click the Info icon, the Select a Security Property pop-up containing the list of available properties will display. ISF-36

37 Select a Security Property pop-up: Step Action Comment 3 Highlight the selected property record, and click the OK button. When you click the OK button, the selected property record will be brought back to the previous page. ISF-37

38 User Preferences page: Step Action Comment 4 In the Value field, enter the default value for the Property. The Value entered will display on the grid. ISF-38

39 Kewill ISF > Getting Started > Security Administration > Security Preferences Tab Security Preferences Tab Page Security Preferences Tab Page Overview The Security Preferences tab page sets up of configuration and default information at the Subscriber level. Procedures The table below describes how to use the Security Preferences page. ISF-39

40 To Add or Delete a Security Preference Record: Security Preference Tab page: Step Action Comment 1 If you would like to add Security Preference record, click the Add button below the grid. Note: To delete a record, highlight the record on the grid and click the Delete You have the option of adding or deleting a Security Preference record. When you click the Add button, a new line displays on the grid and the Property fields are activated. button. 2 In the Property field, click on the Info icon to bring up the master list of Properties. When you click the Info icon, the Select a Security Property pop-up containing the list of available properties will display. ISF-40

41 Select a Security Property pop-up: Step Action Comment 3 Highlight the selected property record, and click the OK button. When you click the OK button, the selected property record will be brought back to the previous page. [Click here for a list of available security properties.] ISF-41

42 Security Preferences page: Step Action Comment 4 In the Value field, enter the default value for the Property. 5 In the Lock Level field, click in one the boxes to indicate the level of security: No Lock, or Lock. The Value entered will display on the grid. Lock indicates that the value cannot be changed by users with security levels below this one. No Lock indicates the value can be changed by users with security levels below this one. ISF-42

43 Kewill ISF > Getting Started > Security Administration > Security Preferences Tab > How to Set Up Reports Security Preferences: How to Set Up Reports Security Preferences: How to Set Up Reports Overview To activate the capability for a user to configure, schedule, view, download or print reports, you must set up the capability in the Security Preferences tab of Security Administration. Note: We recommend that the Company/Subscriber level Security Preference for Reports be set to N and only specific users preference be set to Y. The Admin users will view and maintain reports for all users at their level and below. The non-admin users will only be able to view and maintain their own reports. Procedures Setting up the Reports capability is a two-part process: ISF-43

44 1. At the Company/Subscriber level, the Reports property must be set to N. This will prevent a new user from being set up and inadvertently allowed default Reports access. [For details on how to set up the Company/ Subscriber default for Reports see the How To below.] 2. After the Company/Subscriber level is set up as N for Reports, go into the user s security preferences and add Reports with a Value of Y for those users that will be given access to Reports. This will allow those users to Configure, View, Download and Print Reports. [For details on how to set up Users see the How To below.] The table below describes how to set up Reports on the Security Preferences page. Adding Reports to the Company/Subscriber level Security Preference Record: Security Preference Tab page: ISF-44

45 Step Action Comment 1 If you would like to add Reports to the Company/Subscriber Security Preference record, click the Add button below the grid. When you click the Add button, a new line displays on the grid and the Property fields are activated. 2 In the Property field, click on the Info icon to bring up the master list of Properties and select REPORTS from the list. Or you can type in REPORTS in the Property field. When you click the Info icon, the Select a Security Property pop-up containing the list of available properties will display. 3 In the Value field, enter the default value for Reports, e.g., enter N. The Value entered will display on the grid. A value of N will allow only specific users at the Subscriber level and below to have access to Reports. Warning: At the Company/Subscriber level, if you set the Value to Y, it will indicate that you would like all users at that level and below to have access to reports unless you have individually set users to N. It is easier to control access to reports by starting with a default of N and only changing it to Y for specific users. 4 In the Lock Level field, select Lock. Lock indicates that the value cannot be changed by users with security levels below this one. 5 You are done. The property will be saved when you move off the page. No Lock indicates the value can be changed by users with security levels below this one. ISF-45

46 Adding Reports to the User level Security Preference Record: Security Preference Tab page: Step Action Comment 1 If you would like to add Reports to a User Security Preference record, click the Add button below the grid. When you click the Add button, a new line displays on the grid and the Property fields are activated. 2 In the Property field, click on the Info icon to bring up the master list of Properties and select REPORTS from the list. Or you can type in REPORTS in the Property field. When you click the Info icon, the Select a Security Property pop-up containing the list of available properties will display. 3 In the Value field, enter Y to indicate this user will have Reporting capabilities. The Value entered will display on the grid. Entering Y indicates that this particular user is being given the capability to configure reports, view reports, download reports, and/or print reports. 4 In the Lock Level field, select Lock. Lock indicates that the value cannot be changed by users with security ISF-46

47 Step Action Comment 5 You are done. The property will be saved when you move off the page. levels below this one. No Lock indicates the value can be changed by users with security levels below this one. ISF-47

48 Kewill ISF > Getting Started > Enabling the CSV Download for IE Enabling the CSV Download for Internet Explorer Overview If you use Internet Explorer as your browser, you must set up the ISF website as a Trusted Site so that your computer s security will allow for the download of data from ISF to your PC. Otherwise, you will get a warning when you try to download data. Note: If you use Firefox as your browser, you do NOT have to perform these steps. Procedures The table below describes the steps involved to enable the CSV Download from ISF so that it will work with Internet Explorer. Step Action Comment 1 In your Internet Explorer browser, go to menu Tools- and select Internet Options: The Internet Options popup will display. ISF-48

49 Internet Options popup: Step Action Comment 2 On the Internet Options popup, select Trusted sites. The Trusted sites popup will display. Then click the Sites button. ISF-49

50 Trusted sites popup: Step Action Comment 3 Under Add this website to the zone:, type in *.kewill.net 4 Click the Add button. The site address will display in the Websites: box. Note: If the Require server verification (https: ) for all sites in this zone checkbox is checked, please click on it to uncheck it. ISF-50

51 Trusted Sites popup-website address added: Step Action Comment 5 Click the Close button. The ISF site is now considered a Trusted Site. The Internet Options Security page will redisplay. ISF-51

52 Internet Options Security Page: Step Action Comment 6 Click the Custom Level button. The Security Settings Trusted Sites zone popup will display. ISF-52

53 Security Settings Trusted Sites zone (Custom levels): Step Action Comment 7 Scroll down to the Downloads section and click on Enable for the following two options: 8 Click OK. Automatic prompting for the file downloads File download 9 Close the Internet Explorer application by either clicking on the X box in the top right corner or by selecting Exit from the File menu.. Closing the application will allow Internet Explorer to restart with the new settings the next time you open the application. 10 Log in to the ISF application. The Export functionality should now work. Copyright 2010 by Kewill Inc. [Last revision date: 05/20/10] ISF-53