Initializing help system before first use

facftlogin

facftlogin


Purpose
Login to the FAC File Transfer service.
Synopsis
procedure facftlogin
procedure facftlogin(username:string, password:string)
procedure facftlogin(baseurl:string, username:string, password:string)
Arguments
username 
Username for login
password 
Password for login
baseurl 
URL of the FTS service to use, e.g. https://fts.chi.ficoanalyticcloud.com/api/v1.0
Example
facftlogin('MyUsername','MyPassword')
facftlogin('https://fts.chi.ficoanalyticcloud.com/api/v1.0','MyUsername','MyPassword')
Further information
1. When using the facfiletransfer package from your local machine, you are required to login with a username and password prior to making any other calls. When using facfiletransfer within a DMP component, login is not required if the component has been preconfigured with a FAC File Transfer username and password.
2. If your username or password are rejected by the FAC File Transfer service, or the FAC File Transfer service is unavailable, the function will return an error and your model will terminate.
3. When used without a username and password, the function will use the credentials preconfigured in your DMP component. This is not necessary for use in the FAC, as the module will login on your first facfiletransfer function call, but is provided to allow you to validate credentials at a predicatable place.
4. Your username and password are transmitted to the remote FTS server using HTTP Basic authentication across an HTTPS session.
5. When using the facfiletransfer package from your local machine, you are required to login with a username and password prior to making any other calls. When using facfiletransfer within a DMP component, login is not required if the component has been preconfigured with a FAC File Transfer username and password.
6. If your username or password are rejected by the FAC File Transfer service, or the specified FAC File Transfer service is unavailable, the function will return an error and your model will terminate.
7. When used without a username and password, the function will use the credentials preconfigured in your DMP component. This is not necessary for use in the FAC, as the module will login on your first facfiletransfer function call, but is provided to allow you to validate credentials at a predicatable place.
8. Your username and password are transmitted to the remote FTS server using HTTP Basic authentication across an HTTPS session.